DICOM PS3.3 2022c - Information Object Definitions

C.38 Inventory Modules

C.38.1 Inventory Module

The Attributes of the Inventory Module are shown in Table C.38.1-1.

The Attributes of the Information Entities of the Inventory Information Model (such as Study, Series, Patient, etc. - see Section 7.13.6) are hierarchically encoded within Sequence Attributes in the Inventory Module.

Table C.38.1-1. Inventory Module Attributes

Attribute Name

Tag

Type

Attribute Description

Content Date

(0008,0023)

1

With Content Time (0008,0033), time point at which the Inventory creation began. See Section C.38.1.1.1.

Content Time

(0008,0033)

1

With Content Date (0008,0023), time point at which the Inventory creation began. See Section C.38.1.1.1.

Include Table C.38.2-1 “Scope of Inventory Macro Attributes”

Selection parameters for the studies that are included in the inventory. See Section C.38.1.1.2.

Transaction UID

(0008,1195)

1C

UID of the transaction that initiated creation of this Inventory SOP Instance.

Required if Inventory creation was initiated by a transaction of the Inventory Creation SOP Class. May be present otherwise to identify a local user-initiated or system-initiated Inventory creation.

Inventory Purpose

(0008,0401)

2

Purpose for which the inventory was created.

Inventory Instance Description

(0008,0402)

3

Description of the content of this Inventory SOP Instance, such as limitation of the scope of this Instance within the Scope of Inventory.

Inventory Level

(0008,0403)

1

Information Entity level for records included in Inventory.

Enumerated Values:

STUDY

Study records only

SERIES

Study and Series records only

INSTANCE

Study, Series, and Instance records

Inventory Completion Status

(0008,0426)

1

Degree of completion of Inventory with respect to the defined Scope of Inventory. See Section C.38.1.1.3.

Number of Study Records in Instance

(0008,0427)

1

Number of Items in the Inventoried Studies Sequence (0008,0423) in this SOP Instance.

Total Number of Study Records

(0008,0428)

1

Total number of Items in the Inventoried Studies Sequence (0008,0423) in this SOP Instance and in SOP Instances referenced in the Incorporated Inventory Instance Sequence (0008,0422).

Note

A Study that appears multiple times among the Inventoried Studies Sequence (0008,0423) Items will be counted for each appearance.

Inventory Access End Points Sequence

(0008,0420)

3

Baseline end point(s) for network protocols to access incorporated Inventory SOP Instances. See Section C.38.1.1.4.

Only a single Item is permitted in this Sequence.

>Include Table C.38.2-4 “Access End Points Macro Attributes”

Study Access End Points Sequence

(0008,0421)

3

Baseline end point(s) for network protocols to access inventoried Study-related SOP Instances. See Section C.38.1.1.4.

Only a single Item is permitted in this Sequence.

>Include Table C.38.2-4 “Access End Points Macro Attributes”

Incorporated Inventory Instance Sequence

(0008,0422)

2

Inventory SOP Instances whose content is included by reference. See Section C.38.1.1.5.

Zero or more Items shall be included in this Sequence.

>Include Table C.38.2-3 “Inventory Reference Macro Attributes”

Inventoried Studies Sequence

(0008,0423)

2

Records of Studies whose Attribute values match the Scope of Inventory. See Section C.38.1.1.6.

Zero or more Items shall be included in this Sequence.

>Specific Character Set

(0008,0005)

1C

Character Set that expands or replaces the Basic Graphic Set for this Item.

Required if an extended or replacement character set, other than those specified in the top level Data Set of the Inventory, is used in the Study level Attributes. May be present otherwise.

>Study Instance UID

(0020,000D)

1

Unique identifier for the inventoried Study.

>Modalities in Study

(0008,0061)

2

All of the distinct values used for Modality (0008,0060) in the Series of the Study.

>Item Inventory DateTime

(0008,0404)

1

DateTime of creation of the Inventory information for this Item. All Study Attributes in this Sequence Item are correct as of this DateTime. The value shall be at or after the Content Date (0008,0023) and Content Time (0008,0033) of this Inventory SOP Instance.

Note

This Attribute may be used for Study record reconciliation. See Section YYYY.7.10 in PS3.17.

>Removed from Operational Use

(0008,0405)

1C

Flag that this Study is not to be used for operational purposes. See Section C.38.1.2.2.

Enumerated Values:

Y

Removed from use

N

Not removed from use

Required if this Study is not to be used for operational purposes. May be present otherwise.

>Reason for Removal Code Sequence

(0008,0406)

2C

Reason the Study was removed from operational use.

Required if Removed from Operational Use (0008,0405) value is Y.

Zero or one Item shall be included in this Sequence.

>>Include Table 8.8-1 “Code Sequence Macro Attributes”

Defined Context Group DCID 7031 Reason for Removal from Operational Use.

>Number of Study Related Series

(0020,1206)

2

Count of stored Series in Study. See Section C.38.1.2.3.

>Number of Study Related Instances

(0020,1208)

2

Count of stored SOP Instances in Study. See Section C.38.1.2.3.

>Study Update DateTime

(0008,041F)

2

DateTime of last update to Study instances or metadata managed in the storage system. See Section C.38.1.2.1.

>Study ID

(0020,0010)

2

User or equipment generated Study identifier.

>Study Date

(0008,0020)

2

Date the Study started.

>Study Time

(0008,0030)

2

Time the Study started.

>Study Description

(0008,1030)

2

Description or classification of the Study performed.

>Anatomic Regions in Study Code Sequence

(0008,0063)

3

Anatomic regions and body parts examined in the study. See Section C.38.1.2.4.

One or more Items are permitted in this Sequence.

>>Include Table 8.8-1 “Code Sequence Macro Attributes”

>Procedure Code Sequence

(0008,1032)

3

Type of procedure performed.

One or more Items are permitted in this Sequence.

>>Include Table 8.8-1 “Code Sequence Macro Attributes”

>Name of Physician(s) Reading Study

(0008,1060)

3

Names of the physician(s) reading the Study.

