DICOM PS3.7 2020a - Message Exchange |
Page 81 |
10.3.1.2 N-EVENT-REPORT-RSP
The N-EVENT-REPORT-RSP Message contains fields as defined in Table 10.3-2 and Annex C. Each field shall conform to DICOM encoding and Value Representation as defined in PS3.5. Fields are required as specified in the N-EVENT-REPORT service definition unless otherwise noted in Table 10.3-2. Fields not specified in the N-EVENT-REPORT service definition but present in Table 10.3-2 are required by the DIMSE-N protocol.
Table 10.3-2. N-EVENT-REPORT-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 of the SOP Instance for which this event |
|
|
|
|
occurred. |
Command Field |
(0000,0100) |
US |
1 |
ThisfielddistinguishestheDIMSE-Noperationconveyedby |
|
|
|
|
this Message. The value of this field shall be set to 8100H |
|
|
|
|
for the N-EVENT-REPORT-RSP Message. |
Message ID Being |
(0000,0120) |
US |
1 |
ShallbesettothevalueoftheMessageID(0000,0110)field |
Responded To |
|
|
|
used in associated N-EVENT-REPORT-RQ Message. |
Command Data Set Type |
(0000,0800) |
US |
1 |
This field indicates if a Data Set is present in the Message. |
|
|
|
|
This field shall be set to the value of 0101H if no Data Set |
|
|
|
|
is present; any other value indicates a Data Set is included |
|
|
|
|
in the Message. |
Status |
(0000,0900) |
US |
1 |
The value of this field depends upon the status type. Annex |
|
|
|
|
C defines the encoding of the status types defined in the |
|
|
|
|
service definition. |
AffectedSOPInstanceUID |
(0000,1000) |
UI |
1 |
Contains the UID of the SOP Instance for which this event |
|
|
|
|
occurred. |
Event Type ID |
(0000,1002) |
US |
1 |
Values for this field are application-specific. |
Event Reply |
(no tag) |
- |
- |
Application-specificDataSetcontainingadditionalinformation |
|
|
|
|
related to the operation. |
Note
1.Service Class Specifications contained in PS3.4 defines the values needed for the Event Type ID parameter.
2.Service Class Specifications contained in PS3.4 defines the Data Set needed for the Event Reply parameter related to each defined Event Type ID.
10.3.1.3 N-EVENT-REPORT Protocol Procedures
TheN-EVENT-REPORTreportingproceduresareinitiatedbytheinvokingDIMSEServiceUserissuinganN-EVENT-REPORTrequest primitive. On receipt of the N-EVENT-REPORT request primitive the DIMSE-N protocol machine shall:
•construct a Message conveying the N-EVENT-REPORT-RQ
•send the Message using the P-DATA request service (see 8.1)
On receipt of a Message conveying an N-EVENT-REPORT-RQ the DIMSE-N protocol machine shall issue an N-EVENT-REPORT indication primitive to the performing DIMSE Service User.
OnreceiptoftheN-EVENT-REPORTresponseprimitiveissuedbytheperformingDIMSEServiceUser,theDIMSE-Nprotocolmachine shall:
•construct a Message conveying the N-EVENT-REPORT-RSP
•send the Message using the P-DATA request service (see Section 8.1)
- Standard -
Page 82 |
DICOM PS3.7 2020a - Message Exchange |
On receipt of a Message conveying an N-EVENT-REPORT-RSP the DIMSE-N protocol machine shall issue an N-EVENT-REPORT confirmation primitive to the invoking DIMSE Service User, thus completing the notification procedure.
TheperformingDIMSEServiceUsermayreturnanN-EVENT-REPORT-RSPwiththestatusofFailedorRefusedbeforethecomplete N-EVENT-REPORT-RQ request Message has been completely transmitted by the invoking DIMSE Service User (this is called an earlyfailedresponse).UponreceiptofthisFailedorRefusedN-EVENT-REPORT-RSPtheinvokingDIMSEServiceUsermayterminate the Message before it is completely sent (i.e., set the Last Fragment bit to 1 in a Data PDV for this Message, see Annex F). Following this, it may invoke another operation or notification. It is a protocol violation for an invoking DIMSE Service User to set the Last Fragmentbitto1beforeanN-EVENT-REPORT-RQMessagehasbeencompletelytransmittedifithasnotreceivedaFailedorRefused N-EVENT-REPORT-RSP to that request.
Note
When an Association is operating in asynchronous mode, it is possible for an invoking DIMSE Service User to transmit several Messages before a response. Therefore, while sending a Message it may receive a response to a previously trans- mitted Message. In this case this response is not an early failed response because the related Message has already been sent.
10.3.2 N-GET Protocol
The information necessary for the N-GET request and indication DIMSE-N primitives are conveyed in the N-GET-RQ Message. The information necessary for the N-GET response and confirmation DIMSE-N primitives are conveyed in the N-GET-RSP Message.
10.3.2.1 N-GET-RQ
The N-GET-RQ Message contains fields as defined in Table 10.3-3. Each field shall conform to DICOM encoding and Value Repres- entation as defined in PS3.5. Fields are required as specified in the N-GET service definition unless otherwise noted in Table 10.3- 3. Fields not specified in the N-GET service definition but present in Table 10.3-3 are required by the DIMSE-N protocol.
Table 10.3-3. N-GET-RQ 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. |
Requested SOP Class UID |
(0000,0003) |
UI |
1 |
SOP Class UID of the SOP Instance for which Attribute |
|
|
|
|
Values are to be retrieved. |
Command Field |
(0000,0100) |
US |
1 |
This field distinguishes the DIMSE-N operation conveyed |
|
|
|
|
by this Message. The value of this field shall be set to |
|
|
|
|
0110H for the N-GET-RQ Message. |
Message ID |
(0000,0110) |
US |
1 |
Implementation-specific value that distinguishes this |
|
|
|
|
Message from other Messages. |
Command Data Set Type |
(0000,0800) |
US |
1 |
This field indicates that no Data Set shall be present in |
|
|
|
|
theMessage.Thisfieldshallbesettothevalueof0101H). |
Requested SOP Instance |
(0000,1001) |
UI |
1 |
Contains the UID of the SOP Instance for which Attribute |
UID |
|
|
|
Values are to be retrieved. |
Attribute Identifier List |
(0000,1005) |
AT |
1-n |
This field contains an Attribute Tag for each of the n |
|
|
|
|
Attributes applicable to the N-GET operation. |
10.3.2.2 N-GET-RSP
The N-GET-RSP Message contains fields as defined in Table 10.3-4 and Annex C. Each field shall conform to DICOM encoding and Value Representation as defined in PS3.5. Fields are required as specified in the N-GET service definition unless otherwise noted in Table 10.3-4. Fields not specified in the N-GET service definition but present in Table 10.3-4 are required by the DIMSE-N protocol.
- Standard -
DICOM PS3.7 2020a - Message Exchange Page 83
Table 10.3-4. N-GET-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 |
SOPClassUIDoftheSOPInstanceforwhichAttributeValues |
|
|
|
|
are returned. |
Command Field |
(0000,0100) |
US |
1 |
This field distinguishes the DIMSE-N operation conveyed by |
|
|
|
|
this Message. The value of this field shall be set to 8110H for |
|
|
|
|
the N-GET-RSP Message. |
Message ID Being |
(0000,0120) |
US |
1 |
Shall be set to the value of the Message ID (0000,0110) field |
Responded To |
|
|
|
used in associated N-GET-RQ Message. |
Command Data Set Type |
(0000,0800) |
US |
1 |
This field indicates if a Data Set is present in the Message. |
|
|
|
|
This field shall be set to the value of 0101H if no Data Set is |
|
|
|
|
present; any other value indicates a Data Set is included in |
|
|
|
|
the Message. |
Status |
(0000,0900) |
US |
1 |
The value of this field depends upon the status type. Annex |
|
|
|
|
C defines the encoding of the status types defined in the |
|
|
|
|
service definition. |
AffectedSOPInstanceUID |
(0000,1000) |
UI |
1 |
Contains the UID of the SOP Instance for which Attribute |
|
|
|
|
Values are returned. |
Attribute List |
(no tag) |
- |
- |
T his field is encoded as a Data Set. One Data Element is |
|
|
|
|
encoded for each Attribute Value returned. |
Note
The permitted contents of Attribute List, encoded as a series of Data Elements, are defined in the Information Object Defin- ition (PS3.3) and Service Class Specifications (PS3.4).
10.3.2.3 N-GET Protocol Procedures
The N-GET procedures are initiated by the invoking DIMSE Service User issuing an N-GET request primitive. On receipt of the N- GET request primitive the DIMSE-N protocol machine shall:
•construct a Message conveying the N-GET-RQ
•send the Message using the P-DATA request service (see 8.1)
On receipt of a Message conveying an N-GET-RQ the DIMSE-N protocol machine shall issue an N-GET indication primitive to the performing DIMSE Service User.
On receipt of the N-GET response primitive, issued by the performing DIMSE Service User, the DIMSE-N protocol machine shall:
•construct a Message conveying the N-GET-RSP
•send the Message using the P-DATA request service (see 8.1)
On receipt of a Message conveying an N-GET-RSP the DIMSE-N protocol machine shall issue an N-GET confirmation primitive to the invoking DIMSE Service User, thus completing the N-GET procedure.
10.3.3 N-SET Protocol
The information necessary for the N-SET request and indication DIMSE-N primitives are conveyed in the N-SET-RQ Message. The information necessary for the N-SET response and confirmation DIMSE-N primitives are conveyed in the N-SET-RSP Message. Fields not specified in the N-SET service definition but present in Table 10.3-3 are required by the DIMSE-N protocol.
- Standard -
Page 84 |
DICOM PS3.7 2020a - Message Exchange |
10.3.3.1 N-SET-RQ
The N-SET-RQ Message contains fields as defined in Table 10.3-5. Each field shall conform to DICOM encoding and Value Repres- entation as defined in PS3.5. Fields are required as specified in the N-SET service definition unless otherwise noted in Table 10.3-5. Fields not specified in the N-SET service definition but present in Table 10.3-5 are required by the DIMSE-N protocol.
Table 10.3-5. N-SET-RQ 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. |
Requested SOP Class UID |
(0000,0003) |
UI |
1 |
SOP Class UID of the SOP Instance for which Attribute |
|
|
|
|
Values are to be modified. |
Command Field |
(0000,0100) |
US |
1 |
This field distinguishes the DIMSE-N operation conveyed |
|
|
|
|
bythisMessage.Thevalueofthisfieldshallbesetto0120H |
|
|
|
|
for the N-SET-RQ Message. |
Message ID |
(0000,0110) |
US |
1 |
Implementation-specific value that distinguishes this |
|
|
|
|
Message from other Messages. |
Command Data Set Type |
(0000,0800) |
US |
1 |
This field indicates that a Data Set is present in the |
|
|
|
|
Message. It shall be set to any value other than 0101H |
|
|
|
|
(Null). |
Requested SOP Instance |
(0000,1001) |
UI |
1 |
Contains the UID of the SOP Instance for which Attribute |
UID |
|
|
|
Values are to be modified. |
Modification List |
(no tag) |
- |
- |
This field is encoded as a Data Set. One Data Element is |
|
|
|
|
encoded for each Attribute and Attribute Value applicable |
|
|
|
|
to the operation. |
Note
The permitted contents of Modification List, encoded as a series of Data Elements, are defined in the Information Object Definition (PS3.3) and Service Class Specifications (PS3.4).
10.3.3.2 N-SET-RSP
The N-SET-RSP Message contains all fields as defined in Table 10.3-6 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 N-SET service definition unless otherwise noted. Fields not specified in the N-SET service definition but present in Table 10.3-6 are required by the DIMSE-N protocol.
Table 10.3-6. N-SET-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 SOPClassUIDoftheSOPInstanceforwhichAttributeValues |
|
|
|
|
|
were modified. |
Command Field |
(0000,0100) |
US |
1 This field distinguishes the DIMSE-N operation conveyed by |
|
|
|
|
|
this Message. The value of this field shall be set to 8120H for |
|
|
|
|
the N-SET-RSP Message. |
Message ID Being |
(0000,0120) |
US |
1 Shall be set to the value of the Message ID (0000,0110) field |
|
Responded To |
|
|
|
used in associated N-SET-RQ Message. |
Command Data Set Type |
(0000,0800) |
US |
1 This field indicates if a Data Set is present in the Message. |
|
|
|
|
|
This field shall be set to the value of 0101H if no Data Set is |
|
|
|
|
present; any other value indicates a Data Set is included in |
|
|
|
|
the Message. |
- Standard -
|
DICOM PS3.7 2020a - Message Exchange |
Page 85 |
|||
Message Field |
Tag |
VR |
VM |
Description of Field |
|
Status |
(0000,0900) |
US |
1 |
The value of this field depends upon the status type. Annex |
|
|
|
|
|
C defines the encoding of the status types defined in the |
|
|
|
|
|
service definition. |
|
AffectedSOPInstanceUID |
(0000,1000) |
UI |
1 |
Contains the UID of the SOP Instance for which Attribute |
|
|
|
|
|
Values were modified. |
|
Attribute List |
(no tag) |
- |
- |
This field is encoded as a Data Set. One Data Element is |
|
|
|
|
|
encoded for each Attribute and Attribute Value applicable to |
|
|
|
|
|
the operation. |
|
Note
The permitted contents of Attribute List, encoded as a series of Data Elements, are defined in the Information Object Defin- ition (PS3.3) and Service Class Specifications (PS3.4).
10.3.3.3 N-SET Protocol Procedures
The N-SET procedures are initiated by the invoking DIMSE Service User issuing an N-SET request primitive. On receipt of the N- SET request primitive the DIMSE-N protocol machine shall:
•construct a Message conveying the N-SET-RQ
•send the Message using the P-DATA request service (see 8.1)
On receipt of a Message conveying an N-SET-RQ the DIMSE-N protocol machine shall issue an N-SET indication primitive to the performing DIMSE Service User.
On receipt of the N-SET response primitive, issued by the performing DIMSE Service User, the DIMSE-N protocol machine shall:
•construct a Message conveying the N-SET-RSP
•send the Message using the P-DATA request service (see 8.1)
On receipt of a Message conveying an N-SET-RSP the DIMSE-N protocol machine shall issue an N-SET confirmation primitive to the invoking DIMSE Service User, thus completing the N-SET procedure.
The performing DIMSE Service User may return an N-SET-RSP with the status of Failed or Refused before the complete N-SET-RQ request Message has been completely transmitted by the invoking DIMSE Service User (this is called an early failed response). Upon receipt of this Failed or Refused N-SET-RSP the invoking DIMSE Service User may terminate the Message before it is completely sent (i.e., set the Last Fragment bit to 1 in a Data PDV for this Message, see Annex F). Following this, it may invoke another operation or notification. It is a protocol violation for an invoking DIMSE Service User to set the Last Fragment bit to 1 before an N-SET-RQ Message has been completely transmitted if it has not received a Failed or Refused N-SET-RSP to that request.
Note
When an Association is operating in asynchronous mode, it is possible for an invoking DIMSE Service User to transmit several Messages before a response. Therefore, while sending a Message it may receive a response to a previously trans- mitted Message. In this case this response is not an early failed response because the related Message has already been sent.
10.3.4 N-ACTION Protocol
TheinformationnecessaryfortheN-ACTIONrequestandindicationDIMSE-NprimitivesareconveyedintheN-ACTION-RQMessage. The information necessary for the N-ACTION response and confirmation DIMSE-N primitives are conveyed in the N-ACTION-RSP Message.
- Standard -