HL7 Data Description...............................................................................................................................................7
Data Types..........................................................................................................................................................................8
Data Type Definition.......................................................................................................................................................8
Fields With Insufficient Length .........................................................................................................................12
Structure of ADT Messages................................................................................................................................ 13
Structure of ADT^Z99 Event .............................................................................................................................. 14
Structure of ADT^A40 Event.............................................................................................................................. 14
Structure of OMG^O19 Event............................................................................................................................ 15
Structure of ORM^O01 Event............................................................................................................................ 15
HL7 Segments and Fields Definition for Inbound Workflow............................................................... 16
Structure of outbound HL7 events................................................................................................................. 29
HL7 Segment & Field Definitions ..................................................................................................................... 34
Export of discrete findings.................................................................................................................................. 54
Document Version History
Version Date Description Author
0.1 15.05.05 Initial Creation Juan de Hoyos
1 19.10.2005 M3 Gabriele Rieger
2 1. 12.2005 Movement table revised Gabriele Rieger
Bernhard Hornung
Juan de Hoyos
2.1 19.1.2006 Outbound updated
PV1-50 added
2.2 18.2.2006 Mapping for OBR-32 and 43
outbound added
2.3 27.2.2006 Mapping for OBR-14 and PR1-14
outbound added
2.4 24.4.2006 Update modus added Juan de Hoyos
2.5 2.5.2006 ZVP-8 mapping added Juan de Hoyos
3 31.8.2006 DG1 and PR1 mapping corrected Juan de Hoyos
3 31.8.2006 VKNR type changed to numeric Juan de Hoyos
3 31.8.2006 PDF export added Juan de Hoyos
3.1 18.10.2006 OBX-3 in MDM^T02 event set to
‚IMAGE_REF’
4 27.10.2006 BAR^P12 and discrete findings
added
5 2.11.2006 ORU^R01 message structure for
discrete findings added
Made PV1 segment optional for all
export events
5.1 14.11.2006 NF and Lateral Ventricle marked as
available in FDB_USA version, only.
5.2 9.1.2007 ZDD, ZOX segments added Juan de Hoyos
9.14 mapping added
Coding of DG1-3 and PR1-3 added
for French version
5.5 19.11.2007 TXA-4 used to carry ref. Doctor
information
ZEX, ZEP segments added
5.6 11.01.2008 2nd trim. Diagnosis added to
discrete export list
5.8 30.4.2008 New fields 2.3, 5.1 and 5.2 in ZEX
segment added
5.9 29.5.2008 New fields from 3.4 to 3.11 in ZEX
segment added
5.10 5.5.2009 New fields 7 and 8 added to ZEX Juan de Hoyos
Juan de Hoyos
Juan de Hoyos
Juan de Hoyos
Juan de Hoyos
Juan de Hoyos
Bernhard Hornung
Juan de Hoyos
Juan de Hoyos
Bernhard Hornung
Juan de Hoyos
Juan de Hoyos
Juan de Hoyos
Juan de Hoyos
ViewPoint 5.6 1
HL7 Interface Reference Manual
Version 6
5.11 5. Nov. 2009 Typo corrected
Manufacture’s address symbol
added
5.12 13.Nov.2009 Table 0005 updated
Flag “C” added to OBX-11 in
MDM^T02 event
6 11. Dec. 2009 Version after review Gabriele Rieger
Gabriele Rieger
Juan de Hoyos
ViewPoint 5.6 2
HL7 Interface Reference Manual
Version 6
1. Introduction
This document describes the HL7 interface, as it relates to the ViewPoint 5.5
application.
The ViewPoint (VP) HL7 Interface communicates with a Hospital Information System
(HIS) or other third-party transcription systems via HL7 formatted messages that import
relevant clinical information. This interface is designed to send and receive messages
using the TCP/IP protocol, via a socket connection, and minimal layer protocol (MLP).
These HL7 messages are created automatically, depending upon the event(s) within the
ViewPoint application. The interface communication is at the server level, rather than at
each individual client workstation, although a client is able to produce the necessary
triggers. Successful implementation requires the assistance of a ViewPoint Interface
Specialist, who can provide training, technical, and project management information.
2. Assumptions
a) It is assumed that the reader of this document is familiar with the HL7
standard. This document is not intended to be used standalone, but should be
used in conjunction with the HL7 Specification Version 2.4*.
b) The HL7 interface can only be processed using the TCP/IP protocol.
c) The VP customer is responsible for ensuring that the receiving HIS or
transcription system is capable and ready to receive HL7 messages from
VPHiscomServer for processing.
*HL7 standards committee members can acquire a free copy of the current HL7
specification from the Internet via the HL7 World Wide Web page (http://www.HL7.org).
Non-members can order a copy from the same location or by contacting the
appropriate representatives:
Health Level Seven
3300 Washtenaw Ave.,
Suite 227
Ann Arbor, MI 48104-4250
Phone: (313) 677-7777; Fax: (313) 677-6622
ViewPoint 5.6 3
HL7 Interface Reference Manual
Version 6
3. Interface Workflow Overview
Inbound Workflow Overview
Supported incoming HL7 messages triggered from HIS systems are processed and their
content 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). The VPHisComServer can log every incoming message
and its internal processing.
Incoming streams that are not MLLP formatted are ignored.
Support of Movement Information
ViewPoint can receive and use information about patient movements. Since there is no
HL7 standard yet, which describes how movement information should be transmitted,
ViewPoint uses the ZBE segment. The chosen implementation should be compatible to
the IHE standard and to the German extension of the HL7 2.4 standard.
The ZBE segment is optional and can be included in every ADT message. In order to be
IHE compatible, ViewPoint also accepts the ADT^Z99 event for updating movement
information.
ViewPoint requires that the Movement-ID sent in ZBE-1 is unique across all movements
in the system.
For every message containing a ZBE segment, ViewPoint will use the field PV1-3
(Assigned Patient Location) for the Medical and Nursing ward.
Unless ZBE-3 specifies the Movement End Time, ViewPoint assumes Movement Start +
24h as Movement End Time for movements of type ‘visit’.
ViewPoint treats UPDATE or INSERT commands similarly; if a movement record exists in
the ViewPoint database, it will be updated. If it doesn’t exist, it will be inserted.
ViewPoint uses the trigger event the value of PV1-2 and ZBE-4 to determine some
additional information about the movement as shown in the following table:
ViewPoint 5.6 4
HL7 Interface Reference Manual
Version 6
Trigger Event ZBE-4 PV1-2 Impact on Movement Information
ADT^A01 - Admit/visit notification
ADT^A02 - Transfer a patient
ADT^A05 - Pre-admit a patient
ADT^A08 - Update patient inform.
ADT^Z99 - Update movement
inform.
ADT^A03 - Discharge/end visit
day visit)
ADT^A06 - outpatient to inpatient
ADT^A07 - inpatient to outpatient
ADT^A11 - Cancel admit/visit
notification
ADT^A29 - Delete person
information
ADT^A40 - Merge patient
ADT^A12 - Cancel transfer
ADT^A13 - Cancel discharge/end
visit
Processing of Outcome messages
DELETE or
CANCEL
<all other>
DELETE or
CANCEL
<all other>
DELETE or
<all other> <irrelevant> ‘visit’ movement will be created /
<irrelevant> <irrelevant> ZBE segment will be ignored.
INSERT or
UPDATE
<all other> <irrelevant> Movement will be deleted.
<irrelevant> Movement will be deleted.
out patient ‘visit’ movement will be created /
<all other> ‘stay’ movement will be created /
<irrelevant> Movement will be deleted.
<all other> ‘discharge’ movement will be created /
<irrelevant> Movement will be deleted. ADT^A04 - Register patient (one
<all other> ‘stay’ movement will be created /
updated.
‘
’
updated.
updated.
‘
’
ViewPoint 5.5 offers an interface to populate outcome information through HL7
AD^A08 events containing the non-standard segment ZDD. The association between
incoming outcomes and existing medical cases in ViewPoint follows the algorithm
described in the diagram below. It shows all the preconditions and filters that have
been taken into consideration in order to avoid a wrong assignation of outcomes.
ViewPoint 5.6 5
HL7 Interface Reference Manual
Version 6
ViewPoint 5.6 6
HL7 Interface Reference Manual
Version 6
Outbound Workflow Overview
Processing of Acknowledge Messages
ViewPoint expects to receive an acknowledge message for each message sent.
ViewPoint waits a configurable time period for such a message (10 – 120 seconds).
If no acknowledge is received within the configured time frame, ViewPoint tries to resend the message after some time. No other messages are sent by ViewPoint unless an
acknowledgment is received (or the message was removed from the queue by an
administrator).
ViewPoint uses the field MSA-1 to check whether the acknowledgment was positive or
negative (AA: accepted, AE: error). ViewPoint checks the field MSA-2 to ensure that the
acknowledge message belongs to the message that was just sent by ViewPoint. If MSA2 is empty, ViewPoint always assumes, that the ACK message belongs to the message
that was just sent.
ViewPoint ignores any acknowledge message which is not related to the last message
sent by ViewPoint.
If ViewPoint does not receive an acknowledge message within the configured time
frame, it will terminate the connection to the socket of the receiving system, wait for 60
seconds and re-connect to the socket.
In rare circumstances, ViewPoint will send a message twice. These duplicates can be
identified by the receiving system by means of the Message Control ID. This can happen
e.g. when:
• Network problems prevented the reception of an acknowledge message.
• The VPHISComServer process was killed during a send operation.
4. HL7 Data Description
The VPHiscomServer HL7 interface uses a socket connection. For the import, the HL7
interface process is a server on a configurable port. The message itself has got a HL7
MLLP frame, i.e. a leading \x0B and trailing \x1C\x0D. Acknowledge messages can be
returned after a message is received.
Delimiter Definition
ViewPoint supports the standard HL7 encoding rules. Other encodings are not
supported.
ViewPoint 5.6 7
HL7 Interface Reference Manual
Version 6
Data Types
Delimiter Value Encoding Character
Segment
Terminat or
Field Separator | - Separates two adjacent data fields within a segment. It
Component
Separator
Subcomponent
Separator
Repetition
Separator
Escape
Character
hex 0D
Position
<cr>
^ 1 Separates adjacent components of data fields where
& 4 Separates adjacent subcomponents of data fields where
~ 2 Separates multiple occurrences of a field where allowed.
\ 3 Escape character for use with any field represented by an
- Terminates a segment record. This value cannot be
Usage
changed by implementors.
also separates the segment ID from the first data field in
each segment.
allowed.
allowed. If there are no subcomponents, this character
may be omitted.
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.
The data types in this section are listed in alphabetical order.
Note
The examples given in this section do not specify the choice of the component or subcomponents for data types
which contain multiple components or subcomponents. This must be specified in the field definitions that follow
the formal segment attribute tables to a 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, and 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.
In certain data type definitions, square brackets, “[ ]”, are used to specify optional parts
of a data type (or of a data type component or subcomponent).
Data Type Definition
Data Type Category/
Data Type
Alphanumeric
ST String
TX Text data
FT Formatted text
Numerical
Data Type Name Notes/Format
ViewPoint 5.6 8
HL7 Interface Reference Manual
Version 6
Data Type Category/
Data Type
MO Money <quantity (NM)> ^ <denomination (ID)>
SN Structured numeric <comparator> ^ <num1 (NM)> ^
Identifier
ID Coded values for HL7 tables
IS Coded value for user-defined
HD Hierarchic designator <namespace ID (IS)> ^ <universal ID (ST)> ^
EI Entity identifier <entity identifier (ST)> ^ <namespace ID
RP Reference pointer <pointer (ST) > ^ < application ID (HD)> ^
PL Person location <point of care (IS )> ^ <room (IS )> ^ <bed
PT Processing type <processing ID (ID)> ^ <processing mode
Date/Time
DT Date YYYY[MM[DD]]
TM Time HH[MM[SS[.S[S[S[S]]]]]][+/-ZZZZ]
TS Time stamp YYYY[MM[DD[HHMM[SS[.S[S[S[S]]]]]]]][+/-
Code Values
CE Coded element <identifier (ST)> ^ <text (ST)> ^ <name of
CK Composite ID with check digit <ID number (NM)> ^ <check digit (NM)> ^
Data Type Name Notes/Format
Composite quantity with units <quantity (NM)> ^ <units (CE)>
Numeric
Sequence ID
<separator/suffix> ^ <num2 (NM)>
tables
<universal ID type (ID)>
Used only as part of EI and other data
types.
(IS)> ^ <universal ID (ST)> ^ <universal ID
type (ID)>
In Version 2.3, use instead of the CN data
type. <ID number (ST)> ^ <family name
(ST)> ^ <given name (ST)> ^ <middle initial
or name (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)>
2.2. Hence there are no new CM’s in
Version 2.3.
(ST)> ^ <city (ST)> ^ <state or province (ST)>
^ <zip or postal code (ST)> ^ <country (ID)>
^ <address type (ID)> ^ <other geographic
designation (ST)>
<middle initial or name (ST)> ^ <suffix (e.g.,
JR or III) (ST)> ^ <prefix (e.g., DR) (ST)> ^
<degree (e.g., MD) (ST)>
any text]
<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)>
<family name (ST)> ^ <given name (ST)> ^
<middle initial or name (ST)> ^ <suffix (e.g.,
JR or III) (ST)> ^ <prefix (e.g., DR) (ST)> ^
<degree (e.g., MD) (ST)> ^ <name type code
(ID) >
ViewPoint 5.6 10
HL7 Interface Reference Manual
Version 6
Data Type Category/
Data Type
XON Extended composite name and ID
XTN Extended telecommunications
Specialty/Chapter Specific
Waveform
CD Channel def inition For waveform data only, see Chapter 7,
Specialty/Chapter Specific
NA Numeric array For waveform data only, see Chapter 7,
ED Encapsulated data Supports ASCII MIME-encoding of binary
Price data
CP Composite price In Version 2.3, replaces the MO data type.
Patient
Administration/Financial
Information
FC Financial class <f inancial class (ID)> ^ <effective date (TS)>
Extended Queries
QSC
QIP
RCD Row column definition: <HL7 item number (ST)> ^ <HL7 data type
Master Files
Data Type Name Notes/Format
number for organizations
number
Query selection criteria <name of field (ST)> ^ <relational operator
• for subcomponents of these elements please refer to the definition in the text.
•
for additional data types please refer to the HL7 standard documentation
Inbound HL7 Interface
Fields With Insufficient Length
Note
ViewPoint 5.6 12
HL7 Interface Reference Manual
Version 6
Danger of Data Falsification!
The length of certain fields in ViewPoint is shorter than recommended by the HL7 standard. You must not use
the ViewPoint HL7 interface if your HL7 implementation uses fields that exceed the max. length supported by
ViewPoint.
The table below shows the maximum field lengths supported by ViewPoint .
Field Max. Length
PID-3 (or PID-2, if empty) 30 Patient ID (External ID)
PV1-19 15 Visit Number
PV1-8.1 40 Referring Doctor ID
PV1-9.1 40 Consulting Doctor ID
ORC-2 30 Placer Order Number
Supported HL7 Events
Message Type Event Usage
ADT A01 Admit/visit notification
ADT A02 Transfer a patient
ADT A03 Discharge/end visit
ADT A04 Register a patient (one day visit)
ADT A05 Pre-admit a patient
ADT A06 Change an outpatient to an inpatient
(characters)
Element Name
ADT A07 Change an inpatient to an outpatient
ADT A08 Update patient information
ADT A11 Cancel admit/visit notification
ADT A12 Cancel transfer
ADT A13 Cancel discharge/end visit
ADT A29 Delete person information
ADT A40 Merge patient
OMG O19 Submit a clinical order
ORM O01 Submit a clinical order
ADT Z99 Update Patient Movement Information
Structure of ADT Messages
ADT^A(*) ADT Message
ViewPoint 5.6 13
HL7 Interface Reference Manual
Version 6
MSH Message Header
[EVN] Event
PID Patient Identification
[PV1] Patient Visit
[ZBE] Patient Movement Information
[IN1] Insurance information
[ZDD] Outcome information
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^A11
,ADT^A12,ADT^A13 and ADT^A29.
Structure of ADT^Z99 Event
ADT^Z99 ADT Message
MSH Message Header
[EVN] Event
PID Patient Identification
[PV1] Patient Visit
[ZBE] Patient Movement Information
ACK^Z99 Acknowledgment
MSH Message Header
MSA Message Acknowledgment
Structure of ADT^A40 Event
ADT^A40 ADT Message
MSH Message Header
[EVN] Event
PID Patient Identification
ViewPoint 5.6 14
HL7 Interface Reference Manual
Version 6
[PV1] Patient Visit
MGR Merge information
ACK^A40 Acknowledgment
MSH Message Header
MSA Message Acknowledgment
Note: Multiple PID/MGR pairs are not supported.
Structure of OMG^O19 Event
OMG^O19 General Clinical Order Message
MSH Message Header
[EVN] Event
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^O01 General Clinical Order Message
MSH Message Header
[EVN] Event
PID Patient Identification
[PV1] Patient Visit
ORC Common Order
[OBR] Observation
ACK^OO1 Acknowledgment
ViewPoint 5.6 15
HL7 Interface Reference Manual
Version 6
MSH Message Header
MSA Message Acknowledgment
HL7 Segments and Fields Definition for Inbound Workflow
MSH - Message Header Segment
The MSH segment defines the intent, source, destination, and some specifics of the
syntax of a message.
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
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 NOT USED
12 8 ID R Version ID NOT USED
13 15 NM O Sequence Number NOT USED
14 180 ST O Continuation Pointer NOT USED
15 2 ID O Accept Acknowledgment
Type
16 2 ID O Application
Acknowledgment Type
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
application as defined in the
configuration of the VP HL7
interface.
Values Comparison: “AL” or
not “AL”
Values Comparison: “AL” or
not “AL”
NOT USED
ViewPoint 5.6 16
HL7 Interface Reference Manual
Version 6
MSA – Message acknowledgement segment
The MSA segment contains acknowledge information.
SEQ LEN DT OPT RP/# ELEMENT NAME USAGE
1 2 ID R
2 20 ST R
3 80 ST O
4 15 NM O
5 1 ID B
6 250 CE O
Acknowledgment Code
Message Control ID
Text Message
Expected Sequence Number
Delayed Acknowledgment
Type
Error Condition
Acknowledgment Code:
AA: accepted
AE: error
Message Control ID
Error message if any
NOT USED
NOT USED
NOT USED
EVN – Event type segment
The EVN segment is used to communicate necessary trigger event information to
receiving applications. This information is used only for HL7 definitions and is not used
specifically for any field(s) within the ViewPoint application. This segment is required.
SEQ LEN DT OPT RP/# ELEMENT NAME USAGE
1 3 ID B Event type code Type of the event (e.g. P12)
2 26 TS R Recorded date/time YYYYMMDDHHmmss
3 26 TS O Date/time planned event NOT USED
4 3 IS O Event reason code NOT USED
5 60 XCN O Operator ID NOT USED
6 26 TS O Event occurred NOT USED
PID – Patient Identification Segment
The PID segment is used by the VP HL7 interface for receiving patient identification
information. This segment contains permanent patient identifying and demographic
information that, for the most part, is not likely to change frequently.
The Patient ID is expected in PID-3. Only if PID-3 is empty the patient ID is assumed to
be in PID-2.
ViewPoint 5.6 17
HL7 Interface Reference Manual
Version 6
SEQ LEN DT OPT RP/# ELEMENT NAME USAGE
1 4 SI O Set ID - Patient ID NOT USED
2 20 CX O Patient ID (External ID) Patient ID
3 20 CX R Patient ID (Internal ID) Patient ID
4 20 CX O Y Alternate Patient ID - PID NOT USED
5 48 XPN O Y Patient Name Patient Name
6 48 XPN O Mother’s Maiden Name Patient’s Maiden Name
7 26 TS O Date/Time of Birth DOB
8 1 IS O Sex Patient Sex
9 48 XPN O Y Patient Alias NOT USED
10 1 IS O Race NOT USED
11 106 XAD O Y Patient 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 NOT USED
16 1 IS O Marital Status NOT USED
17 3 IS O Religion NOT USED
18 20 CX O Patient Account Number NOT USED
19 16 ST O SSN Number - Patient SSN (USA version only)
20 25 DLN O Driver's License Number -
Patient
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 Veterans Military Status NOT USED
28 80 CE O Nationality NOT USED
29 26 TS O Patient Death Date and
Time
30 1 ID O Patient Death Indicator NOT USED
Address/City/State/Zip/Count
ry
NOT USED
NOT USED
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
ViewPoint 5.6 18
HL7 Interface Reference Manual
Version 6
:
PV1||E|Trauma room|A||||1234567894^MATHER^JOANNE^W.^DR.^|||In the
hall||||||1234567898^TIESSEN^YEVES^ANDREW.^DR.^||000000001||||||||||||||||||||PA|||||2004
0630060709|20040703060709
SEQ LEN DT OPT RP/# ELEMENT NAME USAGE
1 4 SI O Set ID - PV1 NOT USED
2 1 IS O Patient Class Patient Class (see user defined
3 80 PL O Assigned Patient
Location
4 2 IS O Admission Type NOT USED
5 20 CX O Preadmit Number NOT USED
6 80 PL O Prior Patient Location Prior Patient Location
7 60 XCN O Y Attending Doctor NOT USED
8 60 XCN O Y Referring Doctor Referring Doctor
9 60 XCN O Y Consulting Doctor Consulting Doctor
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 Status 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 Private patient(see user def ined
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
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
table 0004 below for values)
Assigned Patient Location
1)
1)
table 0005 below for values)
NOT USED
ViewPoint 5.6 19
HL7 Interface Reference Manual
Version 6
SEQ LEN DT OPT RP/# ELEMENT NAME USAGE
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 Admit Date/Time
45 26 TS O Discharge Date/Time Discharge Date/Time
7 200 TQ O Quantity/Timing Priority, Quantity, Frequency,
8 200 CM O Parent NOT USED
9 26 TS O Date/Time of
Transaction
10 120 XCN O Entered By NOT USED
11 120 XCN O Verified By NOT USED
and Timing of an Atomic
Service.
Date/Time of Transaction
12 120 XCN O Ordering Provider Identity of the person who is
13 80 PL O Enterer’s Location NOT USED
responsible for creating the
request
ViewPoint 5.6 21
HL7 Interface Reference Manual
Version 6
SEQ LEN DT OPT RP/# SEQ USAGE
14 40 XTN O Y/2 Call Back Phone Number Telephone number to call for
15 26 TS O Order Effective Date/T ime NOT USED
16 200 CE O Order Control Code
Reason
17 60 CE O Entering Organization NOT USED
18 60 CE O Entering Device NOT USED
19 120 XC O Action By NOT USED
20 - N - NOT USED (Reserved) NOT USED (Reserved for future
21 60 CE O Ordering Facility Ordering Facility
clarification of a request or
other information regarding
the order.
Indication
use)
OBR – Observation Request Segment
The Observation Request (OBR) segment is used 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/# ELEMENT NAME USAGE
1 4 SI C Set ID - OBR NOT USED
2 75 EI C Placer Order Number identical to ORC-2-placer order
3 75 EI C Filler Order Number NOT USED
4 200 CE O Universal Service ID identifier code for the
5 2 ID B Priority NOT USED
6 26 TS B Requested Date/time NOT USED
7 26 TS C Observation Date/Time # NOT USED
8 26 TS O Observation End
Date/Time #
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. NOT USED
number.
requested
observation/test/battery
NOT USED
ViewPoint 5.6 22
HL7 Interface Reference Manual
Version 6
SEQ LEN DT OPT RP/# ELEMENT NAME USAGE
14 26 TS C Specimen Received
Date/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
18 60 ST O Placer f ield 1 Placer field 1 (diagnosis)
19 60 ST O Placer field 2 Placer f ield 2
20 60 ST O Filler Field 1 + NOT USED
21 60 ST O Filler Field 2 + NOT USED
22 26 TS C Rpt/Status Chng -
Date/Time
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 information about how many
28 150 XCN O Y/5 Result Copies To NOT USED
NOT USED
telephone number for reporting
a status or a result using the
standard format with extension
and/or beeper number when
applicable.
NOT USED
services to perform at one
service time and how often the
service times are repeated, and
to fix duration of the request.
29 150 CM O Parent NOT USED
30 20 ID O Transportation Mode This f ield identif ies how (or
31 300 CE O Y Reason for Study code or text using the
32 200 CM O Principal Result
33 200 CM O Y Assistant Result
34 200 CM O Y Technician + NOT USED
35 200 CM O Y Transcriptionist + NOT USED
36 26 TS O Scheduled Date/T ime + NOT USED
37 4 NM O
38 250 CE O Y Transport Logistics of
39 250 CE O Y Collector's Comment NOT USED
40 250 CE O Transport Arrangement
Interpreter +
Interpreter +
Number of Sample
Containers
Collected Sample
Responsibility
whether) to transport a patient,
when applicable.
conventions for coded fields
NOT USED
NOT USED
NOT USED
NOT USED
NOT USED
ViewPoint 5.6 23
HL7 Interface Reference Manual
Version 6
SEQ LEN DT OPT RP/# ELEMENT NAME USAGE
41 30 ID O Transport Arranged NOT USED
42 1 ID O Escort Required NOT USED
43 250 CE O Y Planned Patient Transport
Comment
44 250 Procedure Code NOT USED
45 250 Procedure Code Modifier NOT USED
46 250 CE O Y Placer Supplemental
Service Information
NOT USED
Filler Facility (provided by the
placer) in field 2
MRG – Patient merge segment
The MRG segment provides the VP HL7 Interface with information necessary to initiate
the merging of patient data.
A sample MRG segment
:
MRG|33498715||||||
SEQ LEN DT OPT RP/#ELEMENT NAME USAGE
1
2 250 CX B Y Prior Alternate Patient ID NOT USED
3
4 250 CX B Prior Patient ID NOT USED
5 250 CX O Prior Visit Number NOT USED
6 250 CX O Prior Alternate Visit ID NOT USED
7 250 XPN O Y Prior Patient Name NOT USED
CX R Prior Patient Identifier
250
CX O Prior Patient Account
250
List
Number
Prior Patient Identifier List .No
repetition allowed
NOT USED
IN1 – Insurance segment
The IN1 segment contains insurance policy coverage information necessary to produce
properly pro-rated patient and insurance bills.
MDM T02 Document management (export of examination in PDF format)
ACK General acknowledgment
Structure of outbound HL7 events
ADT^A01
MSH Message Header
EVN Event type
PID Patient Identification
ZOX Pregnancy information (non-standard segment)
ACK^A01 Acknowledgment
MSH Message Header
MSA Message Acknowledgment
BAR^P01 Event
MSH Message Header
EVN Event type
ViewPoint 5.6 29
HL7 Interface Reference Manual
Version 6
PID Patient Identification
[PV1] Patient Visit
[{DG1}] Diagnosis
[{PR1}] Procedures
ACK^P01 Acknowledgment
MSH Message Header
MSA Message Acknowledgment
BAR^P12 Event
MSH Message Header
EVN Event type
PID Patient Identification
[PV1] Patient Visit
[{DG1}] Diagnosis
[{PR1}] Procedures
ACK^P12 Acknowledgment
MSH Message Header
MSA Message Acknowledgment
DFT^P03 Event
MSH Message Header
EVN Event type
PID Patient Identification
[PV1] Patient Visit
[ORC] Common order segment
[{FT1}] Financial transaction
ACK^P03 Acknowledgment
MSH Message Header
MSA Message Acknowledgment
ViewPoint 5.6 30
HL7 Interface Reference Manual
Version 6
DFT^VP1 Event
This GE ViewPoint specific segment is used for backwards compatibility to PIA /
ViewPACS 4.12. It’s use is depreciated.
MSH Message Header
EVN Event type
PID Patient Identification
[PV1] Patient Visit
ZVP Viewpoint specific segment
[ORC] Common order segment
[{FT1}] Financial transaction
[{PR1}] Procedures
[{DG1}] Diagnosis
OBR Observation request
OBX Observation segment
ACK^VP1 Acknowledgment
MSH Message Header
MSA Message Acknowledgment
DFT^VP2 Event
This GE ViewPoint specific segment is used for backwards compatibility to PIA /
ViewPACS 4.12. Its use is depreciated.
MSH Message Header
EVN Event type
PID Patient Identification
[PV1] Patient Visit
ZGB Viewpoint specific segment
[{PR1}] Procedures
[{DG1}] Diagnosis
OBR Observation request
OBX Observation segment
{ (Repeated for each child up to 4)
PID Patient Identification for the child
PV1 Patient visit for the child
PR1 Procedures for the child
{[DG1]} Diagnosis for the child
ViewPoint 5.6 31
HL7 Interface Reference Manual
Version 6
}
ACK^VP2 Acknowledgment
MSH Message Header
MSA Message Acknowledgment
ORU^R01 Event (for report text eport)
This event is used to export report information to the receiving system.
MSH Message Header
PID Patient Identification
[PV1] Patient Visit
[ORC] Common order segment
{ OBR Observation report
{OBX} } Observation result
ACK^R01 Acknowledgment
MSH Message Header
MSA Message Acknowledgment
ORU^R01 Event (for discrete finding elements)
This event is used to export report information to the receiving system. It is much more
detailed as the event described above.
There is one OBR segment and the according OBX segment(s) for the patient. If the
report is about a pregnancy, then there are additional OBR segments with the
according OBX segments for each child.
MSH Message Header
PID Patient Identification
[PV1] Patient Visit
[ORC] Common order segment
[
OBR Observation report for the patient
{OBX} Observation results
]
ViewPoint 5.6 32
HL7 Interface Reference Manual
Version 6
[
OBR Observation report for fetus 1
{OBX} Observation results
]
[
OBR Observation report for fetus 2
{OBX} Observation results
]
[
OBR Observation report for fetus 3
{OBX} Observation results
]
[
OBR Observation report for fetus 4
{OBX} Observation results
]
ACK^R01 Acknowledgment
MSH Message Header
MSA Message Acknowledgment
MDM^T02 Event
This event is used to export PDF formatted documents to the receiving system.
MSH Message Header
EVN Event
PID Patient Identification
[PV1] Patient Visit
TXA Document notification
OBX Observation result
ACK^T02 Acknowledgment
MSH Message Header
MSA Message Acknowledgment
ViewPoint 5.6 33
HL7 Interface Reference Manual
Version 6
HL7 Segment & Field Definitions
MSH - message header segment
The MSH segment defines the intent, source, destination, and some specifics of the
syntax of a message. This information is used only for HL7 definitions and is not used
specifically for any field(s) within the GE ViewPoint application. This segment is required.
SEQ LEN DT OPT RP/# ELEMENT NAME USAGE
1 1 ST R Field Separator |
2 4 ST R Encoding Characters ^~\&
3 180 HD O Sending Application GE
4 180 HD O Sending Facility ViewPoint
5 180 HD O Receiving Application Name of HL7 destination as
6 180 HD O Receiving Facility NOT USED
7 26 TS O Date/Time Of Message Date/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 P
12 8 ID R Version ID 2.4
13 15 NM O Sequence Number NOT USED
14 180 ST O Continuation Pointer NOT USED
15 2 ID O Accept Acknowledgment
16 2 ID O Application
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
configured in VPAdmin
AL = Always
Type
NE = Never
Acknowledgment Type
NOT USED
Message
EVN – Event type segment
The EVN segment is used to communicate necessary trigger event information to
receiving applications. This information is used only for HL7 definitions and is not used
specifically for any field(s) within the ViewPoint application. This segment is required.
SEQ LEN DT OPT RP/# ELEMENT NAME USAGE
ViewPoint 5.6 34
HL7 Interface Reference Manual
Version 6
SEQ LEN DT OPT RP/# ELEMENT NAME USAGE
1 3 ID B Event type code Type of the event (e.g. P12)
2 26 TS R Recorded date/time YYYYMMDDHHmmss
3 26 TS O Date/time planned event NOT USED
4 3 IS O Event reason code NOT USED
5 60 XCN O Operator ID NOT USED
6 26 TS O Event occurred NOT USED
PID – Patient Identification Segment
The PID segment is used by the VP HL7 interface for receiving patient identification
information. This segment contains permanent patient identifying and demographic
information that, for the most part, is not likely to change frequently.
SEQ LEN DT OPT RP/# ELEMENT NAME USAGE
1 4 SI O Set ID - Patient ID NOT USED
2 20 CX B Patient ID (External ID) Patient ID external to the VP
3 20 CX R(*) Y Patient ID (Internal ID) Patient ID external to the VP
4 20 CX B Y Alternate Patient ID - PID VP internal Patient ID
5 48 XPN O Y Patient Name Patient Name
6 48 XPN O Mother’s Maiden Name Patient’s Maiden Name
7 26 TS O Date/Time of Birth DOB (YYYYMMDD)
8 1 IS O Sex Patient Sex
9 48 XPN O Y Patient Alias NOT USED
10 1 IS O Race NOT USED
11 106 XAD O N Patient Address
information
11.1 32000 ST O N Patient Address Address
11.3 40 ST O N Patient city Town
11.4 25 ST O N Patient state or province State
11.5 8 ST O N Patient zip code Post/Zip code
11.6 3 ID O N Patient country Country
12 4 IS B N 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 NOT USED
16 1 IS O Marital Status NOT USED
system as received from the
HIS
system as received from the
HIS
Patient’s address
ViewPoint 5.6 35
HL7 Interface Reference Manual
Version 6
SEQ LEN DT OPT RP/# ELEMENT NAME USAGE
17 3 IS O Religion NOT USED
18 20 CX O Patient Account Number NOT USED
19 16 ST O SSN Number - Patient SSN (USA version only)
20 25 DLN O Driver's License Number -
Patient
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 Veterans Military Status NOT USED
28 80 CE O Nationality NOT USED
29 26 TS O Patient Death Date and
Time
30 1 ID O Patient Death Indicator NOT USED
NOT USED
NOT USED
(*) PID-3 optional in MDM^T02 event
PV1 – Patient Visit Segment
The PV1 segment is used by Registration/Patient Administration applications to
communicate information on a visit-specific basis.
SEQ LEN DT OPT RP/# ELEMENT NAME USAGE
1 4 SI O Set ID - PV1 NOT USED
2 1 IS O Patient Class Patient Class (see user defined
3 80 PL O Assigned Patient
Location
4 2 IS O Admission Type NOT USED
5 20 CX O Preadmit Number NOT USED
6 80 PL O Prior Patient Location Prior Patient Location
7 60 XCN O Y Attending Doctor NOT USED
8 60 XCN O Y Referring Doctor Referring Doctor
9 60 XCN O Y Consulting Doctor Consulting Doctor
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
table 0004 below)
Assigned Patient Location
1)
1)
ViewPoint 5.6 36
HL7 Interface Reference Manual
Version 6
SEQ LEN DT OPT RP/# ELEMENT NAME USAGE
15 2 IS O Y Ambulatory Status 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
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
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 Admit Date/Time
45 26 TS O Discharge Date/Time Discharge Date/Time
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
NOT USED
ViewPoint 5.6 37
HL7 Interface Reference Manual
Version 6
SEQ LEN DT OPT RP/# ELEMENT NAME USAGE
50 20 CX O Alternate Visit ID Field 1:
- one character specifying the
table:
e for exam, p for episode and o
for outcome
- @Id from the specified table
Field 4: Assigning Authority is
'GE ViewPoint'
51 1 IS O Visit Indicator NOT USED
52 60 XCN O Y Other Healthcare Provider NOT USED
1) Sequence of sub-fields:
ID^lastname^firstname^^^title^country^postcode^town^address^^phone
Example: 4711^Meier^Anton^^^Dr. med.^D^69152^Heidelberg^Im
Hexenkotten^^06221884733
Mapping der db-Felder:
doctor.matchid^doctor.name^doctor.other_names^^^doctor.title^doctor.country^doc
tor.postcode^doctor.address^^doctor.telephone_1
User-defined Table 0004 – Patient class (outbound)
Value Description (English) Description (German)
O Outpatient ambulant
I Inpatient stationär
P Preadmit vorstationär
R Recurring patient nachstationär
T teilstationär
ORC – Common Order Segment
The Common Order segment (ORC) is used to transmit fields that are common to all
orders. The ORC segment is used specifically by ViewPoint to communicate back to the
HIS receiving system that generated the original order in the first place. This segment is
optional and is non-repeating. Note: the customer must have purchased the “Order
Management module” within ViewPoint for this segment to be available as an export. In
addition, customer must follow the correct procedures to assign orders to
examinations. Please refer to your ViewPoint user manual.
SEQ LEN DT OPT RP/# SEQ USAGE
1 2 ID R Order Control Constant value “OK”
2 22 EI C Placer Order Number Order Number
3 22 EI C Sequence ID Sequence ID
ViewPoint 5.6 38
HL7 Interface Reference Manual
Version 6
SEQ LEN DT OPT RP/# SEQ USAGE
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 NOT USED
8 200 CM O Parent NOT USED
9 26 TS O Date/T ime of Transaction NOT USED
10 120 XCN O Entered By NOT USED
11 120 XCN O Verified By NOT USED
12 120 XCN O Ordering Provider NOT USED
13 80 PL O Enterer ’s Location Enterer’s Location
14 40 XTN O Y/2 Call Back Phone Number NOT USED
15 26 TS O Order Effective Date/T ime NOT USED
16 200 CE O Order Control Code
Reason
17 60 CE O Entering Organization NOT USED
18 60 CE O Entering Device NOT USED
19 120 XC O Action By NOT USED
20 - N - NOT USED (Reserved) NOT USED
21 60 CE O Ordering Facility Ordering Facility
Indication for the Order
OBR – Observation Request Segment
The Observation Request (OBR) segment is used to transmit information specific to an
order for a diagnostic study or observation, physical exam, or assessment. For
ViewPoint, this single order corresponds to a single examination (or to a single
pregnancy in case of FetaDoc). This segment is required and is non-repeating.
If the exam is not assigned to an order, than most of the fields of this segment remain
empty. All those fields are marked with an asterisk (*).
SEQ LEN DT OPT RP/# ELEMENT NAME USAGE
1 4 SI C Set ID – OBR NOT USED
2 75 EI C
3 75 EI C
Placer Order Number identical to ORC-2-placer order
(*)
Filler Order Number VP internal order id
(*)
number.
(examorder.@id)
ViewPoint 5.6 39
HL7 Interface Reference Manual
Version 6
SEQ LEN DT OPT RP/# ELEMENT NAME USAGE
4 200 CE O
5 2 ID B Priority NOT USED
6 26 TS B Requested Date/time NOT USED
7 26 TS C Observation Date/Time Observation Date/Time
8 26 TS O Observation End
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. NOT USED
14 26 TS C Specimen Received
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
18 60 ST O Placer field 1 Placer field 1
19 60 ST O Placer field 2 Placer f ield 2
20 60 ST O
21 60 ST O Filler Field 2 + NOT USED
22 26 TS C Rpt/Status Chng -
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 +
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
Universal Service ID Ordered Procedure
(*)
(YYYYMMDDhhmmss)
Date/Time #
Date/Time *
Number
Filler Field 1 Filler comment
(*)
Date/Time
NOT USED
Observation Date/Time
(YYYYMMDDhhmmss)
NOT USED
NOT USED
P=Preliminary, F=Final,
U=Update to Final
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
32 200 CM O Principal Result
Interpreter +
33 200 CM O Y Assistant Result
Interpreter +
34 200 CM O Y Technician + Assistant
First operator
Second operator
ViewPoint 5.6 40
HL7 Interface Reference Manual
Version 6
SEQ LEN DT OPT RP/# ELEMENT NAME USAGE
35 200 CM O Y Transcriptionist + NOT USED
36 26 TS O Scheduled Date/T ime + 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.
SEQ LEN DT OPT RP/# ELEMENT NAME USAGE
1 10 SI O Set ID - OBX Set ID – OBX
2 2 ID C Value Type Value Type
3 590 CE R Observation Identifier Observation Identifier
4 20 ST C Observation Sub-ID NOT USED
5 6553
6 60 CE O Units Observation 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
12 26 TS O Date Last Obs Normal
13 20 ST O User Defined Access
14 26 TS O Date/Time of the
15 60 CE O Producer's ID NOT USED
16 80 XCN O Responsible Observer Sonographer name
17 60 CE O Y Observation Method NOT USED
ST C Observation Value Observation value
6
Status
Values
Checks
Observation
NOT USED
NOT USED
NOT USED
Exam Date/Time
(YYYYMMDDhhmmss)
The following table describes the possible values for the fields 2 to 6.
ViewPoint 5.6 41
HL7 Interface Reference Manual
Version 6
Content
Value Type
Observation Value
Report text of
an
examination
or pregnancy
NM
ST
Flat Result Text separated by line breaks \.br\
which designate “new line”.
FT1 – Financial Transaction Server
The FT1 segment contains the detail data necessary to post charges, payments,
adjustments, etc. to patient accounting records. This segment is optional and repeating,
where the number of repeating segments is dependent upon the number of “other
codes” selected in the ViewPoint application, pertaining to a single exam. Please refer to
your ViewPoint user manual.
SEQ LEN DT OPT RP/# ELEMENT NAME USAGE
1 4 SI O
2 12 ST O
3 10 ST O
4 26 TS R
5
6 8 IS R
7 80 CE R
8 40 ST B
9 40 ST B
10 6 NM O
11 12 CP O
12 12 CP O
13 60 CE O
14 60 CE O
15 12 CP O
26
TS O
Set ID -FT1
Transaction ID
Transaction Batch ID
Transaction Date
Transaction Posting
Date
Transaction Type
Transaction Code
Transaction Description
Transaction Description
- Alt
Transaction Quantity
Transaction Amount Extended
Transaction Amount Unit
Department Code
Insurance Plan ID
Insurance Amount
Set ID -FT1
NOT USED
NOT USED
Exam Date/Time
(YYYYMMDDHHMMSS)
NOT USED
NOT USED
Field 1 : code
Field 2 : description
Field 3: catalog
NOT USED
NOT USED
Quantity (Default = 1)
NOT USED
NOT USED
NOT USED
NOT USED
NOT USED
ViewPoint 5.6 42
HL7 Interface Reference Manual
Version 6
SEQ LEN DT OPT RP/# ELEMENT NAME USAGE
16 80 PL O
17 1 IS O
18 2 IS O
19 60 CE O
20 120 XCN O
21 120 XCN O
22 12 CP O
23 22 EI O
24 120 XCN O
25 80 CE O
Assigned Patient
Location
Fee Schedule
Patient Type
Diagnosis Code
Performed By Code
Ordered By Code
Unit cost NOT USED
Filler Order Number
Entered By Code
Procedure Code
NOT USED
NOT USED
NOT USED
NOT USED
Performed By Code
Ordered By Code
NOT USED
NOT USED
NOT USED
PR1– Procedures segment
The PR1 segment contains information relative to various types of procedures that can
be performed on a patient. The PR1 segment is used to send multiple procedures, for
example, for medical records encoding or for billing systems. This segment is optional
and repeating, where the number of repeating segments is dependent upon the
number of “cpt codes” selected in the ViewPoint application, pertaining to a single
exam. Please refer to your ViewPoint user manual.
SEQ LEN DT OPT RP/# ELEMENT NAME USAGE
1 4 SI R Set ID – PR1 Set ID - PR1
2 2 IS B
3 80 CE R Procedure Code
4 40 ST B Procedure Description Procedure Description
5 26 TS R Procedure Date/Time
6 2 IS R
7 4 NM O Procedure Minutes NOT USED
8 120 XCN B Y Anesthesiologist NOT USED
9 2 IS O Anesthesia Code NOT USED
10 4 NM O Anesthesia Minutes NOT USED
11 120 XCN B Y Surgeon NOT USED
12 230 XCN B Y
Procedure Coding
Method
Procedure Functional
Type
Procedure Practitioner
Coding method
( only in DFT^VP1 and DFT^VP2
events )
Procedure Code (OPS or CPT Code)
(see note 1)
Exam Date/Time
(YYYYMMDDHHMMSS)
NOT USED
Performed By Code
ViewPoint 5.6 43
HL7 Interface Reference Manual
Version 6
SEQ LEN DT OPT RP/# ELEMENT NAME USAGE
13 60 CE O Consent Code NOT USED
14 2 NM O Procedure Priority Priority
15 80 CE O
19 250 EI C Procedure Identifier
20 1 ID C Procedure Action Code
Associated Diagnosis
Code
NOT USED
19-1:Unique ID for the Procedure
19-2: Unique ID for the sending
entity
(see note 2)
Procedure Action Code:
A – Add
U – Update
D - Delete
(see note 2)
Note 1:
For the French version of ViewPoint, the format of PR1-3 is as follows:
CCAMCode_Thera^CCAMCode_Thera_activity^CCAMCode_Thera_phase^CCAMCode_T
hera_modif
Note 2:
Fields 19 and 20 are present only in a BAR^P12 message. To assure the uniqueness of
DG1-20/PR1-19, the following format was implemented:
Key1: unique number to refer an examination, perinatal or outcome.
E: the diagnosis or procedure refers to an examination
O: the diagnosis or procedure refers to an outcome
P: the diagnosis or procedure refers to an perinatal
Key2: Unique number to refer a diagnosis or procedure
Short description: Short acronym to identify the diagnosis or procedure
Product description: Short description about the ViewPoint product
Installation UID: Unique number generated to identify a ViewPoint installation
Example:
301E1023MP^FDB_DE_DE000078369517633.1140527628 : Main procedure nr. 1023
belonging to examination nr. 301. Generated by an FDB_DE VPHisCom Server with
Installation UID 000078369517633.1140527628.
203O188OD^FDB_DE_DE000078369517633.1140527628: Other diagnosis nr. 188
belonging to outcome nr. 203. Generated by an FDB_DE VPHisCom Server with
Installation UID 000078369517633.1140527628.
ViewPoint 5.6 44
HL7 Interface Reference Manual
Version 6
34P221MP^FDB_DE_DE000078369517633.1140527628: Main procedure nr. 221
belonging to perinatal nr. 34. Generated by an FDB_DE VPHisCom Server with
Installation UID 000078369517633.1140527628.
If there is only one ViewPoint product in the system, the sub field 20-1 is enough to
univocally identify a diagnosis/procedure.
DG1 – Diagnosis segment
The DG1 segment contains patient diagnosis information of various types, for example,
admitting, primary, etc. The DG1 segment is used to send multiple diagnosis (for
example, for medical records encoding). This segment is optional and repeating, where
the number of repeating segments is dependent upon the number of “icd9 codes”
selected in the ViewPoint application, pertaining to a single exam. Please refer to your
ViewPoint user manual.
SEQ LEN DT OPT RP/# ELEMENT NAME USAGE
1 4 SI R Set ID - DG1 Set ID - DG1
2 2 ID R
3 60 CE O Diagnosis Code
4 40 ST B Diagnosis Description
5 26 TS O Diagnosis Date/Time
6 2 IS R Diagnosis Type Diagnosis Type (constant = W)
7 60 CE B
8 60 CE B
9 2 ID B DRG Approval Indicator NOT USED
10 2 IS B
11 60 CE B Outlier Type NOT USED
12 3 NM B Outlier Days NOT USED
13 12 CP B Outlier Cost NOT USED
14 4 ST B
15 2 NM B Diagnosis Priority NOT USED
16 60 XCN O Diagnosing Clinician Sonographer
17 3 IS O Diagnosis Classification NOT USED
18 1 ID O Confidential Indicator NOT USED NOT USED
Diagnosis Coding
Method
Major Diagnostic
Category
Diagnostic Related
Group
DRG Grouper Review
Code
Grouper Version And
Type
Diagnosis Coding Method
( only in DFT^VP1 and DFT^VP2
ViewPoint 5.6 45
HL7 Interface Reference Manual
Version 6
SEQ LEN DT OPT RP/# ELEMENT NAME USAGE
19 26 TS O Attestation Date/Time NOT USED
20-1:Unique ID for the Diagnosis
20 250 EI C Diagnosis Identifier
21 1 ID C Diagnosis Action Code
20-2: Unique ID for the sending
entity
(see note 2)
Diagnosis Action Code:
A – Add
U – Update
D – Delete
(see note 2)
Note 1:
For the French version of ViewPoint, the format of DG1-3 is as follows:
CCAM_Code_Diag^CCAM_Code_Diag_activity^CCAM_Code_Diag_phase^CCAM_Code
_Diag_modif
Note 2:
Fields 20 and 21 are present only in a BAR^P12 message. To assure the uniqueness of
DG1-20/PR1-19, the following format was implemented:
Key1: unique number to refer an examination, perinatal or outcome.
E: the diagnosis or procedure refers to an examination
O: the diagnosis or procedure refers to an outcome
P: the diagnosis or procedure refers to an perinatal
Key2: Unique number to refer a diagnosis or procedure
Short description: Short acronym to identify the diagnosis or procedure
Product description: Short description about the ViewPoint product
Installation UID: Unique number generated to identify a ViewPoint installation
Example:
301E1023MP^FDB_DE_DE000078369517633.1140527628 : Main procedure nr. 1023
belonging to examination nr. 301. Generated by an FDB_DE VPHisCom Server with
Installation UID 000078369517633.1140527628.
203O188OD^FDB_DE_DE000078369517633.1140527628: Other diagnosis nr. 188
belonging to outcome nr. 203. Generated by an FDB_DE VPHisCom Server with
Installation UID 000078369517633.1140527628.
34P221MP^FDB_DE_DE000078369517633.1140527628: Main procedure nr. 221
belonging to perinatal nr. 34. Generated by an FDB_DE VPHisCom Server with
Installation UID 000078369517633.1140527628.
ViewPoint 5.6 46
HL7 Interface Reference Manual
Version 6
If there is only one ViewPoint product in the system, the sub field 20-1 is enough to
univocally identify a diagnosis/procedure.
TXA - transcription document header segment
The TXA segment contains information specific to a transcribed document but does not
include the text of the document. The message is created as a result of a document
status change. This information is used to update other healthcare systems to identify
reports that are available in the transcription system. By maintaining the TXA message
information in these systems, the information is available when constructing queries to
the transcription system requesting the full document text.
1 4 SI R Set ID- TXA Unique Number identifying the
2 30 IS R Document Type DR : Diagnostic Report Other
3 2 ID C Document Content
4 26 TS O Activity Date/Time Exam / Episode Date/Time
5 250 XCN C Y Primary Activity
6 26 TS O Origination Date/T ime Not Used
7 26 TS C Transcription
document (Document ID)
ViewPoint will not send any
further messages referencing
this number.
Presentation
Provider Code/Name
Date/Time
Not Used
Operator or Sonographer name.
The names are transferred
completely in the second
component of the field (Family
Name <FN>).
Repetitions are used to transfer
the different persons:
1. Operator 1 (US
Version: Sonographer)
2. Operator 2 (US
Version: Physician)
3. Risk Assessment
Operator
4. Referring physician
1. ID
2. matchid
3. Family
4. First name
5. clinic
6. town
7. postcode
Not Used
name
ViewPoint 5.6 47
HL7 Interface Reference Manual
Version 6
SEQ LEN DT OPT RP/# ELEMENT NAME ViewPoint Value
8 26 TS O Y Edit Date/Time Date/time the document was
9 250 XCN O Y Originator
Code/Name
10 250 XCN O Y Assigned Document
Authenticator
11 250 XCN C Y Transcriptionist
Code/Name
12 30 EI R Unique Document
Number
13 30 EI C Parent Document
Number
14 22 EI O Y Placer Order Number Placer order number
15 22 EI O Filler Order Number VP internal order id
16 30 ST O Unique Document File
Name
17 2 ID R Document Completion
Status
18 2 ID O Document
Confidentiality Status
19 2 ID O Document Availability
Status
20 2 ID O Document Storage
Status
21 30 ST C Document Change
Reason
22 250 PPN C Y Authentication
Person(s)
23 250 XCN O Y Distributed Copies
(Code and Name of
Recipients)
edited
VP User
9.2 – Name
9.8 – Main user group
Not Used
Not Used
Document ID
Not Used
(examorder.@id)
Not Used
DO (documented): VP record not
locked
AU (authenticated): VP record
locked
Not Used
Not Used
Not Used
Not Used
Only if ‘Document Completion
Status’ is set to ‘AU’, (otherwise
field will be empty):
Operator or Sonographer name.
The names are transferred
completely in the second
component of the field (Family
Name <FN>).
Repetitions are used to transfer
the different persons:
1. Operator 1 (US
Version: Sonographer)
2. Operator 2 (US
Version: Physician)
3. Risk Assessment
Operator
Not Used
ViewPoint 5.6 48
HL7 Interface Reference Manual
Version 6
MSA – Message acknowledgement segment
The MSA segment contains acknowledge information.
SEQ LEN DT OPT RP/# ELEMENT NAME USAGE
1 2 ID R
2 20 ST R
3 80 ST O
4 15 NM O
5 1 ID B
6 250 CE O
Acknowledgment Code
Message Control ID
Text Message
Expected Sequence Number
Delayed Acknowledgment
Type
Error Condition
Acknowledgment Code:
AA: accepted
AE: error
Message Control ID
Error message if any
NOT USED
NOT USED
NOT USED
OBX - observation/result segment
The OBX segment is used to transmit a single observation or observation fragment. It
represents the smallest indivisible unit of a report. Its structure is summarized in Figure
7-5.
The following map applies to OBX segment only when used inside a MDM event
SEQ LEN DT OPT RP/# ELEMENT NAME ViewPoint value
1 4 SI O Set ID - OBX 1
2 2 ID C Value Type ST (String)
3 250 CE R Observation Identifier
4 20 ST C Observation Sub-ID Not Used
5 655
36
6 250 CE O Units Not Used
7 60 ST O References Range Not Used
8 5 IS 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
1
The length of the observation field is variable, depending upon value type. See OBX-2 value
type.
2
May repeat for multipart, single answer results with appropriate data types, e.g., CE, TX, and
* C Y
1
2
Observation Value UNC path to the PDF file to
Generated by VphiscomServer.
In MDM^T02 events, this field
contains the string
‘IMAGE_REF’
export.
FT data types.
ViewPoint 5.6 49
HL7 Interface Reference Manual
Version 6
SEQ LEN DT OPT RP/# ELEMENT NAME ViewPoint value
11 1 ID R Observation Result Status P=Preliminary,
F=Final,
U=Update to Final
C=Corrected
12 26 TS O Date Last Observation
Normal Value
13 20 ST O User Defined Access
Checks
14 26 TS O Date/Time of the
Observation
15 250 CE O Producer's ID Not Used
16 250 XCN O Y Responsible Observer Not Used
17 250 CE O Y Observation Method Not Used
18 22 EI O Y Equipment Instance
Identifier
19 26 TS O Date/Time of the Analysis Not Used
Not Used
Not Used
Not Used
Not Used
ZVP – ViewPoint specific segment
The ZVP segment is used specifically by ViewPoint to communicate exam related
information and the doctors/observers (resources) involved with the specified exam.
This segment is required and is non-repeating.
SEQ LEN DT OPT RP/# ELEMENT NAME USAGE
1 10 SI O SET ID – ZVP
2 26 TS R
3 - - -
4 60 XCN O Ordered by code Ordered by code
5 60 XCN O Performed by code Performed by code
6 60 XCN O Responsible observer Sonographer (operator 1)
7 60 XCN O Attending doctor Physician (operator 2)
8 30 ST O HL7ExamType
9 60 XCN O Ordered by facility name Facility name (Ordered by)
10 60 XCN O Performed by facility name Facility name (Performed by)
11 48 PPN R Message origin
12 60 XCN O Assistant Assistant
Date / Time of the
observation
Date / Time of end of
observation
SET ID – ZVP ^ ID of exam ^
record state
Exam date/time
(YYYYMMDDHHmmss)
End of exam date/time
(YYYYMMDDHHmmss), only
for German USEndo
Examination type ( USEndo
only)
User^Department^Computer
Name which
generated the message
ViewPoint 5.6 50
HL7 Interface Reference Manual
Version 6
ZOX – Pregnancy information (non-standard segment)
The ZOX segment is used specifically by ViewPoint to communicate pregnancy related
information. This segment is non-repeating.
SEQ LEN DT OPT RP/# ELEMENT NAME USAGE
1 32 SI R N Index Fixed to ‘1’
5
5.1 32 NM O N Gravida Gravida
5.2 32 NM O N Para Para
5.5 8 NM O N LMP Last menstrual period
Estimate date of delivery.
5.6 8 DT O N EDD_US
5.7 32 NM O N Case number Episode number
(according with ultrasound
examination, if present,
otherwise according with
LMP)
ZEX – Additional examination information (non-standard segment)*
The ZEX segment is used specifically by ViewPoint to communicate additional
examination information. This segment is non-repeating.
SEQ LEN DT OPT RP/# ELEMENT NAME USAGE
1 32 SI R N Index Fixed to ‘1’
2
2.1 512 ST O N Locker user
2.2 512 ST C N Computer name
2.3 26 TS C N
3
3.1 32 NM O N Exam id Exam.@id
3.2 64 ST O N Exam description Exam.type
3.3 32 ST O N Dicom accession number Dicom accession number
3.4 32 ST O N Exam ordered by code Exam ordered by code
3.5 32 ST O N Exam ordered by facility Exam ordered by facility
3.6 32 ST O N Exam performed by code Exam performed by code
3.7 32 ST O N Exam performed by facility Exam performed by facility
3.8 26 TS O N
Date / Time when the
exam was locked
Exam termination
timestamp
Locker user long name.(User
who locked the exam, if any)
Locker user’s computer
name. Conditioned to 2.1
Locked date/time
(YYYYMMDDHHmmss)
Exam termination timestamp
ViewPoint 5.6 51
HL7 Interface Reference Manual
Version 6
SEQ LEN DT OPT RP/# ELEMENT NAME USAGE
3.9 32 ST O N Operator 1 Operator 1
3.10 32 ST O N Operator 2 Operator 2
3.11 32 ST O N Operator 3 Operator 3 (Assistant)
4
4.1 32 NM O N Episode id Episode.@id
4.2 64 ST O N Episode description episode.type
5
5.1 1 NM R N Previous state Previous state
5.2 1 NM R N Actual state Actual state
6
6.1 32 ST O N Patient hospital number Patient hospital number
7 1st referring physician
7.1 32 NM O N id id
7.2 64 ST O N MatchID MatchID
7.3 64 ST O N Name Name
7.4 64 ST O N Other Names Other Names
7.5 64 ST O N Clinic Clinic
7.6 64 ST O N Town Town
7.7 64 ST O N Email Email
7.8 64 ST O N Communication provider Communication provider
8 2nd referring physician
8.1 32 NM O N id id
8.2 64 ST O N MatchID MatchID
8.3 64 ST O N Name Name
8.4 64 ST O N Other Names Other Names
8.5 64 ST O N Clinic Clinic
8.6 64 ST O N Town Town
8.7 64 ST O N Email Email
8.8 64 ST O N Communication provider Communication provider
The Segment ZEX is not available in ViewPoint installation by default. In order to allow
ViewPoint to add the ZEX segment as part of the exam related outbound HL7 events,
the following formula must be added to the file user_formula.dat, under user directory:
[HL7UseExamZSegement]
/calc="1";
ViewPoint 5.6 52
HL7 Interface Reference Manual
Version 6
This action will override the default implementation of HL7UseExamZSegment present
in common_formula.dat, which returns 0 by default.
ZPE – Additional perinatal information (non-standard segment)*
The ZPE segment is used specifically by ViewPoint to communicate additional perinatal
information. This segment is non-repeating.
SEQ LEN DT OPT RP/# ELEMENT NAME USAGE
1 32 SI R N Index Fixed to ‘1’
2
2.1 512 ST O N Locker user
2.2 512 ST C N Computer name
3
3.1 32 NM O N perinatal id Perinatal.@id
3.2 8 NM O N
3.3 8 NM 0 N Patien visit time perinatal. MutterAufenthalt
Patient visit Extimated
time
Locker user long name.(User
who locked the exam, if any)
Locker user’s computer
name. Conditioned to 2.1
perinatal.KlinikLiegedauer
The Segment ZPE is not available in ViewPoint installation by default. In order to allow
ViewPoint to add the ZPE segment as part of the perinatal related outbound HL7
events, the following formula must be added to the file user_formula.dat, under user
directory:
[HL7UsePerinatalZSegement]
/calc="1";
This action will override the default implementation of HL7UsePerinatalZSegment
present in common_formula.dat, which returns 0 by default.
ViewPoint 5.6 53
HL7 Interface Reference Manual
Version 6
Export of discrete findings
The ViewPoint HL7 interface offers the possibility to export finding values in an
ORU^R01 HL7 event, where each finding value is transmitted in a separate OBX
segment. The values exported depend on the different ViewPoint flavors and are
described in the table below.
Most of the values are coded according with the LOINC code system. However, some
ViewPoint specific finding are not classified as LOINC topic, and, therefore, are exported
with a proprietary identifier. The corresponding coding system for each finding value is
also transmitted to the hospital information system as described in HL7 standard in
OBX-3.3.
Name
Description
Gestational
Age
LMP Last menstrual
CRL Crown-rump
BPD Biparietal
HC Head
AC Abdominal
FL_L Left Femur length Numeric mm. 11963-6 7 Yes Yes Yes Yes Yes Yes Yes No
Gestational age Time weeks
period
length
diameter
circumference
circumference
Type
Date Date 8665-2 2 Yes Yes Yes Yes Yes Yes Yes No
Numeric mm. 11957-8 3 Yes Yes Yes Yes Yes Yes Yes No
Numeric mm. 11820-8 4 Yes Yes Yes Yes Yes Yes Yes No
Numeric mm. 11984-2 5 Yes Yes Yes Yes Yes Yes Yes No
Numeric mm. 11979-2 6 Yes Yes Yes Yes Yes Yes Yes No
Units
/Days
LOINC Code
11884-4 1 Yes Yes Yes Yes Yes Yes Yes No
ViewPoint Code
Present in FDB_USA
Present in FDB_UK
Present in FBD_German
Present in FDB_Spanish
Present in FDB_Italian_it
Present in FDB_French
Present in FDB_Italian_DE
Present in USENDO_DE
ViewPoint 5.6 54
HL7 Interface Reference Manual
Version 6