S.3.2 Operations

The DICOM AEs that claim conformance to this SOP Class as an SCU shall invoke the N-CREATE and the N-ACTION operations. The DICOM AEs that claim conformance to this SOP Class as an SCP shall support the N-CREATE, the N-ACTION and the N-GET operations.

S.3.2.1 Create a Media Creation Request

The Create a Media Creation Request operation allows an SCU to create an instance of the Media Creation Management SOP Class and initialize Attributes of the SOP Class. The SCP uses this operation to create a new media creation request containing the set of SOP Instances that shall be included in the Interchange Media. This operation shall be invoked through the N-CREATE primitive

S.3.2.1.1 Attributes

The DICOM AEs that claim conformance to this SOP Class as an SCU may choose to provide a subset of the Attributes maintained by the SCP. The DICOM AEs that claim conformance to this SOP Class as an SCP shall support a subset of the Media Creation Management specified in Table S.3.2.1.1-1.

Table S.3.2.1.1-1MEDIA CREATION MANAGEMENT – N-CREATE ATTRIBUTES

Attribute Tag Requirement Type SCU/SCP
Specific Character Set (0008,0005) 1C/1C (Required if expanded or replacement character set is used)
Storage Media File-Set ID (0088,0130) 3/3 See Section S.3.2.1.1.1.
Storage Media File-Set UID (0088,0140) 3/3 See Section S.3.2.1.1.1.
Label Using Information Extracted From Instances (2200,0001) 3/1C See Section S.3.2.1.1.4.
Label Text (2200,0002) 3/1C See Section S.3.2.1.1.4.
Label Style Selection (2200,0003) 3/1C See Section S.3.2.1.1.4.
Barcode Value (2200,0005) 3/3 See Section S.3.2.1.1.4
Barcode Symbology (2200,0006) 3/3 See Section S.3.2.1.1.4
Media Disposition (2200,0004) 3/3 See Section S.3.2.1.1.5.
Allow Media Splitting (2200,0007) 3/1C See Section S.3.2.1.1.6
Allow Lossy Compression (2200,000F) 3/1C See Section S.3.2.1.1.9
Include Non-DICOM Objects (2200,0008) 3/1C See Section S.3.2.1.1.7
Include Display Application (2200,0009) 3/1C See Section S.3.2.1.1.8
Preserve Composite Instances After Media Creation (2200,000A) 3/3
Referenced SOP Sequence (0008,1199) 1/1
>Referenced SOP Class UID (0008,1150) 1/1
>Referenced SOP Instance UID (0008,1155) 1/1
>Requested Media Application Profile (2200,000C) 3/1 See Section S.3.2.1.1.2.
>Icon Image Sequence (0088,0200) 3/1C See Section S.3.2.1.1.3.

S.3.2.1.1.1 Storage Media File-set Attributes

If present, the Storage Media File-Set ID (0088,0130) and Storage Media File-Set UID (0088,0140) shall be used on the media created. If absent, the media shall contain values generated by the SCP.

If the media request will not fit on a single volume (single piece or side of media), then whether or not the SCP ignores Storage Media File-Set ID (0088,0130), or uses it as a prefix and appends information to distinguish volumes, is implementation dependent. Different values of Storage Media File-Set UID (0088,0140) shall be used for different volumes.

If multiple copies are requested, the same Storage Media File-Set ID (0088,0130) and Storage Media File-Set UID (0088,0140) shall be used on all copies.

Note: Care should be taken with multiple copies written to rewritable media that their contents do not diverge even though their identifiers are identical.

S.3.2.1.1.2 Requested Media Application Profile

The Requested Media Application Profile (2200,000C), if present, shall be used by the SCP for the specified SOP Instance. If absent for a particular instance, the choice of Media Application Profile for that instance shall be at the discretion of the SCP.

Notes: 1. Different Media Application Profiles may be used for different instances on the same piece of media.

2. The form of the DICOMDIR directory records that the SCP must create may be significantly influenced by the media application profiles used.

S.3.2.1.1.3 Icon Image Sequence

The Icon Image Sequence (0088,0200), if present:

If absent for a particular instance, the choice of Media Application Profile for that instance dictates whether or not the SCP is required to create its own Icon Image Sequence (0088,0200) from the contents of the SOP Instance.

Notes: 1. Some Media Application Profiles require the inclusion of an Icon Image Sequence (0088,0200) in the directory records.

