DIS Diighl7l

Development Interface
Specification (DIS)
for
Data Innovations Standard HL7
Version 2.0
Data Innovations, LLC
Document ID: DIS_0002

Last Updated: 1/6/2011
 COPYRIGHT 2011
DATA INNOVATIONS, LLC. ®
120 Kimball Avenue, Suite 100
South Burlington, Vermont 05403
Office: (802) 658-2850
Customer Support: (802) 658-1955
Support Email: support@datainnovations.com
The contents of this manual are subject to change

without notice and shall not be regarded as warranty.
Development Interface Specification (DIS) for Data Innovations Standard HL7
Table of Contents
Table of Contents ........................................................................................................................... i
Revision History ............................................................................................................................ ii
1. Introduction ..............................................................................................................................1
1.1 Purpose ........................................................................................................................................ 1
1.2 Definitions, Acronyms and Abbreviations .................................................................................. 1
1.3 Scope ........................................................................................................................................... 1
1.4 References ................................................................................................................................... 1
2. Overall Description ..................................................................................................................2
2.1 Low-Level Protocol ..................................................................................................................... 2
2.2 Message Hierarchy ...................................................................................................................... 2
2.2.1 Laboratory Order Message...................................................................................................... 2
2.2.2 Laboratory Result Message ..................................................................................................... 2
2.2.3 Laboratory Order Message for Microbiology ......................................................................... 3
2.2.4 Laboratory Result Message for Microbiology ........................................................................ 3
2.2.5 Laboratory Status Message ..................................................................................................... 3
2.2.6 Laboratory Storage Message ................................................................................................... 3
2.2.7 Acknowledgement Message.................................................................................................... 4
2.3 Message Segment Structure ........................................................................................................ 5
2.3.1 Laboratory Order Message...................................................................................................... 5
2.3.2 Laboratory Order Message for Microbiology ....................................................................... 11
2.3.3 Laboratory Result Message ................................................................................................... 17
2.3.4 Laboratory Result Message for Microbiology ...................................................................... 23
2.3.5 Laboratory Status Message HL7 Version 2.2 ....................................................................... 30
2.3.6 Laboratory Status Message HL7 Version 2.4 ....................................................................... 32
2.3.7 Laboratory Storage Message HL7 Version 2.4 ..................................................................... 33
2.3.8 Acknowledgement Message.................................................................................................. 35
2.4 Communication Examples......................................................................................................... 35
2.4.1 Laboratory Order Message.................................................................................................... 36
2.4.2 Micro Order Message............................................................................................................ 36
2.4.3 Laboratory Result Message ................................................................................................... 37
2.4.4 Micro Result Message........................................................................................................... 38
2.4.5 Laboratory Status Message ................................................................................................... 39
2.4.6 Laboratory Storage Message ................................................................................................. 39
3. External Interface Requirements .........................................................................................39
3.1 Hardware Interfaces .................................................................................................................. 39
3.2 Software Interfaces .................................................................................................................... 39
3.3 Communications Interfaces ....................................................................................................... 39
3.3.1 RS-232 Serial Communications ............................................................................................ 40
3.3.2 TCP/IP Communications ...................................................................................................... 41
3.3.3 LAT Communications ........................................................................................................... 41
4. Other Nonfunctional Requirements .....................................................................................41
4.1 Performance Requirements ....................................................................................................... 41
4.2 Safety Requirements.................................................................................................................. 41
4.3 Security Requirements .............................................................................................................. 41
5. Other Requirements ..............................................................................................................42
6. Approval Signatures ..............................................................................................................42
Document ID: DIS_0002 v2.0  2011 Data Innovations, LLC Page i

Revision History
Name Date Reason For Changes Version
Jennifer Booth 03/03/05 Original 1.0 Draft
Jennifer Booth 03/30/05 Added sections 2.2.5 and 2.2.6 to show 1.1 Draft
status and storage messages
Corrected some values in the “Usage”
column in sections 2.3.1.1, 2.3.2.1, 2.3.2.2,
2.3.3.1, 2.3.4.1, 2.3.4.2, and 2.3.5.1
Added sections 2.4.3 and 2.4.4 for status
and storage message examples
Separated HL7 version 2.2 and 2.4
examples in sections 2.4.1 and 2.4.2
Added “SAC” and “EQU” to section 1.2
Set “OPT IN” and “OPT OUT” to “O” for
NTE segment (section 2.3.7.1)
Jennifer Booth 04/05/05 Restructured document to show orders and 1.2 Draft
results separately
Jennifer Booth 04/12/05 Made several corrections and 1.3 Draft
enhancements pre review by TES
Jennifer Booth 04/15/05 Made enhancements per review by TES 1.4 Draft
Jennifer Booth 04/19/05 Updated OBR.25 in 2.3.2.5 and 2.3.4.6 1.5 Draft
Updated examples in sections 2.3.4.5,
2.3.4.6, and 2.3.4.7
Jennifer Booth 04/19/05 Approved 1.5
Tim Stowe 11/4/10 Updated copyright dates throughout 2.0 draft
Updated company name throughout
2.3.1.2 added note about Patient ID
requirements
Tim Stowe 1/6/2011 Approved 2.0
Document ID: DIS_0002 v2.0  2011 Data Innovations, LLC Page ii

1. Introduction
1.1 Purpose
This document contains the Development Interface Specifications for the Data Innovations Standard
HL7.
1.2 Definitions, Acronyms and Abbreviations

MSH Message Header Segment
IM Instrument Manager by Data Innovations, Inc.
MSA Message Acknowledgement Segment
PID Patient Identification Segment
PV1 Patient Visit Segment
ORC Common Order Segment
OBR Observation Request Segment
OBX Observation Result Segment
NTE Notes and Comments Segment
EQU Equipment Detail Segment
SAC Storage and Container Detail Segment
1.3 Scope
The Data Innovations Standard HL7 driver is a bi-directional driver that uses the standard
Instrument Manager programming API for integration with the Instrument Manager application. The
driver will use the standard Instrument Manager I/O module that allows for the following
communications methods:
RS-232 serial
TCP/IP
LAT
1.4 References
None.
Document ID: DIS_0002 v2.0  2011 Data Innovations, LLC Page 1

