DICOM PS3.3 2019b - Information Object Definitions

10.3 Image SOP Instance Reference Macro (Current)
Prev | 10 Miscellaneous Macros | Next

## 10.3 Image SOP Instance Reference Macro

Table 10-3. Image SOP Instance Reference Macro Attributes

Attribute Name | Tag | Type | Attribute Description
--- | --- | --- | ---
Include Table 10-11 “SOP Instance Reference Macro Attributes” |
Referenced Frame Number | (0008,1160) | 1C | Identifies the frame numbers within the Referenced SOP Instance to which the reference applies. The first frame shall be denoted as frame number 1. ### Note This Attribute may be multi-valued. Required if the Referenced SOP Instance is a multi-frame image and the reference does not apply to all frames, and Referenced Segment Number (0062,000B) is not present.
Referenced Segment Number | (0062,000B) | 1C | Identifies the Segment Number to which the reference applies. Required if the Referenced SOP Instance is a Segmentation or Surface Segmentation and the reference does not apply to all segments and Referenced Frame Number (0008,1160) is not present.

Table 10-3b “Referenced Instances and Access Macro Attributes” contains identifiers and access details for a collection of instances. It is intended to provide sufficient information to retrieve the referenced instances.

Table 10-3b. Referenced Instances and Access Macro Attributes

Attribute Name | Tag | Type | Attribute Description
--- | --- | --- | ---
Type of Instances | (0040,E020) | 1 | Type of object instances referenced. Defined Terms: DICOM CDA
Study Instance UID | (0020,000D) | 1C | Unique identifier for the Study. Required if Type of Instances (0040,E020) is DICOM and the Information Model of the referenced instance contains the Study IE
Series Instance UID | (0020,000E) | 1C | Unique identifier for the Series that is part of the Study identified in Study Instance UID (0020,000D), if present, and contains the referenced object instance(s). Required if Type of Instances (0040,E020) is DICOM and the Information Model of the referenced instance contains the Series IE
Referenced SOP Sequence | (0008,1199) | 1 | References to object instances. One or more Items shall be included in this Sequence
>Referenced SOP Class UID | (0008,1150) | 1 | Uniquely identifies the referenced SOP Class.
>Referenced SOP Instance UID | (0008,1155) | 1 | Uniquely identifies the referenced SOP Instance.
>HL7 Instance Identifier | (0040,E001) | 1C | Instance Identifier of the encapsulated HL7 Structured Document, encoded as a UID (OID or UUID), concatenated with a caret ("^") and Extension value (if Extension is present in Instance Identifier). Required if Type of Instances (0040,E020) is CDA.
>Referenced Frame Number | (0008,1160) | 1C | Identifies the frame numbers within the Referenced SOP Instance to which the reference applies. The first frame shall be denoted as frame number 1. ### Note This Attribute may be multi-valued. Required if the Referenced SOP Instance is a multi-frame image and the reference does not apply to all frames, and Referenced Segment Number (0062,000B) is not present.
>Referenced Segment Number | (0062,000B) | 1C | Identifies the Segment Number to which the reference applies. Required if the Referenced SOP Instance is a Segmentation and the reference does not apply to all segments and Referenced Frame Number (0008,1160) is not present.
DICOM Retrieval Sequence | (0040,E021) | 1C | Details for retrieving instances via the DICOM Retrieve Service. Required if DICOM Media Retrieval Sequence (0040,E022), WADO Retrieval Sequence (0040,E023), WADO-RS Retrieval Sequence (0040,E025) and XDS Retrieval Sequence (0040,E024) are not present. May be present otherwise. This Sequence shall only identify sources known to have instances referenced in Referenced SOP Sequence (0008,1199). One or more Items shall be included in this Sequence.
>Retrieve AE Title | (0008,0054) | 1 | Title of a DICOM Application Entity where the referenced instance(s) may be retrieved on the network.
DICOM Media Retrieval Sequence | (0040,E022) | 1C | Details for retrieving instances from Media. Required if DICOM Retrieval Sequence (0040,E021), WADO Retrieval Sequence (0040,E023), and WADO-RS Retrieval Sequence (0040,E025) and XDS Retrieval Sequence (0040,E024) are not present. May be present otherwise. This Sequence shall only identify media known to have instances referenced in Referenced SOP Sequence (0008,1199). One or more Items shall be included in this Sequence.
>Storage Media File-Set ID | (0088,0130) | 2 | The user or implementation specific human readable identifier that identifies the Storage Media on which the referenced instance(s) reside.
>Storage Media File-Set UID | (0088,0140) | 1 | Uniquely identifies the Storage Media on which the referenced instance(s) reside.
WADO Retrieval Sequence | (0040,E023) | 1C | Details for retrieving instances available via WADO-URI. ### Note This Sequence addresses use of the URI-based Web Access to DICOM Objects. Retrieval via the IHE XDS-I.b RAD-69 Transaction is addressed in the XDS Retrieval Sequence (0040,E024). Required if DICOM Retrieval Sequence (0040,E021), DICOM Media Retrieval Sequence (0040,E022), WADO-RS Retrieval Sequence (0040,E025) and XDS Retrieval Sequence (0040,E024) are not present. May be present otherwise. One or more Items shall be included in this Sequence.
>Retrieve URI | (0040,E010) | 1 | URI/URL specifying the location of the referenced instance(s). Includes fully specified scheme, authority, path, and query in accordance with [RFC3986]. ### Note The VR of this Data Element has changed from UT to UR.
XDS Retrieval Sequence | (0040,E024) | 1C | Details for retrieving instances using the IHE XDS-I.b RAD-69 Transaction. ### Note Retrieval via WADO-URI is addressed by the WADO Retrieval Sequence (0040,E023). Retrieval via WADO-RS is addressed by the WADO-RS Retrieval Sequence (0040,E025). Required if DICOM Retrieval Sequence (0040,E021), DICOM Media Retrieval Sequence (0040,E022), WADO-RS Retrieval Sequence (0040,E025) and WADO Retrieval Sequence (0040,E023) are not present. May be present otherwise. This Sequence shall only identify repositories known to have instances referenced in Referenced SOP Sequence (0008,1199). One or more Items shall be included in this Sequence.
>Repository Unique ID | (0040,E030) | 1 | Uniquely identifies a Repository from which the referenced instances can be retrieved.
>Home Community ID | (0040,E031) | 3 | Uniquely identifies a Community to which requests for the referenced instances can be directed.
WADO-RS Retrieval Sequence | (0040,E025) | 1C | Details for retrieving instances via WADO-RS. ### Note Retrieval via WADO-URI is addressed in the WADO Retrieval Sequence (0040,E023). Retrieval via the IHE XDS-I.b RAD-69 Transaction is addressed in the XDS Retrieval Sequence (0040,E024). Required if DICOM Retrieval Sequence (0040,E021), DICOM Media Retrieval Sequence (0040,E022), WADO Retrieval Sequence (0040,E023) and XDS Retrieval Sequence (0040,E024) are not present. May be present otherwise. One or more Items shall be included in this Sequence.
>Retrieve URL | (0008,1190) | 1 | URL specifying the location of the referenced instance(s).