>Physician(s) Reading Study Identification Sequence

(0008,1062)

3

Identification of the physician(s) reading the Study.

One or more Items are permitted in this Sequence. If more than one Item, the number and order shall correspond to the value of Name of Physician(s) Reading Study (0008,1060), if present.

>>Include Table 10-1 “Person Identification Macro Attributes”

>Consulting Physician's Name

(0008,009C)

3

Consulting physician(s) for this Patient Visit.

>Consulting Physician Identification Sequence

(0008,009D)

3

Identification of the consulting physician(s).

One or more Items are permitted in this Sequence. If more than one Item, the number and order shall correspond to the value of Consulting Physician's Name (0008,009C), if present.

>>Include Table 10-1 “Person Identification Macro Attributes”

>Physician(s) of Record

(0008,1048)

3

Names of the physician(s) who are responsible for overall Patient care at time of Study.

>Physician(s) of Record Identification Sequence

(0008,1049)

3

Identification of the physician(s) who are responsible for overall Patient care at time of Study.

One or more Items are permitted in this Sequence. If more than one Item, the number and order shall correspond to the value of Physician(s) of Record (0008,1048), if present.

>>Include Table 10-1 “Person Identification Macro Attributes”

>Include Table C.12.1.1.9-1 “Original Attributes Macro Attributes”

Recording of prior Attribute values and provenance of metadata changes at the Study level. See Section C.38.1.2.5.

>Retrieve AE Title

(0008,0054)

1C

AE Title from which this Study may be retrieved.

Required if Study SOP Instances may be retrieved using a C-MOVE or C-GET based SOP Class (see PS3.4) and Study Access End Points Sequence (0008,0421) does not include Retrieve AE Title (0008,0054). May be present otherwise.

>Retrieve URL

(0008,1190)

1C

Base URI of the origin server to retrieve Study data through the Studies Service (see Section 10 “Studies Service and Resources” in PS3.18).

Required if Study SOP Instances may be retrieved using the web-based Studies Service (see PS3.18) and Study Access End Points Sequence (0008,0421) does not include Retrieve URL (0008,1190). May be present otherwise.

>Stored Instance Base URI

(0008,0407)

3

Base URI for accessing Study SOP Instances through a non-DICOM protocol. See Section C.38.1.2.6.

>Instance Availability

(0008,0056)

3

Specifies how rapidly the Study becomes available for transmission after a retrieval request. See Section C.38.1.2.9.

>File Set Access Sequence

(0008,0419)

3

Non-DICOM protocol methods to access the set of stored SOP Instances comprising the Study.

Note

"File Set" as used here may not be identical to the File-set concept defined in PS3.10 and used in Storage Media File-set ID (0088,0130).

Only a single Item is permitted in this Sequence.

>>Folder Access URI

(0008,0408)

3

Access URI for a folder containing all SOP Instances for this Study. See Section C.38.1.2.7.

>>File Access URI

(0008,0409)

3

Access URI for a container file containing all SOP Instances for this Study. See Section C.38.1.2.7.

>>Container File Type

(0008,040A)

1C

Type of container file. See Section C.38.1.2.8 for Defined Terms.

Required if File Access URI (0008,0409) is present.

>Storage Media File-set ID

(0088,0130)

3

A human readable Identifier that identifies the Storage Media on which the Study resides.

>Accession Number

(0008,0050)

2

A number that identifies the order for the Study.

>Issuer of Accession Number Sequence

(0008,0051)

3

Identifier of the Assigning Authority that issued the Accession Number (0008,0050).

Only a single Item is permitted in this Sequence.

>>Include Table 10-17 “HL7v2 Hierarchic Designator Macro Attributes”

>Referring Physician's Name

(0008,0090)

3

Name of the Patient's referring physician.

>Referring Physician Identification Sequence

(0008,0096)

3

Identification of the Patient's referring physician.

Only a single Item is permitted in this Sequence.

>>Include Table 10-1 “Person Identification Macro Attributes”

>Patient's Name

(0010,0010)

2

Patient's full name.

>Patient ID

(0010,0020)

2

Primary identifier for the Patient.

>Include Table 10-18 “Issuer of Patient ID Macro Attributes”

Identifier of the Assigning Authority that issued the Patient ID (0010,0020).

>Other Patient IDs Sequence

(0010,1002)

3

Identification numbers or codes used to identify the Patient.

One or more Items are permitted in this Sequence.

>>Patient ID

(0010,0020)

2

An identifier for the Patient.

>>Include Table 10-18 “Issuer of Patient ID Macro Attributes”

Identifier of the Assigning Authority that issued the Patient ID (0010,0020).

>Patient's Birth Date

(0010,0030)

2

Birth date of the Patient.

>Patient's Sex

(0010,0040)

2

Sex of the named Patient.

>Other Patient Names

(0010,1001)

3

Other names used to identify the Patient.

>Inventoried Series Sequence

(0008,0424)

2C

Records of Series whose Study and Series Attribute values match the Scope of Inventory.

See Section C.38.2.1.1.2 for conditions with RELATIONAL matching for Scope of Inventory in which only matching Series will be included in the Inventory.

Required if Inventory Level (0008,0403) has value SERIES or INSTANCE.

Zero or more Items shall be included in this Sequence.

>>Specific Character Set

(0008,0005)

1C

Character Set that expands or replaces the Basic Graphic Set for this Item.

Required if an extended or replacement character set, other than those specified or implied for the Study level Attributes, is used in the Series level Attributes. May be present otherwise.

>>Series Instance UID

(0020,000E)

1

Unique identifier of the inventoried Series.

>>Modality

(0008,0060)

1

Type of device, process or method that originally acquired or produced the data used to create the Instances in this Series.

>>Removed from Operational Use

(0008,0405)

1C

Flag that this Series is not to be used for operational purposes. See Section C.38.1.2.2.

Enumerated Values:

Y

Removed from use

N

Not removed from use

Required if this Series is not to be used for operational purposes, and Removed from Operational Use (0008,0405) Attribute at Study level does not have the value Y. May be present otherwise.

