C.38.2 Inventory Related Macros

C.38.2 Inventory Related Macros (Current)
Prev	C.38 Inventory Modules	Next

Note

See Section 5.5 for the interpretation of the Type column when these Macros are invoked in Normalized IODs.

C.38.2.1 Scope of Inventory Macro

Table C.38.2-1 specifies the Key Attribute valuesthat select the Studies included in the Inventory, i.e., the Scope of Inventory.

The full semantics of the matching process is specified in Annex C “Query/Retrieve Service Class (Normative)” in PS3.4.

Table C.38.2-1. Scope of Inventory Macro Attributes

Attribute Name	Tag	Type	Attribute Description
Scope of Inventory Sequence	(0008,0400)	2	Matching Key Attribute values for the Studies to be included in the Inventory. See Section C.38.2.1.1.1. Zero or one Item shall be included in this Sequence. An empty Sequence, or a Sequence with a single empty Item, indicates Universal Match to all Studies in the Repository.
>Extended Matching Mechanisms	(0008,040F)	1C	Extended Attribute matching mechanisms applied to the Key Attributes, equivalent to mechanisms accepted during Extended Negotiation of the Query/Retrieve Service Class as specified in Section C.5.1.1.2 “SOP Class Extended Negotiation Sub-Item Structure (A-ASSOCIATE-AC)” in PS3.4. See Section C.38.2.1.1.1. Enumerated Values: RELATIONAL Relational-queries COMBINED_DT Date-time Matching FUZZY_SEMANTIC Fuzzy Semantic Matching of person names TIMEZONE_ADJUST Timezone Query Adjustment EMPTY_VALUE Empty Value Matching MULTIPLE_VALUE Multiple Value Matching Required if extended matching mechanisms were applied.
>Specific Character Set	(0008,0005)	1C	Expanded or replacement character sets used in the Key Attributes. See Section C.12.1.1.2. Required if Attributes within the Sequence Item use an expanded or replacement character set.
>Timezone Offset from UTC	(0008,0201)	1C	Offset from UTC to the local timezone for all DA and TM Key Attributes. See Section C.12.1.1.8. Required if Extended Matching Mechanisms (0008,040F) includes value TIMEZONE_ADJUST.
>Query/Retrieve Level	(0008,0052)	1C	Matching level for Relational Matching mechanism. See Section C.38.2.1.1.2. Enumerated Values: STUDY Study level SERIES Series level IMAGE SOP Instance level Required if Extended Matching Mechanisms (0008,040F) includes value RELATIONAL.
>Range Matching Sequence	(0008,0410)	1C	The beginning and end values for Range Matching of date and time Key Attributes. See Section C.38.2.1.1.3. Exactly two Items shall be included in this Sequence. Required if Range Matching is applied to any Key Attribute.
>>Any DA, DT, or TM Attributes		2	Key Attribute values for matching. Multiple Attributes may be present.
>List of UID Matching Sequence	(0008,0411)	1C	Key Attribute values for List of UID Matching. See Section C.38.2.1.1.4. Required if List of UID Matching is applied to any Key Attribute. One or more Items shall be included in this Sequence.
>>Any UI Key Attribute		1	Key Attribute value for matching.
>Empty Value Matching Sequence	(0008,0412)	1C	Key Attributes for Empty Value Matching. See Section C.38.2.1.1.5. Required if Extended Matching Mechanisms (0008,040F) includes value EMPTY_VALUE and Empty Value Matching is applied to any Key Attribute. Only a single Item is permitted in this Sequence.
>>Any Attributes		2	Key Attributes with zero-length values. Multiple Attributes may be present.
>General Matching Sequence	(0008,0413)	1C	Key Attribute values for Single Value, Multiple Value, and Wild Card matching. See Section C.38.2.1.1.6. Required if Single Value, Multiple Value, or Wild Card matching is applied to any Key Attribute. Only a single Item is permitted in this Sequence.
>>Any Attributes		1	Key Attribute values for matching. Multiple Attributes may be present.

C.38.2.1.1 Scope of Inventory Macro Attribute Descriptions

C.38.2.1.1.1 Scope of Inventory Sequence

The Scope of Inventory Sequence (0008,0400) specifies Key Attribute values used to select Studies to be included in an Inventory.

Selection of Studies is done by a matching process between Key Attribute values specified in the Scope of Inventory Sequence (0008,0400) and the corresponding values in Attributes of Studies in the repository. The matching process is identical to the Attribute matching specified for the Query/Retrieve Service Class in Section C.2.2.2 “Attribute Matching” in PS3.4.

Any extended matching mechanisms beyond the baseline Query/Retrieve behavior used in selection of Studies for the Inventory are identified in the Extended Matching Mechanisms (0008,040F) Attribute.

Note

Attributes of Studies that may be matched include those additional Query/Retrieve Attributes that may be managed by the Repository system for managing stored SOP Instances, but are not specified in Composite IODs. See Section C.3.4 and Section C.6.4.1 “Additional Query Information Model Attributes” in PS3.4. Of particular interest for some Inventory use cases are Study Update DateTime (0008,041F), Modalities in Study (0008,0061), and Removed from Operational Use (0008,0405).
In the Query/Retrieve Service Class (including the Repository Query SOP Class), extended matching mechanisms are requested and agreed through SOP Class Extended Negotiation. In the Inventory Creation SOP Class (Section KK.2 “Inventory Creation SOP Class” in PS3.4), the use of extended mechanisms is requested using the Extended Matching Mechanisms (0008,040F) Attribute in the Initiate Action Request. In the Inventory SOP Instances, the actual use of such mechanisms is encoded in the Extended Matching Mechanisms (0008,040F) Attribute by the Instance creator.

