HL7 Supply Interface Spec 67-3078C+

HL7 Supply Interface
Specification
67-3078 Rev C
This guide is CONFIDENTIAL and designed only for Omnicell Technical personnel and/or designated
representatives.
This guide and accompanying software and/or hardware described in it are protected under copyright laws and may
not be copied, wholly or in part, without the express written consent of Omnicell, Inc. The same proprietary and
copyright notices must be attached to any permitted copies as were attached to the original documents.
Omnicell, Inc.
1201 Charleston Road
Mountain View, CA 94043
(650) 251-6100
www.omnicell.com
Omnicell and the Omnicell design mark, OmniBuyer, OmniCenter, OmniRx, OmniSupplier, SafetyMed, SafetyPak,
SafetyStock, and Sure-Med are registered trademarks. Anesthesia TT, Anesthesia Workstation, Anywhere RN,
Executive Advisor, Flexbin, Medication Surveillance, OmniDispenser, OmniLinkRx, OmniScanner, OmniTrack,
Omni TT, Open Touch, OptiFlex, OptiFlex MobileTrack, Point-to-Point Medication Safety, SecureVault, See & Touch,
SinglePointe, TempCheck, Touch & Go, VSuite, and WorkflowRx are trademarks of Omnicell, Inc. in the United States
and internationally. All other trademarks and trade names are the property of their respective owners.
Copyright 2010-2012 Omnicell, Inc. All rights reserved.
HL7 Supply Interface Specifications/67-3078 Rev C © 2012 Omnicell, Inc.

iii
Table of Contents
Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-1
Inventory Interface Information Flow . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-1
Replenishment Interface . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-2
Local Supply . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-2
Non-Stock Supply . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-3
HL7 Messages . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-1

HL7 Implementation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-1
Message Delimiters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-1
Field Use Type . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-2
Sequence Number Protocol. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-2
Data Field Length . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-2
ADT Interface . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-1

General Information. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-1
Supported Message Events. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-2
Acknowledgment Message. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-2
MSH - Message Header Segment . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-3
MSA - Acknowledgement Segment . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-3
ADT Message Segments . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-4
MSH - Message Header . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-5
EVN - Event Type . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-5
PID – Patient Identification. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-6
PV1 – Patient Visit . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-7
AL1 – Allergy Information . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-7
OBX– Observation/Results . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-8
MRG– Merge Patient Information . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-9
Mapping Tables . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-9
Facility Mapping - ADT Facility . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-9
Patient area Mapping - ADT Area . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-9
Patient type Mapping . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-9
Other Possible Entries . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-9
Sample ADT Message . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-10
CHG Interface . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-1

© 2012 Omnicell, Inc. HL7 Supply Interface Specifications/67-3078 Rev C

iv Table of Contents
Financial Transaction Message Segment . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-1

EVN – Event . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-3
PV1 – Patient Visit . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-3
FT1 – Financial Transaction . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-4
ZPM – Pocket Activity (optional). . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-5
Sample DFT Message . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-5
SCH Interface . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-1

Typical Workflows . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-1
Workflow 1. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-1
Workflow 2. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-1
Workflow 3. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-1
Workflow 4. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-2
SIU Message Segments . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-2
EVN – Event Type Segment . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-3
SCH – Schedule Activity Information . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-5
AIS – Appointment Information (Service Segment) . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-5
AIL – Appointment Information (Location Resource) . . . . . . . . . . . . . . . . . . . . . . . . . . 5-5
AIP – Appointment Information (Personnel Resource). . . . . . . . . . . . . . . . . . . . . . . . . 5-6
AIG – Appointment Information (General Resource) . . . . . . . . . . . . . . . . . . . . . . . . . . 5-6
Sample SIU Message . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-6
XOR Interface . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-1

XOR Message Segments . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-1
ORC – Common Order Segment . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-2
RQD – Requisition Detail Segment . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-3
RQ1 – Requisition Detail – 1 Segment. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-3
Sample XOR Message . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-3
ORD Interface . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-1

ORD Message Segments. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-2
FHS – HL7 file header . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-2
BHS – HL7 batch header . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-3
MSH – Message Header . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-3
MFI – Master File Identification Segment. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-3
MFE – Master File Entry . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-4
ZPL – Pick List File Record . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-4
Sample Pick List Message. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-4

Table of Contents v
REQ Interface . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8-1

Inventory Status Request . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8-1
Step A . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8-2
Step B. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8-2
QRD – Query Definition Segment . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8-3
QRF – Query Filter Segment . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8-4
ZSR Unit Status Report Z Segment . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8-4
Sample ZUS Message . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8-4
ASN Interface . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9-1

Master File Notification (MSN) Message . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9-2
MFI – Master File Identification Segment. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9-2
MFE – Master File Entry . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9-3
ZPL – Pick List File Record . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9-3
Sample ASN Message . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9-3
IRC Interface . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10-1

General Information. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10-1
Basic Field Mapping . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10-1
FHS – HL7 File Header . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10-2
BHS – HL7 Batch Header . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10-2
MSH – Message Header . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10-3
MFI – Master File Identification Segment. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10-3
MFE – Master File Entry . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10-3
ZRC – Restock Complete Z Segment . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10-4
Sample IRC Message . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10-4
IMU Interface . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11-1

General Information. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11-1
Supported Record Level Event Codes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11-1
MFN Message Segments (Master Item File) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11-2
MSH – Message Header . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11-2
MFE - Master File Entry Segment. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11-2
ZMI – Master Item File Z Segment . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11-3
Sample MFN Messages . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11-3
Appendix A: PK Command . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . A-1

Patient ID Update Process. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . A-1
Configuration. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . A-2
Database . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . A-2

vi Table of Contents
Implementation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . A-2
Command Details . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . A-2
Code Changes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . A-2
Exceptions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . A-2
For 12.0 servers:. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . A-2
For 16.5 servers:. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . A-3
Index. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . IN-1
Documentation Feedback . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . FB-1

1-1
Overview
In order for Omnicell system to be fully integrated into the hospital’s information systems
solution, it should automatically exchange information with other systems that are part of that
solution. The exchange of information with the Omnicell system will be accomplished via a batch
interface, which complies with HL7 standards.
The exchange of information between the Omnicell system and other vendor products falls into
the following categories:
 Patient admission, discharge and transfer information passing from the ADT system to the
Omnicell system (ADT)
 Charge information passing from the Omnicell system to the billing or financial system
(CHG)
 Patient booking information from an Operating Management System (SCH)
 Inventory information passing from the Omnicell system to the Materials Management
system, and vice versa; Omnicell supports the following inventory interfaces:
 Inventory Adjustment Information (XOR)
 Inventory Re-order Information (ORD)
 Quantity on Hand Information (REQ)
 Advanced Shipping Notices (ASN)
 Restock Complete Information (IRC)
 Item Master Database Update Information (IMU)
This document specifically covers inventory interfaces between Omnicell and the hospital’s
Materials Management System.
ADT and CHG real time interfaces can be found in HL7 Pharmacy Interface Specification (67-2070).
Inventory Interface Information Flow

The list of interfaces described above may be implemented as standalone or in combination with
other interfaces.
The following sections illustrate various inventory interface configurations.

1-2 Overview
Replenishment Interface
Local Supply
Replenishment Interface - Local Supply
4. Display shelf
locations for
1. On-hand or
restocking
re-order
quantity
XPC
DB OmniCenter
2. Print Pick List

Inventory
Management 3. Pick Items
System from stock
Figure 1-1. Replenishment interface for local supply
There are a number of ways to interface with the supply inventory system and to initiate
restocking. The most simple case is where inventory is held primarily in a central supply location
within the hospital. In this case, two methods of interfacing are used.
Method 1: A handheld counting system is emulated where Omnicell delivers the quantity on hand
information to the inventory system. In this case the restock quantity and pick lists are printed by
the existing inventory system.
Method 2: Omnicell generates the pick lists, and then communicate the re-order quantity to the
inventory system. Omnicell has the ability to store a different re-order point, below the par level.
This reduces the number of line items handled on each restocking trip. A critically low level is also
provided which indicates that stock is at critical level.
In both methods, the quantity to be restocked is sent to the cabinet. When the re-stock technicians
arrive at the cabinet, they enter the system in normal re-stock mode. A list of restock orders is
displayed. They select the order they are filling. The lights next to the items to be restocked on that
order are lit. This guides the technicians through the restocking process.
The system specifies exactly how much is to be restocked. The technician simply has to select the
flashing item button for all items (except those on back-order), perform the restock, then push the
button again to acknowledge the quantity restocked.
This contrasts with systems that do not receive the quantity picked, then compute the value from
the par level and the quantity on hand at the time the technician arrives at the cabinet. Because
these values may be different than at the time the pick list was generated, the technician must
check the value for every item. This greatly increases the restock time.