>>Reason for Removal Code Sequence

(0008,0406)

2C

Reason the Series was removed from operational use.

Required if Removed from Operational Use (0008,0405) value is Y.

Zero or one Item shall be included in this Sequence.

>>>Include Table 8.8-1 “Code Sequence Macro Attributes”

Defined Context Group DCID 7031 Reason for Removal from Operational Use.

>>Series Number

(0020,0011)

2

A number that identifies this Series.

>>Series Description

(0008,103E)

3

Description of the Series.

>>Series Date

(0008,0021)

3

Date the Series started.

>>Series Time

(0008,0031)

3

Time the Series started.

>>Body Part Examined

(0018,0015)

3

Identification of the part of the body examined. See Section C.38.1.3.2.

>>Laterality

(0020,0060)

3

Laterality of (paired) body part examined.

>>Request Attributes Sequence

(0040,0275)

3

Attributes from the Imaging Service Request. See Section C.38.1.3.3.

One or more Items are permitted in this Sequence.

>>>Include Table 10-9 “Request Attributes Macro Attributes”

>>Include Table C.12.1.1.9-1 “Original Attributes Macro Attributes”

Recording of prior Attribute values and provenance of metadata changes at the Series level. See Section C.38.1.2.5.

>>Stored Instance Base URI

(0008,0407)

3

Base URI for accessing SOP Instances within this Series through a non-DICOM protocol. See Section C.38.1.2.6.

>>Instance Availability

(0008,0056)

3

Specifies how rapidly the Series becomes available for transmission after a retrieval request. See Section C.38.1.2.9.

>>File Set Access Sequence

(0008,0419)

3

Non-DICOM protocol methods to access the set of stored SOP Instances comprising this Series.

Note

"File Set" as used here may not be identical to the File-set concept defined in PS3.10 and used in Storage Media File-set ID (0088,0130).

Only a single Item is permitted in this Sequence.

>>>Folder Access URI

(0008,0408)

3

Access URI for a folder containing all SOP Instances for the Series. See Section C.38.1.3.1.

>>>File Access URI

(0008,0409)

3

Access URI for a container file containing all SOP Instances for the Series. See Section C.38.1.3.1.

>>>Container File Type

(0008,040A)

1C

Type of container file. See Section C.38.1.2.8 for Defined Terms.

Required if File Access URI (0008,0409) is present.

>>Storage Media File-set ID

(0088,0130)

3

A human readable Identifier that identifies the Storage Media on which the Series resides.

>>Inventoried Instances Sequence

(0008,0425)

2C

Records of SOP Instances whose Study, Series and Instance Attribute values match the Scope of Inventory.

See Section C.38.2.1.1.2 for conditions with RELATIONAL matching for Scope of Inventory in which only matching SOP Instances will be included in the Inventory.

Required if Inventory Level (0008,0403) has value INSTANCE.

Zero or more Items shall be included in this Sequence.

>>>Specific Character Set

(0008,0005)

1C

Character Set that expands or replaces the Basic Graphic Set for this Item.

Required if an extended or replacement character set, other than those specified or implied for the Series level Attributes, is used in the Instance level Attributes. May be present otherwise.

>>>SOP Class UID

(0008,0016)

1

SOP Class UID of the inventoried SOP Instance.

>>>SOP Instance UID

(0008,0018)

1

SOP Instance UID of the inventoried SOP Instance.

>>>Instance Number

(0020,0013)

2

A number that identifies the inventoried SOP Instance.

>>>Related General SOP Class UID

(0008,001A)

3

Uniquely identifies a Related General SOP Class for the SOP Class of the inventoried Instance.

>>>Content Date

(0008,0023)

3

The date that creation of the content of the inventoried SOP Instance started.

>>>Content Time

(0008,0033)

3

The time that creation of the content of the inventoried SOP Instance started.

>>>Timezone Offset From UTC

(0008,0201)

3

Offset from UTC to the timezone for all DA and TM Attributes present in the inventoried Instance, and for all DT Attributes present in the inventoried Instance that do not contain an explicitly encoded timezone offset.

See Section C.12.1.1.8.

>>>Rows

(0028,0010)

3

Number of pixel matrix rows in the inventoried Image SOP Instance.

>>>Columns

(0028,0011)

3

Number of pixel matrix columns in the inventoried Image SOP Instance.

>>>Number of Frames

(0028,0008)

3

Number of frames in the inventoried Image SOP Instance.

>>>Bits Allocated

(0028,0100)

3

Number of bits allocated for each pixel sample in the inventoried Image SOP Instance.

>>>Observation DateTime

(0040,A032)

3

The date and time at which the root Content Item of the inventoried Document SOP Instance was completed.

>>>Concept Name Code Sequence

(0040,A043)

3

A coded description of the content or type of the inventoried SOP Instance.

Only a single Item is permitted in this Sequence.

>>>>Include Table 8.8-1 “Code Sequence Macro Attributes”

No baseline CID is defined.

>>>Content Template Sequence

(0040,A504)

3

Attributes of the Template that describes the content structure and constraints for the inventoried Document SOP Instance.

Only a single Item is permitted in this Sequence.

>>>>Template Identifier

(0040,DB00)

1

Identifier of the Template as defined by the Mapping Resource (0008.0105).

>>>>Mapping Resource

(0008,0105)

1

Resource that defines the Template.

>>>Referenced Request Sequence

(0040,A370)

3

Requested Procedures that were fulfilled (completely or partially) by the inventoried Document SOP Instance.

One or more Items are permitted in this Sequence.

>>>>Include Table C.17-3c “Referenced Request Macro Attributes”

>>>Container Identifier

(0040,0512)

3

Identifier for the physical container that contains the specimen(s) imaged in the inventoried SOP Instance. See Section C.7.6.22.1.1.

Note

Not to be confused with a container file as described in Section P.1.2.

>>>Specimen Description Sequence

(0040,0560)

3

Identifiers for the specimen(s) imaged in the inventoried SOP Instance. See Section C.7.6.22.1.1.

