HL7 - REFACTORED

Co-Chair:	Hans Buitendijk Cerner Corporation
Co-Chair:	Lorraine Constable Constable Consulting Inc.
Co-Chair:	Rob Hausam Hausam Consulting
Co-Chair:	Patrick Loyd ICode Solutions
Co-Chair:	Ken McCaslin Accenture Federal
Co-Chair	JD Nolen Mercy Children’s Hospital
Co-Chair:	Riki Merrick Vernetzt. LLC
Co-Chair:	David Burgess LabCorp
Editor	Riki Merrick Vernetzt. LLC
Sponsoring Work Group:	Orders & Observations
List Server:	ord@lists.hl7.org

Background and Introduction

Background

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.

[1] NCCLS, 940 West Valley Road, Suite 1400, Wayne, PA 19087; www.nccls.org

Introduction

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.

[2] (NCCLS. Laboratory Automation: Communications With Automated Clinical Laboratory Systems, Instruments, Devices, and Information Systems; Approved Standard - NCCLS Document AUTO3-A [ISBN 1-56238-361-2}. NCCLS, 940 West Valley Road, Suite 1400, Wayne, PA 19087-1898 USA, 2000). www.nccls.org

Glossary

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.⁷

[3] ANSI Standard X3.182-1990. Bar Code Print Quality Guidelines. New York, NY: American National Standards Institute; 1995

[4] ASTM E1013-93. Standard Terminology Relating to Computerized Systems. West Conshohocken, PA: American Society for Testing and Materials; 1993

[5] IEEE 100. Dictionary of Electrical and Electronics Terms. Institute of Electrical and Electronics Engineers, Inc.; 1996

[6] IEEE 610. Glossary of Computer Languages. Institute of Electrical and Electronics Engineers, Inc.; 1993

[7] ANSI X3.172-1996. Information Technology – American National Standards Dictionary of Information Technology (ANSDIT). New York, NY: American National Standards Institute; 1996

Accession Identifier (also accession number):

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.

Additive:

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.

Aliquot:

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.

Analyzer:

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.

Automated:

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.

Automated instrument:

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.

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.

Bar code:

An array of parallel rectangular bars and spaces that creates a symbology representing a number or alphanumeric identifier.

Bar length:

The length of the bars in the bar code.

Barrier:

See Separator

Barrier Delta:

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.

Bottom of cap:

The farthest point from the top of the container/test tube that the cap reaches.

Note: This point may be inside the tube.

Bottom of container//Bottom of tube:

The portion of the container/test tube farthest from the cap (see Point of reference).

Bottom of tube:

See Bottom of container.

Carrier:

See Specimen carrier.

Character:

1) 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.

Clinical laboratory automation:

The integration of laboratory personnel and preanalytical, analytical, and postanalytical processes and information systems.

Clinical laboratory automation 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.

Closed-container sampling//Closed-tube sampling:

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.

Closed-tube sampling:

See Closed-container sampling.

Container//Tube//Test Tube:

See Specimen container.

Container Identifier

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.

Cycle time components:

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.

Decapping:

The removal of a closure from a specimen container.

Delimiter:

A symbol used to separate items in a list.

Directions of the specimen, Transportation system, Instrument or Specimen processing and handling device interfaces:

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

Directions of the sample, Transportation system, Instrument or Specimen processing handling device and interfaces

See Directions of the specimen, etc.

Direct track sampling:

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.

Docking site:

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.

Flection:

The point at which the vertical (straight) walls of the specimen container bend to form the base.

Interaction:

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.

Label:

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.

Laboratory automation system (LAS):

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.

Laboratory equipment control interface specification (LECIS):

A high-level protocol that defines message content for standard behaviors or interactions for remote control of analytical instruments and devices (ASTM E 1989-98).

Laboratory information system (LIS):

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.

LECIS:

Acronym for Laboratory Equipment Control Interface Specification, (ASTM E 1989-98).

Location:

A physical place within the laboratory, with a unique identifier (e.g., refrigerator shelf number, instrument buffer ID, track identifier).

Open-container sampling//Open-tube sampling:

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.

Open-tube sampling:

See Open-container sampling.

Pitch:

The center distance between two specimen containers in a carrier or between two sequential specimen container carriers.

Point of reference//Point in space, (POR):

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.

Process instruments:

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.

Quiet zone:

In NCCLS LAB AUTOMATION documents, the white {blank} space on a bar code immediately preceding the first bar and immediately following the last bar.

Recap:

To replace the closure on a specimen container; either with the original closure or with a new replacement closure.

Robotic arm:

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.

Sample//(Specimen):

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.

Sample carrier:

See Specimen carrier.

Sample container:

See Specimen collection container.

Sample-positioning system:

See Specimen-positioning system.

Sample probe:

See Specimen probe.

Separator:

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.

Serum/Plasma Separator:

See Separator.

Service envelope:

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.

Specimen:

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.

Specimen carrier//Sample carrier//Carrier:

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.)

Specimen collection container//Specimen container//Sample container//Container:

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.

Specimen-positioning system//Sample-positioning system (SPS):

A device to position a specimen container within acceptable tolerances of a POR.

Specimen probe//Sample probe:

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.

Stay clear zone:

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.

Symbol:

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.

Test mnemonics:

Short, understandable contractions for test names.

Top of container//Top of tube:

The open end of the container/test tube, closest to the cap.

Top of tube:

See Top of container.

Tray:

A holder for one or more carriers (optional). (See Figure 13-5.)

X–direction:

See Directions.

Y–direction:

See Directions.

Z–direction:

See Directions.

Trigger Events and Message Definitions

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 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.13.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.

ESU/ACK - Automated Equipment Status Update (Event U01)

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

Message Structure
Acknowlegment Choreography
v2.xml XSD

HL7 MessageStructure Table - ESU_U01
Segment	Cardinality	Must Implement	Status
ESU_U01
MSH	1..1	Yes
SFT	0..*
UAC	0..1
EQU	1..1	Yes
ISD	0..*
ROL	0..1		B

Original Mode Acknowledgement Choreography for ESU^U01^ESU_U01

Send Application Ack: ACK^U01^ACK

Enhanced Mode Acknowledgement Choreography for ESU^U01^ESU_U01

When the MSH-15 value of an ESU^U01^ESU_U01 message is AL or ER or SU, an ACK^U01^ACK message SHALL be sent as an immediate ack.

When the MSH-15 value of an ESU^U01^ESU_U01 message is NE, an immediate ack SHALL NOT be sent.

When the MSH-16 value of an ESU^U01^ESU_U01 message is AL or ER or SU, an ACK^U01^ACK message SHALL be sent as an application ack.

When the MSH-16 value of an ESU^U01^ESU_U01 message is NE, an application ack SHALL NOT be sent.

Field	Value	Send Response
MSH-15	AL, ER, SU	immediate ack: ACK^U01^ACK
MSH-15	NE	(none)
MSH-16	AL, ER, SU	application ack: ACK^U01^ACK
MSH-16	NE	(none)

<?xml version="1.0"?>
<!--   v2.xml Message Definitions for Version 2.8.2 - here: ESU_U01-->
<!--   Copyright (c) 1999-2019, Health Level Seven. All rights reserved.   -->
<!--   (generated on 09.01.2019 by HL7-Database) D:\Eigene Dateien\HL7\Datenbank\hl7_94.mdb-->
<xsd:schema xmlns:xsd="http://www.w3.org/2001/XMLSchema"
xmlns="urn:hl7-org:v2xml" xmlns:hl7="urn:hl7-org:v2xml"
targetNamespace="urn:hl7-org:v2xml" version="1.1">
  <!-- import segment definition for version -->
  <xsd:include schemaLocation="segments.xsd" />
  <!-- MESSAGE ESU_U01 -->
  <!-- .. message definition ESU_U01 -->
  <xsd:complexType name="ESU_U01.CONTENT">
    <xsd:sequence>
      <xsd:element ref="MSH" minOccurs="1" maxOccurs="1" />
      <xsd:element ref="SFT" minOccurs="0" maxOccurs="unbounded" />
      <xsd:element ref="UAC" minOccurs="0" maxOccurs="1" />
      <xsd:element ref="EQU" minOccurs="1" maxOccurs="1" />
      <xsd:element ref="ISD" minOccurs="0" maxOccurs="unbounded" />
    </xsd:sequence>
  </xsd:complexType>
  <xsd:element name="ESU_U01" type="ESU_U01.CONTENT" />
</xsd:schema>

Download

ACK^U01^ACK: General Acknowledgement

Message Structure
Acknowlegment Choreography
v2.xml XSD

HL7 MessageStructure Table - ACK
Segment	Cardinality	Must Implement
ACK
MSH	1..1	Yes
SFT	0..*
UAC	0..1
MSA	1..1	Yes
ERR	0..*

Original Mode Acknowledgement Choreography for ACK^U01^ACK

Send An Acknowlegment is never sent in original mode.

Enhanced Mode Acknowledgement Choreography for ACK^U01^ACK

When the MSH-15 value of an ACK^U01^ACK message is AL or ER or SU, an ACK^U01^ACK message SHALL be sent as an immediate ack.

When the MSH-15 value of an ACK^U01^ACK message is NE, an immediate ack SHALL NOT be sent.

Never send an application ack in enhanced mode.

Field	Value	Send Response
MSH-15	AL, ER, SU	immediate ack: ACK^U01^ACK
MSH-15	NE	(none)
MSH-16	NE	(none)

<?xml version="1.0"?>
<!--   v2.xml Message Definitions for Version 2.8.2 - here: ACK-->
<!--   Copyright (c) 1999-2019, Health Level Seven. All rights reserved.   -->
<!--   (generated on 09.01.2019 by HL7-Database) D:\Eigene Dateien\HL7\Datenbank\hl7_94.mdb-->
<xsd:schema xmlns:xsd="http://www.w3.org/2001/XMLSchema"
xmlns="urn:hl7-org:v2xml" xmlns:hl7="urn:hl7-org:v2xml"
targetNamespace="urn:hl7-org:v2xml" version="1.1">
  <!-- import segment definition for version -->
  <xsd:include schemaLocation="segments.xsd" />
  <!-- MESSAGE ACK -->
  <!-- .. message definition ACK -->
  <xsd:complexType name="ACK.CONTENT">
    <xsd:sequence>
      <xsd:element ref="MSH" minOccurs="1" maxOccurs="1" />
      <xsd:element ref="SFT" minOccurs="0" maxOccurs="unbounded" />
      <xsd:element ref="UAC" minOccurs="0" maxOccurs="1" />
      <xsd:element ref="MSA" minOccurs="1" maxOccurs="1" />
      <xsd:element ref="ERR" minOccurs="0" maxOccurs="unbounded" />
    </xsd:sequence>
  </xsd:complexType>
  <xsd:element name="ACK" type="ACK.CONTENT" />
</xsd:schema>

Download

ESR/ACK - Automated Equipment Status Request (Event U02)

This message is used to request information about a device's or piece of equipment's status from one application to another (e.g., Laboratory Automation System to automated equipment). The equipment identified in the EQU segment should respond with its status using the "Automated Equipment Status Update."

ESR^U02^ESR_U02: Equipment Status Message

Message Structure
Acknowlegment Choreography
v2.xml XSD

HL7 MessageStructure Table - ESR_U02
Segment	Cardinality	Must Implement	Status
ESR_U02
MSH	1..1	Yes
SFT	0..*
UAC	0..1
EQU	1..1	Yes
ROL	0..1		B

Original Mode Acknowledgement Choreography for ESR^U02^ESR_U02

Send Application Ack: ESU^U01^ESU_U01

Enhanced Mode Acknowledgement Choreography for ESR^U02^ESR_U02

When the MSH-15 value of an ESR^U02^ESR_U02 message is AL or ER or SU, an ACK^U02^ACK message SHALL be sent as an immediate ack.

When the MSH-15 value of an ESR^U02^ESR_U02 message is NE, an immediate ack SHALL NOT be sent.

When the MSH-16 value of an ESR^U02^ESR_U02 message is AL or ER or SU, an ESU^U01^ESU_U01 message SHALL be sent as an application ack.

When the MSH-16 value of an ESR^U02^ESR_U02 message is NE, an application ack SHALL NOT be sent.

Field	Value	Send Response
MSH-15	AL, ER, SU	immediate ack: ACK^U02^ACK
MSH-15	NE	(none)
MSH-16	AL, ER, SU	application ack: ESU^U01^ESU_U01
MSH-16	NE	(none)

<?xml version="1.0"?>
<!--   v2.xml Message Definitions for Version 2.8.2 - here: ESR_U02-->
<!--   Copyright (c) 1999-2019, Health Level Seven. All rights reserved.   -->
<!--   (generated on 09.01.2019 by HL7-Database) D:\Eigene Dateien\HL7\Datenbank\hl7_94.mdb-->
<xsd:schema xmlns:xsd="http://www.w3.org/2001/XMLSchema"
xmlns="urn:hl7-org:v2xml" xmlns:hl7="urn:hl7-org:v2xml"
targetNamespace="urn:hl7-org:v2xml" version="1.1">
  <!-- import segment definition for version -->
  <xsd:include schemaLocation="segments.xsd" />
  <!-- MESSAGE ESR_U02 -->
  <!-- .. message definition ESR_U02 -->
  <xsd:complexType name="ESR_U02.CONTENT">
    <xsd:sequence>
      <xsd:element ref="MSH" minOccurs="1" maxOccurs="1" />
      <xsd:element ref="SFT" minOccurs="0" maxOccurs="unbounded" />
      <xsd:element ref="UAC" minOccurs="0" maxOccurs="1" />
      <xsd:element ref="EQU" minOccurs="1" maxOccurs="1" />
    </xsd:sequence>
  </xsd:complexType>
  <xsd:element name="ESR_U02" type="ESR_U02.CONTENT" />
</xsd:schema>

Download

ACK^U02^ACK: General Acknowledgment

Message Structure
Acknowlegment Choreography
v2.xml XSD

HL7 MessageStructure Table - ACK
Segment	Cardinality	Must Implement
ACK
MSH	1..1	Yes
SFT	0..*
UAC	0..1
MSA	1..1	Yes
ERR	0..*

Original Mode Acknowledgement Choreography for ACK^U02^ACK

Send An Acknowlegment is never sent in original mode.

Enhanced Mode Acknowledgement Choreography for ACK^U02^ACK

When the MSH-15 value of an ACK^U02^ACK message is AL or ER or SU, an ACK^U02^ACK message SHALL be sent as an immediate ack.

When the MSH-15 value of an ACK^U02^ACK message is NE, an immediate ack SHALL NOT be sent.

Never send an application ack in enhanced mode.

Field	Value	Send Response
MSH-15	AL, ER, SU	immediate ack: ACK^U02^ACK
MSH-15	NE	(none)
MSH-16	NE	(none)

<?xml version="1.0"?>
<!--   v2.xml Message Definitions for Version 2.8.2 - here: ACK-->
<!--   Copyright (c) 1999-2019, Health Level Seven. All rights reserved.   -->
<!--   (generated on 09.01.2019 by HL7-Database) D:\Eigene Dateien\HL7\Datenbank\hl7_94.mdb-->
<xsd:schema xmlns:xsd="http://www.w3.org/2001/XMLSchema"
xmlns="urn:hl7-org:v2xml" xmlns:hl7="urn:hl7-org:v2xml"
targetNamespace="urn:hl7-org:v2xml" version="1.1">
  <!-- import segment definition for version -->
  <xsd:include schemaLocation="segments.xsd" />
  <!-- MESSAGE ACK -->
  <!-- .. message definition ACK -->
  <xsd:complexType name="ACK.CONTENT">
    <xsd:sequence>
      <xsd:element ref="MSH" minOccurs="1" maxOccurs="1" />
      <xsd:element ref="SFT" minOccurs="0" maxOccurs="unbounded" />
      <xsd:element ref="UAC" minOccurs="0" maxOccurs="1" />
      <xsd:element ref="MSA" minOccurs="1" maxOccurs="1" />
      <xsd:element ref="ERR" minOccurs="0" maxOccurs="unbounded" />
    </xsd:sequence>
  </xsd:complexType>
  <xsd:element name="ACK" type="ACK.CONTENT" />
</xsd:schema>

Download

SSU/ACK - Specimen Status Update (Event U03)

This message is used to send information concerning the location and status of specimens from one application to another (e.g., automated equipment to a Laboratory Automation System). The OBX segments attached to the SAC should be used for transfer of information not included in the SAC segment, but relevant for automating processing (e.g., additional characteristics of the specimen container). The NTE segments attached to the SAC should be used for transfer of descriptive information not included in the SAC segment, but relevant for the users (e.g., aliquot groups for an aliquot sample container).

SSU^U03^SSU_U03: Specimen Status Message

Message Structure
Acknowlegment Choreography
v2.xml XSD

HL7 MessageStructure Table - SSU_U03
Segment	Cardinality	Must Implement	Status
SSU_U03
MSH	1..1	Yes
SFT	0..*
UAC	0..1
EQU	1..1	Yes
SPECIMEN_CONTAINER	1..*	Yes
SAC	1..1	Yes
OBX	0..*
NTE	0..*
PRT	0..*
SPECIMEN	0..*
SPM	1..1	Yes
OBX	0..*
PRT	0..*
ROL	0..1		B

Original Mode Acknowledgement Choreography for SSU^U03^SSU_U03

Send Application Ack: ACK^U03^ACK

Enhanced Mode Acknowledgement Choreography for SSU^U03^SSU_U03

When the MSH-15 value of a SSU^U03^SSU_U03 message is AL or ER or SU, an ACK^U03^ACK message SHALL be sent as an immediate ack.

When the MSH-15 value of a SSU^U03^SSU_U03 message is NE, an immediate ack SHALL NOT be sent.

When the MSH-16 value of a SSU^U03^SSU_U03 message is AL or ER or SU, an ACK^U03^ACK message SHALL be sent as an application ack.

When the MSH-16 value of a SSU^U03^SSU_U03 message is NE, an application ack SHALL NOT be sent.

Field	Value	Send Response
MSH-15	AL, ER, SU	immediate ack: ACK^U03^ACK
MSH-15	NE	(none)
MSH-16	AL, ER, SU	application ack: ACK^U03^ACK
MSH-16	NE	(none)

