Aware Gateway HL7 Manual
Aware Gateway HL7 Manual
Aware™ Gateway
HL7 Reference Manual
Aware™ Gateway
English
2018527-021
2028948-001C
© 2006, 2007 General Electric
Company.
All rights reserved.
NOTE
The information in this manual applies to GE Aware Gateway software v1 and later. It does not apply to earlier software
versions. Due to continuing product innovation, specifications in this manual are subject to change without notice.
NOTE
For technical documentation purposes, the abbreviateion GE is used for the legal entity name, GE Medical Systems
Information Technologies.
Listed below are GE Medical Systems Information Technologies trademarks. All other trademarks contained herein are the
property of their respective owners.
AWARE and UNITY NETWORK are trademarks of GE Medical Systems Information Technologies registered in the United
States Patent and Trademark Office.
Compatibility . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-3
A Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . A-1
Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . A-2
C Abbreviations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . C-1
Abbreviations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . C-2
Manual Information
Revision History
Each page of the document has the document part number and revision letter at the
bottom of the page. The revision letter changes whenever the document is updated.
Revision Comments
B Updated the PID and OBX data segment information and the BP, NICO
and Temperature sub-parameter information.
C Updated the ADT business rules definition information for A01, A28,
and A31.
In the Workflow Implementation section, clarified which patient
identification information is used to look up patient records.
Updated the Transcutaneous CO2 (TCO2) sub-parameter
information.
Updated/clarified information for daylight saving time adjustments,
adding HIS mappings, and adding units to a bed list.
Manual Purpose
The GE systems can be connected to hospital information systems (HIS) by the
Health Level Seven standard interface (HL7). This document is intended to be a
technical reference to GE customers implementing the HL7 outbound interface as
well as the ADT inbound interface. It contains data formats for the transmission of
data and describes the requirements for interfacing to the GE system using the HL7
standard. This document does not describe how transactions are processed by the GE
system or the clinical impact of using some of the features described here.
This document is not intended to provide instructions for implementing and using the
HL7 standard. Details of the HL7 standard can be found in Health Level Seven
Version 2.3 or later.
Intended Audience
This manual is intended for service representatives and technical personnel who
maintain, troubleshoot, or repair this equipment.
Manual Conventions
This section describes terminology, standards, and other conventions that are used
throughout this manual.
The safety statements presented in this chapter refer to the equipment in general.
Look for additional safety information throughout the rest of the manual.
The order in which safety statements are presented in no way implies order of
importance.
Ordering Manuals
To order additional copies of this manual, contact your local GE representative and
request the part number on the first page of the manual.
Service Information
Service Requirements
Follow the service requirements listed below.
Warranty
Please refer to the documentation delivered with your system for your warranty
information.
Equipment Identification
Every GE device has a unique serial number for identification. A sample of the
information found on a serial number label is shown below.
### ## ## #### # #
A B C D E F
Description
A product code1
B year manufactured
E manufacturing site
F miscellaneous characteristic
1The product codes for the Aware Gateway DL360 G3 server is SAG,
DL360 G4 server is SCB, and DL360 G4p server is SCR.
The goal of the HL7 standard is to standardize message content and usage, while
allowing user-specific variations within the standard. To accomplish this, the HL7
standard specifies encoding rules used to create the message format. Based on these
rules, the messages generally consist of data fields and data segments.
Multiple Segments
A message is comprised of multiple segments. While some of the segments are
required to create a message, others are optional. Each segment within the HL7
message is separated by special segment separator characters.
Segment 1
Message
Data Elements
Each segment contains a number of data elements. The data elements may be of
varying lengths. Like the segments, they are separated from each other by special
separator characters. A number of data elements and their separators are logically
grouped together to create a data segment such as the message header segment or the
patient identification segment. With the exception of the segment separator
characters, the data contained in HL7 messages consists of displayable ASCII
characters.
Each data segment begins with a three character value, for example “MSH” for the
message header segment. These three characters uniquely identify the segment within
a given message. Segments are identified as either required or optional, and some
may be repeated. Similar to data fields, data segments are separated from each other
by segment separator characters.
Based on the HL7 encoding rules, each message within the HL7 protocol has a known
structure. The data segments and data fields that comprise a given message are always
the same. As a result, an individual data field can be found within a message simply
by knowing its configured position in a segment.
HL7 Communication
HL7 messages are passed between computer systems whenever a valid transaction
occurs. For example, receiving a completed test result on the Aware Gateway system
would cause an HL7 message to be generated and sent. After a message is sent, the
receiving system processes the message. When processing is complete, the receiving
system should generate an application level acknowledgment that is returned to the
sending system.
Since the HL7 standard provides flexibility in message content and format, and in
communication protocol options, its implementation requires mutual agreement
between the sending and receiving computer systems on the following items:
message formats
acknowledgment protocol
communication protocol
data handling
Communication between HIS personnel and GE interface personnel is essential to
determine the customer-specific use of the HL7 standard.
NOTE
The HIS can use the result messages in either of the following ways:
To make test results available for access on the hospital computer system.
To generate charges for completed tests.
ADT Inbound
WARNING
LOSS OF FUNCTION—Do not operate with more than one ADT
server on the Unity Network. Multiple ADT servers on the same
network could potentially disable the ADT system.
Introduction
The purpose of this chapter is to provide an understanding of the ADT business rules
for the Aware Gateway.
CIC Pro/
ApexPro
Hospital
Information Solar
Server
(HIS)
Labs
ADT
Database
ETC.
Enterprise Gateway
ETC.
Unity Network Interface
003A
Process
1 Patient information data from the HIS constantly streams into the Aware Gateway.
2 Patient data from the HIS is held in ADT database by the Enterprise Gateway.
3 A Unity monitor generates a query which is sent to the ADT database in the
Enterprise Gateway
4 Data held in ADT Database is sent to the requesting Unity monitor on the Unity
Network MC network.
Scope
This chapter defines specific business rules for ADT messages sent to the Aware
Gateway from a HIS. It also defines how ADT messages are processed before they
are stored on the local database and relayed to other GE products. Issues such as:
general storage, ADT message queries, etc., are detailed in separate documents.
Overview
Hospital Information Systems generate a variety of patient admit, discharge and
transfer messages using the HL7 ADT message type. There are about 50 different
types of ADT messages, ranging from patient admit to change alternate visit ID. The
Aware Gateway helps relay the ADT messages to other GE products as well as
sending for database storage.
The Aware Gateway uses the business rules defined to add/update/delete records and/
or attributes in the database. Users can configure these business rules to suit custom
needs.
Workflow Implementation
The following workflows have been implemented. For Enterprise Gateway (EG) only
the PID and PV1 segments shall be persisted in the EG database.
NOTE
If the Admit Flag is set to true and if matching encounters/accounts are not found
then new encounters/accounts shall be created. This is applicable for all but the
Admit and Delete Patient workflows.
If the field is empty, the value is unaffected. If the field contains the HL7 NULL
(usually “”) the corresponding field is cleared.
Database entity
HL7 HL7
Create Update Delete
Function Definition
A01 Admit patient If patient does not already exist If patient already exists, update None
create following entities as following entities as applicable:
applicable: Person Identifier, Person Name, Person,
Person Name, Person, PersonCodedProperty,
PersonCodedProperty, PersonAddress, PersonTelecom,
PersonAddress, PersonTelecom, PersonLanguage,
PersonLanguage, PatientRelatedPerson,
PatientRelatedPerson, PatientCodedProperty, Patient,
PatientCodedProperty, Patient, Encounter, Place,
Encounter, Place, EncounterCodedProperty,
EncounterCodedProperty, EncounterIdentifier, Account,
EncounterIdentifier, Account, CareProviderParticipation
CareProviderParticipation
A02 Transfer If patient does not already exist If patient already exists, update None
patient AND Admit flag checked, then the following entities as
same as ‘Admit patient. Else No applicable: Encounter, Place.
change. (New patient location should
appear in PV1-3 and old location
in PV1-6).
A03 Discharge/end If patient does not already exist If patient already exists, update None
visit AND Admit flag checked, then the following entities as
same as ‘Admit patient. Else No applicable: Encounter, Place,
change. and Person.
A06 Change If patient does not already exist If patient already exists, update None
Outpatient to AND Admit flag checked, then the following entities as
Inpatient same as ‘Admit patient. Else No applicable: Encounter, Place,
change. PersonIdentifier
A07 Change If patient does not already exist If patient already exists, update None
Inpatient to AND Admit flag checked, then the following entities as
Outpatient same as ‘Admit patient. Else No applicable: Encounter,
change. EncounterIdentifier, Place,
PersonIdentifier
A08 Update If patient does not already exist Same as ‘Admit Patient’ None.
Patient Info AND Admit flag checked, then
same as ‘Admit patient. Else No
change.
A09 Patient If patient does not already exist If patient already exists, update None
departing AND Admit flag checked, then the following entities as
(same as A02) same as ‘Admit patient. Else No applicable: Encounter, Place.
change.
A10 Patient If patient does not already exist If patient already exists, update None
arriving (same AND Admit flag checked, then the following entities as
as A02) same as ‘Admit patient. Else No applicable: Encounter, Place.
change.
Database entity
HL7 HL7
Create Update Delete
Function Definition
A11 Cancel admit If patient does not already exist None If patient already exists,
AND Admit flag checked, then delete following entities:
similar to ‘Admit patient’ but without Encounter, Place,
any encounter/account info; create EncounterCodedProperty,
the following entities as applicable: EncounterIdentifier, Account,
Person Name, Person, Order,
PersonCodedProperty, CareProviderParticipation
PersonAddress, PersonTelecom, Else No change
PersonLanguage,
PatientRelatedPerson, Patient,
PatientCodedProperty Else No
change
A12 Cancel If patient does not already exist If patient already exists, update None
transfer (same AND Admit flag checked, then the following entities as
as A02) same as ‘Admit patient. Else No applicable: Encounter, Place.
change. (PV1-3 Assigned Patient
Location must now show Prior
patient location).
A13 Cancel If patient does not already exist If patient already exists, update None
discharge AND Admit flag checked, then the following entities as
same as ‘Admit patient. Else No applicable: Encounter, Place,
change. Person. (PV1-3 must show
patient location after
cancellation; use PV1-6 for
patient location prior to
erroneous discharge).
A14 Pending admit Same as ‘Admit patient’ Same as ‘Admit patient’ None
A15 Pending If patient does not already exist If patient already exists, update None
transfer AND Admit flag checked, then the following entities as
same as ‘Admit patient. Else No applicable: Encounter, Place.
change.
A16 Pending If patient does not already exist If patient already exists, update None
discharge AND Admit flag checked, then the following entities as
same as ‘Admit patient. Else No applicable: Encounter, Place.
change.
A17 Swap patients If none of the patients exist AND If both patients already exist, None
Admit flag checked, then ‘Admit update the following entities as
patients’ with new locations. If one applicable for both patients:
of the patients missing AND Admit Encounter, Place. (Patient1’s
flag checked, then ‘Admit’ the new location should match
missing patient and update the Patient2’s prior location and
existing patient with new locations. vice-versa). If one of the patients
Else No change. missing AND Admit flag un-
checked, then update the
existing patient with new
location. Else No change.
A18 Merge patient Not directly supported using A18 Scripts convert the A18 message None
info workaround. Refer to the Aware into either A34, A35 or A36
Gateway Service Manual for merge messages based on MRG
implementation details. fields that are populated. See
A34, A35 and A36 message
definitions.
Database entity
HL7 HL7
Create Update Delete
Function Definition
A21 Patient on If patient does not already exist If patient already exists, update None
‘leave of AND Admit flag checked, then the Encounter entity for
absence’ same as ‘Admit patient’ Else No ‘Expected LOA return time’
change.
A23 Delete a If patient does not already exist None If patient already exists,
patient record AND Admit flag checked, then delete following entities:
similar to ‘Admit patient’ but without Encounter, Place,
any encounter/account info; create EncounterCodedProperty,
the following entities as applicable: EncounterIdentifier, Account,
Person Name, Person, Order,
PersonCodedProperty, CareProviderParticipation
PersonAddress, PersonTelecom, Else No change
PersonLanguage,
PatientRelatedPerson, Patient,
PatientCodedProperty Else No
change
A24 Link patient Involves ‘linking’ two different PIDs None None
info. but not merging.
A25 Cancel If patient does not already exist If patient already exists, update None
pending AND Admit flag checked, then the following entities as
discharge same as ‘Admit patient. Else No applicable: Encounter, Place.
change.
A28 Add person If patient does not already exist If patient already exists, update None
info (a subset (similar to ‘Admit’ but without the following entities as applicable:
of Admit) encounter/account info) create Person Name, Person,
following entities as applicable: PersonCodedProperty,
Person Identifier, Person Name, PersonAddress, PersonTelecom,
Person, PersonCodedProperty, PersonLanguage, Patient,
Patient, PersonAddress, PatientRelatedPerson,
PersonTelecom, PersonLanguage, PatientCodedProperty
PatientRelatedPerson,
PatientCodedProperty
Database entity
HL7 HL7
Create Update Delete
Function Definition
A31 Update person If patient does not already exist If patient already exists, update None
info (similar to AND Admit flag checked create following entities as applicable:
A08, but A08 following entities as applicable: Person Name, Person,
is used for Person Identifier, Person Name, PersonCodedProperty,
current Person, PersonCodedProperty, PersonAddress, PersonTelecom,
episode). Patient, PersonAddress, PersonLanguage, Patient,
PersonTelecom, PersonLanguage, PatientRelatedPerson,
PatientRelatedPerson, PatientCodedProperty
PatientCodedProperty Else no
change.
A32 Cancel patient If patient does not already exist If patient already exists, update None
arriving (same AND Admit flag checked, then the following entities as
as A02) same as ‘Admit patient. Else No applicable: Encounter, Place.
change.
A33 Cancel patient If patient does not already exist If patient already exists, update None
departing AND Admit flag checked, then the following entities as
(same as A02) same as ‘Admit patient. Else No applicable: Encounter, Place.
change.
A34 Merge patient Matching patient records within the Source patient record is merged Source patient is removed
info (pat ID ADT database are identified. into the destination record. from the ADT database .
only)
A35 Merge patient Visits with the source account Source account number is None.
info(acct number within the patient record in merged into the destination
number only) the ADT database are identified. account.
A36 Merge patient Merged record is created. Source patient account record is Source patient account/visit is
info (pat ID & merged into destination account/ removed from the ADT
act number) -visit records. database .
Database entity
HL7 HL7
Create Update Delete
Function Definition
A43 Move pat info - Not supported as MRG segment None None
pat identifier not currently mapped in PDM
list
A44 Move acct info Not supported as MRG segment None None
- pat acct not currently mapped in PDM
number
A45 Move visit info Not supported as MRG segment None None
- visit number not currently mapped in PDM
A52 Cancel leave If patient does not already exist If patient already exists, update None
of absence AND Admit flag checked, then the Encounter entity for
same as ‘Admit patient’ Else No ‘Expected LOA return time’
change.
Database entity
HL7 HL7
Create Update Delete
Function Definition
NOTE
The following ADT workflows are not supported: ADT A14-A16, A18-A22,
A24-A28, A30-A33, A37, and A39-A62.
Workflow Implementation
The following workflows have been implemented. For Enterprise Gateway (EG) only
the PID and PV1 segments shall be persisted in the EG database.
NOTE
If the Admit Flag is set to true, and if matching patient identification information
(PID 3-MRN and PID 19-SSN number, if present) is not found, then new
encounters/accounts shall be created. This is applicable for all but the Admit and
Delete Patient workflows.
Admit Patient
The information below applies to the following workflows.
Admit Patient
Register Patient
Pre-Admit Patient
Patient Arriving
Pending Admit
If patient does not already exist, the new patient shall be inserted. All applicable
attributes (as contained in the incoming ADT message) within the PDM entities
Patient, Person, Encounter and Account shall be persisted.
If patient already exists, this shall become an ‘Update Patient’ workflow (described
below).
Transfer Patient
The information below applies to the following workflows.
Transfer Patient
Pending Transfer
Pending Discharge
Patient Departing
Cancel transfer
Cancel patient arriving
Cancel patient departing
Cancel pending discharge
Cancel pending transfer
Add person information
If patient does not already exist AND Admit Flag is true, the new patient shall be
inserted after setting the Status Code of the Encounter entity to ACTIVE.
If patient does not already exist AND Admit Flag is false, then a PDMException shall
be thrown.
If patient already exists, Assigned and Prior locations of the patient shall be set within
the Encounter entity. Status Code shall also be set to ACTIVE.
Discharge Patient
If a patient does not already exist AND the Admit Flag is true, a new patient is
inserted after assigning the Assigned location to Prior location and setting Assigned
location to null; also the Status code is set to Inactive/Expired as appropriate.
If a patient does not already exist AND the Admit Flag is false, then a PDMException
is thrown.
If a patient already exists, Prior location is set to Assigned location, Assigned location
is set to null and Status code is set to Inactive/Expired as appropriate.
If a patient does not already exist AND the Admit Flag is false, then a PDMException
is thrown.
If a patient already exists, the attributes Assigned location, Prior location, Patient
Class, Patient Account Number and Status code (set to Active) are updated.
If a patient does not already exist AND the Admit Flag is false, a PDMException is
thrown.
If a patient already exists, the attributes Assigned location is set to Prior location, null
to Assigned location; attributes Patient Class, Patient Account Number and Status
code (set to Active) are updated.
If patient does not already exist AND Admit Flag is false, then a PDMException shall
be thrown.
If patient already exists, all applicable attributes within the PDM entities Patient,
Person, Encounter, Account, and CareProviderParticipation shall be updated with the
new incoming values as appropriate.
Cancel Admit
The information below applies to the following workflows.
Cancel Admit
Cancel Pending Admit
Cancel Pre-Admit
If patient does not already exist AND Admit flag checked, then similar to ‘Admit
patient’ but without any encounter/account info; create the following entities as
applicable: Person Name, Person, PersonCodedProperty, PersonAddress,
PersonTelecom, PersonLanguage, PatientRelatedPerson, Patient,
PatientCodedProperty Else No change.
Cancel Discharge
If patient does not already exist AND Admit flag checked, then same as ‘Admit
patient. Else No change.
If patient already exists, update the following entities as applicable: Encounter, Place,
Person. (PV1-3 must show patient location after cancellation; use PV1-6 for patient
location prior to erroneous discharge).
Delete Patient
If patient does not already exist, a PDMException shall be thrown.
Swap Patient
If none of the patients exist AND Admit flag checked, then ‘Admit patients’ with new
locations. If one of the patients missing AND Admit flag checked, then ‘Admit’ the
missing patient and update the existing patient with new locations. Else No change.
If both patients already exist, update the following entities as applicable for both
patients: Encounter, Place. (Patient1’s new location should match Patient2’s prior
location and vice-versa). If one of the patients missing AND Admit flag un-checked,
then update the existing patient with new location. Else No change.
If patient already exists, update the Encounter entity for ‘Expected LOA return time.
When updated, the Source patient account record is merged into destination account/-
visit records.
If patient already exists, when deleted the Source patient/account/visit are removed
from the ADT database as appropriate.
General Description
Introduction
The HL7 standard interface is used to connect a hospital’s information system (HIS)
to the GE system for the transfer of data. Using the HL7 outbound interface, the GE
system can return result messages to the HIS.
CIC Pro/
ApexPro
Hospital
Information Solar
Server
(HIS)
Work-
Aware Gateway Dash
Station
(PC)
002A
Process
1 Patient data is acquired on the Unity Network MC network, and enters the Aware
Gateway via an Ethernet network connection.
2 Unity Network MC Patient data is converted to HL7 data by the Unity Network
Interface.
Process
3 HL7 data from the Unity Network Interface is handed off to the Quovadx HL7
Interface Engine (running inside the Enterprise Gateway), where the data
undergoes a further custom translation to fit the specific communication needs of
the HIS. This second data translation also employs the HL7 protocol.
NOTE
It is important that the Enterprise Network time and the Unity Network MC
network time be synchronized for the time stamps on patient data to match.
The NTP Time Synchronization feature can be used to accomplish this task.
Compatibility
The Aware Gateway will collect data from various GE monitoring products. See the
Aware Gateway Service Manual for a list of compatible devices.
WARNING
LOSS OF FUNCTION—Do not operate with more than one ADT
server on the Unity Network. Multiple ADT servers on the same
network could potentially disable the ADT system.
The Gateway will send data at the configured time intervals of 1, 2, 3, 4, 5, 10, 15, 30,
45, and 60 minutes. Collection intervals can be set for each device enabled to send
data. For a detailed list of the data, see Appendix B.
Client/Server Connections
HL7 Outbound
Any HIS that communicates with the HL7 Outbound application with Aware
Gateway must act as the server. The Aware Gateway HL7 Outbound client
application tries to open a connection on a preconfigured specific IP address and port.
It will connect with the server once the server port is established. The Aware Gateway
continuously tries to connect to the HIS on a regular periodic interval using the auto
connection feature of the Quovadx engine. The Aware Gateway Quovadx engine will
transfer the HL7 messages to the HIS server by TCP/IP socket connection and retry
the message up to three times.
ADT Inbound
Any HIS that communicates with the ADT Inbound application with Aware Gateway
version 1.1 or greater must act as the TCP/IP client. The Aware Gateway ADT
Inbound process uses the Quovadx engine to listen on a preconfigured specific port.
The Aware Gateway server will connect with the HIS client that initiates a connection
to the Quovadx engine server port.
The Aware Gateway contains HIS auto replay implementation on the his_prod
Quovadx site to handle patient data should the HIS get disconnected or a network
outage occur. The following two processes are used in this implementation:
Trigger 1 — If there is a disconnection from the HIS, the Aware Gateway will
begin to send the data to the Relay_mgs_cache file located in the C:\gems-
it\eg\Quovadx\Qdx5.2\integrator directory.
Trigger 2 — When the HIS reconnects and is running, the Aware Gateway will
read the data file and forward the data to the HIS.
Trigger 3 — If the HIS disconnection lasts for more that 12 hours, the Aware
Gateway will stop collecting data and will wait for the HIS reconnect.
Trigger 4 — The Aware Gateway will forward all the data until the end of the file
is reached. It will then stop the forwarding and delete the data file.
Disconnection Types
HL7 Outbound
If the HIS is disconnected from the network for any reason, the data for that time
period will be cached within the Aware Gateway Quovadx engine for up to 12 hours.
Upon HIS reconnection to the network, the Aware Gateway will replay the missed
data and continue to process current Vital Sign Trend HL7 data messages.
NOTE
For instructions on changing the data caching parameter, see the Aware Gateway
service manual.
Unity Monitors
When a monitoring device is disconnected from the network for any reason (e.g.,
disconnected, in transport, rover, etc.), the data for that time period shall be missed.
An algorithm has been implemented to retrieve all missed data, if possible, up to a
maximum of 8 hours, and send it to the Aware Gateway Quovadx engine, if the
monitoring device has not been discharged during that time. The algorithm does this
by keeping track of all possible server/monitor device pairs and the last good HL7
message acknowledgment time for each of these pairs.
ADT Inbound
If the Aware Gateway and the HIS client get disconnected from the network for any
reason, the Aware Gateway will process all in-progress ADT Inbound messages. The
Aware Gateway Quovadx engine server will continue to listen of the specified port for
the HIS client to initiate a new connection. The HIS shall queue ADT Inbound
messages while the client is down and is responsible for the incoming ADT message
before delivery to the Aware Gateway.
Monitors in a transport state are tracked by IP address, because the monitor’s unit
or bed name may change during transport (e.g. Rover mode).
TRAM modules can connect to different monitors as the patient moves throughout
the facility.
The TRAM transport state exists if both of the following are true:
Specific TRAM parameters have already been collected from a monitor by the
Aware Gateway.
Collection of TRAM parameters from the monitor stops, but the monitor is still
admitted and on the network.
Back-collection occurs when the monitor/TRAM module is reconnected to the
network, and the accumulated data is passed to the Aware Gateway.
where:
The following pages provide the general format of the various HL7 data messages
recognized by the GE system for outbound interfaces. This document describes only
the data fields and segments that are provided by the GE system. Fields and segments
not listed here are not sent by the GE system.
Result Message (ORU) — This message indicates that data has been acquired.
Example 1
This example has one OBR segment followed by the corresponding OBX segments
collected at a user configured time interval. The OBX segments contain periodic vital
sign data for heart rate, PVC, temperature, and invasive blood pressures.
MSH|^~\&|HL7|MMS|||20050610162300||ORU^R01|1a9334:10467c7
0429:-7f67:23690087|P|2.3||||||8859/1
PID|||ABCDE^^^DefaultDomain^PI||FLANDERS^ROBE
PV1||E|BAY5^8KM-2
OBR|1||||||20050610162300
OBX|1|ST|HR||60|/min|||||R
OBX|2|ST|ST-I||0.0|mm|||||R
OBX|3|ST|ST-II||0.0|mm|||||R
OBX|4|ST|ST-III||0.0|mm|||||R
OBX|5|ST|ST-V1||0.0|mm|||||R
OBX|6|ST|ST-AVR||0.0|mm|||||R
OBX|7|ST|ST-AVL||0.0|mm|||||R
OBX|8|ST|ST-AVF||0.0|mm|||||R
OBX|9|ST|PVC||0|#/min|||||R
OBX|10|ST|AR1-M||94|mm(hg)|||||R
OBX|11|ST|AR1-S||120|mm(hg)|||||R
OBX|12|ST|AR1-D||80|mm(hg)|||||R
OBX|13|ST|AR1-R||60|/min|||||R
OBX|14|ST|TP1-1||39.2|cel|||||R
OBX|15|ST|TP1-2||39.2|cel|||||R
OBX|16|ST|PA2-M||14|mm(hg)|||||R
OBX|17|ST|PA2-S||24|mm(hg)|||||R
OBX|18|ST|PA2-D||10|mm(hg)|||||R
Example 2
This example shows an OBR segment followed by the corresponding OBX segments
containing various periodic vital sign data collected at a user configured time interval.
MSH|^~\&|HL7|MMS|||20050609155900||ORU^R01|1a9334:1043e02
f365:-7a94:25133566|P|2.3||||||8859/1
PID|||ABCDE^^^DefaultDomain^PI||FLANDERS^ROBE
PV1||E|BAY5^8KM-2
OBR|1||||||20050609155900
OBX|1|ST|HR||60|/min|||||R
OBX|2|ST|ST-I||0.0|mm|||||R
OBX|3|ST|ST-II||0.0|mm|||||R
OBX|4|ST|ST-III||0.0|mm|||||R
OBX|5|ST|ST-V1||0.0|mm|||||R
OBX|6|ST|ST-AVR||0.0|mm|||||R
OBX|7|ST|ST-AVL||0.0|mm|||||R
OBX|8|ST|ST-AVF||0.0|mm|||||R
OBX|9|ST|PVC||0|#/min|||||R
Example 3
This example shows one OBR segment followed by the corresponding OBX
segments which contain periodic respiratory mechanics data collected at a user
configured time interval.
MSH|^~\&|HL7|MMS|||20050610162300||ORU^R01|1a9334:10467c7
0429:-7f66:1265971|P|2.3||||||8859/1
PID|||753-951-852^^^DefaultDomain^PI||HILL^ COTTON
PV1||E|BAY5^BEDNO
OBR|1||||||20050610162300
OBX|1|ST|HR||80|/min|||||R
OBX|2|ST|rPEF||68.0|l/min|||||R
OBX|3|ST|rMV||8.4|l/min|||||R
OBX|4|ST|rMVs||0.0|l/min|||||R
OBX|5|ST|rMVm||8.4|l/min|||||R
OBX|6|ST|rTV||144|ml|||||R
OBX|7|ST|rTVs||0|ml|||||R
OBX|8|ST|ST-I||0.0|mm|||||R
OBX|9|ST|ST-II||0.0|mm|||||R
OBX|10|ST|ST-III||0.0|mm|||||R
OBX|11|ST|rTVm||144|ml|||||R
OBX|12|ST|ST-V1||0.0|mm|||||R
OBX|13|ST|rPIP||28|cm_h2o|||||R
OBX|14|ST|rMAWP||16|cm_h2o|||||R
OBX|15|ST|rPEEP||8|cm_h2o|||||R
OBX|16|ST|rPEEPi||8|cm_h2o|||||R
OBX|17|ST|rRR||57|breaths/min|||||R
OBX|18|ST|rRRs||0|breaths/min|||||R
OBX|19|ST|ST-AVR||0.0|mm|||||R
OBX|20|ST|ST-AVL||0.0|mm|||||R
OBX|21|ST|ST-AVF||0.0|mm|||||R
OBX|22|ST|rRRm||57|breaths/min|||||R
OBX|23|ST|rI:E||0.64|1:|||||R
OBX|24|ST|rCDYN||16|ml/cm_h2o|||||R
OBX|25|ST|rRAWe||5|cm_h2o/l/sec|||||R
OBX|26|ST|rWOBm||0.96|J/l|||||R
Example 4
This example shows one OBR segment followed by the corresponding OBX
segments which contain periodic ventilator data collected at a user configured time
interval.
MSH|^~\&|HL7|MMS|||20050610162300||ORU^R01|1a9334:10467c7
0429:-7f68:6789355|P|2.3||||||8859/1
PID|||^^^DefaultDomain^PI|| C^
PV1||E|TEST^5
OBR|1||||||20050610162300
OBX|1|ST|HR||80|/min|||||R
OBX|2|ST|PT-RR||57|breaths/min|||||R
OBX|3|ST|PEEP||9|cm_h2o|||||R
OBX|4|ST|MV||4.8|l/min|||||R
OBX|5|ST|TV||88|ml|||||R
OBX|6|ST|PIP||29|cm_h2o|||||R
OBX|7|ST|PPLAT||23|cm_h2o|||||R
OBX|8|ST|MAWP||16|cm_h2o|||||R
OBX|9|ST|SENS||0.0|cm_h2o|||||R
OBX|10|ST|VNT-RR||15|breaths/min|||||R
OBX|11|ST|FLW-RT||40|l/min|||||R
OBX|12|ST|IN-HLD||0.2|seconds|||||R
OBX|13|ST|PPS||0|cm_h2o|||||R
OBX|14|ST|INSP||0.0|seconds|||||R
OBX|15|ST|I:E||0.8|1:|||||R
OBX|16|ST|SPO-MV||0.0|l/min|||||R
OBX|17|ST|TVset||248|ml|||||R
OBX|18|ST|PCP||0|cm_h2o|||||R
OBX|19|ST|I:Eset||0.0|1:|||||R
OBX|20|ST|FL-TRG||4|l/min|||||R
OBX|21|ST|ST-II||0.0|mm|||||R
OBX|22|ST|O2set||21|%|||||R
OBX|23|ST|PA1-M||15|mm(hg)|||||R
OBX|24|ST|PA1-S||24|mm(hg)|||||R
OBX|25|ST|PA1-D||10|mm(hg)|||||R
OBX|26|ST|AR2-M||94|mm(hg)|||||R
OBX|27|ST|AR2-S||118|mm(hg)|||||R
OBX|28|ST|AR2-D||78|mm(hg)|||||R
OBX|29|ST|PVC||0|#/min|||||R
Example 5
This example shows two MSH followed by the corresponding OBR and OBX
segments. MSH 1 and MSH 2 contain episodic data for pulmonary calculations and
cardiac calculations respectively. All other result data is marked as results entered –
not verified (R). The result data for cardiac calculations are marked as final results –
stored and verified (F).
MSH|^~\&|HL7|MMS|||20050609145700||ORU^R01|1a9334:1043e02
f365:-7ac8:25133566|P|2.3||||||8859/1
PID|||ABCDE^^^DefaultDomain^PI||FLANDERS^ROBE
PV1||E|BAY5^8KM-2
OBR|1||||||20050609145723||||||PC
OBX|1|ST|FiO2||35|%|||||R
OBX|2|ST|PEEP||10|cm_h2o|||||R
OBX|3|ST|RR||37|breaths/min|||||R
OBX|4|ST|TV||775|ml|||||R
OBX|5|ST|PIP||75|cm_h2o|||||R
OBX|6|ST|CO||8.5|l/min|||||R
OBX|7|ST|PBAR||746|mm(hg)|||||R
OBX|8|ST|Hb||11.8|gm/100ml|||||R
OBX|9|ST|PaCO2||45|mm(hg)|||||R
OBX|10|ST|PaO2||100|mm(hg)|||||R
OBX|11|ST|SaO2||100|%|||||R
OBX|12|ST|PvO2||62|mm(hg)|||||R
OBX|13|ST|SvO2||83|%|||||R
OBX|14|ST|BSA||1.81|m2|||||R
OBX|15|ST|Cdyn||12|ml/cm_h2o|||||R
OBX|16|ST|MV||28.7|l/min|||||R
OBX|17|ST|CI||4.7|l/(min/m2)|||||R
OBX|18|ST|AaDO2||88|mm(hg)|||||R
OBX|19|ST|CaO2||16.71|ml/100ml|||||R
OBX|20|ST|DO2I||785.4|ml/(min/m2)|||||R
OBX|21|ST|CvO2||13.81|ml/100ml|||||R
OBX|22|ST|a-vO2||2.9|ml/100ml|||||R
OBX|23|ST|VO2I||136.3|ml/(min/m2)|||||R
OBX|24|ST|O2ER||17|%|||||R
OBX|25|ST|Pa/FiO2||3|%|||||R
OBX|26|ST|Qs/Qt||8.6|%|||||R
MSH|^~\&|HL7|MMS|||20050609145300||ORU^R01|1a9334:1043e02
f365:-7ad2:25133566|P|2.3||||||8859/1
PID|||ABCDE^^^DefaultDomain^PI||FLANDERS^ROBE
PV1||E|BAY5^8KM-2
OBR|1||||||20050609145240||||||CC
OBX|1|ST|CO||5.9|l/min|||||F
OBX|2|ST|HR||75|/min|||||F
OBX|3|ST|MAP||96|mm(hg)|||||F
OBX|4|ST|CVP||18|mm(hg)|||||F
OBX|5|ST|PAM||29|mm(hg)|||||F
OBX|6|ST|PAW||18|mm(hg)|||||F
OBX|7|ST|BSA||1.81|m2|||||F
OBX|8|ST|CI||3.3|l/(min/m2)|||||F
OBX|9|ST|SV||78.7|ml/beat|||||F
OBX|10|ST|SVR||1057|dyn.sec.cm-5|||||F
OBX|11|ST|SVRI||1914|dyn.sec.cm-5.m2|||||F
OBX|12|ST|PVR||149|dyn.sec.cm-5|||||F
OBX|13|ST|PVRI||270|dyn.sec.cm-5.m2|||||F
OBX|14|ST|LVSWI||46.1|g.m/m2|||||F
OBX|15|ST|RVSWI||6.5|g.m/m2|||||F
Example 6
This example shows an OBR segments followed by the corresponding OBX segments
for the back collection of periodic episodic data.
MSH|^~\&|HL7|MMS|||20050609154500||ORU^R01|1a9334:1043e02
f365:-7a97:25133566|P|2.3||||||8859/1
PID|||ABCDE^^^DefaultDomain^PI||FLANDERS^ROBE
PV1||E|BAY5^8KM-2
OBR|1||||||20050609152600
OBX|1|ST|HR||60|/min|||||R
OBX|2|ST|ST-I||0.0|mm|||||R
OBX|3|ST|ST-II||0.0|mm|||||R
OBX|4|ST|ST-III||0.0|mm|||||R
OBX|5|ST|ST-V1||0.0|mm|||||R
OBX|6|ST|ST-AVR||0.0|mm|||||R
OBX|7|ST|ST-AVL||0.0|mm|||||R
OBX|8|ST|ST-AVF||0.0|mm|||||R
OBX|9|ST|PVC||0|#/min|||||R
OBR|2||||||20050609152700
OBX|1|ST|HR||60|/min|||||R
OBX|2|ST|ST-I||0.0|mm|||||R
OBX|3|ST|ST-II||0.0|mm|||||R
OBX|4|ST|ST-III||0.0|mm|||||R
OBX|5|ST|ST-V1||0.0|mm|||||R
OBX|6|ST|ST-AVR||0.0|mm|||||R
OBX|7|ST|ST-AVL||0.0|mm|||||R
OBX|8|ST|ST-AVF||0.0|mm|||||R
OBX|9|ST|PVC||0|#/min|||||R
OBR|3||||||20050609152800
OBX|1|ST|HR||60|/min|||||R
OBX|2|ST|ST-I||0.0|mm|||||R
OBX|3|ST|ST-II||0.0|mm|||||R
OBX|4|ST|ST-III||0.0|mm|||||R
OBX|5|ST|ST-V1||0.0|mm|||||R
OBX|6|ST|ST-AVR||0.0|mm|||||R
OBX|7|ST|ST-AVL||0.0|mm|||||R
OBX|8|ST|ST-AVF||0.0|mm|||||R
OBX|9|ST|PVC||0|#/min|||||R
OBR|4||||||20050609152900
OBX|1|ST|HR||60|/min|||||R
OBX|2|ST|ST-I||0.0|mm|||||R
OBX|3|ST|ST-II||0.0|mm|||||R
OBX|4|ST|ST-III||0.0|mm|||||R
OBX|5|ST|ST-V1||0.0|mm|||||R
OBX|6|ST|ST-AVR||0.0|mm|||||R
OBX|7|ST|ST-AVL||0.0|mm|||||R
OBX|8|ST|ST-AVF||0.0|mm|||||R
OBX|9|ST|PVC||0|#/min|||||R
OBR|5||||||20050609153000
OBX|1|ST|HR||60|/min|||||R
OBX|2|ST|ST-I||0.0|mm|||||R
OBX|3|ST|ST-II||0.0|mm|||||R
OBX|4|ST|ST-III||0.0|mm|||||R
OBX|5|ST|ST-V1||0.0|mm|||||R
OBX|6|ST|ST-AVR||0.0|mm|||||R
OBX|7|ST|ST-AVL||0.0|mm|||||R
OBX|8|ST|ST-AVF||0.0|mm|||||R
OBX|9|ST|PVC||0|#/min|||||R
OBR|6||||||20050609153100
OBX|1|ST|HR||60|/min|||||R
OBX|2|ST|ST-I||0.0|mm|||||R
OBX|3|ST|ST-II||0.0|mm|||||R
OBX|4|ST|ST-III||0.0|mm|||||R
OBX|5|ST|ST-V1||0.0|mm|||||R
OBX|6|ST|ST-AVR||0.0|mm|||||R
OBX|7|ST|ST-AVL||0.0|mm|||||R
OBX|8|ST|ST-AVF||0.0|mm|||||R
OBX|9|ST|PVC||0|#/min|||||R
OBR|7||||||20050609153200
OBX|1|ST|HR||60|/min|||||R
OBX|2|ST|ST-I||0.0|mm|||||R
OBX|3|ST|ST-II||0.0|mm|||||R
OBX|4|ST|ST-III||0.0|mm|||||R
OBX|5|ST|ST-V1||0.0|mm|||||R
OBX|6|ST|ST-AVR||0.0|mm|||||R
OBX|7|ST|ST-AVL||0.0|mm|||||R
OBX|8|ST|ST-AVF||0.0|mm|||||R
OBX|9|ST|PVC||0|#/min|||||R
OBR|8||||||20050609153300
OBX|1|ST|HR||60|/min|||||R
OBX|2|ST|ST-I||0.0|mm|||||R
OBX|3|ST|ST-II||0.0|mm|||||R
OBX|4|ST|ST-III||0.0|mm|||||R
OBX|5|ST|ST-V1||0.0|mm|||||R
OBX|6|ST|ST-AVR||0.0|mm|||||R
OBX|7|ST|ST-AVL||0.0|mm|||||R
OBX|8|ST|ST-AVF||0.0|mm|||||R
OBX|9|ST|PVC||0|#/min|||||R
OBR|9||||||20050609153400
OBX|1|ST|HR||60|/min|||||R
OBX|2|ST|ST-I||0.0|mm|||||R
OBX|3|ST|ST-II||0.0|mm|||||R
OBX|4|ST|ST-III||0.0|mm|||||R
OBX|5|ST|ST-V1||0.0|mm|||||R
OBX|6|ST|ST-AVR||0.0|mm|||||R
OBX|7|ST|ST-AVL||0.0|mm|||||R
OBX|8|ST|ST-AVF||0.0|mm|||||R
OBX|9|ST|PVC||0|#/min|||||R
OBR|10||||||20050609153500
OBX|1|ST|HR||60|/min|||||R
OBX|2|ST|ST-I||0.0|mm|||||R
OBX|3|ST|ST-II||0.0|mm|||||R
OBX|4|ST|ST-III||0.0|mm|||||R
OBX|5|ST|ST-V1||0.0|mm|||||R
OBX|6|ST|ST-AVR||0.0|mm|||||R
OBX|7|ST|ST-AVL||0.0|mm|||||R
OBX|8|ST|ST-AVF||0.0|mm|||||R
OBX|9|ST|PVC||0|#/min|||||R
OBR|11||||||20050609153600
OBX|1|ST|HR||60|/min|||||R
OBX|2|ST|ST-I||0.0|mm|||||R
OBX|3|ST|ST-II||0.0|mm|||||R
OBX|4|ST|ST-III||0.0|mm|||||R
OBX|5|ST|ST-V1||0.0|mm|||||R
OBX|6|ST|ST-AVR||0.0|mm|||||R
OBX|7|ST|ST-AVL||0.0|mm|||||R
OBX|8|ST|ST-AVF||0.0|mm|||||R
OBX|9|ST|PVC||0|#/min|||||R
OBR|12||||||20050609153700
OBX|1|ST|HR||60|/min|||||R
OBX|2|ST|ST-I||0.0|mm|||||R
OBX|3|ST|ST-II||0.0|mm|||||R
OBX|4|ST|ST-III||0.0|mm|||||R
OBX|5|ST|ST-V1||0.0|mm|||||R
OBX|6|ST|ST-AVR||0.0|mm|||||R
OBX|7|ST|ST-AVL||0.0|mm|||||R
OBX|8|ST|ST-AVF||0.0|mm|||||R
OBX|9|ST|PVC||0|#/min|||||R
OBR|13||||||20050609153800
OBX|1|ST|HR||60|/min|||||R
OBX|2|ST|ST-I||0.0|mm|||||R
OBX|3|ST|ST-II||0.0|mm|||||R
OBX|4|ST|ST-III||0.0|mm|||||R
OBX|5|ST|ST-V1||0.0|mm|||||R
OBX|6|ST|ST-AVR||0.0|mm|||||R
OBX|7|ST|ST-AVL||0.0|mm|||||R
OBX|8|ST|ST-AVF||0.0|mm|||||R
OBX|9|ST|PVC||0|#/min|||||R
OBR|14||||||20050609153900
OBX|1|ST|HR||60|/min|||||R
OBX|2|ST|ST-I||0.0|mm|||||R
OBX|3|ST|ST-II||0.0|mm|||||R
OBX|4|ST|ST-III||0.0|mm|||||R
OBX|5|ST|ST-V1||0.0|mm|||||R
OBX|6|ST|ST-AVR||0.0|mm|||||R
OBX|7|ST|ST-AVL||0.0|mm|||||R
OBX|8|ST|ST-AVF||0.0|mm|||||R
OBX|9|ST|PVC||0|#/min|||||R
OBR|15||||||20050609154000
OBX|1|ST|HR||60|/min|||||R
OBX|2|ST|ST-I||0.0|mm|||||R
OBX|3|ST|ST-II||0.0|mm|||||R
OBX|4|ST|ST-III||0.0|mm|||||R
OBX|5|ST|ST-V1||0.0|mm|||||R
OBX|6|ST|ST-AVR||0.0|mm|||||R
OBX|7|ST|ST-AVL||0.0|mm|||||R
OBX|8|ST|ST-AVF||0.0|mm|||||R
OBX|9|ST|PVC||0|#/min|||||R
OBR|16||||||20050609154100
OBX|1|ST|HR||60|/min|||||R
OBX|2|ST|ST-I||0.0|mm|||||R
OBX|3|ST|ST-II||0.0|mm|||||R
OBX|4|ST|ST-III||0.0|mm|||||R
OBX|5|ST|ST-V1||0.0|mm|||||R
OBX|6|ST|ST-AVR||0.0|mm|||||R
OBX|7|ST|ST-AVL||0.0|mm|||||R
OBX|8|ST|ST-AVF||0.0|mm|||||R
OBX|9|ST|PVC||0|#/min|||||R
OBR|17||||||20050609154200
OBX|1|ST|HR||60|/min|||||R
OBX|2|ST|ST-I||0.0|mm|||||R
OBX|3|ST|ST-II||0.0|mm|||||R
OBX|4|ST|ST-III||0.0|mm|||||R
OBX|5|ST|ST-V1||0.0|mm|||||R
OBX|6|ST|ST-AVR||0.0|mm|||||R
OBX|7|ST|ST-AVL||0.0|mm|||||R
OBX|8|ST|ST-AVF||0.0|mm|||||R
OBX|9|ST|PVC||0|#/min|||||R
OBR|18||||||20050609154300
OBX|1|ST|HR||60|/min|||||R
OBX|2|ST|ST-I||0.0|mm|||||R
OBX|3|ST|ST-II||0.0|mm|||||R
OBX|4|ST|ST-III||0.0|mm|||||R
OBX|5|ST|ST-V1||0.0|mm|||||R
OBX|6|ST|ST-AVR||0.0|mm|||||R
OBX|7|ST|ST-AVL||0.0|mm|||||R
OBX|8|ST|ST-AVF||0.0|mm|||||R
OBX|9|ST|PVC||0|#/min|||||R
OBR|19||||||20050609154400
OBX|1|ST|HR||60|/min|||||R
OBX|2|ST|ST-I||0.0|mm|||||R
OBX|3|ST|ST-II||0.0|mm|||||R
OBX|4|ST|ST-III||0.0|mm|||||R
OBX|5|ST|ST-V1||0.0|mm|||||R
OBX|6|ST|ST-AVR||0.0|mm|||||R
OBX|7|ST|ST-AVL||0.0|mm|||||R
OBX|8|ST|ST-AVF||0.0|mm|||||R
OBX|9|ST|PVC||0|#/min|||||R
OBR|20||||||20050609154500
OBX|1|ST|HR||60|/min|||||R
OBX|2|ST|ST-I||0.0|mm|||||R
OBX|3|ST|ST-II||0.0|mm|||||R
OBX|4|ST|ST-III||0.0|mm|||||R
OBX|5|ST|ST-V1||0.0|mm|||||R
OBX|6|ST|ST-AVR||0.0|mm|||||R
OBX|7|ST|ST-AVL||0.0|mm|||||R
OBX|8|ST|ST-AVF||0.0|mm|||||R
OBX|9|ST|PVC||0|#/min|||||R
Example 7
This example shows five OBR segments followed by the corresponding OBX
segments for the back collection of episodic NBP data.
MSH|^~\&|HL7|MMS|||20050322121600||ORU^R01|1a9334:102ce45
2b74:-788d:12231451|P|2.3||||||8859/1
PID|||A249^^^MSH^MSH||A249^
PV1||E|A^A249
OBR|1||||||20050322115057||||||NBP
OBX|1|ST|NBP-D||1593600|mm(hg)|||||R
OBX|2|ST|NBP-M||1593400|mm(hg)|||||R
OBX|3|ST|NBP-S||1593500|mm(hg)|||||R
OBR|2||||||20050322115557||||||NBP
OBX|1|ST|NBP-D||1593600|mm(hg)|||||R
OBX|2|ST|NBP-M||1593400|mm(hg)|||||R
OBX|3|ST|NBP-S||1593500|mm(hg)|||||R
OBR|3||||||20050322120057||||||NBP
OBX|1|ST|NBP-D||1593650|mm(hg)|||||R
OBX|2|ST|NBP-M||1593450|mm(hg)|||||R
OBX|3|ST|NBP-S||1593550|mm(hg)|||||R
OBR|4||||||20050322120557||||||NBP
OBX|1|ST|NBP-D||1593650|mm(hg)|||||R
OBX|2|ST|NBP-M||1593450|mm(hg)|||||R
OBX|3|ST|NBP-S||1593550|mm(hg)|||||R
OBR|5||||||20050322121057||||||NBP
OBX|1|ST|NBP-D||1593600|mm(hg)|||||R
OBX|2|ST|NBP-M||1593400|mm(hg)|||||R
OBX|3|ST|NBP-S||1593500|mm(hg)|||||R
The Aware Gateway interface does not support single characters or ACK/NACK
acknowledgment responses.
According to the HL7 specification, AE messages are those that contain an error and
are not to be retransmitted; AR messages are also not retransmitted by the Aware
Gateway Quovadx engine. However, if an AE or AR message is received by the
Quovadx engine in the Aware Gateway Outbound HL7 interface, the original
message is logged in the Quovadx Error Database, the message can be manually
corrected and retransmitted using the Quovadx Integrated Development Environment
tools.
This allows the ITPS user to intervene, correct the problem with the messages and
data collection, and allow the Aware Gateway to resume where it left off with the
corrected data format. Under normal operation, the HIS should never return an AE or
AR message. It should be able to handle all the HL7 data types as defined. Appendix
B The receiving system should ignore fields that are present in the message but were
not expected, rather than treat it as an error. The Aware Gateway HL7 outbound
interface expects to match the MSH segment control ID field that was sent in the
result message with the control ID returned in the MSA segment of the
acknowledgement message.
Acknowledgment Accept
MSH|^~\&|NUR^^|.^^|MMS
HL7|.^^|199812021001||ACK^R01|17f1be29-aa2a-11d2-a655-00105a1e9b67|P^|2.3
MSA|AA|17f1be29-aa2a-11d2-a655-00105a1e9b67
Acknowledgment Reject
MSH|^~\&|NUR^^|.^^|MMS
HL7|.^^|199812021003||ACK^R01|17f1be29-aa2a-11d2-a655-00105a1e9b67|P^|2.3
MSA|AR|17f1be29-aa2a-11d2-a655-00105a1e9b67|Unsupported message type
Acknowledgment Error
MSH|^~\&|NUR^^|.^^|MMS
HL7|.^^|199812021002||ACK^R01|17f1be29-aa2a-11d2-a655-00105a1e9b67|P^|2.3
MSA|AE|17f1be29-aa2a-11d2-a655-00105a1e9b67|Unable to find patient
Introduction
The following tables define the various data segments. The tables are shown with the
standard HL7 message layout.
The lengths given for fields are the maximum lengths supported by the GE system,
not the HL7 definitions for field lengths. When the GE HL7 interface support column
indicates N, the data may be optimally sent in the message but it will be ignored by
the GE HL7 interface.
A data field may also be conditionally required, which is indicated with a CR instead
of an R. The Set ID field (seq. 1) in an OBR segment is an example of a conditionally
required field.
Only fields listed Y/R are available in the current HL7 output stream. Many of the
fields listed Y have no means of being entered into the monitoring devices. The Y
simply indicates that the field is supported and would not be ignored, as the fields
marked N, should it be received. However, the HL7 application is strictly outbound at
this point. The reason some fields are marked Y is because there is the potential to
add in-bound ADT capability to the HL7 application coming from an HIS system at
some point in the future; the fields could then be included for outbound data as well.
Data Segments
MSH — Message Header Segment
1
The Sending application field value is dependent on the message originator.
2
The Receiving application field value identifies the receiving applications.
3
The Date/time of message field contains a Unity Network time stamp of when the message was generated.
4
The first 20 characters are not unique but the last 16 characters are unique. If the HIS vendor only allows 20 characters, the last 20 characters of
the 36 will be used.
5
The format of the message control ID is determined by the originating application. The receiving system must be able to accept transactions
regardless of the format of this field, and must return the control ID in its original format. This field is not required when high level
acknowledgments are not used.
6
If this field is not present, the interface will treat the message as “P” for production.
2
The message control ID for the acknowledgment must match the control ID for the message being acknowledged.
A B C
A — MRN
The Unity Network supports 9-14
characters for the MRN.
The recommended length for this field
is 9.
B — Domain/Assigning Authority
The recommended length for this field
is 3.
C — Type Code
The recommended length for this field
is 2.
NOTE
If the PID is greater than 11 characters,
you need to enlarge the length of that
field in Quovadx. See the Aware
Gateway service manual for details.
4 00107 map as @ null N Alternate patient ID
5 00108 26 PN Y/CR Patient name
A B C
A — account number
B — Domain
C — Type Code
19 00122 N SSN number — patient
20 00123 N Drivers lic. num. — patient
21 00124 N Mother’s identifier
22 00125 N Ethnic group
23 00126 N Birth place
24 00127 N Multiple birth identifier
25 00128 N Birth order
26 00129 N Citizenship
27 00130 N Veterans military status
28 00739 N Nationality
29 00740 N Patient death date and time
30 00741 N Patient death indicator
1
The Aware Gateway will not accept messages that are not encoded correctly.
2
Contact your local GE sales representative to review options for supporting this field.
3The Aware Gateway will not accept messages that are not encoded correctly
The Aware Gateway requires the PV1-2 segment to be either a I for Inpatient or
an O for outpatient for purge cycles to delete old records. The ADT database
purge is based on this field that is stored in the ADT database. Therefore, if PV1-
2 is E for emergency or P for pre-admit, the records will not be purged because
they do not match either I or O. This leads to stale entries in the database that do
not get deleted. The solution is to create a translation that converts the
classification code to either I or O in the ADT messages for the purge cycle to
work correctly. The recommended translation is to leave all the I entries and
convert all other entries to O.
A B C
A — visit number
B — Domain/Assigning
Authority
C — Type Code
20 00150 N Financial class
21 00151 N Charge price indicator
22 00152 N Courtesy code
23 00153 N Credit rating
24 00154 N Contract code
25 00155 N Contract effective date
26 00156 N Contract amount
27 00157 N Contract period
28 00158 N Interest code
29 00159 N Transfer to bad debt code
30 00160 N Transfer to bad debt date
31 00161 N Bad debt agency code
32 00162 N Bad debt transfer amount
33 00163 N Bad debt recovery amount
34 00164 N Delete account indicator
35 00165 N Delete account date
36 00166 N Discharge disposition
37 00167 N Discharged to location
38 00168 N Diet type
39 00169 N Servicing facility
40 00170 N Bed status
41 00171 N Patient account status
42 00172 N Pending location
43 00173 N Prior temporary location
44 00174 26 TS N Admit date/time
45 00175 26 TS N Discharge date/time
46 00176 N Current patient balance
47 00177 N Total charges
48 00178 N Total adjustments
49 00179 N Total payments
50 00180 N Alternate visit ID
51 01226 N Visit indicator
52 01224 N Other health care provider
1
Patient location from the host system maps to GE system location, room, and bed fields. In results, the location returned is the GE system location
indicating where the test was taken.
2
The Aware Gateway will not accept messages that are not encoded correctly
CC = Cardiac Calculations
NBP = Non-Invasive Blood
Pressure
PC = Pulmonary
Calculations
POC = Point of Care
PW = Pulmonary Wedge
14 00248 N Specimen received date/time
15 00249 N Specimen source
16 00226 N Ordering provider
17 00250 N Order call-back phone number
OBX — Result
Values are:
Overview
This section provides a brief overview to the Aware Gateway configuration. For
additional configuration details, see the Aware Gateway service manual.
Properties Configuration
The Quovadx server depends on information entered by the user in the Webmin
properties (Webmin> Configuration tab> Aware Gateway> Configuration).
The Webmin Properties page is used to configure certain logging, collection and HL7
patient identification (PID) properties. It is also used for turning the time management
service on/off, for designating the Aware Gateway as the time manager (NTP) server,
and for forcing a time synchronization of the Unity MC Network.
2. Select Configuration > Aware Gateway > Configuration > Setup > Properties.
4. Click Update Properties at the bottom of the page to save and apply the changes.
Property Name
Description
Current Value
New Value
208B
Full HL7 Logging If true, complete HL7 messages will be written to the log
for each acquisition. If false, only the HL7 message
headers will be written to the log for each acquisition.
Maximum back-collection times (hours) The maximum back-collection time value limits the
number of hours of data that will be back-collected from a
monitor/TRAM when it is reconnected to the network after
a transport. Default value is 8 hours. Can be configured
between 0-8 hours in hour increments.
Maximum device cache time Sets the maximum amount of time a device (object) is
tracked for back-collection. If the device is in transport
longer than this setting, it is no longer tracked for back-
collection.
Patient Identifier Type Code Unique patient ID (PID) code appended to ADT_Inbound
HL7 messages.Restrict this identifier to four characters.
Use the standard HL7 definitions for typecode.
Picklist page size Defines the number of results displayed on each page.
Picklist query size Defines the maximum number of responses sent to the
client for a generic picklist query.
CAUTION
COMMUNICATIONS ERROR/TIME INACCURACY— Do not
allow wireless devices to act as time master. Wireless devices can
drop communication packets which may cause communication
problems resulting in time errors.
NOTE
Do not use the Aware Gateway versions 1.1 and 1.2 as the time source when
using the HL7 vitals collection feature.
NOTE
The Time Master Properties configuration table is located near the bottom of the
Properties page.
1. The Allow Time Management services setting determines whether the NTP time
synchronization feature is enabled. Select true to enable the feature; false to turn
it off.
True False
Aware Gateway as True Aware Gateway sends the NTP Time updates —
Time Source to the Unity network
NOTE
NOTE
209B
2. The Aware Gateway as the time source value determines if the Aware Gateway
broadcasts NTP driven updates to its internal clock to the Unity Network MC
network time master. Select true to enable the feature; false to turn it off.
NOTE
The Aware Gateway as the time source setting has no effect if Allow Time
Management services is set to false.
NOTE
If the Aware Gateway as time source setting is true and your Aware
Gateway system is not in one of the following time zones, you need to
enable the daylight saving time flag. If your system is in one of
following time zones, you need to disable the daylight saving time flag
and perform the Daylight Saving Time Workaround below.
(GMT-04:00) Atlantic Time (Canada)
(GMT-05:00) Eastern Time (US and Canada)
(GMT-06:00) Central Time (US and Canada)
(GMT-07:00) Mountain Time (US and Canada)
(GMT-08:00) Pacific Time (US and Canada)
If the Aware Gateway as time source setting is false, you need to
disable the daylight saving time flag.
NOTE
Time zone and daylight savings time may need to match HIS processing
configuration. Refer to the site survey.
3. Click the Time Synch Request button to force a Unity time synchronization to
the Aware Gateway time (when the Aware Gateway is configured as the time
source).
Turn off Automatically Adjust Clock for Daylight Saving Changes on page A-5.
This is a one-time operation and can be executed at anytime.
Perform Manual Time Zone Switch on page A-6, to simulate the daylight saving
changes. This operation is performed twice a year at the following times:
2 a.m. on the day in the Spring when daylight saving time begins.
2 a.m. on the day in the Fall when daylight saving time ends.
3. Select Apply.
a. Login to Webmin and browse to Configuration > Aware Gateway > Start/
Stop Server.
b. Select Stop UGS, and wait for the UGS subsystem to update to Off.
If the Automatically adjust clock for daylight saving changes is enabled at this time,
it is also necessary to perform the procedure to Turn off Automatically Adjust Clock
for Daylight Saving Changes on page A-5.
NOTE
The workarounds for Spring and Fall instruct you to change only the time zone,
and not the time. Do not change the time. If you change the time, the Aware
Gateway will no longer be synchronized with the NTP server.
3. Refer to the following chart and select the applicable time zone to simulate
setting the clock ahead one hour.
(GMT - 05:00) Eastern Time (US and (GMT - 04:00) Atlantic Time (Canada)
Canada)
(GMT - 06:00) Central Time (US and (GMT - 05:00) Eastern Time (US and
Canada) Canada)
(GMT - 07:00) Mountain Time (US and (GMT - 06:00) Central Time (US and
Canada) Canada)
(GMT - 08:00) Pacific Time (US and (GMT - 07:00) Mountain Time (US and
Canada) Canada)
4. Select Apply.
a. Login to Webmin and browse to Configuration > Aware Gateway > Start/
Stop Server.
b. Select Stop UGS, and wait for the UGS subsystem to update to Off.
3. Refer to the following chart and select the applicable time zone to simulate
setting the clock back one hour.
If this is the Simulated Time Zone Select this Actual Time Zone
(GMT - 04:00) Atlantic Time (Canada) (GMT - 05:00) Eastern Time (US and
Canada)
(GMT - 05:00) Eastern Time (US and (GMT - 06:00) Central Time (US and
Canada) Canada)
(GMT - 06:00) Central Time (US and (GMT - 07:00) Mountain Time (US and
Canada) Canada)
(GMT - 07:00) Mountain Time (US and (GMT - 08:00) Pacific Time (US and
Canada) Canada)
4. Select Apply.
a. Login to Webmin and browse to Configuration > Aware Gateway > Start/
Stop Server.
b. Select Stop UGS, and wait for the UGS subsystem to update to Off.
WARNING
LOSS OF FUNCTION— Do not operate the Aware Gateway
without the firewall enabled. The firewall protects the Aware
Gateway from virus contamination which could potentially disable
the system.
CAUTION
LOSS OF CONNECTIVITY—Complete the network mapping
confirmation before configuring the firewall. Connectivity will be
lost when the firewall is started if network mapping is not completed
before the firewall configuration.
Current network address and netmask configuration information for both the
system and firewall.
Firewall rules, listed in order from broad to specific.
337B
4. Firewall rules are set by default so that only the ports necessary for product
function are open. If the site survey requires additional open ports, use the form
at the bottom of the window and click Setup Firewall.
a. Enter HIS ADT as the name of a firewall rule, set the rule Type to pass, the
Protocol to TCP and the direction to in.
b. Set the Port to the HIS ADT inbound port number (indicated on the site
survey).
NOTE
c. Enter HIS HL7 as the name of a firewall rule, set the rule Type to pass, the
Protocol to TCP and the direction to out.
d. Set the Port to the HIS HL7 inbound port number (indicated on the site
survey).
NOTE
5. To remove an entered rule, clear the port number and click Setup Firewall.
Bed List
Overview
To view the bedlist in Webmin, perform the following steps.
NOTE
If a device’s name is changed to one that is not on the bedlist, data collection for
that device will stop.
3. Click Bed List. A variety of bed list functions are available (add/remove beds, set
collection intervals, HIS mapping.
177B
Add/Remove Beds
NOTE
All devices on the Aware Gateway bedlist and the Aware Gateway system must
reside on the fully-switched Unity Network.
Units
NOTE
2. Click Select All, or select individual units in the Units Currently on Network
table.
178A
3. To add all the beds in the selected unit(s), click Add Unit.
CAUTION
When adding a unit using the Add Unit button, any HIS mappings
defined for beds in that unit are removed. Only use Add Unit if you
do not use HIS mappings. If you use HIS mappings, follow the
Multiple Beds procedure below.
4. To delete all the beds in the selected unit(s), click Remove Unit.
Multiple Beds
1. Select Bed List > Network Update.
2. Click Select All, or select individual beds in the Beds Currently on Network
table.
378A
3. To add all the selected beds, click Add Selected.
NOTE
For v1.3, removing a bed does not remove its HIS mapping.
Individual Beds
NOTE
This procedure is used primarily to add/remove beds which are not on the
network.
179A
2. To add simple unit/beds, type the Unit name, the Bed name and any HIS
Mapping code, if required, into the Add Device By Logical Name fields. Select
the bed data collection frequency from the pull-down list.
5. To add telemetry unit/beds, type the Unit name, the Bed name and any HIS
Mapping code, if required, into the Add Telemetry Device fields. Select the bed
data collection frequency from the pull-down list.
2. Select the unit containing the beds for collection interval modification
180A
CAUTION
The change to the interval will take effect on all online beds. The
new interval will not be applied to offline beds that are within the
unit. The offline beds will need to have the change to the interval
manually set.
3. To change the collection interval for an entire unit, select the collection interval
from the list and click Update Unit Intervals.
259A
4. To change the collection interval for an individual bed (or several beds at once),
select the interval for each bed as required from the Collection Interval list, and
click Update Interval.
HIS Mapping
HIS mapping is used to change/add/remove the alias assigned to a particular bed as
seen on the HIS. The name of the Aware Gateway unit and bed should match the
name of the HIS unit and bed as there is a one to one correspondence. A single Aware
Gateway unit should not be mapped to multiple HIS units.
NOTE
If the one to one match does not occur, ADT picklist issues will occur, such as
only the first HIS unit will appear even though the mapping may point to
multiple HIS units.
NOTE
This feature maps from the Unity Name to the HIS name.
NOTE
For v1.3, if the maximum license count is reached, you can still add beds to the
HIS mapping list using Add/Remove Beds. For details, refer to Add/Remove
Beds on page A-11.
NOTE
For v1.3, if the bed for which you wish to add a HIS mapping is not displayed,
but it is displayed in the Bed List, remove the bed from the Bed List and add it
back again. See Add/Remove Beds on page A-11.
2. In the row containing the unit/bed where mapping should be added or changed,
enter a new unit in the Updated Mapping column and click Update HIS
Mappings.
181A
internal TRAM
Calculation
Network ID
Module or
Octanet
Monitor
Unity
Parameter Name Sub-parameter Name Units
internal TRAM
Calculation
Network ID
Module or
Octanet
Monitor
Unity
Parameter Name Sub-parameter Name Units
internal TRAM
Calculation
Network ID
Module or
Octanet
Monitor
Unity
Parameter Name Sub-parameter Name Units
internal TRAM
Calculation
Network ID
Module or
Octanet
Monitor
Unity
Parameter Name Sub-parameter Name Units
internal TRAM
Calculation
Network ID
Module or
Octanet
Monitor
Unity
Parameter Name Sub-parameter Name Units
internal TRAM
Calculation
Network ID
Module or
Octanet
Monitor
Unity
Parameter Name Sub-parameter Name Units
internal TRAM
Calculation
Network ID
Module or
Octanet
Monitor
Unity
Parameter Name Sub-parameter Name Units
Potassium K+ Yes mM
internal TRAM
Calculation
Network ID
Module or
Octanet
Monitor
Unity
Parameter Name Sub-parameter Name Units
Pulse Oximetry Pulse Oximetry Peripheral Heart SPO2-R Yes Yes Yes /min
(SPO2) Rate
internal TRAM
Calculation
Network ID
Module or
Octanet
Monitor
Unity
Parameter Name Sub-parameter Name Units
internal TRAM
Calculation
Network ID
Module or
Octanet
Monitor
Unity
Parameter Name Sub-parameter Name Units
internal TRAM
Calculation
Network ID
Module or
Octanet
Monitor
Unity
Parameter Name Sub-parameter Name Units
internal TRAM
Calculation
Network ID
Module or
Octanet
Monitor
Unity
Parameter Name Sub-parameter Name Units
Abbreviations
Abbreviations and symbols which you may encounter while reading this manual or
using the Aware Gateway HL7 application are listed below with their meanings.
Abbreviation Definition
Addr, AD address
ADD Addendum
CE coded entry
CHAR character
Chg change
CM composite
CN composite name
CV cardiovascular
DT date
EG Enterprise Gateway
Abbreviation Definition
ID identification
IS Information Systems
1K 1024 bytes
Lic license
N no
NM numeric
Num number
Obs observation
O optional
Abbreviation Definition
Req request
Rev revision
Seq sequence
ST string data
TN telephone number
TS time stamp
U unknown
Y/O yes/optional
Y/R yes/required
Y yes