One or more Items are permitted in this Sequence.

>>>>Specimen Identifier

(0040,0551)

1

A departmental information system identifier for the Specimen.

>>>>Specimen UID

(0040,0554)

1

Unique Identifier for Specimen.

>>>Content Label

(0070,0080)

3

A label that is used to identify the inventoried SOP Instance.

>>>Content Description

(0070,0081)

3

A description of the content of the inventoried SOP Instance.

>>>Presentation Creation Date

(0070,0082)

3

Date on which the inventoried Presentation State SOP Instance was created.

>>>Presentation Creation Time

(0070,0083)

3

Time at which the inventoried Presentation State SOP Instance was created.

>>>Content Creator's Name

(0070,0084)

3

Name of operator who created the content of the inventoried SOP Instance.

>>>Removed from Operational Use

(0008,0405)

1C

Flag that the inventoried SOP Instance is not to be used for operational purposes. See Section C.38.1.2.2.

Enumerated Values:

Y

Removed from use

N

Not removed from use

Required if this SOP Instance is not to be used for operational purposes, and Removed from Operational Use (0008,0405) Attribute at Study or Series level does not have the value Y. May be present otherwise.

>>>Reason for Removal Code Sequence

(0008,0406)

2C

Reason the SOP Instance was removed from operational use.

Required if Removed from Operational Use (0008,0405) value is Y.

Zero or one Item shall be included in this Sequence.

>>>>Include Table 8.8-1 “Code Sequence Macro Attributes”

DCID 7031 “Reason for Removal from Operational Use”

>>>Include Table C.12.1.1.9-1 “Original Attributes Macro Attributes”

Recording of prior Attribute values and provenance of metadata changes at the Instance level. See Section C.38.1.2.5.

>>>Instance Availability

(0008,0056)

3

Specifies how rapidly the Instance becomes available for transmission after a retrieval request. See Section C.38.1.2.9.

>>>File Access Sequence

(0008,041A)

3

Non-DICOM protocol methods to access the SOP Instance in the DICOM File Format. See Section C.38.1.4.2 and Section C.38.1.4.3.

One or more Items are permitted in this Sequence.

>>>>Include Table C.38.2-2 “Stored File Access Macro Attributes”

>>>>Expiration DateTime

(0008,0416)

3

The date and time until which the SOP Instance is expected to be available and after which SOP Instance is expected to be unavailable via this non-DICOM protocol URI. See Section C.38.1.4.4.

>>>Storage Media File-set ID

(0088,0130)

3

A human readable Identifier that identifies the Storage Media on which the Instance resides.

>>>Alternate Representation Sequence

(0008,3001)

3

Reference to an alternate encoding of the inventoried SOP Instance. See Section C.38.1.4.5.

One or more Items are permitted in this Sequence.

>>>>Series Instance UID

(0020,000E)

1C

Unique identifier of the Series of the alternate representation.

Required if the alternate representation is in a different Series than the inventoried SOP Instance.

>>>>SOP Class UID

(0008,0016)

1

SOP Class UID of the alternate representation SOP Instance.

>>>>SOP Instance UID

(0008,0018)

1

SOP Instance UID of the alternate representation SOP Instance.

>>>>Purpose of Reference Code Sequence

(0040,A170)

1

The nature of the alternate encoding.

One Item shall be included in this Sequence.

>>>>>Include Table 8.8-1 “Code Sequence Macro Attributes”

BCID 7205 “Purpose of Reference to Alternate Representation”


C.38.1.1 Inventory Instance Attributes

C.38.1.1.1 Content Date and Content Time

Content Date (0008,0023) and Content Time (0008,0033) establish thetime point at which began the creation of the Inventory for which this SOP Instance is the root. Conceptually, all Studies received by the storage system before this DateTime, and that match the specified Scope of Inventory key Attributes, are included in the Inventory, and all Patient and Study updates through this DateTime have been applied to the Attributes as recorded in the Inventory SOP Instance(s).

While Content Date and Time specify the nominal time for creation of the Inventory, each Study record has its own Item Inventory DateTime (0008,0404) that specifies the time of creation of that record, and its Attribute values are accurate as of that time.

Whether Studies and updates received after Content Date and Timemight be included in the Inventory is implementation specific.

The Content Date and Time of SOP Instances included by reference in the Incorporated Inventory Instance Sequence (0008,0422) may differ from the values of this SOP Instance.

C.38.1.1.2 Scope of Inventory

The Scope of Inventory Sequence (0008,0400) specifies the matching rules for values of Attributes that select Studies to be included in the Inventory. It specifies the selection parameters for the current Inventory SOP Instance and all its subsidiary incorporated Instances referenced in the Incorporated Inventory Instance Sequence (0008,0422). The Scope of InventorySequence (0008,0400) within those subsidiary incorporated Instances is relevant only to their respective sub-trees, and may differ.

Note

For example, an Inventory SOP Instance may specify in its Scope of Inventory that it includes studies from the years 2015-2019, but it does that by linking five subsidiary Inventory SOP Instances, one for each year, and which each specifies in its Scope of Inventory the year to which it applies.

While all Studies included in the Inventory will be within the Scope of Inventory, there may be Studies that match the Scope of Inventory that are not included in the Inventory if the Inventory is incomplete. The content of an Inventory SOP Instance, together with its subsidiary incorporated Instances, is complete with respect to the Scope of Inventory only if Inventory Completion Status (0008,0426) has the value COMPLETE.

C.38.1.1.3 Inventory Completion Status

Inventory Completion Status (0008,0426) is the status of the Inventory represented by this SOP Instance, including all SOP Instances referenced in the Incorporated Inventory Instance Sequence (0008,0422). The status is defined with respect to the Scope of Inventory as of the Content Date (0008,0023) and Content Time (0008,0033), for the repository system identified in the General Equipment Module (see Section C.7.5.1).

Enumerated Values:

COMPLETE

All Studies matching the Scope of Inventory are included in the Inventory SOP Instance and its subsidiary Incorporated Inventory SOP Instances

FAILURE