Key Attributes for matching in the Query/Retrieve Service Class are allowed to have values that are exceptions to the VR for those Attributes in other contexts (see Section 6.2 “Value Representation (VR)” in PS3.5), or to have multiplicities that are exceptions to the VM of those Attributes as specified in PS3.6. The Scope of Inventory Sequence (0008,0400) specifies Sequence Attributes that provide equivalent encoding of Key Attributes while maintaining conformance to VR and VM specifications.

Universal matching Key Attributes, i.e., those with zero-length value or with the value "*", do not select Studies, and they shall not be included in the Scope of Inventory. Zero-length values are permitted in Key Attributes of the Range Matching Sequence (0008,0410), where they represent an unbounded beginning or end of a range, and in Key Attributes of the Empty Value Matching Sequence (0008,0412).

C.38.2.1.1.2 Relational Matching

If Extended Matching Mechanisms (0008,040F) does not include the value RELATIONAL, only Key Attributes defined at the Study level, as specified in Section C.6.2.1.2 “Study Level” in PS3.4, shall be included in Scope of Inventory.

If Extended Matching Mechanisms (0008,040F) includes the value RELATIONAL, Studies are selected for the Inventory in accordance with the specifications for Relational-queries matching in Section C.4.1.3.2.2 “Relational Search Method” in PS3.4 using the Query/Retrieve Level (0008,0052) and Key Attributes specified. The Inventory Level (0008,0403) determines the level of information that is included in the Inventory and may differ from this Query/Retrieve Level (0008,0052). In the case that the Inventory Level (0008,0403) is at or lower than the Query/Retrieve Level (0008,0052), then only the records for entities matching all Key Attributes will be included in the Inventory.

Note

For example, specification of Relational Matching, Query/Retrieve Level (0008,0052) SERIES, and a Key Attribute Modality (0008,0060) with value CT will include in the Inventory all Studies that have at least one Series with Modality CT. If the Inventory Level (0008,0403) is INSTANCE, only those Series and Instances with modality CT will be included in the Inventory; Series and Instances with Modality PR or SR, for example, in the same Study will not be included.

Baseline (non-relational) matching of Modalities in Study (0008,0061) with value CT will also include in the Inventory all Studies that have at least one Series with Modality CT. But since that Key Attribute performs selection at the Study level, an Inventory will include all Series of any modality for that Study.

C.38.2.1.1.3 Range Matching Sequence

Range Matching Sequence (0008,0410) provides values for Key Attributes that use range matching of dates and times using the mechanism specified in Section C.2.2.2.5 “Range Matching” in PS3.4.

The same set of Key Attributes shall be present in both Items of this Sequence. For each Key Attribute, at least one Item shall have a non-zero length value.

Values in the first Item represent the beginning of the range, and values in the second Itemrepresent the end of the range. If the first or the second value is empty, the range has an unbounded beginning or end, respectively. The range is inclusive; matched Attributes whose value is at or after the first value and before or at the second value match the range.

Note

In the equivalent Query/Retrieve Service Class range matching, the beginning and end values are encoded in a single Data Element, and delimited by "-".

If Extended Matching Mechanisms (0008,040F) includes the value COMBINED_DT, related date and time Attributes, such as Study Date (0008,0020) and Study Time (0008,0030), are considered together as a datetime value for matching.

If Extended Matching Mechanisms (0008,040F) includes the value TIMEZONE_ADJUST, dates and times are adjusted for the local timezone specified in Timezone Offset from UTC (0008,0201), as specified in Section C.2.2.2.1.3 “Attributes of VR of DA, DT or TM” in PS3.4.

C.38.2.1.1.4 List of UID Matching Sequence

List of UID Matching Sequence (0008,0411) provides a list of UIDs, one per Item, to be matched using the List of UID Matching mechanism specified in Section C.2.2.2.2 “List of UID Matching” in PS3.4.

Note

In the equivalent Query/Retrieve Service Class List of UID Matching, the VM=1 restriction is overridden for Key Attributes.

C.38.2.1.1.5 Empty Value Matching Sequence

Empty Value Matching Sequence (0008,0412) specifies Key Attributes that match when the corresponding Attribute in the Study has no value, as specified in Section C.2.2.2.7 “Empty Value Matching” in PS3.4. Key Attributes identified in this Sequence shall have zero-length values.

Note

In the equivalent Query/Retrieve Service Class Empty Value Matching, the value consisting of exactly two QUOTATION MARK characters signifies an empty value, and its use is permitted in Key Attributes with a VR of DA, DT, or TM.

C.38.2.1.1.6 General Matching Sequence

General Matching Sequence (0008,0413) specifies Key Attributes that are matched using Single Value and Wild Card matching, as specified in Section C.2.2.2.1 “Single Value Matching” in PS3.4 and Section C.2.2.2.4 “Wild Card Matching” in PS3.4.

If Extended Matching Mechanisms (0008,040F) includes the value MULTIPLE_VALUE, General Matching Sequence (0008,0413) may also specify Key Attributes that are matched using Multiple Value matching, as specified in Section C.2.2.2.8 “Multiple Value Matching” in PS3.4.

Note

If Extended Matching Mechanisms (0008,040F) does not include the value MULTIPLE_VALUE, Key Attributes with multiple values have undefined meaning.

If Extended Matching Mechanisms (0008,040F) includes the value TIMEZONE_ADJUST, dates and time are adjusted for the local timezone specified in Timezone Offset from UTC (0008,0201), as specified in Section C.2.2.2.1.3 “Attributes of VR of DA, DT or TM” in PS3.4.

If Extended Matching Mechanisms (0008,040F) includes the value FUZZY_SEMANTIC, matching of Attributes with VR PN may be done using implementation-specific fuzzy semantic matching, as specified in Section C.2.2.2.1.1 “Attributes of VR of PN” in PS3.4.