<?xml version="1.0"?>
<!--   v2.xml Message Definitions for Version 2.8.2 - here: SSU_U03-->
<!--   Copyright (c) 1999-2019, Health Level Seven. All rights reserved.   -->
<!--   (generated on 09.01.2019 by HL7-Database) D:\Eigene Dateien\HL7\Datenbank\hl7_94.mdb-->
<xsd:schema xmlns:xsd="http://www.w3.org/2001/XMLSchema"
xmlns="urn:hl7-org:v2xml" xmlns:hl7="urn:hl7-org:v2xml"
targetNamespace="urn:hl7-org:v2xml" version="1.1">
  <!-- import segment definition for version -->
  <xsd:include schemaLocation="segments.xsd" />
  <!-- MESSAGE SSU_U03 -->
  <!-- .. message definition SSU_U03 -->
  <xsd:complexType name="SSU_U03.CONTENT">
    <xsd:sequence>
      <xsd:element ref="MSH" minOccurs="1" maxOccurs="1" />
      <xsd:element ref="SFT" minOccurs="0" maxOccurs="unbounded" />
      <xsd:element ref="UAC" minOccurs="0" maxOccurs="1" />
      <xsd:element ref="EQU" minOccurs="1" maxOccurs="1" />
      <xsd:element ref="SSU_U03.SPECIMEN_CONTAINER" minOccurs="1"
      maxOccurs="unbounded" />
    </xsd:sequence>
  </xsd:complexType>
  <xsd:element name="SSU_U03" type="SSU_U03.CONTENT" />
  <xsd:complexType name="SSU_U03.SPECIMEN_CONTAINER.CONTENT">
    <xsd:sequence>
      <xsd:element ref="SAC" minOccurs="1" maxOccurs="1" />
      <xsd:element ref="OBX" minOccurs="0" maxOccurs="unbounded" />
      <xsd:element ref="NTE" minOccurs="0" maxOccurs="unbounded" />
      <xsd:element ref="SSU_U03.SPECIMEN" minOccurs="0"
      maxOccurs="unbounded" />
    </xsd:sequence>
  </xsd:complexType>
  <xsd:element name="SSU_U03.SPECIMEN_CONTAINER"
  type="SSU_U03.SPECIMEN_CONTAINER.CONTENT" />
  <xsd:complexType name="SSU_U03.SPECIMEN.CONTENT">
    <xsd:sequence>
      <xsd:element ref="SPM" minOccurs="1" maxOccurs="1" />
      <xsd:element ref="OBX" minOccurs="0" maxOccurs="unbounded" />
    </xsd:sequence>
  </xsd:complexType>
  <xsd:element name="SSU_U03.SPECIMEN"
  type="SSU_U03.SPECIMEN.CONTENT" />
</xsd:schema>

Download

ACK^U03^ACK: General Acknowledgment

Message Structure
Acknowlegment Choreography
v2.xml XSD

HL7 MessageStructure Table - ACK
Segment	Cardinality	Must Implement
ACK
MSH	1..1	Yes
SFT	0..*
UAC	0..1
MSA	1..1	Yes
ERR	0..*

Original Mode Acknowledgement Choreography for ACK^U03^ACK

Send An Acknowlegment is never sent in original mode.

Enhanced Mode Acknowledgement Choreography for ACK^U03^ACK

When the MSH-15 value of an ACK^U03^ACK message is AL or ER or SU, an ACK^U03^ACK message SHALL be sent as an immediate ack.

When the MSH-15 value of an ACK^U03^ACK message is NE, an immediate ack SHALL NOT be sent.

Never send an application ack in enhanced mode.

Field	Value	Send Response
MSH-15	AL, ER, SU	immediate ack: ACK^U03^ACK
MSH-15	NE	(none)
MSH-16	NE	(none)

<?xml version="1.0"?>
<!--   v2.xml Message Definitions for Version 2.8.2 - here: ACK-->
<!--   Copyright (c) 1999-2019, Health Level Seven. All rights reserved.   -->
<!--   (generated on 09.01.2019 by HL7-Database) D:\Eigene Dateien\HL7\Datenbank\hl7_94.mdb-->
<xsd:schema xmlns:xsd="http://www.w3.org/2001/XMLSchema"
xmlns="urn:hl7-org:v2xml" xmlns:hl7="urn:hl7-org:v2xml"
targetNamespace="urn:hl7-org:v2xml" version="1.1">
  <!-- import segment definition for version -->
  <xsd:include schemaLocation="segments.xsd" />
  <!-- MESSAGE ACK -->
  <!-- .. message definition ACK -->
  <xsd:complexType name="ACK.CONTENT">
    <xsd:sequence>
      <xsd:element ref="MSH" minOccurs="1" maxOccurs="1" />
      <xsd:element ref="SFT" minOccurs="0" maxOccurs="unbounded" />
      <xsd:element ref="UAC" minOccurs="0" maxOccurs="1" />
      <xsd:element ref="MSA" minOccurs="1" maxOccurs="1" />
      <xsd:element ref="ERR" minOccurs="0" maxOccurs="unbounded" />
    </xsd:sequence>
  </xsd:complexType>
  <xsd:element name="ACK" type="ACK.CONTENT" />
</xsd:schema>

Download

SSR/ACK - Specimen Status Request (Event U04)

This message is used to request information concerning the location and status of specimens from one application to another (e.g., Laboratory Automation System to automated equipment). The request can be addressed for a specific container, a specific carrier, a specific tray or a specific location, depending on the arguments set in the SAC segment. The equipment specified in the EQU segment should respond with the "Specimen Status Update."

SSR^U04^SSR_U04: Specimen Status Message

Message Structure
Acknowlegment Choreography
v2.xml XSD

HL7 MessageStructure Table - SSR_U04
Segment	Cardinality	Must Implement	Status
SSR_U04
MSH	1..1	Yes
SFT	0..*
UAC	0..1
EQU	1..1	Yes
SPECIMEN_CONTAINER	1..*	Yes
SAC	1..1	Yes
SPM	0..*
ROL	0..1		B

Original Mode Acknowledgement Choreography for SSR^U04^SSR_U04

Send Application Ack: SSU^U03^SSU_U03

Enhanced Mode Acknowledgement Choreography for SSR^U04^SSR_U04

When the MSH-15 value of a SSR^U04^SSR_U04 message is AL or ER or SU, an ACK^U04^ACK message SHALL be sent as an immediate ack.

When the MSH-15 value of a SSR^U04^SSR_U04 message is NE, an immediate ack SHALL NOT be sent.

When the MSH-16 value of a SSR^U04^SSR_U04 message is AL or ER or SU, a SSU^U03^SSU_U03 message SHALL be sent as an application ack.

When the MSH-16 value of a SSR^U04^SSR_U04 message is NE, an application ack SHALL NOT be sent.

Field	Value	Send Response
MSH-15	AL, ER, SU	immediate ack: ACK^U04^ACK
MSH-15	NE	(none)
MSH-16	AL, ER, SU	application ack: SSU^U03^SSU_U03
MSH-16	NE	(none)

<?xml version="1.0"?>
<!--   v2.xml Message Definitions for Version 2.8.2 - here: SSR_U04-->
<!--   Copyright (c) 1999-2019, Health Level Seven. All rights reserved.   -->
<!--   (generated on 09.01.2019 by HL7-Database) D:\Eigene Dateien\HL7\Datenbank\hl7_94.mdb-->
<xsd:schema xmlns:xsd="http://www.w3.org/2001/XMLSchema"
xmlns="urn:hl7-org:v2xml" xmlns:hl7="urn:hl7-org:v2xml"
targetNamespace="urn:hl7-org:v2xml" version="1.1">
  <!-- import segment definition for version -->
  <xsd:include schemaLocation="segments.xsd" />
  <!-- MESSAGE SSR_U04 -->
  <!-- .. message definition SSR_U04 -->
  <xsd:complexType name="SSR_U04.CONTENT">
    <xsd:sequence>
      <xsd:element ref="MSH" minOccurs="1" maxOccurs="1" />
      <xsd:element ref="SFT" minOccurs="0" maxOccurs="unbounded" />
      <xsd:element ref="UAC" minOccurs="0" maxOccurs="1" />
      <xsd:element ref="EQU" minOccurs="1" maxOccurs="1" />
      <xsd:element ref="SSR_U04.SPECIMEN_CONTAINER" minOccurs="1"
      maxOccurs="unbounded" />
    </xsd:sequence>
  </xsd:complexType>
  <xsd:element name="SSR_U04" type="SSR_U04.CONTENT" />
  <xsd:complexType name="SSR_U04.SPECIMEN_CONTAINER.CONTENT">
    <xsd:sequence>
      <xsd:element ref="SAC" minOccurs="1" maxOccurs="1" />
      <xsd:element ref="SPM" minOccurs="0" maxOccurs="unbounded" />
    </xsd:sequence>
  </xsd:complexType>
  <xsd:element name="SSR_U04.SPECIMEN_CONTAINER"
  type="SSR_U04.SPECIMEN_CONTAINER.CONTENT" />
</xsd:schema>

Download

ACK^U04^ACK: General Acknowledgment

Message Structure
Acknowlegment Choreography
v2.xml XSD

HL7 MessageStructure Table - ACK
Segment	Cardinality	Must Implement
ACK
MSH	1..1	Yes
SFT	0..*
UAC	0..1
MSA	1..1	Yes
ERR	0..*

Original Mode Acknowledgement Choreography for ACK^U04^ACK

Send An Acknowlegment is never sent in original mode.

Enhanced Mode Acknowledgement Choreography for ACK^U04^ACK

When the MSH-15 value of an ACK^U04^ACK message is AL or ER or SU, an ACK^U04^ACK message SHALL be sent as an immediate ack.

When the MSH-15 value of an ACK^U04^ACK message is NE, an immediate ack SHALL NOT be sent.

Never send an application ack in enhanced mode.

Field	Value	Send Response
MSH-15	AL, ER, SU	immediate ack: ACK^U04^ACK
MSH-15	NE	(none)
MSH-16	NE	(none)

<?xml version="1.0"?>
<!--   v2.xml Message Definitions for Version 2.8.2 - here: ACK-->
<!--   Copyright (c) 1999-2019, Health Level Seven. All rights reserved.   -->
<!--   (generated on 09.01.2019 by HL7-Database) D:\Eigene Dateien\HL7\Datenbank\hl7_94.mdb-->
<xsd:schema xmlns:xsd="http://www.w3.org/2001/XMLSchema"
xmlns="urn:hl7-org:v2xml" xmlns:hl7="urn:hl7-org:v2xml"
targetNamespace="urn:hl7-org:v2xml" version="1.1">
  <!-- import segment definition for version -->
  <xsd:include schemaLocation="segments.xsd" />
  <!-- MESSAGE ACK -->
  <!-- .. message definition ACK -->
  <xsd:complexType name="ACK.CONTENT">
    <xsd:sequence>
      <xsd:element ref="MSH" minOccurs="1" maxOccurs="1" />
      <xsd:element ref="SFT" minOccurs="0" maxOccurs="unbounded" />
      <xsd:element ref="UAC" minOccurs="0" maxOccurs="1" />
      <xsd:element ref="MSA" minOccurs="1" maxOccurs="1" />
      <xsd:element ref="ERR" minOccurs="0" maxOccurs="unbounded" />
    </xsd:sequence>
  </xsd:complexType>
  <xsd:element name="ACK" type="ACK.CONTENT" />
</xsd:schema>

Download

INU/ACK – Automated Equipment Inventory Update (Event U05)

This message is used to send information about inventory items from one application to another (e.g., automated Equipment to a Laboratory Automation System).

INU^U05^INU_U05: Inventory Update Message

Message Structure
Acknowlegment Choreography
v2.xml XSD

HL7 MessageStructure Table - INU_U05
Segment	Cardinality	Must Implement	Status
INU_U05
MSH	1..1	Yes
SFT	0..*
UAC	0..1
EQU	1..1	Yes
INV	1..*	Yes
ROL	0..1		B

Original Mode Acknowledgement Choreography for INU^U05^INU_U05

Send Application Ack: ACK^U05^ACK

Enhanced Mode Acknowledgement Choreography for INU^U05^INU_U05

When the MSH-15 value of an INU^U05^INU_U05 message is AL or ER or SU, an ACK^U05^ACK message SHALL be sent as an immediate ack.

When the MSH-15 value of an INU^U05^INU_U05 message is NE, an immediate ack SHALL NOT be sent.

When the MSH-16 value of an INU^U05^INU_U05 message is AL or ER or SU, an ACK^U05^ACK message SHALL be sent as an application ack.

When the MSH-16 value of an INU^U05^INU_U05 message is NE, an application ack SHALL NOT be sent.

Field	Value	Send Response
MSH-15	AL, ER, SU	immediate ack: ACK^U05^ACK
MSH-15	NE	(none)
MSH-16	AL, ER, SU	application ack: ACK^U05^ACK
MSH-16	NE	(none)

<?xml version="1.0"?>
<!--   v2.xml Message Definitions for Version 2.8.2 - here: INU_U05-->
<!--   Copyright (c) 1999-2019, Health Level Seven. All rights reserved.   -->
<!--   (generated on 09.01.2019 by HL7-Database) D:\Eigene Dateien\HL7\Datenbank\hl7_94.mdb-->
<xsd:schema xmlns:xsd="http://www.w3.org/2001/XMLSchema"
xmlns="urn:hl7-org:v2xml" xmlns:hl7="urn:hl7-org:v2xml"
targetNamespace="urn:hl7-org:v2xml" version="1.1">
  <!-- import segment definition for version -->
  <xsd:include schemaLocation="segments.xsd" />
  <!-- MESSAGE INU_U05 -->
  <!-- .. message definition INU_U05 -->
  <xsd:complexType name="INU_U05.CONTENT">
    <xsd:sequence>
      <xsd:element ref="MSH" minOccurs="1" maxOccurs="1" />
      <xsd:element ref="SFT" minOccurs="0" maxOccurs="unbounded" />
      <xsd:element ref="UAC" minOccurs="0" maxOccurs="1" />
      <xsd:element ref="EQU" minOccurs="1" maxOccurs="1" />
      <xsd:element ref="INV" minOccurs="1" maxOccurs="unbounded" />
    </xsd:sequence>
  </xsd:complexType>
  <xsd:element name="INU_U05" type="INU_U05.CONTENT" />
</xsd:schema>

Download

ACK^U05^ACK: General Acknowledgment

Message Structure
Acknowlegment Choreography
v2.xml XSD

HL7 MessageStructure Table - ACK
Segment	Cardinality	Must Implement
ACK
MSH	1..1	Yes
SFT	0..*
UAC	0..1
MSA	1..1	Yes
ERR	0..*

Original Mode Acknowledgement Choreography for ACK^U05^ACK

Send An Acknowlegment is never sent in original mode.

Enhanced Mode Acknowledgement Choreography for ACK^U05^ACK

When the MSH-15 value of an ACK^U05^ACK message is AL or ER or SU, an ACK^U05^ACK message SHALL be sent as an immediate ack.

When the MSH-15 value of an ACK^U05^ACK message is NE, an immediate ack SHALL NOT be sent.

Never send an application ack in enhanced mode.

Field	Value	Send Response
MSH-15	AL, ER, SU	immediate ack: ACK^U05^ACK
MSH-15	NE	(none)
MSH-16	NE	(none)

<?xml version="1.0"?>
<!--   v2.xml Message Definitions for Version 2.8.2 - here: ACK-->
<!--   Copyright (c) 1999-2019, Health Level Seven. All rights reserved.   -->
<!--   (generated on 09.01.2019 by HL7-Database) D:\Eigene Dateien\HL7\Datenbank\hl7_94.mdb-->
<xsd:schema xmlns:xsd="http://www.w3.org/2001/XMLSchema"
xmlns="urn:hl7-org:v2xml" xmlns:hl7="urn:hl7-org:v2xml"
targetNamespace="urn:hl7-org:v2xml" version="1.1">
  <!-- import segment definition for version -->
  <xsd:include schemaLocation="segments.xsd" />
  <!-- MESSAGE ACK -->
  <!-- .. message definition ACK -->
  <xsd:complexType name="ACK.CONTENT">
    <xsd:sequence>
      <xsd:element ref="MSH" minOccurs="1" maxOccurs="1" />
      <xsd:element ref="SFT" minOccurs="0" maxOccurs="unbounded" />
      <xsd:element ref="UAC" minOccurs="0" maxOccurs="1" />
      <xsd:element ref="MSA" minOccurs="1" maxOccurs="1" />
      <xsd:element ref="ERR" minOccurs="0" maxOccurs="unbounded" />
    </xsd:sequence>
  </xsd:complexType>
  <xsd:element name="ACK" type="ACK.CONTENT" />
</xsd:schema>

Download

INR/ACK – Automated Equipment Inventory Request (Event U06)

This message is used to request information about inventory items from one application to another (e.g., Laboratory Automation System to automated equipment). The equipment specified in the EQU segment should respond with the information about inventory item requested in the INV segment (or all items).

INR^U06^INR_U06: Inventory Request Message

Message Structure
Acknowlegment Choreography
v2.xml XSD

HL7 MessageStructure Table - INU_U05
Segment	Cardinality	Must Implement	Status
INU_U05
MSH	1..1	Yes
SFT	0..*
UAC	0..1
EQU	1..1	Yes
INV	1..*	Yes
ROL	0..1		B

Original Mode Acknowledgement Choreography for INR^U06^INR_U06

Send Application Ack: INU^U05^INU_U05

Enhanced Mode Acknowledgement Choreography for INR^U06^INR_U06

When the MSH-15 value of an INR^U06^INR_U06 message is AL or ER or SU, an ACK^U06^ACK message SHALL be sent as an immediate ack.

When the MSH-15 value of an INR^U06^INR_U06 message is NE, an immediate ack SHALL NOT be sent.

When the MSH-16 value of an INR^U06^INR_U06 message is AL or ER or SU, an INU^U05^INU_U05 message SHALL be sent as an application ack.

When the MSH-16 value of an INR^U06^INR_U06 message is NE, an application ack SHALL NOT be sent.

Field	Value	Send Response
MSH-15	AL, ER, SU	immediate ack: ACK^U06^ACK
MSH-15	NE	(none)
MSH-16	AL, ER, SU	application ack: INU^U05^INU_U05
MSH-16	NE	(none)