Overview 1-3
Non-Stock Supply
Replenishment Interface - Non-Stock Supplies

1. On-hand 5. Display shelf
and/or locations for
re-order restocking by
quantity P.O. number
XPC 3. Return
DB OmniCenter Advance
Shipping
Notice 6. Confirm
Inventory 2. Generate restock
Purchase quantity
Management
System Orders
4. Pick items from

Distributor stock
Figure 1-2. Replenishment interface for non-stock supply
The Omnicell system was designed with all levels of non-stock and just in time (JIT) inventory
systems in mind. For non-stock systems, OmniCenter sends either the quantity on hand or the
quantity to be re-ordered to the inventory/purchasing system. It sends the information in the form
of an electronic purchase order to the distributor.
Omnicell could provide EDI interfaces directly to distributors using the X.12 standard. However,
hospitals have typically chosen to consolidate Omnicell purchase orders with other EDI orders
through their own system.
Once the order is placed, Omnicell can receive back the quantity ordered from the purchasing
system with the associated P.O. number or in the form of an advanced shipping notice sent
through the purchasing system from the distributor. This information is sent in advance to the
appropriate cabinet.
When the technicians bring the items to restock the cabinet, they select the P.O. number displayed
on the PC screen that matches the P.O. or shipping number on their re-stock list. The lights for all
the items on the corresponding restock list are lit up on the cabinet. Pushing one of these lit
buttons once, displays the quantity to be restocked. There is an opportunity at this point to change
the restock number if the quantity of items brought is not the same. Pushing the button accepts
the number displayed and turns that light out. The technician proceeds until all the lights are out.
The quantities actually stocked are sent to the Omnicenter. They can be used to print exception
reports or sent on to the purchasing system to be matched against invoices as a receiving function.

1-4 Overview

2-1
HL7 Messages
HL7 Implementation
The specification described in this chapter follows the HL7 (health level 7) standard to format
messages. The majority of the messages and segments in this specification are standard HL7
messages and segments.
HL7 Z segments are used where no HL7 segment has been defined for the necessary information.
They are also formatted to the HL7 standard. This chapter only covers segments used by
Omnicell. Detailed information about each field element can be found in the HL7 Implementation
Guide. Omnicell supports HL7 versions 2.1 thru 2.5.
The communications protocol is described in Appendix C of the HL7 Implementation Guide.
Omnicell can interface using either the Hybrid Lower Layer Protocol for a serial RS-232
connection (Section C.2) or the Minimal Lower Layer Protocol for a network environment
(Section C.4). Omnicell recommends the use of Minimal Lower Layer Protocol over a TCP-IP
socket connection.
Message Delimiters
Certain special characters are used to construct a message. They are the:
 Segment terminator
 Field separator
 Component separator
 Subcomponent separator
 Repetition separator
 Escape character
The segment terminator is always a carriage return (in ASCII, a hex 0D) for real-time interfaces.
The other delimiters are defined in the message segment header (MSH) segment. The delimiters
occur as specified in the Encoding Character Position column of the message delimiter table
(Table 2-1).
The delimiter values used in the MSH segment are the delimiter values used throughout the entire
message. In the absence of other considerations, HL7 recommends using the Suggested Values of
the message delimiter table (Table 2-1).
At any given site, the subset of the possible delimiters may be limited by negotiations between
applications. This implies that the receiving applications will use the agreed upon delimiters, as
they appear in the MSH, to parse the message.

2-2 HL7 Messages
Field Use Type
Encoding
Suggested Character
Delimiter Value Position Usage
Segment Terminator <cr> (hex 0D) - Terminates a segment record.
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 & 4 Separates adjacent subcomponents of data fields where allowed. If there are no
Separator subcomponents, this character may be omitted.
Repetition Separator ~ 2 Separates multiple occurrences of a field where allowed.
Escape Character \ 3 Escape character for use with any field represented by an ST, TX or FT data type, or for use
with the data (fourth) component of the ED data type. 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.
Table 2-1. Message delimiters
Field Use Type

Fields are required, optional or conditional in a segment. In the segment attribute tables of the HL7
Implementation Guide, this information is provided in the column labeled R/O. The designations
are:
R: Required; must contain information to process data
O: Optional; supplies extra information that does not affect data processing
C: Conditional on the trigger event or on some other field(s); The field definitions following the
segment attribute table in the following chapters should specify the algorithm that defines the
conditionally for this 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 in the following chapters should denote the field use type for
prior versions.
Data fields with no designated use in the Required/Optional column indicate the data field is not
used by Omnicell.
Sequence Number Protocol

The sequence number protocol is turned off for these interfaces.
Data Field Length

Undefined length normally indicates the information in the data field is not currently used by the
Omnicell interface.

3-1
ADT Interface
The ADT interface processes admission, discharge and transfer information.
Admission, Discharge, and Transfer (ADT) messages are sent from the ADT system to the
Omnicell system to allow each Omnicell cabinet to maintain an up-to-date demographic and visit
information about the patients. When any of the supported trigger events occur on the ADT
system, the corresponding HL7 interface message are translated and transmitted to the Omnicell
system. Once the interface message is sent to the Omnicell system, a Message Acknowledgment
(MSA) message is sent by the Omnicell system to the ADT system confirming that the
transmission was successful. The Omnicell system will then process the message to update
Omnicell patient database.
Figure 3-1. ADT interface
General Information
 Communication mode: TCP/IP socket, MLLP
 HL7 v2.1-5 formats supported
 Omnicell configuration: socket server (listening socket)
 Requires IP address and agreed upon port number for connecting to Omnicell
 ADT may share connection with RXP

3-2 ADT Interface
General Information
Supported Message Events

Code Description
A01 Admit
A02 Transfer
A03 Discharge
A04 Register
A05 Pre-admit
A06 Change an outpatient to inpatient
A07 Change an inpatient to outpatient
A08 Patient update
A11 Cancel Admit
A12 Cancel Transfer
A13 Cancel Discharge
A17 Swap Patients
A18 Merge Patient Information
A23 Delete Patient Visit
A31 Update Patient Information
A34 Merge Patient Information - Patient Id only
A38 Cancel Pre-admit
A40 Merge patient - Identifier list
A41 Merge Account - patient account number
A43 Move Patient Information - Identifier list
A47 Change Patient Identifier list
Acknowledgment Message
As inbound interface, ADT interface is able to generate the generic HL7 acknowledgement
message with AA as the acknowledgement code. A negative acknowledgment (AE) code will be
sent when ADT receives ill-formatted HL7 messages. This means Omnicell is signaling the ADT
system to send a next transaction because the current record is rejected. Content validation shall
be carried out during translation of the message, and therefore, content errors will not be
communicated back to the sending system.
The acknowledgment message consists of a message header and an acknowledgement segment.

ADT Interface 3-3
General Information
Note: The following tables have OmniCenter tokens in bold under Comments.
MSH - Message Header Segment