2. Some Media Application Profiles specify constraints on the form of the Icon Image Sequence (0088,0200).

3. The SCP may choose to extend the Media Application Profile by generating and including icons anyway.

S.3.2.1.1.4 Labeling

The SCP may or may not have the capability to print a label on (or for) the media. If it does, then the following SCP behavior shall apply and the specified attributes are required to be supported by the SCP.

The Label Using Information Extracted From Instances (2200,0001) attribute is a flag that instructs the SCP whether or not to create any label using the Patient and Study information contained within the instances themselves.

Note: The SCP may implement whatever it considers to be an appropriate subset of any attributes of any Modules at the Patient, Specimen and Study entities in the DICOM Information Model specified in PS 3.3. Typically included are such attributes as Patient Name (0010,0010), Patient ID (0010,0020), Study ID (0020,0010), and Study Date (0008,0020).

The Label Text (2200,0002) attribute is additional text that the SCP shall include on any label, either in addition to or instead of any extracted demographics, depending on the value of Label Using Information Extracted From Instances (2200,0001).

The Label Style Selection (2200,0003) attribute is a code string, which if present, may be used by the SCP to choose one or more implementation-dependent styles of labeling.

The Barcode Value (2200,0005) and the Barcode Symbology (2200,0006), if present, may be used by the SCP to print a barcode on the label.

Note It is SCU responsibility to convey a value for the Barcode Value (2200,0005) Attribute consistent in length and content with the requested Barcode Symbology (2200,0006).

S.3.2.1.1.5 Media Disposition

The Media Disposition (2200,0004), if present, may be used by the SCP to determine where and to whom to send the media when completed.

Note: For example, it may contain the name and address of a referring doctor, and be used to print a label for an envelope or mailer, or as additional material to be printed on the media label.

S.3.2.1.1.6 Allow Media Splitting

The SCP may or may not have the capability to split a request over more than one piece of media (e.g. if it doesn’t fit on one). If it does, then the following SCP behavior shall apply and the specified attributes are required to be supported by the SCP.

The Allow Media Splitting Attribute (2200,0007) shall be used by the SCP to determine if it is permitted to split this request over more than one piece of media.

Notes: 1. If the file-set size exceeds the media storage capacity, and this flag has been set to NO, the SCP shall refuse to process the request.

2. If the requested Media Application Profile allows for lossless compression, and images are not already compressed, such compression may be applied by the SCP in order to fit all instances on a single piece of media. This also applies to lossy compression if it has not been allowed by the value of Allow Lossy Compression (2200,000F).

S.3.2.1.1.7 Include Non-DICOM Objects

The SCP may or may not have the capability to include on the created media additional Non-DICOM objects (e.g., HTML files, JPEG images) that are a rendering of the DICOM instances. If it does, then the following SCP behavior shall apply and the specified attributes are required to be supported by the SCP.

The Include Non-DICOM Objects (2200,0008) shall be used to request the SCP to add additional Non-DICOM objects onto the created media.

An SCP is not required to be able to add such files. Inability to add Non-DICOM objects is not an error.

If Include Non-DICOM Objects (2200,0008) is set to NO, the SCP shall not include additional non-DICOM objects on the media.

S.3.2.1.1.8 Include Display Application

The SCP may or may not have the capability to include on the created media an application for displaying DICOM instances. If it does, then the following SCP behavior shall apply and the specified attributes are required to be supported by the SCP.

The Include Display Application (2200,0009) shall be used to request the SCP to add an application for displaying DICOM instances onto the created media.

An SCP is not required to be able to add such an application. Inability to add a display application is not an error.

Whether the display application is capable of displaying all stored instances is beyond the scope of the standard.

Whether the display application automatically executes when media is inserted for reading is beyond the scope of the standard.

Which platforms are supported by the display application(s) is beyond the scope of the standard.

Note: Multiple files may need to be included in the media to support the display application, rather than a single executable file, and these may be present, even if the Include Non-DICOM Objects (2200,0008) Attribute has a value of NO.

If Include Display Application (2200,0009) is set to NO, the SCP shall not include a display application on the media.

S.3.2.1.1.9 Allow Lossy Compression

If Allow Lossy Compression (2200,000F) has a value of YES, the SCP is allowed to perform lossy compression under the following circumstances:

If Allow Lossy Compression (2200,000F) has a value of YES but the requested profile does not permit lossy compression, lossy compression shall not be performed.