2. Overall Description
2.1 Low-Level Protocol

In order to provide a stream-oriented TCP/IP protocol, a Minimal Low-Level Protocol (MLLP) was
chosen.
The HL7 messages are enclosed by control characters in order to form a block. The format is:
<sb>dddd<eb><cr>
• <sb> = Start Block character; ASCII 11dec, the vertical tab character
• dddd = the transmitted data; a variable number of bytes
• <eb> = End Block character; ASCII 28dec, it should not be confused with <etx> ASCII 3dec,
or <etb> ASCII 23dec.
• <cr> = Carriage Return; ASCII 13dec.
2.2 Message Hierarchy

For various information flows various combinations of segments are relevant.
Square brackets, [ ], indicates segments that are optional.
2.2.1 Laboratory Order Message
MSH Message Header

PID Patient Identification
[NTE] Notes and Comments (for Detail)
[PV1] Patient Visit
ORC Common Order
OBR Observation Request
[OBX] Observation Result
2.2.2 Laboratory Result Message
MSH Message Header

[PV1] Patient Visit
ORC Common Order

OBX Observation Results

2.2.3 Laboratory Order Message for Microbiology
MSH Message Header

[PV1] Patient Visit
ORC Common Order
OBR Observation Request, containing panel and Isolate number
2.2.4 Laboratory Result Message for Microbiology
MSH Message Header

[PV1] Patient Visit
ORC Common Order
OBR Observation Request, Parent
OBX Observation Results, Parent, contains Isolate and organism.
OBR Observation Request, Child, contains Panel
OBX Observation Results, Child, contains Drugs and sensitivities.
2.2.5 Laboratory Status Message
2.2.5.1 HL7 Version 2.2

MSH Message Header
ORC Common Order
2.2.5.2 HL7 Version 2.4

MSH Message Header
SAC Specimen and Container Detail Segment
2.2.6 Laboratory Storage Message

2.2.6.1 HL7 Version 2.4

MSH Message Header
2.2.7 Acknowledgement Message
MSH Message Header

MSA Message Acknowledgment

2.3 Message Segment Structure

This section describes all of the message segments used by the Data Innovations Standard HL7
interface. Only these segments may be used to communicate relevant data to the Data Innovations
Standard HL7. Note: The message segment numbers listed do not count the message types.
Description of Segment Tables

SEQ Ordinal position of field/component within the segment. For example, if
SEQ was "2", then the data would be in field 2, if SEQ was "4.1", then the
data would be in field 4, component 1.
REQUIRED Optionality for Incoming and Outgoing Messages
R Required
O Optional
- Not Used, Ignored
ELEMENT NAME name of the field or component
USAGE description of possible contents

MSH Message Header
[NTE]
[PV1] Patient Visit
ORC Common Order
2.3.1.1 MSH Segment HL7 Versions 2.2 and 2.4
SEQ REQUIRED ELEMENT NAME USAGE

1 R Field Separator Vertical Pipe (|) ASCII 124
2 R Encoding characters Component delimiter, repeat delimiter, escape
delimiter, sub-component delimiter; typically
^~\&
8 O Security
11 R Processing ID P for production
D for debug/test
This field must match the Processing ID
configuration setting or the order will be
suppressed
Example:
<11>MSH|^~\&|||||||||P|||||<13>

2.3.1.2 Patient Identification Segment (PID) HL7 Versions 2.2 and 2.4

1 Set ID
3.1 O* Patient ID *Required if other patient data needs to be
stored, optional if no patient data needs to be
stored.
4 O Patient MRN
5.1 O Patient Last Name
5.2 O Patient First Name
5.3 O Patient Middle Initial
7 O Patient DOB YYYYMMDD
8 O Patient Sex M – Male
F – Female
The incoming message must be M or F.
Anything else will be suppressed.
10 O Patient Race
11.1 O Patient Address Line 1
11.3 O Patient Address Location
City
State
Zip
Country
13 O Patient Home Phone
Number
14 O Patient Business Phone
Number
18 O Patient Account Number
19 O Patient SSN Dashes will be stripped from this value for
incoming messages
Example:
PID|1||0101|23|Doe^John^L||19780211|M||WHITE|13 Mills St.^^Burlington^VT^05401ÛSA||802-
238-1189|802-555-1212||||409|001499991<13>
2.3.1.3 Patient Visit Segment (PV1) HL7 Version 2.2 and 2.4

1 Set ID
2 O Patient Status
3.1 O Patient Location Nurse
Station
3.2 O Patient Location Room
3.3 O Patient Location Bed

3.4 O Patient Location Facility If 3.4 is blank, the value in 3.1 (Patient
Location Nurse Station) is used as the Patient
Location Facility value
3.7 O Patient Location Ward
7.1 O Attending Physician – ID
7.2 O Attending Physician –
Last Name
First Name
Middle Initial
8.1 O Referring Physician - ID
8.2 O Referring Physician –
Last Name
First Name
Middle Initial
10 O Patient Hospital Service
Code
17.1 O Admitting Physician - ID
17.2 O Admitting Physician –
Last Name
First Name
Middle Initial
19 O Patient Visit Number
20 O Patient Financial Class
44 O Patient Admission Date
45 O Patient Discharge Date
Example:
PV1|1|Status|Nurse1^Room1^Bed1^Home^^^Ward1||||45Êinstien^Conrad^P|^Thorton^Billy^B||Ser
v Cde|||||||12^Daniels^Larry^B||Visit 5|Fin
Class||||||||||||||||||||||||20000210|20000213<13>
2.3.1.4 Common Order Segment (ORC) HL7 Versions 2.2 and 2.4

1 R Order Control RE for outgoing results
NW for new order
XE to add or delete from existing order
CA to delete order
2 - Specimen ID
3 O Filler Order Number
7.6 O Specimen Priority
12.1 O Ordering Physician – ID
12.2 O Ordering Physician – Last
Name

12.3 O Ordering Physician –