<?xml version="1.0"?>
<!--   v2.xml Message Definitions for Version 2.8.2 - here: INR_U06-->
<!--   Copyright (c) 1999-2019, Health Level Seven. All rights reserved.   -->
<!--   (generated on 09.01.2019 by HL7-Database) D:\Eigene Dateien\HL7\Datenbank\hl7_94.mdb-->
<xsd:schema xmlns:xsd="http://www.w3.org/2001/XMLSchema"
xmlns="urn:hl7-org:v2xml" xmlns:hl7="urn:hl7-org:v2xml"
targetNamespace="urn:hl7-org:v2xml" version="1.1">
  <!-- import segment definition for version -->
  <xsd:include schemaLocation="segments.xsd" />
  <!-- MESSAGE INR_U06 -->
  <!-- .. message definition INR_U06 -->
  <xsd:complexType name="INR_U06.CONTENT">
    <xsd:sequence>
      <xsd:element ref="MSH" minOccurs="1" maxOccurs="1" />
      <xsd:element ref="SFT" minOccurs="0" maxOccurs="unbounded" />
      <xsd:element ref="UAC" minOccurs="0" maxOccurs="1" />
      <xsd:element ref="EQU" minOccurs="1" maxOccurs="1" />
      <xsd:element ref="INV" minOccurs="1" maxOccurs="unbounded" />
    </xsd:sequence>
  </xsd:complexType>
  <xsd:element name="INR_U06" type="INR_U06.CONTENT" />
</xsd:schema>

Download

ACK^U06^ACK: General Acknowledgment

Message Structure
Acknowlegment Choreography
v2.xml XSD

HL7 MessageStructure Table - ACK
Segment	Cardinality	Must Implement
ACK
MSH	1..1	Yes
SFT	0..*
UAC	0..1
MSA	1..1	Yes
ERR	0..*

Original Mode Acknowledgement Choreography for ACK^U06^ACK

Send An Acknowlegment is never sent in original mode.

Enhanced Mode Acknowledgement Choreography for ACK^U06^ACK

When the MSH-15 value of an ACK^U06^ACK message is AL or ER or SU, an ACK^U06^ACK message SHALL be sent as an immediate ack.

When the MSH-15 value of an ACK^U06^ACK message is NE, an immediate ack SHALL NOT be sent.

Never send an application ack in enhanced mode.

Field	Value	Send Response
MSH-15	AL, ER, SU	immediate ack: ACK^U06^ACK
MSH-15	NE	(none)
MSH-16	NE	(none)

<?xml version="1.0"?>
<!--   v2.xml Message Definitions for Version 2.8.2 - here: ACK-->
<!--   Copyright (c) 1999-2019, Health Level Seven. All rights reserved.   -->
<!--   (generated on 09.01.2019 by HL7-Database) D:\Eigene Dateien\HL7\Datenbank\hl7_94.mdb-->
<xsd:schema xmlns:xsd="http://www.w3.org/2001/XMLSchema"
xmlns="urn:hl7-org:v2xml" xmlns:hl7="urn:hl7-org:v2xml"
targetNamespace="urn:hl7-org:v2xml" version="1.1">
  <!-- import segment definition for version -->
  <xsd:include schemaLocation="segments.xsd" />
  <!-- MESSAGE ACK -->
  <!-- .. message definition ACK -->
  <xsd:complexType name="ACK.CONTENT">
    <xsd:sequence>
      <xsd:element ref="MSH" minOccurs="1" maxOccurs="1" />
      <xsd:element ref="SFT" minOccurs="0" maxOccurs="unbounded" />
      <xsd:element ref="UAC" minOccurs="0" maxOccurs="1" />
      <xsd:element ref="MSA" minOccurs="1" maxOccurs="1" />
      <xsd:element ref="ERR" minOccurs="0" maxOccurs="unbounded" />
    </xsd:sequence>
  </xsd:complexType>
  <xsd:element name="ACK" type="ACK.CONTENT" />
</xsd:schema>

Download

EAC/ACK – Automated Equipment Command (Event U07)

This message is used to send equipment commands from one application to another (e.g., a Laboratory Automation System to automated Equipment). The OBR segments attached to the SAC should be used for transfer of information about tests assigned to a specific aliquot in the aliquoting command (not included in the SAC segment, but relevant for automating processing).

The repeatability of the DST segment should be used for multiple destinations in sequence and the remark may be used as additional information, e.g. for destination dependent bar code labels for the secondary (aliquot) containers.

The repeatability of the Specimen Container block enables sending commands for Pooling specimen (multiple sources) from a Primary Specimen. Command for multiple aliquots requires specific Command group for each aliquot.

EAC^U07^EAC_U07: Equipment Command Message

Message Structure
Acknowlegment Choreography
v2.xml XSD

HL7 MessageStructure Table - EAC_U07
Segment	Cardinality	Must Implement	Status
EAC_U07
MSH	1..1	Yes
SFT	0..*
UAC	0..1
EQU	1..1	Yes
COMMAND	1..*	Yes
ECD	1..1	Yes
TQ1	0..1
CNS	0..1
SPECIMEN_CONTAINER	0..*
SAC	1..1	Yes
SPM	0..*
DST	0..*
ORDER_FOR_SPECIMEN_CONTAINER	0..*
OBR	0..*
PRT	0..*
ROL	0..1		B

Original Mode Acknowledgement Choreography for EAC^U07^EAC_U07

Send Application Ack: EAR^U08^EAR_U08

Enhanced Mode Acknowledgement Choreography for EAC^U07^EAC_U07

When the MSH-15 value of an EAC^U07^EAC_U07 message is AL or ER or SU, an ACK^U07^ACK message SHALL be sent as an immediate ack.

When the MSH-15 value of an EAC^U07^EAC_U07 message is NE, an immediate ack SHALL NOT be sent.

When the MSH-16 value of an EAC^U07^EAC_U07 message is AL or ER or SU, an EAR^U08^EAR_U08 message SHALL be sent as an application ack.

When the MSH-16 value of an EAC^U07^EAC_U07 message is NE, an application ack SHALL NOT be sent.

Field	Value	Send Response
MSH-15	AL, ER, SU	immediate ack: ACK^U07^ACK
MSH-15	NE	(none)
MSH-16	AL, ER, SU	application ack: EAR^U08^EAR_U08
MSH-16	NE	(none)

<?xml version="1.0"?>
<!--   v2.xml Message Definitions for Version 2.8.2 - here: EAC_U07-->
<!--   Copyright (c) 1999-2019, Health Level Seven. All rights reserved.   -->
<!--   (generated on 09.01.2019 by HL7-Database) D:\Eigene Dateien\HL7\Datenbank\hl7_94.mdb-->
<xsd:schema xmlns:xsd="http://www.w3.org/2001/XMLSchema"
xmlns="urn:hl7-org:v2xml" xmlns:hl7="urn:hl7-org:v2xml"
targetNamespace="urn:hl7-org:v2xml" version="1.1">
  <!-- import segment definition for version -->
  <xsd:include schemaLocation="segments.xsd" />
  <!-- MESSAGE EAC_U07 -->
  <!-- .. message definition EAC_U07 -->
  <xsd:complexType name="EAC_U07.CONTENT">
    <xsd:sequence>
      <xsd:element ref="MSH" minOccurs="1" maxOccurs="1" />
      <xsd:element ref="SFT" minOccurs="0" maxOccurs="unbounded" />
      <xsd:element ref="UAC" minOccurs="0" maxOccurs="1" />
      <xsd:element ref="EQU" minOccurs="1" maxOccurs="1" />
      <xsd:element ref="EAC_U07.COMMAND" minOccurs="1"
      maxOccurs="unbounded" />
    </xsd:sequence>
  </xsd:complexType>
  <xsd:element name="EAC_U07" type="EAC_U07.CONTENT" />
  <xsd:complexType name="EAC_U07.COMMAND.CONTENT">
    <xsd:sequence>
      <xsd:element ref="ECD" minOccurs="1" maxOccurs="1" />
      <xsd:element ref="TQ1" minOccurs="0" maxOccurs="1" />
      <xsd:element ref="EAC_U07.SPECIMEN_CONTAINER" minOccurs="0"
      maxOccurs="1" />
      <xsd:element ref="CNS" minOccurs="0" maxOccurs="1" />
    </xsd:sequence>
  </xsd:complexType>
  <xsd:element name="EAC_U07.COMMAND"
  type="EAC_U07.COMMAND.CONTENT" />
  <xsd:complexType name="EAC_U07.SPECIMEN_CONTAINER.CONTENT">
    <xsd:sequence>
      <xsd:element ref="SAC" minOccurs="1" maxOccurs="1" />
      <xsd:element ref="OBR" minOccurs="0" maxOccurs="unbounded" />
      <xsd:element ref="SPM" minOccurs="0" maxOccurs="unbounded" />
    </xsd:sequence>
  </xsd:complexType>
  <xsd:element name="EAC_U07.SPECIMEN_CONTAINER"
  type="EAC_U07.SPECIMEN_CONTAINER.CONTENT" />
</xsd:schema>

Download

ACK^U07^ACK: General Acknowledgment

Message Structure
Acknowlegment Choreography
v2.xml XSD

HL7 MessageStructure Table - ACK
Segment	Cardinality	Must Implement
ACK
MSH	1..1	Yes
SFT	0..*
UAC	0..1
MSA	1..1	Yes
ERR	0..*

Original Mode Acknowledgement Choreography for ACK^U07^ACK

Send An Acknowlegment is never sent in original mode.

Enhanced Mode Acknowledgement Choreography for ACK^U07^ACK

When the MSH-15 value of an ACK^U07^ACK message is AL or ER or SU, an ACK^U07^ACK message SHALL be sent as an immediate ack.

When the MSH-15 value of an ACK^U07^ACK message is NE, an immediate ack SHALL NOT be sent.

Never send an application ack in enhanced mode.

Field	Value	Send Response
MSH-15	AL, ER, SU	immediate ack: ACK^U07^ACK
MSH-15	NE	(none)
MSH-16	NE	(none)

<?xml version="1.0"?>
<!--   v2.xml Message Definitions for Version 2.8.2 - here: ACK-->
<!--   Copyright (c) 1999-2019, Health Level Seven. All rights reserved.   -->
<!--   (generated on 09.01.2019 by HL7-Database) D:\Eigene Dateien\HL7\Datenbank\hl7_94.mdb-->
<xsd:schema xmlns:xsd="http://www.w3.org/2001/XMLSchema"
xmlns="urn:hl7-org:v2xml" xmlns:hl7="urn:hl7-org:v2xml"
targetNamespace="urn:hl7-org:v2xml" version="1.1">
  <!-- import segment definition for version -->
  <xsd:include schemaLocation="segments.xsd" />
  <!-- MESSAGE ACK -->
  <!-- .. message definition ACK -->
  <xsd:complexType name="ACK.CONTENT">
    <xsd:sequence>
      <xsd:element ref="MSH" minOccurs="1" maxOccurs="1" />
      <xsd:element ref="SFT" minOccurs="0" maxOccurs="unbounded" />
      <xsd:element ref="UAC" minOccurs="0" maxOccurs="1" />
      <xsd:element ref="MSA" minOccurs="1" maxOccurs="1" />
      <xsd:element ref="ERR" minOccurs="0" maxOccurs="unbounded" />
    </xsd:sequence>
  </xsd:complexType>
  <xsd:element name="ACK" type="ACK.CONTENT" />
</xsd:schema>

Download

EAR/ACK – Automated Equipment Response (Event U08)

This message is used to send equipment responses to previously issued commands from one application to another (e.g., automated Equipment to a Laboratory Automation System).

EAR^U08^EAR_U08: Equipment Command Message

Message Structure
Acknowlegment Choreography
v2.xml XSD

HL7 MessageStructure Table - EAR_U08
Segment	Cardinality	Must Implement	Status
EAR_U08
MSH	1..1	Yes
SFT	0..*
UAC	0..1
EQU	1..1	Yes
COMMAND_RESPONSE	1..*	Yes
ECD	1..1	Yes
ECR	1..1	Yes
SPECIMEN_CONTAINER	0..1
SAC	1..1	Yes
SPM	0..*
ROL	0..1		B

Original Mode Acknowledgement Choreography for EAR^U08^EAR_U08

Send Application Ack: ACK^U08^ACK

Enhanced Mode Acknowledgement Choreography for EAR^U08^EAR_U08

When the MSH-15 value of an EAR^U08^EAR_U08 message is AL or ER or SU, an ACK^U08^ACK message SHALL be sent as an immediate ack.

When the MSH-15 value of an EAR^U08^EAR_U08 message is NE, an immediate ack SHALL NOT be sent.

When the MSH-16 value of an EAR^U08^EAR_U08 message is AL or ER or SU, an ACK^U08^ACK message SHALL be sent as an application ack.

When the MSH-16 value of an EAR^U08^EAR_U08 message is NE, an application ack SHALL NOT be sent.

Field	Value	Send Response
MSH-15	AL, ER, SU	immediate ack: ACK^U08^ACK
MSH-15	NE	(none)
MSH-16	AL, ER, SU	application ack: ACK^U08^ACK
MSH-16	NE	(none)

<?xml version="1.0"?>
<!--   v2.xml Message Definitions for Version 2.8.2 - here: EAR_U08-->
<!--   Copyright (c) 1999-2019, Health Level Seven. All rights reserved.   -->
<!--   (generated on 09.01.2019 by HL7-Database) D:\Eigene Dateien\HL7\Datenbank\hl7_94.mdb-->
<xsd:schema xmlns:xsd="http://www.w3.org/2001/XMLSchema"
xmlns="urn:hl7-org:v2xml" xmlns:hl7="urn:hl7-org:v2xml"
targetNamespace="urn:hl7-org:v2xml" version="1.1">
  <!-- import segment definition for version -->
  <xsd:include schemaLocation="segments.xsd" />
  <!-- MESSAGE EAR_U08 -->
  <!-- .. message definition EAR_U08 -->
  <xsd:complexType name="EAR_U08.CONTENT">
    <xsd:sequence>
      <xsd:element ref="MSH" minOccurs="1" maxOccurs="1" />
      <xsd:element ref="SFT" minOccurs="0" maxOccurs="unbounded" />
      <xsd:element ref="UAC" minOccurs="0" maxOccurs="1" />
      <xsd:element ref="EQU" minOccurs="1" maxOccurs="1" />
      <xsd:element ref="EAR_U08.COMMAND_RESPONSE" minOccurs="1"
      maxOccurs="unbounded" />
    </xsd:sequence>
  </xsd:complexType>
  <xsd:element name="EAR_U08" type="EAR_U08.CONTENT" />
  <xsd:complexType name="EAR_U08.COMMAND_RESPONSE.CONTENT">
    <xsd:sequence>
      <xsd:element ref="ECD" minOccurs="1" maxOccurs="1" />
      <xsd:element ref="EAR_U08.SPECIMEN_CONTAINER" minOccurs="0"
      maxOccurs="1" />
      <xsd:element ref="ECR" minOccurs="1" maxOccurs="1" />
    </xsd:sequence>
  </xsd:complexType>
  <xsd:element name="EAR_U08.COMMAND_RESPONSE"
  type="EAR_U08.COMMAND_RESPONSE.CONTENT" />
  <xsd:complexType name="EAR_U08.SPECIMEN_CONTAINER.CONTENT">
    <xsd:sequence>
      <xsd:element ref="SAC" minOccurs="1" maxOccurs="1" />
      <xsd:element ref="SPM" minOccurs="0" maxOccurs="unbounded" />
    </xsd:sequence>
  </xsd:complexType>
  <xsd:element name="EAR_U08.SPECIMEN_CONTAINER"
  type="EAR_U08.SPECIMEN_CONTAINER.CONTENT" />
</xsd:schema>

Download

ACK^U08^ACK: General Acknowledgment

Message Structure
Acknowlegment Choreography
v2.xml XSD

HL7 MessageStructure Table - ACK
Segment	Cardinality	Must Implement
ACK
MSH	1..1	Yes
SFT	0..*
UAC	0..1
MSA	1..1	Yes
ERR	0..*

Original Mode Acknowledgement Choreography for ACK^U08^ACK

Send An Acknowlegment is never sent in original mode.

Enhanced Mode Acknowledgement Choreography for ACK^U08^ACK

When the MSH-15 value of an ACK^U08^ACK message is AL or ER or SU, an ACK^U08^ACK message SHALL be sent as an immediate ack.

When the MSH-15 value of an ACK^U08^ACK message is NE, an immediate ack SHALL NOT be sent.

Never send an application ack in enhanced mode.

Field	Value	Send Response
MSH-15	AL, ER, SU	immediate ack: ACK^U08^ACK
MSH-15	NE	(none)
MSH-16	NE	(none)

<?xml version="1.0"?>
<!--   v2.xml Message Definitions for Version 2.8.2 - here: ACK-->
<!--   Copyright (c) 1999-2019, Health Level Seven. All rights reserved.   -->
<!--   (generated on 09.01.2019 by HL7-Database) D:\Eigene Dateien\HL7\Datenbank\hl7_94.mdb-->
<xsd:schema xmlns:xsd="http://www.w3.org/2001/XMLSchema"
xmlns="urn:hl7-org:v2xml" xmlns:hl7="urn:hl7-org:v2xml"
targetNamespace="urn:hl7-org:v2xml" version="1.1">
  <!-- import segment definition for version -->
  <xsd:include schemaLocation="segments.xsd" />
  <!-- MESSAGE ACK -->
  <!-- .. message definition ACK -->
  <xsd:complexType name="ACK.CONTENT">
    <xsd:sequence>
      <xsd:element ref="MSH" minOccurs="1" maxOccurs="1" />
      <xsd:element ref="SFT" minOccurs="0" maxOccurs="unbounded" />
      <xsd:element ref="UAC" minOccurs="0" maxOccurs="1" />
      <xsd:element ref="MSA" minOccurs="1" maxOccurs="1" />
      <xsd:element ref="ERR" minOccurs="0" maxOccurs="unbounded" />
    </xsd:sequence>
  </xsd:complexType>
  <xsd:element name="ACK" type="ACK.CONTENT" />
</xsd:schema>

Download

EAN/ACK - Automated Equipment Notification (Event U09)

This message is used to send equipment notifications from one application to another (e.g., alerts sent by automated equipment to a Laboratory Automation System).

EAN^U09^EAN_U09: Equipment Status Message

Message Structure
Acknowlegment Choreography
v2.xml XSD

