0% found this document useful (0 votes)
6 views38 pages

Image Vault 4.2 HL7 Interface White Paper: Revision History

The Image Vault 4.2 HL7 Interface White Paper outlines the HL7 interface functionality for the Image Vault application, detailing how it communicates with Hospital Information Systems via HL7 messages. It describes the inbound and outbound workflows, including message processing, acknowledgments, and data handling from GE Ultrasound scanners. The document also provides information on data types, delimiters, and the necessary technical support for successful implementation.

Uploaded by

tecnimedical1
Copyright
© © All Rights Reserved
We take content rights seriously. If you suspect this is your content, claim it here.
Available Formats
Download as PDF, TXT or read online on Scribd
0% found this document useful (0 votes)
6 views38 pages

Image Vault 4.2 HL7 Interface White Paper: Revision History

The Image Vault 4.2 HL7 Interface White Paper outlines the HL7 interface functionality for the Image Vault application, detailing how it communicates with Hospital Information Systems via HL7 messages. It describes the inbound and outbound workflows, including message processing, acknowledgments, and data handling from GE Ultrasound scanners. The document also provides information on data types, delimiters, and the necessary technical support for successful implementation.

Uploaded by

tecnimedical1
Copyright
© © All Rights Reserved
We take content rights seriously. If you suspect this is your content, claim it here.
Available Formats
Download as PDF, TXT or read online on Scribd
You are on page 1/ 38

White Paper

Image Vault 4.2 HL7 Interface White Paper

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 each time the document is updated.
Revision Date Comment
1 January 2007 Initial release of document.

Introduction

This document describes the HL7 interface, as it relates to the Image Vault 4.2 application.

The Image Vault (IV) HL7 interface communicates with a Hospital Information System (HIS) or
other third-party transcription system via HL7 formatted messages that import and export
relevant clinical information. This interface is designed to send and receive messages, real-time,
using the TCP/IP protocol (via a socket connection) and minimal layer protocol messaging
(MLP). The interface communication is part of the Image Vault application and is able to export
measurement information coming from a Vivid scanner. Successful implementation requires the
assistance of an Image Vault Interface Specialist, who can provide training and technical/project
management information.

Assumptions

„ It is assumed that the reader of this document is familiar with the HL7 standard. This
document is not intended as a standalone document, but should be used in conjunction with
the HL7 Specification, version 2.4*.
„ The HL7 interface can only be processed in real-time mode using the TCP/IP protocol.
„ The Image Vault customer is responsible for ensuring that the receiving HIS or transcription
system is capable and ready to receive HL7 messages from the Image Vault for processing.

* HL7 standards committee members can acquire a free copy of the current HL7 specification via
the http://www.HL7.org web page. Non-members can order a copy from the same location or by
contacting the representatives at the following location:
Health Level Seven
3300 Washtenaw Avenue, Suite 227
Ann Arbor, MI 48104-4250
Phone: (313) 677-7777; Fax: (313) 677-6622

Revision 1 Image Vault 4.2 HL7 Interface White Paper 1 of 38


5183820-100
Interface Workflow Overview
Inbound Workflow Overview
Supported incoming HL7 messages triggered from the HIS system are processed and the content
is saved into the local database.

Successfully processed messages are acknowledged. Messages, which for any reason were not
processed, are rejected with a non-acknowledge ACK HL7 message (as defined in HL7
Specification 2.4).

Incoming streams that are not MLLP formatted are ignored.


Outbound Workflow Overview
The Vivid scanner completes the exam (remote workflow - data is sent to Image Vault
immediately; local workflow - data is exported to Image Vault when study is closed and
exported). This study is then reviewed on an EchoPac and the report is completed. When the
report is stored on the EchoPAC PC, the patient's measurement and analysis data along with
comment fields filled at the EchoPAC PC are stored in a file readable by the Image Vault HL7
interface.

This file is then processed by the HL7 interface and an ORU^R01 HL7 message is sent to the HIS
system, containing the patient information and measurements from the file. These measurements
are wrapped in HL7 OBX segments.

Image Vault expects, for each message sent, that it will receive an acknowledgement message.
Image Vault will wait for period of time (user configured) for that message (60 to 120 seconds).
If no acknowledgement is received during the configured time frame, Image Vault re-sends the
message. No other messages are sent by Image Vault unless an acknowledgement is received (or
the message is manually removed from the Image Vault outbound queue).

Shown below is a successful ACK message:


MSH|^~\&|GE|ImageVault|sap||20060502133658||DFT^VP1|1|P|2.4|||AL|AL
MSA|AA

Escape characters are supported in our results that are sent outbound.
Field Description Symbol Replaced By
Field Separator | \F\
Component Separator ^ S\
Repetition Separator ~ \R\
Escape Characters \ \E\
Subcomponent Separator & \T\

For further details, see “HL7 Segments & Fields Definition for Outbound Workflow” on page 21 and
“Structure of an ORU^R01 event” on page 12.

2 of 38 Image Vault 4.2 HL7 Interface White Paper Revision 1


5183820-100
Measurement and Analysis Data Overview
The measurement and analysis data generated by the GE Ultrasound scanners is completely
documented in the applicable GE Ultrasound user manuals:
‹ EchoPAC PC 6.x User Guide - EP092874
‹ Vivid 7 User Manual - FC092326
‹ Vivid 7/EchoPAC PC User Manual - FC092540
‹ Vivid 5 User Manual - 2326917-100
‹ Vivid 4 User Manual - 2392752-100
‹ Vivid 3 Operator Manual - 2269651-100
‹ Vivid i User Manual - 2378958-100
These manuals give detailed descriptions of each data type and how they are used and accepted
by the system.

Revision 1 Image Vault 4.2 HL7 Interface White Paper 3 of 38


5183820-100
Workflow Description

The following illustration shows the message workflow between the HIS, the Image Vault and
the scanners. The essential steps in the workflow are as follows:

1. The HIS sends the order information to the HISComServer within the Image Vault, through
the HL7 Import function.

2. The acquisition devices retrieve the worklist from the Image Vault through the DICOM
Worklist function. The scanner generates a worklist query and the Image Vault uses the
information stored in the HISComServer to populate the worklist.

3. The staff performs the exam.

4. The exam images and measurement and analysis data are saved and sent to the Image Vault
database.

5. The patient is reviewed at the EchoPAC workstation.

6. The report is completed at the EchoPAC and stored.

7. Measurement and report summary data sent to HISComServer.

8. The HISComServer sends the measurement and analysis and report data back to the HIS
through the HL7 Export function..

4 of 38 Image Vault 4.2 HL7 Interface White Paper Revision 1


5183820-100
The following illustration shows the relationship between the Image Vault database (SQL
database) and the HISComServer. Essentially, data is passed back and forth between the HIS and
the HISComServer, and relevant data is sent to the Image Vault database for storage.

The HISComServer runs as a service, without a user interface. All messages are saved
immediately; however, acknowledge messages are only sent after the data is successfully stored.

(Discrete)

The following illustration shows the message processing within the HISComServer service.

Revision 1 Image Vault 4.2 HL7 Interface White Paper 5 of 38


5183820-100
HL7 Data Description

The Image Vault HL7 interface uses a socket connection (one for each direction). For the import,
the HL7 interface is a server on a configurable port; for the export, it is the client. The message
itself has a HL7 MLLP frame (i.e. a leading 0x0B and trailing \x1C\x0D). Acknowledge
messages can be returned after a message is received. For an export, an acknowledgement is
expected after a message is written to the socket.

Delimiter Definition

Encoding
Delimiter Value Character Usage
Position
Segment Terminator <cr> - Terminates a segment record. This value cannot be changed by implementors.
hex 0D
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 Separator & 4 Separates adjacent subcomponents of data fields, where allowed. If there are no
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.

Data Types

The data types in this section are listed in alphabetical order.

NOTE
For data types which contain multiple components or subcomponents, the examples given in
this section do not specify the optionality of the component or subcomponents. This must be
specified in the field definitions that follow the formal segment attribute tables (maximum
length of 64K).

Except for the TS data type, and the maximum or minimum lengths for several other data types
(CE, PN, TX, FT), the field length of HL7 attributes is specified in the segment attribute tables.
Any specific length of the components or subcomponents of those attributes must be specified in
the field definitions that follow the formal segment attribute tables. In general, HL7 does not
specify the lengths of components and/or subcomponents.

The data type examples are given using the standard HL7 encoding rules. Although only one set
of encoding rules is defined as a standard in HL7, version 2.4, other encoding rules are possible.
However, since they are non-standard, they may only be used by a site-specific agreement. In
certain data type definitions, square brackets ([ ]) are used to specify optional parts of a data type
(or a data type component or subcomponent).