First Name
Middle Initial
Example:
ORC|NW|006001|FillerOrder#||||^^^^^R|||||1^FrankenstienÂlbert^Q<13>
2.3.1.5 Observation Request Segment (OBR) HL7 Version 2.2

1 R Set ID Ignored on incoming messages
2 O Specimen ID
4 O Test Code
5 O Specimen Priority Only if OBR.27.6 is null
7 O Specimen Collection Format: YYYYMMDDHHMMSS
Date/Time
8 O Specimen Collection End
Date/Time
9.1 O Specimen Volume
9.2 O Specimen Volume Units
10 O Collector ID
11 O Specimen Action
12.1 O Danger Code
15.1 O Specimen Fluid Type
15.4 O Specimen Site
16.1 O Ordering Physician - ID
Last Name
First Name
Middle Initial
18 O Destination of where This is the Instrument Manager connection (or
message is to go cluster) name to which the incoming message
should be sent. If this value is blank, the
default destination set up on the Connection
Assignment screen will be used.
19.1 O Test Bottle Type of
19.2 O Test Bottle ID of
19.3 O Test Time to Detection
19.7 O Specimen Type “Q” for QC, blank otherwise
20.1 O Specimen Rack
20.2 O Specimen Position
20.3 O Specimen Sequence
Number
24 O Specimen Accession
Area
27.6 O Specimen Priority Only if ORC.7.6 is null

31 O Reason for Test

44 O Specimen Procedure
Code
Example:
OBR|1|006001|||R||20000210022356|20000210025056|Volume^VolumeUnits||||||Fluid^^^Site|1^Fr
ankenstienÂlbert^Q||78|BottleType^BottleID^^
^^^Q|02^10^006|||||||^^^^^R||||Experiment A|||||||||||||E<13>

2 O Specimen ID
4 O Test Code
Date/Time
Date/Time
10 O Collector ID
12.1 O Danger Code
15.7 O Specimen Type “Q” for QC, blank otherwise
Last Name
First Name
Middle Initial
18 O Destination of where
message is to go
Number
Area

Code
Example:
OBR|1|006001|FillerOrder#||R||20000210022356|20000210025056|Volume^VolumeUnits|ColID||Dan
Cde|||Blood^^^SpecSite^^^Q|1^Franken
stienÂlbert^Q||78|BottleType^BottleID^|02^10^006||||Acc1|||^^^^^R||||Experiment
A|||||||||||||E<13>
2.3.1.7 Observation Result Segment (OBX) HL7 Version 2.2

If the test code of the OBX segment matches the test code in the preceding OBR segment, the result
value in the OBX segment is considered a previous result.

1 O Set ID This field contains the OBX segment index
for the current specimen, 1 for the first OBX,
2 for the second, etc...
3 R Test Code
4 O Test Previous Result of If OBX.3 matches OBR.4 (test codes)
18 O Test Previous Result Date If OBX.3 matches OBR.4 (test codes)
Time of
Example:
OBX|1||BUN|123||||||||||||||<13>

If the test code of the OBX segment matches the test code in the preceding OBR segment, the result
value in the OBX segment is considered a previous result.

1 O Set ID This field contains the OBX segment index
3 R Test Code
Time of
Example:
OBX|1||BUN||123||||||||||||||<13>
2.3.1.9 Notes and Comments Segment (NTE) HL7 versions 2.2 and 2.4

1 O Set ID This field contains the NTE segment index, 1
for the first NTE, 2 for the second, etc...
2 O ? L
3 O Test Comment

Specimen Comment
Patient Comment
Example:
NTE|1|L|These are comments<13>
2.3.2 Laboratory Order Message for Microbiology
MSH Message Header

[NTE]
[PV1] Patient Visit
ORC Common Order
OBR Observation Request, containing panel and Isolate number
2.3.2.1 MSH Segment HL7 Versions 2.2 and 2.4

2 R Encoding characters Component delimiter, repeat delimiter, escape
delimiter, sub-component delimiter; typically
^~\&
8 - Security A value of “MICRO” indicates that the
following message is a microbiology order
D for debug/test
This field must match the Processing ID
configuration setting or the order will be
suppressed
Example:
<11>MSH|^~\&||||||MICRO|||P|||||<13>

1 Set ID 1
3.1 O Patient ID
4 O Patient MRN


F – Female
The incoming message must be M or F.
Anything else will be suppressed.
10 O Patient Race
City
State
Zip
Country
Number
Number
19 O Patient SSN Dashes will be stripped from this value
Example:
PID|1||0101|23|Doe^John^L||19780211|M||WHITE|13 Mills
St.^^Burlington,VT,05401,USA^^||802-238-1189|802-555-1212||||409|001499991<13>

1 Set ID 1
2 O Patient Status
3.1 O Patient Location Nurse
Station
3.4 O Patient Location Facility If 3.4 is blank, the value in 3.1 (Patient
Location Nurse Station) is used as the Patient
Location Facility value
Last Name
First Name
Middle Initial

Last Name
First Name
Middle Initial
Code
Last Name
First Name
Middle Initial
Example:
PV1|1|Status|Nurse1^Room1^Bed1^Home^^^Ward1||||45Êinstien^Conrad^P|^Thorton^Bil
ly^B||Serv Cde|||||||12^Daniels^Larry^B||Visit 5|Fin
Class||||||||||||||||||||||||20000210|20000213<13>

1 R Order Control RE for outgoing results
NW for new order
XE to add or delete from existing order
CA to delete order
2 - Specimen ID
Name
12.3 O Ordering Physician – First
Name
Middle Initial
Example:


2 O Specimen ID
4 O Organism Only in first (parent)
4 O Test Panel Only in second (child)
Date/Time
Date/Time
10 O Collector ID
12.1 O Danger Code
Last Name
First Name
Middle Initial
18 O Destination of where This is the Instrument Manager connection (or
message is to go cluster) name to which the incoming message
should be sent. If this value is blank, the
default destination set up on the Connection
Assignment screen will be used.
19.7 O Specimen Type
Number
Area
25 O Test Isolate Number of Only in child OBR segment.
Code
Example:
OBR|1|1034873||ORGANISM|R||20020611082421|20020611082543|50^ml|mL|||||UR|||MICROSCAN|Bott
leType^BottleID^^^^^Type||<cr>