HL7 MessageStructure Table - EAN_U09
Segment	Cardinality	Must Implement	Status
EAN_U09
MSH	1..1	Yes
SFT	0..*
UAC	0..1
EQU	1..1	Yes
NOTIFICATION	1..*	Yes
NDS	1..1	Yes
NTE	0..1
ROL	0..1		B

Original Mode Acknowledgement Choreography for EAN^U09^EAN_U09

Send Application Ack: ACK^U09^ACK

Enhanced Mode Acknowledgement Choreography for EAN^U09^EAN_U09

When the MSH-15 value of an EAN^U09^EAN_U09 message is AL or ER or SU, an ACK^U09^ACK message SHALL be sent as an immediate ack.

When the MSH-15 value of an EAN^U09^EAN_U09 message is NE, an immediate ack SHALL NOT be sent.

When the MSH-16 value of an EAN^U09^EAN_U09 message is AL or ER or SU, an ACK^U09^ACK message SHALL be sent as an application ack.

When the MSH-16 value of an EAN^U09^EAN_U09 message is NE, an application ack SHALL NOT be sent.

Field	Value	Send Response
MSH-15	AL, ER, SU	immediate ack: ACK^U09^ACK
MSH-15	NE	(none)
MSH-16	AL, ER, SU	application ack: ACK^U09^ACK
MSH-16	NE	(none)

<?xml version="1.0"?>
<!--   v2.xml Message Definitions for Version 2.8.2 - here: EAN_U09-->
<!--   Copyright (c) 1999-2019, Health Level Seven. All rights reserved.   -->
<!--   (generated on 09.01.2019 by HL7-Database) D:\Eigene Dateien\HL7\Datenbank\hl7_94.mdb-->
<xsd:schema xmlns:xsd="http://www.w3.org/2001/XMLSchema"
xmlns="urn:hl7-org:v2xml" xmlns:hl7="urn:hl7-org:v2xml"
targetNamespace="urn:hl7-org:v2xml" version="1.1">
  <!-- import segment definition for version -->
  <xsd:include schemaLocation="segments.xsd" />
  <!-- MESSAGE EAN_U09 -->
  <!-- .. message definition EAN_U09 -->
  <xsd:complexType name="EAN_U09.CONTENT">
    <xsd:sequence>
      <xsd:element ref="MSH" minOccurs="1" maxOccurs="1" />
      <xsd:element ref="SFT" minOccurs="0" maxOccurs="unbounded" />
      <xsd:element ref="UAC" minOccurs="0" maxOccurs="1" />
      <xsd:element ref="EQU" minOccurs="1" maxOccurs="1" />
      <xsd:element ref="EAN_U09.NOTIFICATION" minOccurs="1"
      maxOccurs="unbounded" />
    </xsd:sequence>
  </xsd:complexType>
  <xsd:element name="EAN_U09" type="EAN_U09.CONTENT" />
  <xsd:complexType name="EAN_U09.NOTIFICATION.CONTENT">
    <xsd:sequence>
      <xsd:element ref="NDS" minOccurs="1" maxOccurs="1" />
      <xsd:element ref="NTE" minOccurs="0" maxOccurs="1" />
    </xsd:sequence>
  </xsd:complexType>
  <xsd:element name="EAN_U09.NOTIFICATION"
  type="EAN_U09.NOTIFICATION.CONTENT" />
</xsd:schema>

Download

ACK^U09^ACK: General Acknowledgment

Message Structure
Acknowlegment Choreography
v2.xml XSD

HL7 MessageStructure Table - ACK
Segment	Cardinality	Must Implement
ACK
MSH	1..1	Yes
SFT	0..*
UAC	0..1
MSA	1..1	Yes
ERR	0..*

Original Mode Acknowledgement Choreography for ACK^U09^ACK

Send An Acknowlegment is never sent in original mode.

Enhanced Mode Acknowledgement Choreography for ACK^U09^ACK

When the MSH-15 value of an ACK^U09^ACK message is AL or ER or SU, an ACK^U09^ACK message SHALL be sent as an immediate ack.

When the MSH-15 value of an ACK^U09^ACK message is NE, an immediate ack SHALL NOT be sent.

Never send an application ack in enhanced mode.

Field	Value	Send Response
MSH-15	AL, ER, SU	immediate ack: ACK^U09^ACK
MSH-15	NE	(none)
MSH-16	NE	(none)

<?xml version="1.0"?>
<!--   v2.xml Message Definitions for Version 2.8.2 - here: ACK-->
<!--   Copyright (c) 1999-2019, Health Level Seven. All rights reserved.   -->
<!--   (generated on 09.01.2019 by HL7-Database) D:\Eigene Dateien\HL7\Datenbank\hl7_94.mdb-->
<xsd:schema xmlns:xsd="http://www.w3.org/2001/XMLSchema"
xmlns="urn:hl7-org:v2xml" xmlns:hl7="urn:hl7-org:v2xml"
targetNamespace="urn:hl7-org:v2xml" version="1.1">
  <!-- import segment definition for version -->
  <xsd:include schemaLocation="segments.xsd" />
  <!-- MESSAGE ACK -->
  <!-- .. message definition ACK -->
  <xsd:complexType name="ACK.CONTENT">
    <xsd:sequence>
      <xsd:element ref="MSH" minOccurs="1" maxOccurs="1" />
      <xsd:element ref="SFT" minOccurs="0" maxOccurs="unbounded" />
      <xsd:element ref="UAC" minOccurs="0" maxOccurs="1" />
      <xsd:element ref="MSA" minOccurs="1" maxOccurs="1" />
      <xsd:element ref="ERR" minOccurs="0" maxOccurs="unbounded" />
    </xsd:sequence>
  </xsd:complexType>
  <xsd:element name="ACK" type="ACK.CONTENT" />
</xsd:schema>

Download

TCU/ACK - Automated Equipment Test Code Settings Update (Event U10)

This message is used to send information concerning test codes and parameters from one application to another (e.g., automated equipment to a Laboratory Automation System). This message transfers the current snapshot of the test parameters of the sending system. The sent parameter sets are supposed to replace the parameter sets existing at the receiver of this message before the trigger (there is no selective "Add" or "Delete").

TCU^U10^TCU_U10: Test Code Settings Update

Message Structure
Acknowlegment Choreography
v2.xml XSD

HL7 MessageStructure Table - TCU_U10
Segment	Cardinality	Must Implement	Status
TCU_U10
MSH	1..1	Yes
SFT	0..*
UAC	0..1
EQU	1..1	Yes
TEST_CONFIGURATION	1..*	Yes
SPM	0..1
TCC	1..*	Yes
ROL	0..1		B

Original Mode Acknowledgement Choreography for TCU^U10^TCU_U10

Send Application Ack: ACK^U10^ACK

Enhanced Mode Acknowledgement Choreography for TCU^U10^TCU_U10

When the MSH-15 value of a TCU^U10^TCU_U10 message is AL or ER or SU, an ACK^U10^ACK message SHALL be sent as an immediate ack.

When the MSH-15 value of a TCU^U10^TCU_U10 message is NE, an immediate ack SHALL NOT be sent.

When the MSH-16 value of a TCU^U10^TCU_U10 message is AL or ER or SU, an ACK^U10^ACK message SHALL be sent as an application ack.

When the MSH-16 value of a TCU^U10^TCU_U10 message is NE, an application ack SHALL NOT be sent.

Field	Value	Send Response
MSH-15	AL, ER, SU	immediate ack: ACK^U10^ACK
MSH-15	NE	(none)
MSH-16	AL, ER, SU	application ack: ACK^U10^ACK
MSH-16	NE	(none)

<?xml version="1.0"?>
<!--   v2.xml Message Definitions for Version 2.8.2 - here: TCU_U10-->
<!--   Copyright (c) 1999-2019, Health Level Seven. All rights reserved.   -->
<!--   (generated on 09.01.2019 by HL7-Database) D:\Eigene Dateien\HL7\Datenbank\hl7_94.mdb-->
<xsd:schema xmlns:xsd="http://www.w3.org/2001/XMLSchema"
xmlns="urn:hl7-org:v2xml" xmlns:hl7="urn:hl7-org:v2xml"
targetNamespace="urn:hl7-org:v2xml" version="1.1">
  <!-- import segment definition for version -->
  <xsd:include schemaLocation="segments.xsd" />
  <!-- MESSAGE TCU_U10 -->
  <!-- .. message definition TCU_U10 -->
  <xsd:complexType name="TCU_U10.CONTENT">
    <xsd:sequence>
      <xsd:element ref="MSH" minOccurs="1" maxOccurs="1" />
      <xsd:element ref="SFT" minOccurs="0" maxOccurs="unbounded" />
      <xsd:element ref="UAC" minOccurs="0" maxOccurs="1" />
      <xsd:element ref="EQU" minOccurs="1" maxOccurs="1" />
      <xsd:element ref="TCU_U10.TEST_CONFIGURATION" minOccurs="1"
      maxOccurs="unbounded" />
    </xsd:sequence>
  </xsd:complexType>
  <xsd:element name="TCU_U10" type="TCU_U10.CONTENT" />
  <xsd:complexType name="TCU_U10.TEST_CONFIGURATION.CONTENT">
    <xsd:sequence>
      <xsd:element ref="SPM" minOccurs="0" maxOccurs="1" />
      <xsd:element ref="TCC" minOccurs="1" maxOccurs="unbounded" />
    </xsd:sequence>
  </xsd:complexType>
  <xsd:element name="TCU_U10.TEST_CONFIGURATION"
  type="TCU_U10.TEST_CONFIGURATION.CONTENT" />
</xsd:schema>

Download

ACK^U10^ACK: General Acknowledgment

Message Structure
Acknowlegment Choreography
v2.xml XSD

HL7 MessageStructure Table - ACK
Segment	Cardinality	Must Implement
ACK
MSH	1..1	Yes
SFT	0..*
UAC	0..1
MSA	1..1	Yes
ERR	0..*

Original Mode Acknowledgement Choreography for ACK^U10^ACK

Send An Acknowlegment is never sent in original mode.

Enhanced Mode Acknowledgement Choreography for ACK^U10^ACK

When the MSH-15 value of an ACK^U10^ACK message is AL or ER or SU, an ACK^U10^ACK message SHALL be sent as an immediate ack.

When the MSH-15 value of an ACK^U10^ACK message is NE, an immediate ack SHALL NOT be sent.

Never send an application ack in enhanced mode.

Field	Value	Send Response
MSH-15	AL, ER, SU	immediate ack: ACK^U10^ACK
MSH-15	NE	(none)
MSH-16	NE	(none)

<?xml version="1.0"?>
<!--   v2.xml Message Definitions for Version 2.8.2 - here: ACK-->
<!--   Copyright (c) 1999-2019, Health Level Seven. All rights reserved.   -->
<!--   (generated on 09.01.2019 by HL7-Database) D:\Eigene Dateien\HL7\Datenbank\hl7_94.mdb-->
<xsd:schema xmlns:xsd="http://www.w3.org/2001/XMLSchema"
xmlns="urn:hl7-org:v2xml" xmlns:hl7="urn:hl7-org:v2xml"
targetNamespace="urn:hl7-org:v2xml" version="1.1">
  <!-- import segment definition for version -->
  <xsd:include schemaLocation="segments.xsd" />
  <!-- MESSAGE ACK -->
  <!-- .. message definition ACK -->
  <xsd:complexType name="ACK.CONTENT">
    <xsd:sequence>
      <xsd:element ref="MSH" minOccurs="1" maxOccurs="1" />
      <xsd:element ref="SFT" minOccurs="0" maxOccurs="unbounded" />
      <xsd:element ref="UAC" minOccurs="0" maxOccurs="1" />
      <xsd:element ref="MSA" minOccurs="1" maxOccurs="1" />
      <xsd:element ref="ERR" minOccurs="0" maxOccurs="unbounded" />
    </xsd:sequence>
  </xsd:complexType>
  <xsd:element name="ACK" type="ACK.CONTENT" />
</xsd:schema>

Download

TCR/ACK - Automated Equipment Test Code Settings Request (Event U11)

This message is used to request information concerning test codes from one application to another (e.g., Laboratory Automation System to automated equipment).

TCR^U11^TCU_U10: Test Code Settings Request

Message Structure
Acknowlegment Choreography
v2.xml XSD

HL7 MessageStructure Table - TCU_U10
Segment	Cardinality	Must Implement	Status
TCU_U10
MSH	1..1	Yes
SFT	0..*
UAC	0..1
EQU	1..1	Yes
TEST_CONFIGURATION	1..*	Yes
SPM	0..1
TCC	1..*	Yes
ROL	0..1		B

Original Mode Acknowledgement Choreography for TCR^U11^TCU_U10

Send Application Ack: TCU^U10^TCU_U10

Enhanced Mode Acknowledgement Choreography for TCR^U11^TCU_U10

When the MSH-15 value of a TCR^U11^TCU_U10 message is AL or ER or SU, an ACK^U11^ACK message SHALL be sent as an immediate ack.

When the MSH-15 value of a TCR^U11^TCU_U10 message is NE, an immediate ack SHALL NOT be sent.

When the MSH-16 value of a TCR^U11^TCU_U10 message is AL or ER or SU, a TCU^U10^TCU_U10 message SHALL be sent as an application ack.

When the MSH-16 value of a TCR^U11^TCU_U10 message is NE, an application ack SHALL NOT be sent.

Field	Value	Send Response
MSH-15	AL, ER, SU	immediate ack: ACK^U11^ACK
MSH-15	NE	(none)
MSH-16	AL, ER, SU	application ack: TCU^U10^TCU_U10
MSH-16	NE	(none)

<?xml version="1.0"?>
<!--   v2.xml Message Definitions for Version 2.8.2 - here: TCU_U10-->
<!--   Copyright (c) 1999-2019, Health Level Seven. All rights reserved.   -->
<!--   (generated on 09.01.2019 by HL7-Database) D:\Eigene Dateien\HL7\Datenbank\hl7_94.mdb-->
<xsd:schema xmlns:xsd="http://www.w3.org/2001/XMLSchema"
xmlns="urn:hl7-org:v2xml" xmlns:hl7="urn:hl7-org:v2xml"
targetNamespace="urn:hl7-org:v2xml" version="1.1">
  <!-- import segment definition for version -->
  <xsd:include schemaLocation="segments.xsd" />
  <!-- MESSAGE TCU_U10 -->
  <!-- .. message definition TCU_U10 -->
  <xsd:complexType name="TCU_U10.CONTENT">
    <xsd:sequence>
      <xsd:element ref="MSH" minOccurs="1" maxOccurs="1" />
      <xsd:element ref="SFT" minOccurs="0" maxOccurs="unbounded" />
      <xsd:element ref="UAC" minOccurs="0" maxOccurs="1" />
      <xsd:element ref="EQU" minOccurs="1" maxOccurs="1" />
      <xsd:element ref="TCU_U10.TEST_CONFIGURATION" minOccurs="1"
      maxOccurs="unbounded" />
    </xsd:sequence>
  </xsd:complexType>
  <xsd:element name="TCU_U10" type="TCU_U10.CONTENT" />
  <xsd:complexType name="TCU_U10.TEST_CONFIGURATION.CONTENT">
    <xsd:sequence>
      <xsd:element ref="SPM" minOccurs="0" maxOccurs="1" />
      <xsd:element ref="TCC" minOccurs="1" maxOccurs="unbounded" />
    </xsd:sequence>
  </xsd:complexType>
  <xsd:element name="TCU_U10.TEST_CONFIGURATION"
  type="TCU_U10.TEST_CONFIGURATION.CONTENT" />
</xsd:schema>

Download

ACK^U11^ACK: General Acknowledgment

Message Structure
Acknowlegment Choreography
v2.xml XSD

HL7 MessageStructure Table - ACK
Segment	Cardinality	Must Implement
ACK
MSH	1..1	Yes
SFT	0..*
UAC	0..1
MSA	1..1	Yes
ERR	0..*

Original Mode Acknowledgement Choreography for ACK^U11^ACK

Send An Acknowlegment is never sent in original mode.

Enhanced Mode Acknowledgement Choreography for ACK^U11^ACK

When the MSH-15 value of an ACK^U11^ACK message is AL or ER or SU, an ACK^U11^ACK message SHALL be sent as an immediate ack.

When the MSH-15 value of an ACK^U11^ACK message is NE, an immediate ack SHALL NOT be sent.

Never send an application ack in enhanced mode.

Field	Value	Send Response
MSH-15	AL, ER, SU	immediate ack: ACK^U11^ACK
MSH-15	NE	(none)
MSH-16	NE	(none)

<?xml version="1.0"?>
<!--   v2.xml Message Definitions for Version 2.8.2 - here: ACK-->
<!--   Copyright (c) 1999-2019, Health Level Seven. All rights reserved.   -->
<!--   (generated on 09.01.2019 by HL7-Database) D:\Eigene Dateien\HL7\Datenbank\hl7_94.mdb-->
<xsd:schema xmlns:xsd="http://www.w3.org/2001/XMLSchema"
xmlns="urn:hl7-org:v2xml" xmlns:hl7="urn:hl7-org:v2xml"
targetNamespace="urn:hl7-org:v2xml" version="1.1">
  <!-- import segment definition for version -->
  <xsd:include schemaLocation="segments.xsd" />
  <!-- MESSAGE ACK -->
  <!-- .. message definition ACK -->
  <xsd:complexType name="ACK.CONTENT">
    <xsd:sequence>
      <xsd:element ref="MSH" minOccurs="1" maxOccurs="1" />
      <xsd:element ref="SFT" minOccurs="0" maxOccurs="unbounded" />
      <xsd:element ref="UAC" minOccurs="0" maxOccurs="1" />
      <xsd:element ref="MSA" minOccurs="1" maxOccurs="1" />
      <xsd:element ref="ERR" minOccurs="0" maxOccurs="unbounded" />
    </xsd:sequence>
  </xsd:complexType>
  <xsd:element name="ACK" type="ACK.CONTENT" />
</xsd:schema>

Download

LSU/ACK - Automated Equipment Log/Service Update (Event U12)

This message is used to send log and/or service events from one application to another (e.g., automated equipment to Laboratory Automation System).

LSU^U12^LSU_U12: Equipment Log/Service Message

Message Structure
Acknowlegment Choreography
v2.xml XSD

HL7 MessageStructure Table - LSU_U12
Segment	Cardinality	Must Implement	Status
LSU_U12
MSH	1..1	Yes
SFT	0..*
UAC	0..1
EQU	1..1	Yes
EQP	1..*	Yes
ROL	0..1		B