Production of the Inventory failed; some Studies matching the Scope of Inventory might not be included in the Inventory

CANCELED

Production of the Inventory was canceled; some Studies matching the Scope of Inventory might not be included in the Inventory

PARTIAL

Production of the inventory is incomplete; some Studies matching the Scope of Inventory might not be included in the Inventory

Note

  1. An Inventory may be COMPLETE and have no Study records, i.e., for the Repository identified in the Equipment Module, at the Content Date and Content Time, no Studies match the Scope of Inventory.

  2. The reason for a value other than COMPLETE may be described in Inventory Instance Description (0008,0402).

  3. COMPLETE, FAILURE, and CANCELED are statuses for the corresponding terminal states of the Inventory production process (see Section KK.2.1.1 “Inventory Production States” in PS3.4). PARTIAL is a status representing continuing Inventory production, and this SOP Instance might be expected to be referenced in the Incorporated Inventory Instance Sequence (0400, 06x2) of the SOP Instance at the root of an Inventory tree.

  4. See additional explanatory information and examples of use in Section YYYY.3.3.1 “Scope and Completion Status” in PS3.17.

C.38.1.1.4 Inventory Access End Points Sequence and Study Access End Points Sequence

The Inventory includes Attributes describing the available network access protocol(s) for referenced SOP Instances. The Inventory Access End Points Sequence (0008,0420) provides the default end points, i.e., network addresses, for access to Inventory SOP Instances referenced in the Incorporated Inventory Instance Sequence (0008,0422). The Study Access End Points Sequence (0008,0421) provides the default end points for access to Study-related SOP Instances referenced in the Inventoried Studies Sequence (0008,0423).

These default end points apply only to references within the current SOP Instance; they do not set defaults for references within Inventory SOP Instances referenced in the Incorporated Inventory Instance Sequence (0008,0422).

C.38.1.1.5 Incorporated Inventory Instance Sequence

For implementation specific reasons, the content of an Inventory may be divided into more than one Inventory SOP Instance. The Inventory SOP Instances are organized as a tree of referenced SOP Instances, with one SOP Instance as the root. The Incorporated Inventory Instance Sequence (0008,0422) specifies the links from an Inventory SOP Instance to its subsidiary Instances in the tree. The Incorporated Inventory Instance Sequence (0008,0422) definition recursively includes itself, thus allowing representation of the complete tree of referenced Inventory SOP Instances.

Inventory SOP Instances that are incorporated by reference shall have the same Inventory Level (0008,0403) as the current SOP Instance.

The inclusion of an Inventory SOP Instance reference in the Incorporated Inventory Instance Sequence (0008,0422) means that the Items of the Inventoried Studies Sequence (0008,0423) in that referenced SOP Instance are logically included in the current SOP Instance. Therefore, all inventoried Studies in the referenced SOP Instances shall be within the Scope of Inventory of the current SOP Instance. However, the Item Inventory DateTime (0008,0404) of those Study records may be prior to the Content Date (0008,0023) and Content Time (0008,0033) of the current SOP Instance.

Note

  1. Reasons for splitting an Inventory might include practical limits on the maximum size of an individual SOP Instance, parallel processing across multiple separate subsystems, or reuse of historical Inventories. See Section YYYY.3.3 “Inventory Instance Tree” in PS3.17.

  2. These requirements apply to every Inventory SOP Instance. Thus, each Inventory SOP Instance will include in its Incorporated Inventory Instance Sequence (0008,0422) the complete tree of references to the subtree of which it is the root.

C.38.1.1.6 Inventoried Studies Sequence

The Inventoried Studies Sequence (0008,0423) references Studies whose Attributes match the Scope of Inventory. Within the tree of incorporated Inventory SOP Instances, a given Study may be referenced multiple times among the Inventoried Studies Sequence (0008,0423) Items. The Items may have different content, but each Item shall have a complete record of the contents of the Study as known by the creator of that Item.

Note

  1. Differences in content may occur due to changes to the metadata or content (SOP Instances) of the Study during the production of the Inventory, or due to different Series of a Study being stored on different media, or for other reasons. The application using an Inventory may need to reconcile such multiple occurrences (see Section YYYY.7.10 “Study Record Reconciliation” in PS3.17).

  2. If there are multiple records for a Study among the tree of incorporated SOP Instances, the Total Number of Study Records (0008,0428) value will reflect the number of records, not the number of unique Study UIDs.

C.38.1.2 Inventoried Study Attributes

C.38.1.2.1 Study Update Datetime

Study Update DateTime (0008,041F) is the DateTime of the last update to Study contents (SOP Instances) or to Study metadata within the repository system. Metadata may change either due to coercion of Study related data (Patient ID, Study Description, Accession Number, etc.) to correspond with values set by the enterprise or department master information system (HIS / EMR / RIS), or due to other updates applied by the repository system.

As this is an Attribute of the Study as managed within the repository system, the initial Study Update DateTime (0008,041F) is the time that the Study was first received in the repository system, and is updated upon each new SOP Instance received for the Study, as well as for updates of patient, procedure, and other metadata.

Note

  1. This Attribute, like Number of Study Related Series (0020,1206) and Number of Study Related Instances (0020,1208), is defined at the Study level of the Inventory Information Model, but is not part of the Study Attributes in SOP Instances. It is an Attribute that may be managed by the repository system, and might not have a value for some or all of the Studies in the Inventory.

  2. Study Update DateTime (0008,041F) is not the time of last user access to the Study contents.

C.38.1.2.2 Removed From Operational Use and Reason For Removal Code Sequence

The Removed from Operational Use (0008,0405) Attribute is defined at the Study, Series, and Instance levels. A value of Y indicates the inventoried Study, Series, or Instance has been removed from operational use related to patient care, although it may be retained in the repository system for other reasons (e.g., for audit of patient radiation exposure). At the Study and Series level, the Attribute indicates whether the entire Study or Series has been removed from operational use. A value of Y at the Study level supersedes any value specified for subsidiary Series and Instances, and a value of Y at the Series level supersedes any value specified for subsidiary Instances.