OBR|2|1034873||Gram Negative Panel

1|R||20020611082421|20020611082543|50^ml|mL|||||UR|||MICROSCAN|BottleType^BottleID^^^^^Ty
pe|||||||ISO1|||<cr>

2 O Specimen ID
4 O Organism Only in first (parent)
4 O Test Panel Only in second (child)
Date/Time
Date/Time
10 O Collector ID
12.1 O Danger Code
Last Name
First Name
Middle Initial
18 O Destination of where
message is to go
Number
Area
25 O Test Isolate Number of Only in child OBR segment
Code

Example:
OBR|1|1034873||ORGANISM|R||20020611082421|20020611082543|50^mL|mL|||||^^^^^^Type|||MICROS
CAN|BottleType^BottleID||<cr>
1|R||20020611082421|20020611082543|50^mL|mL|||||^^^^^^Type|||MICROSCAN|BottleType^BottleI
D|||||||ISO1|||<cr>

1 - Set ID This field contains the OBX segment index
3 R Test Code
Time of
Example:
OBX|1||BUN|123||||||||||||||<13>

1 - Set ID This field contains the OBX segment index
3 R Test Code
5 R Test Previous Result of If OBX.3 matches OBR.4 (test codes)
Time of
Example:
OBX|1||BUN||123||||||||||||||<13>

2 O ? L
3 O Test Comment
Specimen Comment
Patient Comment
Example:

MSH Message Header

[NTE]
[PV1] Patient Visit
ORC Common Order
OBX Observation Results
[NTE]
2.3.3.1 Message Header Segment (MSH) HL7 Versions 2.2 and 2.4

2 R Encoding characters Component delimiter, repeat delimiter,
escape delimiter, sub-component delimiter;
typically ^~\&
3 O Sending Application This field can be set up in the configuration
4 O Sending Facility This field can be set up in the configuration
5 O Receiving Application This field can be set up in the configuration
6 O Receiving Facility This field can be set up in the configuration
7 R Date/Time of Message Format: YYYYMMDDHHMMSS
9.1 R Message Type ORU for result messages
9.2 R Event Code R01 for result messages
D for debug/test
For outgoing messages this field can be
toggled by setting the Processing ID
configuration setting.
12 R HL7 Version 2.2 or 2.4
15 R Accept Acknowledgement AL – always expect a low level ack
Type
16 R Application NE – never expect a high level ack on error
Acknowledgement Type
Example:
v2.2:
MSH|^~\&|BICS Orders Interface|LIS|Instrument Manager|Data
Innovations|20041217024000||ORU^R01||P|2.2|||AL|NE<cr>
v2.4:


Innovations|20041217024000||ORU^R01||P|2.4|||AL|NE<cr>

1 Set ID
3.1 R Patient ID
4 O Patient MRN
F – Female
10 O Patient Race
City
State
Zip
Country
Number
Number
19 O Patient SSN No dashes
Example:
St.^^Burlington^VT^05401ÛSA||802-238-1189|802-555-1212||||409|001499991<cr>

1 Set ID
2 O Patient Status
3.1 O Patient Location Nurse If 3.1 is blank, the value in 3.4 (Patient
Station Location Facility) is used as the Patient
Location Nurse Station value
3.4 O Patient Location Facility


7.2 O Attending Physician – Last
Name
First Name
Middle Initial
8.2 O Referring Physician – Last
Name
8.3 O Referring Physician – First
Name
Middle Initial
Code
Last Name
First Name
Middle Initial
Example:
Class||||||||||||||||||||||||20000210|20000213<cr>

1 R Order Control “RE”
2 O Specimen ID
7.1 O Quantity
Name
Name
Middle Initial

Example:
ORC|NW|006001|FillerOrder#||||4^^^^^R|||||1^FrankenstienÂlbert^Q<cr>

1 R Set ID
2 R Specimen ID
Date/Time
Date/Time
10 O Collector ID
12.1 O Danger Code
Name
Name
Middle Initial
18 O Instrument ID
O Connection name, if
instrument ID is null
Number
21 O Specimen Error Flags This is a repeatable field.
24 O Specimen Accession Area
27.1 O Quantity
34 O Operator ID
44 O Specimen Procedure Code
Example:
OBR|1|006001|||R||20000210022356|20000210025056|Volume^VolumeUnits|5|||||Type^^^
Site|1^FrankenstienÂlbert^Q||78|BottleType^BottleID^^

^^^Q|02^10^006|E1~E2||||||7^^^^^R||||Experiment A|||39||||||||||E<cr>

1 R Set ID
2 R Specimen ID
Date/Time
Date/Time
10 O Collector ID
12.1 O Danger Code
Name
Name
Middle Initial
18 O Instrument ID
Number
27.1 O Quantity
34 O Operator ID
Example:
OBR|1|006001|FillerOrder#||R||20000210022356|20000210025056|Volume^VolumeUnits|C
olID||DanCde|||Blood^^^SpecSite^^^Q|1^Franken
stienÂlbert^Q||78|BottleType^BottleID|02^10^006||||Acc1|||8^^^^^R||||Experiment
A|||39||||||||||E<cr>


1 Set ID This field contains the OBX segment index
2 R Value Type This field contains the code for results value
type.
NM for numeric
TX for text
3 R Test Code
4 O Test Result of
5 O Test Units of
6 O Test Reference Range of
7 O Test Error Flags of
10 O Test Result Status of
13 O Test Date Time
Observation of
15 O Operator ID
17 O Test Instrument ID of
18 O Test Date Time
Observation of
Example:
OBX|1|NM|BUN|123|Grams|111^555|Error2|||F|||||39||78|19011104091533<cr>

2 Value Type This field contains the code for results value
type.
NM for numeric
TX for text
3 R Test Code
4 O Test Code Sub-id
5 O Test Result of
6 O Test Units of
14 O Test Date Time
Observation of
16 O Specimen Results
Reviewed by
16 O Operator ID This is separated from the “Specimen Results