The level of compression is at the SCP’s discretion.

The SCP shall not decompress and recompress already lossy compressed images, but may use images that have already been lossy compressed.

The SCP is never required to perform lossy compression.

If Allow Lossy Compression (2200,000F) has a value of NO, the SCP is not allowed to perform lossy compression. If Allow Lossy Compression (2200,000F) has a value of NO and the requested profile requires lossy compression, an error shall be returned.

S.3.2.1.2 Service Class User Behavior

The SCU shall use the N-CREATE primitive to inform the SCP that a new media creation request has been placed and to convey the proprieties of this request. The request proprieties (e.g. the set of SOP Instances that the creating interchange media shall contain) are referenced in the IOD Attributes as specified in Table S.3.2.1.1-1.

Upon receipt of a successful N-CREATE Response Status Code from the SCP, the SCU now knows that the SCP has received the N-CREATE request and a new media creation request has been created.

Upon receipt of a failure N-CREATE Response Status Code from the SCP, the SCU now knows that the SCP will not process the request. The actions taken by the SCU upon receiving the status is beyond the scope of this Standard.

At any time after receipt of the N-CREATE-Response, the SCU may release the association on which it sent the N-CREATE-Request.

Notes: An N-GET of the corresponding of the Media Creation Management SOP Class may be performed on the same or subsequent associations.

S.3.2.1.3 Service Class Provider Behavior

Upon receipt of the N-CREATE request, the SCP shall return, via the N-CREATE response primitive, the N-CREATE Response Status Code applicable to the associated request. A success status conveys that the SCP has successfully received the N-CREATE request.

Warning statuses shall not be returned.

Any other status (i.e. a failure status) conveys that the SCP is not processing the media creation request.

Notes: 1. It is not specified by the Standard what checks the SCP shall accomplish after the N-CREATE request primitive reception and before returning the N-CREATE response. Implementations are discouraged from performing extended validation of the contents of the N-CREATE request, such as availability of the referenced Composite SOP Instances, support for the requested profiles, etc. In case of N-CREATE failure, the SCU would not be able to perform an N-GET to determine the detailed reasons for failure, and allow operators to apply suitable correction actions to make the request processable (e.g. resending any missing Composite SOP Instances). Such checks are better deferred until after receipt of the N-ACTION request, after which an N-GET may be performed.

2. The Standard does not require the SCP to queue multiple requests, though implementations are encouraged to do so. As a consequence, a new request before a previous request has been completed may fail immediately, or may return a successful response and be queued. The size of any such queue is beyond the scope of the Standard.

3. How long the instance of the Media Creation Management SOP Class persists once the Execution Status (2100,0020) has been set to IDLE is beyond the scope of the Standard.

The N-CREATE implicitly creates the Execution Status (2100,0020) and Execution Status Info (2100,0030) Attributes, which may subsequently be retrieved by an N-GET.

S.3.2.1.4 Status Codes.

The status values which are specific for this action are defined in Table S.3.2.2.4-1. See PS 3.7 for general response status codes.

Table S.3.2.2.4-1SOP CLASS STATUS VALUES

Status Meaning Code
Failure Refused because an Initiate Media Creation action has already been received for this SOP Instance. A510

S.3.2.2 Initiate Media Creation

The Initiate Media Creation operation allows an SCU to request an SCP to create Interchange Media according to an already created Media Creation Management SOP Instance. An SCP shall use this operation to schedule the creation of Interchange Media. This operation shall be invoked through the N-ACTION primitive.

S.3.2.2.1 Action Information

The DICOM AEs which claim conformance to this SOP Class as an SCU and/or an SCP shall support the Action Types and Action Information as specified in Table S.3.2.2.1-1.

Table S.3.2.2.1-1MEDIA CREATION REQUEST – ACTION INFORMATION

Action Type Name Action Type ID Attribute Tag Requirement Type SCU/SCP
Initiate Media Creation 1 Number of Copies (2000,0010) 3/1
Request Priority (2200,0020) 3/3 See Section S.3.2.2.1.1

S.3.2.2.1.1 Priority

The Request Priority (2200,0020), if present, may be used by the SCP to prioritize a higher priority request over other pending lower priority requests.

S.3.2.2.2 Service Class User Behavior

The SCU shall use the N-ACTION primitive to request the SCP to create Interchange Media according to an already created Media Creation Management SOP Instance. Action Information is specified in Table S. 3.2.2.1-1.