Note

  1. The meaning of "operational use related to patient care" is implementation or site specific, but generally includes diagnostic, clinical, and therapeutic uses, as well as administrative uses necessary for providing care (e.g., insurance authorization).

  2. Studies, Series, or Instances might be marked as removed from operational use by actions associated with the processing of specific Key Object Selection Document SOP Instances, e.g., in accordance with ??? Image Object Change Management Integration Profile (IOCM). Those Key Object Selection Document SOP Instances, and their Series, may themselves be marked as removed from operational use. The Context Group for Reason for Removal Code Sequence (0008,0406) includes the Key Object Selection Concept Codes specified in IOCM.

  3. An image SOP Instance might be marked as removed from operational use because it has been replaced by a different (e.g., compressed) encoding of the image (see Section C.38.1.4.5).

  4. The content of the Inventory might not match the information obtained through the Query/Retrieve Service since Studies, Series, or Instances in Inventory SOP Instances marked as removed from operational use might not appear in Query/Retrieve responses (e.g., see ??? Section 4.66.4.1.3.1 Access to Rejected Instances).

  5. While defined in this specification at the Study, Series, and Instance levels, an Application Entity might not manage this Attribute at some, or any, of those levels. E.g., an AE may only manage this Attribute at the Instance level, and is not required to infer a value for the Series or Study level.

  6. If the Application Entity retains records of deleted Studies, Series, or Instances, even though the actual Instances are physically deleted, it may include those records in the Inventory with an appropriate Reason for Removal Code Sequence (0008,0406) value. Such instances may have an Instance Availability (0008,0056) value "UNAVAILABLE" (see Section C.38.1.2.9).

C.38.1.2.3 Number of Study Related Series, and Number of Study Related Instances

Number of Study Related Series (0020,1206) and Number of Study Related Instances (0020,1208) shall give accurate counts of Series and SOP Instances stored in the repository, respectively. The counts of Series and Instances shall include those that are marked as removed from operational use.

Note

These counts are not the number of Items in the Inventoried Series Sequence (0008,0424) and Inventoried Instances Sequence (0008,0425). Those Sequence Attributes may be absent depending on the value of Inventory Level (0008,0403). Further, if the Scope of Inventory indicates Relational matching to the Series or Instance level (see Section C.38.2.1.1.2), only Series and Instances matching the Scope of Inventory will be included in the Inventoried Series Sequence (0008,0424) and Inventoried Instances Sequence (0008,0425), and others present in the repository but not matching will not be recorded in the Inventory.

C.38.1.2.4 Anatomic Regions in Study Code Sequence

The Anatomic Regions in Study Code Sequence (0008,0063) consolidates the values of Anatomic Region Sequence (0008,2218) and Body Part Examined (0018,0015) in the SOP Instances of this Study. Recognized values of Body Part Examined can be transcoded to equivalent codes, such as by using the tables of Annex L “Correspondence of Anatomic Region Codes and Body Part Examined Defined Terms” in PS3.16, or by implementation- or site-specific mappings for locally defined terms.

C.38.1.2.5 Original Attributes Macro

The Original Attributes Sequence (0400,0561) is defined at each of the Study, Series, and Instance levels in the Inventory IOD.

Within the Inventoried Studies Sequence (0008,0423), i.e., at the Study level, the Original Attributes Sequence (0400,0561) may be used to record the prior values of updated Study, Patient, and Imaging Study Request Attributes for the referenced Study, and the provenance of such updates (see Section C.12.1.1.9). Within the Inventoried Series Sequence (0400,06x4), i.e., at the Series level, and within the Inventoried Instances Sequence (0008,0425), i.e., at the Instance level, the Original Attributes Sequence may be used to record the prior values of updated Series and Instance Attributes, respectively, and the provenance of such updates (see Section YYYY.7.9.1 “Original Attributes Sequence” in PS3.17).

In the context of an Inventory SOP Instance, the "top level Data Set" in the definition of the Original Attributes Sequence (0400,0561) is the top level Data Set of the SOP Instances of the inventoried Study.

The Original Attributes Sequences (0400,0561) in the Inventory SOP Instance might not be identical to the Original Attributes Sequence (0400,0561) in the individual SOP Instances of the Study, and updates recorded in either location are valid (see Section C.38.1.4.3).

Note

While defined in this specification at the Study, Series, and Instance levels, an Application Entity might manage the Original Attributes Sequence (0400,0561) at only the Instance level. In such case, changes to Study, Patient, Imaging Study Request, and Series Attributes would be recorded at the Instance level for all affected SOP Instances.

C.38.1.2.6 Stored Instance Base URI

Stored Instance Base URI (0008,0407) is defined at the Inventory, Study, and Series levels in the Inventory IOD.

Stored Instance Base URI (0008,0407) contains an [RFC3986] base URI that may be merged with relative path reference URIs for non-DICOM protocol access to SOP Instances of the Study or Series (see Section P.2.1). The Stored Instance Base URI (0008,0407) at the Study level establishes the default base URI for all relative path reference URIs in the Study, overriding a value specified at the Inventory level. Stored Instance Base URI (0008,0407) at the Series level establishes the default base URI for all relative path reference URIs in that Series overriding a value specified at the Inventory or Study level.

Note

  1. At the Inventory level, Stored Instance Base URI (0008,0407) is specified in the Study Access End Points Sequence (0008,0421), setting the default base URI value for all Study records in the current Inventory SOP Instance. See Section C.38.1.1.4.

  2. Stored Instance Base URI (0008,0407) is optional, and if not present the values of Folder Access URI (0008,0408) and File Access URI (0008,0409) at the Study level must be complete URIs. If Stored Instance Base URI (0008,0407) is present, those other Attributes may still provide complete URIs, rather than relative paths to be merged with the Base URI.

  3. See example uses of base URI and relative path reference URI in Section YYYY.7.2 “Using Non-DICOM Protocols” in PS3.17.

  4. For any relative path reference URI, the base URI is the one specified in its level, if present, or successively at the next higher levels, until a Stored Instance Base URI (0008,0407) Attribute is present with a value.