Reviewed By” value with a repeat delimiter

19 O Test Date Time
Observation of
Example:
OBX|1|NM|BUN|SubID|123|Grams|111^555|Error5|||F|||19011104091533||ReviewedBy~Tec
hID||InstID|19011104091533<cr>

2 R ? L
3 O Test Comment Result & microresult msg
Specimen Comment
Patient Comment
Example:
NTE|1|L|These are comments
2.3.4 Laboratory Result Message for Microbiology
MSH Message Header

[NTE]
[PV1] Patient Visit
ORC Common Order
OBR Observation Request, Parent
OBX Observation Results, Parent, contains Isolate and organism.
[NTE]
OBR Observation Request, Child, contains Panel
OBX Observation Results, Child, contains Drugs and sensitivities.
2.3.4.1 Message Header Segment (MSH) HL7 Versions 2.2 and 2.4

typically ^~\&


8 R Security A value of “MICRO” indicates that the
message is a microbiology result
9.1 R Message Type ORU for result messages
9.2 R Event Code R01 for result messages
D for debug/test
Type
Example:
v2.2:
Innovations|20041217024000||ORU^R01|337175|P|2.2|||AL|NE<cr>
v2.4:
MSH|^~\&|IM||||20041122163825||ORU^R01|11|P|2.4|||AL|NE<cr>

1 Set ID
3.1 O Patient ID
4 O Patient MRN
F – Female
10 O Patient Race
City
State
Zip
Country

Number
Number
Example:
PID|1||0101|23|Smith^John^L||19780211|M||WHITE|13 Mills
St.^^Burlington^VT^05401ÛSA||802-238-1189|||||409|001499991<cr>
All outgoing data elements are for result and microresult messages.

1 Set ID
2 O Patient Status
3.1 O Patient Location Nurse If 3.1 is blank, the value in 3.4 (Patient
Station Location Facility) is used as the Patient
Location Nurse Station value
3.4 O Patient Location Facility
7.2 O Attending Physician – Last
Name
First Name
Middle Initial
8.2 O Referring Physician – Last
Name
8.3 O Referring Physician – First
Name
Middle Initial
Code
Last Name
First Name
Middle Initial

Example:
Class||||||||||||||||||||||||20000210|20000213<cr>

1 R Order Control “RE” for outgoing results
2 O Specimen ID
7.1 O Quantity
Name
Name
Middle Initial
Example:
ORC|RE|006001|||||^^^^^R|||||1^FrankenstienÂlbert^Q<cr>

1 R Set ID
2 R Specimen ID
4 O Test Panel
Date/Time
Date/Time
10 O Collector ID
12.1 O Danger Code
Name

Name
Middle Initial
18 O Instrument ID
Number
25 O Test Isolate Number of
27.1 O Quantity
34 O Operator ID
Example:
OBR|1|00001295|||||||Volume^VolumeUnits||||||^^^|||VITEK|BottleType^BottleID^^^^^Q|^^||||
|||^^^^^|||||||||||||||||<cr>
OBR|2|00001295||Panel 020||||||||||||||VITEK|||||||03<cr>

1 R Set ID
2 R Specimen ID
4 O Test Panel/Tray of
Date/Time
Date/Time
10 O Collector ID
12.1 O Danger Code
Name

Name
Middle Initial
18 O Instrument ID
Number
25 O Test Isolate Number of Only in child OBR segment
27.1 O Quantity
34 O Operator ID
Example:
OBR|1|00001295|||||||Volume^VolumeUnits||||||^^^^^^Q|||VITEK|BottleType^BottleID|^^||||||
|^^^^^|||||||||||||||||<cr>

type.
NM for numeric
TX for text
3 R Isolate Number (parent
OBX) or
O Drug Code (child OBX)
4 O Organism (parent OBX) or
O MIC Value (child OBX)
5 O Test Units of
7 O Test Error Flags (parent
OBX) or
O NCCLS Interpretation
(child OBX)
13 O Test Date Time
Observation of

15 O Operator ID
18 O Test Date Time
Observation of
Example:
OBX|1|NM|ISO3|55||||||F|||20020309000000||||VITEK|20020309000000<cr>
OBX|1|TX|Organism Class|N|||||||||20020309000000||||VITEK|20020309000000<cr>

type.
NM for numeric
TX for text
3 R Isolate Number (parent
OBX) or
O Drug Code (child OBX)
5 O Organism (parent OBX) or
O MIC Value (child OBX)
6 O Test Units of
7 O Test Error Flags (parent
OBX) or
NCCLS Interpretation
(child OBX)
14 O Test Date Time
Observation of
16 O Specimen Results
Reviewed by
16 O Operator ID This is separated from the “Specimen
Results Reviewed By” value with a repeat
delimiter
19 O Test Date Time
Observation of
Example:
OBX|1|TX|Organism Class||N|||||||||20020309000000||Myself~39||VITEK|20020309000000<cr>
OBX|2|NM|Am||4|ug/ml||||||||||||VITEK<cr>


2 R ? L
3 O Test Comment Result & microresult msg
Specimen Comment
Patient Comment
Example:
NTE|1|L|These are comments
2.3.5 Laboratory Status Message HL7 Version 2.2

MSH Message Header
ORC Common Order
2.3.5.1 Message Header Segment (MSH) HL7 Version 2.2

typically ^~\&
9.1 R Message Type ORM for status messages (HL7 v2.2)
9.2 R Event Code O01 for status messages (HL7 v2.2)
D for debug/test
This field can be toggled by setting the
Processing ID configuration setting.
Type
Example:
Innovations|20041217024000||ORMÔ01|337175|P|2.2|||AL|NE<cr>
2.3.5.2 Patient Identification Segment (PID) HL7 Version 2.2


1 Set ID
3.1 R Patient ID
4 O Patient MRN
F – Female
10 O Patient Race
City
State
Zip
Country
Number
Number
Example:
St.^^Burlington^VT^05401ÛSA||802-238-1189|802-555-1212||||409|001499991<cr>
2.3.5.3 Common Order Segment (ORC) HL7 Version 2.2

