Page 76 |
DICOM PS3.7 2020a - Message Exchange |
Note
Such an occurrence of a "Failed" response is often called an early failed response.
10.1.5 N-CREATE Service
The N-CREATE service is used by a DIMSE Service User to request a peer DIMSE Service User to create a new managed SOP In- stance, complete with its identification and the values of its associated Attributes, and simultaneously to register its identification. It is a confirmed service.
10.1.5.1 N-CREATE Parameters
Table 10.1-5 lists the parameters for this service.
Table 10.1-5. N-CREATE 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 |
U |
C |
Attribute List |
U |
U |
Status |
- |
M |
10.1.5.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.5.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.
10.1.5.1.3 Affected SOP Class UID
For the request/indication, this parameter specifies the SOP Class of the new SOP Instance that is to be created by the performing DIMSE Service User. The performing DIMSE Service User assigns to the new SOP Instance, a set of Attribute Values as specified by the definition of its SOP Class. For the response/confirmation, this parameter specifies the SOP class of the SOP Instance that was created. It may be included in the response/confirmation. If included in the response/confirmation, this parameter shall be equal to the value in the request/indication.
10.1.5.1.4 Affected SOP Instance UID
For the request/indication, this parameter specifies the SOP Instance that is used by the performing DIMSE Service User. If the SOP Instance UID is not supplied by the invoking DIMSE Service User, then the performing DIMSE Service User assigns a value to this identification of instance. For the response/confirmation, this parameter may only be included in the success response/confirmation and shall be included if it is not supplied by the invoking DIMSE Service User.
10.1.5.1.5 Attribute List
When this parameter is supplied by the invoking DIMSE Service User, it contains a set of Attribute identifiers and values that the performing DIMSE Service User is to assign to the new managed SOP Instance. When returned by the performing DIMSE Service
- Standard -
DICOM PS3.7 2020a - Message Exchange |
Page 77 |
User in the success response/confirmation, this parameter contains the complete list of all Attribute identifiers and values that were assigned to the new managed SOP Instance.
10.1.5.1.6 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 type of status may occur (see also Annex C):
•Duplicate invocation (0210H) - the Message ID (0000,0110) specified is allocated to another notification or operation.
•DuplicateSOPInstance(0111H)-thenewmanagedSOPInstanceValuesuppliedbytheinvokingDIMSEServiceUserwasalready registered for a managed SOP Instance of the specified SOP Class.
•Invalid Attribute Value (0106H) - the Attribute Value specified was out of range or otherwise inappropriate.
•Attribute Value out of range (0116H) - the Attribute Value specified was out of range or otherwise inappropriate. The SCP will apply a default value or will not include the attribute in the created instance.
•Invalid SOP Instance (0117H) - the SOP Instance UID specified implied a violation of the UID construction rules.
•Missing Attribute (0120H) - a required Attribute was not supplied.
•Missing Attribute Value (0121H) - a required Attribute Value was not supplied and a default value was not available.
•Mistyped argument (0212H) - one of the parameters supplied has not been agreed for use on the Association between the DIMSE Service Users.
•No such Attribute (0105H) - the Tag for the specified Attribute was not recognized.
•Attribute list error (0107H) -one or more specified Attributes were not recognized and not included in the created instance.
•No such SOP Class (0118H) - the SOP Class 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.
•Failed (Status value is Service Class specific): no instance was created by the DIMSE Service User
•Warning (Status value is Service Class specific): the DIMSE Service User created an Instance but did not perform all specified operations
10.1.5.2 N-CREATE Service Procedures
The following N-CREATE procedures apply:
a.The invoking DIMSE Service User requests the creation and registration of a new managed SOP Instance by issuing an N- CREATE request primitive to the DIMSE Service Provider.
b.The DIMSE-service provider issues an N-CREATE indication primitive to the performing DIMSE Service User.
c.If the operation can be performed, the performing DIMSE Service User creates and registers the new managed SOP Instance andgeneratesaresponseindicatingacceptanceoftheN-CREATErequestprimitivebyissuinganN-CREATEresponseprimitive to the DIMSE Service Provider. In this case the following procedure does not apply.
d.If the operation cannot be performed, then the performing DIMSE Service User rejects the N-CREATE request by issuing an N- CREATE response primitive with the appropriate error code to the DIMSE Service Provider.
- Standard -
Page 78 |
DICOM PS3.7 2020a - Message Exchange |
e.The DIMSE Service Provider issues an N-CREATE confirmation primitive to the invoking DIMSE Service User, completing the N-CREATE operation.
The performing DIMSE Service User may return an N-CREATE response primitive with the status of Failed or Refused before the entireN-CREATEindication(DataSet)hasbeencompletelytransmittedbytheinvokingDIMSEServiceUser.AN-CREATEresponse primitive with the status of Success or Warning shall not be returned until the entire N-CREATE 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.6 N-DELETE Service
The N-DELETE service is used by an invoking DIMSE Service User to request a peer DIMSE Service User to delete a managed SOP Instance and to de-register its identification. It is a confirmed service.
10.1.6.1 N-DELETE Parameters
Table 10.1-6 lists the parameters for this service.
Table 10.1-6. N-DELETE 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 |
- |
Affected SOP Class UID |
- |
U |
Affected SOP Instance UID |
- |
U |
Status |
- |
M |
10.1.6.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.6.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.
10.1.6.1.3 Requested SOP Class UID
This parameter specifies the SOP Class that is to be deleted.
10.1.6.1.4 Requested SOP Instance UID
This parameter specifies the SOP Instance that is to be deleted.
10.1.6.1.5 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 parameter value used in the request/indication.
- Standard -
DICOM PS3.7 2020a - Message Exchange |
Page 79 |
10.1.6.1.6 Affected SOP Instance UID
This parameter specifies the SOP Instance that was deleted. 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.6.1.7 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 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.
10.1.6.2 N-DELETE Service Procedures
The following N-DELETE procedures apply:
a.The invoking DIMSE Service User requests the performing DIMSE Service User to delete a managed SOP Instance by issuing an N-DELETE request primitive to the DIMSE Service Provider.
b.The DIMSE-service provider issues an N-DELETE indication primitive to the performing DIMSE Service User.
c.Iftheoperationcanbeperformed,theperformingDIMSEServiceUserdeletesthespecifiedmanagedSOPInstanceandgenerates a response indicating acceptance of the N-DELETE request primitive by issuing an N-DELETE response primitive to the DIMSE Service Provider. In this case the following procedure does not apply.
d.If the operation cannot be performed, then the performing DIMSE Service User rejects the N-DELETE request by issuing an N- DELETE response primitive with the appropriate error code to the DIMSE Service Provider.
e.The DIMSE Service Provider issues an N-DELETE confirmation primitive to the invoking DIMSE Service User, completing the N-DELETE operation.
10.2 Sequencing
10.2.1 Types of Services
All operation and notifications shall be confirmed services.
10.2.2 Usage Restrictions
These services may only be invoked within the context of an established Association.
- Standard -
Page 80 |
DICOM PS3.7 2020a - Message Exchange |
10.2.3 Disrupted Procedures
These services do not disrupt any other service procedure.
10.2.4 Disrupting Procedures
These services are disrupted by the A-ABORT service procedure.
10.3 Protocol
This section specifies the protocol necessary to perform the set of DIMSE-N operations and notifications. The Value Representations (VR) specified in the following tables shall be encoded as defined in PS3.5.
10.3.1 N-EVENT-REPORT Protocol
The information necessary for the N-EVENT-REPORT request and indication DIMSE-N primitives are conveyed in the N-EVENT- REPORT-RQ Message. The information necessary for the N-EVENT-REPORT response and confirmation DIMSE-N primitives are conveyed in the N-EVENT-REPORT-RSP Message.
10.3.1.1 N-EVENT-REPORT-RQ
The N-EVENT-REPORT-RQ Message contains fields as defined in Table 10.3-1. Each field shall conform to DICOM encoding and ValueRepresentationasdefinedinPS3.5.FieldsarerequiredasspecifiedintheN-EVENT-REPORTservicedefinitionunlessotherwise noted in Table 10.3-1. Fields not specified in the N-EVENT-REPORT service definition but present in Table 10.3-1 are required by the DIMSE-N protocol.
Table 10.3-1. N-EVENT-REPORT-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. |
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 |
This field distinguishes the DIMSE-N notification conveyed |
|
|
|
|
by this Message. The value of this field shall be set to |
|
|
|
|
0100H for the N-EVENT-REPORT-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 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. |
Affected SOP Instance UID |
(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 Information |
(no tag) |
- |
- |
Application-specific Data Set containing additional |
|
|
|
|
information 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 Information parameter.
- Standard -