C.38.1.2.7 Folder Access URI and File Access URI

If all of the stored SOP Instances of the Study, as identified in this Item, are in the DICOM File Format accessible through a non-DICOM protocol, and all the files are catalogued in a single folder (see Section P.1.3), Folder Access URI (0008,0408) provides the URI for protocol operations on that folder.

If all of the stored SOP Instances of the Study, as identified in this Item, are in a single container file as specified in Section P.1.2, File Access URI (0008,0409) provides the URI for accessing that file.

Folder Access URI (0008,0408) and/or File Access URI (0008,0409) may be a relative path reference beginning with the single-dot-segment "./" (see Section P.2.1). In this case, the URI is merged with the Stored Instance Base URI (0008,0407) applicable to this Study (see Section C.38.1.2.6).

See Section C.38.1.4.3 for requirements on applying metadata from the Inventory SOP Instance to stored SOP Instances of the Study.

Note

  1. The Study may be inventoried in more than one Item (see Section C.38.1.1.6). Only the SOP Instances identified within this Item (and its subsidiary Inventoried Instances Sequence (0008,0425) Attributes) need to be included in the folder or container file.

  2. Stored SOP Instances from other Studies may be present in the folder or container file; the only requirement is that all of the identified SOP Instances of this Study are included.

  3. If the SOP Instances of the Study are split across different container files, e.g., Series 1 and 2 in one container and Series 3 in a different container, then the conditional requirement for File Access URI (0008,0409) is not met and that Attribute is not used. However, if both of those container files are in the same folder, then Folder Access URI (0008,0408) may be present.

  4. Files other than stored SOP Instances may be present in the folder or container file, e.g., reports in a non-DICOM file format.

  5. These URIs provide complete access paths to the referenced folders and files, unlike the Retrieve URL (0008,1190) for the Studies Service (Section 10 “Studies Service and Resources” in PS3.18), which requires composition of the URI using the Study, Series, and/or SOP Instance UIDs.

C.38.1.2.8 Container File Type

Container File Type (0008,040A) identifies the type of container file accessible through the File Access URI (0008,0409).

Defined Terms:

ZIP

see Section P.1.2.1

TAR

see Section P.1.2.2

GZIP

see Section P.1.2.3

TARGZIP

see Section P.1.2.4

BLOB

see Section P.1.2.5

DICM

Single SOP Instance in DICOM File Format (see Section 7 “DICOM File Format” in PS3.10), not in a container

C.38.1.2.9 Instance Availability

Instance Availability (0008,0056) is defined at each of the Study, Series, and Instance levels in the Inventory IOD. It specifies how rapidly the Study, Series, or Instance becomes available for transmission after a retrieval request. For a Study or Series, when some Instances are less rapidly available than others, the value is the availability of the least rapidly available.

Enumerated Values:

ONLINE

the instance is immediately available

NEARLINE

the instance needs to be retrieved from relatively slow media such as optical disk or tape, or requires conversion that takes time

OFFLINE

the instance needs to be retrieved by manual intervention

UNAVAILABLE

the instance cannot be retrieved

Note

  1. See also Section C.4.1.1.3.2 “Response Identifier Structure” in PS3.4.

  2. A Study, Series, or Instance that is UNAVAILABLE may also be marked as removed from operational use with Reason for Removal Code Sequence (0008,0406) value (130752, DCM, "Data Not Accessible from Storage").

C.38.1.3 Inventoried Series Attributes

C.38.1.3.1 Folder Access URI and File Access URI

If all of the stored SOP Instances of the Series are in the DICOM File Format accessible through a non-DICOM protocol, and all the files are catalogued in a single folder (see Section P.1.3), Folder Access URI (0008,0408) provides the URI for protocol operations on that folder.

If all of the stored SOP Instances of the Series are in a single container file as specified in Section P.1.2, File Access URI (0008,0409) provides the URI for accessing that file.

Folder Access URI (0008,0408) and/or File Access URI (0008,0409) may be a relative path reference beginning with the single-dot-segment "./" (see Section P.2.1). In this case, the URI is merged with the Stored Instance Base URI (0008,0407) applicable to this Series (see Section C.38.1.2.6).

Note

See also Section C.38.1.2.7 and its associated notes.

C.38.1.3.2 Body Part Examined

Defined Terms for Body Part Examined (0018,0015) are found in Annex L “Correspondence of Anatomic Region Codes and Body Part Examined Defined Terms” in PS3.16.

Recognized values of Body Part Examined (0018,0015) can be transcoded to their equivalent codes, such as by using the tables of Annex L “Correspondence of Anatomic Region Codes and Body Part Examined Defined Terms” in PS3.16 or by implementation-specific or site-specific mappings for locally defined terms. Those codes may beadded to the Study level Attribute Anatomic Regions in Study Code Sequence (0008,0063) (see Section C.38.1.2.4).

C.38.1.3.3 Request Attributes Sequence

Request Attributes Sequence (0040,0275) may be used to support Series that are related to multiple Imaging Service Requests.

Note

See, for example, [IHE RAD TF-2] Section 4.6.4.1.2.3 Relationship between Scheduled and Performed Procedure Steps.

C.38.1.4 Inventoried SOP Instance Attributes

C.38.1.4.1 Optional Attributes

This Module identifies Type 3 Attributes at the Instance level, some of which are applicable only to certain SOP Classes of inventoried SOP Instances. These Attributes may still be critical for certain repository uses, such as query for SOP Instances with certain characteristics.

Note

  1. Support of some IHE Profiles requires some of these Attributes. See, for example, [IHE RAD TF-2]:

    • Table 4.14-2: Image Specific Query Matching and Return Keys,

    • Table 4.15-1: Presentation State Specific Query Matching and Return Keys,

    • Table 4.30-1: Key Image Note Instance Specific Query Matching and Return Keys, and

    • Table 4.44-1: Evidence Document Instance Specific Query Matching and Return Keys.

  2. A recommended best practice is for the Inventory to include all Attributes supported by the implementation as Matching or Return Keys for Query/Retrieve SOP Classes (see Annex C “Query/Retrieve Service Class (Normative)” in PS3.4).

  3. See also Section YYYY.3.5 “Additional Data Elements” in PS3.17.

