DICOM PS3.3 2022d - Information Object Definitions

C.38.3 Inventory Creation Module

Table C.38.3-1 specifies the Attributes of the Inventory Creation Module, which are contained in an Inventory Creation Request/Response.

Table C.38.3-1. Inventory Creation Module Attributes

Attribute Name

Tag

Attribute Description

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

Key Attribute values for the Studies to be included in the Inventory.

Transaction UID

(0008,1195)

Unique identifier of a transaction initiating the production of an Inventory.

Transaction Status

(0008,0417)

Processing status for this transaction. (See Section KK.2.1.1 “Inventory Production States” in PS3.4).

Enumerated Values:

PROCESSING

Processing continuing

COMPLETE

Processing complete with completed inventory

FAILURE

Processing failure

CANCELED

Processing canceled

PAUSED

Processing paused

Transaction Status Comment

(0008,0418)

Explanation or further detail of Transaction Status (0008,0417).

Expiration DateTime

(0008,0416)

The date and time until which the Inventory SOP Instance is expected to be available. See Section C.38.3.1.3.

Inventory Purpose

(0008,0401)

Purpose for which the Inventory is to be created.

Inventory Level

(0008,0403)

Information Entity level for records to be included in Inventory.

Enumerated Values:

STUDY

Study records

SERIES

Study and Series records

INSTANCE

Study, Series, and Instance records

Referenced SOP Class UID

(0008,1150)

SOP Class UID of the produced Inventory SOP Instance.

Referenced SOP Instance UID

(0008,1155)

SOP Instance UID of the produced Inventory SOP Instance at the root of the tree of incorporated Inventory SOP Instances (see Section C.38.3.1.1).

Retrieve AE Title

(0008,0054)

AE Title from which the Inventory SOP Instance may be retrieved through Inventory MOVE or Inventory GET SOP Classes (see Annex JJ “Inventory Query/Retrieve Service Class” in PS3.4).

Retrieve URL

(0008,1190)

Base URI of the origin server from which the Inventory SOP Instance may be retrieved through the Non-Patient Instance Service (see Section 12 “Non-Patient Instance Service and Resources” in PS3.18).

Stored Instance Base URI

(0008,0407)

Base URI for accessing the Inventory SOP Instance through a non-DICOM protocol. See Section C.38.3.1.2.

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

See Section C.38.3.1.2.

Total Number of Study Records

(0008,0428)

Number of Studies found and processed into Inventory SOP Instances (as of time of message) that match Scope of Inventory.

Requested Status Interval

(0008,0414)

Requested interval, in minutes, between Inventory Status notifications. Value shall be greater than 0.

Retain Instances

(0008,0415)

Whether produced Inventory SOP Instances should be retained when Inventory production is canceled.

Enumerated Values:

Y

SOP Instances are to be retained

N

SOP Instances may be deleted


C.38.3.1 Inventory Creation Module Attribute Descriptions

C.38.3.1.1 Referenced SOP Instance UID

The content of an Inventory may be divided into more than one Inventory SOP Instance, organized as a tree of SOP Instances with one SOP Instance as the root (see Section C.38.1.1.5 and Section YYYY.3.3 “Inventory Instance Tree” in PS3.17). Only the root Inventory SOP Instance is identified in this data set in the Referenced SOP Instance UID (0008,1155); that SOP Instance includes the entire tree of references to SOP Instances comprising the Inventory.

C.38.3.1.2 File Access Uriand Stored Instance Base URI

If the produced Inventory SOP Instance is stored in the DICOM File Format (see Section 7 “DICOM File Format” in PS3.10) and is accessible through a non-DICOM protocol (see Annex P), the File Access URI (0008,0409) contains an [RFC3986] URI for non-DICOM protocol access to the Inventory SOP Instance. File Access URI (0008,0409) may be a relative path reference URI, which is merged with the Stored Instance Base URI (0008,0407) in accordance with Section P.2.1.

File Access URI (0008,0409) may reference a container file that includes the Inventory SOP Instance (see notes in Section C.38.2.3.1.2).

C.38.3.1.3 Expiration DateTime

A data management system may manage the storage lifecycle of the Inventory SOP Instances (e.g., by deleting older Inventory objects after a predetermined time). If there is a scheduled or expected time for SOP Inventory Instance deletion, it may be identified in the Expiration DateTime (0008,0416) Attribute. This is not a guaranteed expiration time; the SOP Instances may become unavailable at an earlier or later time. This Expiration DateTime (0008,0416) applies to all available access methods (both DICOM and non-DICOM protocols).

DICOM PS3.3 2022d - Information Object Definitions