Page 66 |
DICOM PS3.7 2020a - Message Exchange |
9.3.5.2 C-ECHO-RSP
The C-ECHO-RSP Message contains fields as defined in Table 9.3-13 and in Annex C. Each field shall conform to DICOM encoding and Value Representation as defined in PS3.5. Fields are required as specified in the C-ECHO service definition unless otherwise noted in Table 9.3-13. Fields not specified in the C-ECHO service definition but present in Table 9.3-13 are required by the DIMSE- C protocol.
Table 9.3-13. C-ECHO-RSP Message Fields
Message Field |
Tag |
VR |
VM |
Description of Field |
Command Group Length |
(0000,0000) |
UL |
1 The even number of bytes from the end of the value field |
|
|
|
|
|
to the beginning of the next group. |
Affected SOP Class UID |
(0000,0002) |
UI |
1 SOP Class UID associated with the operation. |
|
Command Field |
(0000,0100) |
US |
1 ThisfielddistinguishestheDIMSE-Coperationconveyed |
|
|
|
|
|
by this Message. The value of this field shall be set to |
|
|
|
|
8030H for the C-ECHO-RSP Message. |
Message ID Being |
(0000,0120) |
US |
1 Shall be set to the value of the Message ID (0000,0110) |
|
Responded To |
|
|
|
field used in associated C-ECHO-RQ Message. |
Command Data Set Type |
(0000,0800) |
US |
1 This field indicates that no Data Set is present in the |
|
|
|
|
|
Message and shall be set to a value of 0101H. |
Status |
(0000,0900) |
US |
1 Indicatesthestatusoftheresponse.Itshallhaveavalue |
|
|
|
|
|
of Success. |
9.3.5.3 C-ECHO Protocol Procedures
The C-ECHO procedures are initiated by the invoking DIMSE Service User issuing a C-ECHO request primitive. On receipt of the C- ECHO request primitive the DIMSE-C protocol machine shall:
•construct a Message conveying the C-ECHO-RQ
•send the Message using the P-DATA request service (see 8.1)
On receipt of a Message conveying a C-ECHO-RQ the DIMSE-C protocol machine shall issue a C-ECHO indication primitive to the performing DIMSE Service User.
On receipt of a C-ECHO response primitive, issued by the performing DIMSE Service User, the DIMSE-C protocol machine shall:
•construct a Message conveying the C-ECHO-RSP
•send the Message using the P-DATA request service (see 8.1)
On receipt of a Message conveying a C-ECHO-RSP the DIMSE protocol machine shall issue a C-ECHO confirmation primitive to the invoking DIMSE Service User, thus completing the C-ECHO procedure.
- Standard -
DICOM PS3.7 2020a - Message Exchange |
Page 67 |
10 DIMSE-N
10.1 Services
The following sections describe the DIMSE-N Services. The behavior of these services is also described in PS3.4. The Affected SOP Class UID in the DIMSE-N command need not match the SOP Class UID in the Presentation Context negotiated for the association over which the DIMSE-N command has been sent. PS3.4 specifies which combinations are valid.
10.1.1 N-EVENT-REPORT Service
The N-EVENT-REPORT service is used by a DIMSE Service User to report an event to a peer DIMSE Service User. It is a confirmed service.
10.1.1.1 N-EVENT-REPORT Parameters
Table 10.1-1 lists the parameters for this service.
Table 10.1-1. N-EVENT-REPORT Parameters
DIMSE Parameter Name |
Req/Ind |
Rsp/Conf |
Message ID |
M |
- |
Message ID Being Responded To |
- |
M |
Affected SOP Class UID |
M |
U(=) |
Affected SOP Instance UID |
M |
U(=) |
Event Type ID |
M |
C(=) |
Event Information |
U |
- |
Event Reply |
- |
C |
Status |
- |
M |
10.1.1.1.1 Message ID
This parameter identifies the operation. It is used to distinguish this operation from other notifications or operations that the DIMSE ServiceProvidermayhaveinprogress.NotwoidenticalvaluesfortheMessageID(0000,0110)shallbeusedforoutstandingoperations or notifications.
Note
TheMessageID(0000,0110)isrecommendedtobeuniquewithinthescopeofanAssociation,tosupportdebugprocedures.
10.1.1.1.2 Message ID Being Responded To
ThisparameterspecifiestheMessageID(0000,0110)ofthenotificationrequest/indicationtowhichthisresponse/confirmationapplies.
10.1.1.1.3 Affected SOP Class UID
For the request/indication, this parameter specifies the SOP Class of the SOP Instance for the event. It may be included in the re- sponse/confirmation. If included in the response/confirmation, this parameter shall be equal to the value in the request/indication.
10.1.1.1.4 Affected SOP Instance UID
For the request/indication, this parameter specifies the SOP Instance for the event. It may be included in the response/confirmation. If included in the response/confirmation, this parameter shall be equal to thevalue in the request/indication.
- Standard -
Page 68 |
DICOM PS3.7 2020a - Message Exchange |
10.1.1.1.5 Event Type ID
Thisparameterspecifiesthetypeofeventbeingreported.Itmaybeincludedinthesuccessresponse/confirmationandshallbeincluded if the Event Reply parameter is included.
Note
Service Class Specifications contained in PS3.4 defines any application usage of the Event Type ID parameter.
10.1.1.1.6 Event Information
This application-specific parameter contains information that the invoking DIMSE Service User is able to supply about the event. Note
Service Class Specifications contained in PS3.4 defines any application usage of the Event Information parameter.
10.1.1.1.7 Event Reply
Thisapplication-specificparametercontainstheoptionalreplytotheeventreport.Itmayonlybeincludedinthesuccessresponse/con- firmation.
Note
Service Class Specifications contained in PS3.4 defines any application usage of the Event Reply parameter.
10.1.1.1.8 Status
This parameter contains the error or success notification for the operation. It shall be included by the performing DIMSE Service User in any response/confirmation. The following types of status may occur (see also Annex C):
•Class-Instance conflict (0119H) - the specified SOP Instance is not a member of the specified SOP class. •Duplicate invocation (0210H) - the Message ID (0000,0110) specified is allocated to another notification or operation. •Invalid argument value (0115H) - the event information value specified was out of range or otherwise inappropriate. •Invalid SOP Instance (0117H) - the SOP Instance UID specified implied a violation of the UID construction rules.
•Mistyped argument (0212H) - one of the parameters supplied has not been agreed for use on the Association between the DIMSE Service Users.
•No such argument (0114H) - the event information specified was not recognized. •No such Event Type (0113H) - the event type specified was not recognized. •No such SOP Class (0118H) - the SOP Class was not recognized.
•No such SOP Instance (0112H) - the SOP Instance was not recognized.
•Processing Failure (0110H) - a general failure in processing the operation was encountered. •Resource Limitation (0213H) - the operation was not performed due to resource limitation. •Success (0000H) - successful notification.
•Unrecognized operation (0211H) - the operation is not one of those agreed between the DIMSE Service Users.
10.1.1.2 N-EVENT-REPORT Service Procedures
The following N-EVENT-REPORT procedures apply:
- Standard -
DICOM PS3.7 2020a - Message Exchange |
Page 69 |
a.The invoking DIMSE Service User reports an event to the performing DIMSE Service User by issuing an N-EVENT-REPORT request primitive to the DIMSE Service Provider.
b.The DIMSE Service Provider issues an N-EVENT-REPORT indication primitive to the performing DIMSE Service User.
c.The performing DIMSE Service User reports acceptance or rejection of the N-EVENT-REPORT request primitive by issuing an N-EVENT-REPORT response primitive to the DIMSE Service Provider.
d.TheDIMSEServiceProviderissuesanN-EVENT-REPORTconfirmationprimitivetotheinvokingDIMSEServiceUser,completing the N-EVENT-REPORT notification.
TheperformingDIMSEServiceUsermayreturnanN-EVENT-REPORTresponseprimitivewiththestatusofFailedorRefusedbefore the entire N-EVENT-REPORT indication (Data Set) has been completely transmitted by the invoking DIMSE Service User. A N- EVENT-REPORT response primitive with the status of Success or Warning shall not be returned until the entire N-EVENT-REPORT indication has been received by the performing DIMSE Service User.
Note
Such an occurrence of a "Failed" response is often called an early failed response.
10.1.2 N-GET Service
The N-GET service is used by a DIMSE Service User to retrieve Attribute Values from a peer DIMSE Service User. It is a confirmed service.
10.1.2.1 N-GET Parameters
Table 10.1-2 lists the parameters for this service.
Table 10.1-2. N-GET Parameters
DIMSE Parameter Name |
Req/Ind |
Rsp/Conf |
Message ID |
M |
- |
Message ID Being Responded To |
- |
M |
Requested SOP Class UID |
M |
- |
Requested SOP Instance UID |
M |
- |
Attribute Identifier List |
U |
- |
Affected SOP Class UID |
- |
U |
Affected SOP Instance UID |
- |
U |
Attribute List |
- |
C |
Status |
- |
M |
10.1.2.1.1 Message ID
This parameter identifies the operation. It is used to distinguish this operation from other notifications or operations that the DIMSE ServiceProvidermayhaveinprogress.NotwoidenticalvaluesfortheMessageID(0000,0110)shallbeusedforoutstandingoperations or notifications.
Note
TheMessageID(0000,0110)isrecommendedtobeuniquewithinthescopeofanAssociation,tosupportdebugprocedures.
10.1.2.1.2 Message ID Being Responded To
This parameter specifies the Message ID (0000,0110) of the operation request/indication to which this response/confirmation applies.
- Standard -
Page 70 |
DICOM PS3.7 2020a - Message Exchange |
10.1.2.1.3 Requested SOP Class UID
This parameter specifies the SOP Class for which Attribute Values are to be retrieved.
10.1.2.1.4 Requested SOP Instance UID
This parameter specifies the SOP Instance for which Attribute Values are to be retrieved.
10.1.2.1.5 Attribute Identifier List
ThisparametercontainsasetofAttributeidentifiersforwhichtheAttributeValuesaretobereturnedbytheperformingDIMSEService User. If this parameter is omitted, all Attribute identifiers are assumed. The definitions of the Attributes are found in the specification of the Information Object Definition in PS3.3.
10.1.2.1.6 Affected SOP Class UID
This parameter may be included in the response/confirmation. If included in the response/confirmation, this parameter shall be equal to the Requested SOP Class UID parameter value used in the request/indication.
10.1.2.1.7 Affected SOP Instance UID
This parameter specifies the SOP Instance for which Attribute Values are returned. It may be included in any response/confirmation and when included shall be equal to the Requested SOP Instance UID (0000,1001) parameter value used in the invocation.
10.1.2.1.8 Attribute List
This parameter contains the set of Attribute identifiers and values that are returned by the performing DIMSE Service User. It shall be included in the success response/confirmation.
10.1.2.1.9 Status
This parameter contains the error or success notification for the operation. It shall be included by the performing DIMSE Service User in any response/confirmation. The following types of status may occur (see also Annex C):
•Attribute list error (0107H) - one or more Attribute Values were not read because the specified Attribute was not recognized. The Attribute Values that could be read are returned.
•Class-Instance conflict (0119H) - the specified SOP Instance is not a member of the specified SOP Class.
•Duplicate invocation (0210H) - the Message ID (0000,0110) specified is allocated to another notification or operation.
•Invalid SOP Instance (0117H) - the SOP Instance UID specified implied a violation of the UID construction rules.
•Mistyped argument (0212H) - one of the parameters supplied has not been agreed for use on the Association between the DIMSE Service Users.
•No such SOP Class (0118H) - the SOP Class was not recognized.
•No such SOP Instance (0112H) - the SOP Instance was not recognized.
•Processing Failure (0110H) - a general failure in processing the operation was encountered.
•Resource Limitation (0213H) - the operation was not performed due to resource limitation.
•Success (0000H) - successful operation.
•Unrecognized operation (0211H) - the operation is not one of those agreed between the DIMSE Service Users.
•Refused: Not authorized (0124H) - the DIMSE Service User was not authorized to invoke the operation
•Warning (Status value is Service Class specific): not all optional attributes were returned by DIMSE Service User
•Failed (Status value is Service Class specific): DIMSE Service User failed to complete the operation
- Standard -