Upon receipt of a successful N-ACTION Response Status Code from the SCP, the SCU now knows that the SCP has received the N-ACTION Initiate Media Creation request and will process the request.

Upon receipt of a failure N-ACTION Response Status Code from the SCP, the SCU now knows that the SCP will not process the Initiate Media Creation request. The actions taken by the SCU upon receiving the status is beyond the scope of this Standard.

At any time after receipt of the N-ACTION-Response, the SCU may release the association on which it sent the N-ACTION-Request.

Notes: 1. An N-GET of the corresponding of the Media Creation Management SOP Class may be performed on the same or subsequent associations.

2. The duration for which the SOP Instance UID of an instance of the Media Creation Management SOP Class remains active once the request has been completed or has failed is implementation dependent, but should be sufficiently long to allow an SCU to determine the ultimate outcome of the request.

S.3.2.2.3 Service Class Provider Behavior

Upon receipt of the N-ACTION Initiate Media Creation request, the SCP shall return, via the N-ACTION response primitive, the N-ACTION Response Status Code applicable to the associated request. A success status conveys that the SCP has successfully scheduled the request.

Notes: 1. The extent of validation of the contents of the request, the availability of the referenced Composite SOP Instances, support for the requested profiles and other checks that may determine the ultimate success or failure of the request are not specified by the Standard. In particular, a request may be immediately accepted successfully, but subsequently fail for some reason, or the N-ACTION response primitive may contain a status that reflects a more thorough (and prolonged) check.

2. How long any Composite Instances that have been transferred via the Storage Service Class to the SCP for the purpose of a Media Creation Request persist, is beyond the scope of the Standard. The Preserve Composite Instances After Media Creation (2200,000A) flag is provided as a hint only. Even if this flag is set, a subsequent request referencing some or all of the same instances may fail if the SCP had reason to flush its cache of instances in the interim, and the SCU may need to be prepared to re-send them.

3. How long the instance of the Media Creation Management SOP Class persists once the Execution Status (2100,0020) has been set to DONE or FAILED is beyond the scope of the Standard.

The N-ACTION implicitly creates or updates the Execution Status (2100,0020), Execution Status Info (2100,0030), Total Number of Pieces of Media Created (2200,000B), Failed SOP Sequence (0008,1198) and Referenced Storage Media Sequence (2200,000D) Attributes, which may subsequently be retrieved by an N-GET.

S.3.2.2.4 Status Codes

There are no specific status codes. See PS 3.7 for response status codes.

S.3.2.3 Cancel Media Creation

The Cancel Media Creation operation allows an SCU to request an SCP to cancel a media creation request, whether or not it has begun to be processed. This operation shall be invoked through the N-ACTION primitive.

S.3.2.3.1 Action Information

The DICOM AEs that claim conformance to this SOP Class as an SCU and/or an SCP shall support the Action Types and Action Information as specified in Table S.3.2.3.1-1.

Table S.3.2.3.1-1MEDIA CREATION REQUEST – ACTION INFORMATION

Action Type Name Action Type ID Attribute Tag Requirement Type SCU/SCP
Cancel Media Creation 2

S.3.2.3.2 Service Class User Behavior

The SCU shall use the N-ACTION primitive to request the SCP to cancel the media creation request corresponding to the Affected SOP Instance UID in the N-ACTION request primitive, whether or not it has been initiated with an N-ACTION Initiate Media Creation request, and whether or not it has begun to be processed (i.e. is pending or in progress).

Upon receipt of a successful N-ACTION Response Status Code from the SCP, the SCU knows that the SCP has received the N-ACTION Cancel Media Creation request, has cancelled any pending or in progress media creation, and deleted the Media Creation Management SOP Instance.

Note: Successful cancellation implies that a subsequent N-GET of the corresponding Media Creation Management SOP Instance would fail.

Upon receipt of a failure N-ACTION Response Status Code from the SCP, the SCU knows that the SCP will not process the Cancel Media Creation request. The actions taken by the SCU upon receiving the status is beyond the scope of this Standard.

Note: Cancellation failure implies that media creation has already completed (successfully or not), or will proceed. The status of the media creation request may still be obtained with an N-GET, unless the reason for failure was that the SOP Instance did not exist.

S.3.2.3.3 Service Class Provider Behavior

