Professional Documents
Culture Documents
Appendix D - TVH OMCL RX Interfaces
Appendix D - TVH OMCL RX Interfaces
Specifications
67-3079 Rev G
About Omnicell
Omnicell, Inc. (NASDAQ: OMCL) is a leading provider of systems and software solutions targeting patient safety
and operational efficiency in healthcare facilities. Since 1992, Omnicell has worked with numerous healthcare
facilities to enhance patient safety and allow clinicians to spend more time with their patients. Omnicell’s
medication-use product line includes solutions for the central pharmacy, nursing unit, operating room, and
patient bedside. Solutions range from large central pharmacy “smart inventory” carousels to small handheld
devices. From the point at which a medication arrives at the receiving dock to the time it is administered,
Omnicell systems store it, package it, bar code it, order it, issue it, and provide information and controls on its use
and reorder.
Our supply product lines provide a healthcare institution with fast, effective control of costs, capture of charges
for payor reimbursement, and timely reorder of supplies. Products range from high-security closed-cabinet
systems and software to open-shelf and combination solutions in the nursing unit, cath lab, and operating room.
Omnicell’s mission is to provide the best customer experience in healthcare, helping hospitals reduce medication
errors, operate more efficiently, and decrease costs. For more information, visit www.omnicell.com.
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.
590 E. Middlefield Road
Mountain View, CA 94043
(650) 251-6100
www.omnicell.com
Omnicell and the Omnicell design mark, OmniBuyer, OmniCenter, OmniRx, OmniSupplier, Pandora, PandoraVIA,
SafetyMed, 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, ProServ1,
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-2015 Omnicell, Inc. All rights reserved.
Table of Contents
Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-1
Intended Audience . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-1
Overview
Automatic information exchange with the other hospital systems is required for the Omnicell
system to be fully integrated. It is recommended that the exchange of information with the
Omnicell system be accomplished via an on-line, real time interface which complies with HL7
standards. Connections can either be a point-to-point with the vendor system or through an
interface engine such as eGate, Cloverleaf, etc.
The exchange of pharmacy 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)
Medication Order information passing from the pharmacy system to the Omnicell system
(RXP)
Formulary item updates from the pharmacy system to the Omnicell system (RXF)
Medication Usage information passing from the Omnicell system to either the pharmacy
system, or the billing system (RXC)
Transmission of bin assignment or un-assignment information from the Omnicell system to
the pharmacy system (ZPM)
Cart fill orders for SinglePointe (Patient Specific Bin) orders from the pharmacy system to
Omnicell (CRT)
Patient administration activities carried out and documented by caregivers in the BPOC/
eMAR system (RAS)
Patient scheduling information passing from the SIU system to the Omnicell system (SIU)
Intended Audience
The intended audience for this document is Omnicell field personnel, business partners, and
customers. This document is intended as a mechanism to document and approve customer
specific interface requirements and functionality. It should be shared with the customer and
business partners during specification analysis to obtain approval prior to development and
implementation. It should not be shared with anyone not involved with this specific
implementation project.
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 Characters 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 the suggested values found in
Delimiter Values column of the message delimiter table (Table 8-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.
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
ADT Interface
Admission, Discharge, and Transfer (ADT) messages are sent from the ADT system to the
Omnicell system via the ADT interface. This allows 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 processes the message to
update Omnicell patient database.
Hospital
System
Application OmniCenter
Interface services
Application
Application
General Information
The interface connections are TCP/IP Socket and MLLP.
Interface services support HL7 v2.1 thru 2.5 formats.
Omnicell is configured as socket server (listening socket).
Interface services requires an IP address and a port number for connecting to Omnicell.
The ADT interface may share a connection with the RXP interface.
Acknowledgment Message
As inbound interface, ADT interface is able to generate the generic HL7 acknowledgment
message (acknowledgment code: AA). A negative acknowledgment (code: AE) is sent when the
ADT interface receives mis-formatted HL7 messages. Omnicell signals the ADT system to send
the next transaction because the current record is rejected. Content validation is performed
during the translation of the message. Content errors are not communicated back to the sending
system.
The acknowledgment message consists of a message header and an acknowledgment segment.
Note: The following tables have OmniCenter tokens in bold under Comments.
Name Definition
MSH Message Header
EVN Event Type
PID Patient Identification
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.
Allergy information can be updated during patient admission with the AL1 message (via ADT
interface). However, allergy information is usually recorded at the time doctors prescribe
medication. Thus, it is common practice to update allergy information from the RDE message
(via RXP interface). The allergy update (AL1) in the ADT interface is disabled by default.
Customers, pharmacy vendor, and the Omnicell installation team must agree on the allergy
update (interface) source.
If the allergy alert feature (AL1) 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.
Required/
Sequence Length Optional Element Name Comments
1 4 O Set ID - OBX
2 2 C Value Type
3 250 R Observation Identifier OBX.3.2=weight or height; updates pwt and pht data fields
respectively in Omnicell
4 20 C Observation Sub-ID
5 5 C Observation Value Value is associated with the value of OBX.3.2; pht for height or
pwt for weight
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 26 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-9. Observation/result
Required/
Sequence Length Optional Element Name Comments
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-10. Merge event
Mapping Tables
Facility
The facility mapping table is used for accommodating multi-facility accounts. It is used for
distributing transactions to the appropriate OmniCenter server. The source of data may change
depending on the vendor system. The data usually originates from the Sending Facility field in the
MSH segment. That value is translated to its corresponding Site ID in Omnicenter.
Patient Area
This 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
This table maps the ADT system’s patient types to their corresponding types in Omnicell. The
following patient types are defined in Omnicell:
Other Entries
Other entries can be site specific. If they are part of the HL7 message, they can be saved in
Omnicell’s database.
EXAMPLE: Payer ID# (from insurance plan); ICD9 (diagnosis code)
RXP Interface
RXP is an inbound interface receiving medication orders from the hospital’s pharmacy system.
The pharmacy system sends a message to the Omnicell system via this interface whenever a
patient’s medication order is created, modified, or discontinued. By tracking the medication order
information, the Omnicell system can prevent users from removing medications from the cabinet
if the medications have not been authorized for a particular patient.
Support for multi-component medication orders (MCMO) came out in the OmniCenter 15.1
release. Refer to “Appendix B: MCMO” on page B-1 for details.
It is expected the pharmacy system will only send verified medication orders.
Hospital
System
Application OmniCenter
Interface ser vices Application
Application
Note: The iv token must be set to Yes for the customer to control the iv flag at med order. This is an option and
conditional if the customer cannot correctly manage the med order route table data. The default value is No
for the token. The customer must be consulted before this change is made.
General Information
The interface connections are TCP/IP Socket and MLLP.
Interface services support HL7 v2.1-5 formats.
Omnicell is configured as socket server (listening socket).
Interface services requires an IP address and a port number for connecting to Omnicell.
The RXP interface may share a connection with the ADT interface.
If ADT and RXP interacts with the same vendor, it is recommended to turn off the PA or PI
command from RXP unless updating allergy from RXP. The PA option was provided in
case Omnicell received ADT information and med orders from two different vendors. It is
used as a back-up in case the ADT initially fails to send patient information.
Populating Area and Room tokens should be avoided in RXP. Allow ADT to manage
patient movement.
Acknowledgment Message
See “Acknowledgment Message” on page 3-3 for details.
Note: The following tables have OmniCenter tokens in bold under Comments.
Required/
Sequence Length Optional Element Name Comments
33 5 O Give Drug Strength Volume
34 250 O Give Drug Strength Volume Units
35 60 O Controlled Substance Schedule
36 1 O Formulary Status
37 60 O Pharmaceutical Substance Alternative
38 250 O Pharmacy of Most Recent Fill
39 250 O Initial Dispense Amount
40 250 O Dispensing Pharmacy
41 250 O Dispensing Pharmacy Address
42 80 O Deliver-to Patient Location
43 250 O Deliver-to Address
44 1 O Pharmacy Order Type
Table 4-2. Pharmacy/treatment encoded order segment (2 of 2)
RXE-1 Quantity/Timing
Fields of interest:
Frequency/Sig (frq) – RXE.1.2.1
Admin Times (admtm) – RXE.1.2.2
PRN indicator (prn) – RXE.1.2.1 (if PRN exists), or RXE.1.6, if used
Start date/time (srdt) – RXE.1.4
Stop date/time (spdt) – RXE.1.5
(TQ) 00221
Components: <Quantity (CQ)> ^ <Interval (RI)> ^ <Duration (ST)> ^ <Start Date/Time (TS)> ^ <End Date/
Time (TS)> ^ <Priority (ST)> ^ <Condition (ST)> ^ <Text (TX)> ^ <Conjunction (ID)> ^ <Order
Sequencing (OSD)> ^ <Occurrence Duration (CE)> ^ <Total Occurrences (NM)>
Subcomponents for Quantity (CQ): <Quantity (NM)> & <Units (CE)>
Subcomponent contains sub-subcomponents:
Subcomponents for Interval (RI): <Repeat Pattern (IS)> & <Explicit Time Interval (ST)>
Subcomponents for Start Date/Time (TS): <Time (DTM)> & <DEPRECATED-Degree of Precision (ID)>
Subcomponents for End Date/Time (TS): <Time (DTM)> & <DEPRECATED-Degree of Precision (ID)>
Subcomponents for Order Sequencing (OSD): <Sequence/Results Flag (ID)> & <Placer Order Number: Entity
Identifier (ST)> & <Placer Order Number: Namespace ID (IS)> & <Filler Order Number: Entity
Identifier (ST)> & <Filler Order Number: Namespace ID (IS)> & <Sequence Condition Value (ST)>
& <Maximum Number of Repeats (NM)> & <Placer Order Number: Universal ID (ST)> & <Placer
Order Number: Universal ID Type (ID)> & <Filler Order Number: Universal ID (ST)> & <Filler
Order Number: Universal ID Type (ID)>
Subcomponents for Occurrence Duration (CE): <Identifier (ST)> & <Text (ST)> & <Name of Coding System
(ID)> & <Alternate Identifier (ST)> & <Alternate Text (ST)> & <Name of Alternate Coding System
(ID)>
RXC Interface
When a drug or item is removed from the Omnicell cabinet, a charge or medication dispense
transaction is automatically generated for the patient for whom the item was selected. If an item is
returned to the cabinet, a credit transaction is automatically generated for the patient from whom
the item was returned. This charge/billing information is sent from the Omnicell system to the
hospital’s pharmacy or financial system in real time mode via the RXC interface. A DFT message
will be generated by the Omnicell system and sent immediately to the hospital’s pharmacy or
financial system whenever a chargeable transaction occurs on the Omnicell system. A site may
choose to use the Medication Dispense (DFT) or Charge for Medication Dispense (RDS) message.
Hospital
System
Application OmniCenter
Interface ser vices Application
Application
General Information
The interface connections are TCP/IP Socket and MLLP.
Interface services support HL7 v2.1-5 formats.
Omnicell is configured as socket client.
Interface services requires an IP address and a port number for connecting to Omnicell.
The RXC interface may share a connection with the ZPM interface.
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.
Note: The following tables have OmniCenter tokens in bold under Comments.
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 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 Facility in
NODE.INI.
3 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 Receiving
Application in NODE.INI.
4 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 Receiving Facility in
NODE.INI.
Event (EVN)
Required/
Sequence Length Optional Element Name Comments
0 3 R Segment Name EVN
1 3 R Event Code P03
2 16 R Transaction Date and Time Format: YYYYMMDDHHMMS
Table 5-2. Events
* Format for patient location element = 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 (-).
* Format for patient location element = 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 (-).
ZPM Interface
The ZPM interface handles bin load and unload activities.
Bin loading occurs when a new drug is needed for regular administration to a patient in a certain
area. The pharmacy adds the drug to the local formulary for the cabinet servicing that patient.
The initial supply of the drug is brought to the cabinet. A bin is selected, assigned, and stocked
with the new drug. An update message is then sent to the pharmacy system. The message
automatically updates the floor stock tables. This allows the system to always be aware of what is
available in each cabinet.
Bin unloading occurs when there is no longer a need for a drug in a specified area. The remaining
supply is sent back to the pharmacy. The bin is unassigned to make room for the next drug that is
needed locally.
The list of drugs available in each area of the hospital may be in a constant state of flux. The bin
load/unload messages allows the pharmacy system to determine when a drug needs to be sent
from the pharmacy to fill an order or allow the drug to be dispensed from the cabinet.
Hospital
System
Application OmniCenter
Interface ser vices Application
Application
General Information
The interface connections are TCP/IP Socket and MLLP.
Interface services support HL7 v2.1-5 formats.
Omnicell is configured as socket client.
Interface services requires an IP address and a port number for connecting to Omnicell.
The ZPM interface may share a connection with the RXC interface.
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.
Note: The following tables have OmniCenter tokens in bold under Comments.
1 Source of data may change depending on the vendor system. A Facility mapping table may be needed for multi-facility accounts. Otherwise, get value from Sending Application in NODE.INI.
2 Source of data may change depending on the vendor system. A Facility mapping table may be neededfor multi-facility accounts. Otherwise, get value from Sending Facility in NODE.INI.
3 Source of data may change depending on the vendor system. A Facility mapping table may be needed for multi-facility accounts. Otherwise, get value from Receiving Application in NODE.INI.
4 Source of data may change depending on the vendor system. A Facility mapping table may be needed tfor multi-facility accounts. Otherwise, get value from Receiving Facility in NODE.INI.
1 Derived from xty and xmi token. L (xty = M and xmi = Assign), U = (xty = M and xmi = Delete), C (xty = S, O, D or K)
2 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.
RXF Interface
The formulary update interface (RXF) keeps pharmacy items in the Omnicell database in sync
with the formulary in the pharmacy system. RXF is used to populate a master item list which can
be copied when adding a new drug to a cabinet.
It is assumed that the pharmacy system is the owner of the pharmacy formulary file. Therefore,
any modifications, additions, or deletions, which are made to the formulary file, must be entered
into the pharmacy system. Whenever users at workstations on the pharmacy system modify, add,
or delete items, an interface message could be formatted and transmitted to the Omnicell system.
The Omnicell system processes the message to update Omnicell files. This application is typically
a real-time interface. Third-party vendors normally send formulary update messages with
medication orders on the same CP/IP socket feed. Transmission of data occurs as frequently as
necessary to keep the Omnicell items database in sync with the pharmacy system’s formulary.
Hospital
System
Application OmniCenter
Inter face ser vices Application
Application
General Information
The interface connections are TCP/IP Socket and MLLP.
Interface services support HL7 v2.1-5 formats.
Omnicell is configured as socket server (listening socket).
Interface services requires an IP address and a port number for connecting to Omnicell.
The RXF interface may share a connection with the ADT and RXP interfaces.
Code Description
MAD Add record
MUP Update record
MDL Delete record – NOT SUPPORTED
Acknowledgment Message
Refer to“Acknowledgment Message” on page 3-3 for details.
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.
Note: The following tables have OmniCenter tokens in bold under Comments.
Required/
Sequence Length Optional Element Name Comments
1 varies R Master Item File Table Entry
1.1 16 Drug ID item – same as MFE.4
1.2 48 Drug Description ina
2 10 R Location osi – mapped by RXF.FacilityMasterOmni
3 16 R Charge ID cid
4 48 R Brand Name of Drug Item alias
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)
8 6 Quantity on Hand Not updated unless requested (qoh)
9 4 Unit of order, Unit of Re-stock Uoo, 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
18.1 14 R Unit Dose Strength of Drug dssa
18.2 14 R Unit Dose Strength unit of Drug dssu
19.1 14 R Unit Dose Volume dsa
19.2 14 R Unit Dose Volume unit dsu
20.1 14 R Total Volume dsva
20.2 14 R Total Volume unit dsvu
21 7 R Unit Dose Drug Form dsf
22 1 R DEA Schedule aclv
23.1 16 Manufacturer ID mfno
23.2 16 Manufacturer /Name mfna
Table 7-3. Formulary maintenance segment (ZMI)
Required/
Sequence Length Optional Element Name Comments
1 1 R Formulary Code A - add; C - Change, D- Delete
2 16 R Medication/Drug ID Medication identifier in external system; mapped in
application and is configurable
3 48 R Medication/Drug Name string format; contains generic name (ina)
4 1 R Medication Class DEA schedule based on the state where facility is located
(aciv)
5 16 O Alternate Med ID
6 16 R Facility Code Same as MSH-4
7 48 O Brand Name Item alias
8 7 O Dosage Form dsf
9 14 R Strength dssa
10 5 R Strength Units dssu
11 14 R Volume liquids only
12 5 R Volume Units liquids only
13 varies O Alternate Med 2 ID
14 varies O Therapeutic Class
15 16 O Cost ucs
16 16 O Charge cid
17 20 O Manufacturer Interface may send full description, abbreviated name, or
manufacturer code (mnfo)
Table 7-4. Formulary maintenance segment (ZFM)
MSH|^~\&||HISF_8449|||200709130826||MFN|OMNI-OUT.2.2192199|P|2.2
MFI|MIF^Master Item File||UPD|||NE
MFE|MAD|||12345^ACETAMINOPHEN^99PSD^12345^DIGOXIN^99PSN|CE
ZMI|AXID150^Nizatidine^AXID150|*|AXID150|aliasname|||||||||||Y|||150^MG|^|150^MG|
CAP
Nurse-prepared IV Identification
Medication labels printed for nurse-prepared IV mixtures print component dose details.
Medication labels printed for non-IV nurse-prepared medication orders print total intended dose
for the order. The nurse-prepared med order must be properly identified for the system to make
the distinction and print the label appropriately. If the medication order is identified as IV and the
medication order is nurse-prepared, then component dose details are printed on the label. There
are two ways in which customers can identify a nurse-prepared order as IV or non-IV:
Modifying the IV token name at the interface level. This option requires assistance from an
interface analyst. [Interface affected: RXP]
Note: The C++ version of the RXP interface must be upgraded to Omnicell Interface Services (OIS).
Checking the Med Order Route IV check box at OmniCenter: Database tab > Medication Order
table > Routing/Scheduling
Either option is valid. Interface analysts must discuss the available options with the customer so
that the customer can determine the best course of action. If an interfaces change is desired, the
following table defines the settings.
Example
Label for Nurse-prepared IV mixture
Appendix B: MCMO
Support for multi-component medication order (MCMO) was introduced with the release of
OmniCenter 15.1. Only the OIS version of RXP interface is supported. Customers who want to
use this new feature may request an RXP upgrade at no charge.
For all med orders, multiple component or not, MCMO is now created by the OIS services
because it is now a part of the OmniCenter med order requirement.
Features
Pharmacy prepared orders for patient specific bins
Med orders pre-mixed at the Pharmacy
Only SinglePointe cabinets supported
Basic Complex Meds
Med orders mixed at the nursing stations
Drug components available in the cabinets as single item bins
Each component drug sent as separate DFT or RDS messages via RXC interface
Best guess logic used by OmniCenter to determine Med Order ID for returns and wastes
transactions
Note: Med Order IDs will be accurately reported when the PMA Plus feature is released in a future
version of OmniCenter.
The new, mix type token (mixty) is an optional field. Possible values are:
P - Pharmacy mix
N - Nurse prepared
MCMO - if type is not sent by RXP
Important: For new installs or upgrades, inquire if the pharmacy system can be identified as pharmacy
prepared or nurse prepared med order in the HL7 RDE message. This is very important if SinglePointe
feature is intended to be used by the hospital.
Component drugs are parsed into the moc token as XML strings.
The Single Additive feature (one additive/one base med order) is still supported using the bitem
token.
Note: Single Additive orders are nurse mix by default. However, setting the mixty token to P forces the
med order to be a pharmacy pre-mix order.
Appendix C: 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.
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.
Note: Multi-use vials are not subject to payment for discarded amounts of drug or biological.
The official instruction (CR6711) may be viewed on the CMS website at:
http://www.cms.gov/Transmittals/downloads/R1962CP.pdf
Medicare may require that all waste be billed separately. If so, the billing/dispense interface (RXC
and CHG) may need to be updated to process waste transactions.
OmniCenter Configuration
This sections provides a guideline for configuring Omnicenter. It also covers modification of the
billing/dispense interface so waste transactions are sent to the billing or PIS system.
Background
Interface modification on the Omnicell side is dependent upon the interface requirements from
the pharmacy vendor system. This is because the pharmacy system is the receiving application.
The medicine dispense interfaces (RXC) at all customer sites (with few exceptions) communicate
inventory quantity (EA, TAB, VIAL) to the pharmacy system. In the HL7 message, the unit of
measure is not even part of the message. With partial waste credit, the quantity will have a
fractional value. The pharmacy systems may not be able to accommodate the fractional value until
they are upgraded to support the new Medicare regulation. The third-party vendors may also
decide to require the ADC systems to communicate partial waste credit quantity in dose unit of
measure.
The customer must be requested to initiate a discovery meeting with PIS vendors to define
interface requirements as required by the PIS system.
All Versions
[OmniCenter] Turn on Credit patient for waste.
[Administration tab] Select Patient Related Setup for Credit patient for waste.
Valid items
1. Follow the rules of 2 and 6.
2. Retrieve dose amount from xaamt and dose unit from dssu.
3. If issue unit is requested, use qty. Otherwise, quantity can be calculated by dividing xaamt into
pkd. The result could be fractional.
4. Use uoi for UOM.
Invalid Items
Get waste data from the waste quantity token (wqty). The expected format of this field is: n uuu
where n = quantity and uuu = unit; (Example: 5 mg.)
Note: There is no guaranteed format as wqty is a free text field. As such, it cannot be calculated. Users
must be educated on how to enter waste on Color Touch cabinets.
In either scenario (valid/invalid items), the RXC interface should be able to calculate waste
quantity in inventory unit of measure if the pharmacy vendor system requires it.
Important: This may change the nurse workflow so discuss this with the customer before making
changes. This may be a normal setup at most hospitals.
Note: Waste quantity is only available in the wqty token. It is a free-text field. (Example: 4 MG) Quantity
can be calculated if the XI transaction has the dxa token set to Y. This indicates the wqty token is
formatted as waste amount in dose unit of measure appended by dssu value.
Billable Upgrade
From the interface development perspective, this is a billable upgrade which should be quoted for
12 hours T&M (time and manpower).
Index
A financial transaction (FT1) 5-4
acknowledgement formulary maintenance (ZFM) 7-5
message header 3-3 formulary maintenance (ZMI) 7-4
segment (MSA) 3-4 formulary update interface (RXF) 7-1
acknowledgement message 3-3
ADT G
interface 3-1 give code (RXE-2) 4-7
message header 3-5
message segments 3-4 H
sample message 3-11 HL7 10-1
system 3-1 HL7 standard 1-1, 2-1
Hybrid Lower Layer Protocol 2-1
B
backward compatibility 2-2 I
bin load 6-1 ICD9 3-10
bin unload 6-1 interface engine 1-1
BPOC 9-1 IV token A-1
C L
cart fill order 8-1 label printing A-1
charge for medication (RDS) 5-1
common order segment (ORC) 4-4 M
communications protocol 2-1
mapping table
component dose A-1
USR 10-3
component separator 2-1
mapping tables 3-10
CRT interface 8-1
facility 3-10
CRT message segments 8-2
other entries 3-10
patient area 3-10
D patient type 3-10
DFT message 5-5 master file entry (MFE) 7-3
DFT message segments 5-1 master file identification (MFI) 7-3
MCMO B-1
E interface changes B-1
Electronic Medical Records 9-1 Medicaid services D-1
eMAR 9-1 medical record number C-1
escape character 2-1 Medicare billing D-1
event (EVN) 5-3 Medication Administration 9-3
event types 3-5 medication dispense (DFT) 5-1
medication label printing A-1
F medication orders A-1
field mapping 8-2 merge event segment (MRG) 3-10
field separator 2-1 message events 3-2
field use 2-2 message header
USR 10-2
Feedback Form
Name: E-mail:
Dept./Title: Phone:
Feedback: