The inventory detail segment is the data necessary to track the inventory of substances (e.g. reagent, tips, waste) and equipment state indicators (a special type of non-material inventory items) on equipment.
Figure 13-6. Information on the Types of Measures on a Container
HL7 Attribute Table - INV - Inventory Detail
Base Framework | ||||||||||
---|---|---|---|---|---|---|---|---|---|---|
Seq# | Data Element | Description | Flags | Implement | Cardinality | Length | C.LEN | Vocabulary | Data Type | |
INV | ||||||||||
1 | 01372 | Substance Identifier | C Condition defined for this element | MAY | [0..1] | SubstanceIdentifier (CD) | CWE Coded with Exceptions | |||
2 | 01373 | Substance Status | C Condition defined for this element | MAY | [0..*] | univ: SubstanceStatus (CD) | CWE Coded with Exceptions | |||
3 | 01374 | Substance Type | MAY | [0..1] | univ: SubstanceType (CD) | CWE Coded with Exceptions | ||||
4 | 01532 | Inventory Container Identifier | MAY | [0..1] | InventoryContainerIdentifier (CD) | CWE Coded with Exceptions | ||||
5 | 01376 | Container Carrier Identifier | MAY | [0..1] | ContainerCarrierIdentifier (CD) | CWE Coded with Exceptions | ||||
6 | 01377 | Position on Carrier | MAY | [0..1] | PositiononCarrier (CD) | CWE Coded with Exceptions | ||||
7 | 01378 | Initial Quantity | = Truncation allowed. | MAY | [0..1] | 10 | NM Numeric | |||
8 | 01379 | Current Quantity | = Truncation allowed. | MAY | [0..1] | 10 | NM Numeric | |||
9 | 01380 | Available Quantity | = Truncation allowed. | MAY | [0..1] | 10 | NM Numeric | |||
10 | 01381 | Consumption Quantity | = Truncation allowed. | MAY | [0..1] | 10 | NM Numeric | |||
11 | 01382 | Quantity Units | MAY | [0..1] | QuantityUnits (CD) | CWE Coded with Exceptions | ||||
12 | 01383 | Expiration Date/Time | MAY | [0..1] | DTM Date/Time | |||||
13 | 01384 | First Used Date/Time | MAY | [0..1] | DTM Date/Time | |||||
14 | 01385 | On Board Stability Duration | W withdrawn Element | SHOULD NOT | ||||||
15 | 01386 | Test/Fluid Identifier(s) | MAY | [0..*] | Test/FluidIdentifier(s) (CD) | CWE Coded with Exceptions | ||||
16 | 01387 | Manufacturer Lot Number | = Truncation not allowed! | MAY | [0..1] | 200 | ST String Data | |||
17 | 00286 | Manufacturer Identifier | MAY | [0..1] | ManufacturerIdentifier (CD) | CWE Coded with Exceptions | ||||
18 | 01389 | Supplier Identifier | MAY | [0..1] | SupplierIdentifier (CD) | CWE Coded with Exceptions | ||||
19 | 01626 | On Board Stability Time | MAY | [0..1] | CQ Composite Quantity with Units | |||||
20 | 01896 | Target Value | MAY | [0..1] | CQ Composite Quantity with Units | |||||
21 | 03488 | Equipment State Indicator Type Code | C Condition defined for this element | MAY | [0..1] | univ: EquipmentStateIndicatorTypeCode (CD) | CWE Coded with Exceptions | |||
22 | 03489 | Equipment State Indicator Value | C Condition defined for this element | MAY | [0..1] | CQ Composite Quantity with Units |
The root for the expression is on the segment.
Seq. | Referenced Elements | Introduction | Invariant | Comment | proposed Optionality |
---|---|---|---|---|---|
1 | INV-1, INV2 | It is optional in queries INR^U14 and required in all other messages. | MSH[9][2].equals("U14") or .hasValue() | can be solved by using a general framework with profiling | O |
2 | INV-1, INV2 | It is optional in queries INR^U14 and required in all other messages. | MSH[9][2].equals("U14") or .hasValue() | can be solved by using a general framework with profiling, ie. Different segment profiles | O |
21 | INV-21 | It is optional when INV-3 “Substance Type” is not populated and prohibited otherwise. | INV[3].hasValue() xor hasValue() | O | |
22 | INV-22 | It is optional when INV-21 “Equipment State Indicator Type Code” is populated and prohibited otherwise. | INV[21].hasValue() xor hasValue() | optionality same os INV-21 | O |
Seq# | Data Element | Description | Flags | Implement | Cardinality | Length | C.LEN | Vocabulary | Data Type | |
---|---|---|---|---|---|---|---|---|---|---|
INV | ||||||||||
1 | 01372 | Substance Identifier | C Condition defined for this element | MAY | [0..1] | SubstanceIdentifier (CD) | CWE Coded with Exceptions | |||
2 | 01373 | Substance Status | C Condition defined for this element | MAY | [0..*] | univ: SubstanceStatus (CD) hl7VS-substanceStatus (VS) substanceStatus (CS) | CWE Coded with Exceptions | |||
3 | 01374 | Substance Type | MAY | [0..1] | univ: SubstanceType (CD) hl7VS-substanceType (VS) substanceType (CS) | CWE Coded with Exceptions | ||||
4 | 01532 | Inventory Container Identifier | MAY | [0..1] | InventoryContainerIdentifier (CD) | CWE Coded with Exceptions | ||||
5 | 01376 | Container Carrier Identifier | MAY | [0..1] | ContainerCarrierIdentifier (CD) | CWE Coded with Exceptions | ||||
6 | 01377 | Position on Carrier | MAY | [0..1] | PositiononCarrier (CD) | CWE Coded with Exceptions | ||||
7 | 01378 | Initial Quantity | = Truncation allowed. | MAY | [0..1] | 10 | NM Numeric | |||
8 | 01379 | Current Quantity | = Truncation allowed. | MAY | [0..1] | 10 | NM Numeric | |||
9 | 01380 | Available Quantity | = Truncation allowed. | MAY | [0..1] | 10 | NM Numeric | |||
10 | 01381 | Consumption Quantity | = Truncation allowed. | MAY | [0..1] | 10 | NM Numeric | |||
11 | 01382 | Quantity Units | MAY | [0..1] | QuantityUnits (CD) | CWE Coded with Exceptions | ||||
12 | 01383 | Expiration Date/Time | MAY | [0..1] | DTM Date/Time | |||||
13 | 01384 | First Used Date/Time | MAY | [0..1] | DTM Date/Time | |||||
14 | 01385 | On Board Stability Duration | W withdrawn Element | SHOULD NOT | ||||||
15 | 01386 | Test/Fluid Identifier(s) | MAY | [0..*] | Test/FluidIdentifier(s) (CD) | CWE Coded with Exceptions | ||||
16 | 01387 | Manufacturer Lot Number | = Truncation not allowed! | MAY | [0..1] | 200 | ST String Data | |||
17 | 00286 | Manufacturer Identifier | MAY | [0..1] | ManufacturerIdentifier (CD) | CWE Coded with Exceptions | ||||
18 | 01389 | Supplier Identifier | MAY | [0..1] | SupplierIdentifier (CD) | CWE Coded with Exceptions | ||||
19 | 01626 | On Board Stability Time | MAY | [0..1] | CQ Composite Quantity with Units | |||||
20 | 01896 | Target Value | MAY | [0..1] | CQ Composite Quantity with Units | |||||
21 | 03488 | Equipment State Indicator Type Code | C Condition defined for this element | MAY | [0..1] | univ: EquipmentStateIndicatorTypeCode (CD) (VS) equipmentStateIndicator (CS) | CWE Coded with Exceptions | |||
22 | 03489 | Equipment State Indicator Value | C Condition defined for this element | MAY | [0..1] | CQ Composite Quantity with Units |
Base Framework | Base Standard Profile | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|
Seq# | Data Element | Description | Flags | Implement | Cardinality | Length | C.LEN | Vocabulary | Data Type | Implement | Vocabulary | |
INV | ||||||||||||
1 | 01372 | Substance Identifier | C Condition defined for this element | MAY | [0..1] | SubstanceIdentifier (CD) | CWE Coded with Exceptions | MAY | ||||
2 | 01373 | Substance Status | C Condition defined for this element | MAY | [0..*] | univ: SubstanceStatus (CD) | CWE Coded with Exceptions | MAY | hl7VS-substanceStatus (VS) substanceStatus (CS) | |||
3 | 01374 | Substance Type | MAY | [0..1] | univ: SubstanceType (CD) | CWE Coded with Exceptions | MAY | hl7VS-substanceType (VS) substanceType (CS) | ||||
4 | 01532 | Inventory Container Identifier | MAY | [0..1] | InventoryContainerIdentifier (CD) | CWE Coded with Exceptions | MAY | |||||
5 | 01376 | Container Carrier Identifier | MAY | [0..1] | ContainerCarrierIdentifier (CD) | CWE Coded with Exceptions | MAY | |||||
6 | 01377 | Position on Carrier | MAY | [0..1] | PositiononCarrier (CD) | CWE Coded with Exceptions | MAY | |||||
7 | 01378 | Initial Quantity | = Truncation allowed. | MAY | [0..1] | 10 | NM Numeric | MAY | ||||
8 | 01379 | Current Quantity | = Truncation allowed. | MAY | [0..1] | 10 | NM Numeric | MAY | ||||
9 | 01380 | Available Quantity | = Truncation allowed. | MAY | [0..1] | 10 | NM Numeric | MAY | ||||
10 | 01381 | Consumption Quantity | = Truncation allowed. | MAY | [0..1] | 10 | NM Numeric | MAY | ||||
11 | 01382 | Quantity Units | MAY | [0..1] | QuantityUnits (CD) | CWE Coded with Exceptions | MAY | |||||
12 | 01383 | Expiration Date/Time | MAY | [0..1] | DTM Date/Time | MAY | ||||||
13 | 01384 | First Used Date/Time | MAY | [0..1] | DTM Date/Time | MAY | ||||||
14 | 01385 | On Board Stability Duration | W withdrawn Element | SHOULD NOT | SHOULD NOT | |||||||
15 | 01386 | Test/Fluid Identifier(s) | MAY | [0..*] | Test/FluidIdentifier(s) (CD) | CWE Coded with Exceptions | MAY | |||||
16 | 01387 | Manufacturer Lot Number | = Truncation not allowed! | MAY | [0..1] | 200 | ST String Data | MAY | ||||
17 | 00286 | Manufacturer Identifier | MAY | [0..1] | ManufacturerIdentifier (CD) | CWE Coded with Exceptions | MAY | |||||
18 | 01389 | Supplier Identifier | MAY | [0..1] | SupplierIdentifier (CD) | CWE Coded with Exceptions | MAY | |||||
19 | 01626 | On Board Stability Time | MAY | [0..1] | CQ Composite Quantity with Units | MAY | ||||||
20 | 01896 | Target Value | MAY | [0..1] | CQ Composite Quantity with Units | MAY | ||||||
21 | 03488 | Equipment State Indicator Type Code | C Condition defined for this element | MAY | [0..1] | univ: EquipmentStateIndicatorTypeCode (CD) | CWE Coded with Exceptions | MAY | (VS) equipmentStateIndicator (CS) | |||
22 | 03489 | Equipment State Indicator Value | C Condition defined for this element | MAY | [0..1] | CQ Composite Quantity with Units | MAY |
Base Framework | Base Standard Profile | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|
Seq# | Data Element | Description | Flags | Optionality | Repetition | Length | C.LEN | Table | Data Type | Optionality | Table | |
INV | ||||||||||||
1 | 01372 | Substance Identifier | C Condition defined for this element |
O | CWE Coded with Exceptions |
(0451) | ||||||
2 | 01373 | Substance Status | C Condition defined for this element |
O | Y | CWE Coded with Exceptions |
(0383) | |||||
3 | 01374 | Substance Type | O | CWE Coded with Exceptions |
(0384) | |||||||
4 | 01532 | Inventory Container Identifier | O | CWE Coded with Exceptions |
(0599) | |||||||
5 | 01376 | Container Carrier Identifier | O | CWE Coded with Exceptions |
(0600) | |||||||
6 | 01377 | Position on Carrier | O | CWE Coded with Exceptions |
(0601) | |||||||
7 | 01378 | Initial Quantity | O | 10# | NM Numeric |
|||||||
8 | 01379 | Current Quantity | O | 10# | NM Numeric |
|||||||
9 | 01380 | Available Quantity | O | 10# | NM Numeric |
|||||||
10 | 01381 | Consumption Quantity | O | 10# | NM Numeric |
|||||||
11 | 01382 | Quantity Units | O | CWE Coded with Exceptions |
(0602) | |||||||
12 | 01383 | Expiration Date/Time | O | DTM Date/Time |
||||||||
13 | 01384 | First Used Date/Time | O | DTM Date/Time |
||||||||
14 | 01385 | On Board Stability Duration | W | |||||||||
15 | 01386 | Test/Fluid Identifier(s) | O | Y | CWE Coded with Exceptions |
(0603) | ||||||
16 | 01387 | Manufacturer Lot Number | O | 200= | ST String Data |
|||||||
17 | 00286 | Manufacturer Identifier | O | CWE Coded with Exceptions |
(0385) | |||||||
18 | 01389 | Supplier Identifier | O | CWE Coded with Exceptions |
(0386) | |||||||
19 | 01626 | On Board Stability Time | O | CQ Composite Quantity with Units |
||||||||
20 | 01896 | Target Value | O | CQ Composite Quantity with Units |
||||||||
21 | 03488 | Equipment State Indicator Type Code | C Condition defined for this element |
O | CWE Coded with Exceptions |
(0942) | ||||||
22 | 03489 | Equipment State Indicator Value | C Condition defined for this element |
O | CQ Composite Quantity with Units |
Seq# | Data Element | Description | Optionality | Repetition | Length | C.LEN | Table | Data Type | |
---|---|---|---|---|---|---|---|---|---|
INV | |||||||||
1 | 01372 | Substance Identifier | C | (0451) | CWE Coded with Exceptions |
||||
2 | 01373 | Substance Status | C | Y | (0383) | CWE Coded with Exceptions |
|||
3 | 01374 | Substance Type | O | (0384) | CWE Coded with Exceptions |
||||
4 | 01532 | Inventory Container Identifier | O | (0599) | CWE Coded with Exceptions |
||||
5 | 01376 | Container Carrier Identifier | O | (0600) | CWE Coded with Exceptions |
||||
6 | 01377 | Position on Carrier | O | (0601) | CWE Coded with Exceptions |
||||
7 | 01378 | Initial Quantity | O | 10# | NM Numeric |
||||
8 | 01379 | Current Quantity | O | 10# | NM Numeric |
||||
9 | 01380 | Available Quantity | O | 10# | NM Numeric |
||||
10 | 01381 | Consumption Quantity | O | 10# | NM Numeric |
||||
11 | 01382 | Quantity Units | O | (0602) | CWE Coded with Exceptions |
||||
12 | 01383 | Expiration Date/Time | O | DTM Date/Time |
|||||
13 | 01384 | First Used Date/Time | O | DTM Date/Time |
|||||
14 | 01385 | On Board Stability Duration | W | ||||||
15 | 01386 | Test/Fluid Identifier(s) | O | Y | (0603) | CWE Coded with Exceptions |
|||
16 | 01387 | Manufacturer Lot Number | O | 200= | ST String Data |
||||
17 | 00286 | Manufacturer Identifier | O | (0385) | CWE Coded with Exceptions |
||||
18 | 01389 | Supplier Identifier | O | (0386) | CWE Coded with Exceptions |
||||
19 | 01626 | On Board Stability Time | O | CQ Composite Quantity with Units |
|||||
20 | 01896 | Target Value | O | CQ Composite Quantity with Units |
|||||
21 | 03488 | Equipment State Indicator Type Code | C | (0942) | CWE Coded with Exceptions |
||||
22 | 03489 | Equipment State Indicator Value | C | CQ Composite Quantity with Units |
Definition: Unique identifier for the substance that is in inventory. This is a manufacturer-specific identifier. Refer to User-defined Table 0451 - Substance Identifier in Chapter 2C, Code Tables, for suggested values.
This field is conditional. It is optional in queries INR^U14 and required in all other messages. Absence of this field in a query means that the result shall be not filtered on inventory item ID.
Definition: The status of the inventoried item. The status indicates the current status of the substance. Refer to HL7 Table 0383 - Substance Status in Chapter 2C, Code Tables, for suggested values.
This field is conditional. It is optional in queries INR^U14 and required in all other messages. Absence of this field in a query means that the result shall be not filtered on inventory item status.
Definition: The type of substance. Refer to HL7 Table 0384 - Substance Type in chapter 2C for suggested values.
Definition: Identifies the inventory container, e.g., unique identifier of a specific package instance of a specific substance. This is a manufacturer-specific identifier.Refer to Table 0599 - Inventory Container Identifier in Chapter 2C for valid values.
Definition: This is the carrier used to transport the substance containers (e.g., a removable rotor with reagent bottles). Refer to Table 0600 - Container Carrier Identifier in Chapter 2C for valid values.
Definition: Identifies the position (e.g., index) on the carrier. Refer to Table 0601 - Position on Carrier in Chapter 2C for valid values.
Definition: This field identifies the initial quantity of the substance in inventory.
Definition: This field is the current quantity, i.e., initial quantity minus what has been actually used.
Definition: This field is the available quantity of substance. This is the current quantity minus any planned consumption (e.g., tests that are planned).
Definition: This field is the consumption that is used each time the equipment uses this substance.
Definition: This field is the units of measure of the available quantity. If the units are ISO+ units, they should be recorded as single case abbreviations. If the units are ANS+ or L (local), the units and the source code table must be recorded, except that in this case, component delimiters should be replaced by sub-component delimiters. For example, "l" indicates liters, whereas pt&&ANS+ indicates pints (ANSI units). The default unit is milliliters (ml), which should be assumed if no units are reported. Refer to Table 0602 - Quantity Units in Chapter 2C for valid values.
Definition: This field is the expiration date/time of the substance.
Definition: This field is the time and date when the substance was first used. This date and time can be necessary to determine the stability of the substance. The meaning of the "first used" element depends on the substance. In certain cases it means the time when the substance was put on board of the instrument or prepared (mixed), without actually using it in the analysis.
Attention: As of v2.5 this field was retained for backward compatibility only and withdrawn and removed as of v2.7. The TQ data type was deprecated; see Chapter 2A, section 2.A.81.
Definition: This field is the list of tests and body fluids that relate or correspond to this inventory item . This is a repeating field. An empty field means that this inventory item is not test specific, i.e., it applies to all tests. Refer to Table 0603 - Test/Fluid Identifier(s) in Chapter 2C for valid values.
Definition: This field specifies the lot number assigned by the manufacturer during production of the substance.
Definition: This field identifies the manufacturer of this substance. Refer to User-defined Table 0385 - Manufacturer Identifier in Chapter 2C, Code Tables, for suggested values. Relevant external code systems may be used, e.g., HIBCC Manufacturers Labeler ID Code (LIC), UPC, NDC, etc.
Definition: This field identifies the supplier of this substance. Refer to User-defined Table 0386 - Supplier Identifier in Chapter 2C, Code Tables, for suggested values.
Definition: This field is the duration of time that the calibration/usability of the substance is stable. The duration is used to calculate the date/time when this calibration is no longer valid by adding this "On board stability time" (INV-19) to the "First used date / time" (INV-13).
The 1st component defines the time quantity and the 2nd component the time units (see HL7 Table 0255 - Duration Categories). Recommended accuracy is "minutes", "hours" and "days".
Definition: This field is the target analytical value for a particular test for a specific lot of a manufactured material. Target values for QC purposes are usually selected for their relevance to a reference (normal) range or to a clinically significant decision level.
The 1st component defines the value and the 2nd component the measurement units.
Definition: The type code of an equipment state indicator. Refer to HL7 Table 0942 - Equipment State Indicator Type Code in Chapter 2C, Code Tables, for suggested values.
Due to its dynamic nature, an equipment state indicator is considered to be a [non-material] inventory item. Its value usually can be derived from the material inventory — in that way, a state indicator differs from static configuration parameters and master data stored on the equipment.
This field is conditional. It is optional when INV-3 “Substance Type” is not populated and prohibited otherwise.
Definition: The numeric value of the equipment state indicator specified in INV-21. The 1st component defines the number and the 2nd component the units of measurement.
This field is conditional. It is optional when INV-21 “Equipment State Indicator Type Code” is populated and prohibited otherwise.