Upon receipt of the N-ACTION Cancel Media Creation request, the SCP shall return, via the N-ACTION response primitive, the N-ACTION Response Status Code applicable to the associated request. A success status conveys that the SCP has successfully cancelled the request.

A failure status conveys that the SCP has failed to cancel the request, in which case the Execution Status (2100,0020), Execution Status Info (2100,0030), Total Number of Pieces of Media Created (2200,000B), Failed SOP Sequence (0008,1198) and Referenced Storage Media Sequence (2200,000D) Attributes may subsequently be retrieved by an N-GET.

S.3.2.3.4 Status Codes

The status values that are specific for this SOP Class and DIMSE Service are defined in Table S.3.2.3.4-1.See PS 3.7 for general response status codes.

Table S.3.2.3.4-1 RESPONSE STATUSES

Service Status Further Meaning Response Status Codes
Failure Media creation request already completed. C201H
Media creation request already in progress and cannot be interrupted. C202H
Cancellation denied for unspecified reason. C203H

S.3.2.4 Get Media Creation Result

The Get Media Creation Result operation allows an SCU to request of an SCP the status of a media creation request. This operation shall be invoked through the N-GET primitive used in conjunction with the appropriate Media Creation Management SOP Instance corresponding to the creation request.

S.3.2.4.1 Attributes

The Application Entity which claims conformance to this SOP Class as an SCU may choose to interpret the Attributes maintained by the SCP which the SCU receives via the operations of the SOP Class. The Application Entity that claims conformance as an SCP to this SOP Class shall support the Attributes specified in Table S.3.2.4.1-1.

Table S.3.2.4.1-1 MEDIA CREATION MANAGEMENT SOP CLASS N-GET ATTRIBUTES

Attribute Name Tag Requirement Type (SCU/SCP)
Specific Character Set (0008,0005) 3/1C (Required if expanded or replacement character set is used)
Execution Status (2100,0020) 3/1
Execution Status Info (2100,0030) 3/1
Total Number of Pieces of Media Created (2200,000B) 3/1
Failed SOP Sequence (0008,1198) 3/2
Referenced Storage Media Sequence (2200,000D) 3/2
All Other Attributes of the Media Creation Management Module 3/3

S.3.2.4.2 Service Class User

The SCU shall specify in the N-GET request primitive the UID of the Media Creation Management SOP Instance for which Attribute Values are to be returned. The SCU shall be permitted to request that Attribute Values be returned for any Media Creation Management SOP Class Attribute specified in Section S.3.2.1.1. Additionally, values may be requested for optional Media Creation Management Module Attributes.

The SCU shall specify the list of Media Creation Management SOP Class Attributes for which the Attribute Values are to be returned. The encoding rules for this list are specified in the N-GET request primitive specified in PS 3.7.

In an N-GET operation, Sequence Attributes can only be requested in their entirety, and only the top level Sequence Attribute can be included in the request.

The SCU shall be capable of receiving all requested Attribute Values provided by the SCP in response to the N-GET indication primitive. The SCU may request Attribute values for optional Attributes that are not maintained by the SCP. In such a case the SCU shall function properly regardless of whether the SCP returns values for those Attributes or not. This Service Class Specification places no requirements on what the SCU shall do as a result of receiving this information.

Note: In order to interpret accurately the character set used for Attribute values returned, it is recommended that the Attribute value for Specific Character Set (0008,0005) be requested in the N-GET request primitive.

S.3.2.4.3 Service Class Provider

This operation allows the SCU to request from the SCP, selected Attribute Values for a specific Media Creation Management SOP Instance. This operation shall be invoked through the use of the DIMSE N-GET Service used in conjunction with the appropriate Media Creation Management SOP Instance.

The SCP shall return, via the N-GET response primitive, the N-GET Response Status Code applicable to the associated request. Contingent on the N-GET Response Status, the SCP shall return, via the N-GET Response Primitive, Attribute Values for all requested Attributes maintained by the SCP (see Table S.3.2.4.1-1). The SCP shall not return Data Elements for optional Attributes that are not maintained by the SCP.

The SCP shall return the entire content of a Sequence if a Sequence Attribute is requested.

S.3.2.4.4 Status Codes

The status values that are specific for this SOP Class and DIMSE Service are defined in Table S.3.2.4.4-1.

See PS 3.7 for response status codes.

Table S. 3.2.4.4-1 RESPONSE STATUSES

Service Status Further Meaning Response Status Codes
Warning Requested optional Attributes are not supported 0001