Healthline HL7 Communications Module Definition Statement
Copyright © 2000 - 2005 by Healthline Information
Systems, Inc.
Suite 17 Northeast Drive, Davidson, NC 28036
Tel: (704) 655 0447
Document No: HL7def-1.6
Healthline HL7 Communications Module Definition Statement
Copyright © 2000 - 2005 by Healthline Information
Systems, Inc. Document No: HL7def-1.6 |
|
This document is intended to describe our HL7 implementation within the confines of the HL7 standard, where any conflict arises between this document and the HL7 standard please refer back to the Healthline Medical Imaging, Inc for clarification.
| Incoming Messages | Outgoing Messages | Delimiters | Segments | Hl7 Data Types | Tables |
Primary function
To listen as a client or server on a specified socket, file or communication port (i.e. serial device) and accept HL7 transactions to populate the relevant information into the Healthline PACS database.
To forward status results over on a specified socket, file or communication port (i.e. serial device) for inclusion to a HIS or RIS system.
General Overview
The HL7 protocol consists of a series of messages that represent the data that resulted from the occurrence of a "trigger event" on a sending system. That is, when a trigger event occurs on a sending system (e.g., when a patient is transferred from one bed to another), the sending system application produces an HL7 transaction that contains the results of that trigger event (e.g., contains a notice of the transfer).
Each message contains a series of "segments" each of which is a single, variable-length line of ASCII text terminated (usually) with a CR (ASCII 0x0D) and which contains some specific data to be included in the message. Each segment has a three-character identifier and a sequence of variable-length fields separated from each other by a field separator character, usually "|".
Some fields can contain a substructure, each item of which is called a "component". Components are variable-length strings separated from each other within a field using a "component separator", usually the "^" character. Components can be further subdivided into sub-components, which are, again, variable-length strings, separated from each other by a sub-component separator character, usually the "&" character.
Some fields can contain multiple instances of data, separated by a "repetition separator", usually the tilde "~" character. Thus it is conceivable that there would be multiple repetitions of a field containing multiple components, some of which had sub components.
Note that I identified these separator characters as "usually" being something, that is because they are configurable in the message header and the usual value is the suggested value.
Finally, data can contain "escape characters" that set off codes for new line, tab, etc. (in a manner similar to C), and this character, usually a "\", is also configurable.
Messages must always begin with a message header (MSH) segment and then contain other segments as dictated by the message being sent. There is no explicit termination of the message at the layer-7 protocol.
The Healthline HL7 module is able to address messages that do not necessarily start with a (MSH) Segment record to allow the incorporation of non-standard messaging systems. i.e. ASCII interfaces. (This is not recommended for upgradibility issues and support issues )
Network Communications Protocol and Data Framing
The Healthline HL7 interface supports network transfer of messages using TCP/IP socket connections over an Ethernet backbone and supports the HL7 Minimal Lower Layer Protocol for framing HL7 messages.
When establishing network communications, whether receiving messages or sending messages, Healthline HL7 module can act as a client or server. As a client, the aplication system must be supplied with the IP address of the remote system, along with a Port number on the remote system to which the Healthline HL7 module system can open a TCP/IP connection. The connection will remain open unless the interface is turned off on the Healthline system either using the web interface or the application directly, or a close is initiated by the remote system. If a close is initiated by the remote system and the Healthline HL7 interface is not turned off, the application will attempt to open a connection once every 2 minutes. Once a connection is established between the two systems, message transfer may continue to occur.
As a server, the Healthline HL7 module will wait until a request to open the connection is received and will display Awaiting connection on the application. If a close is initiated by the remote system while the interface is running , the association will be dropped and the state will remain Awaiting connection until a request to open the connection is sent. The Healthline HL7 module can be configured to respond with ACK / NAK messages or to ignore them completely (ie serial or file communication messages). If the Healthline HL7 module is shutdown from the Healthline web interface of the Application directly then the module will attempt to submit a close to the responding system.
Basic Workflow
| Patient is Registered | Setup base record in PACS |
| Patient is Admitted | Setup default location for images to be submitted in PACS and initiate prelimary prefetch rules |
| Order is placed | Initiate pre-fetch of old images in PACS to IMS(Healthline Image Management Server) . Prepare clinical notes to be attached to newly acquired images. Forward any old reports associated with old exams and old clinical notes. PACS must be configured in AUTO ROUTING RULES to perform this task through the WEB interface. Pre-Fetching Rules make use of as much data that is available about the order (eg, Procedure codes, Referring Department, Patients Status (inpatient, outpatient), Modality Type (ie CR,US,CT,NM…), Body Part….) |
| Procedure Performed | QA procedure allows Tech to add additional clinical notes to order whilst QA 'ing the Images, Annotation, image orientation is also performed. New images and clinical notes are forwarded to Requesting Dept, Consultant or Referring Doctor to be merged with old images, clinical notes and reports. New images are also sent to ER, ICU (if necessary) depending on referring dept and the WARD that the patient is expected to be placed in. |
| Radiologist Diagnosis | Radiologist reads the images and can make Annotations, manipulate the image and mark the Image set (study) as reported. (It is usually at this time that a dictation is performed and the transcription services type the report). This report is received back into the PACS and associated with this UNIQUE Accession number. |
| Patient Transferred | All Images, requests, reports follow the patient to the new location and are removed from the old location. |
| Patient Discarded | All references (copies of images etc) are purged and the master record is committed for archival (if not already done) together with clinical notes, new image attributes and newly acquired reports. |
Many of the Triggers are initiated when new HIS/RIS data is received and also when Image attributes are accessed, modified or changed from any of the PACS connected workstations.
( Reports are submitted whenever the RIS determines the report to be available – If a second report (modification or verification) is submitted for a specific admit and order – the newly submitted report will overwrite any existing reports )
Whenever possible an accession number should be used especially for orders and reports. An Accession number is an unique number generally derived from the Admit number and order number for a particular patient. Ie. Patient is admitted and given a billing number (111111) For every procedure an order number is given (0001) and increments continuously until the patient is discharged. The combination of 111111 0001 is the Accession Number that is if the patient had 12 procedures performed with 12 orders then the last accession number may be 111111 0012. Additional fields may be included to ensure this field is unique throughout the enterprise.This would be the preferred number to be used as the placer order number (00216 in ORC record).
Currently Supported Event Triggers
The Healthline PACS provides a configurable interface for communication over the HL7 interface, although based upon the HL7 2.3 definition of the standard. Field definitions within a segment are highly configurable and can be modified to suite most sites specific needs. Segments can be created and utilized within an existing message structure. It is advised to follow the HL7 Standard for greater compatibility with other systems that may be implemented within a specific site.
The Healthline HL7 module will accept all HL7 messages . The HL7 module will handle the messages that the PACS requires and respond accordingly. If a message is not used by the PACS then an ACK will be responded regardless of the integrety of the unwanted transaction.
The Healthline PACS requires a base level of messaging to allow intelligent manipulation of workflow within a hospital system especially for automatic routing of images to required locations for ‘ontime’ display for diagnoses and review.
The following are accepted incoming messages to the Healthline PACS utilizing the HL7 module including but not limited to:
EVENT A01 - Admit / Visit Notifiactaion
An A01 event is intended to be used for "Admitted" patients only. An A01 event is sent as a result of a patient undergoing the admission process that assigns the patient to a bed. It signals the beginning of a patient’s stay in a healthcare facility. Normally, this information is entered in the primary ADT system and broadcast to the nursing units and ancillary systems. It includes short stay and John Doe admissions. PACS will setup the location, as the default location associated with that patient (could be a workstation associated with a room, ward or floor) – images can be routed to this location after regular processing and pre-fetching will be actioned for any prior images.
MSH, EVN, PID, [{ NK1 } ], PV1, [ PV2 ], [{ OBX } ], [{ AL1 } ], [{ DG1 } ], [{ PR1 } ], [{ GT1 } ], [{ IN1, [ IN2 ], [ IN3 ]} ], [ ACC ], [ UB1 ], [ UB2 ]
EVENT A02 - Transfer a patient
An A02 event is issued as a result of the patient changing his or her assigned physical location. PACS can transfer any relevant images to the patient’s new associated location and remove any old related images from the previous location.
MSH, EVN, PID, PV1, [ PV2 ], [{ OBX } ]
EVENT A03 - Discharge / end visit
An A03 event signals the end of a patient’s stay in a healthcare facility. It signals that the patient’s status has changed to "discharged" and that a discharge date has been recorded. The patient is no longer in the facility. PACS can remove all images from any stations associated with the patients stay unless still in an unreported state on a radiologists reporting station.
MSH, EVN, PID, PV1, [ PV2 ], [{ OBX } ]
EVENT A04 - Register a patient
An A04 event signals that the patient has arrived or checked in as a one-time, or recurring outpatient, and is not assigned to a bed. PACS will use this information to register the patient’s demographics into the database.
MSH, EVN, PID, [{ NK1 } ], PV1, [ PV2 ], [{ OBX } ], [{ AL1 } ], [{ DG1 } ], [{ PR1 } ], [{ GT1 } ], [{ IN1, [ IN2 ], [ IN3 ]} ], [ ACC ], [ UB1 ], [ UB2 ]
EVENT A05 - Pre admit a patient
An A05 event is sent when a patient undergoes the pre-admission process. During this process, episode-related data is collected in preparation for a patient’s visit or stay in a healthcare facility. For example, a pre-admit may be performed prior to inpatient or outpatient surgery so that lab tests can be performed prior to the surgery. This event can also be used to pre-register a non-admitted patient.
MSH, EVN, PID, [{ NK1 } ], PV1, [ PV2 ], [{ OBX
} ], [{ AL1 } ], [{ DG1 } ], [{ DRG }] ,[{ PR1 } ], [{ GT1 } ], [{ IN1, [ IN2 ], [ IN3 ]} ], [
ACC ], [ UB1 ], [ UB2 ]
EVENT A06 - Transfer outpatient to inpatient
An A06 event is sent when a patient who was present for a non-admitted visit is being admitted after an evaluation of the seriousness of the patient’s condition. This event changes a patient’s status from non-admitted to admitted. The new patient location should appear in PV1-3-assigned patient location, while the old patient location (if different) should appear in PV1-6-prior patient location. The new patient class should appear in PV1-2-patient class. PACS can use this in similar action to a patient transfer but also modify the patient status to an inpatient – generally this will also trigger historical images to be pre-fetched.
MSH, EVN, PID, [ MRG ], [{ NK1 } ], PV1, [ PV2 ], [{ OBX } ], [{ AL1 } ], [{ DG1 } ], [{ PR1 } ], [{ GT1 } ], [{ IN1, [ IN2 ], [ IN3 ]} ], [ ACC ], [ UB1 ], [ UB2 ]
EVENT A07 - Transfer inpatient to outpatient
An A07 event is sent when a patient who was admitted changes his/her status to "no longer admitted" but is still being seen for this episode of care. This event changes a patient from an "admitted" to a "non-admitted" status. The new patient location should appear in PV1-3-assigned patient location, while the old patient location (if different) should appear in PV1-6-prior patient location. PACS can use this in similar action to a patient transfer but also modify the patient status to an outpatient.
MSH, EVN, PID, [ MRG ], [ { NK1 } ], PV1, [ PV2 ], [ { OBX } ], [ { AL1 } ], [ { DG1 } ], [ { PR1 } ], [ { GT1 } ], [ { IN1, [ IN2 ], [ IN3 ]} ], [ ACC ], [ UB1 ], [ UB2 ]
EVENT A08 - Update patient information
This trigger event is used when any patient information has changed but when no other trigger event has occurred. For example, an A08 event can be used to notify the receiving systems of a change of address or a name change. We recommend that the A08 transaction be used to update fields that are not related to any of the other trigger events. The A08 event can include information specific to an episode of care, but it can also be used for demographic information only. PACS will generally treat this as a demographic change to the patient’s record only.
MSH, EVN, PID, [{ NK1 } ], PV1, [ PV2 ], [{ OBX } ], [{ AL1 } ], [{ DG1 } ], [{ PR1 } ], [{ GT1 } ], [ { IN1, [ IN2 ], [ IN3 ] } ], [ ACC ], [ UB1 ], [ UB2 ]
EVENT A11 - Cancel Admit / Visit Notification
For “admitted” patients,
the A11 event is sent when an A01 (admit/visit notification) event is canceled,
either because of an erroneous entry of the A01 event, or because of a decision
not to admit the patient after all.
For ”non-admitted”
patients, the A11 event is sent when an A04 (register patient) event is
canceled, either because of an erroneous entry of the A04 event, or because of a
decision not to check the patient in for the visit after all.
To cancel an A05 (pre-admit a patient) event, use the A38 (cancel
pre-admit), which is new for version 2.3 of this Standard.
The fields included when
this message is sent should be only the fields necessary to communicate this
event. When other important fields change it is recommended that the
A08 (update patient information) event be used instead.
MSH, EVN, PID, PV1, [ PV2 ], [{ OBX } ], [{ DG1 } ]
The A12 event is sent when an A02 (transfer a patient) event is canceled, either because of erroneous entry of the A02 event or because of a decision not to transfer the patient after all. PV1-3-assigned patient location must show the location of the patient prior to the original transfer, PV1-6-prior patient location must be the location of where the transfer was destined. PACS will treat this as a reverse of an A02 transaction.
MSH, EVN, PID, PV1, [ PV2 ], [{ OBX } ], [{ DG1 } ]
The A13 event is sent when an A03 (discharge/end visit) event is canceled, either because of erroneous entry of the A03 event or because of a decision not to discharge or end the visit of the patient after all. PV1-3-assigned location should reflect the location of the patient after the cancellation has been processed. PACS can recover images similar to an A01 transaction if transaction is older than the auto deletion rule period, otherwise deleted images can be un-deleted from the associated previous location.
MSH, EVN, PID, [{ NK1 } ], PV1, [ PV2 ], [{ OBX } ], [{ AL1 } ], [{ DG1 } ], [{ PR1 } ], [{ GT1 } ], [{ IN1, [ IN2 ], [ IN3 ]} ], [ ACC ], [ UB1 ], [ UB2 ]
The A17 is used when it is decided that two patients will exchange beds. The patient ID and visit data are repeated for the two patients changing places. If the location in the PACS is an active location and is different from the associated workstation then an equivalent patient transfer action will be executed.
MSH, EVN, PID, PV1, [ PV2 ], [{ OBX } ],
PID ,PV1, [ PV2 ], [{ OBX } ]
EVENT A18 - Patient Merge (backward compatibility)
The A18 is used to merge
current and previous patient identification numbers: PID-3-patient
ID ( internal ID), PID-2-patient ID (external ID), PID-4-alternate patient ID -
PID, and PID-18-patient account number.
This procedure is required, for example, when a patient has previously
been registered under a new patient identification number because of an error,
or because there was insufficient time to determine the actual patient
identification number. The merge
event occurs when a decision is made to combine the information under either the
new or the old identifier(s). We
recommend that events A34 (merge patient information-patient ID only), A35
(merge patient information-account number only), and A36 (merge patient
information-patient ID and account number) be utilized in place of the A18 event
whenever possible.
The PID segment contains the
surviving patient ID information. The
MRG segment contains the non-surviving information.
MSH, EVN, PID,[PD1], [MRG], PV1
EVENT A23 - Delete patient record
The A23 event is used to delete visit or episode-specific information from the patient record. For example, it is used to remove old data from a database that cannot hold all historical patient visit data. When an event was entered erroneously, use one of the cancel transactions. This event can be used to purge account level data while retaining the person in the database. PACS will NOT delete any data from it’s database.
MSH, EVN, PID, PV1, [ PV2 ], [{ OBX } ]
EVENT A34 - Merge Patient - Patient_ID ONLY
Only PID-3-patient identification (internal ID) has changed as a result of the merge. An A34 (merge patient information-patient ID only) event is intended for merging or changing patient identifiers. It would be used to change patient identifiers on all of this patient’s existing accounts. The PACS will associate the images with the merged patient to the NEW patient. It must be noted that the image data in the image header will NOT get changed although the database record will be modified to assist with query functionality
EVENT A35 - Merge Patient - Account ONLY
Only the patient account number has changed as a result of the merge. An A35 (merge patient information-account number only) event is intended for merging or changing an account number only. As the PACS does not key off this field the Image data will remain associated with the original order associated with the CURRENT Patient ID
EVENT A36 - Merge Patient - Patient_ID and Account
An A36 (merge patient
information-patient ID and account number) event is intended for changing both
the patient identifier and the account number for one valid account.
For example, account X for patient A changes to account Y for patient B.
This A36 should not be used for changing the patient identifier for any
other accounts than the ones identified in this message.
EVENT ORM - General order message
The function of this message is to initiate the transmission of information about an order. This includes placing new orders, cancellation of existing orders, discontinuation, holding, etc. ORM messages can originate also with a placer, filler, or an interested third party. The PACS uses this message as a crucial link between a RIS / HIS and the PACS in associating images with procedures.
MSH,[{NTE}],[PID,[{NTE}],[PV1,PV2][{IN1,[IN2]}],[GT1][{AL1}]]],{ORC,[OBR[{NTE}],[{DG1}][{OBX,[{NTE}]}]],{[CT1]},[BLG]}
EVENT ORU - Unsolicited transmission of an observation message
The ORU event is used to construct almost any clinical report t as a three-level hierarchy, with the PID segment at the upper level, an order record (OBR) at the next level and one or more observation records (OBX) at the bottom. The PACS takes this information and produces reports associated with orders for viewing when historical images are pre-fetched.
MSH,{[PID,[{NTE}],[PV1]],{[ORC],OBR,{[NTE]},{[OBX],{[NTE]}},{[CTI]}},[DSC]
The following are outgoing messages from the Healthline PACS utilizing the HL7 module including but not limited to:
EVENT PAC - Healthline PACS object status tracking
The Healthline PACS will trigger events to allow tracking of specific object types to assist with workflow issues between the PACS and RIS / HIS applications.
We use a segment specific to MarkCare called PAC. This segment will allow a generic method of tracking objects that are changing in the PACS application.
| Delimiter | Suggested Value |
Encoding Character Position |
Usage |
| Segment Terminator | <cr> hex 0D |
- |
Terminates a segment record. This value cannot be changed by implementors. |
| Field Separator | | |
- |
Separates two adjacent data fields within a segment. It also separates the segment ID from the first data field in each segment. |
| Component Separator | ^ |
1 |
Separates adjacent components of data fields where allowed. |
| Subcomponent Separator | & |
4 |
Separates adjacent subcomponents of data fields where allowed. If there are no subcomponents, this character may be omitted. |
| Repetition Separator | ~ |
2 |
Separates multiple occurrences of a field where allowed. |
| Escape Character | \ |
3 |
Escape character for TX and FT fields. If no escape characters are used in a message, this character may be omitted. However, it must be present if subcomponents are used in the message. |
| SEQ | LEN | Data Types | OPT |
TBL# | ITEM # | ELEMENT NAME |
| 1 | 2 | ID | R |
0008 | 00018 | Acknowledgment Code |
| 2 | 20 | ST | R |
00010 | Message Control ID | |
| 3 | 80 | ST | O |
00020 | Text Message | |
| 4 | 15 | NM | O |
00021 | Expected Sequence Number | |
| 5 | 1 | ID | B |
0102 | 00022 | Delayed Acknowledgment Type |
| 6 | 100 | CE | O |
00023 | Error Condition |
SEQ |
LEN |
OPT |
TBL# |
ITEM # |
ELEMENT NAME | |
1 |
1 | ST | R |
00001 | Field Separator | |
2 |
4 | ST | R |
00002 | Encoding Characters | |
3 |
180 | HD | O |
00003 | Sending Application | |
4 |
180 | HD | O |
00004 | Sending Facility | |
5 |
180 | HD | O |
00005 | Receiving Application | |
6 |
180 | HD | O |
00006 | Receiving Facility | |
7 |
26 | TS | R |
00007 | Date/Time Of Message | |
8 |
40 | ST | O |
00008 | Security | |
9 |
7 | CM | R |
0076 | 00009 | Message Type |
10 |
20 | ST | R |
00010 | Message Control ID | |
11 |
3 | PT | R |
01030207 | 00011 | Processing ID |
12 |
8 | ID | R |
0104 | 00012 | Version ID |
13 |
15 | NM | O |
00013 | Sequence Number | |
14 |
180 | ST | O |
00014 | Continuation Pointer | |
15 |
2 | ID | O |
0155 | 00015 | Accept Acknowledgment Type |
16 |
2 | ID | O |
0155 | 00016 | Application Acknowledgment Type |
17 |
2 | ID | O |
00017 | Country Code | |
18 |
6 | ID | O |
0211 | 00692 | Character Set |
19 |
60 | CE | O |
00693 | Principal Language Of Message |
SEQ |
LEN | Data Types | OPT |
TBL# | ITEM# | ELEMENT NAME |
1 |
3 | ID | R |
0003 | 00099 | Event Type Code |
2 |
26 | TS | R |
00100 | Date/Time of Event | |
3 |
26 | TS | O |
00101 | Date/Time Planned Event | |
4 |
3 | IS | O |
0062 | 00102 | Event Reason Code |
5 |
60 | XCN | O |
0188 | 00103 | Operator ID |
SEQ |
LEN | Data Types | OPT |
TBL# | ITEM# | ELEMENT NAME |
1 |
64 | EI | R |
Object ID (eg.Accession Number, Image UID,Patient ID) | ||
2 |
20 | CX | R |
00106 | Patient ID (Internal ID) | |
3 |
26 | TS | R |
00100 | Date/Time of Event | |
4 |
20 | ST | R |
9001 | PACS object type | |
5 |
16 | CE | R |
9002 | PACS object status | |
6 |
20 | CM | O |
9003 | Principal Object Interpreter | |
7 |
60 | XCN | O |
00103 | Interpreter code Operator ID (e.g. consultant id) | |
| 8 | 2 | ID | O | 0125 | 00570 | Additional Value Type (describe info returned in field 9) |
| 9 | 200 | ST | O | 9004 | Value (can be number of images or additional info re 9001) |
SEQ |
LEN | Data Types | OPT |
TBL# | ITEM# | ELEMENT NAME |
1 |
4 | SI | o | 00104 | Set ID - Patient ID | |
2 |
16 | CK | o | 00105 | Patient ID (External ID) | |
3 |
20 | CX | R |
00106 | Patient ID (Internal ID) | |
4 |
12 | ST | o | 00107 | Alternate Patient ID - PID | |
5 |
48 | XPN | R |
00108 | Patient Name | |
6 |
48 | XPN | o | 00109 | Mother's Maiden Name | |
7 |
26 | TS | R | 00110 | Date/Time of Birth | |
8 |
1 | IS | R | 0001 | 00111 | Sex |
9 |
48 | XPN | o | 00112 | Patient Alias | |
10 |
1 | IS | o | 0005 | 00113 | Race |
11 |
106 | XAD | R | 00114 | Patient Address | |
12 |
4 | IS | o | 00115 | County Code | |
13 |
40 | XTN | R | 00116 | Phone Number - Home | |
14 |
40 | XTN | o | 00117 | Phone Number - Business | |
15 |
60 | CE | o | 0296 | 00118 | Primary Language |
16 |
1 | IS | o | 0002 | 00119 | Marital Status |
17 |
3 | IS | o | 0006 | 00120 | Religion |
18 |
20 | CX | R | 00121 | Patient Account Number | |
19 |
16 | ST | o | 00122 | SSN Number - Patient | |
20 |
25 | CM | o | 00123 | Driver's Lic Num - Patient | |
21 |
20 | CX | o | 00124 | Mother's Identifier | |
22 |
3 | IS | o | 0189 | 00125 | Ethnic Group |
23 |
60 | ST | o | 00126 | Birth Place | |
24 |
2 | ID | o | 0136 | 00127 | Multiple Birth Indicator |
25 |
2 | NM | o | 00128 | Birth Order | |
26 |
4 | IS | o | 0171 | 00129 | Citizenship |
27 |
60 | CE | o | 0172 | 00130 | Veterans Military Status |
28 |
80 | CE | o | 0212 | 00739 | Nationality |
29 |
26 | TS | o | 00740 | Patient Death Date and Time | |
30 |
1 | ID | o | 0136 | 00741 | Patient Death Indicator |
| SEQ | LEN | Data Types | OPT | TBL# | ITEM# | ELEMENT NAME |
| 1 | 4 | SI | O | 00131 | Set ID - Patient Visit | |
| 2 | 1 | IS | R | 0004 | 00132 | Patient Class |
| 3 | 12 | PL | R | 00133 | Assigned Patient Location | |
| 4 | 2 | IS | O | 0007 | 00134 | Admission Type |
| 5 | 20 | CX | O | 00135 | Preadmit Number | |
| 6 | 12 | PL | R | 00136 | Prior Patient Location | |
| 7 | 60 | XCN | O | 0010 | 00137 | Attending Doctor |
| 8 | 60 | XCN | O | 0010 | 00138 | Referring Doctor |
| 9 | 60 | XCN | O | 0010 | 00139 | Consulting Doctor |
| 10 | 3 | IS | R | 0069 | 00140 | Hospital Service |
| 11 | 12 | PL | O | 00141 | Temporary Location | |
| 12 | 2 | IS | O | 0087 | 00142 | Preadmit Test Indicator |
| 13 | 2 | IS | O | 0092 | 00143 | Readmission Indicator |
| 14 | 3 | IS | O | 0023 | 00144 | Admit Source |
| 15 | 2 | IS | O | 0009 | 00145 | Ambulatory Status |
| 16 | 2 | IS | O | 0099 | 00146 | VIP Indicator |
| 17 | 60 | XCN | R | 0010 | 00147 | Admitting Doctor |
| 18 | 2 | IS | O | 0018 | 00148 | Patient Type |
| 19 | 15 | CK | O | 00149 | Visit Number | |
| 20 | 50 | CM | O | 0064 | 00150 | Financial Class |
| 21 | 2 | IS | O | 0032 | 00151 | Charge Price Indicator |
| 22 | 2 | IS | O | 0045 | 00152 | Courtesy Code |
| 23 | 2 | IS | O | 0046 | 00153 | Credit Rating |
| 24 | 2 | IS | O | 0044 | 00154 | Contract Code |
| 25 | 8 | DT | O | 00155 | Contract Effective Date | |
| 26 | 12 | NM | O | 00156 | Contract Amount | |
| 27 | 3 | NM | O | 00157 | Contract Period | |
| 28 | 2 | IS | O | 0073 | 00158 | Interest Code |
| 29 | 1 | IS | O | 0110 | 00159 | Transfer to Bad Debt Code |
| 30 | 8 | DT | O | 00160 | Transfer to Bad Debt Date | |
| 31 | 10 | IS | O | 0021 | 00161 | Bad Debt Agency Code |
| 32 | 12 | NM | O | 00162 | Bad Debt Transfer Amount | |
| 33 | 12 | NM | O | 00163 | Bad Debt Recovery Amount | |
| 34 | 1 | IS | O | 0111 | 00164 | Delete Account Indicator |
| 35 | 8 | DT | O | 00165 | Delete Account Date | |
| 36 | 3 | IS | O | 0112 | 00166 | Discharge Disposition |
| 37 | 25 | IS | O | 0113 | 00167 | Discharged to Location |
| 38 | 2 | IS | O | 0114 | 00168 | Diet Type |
| 39 | 2 | IS | O | 0115 | 00169 | Servicing Facility |
| 40 | 1 | IS | O | 0116 | 00170 | Bed Status |
| 41 | 2 | IS | O | 0117 | 00171 | Account Status |
| 42 | 12 | PL | O | 00172 | Pending Location | |
| 43 | 12 | PL | O | 00173 | Prior Temporary Location | |
| 44 | 26 | TS | O | 00174 | Admit Date/Time | |
| 45 | 26 | TS | O | 00175 | Discharge Date/Time | |
| 46 | 12 | NM | O | 00176 | Current Patient Balance | |
| 47 | 12 | NM | O | 00177 | Total Charges | |
| 48 | 12 | NM | O | 00178 | Total Adjustments | |
| 49 | 12 | NM | O | 00179 | Total Payments | |
| 50 | 20 | CX | O | 00180 | Alternate Visit ID | |
| 51 | 1 | IS | O | 0326 | 01226 | Visit Indicator |
| 52 | 60 | XCN | O | 0010 | 01224 | Other Healthcare Provider |
| SEQ | LEN | Data Types | OPT | TBL# | ITEM# | ELEMENT NAME |
| 1 | 2 | ID | R | 0119 | 00215 | Order Control |
| 2 | 22 | EI | C | 00216 | Placer Order Number | |
| 3 | 22 | EI | C | 00217 | Filler Order Number | |
| 4 | 22 | EI | O | 00218 | Placer Group Number | |
| 5 | 2 | ID | O | 0038 | 00219 | Order Status |
| 6 | 1 | ID | O | 0121 | 00220 | Response Flag |
| 7 | 200 | TQ | O | 00221 | Quantity/Timing | |
| 8 | 200 | CM | O | 00222 | Parent | |
| 9 | 26 | TS | R | 00223 | Date/Time of Transaction | |
| 10 | 120 | XCN | O | 00224 | Entered By | |
| 11 | 120 | XCN | O | 00225 | Verified By | |
| 12 | 120 | XCN | O | 00226 | Ordering Provider | |
| 13 | 80 | PL | O | 00227 | Enterer's Location | |
| 14 | 40 | XTN | O | 00228 | Call Back Phone Number | |
| 15 | 26 | TS | R | 00229 | Order Effective Date/Time | |
| 16 | 200 | CE | O | 00230 | Order Control Code Reason | |
| 17 | 60 | CE | O | 00231 | Entering Organization | |
| 18 | 60 | CE | O | 00232 | Entering Device | |
| 19 | 120 | XCN | O | 00233 | Action By |
| SEQ | LEN | Data Types | OPT | TBL# | ITEM # | ELEMENT NAME |
| 1 | 4 | SI | C | 00237 | Set ID - Observation Request | |
| 2 | 75 | EI | R | 00216 | Placer Order Number | |
| 3 | 75 | EI | C | 00217 | Filler Order Number + | |
| 4 | 200 | CE | R | 00238 | Universal Service ID | |
| 5 | 2 | ID | C | 00239 | Priority (required if not specified in filed 27 comp 6) | |
| 6 | 26 | TS | R | 00240 | Requested Date/time | |
| 7 | 26 | TS | C | 00241 | Observation Date/Time # | |
| 8 | 26 | TS | O | 00242 | Observation End Date/Time # | |
| 9 | 20 | CQ | O | 00243 | Collection Volume * | |
| 10 | 60 | XCN | O | 00244 | Collector Identifier * | |
| 11 | 1 | ID | O | 0065 | 00245 | Specimen Action Code * |
| 12 | 60 | CE | O | 00246 | Danger Code | |
| 13 | 300 | ST | O | 00247 | Relevant Clinical Info. | |
| 14 | 26 | TS | C | 00248 | Specimen Received Date/Time * | |
| 15 | 300 | CM | O | 0070 | 00249 | Specimen Source * |
| 16 | 80 | XCN | O | 00226 | Ordering Provider | |
| 17 | 40 | XTN | O | 00250 | Order Callback Phone Number | |
| 18 | 60 | ST | O | 00251 | Placer field 1 | |
| 19 | 60 | ST | O | 00252 | Placer field 2 | |
| 20 | 60 | ST | O | 00253 | Filler Field 1 + | |
| 21 | 60 | ST | O | 00254 | Filler Field 2 + | |
| 22 | 26 | TS | C | 00255 | Results Rpt/Status Chng - Date/Time + | |
| 23 | 40 | CM | O | 00256 | Charge to Practice + | |
| 24 | 10 | ID | O | 0074 | 00257 | Diagnostic Serv Sect ID |
| 25 | 1 | ID | C | 0123 | 00258 | Result Status + |
| 26 | 200 | CM | O | 00259 | Parent Result + | |
| 27 | 200 | TQ | R(6) | 00221 | Quantity/Timing (Require priority in 6th field) | |
| 28 | 150 | XCN | O | 00260 | Result Copies To | |
| 29 | 150 | CM | O | 00261 | Parent Number | |
| 30 | 20 | ID | O | 0124 | 00262 | Transportation Mode |
| 31 | 300 | CE | O | 00263 | Reason for Study | |
| 32 | 200 | CM | R | 00264 | Principal Result Interpreter + | |
| 33 | 200 | CM | O | 00265 | Assistant Result Interpreter + | |
| 34 | 200 | CM | R | 00266 | Technician + | |
| 35 | 200 | CM | O | 00267 | Transcriptionist + | |
| 36 | 26 | TS | O | 00268 | Scheduled Date/Time + | |
| 37 | 4 | NM | O | 01028 | Number of Sample Containers * | |
| 38 | 60 | CE | O | 01029 | Transport Logistics of Collected Sample * | |
| 39 | 200 | CE | O | 01030 | Collector's Comment * | |
| 40 | 60 | CE | O | 01031 | Transport Arrangement Responsibility | |
| 41 | 30 | ID | O | 0224 | 01032 | Transport Arranged |
| 42 | 1 | ID | O | 0225 | 01033 | Escort Required |
| 43 | 200 | CE | O | 01034 | Planned Patient Transport Comment |
SEQ |
LEN |
OPT |
TBL# |
ITEM# |
ELEMENT NAME | |
| 1 | 10 | SI | O |
00569 | Set ID - Observational Simple | |
| 2 | 2 | ID | R |
0125 | 00570 | Value Type |
| 3 | 590 | CE | R |
00571 | Observation Identifier | |
| 4 | 20 | ST | C |
00572 | Observation Sub-ID | |
| 5 | 65536 | * | C |
00573 | Observation Value | |
| 6 | 60 | CE | O |
00574 | Units | |
| 7 | 10 | ST | O |
00575 | References Range | |
| 8 | 5 | ID | O |
0078 | 00576 | Abnormal Flags |
| 9 | 5 | NM | O |
00577 | Probability | |
| 10 | 2 | ID | O |
0080 | 00578 | Nature of Abnormal Test |
| 11 | 1 | ID | R |
0085 | 00579 | Observ Result Status |
| 12 | 20 | TS | O |
00580 | Date Last Obs Normal Values | |
| 13 | 26 | ST | O |
00581 | User Defined Access Checks | |
| 14 | 200 | TS | O |
00582 | Date/Time of the Observation | |
| 15 | 60 | CE | O |
00583 | Producer's ID | |
| 16 | 80 | XCN | O |
00584 | Responsible Observer | |
| 17 | 60 | CE | O |
00936 | Observation Method |
SEQ |
LEN |
OPT |
TBL# |
ITEM # |
ELEMENT NAME | |
| 1 | 80 | CM | R |
0060 | 00024 | Error Code and Location |
MRG - MERGE PATIENT INFORMATION
SEQ |
LEN |
OPT |
TBL# |
ITEM # |
ELEMENT NAME | |
1 |
20 | CX | R |
00211 | Prior Patient ID - Internal | |
2 |
16 | CX | O |
00212 | Prior Alternate Patient ID | |
3 |
20 | CX | O |
00213 | Prior Patient Account Number | |
| 4 | 16 | CX | O | 00214 | Prior Patient ID - External |
SEQ |
LEN |
OPT |
TBL# |
ITEM # |
ELEMENT NAME | |
1 |
4 | SI | C |
00096 | Set ID - NTE (dependant if using old Z11 message) | |
2 |
8 | ID | C |
0105 | 00097 | Source of Comment (dependant if using old Z11 message) |
3 |
64k | FT | C |
00098 | Comment (dependant if using old Z11 message) |
| VALUE | DESCRIPTION |
|---|---|
F |
Female |
M |
Male |
O |
Other |
U |
Unknown |
| VALUE | DESCRIPTION |
|---|---|
A |
Separated |
D |
Divorced |
M |
Married |
S |
Single |
W |
Widowed |
| VALUE | DESCRIPTION |
|---|---|
A01 |
ADT/ACK - Admit / visit notification |
A02 |
ADT/ACK - Transfer a patient |
A03 |
ADT/ACK - Discharge/end visit |
A04 |
ADT/ACK - Register a patient |
A05 |
ADT/ACK - Pre-admit a patient |
A06 |
ADT/ACK - Change an outpatient to an inpatient |
A07 |
ADT/ACK - Changer an inpatient to an outpatient |
A08 |
ADT/ACK - Update patient information |
A09 |
ADT/ACK - Patient departing - tracking |
A10 |
ADT/ACK - Patient arriving - tracking |
A11 |
ADT/ACK - Cancel admit/visit notification |
A12 |
ADT/ACK - Cancel transfer |
A13 |
ADT/ACK - Cancel discharge/end visit |
A14 |
ADT/ACK - Pending admit |
A15 |
ADT/ACK - Pending transfer |
A16 |
ADT/ACK - Pending discharge |
A17 |
ADT/ACK - Swap patients |
A18 |
ADT/ACK - Merge patient information |
A19 |
QRY/ACK - Patient query |
A20 |
ADT/ACK - Bed status update |
A21 |
ADT/ACK - Patient goes on a "leave of absence" |
A22 |
ADT/ACK - Patient returns from a "leave of absence" |
A23 |
ADT/ACK - Delete a patient record |
A24 |
ADT/ACK - Link patient information |
A25 |
ADT/ACK - Cancel pending discharge |
A26 |
ADT/ACK - Cancel pending transfer |
A27 |
ADT/ACK - Cancel pending admit |
A28 |
ADT/ACK - Add person information |
A29 |
ADT/ACK - Delete person information |
A30 |
ADT/ACK - Merge person information |
A31 |
ADT/ACK - Update person information |
A32 |
ADT/ACK - Cancel patient arriving - tracking |
A33 |
ADT/ACK - Cancel patient departing - tracking |
A34 |
ADT/ACK - Merge patient information - patient ID only |
A35 |
ADT/ACK - Merge patient information - account number only |
A36 |
ADT/ACK - Merge patient information - patient ID and account number |
A37 |
ADT/ACK - Unlink patient information |
A38 |
ADT/ACK - Cancel pre-admit |
A39 |
BAR/ACK - Change account on visit |
A40 |
BAR/ACK - Change patient ID and account on visit |
A41 |
ADT/ACK - Merge alternate patient ID only |
B01 |
PPR/ACK - Patient problem |
C01 |
CRM - Register a patient on a clinical trial |
C02 |
CRM - Cancel a patient registration on clinical trial (for clerical mistakes only) |
C03 |
CRM - Correct/update registration information |
C04 |
CRM - Patient has gone off a clinical trial |
C05 |
CRM - Patient enters phase of clinical trial |
C06 |
CRM - Cancel patient entering a phase (clerical mistake) |
C07 |
CRM - Correct/update phase information |
C08 |
CRM - Patient has gone off phase of clinical trial |
C09 |
CSU - Automated time intervals for reporting, like monthly |
C10 |
CSU - Patient completes the clinical trial |
C11 |
CSU - Patient completes a phase of the clinical trial |
C12 |
CSU - Update/correction of patient order/result information |
G01 |
PGL/ACK - Patient goal |
I01 |
RQI/RPI - Request for insurance information |
I02 |
RQI/RPL - Request/receipt of patient selection display list |
I03 |
RQI/RPR - Request/receipt of patient selection list |
I04 |
RQD/RPI - Request for patient demographic data |
I05 |
RQC/RCI - Request for patient clinical information |
I06 |
RQC/RCL - Request/receipt of clinical data listing |
I07 |
PIN/ACK - Unsolicited insurance information |
I08 |
RQA/RPA - Request for treatment authorization information |
I09 |
RQA/RPA - Request for modification to an authorization |
I10 |
RQA/RPA - Request for resubmission of an authorization |
I11 |
RQA/RPA - Request for cancellation of an authorization |
I12 |
REF/RRI - Patient referral |
I13 |
REF/RRI - Modify patient referral |
I14 |
REF/RRI - Cancel patient referral |
I15 |
REF/RRI - Request patient referral status |
M01 |
MFN/MFK - Master file not otherwise specified (for backward compatibility only) |
M02 |
MFN/MFK - Master file - Staff Practioner |
M03 |
MFN/MFK - Master file - Test/Observation |
varies |
MFQ/MFR - Master files query (use event same as asking for e.g., M05 - location) |
M04 |
MFD/ACK - Master files delayed application acknowledgement |
M05 |
MFN/MFK - Patient location master file |
M06 |
MFN/MFK - Charge description master file |
M07 |
MFN/MFK - Clinical study with phases and schedules master file |
M08 |
MFN/MFK - Clinical study without phases but with schedules master file |
O01 |
ORM - Order message (also RDE, RDS, RGV, RAS) |
O02 |
ORR - Order response (also RRE, RRD, RRG, RRA) |
PAC |
PAC - PACS object status tracking (outgoing message from Healthline PACS ) |
P01 |
BAR/ACK - Add and update patient account |
P02 |
BAR/ACK - Purge patient account |
P03 |
DFT/ACK - Post detail financial transaction |
P04 |
QRY/DSP - Generate bill and A/R statements |
P05 |
BAR/ACK - Update account |
P06 |
BAR/ACK - End account |
P07 |
PEX - Unsolicited initial individual product experience report |
P08 |
PEX - Unsolicited update individual product experience report |
P09 |
SUR - Summary product experience report |
PC1 |
PPR - PC/ Problem Add |
PC2 |
PPR - PC/ Problem Update |
PC3 |
PPR - PC/ Problem Delete |
PC4 |
PRQ - PC/ Problem Query |
PC5 |
PRR - PC/ Problem Response |
PC6 |
PGL - PC/ Goal Add |
PC7 |
PGL - PC/ Goal Update |
PC8 |
PGL - PC/ Goal Delete |
PC9 |
PGQ - PC/ Goal Query |
PCA |
PGR - PC/ Goal Response |
PCB |
PPP - PC/ Pathway (Problem-Oriented) Add |
PCC |
PPP - PC/ Pathway (Problem-Oriented) Update |
PCD |
PPP - PC/ Pathway (Problem-Oriented) Delete |
PCE |
PTQ - PC/ Pathway (Problem-Oriented) Query |
PCF |
PTR - PC/ Pathway (Problem-Oriented) Query Response |
PCG |
PPG - PC/ Pathway (Goal-Oriented) Add |
PCH |
PPG - PC/ Pathway (Goal-Oriented) Update |
PCJ |
PPG - PC/ Pathway (Goal-Oriented) Delete |
PCK |
PTU - PC/ Pathway (Goal-Oriented) Query |
PCL |
PTV - PC/ Pathway (Goal-Oriented) Query Response |
Q01 |
QRY/DSR - Query sent for immediate response |
Q02 |
QRY/ACK - Query sent for deferred response |
Q03 |
DSR/ACK - Deferred response to a query |
Q05 |
UDM/ACK - Unsolicited display update |
R01 |
ORU/ACK - Unsolicited transmission of an observation |
R02 |
QRY - Query for results of observation |
R03 |
Display-oriented results, query/unsol. update (for backward compatibility only) |
R04 |
ORF - Response to query; transmission of requested observation |
RAR |
RAR - Pharmacy administration information query response |
RDR |
RDR - Pharmacy dispense information query response |
RER |
RER - Pharmacy encoded order information query response |
RGR |
RGR - Pharmacy dose information query response |
ROR |
ROR - Pharmacy prescription order query response |
S01 |
SRM/SRR - Request new appointment booking |
S02 |
SRM/SRR - Request appointment rescheduling |
S03 |
SRM/SRR - Request appointment modification |
S04 |
SRM/SRR - Request appointment cancellation |
S05 |
SRM/SRR - Request appointment discontinuation |
S06 |
SRM/SRR - Request appointment deletion |
S07 |
SRM/SRR - Request addition of service/resource on appointment |
S08 |
SRM/SRR - Request modification of service/resource on appointment |
S09 |
SRM/SRR - Request cancellation of servic/resource on appointment |
S10 |
SRM/SRR - Request discontinuation of servic/resource on appointment |
S11 |
SRM/SRR - Request deletion of servic/resource on appointment |
S12 |
SIU/ACK - Notification of new appointment booking |
S13 |
SIU/ACK - Notification of appointment rescheduling |
S14 |
SIU/ACK - Notification of appointment modification |
S15 |
SIU/ACK - Notification of appointment cancellation |
S16 |
SIU/ACK - Notification of appointment discontinuation |
S17 |
SIU/ACK - Notification of appointment deletion |
S18 |
SIU/ACK - Notification of addition of service/resource on appointment |
S19 |
SIU/ACK - Notification of modification of service/resource on appointment |
S20 |
SIU/ACK - Notification of cancellation of service/resource on appointment |
S21 |
SIU/ACK - Notification of discontinuation of service/resource on appointment |
S22 |
SIU/ACK - Notification of deletion of service/resource on appointment |
S23 |
SIU/ACK - Notification of blocked schedule time slot(s) |
S24 |
SIU/ACK - Notification of open ("unblocked") schedule time slot(s) |
S25 |
SQM/SQR - Query schedule information |
T01 |
MDM/ACK - Original document notification |
T02 |
MDM/ACK - Original document notification and content |
T03 |
MDM/ACK - Document status change notification |
T04 |
MDM/ACK - Document status change notification and content |
T05 |
MDM/ACK - Document addendum notification |
T06 |
MDM/ACK - Document addendum notification and content |
T07 |
MDM/ACK - Document edit notification |
T08 |
MDM/ACK - Document edit notification and content |
T09 |
MDM/ACK - Document replacement notification |
T10 |
MDM/ACK - Document replacement notification and content |
T11 |
MDM/ACK - Document cancel notification |
T12 |
QRY/DOC - Document query |
V01 |
VXQ - Query for vaccination record |
V02 |
VXX - Response to vaccination query returning multiple PID matches |
V03 |
VXR - Vaccination record response |
V04 |
VXU - Unsolicited vaccination record update |
W01 |
ORU - Waveform result, unsolicited transmission of requested information |
W02 |
QRF - Waveform result, response to query |
X01 |
PEX - Product experience |
| VALUE | DESCRIPTION |
|---|---|
E |
Emergency |
I |
Inpatient |
O |
Outpatient |
P |
Preadmit |
R |
Recurring Patient |
B |
Obstetrics |
| VALUE | DESCRIPTION |
|---|---|
A |
Accident |
E |
Emergency |
L |
Labor and Delivery |
R |
Routine |
TABLE 0008 - ACKNOWLEDGEMENT CODE
| VALUE | DESCRIPTION |
|---|---|
| AA | APPLICATION ACCEPT |
| AE | APPLICATION ERROR |
| AR | APPLICATION REJECT |
| CA | COMMIT ACCEPT |
| CE | COMMIT ERROR |
| CR | COMMIT REJECT |
TABLE 0009 - AMBULATORY STATUS
| VALUE | DESCRIPTION |
|---|---|
A0 |
No functional limitations |
A1 |
Ambulates with assistive device |
A2 |
Wheelchair/stretcher bound |
A3 |
Comatose; non-responsive |
A4 |
Disoriented |
A5 |
Vision impaired |
A6 |
Hearing impaired |
A7 |
Speech impaired |
A8 |
Non-English speaking |
A9 |
Functional level unknown |
B1 |
Oxygen Therapy |
B2 |
Special equipment (tubes, IVs, catheters) |
B3 |
Amputee |
B4 |
Mastectomy |
B5 |
Paraplegic |
B6 |
Pregnant |
| VALUE | DESCRIPTION |
|---|---|
A |
Some, but not all, results available |
CA |
Order was canceled |
CM |
Order is completed |
DC |
Order was discontinued |
ER |
Error, order not found |
HD |
Order is on hold |
IP |
In process, unspecified |
RP |
Order has been replaced |
SC |
In process, scheduled |
| VALUE | DESCRIPTION |
|---|---|
01 |
Patient request |
02 |
Physician order |
03 |
Census management |
TABLE 0065 - SPECIMEN ACTION CODE
VALUE |
DESCRIPTION |
|---|---|
A |
Add ordered tests to the existing specimen |
G |
Generated order; reflex order |
L |
Lab to obtain specimen from patient |
O |
Specimen obtained by service other than Lab |
P |
Pending specimen; Order sent prior to delivery |
R |
Revised order |
S |
Schedule the tests specified below |
| Value | Description | Value | Description | Value | Description |
| ABS | Abcess | FLU | Body fluid, unsp | SER | Serum |
| AMN | Amniotic fluid | GAS | Gas | SKN | Skin |
| ASP | Aspirate | GAST | Gastric fluid/contents | SKM | Skeletal muscle |
| BPH | Basophils | GEN | Genital | SPRM | Spermatozoa |
| BIFL | Bile fluid | GENC | Genital cervix | SPT | Sputum |
| BLDA | Blood arterial | GENL | Genital lochia | SPTC | Sputum - coughed |
| BBL | Blood bag | GENV | Genital vaginal | SPTT | Sputum - tracheal aspirate |
| BLDC | Blood capillary | HAR | Hair | STON | Stone (use CALC) |
| BPU | Blood product unit | IHG | Inhaled Gas | STL | Stool = Fecal |
| BLDV | Blood venous | IT | Intubation tube | SWT | Sweat |
| BON | Bone | ISLT | Isolate | SNV | Synovial fluid (Joint fluid) |
| BRTH | Breath (use EXHLD) | LAM | Lamella | TEAR | Tears |
| BRO | Bronchial | WBC | Leukocytes | THRT | Throat |
| BRN | Burn | LN | Line | THRB | Thrombocyte (platelet) |
| CALC | Calculus (=Stone) | LNA | Line arterial | TISS | Tissue |
| CDM | Cardiac muscle | LNV | Line venous | TISG | Tissue gall bladder |
| CNL | Cannula | LIQ | Liquid NOS | TLGI | Tissue large intestine |
| CTP | Catheter tip | LYM | Lymphocytes | TLNG | Tissue lung |
| CSF | Cerebral spinal fluid | MAC | Macrophages | TISPL | Tissue placenta |
| CVM | Cervical mucus | MAR | Marrow | TSMI | Tissue small intestine |
| CVX | Cervix | MEC | Meconium | TISU | Tissue ulcer |
| COL | Colostrum | MBLD | Menstrual blood | TUB | Tube NOS |
| CBLD | Cord blood | MLK | Milk | ULC | Ulcer |
| CNJT | Conjunctiva | MILK | Breast milk | UMB | Umbilical blood |
| CUR | Curettage | NAIL | Nail | UMED | Unknown medicine |
| CYST | Cyst | NOS | Nose (nasal passage) | URTH | Urethra |
| DIAF | Dialysis fluid | ORH | Other | UR | Urine |
| DOSE | Dose med or substance | PAFL | Pancreatic fluid | URC | Urine clean catch |
| DRN | Drain | PAT | Patient | URT | Urine catheter |
| DUFL | Duodenal fluid | PRT | Peritoneal fluid /ascites | URNS | Urine sediment |
| EAR | Ear | PLC | Placenta | USUB | Unknown substance |
| EARW | Ear wax (cerumen) | PLAS | Plasma | VOM | Vomitus |
| ELT | Electrode | PLB | Plasma bag | BLD | Whole blood |
| ENDC | Endocardium | PLR | Pleural fluid (thoracentesis fld) | BDY | Whole body |
| ENDM | Endometrium | PMN | Polymorphonuclear neutrophils | WAT | Water |
| EOS | Eosinophils | PPP | Patelet poor plasma | WICK | Wick |
| RBC | Erythrocytes | PRP | Platelet rich plasma | WND | Wound |
| EYE | Eye | PUS | Pus | WNDA | Wound abscess |
| EXHLD | Exhaled gas (=breath) | RT | Route of medicine | WNDE | Wound exudate |
| FIB | Fibroblasts | SAL | Saliva | WNDD | Wound drainage |
| FLT | Filter | SEM | Seminal fluid | XXX | To be specified in another part of the message |
| FIST | Fistula |
TABLE 0074 - DIAGNOSTIC SERVICE SECTION ID
Value |
Description | Value |
Description |
AU |
Audiology | OUS |
OB Ultrasound |
BG |
Blood gases | OT |
Occupational Therapy |
BLB |
Blood bank | OTH |
Other |
CUS |
Cardiac Ultrasound | OSL |
Outside Lab |
CTH |
Cardiac catheterization | PHR |
Pharmacy |
CT |
CAT scan | PT |
Physical Therapy |
CH |
Chemistry | PHY |
Physician (Hx. Dx, admission note, etc.l) |
CP |
Cytopathology | PF |
Pulmonary function |
EC |
Electrocardiac (e.g., EKG, EEC, Holter) | RAD |
Radiology |
EN |
Electroneuro (EEG, EMG,EP,PSG) | RX |
Radiograph |
HM |
Hematology | RUS |
Radiology ultrasound |
ICU |
Bedside ICU Monitoring | RC |
Respiratory Care (therapy) |
IMM |
Immunology | RT |
Radiation therapy |
LAB |
Laboratory | SR |
Serology |
MB |
Microbiology | SP |
Surgidal Pathology |
MCB |
Mycobacteriology | TX |
Toxicology |
MYC |
Mycology | VUS |
Vascular Ultrasound |
NMS |
Nuclear medicine scan | VR |
Virology |
NMR |
Nuclear magnetic resonance | XRC |
Cineradiograph |
NRS |
Nursing service measures |
VALUE |
DESCRIPTION |
|---|---|
ACK |
General acknowledgment message |
ADR |
Patient query response |
ADT |
ADT message |
ARD |
Ancillary RPT (display) |
BAR |
Add/change billing account |
CNQ |
Cancel query |
CSU |
Unsolicited clinical study data |
DFT |
Detail financial transaction |
DSR |
Display response |
EDR |
Enhanced display response |
ERP |
Event replay response |
ERQ |
Event replay query |
EQL |
Embedded query language query |
MCF |
Delayed acknowledgment |
MDM |
Documentation message |
MFN |
Master files notification |
MFK |
Master files application acknowledgement |
MFD |
Master files delayed application acknowledgement |
MFQ |
Master files query |
MFR |
Master files query response |
ORF |
Observ. result/record response |
ORM |
Order message |
ORR |
Order acknowledgement message |
ORU |
Observ result/unsolicited |
OSQ |
Order status query |
OSR |
Order status response |
QRY |
Query, original Mode |
PAC |
Healthline PACS Interface module |
PEX |
Product experience |
PGL |
Patient goal |
PGR |
Patient goal response |
PGQ |
Patient goal query |
PPG |
Patient pathway (goal-oriented) |
PPP |
Patient pathway (problem-oriented) |
PPR |
Patient problem |
PRQ |
Patient care problem query |
PRR |
Patient problem response |
PTQ |
Patient pathway (problem-oriented) query |
PTR |
Patient pathway (problem-oriented) response |
PTU |
Patient pathway (goal-oriented) query |
PTV |
Patient pathway (goal-oriented) response |
PIN |
Patient information |
RAR |
Pharmacy administration information |
RAS |
Pharmacy administration message |
RCI |
Return clinical information |
RCL |
Return clinical list |
RDE |
Pharmacy encoded order message |
RDR |
Pharmacy dispense information |
RDS |
Pharmacy dispense message |
RGV |
Pharmacy give message |
RGR |
Pharmacy dose information |
REF |
Patient referral |
RER |
Pharmacy encoded order information |
ROD |
Request pateint demographics |
ROR |
Pharmacy prescription order response |
RPA |
Return patient authorization |
RPI |
Return patient information |
RPL |
Return patient display list |
RPR |
Return patient list |
RQA |
Request patient authorization |
RQC |
Request clinical information |
RQI |
Request patient information |
RQP |
Request patient demographics |
RRA |
Pharmacy administration acknowledgment |
RRD |
Pharmacy dispense acknowledgment |
RRE |
Pharmacy encoded order acknowledgment |
RRG |
Pharmacy give acknowledgment |
RRI |
Return patient referral |
SIU |
Schedule information unsolicited |
SPR |
Stored procedure request |
SQM |
Schedule query |
SQR |
Schedule query response |
CRM |
Clinical study registration |
SRM |
Schedule request |
SRR |
Scheduled request response |
SUR |
Summary product experience report |
TBR |
Tabular response |
UDM |
Unsolicited display message |
VTQ |
Virtual table query |
VXQ |
Query for vaccination record |
VXX |
Vaccination query response with multiple PID matches |
VXR |
Vaccination query record response |
VXU |
Unsolicited vaccination record update |
| VALUE | DESCRIPTION |
|---|---|
L |
Below low normal |
H |
Above high normal |
LL |
Below lower panic limits |
HH |
Above upper panic limits |
< |
Below absolute low-off instrument scale |
> |
Above absolute high-off instrument scale |
N |
Normal (applies to non-numeric results) |
A |
Abnormal (applies to non-numeric results) |
AA |
Very abnormal (applies to non-numeric units, analagous to panic limits for numeric units) |
null |
No range defined, or normal ranges don't apply |
U |
Significant change up |
D |
Significant change down |
B |
Better--use when direction not relevant |
W |
Worse--use when direction not relevant |
| For microbiology sensitivities only: | |
S |
Sensitive |
R |
Resistant |
I |
Intermediate |
MS |
Moderately sensitive |
VS |
Very sensitive |
TABLE 0085 - OBSERVATION RESULTS STATUS CODE INTERPRETATION
| VALUE | DESCRIPTION |
|---|---|
C |
Record coming over is a correction and thus replaces a final result |
D |
Deletes the OBX record |
F |
Final results; Can only be changed with a corrected result. |
I |
Specimen in lab; results pending |
P |
Preliminary results |
R |
Results entered -- not verified |
S |
Partial results |
X |
Results cannot be obtained for this observation |
U |
Results status change to Final. without retransmitting results already sent as ‘preliminary.’ E.g., radiology changes status from preliminary to final |
| VALUE | DESCRIPTION |
|---|---|
| D | DEBUGGING |
| P | PRODUCTION |
| T | TRAINING |
| VALUE | DESCRIPTION |
|---|---|
| 2.0 | RELEASE 2.0 SEPTEMBER 1988 |
| 2.1 | RELEASE 2.1 MARCH 1990 |
| 2.2 | RELEASE 2.2 DECEMBER 1994 |
| 2.3 | RELEASE 2.3 JULY 1996 |
TABLE 0105 - SOURCE OF COMMENT
| VALUE | DESCRIPTION |
|---|---|
L |
Ancillary (filler) department is source of comment |
P |
Orderer (placer) is source of comment |
O |
Other system is source of comment |
| VALUE | DESCRIPTION |
|---|---|
C |
Closed |
H |
Housekeeping |
O |
Occupied |
U |
Unoccupied |
K |
Contaminated |
I |
Isolated |
TABLE 0119 - ORDER CONTROL CODES
| VALUE | DESCRIPTION |
|---|---|
| NW | New order |
| OK | Order accepted & OK |
| UA | Unable to Accept Order |
| CA | Cancel order request |
| OC | Order canceled |
| CR | Canceled as requested |
| UC | Unable to cancel |
| DC | Discontinue order request |
| OD | Order discontinued |
| DR | Discontinued as requested |
| UD | Unable to discontinue |
| HD | Hold order request |
| OH | Order held |
| UH | Unable to put on hold |
| HR | On hold as requested |
| RL | Release previous hold |
| OE | Order released |
| OR | Released as requested |
| UR | Unable to release |
| RP | Order replace request |
| RU | Replaced unsolicited |
| RO | Replacement order |
| RQ | Replaced as requested |
| UM | Unable to replace |
| PA | Parent order |
| CH | Child order |
| XO | Change order request |
| XX | Order changed, unsol. |
| UX | Unable to change |
| XR | Changed as requested |
| DE | Data errors |
| RE | Observations to follow |
| RR | Request received |
| SR | Response to send order status request |
| SS | Send order status request |
| SC | Status changed |
| SN | Send order number |
| NA | Number assigned |
| CN | Combined result |
| RF | Refill order request |
| AF | Order refill request approval |
| DF | Order refill request denied |
| FU | Order refilled, unsolicited |
| OF | Order refilled as requested |
| UF | Unable to refill |
| VALUE | DESCRIPTION |
|---|---|
E |
Report exceptions only |
R |
Same as E, also Replacement and Parent-Child |
D |
Same as R, also other associated segments |
F |
Same as D, plus confirmations explicitly |
N |
Only the MSA segment is returned |
Value |
Description | Value |
Description |
O |
Order received; specimen not yet received | R |
Results stored; not yet verified |
I |
No results available; specimen received, procedure incomplete | F |
Final results; results stored and verified. Can only be changed with a corrected result. |
S |
No results available; procedure scheduled, but not done | X |
No results available; Order canceled. |
A |
Some, but not all, results available | Y |
No order on record for this test. (Used only on queries) |
P |
Preliminary: A verified early result is available, final results not yet obtained | Z |
No record of this patient. (Used only on queries) |
C |
Correction to results |
TABLE 0124 - TRANSPORTATION MODE
| VALUE | DESCRIPTION |
|---|---|
CART |
Cart - patient travels on cart or gurney |
PORT |
The examining device goes to patient's location |
WALK |
Patient walks to diagnostic service |
WHLC |
Wheelchair |
| VALUE | DESCRIPTION |
|---|---|
AD |
Address |
CE |
Coded Entry |
CF |
Coded Element With Formatted Values |
CK |
Composite ID With Check Digit |
CN |
Composite ID And Name |
CP |
Composite Price |
CX |
Extended Composite ID With Check Digit |
DT |
Date |
ED |
Encapsulated Data |
FT |
Formatted Text (Display) |
MO |
Money |
NM |
Numeric |
PN |
Person Name |
RP |
Reference Pointer |
SN |
Structured Numeric |
ST |
String Data. |
TM |
Time |
TN |
Telephone Number |
TS |
Time Stamp (Date & Time) |
TX |
Text Data (Display) |
XAD |
Extended Address |
XCN |
Extended Composite Name And Number For Persons |
XON |
Extended Composite Name And Number For Organizations |
XPN |
Extended Person Number |
XTN |
Extended Telecommunications Number |
TABLE 0155 - ACCEPT/APPLICATION ACKNOWLEDGEMENT CONDITIONS
| VALUE | DESCRIPTION |
|---|---|
| AL | ALWAYS |
| ER | ERROR/REJECT CONDITIONS ONLY |
| NE | NEVER |
| SU | SUCCESSFUL COMPLETION ONLY |
| VALUE | DESCRIPTION |
|---|---|
| A | ARCHIVE |
| R | RESTORE FROM ARCHIVE |
| I | INITIAL LOAD |
| NOT PRESENT | NOT PRESENT(DEFAULT MEANING CURRENT) |
TABLE 0211 - ALTERNATE CHARACTER SETS
| VALUE | DESCRIPTION |
|---|---|
ASCII |
The printable 7-bit ASCII character set . (This is the default if this field is omitted) |
8859/1 |
The printable characters from the ISO 8859/1 Character set |
8859/2 |
The printable characters from the ISO 8859/2 Character set |
8859/3 |
The printable characters from the ISO 8859/3 Character set |
8859/4 |
The printable characters from the ISO 8859/4 Character set |
8859/5 |
The printable characters from the ISO 8859/5 Character set |
8859/6 |
The printable characters from the ISO 8859/6 Character set |
8859/7 |
The printable characters from the ISO 8859/7 Character set |
8859/8 |
The printable characters from the ISO 8859/8 Character set |
8859/9 |
The printable characters from the ISO 8859/9 Character set |
JAS2020 |
A subset of ISO2020 used for most Kanjii transmissions |
UNICODE |
<needs document reference> |
JIS X 0202 |
ISO 2022 with escape sequences for Kanjii |
JIS X 0201-1976 |
Code for Information Exchange |
JIS X 0208-1990 |
Code for the Japanese Graphic Character set for information interchange |
JIS X 0212-1990 |
Code of the supplementary Japanese Graphic Character set for information interchange |
| VALUE | DESCRIPTION |
|---|---|
PATIENT |
Patient record |
VISIT |
Visit number |
ATTEND |
Attendance |
ACCESSION |
Filler Order , admission, billing number record (Above a Study in hireachy) |
STUDY |
Study record |
EXAM |
Exam record |
SERIES |
Series record |
IMAGE |
Image record |
TABLE 9002 - PACS OBJECT STATUS
| VALUE | DESCRIPTION |
|---|---|
1 |
Objects has been registered from modality |
2 |
Objects have been verified (QA'd) |
4 |
Objects have been Reported |
8 |
Objects have been Archived |
TABLE 9003 - PRIMARY OBJECT INTERPRETER
| VALUE | DESCRIPTION |
|---|---|
TECH |
TECHNICIAN |
CONS |
CONSULTANT RADIOLOGIST |
CLIN |
CLINICIAN (NON RADIOLOGIST ) OR PHYSICIAN |
| Data Type Category/ Datatype | Data Type Name | Notes/Format |
| String | ||
ST |
String | |
TX |
Text data | |
FT |
Formatted text | |
| Numeric | ||
CQ |
Composite quantity with units | <quantity (NM)> ^ <units (CE)> |
MO |
Money | <quantity (NM)> ^ <denomination (ID)> |
NM |
Numeric | |
SI |
Sequence ID | |
SN |
Structured numeric | <comparator> ^ <num1 (NM)> ^ <separator/suffix> ^ <num2 (NM)> |
| Identifier | ||
ID |
Coded values for HL7 tables | |
IS |
Coded value for user-defined tables | |
HD |
Hierarchic designator | <application identifier
(IS)> ^ <universal ID (ST)> ^ <universal ID type (ID)> Used only as part of EI and other data types. |
EI |
Entity identifier | <entity identifier (ST)> ^ <assigning authority (HD)> |
RP |
Reference pointer | <pointer (ST) > ^ < application ID (HD)> ^ <main type (ID)> & <subtype (ID)> |
PL |
Patient location | <point of care (IS )> ^ <room (IS )> ^ <bed (IS)> ^ <facility (HD)> ^ < location status (IS )> ^ <patient location type (IS)> ^ <building (IS )> ^ <floor (IS )> |
PT |
Processing type | <processing ID (ID)> ^ <processing mode (ID)> |
| Date/Time | ||
DT |
Date | YYYY[MM[DD]] |
TM |
Time | HH[MM[SS[.S[S[S[S]]]]]][+/-ZZZZ] |
TS |
Time stamp | YYYY[MM[DD[HHMM[SS[.S[S[S[S]]]]]]]][+/-ZZZZ] ^ <degree of precision> |
| Code Values | ||
CE |
Coded element | <identifier (ID)> ^ <text (ST)> ^ <name of coding system (ST)> ^ <alternate identifier (ID)> ^ <alternate text (ST)> ^ <name of alternate coding system (ST)> |
CF |
Coded element with formatted values | <identifier (ID)> ^ <formatted text (FT)> ^ <name of coding system (ST)>^<alternate identifier (ID)> ^ <alternate formatted text (FT)> ^ <name of alternate coding system (ST)> |
CK |
Composite ID with check digit | <ID number (NM)> ^ <check digit (NM)> ^ <code identifying the check digit scheme employed (ID)> ^ < assigning authority (HD)> |
CN |
Composite ID number and name | <ID number (ST)> ^ <family name (ST)> ^ <given name (ST)> ^ <middle initial or name (ST)> ^ <suffix (e.g., JR or III) (ST)> ^ <prefix (e.g., DR) (ST)> ^ <degree (e.g., MD) (ST)> ^ <source table (IS)> ^ <assigning authority (HD)> |
CX |
Extended composite ID with check digit | <ID (ST)> ^ <check digit (ST)> ^ <code identifying the check digit scheme employed (ID)> ^ < assigning authority (HD) )> ^ <identifier type code (IS)> ^ < assigning facility (HD) |
XCN |
Extended composite ID number and name | In version 2.3, use instead of the CN data type. <ID number (ST)> ^<family name (ST)> ^ <given name (ST)> ^ <middle initial or name (ST)> ^ <suffix (e.g., JR or III) (ST)> ^ <prefix (e.g., DR) (ST)> ^ <degree (e.g., MD) (ST)> ^ <source table (IS)> ^<assigning authority (HD)> ^<name type code (ID)> ^<identifier check digit (ST)> ^ <code identifying the check digit scheme employed (ID)> ^ <identifier type code (IS)> ^ <assigning facility (HD)> |
| Generic | ||
CM |
Composite | No new CM’s in version 2.3. |
| Demographics | ||
AD |
Address | <street address (ST)> ^ < other designation (ST)> ^ <city (ST)> ^ <state or province (ST)> ^ <zip or postal code (ST)> ^ <country (ID)> ^ <address type (ID)> ^ <other geographic designation (ST)> |
PN |
Person name | <family name (ST)> ^ <given name (ST)> ^ <middle initial or name (ST)> ^ <suffix (e.g., JR or III) (ST)> ^ <prefix (e.g., DR) (ST)> ^ <degree (e.g., MD) (ST)> |
TN |
Telephone number | [NN] [(999)]999-9999[X99999][B99999][C any text] |
XAD |
Extended address | In version 2.3, replaces the AD data type. <street address (ST)> ^ <other designation (ST)> ^ <city (ST)> ^ <state or province (ST)> ^ <zip or postal code (ST)> ^ <country (ID)> ^ < address type (ID)> ^ <other geographic designation (ST)>^ <county/parish code (IS)> ^ <census tract (IS)> |
XPN |
Extended person name | In version 2.3, replaces the PN data type. <family name (ST)> ^ <given name (ST)> ^ <middle initial or name (ST)> ^ <suffix (e.g., JR or III) (ST)> ^ <prefix (e.g., DR) (ST)> ^ <degree (e.g., MD) (ST)>^ <name type code (ID) > |
XON |
Extended composite name and ID number for organizations | <organization name (ST)>^ <organization name type code (IS)> ^<ID number (NM)> ^ <check digit (NM)> ^ <code identifying the check digit scheme employed (ID)> ^ <assigning authority (HD)> ^ <identifier type code (IS)> ^ <assigning facility ID (HD)> |
XTN |
Extended telecommunications number | In version 2.3, replaces the TN data type. [NNN] [(999)]999-9999 [X99999] [B99999] [C any text] ^<telecommunication use code (ID)> ^ <telecommunication equipment type (ID)>^ <email address (ST)> ^ <country code (NM)> ^ <area/city code (NM)> ^ <phone number (NM)> ^ <extension (NM)> ^ <any text (ST)> |
| Specialty | ||
CD |
Channel definition | <channel identifier (*)> ^ <electrode names (*) > ^ <channel sensitivity/units (*) > ^ <calibration parameters (*)> ^ <sampling frequency (NM)> ^ <minimum/maximum data values (*)> |
ED |
Encapsulated data | Supports ASCII MIME-encoding of binary data. <source application (HD) > ^ <type of data (<main type (ID)> & <subtype (ID)> ^ <encoding (ID)>^<data (ST)> |
MA |
Multiplexed array | <sample 1 from channel 1 (NM)> ^ <sample 1 from channel 2 (NM)> ^ <sample 1 from channel 3 (NM)> ...~<sample 2 from channel 1 (NM)> ^ <sample 2 from channel 2 (NM)> ^ <sample 2 from channel 3 (NM)> ...~ |
NA |
Numeric array | <value1 (NM)> ^ <value2 (NM)> ^ <value3 (NM)> ^ <value4 (NM)> ^ ... |
CP |
Composite price | In version 2.3, replaces the MO data type. <price (MO)> ^ <price type (ID)> ^ <from value (NM)> ^ <to value (NM)> ^ <range units (CE)> ^ <range type (ID)> |
TQ |
Timing/quantity | <quantity (CQ)> ^ <interval (*)> ^ <duration (*)> ^ <start date/time (TS)> ^ <end date/time (TS)> ^ <priority (ID)> ^ <condition (ST)> ^ <text (TX)> ^ <conjunction (ID)> ^ <order sequencing> |
Additional Composites carried forward from previous versions of HL7
| TYPE | NAME | TABLE |
|---|---|---|
| ST | COMPONENT 1 | |
| ST | COMPONENT 2 | |
| ST | COMPONENT 3 | |
| ST | COMPONENT 4 | |
| ST | COMPONENT 5 | |
| ST | COMPONENT 6 | |
| ST | COMPONENT 7 | |
| ST | COMPONENT 8 |
| TYPE | NAME | TABLE |
|---|---|---|
| ST | SEGMENT ID | |
| NM | SEQUENCE | |
| NM | FIELD POSITION | |
| CE | CODE IDENTIFYING ERROR | |
| ST | FULL PATH |
| TYPE | NAME | TABLE |
|---|---|---|
| ID | NURSE UNIT | |
| ID | ROOM | |
| ID | BED | |
| ID | FACILITY ID | |
| ID | BED STATUS |
| TYPE | NAME | TABLE |
|---|---|---|
| ID | MESSAGE ID | 76 |
| ID | EVENT TYPE | 3 |