13. Clinical Laboratory Automation |
|
Chapter Chairs/Editors
Andrzej J. Knafel, PhD Roche Diagnostics
Manish Narang Ortho-Clinical Diagnostics Inc., a Johnson & Johnson Company
Additional Editors
Charles D. Hawker, PhD ARUP Laboratories
Clinical laboratory automation involves the integration or interfacing of automated or robotic transport systems, analytical instruments, and pre- or post-analytical process equipment such as automated centrifuges and aliquoters, decappers, recappers, sorters, and specimen storage and retrieval systems. In addition to the electrical and mechanical interfaces of these various components, the computers that control these devices or instruments must also be interfaced to each other and/or the Laboratory Information System (LIS).
The types of information communicated between these systems include process control and status information for each device or analyzer, each specimen, specimen container, and container carrier, information and detailed data related to patients, orders, and results, and information related to specimen flow algorithms and automated decision making. This wide array of communicated information is essential for a Laboratory Automation System (LAS) to control the various processes and to ensure that each specimen or aliquot has the correct tests performed in the proper sequence.
As of 1999 there are already more than 200 clinical laboratories in the world with "total laboratory automation" systems and hundreds more with a lesser level of automation _ generally workcells or modular automation systems. The development of prospective standards for these aspects of clinical laboratory automation will facilitate the inter-operability of the systems being developed by the various players in lab automation _ the vendors of analytical instruments, LIS systems, automation systems and components and their laboratory customers.
In the early 1990's an ad hoc task force, Clinical Testing Automation Standards Steering Committee (CTASSC), began to meet at the annual meetings of the International Conference on Automation and Robotics (ICAR) and the American Association for Clinical Chemistry (AACC). In 1996, CTASSC approached NCCLS, a globally-recognized, consensus standards organization that has developed more than 125 clinical laboratory standards and related products since it was founded in 1968, about taking on a project for clinical laboratory automation. NCCLS agreed to sponsor this project which was separately funded via a direct solicitation of the vendors in lab automation, instruments, LIS systems, and automation customers. It was organized as a "fast track" project to develop prospective standards to guide future developments in laboratory automation. With the oversight of an Area Committee on Automation, five separate subcommittees have worked since 1997 to develop a series of prospective standards for:
Specimen containers and carriers
Bar codes for specimen container identification
Communications
System operational requirements and characteristics
Electromechanical interfaces
Approved level standards for all five of these areas were published by NCCLS.
This chapter specifies HL7 triggers, messages, and segments required for implementation of clinical laboratory automation communication interfaces. It was developed jointly by the HL7 Laboratory Automation Special Interest Group and the NCCLS Subcommittee on Communications with Automated Systems. This chapter, by agreement between HL7 and NCCLS, is also published in its entirety as part of the NCCLS Approved Level standard:
AUTO3, "Laboratory Automation: Communications with Automated Clinical Laboratory Systems, Instruments, Devices, and Information Systems, © NCCLS"
This document contains other chapters to enable a vendor to successfully implement all of the elements essential to meet the standard.
The other related NCCLS clinical laboratory automation standards are:
AUTO1: "Laboratory Automation: Specimen Container / Specimen Carrier", © NCCLS.
AUTO2: "Laboratory Automation: Bar Codes for Specimen Container Identification", © NCCLS.
AUTO4: "Laboratory Automation: Systems Operational Requirements, Characteristics, and Information Elements", © NCCLS.
AUTO5: "Laboratory Automation: Electromechanical Interfaces", © NCCLS.
The reader is referred to any or all of these NCCLS standards, particularly AUTO3 and AUTO4, for detailed information on the communications requirements in clinical laboratory automation applications.
The control model proposed in this standard is an extension of the model described in LECIS:
ASTM E1989-98. Laboratory Equipment Control Interface Specification (LECIS). American Society for Testing and Materials; 1998
The terminology found in ANSI X3.182-1990 shall be used where applicable. Other computer-related technical terms used in this document can be found in ASTM Terminology E 1013, IEEE 100, IEEE 610, and ANSI X3.172
A numeric (or alphanumeric) identifier assigned by the LIS for a test order. Depending on the particular LIS a patient's test orders for a single encounter may use one or more accession identifiers and each accession identifier may encompass one or more tests and one or more specimens and/or specimen containers. However, accession identifiers are unique within each patient encounter. The Accession identifier may not be equal to the Placer or Filler Order Numbers, because of uniqueness requirement.
As used here, refers to a substance generally a chemical that has been added to a specimen collection tube or container to prevent degradation of one or more constituents of the specimen.
In Quantitative Analysis, a sample comprising a known fraction or measured portion of the whole; 2) In NCCLS LAB AUTOMATION Standard documents, a portion of a specimen placed in a separate container to facilitate concurrent testing or to hold in reserve for future use.
Notes: a) The portion of the specimen is typically removed from the original specimen after initial processing, such as centrifugation, to obtain serum or plasma samples, and is considered to be chemically identical to all other subdivisions of an original sample of serum, plasma, urine, CSF, etc.;
b) It may be necessary to identify the aliquot as an individual specimen distinct from the original specimen in a collection container labeled with a unique identifier that may be linked to or associated with the primary collection container.
An instrument and/or specimen processing and handling device that performs measurements on patient specimens of quantitative, clinically relevant analytes.
Note: A portion of a patient's specimen is consumed in the analytic process.
A characterization applied when all analytical processes, including sample and reagent uptake, sample/reagent interaction, chemical/biological analysis, result calculation, and result readout are mechanized.
A laboratory instrument that may or may not be connected to a laboratory information system (LIS), hospital information system (HIS), and/or laboratory automation system (LAS), which performs measurements on a patient's sample;
Note: These instruments may have specific hardware and/or software modifications that allow interfacing to a laboratory automation system.
An automation system refers to a variety of possible systems that can include some of the following types: automated instruments, laboratory information systems (LIS), laboratory automation systems (LAS), hospital information systems (HIS), and front-end processing devices.
An array of parallel rectangular bars and spaces that creates a symbology representing a number or alphanumeric identifier.
The length of the bars in the bar code.
See Separator
Identifies the distance from the Point of Reference to the separator material (barrier) within the container. This distance may be provided by the LAS to the instrument and/or specimen processing/handling device to facilitate the insertion of a sampling probe into the specimen without touching the separator. See the Point of reference definition or in NCCLS standard AUTO5 Laboratory Automation: Electromechanical Interfaces.
The farthest point from the top of the container/test tube that the cap reaches.
Note: This point may be inside the tube.
The portion of the container/test tube farthest from the cap (see Point of reference).
See Bottom of container.
See Specimen carrier.
The smallest abstract element of a writing system or script.
Note: A character refers to an abstract idea rather than to a specific shape.
2) A code element.
The integration of laboratory personnel and preanalytical, analytical, and postanalytical processes and information systems.
An assemblage of components that mechanically and electronically transfers, analyzes, and processes information and material related to clinical diagnostic testing of patient specimens, controls, calibrators, standards, and images.
The action of aspirating a sample from a container/tube with the closure in place, requiring the sample probe to pierce the closure of the container/sample container.
See Closed-container sampling.
See Specimen container.
A numeric (or alphanumeric) identifier provided by the LIS or LAS to uniquely identify each specimen container or aliquot container. The NCCLS LAB AUTOMATION STANDARD requires a unique identifier for each container introduced into the LAS or leaving the LAS.
The identified time segments of the process of moving from one sample to the next, including: presentation of specimen along transportation system to docking site at instrument; identification/recognition that the correct specimen is in place; either direct aspiration from specimen container by probe, or transfer of specimen container to instrument, aspiration, and return of specimen container to specimen carrier/transportation system; departure of completed specimen container; movement into position of next specimen container.
The removal of a closure from a specimen container.
A symbol used to separate items in a list.
The orthogonal axes.
Note: a) These axes are demonstrated in Figure 13-1.
Figure 13-1. Physical Frame of Reference in a Three-Dimensional Space (X-Y-Z)
X_direction, n - The direction that a specimen travels along a transportation system.
Note: b) Specimens would move along the X dimension as, for example, in transportation from station to station in a laboratory (See Figure 13-2.)
Figure 13-2. X Direction
Y_direction, n - The horizontal direction perpendicular to specimen travel along a transportation system;
Note: c) Specimens could move in the Y dimension away from a transport system to be placed onto an instrument for analysis (see Figure 13-3). The sample probe would move in the Y dimension as it moves out from the instrument or specimen processing and handling device to a position directly over the specimen container.
Figure 13-3. Y Direction
Z_direction, n - The vertical dimension;
Notes: d) Specimens could be lifted in the Z dimension off a transport system for transfer between locations;
e) The center line of a container should be controlled, so it is in the Z dimension; a specimen centering device would be referenced to the Z dimension; a sample probe would follow the Z dimension as it moves downward into a specimen container to aspirate serum, blood, etc. for analysis (see Figure 13-4);
f) Rotation about the Z dimension may be used to locate and read the bar-code label on a specimen container or to assess the quality of a specimen in terms of turbidity, hemolysis, icterus, etc.
Figure 13-4. Z Direction
See Directions of the specimen, etc.
The process in which aspiration of a sample occurs directly from the specimen container while it is on the transportation system, whereby the instrument probe extends to reach the specimen container on the transportation system;
Note: This process requires agreement between the transportation system and the instrument and specimen processing and handling devices regarding point of reference (POR) to guide movement of the probe to the specimen.
1) The location of the physical interface between two components of a system; 2) In NCCLS LAB AUTOMATION Standard documents, the interface between the transportation system and the instrument and/or the specimen processing and handling devices where the specimen container arrives for sampling to occur.
The point at which the vertical (straight) walls of the specimen container bend to form the base.
A standard exchange of messages between two instances of equipment that synchronizes the execution of one or more commands. State models are used describe the standard interactions.
1) The display of written, printed, or graphic matter upon the immediate container of any article; 2) In NCCLS LAB AUTOMATION Standard documents, the paper and attached adhesive coating on which the bar code and other human readable information is printed.
A system of information and hardware technology that allows the operation of the clinical laboratory process without significant operator intervention;
Note: Typical functionality includes information system control of the instruments through direct LAS interfacing, including any technology that manipulates the specimen (i.e., centrifuge); transportation of the specimen; result evaluation, repeat testing, reflex testing; and quality assessment and results reporting.
A high-level protocol that defines message content for standard behaviors or interactions for remote control of analytical instruments and devices (ASTM E 1989-9810).
The information system that is responsible for management of data regarding patient specimen identification, tests requested, results reported, quality control testing, and other aspects of sample analysis;
Notes: a) The LIS interfaces directly with the LAS to communicate patient, visit, container, test orders, specimen status, and results about specific testing to be done
b) Instrument or specimen processing and handling devices may be interfaced with the LIS or the LAS to direct specific testing and to retrieve results for reporting;
c) The LIS is frequently also interfaced to a clinical information system for use by physicians and other medical personnel.
Acronym for Laboratory Equipment Control Interface Specification, (ASTM E 1989-9810).
A physical place within the laboratory, with a unique identifier (e.g., refrigerator shelf number, instrument buffer ID, track identifier).
The action of aspirating a sample from a specimen container from which the closure has previously been removed;
Note: The sample probe contacts the surface of the specimen without other physical barriers.
See Open-container sampling.
The center distance between two specimen containers in a carrier or between two sequential specimen container carriers.
The intersection of the xy plane and an infinite line in the 'z' direction.
Note: The POR is the reference from which all positioning and alignment of specimen containers are measured.
In NCCLS LAB AUTOMATION Standard documents, components of an automated laboratory comprising the automated devices that perform a multitude of pre- and postanalytical tasks, and perform nonanalytical tasks on specimens, containers, carriers, and similar processes.
In NCCLS LAB AUTOMATION documents, the white {blank} space on a bar code immediately preceding the first bar and immediately following the last bar.
To replace the closure on a specimen container; either with the original closure or with a new replacement closure.
A device capable of moving a specimen container, specimen carrier, or another object in the X, Y, and Z directions;
Note: Unless this device is an integral part of the LAS system, it is considered an instrument for the purpose of this proposed standard.
1) A small part of anything ... intended to show the quality, style, or nature of the whole; 2) In NCCLS LAB AUTOMATION Standard documents, a portion or aliquot withdrawn from a container for the actual test;
Notes: In NCCLS LAB AUTOMATION Standard documents,
a) samples are typically not placed in containers that will have to be uniquely identified, but may go directly into the instrument or specimen processing and handling device test stream or may be placed in sample cups unique to the instrument or specimen processing and handling device;
b) the ID of the specimen is typically assured by computer linkage of the pipetting or aspiration step to the ID of the container from which it was obtained, or by a separate numbering system for the sample cups that is internal to the analytical instrument or specimen processing and handling device.
See Specimen carrier.
See Specimen collection container.
See Specimen-positioning system.
See Specimen probe.
A material such as a gel which is contained in blood collection tubes to facilitate separation of blood cells from blood serum by creating a physical "barrier" between them.
See Separator.
In NCCLS LAB AUTOMATION Standard documents, the space around the transportation system and instruments that may be accessed periodically for maintenance or repair of equipment;
Note: A transportation system and analytic instruments should not have mutually impinging service envelopes.
The discrete portion of a body fluid or tissue taken for examination, study, or analysis of one or more quantities or characteristics, to determine the character of the whole.
Note: The substance may still be referred to as a specimen if it has been processed from the obtained specimen; thus, examples of specimens include whole blood and serum or plasma prepared from whole blood; saliva; cerebrospinal fluid; feces; urine; fingernail clippings; hair clippings; tissue samples, even if embedded in a paraffin block; etc.
A device that holds the specimen container;
Note: The specimen carrier interfaces mechanically with the transportation system to move the specimen from location to location, and may carry one specimen container or many specimen containers. (See Figure 13-5).
The tube that holds a patient specimen;
Note: The container typically consists of a glass or plastic closed-end tube with a removable closure on the opposite end. (See Figure 13-5)
Figure 13-5: Relationship Among Specimen Container, Specimen Carrier, Tray, and Locations.
A device to position a specimen container within acceptable tolerances of a POR.
A part of an instrument or specimen processing and handling device that aspirates fluid from a specimen and delivers it to the instrument for analysis.
Note: The sample probe can also be called sample proboscis, nozzle, needle, or sampling mechanism.
In NCCLS LAB AUTOMATION Standard documents, the area between the instrument or specimen processing and handling device and the automation hardware that must remain clear of any physical device, ensuring that there is adequate access by the user or service person to either system.
In NCCLS LAB AUTOMATION Standard documents, a combination of bar-code characters, including start/stop characters, quiet zones, data elements, and check characters which form a complete scanning entity.
Short, understandable contractions for test names.
The open end of the container/test tube, closest to the cap.
See Top of container.
A holder for one or more carriers (optional). (See Figure 13-5).
See Directions.
See Directions.
See Directions.
Each trigger event is listed below, along with the application form of the message exchange. The notation used to describe the sequence, optionality and repetition of segments is described in Chapter 2.
The notation used to describe the sequence, the optionality, and the repetition of segments is described in HL7, Chapter 2, under "Format for Defining Abstract Message."
All the ACK messages are varieties of the 'general acknowledgement' message defined in Chapter 2, Section 2.14.1. The only difference is the event code.
The "Equipment Notification" message (EAN/ACK event U09) is used to send information about the occurrence of an event. An event does not necessarily cause a state transition. The "Status Update" message (EAU/ACK event U01) is used to transfer information about the current status. This status can be the result of one or more events that led to the state transition. Example: The event of a "warning level of a consumable being reached" (e.g., 10% left) does not cause a state transition, because the system can remain "In operation". This results in an EAN/ACK message. An event "container transport jammed" causes the state transition to "Emergency stop". This results in both EAN/ACK and EAU/ACK messages.
For the transfer of laboratory automation orders and results refer to 4.4.6 OML - laboratory order message (event O21) instead of ORM and 7.3.2 OUL _ unsolicited laboratory observation message (event O20) instead of ORU.
This message is used to send information about the status of a device or equipment from one application to another (e.g., automated device to a Laboratory Automation System). The status update can be sent unsolicited or as a response to the trigger "Automated Equipment Status Request."
ESU^U01^ESU_U01 | Equipment Status Message | Status | Chapter | DB Ref. |
---|---|---|---|---|
MSH | Message Header |
| 2 | DB |
[ { SFT } ] | Software Segment |
| 2 | DB |
EQU | Equipment Detail |
| 13 | DB |
[ { ISD } ] | Interaction Status Detail |
| 13 | DB |
[ ROL ] | Role Detail |
| 12 | DB |
ACK^U01^ACK | General Acknowledgement | Status | Chapter | DB Ref. |
---|---|---|---|---|
MSH | Message Header |
| 2 | DB |
[ { SFT } ] | Software segment |
| 2 | DB |
MSA | Message Acknowledgment |
| 2 | DB |
[ { ERR } ] | Error |
| 2 | DB |
ESR^U02^ESR_U02 | Equipment Status Message | Status | Chapter | DB Ref. |
---|---|---|---|---|
MSH | Message Header |
| 2 | DB |
[ { SFT } ] | Software Segment |
| 2 | DB |
EQU | Equipment Detail |
| 13 | DB |
[ ROL ] | Role Detail |
| 12 | DB |
ACK^U02^ACK | General Acknowledgment | Status | Chapter | DB Ref. |
---|---|---|---|---|
MSH | Message Header |
| 2 | DB |
[ { SFT } ] | Software segment |
| 2 | DB |
MSA | Message Acknowledgment |
| 2 | DB |
[ { ERR } ] | Error |
| 2 | DB |
SSU^U03^SSU_U03 | Specimen Status Message | Status | Chapter | DB Ref. |
---|---|---|---|---|
MSH | Message Header |
| 2 | DB |
[ { SFT } ] | Software Segment |
| 2 | DB |
EQU | Equipment Detail |
| 13 | DB |
{ | --- SPECIMEN_CONTAINER begin |
|
|
|
SAC | Specimen Container Detail |
| 13 | DB |
[ { OBX } ] | Additional specimen characteristics |
| 7 | DB |
{ [ | --- SPECIMEN begin |
|
|
|
SPM | Specimen |
| 7 | DB |
[ { OBX } ] | Specimen related observation |
| 7 | DB |
] } | --- SPECIMEN end |
|
|
|
} | --- SPECIMEN_CONTAINER end |
|
|
|
[ ROL ] | Role Detail |
| 12 | DB |
ACK^U03^ACK | General Acknowledgment | Status | Chapter | DB Ref. |
---|---|---|---|---|
MSH | Message Header |
| 2 | DB |
[ { SFT } ] | Software segment |
| 2 | DB |
MSA | Message Acknowledgment |
| 2 | DB |
[ { ERR } ] | Error |
| 2 | DB |
SSR^U04^SSR_U04 | Specimen Status Message | Status | Chapter | DB Ref. |
---|---|---|---|---|
MSH | Message Header |
| 2 | DB |
[ { SFT } ] | Software Segment |
| 2 | DB |
EQU | Equipment Detail |
| 13 | DB |
{ | --- SPECIMEN_CONTAINER begin |
|
|
|
SAC | Specimen Container Detail |
| 13 | DB |
[ { SPM } ] | Specimen |
| 7 | DB |
} | --- SPECIMEN_CONTAINER end |
|
|
|
[ ROL ] | Role Detail |
| 12 | DB |
ACK^U04^ACK | General Acknowledgment | Status | Chapter | DB Ref. |
---|---|---|---|---|
MSH | Message Header |
| 2 | DB |
[ { SFT } ] | Software segment |
| 2 | DB |
MSA | Message Acknowledgment |
| 2 | DB |
[ { ERR } ] | Error |
| 2 | DB |
INU^U05^INU_U05 | Inventory Update Message | Status | Chapter | DB Ref. |
---|---|---|---|---|
MSH | Message Header |
| 2 | DB |
[ { SFT } ] | Software Segment |
| 2 | DB |
EQU | Equipment Detail |
| 13 | DB |
{ INV } | Inventory Detail |
| 13 | DB |
[ ROL ] | Role Detail |
| 12 | DB |
ACK^U05^ACK | General Acknowledgment | Status | Chapter | DB Ref. |
---|---|---|---|---|
MSH | Message Header |
| 2 | DB |
[ { SFT } ] | Software segment |
| 2 | DB |
MSA | Message Acknowledgment |
| 2 | DB |
[ { ERR } ] | Error |
| 2 | DB |
INR^U06^INR_U06 | Inventory Request Message | Status | Chapter | DB Ref. |
---|---|---|---|---|
MSH | Message Header |
| 2 | DB |
[ { SFT } ] | Software Segment |
| 2 | DB |
EQU | Equipment Detail |
| 13 | DB |
{ INV } | Inventory Detail |
| 13 | DB |
[ ROL ] | Role Detail |
| 12 | DB |
ACK^U06^ACK | General Acknowledgment | Status | Chapter | DB Ref. |
---|---|---|---|---|
MSH | Message Header |
| 2 | DB |
[ { SFT } ] | Software segment |
| 2 | DB |
MSA | Message Acknowledgment |
| 2 | DB |
[ { ERR } ] | Error |
| 2 | DB |
EAC^U07^EAC_U07 | Equipment Command Message | Status | Chapter | DB Ref. |
---|---|---|---|---|
MSH | Message Header |
| 2 | DB |
[ { SFT } ] | Software Segment |
| 2 | DB |
EQU | Equipment Detail |
| 13 | DB |
{ | --- COMMAND begin |
|
|
|
ECD | Equipment Command Detail |
| 13 | DB |
[ TQ1 ] | Timing/quantity |
| ? | DB |
[ | --- SPECIMEN_CONTAINER begin |
|
|
|
SAC | Specimen Container Detail |
| 13 | DB |
[ { SPM } ] | Specimen |
| 7 | DB |
] | --- SPECIMEN_CONTAINER end |
|
|
|
[ CNS ] | Clear Notification |
| 13 | DB |
} | --- COMMAND end |
|
|
|
[ ROL ] | Role Detail |
| 12 | DB |
ACK^U07^ACK | General Acknowledgment | Status | Chapter | DB Ref. |
---|---|---|---|---|
MSH | Message Header |
| 2 | DB |
[ { SFT } ] | Software segment |
| 2 | DB |
MSA | Message Acknowledgment |
| 2 | DB |
[ { ERR } ] | Error |
| 2 | DB |
EAR^U08^EAR_U08 | Equipment Command Message | Status | Chapter | DB Ref. |
---|---|---|---|---|
MSH | Message Header |
| 2 | DB |
[ { SFT } ] | Software Segment |
| 2 | DB |
EQU | Equipment Detail |
| 13 | DB |
{ | --- COMMAND_RESPONSE begin |
|
|
|
ECD | Equipment Command Detail |
| 13 | DB |
[ | --- SPECIMEN_CONTAINER begin |
|
|
|
SAC | Specimen Container Detail |
| 13 | DB |
[ { SPM } ] | Specimen |
| 7 | DB |
] | --- SPECIMEN_CONTAINER end |
|
|
|
ECR | Equipment Command Response |
| 13 | DB |
} | --- COMMAND_RESPONSE end |
|
|
|
[ ROL ] | Role Detail |
| 12 | DB |
ACK^U08^ACK | General Acknowledgment | Status | Chapter | DB Ref. |
---|---|---|---|---|
MSH | Message Header |
| 2 | DB |
[ { SFT } ] | Software segment |
| 2 | DB |
MSA | Message Acknowledgment |
| 2 | DB |
[ { ERR } ] | Error |
| 2 | DB |
EAN^U09^EAN_U09 | Equipment Status Message | Status | Chapter | DB Ref. |
---|---|---|---|---|
MSH | Message Header |
| 2 | DB |
[ { SFT } ] | Software Segment |
| 2 | DB |
EQU | Equipment Detail |
| 13 | DB |
{ | --- NOTIFICATION begin |
|
|
|
NDS | Notification Detail |
| 13 | DB |
[ NTE ] | Notification Note |
| 2 | DB |
} | --- NOTIFICATION end |
|
|
|
[ ROL ] | Role Detail |
| 12 | DB |
ACK^U09^ACK | General Acknowledgment | Status | Chapter | DB Ref. |
---|---|---|---|---|
MSH | Message Header |
| 2 | DB |
[ { SFT } ] | Software segment |
| 2 | DB |
MSA | Message Acknowledgment |
| 2 | DB |
[ { ERR } ] | Error |
| 2 | DB |
TCU^U10^TCU_U10 | Test Code Settings Update | Status | Chapter | DB Ref. |
---|---|---|---|---|
MSH | Message Header |
| 2 | DB |
[ { SFT } ] | Software Segment |
| 2 | DB |
EQU | Equipment Detail |
| 13 | DB |
{ | --- TEST_CONFIGURATION begin |
|
|
|
[ SPM ] | Specimen |
| 7 | DB |
{ TCC } | Test Code Configuration |
| 13 | DB |
} | --- TEST_CONFIGURATION end |
|
|
|
[ ROL ] | Role Detail |
| 12 | DB |
ACK^U10^ACK | General Acknowledgment | Status | Chapter | DB Ref. |
---|---|---|---|---|
MSH | Message Header |
| 2 | DB |
[ { SFT } ] | Software segment |
| 2 | DB |
MSA | Message Acknowledgment |
| 2 | DB |
[ { ERR } ] | Error |
| 2 | DB |
TCR^U11^TCU_U10 | Test Code Settings Request | Status | Chapter | DB Ref. |
---|---|---|---|---|
MSH | Message Header |
| 2 | DB |
[ { SFT } ] | Software Segment |
| 2 | DB |
EQU | Equipment Detail |
| 13 | DB |
{ | --- TEST_CONFIGURATION begin |
|
|
|
[ SPM ] | Specimen |
| 7 | DB |
{ TCC } | Test Code Configuration |
| 13 | DB |
} | --- TEST_CONFIGURATION end |
|
|
|
[ ROL ] | Role Detail |
| 12 | DB |
ACK^U11^ACK | General Acknowledgment | Status | Chapter | DB Ref. |
---|---|---|---|---|
MSH | Message Header |
| 2 | DB |
[ { SFT } ] | Software segment |
| 2 | DB |
MSA | Message Acknowledgment |
| 2 | DB |
[ { ERR } ] | Error |
| 2 | DB |
LSU^U12^LSU_U12 | Equipment Log/Service Message | Status | Chapter | DB Ref. |
---|---|---|---|---|
MSH | Message Header |
| 2 | DB |
[ { SFT } ] | Software Segment |
| 2 | DB |
EQU | Equipment Detail |
| 13 | DB |
{ EQP } | Equipment Log/Service |
| 13 | DB |
[ ROL ] | Role Detail |
| 12 | DB |
ACK^U12^ACK | General Acknowledgment | Status | Chapter | DB Ref. |
---|---|---|---|---|
MSH | Message Header |
| 2 | DB |
[ { SFT } ] | Software segment |
| 2 | DB |
MSA | Message Acknowledgment |
| 2 | DB |
[ { ERR } ] | Error |
| 2 | DB |
LSR^U13^LSU_U12 | Equipment Log/Service Message | Status | Chapter | DB Ref. |
---|---|---|---|---|
MSH | Message Header |
| 2 | DB |
[ { SFT } ] | Software Segment |
| 2 | DB |
EQU | Equipment Detail |
| 13 | DB |
{ EQP } | Equipment Log/Service |
| 13 | DB |
[ ROL ] | Role Detail |
| 12 | DB |
ACK^U13^ACK | General Acknowledgment | Status | Chapter | DB Ref. |
---|---|---|---|---|
MSH | Message Header |
| 2 | DB |
[ { SFT } ] | Software segment |
| 2 | DB |
MSA | Message Acknowledgment |
| 2 | DB |
[ { ERR } ] | Error |
| 2 | DB |
The following section identifies the message segments proposed for incorporation in this standard, and will be submitted for incorporation or reference in other HL7 and NCCLS standard documents. Valid entries are presented in an Attribute Table for each segment.
The equipment detail segment contains the data necessary to identify and maintain the equipment that is being used throughout the Laboratory Automation System.
HL7 Attribute Table _ EQU _ Equipment Detail
13.4 MESSAGE SEGMENTS
13.4.1 EQU - Equipment Detail Segment
SEQ | LEN | DT | OPT | RP/# | TBL# | ITEM # | ELEMENT NAME | DB Ref. |
---|---|---|---|---|---|---|---|---|
1 | 22 | EI | R |
|
| 01479 | Equipment Instance Identifier | DB |
2 | 26 | TS | R |
|
| 01322 | Event Date/Time | DB |
3 | 250 | CE | C |
| 0365 | 01323 | Equipment State | DB |
4 | 250 | CE | O |
| 0366 | 01324 | Local/Remote Control State | DB |
5 | 250 | CE | O |
| 0367 | 01325 | Alert Level | DB |
Components: <Entity Identifier (ST)> ^ <Namespace ID (IS)> ^ <Universal ID (ST)> ^ <Universal ID Type (ID)>
Definition: This field identifies the equipment. This is the identifier from an institution's master list of equipment. The <namespace ID> identifies the institution.
Components: <Time (DTM)> ^ <DEPRECATED-Degree of Precision (ID)>
Definition: This field is the date/time that the event (e.g., state transition, issuing of command, finishing of command execution) occurred.
Components: <Identifier (ST)> ^ <Text (ST)> ^ <Name of Coding System (ID)> ^ <Alternate Identifier (ST)> ^ <Alternate Text (ST)> ^ <Name of Alternate Coding System (ID)>
Definition: This field identifies the status that the equipment was in at the time that the transaction was initiated. Refer to HL7 Table 0365 _ Equipment state for valid values. The Equipment State is required in the ESU message and is optional otherwise.
HL7 Table 0365 - Equipment state
13.4.1.0 EQU Field Definitions
13.4.1.1 EQU-1 Equipment Instance Identifier (EI) 01479
13.4.1.2 EQU-2 Event Date/Time (TS) 01322
13.4.1.3 EQU-3 Equipment State (CE) 01323
Value | Description | Comment |
---|---|---|
PU | Powered Up |
|
IN | Initializing |
|
ID | Idle |
|
CO | Configuring |
|
OP | Normal Operation |
|
CL | Clearing |
|
PA | Pausing |
|
PD | Paused |
|
ES | E-stopped |
|
| (null) No state change |
|
This table is based on LECIS (see sub-chapter "Introduction and Overview")
Components: <Identifier (ST)> ^ <Text (ST)> ^ <Name of Coding System (ID)> ^ <Alternate Identifier (ST)> ^ <Alternate Text (ST)> ^ <Name of Alternate Coding System (ID)>
Definition: This field identifies the current state of control associated with the equipment. An equipment can either work autonomously ('Local' control state) or it can be controlled by another system, e.g., LAS computer ('Remote' control state). Refer to HL7 Table 0366 _ Local/remote control state for valid values.
HL7 Table 0366 - Local/remote control state
Value | Description | Comment |
---|---|---|
L | Local |
|
R | Remote |
|
| (null) No state change |
|
This table is based on LECIS (see sub-chapter "Introduction and Overview")
Components: <Identifier (ST)> ^ <Text (ST)> ^ <Name of Coding System (ID)> ^ <Alternate Identifier (ST)> ^ <Alternate Text (ST)> ^ <Name of Alternate Coding System (ID)>
Definition: This field identifies the highest level of the alert state (e.g., highest alert severity) that is associated with the indicated equipment (e.g. processing event, inventory event, QC event). Refer to HL7 Table 0367 _ Alert level for valid values.
HL7 Table 0367 - Alert level
Value | Description | Comment |
---|---|---|
N | Normal | No Corrective Action Needed |
W | Warning | Corrective Action Anticipated |
S | Serious | Corrective Action Required |
C | Critical | Shut Down, Fix Problem and Re-init |
| (null) No level change |
|
The interaction detail segment contains information about the status of specific interaction (e.g., processing _ see section Glossary) on the specific equipment.
HL7 Attribute Table _ ISD _ Interaction Status Detail
13.4.2 ISD _ Interaction Status Detail Segment
SEQ | LEN | DT | OPT | RP/# | TBL# | ITEM # | ELEMENT NAME | DB Ref. |
---|---|---|---|---|---|---|---|---|
1 | 20 | NM | R |
|
| 01326 | Reference Interaction Number (unique identifier) | DB |
2 | 250 | CE | O |
| 0368 | 01327 | Interaction Type Identifier | DB |
3 | 250 | CE | R |
| 0387 | 01328 | Interaction Active State | DB |
Definition: This number uniquely identifies the interaction. If the interaction is performed as the result of a previous command, then the Reference Command Number should be used. (See 13.4.5.1 ECD-1 Reference Command Number (NM) 01390)
Components: <Identifier (ST)> ^ <Text (ST)> ^ <Name of Coding System (ID)> ^ <Alternate Identifier (ST)> ^ <Alternate Text (ST)> ^ <Name of Alternate Coding System (ID)>
Definition: This field specifies the type of interaction. If the interaction is performed as the result of a previous command, then the interaction type as specified in User-defined Table 0368 - Remote control command should be used.
Components: <Identifier (ST)> ^ <Text (ST)> ^ <Name of Coding System (ID)> ^ <Alternate Identifier (ST)> ^ <Alternate Text (ST)> ^ <Name of Alternate Coding System (ID)>
Definition: This field transfers the state of the interaction. If the interaction is performed as the result of a previous command, then the interaction state should be one of the Command Responses (Refer to User-defined Table 0387 _ Command response). If the interaction is not performed as a result of a command (e.g., periodically time triggered automatic maintenance) then this state is interaction specific, and should refer to either the LECIS state transitions for interactions or a user or equipment specific table.
The container detail segment is the data necessary to maintain the containers that are being used throughout the Laboratory Automation System.
The specimens in many laboratories are transported and processed in containers (e.g., sample tubes). When SPM and SAC are used in the same message, then the conceptually duplicate attributes will be valued only in the SPM. This applies to SAC-6 (Specimen Source), SAC-27 (Additives), and SAC-43 (Special Handling Considerations).
HL7 Attribute Table _ SAC _ Specimen Container detail
13.4.2.0 ISD Field Definitions
13.4.2.1 ISD-1 Reference Interaction Number (NM) 01326
13.4.2.2 ISD-2 Interaction Type Identifier (CE) 01327
13.4.2.3 ISD-3 Interaction Active State (CE) 01328
13.4.3 SAC_ Specimen Container Detail Segment
SEQ | LEN | DT | OPT | RP/# | TBL# | ITEM # | ELEMENT NAME | DB Ref. |
---|---|---|---|---|---|---|---|---|
1 | 80 | EI | O |
|
| 01329 | External Accession Identifier | DB |
2 | 80 | EI | O |
|
| 01330 | Accession Identifier | DB |
3 | 80 | EI | C |
|
| 01331 | Container Identifier | DB |
4 | 80 | EI | C |
|
| 01332 | Primary (parent) Container Identifier | DB |
5 | 80 | EI | O |
|
| 01333 | Equipment Container Identifier | DB |
6 | 300 | SPS | C |
|
| 00249 | Specimen Source | DB |
7 | 26 | TS | O |
|
| 01334 | Registration Date/Time | DB |
8 | 250 | CE | O |
| 0370 | 01335 | Container Status | DB |
9 | 250 | CE | O |
| 0378 | 01336 | Carrier Type | DB |
10 | 80 | EI | O |
|
| 01337 | Carrier Identifier | DB |
11 | 80 | NA | O |
|
| 01338 | Position in Carrier | DB |
12 | 250 | CE | O |
| 0379 | 01339 | Tray Type - SAC | DB |
13 | 80 | EI | O |
|
| 01340 | Tray Identifier | DB |
14 | 80 | NA | O |
|
| 01341 | Position in Tray | DB |
15 | 250 | CE | O | Y |
| 01342 | Location | DB |
16 | 20 | NM | O |
|
| 01343 | Container Height | DB |
17 | 20 | NM | O |
|
| 01344 | Container Diameter | DB |
18 | 20 | NM | O |
|
| 01345 | Barrier Delta | DB |
19 | 20 | NM | O |
|
| 01346 | Bottom Delta | DB |
20 | 250 | CE | O |
|
| 01347 | Container Height/Diameter/Delta Units | DB |
21 | 20 | NM | O |
|
| 00644 | Container Volume | DB |
22 | 20 | NM | O |
|
| 01349 | Available Specimen Volume | DB |
23 | 20 | NM | O |
|
| 01350 | Initial Specimen Volume | DB |
24 | 250 | CE | O |
|
| 01351 | Volume Units | DB |
25 | 250 | CE | O |
| 0380 | 01352 | Separator Type | DB |
26 | 250 | CE | O |
| 0381 | 01353 | Cap Type | DB |
27 | 250 | CWE | O | Y | 0371 | 00647 | Additive | DB |
28 | 250 | CE | O |
|
| 01355 | Specimen Component | DB |
29 | 20 | SN | O |
|
| 01356 | Dilution Factor | DB |
30 | 250 | CE | O |
| 0373 | 01357 | Treatment | DB |
31 | 20 | SN | O |
|
| 01358 | Temperature | DB |
32 | 20 | NM | O |
|
| 01359 | Hemolysis Index | DB |
33 | 250 | CE | O |
|
| 01360 | Hemolysis Index Units | DB |
34 | 20 | NM | O |
|
| 01361 | Lipemia Index | DB |
35 | 250 | CE | O |
|
| 01362 | Lipemia Index Units | DB |
36 | 20 | NM | O |
|
| 01363 | Icterus Index | DB |
37 | 250 | CE | O |
|
| 01364 | Icterus Index Units | DB |
38 | 20 | NM | O |
|
| 01365 | Fibrin Index | DB |
39 | 250 | CE | O |
|
| 01366 | Fibrin Index Units | DB |
40 | 250 | CE | O | Y | 0374 | 01367 | System Induced Contaminants | DB |
41 | 250 | CE | O | Y | 0382 | 01368 | Drug Interference | DB |
42 | 250 | CE | O |
| 0375 | 01369 | Artificial Blood | DB |
43 | 250 | CWE | O | Y | 0376 | 01370 | Special Handling Code | DB |
44 | 250 | CE | O | Y | 0377 | 01371 | Other Environmental Factors | DB |
Components: <Entity Identifier (ST)> ^ <Namespace ID (IS)> ^ <Universal ID (ST)> ^ <Universal ID Type (ID)>
Definition: This field identifies the laboratory accession (see section Glossary). This identifier is assigned by the external laboratory information system.
Example: If laboratory A sends a specimen to laboratory B, then within laboratory B this field contains accession identifier of lab A.
Components: <Entity Identifier (ST)> ^ <Namespace ID (IS)> ^ <Universal ID (ST)> ^ <Universal ID Type (ID)>
Definition: This field identifies the laboratory accession (see section Glossary). This identifier is assigned by the information system of the laboratory performing the tests.
An accession identifier can refer to more than one container. A Container Identifier (see below) is a Unique Identifier for that container.
Components: <Entity Identifier (ST)> ^ <Namespace ID (IS)> ^ <Universal ID (ST)> ^ <Universal ID Type (ID)>
Definition: This field identifies the container. This field is the container's unique identifier assigned by the corresponding equipment. A container may contain the primary (original) specimen or an aliquot (secondary sample) of that specimen. For primary sample this field contains Primary Container ID; for bar-coded aliquot samples this field contains Aliquot Container ID; for non-bar-coded aliquot samples (e.g., microtiter plate) this field is empty
The NCCLS standard requires a unique identifier for each container introduced into the Laboratory Automation System. The combination of the fields: Primary Container ID, Container ID, Carrier ID / Position, Tray ID / Position must identify the container uniquely within the LAS. The naturally best solution is unique machine-readable id attached to the container (which of course is sufficient to ensure the uniqueness of the fields' combination). A bar code that symbolizes this ID should meet the proposed standard NCCLS AUTO2 (Laboratory Automation: Bar Codes for Specimen Container Identification).
Components: <Entity Identifier (ST)> ^ <Namespace ID (IS)> ^ <Universal ID (ST)> ^ <Universal ID Type (ID)>
Definition: If this field is filled in, it identifies the primary container from which this specimen came. For primary samples this field is empty; for aliquot samples this field should contain the identifier of primary container.
Components: <Entity Identifier (ST)> ^ <Namespace ID (IS)> ^ <Universal ID (ST)> ^ <Universal ID Type (ID)>
Definition: This field identifies the container in a particular device (e.g., one container in a carousel or rack of containers within an analyzer, analyzer specific bar code mapping, etc.).
Components: <Specimen Source Name or Code (CWE)> ^ <Additives (CWE)> ^ <Specimen Collection Method (TX)> ^ <Body Site (CWE)> ^ <Site Modifier (CWE)> ^ <Collection Method Modifier Code (CWE)> ^ <Specimen Role (CWE)>
Subcomponents for Specimen Source Name or Code (CWE): <Identifier (ST)> & <Text (ST)> & <Name of Coding System (ID)> & <Alternate Identifier (ST)> & <Alternate Text (ST)> & <Name of Alternate Coding System (ID)> & <Coding System Version ID (ST)> & <Alternate Coding System Version ID (ST)> & <Original Text (ST)>
Subcomponents for Additives (CWE): <Identifier (ST)> & <Text (ST)> & <Name of Coding System (ID)> & <Alternate Identifier (ST)> & <Alternate Text (ST)> & <Name of Alternate Coding System (ID)> & <Coding System Version ID (ST)> & <Alternate Coding System Version ID (ST)> & <Original Text (ST)>
Subcomponents for Body Site (CWE): <Identifier (ST)> & <Text (ST)> & <Name of Coding System (ID)> & <Alternate Identifier (ST)> & <Alternate Text (ST)> & <Name of Alternate Coding System (ID)> & <Coding System Version ID (ST)> & <Alternate Coding System Version ID (ST)> & <Original Text (ST)>
Subcomponents for Site Modifier (CWE): <Identifier (ST)> & <Text (ST)> & <Name of Coding System (ID)> & <Alternate Identifier (ST)> & <Alternate Text (ST)> & <Name of Alternate Coding System (ID)> & <Coding System Version ID (ST)> & <Alternate Coding System Version ID (ST)> & <Original Text (ST)>
Subcomponents for Collection Method Modifier Code (CWE): <Identifier (ST)> & <Text (ST)> & <Name of Coding System (ID)> & <Alternate Identifier (ST)> & <Alternate Text (ST)> & <Name of Alternate Coding System (ID)> & <Coding System Version ID (ST)> & <Alternate Coding System Version ID (ST)> & <Original Text (ST)>
Subcomponents for Specimen Role (CWE): <Identifier (ST)> & <Text (ST)> & <Name of Coding System (ID)> & <Alternate Identifier (ST)> & <Alternate Text (ST)> & <Name of Alternate Coding System (ID)> & <Coding System Version ID (ST)> & <Alternate Coding System Version ID (ST)> & <Original Text (ST)>
Definition: This field is the site where the specimen should be obtained or where the service should be performed.
This field is deprecated and retained for backward compatibility. This field is conditional, meaning that, in case where the SPM segment is used in a message together with the SAC, this field should be ignored. The reader is referred to the SPM Specimen segment in chapter 7.
Components: <Time (DTM)> ^ <DEPRECATED-Degree of Precision (ID)>
Definition: This field is the date/time that the container was last registered with the "automated system.", e.g., reading of a container bar code by a device.
Components: <Identifier (ST)> ^ <Text (ST)> ^ <Name of Coding System (ID)> ^ <Alternate Identifier (ST)> ^ <Alternate Text (ST)> ^ <Name of Alternate Coding System (ID)>
Definition: This field identifies the status of the unique container in which the specimen resides at the time that the transaction was initiated. Refer to HL7 Table 0370 - Container status for valid values. The equipment specific container status should be sent as <alternate identifier> as needed.
HL7 Table 0370 - Container status
13.4.3.0 SAC Field Definitions
13.4.3.1 SAC-1 External Accession Identifier (EI) 01329
13.4.3.2 SAC-2 Accession Identifier (EI) 01330
13.4.3.3 SAC-3 Container Identifier (EI) 01331
13.4.3.4 SAC-4 Primary (Parent) Container Identifier (EI) 01332
13.4.3.5 SAC-5 Equipment Container Identifier (EI) 01333
13.4.3.6 SAC-6 Specimen Source (SPS) 00249
13.4.3.7 SAC-7 Registration Date/Time (TS) 01334
13.4.3.8 SAC-8 Container Status (CE) 01335
Value | Description | Comment |
---|---|---|
I | Identified |
|
P | In Position |
|
O | In Process |
|
R | Process Completed |
|
L | Left Equipment |
|
M | Missing |
|
X | Container Unavailable |
|
U | Unknown |
|
The container states are relevant for the exchange of information among devices (within the LAS). Not all of them are relevant for information transfer between the LAS and the LIS.
In the explanations below the system means the LAS or any equipment interfaced to it or to another equipment.
Identified status is used by one system to inform another that it has received a container. In the exchange between the LAS and LIS the Identified status can be used for reporting of the "In Lab" (Specimen Received) status. In some cases this may not be equal to the first event of sample recognition.
In Position status is used by one system to inform another that the container is in position for specimen transfer (e.g., container removal from track, pipetting, etc.).
In Process status is used by one system to inform another that the specific container is being processed by the equipment. It is useful as a response to a query about Container Status, when the specific step of the process is not relevant.
Process Completed status is used by one system to inform another that the processing has been completed, but the container has not been released from that system.
Left Equipment status is used by one system to inform another that the container has been released from that system.
Missing status is used by one system to inform another that the container did not arrive at its next expected location.
Cancelled status is used by one system to inform another that the container is no longer available within the scope of the system (e.g., tube broken or discarded).
Unknown status is used by one system to inform another that the container has not been identified.
Components: <Identifier (ST)> ^ <Text (ST)> ^ <Name of Coding System (ID)> ^ <Alternate Identifier (ST)> ^ <Alternate Text (ST)> ^ <Name of Alternate Coding System (ID)>
Definition: This field identifies the type of the carrier (see section Glossary). Refer to User-defined Table 0378 _ Carrier type for suggested values. Because the geometry can be different, the carrier type should, if possible, express the number of positions in the carrier.
The definition assumes hierarchical nesting using the following phrases: container is located in a carrier, carrier is located in a tray.
User-defined Table 0378 _ Carrier type
Value | Description | Comment |
---|---|---|
| No suggested values defined |
|
Examples of values: R01 (one position carrier), R05 (five position carrier)
Components: <Entity Identifier (ST)> ^ <Namespace ID (IS)> ^ <Universal ID (ST)> ^ <Universal ID Type (ID)>
Definition: This field identifies the carrier. It is the ID (e.g., number or bar code) of the carrier where the container (e.g., tube) is located.
Example: A carrier could be a rack with single or multiple specimen containers. A carrier is usually used for automated specimen transport. Multiple carriers can be stacked in a tray, which is then used for manual or automatic transport.
Components: <Value1 (NM)> ^ <Value2 (NM)> ^ <Value3 (NM)> ^ <Value4 (NM)> ^ < ()>
Definition: This field identifies the position of the container in the carrier (e.g., 1_3_). The sub-components allow, if necessary, to transfer multiple axis information, e.g., 2-dimensional carrier (X^Y).
Components: <Identifier (ST)> ^ <Text (ST)> ^ <Name of Coding System (ID)> ^ <Alternate Identifier (ST)> ^ <Alternate Text (ST)> ^ <Name of Alternate Coding System (ID)>
Definition: This field identifies the type of the tray (see section Glossary). Refer to User-defined Table 0379 _ Tray type for suggested values. Because the geometry can be different, the tray type should if possible express the number of positions in the tray.
The definition assumes hierarchical nesting using the following phrases: container is located in a carrier, carrier is located in a tray.
User-defined Table 0379 _ Tray type
Value | Description | Comment |
---|---|---|
| No suggested values defined |
|
Components: <Entity Identifier (ST)> ^ <Namespace ID (IS)> ^ <Universal ID (ST)> ^ <Universal ID Type (ID)>
Definition: This field identifies the tray identifier (e.g., a number of a tray or a bar code on the tray), where the container carrier is located.
Components: <Value1 (NM)> ^ <Value2 (NM)> ^ <Value3 (NM)> ^ <Value4 (NM)> ^ < ()>
Definition: This field identifies the position of the carrier in the tray. The sub-components allow, if necessary, to transfer multiple axis information, e.g., 2-dimensional tray (X^Y).
Components: <Identifier (ST)> ^ <Text (ST)> ^ <Name of Coding System (ID)> ^ <Alternate Identifier (ST)> ^ <Alternate Text (ST)> ^ <Name of Alternate Coding System (ID)>
Definition: This field is the physical location that the specimen was at the time that the transaction was initiated. The location description can vary with the LAS. For example, it can be an X,Y,Z coordinate in a storage system; a refrigerator number and drawer number where the container-carrier-tray is located; or it can be the name of the institution and the laboratory which owns the container currently. The repeating of this field allows for hierarchical representation of location (lowest level first), e.g., shelf number, refrigerator storage id, lab name, institution name, etc.
Definition: This field identifies the height of the container in units specified below.
Definition: This field identifies the outside diameter of the container in units specified below.
Definition: This field identifies the distance from the Point of Reference to the separator material (barrier) within the container in units specified below. This distance may be provided by the LAS to the instrument and/or specimen processing/handling device to facilitate the insertion of a sampling probe into the specimen without touching the separator. Refer to Point Of Reference definition in section Glossary or in NCCLS standard AUTO5 Laboratory Automation: Electromechanical Interfaces.
Definition: This field identifies the distance from the Point of Reference to the outside bottom of the container in units specified below. Refer to Point Of Reference definition in section Glossary or in NCCLS standard AUTO5 Laboratory Automation: Electromechanical Interfaces.
Components: <Identifier (ST)> ^ <Text (ST)> ^ <Name of Coding System (ID)> ^ <Alternate Identifier (ST)> ^ <Alternate Text (ST)> ^ <Name of Alternate Coding System (ID)>
Definition: This field is the unit identifier that is being used to describe the diameter, height and deltas of the container. 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 subcomponent delimiters. The default unit is millimeters (mm), which should be assumed if no units are reported.
Definition: This field indicates the capacity of the container in the units specified below.
Definition: This field identifies the current specimen volume available for use in this container in the units specified below.
Definition: This field identifies the volume of the specimen initially filled in this container in the units specified below.
Components: <Identifier (ST)> ^ <Text (ST)> ^ <Name of Coding System (ID)> ^ <Alternate Identifier (ST)> ^ <Alternate Text (ST)> ^ <Name of Alternate Coding System (ID)>
Definition: This field is the unit identifier that is being used to describe the volume of the container. If the units are ISO+ units, they should be recorded as single case abbreviations. The default unit is milliliters (ml), which should be assumed if no units are reported.
Components: <Identifier (ST)> ^ <Text (ST)> ^ <Name of Coding System (ID)> ^ <Alternate Identifier (ST)> ^ <Alternate Text (ST)> ^ <Name of Alternate Coding System (ID)>
Definition: This field identifies the type of the separator that is being used (e.g., gel separator in the container _ not to be confused with the communication separators). Refer to User-defined Table 0380 _ Separator type for suggested values. It is recommended that the first table entry be "NO" meaning "No Separator".
User-defined Table 0380 _ Separator type
13.4.3.13 SAC-13 Tray Identifier (EI) 01340
13.4.3.14 SAC-14 Position in Tray (NA) 01341
13.4.3.15 SAC-15 Location (CE) 01342
13.4.3.16 SAC-16 Container Height (NM) 01343
13.4.3.17 SAC-17 Container Diameter (NM) 01344
13.4.3.18 SAC-18 Barrier Delta (NM) 01345
13.4.3.19 SAC-19 Bottom Delta (NM) 01346
13.4.3.20 SAC-20 Container Diameter/Height/Delta Units (CE) 01347
13.4.3.21 SAC-21 Container Volume (NM) 00644
13.4.3.22 SAC-22 Available Specimen Volume (NM) 01349
13.4.3.23 SAC-23 Initial Specimen Volume (NM) 01350
13.4.3.24 SAC-24 Volume Units (CE) 01351
13.4.3.25 SAC-25 Separator Type (CE) 01352
Value | Description | Comment |
---|---|---|
| No suggested values defined |
|
Examples of values: NO (no separator), GEL (gel separator), M01 (manufacturer specific)
Components: <Identifier (ST)> ^ <Text (ST)> ^ <Name of Coding System (ID)> ^ <Alternate Identifier (ST)> ^ <Alternate Text (ST)> ^ <Name of Alternate Coding System (ID)>
Definition: This field indicates the type of cap that is to be used with this container for decapping, piercing or other mechanisms. Refer to User-defined Table 0381 _ Cap type for suggested values.
User-defined Table 0381 _ Cap type
Value | Description | Comment |
---|---|---|
| No suggested values defined |
|
Examples of values: SCR (screw cap), PSH (push cap), FOIL (foil)
Components: <Identifier (ST)> ^ <Text (ST)> ^ <Name of Coding System (ID)> ^ <Alternate Identifier (ST)> ^ <Alternate Text (ST)> ^ <Name of Alternate Coding System (ID)> ^ <Coding System Version ID (ST)> ^ <Alternate Coding System Version ID (ST)> ^ <Original Text (ST)>
Definition: This field identifies any additives introduced to the specimen before or at the time of collection. These additives may be introduced in order to preserve, maintain or enhance the particular nature or component of the specimen. It is a repetitive field. Refer to HL7 Table 0371 _ Additive for valid values. 'The value set can be extended with user specific values.
Components: <Identifier (ST)> ^ <Text (ST)> ^ <Name of Coding System (ID)> ^ <Alternate Identifier (ST)> ^ <Alternate Text (ST)> ^ <Name of Alternate Coding System (ID)>
Definition: This field identifies the specimen component, e.g., supernatant, sediment, etc. Refer to User-defined Table 0372 _ Specimen component for valid values. This table's values are taken from NCCLS AUTO4. The value set can be extended with user specific values.
User-defined Table 0372 - Specimen component
Value | Description | Comment |
---|---|---|
SUP | Supernatant |
|
SED | Sediment |
|
BLD | Whole blood, homogeneous |
|
BSEP | Whole blood, separated |
|
PRP | Platelet rich plasma |
|
PPP | Platelet poor plasma |
|
SER | Serum, NOS (not otherwise specified) |
|
PLAS | Plasma, NOS (not otherwise specified) |
|
Components: <Comparator (ST)> ^ <Num1 (NM)> ^ <Separator/Suffix (ST)> ^ <Num2 (NM)>
Definition: This field identifies the factor of dilution already performed on the specimen. The equipment entity that changes the dilution is responsible for sending this information to other equipment. If the endogenous content of the test (analyte) in the diluent is required for the calculation of the test (analyte) concentration, then the test (analyte) specific values should be exchanged between the systems via Master Files or other means.
Examples of use:
|^1^:^5| - means dilution 1 to 5, i.e., 1 part sample, 4 parts diluent
|^1^+| - sample is diluted, but the factor is unknown
|^1^:^1| - not diluted sample
|| - dilution not changed
Components: <Identifier (ST)> ^ <Text (ST)> ^ <Name of Coding System (ID)> ^ <Alternate Identifier (ST)> ^ <Alternate Text (ST)> ^ <Name of Alternate Coding System (ID)>
Definition: This field identifies the specimen treatment performed during lab processing. Refer to User-defined Table 0373 _ Treatment for valid values. This table's values are taken from NCCLS AUTO4. The value set can be extended with user specific values.
User-defined Table 0373 _ Treatment
13.4.3.29 SAC-29 Dilution Factor (SN) 01356
13.4.3.30 SAC-30 Treatment (CE) 01357
Value | Description | Comment |
---|---|---|
LDLP | LDL Precipitation |
|
RECA | Recalification |
|
DEFB | Defibrination |
|
ACID | Acidification |
|
NEUT | Neutralization |
|
ALK | Alkalization |
|
FILT | Filtration |
|
UFIL | Ultrafiltration |
|
Components: <Comparator (ST)> ^ <Num1 (NM)> ^ <Separator/Suffix (ST)> ^ <Num2 (NM)>
Definition: This field identifies the specimen temperature in degrees Celsius [°C] at the time of the transaction specified in the EQU segment.
Definition: This field is the index identifier that is being used to describe the Hemolysis Index of the specimen.
Components: <Identifier (ST)> ^ <Text (ST)> ^ <Name of Coding System (ID)> ^ <Alternate Identifier (ST)> ^ <Alternate Text (ST)> ^ <Name of Alternate Coding System (ID)>
Definition: This field is the unit's identifier that is being used to describe the Hemolysis Index of the specimen. It is recommended to use g/L. (The transmission of the index values is added here instead of the original use of the OBX segments, because the frequency of the transfer of the specimen details justifies use of more efficient mechanism.)
If this field is null, the recommended value is assumed.
Definition: This field is the index identifier that is being used to describe the Lipemia Index of the specimen. It is recommended to use the optical turbidity at 600 nm (in absorbance units).
Components: <Identifier (ST)> ^ <Text (ST)> ^ <Name of Coding System (ID)> ^ <Alternate Identifier (ST)> ^ <Alternate Text (ST)> ^ <Name of Alternate Coding System (ID)>
Definition: This field is the unit's identifier that is being used to describe the Lipemia Index of the specimen.
If this field is null, the recommended value is assumed.
Definition: This field is the index identifier that is being used to describe the Icterus Index of the specimen.
Components: <Identifier (ST)> ^ <Text (ST)> ^ <Name of Coding System (ID)> ^ <Alternate Identifier (ST)> ^ <Alternate Text (ST)> ^ <Name of Alternate Coding System (ID)>
Definition: This field is the unit's identifier that is being used to describe the Icterus Index of the specimen. It is recommended to use mMol/L of bilirubin.
If this field is null, the recommended value is assumed.
Definition: This field is the index identifier that is being used to describe the Fibrin Index of the specimen. In the case of only differentiating between Absent and Present, we recommend using 0 and 1 respectively and send the field Fibrin Index Units null.
Components: <Identifier (ST)> ^ <Text (ST)> ^ <Name of Coding System (ID)> ^ <Alternate Identifier (ST)> ^ <Alternate Text (ST)> ^ <Name of Alternate Coding System (ID)>
Definition: This field is the unit's identifier that is being used to describe the Fibrin Index of the specimen.
Components: <Identifier (ST)> ^ <Text (ST)> ^ <Name of Coding System (ID)> ^ <Alternate Identifier (ST)> ^ <Alternate Text (ST)> ^ <Name of Alternate Coding System (ID)>
Definition: This field describes the specimen contaminant identifier that is associated with the specimen in this container. Refer to User-defined Table 0374 _ System induced contaminants for valid values. This table's values are taken from NCCLS AUTO4. The value set can be extended with user specific values.
User-defined Table 0374 - System induced contaminants
13.4.3.31 SAC-31 Temperature (SN) 01358
13.4.3.32 SAC-32 Hemolysis Index (NM) 01359
13.4.3.33 SAC-33 Hemolysis Index Units (CE) 01360
13.4.3.34 SAC-34 Lipemia Index (NM) 01361
13.4.3.35 SAC-35 Lipemia Index Units (CE) 01362
13.4.3.36 SAC-36 Icterus Index (NM) 01363
13.4.3.37 SAC-37 Icterus Index Units (CE) 01364
13.4.3.38 SAC-38 Fibrin Index (NM) 01365
13.4.3.39 SAC-39 Fibrin Index Units (CE) 01366
13.4.3.40 SAC-40 System Induced Contaminants (CE) 01367
Value | Description | Comment |
---|---|---|
CNTM | Present, type of contamination unspecified |
|
Components: <Identifier (ST)> ^ <Text (ST)> ^ <Name of Coding System (ID)> ^ <Alternate Identifier (ST)> ^ <Alternate Text (ST)> ^ <Name of Alternate Coding System (ID)>
Definition: This field describes the drug interference identifier that is associated with the specimen. Refer to User-defined Table 0382 _ Drug interference for suggested values.
User-defined Table 0382 _ Drug interference
13.4.3.41 SAC-41 Drug Interference (CE) 01368
Value | Description | Comment |
---|---|---|
| No suggested values defined |
|
Components: <Identifier (ST)> ^ <Text (ST)> ^ <Name of Coding System (ID)> ^ <Alternate Identifier (ST)> ^ <Alternate Text (ST)> ^ <Name of Alternate Coding System (ID)>
Definition: This field describes the artificial blood identifier that is associated with the specimen. Refer to User-defined Table 0375 _ Artificial blood for valid values. This table's values are taken from NCCLS AUTO4. The value set can be extended with user specific values.
User-defined Table 0375 - Artificial blood
13.4.3.42 SAC-42 Artificial Blood (CE) 01369
Value | Description | Comment |
---|---|---|
SFHB | Stromal free hemoglobin preparations |
|
FLUR | Fluorocarbons |
|
Components: <Identifier (ST)> ^ <Text (ST)> ^ <Name of Coding System (ID)> ^ <Alternate Identifier (ST)> ^ <Alternate Text (ST)> ^ <Name of Alternate Coding System (ID)> ^ <Coding System Version ID (ST)> ^ <Alternate Coding System Version ID (ST)> ^ <Original Text (ST)>
Definition: This field describes any special handling considerations that are associated with the specimen in the specific container (e.g. centrifugation). This describes how the specimen needs to be stored during collection, in transit, and upon receipt. Refer to User-defined Table 0376 _ Special handling code for valid values. 'The value set can be extended with user specific values.
Components: <Identifier (ST)> ^ <Text (ST)> ^ <Name of Coding System (ID)> ^ <Alternate Identifier (ST)> ^ <Alternate Text (ST)> ^ <Name of Alternate Coding System (ID)>
Definition: This field describes other environmental factors that are associated with the specimen in a specific container, e.g., atmospheric exposure. Refer to User-defined Table 0377 _ Other environmental factors for valid values. This table's values are taken from NCCLS AUTO4. The value set can be extended with user specific values.
User-defined Table 0377 - Other environmental factors
13.4.3.43 SAC-43 Special Handling Code (CWE) 01370
13.4.3.44 SAC-44 Other Environmental Factors (CE) 01371
Value | Description | Comment |
---|---|---|
ATM | Opened container, atmosphere and duration unspecified |
|
A60 | Opened container, indoor atmosphere, 60 minutes duration |
|
The inventory detail segment is the data necessary to track the inventory of substances (e.g. reagent, tips, waste) on equipment.
Figure 13-6. Information on the Types of Measures on a Container
HL7 Attribute Table _ INV _ Inventory Detail
13.4.4 INV _ Inventory Detail Segment
SEQ | LEN | DT | OPT | RP/# | TBL# | ITEM # | ELEMENT NAME | DB Ref. |
---|---|---|---|---|---|---|---|---|
1 | 250 | CE | R |
| 0451 | 01372 | Substance Identifier | DB |
2 | 250 | CE | R | Y | 0383 | 01373 | Substance Status | DB |
3 | 250 | CE | O |
| 0384 | 01374 | Substance Type | DB |
4 | 250 | CE | O |
|
| 01532 | Inventory Container Identifier | DB |
5 | 250 | CE | O |
|
| 01376 | Container Carrier Identifier | DB |
6 | 250 | CE | O |
|
| 01377 | Position on Carrier | DB |
7 | 20 | NM | O |
|
| 01378 | Initial Quantity | DB |
8 | 20 | NM | O |
|
| 01379 | Current Quantity | DB |
9 | 20 | NM | O |
|
| 01380 | Available Quantity | DB |
10 | 20 | NM | O |
|
| 01381 | Consumption Quantity | DB |
11 | 250 | CE | O |
|
| 01382 | Quantity Units | DB |
12 | 26 | TS | O |
|
| 01383 | Expiration Date/Time | DB |
13 | 26 | TS | O |
|
| 01384 | First Used Date/Time | DB |
14 | 200 | TQ | B |
|
| 01385 | On Board Stability Duration | DB |
15 | 250 | CE | O | Y |
| 01386 | Test/Fluid Identifier(s) | DB |
16 | 200 | ST | O |
|
| 01387 | Manufacturer Lot Number | DB |
17 | 250 | CE | O |
| 0385 | 00286 | Manufacturer Identifier | DB |
18 | 250 | CE | O |
| 0386 | 01389 | Supplier Identifier | DB |
19 | 20 | CQ | O |
|
| 01626 | On Board Stability Time | DB |
20 | 20 | CQ | O |
|
| 01896 | Target Value | DB |
Components: <Identifier (ST)> ^ <Text (ST)> ^ <Name of Coding System (ID)> ^ <Alternate Identifier (ST)> ^ <Alternate Text (ST)> ^ <Name of Alternate Coding System (ID)>
Definition: Unique identifier for the substance that is in inventory. This is a manufacturer-specific identifier.
User-defined Table 0451 _ Substance identifier
13.4.4.0 INV Field Definitions
13.4.4.1 INV-1 Substance Identifier (CE) 01372
Value | Description | Comment |
---|---|---|
ALL | Used for query of all inventory items |
|
Components: <Identifier (ST)> ^ <Text (ST)> ^ <Name of Coding System (ID)> ^ <Alternate Identifier (ST)> ^ <Alternate Text (ST)> ^ <Name of Alternate Coding System (ID)>
Definition: The status of the inventoried item. The status indicates the current status of the substance. Refer to HL7 Table 0383 _ Substance status for suggested values.
HL7 Table 0383 - Substance status
13.4.4.2 INV-2 Substance Status (CE) 01373
Value | Description | Comment |
---|---|---|
EW | Expired Warning |
|
EE | Expired Error |
|
CW | Calibration Warning |
|
CE | Calibration Error |
|
QW | QC Warning |
|
QE | QC Error |
|
NW | Not Available Warning |
|
NE | Not Available Error |
|
OW | Other Warning |
|
OE | Other Error |
|
OK | OK Status |
|
Components: <Identifier (ST)> ^ <Text (ST)> ^ <Name of Coding System (ID)> ^ <Alternate Identifier (ST)> ^ <Alternate Text (ST)> ^ <Name of Alternate Coding System (ID)>
Definition: The type of substance. Refer to HL7 Table 0384 _ Substance type for suggested values.
HL7 Table 0384 - Substance type
13.4.4.3 INV-3 Substance Type (CE) 01374
Value | Description | Comment |
---|---|---|
SR | Single Test Reagent |
|
MR | Multiple Test Reagent | The consumption cannot be tied to orders for a single test |
DI | Diluent |
|
PT | Pretreatment |
|
RC | Reagent Calibrator |
|
CO | Control |
|
PW | Purified Water |
|
LW | Liquid Waste |
|
SW | Solid Waste |
|
SC | Countable Solid Item | E.g., Pipetting tip |
LI | Measurable Liquid Item |
|
OT | Other |
|
Components: <Identifier (ST)> ^ <Text (ST)> ^ <Name of Coding System (ID)> ^ <Alternate Identifier (ST)> ^ <Alternate Text (ST)> ^ <Name of Alternate Coding System (ID)>
Definition: Identifies the inventory container, e.g., unique identifier of a specific package instance of a specific substance. This is a manufacturer-specific identifier.
Components: <Identifier (ST)> ^ <Text (ST)> ^ <Name of Coding System (ID)> ^ <Alternate Identifier (ST)> ^ <Alternate Text (ST)> ^ <Name of Alternate Coding System (ID)>
Definition: This is the carrier used to transport the substance containers, (e.g., a removable rotor with reagent bottles).
Components: <Identifier (ST)> ^ <Text (ST)> ^ <Name of Coding System (ID)> ^ <Alternate Identifier (ST)> ^ <Alternate Text (ST)> ^ <Name of Alternate Coding System (ID)>
Definition: Identifies the position (e.g., index) on the carrier.
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.
Components: <Identifier (ST)> ^ <Text (ST)> ^ <Name of Coding System (ID)> ^ <Alternate Identifier (ST)> ^ <Alternate Text (ST)> ^ <Name of Alternate Coding System (ID)>
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.
Components: <Time (DTM)> ^ <DEPRECATED-Degree of Precision (ID)>
Definition: This field is the expiration date/time of the substance.
Components: <Time (DTM)> ^ <DEPRECATED-Degree of Precision (ID)>
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.
Components: <Quantity (CQ)> ^ <Interval (RI)> ^ <Duration (ST)> ^ <Start Date/Time (TS)> ^ <End Date/Time (TS)> ^ <Priority (ST)> ^ <Condition (ST)> ^ <Text (TX)> ^ <Conjunction (ID)> ^ <Order Sequencing (OSD)> ^ <Occurrence Duration (CE)> ^ <Total Occurrences (NM)>
Subcomponents for Quantity (CQ): <Quantity (NM)> & <Units (CE)>
Note subcomponent contains sub-subcomponents
Subcomponents for Interval (RI): <Repeat Pattern (IS)> & <Explicit Time Interval (ST)>
Subcomponents for Start Date/Time (TS): <Time (DTM)> & <DEPRECATED-Degree of Precision (ID)>
Subcomponents for End Date/Time (TS): <Time (DTM)> & <DEPRECATED-Degree of Precision (ID)>
Subcomponents for Order Sequencing (OSD): <Sequence/Results Flag (ID)> & <Placer Order Number: Entity Identifier (ST)> & <Placer Order Number: Namespace ID (IS)> & <Filler Order Number: Entity Identifier (ST)> & <Filler Order Number: Namespace ID (IS)> & <Sequence Condition Value (ST)> & <Maximum Number of Repeats (NM)> & <Placer Order Number: Universal ID (ST)> & <Placer Order Number: Universal ID Type (ID)> & <Filler Order Number: Universal ID (ST)> & <Filler Order Number: Universal ID Type (ID)>
Subcomponents for Occurrence Duration (CE): <Identifier (ST)> & <Text (ST)> & <Name of Coding System (ID)> & <Alternate Identifier (ST)> & <Alternate Text (ST)> & <Name of Alternate Coding System (ID)>
Definition: This field is the time duration that the substance is stable. This field is left for backward compatibility only. The TQ data type was deprecated, see section 2.A.81 (chapter 2). The field INV-19 "On board stability time" should be used to represent this concept.
Components: <Identifier (ST)> ^ <Text (ST)> ^ <Name of Coding System (ID)> ^ <Alternate Identifier (ST)> ^ <Alternate Text (ST)> ^ <Name of Alternate Coding System (ID)>
Definition: This field is the list of tests and body fluid that apply to this substance. This is a repeating field. An empty field means that this substance is not test specific, i.e., it applies to all tests.
Definition: This field specifies the lot number assigned by the manufacturer during production of the substance.
Components: <Identifier (ST)> ^ <Text (ST)> ^ <Name of Coding System (ID)> ^ <Alternate Identifier (ST)> ^ <Alternate Text (ST)> ^ <Name of Alternate Coding System (ID)>
Definition: This field identifies the manufacturer of this substance. Refer to User-defined Table 0385 _ Manufacturer identifier for suggested values. Relevant external code systems may be used, e.g., HIBCC Manufacturers Labeler ID Code (LIC), UPC, NDC, etc.
User-defined Table 0385 _ Manufacturer identifier
13.4.4.4 INV-4 Inventory Container Identifier (CE) 01532
13.4.4.5 INV-5 Container Carrier Identifier (CE) 01376
13.4.4.6 INV-6 Position on Carrier (CE) 01377
13.4.4.7 INV-7 Initial Quantity (NM) 01378
13.4.4.8 INV-8 Current Quantity (NM) 01379
13.4.4.9 INV-9 Available Quantity (NM) 01380
13.4.4.10 INV-10 Consumption Quantity (NM) 01381
13.4.4.11 INV-11 Quantity Units (CE) 01382
13.4.4.12 INV-12 Expiration Date/Time (TS) 01383
13.4.4.13 INV-13 First Used Date/Time (TS) 01384
13.4.4.14 INV-14 On Board Stability Duration (TQ) 01385
13.4.4.15 INV-15 Test/Fluid Identifier(s) (CE) 01386
13.4.4.16 INV-16 Manufacturer Lot Number (ST) 01387
13.4.4.17 INV-17 Manufacturer Identifier (CE) 00286
Value | Description | Comment |
---|---|---|
| No suggested value defined |
|
Components: <Identifier (ST)> ^ <Text (ST)> ^ <Name of Coding System (ID)> ^ <Alternate Identifier (ST)> ^ <Alternate Text (ST)> ^ <Name of Alternate Coding System (ID)>
Definition: This field identifies the supplier of this substance. Refer to User-defined Table 0386 _ Supplier identifier for suggested values.
User-defined Table 0386 _ Supplier identifier
13.4.4.18 INV-18 Supplier Identifier (CE) 01389
Value | Description | Comment |
---|---|---|
| No suggested value defined |
|
Components: <Quantity (NM)> ^ <Units (CE)>
Subcomponents for Units (CE): <Identifier (ST)> & <Text (ST)> & <Name of Coding System (ID)> & <Alternate Identifier (ST)> & <Alternate Text (ST)> & <Name of Alternate Coding System (ID)>
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".
Components: <Quantity (NM)> ^ <Units (CE)>
Subcomponents for Units (CE): <Identifier (ST)> & <Text (ST)> & <Name of Coding System (ID)> & <Alternate Identifier (ST)> & <Alternate Text (ST)> & <Name of Alternate Coding System (ID)>
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.
The equipment command segment contains the information required to notify the receiving component what is to happen.
HL7 Attribute Table _ ECD _ Equipment Command
13.4.4.19 INV-19 On Board Stability Time (CQ) 01626
13.4.4.20 INV-20 Target Value (CQ) 01896
13.4.5 ECD - Equipment Command Segment
SEQ | LEN | DT | OPT | RP/# | TBL# | ITEM # | ELEMENT NAME | DB Ref. |
---|---|---|---|---|---|---|---|---|
1 | 20 | NM | R |
|
| 01390 | Reference Command Number | DB |
2 | 250 | CE | R |
| 0368 | 01391 | Remote Control Command | DB |
3 | 80 | ID | O |
| 0136 | 01392 | Response Required | DB |
4 | 200 | TQ | B |
|
| 01393 | Requested Completion Time | DB |
5 | 65536 | TX | O | Y |
| 01394 | Parameters | DB |
Definition: This field contains the unique identifier for this particular command that should be used by the various components for future referral to this command. It is similar to the concept of MSH-10 "Message control ID", but at the equipment command/response level. This number is generated by the originator of this command.
Components: <Identifier (ST)> ^ <Text (ST)> ^ <Name of Coding System (ID)> ^ <Alternate Identifier (ST)> ^ <Alternate Text (ST)> ^ <Name of Alternate Coding System (ID)>
Definition: This field identifies the command that the component is to initiate. Refer to User-defined Table 0368 _ Remote control command for valid values. Refer to LECIS standard for details.
User-defined Table 0368 - Remote control command
13.4.5.0 ECD Field Definitions
13.4.5.1 ECD-1 Reference Command Number (NM) 01390
13.4.5.2 ECD-2 Remote Control Command (CE) 01391
Value | Description | Comment |
---|---|---|
SA | Sampling |
|
LO | Load |
|
UN | Unload |
|
LK | Lock |
|
UC | Unlock |
|
TT | Transport To |
|
CN | Clear Notification |
|
IN | Initialize/Initiate |
|
SU | Setup |
|
CL | Clear |
|
PA | Pause |
|
RE | Resume |
|
ES | Emergency _stop |
|
LC | Local Control Request |
|
RC | Remote Control Request |
|
AB | Abort |
|
EN | Enable Sending Events |
|
DI | Disable Sending Events |
|
EX | Execute (command specified in field Parameters (ST) 01394) |
|
Definition: This field identifies the mode of synchronization that is to be used in relation to the execution of the command. "Y" (Yes) means that the response is required immediately after execution, "N" (No) response is not required at all. Refer to HL7 Table 0136 _ Yes/no indicator for valid values.
Components: <Quantity (CQ)> ^ <Interval (RI)> ^ <Duration (ST)> ^ <Start Date/Time (TS)> ^ <End Date/Time (TS)> ^ <Priority (ST)> ^ <Condition (ST)> ^ <Text (TX)> ^ <Conjunction (ID)> ^ <Order Sequencing (OSD)> ^ <Occurrence Duration (CE)> ^ <Total Occurrences (NM)>
Subcomponents for Quantity (CQ): <Quantity (NM)> & <Units (CE)>
Note subcomponent contains sub-subcomponents
Subcomponents for Interval (RI): <Repeat Pattern (IS)> & <Explicit Time Interval (ST)>
Subcomponents for Start Date/Time (TS): <Time (DTM)> & <DEPRECATED-Degree of Precision (ID)>
Subcomponents for End Date/Time (TS): <Time (DTM)> & <DEPRECATED-Degree of Precision (ID)>
Subcomponents for Order Sequencing (OSD): <Sequence/Results Flag (ID)> & <Placer Order Number: Entity Identifier (ST)> & <Placer Order Number: Namespace ID (IS)> & <Filler Order Number: Entity Identifier (ST)> & <Filler Order Number: Namespace ID (IS)> & <Sequence Condition Value (ST)> & <Maximum Number of Repeats (NM)> & <Placer Order Number: Universal ID (ST)> & <Placer Order Number: Universal ID Type (ID)> & <Filler Order Number: Universal ID (ST)> & <Filler Order Number: Universal ID Type (ID)>
Subcomponents for Occurrence Duration (CE): <Identifier (ST)> & <Text (ST)> & <Name of Coding System (ID)> & <Alternate Identifier (ST)> & <Alternate Text (ST)> & <Name of Alternate Coding System (ID)>
Definition: This field identifies when the remote control action must be completed. The devices managed in the LAS should have synchronized time (use original HL7 message NMQ, NMD with "System Clock Segment" NCK). If relative time quantity is used, then the referenced time is the time transferred in the EQU segment.
As of version 2.5 this field is defined for backward compatibility only. The TQ data type was deprecated, see section 2.A.81 (chapter 2). Instead use the "Explicit time" (TQ1-4) or "Relative Time and Units" (TQ1-5) fields of the TQ1 segment in a message using ECD segment.
Definition: This field identifies the parameters of the command (if they are not included in separate segment[s]).
Note: Elements of this segment (or other elements not defined here) may be required for certain vendor-specific equipment such as centrifuges, aliquoters, sorters, uncappers, recappers, automated storage units, etc.
The equipment command response segment contains the receiving component's response to the previously received command.
HL7 Attribute Table _ ECR _ Equipment Command Response
13.4.5.3 ECD-3 Response Required (ID) 01392
13.4.5.4 ECD-4 Requested Completion Time (TQ) 01393
13.4.5.5 ECD-5 Parameters (TX) 01394
13.4.6 ECR - Equipment Command Response Segment
SEQ | LEN | DT | OPT | RP/# | TBL# | ITEM # | ELEMENT NAME | DB Ref. |
---|---|---|---|---|---|---|---|---|
1 | 250 | CE | R |
| 0387 | 01395 | Command Response | DB |
2 | 26 | TS | R |
|
| 01396 | Date/Time Completed | DB |
3 | 65536 | TX | O | Y |
| 01397 | Command Response Parameters | DB |
Components: <Identifier (ST)> ^ <Text (ST)> ^ <Name of Coding System (ID)> ^ <Alternate Identifier (ST)> ^ <Alternate Text (ST)> ^ <Name of Alternate Coding System (ID)>
Definition: This field identifies the response of the previously issued command. Refer to User-defined Table 0387 _ Command response for valid values.
User-defined Table 0387 - Command response
13.4.6.0 ECR Field Definitions
13.4.6.1 ECR-1 Command Response (CE) 01395
Value | Description | Comment |
---|---|---|
OK | Command completed successfully |
|
TI | Command cannot be completed within requested completion time |
|
ER | Command cannot be completed because of error condition | See response parameters. |
ST | Command cannot be completed because of the status of the requested equipment |
|
UN | Command cannot be completed for unknown reasons |
|
Components: <Time (DTM)> ^ <DEPRECATED-Degree of Precision (ID)>
Definition: This field contains the date and time that the receiving component completed the requested command.
Definition: This field identifies any associated parameters that relate to the returned response command message.
The equipment notification detail segment is the data necessary to maintain an adequate audit trail as well as notifications of events, (e.g., alarms that have occurred on a particular piece of equipment.
HL7 Attribute Table _ NDS _ Notification Detail
13.4.6.2 ECR-2 Date/Time Completed (TS) 01396
13.4.6.3 ECR-3 Command Response Parameters (TX) 01397
13.4.7 NDS - Notification Detail Segment
SEQ | LEN | DT | OPT | RP/# | TBL# | ITEM # | ELEMENT NAME | DB Ref. |
---|---|---|---|---|---|---|---|---|
1 | 20 | NM | R |
|
| 01398 | Notification Reference Number | DB |
2 | 26 | TS | R |
|
| 01399 | Notification Date/Time | DB |
3 | 250 | CE | R |
| 0367 | 01400 | Notification Alert Severity | DB |
4 | 250 | CE | R |
|
| 01401 | Notification Code | DB |
Definition: This field contains a unique sequential reference number that may be used by various components to refer to this transaction. This number is generated by the originator of this notification.
Components: <Time (DTM)> ^ <DEPRECATED-Degree of Precision (ID)>
Definition: This field is the date/time of the notifications.
Components: <Identifier (ST)> ^ <Text (ST)> ^ <Name of Coding System (ID)> ^ <Alternate Identifier (ST)> ^ <Alternate Text (ST)> ^ <Name of Alternate Coding System (ID)>
Definition: The severity of the specific notification. Refer to HL7 Table 0367 - Alert level for valid entries.
Components: <Identifier (ST)> ^ <Text (ST)> ^ <Name of Coding System (ID)> ^ <Alternate Identifier (ST)> ^ <Alternate Text (ST)> ^ <Name of Alternate Coding System (ID)>
Definition: This field contains information about the type of notification being sent. These are manufacturer and equipment specific error or status codes, e.g., AQN0123 _ aliquoting error _ clot detected.
The clear equipment notification segment contains the data necessary to allow the receiving equipment to clear any associated notifications.
HL7 Attribute Table _ CNS _ Clear Notification
13.4.7.0 NDS Field Definitions
13.4.7.1 NDS-1 Notification Reference Number (NM) 01398
13.4.7.2 NDS-2 Notification Date/Time (TS) 01399
13.4.7.3 NDS-3 Notification Alert Severity (CE) 01400
13.4.7.4 NDS-4 Notification Code (CE) 01401
13.4.8 CNS _ Clear Notification Segment
SEQ | LEN | DT | OPT | RP/# | TBL# | ITEM # | ELEMENT NAME | DB Ref. |
---|---|---|---|---|---|---|---|---|
1 | 20 | NM | O |
|
| 01402 | Starting Notification Reference Number | DB |
2 | 20 | NM | O |
|
| 01403 | Ending Notification Reference Number | DB |
3 | 26 | TS | O |
|
| 01404 | Starting Notification Date/Time | DB |
4 | 26 | TS | O |
|
| 01405 | Ending Notification Date/Time | DB |
5 | 250 | CE | O |
|
| 01406 | Starting Notification Code | DB |
6 | 250 | CE | O |
|
| 01407 | Ending Notification Code | DB |
Definition: This field contains the starting notification reference number that is to be cleared.
Definition: This field contains the ending notification reference number that is to be cleared. If empty, then only notification with Starting Notification Reference Number will be cleared.
Components: <Time (DTM)> ^ <DEPRECATED-Degree of Precision (ID)>
Definition: This field is the starting date/time of the notifications to be cleared. If this field is empty but Ending Notification Date/Time is filled, then all notifications before Ending Notification Date/Time will be cleared.
Components: <Time (DTM)> ^ <DEPRECATED-Degree of Precision (ID)>
Definition: This field is the ending date/time of the notifications to be cleared. If this field is empty but Starting Notification Date/Time is filled, then all notifications after Starting Notification Date/Time will be cleared.
Components: <Identifier (ST)> ^ <Text (ST)> ^ <Name of Coding System (ID)> ^ <Alternate Identifier (ST)> ^ <Alternate Text (ST)> ^ <Name of Alternate Coding System (ID)>
Definition: This field contains the starting notification code that is to be cleared (see 13.4.7.4 NDS-4 Notification Code (CE) 01401).
Components: <Identifier (ST)> ^ <Text (ST)> ^ <Name of Coding System (ID)> ^ <Alternate Identifier (ST)> ^ <Alternate Text (ST)> ^ <Name of Alternate Coding System (ID)>
Definition: This field contains the ending notification code that is to be cleared (see 13.4.7.4 NDS-4 Notification Code (CE) 01401). If empty, then only notification with Starting Notification Code will be cleared.
The test (e.g., analyte) code configuration segment is the data necessary to maintain and transmit information concerning the test entity codes that are being used throughout the "automated system."
HL7 Attribute Table _ TCC _ Test Code Configuration
13.4.8.0 CNS Field Definitions
13.4.8.1 CNS-1 Starting Notification Reference Number (NM) 01402
13.4.8.2 CNS-2 Ending Notification Reference Number (NM) 01403
13.4.8.3 CNS-3 Starting Notification Date/Time (TS) 01404
13.4.8.4 CNS-4 Ending Notification Date/Time (TS) 01405
13.4.8.5 CNS-5 Starting Notification Code (CE) 01406
13.4.8.6 CNS-6 Ending Notification Code (CE) 01407
13.4.9 TCC - Test Code Configuration Segment
SEQ | LEN | DT | OPT | RP/# | TBL# | ITEM # | ELEMENT NAME | DB Ref. |
---|---|---|---|---|---|---|---|---|
1 | 250 | CE | R |
|
| 00238 | Universal Service Identifier | DB |
2 | 80 | EI | R |
|
| 01408 | Test Application Identifier | DB |
3 | 300 | SPS | B |
|
| 00249 | Specimen Source | DB |
4 | 20 | SN | O |
|
| 01410 | Auto-Dilution Factor Default | DB |
5 | 20 | SN | O |
|
| 01411 | Rerun Dilution Factor Default | DB |
6 | 20 | SN | O |
|
| 01412 | Pre-Dilution Factor Default | DB |
7 | 20 | SN | O |
|
| 01413 | Endogenous Content of Pre-Dilution Diluent | DB |
8 | 10 | NM | O |
|
| 01414 | Inventory Limits Warning Level | DB |
9 | 1 | ID | O |
| 0136 | 01415 | Automatic Rerun Allowed | DB |
10 | 1 | ID | O |
| 0136 | 01416 | Automatic Repeat Allowed | DB |
11 | 1 | ID | O |
| 0136 | 01417 | Automatic Reflex Allowed | DB |
12 | 20 | SN | O |
|
| 01418 | Equipment Dynamic Range | DB |
13 | 250 | CE | O |
|
| 00574 | Units | DB |
14 | 250 | CE | O |
| 0388 | 01419 | Processing Type | DB |
Components: <Identifier (ST)> ^ <Text (ST)> ^ <Name of Coding System (ID)> ^ <Alternate Identifier (ST)> ^ <Alternate Text (ST)> ^ <Name of Alternate Coding System (ID)>
Definition: This field identifies the test code that information is being transmitted about. The alternate elements represent the test code identifier that has been assigned by the manufacturer to this particular test code.
Components: <Entity Identifier (ST)> ^ <Namespace ID (IS)> ^ <Universal ID (ST)> ^ <Universal ID Type (ID)>
Definition: This field identifies the test application code assigned by the manufacturer of the equipment or reagents and associated with performing of the particular test specified by the Universal Test Identifier.
Components: <Specimen Source Name or Code (CWE)> ^ <Additives (CWE)> ^ <Specimen Collection Method (TX)> ^ <Body Site (CWE)> ^ <Site Modifier (CWE)> ^ <Collection Method Modifier Code (CWE)> ^ <Specimen Role (CWE)>
Subcomponents for Specimen Source Name or Code (CWE): <Identifier (ST)> & <Text (ST)> & <Name of Coding System (ID)> & <Alternate Identifier (ST)> & <Alternate Text (ST)> & <Name of Alternate Coding System (ID)> & <Coding System Version ID (ST)> & <Alternate Coding System Version ID (ST)> & <Original Text (ST)>
Subcomponents for Additives (CWE): <Identifier (ST)> & <Text (ST)> & <Name of Coding System (ID)> & <Alternate Identifier (ST)> & <Alternate Text (ST)> & <Name of Alternate Coding System (ID)> & <Coding System Version ID (ST)> & <Alternate Coding System Version ID (ST)> & <Original Text (ST)>
Subcomponents for Body Site (CWE): <Identifier (ST)> & <Text (ST)> & <Name of Coding System (ID)> & <Alternate Identifier (ST)> & <Alternate Text (ST)> & <Name of Alternate Coding System (ID)> & <Coding System Version ID (ST)> & <Alternate Coding System Version ID (ST)> & <Original Text (ST)>
Subcomponents for Site Modifier (CWE): <Identifier (ST)> & <Text (ST)> & <Name of Coding System (ID)> & <Alternate Identifier (ST)> & <Alternate Text (ST)> & <Name of Alternate Coding System (ID)> & <Coding System Version ID (ST)> & <Alternate Coding System Version ID (ST)> & <Original Text (ST)>
Subcomponents for Collection Method Modifier Code (CWE): <Identifier (ST)> & <Text (ST)> & <Name of Coding System (ID)> & <Alternate Identifier (ST)> & <Alternate Text (ST)> & <Name of Alternate Coding System (ID)> & <Coding System Version ID (ST)> & <Alternate Coding System Version ID (ST)> & <Original Text (ST)>
Subcomponents for Specimen Role (CWE): <Identifier (ST)> & <Text (ST)> & <Name of Coding System (ID)> & <Alternate Identifier (ST)> & <Alternate Text (ST)> & <Name of Alternate Coding System (ID)> & <Coding System Version ID (ST)> & <Alternate Coding System Version ID (ST)> & <Original Text (ST)>
Definition: This field is the site where the specimen should be obtained or where the service should be performed.
As of version 2.5 this field is deprecated and retained for backward compatibility. This field is conditional, meaning that, in case where the SPM segment is used in a message together with the SAC, this field should be ignored. The reader is referred to the SPM Specimen segment in chapter 7.
Components: <Comparator (ST)> ^ <Num1 (NM)> ^ <Separator/Suffix (ST)> ^ <Num2 (NM)>
Definition: This field is the value that is to be used as the default factor for automatically diluting a specimen by an instrument for this particular test code. (See examples in definition of "Dilution factor" (SAC-29) in the "Specimen Container Detail Segment".)
Components: <Comparator (ST)> ^ <Num1 (NM)> ^ <Separator/Suffix (ST)> ^ <Num2 (NM)>
Definition: This field is the value that is to be used as the default factor for automatically diluting a specimen in case of rerun for this particular test code.
Components: <Comparator (ST)> ^ <Num1 (NM)> ^ <Separator/Suffix (ST)> ^ <Num2 (NM)>
Definition: This field is the value that is to be used as the default factor for a specimen that is delivered to the laboratory automation system as pre-diluted for this particular test code.
Components: <Comparator (ST)> ^ <Num1 (NM)> ^ <Separator/Suffix (ST)> ^ <Num2 (NM)>
Definition: This field represents a baseline value for the measured test that is inherently contained in the diluent. In the calculation of the actual result for the measured test, this baseline value is normally considered.
Definition: This field is the value that is to be used as the threshold for initiating inventory warning-level messages.
Definition: This field identifies whether or not automatic reruns are to be initiated on specimens for this particular test code. Refer to HL7 Table 0136 -Yes/no indicator for valid values.
Definition: This field identifies whether or not automatic repeat testing is to be initiated on specimens for this particular test code. Refer to HL7 Table 0136 -Yes/no indicator for valid values.
Definition: This field identifies whether or not automatic or manual reflex testing is to be initiated on specimens for this particular test code. Refer to HL7 Table 0136 -Yes/no indicator for valid values.
Components: <Comparator (ST)> ^ <Num1 (NM)> ^ <Separator/Suffix (ST)> ^ <Num2 (NM)>
Definition: This is the range over which the equipment can produce results.
Components: <Identifier (ST)> ^ <Text (ST)> ^ <Name of Coding System (ID)> ^ <Alternate Identifier (ST)> ^ <Alternate Text (ST)> ^ <Name of Alternate Coding System (ID)>
Definition: This field is the units that have a data type of CE. The default coding system for the units codes consists of the ISO+ abbreviation for a single case unit (ISO 2955-83) plus extensions, that do not collide with ISO abbreviations (see Section 7.4.2.6). We designate this coding system as ISO+. Both the ISO unit's abbreviations and the extensions are defined in Section 7.4.2.6.2 and listed in Figure 7-9. The ISO+ abbreviations are the codes for the default coding system. Consequently, when ISO+ units are being used, only ISO+ abbreviations need be sent, and the contents of the units field will be backward compatible to HL7 Version 2.1. For more information on this field see reference Chapter 7, Section 7.4.2.6.
These units apply to fields "Endogenous content of pre-dilution diluent" and "Equipment dynamic range".
Components: <Identifier (ST)> ^ <Text (ST)> ^ <Name of Coding System (ID)> ^ <Alternate Identifier (ST)> ^ <Alternate Text (ST)> ^ <Name of Alternate Coding System (ID)>
Definition: This field identifies the processing type that applies to this test code. If this attribute is omitted, then regular production is the default. Refer to HL7 Table 0388 _ Processing type for valid values.
HL7 Table 0388 - Processing type
13.4.9.0 TCC Field Definitions
13.4.9.1 TCC-1 Universal SERVICE IDENTIFIER (CE) 00238
13.4.9.2 TCC-2 Equipment Test Application Identifier (EI) 01408
13.4.9.3 TCC-3 Specimen Source (SPS) 00249
13.4.9.4 ""TCC-4 Auto-Dilution Factor Default (SN) 01410
13.4.9.5 TCC-5 Rerun Dilution Factor Default (SN) 01411
13.4.9.6 TCC-6 Pre-Dilution Factor Default (SN) 01412
13.4.9.7 TCC-7 Endogenous Content of Pre-Dilution diluent (SN) 01413
13.4.9.8 TCC-8 Inventory Limits Warning Level (NM) 01414
13.4.9.9 TCC-9 Automatic Rerun Allowed (ID) 01415
13.4.9.10 TCC-10 Automatic Repeat Allowed (ID) 01416
13.4.9.11 TCC-11 Automatic Reflex Allowed (ID) 01417
13.4.9.12 TCC-12 Equipment Dynamic Range (SN) 01418
13.4.9.13 TCC-13 Units (CE) 00574
13.4.9.14 TCC-14 Processing Type (CE) 01419
Value | Description | Comment |
---|---|---|
P | Regular Production |
|
E | Evaluation |
|
The test code detail segment contains the data necessary to perform operations or calculations, or execute decisions by the laboratory automation system, and which are not supported by the original HL7 segments related to orders (ORC, OBR). For detail of use see messages of laboratory orders and observations in chapters 4 and 7.
HL7 Attribute Table _ TCD _ Test Code Detail
13.4.10 TCD - Test Code Detail Segment
SEQ | LEN | DT | OPT | RP/# | TBL# | ITEM # | ELEMENT NAME | DB Ref. |
---|---|---|---|---|---|---|---|---|
1 | 250 | CE | R |
|
| 00238 | Universal Service Identifier | DB |
2 | 20 | SN | O |
|
| 01420 | Auto-Dilution Factor | DB |
3 | 20 | SN | O |
|
| 01421 | Rerun Dilution Factor | DB |
4 | 20 | SN | O |
|
| 01422 | Pre-Dilution Factor | DB |
5 | 20 | SN | O |
|
| 01413 | Endogenous Content of Pre-Dilution Diluent | DB |
6 | 1 | ID | O |
| 0136 | 01416 | Automatic Repeat Allowed | DB |
7 | 1 | ID | O |
| 0136 | 01424 | Reflex Allowed | DB |
8 | 250 | CE | O |
| 0389 | 01425 | Analyte Repeat Status | DB |
Components: <Identifier (ST)> ^ <Text (ST)> ^ <Name of Coding System (ID)> ^ <Alternate Identifier (ST)> ^ <Alternate Text (ST)> ^ <Name of Alternate Coding System (ID)>
Definition: This field identifies the test code that information is being transmitted about.
Components: <Comparator (ST)> ^ <Num1 (NM)> ^ <Separator/Suffix (ST)> ^ <Num2 (NM)>
Definition: This field is the value that is to be used as the factor for automatically diluting a particular specimen by an instrument for this particular test code. (See examples in definition of SAC-29 "Dilution factor" in the "Specimen Container Detail Segment".)
Components: <Comparator (ST)> ^ <Num1 (NM)> ^ <Separator/Suffix (ST)> ^ <Num2 (NM)>
Definition: This field is the value that is to be used as the factor for automatically diluting a particular specimen in case of rerun for this particular test code.
Components: <Comparator (ST)> ^ <Num1 (NM)> ^ <Separator/Suffix (ST)> ^ <Num2 (NM)>
Definition: This field is the value that is to be used as the factor for a particular specimen that is delivered to the automated system as pre-diluted for this particular test code.
Components: <Comparator (ST)> ^ <Num1 (NM)> ^ <Separator/Suffix (ST)> ^ <Num2 (NM)>
Definition: This field represents the rest concentration of the measured test in the diluent. It is the value that is to be used for calculation of the concentration of pre-diluted specimens for this particular test code.
Definition: This field identifies whether or not automatic repeats are to be initiated for this particular specimen for this particular test code. Refer to HL7 Table 0136 -Yes/no indicator for valid values.
Definition: This field identifies whether or not automatic or manual reflex testing is to be initiated for this particular specimen. Refer to HL7 Table 0136 -Yes/no indicator for valid values
Components: <Identifier (ST)> ^ <Text (ST)> ^ <Name of Coding System (ID)> ^ <Alternate Identifier (ST)> ^ <Alternate Text (ST)> ^ <Name of Alternate Coding System (ID)>
Definition: This field identifies the repeat status for the analyte/result (e.g. original, rerun, repeat, reflex). Refer to HL7 Table 0389 _ Analyte repeat status for valid values.
For purpose of this chapter we assume the following:
Repeated test without dilution _ performed usually to confirm correctness of results (e.g., in case of results flagged as "Panic" or mechanical failures).
Repeated test with dilution _ performed usually in the case the original result exceeded the measurement range (technical limits).
Reflex test _ this test is performed as the consequence of rules triggered based on other test result(s)
HL7 Table 0389 - Analyte repeat status
13.4.10.0 TCD Field Definitions
13.4.10.1 TCD-1 Universal Service Identifier (CE) 00238
13.4.10.2 TCD-2 Auto-Dilution Factor (SN) 01420
13.4.10.3 TCD-3 Rerun Dilution Factor (SN) 01421
13.4.10.4 TCD-4 Pre-Dilution Factor (SN) 01422
13.4.10.5 TCD-5 Endogenous Content of Pre-Dilution Diluent (SN) 01413
13.4.10.6 TCD-6 Automatic Repeat Allowed (ID) 01416
13.4.10.7 TCD-7 Reflex Allowed (ID) 01424
13.4.10.8 TCD-8 Analyte Repeat Status (CE) 01425
Value | Description | Comment |
---|---|---|
O | Original, first run |
|
R | Repeated without dilution |
|
D | Repeated with dilution |
|
F | Reflex test |
|
The Substance Identifier segment contains data necessary to identify the substance (e.g., reagents) used in the production of analytical test results. The combination of these fields must uniquely identify the substance, i.e., depending on the manufacturer all or some fields are required (this is the reason the optionality is 'C' (conditional)). If the analysis requires multiple substances, this segment is repeated for each substance. The segment(s) should be attached to the TCD segment.
Another purpose of this segment is to transfer the control manufacturer, lot, etc. information for control specimens. In this case the SID segment should be attached to the SAC segment describing the container with the control specimen.
HL7 Attribute Table _ SID _ Substance Identifier
13.4.11 SID _ Substance Identifier Segment
SEQ | LEN | DT | OPT | RP/# | TBL# | ITEM # | ELEMENT NAME | DB Ref. |
---|---|---|---|---|---|---|---|---|
1 | 250 | CE | C |
|
| 01426 | Application / Method Identifier | DB |
2 | 20 | ST | C |
|
| 01129 | Substance Lot Number | DB |
3 | 200 | ST | C |
|
| 01428 | Substance Container Identifier | DB |
4 | 250 | CE | C |
| 0385 | 01429 | Substance Manufacturer Identifier | DB |
Components: <Identifier (ST)> ^ <Text (ST)> ^ <Name of Coding System (ID)> ^ <Alternate Identifier (ST)> ^ <Alternate Text (ST)> ^ <Name of Alternate Coding System (ID)>
Definition: This field identifies the application / method used for the analysis.
Example: GLUCOSE is an orderable test. GLUCOSE can be analyzed using various applications / methods, which have manufacturer specific identifiers.
Definition: This field specifies the lot number assigned by the manufacturer during production of the substance.
Definition: This field specifies the container assigned by the manufacturer during production of the substance. This identifier should be unique within specific lot of specific application / method.
Components: <Identifier (ST)> ^ <Text (ST)> ^ <Name of Coding System (ID)> ^ <Alternate Identifier (ST)> ^ <Alternate Text (ST)> ^ <Name of Alternate Coding System (ID)>
Definition: This field identifies the manufacturer of this substance. Refer to User-defined Table 0451 - Manufacturer identifier for suggested values.
The equipment log/service segment is the data necessary to maintain an adequate audit trail of events that have occurred on a particular piece of equipment.
HL7 Attribute Table _ EQP _ Equipment/log Service
13.4.11.0 SID Field Definitions
13.4.11.1 SID-1 Application / Method Identifier (CE) 01426
13.4.11.2 SID-2 Substance Lot Number (ST) 01129
13.4.11.3 SID-3 Substance Container Identifier (ST) 01428
13.4.11.4 SID-4 Substance Manufacturer Identifier (CE) 01429
13.4.12 EQP - Equipment Log/Service Segment
SEQ | LEN | DT | OPT | RP/# | TBL# | ITEM # | ELEMENT NAME | DB Ref. |
---|---|---|---|---|---|---|---|---|
1 | 250 | CE | R |
| 0450 | 01430 | Event type | DB |
2 | 20 | ST | O |
|
| 01431 | File Name | DB |
3 | 26 | TS | R |
|
| 01202 | Start Date/Time | DB |
4 | 26 | TS | O |
|
| 01432 | End Date/Time | DB |
5 | 65536 | FT | R |
|
| 01433 | Transaction Data | DB |
Components: <Identifier (ST)> ^ <Text (ST)> ^ <Name of Coding System (ID)> ^ <Alternate Identifier (ST)> ^ <Alternate Text (ST)> ^ <Name of Alternate Coding System (ID)>
Definition: This field identifies the type of event of the message. Refer to HL7 Table 0450 _ Event type for valid values.
HL7 Table 0450 _ Event type
13.4.12.0 EQP Field Definitions
13.4.12.1 EQP-1 Event Type (CE) 01430
Value | Description | Comment |
---|---|---|
LOG | Log Event |
|
SER | Service Event |
|
Definition: This field is the physical file name that is being used to store information about the transmitted log and/or service event.
Components: <Time (DTM)> ^ <DEPRECATED-Degree of Precision (ID)>
Definition: This field is the date/time that the event started.
Components: <Time (DTM)> ^ <DEPRECATED-Degree of Precision (ID)>
Definition: This field is the date/time that the event was completed.
Definition: This field is the data that the log and/or service event was about and is to be logged.
The transaction for synchronization of system clocks must be supported by all equipment as receiver. The master (sender) of the time is either the LAS computer or the LIS.
For the transfer of laboratory automation orders and results refer to 4.2.6 OML - laboratory order message (event O21) instead of ORM and 7.2.2 ORL _ unsolicited laboratory observation message (event O20) instead of ORU.
Use SPM-11 Specimen Role, or SAC-6 -specimen source, or the 7th component of OBR-15-specimen source or SAC-6 -specimen source to indicate that this is a control specimen. Use SAC-3-container identifier for the identification of a control specimen container. The SID segment appended to this SAC segment specifies the manufacturer, lot identifiers, etc. for the control specimen.
The identification of the instrument performing the QC measurement, should be transferred with the OBX-18-equipment instance identifier), the measurement data/time with the OBX-19 date/time of the analysis.
There is no specific query for laboratory order information. Instead, the order information should be downloaded to the LAS either unsolicited (based on LIS internal triggers such as Sample Collected or Order Entered) or after an implicit trigger such as Sample Status Update _ sample identified by the LAS.
Instruments requiring additional information for performing of automated processing based on automatic validation, such as Expected Date of Birth (Delivery Date), Menstrual Status, History of Medication Use, should consider using OBX segments and LOINC codes. For example, the LOINC code for Delivery Date is 11778-8, Menstrual status is 8678-5, History of Medication Use is 10160-0.
This sub-chapter contains examples to messages defined in the chapter 13. Examples for other messages using segments defined in the chapter 13 are published in corresponding chapters, e.g., for laboratory orders in chapter 4 and for laboratory observations in chapter 7.
The chemistry analyzer 0001 was powered up directly by the operator (local control) and correctly performed the initialization process. This information is sent by the analyzer to the LAS.
MSH|^~\&|INSTPROG|AUTINST|LASPROG|LASSYS|19980630080040|SECURITY |ESU^U01|MSG00001|P|2.4|<cr>
EQU|0001^CHEMISTRYANALYZER|19980630080038|PU^POWERED_UP|L^LOCAL|N^NORMAL<cr>
ISD|123456789|IN^INIT|OK<cr>
The LAS queries the chemistry analyzer 0001 for status information.
MSH|^~\&|LASPROG|LASSYS|INSTPROG|AUTINST|19980630080040|SECURITY |ESR^U02|MSG00001|P|2.4|<cr>
EQU|0001^CHEMISTRYANALYZER|19980630080038<cr>
The chemistry analyzer 0001 recognized an aliquot container (id=092321A) with blood. This container is in a position 1 of carrier type R5 (id=120) and is located in the input buffer 1.
MSH|^~\&|INSTPROG|AUTINST|LASPROG|LASSYS|19980630080040|SECURITY |SSU^U03|MSG00001|P|2.4|<cr>
EQU|0001^CHEMISTRYANALYZER|19980630080038<cr>
SAC|991912376^EXTLAB|01039421^THISLAB|092321A^LAS|092321^LAS||BLD^BLOOD |19980620080037|I^IDENTIFIED|R5^5_HOLE_RACK|120|1||||BUF1^INPUT BUFFER 1<cr>
A pre-analytical instrument 0001 performed aliquoting and sorting operation. (See Fig. 13-5 for visualization of positions and locations) The carrier (id=2002) with primary/parent container (id=12345) at position 2 was transported in the location: output buffer 1, into position 4 of the output tray (id=A1203). The aliquot container (id=12345A) was sorted into the manual transportable carrier (id=045), in row 3, column 2. This carrier is located in the sorter bed at location 4.
MSH|^~\&|PREANPROG|AUTPREAN|LASPROG|LASSYS|19980630080040|SECURITY |SSU^U03|MSG00002|P|2.4|<cr>
EQU|0001^AQS|19980630080043<cr>
SAC|991912376^EXTLAB|01039421^THISLAB|12345^LAS||||19980620080039|R^COMPLETED |R3^3_HOLE_RACK|2002|1|OT^OUTPUTTRAY|A1203^AQSTRAY|4|OB1^OUTPUTBUFFER<cr>
SAC|991912376^EXTLAB|01039421^THISLAB|12345A^LAS|12345^LAS|||19980620080039 |R^COMPLETED|R14^14_HOLE_RACK|045|3^2||||AQSBED||||||2|0.5||ml<cr>
The chemistry analyzer 0001 queries the LAS for status of specimen/container (id=092321A).
MSH|^~\&|LASPROG|LASSYS|INSTPROG|AUTINST|19980630080040|SECURITY |SSR^U04|MSG00001|P|2.4|<cr>
EQU|0001^CHEMISTRYANALYZER|19980630080038<cr>
SAC|991912376^EXTLAB|01039421^THISLAB|092321A^LAS||||199806200823<cr>
The chemistry analyzer 0001 sends to the LAS the status of a TSH reagent (id=MF01239) in bottle (id=12345).
MSH|^~\&|INSTPROG|AUTINST|LASPROG|LASSYS|19980630080040|SECURITY |INU^U05|MSG00001|P|2.4|<cr>
EQU|0001^CHEMISTRYANALYZER|19980630080038<cr>
INV|MF01239^REAGENT1|OK^OK_STATUS|SR^SINGLE_TEST_REAGENT |12345^BOTTLE_NUM|||||190||ML|20000101||^^D60|TSH|A12345678|PROD1<cr>
The LAS queries the chemistry analyzer 0001 for status of all packages of the substance (id=MF01239).
MSH|^~\&|LASPROG|LASSYS|INSTPROG|AUTINST|19980630080040|SECURITY |INR^U06|MSG00001|P|2.4|<cr>
EQU|0001^CHEMISTRYANALYZER|19980630080038<cr>
INV|MF01239^REAGENT1|OK^OK_STATUS<cr>
The LAS sends command of "Clearing Notification" to the chemistry analyzer 0001.
MSH|^~\&|LASPROG|LASSYS|INSTPROG|AUTINST|19980630080040|SECURITY |EAC^U07|MSG00001|P|2.4|<cr>
EQU|0001^CHEMISTRYANALYZER|19980630080038<cr>
ECD|89421|CN^CLEAR NOTIFICATION|Y^YES<cr>
CNS|1209|1500|199806010800|199806300800<cr>
The chemistry analyzer confirms completion of the execution of the initialization command.
MSH|^~\&|INSTPROG|AUTINST|LASPROG|LASSYS|19980630080040|SECURITY |EAR^U08|MSG00001|P|2.4|<cr>
EQU|0001^CHEMISTRYANALYZER|19980630080038<cr>
ECD|89421|IN^INIT|Y^YES<cr>
ECR|OK^COMMAND_COMPLETE|19980630080035<cr>
The chemistry analyzer sends a notification (warning) about drift in the detection unit.
MSH|^~\&|INSTPROG|AUTINST|LASPROG|LASSYS|19980630080040|SECURITY |EAN^U09|MSG00001|P|2.4|<cr>
EQU|0001^CHEMISTRYANALYZER|19980630080038<cr>
NDS|8923|199806300800|W^WARNING^|DU001^DETECTIO UNIT DRIFT<cr>
The LAS send update of configuration parameters for Glucose test.
MSH|^~\&|LASPROG|LASSYS|INSTPROG|AUTINST|19980630080040|SECURITY |TCU^U10|MSG00001|P|2.4|<cr>
EQU|0001^CHEMISTRYANALYZER|19980630080038<cr>
TCC|15074-8^GLUCOSE|GLU-HK^CHEMISTRYANALYZER|SER^SERUM|10|10|0|0|500| Y^YES|Y^YES|N^NO |^2^-^400|mg/dL|P<cr>
The chemistry analyzer 0001 queries the LAS for configuration parameters of the Glucose test.
MSH|^~\&|INSTPROG|AUTINST|LASPROG|LASSYS|19980630080040|SECURITY |TCR^U11|MSG00001|P|2.4|<cr>
EQU|0001^CHEMISTRYANALYZER|19980630080038<cr>
TCC|15074-8^GLUCOSE|GLU-HK^CHEMISTRYANALYZER<cr>
The chemistry analyzer 0001 sends 1 record from the event log to the LAS.
MSH|^~\&|INSTPROG|AUTINST|LASPROG|LASSYS|19980630080040|SECURITY |LSU^U12|MSG00001|P|2.4|<cr>
EQU|0001^CHEMISTRYANALYZER|19980630080038<cr>
EQP|LOG^LOG_EVENT||199806300755|199806300800|I976 Instrument Initialization<cr>
The LAS queries chemistry analyzer for log file of events occurring between 7am and 8am on 30th June 1998.
MSH|^~\&|LASPROG|LASSYS|INSTPROG|AUTINST|19980630080040|SECURITY |LSR^U13|MSG00001|P|2.4|<cr>
EQU|0001^CHEMISTRYANALYZER|19980630080038<cr>
EQP|LOG^LOG_EVENT||199806300700|199806300800<cr>
None.
13.4.12.2 EQP-2 File Name (ST) 01431
13.4.12.3 EQP-3 Start Date/Time (TS) 01202
13.4.12.4 EQP-4 End Date/Time (TS) 01432
13.4.12.5 EQP-5 Transaction Data (FT) 01433
13.5 NOTES REGARDING USAGE
13.5.1 Other Required Original HL7 Messages
13.5.2 Transfer of Laboratory Test Orders and Results
13.5.3 Transfer of QC Results
13.5.4 Query For Order Information _ Triggers for Download of Test Orders
13.5.5 Transfer of Additional Information for Automated Processing
13.6 EXAMPLE MESSAGES
13.6.1 Automated Equipment Status Update
13.6.2 Automated Equipment Status Request
13.6.3 Specimen Status Update
13.6.4 Specimen Status Request
13.6.5 Automated Equipment Inventory Update
13.6.6 Automated Equipment Inventory Request
13.6.7 Automated Equipment Command
13.6.8 Automated Equipment Response
13.6.9 Automated Equipment Notification
13.6.10 Automated Equipment Test Code Settings Update
13.6.11 Automated Equipment Test Code Settings Request
13.6.12 Automated Equipment Log/Service Update
13.6.13 Automated Equipment Log/Service Request
13.7 OUTSTANDING ISSUES