Original Mode Acknowledgement Choreography for LSU^U12^LSU_U12

Send Application Ack: ACK^U12^ACK

Enhanced Mode Acknowledgement Choreography for LSU^U12^LSU_U12

When the MSH-15 value of a LSU^U12^LSU_U12 message is AL or ER or SU, an ACK^U12^ACK message SHALL be sent as an immediate ack.

When the MSH-15 value of a LSU^U12^LSU_U12 message is NE, an immediate ack SHALL NOT be sent.

When the MSH-16 value of a LSU^U12^LSU_U12 message is AL or ER or SU, an ACK^U12^ACK message SHALL be sent as an application ack.

When the MSH-16 value of a LSU^U12^LSU_U12 message is NE, an application ack SHALL NOT be sent.

Field	Value	Send Response
MSH-15	AL, ER, SU	immediate ack: ACK^U12^ACK
MSH-15	NE	(none)
MSH-16	AL, ER, SU	application ack: ACK^U12^ACK
MSH-16	NE	(none)

<?xml version="1.0"?>
<!--   v2.xml Message Definitions for Version 2.8.2 - here: LSU_U12-->
<!--   Copyright (c) 1999-2019, Health Level Seven. All rights reserved.   -->
<!--   (generated on 09.01.2019 by HL7-Database) D:\Eigene Dateien\HL7\Datenbank\hl7_94.mdb-->
<xsd:schema xmlns:xsd="http://www.w3.org/2001/XMLSchema"
xmlns="urn:hl7-org:v2xml" xmlns:hl7="urn:hl7-org:v2xml"
targetNamespace="urn:hl7-org:v2xml" version="1.1">
  <!-- import segment definition for version -->
  <xsd:include schemaLocation="segments.xsd" />
  <!-- MESSAGE LSU_U12 -->
  <!-- .. message definition LSU_U12 -->
  <xsd:complexType name="LSU_U12.CONTENT">
    <xsd:sequence>
      <xsd:element ref="MSH" minOccurs="1" maxOccurs="1" />
      <xsd:element ref="SFT" minOccurs="0" maxOccurs="unbounded" />
      <xsd:element ref="UAC" minOccurs="0" maxOccurs="1" />
      <xsd:element ref="EQU" minOccurs="1" maxOccurs="1" />
      <xsd:element ref="EQP" minOccurs="1" maxOccurs="unbounded" />
    </xsd:sequence>
  </xsd:complexType>
  <xsd:element name="LSU_U12" type="LSU_U12.CONTENT" />
</xsd:schema>

Download

ACK^U12^ACK: General Acknowledgment

Message Structure
Acknowlegment Choreography
v2.xml XSD

HL7 MessageStructure Table - ACK
Segment	Cardinality	Must Implement
ACK
MSH	1..1	Yes
SFT	0..*
UAC	0..1
MSA	1..1	Yes
ERR	0..*

Original Mode Acknowledgement Choreography for ACK^U12^ACK

Send An Acknowlegment is never sent in original mode.

Enhanced Mode Acknowledgement Choreography for ACK^U12^ACK

When the MSH-15 value of an ACK^U12^ACK message is AL or ER or SU, an ACK^U12^ACK message SHALL be sent as an immediate ack.

When the MSH-15 value of an ACK^U12^ACK message is NE, an immediate ack SHALL NOT be sent.

Never send an application ack in enhanced mode.

Field	Value	Send Response
MSH-15	AL, ER, SU	immediate ack: ACK^U12^ACK
MSH-15	NE	(none)
MSH-16	NE	(none)

<?xml version="1.0"?>
<!--   v2.xml Message Definitions for Version 2.8.2 - here: ACK-->
<!--   Copyright (c) 1999-2019, Health Level Seven. All rights reserved.   -->
<!--   (generated on 09.01.2019 by HL7-Database) D:\Eigene Dateien\HL7\Datenbank\hl7_94.mdb-->
<xsd:schema xmlns:xsd="http://www.w3.org/2001/XMLSchema"
xmlns="urn:hl7-org:v2xml" xmlns:hl7="urn:hl7-org:v2xml"
targetNamespace="urn:hl7-org:v2xml" version="1.1">
  <!-- import segment definition for version -->
  <xsd:include schemaLocation="segments.xsd" />
  <!-- MESSAGE ACK -->
  <!-- .. message definition ACK -->
  <xsd:complexType name="ACK.CONTENT">
    <xsd:sequence>
      <xsd:element ref="MSH" minOccurs="1" maxOccurs="1" />
      <xsd:element ref="SFT" minOccurs="0" maxOccurs="unbounded" />
      <xsd:element ref="UAC" minOccurs="0" maxOccurs="1" />
      <xsd:element ref="MSA" minOccurs="1" maxOccurs="1" />
      <xsd:element ref="ERR" minOccurs="0" maxOccurs="unbounded" />
    </xsd:sequence>
  </xsd:complexType>
  <xsd:element name="ACK" type="ACK.CONTENT" />
</xsd:schema>

Download

LSR/ACK - Automated Equipment Log/Service Request (Event U13)

This message is used to request log and/or service events from one application to another (e.g., Laboratory Automation System to automated equipment).

LSR^U13^LSU_U12: Equipment Log/Service Message

Message Structure
Acknowlegment Choreography
v2.xml XSD

HL7 MessageStructure Table - LSU_U12
Segment	Cardinality	Must Implement	Status
LSU_U12
MSH	1..1	Yes
SFT	0..*
UAC	0..1
EQU	1..1	Yes
EQP	1..*	Yes
ROL	0..1		B

Original Mode Acknowledgement Choreography for LSR^U13^LSU_U12

Send Application Ack: LSU^U12^LSU_U12

Enhanced Mode Acknowledgement Choreography for LSR^U13^LSU_U12

When the MSH-15 value of a LSR^U13^LSU_U12 message is AL or ER or SU, an ACK^U13^ACK message SHALL be sent as an immediate ack.

When the MSH-15 value of a LSR^U13^LSU_U12 message is NE, an immediate ack SHALL NOT be sent.

When the MSH-16 value of a LSR^U13^LSU_U12 message is AL or ER or SU, a LSU^U12^LSU_U12 message SHALL be sent as an application ack.

When the MSH-16 value of a LSR^U13^LSU_U12 message is NE, an application ack SHALL NOT be sent.

Field	Value	Send Response
MSH-15	AL, ER, SU	immediate ack: ACK^U13^ACK
MSH-15	NE	(none)
MSH-16	AL, ER, SU	application ack: LSU^U12^LSU_U12
MSH-16	NE	(none)

<?xml version="1.0"?>
<!--   v2.xml Message Definitions for Version 2.8.2 - here: LSU_U12-->
<!--   Copyright (c) 1999-2019, Health Level Seven. All rights reserved.   -->
<!--   (generated on 09.01.2019 by HL7-Database) D:\Eigene Dateien\HL7\Datenbank\hl7_94.mdb-->
<xsd:schema xmlns:xsd="http://www.w3.org/2001/XMLSchema"
xmlns="urn:hl7-org:v2xml" xmlns:hl7="urn:hl7-org:v2xml"
targetNamespace="urn:hl7-org:v2xml" version="1.1">
  <!-- import segment definition for version -->
  <xsd:include schemaLocation="segments.xsd" />
  <!-- MESSAGE LSU_U12 -->
  <!-- .. message definition LSU_U12 -->
  <xsd:complexType name="LSU_U12.CONTENT">
    <xsd:sequence>
      <xsd:element ref="MSH" minOccurs="1" maxOccurs="1" />
      <xsd:element ref="SFT" minOccurs="0" maxOccurs="unbounded" />
      <xsd:element ref="UAC" minOccurs="0" maxOccurs="1" />
      <xsd:element ref="EQU" minOccurs="1" maxOccurs="1" />
      <xsd:element ref="EQP" minOccurs="1" maxOccurs="unbounded" />
    </xsd:sequence>
  </xsd:complexType>
  <xsd:element name="LSU_U12" type="LSU_U12.CONTENT" />
</xsd:schema>

Download

ACK^U13^ACK: General Acknowledgment

Message Structure
Acknowlegment Choreography
v2.xml XSD

HL7 MessageStructure Table - ACK
Segment	Cardinality	Must Implement
ACK
MSH	1..1	Yes
SFT	0..*
UAC	0..1
MSA	1..1	Yes
ERR	0..*

Original Mode Acknowledgement Choreography for ACK^U13^ACK

Send An Acknowlegment is never sent in original mode.

Enhanced Mode Acknowledgement Choreography for ACK^U13^ACK

When the MSH-15 value of an ACK^U13^ACK message is AL or ER or SU, an ACK^U13^ACK message SHALL be sent as an immediate ack.

When the MSH-15 value of an ACK^U13^ACK message is NE, an immediate ack SHALL NOT be sent.

Never send an application ack in enhanced mode.

Field	Value	Send Response
MSH-15	AL, ER, SU	immediate ack: ACK^U13^ACK
MSH-15	NE	(none)
MSH-16	NE	(none)

<?xml version="1.0"?>
<!--   v2.xml Message Definitions for Version 2.8.2 - here: ACK-->
<!--   Copyright (c) 1999-2019, Health Level Seven. All rights reserved.   -->
<!--   (generated on 09.01.2019 by HL7-Database) D:\Eigene Dateien\HL7\Datenbank\hl7_94.mdb-->
<xsd:schema xmlns:xsd="http://www.w3.org/2001/XMLSchema"
xmlns="urn:hl7-org:v2xml" xmlns:hl7="urn:hl7-org:v2xml"
targetNamespace="urn:hl7-org:v2xml" version="1.1">
  <!-- import segment definition for version -->
  <xsd:include schemaLocation="segments.xsd" />
  <!-- MESSAGE ACK -->
  <!-- .. message definition ACK -->
  <xsd:complexType name="ACK.CONTENT">
    <xsd:sequence>
      <xsd:element ref="MSH" minOccurs="1" maxOccurs="1" />
      <xsd:element ref="SFT" minOccurs="0" maxOccurs="unbounded" />
      <xsd:element ref="UAC" minOccurs="0" maxOccurs="1" />
      <xsd:element ref="MSA" minOccurs="1" maxOccurs="1" />
      <xsd:element ref="ERR" minOccurs="0" maxOccurs="unbounded" />
    </xsd:sequence>
  </xsd:complexType>
  <xsd:element name="ACK" type="ACK.CONTENT" />
</xsd:schema>

Download

INR/ACK – Automated Equipment Inventory Request (Event U14)

Compared to INR^U06, it declares INV as optional and does not require fields INV-1 and INV-2 there. In that way, it supports queries for all inventory items without filtering on any attributes.

INR^U14^INR_U14: Inventory Request Message

Message Structure
Acknowlegment Choreography

HL7 MessageStructure Table - INR_U14
Segment	Cardinality	Must Implement
INR_U14
MSH	1..1	Yes
SFT	0..*
UAC	0..1
EQU	1..1	Yes
INV	0..*

Original Mode Acknowledgement Choreography for INR^U14^INR_U14

Send Application Ack: INU^U05^INU_U05

Enhanced Mode Acknowledgement Choreography for INR^U14^INR_U14

When the MSH-15 value of an INR^U14^INR_U14 message is AL or ER or SU, an ACK^U14^ACK message SHALL be sent as an immediate ack.

When the MSH-15 value of an INR^U14^INR_U14 message is NE, an immediate ack SHALL NOT be sent.

When the MSH-16 value of an INR^U14^INR_U14 message is AL or ER or SU, an INU^U05^INU_U05 message SHALL be sent as an application ack.

When the MSH-16 value of an INR^U14^INR_U14 message is NE, an application ack SHALL NOT be sent.

Field	Value	Send Response
MSH-15	AL, ER, SU	immediate ack: ACK^U14^ACK
MSH-15	NE	(none)
MSH-16	AL, ER, SU	application ack: INU^U05^INU_U05
MSH-16	NE	(none)

ACK^U14^ACK: General Acknowledgment

Message Structure
Acknowlegment Choreography
v2.xml XSD

HL7 MessageStructure Table - ACK
Segment	Cardinality	Must Implement
ACK
MSH	1..1	Yes
SFT	0..*
UAC	0..1
MSA	1..1	Yes
ERR	0..*

Original Mode Acknowledgement Choreography for ACK^U14^ACK

Send An Acknowlegment is never sent in original mode.

Enhanced Mode Acknowledgement Choreography for ACK^U14^ACK

When the MSH-15 value of an ACK^U14^ACK message is AL or ER or SU, an ACK^U14^ACK message SHALL be sent as an immediate ack.

When the MSH-15 value of an ACK^U14^ACK message is NE, an immediate ack SHALL NOT be sent.

Never send an application ack in enhanced mode.

Field	Value	Send Response
MSH-15	AL, ER, SU	immediate ack: ACK^U14^ACK
MSH-15	NE	(none)
MSH-16	NE	(none)

<?xml version="1.0"?>
<!--   v2.xml Message Definitions for Version 2.8.2 - here: ACK-->
<!--   Copyright (c) 1999-2019, Health Level Seven. All rights reserved.   -->
<!--   (generated on 09.01.2019 by HL7-Database) D:\Eigene Dateien\HL7\Datenbank\hl7_94.mdb-->
<xsd:schema xmlns:xsd="http://www.w3.org/2001/XMLSchema"
xmlns="urn:hl7-org:v2xml" xmlns:hl7="urn:hl7-org:v2xml"
targetNamespace="urn:hl7-org:v2xml" version="1.1">
  <!-- import segment definition for version -->
  <xsd:include schemaLocation="segments.xsd" />
  <!-- MESSAGE ACK -->
  <!-- .. message definition ACK -->
  <xsd:complexType name="ACK.CONTENT">
    <xsd:sequence>
      <xsd:element ref="MSH" minOccurs="1" maxOccurs="1" />
      <xsd:element ref="SFT" minOccurs="0" maxOccurs="unbounded" />
      <xsd:element ref="UAC" minOccurs="0" maxOccurs="1" />
      <xsd:element ref="MSA" minOccurs="1" maxOccurs="1" />
      <xsd:element ref="ERR" minOccurs="0" maxOccurs="unbounded" />
    </xsd:sequence>
  </xsd:complexType>
  <xsd:element name="ACK" type="ACK.CONTENT" />
</xsd:schema>

Download

Message Segments

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.

EQU - Equipment Detail 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 Segment
Seq#	DataElement	Description	Must Implement	Flags	Cardinality	Vocabulary	DataType
EQU
1	01479	Equipment Instance Identifier	SHALL		[1..*]		EI
2	01322	Event Date/Time	SHALL		[1..1]		DTM
3	01323	Equipment State	MAY True: False:	C	[1..1] [0..1]	0365 Equipment State	CWE
4	01324	Local/Remote Control State			[0..1]	0366 Local/Remote Control State	CWE
5	01325	Alert Level			[0..1]	0367 Alert Level	CWE
6	03487	Expected date/time of the next status change			[0..1]		DTM

EQU-1: Equipment Instance Identifier (EI) 01479

(Definition from OBX.18 in Ch. 7)

Definition: Retained for backwards compatibility as of v 2.7 only. This field is now represented through the PRT segment. This field identifies the Equipment Instance (e.g., Analyzer, Analyzer module, group of Analyzers, etc.) responsible for the production of the observation. This is the identifier from an institution's master list of equipment, where the institution is specified by the namespace ID or if it is blank, then by the "Producer's ID" (OBX-15). It should be possible to retrieve from this master list the equipment type, serial number, etc., however it is not planned to transfer this information with every OBX. The repeating of this field allows for the hierarchical representation of the equipment (lowest level first), e.g., module of an instrument, instrument consisting of modules, cluster of multiple instruments, etc.

(Definition from EQU.1 in Ch. 13)

Definition: This field identifies the equipment. This is the identifier from an institution's master list of equipment. The <namespace ID> identifies the institution.

The Equipment Instance Identifier shall be unique, meaning that the “Entity Identifier” component shall be unique within the Namespace ID that should accommodate hierarchical representation of equipment (recursive hierarchy like in "Russian dolls", e.g., a sub-module embedded in a module assembled in a system being a member of a cluster).

If this attribute repeats, all instances must represent the same device.

EQU-2: Event Date/Time (DTM) 01322

Definition: This field is the date/time that the event (e.g., state transition, issuing of command, finishing of command execution) occurred.

EQU-3: Equipment State (CWE) 01323

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 in Chapter 2C, Code Tables, for valid values. The Equipment State is required in the ESU message and is optional otherwise.

EQU-4: Local/Remote Control State (CWE) 01324

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 in Chapter 2C, Code Tables, for valid values.

EQU-5: Alert Level (CWE) 01325

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 in Chapter 2C, Code Tables, for valid values.

EQU-6: Expected date/time of the next status change (DTM) 03487

Definition: This field is the predicted date/time of the next equipment status change (e.g. from “maintenance” back to “normal operation”).

ISD - Interaction Status Detail Segment

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 Segment
Seq#	DataElement	Description	Must Implement	Cardinality	Vocabulary	DataType
ISD
1	01326	Reference Interaction Number	SHALL	[1..1]		NM
2	01327	Interaction Type Identifier		[0..1]	0368 Remote Control Command	CWE
3	01328	Interaction Active State	SHALL	[1..1]	0387 Command Response	CWE

ISD-1: Reference Interaction Number (NM) 01326

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.")

ISD-2: Interaction Type Identifier (CWE) 01327

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.

ISD-3: Interaction Active State (CWE) 01328

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.

