| DICOM PS3.4 2024d - Service Class Specifications |
|---|
This operation allows an SCU to instruct an SCP to create a Unified Procedure Step. This operation shall be invoked by the SCU through the DIMSE N-CREATE Service.
An Application Entity that claims conformance to the UPS Push SOP Class as an SCU shall provide all Required Attributes as specified in Table CC.2.5-3. Additional Attributes defined by the UPS IOD may be provided as well.
An Application Entity that claims conformance to the UPS Push SOP Class as an SCP shall support all required Attributes as specified in Table CC.2.5-3. Additional Attributes defined by the UPS IOD may be supported as well.
COMPLETED and CANCELED are Final States for a UPS instance. The Attributes and values of the UPS instance must meet certain requirements before it may be placed in either of the Final States.
A UPS instance is in the SCHEDULED state when created. See Section CC.1.1 for rules governing state transitions.
Attributes shall be valued as indicated by the Final State Codes in the Final State Column of Table CC.2.5-3 before the Procedure Step State (0074,1000) may be set to COMPLETED or CANCELED (i.e., Final State).
Performing systems are encouraged to ensure that the values for all Attributes reasonably reflect what was done and the Final State of the UPS. This may include blanking Attributes that are permitted to be empty and for which no reasonable value can be determined. The UPS contents should make it clear whether the step was completed, what work was done, what results were produced and whether the results are usable. See Section GGG.3.1 “What Was Scheduled Vs. What Was Performed” in PS3.17 for a discussion of methods to convey things like partial completion.
The SCU may choose not to distribute, or otherwise make available, some or all instances created during the procedure step and referenced in the Output Information Sequence (0040,4033).
Table CC.2.5-1. Final State Codes
To reduce the size and complexity of Table CC.2.5-3, a macro notation is used.
For example, in Table CC.2.5-3, a table entry specifying "Include Table CC.2.5-2a “UPS Code Sequence Macro”" should be interpreted as including the following table of text as a substitution. The nesting level for the sequence inclusion is indicated by the nesting level on the reference to the macro. Where the matching key type requirement is "*" it should be replaced with the matching key type requirement of the sequence Attribute that incorporates this macro.
For code sequences that have requirements for N-CREATE, N-SET, N-GET, or C-FIND behavior that differ from the Macro, the code sequence contents are explicitly listed in the Table rather than specifying inclusion of the Macro.
Table CC.2.5-2a. UPS Code Sequence Macro
Table CC.2.5-2b. UPS Content Item Macro
|
Units of measurement for a numeric value in this name-value Item. |
||||||||
|
Baseline CID 82 “Measurement Unit” |
||||||||
Table CC.2.5-2c. Referenced Instances and Access Macro
Table CC.2.5-2d. HL7V2 Hierarchic Designator Macro
Table CC.2.5-2e. Issuer of Patient ID Macro
|
Required if Universal Entity ID (0040,0032) is present in this item with a value. |
||||||||
|
The Attributes of the Assigning Facility Sequence shall only be retrieved with Sequence Matching. |
||||||||
|
>>Include Table CC.2.5-2d “HL7V2 Hierarchic Designator Macro” |
||||||||
|
The Attributes of the Assigning Jurisdiction Code Sequence shall only be retrieved with Sequence Matching. |
||||||||
|
Baseline CID 5001 “Country” for country codes. |
||||||||
|
The Attributes of the Assigning Agency or Department Code Sequence shall only be retrieved with Sequence Matching. |
||||||||
Table CC.2.5-2g. Storage Macro
This table combines the Attribute requirements for multiple DIMSE services (N-CREATE, N-SET, N-GET, C-FIND) to facilitate consistency between the requirements.
See PS3.4 for the meaning of the requirement codes used in the N-CREATE, N-SET, N-GET and Return Key columns in the following table.
See Section C.1.2 for the meaning of the requirement codes used in the Matching Key column in the following table.
See Table CC.2.5-1 for the meaning of the requirement codes used in the Final State column of the following table.
Table CC.2.5-3. UPS SOP Class N-CREATE/N-SET/N-GET/C-FIND Attributes
|
(see CC.2.6.3) |
||||||||
|
See CC.2.5.1.3.1 |
Uniquely identifies the SOP Class of the Unified Procedure Step. See Section CC.3.1 for further explanation. |
|||||||
|
SOP Instance is conveyed in the Affected SOP Instance UID (0000,1000) |
SOP Instance is conveyed in the Requested SOP Instance UID (0000,1001) |
SOP Instance is conveyed in the Requested SOP Instance UID (0000,1001) |
Uniquely identifies the SOP Instance of the UPS. SOP Instance UID shall be retrieved with Single Value Matching. |
|||||
|
All other Attributes of the SOP Common Module |
||||||||
|
Unified Procedure Step Scheduled Procedure Information Module |
||||||||
|
Scheduled Procedure Step Priority shall be retrieved with Single Value Matching. |
||||||||
|
Scheduled Procedure Step Modification DateTime shall be retrieved with Single Value Matching or Range Matching. |
||||||||
|
If a value is not provided by the SCU, the SCP shall fill in the Worklist Label, e.g., using a default value or by assigning the UPS instance to a logical worklist. |
||||||||
|
The Attributes of the Scheduled Station Name Code Sequence shall only be retrieved with Sequence Matching. |
||||||||
|
The Attributes of the Scheduled Station Class Code Sequence shall only be retrieved with Sequence Matching. |
||||||||
|
The Attributes of the Scheduled Station Geographic Location Code Sequence shall only be retrieved with Sequence Matching. |
||||||||
|
The Attributes of the Scheduled Human Performers Sequence shall only be retrieved with Sequence Matching. |
||||||||
|
The Attributes of the Scheduled Human Performers Code Sequence shall only be retrieved with Sequence Matching. |
||||||||
|
Scheduled Procedure Step Start DateTime shall be retrieved with Single Value Matching or Range Matching. |
||||||||
|
Expected Completion DateTime shall be retrieved with Single Value Matching or Range Matching. |
||||||||
|
Scheduled Procedure Step Expiration DateTime shall be retrieved with Single Value Matching or Range Matching. |
||||||||
|
The Attributes of the Scheduled Workitem Code Sequence shall only be retrieved with Sequence Matching. |
||||||||
|
Input Readiness State shall be retrieved with Single Value Matching. |
||||||||
|
The Attributes of the Input Information Sequence shall only be retrieved with Sequence Matching. |
||||||||
|
>Include Table CC.2.5-2c “Referenced Instances and Access Macro” |
||||||||
|
Required if the Workitem is expected to result in the creation of any DICOM Composite Instances whose IOD contains the Study IE. There may be situations where the performer does not use the Study Instance UID suggested by the Scheduler. |
||||||||
|
The Attributes of the Output Destination Sequence shall only be retrieved with Sequence Matching. |
||||||||
|
>Include Table CC.2.5-2g “Storage Macro” |
||||||||
|
All other Attributes of the Unified Procedure Step Scheduled Procedure Information Module |
||||||||
|
Required if the subject of the workitem requires identification or if the workitem is expected to result in the creation of objects that identify the subject. |
||||||||
|
>Include Table CC.2.5-2c “Referenced Instances and Access Macro” |
||||||||
|
>Include Table CC.2.5-2d “HL7V2 Hierarchic Designator Macro” |
||||||||
|
The Attributes of the Admitting Diagnoses Code Sequence shall only be retrieved with Sequence Matching. |
||||||||
|
Could be "changed" while SCHEDULED by canceling and re-creating with the "correct" values. |
||||||||
|
The Issuer of Accession Number Sequence shall only be retrieved with Sequence Matching. |
||||||||
|
>>Include Table CC.2.5-2d “HL7V2 Hierarchic Designator Macro” |
||||||||
|
The Order Placer Identifier Sequence shall only be retrieved with Sequence Matching. |
||||||||
|
>>Include Table CC.2.5-2d “HL7V2 Hierarchic Designator Macro” |
||||||||
|
The Order Filler Identifier Sequence shall only be retrieved with Sequence Matching. |
||||||||
|
>>Include Table CC.2.5-2d “HL7V2 Hierarchic Designator Macro” |
||||||||
|
All other Attributes of the Unified Procedure Step Relationship Module |
||||||||
|
All Attributes of the Patient Demographic Module |
||||||||
|
All other Attributes of the Patient Medical Module |
||||||||
|
All Attributes of the Visit Identification Module |
||||||||
|
All Attributes of the Visit Status Module |
||||||||
|
All Attributes of the Visit Admission Module |
||||||||
|
Procedure Step State shall be retrieved with Single Value Matching |
||||||||
|
>>Include Table CC.2.5-2b “UPS Content Item Macro” |
||||||||
|
>>>Include Table CC.2.5-2b “UPS Content Item Macro” |
||||||||
|
If changing the UPS State (0074,1000) to CANCELED and this Attribute has no value, the SCP shall fill it with the current datetime. |
||||||||
|
Unified Procedure Step Performed Procedure Information Module |
||||||||
|
See CC.2.5.1.3.2. |
||||||||
|
The Attributes of the Actual Human Performers Sequence shall only be retrieved with Sequence Matching. |
||||||||
|
>>>Include Table CC.2.5-2a “UPS Code Sequence Macro” |
||||||||
|
>>Include Table CC.2.5-2b “UPS Content Item Macro” |
||||||||
|
If there are no relevant output objects, then this sequence may have no items. |
||||||||
|
>Include Table CC.2.5-2c “Referenced Instances and Access Macro” |
||||||||
| DICOM PS3.4 2024d - Service Class Specifications |
|---|