Required/
SEQ Length Optional Element Name Comments
0 3 R Segment Name MSH
1 1 R Field Separator Use default of "|" (pipe character)
2 4 R Encoding Characters ^~\&
3 15 Sending Application Omnicell
4 20 R Sending Facility Derived from input's receiving facility
5 15 Receiving Application Derived from input's sending application
6 30 R Receiving Facility Derived from input's sending facility
7 16 R Date/Time of Message Format YYYYMMDDHHMMSS
8 40 Security Not used by Omnicell
9 7 R Message Type ACK
10 20 Message Control Type Uniquely identifies message. Same value as MSH.10 sent by the ADT system. If the ADT
system requests Omnicell-generated number, the Record ID is used, and prefixed by the
interface name. In this case ADT. Example, ADT-000001.
11 1 R Processing ID (P)roduction, (T)raining, (D)ebugging
12 8 R Version ID 2.5 (derived from input's MSH.12)
13 15 Sequence Number Not used by Omnicell
14 varies Continuation Pointer None
15-17 varies Not used by Omnicell
MSA - Acknowledgement Segment

Required/
SEQ Length Optional Element Name Comments
0 3 R Segment Name MSA
1 2 R Acknowledgement Code AA, AR or AE
2 20 R Message Control ID Same as MSH.10 above
3 80 Text Message Description of error, if AR or AE
4 15 Expected Sequence Number Not used by Omnicell
5 1 O Delayed Acknowledgement Type Used only for delayed acknowledgement handshaking

3-4 ADT Interface
ADT Message Segments

The following common HL7 segments are used:
Name Definition
MSH Message Header
EVN Event Type
PID Patient OD
PV1 Patient Visit
[{AL1}] Allergy Information
[MRG] Merge Patient Information (merge events)
[{OBX}] Observation/Results
The segments listed under each message are the segments that the Omnicell system processes
unless specified otherwise. If additional segments (Z-segments or segments not in the HL7
specification) are sent within the messages, Omnicell ignores them. Fields within a segment are
ignored if the Omnicell system does not process them. Complete messages and segments may be
sent by the sending system. The Omnicell system handles the filtering of segments and fields that
it does not need.
The length of the data fields used by Omnicell is based upon the maximum length defined in the
Omnicell data dictionary. Length of the data fields not used by Omnicell follows the length as
defined in the HL7 standard document.

ADT Interface 3-5
MSH - Message Header

Required/
Sequence Length Optional Element Name Comments
1 1 R Field Separator Use default of “|” (pipe character)
3 15 Sending Application Vendor system
4 20 R Sending Facility Hospital facility – translation table may be used to alias Omnicell site id.
5 15 Receiving Application Omnicell
6 30 R Receiving Facility Hospital facility
7 16 R Date/Time of Message Format: YYYYMMDDHHMMSS
8 40 Security Not used
9 7 R Message Type
9.1 3 Message Code ADT
9.2 3 Trigger Event Refer to “Supported Message Events” on page 3-2.
10 20 R Message Control ID Unique identifier
12 8 R Version ID 2.4
13 15 Sequence Number Not used
15-17 varies Not used
Table 3-1. Message header
EVN - Event Type

t
Required/
1 3 R Event Code Refer to “Supported Message Events” on page 3-2.
2 26 R Recorded Date/Time Format: YYYYMMDDHHMMSS
3 26 O Date/Time Planned Event Not used
4 3 O Event Reason Code Not used
5 250 O Operator ID Not used
6 26 O Event Occurred Not used
7 241 O Event Facility Not used
Table 3-2. Event type

3-6 ADT Interface
PID – Patient Identification

Required/
1 4 O Set ID - PID
2.1 16 B Patient ID Same as PID.18.1 - account or visit number (pid)
3 R Patient Identifier List
3.1 16 R Medical Record Number mrn - Lifetime patient number
3.2 O
3.3 O
3.4 16 R Facility code ID of hospital, clinic or location. Same as MSH.4. May need a
translation table to alias to Omnicell Site ID (site)
4 20 B Alternate Patient ID - PID
5 32 R Patient Name pna (formatted in Omnicell as Last, First Middle)
5.1 varies R Last Name
5.2 varies R First Name
5.3 varies O Middle Name
6 250 O Mother's Maiden Name
7 16 O Date/Time of Birth dob
8 1 0 Administrative Sex gen - patient gender
9 250 B Patient Alias
10 250 0 Race
11 250 0 Patient Address
12 4 B County Code
13 250 0 Phone Number - Home
14 250 0 Phone Number - Business
15 250 0 Primary Language
16 250 0 Marital Status
17 250 0 Religion
18 varies R Patient Account Number
18.1 16 R Financial account or visit number pid
19 11 B SSN Number - Patient
Table 3-3. Patient identification

ADT Interface 3-7
PV1 – Patient Visit

Required/
1 4 Set ID - PV1
2 1 Patient Class Secondary criteria for setting patient type (ptyp): I, O, E, R
3 80 Assigned Patient Location
3.1 8 Nurse Station area - aliases using Area mapping table. Original value stored in
pm1(16 chars max)
3.2 8 Room & bed (Room^bed) rm
4 2 Admission Type
5 250 Pre-admit Number
6 80 Prior Patient Location
7 32 Attending Doctor Code^Last^First^Middle if using caret as subfield delimiter
8 32 Referring Doctor Code^Last^First^Middle if using caret as subfield delimiter
9 32 Consulting Doctor Code^Last^First^Middle if using caret as subfield delimiter
10 3 Hospital Service Secondary criteria for setting patient type (ptyp)
11 80 Temporary Location
12 2 Pre-admit Test Indicator
13 2 Re-admission Indicator
14 6 Admit Source
15 2 Ambulatory Status
16 2 VIP Indicator
17 32 Admitting Doctor Code^Last^First^Middle if using caret as subfield delimiter
18 3 Patient Type Primary criteria for determining patient type (ptyp). Aliases to valid
Omnicell patient type using mapping table. Original value is stored in
pm2 (16 chars max)
19 250 Visit Number Same value as PID.18.1 - patient account number
44 16 Admit Date/Time dam - Format YYYYMMDDHHMMSS
45 16 Discharge Date/Time dds - Format YYYYMMDDHHMMSS
Table 3-4. Patient visit
AL1 – Allergy Information

Required/
1 4 R Set ID AL1
2 250 O Allergen Type Code
3 250 R Allergen Code/Mnemonic/Description Use either ali or alrgy data field, but not both!
3.1 varies R Allergy Code Use ali if using Allergy Alert feature, delimited by a caret (^)
3.2 varies R Allergy Description/Name Use alrgy if not using Allergy Alert feature. Concatenate allergy
description from all AL1 segments, delimited by a semi-colon.
Table 3-5. Allergy information

3-8 ADT Interface
Allergy information is generally updated during patient admission. In most cases, accurate allergy
information is recorded at the time doctors are prescribing medication. Thus, it is a common
practice allergy is updated from the RDE message (RXP interface). Regardless, the decision on
which interface should be used to update allergy information must be agreed upon by customers,
pharmacy vendor and the Omnicell installation team. As a default, allergy update in ADT
interface is disabled although it can easily be turned on.
If Allergy Alert feature is used, the ADT system is required to send valid allergy codes to
Omnicell. With this feature, allergies are referenced using allergy codes. In addition, this interface
is capable of dynamically updating Omnicenter Allergy database from patient's allergy
information so users will not have to manually add codes to the database.
OBX– Observation/Results
The OBX segment is a repeating segment used to transmit a single observation or observation
fragment. It represents the smallest indivisible unit of a report. For this interface, this segment is
specifically used to retrieve height and weight of a patient.
Required/
1 4 O Set ID - OBX
2 2 C Value Type
3 250 R Observation Identifier OBX.3.2 can be either “WEIGHT” or “HEIGHT”. Updates pwt and
pht data fields, respectively in Omnicell
4 20 C Observation Sub-ID
5 5 C Observation Value pht for height, or pwt for weight; Value is associated with the
value of OBX.3.2
6 5 O Units Units of measures must be CM for height, and KG for weight
7 60 O References Range
8 5 O Abnormal Flags
9 5 O Probability
10 2 O Nature of Abnormal Test
11 1 O Observation Result Status
12 26 O Date Last Observation Normal Value
13 20 O User Defined Access Checks
14 25 O Date/Time of the Observation
15 250 O Producer's ID
16 250 O Responsible Observer
17 250 O Observation Method
18 22 O Equipment Instance Identifier
19 26 O Date/Time of the Analysis
Table 3-6. Observation/Results

ADT Interface 3-9
Mapping Tables
MRG– Merge Patient Information

This segment is used when merging old and new patient accounts/visit numbers or when MRN is
updated.
Required/
1.1 16 R Prior Patient Identifier List
2 16 B Prior Alternate Patient ID
3 16 R Prior Patient Account Number
4 16 B Prior Patient ID
5 16 R Prior Visit Number
6 16 O Prior Alternate Visit ID
7 32 R Prior Patient Name
Table 3-7. Merge patient information
Mapping Tables
Facility Mapping - ADT Facility
The facility mapping table is used for accommodating multi-facility accounts. This will be used
for distributing transactions to appropriate Omnicenter server. The source of data may change
depending on the vendor system. Generally, the data originates from the Sending Facility field in
the MSH segment. That value is translated to its corresponding Site ID in Omnicenter.
Patient area Mapping - ADT Area

The area mapping table is used for mapping vendor's patient location to Omnicell areas. The
source of data may change depending on the vendor system.
Patient type Mapping

The following patient types are defined in Omnicell: CF1, CF2, CF3, CF4, ERM, INP, MS1, MS2,
MS3, MS4, OP1, OPB, REC, SDS and TMP. In most cases, a different set of codes are defined on
the ADT system. This mapping table is provided to map the ADT system's patient types to their
corresponding codes in Omnicell.
Other Possible Entries

The following information can be site specific. If any of the information is present in the HL7
message, it can be saved to Omnicell's data base.
 Date & time of last admission, transfer or discharge.
 Payer (insurance plan) ID#.
 User ID for last admission, transfer or discharge.
 ICD9 (diagnosis code)

3-10 ADT Interface
Sample ADT Message
Sample ADT Message

MSH|^~\&|HISA_8592|HISF_2603|||200706081131||ADTÂ04|HL7O.1.11379|D|2.1
EVN|A04|200706081131|
PID|1||id_1896||lname_8159^fname_616^^^^||19231111|F|^^^^^||address_316||phone_4
683|||S|BAP|id_9780|||^|
PV1|1|E|ER^^|||ER^^|code_2843^lname_9433^fname_5593|||||||ED||||ER||OHI|||||||||
||||||||||CVH5.5||REG|||20070608|
AL1|1|DA|ANTIHISTAMINE DRUGS|

4-1
CHG Interface
The CHG interface processes patient charges and credits.
When a drug or item is removed from the Omnicell cabinet, a charge transaction is automatically
generated for the patient for whom the item was selected. If an item, which was selected for a
patient, is returned to the cabinet, a credit transaction is automatically generated for the patient
from whom the item was returned. This charge/billing information can then be sent from the
Omnicell system to the hospital's financial or billing system in either real-time or batch mode,
depending on the receiving vendor system's requirements. A financial transaction (DFT) message
is the preferred format used by the Omnicell system.
Figure 4-1. CHG interface
General Information
 Connection: TCP/IP Socket, MLLP, or via Net bios or FTP as batch file
 HL7 v2.1-5 formats supported.
 Omnicell is configured as socket client, or batch file.
 Requires IP address and agreed upon port number for connecting to the pharmacy or financial
system for real-time mode. Batch requires login credentials to access destination folder.
Financial Transaction Message Segment

The following DFT message segments are used:
Code Segment Definition

MSH Message Header
EVN Event Type (P03) - post detail financial transaction
PID Patient Identification
[PV 1] Patient Visit
{FT1} Financial Transaction
[ZPM] Pocket Activity

4-2 CHG Interface

Required/
3 15 Sending Application Used to support multiple facility accounts1
4 20 R Sending Facility Used to support multiple facility accounts2
5 15 Receiving Application Used to support multiple facility accounts3
6 30 R Receiving Facility Used to support multiple facility accounts4
8 40 Security Not used by Omnicell
9 7 Message Type
9.1 3 R Message Control ID DFT
9.2 3 R Trigger Event P03
10 20 R Message Control Type Unique identifier
13 15 Sequence Number Not used by Omnicell
1
Source of data may change depending on the vendor system. A Facility mapping table may be
needed to accommodate multi-facility accounts. Otherwise, get value from Sending Application
in NODE.INI.
2
needed to accommodate multi-facility accounts. Otherwise, get value from Sending Facility in
NODE.INI.
3
needed to accommodate multi-facility accounts. Otherwise, get value from Receiving Application
in NODE.INI.
4
needed to accommodate multi-facility accounts. Otherwise, get value from Receiving Facility in
NODE.INI

CHG Interface 4-3
EVN – Event
t
Required/
0 3 R Segment Name EVN
1 3 R Event Code P03
2 16 R Transaction Date and Time Format: YYYYMMDDHHMMS
Table 4-2. Event

Required/
0 3 R Segment Name PID
1 4 O Set ID
3.1 20 R Patient ID - Internal ID mrn - Lifetime patient number
4 20 R Patient Account Number pid - Patient ID
5 48 O Patient Name pna (formatted in Omnicell as Last, First Middle)
18 16 B Patient Account Number pid - Patient ID
PV1 – Patient Visit

Required/
0 varies Segment Name PV1
3 80 Assigned Patient Location Format pm1^rm^bed assuming caret is the sub-field delimiter. pm1
contains the original value captured from ADT interface. Room and bed
are stored in rm token delimited by a dash (-).
7 32 Attending Doctor Retrieve from phy token
18 3 Patient Type Not used
Table 4-4. Patient visit

4-4 CHG Interface
FT1 – Financial Transaction

Required/
0 3 R Segment Name FT1
2 16 O Transaction Date system generated sequence number
4 14 R Transaction Date xdt - Format YYYYMMDDHHMMSS
5 14 O Posting Date xdt - Format YYYYMMDDHHMMSS
6 8 R Transaction Type Derived from xty - mapped through RXC Transaction Type table
7.1 16 R Transaction Code item - Item ID
7.2 48 R Transaction Description ina - Item Description
9 16 O Alt Transaction Description
10 8 R Transaction Quantity The absolute value of qty - Quantity taken, return or wasted.
13 16 O Department Code cntr - cost center, null if empty
16 12 O Patient Location Format pm1^rm^bed assuming caret is the sub-field delimiter. pm1
contains the original value captured from ADT interface. Room and bed are
stored in rm token delimited by a dash (-).
18 16 O Patient Type ptyp - mapped patient type from ADT interface. null if empty.
20 60 O Performed By Code OMNICELL^ToHL7PersonName(una, "^")
23 16 O Filler Order Number Not used
Table 4-5. Financial Transaction

CHG Interface 4-5
Sample DFT Message
ZPM – Pocket Activity (optional)

Required/
0 3 R Segment Name ZPM
1 16 R Transaction Type L for bin load, U for unload, C for others
2 10 R Dispensing System Defined in node.ini. Default is OMNICELL
3 10 R Dispensing Location osi - OmniSupplier ID. Use Floor Stock Mapping table
5 5 O Pocket Descriptor omb - Internal Bin ID
6 16 R Medication/Drug ID Item - Item ID
7 48 O Medication Name ina - Item Name
8 1 O Medication Class aclv - Supply only ("S")
10 8 O Actual Begin Count qt - Quantity On Hand (total qty for multi-bin items)
11 8 O Transaction Amount qty - quantity issued or returned.
12 12 O User ID xus
13 32 O User Name una
14 12 O Witness ID wtid
15 32 O Witness Name wtnm
16 8 R Total Count of Med on Unit qt - Quantity On Hand (total qty for multi-bin items)
20 16 O Nursing Unit pm1 - patient location as originally received from ADT interface.
22 8 O Transaction Date qpl
24 14 R Transaction Date xdt - Format YYYYMMDDHHMMSS
Table 4-6. Pocket Activity
5
The TO field in the mapping table may contain multiple Floor Stock locations. Use ^ to separate
each floor stock location. When an OmniSupplier ID is mapped to multiple locations, generate
the same exact message and set ZPM.3 accordingly for each location.
Sample DFT Message

MSH|^~\&|OMNIMEDS-IN|UTMH|HNAM|HNAM|20090807102204|SECURE|DFT^P03|RXC-
0008333849|P|2.3
EVN|P03|20090807102204
PID|1||441306|pid_9643|LastName^FirstName9317|||||||||||||pid_9643
PV1|||2ND^218-A||||phy_8678|||||||||||OP1
FT1||moid_9303||2007052909174600|2007052909174600|I|43428234^PROPOFOL||moid_9303
|1|||""|||2ND^218-A||OP1||LastName^FirstName6086|||moid_9303
ZPM|C|OMNIRX|GLANES2||49290|43428234|PROPOFOL|6||10|1|DFRANK|LastName,
FirstName6086|""|""|10||||2ND||12||2007052909174600

4-6 CHG Interface
Sample DFT Message

5-1
SCH Interface
The SCH interface processes operating room (OR) scheduling.
The OR Scheduling Interface enables OmniCenter to receive OR booking information from an
OR Scheduling System when a patient is scheduled for a new surgery, an existing surgery booking
is modified, a booking is rescheduled, or a booking is cancelled. It enables end users and
schedulers to view all appointments scheduled for a patient across departments. In addition, this
interface can be used to inform any system of the patients coming in for surgery as well as the
details of the patient's surgeries such as surgery time, location and procedure.
Patients are booked for surgeries in OR Scheduling department. Omnicell supports the following
HL7 SIU message type trigger events:
 S12 - New appointment
 S13 - Reschedule appointment
 S14 - Modify appointment
 S15 - Cancel appointment
Typical Workflows
Workflow 1
1. The OR scheduler is informed by a doctor's office that a patient needs to be scheduled for
surgery.
2. The patient is booked for surgery in the OR department.
3. An S12 HL7 outbound scheduling message is sent to Omnicell including a unique case or
booking number.
4. A case is added to Omnicell Case table upon receiving the message from the OR scheduling
system.
Workflow 2
1. The OR scheduler reschedules a booking by moving it through manage booking or the grid.
2. An S13 HL7 outbound scheduling message is sent to Omnicell including the case or booking
number.
3. Omnicell receives the message and updates the patient's appointment in the Case table.
Workflow 3
1. The OR scheduler modifies a booking by changing any information that is not associated with
the time, date, duration, or room and re-files the booking.
number.
3. The Omnicell system updates the OR appointment for the patient in the Case table.

5-2 SCH Interface
General Information
Workflow 4
1. The OR scheduler cancels a booking.
number.
3. Omnicell receives the message and cancels the patient's appointment in the Case table.
General Information
 Real-time via TCP/IP socket, MLLP
 Connection is persistent
SIU Message Segments

Name Definition
MSH Message Header
{
EVN Event Type
PID Patient Identification
PV1 Patient Visit
SCH Schedule Activity Information
AIS Appointment Information - Service Segment
AIP Appointment Information - Personnel Resource Segment
AIL Appointment Information - Location Resource Segment
[AIG] Appointment Information - General Resource
}

SCH Interface 5-3

Required/
3 15 O Sending Application <The OR system>
4 20 R Sending Facility Hospital facility – translation table may be used to alias Omnicell site id to
facility code or use AIL 3.4
5 15 Receiving Application OMNICELL
7 16 R Date/Time of Message
9 7 R Message Type
9.1 3 R Message Code SIU
9.2 3 R Event Code S12, S13, S14 or S15 - Use Event Type mapping table
EVN – Event Type Segment

t
Required/
1 3 R Event Type S12 - New Appointment (A)
S13 - Reschedule Appointment (U)
S14 - Modify Appointment (U)
S15 - Cancel Appointment (D)
2 16 R Recorded Date/Time Format: YYYYMMDDHHMMSS
Table 5-2. Event type segment

5-4 SCH Interface

Required/
1 4 O Set ID - PID
2.1 16 B Patient ID Same as PID.3.1 - Medical Record Number (not used in case table)
3 varies R Patient Identifier List
3.1 16 R Medical Record Number mrn - Lifetime patient number (not used in case table)
3.2 varies O
3.3 varies O
3.4 16 O Facility code ID of hospital, clinic or location. Same as MSH.4. May need a mapping
table.
4 20 B Alternate Patient ID - PID Case ID (csid) - use SCH.23 instead
5 32 R Patient Name pna (formatted in Omnicell as Last, First Middle)
5.1 varies R Last Name
5.2 varies R First Name
5.3 varies O Middle Name
6 250 O Mother's Maiden Name
7 16 O Date/Time of Birth
8 1 0 Administrative Sex
9 250 B Patient Alias
10 250 0 Race
11 250 0 Patient Address
12 4 B County Code
13 250 0 Phone Number - Home
14 250 0 Phone Number - Business
15 250 0 Primary Language
16 250 0 Marital Status
17 250 0 Religion
18 varies R Patient Account Number
18.1 16 R Financial account or visit number pid; blank if not sent
19 11 B SSN Number - Patient

SCH Interface 5-5
SCH – Schedule Activity Information

Required/
6 10 O Cancel Reason
8 60 O Appointment Type
9 16 O Appointment Duration
20 60 O Entered by user
23 75 R Parent Placer Appointment ID csid - booking number or case ID
Table 5-4. Schedule activity information
AIS – Appointment Information (Service Segment)

Required/
1 4 O Set ID
2 1 R Event Type Use EVN.1 or MSH.9.2 to map to OFL code.
3.1 15 R Procedure Code cdsc - Concatenated with AIS.3.2
3.2 50 R Procedure Description cdsc -Concatenated with AIS.3.1
3.4 10 O Procedure Mnemonic
4 16 R Booking Date and setup start time YYMMDDHHMMSS - convert to OFL required format cdt
5 10 O Location crm - May contain location or Pick Location name
6 20 R Room crm - Or, use AIL.3.2
7 8 O Procedure Duration
10 25 O Clinical Specialty Number Not available in Case table
12.1 15 R Doctor ID cphy - Or, use AIP.3 - concatenated with Doctor name
12.2 30 R Doctor Last Name cphy
12.3 20 R Doctor First Name cphy
Table 5-5. Appointment information
AIL – Appointment Information (Location Resource)

Required/
3.2 15 O Room Mnemonic crm - see IS.6
3.4 20 O Facility Mnemonic Not available in case table

5-6 SCH Interface
Sample SIU Message
AIP – Appointment Information (Personnel Resource)

Required/
3 15 O Surgeon Mnemonic
7 20 O Start Date/Time Offset
20 60 O Entered by user luf
23 75 R Parent Placer Appointment ID csid - booking number or case ID
AIG – Appointment Information (General Resource)

This segment is not used.
Sample SIU Message

MSH|^~\&|Picis|Picis|||20060928112448||SIU^S14|20060928135319||2.3|||||
EVN|S14|20060928112448||||
PID||000718|||JONES^PRE02^||||||||||||||484845855
PV1|||||||||||||||||||||||||||||||||||||||||||||||||||||
SCH|||||||||100||||||||||||||3374|||
AIS|1|| ^Craniotomy for tumor^^.craniT |20060901084000|||100||||
AIP|1||POTSHTESTW||||0||||||
AIL|||^PMR2^^MSM|
AIG|1||L-C-ArmÂrm|E||2||||||||

6-1
XOR Interface
The XOR interface processes inventory adjustment information.
If the Materials Management department wants the Materials Management system to receive
inventory adjustment (depletion, return and other transactions affecting quantity on hand)
information, the Omnicell system can pass each item transaction record to the materials
management system. This information can be passed from the Omnicell system to the materials
management system as the transaction occurs on the Omnicell system (real-time), or the
transaction can be passed in a batch file once or more each day.
Hospital
System Interface services OmniCenter
Application Application
Application
Socket or batch file XOR

Interface Messages sent over MSMQ
Figure 6-1. XOR interface
General Information
 Communication mode: Batch file via file transfer protocol (FTP) or network drive mapping
 Omnicell configuration: send a batch file on a scheduled basis
XOR Message Segments

Name Definition
MSH Message Header
{
ORC Common Order Segment
{
RQD Requisition Detail Segment
[RQ1] Requisition Detail – 1 Segment
}
}

6-2 XOR Interface
XOR Message Segments
it does not need.

Required/
3 15 O Sending Application OMNICELL
4 20 R Sending Facility Hospital facility – translation table may be used to alias Omnicell site id to
facility code.
5 15 O Receiving Application Vendor system name
9 7 R Message Type
9.1 3 O Message Code ORM
ORC – Common Order Segment

t
Required/
1 2 R Order Control NW
2 16 R Placer Order Number ÔMNI – assuming caret is subfield delimiter
4 22 O Placer Group Number ÔMNI – assuming caret is subfield delimiter
6 1 O Response Flag N
9 14 O Date/Time of Transaction Format: YYYYMMDDHHMMSS
10 250 O Entered by User formatted according to HL7 standard
18.2 250 O Entering Device "OMNI Interface"
Table 6-2. Common order segment

XOR Interface 6-3
Sample XOR Message
RQD – Requisition Detail Segment

Required/
1 4 O Requisition Line Number 1
2.1 16 O Item Code – Internal item
2.2 48 O Item description ina; Item name, qualities
2.3 16 O Name of Coding System OMNI
5 6 O Requisition Quantity Negative qty = item was returned
6 60 O Requisition Unit of Measure Unit of measure for this item
7 30 O Dept. Cost Center Department Accounting code
9 60 O Deliver to ID Dept/location mapped from Omni cabinet name through XOROmniId table
Table 6-3. Requisition detail segment
RQ1 – Requisition Detail – 1 Segment

Required/
1 16 O Anticipated Price Use Omnicell ItemPrice
2 16 O Manufacturer ID mnfo
3 20 O Manufacturer Catalog
4 16 O Normal re-order source srceNormal re-order source
Table 6-4. Requisition detail sub-segment
Sample XOR Message

MSH|^~\&|OMNICELL|AA|VENDOR||200609250816||ORM|2654|P|2.4|
ORC|NW|ÔMNI||ÔMNI||N|1||19940531084520|1230^JONES^NURSE||||||||ÔMNI Interface
RQD|1|1001^2x2 Gauze PadÔMNI|||-2|ea
RQ1|10.00|135796224||Baxter

6-4 XOR Interface
Sample XOR Message

7-1
ORD Interface
The ORD interface processes inventory re-order information.
A customer’s Materials Management department can choose to have inventory re-order
information sent from the Omnicell system to the Materials Management system. A pick list
information is generated in Omnicell and sent to the Materials Management system via an
interface.
Par levels and re-order levels are stored on the Omnicell system. They are used to calculate re-
order quantities for each item. A pick list file of the reorder quantities is generated whenever a
user at the OmniCenter chooses to generate a pick list. At that time, the pick list information is
communicated to the materials management system either as individual records or as a batch file
containing information on the complete pick list.
Hospital
Application
Socket or batch file ORD

Figure 7-1. ORD interface
General Information
 Omnicell configuration: Send file on a scheduled basis

7-2 ORD Interface
ORD Message Segments

The following Master File Notification (MFN) message segments for a Pick List File (ZPL) are
used:
Name Definition
FHS HL7 file header
BHS HL7 batch header
MSH Message Header
MFI Master File Identification
{
MFE Master File Entry
[ZPL] Pick List File Record
}
it does not need.
FHS – HL7 file header

Required/
0 3 R Segment Name FHS
3 15 O Sending Application Sending application; defined in file node.ini
4 20 R Sending Facility Hospital facility; defined in file node.ini
5 15 O Receiving Application Vendor system name; defined in file node.ini
6 30 R Receiving Facility Hospital facility; defined in file node.ini
Table 7-1. File header

ORD Interface 7-3
BHS – HL7 batch header

Required/
0 3 R Segment Name BHS
5 15 O Receiving Application Vendor system name; defined in file node.ini
6 30 R Receiving Facility Hospital facility; defined in file node.ini
Table 7-2. Batch header
MSH – Message Header

Refer to “MSH - Message Header” on page 6-2 for a complete segment definition.
MSH.9.1 = MFN
MSH.9.2 = None
MFI – Master File Identification Segment

Required/
1 60 R Master File Identifier PLF^Pick List File
3 3 R File Level Event Code UPD
4 19 O Entered Date/Time Format: YYYYMMDDHHMMSS
5 19 Effective Date/Time Not currently used by Omnicell
6 6 R Response Level Code NE – no application level response
Table 7-3. Master file identification segment

7-4 ORD Interface
Sample Pick List Message
MFE – Master File Entry

Required/
1 3 R Record Level Event Code MAD – add record to master file
MDL – not currently supported
MUP – not currently supported
2 20 MFN Control ID Not currently used by Omnicell
4 60 R Primary Key Value OmniSupplier Name (osi)
Table 7-4. Master file entry
ZPL – Pick List File Record

Required/
1 4 R Location OmniSupplier Name (osi)
-- O Uses OmniSupplierIgnore map
2 16 R Item ID Item ID
3 8 R Requested Restock Quantity (qor / csi) – in restock unit of measure
4 20 R Purchase Order Number Restock ID (pon)
5 20 R Unit of stock Unit of stock (usk)
7 20 R Restock route Remote restock route (rrt)
Table 7-5. Pick list file record
Sample Pick List Message

FHS|^~\&|OMNIMEDS-IN|UTMH|HNAM|HNAM|20070926090015
BHS|^~\&|OMNIMEDS-IN|UTMH|HNAM|HNAM|20070926090015
MSH|^~\&|OMNIMEDS-IN|UTMH|HNAM|HNAM|20070926090015||MFN|##|P|2.3
MFI|PLF^Pick List File||UPD|20070926090015||NE
MFE|MAD|||SV5TWR
ZPL|SV5TWR|125761S|1|CPC01-0000058075|EA||>5T: M-F 900

8-1
REQ Interface
The REQ interface processes quantity on hand information.
The current quantities on hand at all cabinets are required to calculate re-order quantities before
pick lists or purchase orders are generated. If the Materials Management system is receiving
inventory depletion information in real time from the Omnicell system, it could calculate quantity
on hand at any time.
If inventory depletion information is not received in real time, the Materials Management system
will need the Omnicell system to send the quantity on hand for each cabinet just prior to
generating pick lists or purchase orders. This is accomplished by sending an Inventory Status
Request message to the Omnicell system. A Quantity on Hand Report is returned.
Hospital
System
Application OmniCenter
Interface services
Application
Application
Messages sent as batch file REQ Messages sent over MSMQ

Interface
Figure 8-1. REQ interface
General Information
 Omnicell configuration: send a file on a scheduled basis
Inventory Status Request

The Materials Management department can choose to have its system receive quantity on hand
(QOH) information or individual transactions / re-order information from the Omnicell system.
The Materials Management system can periodically query the Omnicell system for a current
Inventory Status Report for a particular Omnicell cabinet. The Omnicell system transmits a Unit
Status (Quantity on Hand) Report to the materials management system.

8-2 REQ Interface
Step A
Event Code QRY - Status Report Query

MSH Message Header
QRD Query Definition Segment
[{QRF}] Query Filter Segment
Step B
Event Code ZUS - Unit Status (Quantity on Hand) Report

MSH Message Header
QRD Query Definition Segment
{
QRF Query Filter Segment
ZSR Unit Status Report Z Segment
}
Note: Step A is optional. The REQ interface can be configured to automatically generate QOH information on
a scheduled basis. However, all cabinets will be included in the QOH message. Step A may be implemented if
the inventory system is capable of sending QOH query by cabinet.
it does not need.

REQ Interface 8-3

MSH.9.1 = QRY for query [or] ZUS for QOH response
MSH.9.2 = None
QRD – Query Definition Segment

Required/
1 19 R Query Date/Time Format: YYYYMMDDHHMMSS
2 1 R Query Format Code R - record-oriented response format
D - Not currently used by Omnicell
3 1 R Query Priority D - Deferred
I - Not currently used by Omnicell
4 10 R Query ID Unique identifier for the query
5 1 Deferred Response Type Not currently used by Omnicell
6 19 Deferred Response Date/Time Not currently used by Omnicell
7 10 Quantity Limited Request Not currently used by Omnicell
8 20 Who Subject Filter Not currently used by Omnicell
9 3 R What Subject Filter STA - Status
10 20 O What Department Data Area of Omnicell Unit
11 20 What Data Code Value Qualifier Not currently used by Omnicell
12 1 O Query Results Level S - Status only
R - Not currently used by Omnicell
T - Not currently used by Omnicell
O - Not currently used by Omnicell
Table 8-1. Query definition segment

8-4 REQ Interface
Sample ZUS Message
QRF – Query Filter Segment

Required/
1 20 R Where Subject Filter “OMNI”
2 19 R When Date Start Date/Time Current Date/Time; YYYYMMDDHHMMSS
3 19 When Date End Date/Time Not currently used by Omnicell
4 20 What User Qualifier Not currently used by Omnicell
5 20 R What QRY Subject Filter Components:
<Omnicell Unit Name or "*" for all> ^<Item ID#>
(second component is optional)
6 12 Which Date/Time Qualifier Not currently used by Omnicell
7 12 Which Date/Time Status Qualifier Not currently used by Omnicell
8 12 Date/Time Selection Qualifier Not currently used by Omnicell
Table 8-2. Query filter segment
ZSR Unit Status Report Z Segment

Required/
1 4 R Location Cabinet name
2 17 R Item ID 1 Item identifier
3 8 R Quantity on Hand QOH
Table 8-3. Unit status report
Sample ZUS Message

MSH|^~\&|OMNICELL| |VENDOR| |20071127155552||ZUS|290|P|2.4|290
QRD|19940520084520|R|D|13579|BL||||STA|ICU||S
QRF|OMNI|19940520084520|||ICU1^1001
ZSR|OR1|1001|8

9-1
ASN Interface
The ASN interface processes advanced shipping notices.
An Advanced Shipping Notice (ASN) includes quantities of which items are being sent for
restocking on each cabinet. The items sent from the supply room or vendor are expected to be
physically restocked in cabinets soon (hours or days if ordered from a vendor) after the pick list is
transmitted. Cabinets use the ASN information allows the lights on the cabinet to show the
restock technician the locations of the items to be restocked.
The ASN message is the same as the Inventory Re-order Information message. The difference is
that an Inventory Re-order Information message is sent from the Omnicell system to the
Materials Management system while the ASN message is sent from the Materials Management
system to the Omnicell system.
This message is optional, depending on the needs of the hospital’s Materials Management
department.
Hospital
System
Interface services
Application
Application
Messages sent over as batch file ASN

Interface
Figure 9-1. ASN interface
General Information
 Omnicell configuration: receive a file from the inventory system; The existence of the input file
triggers ASN to automatically process the batch file.

9-2 ASN Interface
Master File Notification (MFN) Message
Master File Notification (MFN) Message

The following Master File Notification (MFN) message segments for a Pick List File (ZPL) are
used:
Name Definition
MSH Message Header
{
[ZPL] Pick List File Record
}
it does not need.

MSH.9.1 = MFN
MSH.9.2 = None

Required/
1 60 R Master File Identifier ASNÂdvanced Shipping Notice
3 3 R File Level Event Code UPD
4 19 O Entered Date/Time Format: YYYYMMDDHHMMSS
Table 9-1. Master file identification

ASN Interface 9-3
Sample ASN Message

Required/
MDL – not currently supported
MUP – not currently supported
4 60 R Primary Key Value OmniSupplier Name (osi)
ZPL – Pick List File Record

Required/
1 4 R Location OmniSupplier Name (osi) Uses OmniSupplierIgnore map
2 17 R Item ID Item ID (item)
3 8 R Expected Restock Quantity Multiply by OC conversion factor (csi) and store in qor, in restock unit of measure
4 20 R Purchase Order Number Restock ID (pon)
5 20 R Unit of stock Unit of stock (usk)
7 20 R Restock route Remote restock route (rrt)
Table 9-3. Pick list file record
Sample ASN Message

MSH|^~\&|VENDOR|AA|OMNICELL| |20070926090015||MFN|22|P|2.4
MFI|ASN^ Advanced Shipping Notice||UPD|20070926090015||NE
MFE|MAD|||SV5TWR
MFE|MAD|||SVICU
ZPL|SVICU|3456|1|CPC01-0000058075|EA||>5T: M-F 900

9-4 ASN Interface
Sample ASN Message

10-1
IRC Interface
The IRC interface processes restock complete information.
When a restock technician completes the restocking process for a cabinet, a Restock Complete
message is sent to the Materials Management system. This verifies for the Materials Management
system that the restocking had been completed. It also shows the quantity of items physically
restocked. This quantity can be compared to the quantity ordered. The numbers should be the
same. This interface is optional depending on the need to compare the two quantities.
Hospital
Application
Messages sent as batch file IRC

Figure 10-1. IRC interface
General Information
 Omnicell configuration: send a file to the Material Management system
Basic Field Mapping

The following MFN message segments are used for the Restock Complete Report:
Name Definition
FHS HL7 file header
BHS HL7 batch header
MSH Message Header
{
[ZRC] Restock Complete Record
}

10-2 IRC Interface
Basic Field Mapping
it does not need.
FHS – HL7 File Header

Required/
0 3 R Segment Name FHS
4 20 R Sending Facility Receiving application; defined in file node.ini
5 15 O Receiving Application Receiving application; defined in file node.ini
6 30 R Receiving Facility Receiving facility; defined in file node.ini
Table 10-1. File header
BHS – HL7 Batch Header

Required/
0 3 R Segment Name BHS

Table 10-2. Batch header

IRC Interface 10-3
Basic Field Mapping

Required/
3 15 O Sending Application Sending Application; defined in file node.ini
9.1 16 R Message type MFN
10 16 R Unique sequence number Generated by Omnicell
11 16 R ProcessID ProcessID defined in file node.ini
12 16 R VersionID VersionID defined in file node.ini

Required/
1 60 R Master File Identifier RCR^Restock Complete Report
3 3 R File Level Event Code UPD (update) only; REP (replace) will not be used
4 19 O Entered Date/Time rdt; Format: YYYYMMDDHHMMSS
Table 10-4. Master file identification

Required/
4 60 R Primary Key Value OmniSupplier Name - osi

10-4 IRC Interface
Sample IRC Message
ZRC – Restock Complete Z Segment

Required/
1 4 R Location OmniSupplier ID - osi
2 17 R Item ID item
3 8 R Requested Restock Qty qor
4 8 R Actual Qty Restocked qrc / csi – in restock unit of measure
5 20 R Purchase Order Number P.O. Number or Restock ID Number - pon
6 11 O Restock Tech ID Employee ID
7 10 R Date/Time Format: YYYYMMDDHHMMSS; rdt
Table 10-6. Restock complete
Sample IRC Message

MSH|^~\&|OMNICELL|AA|VENDOR||20081031155212||MFN |121414401100|P|2.4
MFI|RCR^Restock Complete Report||UPD|199405180845||NE|MFE|MAD|||ICU1
MFE|MAD|||ICU1
ZRC|OR1|1001|100|95|1000045002|9876|19940520084520

11-1
IMU Interface
The IMU interface process item master updates.
The IMU interface can be implemented to transmit information whenever items are modified,
added or deleted on the Materials Management system. It is assumed that the Materials
Management system is the owner of the Inventory Master File. Any modifications, additions or
deletions made to the inventory master file must be keyed into the Materials Management system.
In order to allow users at workstations on the Materials Management system to modify, add or
delete items on each cabinet, an HL7 message has been defined for the exchange of the necessary
information. Entering modifications, additions or deletions into the Materials Management
system should trigger the corresponding HL7 interface message to be formatted and transmitted
to the Omnicell system.
Hospital
System
Interface services
Application
Application
Messages sent over as batch file IMU

Interface
Figure 11-1. IMU interface
General Information
 Omnicell configuration: receive a file from the inventory system; The existence of the input file
triggers ISU to automatically process the batch file.
Supported Record Level Event Codes

Code Description
MAD Add record
MUP* Update record
MDL Delete record – NOT SUPPORTED
*For MUP item update, IMU interface only updates item cost and item price.

11-2 IMU Interface
MFN Message Segments (Master Item File)
MFN Message Segments (Master Item File)

The following MFN message segments are used:
Name Definition
MSH Message Header
{
[ZMI] Master Item File Record
}
it does not need.
defined in the HL7 standard document. The caret (^) in the example indicates subfield delimiter.

MSH.9.1 = MFN (Optional)
MSH.9.2 = None
MFE - Master File Entry Segment

Required/
1 3 R Record-Level Event Code See Section 7.27.2 for supported events.
2 20 C MFN Control ID
3 26 O Effective Date/Time
4 16 O Primary Key Value - MFE Itemîna - same as ZMI.1.1
5 3 O Primary Key Value Type

IMU Interface 11-3
Sample MFN Messages
ZMI – Master Item File Z Segment

Required/
1 R Master Item File Table Entry
1.1 16 Drug ID item
1.2 48 Drug Description ina
2 10 R Location Master osi – obtained from node.ini file entry
OmnisupplierMasterName
3 16 R Charge ID cid
4 48 R Brand Name of Drug Item alias – create alias if available
5 6 PAR Level Not updated unless requested (qpl)
6 6 Reorder Point Not updated unless requested (qmn)
7 6 Critically Low Level Not updated unless requested (qal)
9 4 Unit of Re-stock usk
10 4 Unit of Issue uoi
11 16 Normal Re-order Source mns
12 20 Normal Re-order Bin Location or Part # mnl
13 16 Critically Low Re-order Source als
14 20 Critically Low Re-order Bin Location or Part # all
15 1 Billable/Non-billable cty
16 16 Item Cost (per unit of issue) ucs
17 16 Item Price (per unit of issue) upr
Table 11-2. Master item file
Sample MFN Messages

MSH|^~\&|||||200706040944||ZUSER|HL7O.4.11307|P|2.1
MFE|MAD
ZMI|JDC22Âdd to the master|||JDC22_Alias||||||||||||10.10|20.99
MSH|^~\&|||||200706040944||ZUSER|HL7O.4.11307|P|2.1
MFE|MUP
ZMI|JDC23Ûpdate the master|||JDC23_Alias||||||||||||

11-4 IMU Interface
Sample MFN Messages

A-1
Appendix A: PK Command
This command allows a hospital to change its patient identification when migrating to a new
system. It is used with the ADT interface.
Patient ID Update Process

Modification to patient ID is initiated at the OmniCenter. Affected cabinets are sent the PK
command with the current patient ID to be modified and the new patient ID value. The old ID is
then updated to the new ID. This saves time from manually re-entering the new patient IDs and
eliminates user error.
All patient associated information stays intact: medication orders, patient specific bins, restock,
etc.
Historical data in transactions and waste tables are also updated. These tables include:
 CASE
 DAPATINFO
This table holds historical data relating to one-time dispensing alerts. If a one-time alert for a
patient has been triggered then a record for this event will be found in the table and
subsequent operations on the patient will not trigger the alert again.
 TEMBINS
 MEDITEM
 MORDER
 PATBINS
 PATIENT
The PAT_ID and TMPATID field will be updated.
 PCR
 PMACCT
 RESTOCK
 RMTREQ
 USERPATS
 WASTE
 XACTIONS
Patient Allergies are associated with the patient's Medical Record Number (MRN) and so are not
affected by the change of ID.
Data table updates will be restricted to when no user is logged in.
The feature does not need a GUI as all operations proceed without user interaction once the
command has been received at the cabinet.

A-2 Appendix A: PK Command
Configuration
Configuration
No configuration changes are required for this feature.
Database
No database table or field changes are required for this feature
Implementation
The existing command processing infrastructure will be used to handle this new command so no
additional error handling or error reporting function needs to be added.
The coding effort is essentially an extension to existing code.
Command Details
Token Description Rule Notes
pid Existing patient ID U16 Any value longer than 16 will be rejected
pidn New patient ID U16 Any value longer than 16 will be rejected; cannot be blank; cannot start with '*'; cannot be existing patient id
Code Changes
ff_process:get_obj Add command to patient group.
ff_patient:process input Add call to processing function.
ff_patient:pk() Author command processing function with business rules.
CPatient:Change Pat ID() Author DB access sub-function
Exceptions
The following tables are not updated by the PK command as specified by software version.
For 12.0 servers:

 Modified patient IDs will not be sent via command subscriptions.
 There will be no changes to PATAL (patient allergies) because it uses the MRN.
 The Waste table in Color Touch will not be updated.
 The XACTIONS table in Color Touch will not be updated.
 The DAPATINFO table in Color Touch will not be updated.
 No transaction will be generated when replacing Pat_id in the Pat_bin table.

Appendix A: PK Command A-3
Exceptions
For 16.5 servers:

 There will be no changes to PATAL (patient allergies) because it uses the MRN.
 UEVENTS and Audit tables will not be updated so that the history of patient ID changes can
be reserved.
 The Waste table in legacy Color Touch cabinets will not be updated.
 The XACTIONS table in legacy Color Touch cabinets will not be updated.
 The DAPATINFO table in Color Touch will not be updated.

A-4 Appendix A: PK Command
Exceptions

IN-1
Index
A I
acknowledgement segment (MSA) 3-3 IMU interface 11-1
admission, discharge, transfer 3-1 inventory adjustment 6-1
ADT inventory re-order 7-1
acknowledgment message 3-2 inventory request 8-1
ADT interface 3-1 IRC interface 10-1
advanced shipping notices 9-1 IRC message 10-4
allergy information (AL1) 3-7 item master updates 11-1
ASN interface 9-1
ASN Message 9-3 M
mapping tables 3-9
B master file entry (MFE) 7-4, 9-3, 10-3, 11-2
backward compatibility 2-2 master file identification (MFI) 7-3, 9-2, 10-3
batch header (BHS) 7-3, 10-2 master item file (ZMI) 11-3
medical record number A-1
C merge patient information (MRG) 3-9
common order segment (ORC) 6-2 message events
communications protocol 2-1 ADT 3-2
component separator 2-1 message header (MSH) 3-5, 4-2, 5-3, 6-2, 10-3
message header segment (MSH) 3-3
D message segment header 2-1
message segments
DFT message 4-5
ADT 3-4
ORD 7-2
E SIU 5-2
escape character 2-1 XOR 6-1
event (EVN) 4-3 messages 2-1
event code MFN messages 11-3
QRY 8-2 Minimal Lower Layer Protocol 2-1
ZUS 8-2 MRN A-1
event type (EVN) 3-5
event type segment (EVN) 5-3 O
observation/results (OBX) 3-8
F operating room scheduling 5-1
field separator 2-1 ORD interface 7-1
field use 2-2
file header (FHS) 7-2, 10-2 P
financial transaction (DFT) 4-1
patient charges 4-1
financial transaction (FT1) 4-4
patient credits 4-1
formats supported 3-1, 4-1, 5-2, 6-1
patient ID A-1
patient identification (PID) 3-6, 4-3, 5-4
H patient visit (PV1) 3-7, 4-3
HL7 standard 2-1 pick list file (ZPL) 7-4, 9-3
Hybrid Lower Layer Protocol 2-1 pick list message 7-4

IN-2 Index
PK command A-1
code changes A-2
exceptions A-2
pocket activity (ZPM) 4-5
Q
quantity on hand 8-1
Quantity on Hand Report 8-1
query definition segment (QRD) 8-3
query filter segment (QRF) 8-4
R
record level event codes 11-1
repetition separator 2-1
replenishment interface
local supply 1-2
non-stock supply 1-3
REQ interface 8-1
requisition detail segment (RQD) 5-5, 6-3
restock complete (ZRC) 10-4
S
SCH interface 5-1
segment attribute 2-2
segment terminator 2-1
sequence number protocol 2-2
SIU message 5-6
subcomponent separator 2-1
T
transactions tables A-1
trigger event 2-2
U
unit status report (ZSR) 8-4
W
waste tables A-1
X
XOR interface 4-1, 6-1
XOR message 3-10, 6-3
Z
Z segment 8-4, 10-4, 11-3
ZUS message 8-4

Documentation Feedback
This document is designed to provide relevant technical information to those responsible for the
implementation, service, and support of Omnicell products. The Documentation team needs your
input, so we can continue to improve our publications.
Sending Comments to the Technical Documentation Team

Did this document meet your needs? If so, please let us know what we’re doing right. If not, please
provide specific feedback. E-mail or fax your feedback as follows:
 E-mail: Documentation Requests e-mail group at documentationrequests@omnicell.com (specify the
document title or PN).
 Fax: Send this page, along with your feedback, to (650) 251-6266, attention: Documentation.
This document is designed to provide relevant technical information to Omnicell personnel
responsible for the implementation, service, and support of Omnicell Automation Systems.
Feedback Form
Name: E-mail:
Dept./Title: Phone:
Feedback:

HL7 Supply Interface Spec 67-3078C+

Uploaded by

Document Information

Copyright

Available Formats

Share this document

Share or Embed Document

Sharing Options

Did you find this document useful?

Is this content inappropriate?

Copyright:

Available Formats

HL7 Supply Interface Spec 67-3078C+

Uploaded by

Copyright:

Available Formats

HL7 Supply Interface

HL7 Supply Interface Specifications/67-3078 Rev C © 2012 Omnicell, Inc.

HL7 Messages . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-1

ADT Interface . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-1

CHG Interface . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-1

© 2012 Omnicell, Inc. HL7 Supply Interface Specifications/67-3078 Rev C

Financial Transaction Message Segment . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-1

SCH Interface . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-1

XOR Interface . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-1

ORD Interface . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-1

HL7 Supply Interface Specifications/67-3078 Rev C © 2012 Omnicell, Inc.

REQ Interface . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8-1

ASN Interface . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9-1

IRC Interface . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10-1

IMU Interface . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11-1

Appendix A: PK Command . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . A-1

© 2012 Omnicell, Inc. HL7 Supply Interface Specifications/67-3078 Rev C

Documentation Feedback . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . FB-1

HL7 Supply Interface Specifications/67-3078 Rev C © 2012 Omnicell, Inc.

Inventory Interface Information Flow

© 2012 Omnicell, Inc. HL7 Supply Interface Specifications/67-3078 Rev C

Replenishment Interface - Local Supply

2. Print Pick List

Figure 1-1. Replenishment interface for local supply

HL7 Supply Interface Specifications/67-3078 Rev C © 2012 Omnicell, Inc.

Replenishment Interface - Non-Stock Supplies

4. Pick items from

Figure 1-2. Replenishment interface for non-stock supply

© 2012 Omnicell, Inc. HL7 Supply Interface Specifications/67-3078 Rev C

HL7 Supply Interface Specifications/67-3078 Rev C © 2012 Omnicell, Inc.

© 2012 Omnicell, Inc. HL7 Supply Interface Specifications/67-3078 Rev C

Field Use Type

Sequence Number Protocol

Data Field Length

HL7 Supply Interface Specifications/67-3078 Rev C © 2012 Omnicell, Inc.

Figure 3-1. ADT interface

© 2012 Omnicell, Inc. HL7 Supply Interface Specifications/67-3078 Rev C

Supported Message Events

HL7 Supply Interface Specifications/67-3078 Rev C © 2012 Omnicell, Inc.

MSH - Message Header Segment

MSA - Acknowledgement Segment

© 2012 Omnicell, Inc. HL7 Supply Interface Specifications/67-3078 Rev C

ADT Message Segments

HL7 Supply Interface Specifications/67-3078 Rev C © 2012 Omnicell, Inc.

MSH - Message Header

EVN - Event Type

© 2012 Omnicell, Inc. HL7 Supply Interface Specifications/67-3078 Rev C

PID – Patient Identification

HL7 Supply Interface Specifications/67-3078 Rev C © 2012 Omnicell, Inc.

PV1 – Patient Visit

AL1 – Allergy Information

© 2012 Omnicell, Inc. HL7 Supply Interface Specifications/67-3078 Rev C

HL7 Supply Interface Specifications/67-3078 Rev C © 2012 Omnicell, Inc.

MRG– Merge Patient Information

Patient area Mapping - ADT Area

Patient type Mapping

Other Possible Entries

© 2012 Omnicell, Inc. HL7 Supply Interface Specifications/67-3078 Rev C

Sample ADT Message

HL7 Supply Interface Specifications/67-3078 Rev C © 2012 Omnicell, Inc.

Figure 4-1. CHG interface

Financial Transaction Message Segment

Code Segment Definition

© 2012 Omnicell, Inc. HL7 Supply Interface Specifications/67-3078 Rev C