Table 10-3c “Storage Macro Attributes” contains details for where and how to store instances. It is intended to provide sufficient information to store instances to the correct location.

This Macro mirrors Table 10-3b “Referenced Instances and Access Macro Attributes”.

Table 10-3c. Storage Macro Attributes

Attribute Name | Tag | Type | Attribute Description
--- | --- | --- | ---
Referenced SOP Class UID | (0008,1150) | 1C | Uniquely identifies the referenced SOP Class. Required if the storage request only applies to a specific SOP Class.
DICOM Storage Sequence | (0040,4071) | 1C | Details for storing instances via the DICOM Storage Service. Required if STOW-RS Storage Sequence (0040,4072) or XDS Storage Sequence (0040,4074) is not present. May be present otherwise. One or more Items shall be included in this Sequence.
>Destination AE | (2100,0140) | 1 | Title of a DICOM Application Entity to which instances will be stored.
STOW-RS Storage Sequence | (0040,4072) | 1C | Details for storing instances via STOW-RS. Required if DICOM Storage Sequence (0040,4071) and XDS Storage Sequence (0040,4074) are not present. May be present otherwise. One or more Items shall be included in this Sequence.
>Storage URL | (0040,4073) | 1 | URI/URL specifying the location of the STOW-RS storage service to which instances will be stored. The value shall be a fully specified URI with protocol, authority and path, in accordance with [RFC3986] and Section 10.5 “Store Transaction” in PS3.18.
XDS Storage Sequence | (0040,4074) | 1C | Details for storing instances via the IHE Provide and Register Document Set-b (ITI-41) transaction [IHE ITI-TF 2.b]. Required if STOW-RS Storage Sequence (0040,4072) and DICOM Storage Sequence (0040,4071) are not present. May be present otherwise. One or more Items shall be included in this Sequence.
>Repository Unique ID | (0040,E030) | 1 | Uniquely identifies a Repository from which the referenced instances can be retrieved.
>Home Community ID | (0040,E031) | 3 | Uniquely identifies a Community to which requests for the referenced instances can be directed.

Prev | Up | Next
10.2 Content Item Macro | Home | 10.4 Series and Instance Reference Macro

DICOM PS3.3 2019b - Information Object Definitions