C.38.1.4.2 File Access Sequence

A repository system may store a SOP Instance on multiple storage devices (e.g., fast short-term media and slower long-term media), or with different Transfer Syntaxes. The SOP Instance may therefore be accessible through a non-DICOM protocol at multiple URIs. The File Access Sequence (0008,041A) provides one Item for each URI (see Section P.1.1). A URI relative path reference within this Sequence shall be relative to the Stored Instance Base URI (0008,0407) applicable to the Series (see Section C.38.1.2.6).

C.38.1.4.3 Metadata From Inventory

A stored SOP Instance accessible through a non-DICOM protocol shall be conformant to its IOD and to the DICOM File Format. However, some Attributes might not have current values (e.g., Patient Name may have been corrected or changed after the Instance was stored). The current values are encoded in the Inventory SOP Instance. For all Attributes defined in the IOD of the stored SOP Instance, and for which values are recorded in the Inventory, the values in the Inventory are authoritative and are imputed to the SOP Instance.

Items of the Original Attributes Sequences (0400,0561) in the Inventory at the Study, Series, and Instance levels (see Section C.38.1.2.5) are additive to any Items in the Original Attributes Sequence (0400,0561) of the stored SOP Instance.

Note

  1. SOP Instances accessed through DICOM protocols are expected to have current values in all Attributes.

  2. Depending on its function, and application accessing a stored SOP Instance through a non-DICOM protocol may not require updated metadata, e.g., if it is only accessing the pixel data for a machine learning process. Hence, there is no normative requirement that such an application must use metadata from the Inventory SOP Instance, only that the metadata is imputed (conceptually ascribed) to the SOP Instance.

  3. Attributes that are not defined in the IOD of the stored SOP Instance, but that are defined in the Inventory IOD, include Study level summary Attributes, such as Modalities in Study (0008,0061) and Number of Study Related Instances (0020,1208), and access Attributes, such as Retrieve AE Title (0008,0054), Stored Instance Base URI (0008,0407), and File Access URI (0008,0409). These Attributes are not to be imputed to the stored SOP Instance.

  4. Attributes that are not defined in the Inventory IOD, but that are defined in the IOD of the stored SOP Instance, may be included in the Inventory SOP Instance, especially if they have been updated, such as change of an SR Concept Name Code Sequence (0040,A043) from a SNOMED RT to a SNOMED CT coded concept. See Section YYYY.3.5 “Additional Data Elements” in PS3.17. These Attributes are to be imputed to the stored SOP Instance.

  5. An Inventory SOP Instance with Inventory Level (0008,0403) STUDY or SERIES does not include potentially updated metadata for lower levels of the information model. Users of such Inventories that access stored SOP Instances using a non-DICOM protocol, e.g., through the File Set Access Sequence (0008,0419) Attributes at the Study or Series level, should ensure that potentially outdated metadata is acceptable for their purposes.

  6. An empty Type 2 Attribute in an Inventory SOP Instance, e.g., Patient's Birth Date (0010,0030), implies that an empty value should be imputed to the referenced stored SOP Instances. A creator of an Inventory SOP Instance should ensure that empty Type 2 Attributes are appropriately conveying the semantics that the value is unknown, and any value in the stored SOP Instances will be overridden.

  7. As described in Section C.12.1.1.9, when performing a coercion, correction or conversion of SOP Instance Attributes, the application may add an Item to the Original Attributes Sequence (0400,0561) describing the provenance of the change, but preserving any existing Items in the Sequence. Thus, changes to Study, Patient, or Imaging Service Request Attributes recorded in the Inventory may have the provenance of those changes recorded in the Original Attributes Sequence (0400,0561) at the Study level, changes to Series or Instance Attributes may have their provenance recorded in the Original Attributes Sequence (0400,0561) at the Series or Instance level, respectively. When those changes are applied to the stored SOP Instances of the Study, all Items in the Original Attributes Sequence (0400,0561) in the Inventory at the Study, Series, and Instance levels are added to the Original Attributes Sequence (0400,0561) of the stored SOP Instances. See Section YYYY.7.9.1 “Original Attributes Sequence” in PS3.17.

C.38.1.4.4 Expiration Datetime

A repository system may store a SOP Instance in a temporary location (e.g., on fast short-term media). If such storage has a scheduled or expected expiration time, it may be identified in the Expiration DateTime (0008,0416) Attribute. This is not a guaranteed expiration time; the SOP Instance may become unavailable at the access URI at an earlier or later time. This Expiration DateTime (0008,0416) applies only to this non-DICOM protocol access; SOP Instances may continue to be accessible through other DICOM or non-DICOM access methods.

C.38.1.4.5 Alternate Representation Sequence

Alternate Representation Sequence (0008,3001) encodes a reference to an alternate encoding of the inventoried SOP Instance. This alternate encoding may utilize a different SOP Class or Transfer Syntax, but the alternate encoding of an image shall be the same image although it may have different image quality characteristics.

Note

  1. The Alternate Representation Sequence (0008,3001) allows the Inventory record of an original image to reference a lossy compressed alternate representation, and vice versa.

  2. See also Section C.6.1.1.5.1 “Alternate Representation Sequence” in PS3.4.

  3. An original SOP Instance that has been operationally replaced by an alternate encoded SOP Instance, and the original then deleted, may still have its Inventory record retained to provide forward referential resolution throughthe Alternate Representation Sequence (0008,3001) for other SOP Instances that reference the original. This record may have Instance Availability (0008,0056) set to UNAVAILABLE (see Section C.38.1.2.9), and/or may also be marked as removed from operational use with Reason for Removal Code Sequence (0008,0406) value (130754, DCM, "Replaced by Alternate Representation") (see Section C.38.1.2.2).

DICOM PS3.3 2022c - Information Object Definitions