VM Series HL7 Guide
VM Series HL7 Guide
Patient Monitors
HL7 Guide
Release A
English
Proprietary Notice
This document and the information contained in it is proprietary and confidential information
of Philips Medical Systems (“Philips”) and may not be reproduced, copied in whole or in part,
adapted, modified, disclosed to others, or disseminated without the prior written permission of
the Philips Legal Department. Use of this document and the information contained in it is
strictly reserved for current Philips personnel and Philips customers who have a current and
valid license from Philips for use by the customer's designated in-house service employee on
equipment located at the customer's designated site. Use of this document by unauthorized
persons is strictly prohibited. Report violation of these requirements to the Philips Legal
Department. This document must be returned to Philips when the user is no longer licensed
and in any event upon Philips' first written request.
Document Number
4535 640 41111
Warranty Disclaimer
Philips provides this document without warranty of any kind, either implied or expressed,
including, but not limited to, the implied warranties of merchantability and fitness for a
particular purpose.
Limits of Liability
Philips has taken care to ensure the accuracy of this document. However, Philips assumes no
liability for errors or omissions and reserves the right to make changes without further notice
to any products herein to improve reliability, function, or design. Philips may make
improvements or changes in the product(s) or program(s) described in this document at any
time.
ii
Printing History
New editions of this document incorporate all material updated since the previous edition.
Update packages may be issued between editions and contain replacement and additional
pages to be merged by a revision date at the bottom of the page. Pages that are rearranged due
to changes on a previous page are not considered revised.
The documentation printing date and part number indicate its current edition. The printing
date changes when a new edition is printed. (Minor corrections and updates that are
incorporated at reprint do not cause the date to change.) The document part number changes
when extensive technical changes are incorporated.
iii
Text Conventions
The manual uses the following conventions for Notes, Cautions, and Warnings.
Caution A Caution calls attention to a condition or possible situation that could damage or
destroy the product or the user’s work.
Warning A Warning calls attention to a condition or possible situation that could cause injury to
the user and/or patient.
iv
Contents
1. Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-1
What is Exported? . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-1
Establishing a Connection. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-2
System Requirements . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-2
Contents-1
Contents-2
1
Overview
The SureSigns VM Series patient monitors can export patient monitoring data in HL7 format
over a local area network (LAN) using the TCP/IP transport protocol. The data can be sent to
a server and then forwarded to an Electronic Medical Records (EMR) system or sent directly
to the EMR system.
This manual is for HL7 programmers who want to develop an application that will receive the
HL7 data exported from the SureSigns VM monitors. This manual provides the following
information:
• The type of data that is exported from the SureSigns VM monitors and the intervals at
which the data is exported
• The syntax of the exported HL7 messages
• The MDIL numeric codes used in the exported HL7 messages
• The procedure for enabling data export on the SureSigns VM Series monitors
This manual assumes that the user is familiar with HL7 programming.
What is Exported?
Note—Only data with an assigned Patient ID is exported. If an entry does not have an
associated patient ID (“ID Unknown” appears in the patient information pane), the data is
not exported.
When the Data Export function is enabled, the SureSigns VM monitor exports data
periodically and aperiodically.
The periodic data is sent at regular time intervals, which can be configured in the Network
Configuration menu. Available intervals are: 5 min., 10 min., 15 min., 30 min., 1 hour,
2 hours, 4 hours, and 8 hours. Periodic data includes:
For information on setting the export intervals, enabling the Data Export function, and
encrypting the data, see Chapter 3, Enabling Data Export.
Overview 1-1
Establishing a Connection
Establishing a Connection
To establish a network connection, you must:
System Requirements
The server and network must meet the following minimum requirements:
1-2 Overview
2
HL7 Messages
Introduction
This chapter describes the two types of HL7 messages used with the SureSigns VM patient
monitor:
Message Description
ORU Unsolicited Observation Reporting. This message contains patient data
and vital signs parameters.
Note For a complete description of HL7 message syntax, see the HL7 Interface Standards Version
2.4.
Notation Conventions
The HL7 messages use the following notation conventions:
<SB>ddddd<EB><CR> <SB>
where:
<SB> = Start Block character (1 byte) ASCII <VT>, for example, <0x0B>. Do not confuse
this with the ASCII characters SOH or STX.
dddd = Data (variable number of bytes). This is the HL7 data content of the block. The data
can contain any ASCII characters and the carriage return character, <CR>, as delimiter of
individual segments.
<EB> = End Block character (1 byte) ASCII <FS>, for example, <0x1C>. Do not confuse this
with the ASCII characters ETX or EOT.
<CR> = Carriage Return (1 byte). The ASCII carriage return character, for example, <0x0D>.
^ Component separator
~ Repetition separator
\ Escape character
Abbreviations
The following abbreviations are used in the message syntax descriptions.
Abbreviations Description
Seq Sequence number
DT Data type
5. The receiver of the ACK message (the monitor) starts to send the next message in case
of success (AA code).
6. The receiver of the ACK message (the monitor) resends the message if the message was
rejected (AR code). After 3 retries, the monitor stops trying and waits until the next
interval.
7. If the server does not respond within 60 seconds, the monitor times out and retries the
transmission. After 3 retries, the monitor stops trying and waits until the next interval.
The following figure shows what happens when the monitor (Sender) sends a message to a
server (Receiving Application).
ORU
ACK (AA)
ORU
ACK (AR)
Retry ORU
ACK (AR)
ORU
ACK (AA)
• Patient information
• Bed data (device ID)
• All vital signs parameters currently available
Each ORU message consists of a variable number of segments that are delimited by the <CR>
character.
The following table describes the segments within the ORU message:
OBX Observation/result R 1 7
Example:
MSH|^~\&|^SureSignsVM||||20060510124500||ORU^R01^ORU_R01|USP1000302200
60510124500|P|2.4|||||||||2.16.840.1.113883.9.2.1<CR>
PID|||412345134||<CR>
ORC|NW|||||||||||||||||USP1000302
PV1||||||||||||||||||A<CR>
OBR||||MONITOR|||20060328134602<CR>
OBX||NM|0002-4bb8^SpO2^MDIL|0|95|0004-0220^%^MDIL|||||F<CR>
OBX||NM|0002-4182^HR^MDIL|0|60|0004-0aa0^bpm^MDIL|||||F<CR>
OBX||NM|0002-4a05^NBPs^MDIL|0|120|0004-0f20^mmHg^MDIL|||||F<CR>
OBX||NM|0002-4a06^NBPd^MDIL|0|70|0004-0f20^mmHg^MDIL|||||F<CR>
OBX||NM|0002-4a07^NBPm^MDIL|0|91|0004-0f20^mmHg^MDIL|||||F<CR>
OBX||NM|0401-0b54^pTemp^MDIL|0|37.1|0004-17a0^C^MDIL|||||F<CR>
Example:
MSH|^~\&|^SureSignsVM||||20060510124500||ORU^R01^ORU_R01|USP1000302200
60510124500|P|2.4|||||||||2.16.840.1.113883.9.2.1<CR>
Sample
Seq. Field Description DT Len Usage Min Max Table
Value
1 Field ST 1 R 1 1 |
Separator
7 Date/Time TS 20 R 1 1
of Message
Sample
Seq. Field Description DT Len Usage Min Max Table
Value
11 Processing PT 3 R 1 1
ID
Example: PID|||412345134||<CR>
Note — The Patient Name, family name, surname, and given name fields are not supported in
the current release of the SureSigns VM monitors.
Sample
Seq. Field Description DT Len Usage Min Max Table
Value
Sample
Seq. Field Description DT Len Usage Min Max Table
Value
5.1 family FN 20 RE 0 1
name
Example: ORC|NW|||||||||||||||||USP1000302
Sample
Seq. Field Description DT Len Usage Min Max Table
Value
1 Order ID 2 R 1 1 0119 NW
Control
Example: PV1||||||||||||||||||A<CR>
Sample
Seq. Field Description DT Len Usage Min Max Table
Value
Examples:
OBR||||MONITOR|||20060328134602<CR>
OBR||||SPOTCHECK|||20060328134602<CR>
OBR||||ALARM|||20060328134602<CR>
Sample
Seq. Field Description DT Len Usage Min Max Table
Value
4 Universal CE 250 R 1 1
Service
Identifier
Examples:
OBX||TX|1^Red Alarm^MDIL-ALERT|0|ASYSTOLE||||||F<CR>
OBX||NM|0002-4bb8^SpO2^MDIL|0|95|0004-0220^%^MDIL|||||F<CR>
OBX||NM|0002-4182^HR^MDIL|0|60|0004-0aa0^bpm^MDIL|||||F<CR>
OBX||NM|0002-4a05^NBPs^MDIL|0|120|0004-0f20^mmHg^MDIL|||||F<CR>
OBX||NM|0002-4a06^NBPd^MDIL|0|70|0004-0f20^mmHg^MDIL|||||F<CR>
OBX||NM|0002-4a07^NBPm^MDIL|0|91|0004-0f20^mmHg^MDIL|||||F<CR>
OBX||NM|0401-0b54^pTemp^MDIL|0|37.1|0004-17a0^C^MDIL|||||F<CR>
OBX||NM|0002-4a15^IBPs^MDIL|0|120|0004-0f20^mmHg^MDIL|||||F<CR>
OBX||NM|0002-4a16^IBPd^MDIL|0|70|0004-0f20^mmHg^MDIL|||||F<CR>
OBX||NM|0002-4a17^IBPm^MDIL|0|91|0004-0f20^mmHg^MDIL|||||F<CR>
OBX||NM|0002-50b0^etCO2^MDIL|4|38|0004-0220^%^MDIL|||||F<CR>
OBX||NM|0002-5000^Resp^MDIL|4|23|0004-0ae0^rpm^MDIL|||||F<CR>
OBX||NM|0401-0068^YSI^MDIL|0|37.1|0004-17a0^C^MDIL|||||F<CR>
OBX||NM|0002-5012^awRR^MDIL|4|30|0004-0ae0^rpm^MDIL|||||F<CR>
Sample
Seq. Field Description DT Len Usage Min Max Table
Value
Sample
Seq. Field Description DT Len Usage Min Max Table
Value
The following table describes the segments within the ACK message.
The following syntax message information represents the profile for the Receiver. Any
message segment not supported is ignored. RE elements (required, but can be empty) will be
used, if valid, but ignored otherwise.
Example:
MSH|^~\&|||||2006022012342200|ACK^^ACK_ALL|398098728972|P|2.4|
NE|NE|||415235.353.654
Sample
Seq. Field Description DT Len Usage Min Max Table
Value
1 Field ST 1 R 1 1 |
Separator
2 Encoding ST 4 R 1 1 ^~\&
Characters
7 Date/Time Of TS 26 R 1 1
Message
9 Message ST 20 R 1 1 398098728
Control ID 972
10 Processing ID PT 3 R 1 1
12 Accept ID 2 R 1 1 0155 NE
Acknowledg
ment Type
13 Application ID 2 R 1 1 0155 NE
Acknowledg
ment Type
Example: MSA|AA|USP100030220060510124500
Sample
Seq. Field Description DT Len Usage Min Max Table
Value
MDIL Codes
The SureSigns VM monitors use numeric codes from the Medical Device Interface Language
(MDIL) standard to uniquely identify parameter, alarm, and unit sources. The identifiers use
the following format:
<Partition>-<TermCode>
The values for the Partition and TermCode are hexadecimal values between 0x0000 and
0xffff, which are separated in the output with a “-” character.
Note The label strings in this chapter are valid only for installations with English language software.
When used in other countries, the label strings vary according to how they are translated into
the respective language. Philips recommends that for parameter identification, you use the
numeric parameter identifiers instead of parameter labels.
The following table shows the coding systems used by the SureSigns VM monitors.
<Partition>-<TermCode>
MDIL-ALERT Contains a unique ID for the severity of the alarm: Contains the alarm message
The following table lists the MDIL codes for all SureSigns VM parameters. Only those
parameters that are available on your SureSigns VM monitor are exported.
Parameter
MDIL Code Description
Label
0002-4bb8 SpO2 Oxygen saturation of arterial blood
Parameter
MDIL Code Description
Label
0401-0b54 pTemp Predictive temperature
The following table lists the MDIL codes for the units of measurement.
0004-0f20 mmHg
0004-0aa0 bpm
0004-0ae0 rpm
0004-17a0 C (Celsius)
1. Rotate the navigation wheel until the System icon is highlighted, then press the wheel.
System
Icon The System Menu appears.
2. Turn the navigation wheel until the System Admin button is highlighted, then press the
wheel.
A Password window appears.
3. Enter the Administrator password (2-1-5) by turning the navigation wheel until the first
box is highlighted, then pressing the wheel. Turn the wheel to select the first digit, then
press the wheel to save the digit. Repeat this for the next two digits of the password.
4. Rotate the navigation wheel until the OK button is highlighted, then press the wheel.
The System Admin Menu appears.
5. Rotate the navigation wheel until the Networking button is highlighted, then press the
wheel.
The Network Configuration menu appears.
6. Specify an IP address for the monitor:
To obtain an IP address from a DHCP server, select the Obtain an IP address
automatically (DHCP) checkbox.
To assign a specific IP address, select the Use the following IP address checkbox, and
then use the navigation wheel to manually enter an IP Address, Subnet Mask, and
Default Gateway.
7. Rotate the navigation wheel until the Data Export Interval field is highlighted. Select
the desired export interval. The available options are: Disable, 5 min., 10 min., 15
min., 30 min., 1 hour, 2 hours, 4 hours, and 8 hours.
After you select an interval, the Server IP Address field becomes available.
If you did not make changes to the IP address, the System Admin Menu reappears.
Rotate the wheel to highlight the Return button. The System Menu reaappears. Press
the Main Screen button on the front panel to return to the main screen.
Enabling Encryption
The SureSigns VM monitor supports the RC4 stream algorithm for encryption. RC4 is a data
encryption algorithm based on the RC4 symmetric stream cipher. The shared encryption key
must reside on the SureSigns VM Monitor and the server.
Establishing a Connection
To establish a network connection, plug one end of an RJ-45 Ethernet cable into the Ethernet
port on the back of the monitor and the other end into a LAN port.
Connection icon After you configure the TCP/IP address of the designated server and enable the Data Export
function (as described in the previous section), the monitor attempts to establish a connection
to the server.
When a connection is established, a connection icon appears in the upper left corner of the
monitor’s screen. The connection remains in effect indefinitely. If the network goes down or
the monitor is shut down, the monitor will attempt to re-establish the connection when the
next export interval is due to occur.
Note Each SureSigns VM monitor can export data to one server. The monitor cannot be configured
to export data to multiple destinations.
Index-1
Index-2