1 R Order Control “SC”
2 R Specimen ID
7.1 O Quantity
Name
Name
Middle Initial
Example:

ORC|SC|006001|FillerOrder#||||^^^^^R|||||1^FrankenstienÂlbert^Q<cr>
2.3.6 Laboratory Status Message HL7 Version 2.4

MSH Message Header

typically ^~\&
9.1 R Message Type SSU for status and storage messages (HL7
v2.4)
9.2 R Event Code U03 for status and storage messages (HL7
v2.4)
D for debug/test
Type
Example:
Innovations|20041217024000||SSUÛ03|337175|P|2.2|||AL|NE<cr>
2.3.6.2 Equipment Detail Segment (EQU) HL7 version 2.4

1 R Instrument ID
2 R Current Date/Time

Example:
EQU|InstID|20050307164634<cr>
2.3.6.3 Specimen and Container Detail Segment (SAC) HL7 version 2.4

2 O Accession Number If there is sample data
3 O SID If there is sample data
O Aliquot SID if Aliquot
4 O SID If there is sample data
5 O Carrier Sequence Number If there is sample data
6.1 O Specimen Fluid Type If there is sample data
6.7 O Specimen Type If there is sample data
7 O Current Date/Time If there is sample data or carrier data
8 O “I” If there is sample data
8.1 O Container Status If there is carrier data
8.4 O Container Flags If there is carrier data
8.6 O “RDC” If there is carrier data
9 O Carrier Aliquot Carrier If aliquot carrier type is not null, If there is
Type carrier data
Carrier Type If aliquot carrier type is null, If there is
carrier data
10 O Carrier Aliquot Carrier ID If Aliquot carrier ID is not null, If there is
carrier data
Carrier ID If Aliquot carrier ID is null, If there is
carrier data
11 O Carrier X Position If there is carrier data
Carrier Position in Aliquot If position in Aliquot carrier not null, If
Carrier there is carrier data
12 O Carrier Tray Type If container level location and locations 1-3
are not null
15 O Volume If carrier container level location not
Null and locations 1-3 are not null
Carrier Container Level If carrier container level location not null
Location and locations 1-3 are not null
Example:
SAC|||006001|006001|Seq#||18741019122044|Container Status^^^Flags^^RDC|Aliquot
Type|006001|Second||||555<cr>
2.3.7 Laboratory Storage Message HL7 Version 2.4

MSH Message Header


typically ^~\&
9.1 R Message Type SSU for status and storage messages (HL7
v2.4)
9.2 R Event Code U03 for status and storage messages (HL7
v2.4)
D for debug/test
This field can be toggled by setting the
Processing ID configuration setting.
Type
Example:
MSH|^~\&|IM||||20041122163825||SSUÛ03|11|P|2.4|||AL|NE<cr>
2.3.7.2 Equipment Detail Segment (EQU) HL7 version 2.4

1 R Instrument ID
2 R Current Date/Time
Example:
EQU|InstID|20050307164634<cr>
2.3.7.3 Specimen and Container Detail Segment (SAC) HL7 version 2.4

2 O Accession Number
3 O SID
O Aliquot SID If Aliquot
4 O SID

5 Sequence Number
7 Current Date/Time
8 Carrier Container Status If container type is not null
“R” If container type is null
9 Carrier Type Sequence # If aliquot carrier type is null
10 Carrier ID If Aliquot carrier ID is null
11.1 Carrier X Position
11.2 Carrier Y Position
15 Carrier Container Level If carrier container level location not
Location null
15.1 Location 1 If carrier container level location is null
22 Carrier Volume If carrier volume is not null
24 Carrier Volume Units If carrier volume units is not null
Example:
SAC|||006001|006001|Seq#||18741019122044|Container Status|Aliquot
Type|006001|X^Y||||555|||||||34||Grams<cr>
2.3.8 Acknowledgement Message
MSH Message Header

MSA Message Acknowledgment
2.3.8.1 Message Acknowledgement Segment (MSA) HL7 versions 2.2 and 2.4

1 R Acknowledgement Code AA for Accept Acknowledgement
AE for error
2 R Message Control ID Message Control ID of message being

acknowledged
3 O Text Message If Acknowledgement Code is AE, this field
may contain text describing the error
condition.
Example:
MSA|AA|1
2.4 Communication Examples

Definitions:
<sb> - ASCII 11

<cr> - ASCII 13
<eb> - ASCII 28

Order message sent from Instrument to Standard HL7.
2.4.1.1 HL7 Version 2.2
<11>MSH|^~\&|||||||||P|||||<13>
555-1212|802-555-1212||||409|001499991<13>
Class||||||||||||||||||||||||20000210|20000213<13>
OBR|1|006001|||R||20000210022356|20000210025056|Volume^VolumeUnits||||||Fluid^^^Site|1^Fr
ankenstienÂlbert^Q||78|BottleType^BottleID^^
^^^Q|02^10^006|||||||^^^^^R||||Experiment A|||||||||||||E<13>
OBX|1||BUN|123||||||||||||||<13>
NTE|1|L|These are comments<13><28>
2.4.1.2 HL7 Version 2.4
<11>MSH|^~\&|||||||||P|||||<13>
555-1212|802-555-1212||||409|001499991<13>
Class||||||||||||||||||||||||20000210|20000213<13>
OBR|1|006001|FillerOrder#||R||20000210022356|20000210025056|Volume^VolumeUnits|ColID||Dan
Cde|||Blood^^^SpecSite^^^Q|1^Franken
stienÂlbert^Q||78|BottleType^BottleID^|02^10^006||||Acc1|||^^^^^R||||Experiment
A|||||||||||||E<13>
OBX|1||BUN||123||||||||||||||<13>
NTE|1|L|These are comments<13><28>
2.4.2 Micro Order Message

Micro order message sent from Instrument to Standard HL7.
2.4.2.1 HL7 Version 2.2
MSH|^~\&|||||||||P|||||<13>
Class||||||||||||||||||||||||20000210|20000213<13>