SAC - Specimen Container Detail Segment

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 Segment
Seq#	DataElement	Description	Must Implement	Flags	Cardinality	C.LEN	Vocabulary	DataType
SAC
1	01329	External Accession Identifier			[0..1]			EI
2	01330	Accession Identifier			[0..1]			EI
3	01331	Container Identifier	MAY True: False:	C	[1..1] [0..1]			EI
4	01332	Primary	MAY True: False:	C	[1..1] [0..1]			EI
5	01333	Equipment Container Identifier			[0..1]			EI
6	00249	Specimen Source	SHALL NOT	W	[0..0]
7	01334	Registration Date/Time			[0..1]			DTM
8	01335	Container Status			[0..1]		0370 Container Status	CWE
9	01336	Carrier Type			[0..1]		0378	CWE
10	01337	Carrier Identifier			[0..1]			EI
11	01338	Position in Carrier			[0..1]			NA
12	01339	Tray Type – SAC			[0..1]		0379	CWE
13	01340	Tray Identifier			[0..1]			EI
14	01341	Position in Tray			[0..1]			NA
15	01342	Location			[0..*]		0774	CWE
16	01343	Container Height		#	[0..1]	10		NM
17	01344	Container Diameter		#	[0..1]	10		NM
18	01345	Barrier Delta		#	[0..1]	10		NM
19	01346	Bottom Delta		#	[0..1]	10		NM
20	01347	Container Height/Diameter/Delta Units			[0..1]		0775	CWE
21	00644	Container Volume			[0..1]			NM
22	01349	Available Specimen Volume		#	[0..1]	10		NM
23	01350	Initial Specimen Volume		#	[0..1]	10		NM
24	01351	Volume Units			[0..1]		0777	CWE
25	01352	Separator Type			[0..1]		0380	CWE
26	01353	Cap Type			[0..1]		0381	CWE
27	00647	Additive			[0..*]		0371 Additive/Preservative	CWE
28	01355	Specimen Component			[0..1]		0372 Specimen Component	CWE
29	01356	Dilution Factor			[0..1]			SN
30	01357	Treatment			[0..1]		0373 Treatment	CWE
31	01358	Temperature			[0..1]			SN
32	01359	Hemolysis Index		#	[0..1]	10		NM
33	01360	Hemolysis Index Units			[0..1]		0779	CWE
34	01361	Lipemia Index		#	[0..1]	10		NM
35	01362	Lipemia Index Units			[0..1]		0780	CWE
36	01363	Icterus Index		#	[0..1]	10		NM
37	01364	Icterus Index Units			[0..1]		0781	CWE
38	01365	Fibrin Index		#	[0..1]	10		NM
39	01366	Fibrin Index Units			[0..1]		0782	CWE
40	01367	System Induced Contaminants			[0..*]		0374 System Induced Contaminants	CWE
41	01368	Drug Interference			[0..*]		0382	CWE
42	01369	Artificial Blood			[0..1]		0375 Artificial Blood	CWE
43	01370	Special Handling Code			[0..*]		0376 Special Handling Code	CWE
44	01371	Other Environmental Factors			[0..*]		0377 Other Environmental Factors	CWE
45	02496	Container Length			[0..1]			CQ
46	02497	Container Width			[0..1]			CQ
47	02498	Container Form			[0..1]		0967	CWE
48	02499	Container Material			[0..1]		0968	CWE
49	02500	Container Common Name			[0..1]		0969	CWE

SAC-1: External Accession Identifier (EI) 01329

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.

SAC-2: Accession Identifier (EI) 01330

(Definition from IPC.1 in Ch. 4)

Definition: A workflow-management IDIS generated number that identifies the Filler Order for an Imaging Service (Imaging Service Request). This identifier corresponds one-to-one to the Order Filler number but is used in internal tracking of the work by the IDIS and in communication between IDIS within the department. It also has specific requirements to assure its compatibility with DICOM. It is a case of the Entity Identifier data type (section 2.A.28). Its first component is a string that identifies the Imaging Service Request. A limit of sixteen (16) characters is required to allow compatibility with DICOM. See DICOM Standard Part 3 for further details on DICOM Attribute (0008,0050) that conveys information identical to the component one of this field.

An IDIS that performs functions of the workflow management for a department may accept a single Placer Order that gives rise to one or more Filler Orders-Imaging Service Requests. For example, an IDIS may receive an order for an X-ray examination of the patient daily at 8 am for the next three days. For the purposes of fulfilling the Placer Order, it will identify each of the daily exams either as a separate Filler Order or parts of a single Filler Order. Correspondingly, it will assign one or more Filler Order numbers associated with the order. For each of the Filler Order numbers, it will assign a unique Accession Number.

Each of the Imaging Service Requests may contain one or more Requested Procedures that it will identify with the Requested Procedure ID. The Requested Procedure is the most granular unit of work that may lead to the creation of the procedure report. Each procedure report contributes to the results for the order. In the example mentioned above, each of the daily examinations will require a separate diagnostic report, hence each of them will be treated as a separate Requested Procedure. Depending on the treatment of the order by the IDIS, it will either link all Requested Procedures to a single Filler Order-Imaging Service Request, or link each Requested Procedure to its own Imaging Service Request. Exact type of requested procedure is conveyed by the coded values in OBR-44 Procedure Code and OBR-45 Procedure Code modifier for each procedure. Note that in case of multiple Requested Procedures corresponding to one order, each procedure may have different code.

To support communication with the instances of equipment in a department (acquisition modalities), IDIS will also generate the Study Instance UID, a globally unique identifier for each Requested Procedure. This identifier will be used by acquisition modalities to identify all generated images and other DICOM objects related to this Requested Procedure. Note that, unlike the Study Instance UID, the Requested Procedure ID must only be unique within the scope of the encompassing Imaging Service Request identified by an Accession Number.

Each of the Requested Procedures may be further broken down by the IDIS into the Scheduled Procedure Steps based on the timing and equipment requirements. Each step is identified with the Scheduled Procedure Step ID. A single Procedure Step may only be performed on a single type and instance of the equipment. Thus, while the Requested Procedure may identify multi-modality examination (such as ones common in Nuclear Medicine), a single Procedure Step shall correspond to the operations performed on a single modality.

The example of the hierarchy of Imaging Service Request, Requested Procedure and Scheduled Procedure Step is depicted in a figure 4-6. Identifiers of the entities are represented by the field names stated in square brackets.

Figure 4-6. Hierarchy of Imaging Service Request, Requested Procedure and Scheduled Procedure Step

The full hierarchy constitutes the context that will be shared between all IDIS within a department in a course of order fulfillment.

Each OMI message shall convey information about Requested Procedure(s) pertaining to one order. A pair of Segments ORC/OBR shall correspond to each requested procedure. If the Requested Procedure is comprised of multiple Procedure Steps, multiple IPC segments shall be included for each ORC/OBR pair in the message. Value of the IPC-1 field shall be identical in all IPC segments.

Considering the preceding example of X-ray examinations on subsequent days with two different steps identified for the last Requested Procedure and examinations to be performed at the site, "RADIOLOGY", the communication of the information using OMI message may look like the following:

MSH|...<cr>

PID|...<cr>

ORC|NW|...<cr>

OBR|1|X1234^HIS|R578^RIS|56782^X-Ray Chest|...|XPA^X-Ray Chest PA|...<cr>

IPC|A345^RIS|P1234^RIS|1.2.840.1234567890.3456786.1^RIS|SPS1^RIS|CR|SXPA^Chest PA||RADIOLOGY|<cr>

ORC|NW|...<cr>

OBR|2|X1234^HIS|R578^RIS|56782^X-Ray Chest|...|XPA^X-Ray Chest PA|...<cr>

IPC|A345^RIS|P1235^RIS|1.2.840.1234567890.3456786.2^RIS|SPS1^RIS|CR|SXPA^Chest PA||RADIOLOGY|<cr>

ORC|NW|...<cr>

OBR|3|X1234^HIS|R578^RIS|56782^X-Ray Chest|...|XPALAT^X-Ray Chest PA and Lateral|...<cr>

IPC|A345^RIS|P1236^RIS|1.2.840.1234567890.3456786.3^RIS|SPS1^RIS|CR|SXPA^Chest PA||RADIOLOGY|<cr>

IPC|A345^RIS|P1236^RIS|1.2.840.1234567890.3456786.3^RIS|SPS2^RIS|CR|SXLAT^Chest Lat||RADIOLOGY|<cr>

(Definition from SAC.2 in Ch. 13)

Definition: This field identifies the laboratory accession (see section 13.2.3, "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.

SAC-3: Container Identifier (EI) 01331

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).

SAC-4: Primary (EI) 01332

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.

SAC-5: Equipment Container Identifier (EI) 01333

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.).

SAC-6: Specimen Source

(Definition from OBR.15 in Ch. 4)

Attention: The OBR-15 element was retained for backward compatibility only as of v 2.5 and the detail was withdrawn and removed from the standard as of v 2.7. See SPM in Chapter 7.

(Definition from OBR.15 in Ch. 7)

Attention: The OBR-15 element was retained for backward compatibility only as of v 2.5 and the detail was withdrawn and removed from the standard as of v 2.7. See SPM in Chapter 7.

(Definition from SAC.6 in Ch. 13)

Attention: This field was deprecated and retained for backward compatibilityonly as of v2.5 and withdrawn and removed as of v2.7.

(Definition from TCC.3 in Ch. 13)

Attention: As of version 2.5 this field was deprecated and retained for backward compatibility only and withdrawn as of v2.7.

SAC-7: Registration Date/Time (DTM) 01334

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.

SAC-8: Container Status (CWE) 01335

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 in Chapter 2C, Code Tables, for valid values. The equipment specific container status should be sent as <alternate identifier> as needed.

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.

SAC-9: Carrier Type (CWE) 01336

Definition: This field identifies the type of the carrier (see section 13.2.3, "Glossary"). Refer to User-defined Table 0378 – Carrier Type in Chapter 2C, Code Tables, 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.

SAC-10: Carrier Identifier (EI) 01337

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.

SAC-11: Position in Carrier (NA) 01338

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).

SAC-12: Tray Type – SAC (CWE) 01339

Definition: This field identifies the type of the tray (see section 13.2.3, "Glossary"). Refer to User-defined Table 0379 – Tray Type in chapter 2C 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.

SAC-13: Tray Identifier (EI) 01340

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.

SAC-14: Position in Tray (NA) 01341

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).

SAC-15: Location (CWE) 01342

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. Refer to Table 0774 - Location in Chapter 2C for valid values.

SAC-16: Container Height (NM) 01343

Definition: This field identifies the height of the container in units specified below.

Note: If the container type is categorized (FBT (false-bottom-tube), Cup, etc.), the specific codes should be transferred in the SPM-27 field “Container Type”. If the container is characterized by dimensions and other characteristics this information should be transferred as specific values in the SAC segment (fields: SAC-16 through SAC-21, or SAC-45 to SAC-48).

SAC-17: Container Diameter (NM) 01344

Definition: This field identifies the outside diameter of the container in units specified below. For non-cylindrical containers SAC-45 Container Length and SAC-46 Container Width may be used instead of SAC-17 Container Diameter.

SAC-18: Barrier Delta (NM) 01345

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.

SAC-19: Bottom Delta (NM) 01346

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 13.2.3, "Glossary," or in NCCLS standard AUTO5 Laboratory Automation: Electromechanical Interfaces.

SAC-20: Container Height/Diameter/Delta Units (CWE) 01347

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. Refer to Table 0775 - Container Height/Diameter/Delta Units in Chapter 2C for valid values.

SAC-21: Container Volume (NM) 00644

(Definition from OM4.4 in Ch. 8)

Definition: This field indicates the capacity of the container. This field repeats to accommodate all the possible specimen that will be allowed. If a container is preferred, only that container should be messaged here with the alternate containers messaged in a repeat OM4 segment

(Definition from SAC.21 in Ch. 13)

Definition: This field indicates the capacity of the container in the units specified below.

SAC-22: Available Specimen Volume (NM) 01349

Definition: This field identifies the current specimen volume available for use in this container in the units specified below.

SAC-23: Initial Specimen Volume (NM) 01350

Definition: This field identifies the volume of the specimen initially filled in this container in the units specified below.

SAC-24: Volume Units (CWE) 01351

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. Refer to Table 0777 - Volume Units in Chapter 2C for valid values.

SAC-25: Separator Type (CWE) 01352

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 – SeparatorType in Chapter 2C, Code Tables, for suggested values. It is recommended that the first table entry be "NO" meaning "No Separator."

SAC-26: Cap Type (CWE) 01353

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 in Chapter 2C, Code Tables, for suggested values.

SAC-27: Additive (CWE) 00647

(Definition from OM4.7 in Ch. 8)

Definition: This field contains the codes that should be those provided by NCCLS³. Refer to HL7 Table 0371 - Additive/Preservative in Chapter 2C, Code Tables, for valid values. The table's values are taken from NCCLS AUTO4. The value set can be extended with user specific values.

This table was not specified in previous versions and thus sites may choose to use other site-specific tables.

(Definition from SAC.27 in Ch. 13)

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/Preservative for valid values. 'The value set can be extended with user specific values.

When the SPM (Specimen) segment is sent together with the SAC segment the additive attribute value from the SPM segment can be included in this field of the SAC.

SAC-28: Specimen Component (CWE) 01355

Definition: This field identifies the specimen component, e.g., supernatant, sediment, etc. Refer to User-defined Table 0372 – Specimen Component in Chapter 2C, Code Tables, for valid values. This table's values are taken from NCCLS AUTO4. The value set can be extended with user specific values.

SAC-29: Dilution Factor (SN) 01356

(Definition from SAC.29 in Ch. 13)

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

(Definition from SCD.35 in Ch. 17)

Definition: The dilution ratio of peracetic acid to water.

SAC-30: Treatment (CWE) 01357

Definition: This field identifies the specimen treatment performed during lab processing. Refer to User-defined Table 0373 – Treatment in chapter 2C for valid values. This table's values are taken from NCCLS AUTO4. The value set can be extended with user specific values.

SAC-31: Temperature (SN) 01358

Definition: This field identifies the specimen temperature in degrees Celsius [°C] at the time of the transaction specified in the EQU segment.

SAC-32: Hemolysis Index (NM) 01359

Definition: This field is the index identifier that is being used to describe the Hemolysis Index of the specimen.

SAC-33: Hemolysis Index Units (CWE) 01360

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.) Refer to Table 0779 - Hemolysis Index Units in Chapter 2C for valid values.

If this field is null, the recommended value is assumed.

SAC-34: Lipemia Index (NM) 01361

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).

SAC-35: Lipemia Index Units (CWE) 01362

Definition: This field is the unit's identifier that is being used to describe the Lipemia Index of the specimen. Refer to Table 0780 - Lipemia Index Units in Chapter 2C for valid values.

If this field is null, the recommended value is assumed.

SAC-36: Icterus Index (NM) 01363

Definition: This field is the index identifier that is being used to describe the Icterus Index of the specimen.

SAC-37: Icterus Index Units (CWE) 01364

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. Refer to Table 0781 - Icterus Index Units in Chapter 2C for valid values.

If this field is null, the recommended value is assumed.

SAC-38: Fibrin Index (NM) 01365

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.

SAC-39: Fibrin Index Units (CWE) 01366

Definition: This field is the unit's identifier that is being used to describe the Fibrin Index of the specimen. Refer to Table 0782 - Fibrin Index Units in Chapter 2C for valid values.

SAC-40: System Induced Contaminants (CWE) 01367

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 in Chapter 2C, Code Tables, for valid values. This table's values are taken from NCCLS AUTO4. The value set can be extended with user specific values.

SAC-41: Drug Interference (CWE) 01368

Definition: This field describes the drug interference identifier that is associated with the specimen. Refer to User-defined Table 0382 – Drug Interference in Chapter 2C, Code Tables, for suggested values.

SAC-42: Artificial Blood (CWE) 01369

Definition: This field describes the artificial blood identifier that is associated with the specimen. Refer to User-defined Table 0375 – Artificial Blood in Chapter 2C, Code Tables, for valid values. This table's values are taken from NCCLS AUTO4. The value set can be extended with user specific values.

SAC-43: Special Handling Code (CWE) 01370

(Definition from SAC.43 in Ch. 13)

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 in Chapter 2C, Code Tables, for valid values. 'The value set can be extended with user specific values.

(Definition from ITM.29 in Ch. 17)

Definition: This field contains a special handling code to describe special handling considerations for this item. Refer to User-defined Table 0376 – Special Handling Code in Chapter 2C, Code Tables, for suggested values. The value set can be extended with user specific values.

SAC-44: Other Environmental Factors (CWE) 01371

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 in Chapter 2C, Code Tables, for valid values. This table's values are taken from NCCLS AUTO4. The value set can be extended with user specific values.

SAC-45: Container Length (CQ) 02496

Definition: This field describes the longest horizontal measurement of the container, for non-cylindrical containers. For cylindrical containers SAC-17 Container Diameter may be used instead of SAC-45 Container Length and SAC-46 Container Width.

SAC-46: Container Width (CQ) 02497

Definition: This field desrcibes the distance from side to side, measuring across the object at right angles to the length, for non-cylindrical containers. For cylindrical containers SAC-17 Container Diameter may be used instead of SAC-45 Container Length and SAC-46 Container Width.

SAC-47: Container Form (CWE) 02498

Definition: This field is the coded representation of the format or type of the container (e.g. tube/vial, jar, bag, block, slide, etc.). Refer to User-Defined Table 0967 for suggested values.

SAC-48: Container Material (CWE) 02499

Definition: This field is the coded representation of the material composition (i.e. physical substance) of the container and may be considered to modify for further describe SAC-47 (Container Form). It may also indicate a virtual container in the cases of digitized specimens (e.g. scans obtained by whole slide imaging techniques, etc.). Refer to User-Defined Table 0968 for suggested values.

SAC-49: Container Common Name (CWE) 02500

Definition: This field is a coded representation of the way the container type is commonly referenced in an organization, in order to aid in ensuring the appropriate container is used. Examples include “Red Top” (for tubes/vials), “Wet Mount” (for slides), etc. Frequently these values will be locally defined and meaning may vary by supplier. Refer to User-Defined Table 0969 for suggested values.

In many cases this is a shorthand way to express a combination of other container attributes, for example the combination of SAC-47 (Container Form) of “Tube/vial” + SAC-48 (Container Material) of “Glass” + SAC-27 (Additive) of “EDTA” may be referenced commonly in an organization as a “Lavender Top”.

INV - Inventory Detail Segment

The inventory detail segment is the data necessary to track the inventory of substances (e.g. reagent, tips, waste) and equipment state indicators (a special type of non-material inventory items) on equipment.

Figure 13-6. Information on the Types of Measures on a Container

