1 Order Implementation Guide 2003-05-27
1 Order Implementation Guide 2003-05-27
Table of Contents
TABLE OF CONTENTS ............................................................................................................................. 2
REVISION HISTORY................................................................................................................................. 4
CREDITS ...................................................................................................................................................... 4
INTRODUCTION ........................................................................................................................................ 4
SCOPE........................................................................................................................................................... 5
DEFINITIONS.............................................................................................................................................. 5
CONVENTIONS .......................................................................................................................................... 6
MESSAGE SEGMENT STRUCTURE................................................................................................................ 6
MESSAGE SCHEMA ..................................................................................................................................... 6
MESSAGE EXAMPLE ................................................................................................................................... 6
SEGMENT DEFINITIONS .............................................................................................................................. 7
Segment Attribute Table Header Definitions .................................................................................................... 7
USE CASES .................................................................................................................................................. 8
CLINICAL SCENARIO................................................................................................................................... 8
DIAGNOSTIC TESTING ................................................................................................................................. 9
Message Segment Structure .................................................................................................................. 9
Message Schema ................................................................................................................................... 9
Message Example................................................................................................................................ 10
PHARMACY............................................................................................................................................... 10
Message Segment Structure ................................................................................................................ 11
Message Schema ................................................................................................................................. 12
Message Example................................................................................................................................ 12
SUPPLY ..................................................................................................................................................... 13
Message Segment Structure ................................................................................................................ 13
Message Schema ................................................................................................................................. 13
Message Example................................................................................................................................ 14
SEGMENT DEFINITIONS....................................................................................................................... 14
MSH SEGMENT – MESSAGE HEADER ....................................................................................................... 15
MSH – Message Header Segment attributes ................................................................................................... 15
MSH field definitions .......................................................................................................................... 16
MSH-4 Sending facility (HD) 00004 ............................................................................................................ 16
PID SEGMENT - PATIENT IDENTIFICATION ............................................................................................... 16
AL1 SEGMENT – ALLERGY INFORMATION ............................................................................................... 17
AL1 – Allergy Information Segment attributes............................................................................................... 17
AL1 field definitions............................................................................................................................ 17
AL1-2 Allergy Type (IS) 00204................................................................................................................ 17
AL1-3 Allergy code/mnemonic/description (CE) 00205...................................................................... 17
ORC SEGMENT – COMMON ORDER .......................................................................................................... 17
RQD - REQUISITION DETAIL SEGMENT .................................................................................................... 18
RQD – Requisition Detail Segment attributes................................................................................................. 18
RQD field definitions .......................................................................................................................... 18
RQD-3 Item code - external (CE) 00277 .................................................................................................... 18
RQD-7 Dept. cost center (IS) 00281 ........................................................................................................... 18
RXO - PHARMACY/TREATMENT ORDER SEGMENT .................................................................................... 19
RXO – Pharmacy/treatment Order Segment attributes.................................................................................... 19
RXO field definitions........................................................................................................................... 20
5/28/2003 Page 2 of 30
Implementation Guide Laboratory, Pharmacy and Supply Orders HL7 v2.3.1
5/28/2003 Page 3 of 30
Implementation Guide Laboratory, Pharmacy and Supply Orders HL7 v2.3.1
Revision History
Credits
A working group (members are listed in the Appendix) convened by the CDC and
eHealth Foundation’s Public Private Collaboration created materials that formed the basis
for this implementation guide.
Introduction
There is a strong logical link between a clinician’s notions of what is wrong with a
patient and what is ordered to care for that patient. Even before results of test are
available, orders for them are often recorded in electronic systems. Other aspects of
medical care such as ventilator management might be determined or inferred from other
orders such as those for supplies or ancillary services. Because orders are one of the
earliest electronically available sources of information about episodes of medical care,
they may be a useful source of information for detecting the onset, increase, or spread of
a public health problem. For example:
5/28/2003 Page 4 of 30
Implementation Guide Laboratory, Pharmacy and Supply Orders HL7 v2.3.1
gasses, intubation
CNS infection lumbar puncture, CSF culture, blood culture
More specificity might be gained by combining orders, like chest X-ray PLUS sputum
culture, or by imposing age restrictions.
Scope
This guide does not stand alone – it should be read in conjunction with CDC’s
“Implementation Guide for Transmission of Laboratory-Based Reporting of Public
Health Reporting Information using Version 2.3.1 of the Health Level Seven (HL7)
Standard Protocol” and the HL7 Version 2.3.1 standard.
This guide focuses on diagnostic test or clinical observation orders, supplies and
pharmacy orders. Test orders could include a broad spectrum of diagnostic testing and
clinical observations such as vital signs, electrocardiograms, cultures and serology
depending on the institution’s processes. Which supplies are represented in messsages
will also be highly dependent on local processes.
In addition to surveillance applications of orders, public health may need to monitor use
of specific antibiotics or other medications used in either the inpatient or outpatient
setting. These applications may require more details about the order and the medication
administration process than surveillance. Tracking the administration of aspirin after
recognition of acute myocardial infarction in the inpatient setting for example, requires
messages that contain not only ordering but administration data. These uses are out of
scope for the current version of this implementation guide. HL7 is the NEDSS messaging
standard so this guide focuses exclusively on HL7 order messages. However, the NCPDP
standard is used for a large volume of outpatient prescription messaging.
Public health officials will specify which orders are needed for specific public health
purposes using LOINC codes, NDC (and later RxNORM) codes or ECRI UMDNS codes.
Orders that are not associated with a specific patient such as orders for supplies to
replenish unit or floor stock should not be sent to public health.
Definitions
Filler: (also Performer) the application responding to, i.e., performing, a request for
services (orders) or producing an observation. The filler can also originate requests for
services (new orders), add additional services to existing orders, replace existing orders,
put an order on hold, discontinue an order, release a held order, or cancel existing orders.
Order: a request for a service from one application to a second application. The second
application may in some cases be the same; i.e., an application is allowed to place orders
with itself.
5/28/2003 Page 5 of 30
Implementation Guide Laboratory, Pharmacy and Supply Orders HL7 v2.3.1
Order detail segment: one of several segments that can carry order information.
Examples are OBR and RXO. Future ancillary-specific segments may be defined in
subsequent releases of the Standard if they become necessary.
Placer: (also Requestor) the application or individual originating a request for services
(order).
Placer order group: a list of associated orders coming from a single location regarding a
single patient.
Conventions
In order to provide concrete guidance, each message use case will be presented in three
versions: as a message segment structure, message schema and message example.
Message Schema
This format describes how data elements within segments are valued, typically using
generic terms (e.g. date of birth, medical record number). It illustrates the content of the
message.
Message Example
This format provides a concrete example of individual data elements within the segments
of a message. It illustrates the formatting of individual data elements.
5/28/2003 Page 6 of 30
Implementation Guide Laboratory, Pharmacy and Supply Orders HL7 v2.3.1
[ OBX ] Observation
The generic order message in the table above represents a superset of all order messages.
It supports the several use cases including orders for
• diagnostic tests,
• medications, and
• supplies.
Segment Definitions
The Segment Attribute Table summarizes the field content of a specified segment. The
column headers for the Segment Attribute Table are described as follows:
5/28/2003 Page 7 of 30
Implementation Guide Laboratory, Pharmacy and Supply Orders HL7 v2.3.1
SEQ The sequence of the elements as they are numbered in the segment.
LEN The length of the element.
DT The data type of the element.
OPT Whether the field is required, optional, or conditional in a segment as defined by HL7 2.3.1.
These do not refer to requirements for reporting in the context of this guide. The designations
are:
R Required.
O Optional.
C Conditional on the trigger event or on some other field(s). The field definitions
following the segment attribute table should specify the algorithm that defines the
conditionality for the field.
X Not used with this trigger event.
B Left in for backward compatibility with previous versions of HL7. The field
definitions following the segment attribute table should denote the optionality of the
field for prior versions.
RP/# Indicates if element repeats. IF the number of repetitions is limited, the number of allowed
repetitions is given.
TBL# Specific table reference. Tables defined in HL7 v2.3.1 and used in this guide are listed in
Appendix B.
ITEM# HL7 unique item number for each element.
Element Name Descriptive name of element in the segment.
OPT for ELR Whether the field is required or ignored specifically in the context of this guide. The
designations are:
R Required.
I Ignored.
IMPLEMENTATION Addition comments related to the use of the field in the context of this guide.
COMMENTS
The field definitions following the Segment Attribute Table serve to clarify, extend or
constrain the meaning or intent of the field in the context of this guide. Not all fields
present in a segment will have accompanying narrative.
Use Cases
Clinical Scenario
In order to provide consistent examples, this guide uses the following common clinical
scenario: Michael Able presents at the emergency department at MyHospital with
symptoms of cough, fever and malaise. Dr M J Welby evaluates the patient and orders a
chest radiograph. Based on symptoms and the radiographic findings, Dr Welby
prescribes an initial dose of ciprofloxicin intravenously. The patient deteriorates and
requires tracheal intubation and mechanical ventilation. The respiratory therapist in the
emergency department records an order for a “ventilator” and “endotracheal tube #8” that
will allow MyHospital to generate a charge for the ventilator setup.
5/28/2003 Page 8 of 30
Implementation Guide Laboratory, Pharmacy and Supply Orders HL7 v2.3.1
Diagnostic testing
When a provider orders a diagnostic test, even without a provider order entry system,
there is usually an electronic order generated either in an institutional order management
system (entered by a clerk for example) or by the laboratory information system (entered
by laboratory personnel). This order may be available a long time before the actual result
for certain tests. For example, results from some cultures may require days to weeks to
become available. Diagnostic test orders may also provide information that diagnostic
tests have been ordered for which results are not electronically available. An order for a
chest radiograph in an environment without electronic access to radiology reports, for
example. Even in environments with a sophisticated radiology information system,
results may be delayed for days.
The General Order Message segment structure, above, is a subset of the ORM_O01
structure defined in HL7 v2.3.1 Chapter 4. This subset constitutes the minimum
necessary message structure to communicate an order for a diagnostic test in the context
of this Implementation Guide. Additional segments, as defined in HL7 v2.3.1, may be
present in the message, but are not required and are not detailed in this Implementation
Guide.
Message Schema
MSH|^~\&| sending application | sending facility |
receiving application ||||ORM^O01^ORM_O01| message
control id |P|2.3.1…<cr>
PID||| patient ids || patient name …<cr>
[{ AL1| set id | allergy type | allergen …<cr> }]
ORC| order control code | requestor’s order number |
processor’s order number ||||| transaction date-time |
enterer Id || ordering provider ID | enterer's location
…<cr>
5/28/2003 Page 9 of 30
Implementation Guide Laboratory, Pharmacy and Supply Orders HL7 v2.3.1
Message Example
The following message example represents the initial order in the clinical scenario
presented above. Specifically, a new order by Dr M J Welby (entered by ward clerk
Mary Gilbert) in the ER at MyHospital for a Portable Chest X-ray of Michael Able. In
this case there are no allergies communicated and only the requestor's order number is
available. Since this is a new order is being sent from the order management system to
the radiology system, no processor order number has been assigned.
MSH|^~\&|MyHospital|MyHospital^543876^CMS|LocalRadiology|||
|ORM^O01^ORM_O01|00001|P|2.3.1<cr>
PID|||1234321^^^MyHospital^MR||Able^Michael^D^^^^L<cr>
ORC|NW|0889436^MyHospital||||||20011001081234|A99887^Gilber
t^Mary^^^^^MyHospital||1234567^Welby^M^J^Jr^Dr^^MyHospit
al|ER<cr>
OBR|1|0889436^MyHospital||24632-2^Portable Chest^LN<cr>
Pharmacy
When a provider orders a medication, even without a provider order entry system, there is
usually an electronic order generated either in an institutional order management system
(entered by a clerk for example) or by the pharmacy system (entered by pharmacy
personnel). Depending on the details of the environment, there may or may not be
subsequent messages indicating dispensing, administration and other activity related to
this order.
5/28/2003 Page 10 of 30
Implementation Guide Laboratory, Pharmacy and Supply Orders HL7 v2.3.1
Two message structures are presented as HL7 v2.3.1 defines distinct messages depending
on message origination. A hospital order entry system, acting as a Placer, would send an
ORM message to the pharmacy system, acting as the Filler. The pharmacy system would
send an RDE message to a hospital order entry system. The content is similar in both
messages, however the ORM message reports the prescriber's request, while the RDE
message reports what how the pharmacy has interpreted the order. The content of the
request is sufficiently different from the content of the interpretation that HL7 v2.3.1
provides these different messages (ORM versus RDE), structures (RDO_O01 versus
RDE_O01) and target segments (RXO versus RXE).
5/28/2003 Page 11 of 30
Implementation Guide Laboratory, Pharmacy and Supply Orders HL7 v2.3.1
Message Schema
MSH|^~\&| sending application | sending facility |
receiving application ||||ORM^O01^RDO_O01| message
control id |P|2.3.1…<cr>
PID||| patient ids || patient name …<cr>
[{ AL1| set id | allergy type | allergen …<cr> }]
ORC| order control code | requestor’s order number |
processor’s order number ||||| transaction date-time |
enterer Id || ordering provider ID | enterer's location
…<cr>
RXO| quantity/timing | medication code | amount to be given ||
give amount units | dosage form …<cr>
RXR| route of administration …<cr>
Message Example
The following message example represents the order for ciprofloxacin in the clinical
scenario presented above. Specifically, a new order by Dr M J Welby, Jr (entered by
ward clerk Mary Gilbert) in the ER at MyHospital for a single intravenous dose of
ciprofloxacin 200mg to be administered to Michael Able. This message also contains
information that the patient is allergic to penicillins. Since this is a new order is being
sent from the order management system to the pharmacy system, the pharmacy order
number has yet to be assigned.
MSH|^~\&|MyHospital|MyHospital^543876^CMS|LocalPharmacy||||
ORM^O01^RDO_O01|00015|P|2.3.1<cr>
5/28/2003 Page 12 of 30
Implementation Guide Laboratory, Pharmacy and Supply Orders HL7 v2.3.1
PID|||1234321^^^MyHospital^MR||Able^Michael^D^^^^L<cr>
AL1|1|DA|^Penicillin<cr>
ORC|NW|0889475^MyHospital||||||20011001084135|A99887^Gilber
t^Mary^^^^^MyHospital||1234567^Welby^M^J^Jr^Dr^^MyHospit
al|ER<cr>
RXO|1^Once|0026-8562^Ciprofloxicin
Inj^NDC|200||mg^milligram^ISO+|^Injection …<cr>
RXR|IV^Intravenous^HL70162<cr>
Supply
Even in environments with provider order entry, the only indication that certain
treatments or diagnostic tests are being used may come from orders for supplies that are
generated primarily for charge capture. A clerk, technician or nursing personnel will
often enter these orders.
The Stock Requisition Order Message segment structure, above, is a subset of the
OMS_O01 structure defined in HL7 v2.3.1 Chapter 4. This subset constitutes the
minimum necessary message structure to communicate a supply order in the context of
this Implementation Guide. Additional segments, as defined in HL7 v2.3.1, may be
present in the message, but are not required and are not detailed in this Implementation
Guide.
Message Schema
MSH|^~\&| sending application | sending facility |
receiving application ||||ORM^O01^OMS_O01| message
control id |P|2.3.1…<cr>
PID||| patient ids || patient name …<cr>
[{ AL1| set id | allergy type | allergen …<cr> }]
5/28/2003 Page 13 of 30
Implementation Guide Laboratory, Pharmacy and Supply Orders HL7 v2.3.1
Message Example
The following message example represents the order for ventilator setup in the clinical
scenario presented above. Specifically, a new order by Dr M J Welby, Jr (entered by
respiratory therapist Martin James) in the ER at MyHospital for a ventilator and
endotrachial tube #8, to be used in therpeutic management of Michael Able. Since this is
a new order is being sent from the order management system to the materials
management system, the materials management order number has yet to be assigned.
MSH|^~\&|MyHospital|MyHospital^543876^CMS|LocalPharmacy||||
ORM^O01^RDO_O01|00015|P|2.3.1<cr>
PID|||1234321^^^MyHospital^MR||Able^Michael^D^^^^L<cr>
AL1|1|DA|^Penicillin<cr>
ORC|NW|0889587^MyHospital||||||2001100114505|R32412^James^M
artin^^^^^MyHospital||1234567^Welby^M^J^Jr^Dr^^MyHospita
l|ER<cr>
RQD|1|10-053^endotracheal tube #8^UMD|||1|UT^unit^L|
ORC|NW|0889588^MyHospital||||||2001100114505|R32412^James^M
artin^^^^^MyHospital||1234567^Welby^M^J^Jr^Dr^^MyHospita
l|ER<cr>
RQD|2|15-613^ventilator cirucuit^UMD|||1|UT^unit^L|
Segment Definitions
The HL7 General Order Message (ORM) is the starting point. Unneeded contents were
pared away to form the recommended message. The format includes minimal segments:
[AL1] – Allergy
5/28/2003 Page 14 of 30
Implementation Guide Laboratory, Pharmacy and Supply Orders HL7 v2.3.1
1 1 ST R 00001 Field
separator
2 4 ST R 00002 Encoding
characters
7 26 TS O 00007 Date/Time of
message
8 40 ST O 00008 Security
10 20 ST R 00010 Message
control ID
11 3 PT R 00011 Processing
ID
13 15 NM O 00013 Sequence
number
5/28/2003 Page 15 of 30
Implementation Guide Laboratory, Pharmacy and Supply Orders HL7 v2.3.1
19 60 CE O 00693 Principal
language of
message
Definition: In order to clearly identify the sending institution, the sending facility
field should be constructed as follows: The sending institution will use the CMS
Provider of Services (POS) code (available for download at
http://www.cms.hhs.gov/data/download/default.asp) to identify itself in this field.
They should include the text name of the institution, followed by the unique CMS
Provider of service identifier and finally, the identifier type “CMS”. For example:
MSH|^~\&||MyHospital^543876^CMS|…<cr>
5/28/2003 Page 16 of 30
Implementation Guide Laboratory, Pharmacy and Supply Orders HL7 v2.3.1
5 15 ST O Y 00207 Allergy I
Reaction
6 8 DT O 00208 Identification I
Date
Definition: This field identifies the type of allergy being reported. Refer to User-
defined Table 0127 – Allergy Type for suggested values.
Definition: This field identifies the agent the patient has an allergy to. For drugs,
the agent should be identified using the NDC coding system to be replaced by
RxNorm when available. For other agents, free text may be used but public
health systems may not store uncoded results.
5/28/2003 Page 17 of 30
Implementation Guide Laboratory, Pharmacy and Supply Orders HL7 v2.3.1
1 4 SI O 00275 Requisition I
Line Number
5 6 NM O 00279 Requisition I
Quantity
6 60 CE O 00280 Requisition I
Unit of
Measure
9 60 CE O 00283 Deliver To ID I
Definition: This field contains the ECRI UMDNS code the supply being ordered.
Definition: This field contains the code from user-defined table 0319 -
Department cost center that identifies the department that the supply being
5/28/2003 Page 18 of 30
Implementation Guide Laboratory, Pharmacy and Supply Orders HL7 v2.3.1
It can be used for any type of pharmacy order, including inpatient (unit dose and
compound unit dose), outpatient, IVs, and hyperalimentation IVs (nutritional IVs), as
well as other non-pharmacy treatments, e.g., respiratory therapy, oxygen, and
metabolites.
5/28/2003 Page 19 of 30
Implementation Guide Laboratory, Pharmacy and Supply Orders HL7 v2.3.1
SEQ LEN DT OPT RP/# TBL ITEM ELEMENT NAME OPT Implementation
# # For Comments
ELR
Unit)
Definition: This field is the ordered amount. In a variable dose order, this is the
minimum ordered amount. In an order in which a specific dose is specified, this
is the exact amount of the order.
5/28/2003 Page 20 of 30
Implementation Guide Laboratory, Pharmacy and Supply Orders HL7 v2.3.1
Definition: This field indicates the units for the give amount. Units should follow the
HL7 Version 2.3.1 convention specified in Chapter 7.
Definition: This field indicates the manner in which the medication is aggregated
for dispensing, e.g., tablets, capsules, suppositories. In some cases, this
information is implied by the dispense/give code in RXO-1-requested give code or
RXO-10-requested dispense code. Use when both RXO-1-requested give code
and RXO-10-requested dispense code do not specify the drug/treatment form.
SEQ LEN DT OPT RP/# TBL ITEM ELEMENT NAME OPT Implementation
# # For Comments
ELR
5/28/2003 Page 21 of 30
Implementation Guide Laboratory, Pharmacy and Supply Orders HL7 v2.3.1
SEQ LEN DT OPT RP/# TBL ITEM ELEMENT NAME OPT Implementation
# # For Comments
ELR
5/28/2003 Page 22 of 30
Implementation Guide Laboratory, Pharmacy and Supply Orders HL7 v2.3.1
Definition: This field is the ordered amount. In a variable dose order, this is the
minimum ordered amount. In an order in which a specific dose is specified, this
is the exact amount of the order.
Definition: This field indicates the units for the give amount. Units should follow the
HL7 Version 2.3.1 convention specified in Chapter 7.
5/28/2003 Page 23 of 30
Implementation Guide Laboratory, Pharmacy and Supply Orders HL7 v2.3.1
Definition: This field indicates the manner in which the medication is aggregated
for dispensing, e.g., tablets, capsules, suppositories. In some cases, this
information is implied by the dispense/give code in RXO-1-requested give code or
RXO-10-requested dispense code. Use when both RXO-1-requested give code
and RXO-10-requested dispense code do not specify the drug/treatment form.
5/28/2003 Page 24 of 30
Implementation Guide Laboratory, Pharmacy and Supply Orders HL7 v2.3.1
5/28/2003 Page 25 of 30
Implementation Guide Laboratory, Pharmacy and Supply Orders HL7 v2.3.1
Appendix B – Tables
User-defined Table 0127 – Allergy Type
Value Description
DA Drug allergy
FA Food allergy
MA Miscellaneous allergy
MC Miscellaneous contraindication
CM Order is completed
HD Order is on hold
IP In process, unspecified
SC In process, scheduled
AU Audiology
BG Blood gases
CT CAT scan
CH Chemistry
CP Cytopathology
HM Hematology
5/28/2003 Page 26 of 30
Implementation Guide Laboratory, Pharmacy and Supply Orders HL7 v2.3.1
Value Description
IMM Immunology
LAB Laboratory
MB Microbiology
MCB Mycobacteriology
MYC Mycology
OUS OB Ultrasound
OT Occupational Therapy
OTH Other
PAR Parasitology
PHR Pharmacy
PT Physical Therapy
PF Pulmonary function
RAD Radiology
RX Radiograph
RT Radiation therapy
SR Serology
SP Surgical Pathology
TX Toxicology
URN Urinalysis
VR Virology
XRC Cineradiograph
5/28/2003 Page 27 of 30
Implementation Guide Laboratory, Pharmacy and Supply Orders HL7 v2.3.1
Value Description
P Preliminary: A verified early result is available, final results not yet obtained
C Correction to results
F Final results; results stored and verified. Can only be changed with a corrected result.
N Not asked; used to affirmatively document that the observation identified in the OBX was not sought
when the universal service ID in OBR-4 implies that it would be sought.
P Preliminary results
S Partial results
U Results status change to final without retransmitting results already sent as ‘preliminary.’ E.g.,
radiology changes status from preliminary to final
Value Description
CH Child order/service
CN Combined result
CR Canceled as requested
5/28/2003 Page 28 of 30
Implementation Guide Laboratory, Pharmacy and Supply Orders HL7 v2.3.1
Value Description
DE Data errors
DR Discontinued as requested
HR On hold as requested
NA Number assigned
NW New order/service
OC Order/service canceled
OD Order/service discontinued
OE Order/service released
OH Order/service held
OR Released as requested
PA Parent order/service
RO Replacement order
RQ Replaced as requested
RR Request received
RU Replaced unsolicited
SC Status changed
UC Unable to cancel
UD Unable to discontinue
UF Unable to refill
5/28/2003 Page 29 of 30
Implementation Guide Laboratory, Pharmacy and Supply Orders HL7 v2.3.1
Value Description
UM Unable to replace
UR Unable to release
UX Unable to change
XR Changed as requested
5/28/2003 Page 30 of 30