OBR|1|1034873||ORGANISM|R||20020611082421|20020611082543|50^ml|mL|||||UR|||MICROSCAN|Bott
leType^BottleID^^^^^Type||<cr>
1|R||20020611082421|20020611082543|50^ml|mL|||||UR|||MICROSCAN|BottleType^BottleID^^^^^Ty
pe|||||||ISO1|||<cr>
OBX|1||BUN|123||||||||||||||<13>
2.4.2.2 HL7 Version 2.4

MSH|^~\&|||||||||P|||||<13>
Class||||||||||||||||||||||||20000210|20000213<13>
OBR|1|1034873||ORGANISM|R||20020611082421|20020611082543|50^mL|mL|||||^^^^^^Type|||MICROS
CAN|BottleType^BottleID||<cr>
1|R||20020611082421|20020611082543|50^mL|mL|||||^^^^^^Type|||MICROSCAN|BottleType^BottleI
D|||||||ISO1|||<cr>
OBX|1||BUN||123||||||||||||||<13>

Result message sent from Standard HL7 to Instrument.
2.4.3.1 HL7 Version 2.2
MSH|^~\&|Send App|SendingFAC|Recv APp|Recv Fac|20050406100011||ORU^R01||P|2.2|||AL|NE<cr>

PID|1||0101|MRN|Smith^John^L||19780211|M||WHITE|13 Mills
NTE|1|L|This is a patient comment<cr>
PV1|1|PS|Nurse^Room^Bed^Home||||45Êinstien^Conrad^P|^Thorton^Billy^B||HSC|||||||12^Danie
ls^Larry^B||89011101|FC|||||||||||||
|||||||||||20000210|20000213<cr>
ORC|RE|006001|FillerOrder||||5^^^^^R|||||1^FrankenstienÂlbert^Q<cr>
OBR|1|006001|FillerOrder||R||20000210022356|20000210025056|12^Grams|CollectorID||Danger
Code|||SER^^^Site1|1^FrankenstienÂlb
ert^Q||78|Bottle^Bott ID3^^^^^Q|02^10^006|Error3|||AccArea|||5^^^^^R||||Experiment
A|||TechID||||||||||E<cr>
NTE|1|L|This is a sample comment<cr>
OBX|1|NM|ISO0|BUN|Grams|111^555|Error5|||F|||19011104091533||TechID||InstID|1901110409153
3<cr>
NTE|1|L|This is a test comment<cr>
2.4.3.2 HL7 Version 2.4
MSH|^~\&|Send App|SendingFAC|Recv APp|Recv Fac|20050406095742||ORU^R01||P|2.4|||AL|NE<cr>

NTE|1|L|This is a patient comment<cr>
PV1|1|PS|Nurse^Room^Bed^Home^^^Ward||||45Êinstien^Conrad^P|^Thorton^Billy^B||HSC|||||||1
2^Daniels^Larry^B||89011101|FC||||||
||||||||||||||||||20000210|20000213<cr>
ORC|RE|006001|FillerOrder||||5^^^^^R|||||1^FrankenstienÂlbert^Q<cr>
OBR|1|006001|FillerOrder||R||20000210022356|20000210025056|12^Grams|CollectorID||Danger
Code|||SER^^^Site1^^^Q|1^Frankenstien
Âlbert^Q||78|Bottle^Bott ID3^|02^10^006|Error3|||AccArea|||5^^^^^R||||Experiment
A|||TechID||||||||||E<cr>
NTE|1|L|This is a sample comment<cr>
OBX|1|NM|ISO0||BUN|Grams|111^555|Error5|||F|||19011104091533||ReviewedBy~TechID||InstID|1
9011104091533<cr>
NTE|1|L|This is a test comment<cr>
2.4.4 Micro Result Message

Micro result message sent from Standard HL7 to Instrument.
2.4.4.1 HL7 Version 2.2
Innovations|20041217024000|MICRO|ORU^R01|337175|P|2.2|||AL|NE<cr>
Class||||||||||||||||||||||||20000210|20000213<cr>
OBR|1|00001295|||||||Volume^VolumeUnits||||||^^^|||VITEK|BottleType^BottleID^^^^^Q|^^||||
|||^^^^^|||||||||||||||||<cr>
NTE|1|L|test message for front page free text<cr>
NTE|2|L|3rd test bugfor S\T\G's<cr>
OBX|1|NM|ISO3|55||||||F|||20020309000000||||VITEK|20020309000000<cr>
OBX|1|TX|Organism Class|N|||||||||20020309000000||||VITEK|20020309000000<cr>
2.4.4.2 HL7 Version 2.4

MSH|^~\&|IM||||20041122163825|MICRO|ORU^R01|11|P|2.4|||AL|NE<cr>
Class||||||||||||||||||||||||20000210|20000213<cr>
OBR|1|00001295|||||||Volume^VolumeUnits||||||^^^^^^Q|||VITEK|BottleType^BottleID|^^||||||
|^^^^^|||||||||||||||||<cr>
NTE|1|L|test message for front page free text<cr>
NTE|2|L|3rd test bug for S\T\G's<cr>
OBX|1|NM|ISO3||55||||||F|||20020309000000||||VITEK|20020309000000<cr>
OBX|1|TX|Organism Class||N|||||||||20020309000000||||VITEK|20020309000000<cr>
OBX|2|NM|Am||4|ug/ml||||||||||||VITEK<cr>

2.4.5 Laboratory Status Message
Status message sent from Standard HL7 to Instrument.

2.4.5.1 HL7 Version 2.2
MSH|^~\&|Send App|SendingFAC|Recv APp|Recv Fac|20050406100110||ORMÔ01||P|2.2|||AL|NE<cr>

ORC|SC|006001|FillerOrder||||5^^^^^R|||||1^FrankenstienÂlbert^Q<cr>
2.4.5.2 HL7 Version 2.4
MSH|^~\&|Send App|SendingFAC|Recv APp|Recv Fac|20050406100232||SSUÛ03||P|2.4|||AL|NE<cr>

EQU|78|20050406100232<cr>
SAC|||006001|||SER^^^^^^C|20050406100232|I<cr>
2.4.6 Laboratory Storage Message