HL7 Attribute Table - INV - Inventory Detail Segment
Seq#	DataElement	Description	Must Implement	Flags	Cardinality	C.LEN	Vocabulary	DataType
INV
1	01372	Substance Identifier	MAY True: False:	C	[1..1] [0..1]		0451	CWE
2	01373	Substance Status	MAY True: False:	C	[1..1] [0..1]		0383 Substance Status	CWE
3	01374	Substance Type			[0..1]		0384 Substance Type	CWE
4	01532	Inventory Container Identifier			[0..1]		0599	CWE
5	01376	Container Carrier Identifier			[0..1]		0600	CWE
6	01377	Position on Carrier			[0..1]		0601	CWE
7	01378	Initial Quantity		#	[0..1]	10		NM
8	01379	Current Quantity		#	[0..1]	10		NM
9	01380	Available Quantity		#	[0..1]	10		NM
10	01381	Consumption Quantity		#	[0..1]	10		NM
11	01382	Quantity Units			[0..1]		0602	CWE
12	01383	Expiration Date/Time			[0..1]			DTM
13	01384	First Used Date/Time			[0..1]			DTM
14	01385	On Board Stability Duration	SHALL NOT	W	[0..0]
15	01386	Test/Fluid Identifier(s)			[0..*]		0603	CWE
16	01387	Manufacturer Lot Number		=	[0..1]	200		ST
17	00286	Manufacturer Identifier			[0..1]		0385	CWE
18	01389	Supplier Identifier			[0..1]		0386	CWE
19	01626	On Board Stability Time			[0..1]			CQ
20	01896	Target Value			[0..1]			CQ
21	03488	Equipment State Indicator Type Code	MAY True: False:	C	[1..1] [0..1]		0942	CWE
22	03489	Equipment State Indicator Value	MAY True: False:	C	[1..1] [0..1]			CQ

INV-1: Substance Identifier (CWE) 01372

Definition: Unique identifier for the substance that is in inventory. This is a manufacturer-specific identifier. Refer to User-defined Table 0451 – Substance Identifier in Chapter 2C, Code Tables, for suggested values.

This field is conditional. It is optional in queries INR^U14 and required in all other messages. Absence of this field in a query means that the result shall be not filtered on inventory item ID.

INV-2: Substance Status (CWE) 01373

Definition: The status of the inventoried item. The status indicates the current status of the substance. Refer to HL7 Table 0383 – Substance Status in Chapter 2C, Code Tables, for suggested values.

This field is conditional. It is optional in queries INR^U14 and required in all other messages. Absence of this field in a query means that the result shall be not filtered on inventory item status.

INV-3: Substance Type (CWE) 01374

Definition: The type of substance. Refer to HL7 Table 0384 – Substance Type in chapter 2C for suggested values.

INV-4: Inventory Container Identifier (CWE) 01532

Definition: Identifies the inventory container, e.g., unique identifier of a specific package instance of a specific substance. This is a manufacturer-specific identifier.Refer to Table 0599 - Inventory Container Identifier in Chapter 2C for valid values.

INV-5: Container Carrier Identifier (CWE) 01376

Definition: This is the carrier used to transport the substance containers (e.g., a removable rotor with reagent bottles). Refer to Table 0600 - Container Carrier Identifier in Chapter 2C for valid values.

INV-6: Position on Carrier (CWE) 01377

Definition: Identifies the position (e.g., index) on the carrier. Refer to Table 0601 - Position on Carrier in Chapter 2C for valid values.

INV-7: Initial Quantity (NM) 01378

Definition: This field identifies the initial quantity of the substance in inventory.

INV-8: Current Quantity (NM) 01379

Definition: This field is the current quantity, i.e., initial quantity minus what has been actually used.

INV-9: Available Quantity (NM) 01380

Definition: This field is the available quantity of substance. This is the current quantity minus any planned consumption (e.g., tests that are planned).

INV-10: Consumption Quantity (NM) 01381

Definition: This field is the consumption that is used each time the equipment uses this substance.

INV-11: Quantity Units (CWE) 01382

Definition: This field is the units of measure of the available quantity. If the units are ISO+ units, they should be recorded as single case abbreviations. If the units are ANS+ or L (local), the units and the source code table must be recorded, except that in this case, component delimiters should be replaced by sub-component delimiters. For example, "l" indicates liters, whereas pt&&ANS+ indicates pints (ANSI units). The default unit is milliliters (ml), which should be assumed if no units are reported. Refer to Table 0602 - Quantity Units in Chapter 2C for valid values.

INV-12: Expiration Date/Time (DTM) 01383

Definition: This field is the expiration date/time of the substance.

INV-13: First Used Date/Time (DTM) 01384

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.

INV-14: On Board Stability Duration

Attention: As of v2.5 this field was retained for backward compatibility only and withdrawn and removed as of v2.7. The TQ data type was deprecated; see Chapter 2A, section 2.A.81.

INV-15: Test/Fluid Identifier(s) (CWE) 01386

Definition: This field is the list of tests and body fluids that relate or correspond to this inventory item . This is a repeating field. An empty field means that this inventory item is not test specific, i.e., it applies to all tests. Refer to Table 0603 - Test/Fluid Identifier(s) in Chapter 2C for valid values.

INV-16: Manufacturer Lot Number (ST) 01387

Definition: This field specifies the lot number assigned by the manufacturer during production of the substance.

INV-17: Manufacturer Identifier (CWE) 00286

(Definition from RQ1.2 in Ch. 4)

Definition: This field contains the unique code that identifies the manufacturer on the application receiving the requisition. This field is conditional because either RQ1-2-manufacturer ID and RQ1-3-manufacturer's catalog or RQ1-4-vendor ID and RQ1-5-vendor catalog must be valued.

Refer to User-defined Table 0385 – Manufacturer identifier in Chapter 2C, Code Tables, for suggested values, or relevant external code sets may be used (e.g., HIBCC Manufacturers Labeler ID Code (LIC), UPC, NDC).

(Definition from INV.17 in Ch. 13)

Definition: This field identifies the manufacturer of this substance. Refer to User-defined Table 0385 – Manufacturer Identifier in Chapter 2C, Code Tables, for suggested values. Relevant external code systems may be used, e.g., HIBCC Manufacturers Labeler ID Code (LIC), UPC, NDC, etc.

INV-18: Supplier Identifier (CWE) 01389

Definition: This field identifies the supplier of this substance. Refer to User-defined Table 0386 – Supplier Identifie r in Chapter 2C, Code Tables, for suggested values.

INV-19: On Board Stability Time (CQ) 01626

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".

INV-20: Target Value (CQ) 01896

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.

INV-21: Equipment State Indicator Type Code (CWE) 03488

Definition: The type code of an equipment state indicator. Refer to HL7 Table 0942 – Equipment State Indicator Type Code in Chapter 2C, Code Tables, for suggested values.

Due to its dynamic nature, an equipment state indicator is considered to be a [non-material] inventory item. Its value usually can be derived from the material inventory — in that way, a state indicator differs from static configuration parameters and master data stored on the equipment.

This field is conditional. It is optional when INV-3 “Substance Type” is not populated and prohibited otherwise.

INV-22: Equipment State Indicator Value (CQ) 03489

Definition: The numeric value of the equipment state indicator specified in INV-21. The 1st component defines the number and the 2nd component the units of measurement.

This field is conditional. It is optional when INV-21 “Equipment State Indicator Type Code” is populated and prohibited otherwise.

ECD - Equipment Command Segment

The equipment command segment contains the information required to notify the receiving component what is to happen.

HL7 Attribute Table - ECD - Equipment Command Segment
Seq#	DataElement	Description	Must Implement	Flags	Cardinality	Length	C.LEN	Vocabulary	DataType
ECD
1	01390	Reference Command Number	SHALL	=	[1..1]		10		NM
2	01391	Remote Control Command	SHALL		[1..1]			0368 Remote Control Command	CWE
3	01392	Response Required			[0..1]	[1..1]		0136 Yes/no Indicator	ID
4	01393	Requested Completion Time	SHALL NOT	W	[0..0]
5	01394	Parameters			[0..*]				TX

ECD-1: Reference Command Number (NM) 01390

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.

ECD-2: Remote Control Command (CWE) 01391

Definition: This field identifies the command that the component is to initiate. Refer to User-defined Table 0368 – Remote Control Comman d in Chapter 2C, Code Tables, for valid values. Refer to LECIS standard for details.

ECD-3: Response Required (ID) 01392

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.

ECD-4: Requested Completion Time

Attention: As of version 2.5 this fieldwas retained for backward compatibility only and withdrawn as of v2.7. The TQ data type was deprecated; see Chapter 2A, section 2.A.81. 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.

ECD-5: Parameters (TX) 01394

Definition: This field identifies the parameters of the command (if they are not included in a 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.

ECR - Equipment Command Response Segment

The equipment command response segment contains the receiving component's response to the previously received command.

HL7 Attribute Table - ECR - Equipment Command Response Segment
Seq#	DataElement	Description	Must Implement	Cardinality	Vocabulary	DataType
ECR
1	01395	Command Response	SHALL	[1..1]	0387 Command Response	CWE
2	01396	Date/Time Completed	SHALL	[1..1]		DTM
3	01397	Command Response Parameters		[0..*]		TX

ECR-1: Command Response (CWE) 01395

Definition: This field identifies the response of the previously issued command. Refer to User-defined Table 0387 – Command Response in Chapter 2C, Code Tables, for valid values.

ECR-2: Date/Time Completed (DTM) 01396

Definition: This field contains the date and time that the receiving component completed the requested command.

ECR-3: Command Response Parameters (TX) 01397

Definition: This field identifies any associated parameters that relate to the returned response command message.

NDS - Notification Detail Segment

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 Segment
Seq#	DataElement	Description	Must Implement	Flags	Cardinality	C.LEN	Vocabulary	DataType
NDS
1	01398	Notification Reference Number	SHALL	=	[1..1]	10		NM
2	01399	Notification Date/Time	SHALL		[1..1]			DTM
3	01400	Notification Alert Severity	SHALL		[1..1]		0367 Alert Level	CWE
4	01401	Notification Code	SHALL		[1..1]		0610	CWE

NDS-1: Notification Reference Number (NM) 01398

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.

NDS-2: Notification Date/Time (DTM) 01399

Definition: This field is the date/time of the notifications.

NDS-3: Notification Alert Severity (CWE) 01400

Definition: The severity of the specific notification. Refer to HL7 Table 0367 – Alert Level in Chapter 2C, Code Tables, for valid entries.

NDS-4: Notification Code (CWE) 01401

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. Refer to Table 0610 - Notification Code in Chapter 2C for valid values.

CNS - Clear Notification Segment

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 Segment
Seq#	DataElement	Description	Flags	Cardinality	C.LEN	Vocabulary	DataType
CNS
1	01402	Starting Notification Reference Number	=	[0..1]	10		NM
2	01403	Ending Notification Reference Number	=	[0..1]	10		NM
3	01404	Starting Notification Date/Time		[0..1]			DTM
4	01405	Ending Notification Date/Time		[0..1]			DTM
5	01406	Starting Notification Code		[0..1]		0585	CWE
6	01407	Ending Notification Code		[0..1]		0586	CWE

CNS-1: Starting Notification Reference Number (NM) 01402

Definition: This field contains the starting notification reference number that is to be cleared.

CNS-2: Ending Notification Reference Number (NM) 01403

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.

CNS-3: Starting Notification Date/Time (DTM) 01404

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.

CNS-4: Ending Notification Date/Time (DTM) 01405

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.

CNS-5: Starting Notification Code (CWE) 01406

Definition: This field contains the starting notification code that is to be cleared (see 13.4.7.4, "NDS-4 Notification Code (CWE) 01401").Refer to Table 0585 - Starting Notification Code in Chapter 2C for valid values.

CNS-6: Ending Notification Code (CWE) 01407

Definition: This field contains the ending notification code that is to be cleared (see 13.4.7.4, "NDS-4 Notification Code (CWE) 01401"). If empty, then only notification with Starting Notification Code will be cleared. Refer to Table 0586 - Ending Notification Code in Chapter 2C for valid values.

TCC - Test Code Configuration Segment

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 Segment
Seq#	DataElement	Description	Must Implement	Flags	Cardinality	Length	C.LEN	Vocabulary	DataType
TCC
1	00238	Universal Service Identifier	SHALL		[1..1]			0612	CWE
2	01408	Equipment Test Application Identifier	SHALL		[1..1]				EI
3	00249	Specimen Source	SHALL NOT	W	[0..0]
4	01410	Auto-Dilution Factor Default			[0..1]				SN
5	01411	Rerun Dilution Factor Default			[0..1]				SN
6	01412	Pre-Dilution Factor Default			[0..1]				SN
7	01413	Endogenous Content of Pre-Dilution Diluent			[0..1]				SN
8	01414	Inventory Limits Warning Level		#	[0..1]		10		NM
9	01415	Automatic Rerun Allowed			[0..1]	[1..1]		0136 Yes/no Indicator	ID
10	01416	Automatic Repeat Allowed			[0..1]	[1..1]		0136 Yes/no Indicator	ID
11	01417	Automatic Reflex Allowed			[0..1]	[1..1]		0136 Yes/no Indicator	ID
12	01418	Equipment Dynamic Range			[0..1]				SN
13	00574	Units			[0..1]			0623	CWE
14	01419	Processing Type			[0..1]			0388 Processing Type	CWE
15	03313	Test Criticality			[0..1]	[705..*]			CWE

TCC-1: Universal Service Identifier (CWE) 00238

(Definition from OBR.4 in Ch. 4)

Definition: This field contains the identifier code for the requested observation/test/battery. The identifier can come from either a local coding system or industry standards. Examples may be LOINC (emerging as the global standard for observation identifiers), JLAC10, or SNOMED CT. Refer to Table 0612 - Universal Service Identifier in Chapter 2C for valid values.

(Definition from OBR.4 in Ch. 7)

(Definition from OM7.2 in Ch. 8)

Definition: This field contains the producer's usual or preferred identification of the test or service.

(Definition from AIS.3 in Ch. 10)

Definition: This field contains an identifier code for a service to be scheduled. This field may contain a universal service identifier describing the observation/test/battery/procedure or other activity that is to be performed during the requested appointment, similar to the universal service identifier defined for the OBR segment in the Order Entry chapter (Chapter 4). This code can be based on local and/or universal codes. The use of universal codes is recommended.

(Definition from TCC.1 in Ch. 13)

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. Refer to Table 0787 - Universal Service Identifier in Chapter 2C for valid values.

(Definition from TCD.1 in Ch. 13)

Definition: This field identifies the test code that information is being transmitted about. Refer to Table 0789 - Universal Service Identifier in Chapter 2C for valid values.

TCC-2: Equipment Test Application Identifier (EI) 01408

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.

TCC-3: Specimen Source

(Definition from OBR.15 in Ch. 4)

Attention: The OBR-15 element was retained for backward compatibility only as of v 2.5 and the detail was withdrawn and removed from the standard as of v 2.7. See SPM in Chapter 7.

(Definition from OBR.15 in Ch. 7)

Attention: The OBR-15 element was retained for backward compatibility only as of v 2.5 and the detail was withdrawn and removed from the standard as of v 2.7. See SPM in Chapter 7.

(Definition from SAC.6 in Ch. 13)

Attention: This field was deprecated and retained for backward compatibilityonly as of v2.5 and withdrawn and removed as of v2.7.

(Definition from TCC.3 in Ch. 13)

Attention: As of version 2.5 this field was deprecated and retained for backward compatibility only and withdrawn as of v2.7.

TCC-4: Auto-Dilution Factor Default (SN) 01410

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 13.4.3.29, "SAC-29 Dilution Factor (SN) 01356" in, "Specimen Container Detail Segment.")

TCC-5: Rerun Dilution Factor Default (SN) 01411

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.

TCC-6: Pre-Dilution Factor Default (SN) 01412

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.

TCC-7: Endogenous Content of Pre-Dilution Diluent (SN) 01413

(Definition from TCC.7 in Ch. 13)

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 from TCD.5 in Ch. 13)

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.

TCC-8: Inventory Limits Warning Level (NM) 01414

Definition: This field is the value that is to be used as the threshold for initiating inventory warning-level messages.

TCC-9: Automatic Rerun Allowed (ID) 01415

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.

TCC-10: Automatic Repeat Allowed (ID) 01416

(Definition from TCC.10 in Ch. 13)

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 from TCD.6 in Ch. 13)

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.

TCC-11: Automatic Reflex Allowed (ID) 01417

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.

TCC-12: Equipment Dynamic Range (SN) 01418

Definition: This is the range over which the equipment can produce results.

TCC-13: Units (CWE) 00574

(Definition from OBX.6 in Ch. 7)

Definition: This field contains the units of measurement for the value in OBX-5, Observation Value. Coding system from which the values may be drawn include, UCUM, ISO+, ANSI X3.50 - 1986 and site specific (local) coding systems. Considering Version 3 direction and consistent use of V2 and V3 messages/documents within an organization, use of UCUM is strongly recommended. Refer to Table 0623 - Units in Chapter 2C for valid values.

Note that OBX-6 applies to both OBX-5.2 and OBX-5.4 if OBX-2 = “SN”.

(Definition from TCC.13 in Ch. 13)

Definition: This field is the units that have a data type of CWE. 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 Chapter 7, section 7.4.2.6). We designate this coding system as ISO+. Both the ISO unit's abbreviations and the extensions are defined in Chapter 7, 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".

Refer to Table 0788 - Units in Chapter 2C for valid values.

TCC-14: Processing Type (CWE) 01419

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 in Chapter 2C, Code Tables, for valid values.

TCC-15: Test Criticality (CWE) 03313

Definition: This field identifies the test the Test Criticality. The values in this field are used for decisions, which tests should be performed, in case of, e.g., insufficient specimen volume.
The data type is CWE because its meaning is a coded value. However, in order to make the processing decisions easy the content can be a sequential number of the test sorted according to the criticality assigned by the lab. The lower numbers are more critical than higher numbers.

TCD - Test Code Detail Segment

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 Segment
Seq#	DataElement	Description	Must Implement	Cardinality	Length	Vocabulary	DataType
TCD
1	00238	Universal Service Identifier	SHALL	[1..1]		0612	CWE
2	01420	Auto-Dilution Factor		[0..1]			SN
3	01421	Rerun Dilution Factor		[0..1]			SN
4	01422	Pre-Dilution Factor		[0..1]			SN
5	01413	Endogenous Content of Pre-Dilution Diluent		[0..1]			SN
6	01416	Automatic Repeat Allowed		[0..1]	[1..1]	0136 Yes/no Indicator	ID
7	01424	Reflex Allowed		[0..1]	[1..1]	0136 Yes/no Indicator	ID
8	01425	Analyte Repeat Status		[0..1]		0389 Analyte Repeat Status	CWE
9	03490	Specimen Consumption Quantity		[0..1]			CQ
10	03493	Pool Size		[0..1]			NM
11	03494	Auto-Dilution Type		[0..1]		0945	CWE