6 of 38 Image Vault 4.2 HL7 Interface White Paper Revision 1


5183820-100
Data Type Definitions

Data Type
Category / Data Type Name Notes/Format
Data Type
Alphanumeric
ST String
TX Text Data
FT Formatted Text
Numeric
CQ Composite quantity with units <quantity (NM)> ^ <units (CE)>
MO Money <quantity (NM)> ^ <denomination (ID)>
NM Numeric
SI Sequence ID
SN Structured Numeric <comparator> ^ <num1 (NM)> ^ <separator/suffix> ^ <num2 (NM)>
Identifier
ID Coded values for HL7 tables
IS Coded value for user-defined
tables
HD Hierarchic designator <namespace ID (IS)> ^ <universal ID (ST)> ^ <universal ID type (ID)>
Used only as part of EI and other data types.
EI Entity Identifier <entity identifier (ST)> ^ <namespace ID (IS)> ^ <universal ID (ST)> ^ <universal ID
type (ID)>
RP Reference Pointer <pointer (ST)> ^ <application ID (HD)> ^ <type of data (ID)> ^ <subtype (ID)>
PL Person Location <point of care (IS)> ^ <room (IS)> ^ <bed (IS)> ^ <facility (HD)> ^ <location status (IS)>
^ <person location type (IS)> ^ <building (IS)> ^ <floor (IS)> ^ <location description
(ST)>
PT Processing Type <processing ID (ID)> ^ <processing mode (ID)>
Date/Time
DT Date YYYY[MM[DD]]
TM time HH[MM[SS[.S[S[S[S]]]]]][+/-ZZZZ]
TS Time Stamp YYY[MM[DD[HHMM[SS[.S[S[S[S]]]]]][+/-ZZZZ] ^ <degree of precision>
Code Values
CE Coded Element <identifier (ST)> ^ <text (ST)> ^ <name of coding system (ST)> ^ <alternate identifier
(ST)> ^ <alternate text (ST)> ^ <name of alternate coding system (ST)>
CF Coded Element with <identifier (ID)> ^ <formatted text (FT)> ^ <name of coding system (ST)> ^ <alternate
Formatted Values identifier (ID)> ^ <alternate formatted text (FT)> ^ <name of alternate coding system>
CK Composite ID with Check <ID number (NM)> ^ <check digit (NM)> ^ <code identifying the check digit scheme
Digit employed (ID)> ^ <assigning authority (HD)>
CN Composite ID Number and <ID number (ST)> ^ <family name (ST)> ^ <given name (ST)> ^ <middle initial or name
Name (ST)> ^ <suffix (ST)> ^ <prefix (ST)> ^ <degree (ST)> ^ <source table (IS)> ^ <assigning
authority (HD)>

Revision 1 Image Vault 4.2 HL7 Interface White Paper 7 of 38


5183820-100
CX Extended Composite ID with <ID (ST)> ^ <check digit (ST)> ^ <code identifying the check digit scheme employed
Check Digit (ID)> ^ <assigning authority (HD)> ^ <identifier type code (IS)> ^ <assigning facility
(HD)>
XCN Extended Composite ID In version 2.3, instead use the CN data type.
Number and Name <ID number (ST)> ^ <family name (ST)> ^ <given name (ST)> ^ <middle initial or name
(ST)> ^ <suffix (ST)> ^ <prefix (ST)> ^ <degree (ST)> ^ <source table (IS)> ^ <assigning
authority (HD)> ^ <name type code (ID)> ^ <identifier check digit (ST)> ^ <code
identifying the check digit scheme employed (ID)> ^ <identifier type code (IS)> ^
<assigning facility (HD)>
Generic
CM Composite No new CMs are allowed after HL7, version 2.2.
Demographics
AD Address <street address (ST)> ^ <other designation (ST)> ^ <city (ST)> ^ <state or province
(ST)> ^ <zip or postal code (ST)> ^ <country (ID)> ^ <address type (ID)> ^ <other
geographic designation (ST)>
PN Person Name <family name (ST)> ^ <given name (ST)> ^ <middle initial or name (ST)> ^ <suffix (ST)>
^ <prefix (ST)> ^ <degree (ST)>
TN Telephone Number [NN] [(999)999-9999[X99999][B99999][C any text]
XAD Extended Address In version 2.3, replaces AD data type.
<street address (ST)> ^ <other designation (ST)> ^ <city (ST)> ^ <state or province
(ST)> ^ <zip or postal code (ST)> ^ <country (ID)> ^ <address type (ID)> ^ <other
geographic designation (ST)> ^ <county/parish code (IS)> ^ <census tract (IS)>
XPN Extended Person Name In Version 2.3, replaces the PN data type.
<family name (ST)> ^ <given name (ST)> ^ <middle initial or name (ST)> ^ <suffix (ST)>
^ <prefix (ST)> ^ <degree (ST)> ^ <name type code (ID)>
XON Extended Composite Name <organization name (ST)> ^ <organization name type code (IS)> ^ <ID number (NM)> ^
and ID Number for <check digit (NM)> ^ <code identifying the check digit scheme employed (ID) > ^
Organization <assigning authority (HD)> ^ <identifier type code (IS)> ^ <assigning facility ID (HD)>
XTN Extended In version 2.3, replaces the TN data type.
telecommunications Number [NN] [(999)999-9999[X99999][B99999][C any text] ^ <telecommunication use code
(ID)> ^ <telecommunication equipment type (ID)> ^ <email address (ST)> ^ <country
code (NM)> ^ <area/city code (NM)> ^ <phone number (NM)> ^ <extension (NM)> ^
<any text (ST)>
Specialty/Chapter Specific
Waveform
CD Channel Definition For waveform data only.
<channel identifier (*)> ^ <channel number (NM)> & <channel name (ST)>> ^
<electrode names (*) > ^ <channel sensitivity/units (*) > ^ <calibration parameters (*)> ^
<sampling frequency (NM)> ^ <minimum/maximum data values (*)>
MA Multiplexed Array For wave form data only.
<sample 1 from channel 1 (NM)> ^ <sample 1 from channel 2 (NM)> ^ <sample 1 from
channel 3 (NM)> .. ~<sample 2 from channel 1 (NM)> ^ <sample 2 from channel 2
(NM)> ^ <sample 2 from channel 3 (NM)>... ~
NA Numeric Array For wave form data only.
<value1 (NM)> ^ <value2 (NM)> ^ <value3 (NM)> ^ <value4 (NM)> ^...

8 of 38 Image Vault 4.2 HL7 Interface White Paper Revision 1


5183820-100
ED Encapsulated Data Support ASCII MIME-encoding of binary data.
<source application (HD) > ^ <main type of data (ID)> ^ <data subtype (ID)> ^
<encoding (ID)> ^ <data (ST)>
Price Data
CP Composite Price In version 2.3, replaces the MO data type.
<price (MO) > ^ <price type (ID)> ^ <from value (NM)> ^ <to value (NM)> ^ <range units
(CE)> ^ <range type (ID)>
Patient Administration / Financial Information
FC Financial Class <financial class (ID)> ^ <effective date (TS)>
Extended Queries
QSC Query Selection Criteria <name of field (ST)> ^ <relational operator (ID)> ^ <value (ST)> ^ <relational
conjunction (ID)>
QIP Query Input Parameter List <field name (ST) > ^ <value1 (ST) & value2 (ST) & value3 (ST)...>
RCD Row Column Definition <HL7 item number (ST)> ^ <HL7 data type (ST)> ^ <maximum column width (NM)>
Master Files
DLN Driver’s License Number <license number (ST)> ^ <issuing state, province, country (IS)> ^ <expiration date (DT)
JCC Job Code/Class <job code (IS)> ^ <job class (IS)>
VH Visiting Hours <start day range (ID)> ^ <end day range (ID)> ^ <start hour range (TM)> ^ <end hour
range (TM)>
Medical Records / Information Management
PPN Performing Person Time <ID number (ST)> ^ <family name (ST)> ^ <given name (ST)> ^ <middle initial or name
Stamp (ST)> ^ <suffix (e.g., JR or III) (ST)> ^ <prefix (e.g., DR) (ST)> ^ <degree (e.g., MD)
(ST)> ^ <source table (IS)> ^ <assigning authority (HD)> ^ <name type code(ID)> ^
<identifier check digit (ST)> ^ <code identifying the check digit scheme employed (ID)>
^ <identifier type code (IS)> ^ <assigning facility (HD)> ^ < date/time action performed
(TS)>
Time Series
DR Date/Time Range Scheduling Chapter Only: <range start date/time (TS)> ^ <range end date/time (TS)>
RI Repeat Interval Scheduling Chapter Only. <repeat pattern (IS)> ^ <explicit time interval (ST)>
SCV Scheduling Class Value Pair Scheduling Chapter Only. <parameter class (IS)> ^ <parameter value (IS)>
TQ Timing/Quantity <quantity (CQ)> ^ <interval (*)> ^ <duration (*)> ^ <start date/time (TS)> ^ <end date/
time (TS)> ^ <priority (ID)> ^ <condition (ST)> ^ <text (TX)> ^ <conjunction (ID)> ^
<order sequencing (*)>

Revision 1 Image Vault 4.2 HL7 Interface White Paper 9 of 38


5183820-100
Supported Messages and Events

Message Import to Export from


Event Structure Usage
Type Image Vault Image Vault
ADT A01 X 1 Admission of inpatients/outpatients
ADT A02 X 1 Transfer
ADT A03 X 1 Discharge
ADT A04 X 1 Register visit
ADT A06 X 1 Change outpatient to inpatient
ADT A07 X 1 Change inpatient to outpatient
ADT A08 X 2 Change of patient or account data
ADT A11 X Cancel admission of inpatient/outpatient
ADT A12 X 1 Insert or update patient demographics
ADT A13 X 1 Insert or update patient demographics
ADT A29 X 1 Delete existing patient
ADT A40 X Merge patient info
OMG O19 X 4 Submit a clinical order
ORM O01 X 4 Submit a clinical order
ORU R01 X 5 Measurement data from Vivid scanner
ACK X 6 Acknowledgement to all inbound messages

Structure of ADT Messages

ADT^A(*) Adt message


MSH Message Header
PID Patient Identification
PV1 Patient Visit

ACK^A(*) Acknowledgment
MSH Message header
MSA Message acknowledgment

(*): The message structure is identical for the following ADT events:

ADT^A01, ADT^A02, ADT^A03, ADT^A04, ADT^A05, ADT^A06, ADT^A07, ADT^ A08,


ADT^A12, ADT^A13 and ADT^A29.

10 of 38 Image Vault 4.2 HL7 Interface White Paper Revision 1


5183820-100
Structure of ADT^A40 Event

ADT^A40 Adt message


MSH Message Header
PID Patient Identification
PV1 Patient Visit
MGR Merge information

ACK^A40 Acknowledgment
MSH Message header
MSA Message acknowledgment

Structure of OMG^O19 Event

OMG^O19 General Clinical Order Message


MSH Message Header
PID Patient Identification
PV1 Patient Visit
ORC Common order
OBR Observation

ACK^O19 Acknowledgment
MSH Message header
MSA Message acknowledgment

Structure of ORM^O01 Event

ORM^R01 General Clinical Order Message


MSH Message Header
PID Patient Identification
PV1 Patient Visit
ORC Common order
OBR Observation

ACK^RO1 Acknowledgment
MSH Message header
MSA Message acknowledgment

Revision 1 Image Vault 4.2 HL7 Interface White Paper 11 of 38


5183820-100
Structure of an ORU^R01 event

ORU^R01 Unsolicited Observation Message


MSH Message Header
PID Patient Identification
PV1 Patient Visit
OBR Observations Report ID 7
{OBX} Observation/Result 7
[AL1] Patient Allergy
ZDS
{
}

ACK^R01 Acknowledgment
MSH Message header
MSA Message acknowledgment

Example of an ORU^R01 event from Vivid:

MSH|^~\&|VPHISCOMSERVER||facility1||||ORU^R01|7|P|2.4||||AL
PID|||23|21|WHITE^DAVID||19451201|MALE|||
ADDRESS^^CITY^STATE^9888||9888233|98882387||||||||TYPE
PV1|||bed1||||||||||||||||133
OBR||||^description|||||||||alert1|||||||234
OBX|1|NM|^pname1|id1|value1|units1|||||F
OBX|2|NM|^pname2|id2|value2|units2|||||F
OBX|3|NM|^pname3|id3|value3|units3|||||F
AL1||DA|^allergy type
ZDS|1.2.34665.347653.88.547.2

12 of 38 Image Vault 4.2 HL7 Interface White Paper Revision 1


5183820-100
HL7 Segments & Fields Definition for Inbound Workflow
The interpretation of the fields is based in HL7 Standard version 2.4.
NOTE
The inbound workflow information described in the following sections reflects what the
Image Vault receives from the HIS; however, not all fields are published in the worklist. For
more details on what is contained in the worklist, refer to the Image Vault 4.1 DICOM
Conformance Statement, found at the following link:
http://www.gehealthcare.com/usen/interoperability/dicom/index.html

The following abbreviations are used in the tables below:


„ Seq - Sequence
„ Len - Length
„ DT - Data Type
„ Opt - Optional (R = Required, O = Optional)
„ RP# - Reference Pointer number
MSH - Message Header Segment
The MSH segment defines the intent, source, destination and some specifics of the syntax of a
message.
A sample MSH segment:
MSH|^\&~|Viewpoint|Orders|||20040330144907||ORM^O01|116|P|2.4|||||

Seq Len DT Opt RP# HL7 Field Name Description


1 1 ST R Field Separator |
2 4 ST R Encoding Characters ^~\&
3 180 HD O Sending Application Sending application
4 180 HD O Sending Facility NOT USED
5 180 HD O Receiving Application Name of the receiving application, as defined in the
configuration of the Image Vault HL7 interface
6 180 HD O Receiving Facility NOT USED
7 26 TS O Date/Time of Message Time of the message
8 40 ST O Security NOT USED
9 7 CM R Message Type HL7 Message Type
10 20 ST R Message Control ID Message Identifier
11 3 PT R Processing ID Processing ID
12 8 ID R Version ID Version Number
13 15 NM O Sequence Number NOT USED
14 180 ST O Continuation Pointer NOT USED
15 2 ID O Accept Acknowledgement Type Values comparison: “AL” or not “AL”
16 2 ID O Application Acknowledgment Type Values comparison: “AL” or not “AL”
17 2 ID O Country Code NOT USED
18 6 ID O Y/3 Character Set NOT USED
19 60 CE O Principal Language of Message NOT USED

Revision 1 Image Vault 4.2 HL7 Interface White Paper 13 of 38


5183820-100
PID - Patient Identification Segment

The PID segment is used by the Image Vault HL7 interface for receiving patient identification
information. This segment contains permanent patient identification and demographic
information that, for the most part, is not likely to change frequently.
A sample PID segment:
PID||1234567890111111|000011|123456789011| ULTRASOUND^P1^APPLE||19700101|M
Seq Len DT Opt RP# HL7 Field Name Description
1 4 SI O Set ID - Patient ID NOT USED
2 20 CX R Patient ID (External ID) Patient ID
3 20 CX O Y Patient ID (Internal ID) NOT USED
4 20 CX O Y Alternate Patient ID - PID NOT USED
5 48 XPN R Y Patient Name Patient Name
6 48 XPN O Mother’s Maiden Name Maiden name
7 26 TS R Date/Time of Birth DOB
8 1 IS R Sex Patient sex
9 48 XPN O Y Patient Alias NOT USED
10 1 IS O Race Ethnic origin
11 106 XAD O Y Patient Address Address
12 4 IS B County Code NOT USED
13 40 XTN O Y Phone Number: Home Private phone
14 40 XTN O Y Phone Number: Business Work phone
15 60 CE O Primary Language Language
16 1 IS O Marital Status Marital Status
17 3 IS O Religion Patient religion
18 20 CX R Patient Account Number Patient Account Number
19 16 ST O SSN Number - Patient NOT USED
20 25 DLN O Driver’s License Number - Patient NOT USED
21 20 CX O Y Mother’s Identifier NOT USED
22 3 IS O Ethnic Group Patient ethnic group
23 60 ST O Birth Place NOT USED
24 2 ID O Multiple Birth Indicator NOT USED
25 2 NM O Birth Order NOT USED
26 4 IS O Y Citizenship NOT USED
27 60 CE O Veteran’s Military Status NOT USED
28 80 CE O Nationality NOT USED
29 26 TS O Patient Death Date and Time NOT USED
30 1 ID O Patient Death Indicator NOT USED

14 of 38 Image Vault 4.2 HL7 Interface White Paper Revision 1


5183820-100
PV1 - Patient Visit Segment

The PV1 segment is used by Registration/Patient Administration applications to communicate


information on a visit-specific basis.

A sample PV1 segment:

PV1||E|Trauma room|A||||1234567894^MATHER^JOANNE^W.^DR.^|||In the


hall||||||1234567898^TIESSEN^YEVES^ANDREW.^DR.^||000000001||||||||||||
||||||||PA|||||20040630060709|20040703060709

Seq Len DT Opt RP# HL7 Field Name Description


1 4 SI O Set ID - PV1 NOT USED
2 1 IS O Patient Class Case Type
3 80 PL O Assigned Patient Location Patient Location
4 2 IS O Admission Type NOT USED
5 20 CX O Preadmit Number NOT USED
6 80 PL Prior Patient Location Prior patient location

7 60 XCN O Y Attending Doctor NOT USED


8 60 XCN O Y Referring Doctor NOT USED
9 60 XCN O Y Consulting Doctor NOT USED
10 3 IS O Hospital Service NOT USED
11 80 PL O Temporary Location NOT USED
12 2 IS O Preadmit Test Indicator NOT USED
13 2 IS O Readmission Indicator NOT USED
14 3 IS O Admit Source NOT USED
15 2 IS O Y Ambulatory Source NOT USED
16 2 IS O VIP Indicator VIP Indicator
17 60 XCN O Y Admitting Doctor NOT USED
18 2 IS O Patient Type NOT USED
19 20 CX R Visit Number Hospital Case ID
20 50 FC O Y Financial Class NOT USED
21 2 IS O Charge Price Indicator NOT USED
22 2 IS O Courtesy Code NOT USED
23 2 IS O Credit Rating NOT USED
24 2 IS O Y Contract Code Contract Code
25 8 DT O Y Contract Effective Date NOT USED
26 12 NM O Y Contract Amount NOT USED
27 3 NM O Y Contract Period NOT USED
28 2 IS O Interest Code NOT USED
29 1 IS O Transfer to Bad Debt Code NOT USED

Revision 1 Image Vault 4.2 HL7 Interface White Paper 15 of 38


5183820-100
30 8 DT O Transfer to Bad Debt Date NOT USED
31 10 IS O Bad Debt Agency Code NOT USED
32 12 NM O Bad Debt Transfer Amount NOT USED
33 12 NM O Bad Debt Recovery Amount NOT USED
34 1 IS O Delete Account Indicator NOT USED
35 8 DT O Delete Account Date NOT USED
36 3 IS O Discharge Disposition NOT USED
37 25 CM O Discharged to Location NOT USED
38 2 IS O Diet Type NOT USED
39 2 IS O Servicing Facility Servicing Facility
40 1 IS B Bed Status NOT USED
41 2 IS O Account Status NOT USED
42 80 PL O Pending Location NOT USED
43 80 PL O Prior Temporary Location NOT USED
44 26 TS O Admit Date/Time NOT USED
45 26 TS O Discharge Date/Time NOT USED
46 12 NM O Current Patient Balance NOT USED
47 12 NM O Total Charges NOT USED
48 12 NM O Total Adjustments NOT USED
49 12 NM O Total Payments NOT USED
50 20 CX O Alternate Visit ID NOT USED
51 1 IS O Visit Indicator NOT USED
52 60 XCN O Y Other Healthcare Provider NOT USED

16 of 38 Image Vault 4.2 HL7 Interface White Paper Revision 1


5183820-100
ORC - Common Order Segment

The Common Order segment (ORC) is used to transmit fields that are common to all orders.

A sample ORC segment:

ORC||DMS_10074|||||^1^INDEF^20040330142522^||20040330142522||||||||||
Seq Len DT Opt RP# HL7 Field Name Description
1 2 ID O Order Control NOT USED
2 22 EI R Placer Order Number Order Number
3 22 EI O Sequence ID NOT USED
4 22 EI O Placer Group Number NOT USED
5 2 ID O Order Status NOT USED
6 1 ID O Response Flag NOT USED
7 200 TQ O Quantity/Timing Priority^quantity^frequency^timing of an atomic device.
8 200 CM O Parent NOT USED
9 26 TS O Date/Time of Transaction Date/Time of Transaction
10 120 XCN O Entered By NOT USED
11 120 XCN O Verified By NOT USED
12 120 XCN O Ordering Provider Identify of the person who is responsible for creating the request.
13 80 PL O Enterer’s Location NOT USED
14 40 XTN O Y/2 Callback Phone Number Telephone number to call for clarification of a request or other
information regarding the order. ORC-14 callback number is the
same as OBR-17 order callback phone number
15 26 TS O Order Effective Date/Time NOT USED
16 200 CE O Order Control Code Reason NOT USED
17 60 CE O Entering Organization NOT USED
18 60 CE O Entering Device NOT USED
19 120 XCN O Action By NOT USED
20 - - - NOT USED (Reserved) NOT USED (Reserved for future use)
21 60 CE O Ordering Facility Ordering Facility

Revision 1 Image Vault 4.2 HL7 Interface White Paper 17 of 38


5183820-100
OBR - Observation Request Segment

The Observation Request segment is use to transmit information specific to an order for a
diagnostic study or observation, physical exam, or assessment.

A sample OBR segment:

OBR||DMS_10074||DEFAULT_CATH^Default CATH Emergency Universal Service


ID^^^^||||||||||||||DMS_10094|92||||||||^1^INDEF^20040330142522^|||| ^^^^^||||||||||||||||

Seq Len DT Opt RP# HL7 Field Name Description


1 4 SI O Set ID - OBR NOT USED
2 75 EI R Placer Order Number Identical to ORC-2 placer order number
3 75 EI O Filler Order Number + NOT USED
4 200 CE O Universal Service ID Identifier code for the requested observation/test/battery.
5 2 ID O Priority NOT USED
6 26 TS O Requested Date/Time NOT USED
7 26 TS O Observation Date/Time # NOT USED
8 26 TS O Observation End Date/Time # NOT USED
9 20 CQ O Collection volume * NOT USED
10 60 XCN O Y Collector Identifier * NOT USED
11 1 ID O Specimen Action Code * NOT USED
12 60 CE O Danger Code NOT USED
13 300 ST O Relevant Clinical Information NOT USED
14 26 TS O Specimen Received Date/ NOT USED
Time *
15 300 CM O Specimen Source * NOT USED
16 80 XCN O Y Ordering Provider Provider who ordered the test.
17 40 XTN O Y/2 Order Callback Phone Number Telephone number for reporting a status or a result using the
standard format with extension and/or beeper number when
applicable.
18 60 ST O Placer Field 1 Placer field 1
19 60 ST O Placer Field 2 Placer field 2
20 60 ST O Filler Field 1 + This field is definable for any use by the filler (diagnostic service)
21 60 ST O Filler Field 2 + NOT USED
22 26 TS O Rpt/Status Chng - Data/Time NOT USED
23 40 CM O Charge to Practice + NOT USED
24 10 ID O Diagnostic Service Section ID NOT USED
25 1 ID C Result Status + NOT USED
26 400 CM O Parent Result + NOT USED
27 200 TQ R Y Quantity/Timing Transaction Date/Time
28 150 XCN O Y/5 Result Copies to NOT USED

18 of 38 Image Vault 4.2 HL7 Interface White Paper Revision 1


5183820-100
29 150 CM O Parent NOT USED
30 20 ID O Transportation Mode This field identifies how (or whether) to transport a patient, when
applicable.
31 300 CE O Y Reason for Study Code or text using the conventions for coded fields.
32 200 CM O Principal Result Interpreter + NOT USED
33 200 CM O Y Assistant Result Interpreter + NOT USED
34 200 CM O Y Technician + NOT USED
35 200 CM O Y Transcriptionist + NOT USED
36 26 TS R Scheduled Date/Time + Exam Scheduled Date/Time
37 4 NM O 01028 NOT USED
38 60 CE O 01029 NOT USED
39 200 CE O 01030 NOT USED
40 60 CE O 01031 NOT USED
41 30 ID O 01032 NOT USED
42 1 ID O 01033 NOT USED
43 200 CE O 01034 NOT USED

Revision 1 Image Vault 4.2 HL7 Interface White Paper 19 of 38


5183820-100
Sample Inbound Message

MSH|^~\&|VIEWPOINT|ORDERS|||200503071251||ORM^O01|CHPFADMT|P|2.4|||AL|NE

EVN|O01|200503071251|||TLACOR

PID|1|111114|111112|672024^^^MXV^PI|Ordertest^Hannah^A^^MS||19761212|F||17|123 ELM
STREET^SUITE 678^NORTHRIDGE^CA^91324^USA||(800)555-2222|(888)666-
3333|GERMAN|100000|AOG|11111|123456789

PV1||I|6SOUTH^999^B|R|||022822^PRESTON, BILL S.|77778^JACKSON^JANET^^^^^GE


HOSPITAL^123 ELECTRIC AVE.^MILWAUKEE^WI^20202^(888)111-2222^(888)111-
2223^(888)111-2224^HELLO, THIS IS A TEST!||MED||||RA|||022822^PRESTON, BILL
S.|IA|00000963852741|C||||||||||||||||||||||||200503101250

ORC|NW|DMS_10074|10094||SC||^1^INDEF^20040330142522^||20040330142522||||^^^WCC^
^^^^||||||

OBR|1|DMS_10074|369125|Cardiac Bubble Study^Default US Emergency Universal Service


ID^^^^||||||||||||||DMS_10094|92||||||||^1^INDEF^20040330142522^||||^^^^^|||||||||||||DEFAULT_US^
Default US Emergency Requested Procedure Code^^^^||||||

20 of 38 Image Vault 4.2 HL7 Interface White Paper Revision 1


5183820-100
HL7 Segments & Fields Definition for Outbound Workflow

The interpretation of the fields is based in HL7 Standard version 2.4.

MSH - Message Header Segment

The MSH segment defines the intent, source, destination and some specifics of the syntax of a
message.

A sample MSH segment:

MSH|^~\&|VPHISCOMSERVER||facility1||||ORU^R01|7|P|2.3.1||||AL|

Seq Len DT Opt RP# HL7 Field Name Description


1 1 ST R Field Separator |
2 4 ST R Encoding Characters ^~\&
3 180 HD R Sending Application From
4 180 HD R Sending Facility Sending Facility
5 180 HD R Receiving Application Destination
6 180 HD R Receiving Facility Receiving facility
7 26 TS R Date/Time of Message Time
8 40 ST O Security NOT USED
9 7 CM R Message Type ORU^R01
10 20 ST R Message Control ID Message Identifier
11 3 PT R Processing ID P
12 8 ID R Version ID 2.3.1
13 15 NM O Sequence Number NOT USED
14 180 ST O Continuation Pointer NOT USED
15 2 ID O Accept Acknowledgement Type NOT USED
16 2 ID O Application Acknowledgment Type AL= Always
17 2 ID O Country Code NOT USED
18 6 ID O Y/3 Character Set NOT USED
19 60 CE O Principal Language of Message NOT USED

Revision 1 Image Vault 4.2 HL7 Interface White Paper 21 of 38


5183820-100
PID - Patient Identification Segment

The PID segment is used by the Image Vault HL7 interface for receiving patient identification
information. This segment contains permanent patient identification and demographic
information that, for the most part, is not likely to change frequently.
A sample PID segment:
PID|||measurements||all^cardiac||1981-06-04 00:00:00|FEMALE||||||||||||||
Seq Len DT Opt RP# HL7 Field Name Vivid Column Name
1 4 SI O Set ID - Patient ID NOT USED
2 20 CX R Patient ID (External ID) Patient ID
3 20 CX O Y Patient ID (Internal ID) NOT USED
4 20 CX O Y Alternate Patient ID - PID Other patient ID
5 48 XPN R Y Patient Name LastName^FirstName
6 48 XPN O Mother’s Maiden Name NOT USED
7 26 TS R Date/Time of Birth Birthdate
8 1 IS R Sex Sex
9 48 XPN O Y Patient Alias NOT USED
10 1 IS O Race NOT USED
11 106 XAD O Y Patient Address Address
12 4 IS B County Code NOT USED
13 40 XTN O Y Phone Number - Home Home Phone
14 40 XTN O Y Phone Number - Business NOT USED
15 60 CE O Primary Language NOT USED
16 1 IS O Marital Status NOT USED
17 3 IS O Religion NOT USED
18 20 CX R Patient Account Number Admission ID
19 16 ST O SSN Number - Patient NOT USED
20 25 DLN O Driver’s License Number - Patient NOT USED
21 20 CX O Y Mother’s Identifier NOT USED
22 3 IS O Ethnic Group NOT USED
23 60 ST O Birth Place NOT USED
24 2 ID O Multiple Birth Indicator NOT USED
25 2 NM O Birth Order NOT USED
26 4 IS O Y Citizenship NOT USED
27 60 CE O Veteran’s Military Status NOT USED
28 80 CE O Nationality NOT USED
29 26 TS O Patient Death Date and Time NOT USED
30 1 ID O Patient Death Indicator NOT USED

22 of 38 Image Vault 4.2 HL7 Interface White Paper Revision 1


5183820-100
PV1 - Patient Visit Segment

The PV1 segment is used by Registration/Patient Administration applications to communicate


information on a visit-specific basis.

A sample PV1 segment:

PV1|||bed1||||||||||||||||133
Seq Len DT Opt RP# HL7 Field Name Vivid Column Name
1 4 SI O Set ID - PV1 NOT USED
2 1 IS O Patient Class NOT USED
3 80 PL O Assigned Patient Location Current Patient Location

4 2 IS O Admission Type NOT USED


5 20 CX O Preadmit Number NOT USED
6 80 PL Prior Patient Location NOT USED

7 60 XCN O Y Attending Doctor NOT USED


8 60 XCN O Y Referring Doctor NOT USED
9 60 XCN O Y Consulting Doctor NOT USED
10 3 IS O Hospital Service NOT USED
11 80 PL O Temporary Location NOT USED
12 2 IS O Preadmit Test Indicator NOT USED
13 2 IS O Readmission Indicator NOT USED
14 3 IS O Admit Source NOT USED
15 2 IS O Y Ambulatory Source NOT USED
16 2 IS O VIP Indicator NOT USED
17 60 XCN O Y Admitting Doctor NOT USED
18 20 CX O Patient Type NOT USED
19 20 CX R Visit Number Admission ID
20 50 FC O Y Financial Class NOT USED
21 2 IS O Charge Price Indicator NOT USED
22 2 IS O Courtesy Code NOT USED
23 2 IS O Credit Rating NOT USED
24 2 IS O Y Contract Code NOT USED
25 8 DT O Y Contract Effective Date NOT USED
26 12 NM O Y Contract Amount NOT USED
27 3 NM O Y Contract Period NOT USED
28 2 IS O Interest Code NOT USED
29 1 IS O Transfer to Bad Debt Code NOT USED
30 8 DT O Transfer to Bad Debt Date NOT USED

Revision 1 Image Vault 4.2 HL7 Interface White Paper 23 of 38


5183820-100
31 10 IS O Bad Debt Agency Code NOT USED
32 12 NM O Bad Debt Transfer Amount NOT USED
33 12 NM O Bad Debt Recovery Amount NOT USED
34 1 IS O Delete Account Indicator NOT USED
35 8 DT O Delete Account Date NOT USED
36 3 IS O Discharge Disposition NOT USED
37 25 CM O Discharged to Location NOT USED
38 2 IS O Diet Type NOT USED
39 2 IS O Servicing Facility NOT USED
40 1 IS B Bed Status NOT USED
41 2 IS O Account Status NOT USED
42 80 PL O Pending Location NOT USED
43 80 PL O Prior Temporary Location NOT USED
44 26 TS O Admit Date/Time NOT USED
45 26 TS O Discharge Date/Time NOT USED
46 12 NM O Current Patient Balance NOT USED
47 12 NM O Total Charges NOT USED
48 12 NM O Total Adjustments NOT USED
49 12 NM O Total Payments NOT USED
50 20 CX O Alternate Visit ID NOT USED
51 1 IS O Visit Indicator NOT USED
52 60 XCN O Y Other Healthcare Provider NOT USED

24 of 38 Image Vault 4.2 HL7 Interface White Paper Revision 1


5183820-100
OBR - Observation Request Segment

The Observation Request segment is use to transmit information specific to an order for a
diagnostic study or observation, physical exam, or assessment. This segment is non-repeating.

A sample OBR segment:

OBR||||^description|||||||||alert1|||||||234|

Seq Len DT Opt RP# HL7 Field Name Vivid Column Name
1 4 SI O Set ID - OBR NOT USED
2 75 EI R Placer Order Number Accession Number
3 75 EI O Filler Order Number NOT USED
4 200 CE O Universal Service ID Requested procedure description
5 2 ID O Priority NOT USED
6 26 TS O Requested Date/Time NOT USED
7 26 TS R Observation Date/Time # Study Date/Time
8 26 TS O Observation End Date/Time # NOT USED
9 20 CQ O Collection Volume * NOT USED
10 60 XCN O Y Collector Identifier * NOT USED
11 1 ID O Specimen Action Code * NOT USED
12 60 CE O Danger Code NOT USED
13 300 ST O Relevant Clinical Info. Medical alerts
14 26 TS C Specimen Received Date/Time * NOT USED
15 300 CM O Specimen Source * NOT USED
16 80 XCN O Y Ordering Provider NOT USED
17 40 XTN O Y/2 Order Callback Phone Number NOT USED
18 60 ST O Placer Field 1 NOT USED
19 60 ST O Placer Field 2 NOT USED
20 60 ST O Filler Field 1 + SPSID
21 60 ST O Filler Field 2 + NOT USED
22 26 TS R Rpt/Status Chng - Data/Time Report URL/Report Verification Date
23 40 CM O Charge to Practice + NOT USED
24 10 ID O Diagnostic Serv Sect ID NOT USED
25 1 ID C Result Status + NOT USED
26 400 CM O Parent Result + NOT USED
27 200 TQ O Y Quantity/Timing NOT USEd
28 150 XCN O Y/5 Result Copies to NOT USED
29 150 CM O Parent NOT USED
30 20 ID O Transportation Mode NOT USED
31 300 CE O Y Reason for Study NOT USED

Revision 1 Image Vault 4.2 HL7 Interface White Paper 25 of 38


5183820-100
32 200 CM R Principal Result Interpreter + Reading Physician
33 200 CM O Y Assistant Result Interpreter + NOT USED
34 200 CM O Y Technician + NOT USED
35 200 CM R Y Transcriptionist + Operator
36 26 TS O Scheduled Date/Time + NOT USED
37 4 NM O 01028 NOT USED
38 60 CE O Y 01029 NOT USED
39 200 CE O Y 01030 NOT USED
40 60 CE O 01031 NOT USED
41 30 ID O 01032 NOT USED
42 1 ID O 01033 NOT USED
43 200 CE O Y 01034 NOT USED
OBX - Observation Segment

The OBX segment is used to transmit an entire observation result, for a specific examination (one
examination only) This segment is repeating.

A spreadsheet containing the Vivid 7 (BT05) parameters for the Result Values is available
on the Ultrasound Support Central site, in the Image Vault section.

A sample OBX segment:

OBX|1|NM|^pname1|id1|value1|units1|||||F
Seq Len DT Opt RP# HL7 Field Name Vivid Column Name
1 10 SI O Set ID - OBX ID
2 2 ID R Value Type Value Type
3 590 CE R Observation Identifier ResultIdentifier^parameter name
4 20 ST O Observation Sub-ID NOT USED
5 65536 ST R Observation Value Result Value
6 60 CE O Units Display Units
7 10 ST O References Range NOT USEd
8 5 ID O Y/5 Abnormal Flags NOT USED
9 5 NM O Probability NOT USED
10 2 ID O Y Nature of Abnormal Test NOT USED
11 1 ID R Observation Result Status Results status
12 26 TS O Data Last Obs Normal Values NOT USED
13 20 ST O User Defined Access Checks NOT USED
14 26 TS C Date/Time of the Observation NOT USED
15 60 CE O Producer’s ID NOT USED
16 80 XCN O Responsible Observer NOT USEd
17 60 CE O Y Observation Method NOT USED

26 of 38 Image Vault 4.2 HL7 Interface White Paper Revision 1


5183820-100
Explanation of Observation Segment Fields

List of Field Types

The following field types are exported:


„ Numeric - Numbers, such as “Age”, “ResultValue”, etc.
„ String - Character strings, suchas “PatientID”, LastName”, etc.
„ Date or Time - Date/Time fields, such as “BirthDate”, LastSeriesDateTime”, etc.

Tables of exported fields and comments are listed in this section.

Identification of a Patient, Examination, or M&A Data

„ A patient may be uniquely identified the following sequence: “PatientId”, “LastName” and
“Birthdate” fields.
„ An examination may be uniquely identifed by the following field value “StudyInstanceUID”.
„ Measured values are uniquely defined by the “ParameterStudy”, “ParameterMeasure” and
ParameterId” field. Each value is specified by the “ResultIdentifier” and “Qualifier”
attributes.
„ "The value of the "ResultString" field is only used if there is no value in the "ResultValue"
field (and vice versa). The value of the "ResultValue" field is always stored in MKSA units
and, therefore, should be converted to display values (using the value in the "Units" field and
the conversion table shown later in this section).
„ Wall motion scorings are stored as a measured parameter in the “Value String” attribute in the
following format: “Segment Name=value: Segment Name=value:...”

Available segment names are the abbreviations shown in the “Lists of Stress Echo Attributes” on
page 35 section (wall motion segment list). Up to 18 segments follow the 18-wall motion
segment model. Order is not important in the string, since values are tagged with the Segment
ID. The value is a floating-point number; values are listed in the Scoring Value list in the
“Lists of Stress Echo Attributes” on page 35 section.

Example:
“BAS=x.y:BA=x.y:BL=x.y:BP=x.y:BL=x.y:MAS=x.y:MA=x.y:ML=x.y:MI=x.y:MS=x.y:A
S=x.y:AA=x.y:AL=x.y:AI=x.y:AAS=x.y:AP=x.y (where x.y indicates a floating-point
value, with one decimal).

Example (AAS and AP not scored, BAS not normal):

“ BAS=1.5:BA=1:BL=1:BP=1:BI=1:BS-
1:MAS=1:MA=1:ML=1:MP=1:MI=1:MS=1:AS=1:AA=1:AL=1:AI=1:AAS=-1:AP=-1”

ParameterId = “WallSegmentScoring”
‹ Contrast scoring -- ParameterId = “ContrastWallSegmentScoring”
‹ Normal scoring -- ParameterId = “NormalWallSegmentScoring”

Revision 1 Image Vault 4.2 HL7 Interface White Paper 27 of 38


5183820-100
„ The wall motion scoring index is stored as a parameter also (WMSI).

ParameterId = “WallMotionScoringIndex”

This is calculated as an average of scored segments (valid values between 1 through 5 only)
„ Normal muscle percent is stored as a parameter also (NORM).

ParameterId = “NormalMusclePercent”

This is calculated as a percentage of normal segments out of all scored segments.

Update of Format

The following rules will be considered:


„ Fields and their types remain unchanged; however, new fields/properties may be added.
„ Logical links between fields remain unchanged.
„ Content of any field may be changed frequently.
„ Order of fields will not be preserved; however, normally the newer fields are added last.

28 of 38 Image Vault 4.2 HL7 Interface White Paper Revision 1


5183820-100
List of Availble Fields for Export (not all fields are exported by default)

Patient Level Fields


Field Name Comments
IndexPatient Internal index - unique identifier for a patient
Locked Locks a patient for a certain machine - Yes/No
LockedAt Time of last lock/unlock operation
LockedBy Name of logged-in user
PatientId Unique, if not empty; otherwise, Last Name + Birthdate must be unique
LastName
FirstName
Birthdate
Age Calculated, based on birthdate
SeriesCount Number of exams for a patient
ImageRefCount Number of images for a patient
ReportRefCount Number of reports for a patient
ProtocolCount Number of Protocol (Stress) exams for a patient
LastSeriesDateTime Last existing series date/time
MiddleName
Prefix
Suffix
Sex Possible values: MALE, FEMALE, OTHER
Address Holds either a free-text address or only the street if the other “address”
fields are used
City If used, then Address field holds the street name and number
ZipCode If used, then Address field holds the street name and number
State Holds either the state name (with USA) or country name (outside USA)
Email
Phone1 Patient’s Phone 1
Phone2 Patient’s Phone 2
Label Title Bar free-text label
OtherPatientId Other patient ID, such as Social Security Number
EthnicGroup Ethnic group or race of patient
ContrastAllergies Patient’s reaction to contrast agents
MedicalAlerts Medical alerts, such as contagious conditions or drug allergies
ReferencedPatientSequence Only mapped from worklist to DICOM image
Comments Patient comments
CreatedAt When patient is added to the table
CreatedBy Name of user who is logged in when this patient is added to the table

Revision 1 Image Vault 4.2 HL7 Interface White Paper 29 of 38


5183820-100
Study Level Fields
Field Name Comments
IndexStudy Internal index - unique identifier of a study within a patient
StudyInstanceUID A StudyInstanceUID must be created by the scanne when several
SPS belonging to different requested procedures are satisified by a
single PPS or when a PPS is unscheduled
StudyDateTime Study Date and Time
StudyID Only used for DICOM images and MPPS
AccessionNumber HIS/RIS/CVIS - number for study
Height In meters
Weight In Kg
BSA Based on adult BSA formula: 0.007184 * Weight^0.425 *
Height^0.725
Abortion
Ectopic
Gravida Number of pregnancies
Para Number of deliveries
PregancyOrigin Pregnancy origin
LMP Last menstrual period
Indications
AdmissionId
AdmittingDiagnosisDescription Admitting diagnosis description
CurrentPatientLocation Current patient location
DepartmentOfRequestInitiation Department of request initiation
StudyDescription Study description
ReferenceStudySequence Reference study sequence
RequestedContrastAgent Requested contrast agent
RequestedProcedureCodeSequence Requested procedure code sequence
RequestedProcedureDescription Requested procedure description
AdditionalPatientHistory Additional patient history
ImageServiceRequestComments Image service request comments

30 of 38 Image Vault 4.2 HL7 Interface White Paper Revision 1


5183820-100
Series Level Fields
Field Name Comments
IndexSeries Internal index - unique identifier of a series within a study
Modality DICOM default - US
SeriesInstanceUID Unique identifier of the series
SeriesNumber Sequential number of series under the current study - only used in the DICOM image
SeriesDateTime Series date/time
SeriesCategory Application Type - Abdominal = A, Cardiac = C, Gynecology = G, Obstetrics = O, Pediatric = P,
Small Parts or Musculoskeletal = S, Urology = U, Vascular = V, Special Apps = X
SubCategory Second level of application that enables user interface modules to appear in correct layout
BloodPressure Format: XXX / XXX
EDD Expected delivery date
EGA Estimated gestational age format - XXw YYd
BBT Basal body temperature
PSA Prosthetic specific antigen
NumberOfFetuses Number of fetuses
PregnancyStatus Pregnancy status
ExamComments Exam comments
ExamDiagnosis Exam diagnosis
DepartmentName Department name
SeriesDescription Series Description
BodyPartExamined Defined terms: ABDOMEN, HEART, etc. Refer to DICOM standard.
RequestedProcedureId Requested procedure ID - taken from worklist
PerformedLocation Performed location - lab where exam was performed
PerformedStationAETitle Performed station AE title - AE title of imaging equipment
PPSId Performed procedure step ID - system-generated ID of procedure step
PPSStartDateTime PPS start time - time when procedure was started
PPSEndDateTime PPS end time - time when procedure was ended
PPSStatus PPS status - IN PROGRESS, COMPLETED or DISCONTINUED
PPSDescription Performed procedure step description - institution’s name of procedure
PPSTypeDescription PPS type description - type description - no precisely defined
ProtocolName User-defined description of protocol, such as stress name
ProtocolNumberOfViews Number of columns in the protocol
ProtocolNumberOfStages Number of rows in the protocol
ContrastAgent Contrast agent
ReferencedSOPClassUID Referenced SOP class UID - unique ID of referenced image’s SOP class
ReferencedSOPInstanceUID Referenced SOP instance UID - unique ID of referenced image
RetrieveAETitle Retrieve AE title - AE title of DICOM server, where the image can be retrieved
SPSId Schedule procedure step ID - Institution’s ID of procedure step to perform
SPSStartDateTime Scheduled procedure step start date - time when procedure is planned to start
SPSLocation Scheduled procedure step location - lab
SPSDescription Scheduled procedure step description - Institution’s description of procedure step to perform

Revision 1 Image Vault 4.2 HL7 Interface White Paper 31 of 38


5183820-100
ScheduledActionItemCodeSequence Scheduled action item code sequence - only used for mapping to DICOM image - allows 69
items of 171 bytes each
ScheduledStationAETitle Scheduled station AE title - AE title of imaging equipment to perform the procedure step
SignedOff No / Yes - Yes means that the series under a delete warning, even though a delete operation is
allowed
SignedOffBy Name of user who has signing authorization and has signed on this procedure
SignedOffAt Date/time of signoff procedure
UpdatedAt
VCRTapeName VCR tape name - up to 8 characters display
VCRTapeCounter VCR counter - format 9:59:59

M&A Level Fields


Field Name Comments
ParameterStudy StudyId- holds the study that the parameter was measured in
ParameterMeasure MeasureId holds the measuring method (tool) that parameter was measured
with
ParameterId Identification of a parameter
Qualifier Attribute, such as stress level, fetus number, laterality (rt=right, lt=left), location
(mid, post, inf, etc). Attributes can appear in any order inside the qualifier.
ResultIdentifier Sequential number of measurement zero-based correlates matching
measurements sessions. Possible values: Average, Measurement No. X
(where X is a number from 1 to 6) and Measurement No. X (manually edited).
ResultValue Result value in SI units
ResultString Result string value - is vali only if ResultValue was not defined
DisplayValue ResultValue transformed into display units
DisplayUnit Result units
ParameterName Parameter alias
ScanMode Scan modes: 2D, CF, MM, CM, AMM, CAMM, PW, CW, VT, Trace, TVI, BMI,
SRI, TT
Video modes: VR2D, VRMM, VRCF, VRCM, VRPW, VRCW, VR (uncalibrated
video)
DisplayMode Defines the default window where to show the data (default = All)
ExcludeFromAverage No / Yes - Yes is excluded from averaging
ExcludeFromCalculation No / Yes - Yes is excluded from calculations
Edited No / Yes - Yes if value was manually edited by user
ParameterType Possible values: MEASURED, CALCULATED, SYSTEM
AverageType Possible values: AVERAGE, LAST, MAX, MIN, USER
ParameterCategory Application type

32 of 38 Image Vault 4.2 HL7 Interface White Paper Revision 1


5183820-100
List of Parameter Units

Format: display unit = factor: offset

All units are assumed to be case-insenstive and, therefore, should always be converted to lower
case by the receiving party.
s = 1.0:0.0
ms = 1000.0:0.0
Time Units
min - 0.0167.0:0.0
h = 0.00027778:0.0
ratio = 1.0:0.0
Ratio Units
% = 100.0:0.0
Hz - 1.0:0.0
Frequency Units
kHz = 0.001:0.0
rad - 1.0:0.0
Angle Units deg - 57.2958:0.0
grad = 63.6620:0.0
cm - 100..0:0.0
m - 1.0:0.0
dm - 10.0:0.0
cm = 100.0:0.0
Distance Units
mm = 1000.0:0.0
inch = 39.37:0.0
feet = 3.281:0.0
pixels = 1.0:0.0
m/s = 1.0:0.0
dm/s = 10.0:0.0
Velocity Units cm/s = 100.0:0.0
mm/s = 1000.0:0.0
inch/s = 39.37:0.0
m/s2 = 1.0:0.0
dm/s2 = 10.0:0.0
Acceleration Units cm/s2 = 100.0:0.0
mm/s2 = 1000.0:0.0
inch/s2 = 39.37:0.0
m2 = 1.0:0.0
dm2 = 100.0:0.0
Area Units cm2 = 10000.0:0.0
mm2 = 1000000.0:0.0
inch2 = 1550.0:0.0
m3 = 1.0:0.0
dm3 = 1000.0:0.0
cm3 = 1000000.0:0.0
L - 1000.0:0.0
Volume Units dl = 10000.0:0.0
cl = 100000.0:0.0
ml = 1000000.0:0.0
gallon = 264.178:0.0
quart = 1056.71:0.0

Revision 1 Image Vault 4.2 HL7 Interface White Paper 33 of 38


5183820-100
m3/s = 1.0:0.0
dm3/s = 1000.0:0.0
cm3/s = 1000000.0:0.0
l/s = 1000.0:0.0
dl/s = 10000.0:0.0
cl/s =100000.0:0.0
ml/s = 1000000.0:0.0
Volume Flow Units m3/min = 60.0:0.0
dm3/min = 60000.0:0.0
cm3/min = 60000000.0:0.0
l/min = 60000.0:0.0
dl/min = 600000.0:0.0
cl/min = 6000000.0:0.0
ml/min = 60000000.0:0.0
ml/m2 = 1000000.0:0.0
mmHg = 1.0:0.0
torr = 1.0:0.0
Pascal - 133.3333:0.0 (N/m2)
Pressure Units
kPa = 0.13332:0.0:0.0
bar = 1.3333x10 (3):0.0
psi = 1.9347x10(-2):0.0
Pressure Flow Units mmHg/s = 1.0:0.0
kg - 1.0:0.0
g = 1000.0:0.0
Mass Units
ounce = 35.273962:0.0
pound = 2.2046226:0.0
Date - 1.0:0.0
Weekday = 1.0:0.0
Day = 1.0:0.0
Week = 7.0:0.0
Other Units NoUnit = 1.0:0.0
l/minm2 = 60000.0:0.0
g/m2 = 1000.0:0.0
cm/m2 = 100.0:0.0
bpm = 60.0:0.0

34 of 38 Image Vault 4.2 HL7 Interface White Paper Revision 1


5183820-100
Lists of Stress Echo Attributes

List of valid projections:


„ PLAX, SAX-PM, 4CH, 2CH, APLAX, SAX-MV

List of wall segments:


„ BAS - basal anterior septal
„ BA - basal anterior
„ BL - basal lateral
„ BP - basal posterior
„ BI - basal inferior
„ BS - basal septal
„ MAS - mid anterior septal
„ MA - mid anterior
„ ML - mid lateral
„ MP - mid posterior
„ MI - mid inferior
„ MS - mid septal
„ AS - apical septal
„ AA - apical anterior
„ AL - apical lateral
„ AI - apical inferior
„ AAS - apical anterior septal
„ AP - apical posterior

List of scoring values:


Score Value for
Score Score Value in File Score Sign
Calculation
Not scored - default -1 -1
Unable to interpret 0 0 X
Normal 1 1 1
Mild Hypokinetic 1.5 1.5 1.5
Hypokinetic 2 2 2
Severe Hypokinetic 2.5 2.5 2.5
Akinetic 3 3 3
Dyskinetic 4 4 4
Aneurysmal 5 5 5
Akinetic w/scar 6 3 3s
Dyskinetic w/scar 7 4 4s

Revision 1 Image Vault 4.2 HL7 Interface White Paper 35 of 38


5183820-100
AL1 - Patient Allergy Information

The AL1 segment contains patient allergy information of various types.

A sample AL1 segment:

AL1||DA|^allergy description
Seq Len DT Opt RP# HL7 Field Name Vivid Column Name
1 250 CE O Set ID - AL1 NOT USED
2 250 CE O Allergen Type Code NOT USED
3 250 CE O Allergen Code / Mnemonic / Description Description
4 250 CE O Allergy Severity Code NOT USED
5 15 ST O Y Allergy Reaction Code NOT USED
6 8 DT O Identification Date NOT USED

ZDS - Study Instance UID

The HL7 non-standard ZDS segment contains the study DICOM UID, delivered from the Vivid
scanners. This segment is non-repeating.

A sample ZDS segment:

ZDS|1.2.34665.347653.88.547.2
Seq Len DT Opt RP# HL7 Field Name Vivid Column Name
1 250 ST R Study Instance UID Study Instance UID

36 of 38 Image Vault 4.2 HL7 Interface White Paper Revision 1


5183820-100
Sample Outbound Message

Basic HL7 Message


MSH|^~\&|VPHISCOMSERVER||sap||20060515093024||ORU^R01|1|P|2.4||||AL
PID|||M000000289||GIANT^JOLLY||19460512000000|MALE||||||||||||||
PV1|||||||||||||||||||000000000000964
OBR|||000000300|ECHO|||20060515085018|||||||||||||A||||||||||||RUB^RUBIN^^DAVID|||SLC^CASSI
DY^^SHARON
OBX|1|NM||Average|MM/Ao Root Diam MM 0.02234043 cm||||||F
OBX|2|NM||Average|LVOT Vmean PW 0.5600183 m/s||||||F
OBX|3|NM||Average|LVOT meanPG PW 1.503312 mmHg||||||F
OBX|4|NM||Average|LVOT VTI PW 0.1801168 cm||||||F
OBX|5|TX||EXAM SUMMARY| -Technically difficult study: -The estimated left ventricular ejection
fraction is 65 %.\br\-The left atrium is normal.\br\-The right atrial size is normal.\br\-The right
ventricle is normal in size and function.\br\-The aortic valve is normal.\br\-There is mild prolapse of
the anterior mitral valve leaflet.\br\-The tricuspid valve is normal.\br\-The pulmonic valve was not
well visualized.\br\

Detailed HL7 Message


MSH|^~\&|ECHOPACS_RSLT|TEST|sap|sap|20060510135231||ORU^R01|1|P|2.4||||AL
PID||1305852|||ECHOBUILDTEST^THURSDAY||19601231000000|M|||786.09||UTOP|||||||||
PV1|||||||||||||||||||13058520001
OBR||103742073|103742073|ECHOPACS4 ^ECHO, Limited Study
Portable|||20060505102834|||||||||||||1|A|||||||||||JDY^TEST DOCTOR D.|||SO^SO
OBX|1|TX|ECHOPACS4 ;ECHO, Limited Study Portable|REPORT|||||||F
OBX|2|TX|ECHOPACS4 ;ECHO, Limited Study Portable|REPORT|Pat: ECHOBUILDTEST
Pat.ID: 1305852 ExDate: 05/05/2006 10:28:34||||||F
OBX|3|TX|ECHOPACS4 ;ECHO, Limited Study Portable|REPORT|||||||F
OBX|4|TX|ECHOPACS4 ;ECHO, Limited Study Portable|REPORT|Patient Info
Ultrasound Images||||||F
OBX|5|TX|ECHOPACS4 ;ECHO, Limited Study Portable|REPORT|Patient:
ECHOBUILDTEST,THURSDAY||||||F
OBX|6|TX|ECHOPACS4 ;ECHO, Limited Study Portable|REPORT|Patient ID: 1305852||||||F
OBX|7|TX|ECHOPACS4 ;ECHO, Limited Study Portable|REPORT|Birthdate: 12/31/1960||||||F
OBX|8|TX|ECHOPACS4 ;ECHO, Limited Study Portable|REPORT|Sex: MALE||||||F
OBX|9|TX|ECHOPACS4 ;ECHO, Limited Study Portable|REPORT|Examination ID:
103742073||||||F
OBX|10|TX|ECHOPACS4 ;ECHO, Limited Study Portable|REPORT|Examination Date: 05/05/
2006 10:28:34||||||F
OBX|11|TX|||||||||F
OBX|1|TX|ECHOPACS4 ;ECHO, Limited Study Portable|REPORT|MEASUREMENTS||||||F
OBX|2|TX|ECHOPACS4 ;ECHO, Limited Study Portable|REPORT|Ao Diam 0.03 cm||||||F
OBX|4|TX|ECHOPACS4 ;ECHO, Limited Study Portable|REPORT|EDV(Teich) 2.69 ml||||||F
OBX|6|TX|ECHOPACS4 ;ECHO, Limited Study Portable|REPORT|LVIDd 6.44 cm||||||F
OBX|8|TX|ECHOPACS4 ;ECHO, Limited Study Portable|REPORT|IVSd 1.67 cm||||||F
OBX|10|TX|ECHOPACS4 ;ECHO, Limited Study Portable|REPORT|AV Diam 1.05 cm||||||F
OBX|12|TX|ECHOPACS4 ;ECHO, Limited Study Portable|REPORT|Ao Diam 6.78 cm||||||F

Revision 1 Image Vault 4.2 HL7 Interface White Paper 37 of 38


5183820-100
OBX|15|TX|ECHOPACS4 ;ECHO, Limited Study Portable|REPORT|LVPWd 8.67 cm||||||F
OBX|16|TX|ECHOPACS4 ;ECHO, Limited Study Portable|REPORT|LVPWd 0.03 cm||||||F
OBX|18|TX|ECHOPACS4 ;ECHO, Limited Study Portable|REPORT|EDV(Teich) 0.07 ml||||||F
OBX|20|TX|ECHOPACS4 ;ECHO, Limited Study Portable|REPORT|LVIDd 0.04 cm||||||F
OBX|23|TX|ECHOPACS4 ;ECHO, Limited Study Portable|REPORT|IVSd 0.01 cm||||||F
OBX|26|TX|ECHOPACS4 ;ECHO, Limited Study Portable|REPORT|LA Diam 0.04 cm||||||F
OBX|1|TX|ECHOPACS4 ;ECHO, Limited Study Portable|REPORT|||||||F
OBX|2|TX|ECHOPACS4 ;ECHO, Limited Study Portable|REPORT|INTERPRETATION||||||F
OBX|4|TX||EXAM COMMENTS|-Left Ventricle: Normal left ventricular size, wall thickness, and
function.\br\ Left ventricular ejection fraction is within normal limits.\br\ -Left Atrium: Normal left
atrial size and function.\br\ -Right Ventricle: Normal right ventricular size and function.\br\ -Right
Atrium: Normal right atrial size and function.\br\ -Valvular Structures: Normal mitral, tricuspid,
pulmonic, and aortic valve structures.\br\ -Aortic root is normal.\br\ -No evidence of pericardial
effusion.\br\ -Normal echocardiogram and doppler examination.\br\ |||||F
OBX|6|TX||REFERRING PHYSICIAN| REFERRING PHYSICIAN: TEST DOCTOR MD ||||||F
OBX|7|TX|||||||||F
OBX|8|TX||ELECTRONIC SIGNOFF|This report was electronically signed by : TEST DOCTOR,
M.D. ||||||F
OBX|9|TX|||||||||F
ZDS|

38 of 38 Image Vault 4.2 HL7 Interface White Paper Revision 1


5183820-100

You might also like