Storage message sent from Standard HL7 to Instrument.
2.4.6.1 HL7 Version 2.4
MSH|^~\&|IM||||20050104140912||SSUÛ03||P|2.4|||AL|NE<cr>
EQU|Specimen Management|20050104140912<cr>
SAC||Acc|006001|006001|Seq||20050406101032|Status|CarrierSeq||X^Y||||LevelLoc|||||||Volum
e||Units<cr>
3. External Interface Requirements
3.1 Hardware Interfaces

None.
3.2 Software Interfaces

None.
3.3 Communications Interfaces

This driver will utilize the standard Instrument Manager communication model which allows for the
following communications methods:
RS-232 serial
TCP/IP

LAT
For each standard type of communication, specify and requirements or limitations:
3.3.1 RS-232 Serial Communications

These are the available RS-232 communication parameters. The default settings are in BOLD.
Baud: 1200, 2400, 4800, 9600, 19200
Data bits: 7, 8
Parity: ODD, EVEN, NONE
Stop bits: 1, 2
Flow Control: NO XON/XOFF
Pinout information for connectors on the Instrument Manager system:
COM Port Type Connector Type Pin Out

Equinox Port
2-Tx
3-Rx
7-SG

PC COM Port
2-Rx
3-Tx
5-SG
3.3.2 TCP/IP Communications

The Standard HL7 Interface supports both TCP/IP Client and TCP/IP Server communications.
TCP/IP Server Ports 23 and 1972 are reserved by Cache and cannot be used. Server Ports greater
than 10000 are recommended.
3.3.3 LAT Communications

The Standard HL7 Interface supports LAT communications by defining a LAT Node and Port that
the BCI Flow Cytometry IM HL7 Interface will connect to.
4. Other Nonfunctional Requirements
4.1 Performance Requirements

None.
4.2 Safety Requirements

None.
4.3 Security Requirements

None.

5. Other Requirements
None.
6. Approval Signatures
Signatures required for approval of specification:
Role Signature Date

Development Manager
Don Jarvis
Quality Assurance Engineer
Dave Delang
Author
Tim Stowe

DIS Diighl7l

Hochgeladen von

Dokumentinformationen

Copyright

Verfügbare Formate

Dieses Dokument teilen

Dokument teilen oder einbetten

Freigabeoptionen

Stufen Sie dieses Dokument als nützlich ein?

Sind diese Inhalte unangemessen?

Copyright:

Verfügbare Formate

DIS Diighl7l

Hochgeladen von

Copyright:

Verfügbare Formate

Development Interface

Data Innovations Standard HL7

Document ID: DIS_0002

The contents of this manual are subject to change

Document ID: DIS_0002 v2.0  2011 Data Innovations, LLC Page i

Document ID: DIS_0002 v2.0  2011 Data Innovations, LLC Page ii

1.2 Definitions, Acronyms and Abbreviations

Document ID: DIS_0002 v2.0  2011 Data Innovations, LLC Page 1

2.1 Low-Level Protocol

2.2 Message Hierarchy

2.2.1 Laboratory Order Message

MSH Message Header

2.2.2 Laboratory Result Message

MSH Message Header

Document ID: DIS_0002 v2.0  2011 Data Innovations, LLC Page 2

OBX Observation Results

2.2.3 Laboratory Order Message for Microbiology

MSH Message Header

2.2.4 Laboratory Result Message for Microbiology

MSH Message Header

2.2.5 Laboratory Status Message

2.2.5.1 HL7 Version 2.2

2.2.5.2 HL7 Version 2.4

2.2.6 Laboratory Storage Message

Document ID: DIS_0002 v2.0  2011 Data Innovations, LLC Page 3

2.2.6.1 HL7 Version 2.4

2.2.7 Acknowledgement Message

MSH Message Header

Document ID: DIS_0002 v2.0  2011 Data Innovations, LLC Page 4

2.3 Message Segment Structure

Description of Segment Tables

2.3.1 Laboratory Order Message

2.3.1.1 MSH Segment HL7 Versions 2.2 and 2.4

SEQ REQUIRED ELEMENT NAME USAGE

Document ID: DIS_0002 v2.0  2011 Data Innovations, LLC Page 5

SEQ REQUIRED ELEMENT NAME USAGE

SEQ REQUIRED ELEMENT NAME USAGE

Document ID: DIS_0002 v2.0  2011 Data Innovations, LLC Page 6

SEQ REQUIRED ELEMENT NAME USAGE

Document ID: DIS_0002 v2.0  2011 Data Innovations, LLC Page 7

12.3 O Ordering Physician –

2.3.1.5 Observation Request Segment (OBR) HL7 Version 2.2

SEQ REQUIRED ELEMENT NAME USAGE

Document ID: DIS_0002 v2.0  2011 Data Innovations, LLC Page 8

31 O Reason for Test

2.3.1.6 Observation Request Segment (OBR) HL7 Version 2.4

SEQ REQUIRED ELEMENT NAME USAGE

Document ID: DIS_0002 v2.0  2011 Data Innovations, LLC Page 9

2.3.1.7 Observation Result Segment (OBX) HL7 Version 2.2

SEQ REQUIRED ELEMENT NAME USAGE

2.3.1.8 Observation Result Segment (OBX) HL7 Version 2.4

SEQ REQUIRED ELEMENT NAME USAGE

SEQ REQUIRED ELEMENT NAME USAGE

Document ID: DIS_0002 v2.0  2011 Data Innovations, LLC Page 10

2.3.2 Laboratory Order Message for Microbiology

MSH Message Header

2.3.2.1 MSH Segment HL7 Versions 2.2 and 2.4

SEQ REQUIRED ELEMENT NAME USAGE

SEQ REQUIRED ELEMENT NAME USAGE

Document ID: DIS_0002 v2.0  2011 Data Innovations, LLC Page 11

7 O Patient DOB YYYYMMDD

SEQ REQUIRED ELEMENT NAME USAGE

Document ID: DIS_0002 v2.0  2011 Data Innovations, LLC Page 12

SEQ REQUIRED ELEMENT NAME USAGE