TCD-1: Universal Service Identifier (CWE) 00238

(Definition from OBR.4 in Ch. 4)

(Definition from OBR.4 in Ch. 7)

(Definition from OM7.2 in Ch. 8)

Definition: This field contains the producer's usual or preferred identification of the test or service.

(Definition from AIS.3 in Ch. 10)

(Definition from TCC.1 in Ch. 13)

(Definition from TCD.1 in Ch. 13)

Definition: This field identifies the test code that information is being transmitted about. Refer to Table 0789 - Universal Service Identifier in Chapter 2C for valid values.

TCD-2: Auto-Dilution Factor (SN) 01420

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 13.4.3.29, "SAC-29 Dilution Factor (SN) 01356," in the "Specimen Container Detail Segment.")

TCD-3: Rerun Dilution Factor (SN) 01421

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.

TCD-4: Pre-Dilution Factor (SN) 01422

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.

TCD-5: Endogenous Content of Pre-Dilution Diluent (SN) 01413

(Definition from TCC.7 in Ch. 13)

(Definition from TCD.5 in Ch. 13)

TCD-6: Automatic Repeat Allowed (ID) 01416

(Definition from TCC.10 in Ch. 13)

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 from TCD.6 in Ch. 13)

TCD-7: Reflex Allowed (ID) 01424

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.

TCD-8: Analyte Repeat Status (CWE) 01425

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 in Chapter 2C, Code Tables, 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).

TCD-9: Specimen Consumption Quantity (CQ) 03490

Definition: The specimen consumption quantity determines how much of the specimen shall be consumed in each run of the test. For some types of equipment, observation accuracy depends on this parameter.

TCD-10: Pool Size (NM) 03493

Definition: In order submission messages, this field defines the maximal size of the pool where the given specimen may be combined into. In result submission messages, this field defines the actual size of such pool.

TCD-11: Auto-Dilution Type (CWE) 03494

Definition: This field contains a vendor-defined code of the auto-dilution factor pre-configured on the instrument, which can be used instead of TCD-2 “Auto-Dilution Factor”. Refer to User-defined Table 0945– Auto Dilution Type in Chapter 2C, Code Tables, for suggested values.

If both TCD-2 “Auto-Dilution Factor” and TCD-11 “Auto-Dilution Type” are populated, they shall not contradict each other.

SID - Substance Identifier Segment

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 Segment
Seq#	DataElement	Description	Must Implement	Flags	Cardinality	C.LEN	Vocabulary	DataType
SID
1	01426	Application/Method Identifier	MAY True: False:	C	[1..1] [0..1]		0783	CWE
2	01129	Substance Lot Number	MAY True: False:	C=	[1..1] [0..1]	20		ST
3	01428	Substance Container Identifier	MAY True: False:	C=	[1..1] [0..1]	200		ST
4	01429	Substance Manufacturer Identifier	MAY True: False:	C	[1..1] [0..1]		0385	CWE

SID-1: Application/Method Identifier (CWE) 01426

Definition: This field identifies the application/method used for the analysis. Refer to Table 0783 - Application/Method Identifier in Chapter 2C for valid values.

Example: GLUCOSE is an orderable test. GLUCOSE can be analyzed using various applications/methods, which have manufacturer specific identifiers.

SID-2: Substance Lot Number (ST) 01129

(Definition from RXD.18 in Ch. 4A)

Definition: This field contains the lot number of the medical substance administered.

Note: The lot number is the number printed on the label attached to the container holding the substance and on the packaging which houses the container. If the substance is a vaccine, for example, and a diluent is required, a lot number may appear on the vial containing the diluent; however, any such identifier associated with a diluent is not the identifier of interest. The substance lot number should be reported, not that of the diluent.

(Definition from RXG.19 in Ch. 4A)

Definition: This field contains the lot number of the medical substance administered.

(Definition from RXA.15 in Ch. 4A)

Definition: This field contains the lot number of the medical substance administered.

(Definition from SID.2 in Ch. 13)

Definition: This field specifies the lot number assigned by the manufacturer during production of the substance.

SID-3: Substance Container Identifier (ST) 01428

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.

SID-4: Substance Manufacturer Identifier (CWE) 01429

Definition: This field identifies the manufacturer of this substance. Refer to User-defined Table 0385 - Manufacturer Identifier in Chapter 2C, Code Tables, for suggested values.

EQP - Equipment Log/Service Segment

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 Segment
Seq#	DataElement	Description	Must Implement	Flags	Cardinality	C.LEN	Vocabulary	DataType
EQP
1	01430	Event type	SHALL		[1..1]		0450 Event Type	CWE
2	01431	File Name		=	[0..1]	20		ST
3	01202	Start Date/Time	SHALL		[1..1]			DTM
4	01432	End Date/Time			[0..1]			DTM
5	01433	Transaction Data	SHALL		[1..1]			FT

EQP-1: Event type (CWE) 01430

Definition: This field identifies the type of event of the message. Refer to HL7 Table 0450 – Event Type in Chapter 2C, Code Tables, for valid values.

EQP-2: File Name (ST) 01431

Definition: This field is the physical file name that is being used to store information about the transmitted log and/or service event.

EQP-3: Start Date/Time (DTM) 01202

(Definition from AIS.4 in Ch. 10)

Definition: This field contains the date and time this service needs for the appointment. This field allows the application to identify that the service is required for the appointment at a different time than the appointment's start date/time.

This field is conditionally required. If a value for AIS-5-Start Date/Time Offset is not provided, then a value is required for this field. To specify that there is no difference between the appointment's start date/time and the resource's start date/time either replicate the appointment's start date/time into this field, or specify an offset of zero (0) in AIS-5-Start Date/Time Offset and any valid time unit code in AIS-6-Start Date/Time Offset Units.

(Definition from AIG.8 in Ch. 10)

This field is conditionally required. If a value for AIG-9-Start Date/Time Offset is not provided, then a value is required for this field. To specify that there is no difference between the appointment's start date/time and the resource's start date/time either replicate the appointment's start date/time into this field, or specify an offset of zero (0) in AIG-9-Start Date/Time Offset and any valid time unit code in AIG-10-Start Date/Time Offset Units.

(Definition from AIL.6 in Ch. 10)

This field is conditionally required. If a value for AIL-7 Start Date/Time Offset is not provided, then a value is required for this field. To specify that there is no difference between the appointment's start date/time and the resource's start date/time either replicate the appointment's start date/time into this field, or specify an offset of zero (0) in AIL-7 Start Date/Time Offset and any valid time unit code in AIL-8-Start Date/Time Offset Units.

(Definition from AIP.6 in Ch. 10)

This field is conditionally required. If a value for AIP-7 Start Date/Time Offset is not provided, then a value is required for this field. To specify that there is no difference between the appointment's start date/time and the resource's start date/time either replicate the appointment's start date/time into this field, or specify an offset of zero (0) in AIP-7 Start Date/Time Offset and any valid time unit code in AIP-8 Start Date/Time Offset Units.

(Definition from EQP.3 in Ch. 13)

Definition: This field is the date/time that the event started.

EQP-4: End Date/Time (DTM) 01432

Definition: This field is the date/time that the event was completed.

EQP-5: Transaction Data (FT) 01433

Definition: This field is the data that the log and/or service event was about and is to be logged.

DST - Transport Destination Segment

The Transport Destination segment contains information relevant for transport of the specimen container to specific destination on the specific equipment. This segment should be used in conjunction with the TT, AF, and AT commands of the ECD segment used in the EAC message.

HL7 Attribute Table - DST - Transport Destination Segment
Seq#	DataElement	Description	Must Implement	Cardinality	Vocabulary	DataType
DST
1	03491	Destination	SHALL	[1..1]	0943	CWE
2	03492	Route		[0..*]	0944	CWE

DST-1: Destination (CWE) 03491

Definition: This field identifies the destination for transport of a specific container. Refer to User-defined Table 0943 – Transport Destination in Chapter 2C, Code Tables; there are no suggested values.

DST-2: Route (CWE) 03492

Definition: This field identifies the route for transport of a specific container. . Refer to User-defined Table 0944 – Transport Route in Chapter 2C, Code Tables; there are no suggested values.

Each repetion indicates the device to which the sample needs to be moved along the route.Notes regarding usage

Other Required Original HL7 Messages

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.

Transfer of Laboratory Test Orders and Results

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.

Transfer of QC Results

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.

Query for Order Information – Triggers for Download of Test Orders

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.

Transfer of Additional Information for Automated Processing

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.

Working With Non-Substance Inventory Items

This section provides examples of INV segments related to reporting and querying values of equipment state indicators (special non-material inventory items).

Example 1: Reporting that all tests are available (in INU^U05):

INV|NONE^^HL70451|OK^^HL70383|||||||||||||||||||TA^^HL70942

Example 2: Reporting that tests with LOINC codes 1492-8 and 1496-8 are available (in INU^U05):

INV|NONE^^HL70451|OK^^HL70383|||||||||||||1492-8^^LN~1496-8^^LN||||||TA^^HL70942

Example 3: Reporting that the current instrument processing capacity is 42 % (in INU^U05):

INV|NONE^^HL70451|OK^^HL70383|||||||||||||||||||IC^^HL70942|42^%&&UCUM

Example 4: Reporting that an output specimen buffer “Buffer1” is full (in INU^U05):

INV|BufferId1^^HL70451|OK^^HL70383|||||||||||||||||||OB^^HL70942|100^%&&UCUM

Example 5: Reporting that an emergency input specimen buffer “Buffer2” is empty (in INU^U05):

INV|BufferId2^^HL70451|OK^^HL70383|||||||||||||||||||EB^^HL70942|0^%&&UCUM

Example 6: Querying the current instrument processing capacity (in INR^U14):

INV|||||||||||||||||||||IC^^HL70942

Example 7: Querying the current capacity of all regular specimen input buffers (in INR^U14):

INV|||||||||||||||||||||IB^^HL70942

Example 8: Querying the current capacity of the regular specimen input buffer “Buffer3” (in INR^U14):

INV|Buffer3^^HL70451||||||||||||||||||||IB^^HL70942

Example Messages

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.

Automated Equipment Status Update

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|^~VALUEamp;|INSTPROG|AUTINST|LASPROG|LASSYS|19980630080040|SECURITY |ESU^U01^ESU|MSG00001|P|2.8|<cr>

ISD|123456789|IN^INIT|OK<cr>

Automated Equipment Status Request

The LAS queries the chemistry analyzer 0001 for status information.

MSH|^~VALUEamp;|LASPROG|LASSYS|INSTPROG|AUTINST|19980630080040|SECURITY |ESR^U02^ESR|MSG00001|P|2.9|<cr>

EQU|0001^CHEMISTRYANALYZER|19980630080038<cr>

Specimen Status Update

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|^~VALUEamp;|INSTPROG|AUTINST|LASPROG|LASSYS|19980630080040|SECURITY |SSU^U03^SSU|MSG00001|P|2.9|<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|^~VALUEamp;|PREANPROG|AUTPREAN|LASPROG|LASSYS|19980630080040|SECURITY |SSU^U03^SSU|MSG00002|P|2.9|<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>

Specimen Status Request

The chemistry analyzer 0001 queries the LAS for status of specimen/container (id=092321A).

MSH|^~VALUEamp;|LASPROG|LASSYS|INSTPROG|AUTINST|19980630080040|SECURITY |SSR^U04^SSR|MSG00001|P|2.9|<cr>

EQU|0001^CHEMISTRYANALYZER|19980630080038<cr>

SAC|991912376^EXTLAB|01039421^THISLAB|092321A^LAS||||199806200823<cr>

Automated Equipment Inventory Update

The chemistry analyzer 0001 sends to the LAS the status of a TSH reagent (id=MF01239) in bottle (id=12345).

MSH|^~VALUEamp;|INSTPROG|AUTINST|LASPROG|LASSYS|19980630080040|SECURITY |INU^U05^INU|MSG00001|P|2.9|<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>

Automated Equipment Inventory Request

The LAS queries the chemistry analyzer 0001 for status of all packages of the substance (id=MF01239).

MSH|^~VALUEamp;|LASPROG|LASSYS|INSTPROG|AUTINST|19980630080040|SECURITY |INR^U06^INR|MSG00001|P|2.9|<cr>

EQU|0001^CHEMISTRYANALYZER|19980630080038<cr>

INV|MF01239^REAGENT1|OK^OK_STATUS<cr>

Automated Equipment Command

The LAS sends command of "Clearing Notification" to the chemistry analyzer 0001.

MSH|^~VALUEamp;|LASPROG|LASSYS|INSTPROG|AUTINST|19980630080040|SECURITY |EAC^U07^EAC|MSG00001|P|2.9|<cr>

EQU|0001^CHEMISTRYANALYZER|19980630080038<cr>

ECD|89421|CN^CLEAR NOTIFICATION|Y^YES<cr>

CNS|1209|1500|199806010800|199806300800<cr>

Automated Equipment Response

The chemistry analyzer confirms completion of the execution of the initialization command.

MSH|^~VALUEamp;|INSTPROG|AUTINST|LASPROG|LASSYS|19980630080040|SECURITY |EAR^U08^EAR|MSG00001|P|2.9|<cr>

EQU|0001^CHEMISTRYANALYZER|19980630080038<cr>

ECD|89421|IN^INIT|Y^YES<cr>

ECR|OK^COMMAND_COMPLETE|19980630080035<cr>

Automated Equipment Notification

The chemistry analyzer sends a notification (warning) about drift in the detection unit.

MSH|^~VALUEamp;|INSTPROG|AUTINST|LASPROG|LASSYS|19980630080040|SECURITY |EAN^U09^EAN|MSG00001|P|2.9|<cr>

EQU|0001^CHEMISTRYANALYZER|19980630080038<cr>

NDS|8923|199806300800|W^WARNING^|DU001^DETECTIO UNIT DRIFT<cr>

Automated Equipment Test Code Settings Update

The LAS send update of configuration parameters for Glucose test.

MSH|^~VALUEamp;|LASPROG|LASSYS|INSTPROG|AUTINST|19980630080040|SECURITY |TCU^U10^TCU|MSG00001|P|2.9|<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>

Automated Equipment Test Code Settings Request

The chemistry analyzer 0001 queries the LAS for configuration parameters of the Glucose test.

MSH|^~VALUEamp;|INSTPROG|AUTINST|LASPROG|LASSYS|19980630080040|SECURITY |TCR^U11^TCU|MSG00001|P|2.9|<cr>

EQU|0001^CHEMISTRYANALYZER|19980630080038<cr>

TCC|15074-8^GLUCOSE|GLU-HK^CHEMISTRYANALYZER<cr>

Automated Equipment Log/Service Update

The chemistry analyzer 0001 sends 1 record from the event log to the LAS.

MSH|^~VALUEamp;|INSTPROG|AUTINST|LASPROG|LASSYS|19980630080040|SECURITY |LSU^U12^LSU|MSG00001|P|2.9|<cr>

EQU|0001^CHEMISTRYANALYZER|19980630080038<cr>

EQP|LOG^LOG_EVENT||199806300755|199806300800|I976 Instrument Initialization<cr>

Automated Equipment Log/Service Request

The LAS queries chemistry analyzer for log file of events occurring between 7am and 8am on 30th June 1998.

MSH|^~VALUEamp;|LASPROG|LASSYS|INSTPROG|AUTINST|19980630080040|SECURITY |LSR^U13^LSU|MSG00001|P|2.9|<cr>

EQU|0001^CHEMISTRYANALYZER|19980630080038<cr>

EQP|LOG^LOG_EVENT||199806300700|199806300800<cr>

outstanding issues

The element definition for TCC-15 Test Criticality in section 13.4.9.15 proposes an ambigous use of the CWE data type in. Currently the element definition indicates that a CWE data type is used; however, the definition also advises that the element can be populated with "a sequential number of the test sorted according to the criticality assigned by the lab". In general practice, the CWE data type references a table of assigned values, recognizing that those values are often assigned by the user. It is expected that the definition for this element will be reviewed and revised with the next release.

Draft Website - For Review Purposes Only

Clinical Laboratory Automation

Background and Introduction

Background

Introduction

Glossary

Accession Identifier (also accession number):

Additive:

Aliquot:

Analyzer:

Automated:

Automated instrument:

Automation system:

Bar code:

Bar length:

Barrier:

Barrier Delta:

Bottom of cap:

Bottom of container//Bottom of tube:

Bottom of tube:

Carrier:

Character:

Clinical laboratory automation:

Clinical laboratory automation systems:

Closed-container sampling//Closed-tube sampling:

Closed-tube sampling:

Container//Tube//Test Tube:

Container Identifier

Cycle time components:

Decapping:

Delimiter:

Directions of the specimen, Transportation system, Instrument or Specimen processing and handling device interfaces:

Directions of the sample, Transportation system, Instrument or Specimen processing handling device and interfaces

Direct track sampling:

Docking site:

Flection:

Interaction:

Label:

Laboratory automation system (LAS):

Laboratory equipment control interface specification (LECIS):

Laboratory information system (LIS):

LECIS:

Location:

Open-container sampling//Open-tube sampling:

Open-tube sampling:

Pitch:

Point of reference//Point in space, (POR):

Process instruments:

Quiet zone:

Recap:

Robotic arm:

Sample//(Specimen):

Sample carrier:

Sample container:

Sample-positioning system:

Sample probe:

Separator:

Serum/Plasma Separator:

Service envelope:

Specimen:

Specimen carrier//Sample carrier//Carrier:

Specimen collection container//Specimen container//Sample container//Container:

Specimen-positioning system//Sample-positioning system (SPS):

Specimen probe//Sample probe:

Stay clear zone:

Symbol:

Test mnemonics:

Top of container//Top of tube:

Top of tube:

Tray:

X–direction:

Y–direction:

Z–direction:

Trigger Events and Message Definitions

ESU/ACK - Automated Equipment Status Update (Event U01)

Original Mode Acknowledgement Choreography for ESU^U01^ESU_U01

Enhanced Mode Acknowledgement Choreography for ESU^U01^ESU_U01

Original Mode Acknowledgement Choreography for ACK^U01^ACK

Enhanced Mode Acknowledgement Choreography for ACK^U01^ACK

ESR/ACK - Automated Equipment Status Request (Event U02)