You are on page 1of 96

Automated Clinical Analyzer

Communication Specifications

TOKYO BOEKI MEDISYS INC.

Original Instructions
V1.4.2

Manufactured by Tokyo Boeki Medisys Inc.


1-14-21, Higashitoyoda, Hino-shi, Tokyo 191-0052, Japan
Tel: (81)-42-587-7777
Communication Specifications

Contents
1. Introduction....................................................................................................................... 1
1.1. Reference ........................................................................................................................... 1
1.2. Motion Mode...................................................................................................................... 1
2. Interface Specifications..................................................................................................... 2
2.1. Transmission medium (from Layer 1 “Physical Layer” to Layer 2 “Data Link Layer” in
the OSI reference model) ............................................................................................................. 2
2.2. IEEE 802 (LAN) ................................................................................................................ 2
2.2.1. From Layer 1 “Physical Layer” to Layer 4 “Transport Layer” in the OSI Reference
Model .................................................................................................................................... 2
2.3. RS-232C ............................................................................................................................. 2
3. Application Layer Protocol ............................................................................................... 3
3.1. Glossary ............................................................................................................................. 3
3.1.1. Trigger Event ............................................................................................................. 3
3.1.2. Message ...................................................................................................................... 3
3.1.3. Segment...................................................................................................................... 3
3.1.4. Field............................................................................................................................ 3
3.1.5. Field Components ...................................................................................................... 3
3.1.6. Message Delimiters ................................................................................................... 3
3.1.7. Battery ....................................................................................................................... 4
3.2. Use of Escape Sequences in Text Fields........................................................................... 4
3.3. Editing Method for Unicode(UTF-8) ................................................................................ 5
3.4. Message and Trigger Event Supported by BiOLiS.......................................................... 6
3.5. Message Framework Summary........................................................................................ 6
3.6. Segment Framework Summary ....................................................................................... 6
3.7. Other Rules ....................................................................................................................... 7
3.8. Message Composition ....................................................................................................... 8
3.8.1. Explanatory Notes ..................................................................................................... 8
3.8.2. Clinical Test Order..................................................................................................... 8
3.8.3. Clinical Test Result.................................................................................................... 8
3.8.4. Patient Information Notification .............................................................................. 8
3.8.5. Test Result Information Referral – Patient Basis .................................................... 9
3.8.6. Test Result Information Referral – Sample Basis.................................................... 9
3.8.7. Test Order Information Referral ............................................................................. 10
3.9. Segment Component ....................................................................................................... 10
3.9.1. MSH - Message header segment ..............................................................................11
(1) Field separator ..........................................................................................................11
(2) Encoding characters ................................................................................................ 12
(3) Sending application ................................................................................................. 12
(4) Sending facility ........................................................................................................ 12
(5) Receiving application............................................................................................... 12
(6) Receiving facility...................................................................................................... 12
(7) Date/Time of message .............................................................................................. 12
(8) Security .................................................................................................................... 12
(9) Message type ............................................................................................................ 12
(10) Message control ID .................................................................................................. 13
V1.4.2

(11) Processing ID ........................................................................................................... 13


(12) Version ID ................................................................................................................ 13
(13) Sequence number .................................................................................................... 13
(14) Continuation pointer ............................................................................................... 13
(15) Accept acknowledgment type .................................................................................. 13
(16) Application acknowledgment type .......................................................................... 13
(17) Country code ............................................................................................................ 14
(18) Character set ........................................................................................................... 14
(19) Principal language of message ................................................................................ 15
(20) Alternate character set handling scheme............................................................... 15
(21) Message profile identifier ........................................................................................ 15
3.9.2. PID - Patient identification segment ...................................................................... 16
(1) Set ID - Patient ID................................................................................................... 17
(2) Patient ID ................................................................................................................ 17
(3) Patient identifier list ............................................................................................... 17
(4) Alternate patient ID ................................................................................................ 17
(5) Patient name............................................................................................................ 17
(6) Mother's maiden name ............................................................................................ 18
(7) Date/Time of birth ................................................................................................... 18
(8) Administrative sex................................................................................................... 18
(9) Patient alias ............................................................................................................. 18
(10) Race .......................................................................................................................... 18
(11) Patient address ........................................................................................................ 18
(12) County code .............................................................................................................. 18
(13) Phone number - Home ............................................................................................. 18
(14) Phone number - Business........................................................................................ 19
(15) Primary language .................................................................................................... 19
(16) Marital status .......................................................................................................... 19
(17) Religion .................................................................................................................... 19
(18) Patient account number .......................................................................................... 19
(19) SSN number............................................................................................................. 19
(20) Driver's license number........................................................................................... 19
(21) Mother's identifier ................................................................................................... 19
(22) Ethnic group ............................................................................................................ 19
(23) Birth place................................................................................................................ 19
(24) Multiple birth indicator ........................................................................................... 20
(25) Birth order ............................................................................................................... 20
(26) Citizenship ............................................................................................................... 20
(27) Veterans military status.......................................................................................... 20
(28) Nationality ............................................................................................................... 20
(29) Patient death date and time ................................................................................... 20
(30) Patient death indicator............................................................................................ 20
(31) Identity unknown indicator .................................................................................... 20
(32) Identity reliability code ........................................................................................... 20
(33) Last update date/time ............................................................................................. 20
(34) Last update facility .................................................................................................. 21
(35) Species code.............................................................................................................. 21
Communication Specifications

(36) Breed code ................................................................................................................ 21


(37) Strain........................................................................................................................ 21
(38) Production class code ............................................................................................... 21
(39) Tribal citizenship ..................................................................................................... 21
3.9.3. SPM - Specimen segment ........................................................................................ 22
(1) Set ID - SPM ............................................................................................................ 22
(2) Specimen ID ............................................................................................................. 22
(3) Specimen parent IDs ............................................................................................... 23
(4) Specimen type .......................................................................................................... 23
(5) Specimen type modifier ........................................................................................... 23
(6) Specimen additives .................................................................................................. 24
(7) Specimen collection method .................................................................................... 24
(8) Specimen source site................................................................................................ 24
(9) Specimen source site modifier ................................................................................. 24
(10) Specimen collection site ........................................................................................... 25
(11) Specimen role ........................................................................................................... 25
(12) Specimen collection amount .................................................................................... 26
(13) Grouped specimen count ......................................................................................... 26
(14) Specimen description ............................................................................................... 26
(15) Specimen handling code .......................................................................................... 26
(16) Specimen risk code .................................................................................................. 26
(17) Specimen collection date/time ................................................................................. 26
(18) Specimen received date/time ................................................................................... 27
(19) Specimen expiration date/time ............................................................................... 27
(20) Specimen availability .............................................................................................. 27
(21) Specimen reject reason ............................................................................................ 27
(22) Specimen quality ..................................................................................................... 27
(23) Specimen appropriateness ...................................................................................... 27
(24) Specimen condition .................................................................................................. 28
(25) Specimen current quantity...................................................................................... 28
(26) Number of specimen containers .............................................................................. 28
(27) Container type ......................................................................................................... 28
(28) Container condition ................................................................................................. 28
(29) Specimen child role .................................................................................................. 28
3.9.4. SAC - Specimen and container detail segment ...................................................... 30
(1) External accession identifier ................................................................................... 31
(2) Accession identifier .................................................................................................. 31
(3) Container identifier ................................................................................................. 31
(4) Primary (parent) container identifier ..................................................................... 32
(5) Equipment container identifier............................................................................... 32
(6) Specimen source....................................................................................................... 32
(7) Registration date/time ............................................................................................. 32
(8) Container Status...................................................................................................... 32
(9) Carrier type .............................................................................................................. 33
(10) Carrier identifier...................................................................................................... 33
(11) Position in carrier .................................................................................................... 33
(12) Tray type .................................................................................................................. 33
V1.4.2

(13) Tray identifier .......................................................................................................... 34


(14) Position in tray ........................................................................................................ 34
(15) Location .................................................................................................................... 34
(16) Container height ...................................................................................................... 34
(17) Container diameter ................................................................................................. 34
(18) Barrier delta ............................................................................................................ 34
(19) Bottom delta ............................................................................................................ 34
(20) Container diameter/height/delta units ................................................................... 35
(21) Container volume .................................................................................................... 35
(22) Available volume...................................................................................................... 35
(23) Initial specimen volume .......................................................................................... 35
(24) Volume units ............................................................................................................ 35
(25) Separator type ......................................................................................................... 35
(26) Cap type ................................................................................................................... 36
(27) Additive .................................................................................................................... 36
(28) Specimen component ............................................................................................... 36
(29) Dilution factor .......................................................................................................... 36
(30) Treatment ................................................................................................................ 36
(31) Temperature............................................................................................................. 37
(32) Hemolysis index....................................................................................................... 37
(33) Hemolysis index units ............................................................................................. 37
(34) Lipemia index .......................................................................................................... 37
(35) Lipemia index units ................................................................................................. 37
(36) Icterus index ............................................................................................................ 37
(37) Icterus index units ................................................................................................... 37
(38) Fibrin index.............................................................................................................. 37
(39) Fibrin index units .................................................................................................... 38
(40) System induced contaminants ................................................................................ 38
(41) Drug interference..................................................................................................... 38
(42) Artificial blood ......................................................................................................... 38
(43) Special handling consideration ............................................................................... 38
(44) Other environmental factors ................................................................................... 39
3.9.5. OBR - Observation Request Segment ..................................................................... 40
(1) Set ID - Observation request................................................................................... 42
(2) Placer order number ................................................................................................ 42
(3) Filler order number ................................................................................................. 42
(4) Universal service ID ................................................................................................ 42
(5) Priority ..................................................................................................................... 42
(6) Requested date/time ................................................................................................ 42
(7) Observation date/time ............................................................................................. 42
(8) Observation end date/time ...................................................................................... 43
(9) Collection volume..................................................................................................... 43
(10) Collector identifier ................................................................................................... 43
(11) Specimen action code ............................................................................................... 43
(12) Danger code ............................................................................................................. 44
(13) Relevant clinical code .............................................................................................. 44
(14) Specimen received date/time................................................................................... 44
Communication Specifications

(15) Specimen source....................................................................................................... 44


(16) Ordering provider .................................................................................................... 44
(17) Order callback phone number ................................................................................. 45
(18) Placer field1 ............................................................................................................. 45
(19) Placer field2 ............................................................................................................. 45
(20) Filler field1 ............................................................................................................... 45
(21) Filler field2 ............................................................................................................... 45
(22) Results rpt/status change - date/time ..................................................................... 45
(23) Charge to practice .................................................................................................... 45
(24) Diagnostic serv sect ID ............................................................................................ 46
(25) Result status ............................................................................................................ 46
(26) Parent result ............................................................................................................ 46
(27) Quality / Timing ....................................................................................................... 47
(28) Result copies to ........................................................................................................ 47
(29) Parent number ......................................................................................................... 47
(30) Transportation mode ............................................................................................... 47
(31) Reason for study ...................................................................................................... 48
(32) Principal result interpreter ..................................................................................... 48
(33) Assistant result interpreter..................................................................................... 48
(34) Technician ................................................................................................................ 48
(35) Transcriptionist........................................................................................................ 48
(36) Scheduled date/time ................................................................................................ 48
(37) Number of sample containers ................................................................................. 49
(38) Transport logistics of collected sample ................................................................... 49
(39) Collector's comment ................................................................................................. 49
(40) Transport arrangement responsibility.................................................................... 49
(41) Transport arranged.................................................................................................. 49
(42) Escort required ........................................................................................................ 49
(43) Planned patient transport comment ....................................................................... 49
(44) Procedure code ......................................................................................................... 50
(45) Procedure code modifier .......................................................................................... 50
(46) Placer supplemental service information ............................................................... 50
(47) Filler supplemental service information ................................................................ 51
(48) Medically necessary duplicate procedure reason ................................................... 51
(49) Result handling........................................................................................................ 51
3.9.6. OBX - Observation/Result Segment........................................................................ 52
(1) Set ID - OBX ............................................................................................................ 52
(2) Value type................................................................................................................. 53
(3) Observation identifier.............................................................................................. 53
(4) Observation Sub ID ................................................................................................. 53
(5) Observation value .................................................................................................... 53
(6) Units ......................................................................................................................... 54
(7) References Range..................................................................................................... 54
(8) Abnormal Flags........................................................................................................ 55
(9) Probability ................................................................................................................ 55
(10) Nature of abnormal test .......................................................................................... 55
(11) Observation result status ........................................................................................ 55
V1.4.2

(12) Effective date of reference range............................................................................. 55


(13) User defined access check ....................................................................................... 55
(14) Date/Time of the observation .................................................................................. 56
(15) Producer's ID ........................................................................................................... 56
(16) Responsible observer ............................................................................................... 57
(17) Observation method ................................................................................................ 57
(18) Equipment instance identifier ................................................................................ 57
(19) Date/Time of the analysis........................................................................................ 57
3.9.7. QAK - Query acknowledgment Segment ................................................................ 58
(1) Query tag ................................................................................................................. 58
(2) Query response status ............................................................................................. 58
(3) Message query name ............................................................................................... 58
(4) Hit count total .......................................................................................................... 59
(5) This payload............................................................................................................. 59
(6) Hits remaining ......................................................................................................... 59
3.9.8. QPD - Query parameter definition Segment .......................................................... 60
(1) Message query name ............................................................................................... 60
(2) Query tag ................................................................................................................. 60
(3) Patient Identifier List.............................................................................................. 60
(4) Container identifier ................................................................................................. 60
(5) Position in carrier .................................................................................................... 61
3.9.9. RCP - Response control parameter Segment ......................................................... 62
(1) Query priority .......................................................................................................... 62
(2) Quantity limited request ......................................................................................... 62
(3) Response modality ................................................................................................... 62
(4) Execution and delivery time ................................................................................... 62
(5) Modify indicator....................................................................................................... 62
(6) Sort-by field.............................................................................................................. 62
(7) Segment group inclusion ......................................................................................... 63
3.9.10. MSA - Message acknowledgment Segment ........................................................ 64
(1) Acknowledgment code ............................................................................................. 64
(2) Message control ID .................................................................................................. 64
(3) Text message ............................................................................................................ 64
(4) Expected sequence number ..................................................................................... 64
(5) Delayed acknowledgment type ............................................................................... 64
(6) Error condition......................................................................................................... 64
3.9.11. ERR - Error Segment ........................................................................................... 65
(1) Error code and location ........................................................................................... 65
(2) Error location ........................................................................................................... 65
(3) HL7 error code ......................................................................................................... 65
(4) Severity .................................................................................................................... 66
(5) Application error code ............................................................................................. 66
(6) Application error parameter ................................................................................... 66
(7) Diagnostic information ............................................................................................ 66
(8) User message ........................................................................................................... 66
(9) Inform person indicator ........................................................................................... 66
(10) Override type ........................................................................................................... 66
Communication Specifications

(11) Override reason code ............................................................................................... 67


(12) Help desk contact point ........................................................................................... 67
3.9.12. EVN - Event type Segment.................................................................................. 68
(1) Event type code ........................................................................................................ 68
(2) Recorded date/time .................................................................................................. 68
(3) Date/Time planned event ........................................................................................ 68
(4) Event reason code .................................................................................................... 68
(5) Operator ID .............................................................................................................. 68
(6) Event occurred ......................................................................................................... 69
(7) Event facility ............................................................................................................ 69
3.10. Data type ..................................................................................................................... 70
3.10.1. ST - string data .................................................................................................... 71
3.10.2. TX - text data ....................................................................................................... 71
3.10.3. NM - numeric ....................................................................................................... 71
3.10.4. SI - sequence ID ................................................................................................... 71
3.10.5. ID - coded value for HL7 defined tables .............................................................. 71
3.10.6. IS - coded value for user-defined tables .............................................................. 71
3.10.7. DT - date ............................................................................................................... 71
3.10.8. DTM - date/time ................................................................................................... 71
3.10.9. SRT - sort order .................................................................................................... 72
3.10.10. CQ - composite quantity with units .................................................................... 72
3.10.11. MO - money .......................................................................................................... 72
3.10.12. SN - structured numeric ...................................................................................... 72
3.10.13. EI - entity identifier ............................................................................................. 73
3.10.14. HD - hierarchic designator .................................................................................. 73
3.10.15. PT - processing type ............................................................................................. 73
3.10.16. VID - version identifier ........................................................................................ 73
3.10.17. TS - time stamp .................................................................................................... 73
3.10.18. CNN - composite ID number and name simplified ............................................ 73
3.10.19. CWE - coded with exceptions............................................................................... 74
3.10.20. CX - extended composite ID with check digit ..................................................... 74
3.10.21. XCN - extended composite ID number and name for persons ........................... 74
3.10.22. EIP - entity identifier pair ................................................................................... 75
3.10.23. ELD - error location and description................................................................... 75
3.10.24. MOC - money and charge code ............................................................................ 75
3.10.25. MSG - message type............................................................................................. 75
3.10.26. NDL - name with date and location .................................................................... 75
3.10.27. OSD - order sequence definition .......................................................................... 76
3.10.28. PRL - parent result link ....................................................................................... 76
3.10.29. SPS - specimen source ......................................................................................... 76
3.10.30. FN - family name ................................................................................................. 76
3.10.31. SAD - street address ............................................................................................ 77
3.10.32. XAD - extended address....................................................................................... 77
3.10.33. XPN - extended person name .............................................................................. 77
3.10.34. XTN - extended telecommunication number ...................................................... 78
3.10.35. NA - numeric array .............................................................................................. 78
3.10.36. DLN - driver’s license number ............................................................................ 78
V1.4.2

3.10.37. DR - date/time range............................................................................................ 78


3.10.38. RI - repeat interval .............................................................................................. 78
4. Message Examples .......................................................................................................... 80
4.1. Clinical Test Order .......................................................................................................... 80
4.2. Clinical Test Result ......................................................................................................... 80
4.3. Patient Information Notification.................................................................................... 81
4.4. Test Result Information Referral - Patient basis .......................................................... 81
4.5. Test Result Information Referral - Sample basis .......................................................... 81
4.6. Test Order Information Referral .................................................................................... 82
4.6.1. Sample Barcode Mode ............................................................................................. 82
4.6.2. Sample Position Mode ............................................................................................. 83
Communication Specifications

Revision History
Edition Date Revision Summary
1.1 2016/04/04 Corrected the mistake of the item from “4.6 Test Result
Referral” to”4.6 Test Order Referral"

1.2 2016/04/11 Corrected the mistake in chapter 3.9.1(10) Message control


ID from “Implementation: YYYYMMDDHHMMSS” to
“Implementation: YYYYMMDDHHMMSS[FFF] or use a
unique number as needed.”.
1.3 2016/6/1 Specification change
3.10.30.FN- family name SEQ 1Lebgth 50⇒199
3.10.33.XPN - extended person name SEQ 1Lebgth 194⇒
339, SEQ 2Lebgth 30⇒199
1.4 2017/4/25 3.9.2. PID (3) Patient identifier list
The ID number should be within 20 characters.⇒The ID
number should be within 15 characters.
1.4.1 2018/10/1 2.2.1. From Layer 1 “Physical Layer” to Layer 4 “Transport
Layer” in the OSI Reference Model
The socket communication for TCP/IP is used and the
system conducts the communication at the following 4 ports.
⇒The socket communication for TCP/IP is used and the
system conducts the communication at the following 5
ports.
1.4.2 2018/10/15 4.3Patient Information Notification、Fixing typos
Communication Specifications

1. Introduction
This specifications defines the communication between BiOLiS 30i (BiOLiS) and
Laboratory Information System (LIS). The BiOLiS has the settings of the following
motion modes. Please read this specifications after you decide the operation procedures
by thoroughly talking with users.

1.1. Reference
HL7 Messaging Standard Version 2.5: An Application Protocol for Electronic Data
Exchange in Healthcare Environments

1.2. Motion Mode


Motion Mode Contents
Position Number Receives orders by recognizing sample positions as a key, and
Mode transfers results.
Sample Barcode Receives orders by recognizing sample barcode as a key, and
Mode transfers results.

The change of the operation methods may lead the modification of the LIS. Again, we
kindly ask for your understanding.
If there's anything you are unclear on, please contact us.

1
V1.4.2

2. Interface Specifications
2.1. Transmission medium (from Layer 1 “Physical Layer” to Layer 2 “Data Link Layer” in the
OSI reference model)
There may be the following 2 models and the IEEE 802(LAN) has been
implemented.
・IEEE 802 (LAN)
・RS-232C
The RS-232C is Not implemented in consideration of the current trend.

2.2. IEEE 802 (LAN)


2.2.1. From Layer 1 “Physical Layer” to Layer 4 “Transport Layer” in the OSI Reference Model
The socket communication for TCP/IP is used and the system conducts the
communication at the following 5 ports.
No. Contents Direction of Information Port No.
Transmission
1 Test orders  55000
2 Test results  55001
3 Patient information  55002
4 Test result inquiry  55003
5 Test order inquiry  55004
The [] indicates the information flow from the LIS to the BiOLiS.
The [] indicates the information flow from the BiOLiS to the LIS.
The [] indicates that the BiOLiS becomes a server and the LIS accepts the
connection establishment.
The [] indicates that the LIS becomes a server and the BiOLiS established
(accepts) the connection.

2.3. RS-232C
Not implemented

2
Communication Specifications

3. Application Layer Protocol


3.1. Glossary
3.1.1. Trigger Event
The event that initiates an exchange of messages is called a trigger event.

3.1.2. Message
A message is the atomic unit of data transferred between systems. It is comprised of a
group of segments in a defined sequence. Each message has a message type that defines its
purpose.

3.1.3. Segment
An HL7 segment is a logical grouping of data fields. Segments of a message may be
required or optional. They may occur only once in a message or they may be allowed to
repeat. Each segment is identified by a unique three character code known as the
Segment ID.

3.1.4. Field
An HL7 field is a string of characters defined by one of the HL7 data types, e.g.
measurement item name. The field may have a group of data describing the detail of
the basic attribute.

3.1.5. Field Components


A field entry may also have discernable parts or components. For example, the
patient’s name is recorded as last name, first name, and middle initial, each of which is
a distinct entity separated by a component delimiter. The components may consist of
subcomponents.

3.1.6. Message Delimiters


In constructing a message certain characters are used. These include the Segment
Terminator, the Field Separator, the Component Separator, the Sub-Component
Separator, Repetition Character, and the Escape Character.
Encoding Delimiter Sugge Usage
Character sted
Position Value
- Segment Terminator [CR] Terminates a segment record.
Separates two adjacent data fields
Field Separator (Field within a segment. It also separates
- |
Deliminator) the segment ID from the first data
field in each segment.
Separates adjacent components of
Component Separator data fields where allowed. Usage
1 ^
(Component Deliminator) of Component is described in the
relevant Data Field.
Separates multiple occurrences of
2 Repetition Separator ~
a field where allowed.
Escape character for use with text
¥
3 Escape Character fields represented by an ST, TX
5Chex
data type (fourth). A single text
3
V1.4.2

indicating this character is


designated in the text field of
coded value of MSH segment.
Separates adjacent
subcomponents of data fields
4 Subcomponent Separator & where allowed. If there are no
subcomponents, this character
may be omitted.
It is Not allowed to change any deliminators in the BiOLiS.

3.1.7. Battery
The word battery is used in this specification synonymously with the word profile or
panel. The individual observation elements within a battery may be characteristic of a
physiologic system (e.g., liver function tests), or many different physiologic systems. Vital
signs (conventionally) consist of diastolic and systolic blood pressure, pulse, and respiratory
rate. Electrolytes usually consist of Na+, K+, Cl- and HCO3-. Routine admission tests might
contain CBC, Electrolytes, SMA12, and Urinalysis. (Note that the elements of a battery for
our purposes may also be batteries). Obstetrical ultrasound is a battery made up of
traditional component measurements and the impression, all of which would be returned
as separate results when returned to the requestor. A test involving waveform recording
(such as an EKG) can be represented as a battery comprised of results of many categories,
including digital waveform data, labels and annotations to the data, measurements, and
the impression.

3.2. Use of Escape Sequences in Text Fields


When a field of type TX, ST etc. is being encoded, the escape character may be used
to signal certain special characteristics of portions of the text field. The escape
character is ¥(5Chex). An escape sequence consists of the escape character followed by
an escape code ID of one character, zero (0) or more data characters, and another
occurrence of the escape character for termination. No escape sequence may contain a
nested escape sequence.
 Special character
The following escape sequences are defined for special characters, such as a field
separator, a component separator, a subcomponent separator, a repetition separator
and an escape character.
¥F¥ | field separator
¥S¥ ^ component separator
¥T¥ & subcomponent separator
¥R¥ ~ repetition separator
¥E¥ ¥ escape character.
¥Xdd...dd¥ hexadecimal data. This is used in the text fields.
e.g. The ¥0d¥ is for carriage return. The ¥0a¥ is for line
feed
¥Cxxyy¥ Single-byte character set escape sequence with two
hexadecimal values not converted
Single-byte character set escape sequence with two
hexadecimal values, xx and yy, that indicate the escape

4
Communication Specifications

sequence defined for one of the character repertoires


supported for the current message (i.e., ISO-IR xxx). When
the contents are displayed with a set of characters of ST or
text type, this escape sequence is used.
¥Mxxyyzz¥ Multi-byte character set escape sequence with two or three
hexadecimal values (zz is optional) not converted
Multi-byte character set escape sequence with three
hexadecimal values, xx, yy and zz. zz is optional. When the
contents are displayed with a set of characters of ST or text
type, this escape sequence is used.

 Exception
¥¥ ¥ Escape character
Characters except for the above special character
¥A¥ Ignorance
¥F...¥ Ignorance
Others
|...¥S| ...^ Regards it as “¥S¥”.
|...¥S...| ... Ignores “¥S...”.

3.3. Editing Method for Unicode(UTF-8)


The ST type or text type can display characters except for ASCII. This section describes
an editing method for UTF-8.
The escape sequence to UTF-8 defines as “¥MEFBBBF¥”.
The escape sequence to ASCII defines as “¥C2842¥”.
The character code of UTF-8 is edited in hexadecimal data.
And then, designate |UNICODE UTF-8| in the field 18 of Message header segment.
Reference: 3.2 Use of Escape sequences in Text fields
3.9.1 1.1.1.1(18)Character set
e.g. ABCDEF is |ABC¥MEFBBBF¥¥XCEB1CEB2CEB3¥¥C2842¥DEF|.

5
V1.4.2

3.4. Message and Trigger Event Supported by BiOLiS


No. Message definition Message type Trigger event Event type
OML Determination of O35
1 Clinical test order ORL Buttery to one sample O36
and one container
OUL Measurement result R23
2 Clinical test result
ACK calculation R23
Patient information ADT Determination of A08
3
notification ACK patient information A08
Patient result QBP As needed ZB5
4 information RSP ZB6
referral(patient basis)
Measurement result QBP As needed ZB7
5 information RSP ZB8
referral(sample basis)
Test order information QBP No order after WOS
6
referral RSP detecting samples WOS
Ignores messages except for the above messages.
*5 The Measurement result information referral (sample basis) is an extended
function of Tokyo Boeki Medisys Inc.

3.5. Message Framework Summary


A message is the atomic unit of data transferred between systems. It is comprised of a
group of segments in a defined sequence. Message, e.g. test order, is occurred by a trigger
event, e.g. order. All messages begin with the letter <VT> and consist of segments (e.g.
patient attribute), such as Message header (MSH) segment, data composition element (e.g.
patient name). And then, the messages are comprised of <FS><CR> as a terminal letter.

3.6. Segment Framework Summary


A segment is a logically divided message and is from Message Header (MSH) to <CR>. The
segment omits a terminal <CR> and is ASCII printable character

6
Communication Specifications

The details are described for each message separately.

3.7. Other Rules


Test results of ISE are calculated three times at the same time so this segment repeats
three times. At the time, three segments, |1|,|2|,|3|, repeats. Besides, this repeat occurs
about calculation item or HbA1c for test result transmission.
Moreover, when only the calculation item A/G ratio is ordered, the analyzer sends results
of Albumin and Globulin to the LIS.

7
V1.4.2

3.8. Message Composition


3.8.1. Explanatory Notes
Comment field
Option Content
R Required
O Optional
X Not used

3.8.2. Clinical Test Order


This is sent as needed when the order for one sample/one container is determined in
the LIS.
OML (LIS->BiOLiS) Event(O35)
Segment No. Segment name Content Option
1 MSH Message header R
2 PID Patient identification O
3 SPM Specimen R
4 SAC Specimen container R
5 OBR Observation request R
6 OBX Observation/Result R
ORL (BiOLiS->LIS) Event(O36)
Segment No. Segment Name Content Option
1 MSH Message header R
2 MSA Message acknowledgment R
3 ERR Error O

3.8.3. Clinical Test Result


This is sent as needed when the result for a test is calculated in the BiOLiS.
OUL (BiOLiS->LIS) Event(R23)
Segment No. Segment name Content Option
1 MSH Message header R
2 PID Patient identification O
3 SPM Specimen information R
4 SAC Container information R
5 OBR Observations request R
6 OBX Observation related to OBR R
Observation related to OBR, O
7 OBX
repeats as much as needed.
ACK (LIS->BiOLiS) Event(R23)
Segment No. Segment name Content Option
1 MSH Message header R
2 MSA Message acknowledgment R
3 ERR Error O

3.8.4. Patient Information Notification


This is sent in the LIS as needed.
ADT(LIS->BiOLiS) Event(A08)

8
Communication Specifications

Segment No. Segment name Content Option


1 MSH Message header R
2 EVN Event type R
3 PID Patient identification R
ACK (BiOLiS->LIS) Event(A08)
Segment No. Segment Name Content Option
1 MSH Message header R
2 MSA Message acknowledgment R
3 ERR Error O

3.8.5. Test Result Information Referral – Patient Basis


This is sent in the LIS as needed.
QBP(LIS->BiOLiS) Event(ZB5)
Segment No. Segment name Content Option
1 MSH Message header R
2 QPD Query parameter definition R
segment
3 RCP Response control parameters R
RSP(BiOLiS->LIS) Event(ZB6)
Segment No. Segment name Content Option
1 MSH Message header R
2 MSA Message acknowledgment R
3 ERR Error O
4 QAK Query acknowledgment R
5 QPD Query parameter definition R
segment
6 PID Patient identification R
7 SPM Specimen R
8 OBR Observations request R
9 OBX Observation related to OBR R
No the Seg.No.4 and after exist if an error is reported in Seg.No.3.
No the Seg.No.7 and after exist if no sample for a referral Patient Identification
exists.
No the Seg.No.8 and after exist if a sample for a referral Patient Identification but
no order exists.
No the Seg.No.9 exists if a sample for a referral Patient Identification and an order
exists but no measurement result exists.
Things from Seg.No.7 to Seg.No.9 repeat if plural samples exist for a referral Patient
Identification.
The Seg.No.9 repeats if plural orders for a referral Patient Identification to one
sample exist.

3.8.6. Test Result Information Referral – Sample Basis


QBP(LIS->BiOLiS) Event(ZB7)
Segment No. Segment name Content Option
1 MSH Message header R

9
V1.4.2

2 QPD Query parameter definition segment R


3 RCP Response control parameters R
RSP(BiOLiS->LIS) Event(ZB8)
Segment No. Segment name Content Option
1 MSH Message header R
2 MSA Message acknowledgment R
3 ERR Error O
4 QAK Query acknowledgment R
5 QPD Query parameter definition segment R
6 SPM Specimen R
7 OBR Observations request R
8 OBX Observation related to OBR R
No the Seg.No.4 and after exist if an error is reported in the Seg.No.3.
No the Seg.No.6 and after exist if no order for a referral sample exists.
No the Seg.No.8 exists if an order for a referral sample exists but no measurement
result exists.
The Seg.No.8 repeats if plural orders for a referral sample exist.

3.8.7. Test Order Information Referral


The time period from the referral of QBP^WOS to the response of RSP^WOS is set
to 40 seconds.
QBP(BiOLiS->LIS) Event(WOS)
Segment No. Segment name Content Option
1 MSH Message header R
2 QPD Query parameter definition segment R
3 RCP Response control parameters R
RSP(LIS->BiOLiS) Event(WOS)
Segment No. Segment name Content Option
1 MSH Message header R
2 MSA Message acknowledgment R
3 ERR Error O
4 QAK Query acknowledgment R
5 QPD Query parameter definition segment R
6 SPM Specimen R
7 OBR Observations request R
8 OBX Observation related to OBR R

3.9. Segment Component


The segment attribute table is described on the beginning of the explanation for each
segment. The summary is shown as below.
Column Content
SEQ This is the filed serial number continuing to the Segment ID.
The number in “()” means SEQ.
LEN The maximum length of the field
DT The data type of the field
10
Communication Specifications

Omittable of not for the number in the field


Symbol Content
R Required
OPT RO Required depending on the operation method
RM Required depending on the message
O Option
N Not used
Omittable or not for the repeat of the field element
Symbol Content
RP#
Y Repetition omittable
N No repetition omittable
ITEM# The uniquely specified field number in all HL7 rules
ELEMENT The name of the field
NAME
Notes: Don’t insert a space if it is no data (null) in the field component or
subcomponent.

3.9.1. MSH - Message header segment


The MSH segment defines the intent, source, destination, and some specifics of the
syntax of a message.
SEQ LEN DT OPT RP# ITEM# ELEMENT NAME
1 1 ST R N 00001 Field separator
2 4 ST R N 00002 Encoding characters
3 227 HD R N 00003 Sending application
4 227 HD N N 00004 Sending facility
5 227 HD R N 00005 Receiving application
6 227 HD N N 00006 Receiving facility
7 26 TS R N 00007 Date/Time of message
8 40 ST N N 00008 Security
9 15 MSG R N 00009 Message type
10 20 ST R N 00010 Message control ID
11 3 PT N N 00011 Processing ID
12 60 VID R N 00012 Version ID
13 15 NM N N 00013 Sequence number
14 180 ST N N 00014 Continuation pointer
15 2 ID N N 00015 Accept acknowledgment type
16 2 ID N N 00016 Application acknowledgment type
17 3 ID N N 00017 Country code
18 16 ID O N 00692 Character set
19 250 CWE N N 00693 Principal language of message
Alternate character set handing
20 20 ID N N 01317
scheme
21 427 EI N N 01598 Message profile identifier
(1) Field separator
Definition: This field contains the separator between the segment ID and the first
real field, Encoding characters.

11
V1.4.2

Implementation: Fixed "|"


(2) Encoding characters
Definition: This field contains the four characters in the following order: the
component separator, repetition separator, escape characters, and
subcomponent separator.
Implementation: Fixed "^~¥&",. The "¥" is a character code “5C(hex)”.
(3) Sending application
Components: <Namespace ID(IS)>^<Universal ID(ST)>^<Universal ID type(ID)>
Definition: This field is used to identify the sending application.
Implementation: Only uses the Universal ID. The default IDs are the followings
and they are changeable.
Application Universal ID
In BiOLiS BiOLiS30i
In LIS Laboratory Information System
The Namespace ID and the Universal ID Type are ignored.
Therefore, "^BiOLiS30i" and "^BiOLiS30i^"are identical.
(4) Sending facility
Components: <Namespace ID(IS)>^<Universal ID(ST)>^<Universal ID type(ID)>
Definition: This field is used to identify the sending facility and corresponds to the
facility code of the sending source or abbreviations.
Implementation: Not used
(5) Receiving application
Components: <Namespace ID(IS)>^<Universal ID(ST)>^<Universal ID type(ID)>
Definition: This field is used to identify the receiving application.
Implementation: Refer to the (3) Sending application.
(6) Receiving facility
Components: <Namespace ID(IS)>^<Universal ID(ST)>^<Universal ID type(ID)>
Definition: This field identifies the receiving facility and corresponds to the facility
code of the receiving facility or abbreviations.
Implementation: Not used
(7) Date/Time of message
Components: <Time(DTM)>^<DEPRECATED-Degree of precision(ID)>
Definition: This field contains the date/time that the sending system created the
message. If the time zone is specified, it will be used throughout the
message as the default time zone.
Implementation: Only uses Time(DTM). Fixes “YYYYMMDD” as a format.
(8) Security
Definition: This usage is not decided.
Implementation: Not used
(9) Message type
Components: <Message type(ID)>^<Trigger event(ID)>^<Message structure(ID)>
Definition: The first component is the message type listed in HL7 Table 0076 –
Message Type. The second component is the trigger event code listed in HL7
Table 0003 – Event Type. The third component is the message structure
listed in HL7 Table 0354 – Message Structure. The receiving system uses
this field and knows the data segment to be recognized and knows the
application to be transferred.

12
Communication Specifications

Implementation: The following table is excerpted from the HL7 Table 0076, 0003,
0354 about only the messages being used in this specifications.
Message type Message
OML^o35^OML_o35 Clinical test order
ORL^o36^ORL_o36 Response to the clinical test order
OUL^R23^OUL_R23 Clinical test result
ACK^R23^ACK Response to the clinical test result
ADT^A08^ADT_A01 Patient information notification
ACK^A08^ACK Response to the patient information notification
QBP^ZB5^QBP_Q11 Test result information referral (patient basis)
RSP^ZB6^RSP_ZB6 Response to the test result information referral
(patient basis)
QBP^ZB7^QBP_Q11 Test result information referral (sample basis)
RSP^ZB8^RSP_ZB8 Response to the test result information referral
(sample basis)
QBP^WOS^QBP_Q11 Test order information referral
RSP^WOS^RSP_K11 Response to the test order information referral
(10) Message control ID
Definition: This field contains a number or other identifier that uniquely identifies
the message.
Implementation: YYYYMMDDHHMMSS[FFF] or use a unique number as needed.
(11) Processing ID
Components: <Processing ID(ID)>^<Processing Mode(ID)>
Definition: This field is used to decide whether to process the message.
Implementation: Not used
(12) Version ID
Components: <Version ID(ID)>^<Internationalization
Code(CWE)>^<International Version ID(CWE)>
Definition: This field identifies the version ID and ensure that the message will be
interpreted correctly. The version ID of this rule is designated with 2.5.
Implementation: Only uses Version ID. Fixes “2.5”.
(13) Sequence number
Definition: A non null value in this field implies that the sequence number protocol
is in use. This numeric field is incremented by one for each subsequent
value.
Implementation: Not used
(14) Continuation pointer
Definition: This field is used to define continuations in application-specific ways.
Implementation: Not used
(15) Accept acknowledgment type
Definition: This field identifies the conditions under which accept
acknowledgments are required to be returned in response to this message.
Required for enhanced acknowledgment mode.
Implementation: Not used
(16) Application acknowledgment type
Definition: This field identifies the conditions under which accept
acknowledgments are required to be returned in response to this message.
13
V1.4.2

Required for enhanced acknowledgment mode.


Implementation: Not used
(17) Country code
Definition: This field contains the country of origin for the message. It will be used
primarily to specify default elements, such as currency denominations. The
values to be used are those of ISO 3166.
Implementation: Not used
(18) Character set
Definition: This field contains the character set for the entire message. Refer to
HL7 Table 0211 - Alternate character sets for valid values. The character
set may be left blank, or may contain one or more values delimited by the
repetition separator. If the field is left blank, the character set in use is
understood to be the 7-bit ASCII set, decimal 0 through decimal 127 (hex 00
through hex 7F). This default value may also be explicitly specified as
ASCII.
Implementation: The valid values in use are shown in bellow table. The
“big-endian” is used and the “little-endian” is Not used.
Character set Escape sequence Content
The printable 7-bit ASCII character set.
ASCII ¥C2842¥
(This is the default if this field is omitted)
The printable characters from the ISO
8859/1 ¥C2D41¥
8859/1 Character set
The printable characters from the ISO
8859/2 ¥C2D42¥
8859/2 Character set
The printable characters from the ISO
8859/3 ¥C2D43¥
8859/3 Character set
The printable characters from the ISO
8859/4 ¥C2D44¥
8859/4 Character set
The printable characters from the ISO
8859/5 ¥C2D4C¥
8859/5 Character set
The printable characters from the ISO
8859/6 ¥C2D47¥
8859/6 Character set
The printable characters from the ISO
8859/7 ¥C2D46¥
8859/7 Character set
The printable characters from the ISO
8859/8 ¥C2D48¥
8859/8 Character set
The printable characters from the ISO
8859/9 ¥C2D4D¥
8859/9 Character set
UCS Transformation Format, 8-bit form.
UTF-8 is a variable-length encoding, each
code value is represented by 1, 2 or 3
UNICODE
¥MEFBBBF¥ bytes, depending on the code value. 7 bit
UTF-8
ASCII is a proper subset of UTF-8. Note
that the code contains a space before UTF
but not before and after the hyphen.
*The Escape sequence of UTF-8 is defined by our company.

14
Communication Specifications

(19) Principal language of message


Components: <Identifier(ST)>^<Text(ST)>^<Name of coding
system(ID)>^<Alternate identifier(ST)>^<Alternate text(ST)>^<Name of
alternate coding system(ID)>^<Coding system version ID(ST)>^<Alternate
coding system version ID(ST)>^<Original test(ST)>
Definition: This field contains the principal language of the message. Codes come
from ISO 639.
Implementation: Not used
(20) Alternate character set handling scheme
Definition: When any alternative character sets are used (as specified in the
second or later iterations of MSH-18 character sets), and if any special
handling scheme is needed, this component is to specify the scheme used,
according to HL7 Table 0356- Alternate character set handling scheme.
Implementation: Not used
(21) Message profile identifier
Components: <Entity identifier(ST)>^<Namespace ID(IS)>^<Universal
ID(ST)>^<Universal ID type(ID)>
Definition: Sites may use this field to assert adherence to, or reference, a message
profile. Message profiles contain detailed explanations of grammar, syntax,
and usage for a particular message or set of messages. See HL7 section 2.12,
"Conformance Using Message Profiles".
Implementation: Not used

15
V1.4.2

3.9.2. PID - Patient identification segment


The PID segment is used by all applications as the primary means of communicating
patient identification information. This segment contains permanent patient
identifying and demographic information that, for the most part, is not likely to change
frequently.
In the BiOLiS, when PID Segment is sent to the LIS, the patient ID is provided in
the Patient identifier list. The other information is Not provided.
SEQ LEN DT OPT RP# ITEM# ELEMENT NAME
1 4 SI N N 00104 Set ID - Patient ID
2 20 CX N N 00105 Patient ID
3 250 CX O N 00106 Patient identifier list
4 20 CX N N 00107 Alternate patient ID
5 250 XPN O N 00108 Patient name
6 250 XPN N N 00109 Mother's maiden name
7 26 TS O N 00110 Date/Time of birth
8 1 IS O N 00111 Administrative sex
9 250 XPN N N 00112 Patient alias
10 250 CWE N N 00113 Race
11 250 XAD N N 00114 Patient address
12 4 IS N N 00115 Country code
13 250 XTN N N 00116 Phone number - Home
14 250 XTN N N 00117 Phone number - Business
15 250 CWE N N 00118 Primary language
16 250 CWE N N 00119 Marital status
17 250 CWE N N 00120 Religion
18 250 CX N N 00121 Patient account number
19 16 ST N N 00122 SSN number
20 25 DLN N N 00123 Driver's license number
21 250 CX N N 00124 Mother's identifier
22 250 CWE N N 00125 Ethnic group
23 250 ST N N 00126 Birth place
24 1 ID N N 00127 Multiple birth indicator
25 2 NM N N 00128 Birth order
26 250 CWE N N 00129 Citizenship
27 250 CWE N N 00130 Veterans military status
28 250 CWE N N 00739 Nationality
29 26 TS N N 00740 Patient death date and time
30 1 ID N N 00741 Patient death indicator
31 1 ID N N 01535 Identity unknown indicator
32 20 IS N N 01536 Identity reliability code
33 26 TS N N 01537 Last update date/time
34 241 HD N N 01538 Last update facility
35 250 CWE N N 01539 Species code
36 250 CWE N N 01540 Breed code
37 80 ST N N 01541 Strain
38 250 CWE N N 01542 Production class code

16
Communication Specifications

39 250 CWE N N 01840 Tribal citizenship

(1) Set ID - Patient ID


Definition: The set ID field is used to identify the repetition about the message
being allowed for the segment repetition. For example, the transaction for
exchange and referral can have many PID segment, such as ID value 1, 2, 3.
Implementation: Not used. Don’t allow the repetition of this segment in the same
message.
(2) Patient ID
Definition: This field has been retained for backward compatibility only. The term
of “external ID” was in the old version.
Implementation: Not used
(3) Patient identifier list
Components: <ID number(ST)>^<Check digit(ST)>^<Check digit
scheme(ID)>^<Assigning authority(HD)>^<Identifier type
code(ID)>^<assigning facility(HD)>^<Effective date(DT)>^<Expiration
date(DT)>^<Assigning jurisdiction(CWE)>^<Assigning agency or
department(CWE)>
Definition: This field contains the list of identifiers (one or more) used by the
healthcare facility to uniquely identify a patient (e.g., medical record
number, billing number, birth registry, national unique individual identifier,
etc.).
Implementation: Only uses the <ID number(ST)>. The ID number should be
within 15 characters. Other field components are ignored.
(4) Alternate patient ID
Definition: This field has been retained for backward compatibility only.
Implementation: Not used
(5) Patient name
Components: <Family name(FN)>^<Given name(ST)>^<Second and further given
names or initials
thereof(ST)>^<Suffix(ST)>^<Prefix(ST)>^<Degree(IS)>^<Name type
code(ID)>^<Name representation code(ID)>^<Name
context(CWE)>^<Name validity range(DR)>^<Name assembly
order(ID)>^<Effective date(TS)>^<Expiration date(TS)>^<Professional
suffix(ST)>
Definition: This field contains the names of the patient, the primary or legal name
of the patient is reported first. Refer to HL7 Table 0200 - Name Type, HL7
Table 0465 – Name Representation code for valid values. Repetition of this
field is allowed for representing the same name in different character sets.
Implementation: Only the <Family name(FN)> and <Given name(ST)> are used.
The other field components are ignored. Only subcomponent
<Surname(ST)> in <Family name(FN)> is used. The <Family name(FN)>
and <Given name(ST)> should be within 29 characters in total. Only one
patient name is processed. The patient name is provided with the character
code designated in the Character set of MSH.
Furthermore, the display in the BiOLiS is the order of '[Given name]
[Family name]'. In case of Emma Brown, send [Given name]='Emma'

17
V1.4.2

[Family name]='Brown'. However, you should chose them appropriately,


considering the local culture.
(6) Mother's maiden name
Definition: This field contains the family name under which the mother was born
(i.e., before marriage). It is used to distinguish between patients with the
same last name.
Implementation: Not used
(7) Date/Time of birth
Definition: A patient’s date of birth is provided. In case of a newborn infant, a time
of birth can be provided. A patient’s age “nnnu” after a date of birth can be
provided. The “Y” age, “L” age of the moon, “W” age in weeks, “D” age in
days are used for the age unit “u”. If this is omitted, the “Y” age is used
(YYYYMMDDHHMMSS^nnnu). For example, 7 years old, born on March 1
in 1990 is “19900301^7”. 10 years old is “^10” and 5 days is “^5D”.
Implementation: The format is “YYYYMMDD[HHMMSS]”. Age is not used but
this is calculated from date of birth. The “HHMMSS” can be omittable but
“00:00:00” is used.
(8) Administrative sex
Definition: This field contains the patient’s sex.
Implementation: As shown below table.
Administrative sex Content
F Female
M Male
U Unknown
(9) Patient alias
Definition: This field has been retained for backward compatibility only.
Implementation: Not used
(10) Race
Definition: This field can be used if you obtain patient’s consent.
Implementation: Not used
(11) Patient address
Components: <Street address(SAD)>^<Other designation(ST)>^<City(ST)>^<Zip
or postal code(ST)>^<Country(ID)>^<Address type(ID)>^<Other
geographic designation(ST)>^<Country/Parish code(IS)>^<Census
tract(IS)>^<Address representation code(ID)>^<Address validity
range(DR)>^<Effective date(TS)>^<Expiration date(TS)>
Definition: This field contains the mailing address of the patient.
Implementation: Not used
(12) County code
Definition: This field has been retained for backward compatibility. This field
contains the patient’s county code.
Implementation: Not used
(13) Phone number - Home
Definition: This field contains the patient’s personal phone numbers. All personal
phone numbers for the patient are sent in the following sequence. The first
sequence is considered the primary number (for back-ward compatibility). If
the primary number is not sent, then a repeat delimiter is sent in the first

18
Communication Specifications

sequence. Refer to HL7 Table 0201 - Telecommunication Use Code and HL7
Table 0202 - Telecommunication Equipment Type for valid values.
Implementation: Not used
(14) Phone number - Business
Definition: This field contains the patient’s business telephone numbers. All
business numbers for the patient are sent in the following sequence. The
first sequence is considered the patient’s primary business phone number
(for backward compatibility). If the primary business phone number is not
sent, then a re-peat delimiter must be sent in the first sequence. Refer to
HL7 Table 0201 - Telecommunication Use Code and HL7 Table 0202 -
Telecommunication Equipment Type for valid values.
Implementation: Not used
(15) Primary language
Definition: This field contains the patient’s primary language. HL7 recommends
using ISO table 639 as the suggested values in User-defined Table 0296 -
Primary Language.
Implementation: Not used
(16) Marital status
Definition: This field contains the patient’s marital (civil) status. Refer to
User-defined Table 0002 - Marital Status for suggested values.
Implementation: Not used
(17) Religion
Definition: This field contains the patient’s religion. Refer to User-defined Table
0006 - Religion for suggested values.
Implementation: Not used
(18) Patient account number
Definition: This field contains the patient account number assigned by accounting
to which all charges, payments, etc., are recorded. It is used to identify the
patient’s account.
Implementation: Not used
(19) SSN number
Definition: This field contains the patient’s social security number and has been
retained for backward compatibility only.
Implementation: Not used
(20) Driver's license number
Definition: This field contains the patient’s driver’s license number. This field has
been retained for backward compatibility only.
Implementation: Not used
(21) Mother's identifier
Definition: This field is used, for example, as a link field for newborns. Typically a
patient ID or account number may be used.
Implementation: Not used
(22) Ethnic group
Definition: This field further defines the patient’s ancestry.
Implementation: Not used
(23) Birth place
Definition: This field indicates the location of the patient’s birth.

19
V1.4.2

Implementation: Not used


(24) Multiple birth indicator
Definition: This field indicates whether the patient was part of a multiple birth.
Refer to HL7 Table 0136 - Yes/No Indicator for valid values.
Implementation: Not used
(25) Birth order
Definition: When a patient was part of a multiple birth, a value (number)
indicating the patient’s birth or-der is entered in this field.
Implementation: Not used
(26) Citizenship
Definition: This field contains the information related to a person's country
citizenship. For country citizenship HL7 recommends using ISO table 3166.
For a local definition, User-defined Table 0171 - Citizenship should be used.
Implementation: Not used
(27) Veterans military status
Definition: Unknown
Implementation: Not used
(28) Nationality
Definition: Nationality. This field has been retained for backward compatibility
only.
Implementation: Not used
(29) Patient death date and time
Definition: This field contains the date and time at which the patient death
occurred.
Implementation: Not used
(30) Patient death indicator
Definition: This field indicates whether the patient is deceased. Refer to HL7 Table
0136 - Yes/no Indicator for valid values.
Implementation: Not used
(31) Identity unknown indicator
Definition: This field indicates whether or not the patient’s/person’s identity is
known. Refer to HL7 Table 0136 - Yes/no Indicator for valid values.
Implementation: Not used
(32) Identity reliability code
Definition: This field contains a coded value used to communicate information
regarding the reliability of patient/person identifying data transmitted via a
transaction. Values could indicate that certain fields on a PID segment for a
given patient/person are known to be false (e.g., use of default or
system-generated values for Date of Birth or Social Security Number. Refer
to User-defined Table 0445 - Identity Reliability Code for suggested values.
Implementation: Not used
(33) Last update date/time
Definition: This field contains the last update date and time for the
patient’s/person’s identifying and demographic data, as defined in the PID
segment. Receiving systems will use this field to determine how to apply the
transaction to their systems. If the receiving system (such as an enterprise
master patient index) already has a record for the person with a later last

20
Communication Specifications

update date/time, then the EMPI could decide not to apply the
patient’s/person’s demo-graphic and identifying data from this transaction.
Implementation: Not used
(34) Last update facility
Definition: This field identifies the facility of the last update to a patient’s/person’s
identifying and demographic data, as defined in the PID segment. Receiving
systems or users will use this field to determine how to apply the
transaction to their systems. If the receiving system (such as a hospital’s
patient management system) already has a record for the patient/person,
then it may decide to only update its data if the source is a “trusted” source.
A hospital might consider other hospitals trusted sources, but not “trust”
updates from non-acute care facilities.
Implementation: Not used
(35) Species code
Definition: The species of living organism. This may include the common or
scientific name, based on the coding system(s) used. SNOMED is the
recommended coding system. If this field is not valued, a human is assumed.
Refer to User-defined Table 0446 - Species Code for suggested values.
Implementation: Not used
(36) Breed code
Definition: The specific breed of animal. This field, unlike Species and Strain is
specific to animals and cannot be generally used for all living organisms.
SNOMED is the recommended coding system. Refer to User-defined Table
0447 - Breed Code for suggested values.
Implementation: Not used
(37) Strain
Definition: This field contains the specific strain of animal. It can also be expanded
to include strain of any living organism and is not restricted to animals.
Implementation: Not used
(38) Production class code
Definition: This field contains the code and/or text indicating the primary use for
which the living subject was bred or grown. Refer to User-defined Table
0429 - Production Class Code for suggested values. For example:
Implementation: Not used
(39) Tribal citizenship
Definition: This field contains the information related to a person's tribal
citizenship.
Implementation: Not used

21
V1.4.2

3.9.3. SPM - Specimen segment


The intent of this segment is to describe the characteristics of a specimen. It differs
from the intent of the OBR in that the OBR addresses order-specific information. It
differs from the SAC segment in that the SAC addresses specimen container attributes.
An advantage afforded by a separate specimen segment is that it generalizes the
multiple relationships among order(s), results, specimen(s) and specimen container(s).
This segment only uses HL7, (4)Specimen type.
SEQ LEN DT OPT RP# ITEM# ELEMENT NAME
1 4 SI N N 01754 Set ID – SPM
2 80 EIP N N 01755 Specimen ID
3 80 EIP N N 01756 Specimen parent IDs
4 250 CWE R N 01900 Specimen type
5 250 CWE N N 01757 Specimen type modifier
6 250 CWE N N 01758 Specimen additives
7 250 CWE N N 01759 Specimen collection method
8 250 CWE N N 01901 Specimen source site
9 250 CWE N N 01760 Specimen source site modifier
10 250 CWE N N 01761 Specimen collection site
11 250 CWE N N 01762 Specimen role
12 20 CQ N N 01902 Specimen collection amount
13 6 NM N N 01763 Grouped specimen count
14 250 ST N N 01764 Specimen description
15 250 CWE N N 01908 Specimen handling code
16 250 CWE N N 01903 Specimen risk code
17 26 DR N N 01765 Specimen collection date/time
18 26 TS N N 00248 Specimen received date/time
19 26 TS N N 01904 Specimen expiration date/time
20 1 ID N N 01766 Specimen availability
21 250 CWE N N 01767 Specimen reject reason
22 250 CWE N N 01768 Specimen quality
23 250 CWE N N 01769 Specimen appropriateness
24 250 CWE N N 01770 Specimen condition
25 20 CQ N N 01771 Specimen current quantity
26 4 NM N N 01772 Number of specimen containers
27 250 CWE N N 01773 Container type
28 250 CWE N N 01774 Container condition
29 250 CWE N N 01775 Specimen child role
(1) Set ID - SPM
Definition: This field contains the sequence number. This field is used to identify
SPM segment instances in message structures where the SPM segment
repeats.
Implementation: Not used. Dose not allow this segment in the same message.
(2) Specimen ID
Components: Placer assigned identifier(EI)>^<Filler assigned identifier(EI)>
Definition: This field contains a unique identifier for the specimen as referenced by
the Placer application, the Filler application, or both.

22
Communication Specifications

Implementation: Not used


(3) Specimen parent IDs
Components: Placer assigned identifier(EI)>^<Filler assigned identifier(EI)>
Definition: This field contains the identifiers for the specimen or specimens that
contributed to the specimen that is described by the segment instance.
Implementation: Not used
(4) Specimen type
Components: Identifier(ST)>^<Text(ST)>^<Name of coding
system(ID)>^<Alternate identifier(ST)>^<Alternate text(ST)>^<Name of
alternate coding system(ID)>^<Coding system version ID(ST)>^<Alternate
coding system version ID(ST)>^<Original text(ST)>
Definition: This field describes the precise nature of the entity that will be the
source material for the observation. Any physical entity that may have
observations made about it may qualify as a specimen. The entry in this
attribute describes the specific entity as precisely as possible, whether that
is a complex organism (e.g., an ostrich) or a specific cellular mass (e.g., a
specific muscle biopsy).
A nationally recognized coding system is to be used for this field. Valid
coding sources for this field include:
•HL7 table 0487 – Specimen Type (replaces HL7 table 0070 – Specimen
source codes)
• SNOMED, etc.
• Veterinary medicine may choose the tables supported for the components
of this field as decided by their industry.
Implementation: Excerpts from HL7 Table 0487 and describes as below table.
Value Content
SER Serum
UR Urine
PLAS Plasma
CSF Cerebral spinal fluid
DIAF Dialysis fluid
ORH Other
BLD Whole blood
BLCL Blood cell
*The BLCL is our extension. Note that the sample is aspirated from the bottom
of the container when the BLCL is designated and HbA1c is ordered.
(5) Specimen type modifier
Components: Identifier(ST)>^<Text(ST)>^<Name of coding
system(ID)>^<Alternate identifier(ST)>^<Alternate text(ST)>^<Name of
alternate coding system(ID)>^<Coding system version ID(ST)>^<Alternate
coding system version ID(ST>^<Original text(ST)>
Definition: This field contains modifying or qualifying description(s) about the
specimen type.
The use of this attribute is to modify, qualify or further specify, the entity
described by SPM-4 -Specimen Type. This is particularly useful when the
code set used in SPM-4-Specimen Type does not provide the precision
required to fully describe the specimen. For example, if the specimen was
23
V1.4.2

precisely described as ‘capillary venous blood’ but the code set employed
only provided ‘venous blood,’ this attribute could be employed to add the
modifier ‘capillary.’
Refer to User-Defined Table 0541 Specimen Type Modifier for suggested
values.
Implementation: Not used
(6) Specimen additives
Components: Identifier(ST)>^<Text(ST)>^<Name of coding
system(ID)>^<Alternate identifier(ST)>^<Alternate text(ST)>^<Name of
alternate coding system(ID)>^<Coding system version ID(ST)>^<Alternate
coding system version ID(ST>^<Original text(ST)>
Definition: This field identifies any additives introduced to the specimen before or
at the time of collection. These additives may be introduced in order to
preserve, maintain or enhance the particular nature or component of the
specimen. Refer to HL7 Table 0371 – Additive for valid values.
Implementation: Not used
(7) Specimen collection method
Components: Identifier(ST)>^<Text(ST)>^<Name of coding
system(ID)>^<Alternate identifier(ST)>^<Alternate text(ST)>^<Name of
alternate coding system(ID)>^<Coding system version ID(ST)>^<Alternate
coding system version ID(ST)>^<Original text(ST)>
Definition: Describes the procedure or process by which the specimen was collected.
Any nationally recognized coding system might be used for this field
including SNOMED; alternatively the HL7 defined table 0488 may be used.
Veterinary medicine may choose the tables supported for the components of
this field as decided by their industry.
Implementation: Not used
(8) Specimen source site
Components: Identifier(ST)>^<Text(ST)>^<Name of coding
system(ID)>^<Alternate identifier(ST)>^<Alternate text(ST)>^<Name of
alternate coding system(ID)>^<Coding system version ID(ST)>^<Alternate
coding system version ID(ST)>^<Original text(ST)>
Definition: specifies the source from which the specimen was obtained. For
example, in the case where a liver biopsy is obtained via a percutaneous
needle, the source would be ‘liver.’
Any nationally recognized coding system might be used for this field
including SNOMED; alternatively the HL7 defined table 0070 may be used.
Veterinary medicine may choose the tables supported for the components of
this field as decided by their industry.
Implementation: Not used
(9) Specimen source site modifier
Components: Identifier(ST)>^<Text(ST)>^<Name of coding
system(ID)>^<Alternate identifier(ST)>^<Alternate text(ST)>^<Name of
alternate coding system(ID)>^<Coding system version ID(ST)>^<Alternate
coding system version ID(ST)>^<Original text(ST)>
Definition: This field contains modifying or qualifying description(s) about the
specimen source site.

24
Communication Specifications

The use of this attribute is to modify, qualify or further specify, the entity
described by SPM-8 – Specimen Source Site. This is particularly useful
when the code set used in SPM-8 does not provide the precision required to
fully describe the site from which the specimen originated. For example, if
the specimen source site was precisely described as ‘left radial vein’ but the
code set employed only provided ‘radial vein,’ this attribute could be
employed to add the modifier ‘left.’
Veterinary medicine may choose the tables supported for the components of
this field as decided by their industry. Refer to User-Defined Table 0542 –
Specimen Source Type Modifier for suggested values.
Implementation: Not used
(10) Specimen collection site
Components: Identifier(ST)>^<Text(ST)>^<Name of coding
system(ID)>^<Alternate identifier(ST)>^<Alternate text(ST)>^<Name of
alternate coding system(ID)>^<Coding system version ID(ST)>^<Alternate
coding system version ID(ST>^<Original text(ST)>
Definition: This field differs from SPM-8-Specimen Source Site in those cases
where the source site must be approached via a particular site (e.g.,
anatomic location). For example, in the case where a liver biopsy is obtained
via a percutaneous needle, the collection site would be the point of entry of
the needle. For venous blood collected from the left radial vein, the
collection site could be “antecubital fossa”.
Veterinary medicine may choose the tables supported for the components of
this field as decided by their industry.
Refer to User-Defined Table 0543 – Specimen Collection Site for suggested
values.
Implementation: Not used
(11) Specimen role
Components: Identifier(ST)>^<Text(ST)>^<Name of coding
system(ID)>^<Alternate identifier(ST)>^<Alternate text(ST)>^<Name of
alternate coding system(ID)>^<Coding system version ID(ST)>^<Alternate
coding system version ID(ST)>^<Original text(ST)>
Definition: This field indicates the role of the sample. Refer to User-defined Table
0369 – Specimen role for suggested values. Each of these values is normally
identifiable by the systems and its components and can influence processing
and data management related to the specimen.
If this field is not populated, then the specimen described has no special, or
specific, role other than serving as the focus of the observation. Such
specimens include patient, environmental and other specimens that are
intended for analysis.
A grouped specimen consists of identical specimen types from multiple
individuals that do not have individual identifiers and upon which the same
services will be performed. If the specimen role value is “G” then the
Grouped Specimen Count (SPM-13) must be valued with the total number
of specimens contained in the group.
If the specimen role is “L”, the repetitions of Parent Specimen ID (SPM-4)
represent the individual parent specimens that contribute to the pooled

25
V1.4.2

specimen. Refer to User-defined Table 0369 – Specimen Role for suggested


values.
Implementation: Not used
(12) Specimen collection amount
Components: Quantity(NM)>^<Units(CWE)>
Definition: This field specifies the volume or mass of the collected specimen. For
laboratory tests, the collection volume is the volume of a specimen.
Specifically, units should be expressed in the ISO Standard unit
abbreviations (ISO 2955, 1977). This is a results-only field except when
the placer or a party has already drawn the specimen. (See Chapter 7 for
full details about units.)
Implementation: Not used
(13) Grouped specimen count
Definition: This field refers to the number of individual specimens of a particular
type represented by this instance of a specimen. The use of this field is
restricted to specimens upon which all specimen related attributes are
identical. This field would only be valued if the specimen role attribute has
the value “G”.
Implementation: Not used
(14) Specimen description
Definition: This is a text field that allows additional information specifically about
the specimen to be sent in the message.
Implementation: Not used
(15) Specimen handling code
Definition: This describes how the specimen and/or container need to be handled
from the time of collection through the initiation of testing. As this field is
not required, no assumptions can be made as to meaning when this field is
not populated. Refer to User-defined Table 0376 – Special Handling Code
for suggested values.
Implementation: Not used
(16) Specimen risk code
Components: Identifier(ST)>^<Text(ST)>^<Name of coding
system(ID)>^<Alternate identifier(ST)>^<Alternate text(ST)>^<Name of
alternate coding system(ID)>^<Coding system version ID(ST)>^<Alternate
coding system version ID(ST)>^<Original text(ST)>
Definition: This field contains any known or suspected specimen hazards, e.g.,
exceptionally infectious agent or blood from a hepatitis patient. Either code
and/or text may be absent. However, the code is always placed in the first
component position and any free text in the second component. Thus, a
component delimiter must precede free text without a code. Refer to
User-defined Table 0489 – Risk Codes for suggested entries.
Implementation: Not used
(17) Specimen collection date/time
Components: Range start date/time(TS)>^<Range end date/time(ST)>
Definition: The date and time when the specimen was acquired from the source.
The use of the Date Range data type allows for description of specimens
collected over a period of time, for example, 24-hour urine collection. For

26
Communication Specifications

specimens collected at a point in time, only the first component (start


date/time) will be populated.
Implementation: Not used
(18) Specimen received date/time
Components: Time(DTM)>^<DEPRECATED-degree of precision(ID)>
Definition: The specimen received date/time is the time that the specimen is
received at the diagnostic service. The actual time that is recorded is based
on how specimen receipt is managed and may correspond to the time the
sample is logged in. This is fundamentally different from SPM-17
Specimen Collection date/time.
Implementation: Not used
(19) Specimen expiration date/time
Components: Time(DTM)>^<DEPRECATED-degree of Precision(ID)>
Definition: This field is the date and time the specimen can no longer be used for
the purpose implied by the order. For example, in the Blood Banking
environment the specimen can no longer be used for pre-transfusion
compatibility testing. The specimen segment will include an
SPM-21-Specimen Reject Reason of 'EX' indicating 'Expired' for message
instances created after this date and time.
Implementation: Not used
(20) Specimen availability
Definition: This describes whether the specimen, as it exists, is currently available
to use in an analysis. Refer to HL7 Table 0136 Yes/No Indicator for valid
values.
Implementation: Not used
(21) Specimen reject reason
Components: Identifier(ST)>^<Text(ST)>^<Name of coding
system(ID)>^<Alternate identifier(ST)>^<Alternate text(ST)>^<Name of
alternate coding system(ID)>^<Coding system version ID(ST)>^<Alternate
coding system version ID(ST>^<Original text(ST)>
Definition: This describes one or more reasons the specimen is rejected for the
specified observation/result/analysis. Refer to HL7 Table 0490 – Specimen
Reject Reason for valid values.
Implementation: Not used
(22) Specimen quality
Components: Identifier(ST)>^<Text(ST)>^<Name of coding
system(ID)>^<Alternate identifier(ST)>^<Alternate text(ST)>^<Name of
alternate coding system(ID)>^<Coding system version ID(ST)>^<Alternate
coding system version ID(ST)>^<Original text(ST)>
Definition: The degree or grade of excellence of the specimen at receipt. The filler
populates this attribute. Refer to User-defined Table 0491 – Specimen
Quality for suggested entries.
Implementation: Not used
(23) Specimen appropriateness
Components: Identifier(ST)>^<Text(ST)>^<Name of coding
system(ID)>^<Alternate identifier(ST)>^<Alternate text(ST)>^<Name of
alternate coding system(ID)>^<Coding system version ID(ST)>^<Alternate

27
V1.4.2

coding system Version ID(ST>^<Original text(ST)>


Definition: The suitability of the specimen for the particular planned use as
determined by the filler. Refer to User-defined Table 0492 – Specimen
Appropriateness for suggested entries.
Implementation: Not used
(24) Specimen condition
Components: Identifier(ST)>^<Text(ST)>^<Name of coding
system(ID)>^<Alternate identifier(ST)>^<Alternate text(ST)>^<Name of
alternate coding system(ID)>^<Coding system version ID(ST)>^<Alternate
coding system version ID(ST)>^<Original text(ST)>
Definition: A mode or state of being that describes the nature of the specimen.
Refer to User-defined Table 0493 – Specimen Condition for suggested
entries.
Implementation: Not used
(25) Specimen current quantity
Components: Quantity(NM)>^<Units(CWE)>
Definition: This attributes contains the amount of specimen that currently exists
or is available for use in further testing.
Implementation: Not used
(26) Number of specimen containers
Definition: This field identifies the number of containers for a given sample. For
sample receipt verification purposes; may be different from the total
number of samples that accompany the order.
Implementation: Not used
(27) Container type
Components: Identifier(ST)>^<Text(ST)>^<Name of coding
system(ID)>^<Alternate identifier(ST)>^<Alternate text(ST)>^<Name of
alternate coding system(ID)>^<Coding system version ID(ST)>^<Alternate
coding system Version ID(ST>^<Original text(ST)>
Definition: The container in or on which a specimen is transported.
Implementation: Not used
(28) Container condition
Components: Identifier(ST)>^<Text(ST)>^<Name of coding
system(ID)>^<Alternate identifier(ST)>^<Alternate text(ST)>^<Name of
alternate coding system(ID)>^<Coding system version ID(ST)>^<Alternate
coding system version ID(ST)>^<Original text(ST)>
Definition: In chain of custody cases where specimens are moved from lab to lab,
the status of the container that the specimen is shipped in must be recorded
at each receipt. If the container is compromised in any way (seal broken,
container cracked or leaking, etc.) then this needs to be recorded for legal
reasons. Refer to User-defined Table 0544 – Container Condition for
suggested values.
Implementation: Not used
(29) Specimen child role
Components: Identifier(ST)>^<Text(ST)>^<Name of coding
system(ID)>^<Alternate identifier(ST)>^<Alternate text(ST)>^<Name of
alternate coding system(ID)>^<Coding system version ID(ST)>^<Alternate

28
Communication Specifications

coding system version ID(ST>^<Original text(ST)>


Definition: For child specimens, this field identifies the relationship between this
specimen and the parent specimen. If this field is populated, then
SPM-3-Specimen Parent ID must be populated. This field differs from
SPM-15-Specimen Role in that this field refers to the role of this specimen
relative to a parent role rather than the role of this specimen to the ordered
service.
Refer to HL7 Table 0494 – Specimen Child Role for valid values.
Implementation: Not used

29
V1.4.2

3.9.4. SAC - Specimen and container detail segment


The container detail segment is the data necessary to maintain the containers that
are being used throughout the Laboratory Automation System. The specimens in
many laboratories are transported and processed in containers (e.g., sample tubes).
When SPM and SAC are used in the same message, then the conceptually duplicate
attributes will be valued only in the SPM. This applies to SAC-6 (Specimen Source),
SAC-27 (Additives), and SAC-43 (Special Handling Considerations). (Note:
SPM-8(Specimen source site), SPM-6(Specimen additives), SPM-15(Specimen
handling code))
SEQ LEN DT OPT RP# ITEM# ELEMENT NAME
1 427 EI N N 01329 External accession identifier
2 427 EI N N 01330 Accession identifier
3 427 EI RO N 01331 Container identifier
4 427 EI N N 01332 Primary(parent) container identifier
5 427 EI N N 01333 Equipment container identifier
6 4436 SPS N N 00249 Specimen source
7 26 TS N N 01334 Registration date/time
8 705 CWE N N 01335 Container Status
9 705 CWE N N 01336 Carrier type
10 427 EI N N 01337 Carrier identifier
11 80 NA RO N 01338 Position in carrier
12 705 CWE N N 01339 Tray type
13 427 EI N N 01340 Tray identifier
14 80 NA N N 01341 Position in tray
15 405 CWE N N 01342 Location
16 20 NM N N 01343 Container height
17 20 NM N N 01344 Container diameter
18 20 NM N N 01345 Barrier delta
19 20 NM N N 01346 Bottom delta
20 705 CWE N N 01347 Container diameter/height/delta units
21 20 NM N N 00644 Container volume
22 20 NM N N 01349 Available volume
23 20 NM N N 01350 Initial specimen volume
24 705 CWE N N 01351 Volume units
25 705 CWE N N 01352 Separator type
26 705 CWE N N 01353 Cap type
27 705 CWE N N 00647 Additive
28 705 CWE N N 01355 Specimen component
29 36 SN N N 01356 Dilution factor
30 705 CWE N N 01357 Treatment
31 36 SN N N 01358 Temperature
32 20 NM N N 01359 Hemolysis index
33 705 CWE N N 01360 Hemolysis index units
34 20 NM N N 01361 Lipemia index
35 705 CWE N N 01362 Lipemia index units
36 20 NM N N 01363 Icterus index

30
Communication Specifications

37 705 CWE N N 01364 Icterus index units


38 20 NM N N 01365 Fibrin index
39 705 CWE N N 01366 Fibrin index units
40 705 CWE N N 01367 System induced contaminants
41 705 CWE N N 01368 Drug interference
42 705 CWE N N 01369 Artificial blood
43 705 CWE N N 01370 Special handling consideration
44 705 CWE N N 01371 Other environmental factors

(1) External accession identifier


Components: Entity identifier (ST)>^<Namespace ID (IS)>^<Universal ID
(ST)>^<Universal ID type (ID)>
Definition: This field identifies the laboratory accession (see section Glossary).
This identifier is assigned by the external laboratory information system.
Example: If laboratory A sends a specimen to laboratory B, then within
laboratory B this field contains accession identifier of lab A.
Implementation: Not used
(2) Accession identifier
Components: Entity identifier(ST)>^<Namespace ID(IS)>^<Universal
ID(ST)>^<Universal ID type(ID)>
Definition: This field identifies the laboratory accession. This identifier is assigned
by the information system of the laboratory performing the tests. An
accession identifier can refer to more than one container. A Container
Identifier is a Unique Identifier for that container.
Implementation: Not used
(3) Container identifier
Components: Entity identifier(ST)>^<Namespace ID(IS)>^<Universal
ID(ST)>^<Universal ID type(ID)>
Definition: This field identifies the container. This field is the container's unique
identifier assigned by the corresponding equipment. A container may
contain the primary (original) specimen or an aliquot (secondary sample) of
that specimen. For primary sample this field contains Primary Container
ID; for bar-coded aliquot samples this field contains Aliquot Container ID;
for non-bar-coded aliquot samples (e.g., microtiter plate) this field is empty.
The NCCLS standard requires a unique identifier for each container
introduced into the Laboratory Automation System. The combination of the
fields: Primary Container ID, Container ID, Carrier ID / Position, Tray ID /
Position must identify the container uniquely within the LAS. The
naturally best solution is unique machine-readable id attached to the
container (which of course is sufficient to ensure the uniqueness of the
fields' combination). A bar code that symbolizes this ID should meet the
proposed standard NCCLS AUTO2 (Laboratory Automation: Bar Codes for
Specimen Container Identification).
Implementation: The <Entity identifier(ST)> means the sample barcode. The
other components are not used.
BiOLiS Motion Mode Entity identifier
Sample barcode mode Required. Identifies samples with the value of
31
V1.4.2

Entity identifier.
Sample position mode Not used. However, in this mode, if the sample
is labeled with the barcode, the test result is
displayed in the clinical test result message.
(4) Primary (parent) container identifier
Components: <Entity identifier(ST)>^<Namespace ID(IS)>^<Universal
ID(ST)>^<Universal ID type(ID)>
Definition: If this field is filled in, it identifies the primary container from which
this specimen came. For primary samples this field is empty; for aliquot
samples this field should contain the identifier of primary container.
Implementation: Not used
(5) Equipment container identifier
Components: <Entity identifier(ST)>^<Namespace ID(IS)>^<Universal
ID(ST)>^<Universal ID type(ID)>
Definition: This field identifies the container in a particular device (e.g., one
container in a carousel or rack of containers within an analyzer, analyzer
specific bar code mapping, etc.).
Implementation: Not used
(6) Specimen source
Components: <Specimen source name or
code(CWE)>^<Additives(CWE)>^<Specimen collection
method(TX)>^<Body site(CWE)>^<Site modifier(CWE)>^<Collection
method modifier code(CWE)>^<Specimen role(CWE)>
Definition: This field is the site where the specimen should be obtained or where
the service should be performed. This field is deprecated and retained for
backward compatibility. This field is conditional, meaning that, in case
where the SPM segment is used in a message together with the SAC, this
field should be ignored. The reader is referred to the SPM Specimen
segment in chapter 7.
Implementation: Not used
In case that QC samples are measured by the order from the LIS,
(Sample barcode mode) Special barcodes are made and the LIS judges with
only them. The BiOLiS measures them as patient samples. Conduct QC in
the LIS because the QC in the BiOLiS cannot be used.
For example, Control X-Low=9999900001, Control X-High=9999900002.
(Sample Position Mode) Designates the positions of the containers with
Position in carrier as stated below.
(7) Registration date/time
Definition: This field is the date/time that the container was last registered with
the "automated system.", e.g., reading of a container bar code by a device.
Implementation: Not used
(8) Container Status
Components: <Identifier(ST)>^<Text(ST)>^<Name of coding
system(IS)>^<Alternate identifier(ST)>^<Alternate text(ST)>^<Name of
alternate coding system(IS)>
Definition: This field identifies the status of the unique container in which the
specimen resides at the time that the transaction was initiated. Refer to

32
Communication Specifications

HL7 Table 0370 - Container status for valid values. The equipment specific
container status should be sent as <alternate identifier> as needed. The
container states are relevant for the exchange of information among devices
(within the LAS). Not all of them are relevant for information transfer
between the LAS and the LIS.
Implementation: Not used
(9) Carrier type
Components: <Identifier(ST)>^<Text(ST)>^<Name of coding
system(IS)>^<Alternate identifier(ST)>^<Alternate text(ST)>^<Name of
alternate coding system(IS)>
Definition: This field identifies the type of the carrier (see section Glossary). Refer
to User-defined Table 0378 – Carrier type for suggested values. Because the
geometry can be different, the carrier type should, if possible, express the
number of positions in the carrier. The definition assumes hierarchical
nesting using the following phrases: container is located in a carrier, carrier
is located in a tray.
Implementation: Not used
(10) Carrier identifier
Components: <Entity identifier(ST)>^<Namespace ID(IS)>^<Universal
ID(ST)>^<Universal ID type(ID)>
Definition: This field identifies the carrier. It is the ID (e.g., number or bar code) of
the carrier where the container (e.g., tube) is located. Example: A carrier
could be a rack with single or multiple specimen containers. A carrier is
usually used for automated specimen transport. Multiple carriers can be
stacked in a tray, which is then used for manual or automatic transport.
Implementation: Not used
(11) Position in carrier
Definition: This field identifies the position of the container in the carrier (e.g.,
1…3…). The sub-components allow, if necessary, to transfer multiple axis
information, e.g., 2-dimensional carrier (X^Y).
Implementation: Required in [Sample position mode]. Not used in [Sample
barcode mode]. However, in case of the [Sample barcode mode], the
information is described in the clinical test result message.
A tray number is described in the first component and a position is
described in the second component.
First Content Second Content
Component Component
1-30 For patient sample
1-50 Patient sample tray
31-45 For QC sample
61-66 Calibration tray 31-45 For QC sample
81-83 QC tray 1-45 For QC sample
(12) Tray type
Components: <Identifier(ST)>^<Text(ST)>^<Name of coding
system(IS)>^<Alternate identifier(ST)>^<Alternate text(ST)>^<Name of
alternate coding system(IS)>
Definition: This field identifies the type of the tray (see section Glossary). Refer to
User-defined Table 0379 – Tray type for suggested values. Because the
33
V1.4.2

geometry can be different, the tray type should if possible express the
number of positions in the tray. The definition assumes hierarchical nesting
using the following phrases: container is located in a carrier, carrier is
located in a tray.
Implementation: Not used
(13) Tray identifier
Components: <Entity identifier(ST)>^<Namespace ID(IS)>^<Universal
ID(ST)>^<Universal ID type(ID)>
Definition: This field identifies the tray identifier (e.g., a number of a tray or a bar
code on the tray), where the container carrier is located.
Implementation: Not used
(14) Position in tray
Definition: This field identifies the position of the carrier in the tray. The
sub-components allow, if necessary, to transfer multiple axis information,
e.g., 2-dimensional tray (X^Y).
Implementation: Not used
(15) Location
Components: <Identifier(ST)>^<Text(ST)>^<Name of coding
system(IS)>^<Alternate identifier(ST)>^<Alternate text(ST)>^<Name of
alternate coding system(IS)>
Definition: This field is the physical location that the specimen was at the time
that the transaction was initiated. The location description can vary with
the LAS. For example, it can be an X,Y,Z coordinate in a storage system; a
refrigerator number and drawer number where the container-carrier-tray is
located; or it can be the name of the institution and the laboratory which
owns the container currently. The repeating of this field allows for
hierarchical representation of location (lowest level first), e.g., shelf number,
refrigerator storage id, lab name, institution name, etc.
Implementation: Not used
(16) Container height
Definition: This field identifies the height of the container in units specified below.
Implementation: Not used
(17) Container diameter
Definition: This field identifies the outside diameter of the container in units
specified below.
Implementation: Not used
(18) Barrier delta
Definition: This field identifies the distance from the Point of Reference to the
separator material (barrier) within the container in units specified below.
This distance may be provided by the LAS to the instrument and/or
specimen processing/handling device to facilitate the insertion of a sampling
probe into the specimen without touching the separator. Refer to Point Of
Reference definition in section Glossary or in NCCLS standard AUTO5
Laboratory Automation: Electromechanical Interfaces.
Implementation: Not used
(19) Bottom delta
Definition: This field identifies the distance from the Point of Reference to the

34
Communication Specifications

outside bottom of the container in units specified below. Refer to Point Of


Reference definition in section Glossary or in NCCLS standard AUTO5
Laboratory Automation: Electromechanical Interfaces.
Implementation: Not used
(20) Container diameter/height/delta units
Components: <Identifier(ST)>^<Text(ST)>^<Name of coding
system(IS)>^<Alternate identifier(ST)>^<Alternate text(ST)>^<Name of
alternate coding system(IS)>
Definition: This field is the unit identifier that is being used to describe the
diameter, height and deltas of the container. If the units are ISO+ units,
they should be recorded as single case abbreviations. If the units are ANS+
or L (local), the units and the source code table must be recorded, except
that in this case, component delimiters should be replaced by subcomponent
delimiters. The default unit is millimeters (mm), which should be assumed
if no units are reported.
Implementation: Not used
(21) Container volume
Definition: This field indicates the capacity of the container in the units specified
below.
Implementation: Not used
(22) Available volume
Definition: This field identifies the current specimen volume available for use in
this container.
Implementation: Not used
(23) Initial specimen volume
Definition: This field identifies the volume of the specimen initially filled in this
container.
Implementation: Not used
(24) Volume units
Components: <Identifier(ST)>^<Text(ST)>^<Name of coding
system(IS)>^<Alternate identifier(ST)>^<Alternate text(ST)>^<Name of
alternate coding system(IS)>
Definition: This field is the unit identifier that is being used to describe the volume
of the container. If the units are ISO+ units, they should be recorded as
single case abbreviations. The default unit is milliliters (ml), which should
be assumed if no units are reported.
Implementation: Not used
(25) Separator type
Components: <Identifier(ST)>^<Text(ST)>^<Name of coding
system(IS)>^<Alternate identifier(ST)>^<Alternate text(ST)>^<Name of
alternate coding system(IS)>
Definition: This field identifies the type of the separator that is being used (e.g.,
gel separator in the container – not to be confused with the communication
separators). Refer to User-defined Table 0380 – Separator type for
suggested values. It is recommended that the first table entry be "NO"
meaning "No Separator".
Implementation: Not used

35
V1.4.2

(26) Cap type


Components: <Identifier(ST)>^<Text(ST)>^<Name of coding
system(IS)>^<Alternate identifier(ST)>^<Alternate text(ST)>^<Name of
alternate coding system(IS)>
Definition: This field indicates the type of cap that is to be used with this container
for decapping, piercing or other mechanisms. Refer to User-defined Table
0381 – Cap type for suggested values.
Implementation: Not used
(27) Additive
Components: <Identifier(ST)>^<Text(ST)>^<Name of coding
system(IS)>^<Alternate identifier(ST)>^<Alternate text(ST)>^<Name of
alternate coding system(IS)>
Definition: This field identifies any additives introduced to the specimen before or
at the time of collection. These additives may be introduced in order to
preserve, maintain or enhance the particular nature or component of the
specimen. It is a repetitive field. Refer to HL7 Table 0371 – Additive for
valid values. The value set can be extended with user specific values.
Implementation: Not used
(28) Specimen component
Components: <Identifier(ST)>^<Text(ST)>^<Name of coding
system(IS)>^<Alternate identifier(ST)>^<Alternate text(ST)>^<Name of
alternate coding system(IS)>
Definition: This field identifies the specimen component, e.g., supernatant,
sediment, etc. Refer to User-defined Table 0372 – Specimen component for
valid values. This table's values are taken from NCCLS AUTO4. The value
set can be extended with user specific values.
Implementation: Not used
(29) Dilution factor
Components:
<Comparator(ST)>^<Num1(NM)>^<Separator/suffix(ST)>^<Num2(NM)>
Definition: This field identifies the factor of dilution already performed on the
specimen. The equipment entity that changes the dilution is responsible for
sending this information to other equipment. If the endogenous content of
the test (analyte) in the diluent is required for the calculation of the test
(analyte) concentration, then the test (analyte) specific values should be
exchanged between the systems via Master Files or other means.
Implementation: Not used
(30) Treatment
Components: <Identifier(ST)>^<Text(ST)>^<Name of coding
system(IS)>^<Alternate identifier(ST)>^<Alternate text(ST)>^<Name of
alternate coding system(IS)>
Definition: This field identifies the specimen treatment performed during lab
processing. Refer to User-defined Table 0373 – Treatment for valid values.
This table's values are taken from NCCLS AUTO4. The value set can be
extended with user specific values.
Implementation: Not used

36
Communication Specifications

(31) Temperature
Components:
<Comparator(ST)>^<num1(NM)>^<Separator/Suffix(ST)>^<Num2(NM)>
Definition: This field identifies the specimen temperature in degrees Celsius [°C]
at the time of the transaction specified in the EQU segment.
Implementation: Not used
(32) Hemolysis index
Definition: This field is the index identifier that is being used to describe the
Hemolysis Index of the specimen.
Implementation: Not used
(33) Hemolysis index units
Components: <Identifier(ST)>^<Text(ST)>^<Name of coding
system(IS)>^<Alternate identifier(ST)>^<Alternate text(ST)>^<Name of
alternate coding system(IS)>
Definition: This field is the unit's identifier that is being used to describe the
Hemolysis Index of the specimen. It is recommended to use g/L. (The
transmission of the index values is added here instead of the original use of
the OBX segments, because the frequency of the transfer of the specimen
details justifies use of more efficient mechanism.)
Implementation: Not used
(34) Lipemia index
Definition: This field is the index identifier that is being used to describe the
Lipemia Index of the specimen. It is recommended to use the optical
turbidity at 600 nm (in absorbance units).
Implementation: Not used
(35) Lipemia index units
Components: <Identifier(ST)>^<Text(ST)>^<Name of coding
system(IS)>^<Alternate identifier(ST)>^<Alternate text(ST)>^<Name of
alternate coding system(IS)>
Definition: This field is the unit's identifier that is being used to describe the
Lipemia Index of the specimen. If this field is null, the recommended value
is assumed.
Implementation: Not used
(36) Icterus index
Definition: This field is the index identifier that is being used to describe the
Icterus Index of the specimen.
Implementation: Not used
(37) Icterus index units
Components: <Identifier(ST)>^<Text(ST)>^<Name of coding
system(IS)>^<Alternate identifier(ST)>^<Alternate text(ST)>^<Name of
alternate coding system(IS)>
Definition: This field is the unit's identifier that is being used to describe the
Icterus Index of the specimen. It is recommended to use mMol/L of bilirubin.
Implementation: Not used
(38) Fibrin index
Definition: This field is the index identifier that is being used to describe the
Fibrin Index of the specimen. In the case of only differentiating between

37
V1.4.2

Absent and Present, we recommend using 0 and 1 respectively and send the
field Fibrin Index Units null.
Implementation: Not used
(39) Fibrin index units
Components: <Identifier(ST)>^<Text(ST)>^<Name of coding
system(IS)>^<Alternate identifier(ST)>^<Alternate text(ST)>^<Name of
alternate coding system(IS)>
Definition: This field is the unit's identifier that is being used to describe the
Fibrin Index of the specimen.
Implementation: Not used
(40) System induced contaminants
Components: <Identifier(ST)>^<Text(ST)>^<Name of coding
system(IS)>^<Alternate identifier(ST)>^<Alternate text(ST)>^<Name of
alternate coding system(IS)>
Definition: This field describes the specimen contaminant identifier that is
associated with the specimen in this container. Refer to User-defined Table
0374 – System induced contaminants for valid values. This table's values
are taken from NCCLS AUTO4. The value set can be extended with user
specific values.
Implementation: Not used
(41) Drug interference
Components: <Identifier(ST)>^<Text(ST)>^<Name of coding
system(IS)>^<Alternate identifier(ST)>^<Alternate text(ST)>^<Name of
alternate coding system(IS)>
Definition: This field describes the drug interference identifier that is associated
with the specimen. Refer to User-defined Table 0382 – Drug interference for
suggested values.
Implementation: Not used
(42) Artificial blood
Components: <Identifier(ST)>^<Text(ST)>^<Name of coding
system(IS)>^<Alternate identifier(ST)>^<Alternate text(ST)>^<Name of
alternate coding system(IS)>
Definition: This field describes the artificial blood identifier that is associated with
the specimen. Refer to User-defined Table 0375 – Artificial blood for valid
values. This table's values are taken from NCCLS AUTO4. The value set
can be extended with user specific values.
Implementation: Not used
(43) Special handling consideration
Components: <Identifier(ST)>^<Text(ST)>^<Name of coding
system(IS)>^<Alternate identifier(ST)>^<Alternate text(ST)>^<Name of
alternate coding system(IS)>
Definition: This field describes any special handling considerations that are
associated with the specimen in the specific container (e.g. centrifugation).
This describes how the specimen needs to be stored during collection, in
transit, and upon receipt. Refer to User-defined Table 0376 – Special
handling code for valid values. The value set can be extended with user
specific values.

38
Communication Specifications

Implementation: Not used


(44) Other environmental factors
Components: <Identifier(ST)>^<Text(ST)>^<Name of coding
system(IS)>^<Alternate identifier(ST)>^<Alternate text(ST)>^<Name of
alternate coding system(IS)>
Definition: This field describes other environmental factors that are associated
with the specimen in a specific container, e.g., atmospheric exposure. Refer
to User-defined Table 0377 – Other environmental factors for valid values.
This table's values are taken from NCCLS AUTO4. The value set can be
extended with user specific values.
Implementation: Not used

39
V1.4.2

3.9.5. OBR - Observation Request Segment


General (taken from ASTM E1238)
The Observation Request (OBR) segment is used to transmit information specific to
an order for a diagnostic study or observation, physical exam, or assessment.
The Observation Request segment defines the attributes of a particular request for
diagnostic services (e.g., laboratory, EKG) or clinical observations (e.g., vital signs or
physical exam). When a placer requests a given set of observations, always include an
order segment. For lab tests, the information in the order segment usually applies to a
single specimen. However, there is not a one-to-one relationship between specimen and
tests ordered. Different test batteries will usually require their own order segments
even when they can be performed on a single specimen. In this case, the specimen
information must be duplicated in each of the order segments that employ that
specimen. For other diagnostic studies, e.g., chest X-ray, a separate order segment will
usually be generated for each diagnostic study.
Though multiple observation batteries can be ordered on a single order segment, the
observation filler shall generate a separate order segment for each battery that it
processes independently, e.g., electrolyte, CBC, vital signs. When reporting the
observations, the filling service shall copy the appropriate order (specimen)
information from the original order segment into each of the new order segments so
that a separate "order" segment is returned to the placer as a "header" for each
separate battery of observations.
In the event that an ordered battery of observations cannot be performed, e.g.,
because of hemolysis on a blood sample, an order segment will be returned to the
placer with OBR-25-result status equal to X (to indicate that the study was not
performed). In this case, no observation segments will be transmitted.
When observations are successfully completed, the message returned to the placer
will include the order segment (OBR) followed by observation (OBX) segments for each
distinct observation generated by the order. The number of such observation segments
will depend upon the number of individual measurements performed in the process.
OBX segments can be sent by the placer along with an order to provide the filling
service with clinical data needed to interpret the results.

In the implementation of this specifications, all fields in the OBR segment in the
clinical test order message (OML-o35) are Not used. The OBR segment in the clinical
test result message (OUL-R23) and the referral message for clinical result information
(RSP-ZB6/RSP-ZB8) are used about SEQ20:Filler Field1 only.
Moreover, in this specifications, repetition of the OBR segment is Not allowed (one
time use in one message).
SEQ LEN DT OPT RP# ITEM# ELEMENT NAME
1 4 SI N N 00237 Set ID - Observation request
2 22 EI N N 00216 Placer order number
3 22 EI N N 00217 Filler order number
4 250 CWE N N 00238 Universal service ID
5 2 ID N N 00239 Priority
6 26 TS N N 00240 Requested date/time
7 26 TS N N 00241 Observation date/time
8 26 TS N N 00242 Observation end date/time

40
Communication Specifications

9 20 CQ N N 00243 Collection volume


10 250 XCN N N 00244 Collector identifier
11 1 ID N N 00245 Specimen action code
12 250 CWE N N 00246 Danger code
13 300 ST N N 00247 Relevant clinical code
14 26 TS N N 00248 Specimen received date/time
15 300 SPS N N 00249 Specimen source
16 250 XCN N N 00226 Ordering provider
17 250 XTN N N 00250 Order callback phone number
18 60 ST N N 00251 Placer field1
19 60 ST N N 00252 Placer field2
20 60 ST R N 00253 Filler field1
21 60 ST N N 00254 Filler field2
22 26 TS N N 00255 Results rpt/status change - date/time
23 40 MOC N N 00256 Charge to practice
24 10 ID N N 00257 Diagnostic serv sect ID
25 1 ID N N 00258 Result status
26 400 PRL N N 00259 Parent result
27 200 TQ N N 00221 Quality / Timing
28 250 XCN N N 00260 Result copies to
29 200 EIP N N 00261 Parent number
30 20 ID N N 00262 Transportation mode
31 250 CWE N N 00263 Reason for study
32 200 NDL N N 00264 Principal result interpreter
33 200 NDL N N 00265 Assistant result interpreter
34 200 NDL N N 00266 Technician
35 200 NDL N N 00267 Transcriptionist
36 26 TS N N 00268 Scheduled date/time
37 4 NM N N 01028 Number of sample containers
38 250 CWE N N 01029 Transport logistics of collected sample
39 250 CWE N N 01030 Collector's comment
40 250 CWE N N 01031 Transport arrangement responsibility
41 30 ID N N 01032 Transport arranged
42 1 ID N N 01033 Escort required
43 250 CWE N N 01034 Planned patient transport comment
44 250 CWE N N 00393 Procedure code
45 250 CWE N N 01316 Procedure code modifier
Placer supplemental service
46 250 CWE N N 01474
information
Filler supplemental service
47 250 CWE N N 01475
information
Medically necessary duplicate
48 250 CWE N N 01646
procedure reason
49 2 IS N N 01647 Result handling

41
V1.4.2

(1) Set ID - Observation request


Definition: The ID is allocated with serial number from 1 if this is a clinical test
order (ORM,OMG^O19,OML^O21) of order-dependent type (Option). The
ID is allocated with serial number from 1 under SPM if this is a specimen
test order (OML^O33,OML^O35) of sample-dependent type (Required).
Implementation: Not used
(2) Placer order number
Components: <Entity identifier(ST)>^<Namespace ID(IS)>^<Universal
ID(ST)>^<Universal ID type(ID)>
Definition: This field is identical to ORC-2-Placer Order Number such as a number
of a filling side. The first component is a string that identifies an individual
order (e.g., OBR). It identifies an order uniquely among all orders from a
particular ordering application. An application ID is connected to a special
application identically.
Implementation: Not used
(3) Filler order number
Components: <Entity identifier(ST)>^<Namespace ID(IS)>^<Universal
ID(ST)>^<Universal ID type(ID)>
Definition: This is a permanent identifier for an order and its associated
observations such as a sample number in LIS. The first component is a
string that identifies an individual order segment (e.g., OBR). It is assigned
by the order filling (receiving) application. It identifies an order uniquely
among all orders from a particular filling application (e.g., clinical
laboratory). ). The second component is a filling application ID. OBR-3-filler
order number is identical to ORC-3-filler order number.
Implementation: Not used
(4) Universal service ID
Components: <Identifier(ST)>^<Text(ST)>^<Name of coding
system(ID)>^<Alternate identifier(ST)>^<Alternate text(ST)>^<Name of
alternate coding system(ID)>^<Coding system version ID(ST)>^<Alternate
coding system version ID(ST)>^<Original text(ST)>
Definition: This field contains the identifier code for the requested
observation/test/battery. This can be based on local and/or "universal" codes.
We recommend the "universal" procedure identifier. The structure of this
CE data type is described in the control section.
Implementation: Not used
(5) Priority
Definition: This field has been retained for backward compatibility only.
Implementation: Not used
(6) Requested date/time
Components: <Time(DTM)>^<DEPRECATED-degree of precision(ID)>
Definition: This field has been retained for backward compatibility only.
Implementation: Not used
(7) Observation date/time
Components: <Time(DTM)>^<DEPRECATED-degree of precision(ID)>
Definition: This field is the clinically relevant date/time of the observation. In the
case of observations taken directly from a subject, it is the actual date and

42
Communication Specifications

time the observation was obtained. In the case of a specimen associated


study, this field shall represent the date and time the specimen was
collected or obtained. (This is a results-only field except when the placer or a
third party has already drawn the specimen.) This field is conditionally
required. If the SPM segment exists on the messages, this information is
described in the SPM segment.
Implementation: Not used
(8) Observation end date/time
Components: <Time(DTM)>^<DEPRECATED-degree of precision(ID)>
Definition: This field contains the end date and time of a study or timed specimen
collection. If an observation takes place over a substantial period of time, it
will indicate when the observation period ended. For observations made at a
point in time, it will be null. This is a results field except when the placer or
a party other than the filler has already drawn the specimen. If the SPM
segment exists on the messages, this information is described in the SPM
segment.
Implementation: Not used
(9) Collection volume
Components: <Quantity(NM)>^<Units(CWE)>
Definition: For laboratory tests, the collection volume is the volume of a specimen.
The default unit is ML. Specifically, units should be expressed in the ISO
Standard unit abbreviations (ISO 2955, 1977). This is a results-only field
except when the placer or a party has already drawn the specimen.
Implementation: Not used
(10) Collector identifier
Components: <ID number(ST)>^<Family Name(FN)>^<Given
name(ST)>^<Second and further given name or initials
thereof(ST)>^<Suffix(e.g.,JR or
Ⅲ)(ST)>^<Prefix(e.g.,DR)(ST)>^<Degree(e.g.,MD)(IS)>^<Source
table(IS)>^<Assigning authority(HD)>^<Name type code(ID)>^<Identifier
check digit(ST)>^<Check digit scheme(ID)>^<Identifier type
code(ID)>^<Assigning facility(HD)>^<Name representation
code(ID)>^<Name context(CWE)>^<Name validity range(DR)>^<Name
assembly order(ID)>^<Effective date(TS)>^<Expiration
date(TS)>^<Professional suffix(ST)>^<Assigning
jurisdiction(CWE>^<Assigning agency or department(CWE)>
Definition: When a specimen is required for the study, this field will identify the
person, department, or facility that collected the specimen. Either name or
ID code, or both, may be present.
Implementation: Not used
(11) Specimen action code
Definition: This field identifies the action to be taken with respect to the
specimens that accompany or precede this order. The purpose of this field is
to further qualify (when appropriate) the general action indicated by the
order control code contained in the accompanying ORC segment. For
example, when a new order (ORC - "NW") is sent to the lab, this field would
be used to tell the lab whether or not to collect the specimen ("L" or "O").

43
V1.4.2

Refer to HL7 Table 0065 - Specimen Action Code for valid values.
Implementation: Not used
(12) Danger code
Components: <Identifier(ST)>^<Text(ST)>^<Name of coding
system(ID)>^<Alternate identifier(ST)>^<Alternate text(ST)>^<Name of
alternate coding system(ID)>^<Coding system version ID(ST)>^<Alternate
coding system version ID(ST)>^<Original text(ST)>
Definition: This field contains the code and/or text indicating any known or
suspected patient or specimen hazards, e.g., patient with active tuberculosis
or blood from a hepatitis patient. Either code and/or text may be absent.
However, the code is always placed in the first component position and any
free text in the second component. Thus, free text without a code must be
preceded by a component delimiter.
Implementation: Not used
(13) Relevant clinical code
Definition: This field contains the additional clinical information about the patient
or specimen. This field is used to report the suspected diagnosis and clinical
findings on requests for interpreted diagnostic studies. Examples include
reporting the amount of inspired carbon dioxide for blood gasses, the point
in the menstrual cycle for cervical pap tests, and other conditions that
influence test interpretations. For some orders this information may be sent
on a more structured form as a series of OBX segments that immediately
follow the order segment.
Implementation: Not used
(14) Specimen received date/time
Components: <Time(DTM)>^<DEPRECATED-degree of precision(ID)>
Definition: This field has been retained for backward compatibility only. As of
version 2.5, in messages where the SPM segment is present, the use of
SPM-18 Specimen Received Date/Time is favored over this field.
Implementation: Not used
(15) Specimen source
Components: <Specimen source name or
code(CWE)>^<Additive(CWE)>^<Specimen collection method(TX)>^<Body
site(CWE)>^<Site modifier(CWE)^<Collection method modifier
code(CWE)>^<Specimen role(CWE)>
Definition: This field has been retained for backward compatibility only. As of
version 2.5, in messages where the SPM segment is present, the use of SPM
Specimen segment is favored over this field.
Implementation: Not used
(16) Ordering provider
Components: <ID number(ST)>^<Family Name(FN)>^<Given
name(ST)>^<Second and further given name or initials
thereof(ST)>^<Suffix(e.g.,JR or
Ⅲ)(ST)>^<Prefix(e.g.,DR)(ST)>^<Degree(e.g.,MD)(IS)>^<Source
table(IS)>^<Assigning authority(HD)>^<Name type code(ID)>^<Identifier
check digit(ST)>^<Check digit scheme(ID)>^<Identifier type
code(ID)>^<Assigning facility(HD)>^<Name representation

44
Communication Specifications

code(ID)>^<Name context(CWE)>^<Name validity range(DR)>^<Name


assembly order(ID)>^<Effective date(TS)>^<Expiration
date(TS)>^<Professional suffix(ST)>^<Assigning
jurisdiction(CWE>^<Assigning agency or department(CWE)>
Definition: This field identifies the provider who ordered the test. Either the ID
code or the name, or both, may be present. This is the same as
ORC-12-ordering provider.
Implementation: Not used
(17) Order callback phone number
Components: <DEPRECATED-telephone number(ST)>^<Telecommunication use
code(ID)>^<Telecommunication equipment type(ID)>^<Email
address(ST)>^<Country code(NM)>^<Area/City code(NM)>^<Local
number(NM)>^<Extension(NM)>^<Any text(ST)>^<Extension
prefix(ST)>^<Speed dial code(ST)>^<Unformatted telephone number(ST)>
Definition: This field contains the telephone number for reporting a status or a
result using the standard format with extension and/or beeper number
when applicable.
Implementation: Not used
(18) Placer field1
Definition: This field is user field #1. Text sent by the placer will be returned with
the results.
Implementation: Not used
(19) Placer field2
Definition: This field is similar to placer field #1.
Implementation: Not used
(20) Filler field1
Definition: This field is definable for any use by the filler (diagnostic service).
Implementation: Not used
(21) Filler field2
Definition: This field is similar to filler field #1.
Implementation: Not used
(22) Results rpt/status change - date/time
Components: <Time(DTM)>^<DEPRECATED-degree of precision(ID)>
Definition: This field specifies the date/time when the results were reported or
status changed. This field is used to indicate the date and time that the
results are composed into a report and released, or that a status, as defined
in ORC-5 order status, is entered or changed. (This is a results field only.)
When other applications (such as office or clinical database applications)
query the laboratory application for untransmitted results, the information
in this field may be used to control processing on the communications link.
Usually, the ordering service would want only those results for which the
reporting date/time is greater than the date/time the inquiring application
last received results.
Implementation: Not used
(23) Charge to practice
Components: <Monetary amount(MO)>^<Charge code(CWE)>
Definition: This field is the charge to the ordering entity for the studies performed

45
V1.4.2

when applicable. The first component is a dollar amount when known by


the filler. The second is a charge code when known by the filler (results
only).
Implementation: Not used
(24) Diagnostic serv sect ID
Definition: This field is the section of the diagnostic service where the observation
was performed. If the study was performed by an outside service, the
identification of that service should be recorded here. Refer to HL7 Table
0074 - Diagnostic Service Section ID for valid entries.
Implementation: Not used
(25) Result status
Definition: This field contains the status of results for this order. This conditional
field is required whenever the OBR is contained in a report message. It is
not required as part of an initial order. There are two methods of sending
status information. If the status is that of the entire order, use
ORC-15-order effective date/time and ORC-5-order status. If the status
pertains to the order detail segment, use OBR-25-result status and
OBR-22-results rpt/status chng - date/time. If both are present, the OBR
values override the ORC values. This field would typically be used in a
response to an order status query where the level of detail requested does
not include the OBX segments. When the individual status of each result is
necessary, OBX-11-observ result status may be used. Refer to HL7 Table
0123 - Result Status for valid entries.
Implementation: Not used
(26) Parent result
Components: <OBX-3 Observation identifier of parent result(CWE)>^<OBX-4
Sub-ID of parent result(ST)>^<OBX-5 Observation results from
parent(varies)>
Definition: This field is defined to make it available for other types of linkages (e.g.,
toxicology). This important information, together with the information in
OBR-29-parent, uniquely identifies the parent result's OBX segment
related to this order. The value of this OBX segment in the parent result is
the organism or chemical species about which this battery reports. For
example, if the current battery is an antimicrobial susceptibility, the parent
results identified OBX contains a result which identifies the organism on
which the susceptibility was run. This indirect linkage is preferred because
the name of the organism in the parent result may undergo several
preliminary values prior to finalization. The third component may be used
to record the name of the microorganism identified by the parent result
directly. The organism in this case should be identified exactly as it is in
the parent culture. We emphasize that this field does not take the entire
result field from the parent. It is meant only for the text name of the
organism or chemical subspecies identified. This field is included only to
provide a method for linking back to the parent result for those systems
that could not generate unambiguous Observation IDs and sub-IDs. This
field is present only when the parent result is identified by OBR-29-parent
and the parent spawns child orders for each of many results. A second mode

46
Communication Specifications

of conveying this information is to use a standard observation result


segment (OBX). If more than one organism is present, OBX-4-observation
sub-ID is used to distinguish them. In this case, the first OBX with subID N
will contain a value identifying the Nth microorganism, and each additional
OBX with subID N will contain susceptibility values for a given
antimicrobial test on this organism.
Implementation: Not used
(27) Quality / Timing
Components: <Quantity(CQ)>^<Interval(RI)>^<Duration(ST)>^<State
date/time(TS)>^<End
date/time(TS>)^<Priority(ST)>^<Condition(ST)>^<Text(TX)>^<Conjunctio
n(ID)>^<Order sequencing(OSD)>^<Occurrence duration(CWE)>^<Total
occurrences(NM)>
Definition: This field is retained for backward compatibility only. The reader is
referred to the TQ1 and TQ2 segments described in sections 4.5.4 and 4.5.5
respectively of HL7. This field contains information about how many
services to perform at one service time and how often the service times are
repeated, and to fix duration of the request.
Implementation: Not used
(28) Result copies to
Components: <ID number(ST)>^<Family Name(FN)>^<Given
name(ST)>^<Second and further given name or initials
thereof(ST)>^<Suffix(e.g.,JR or
Ⅲ)(ST)>^<Prefix(e.g.,DR)(ST)>^<Degree(e.g.,MD)(IS)>^<Source
table(IS)>^<Assigning authority(HD)>^<Name type code(ID)>^<Identifier
check digit(ST)>^<Check digit scheme(ID)>^<Identifier type
code(ID)>^<Assigning facility(HD)>^<Name representation
code(ID)>^<Name context(CWE)>^<Name validity range(DR)>^<Name
assembly order(ID)>^<Effective date(TS)>^<Expiration
date(TS)>^<Professional suffix(ST)>^<Assigning
jurisdiction(CWE>^<Assigning agency or department(CWE)>
Definition: This field identifies the people who are to receive copies of the results.
By local convention, either the ID number or the name may be absent.
Clinical department or hospital ward can be designated as a reporting
address.
Implementation: Not used
(29) Parent number
Components: <Placer assigned identifier(EI)>^<Filler assigned identifier(EI)>
Definition: This field is identical to ORC-8-parent. This field relates a child to its
parent when a parent child relationship exists. For example, observations
that are spawned by previous observations, e.g., antimicrobial
susceptibilities spawned by blood cultures, need to record the parent (blood
culture) filler order number here. The parent child mechanism is described
under the order control field notes. It is required when the order is a child.
Implementation: Not used
(30) Transportation mode
Definition: This field identifies how (or whether) to transport a patient, when

47
V1.4.2

applicable. Refer to HL7 Table 0124 - Transportation Mode for valid codes.
Implementation: Not used
(31) Reason for study
Components: <Identifier(ST)>^<Text(ST)>^<Name of coding
system(ID)>^<Alternate identifier(ST)>^<Alternate text(ST)>^<Name of
alternate coding system(ID)>^<Coding system version ID(ST)>^<Alternate
coding system version ID(ST)>^<Original text(ST)>
Definition: This is required for some studies to obtain proper reimbursement.
Implementation: Not used
(32) Principal result interpreter
Components: <Name(CNN)>^<Start date/time(TS)>^<End
date/time(TS)>^<Point of
care(IS)>^<Room(IS)>^<Bed(IS)>^<Facility(HD)>^<Location
status(IS)>^<Patient location type(IS)>^<Building(IS)>^<Floor(IS)>
Definition: This field identifies the physician or other clinician who interpreted the
observation and is responsible for the report content.
Implementation: Not used
(33) Assistant result interpreter
Components: <Name(CNN)>^<Start date/time(TS)>^<End
date/time(TS)>^<Point of
care(IS)>^<Room(IS)>^<Bed(IS)>^<Facility(HD)>^<Location
status(IS)>^<Patient location type(IS)>^<Building(IS)>^<Floor(IS)>
Definition: This field identifies the clinical observer who assisted with the
interpretation of this study.
Implementation: Not used
(34) Technician
Components: <Name(CNN)>^<Start date/time(TS)>^<End
date/time(TS)>^<Point of
care(IS)>^<Room(IS)>^<Bed(IS)>^<Facility(HD)>^<Location
status(IS)>^<Patient location type(IS)>^<Building(IS)>^<Floor(IS)>
Definition: This field identifies the performing technician.
Implementation: Not used
(35) Transcriptionist
Components: <Name(CNN)>^<Start date/time(TS)>^<End
date/time(TS)>^<Point of
care(IS)>^<Room(IS)>^<Bed(IS)>^<Facility(HD)>^<Location
status(IS)>^<Patient location type(IS)>^<Building(IS)>^<Floor(IS)>
Definition: This field identifies the report transcriber.
Implementation: Not used
(36) Scheduled date/time
Components: <Time(DTM)>^<DEPRECATED-degree of precision(ID)>
Definition: This field is the date/time the filler scheduled an observation, when
applicable (e.g., action code in OBR-11-specimen action code = "S"). This is a
result of a request to schedule a particular test and provides a way to inform
the placer of the date/time a study is scheduled (result only).
Implementation: Not used

48
Communication Specifications

(37) Number of sample containers


Definition: This field identifies the number of containers for a given sample. For
sample receipt verification purposes; may be different from the total
number of samples which accompany the order. The number of sampled
containers with identical sample/identical collection container at overflow of
collection quantity is described. This is normally interpreted as 1, including
no description. This information is described in SPM segment.
Implementation: Not used
(38) Transport logistics of collected sample
Components: <Identifier(ST)>^<Text(ST)>^<Name of coding
system(ID)>^<Alternate identifier(ST)>^<Alternate text(ST)>^<Name of
alternate coding system(ID)>^<Coding system version ID(ST)>^<Alternate
coding system version ID(ST)>^<Original text(ST)>
Definition: This field is the means by which a sample reaches the diagnostic
service provider. This information is to aid the lab in scheduling or
interpretation of results. Possible answers: routine transport van, public
postal service, etc.
Implementation: Not used
(39) Collector's comment
Components: <Identifier(ST)>^<Text(ST)>^<Name of coding
system(ID)>^<Alternate identifier(ST)>^<Alternate text(ST)>^<Name of
alternate coding system(ID)>^<Coding system version ID(ST)>^<Alternate
coding system version ID(ST)>^<Original text(ST)>
Definition: This field is for reporting additional comments related to the sample. If
only free text is reported, it is placed in the second component with a null in
the first component, e.g., ^difficult clotting after venipuncture and
ecchymosis.
Implementation: Not used
(40) Transport arrangement responsibility
Components: <Identifier(ST)>^<Text(ST)>^<Name of coding
system(ID)>^<Alternate identifier(ST)>^<Alternate text(ST)>^<Name of
alternate coding system(ID)>^<Coding system version ID(ST)>^<Alternate
coding system version ID(ST)>^<Original text(ST)>
Definition: This field is an indicator of who is responsible for arranging transport
to the planned diagnostic service. Examples: Requester, Provider, Patient.
Implementation: Not used
(41) Transport arranged
Definition: This field is an indicator of whether transport arrangements are
known to have been made.
Implementation: Not used
(42) Escort required
Definition: This field is an indicator that the patient needs to be escorted to the
diagnostic service department. Note: The nature of the escort requirements
should be stated in OBR-43-planned patient transport comment.
Implementation: Not used
(43) Planned patient transport comment
Components: Identifier(ST)>^<Text(ST)>^<Name of coding

49
V1.4.2

system(ID)>^<Alternate identifier(ST)>^<Alternate text(ST)>^<Name of


alternate coding system(ID)>^<Coding system version ID(ST)>^<Alternate
coding system version ID(ST)>^<Original text(ST)>
Definition: This field is the code or free text comments on special requirements
for the transport of the patient to the diagnostic service department.
Implementation: Not used
(44) Procedure code
Components: Identifier(ST)>^<Text(ST)>^<Name of coding
system(ID)>^<Alternate identifier(ST)>^<Alternate text(ST)>^<Name of
alternate coding system(ID)>^<Coding system version ID(ST)>^<Alternate
coding system version ID(ST)>^<Original text(ST)>
Definition: This field contains a unique identifier assigned to the procedure, if any,
associated with the charge. Refer to User-defined table 0088 - Procedure
code for suggested values. This field is a CE data type for compatibility with
clinical and ancillary systems.
Implementation: Not used
(45) Procedure code modifier
Components: Identifier(ST)>^<Text(ST)>^<Name of coding
system(ID)>^<Alternate identifier(ST)>^<Alternate text(ST)>^<Name of
alternate coding system(ID)>^<Coding system version ID(ST)>^<Alternate
coding system version ID(ST)>^<Original text(ST)>
Definition: This field contains the procedure code modifier to the procedure code
reported in OBR-44-procedure code, when applicable. Procedure code
modifiers are defined by regulatory agencies such as CMS and the AMA.
Multiple modifiers may be reported. The modifiers are sequenced in priority
according to user entry. In the USA, this is a requirement of the UB and the
1500 claim forms. Multiple modifiers are allowed and the order placed on
the form affects reimbursement. Refer to user-defined table 0340 -
Procedure code modifier for suggested values.
Implementation: Not used
(46) Placer supplemental service information
Components: <Identifier(ST)>^<Text(ST)>^<Name of coding
system(ID)>^<Alternate identifier(ST)>^<Alternate text(ST)>^<Name of
alternate coding system(ID)>^<Coding system version ID(ST)>^<Alternate
coding system version ID(ST)>^<Original text(ST)>
Definition: This field contains supplemental service information sent from the
placer system to the filler system for the universal procedure code reported
in OBR-4 Universal Service ID. This field will be used to provide ordering
information detail that is not available in other, specific fields in the OBR
segment. Multiple supplemental service information elements may be
reported. Refer to User-defined Table 0411 - Supplemental service
information values. This field can be used to describe details such as
whether study is to be done on the right or left, for example where the study
is of the arm and the order master file does not distinguish right from left or
whether the study is to be done with or without contrast (when the order
master file does not make such distinctions).
Implementation: Not used

50
Communication Specifications

(47) Filler supplemental service information


Components: <Identifier(ST)>^<Text(ST)>^<Name of coding
system(ID)>^<Alternate identifier(ST)>^<Alternate text(ST)>^<Name of
alternate coding system(ID)>^<Coding system version ID(ST)>^<Alternate
coding system version ID(ST)>^<Original text(ST)>
Definition: This field contains supplemental service information sent from the
filler system to the placer system for the procedure code reported in OBR-4
Universal Service ID. This field will be used to report ordering information
details that is not available in other, specific fields in the OBR segment.
Typically it will reflect the same information as was sent to the filler system
in OBR-46-Placer supplemental information unless the order was modified
in which case the filler system will report what was actually performed
using this field. Multiple supplemental service information elements may
be reported. Refer to User-Defined Table 0411 - Supplemental Service
Information Values.
This field can be used to describe details such as whether study is to be done
on the right or left, for example where the study is of the arm and the order
master file does not distinguish right from left or whether the study is to be
done with or without contrast (when the order master file does not make
such distinctions).
Implementation: Not used
(48) Medically necessary duplicate procedure reason
Components: <Identifier(ST)>^<Text(ST)>^<Name of coding
system(ID)>^<Alternate identifier(ST)>^<Alternate text(ST)>^<Name of
alternate coding system(ID)>^<Coding system version ID(ST)>^<Alternate
coding system version ID(ST)>^<Original text(ST)>
Definition: This field is used to document why the procedure found in OBR-44 -
Procedure Code is a duplicate of one ordered/charged previously for the
same patient within the same date of service and has been determined to be
medically necessary. The reason may be coded or it may be a free text entry.
This field is intended to provide financial systems information on who to bill
for duplicate procedures. Refer to User-Defined Table 0476 – Medically
Necessary Duplicate Procedure Reason for suggested values.
Implementation: Not used
(49) Result handling
Definition: Transmits information regarding the handling of the result. For
example, an order may specify that the result (e.g., an x-ray film) should be
given to the patient for return to the requestor. Refer to User-defined Table
0507 Observation Result Handling for suggested values. If this field is not
populated then routine handling is implied.
Implementation: Not used

51
V1.4.2

3.9.6. 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. The OBX segment can also
contain encapsulated data, e.g., a CDA document or a DICOM image.
Its principal mission is to carry information about observations in report messages.
But the OBX can also be part of an observation order. In this case, the OBX carries
clinical information needed by the filler to interpret the observation the filler makes.
For example, an OBX is needed to report the inspired oxygen on an order for a blood
oxygen to a blood gas lab, or to report the menstrual phase information which should
be included on an order for a pap smear to a cytology lab. Moreover, if multi-test items
are not clear in the OBX, the OBX can be designated about each test item For example,
it is conducted about a set of hepatitis in OBR, GOT/GPT/HBs antibody in OBX, 100g
glucose tolerance test in OBR, pre-glucose level and 30 minute value of glucose level in
OBX. In addition, if you want to set test result comments refer to the handling of test
result comment.
SEQ LEN DT OPT RP# ITEM# ELEMENT NAME
1 4 SI R N 00569 Set ID - OBX
2 2 ID RM N 00570 Value type
3 250 CWE R N 00571 Observation identifier
4 20 ST RM N 00572 Observation Sub ID
5 99999 varies RM N 00573 Observation value
6 250 CWE RM N 00574 Units
7 60 ST RM N 00575 References Range
8 5 IS RM N 00576 Abnormal Flags
9 5 NM N N 00577 Probability
10 2 ID N N 00578 Nature of abnormal test
11 1 ID RM N 00579 Observation result status
12 26 TS N N 00580 Effective date of reference range
13 20 ST RM N 00581 User defined access check
14 26 TS RM N 00582 Date/Time of the observation
15 250 CWE N N 00583 Producer's ID
16 250 XCN N N 00584 Responsible observer
17 250 CWE N N 00936 Observation method
18 22 EI N N 01479 Equipment instance identifier
19 26 TS N N 01480 Date/Time of the analysis

(1) Set ID - OBX


Definition: This field contains the sequence number from 1.
Implementation: As described in the Definition.
This segment in clinical test order messages repeats at the number of times
of test item orders. Test result is normally calculated once in each 1.3
seconds so this segment is 1 in a clinical test result message. At the time,
the value is fixed at |1|. However, ISE test result is simultaneously
calculated for 3 items so this segment repeats three times. In case of this,
three segments of |1|,|2|,|3| repeat. This repetition occurs for test result
transmission of calculation item or HbA1c. This segment in a test result

52
Communication Specifications

referral message repeats for the number of times of all test results for the
specimen.
(2) Value type
Definition: This field contains the format of the observation value in OBX.
Implementation: This field in a clinical test order message is Not used. That is ||.
This field in a clinical test result message and test result information
referral message is fixed to CWE type. That is |CWE|. This is the fifth field
in this segment.
(3) Observation identifier
Components: <Identifier(ST)>^<Text(ST)>^<Name of coding
system(ID)>^<Alternate identifier(ST)>^<Alternate text(ST)>^<Name of
alternate coding system(ID)>^<Coding system version ID(ST)>^<Alternate
coding system version ID(ST)>^<Original text(ST)>
Definition: This field contains a unique identifier for the observation.
Implementation: The <Identifier(ST)> is set on a Test Item ID and is used in NM
type. The BiOLiS has a master of “test item ID” versus “item number in
BiOLiS” and matches them (Required). The <Text(ST)> is set on an Item
Name (Option). The value of this component in a clinical test order message
is ignored. Item Name of BiOLiS is described in this component in a clinical
test result message and a test result information referral message.
The <Name of coding system(ID)> is ignored.
The <Alternate text(ST)> is ignored.
The <Name of alternate coding system(ID)> is ignored.
The <Coding system version ID(ST)> is ignored.
The <Alternate coding system version ID(ST)> is ignored.
The <Original text(ST)> is ignored.
(4) Observation Sub ID
Definition: This field is used to distinguish between multiple OBX segments with
the same observation ID organized under one OBR.
Implementation: This field in a clinical test order message is Not used. That is ||.
This field in a clinical test result message and a test result information
referral message has a meaning as follows. A test item for a specimen may
be tested multiple times. This field is used in NM type and is described how
many times the test results were.
(5) Observation value
Components: <Identifier(ST)>^<Text(ST)>^<Name of coding
system(ID)>^<Alternate identifier(ST)>^<Alternate text(ST)>^<Name of
alternate coding system(ID)>^<Coding system version ID(ST)>^<Alternate
coding system version ID(ST)>^<Original text(ST)>
Definition: This field contains the value observed by the observation producer.
OBX-2-value type contains the data type for this field according to which
observation value is formatted. This field is required for OBX segment. A
response must be recorded by ASCII character code no matter whether this
is a value or a short texts.
Implementation: This field in a clinical test order is Not used. That is ||. This
field in a clinical test result message and a test result information referral
message is fixed for CWE type.

53
V1.4.2

The <Identifier(ST)> is used in NM type and is described for determined


results. For example, it is 1.23. Note: 1.2 and 1.20 are different. If 1.2 is
described, its determined result means the number from 1.15 to 1.24999….
If 1.20 is described, its determined result means the number from 1.195 to
1.204999….
The <Text(ST)> is described the determined result when a qualitative
result is conducted in the BiOLiS. If no qualitative result exists, this is
described as “null(||)”.
The components, <Name of coding system(ID)>, <Alternate identifier(ST)>,
<Alternate text(ST)>, <Name of alternate coding system(ID)>, <Coding
system version ID(ST)>, <Alternate coding system version ID(ST)> and
<Original text(ST)> are omitted.
Qualitative result list
value
2-
-
+-
+
2+
3+
4+
(6) Units
Components: <Identifier(ST)>^<Text(ST)>^<Name of coding
system(ID)>^<Alternate identifier(ST)>^<Alternate text(ST)>^<Name of
alternate coding system(ID)>^<Coding system version ID(ST)>^<Alternate
coding system version ID(ST)>^<Original text(ST)>
Definition: A data type of units are CWE data type. If a test result which is
accompanied with units, this field is required. This is described with the
following components; < Units(ASCII)(ST) > ^ < Units Name(ST) > ^ <Code
System Name(ID) >. Identifier component or test component can be omitted.
Refer to HL7 chapter 7 (7.4.2.6) about the detail.
Implementation: This field in a clinical test order is Not used. That is ||. This
field in a clinical test result message and a test result information referral
message is described as below:
The <Identifier(ST)> is described with units for the value described with
the determined result of the first component in the field [Observation
value].
The components, <Text(ST)>, <Name of coding system(ID)>, <Alternate
identifier(ST)>, <Alternate text(ST)>, <Name of alternate coding
system(ID)>, <Coding system version ID(ST)>, <Alternate coding system
version ID(ST)> and <Original text(ST)> are omitted.
(7) References Range
Definition: This field contains reference range.
This field in a clinical test order message is Not used. That is ||. This field in a
clinical test result message and a test result information referral message is
described as below:
a) If both an upper limit and a lower limit are defined, this is described as

54
Communication Specifications

|12.3-23.4|.
b) If only a lower limit is defined, this is described as |>12.3|.
c) If only an upper limit is defined, this is described as |<23.4|.
(8) Abnormal Flags
Definition: This field contains a table lookup indicating the normalcy status of the
result.
This field in a clinical test order message is Not used. That is ||. This field in a
clinical test result message and a test result information referral message is
described as below:
Value Content
null Within reference range
L Below lower limit
H Above upper limit
(9) Probability
Definition: This field contains the probability of a result being true for results with
categorical values. It mainly applies to discrete coded results.
Implementation: Not used
(10) Nature of abnormal test
Definition: This field contains the nature of the abnormal test. Refer to HL7 Table
0080 - Nature of abnormal testing for valid values. As many of the codes as
apply may be included, separated by repeat delimiters. For example, normal
values based on age, sex, and race would be codes as A~S~R.
Implementation: Not used
(11) Observation result status
Definition: This field contains the observation result status. Refer to HL7 table
0085 - Observation result status codes interpretation for valid values. This
field reflects the current completion status of the results for one
Observation Identifier.
This field in a clinical test order message is Not used. That is ||. This field in a
clinical test result message and a test result information referral message is
described as below:
Value Content
F Final results
D Deletes the OBX record
No result
O
No result, not yet at a referral.
Post original as wrong, e.g., transmitted for wrong patient
W Not guarantee the Observation value due to a disorder of some
kind.
(12) Effective date of reference range
Components: <Time(DTM)>^<DEPRECATED-degree of precision(ID)>
Definition: If the value measured by the old method can’t be compared with the
one by the updated method, this means the changed date of these
measurement methods.
Implementation: Not used
(13) User defined access check
Definition: This field permits the producer to record results-dependent codes for
55
V1.4.2

classifying the observation at the receiving system.


Implementation: State a dilution rate in the OBX segment of a clinical test order,
OML^O35, and of a test order information referral, RSP^WOS, as below
table if the dilution rate is designated in the LIS, State null, ||, there if the
dilution rate is not designated, If this is null, the dilution rate is determined
by the settings in the BiOLiS.
This field in a clinical test result, OUL^R23 and a clinical test information
referral, RSP^ZB6,RSP^ZB8 is described with the diluted rate by the
analyzer about the measurement result.
Num1 Content
|| No designation. Samples are measured with the dilution rate which is
designated by using the item parameters in the analyzer.
|^0.5| Designation of 0.5-fold dilution. Actually, doubled samples
are measured.
|^1| Designation of no dilution
|^6| Designation of 6-fold dilution
|^10| Designation of 10-fold dilution
|^20| Designation of 20-fold dilution
|^30| Designation of 30-fold dilution
|^40| Designation of 40-fold dilution
|^50| Designation of 50-fold dilution
|^60| Designation of 60-fold dilution
|^70| Designation of 70-fold dilution
|^80| Designation of 80-fold dilution
|^90| Designation of 90-fold dilution
|^100| Designation of 100-fold dilution
(14) Date/Time of the observation
Components: <Time(DTM)>^<DEPRECATED-degree of precision(ID)>
Definition: This field is required in two circumstances. The first is when the
observations reported beneath one report header (OBR) have different
dates/times. This could occur in the case of queries, timed test sequences, or
clearance studies where one measurement within a battery may have a
different time than another measurement. It is also needed in the case of
OBX segments that are being sent by the placer to the filler, in which case
the date of the observation being transmitted is likely to have no relation to
the date of the requested observation. In France, requesting services
routinely send a set of the last observations along with the request for a new
set of observations. The date of these observations is important to the filler
laboratories.
Implementation: This field in a clinical test order message is Not used. That is ||.
This field in a clinical test result message and a test result information
referral message is described with the calculated time of the observation
value written in this segment. YYYYMMDDHHMMSS.
(15) Producer's ID
Components: <Identifier(ST)>^<Text(ST)>^<Name of coding
system(ID)>^<Alternate identifier(ST)>^<Alternate text(ST)>^<Name of
alternate coding system(ID)>^<Coding system version ID(ST)>^<Alternate
56
Communication Specifications

coding system version ID(ST)>^<Original text(ST)>


Definition: This field contains a unique identifier of the responsible producing
service.
Implementation: Not used
(16) Responsible observer
Components: <ID number(ST)>^<Family Name(FN)>^<Given
name(ST)>^<Second and further given name or initials
thereof(ST)>^<Suffix(e.g.,JR or
Ⅲ)(ST)>^<Prefix(e.g.,DR)(ST)>^<Degree(e.g.,MD)(IS)>^<Source
table(IS)>^<Assigning authority(HD)>^<Name type code(ID)>^<Identifier
check digit(ST)>^<Check digit scheme(ID)>^<Identifier type
code(ID)>^<Assigning facility(HD)>^<Name representation
code(ID)>^<Name context(CWE)>^<Name validity range(DR)>^<Name
assembly order(ID)>^<Effective date(TS)>^<Expiration
date(TS)>^<Professional suffix(ST)>^<Assigning
jurisdiction(CWE>^<Assigning agency or department(CWE)>
Definition: When required, this field contains the identifier of the individual
directly responsible for the observation (i.e., the person who either
performed or verified it).
Implementation: Not used
(17) Observation method
Components: <Identifier(ST)>^<Text(ST)>^<Name of coding
system(ID)>^<Alternate identifier(ST)>^<Alternate text(ST)>^<Name of
alternate coding system(ID)>^<Coding system version ID(ST)>^<Alternate
coding system version ID(ST)>^<Original text(ST)>
Definition: This optional field can be used to describe the observation method
when the observation method is not published in the test item guidance and
so on.
Implementation: Not used
(18) Equipment instance identifier
成分 Components: <Entity identifier(ST)>^<Namespace ID(IS)>^<Universal
ID(ST)>^<Universal ID type(ID)>
Definition: This field identifies the Equipment Instance (e.g., Analyzer, Analyzer
module, group of Analyzers,...) responsible for the production of the
observation.
Implementation: Not used
(19) Date/Time of the analysis
Components: <Time(DTM)>^<DEPRECATED-degree of precision(ID)>
Definition: This field is used to transfer the time stamp associated with generation
of the analytical result by the instrument specified in Equipment Instance
Identifier (see above).
Implementation: Not used

57
V1.4.2

3.9.7. QAK - Query acknowledgment Segment


The QAK segment contains information sent with responses to a query. Although the
QAK segment is required in the responses to the enhanced queries, it may appear as
an optional segment placed after the (optional) ERR segment in any query response
(message) to any original mode query.
SEQ LEN DT OPT RP# ITEM# ELEMENT NAME
1 32 ST O N 00696 Query tag
2 2 ID O N 00708 Query response status
3 250 CWE O N 01375 Message query name
4 10 NM N N 01434 Hit count total
5 10 NM N N 01622 This payload
6 10 NM N N 01623 Hits remaining

(1) Query tag


Definition: This field may be valued by the initiating system to identify the query,
and may be used to match response messages to the originating query. If it
is valued, the responding system is required to echo it back as the first field
in the query acknowledgment segment (QAK).
Implementation: If the Query tag exists in the QPD segment in the clinical result
information referral message, its copy is described. This is etiquette for
information exchange. The BiOLiS ignores the QAK-Query tag in the
RSP^WOS.
(2) Query response status
Definition: This field allows the responding system to return a precise response
status. It is especially useful in the case where no data is found that
matches the query parameters, but where there is also no error. It is defined
with HL7 Table 0208 - Query Response Status.
Implementation: The OK,NF,AE in HL7 Table 0208 - Query response status is
described.
Value Content
OK Data found, no errors
NF No data found, no errors
AE Application error
AR Application reject
(3) Message query name
Components: <Identifier(ST)>^<Text(ST)>^<Name of coding
system(ID)>^<Alternate identifier(ST)>^<Alternate text(ST)>^<Name of
alternate coding system(ID)>^<Coding system version ID(ST)>^<Alternate
coding system version ID(ST)>^<Original text(ST)>
Definition: This field contains the name of the query. These names are assigned by
the function-specific chapters of this specification. Site-specific event replay
query names begin with the letter “Z.” Refer to User defined table 0471 -
Query name for suggested values.
Implementation: If the Message query name exists in the QPD segment in the test
result information referral message, its copy is described. This is etiquette
for information exchange. The BiOLiS ignores the QAK-Message query
name in the RSP^WOS.
58
Communication Specifications

(4) Hit count total


Definition: This field, when used, contains the total number of records found by
the Server that matched the query. For tabular responses, this is the
number of rows found. For other response types, the Conformance
Statement defines the meaning of a “hit.”
Implementation: Not used
(5) This payload
Definition: This field, when used, contains the total number of matching records
that the Server sent in the current response. Where the continuation
protocol is used to transmit the response in partial installments, this
number will differ from the value sent in QAK-4-Hit count total.
Implementation: Not used
(6) Hits remaining
Definition: This field, when used, contains the number of matching records found
by the Server that have yet to be sent. It is only meaningful when the
Server uses the continuation protocol to transmit partial responses.
Implementation: Not used

59
V1.4.2

3.9.8. QPD - Query parameter definition Segment


The QPD segment defines the parameters of the query.
SEQ LEN DT OPT RP# ITEM# ELEMENT NAME
1 250 CWE O N 01375 Message query name
2 32 ST O N 00696 Query tag
3 20 CX RM N 00105 Patient Identifier List
4 427 EI RM N 01331 Container identifier
5 80 NA RM N 01338 Position in carrier

(1) Message query name


Components: <Identifier(ST)>^<Text(ST)>^<Name of coding
system(ID)>^<Alternate identifier(ST)>^<Alternate text(ST)>^<Name of
alternate coding system(ID)>^<Coding system version ID(ST)>^<Alternate
coding system version ID(ST)>^<Original text(ST)>
Definition: This field contains the name of the query. These names are assigned by
the function-specific chapters of this specification. It is one to one with the
conformance statement for this query name, and it is in fact an identifier for
that conformance statement. Site-specific query names begin with the letter
“Z.” Refer to User defined table 0471 - Query name for suggested values.
Implementation: If the Message query name exists in the test result information
referral message, its copy is described. This is etiquette for information
exchange. The BiOLiS ignores the QPD-Message query name in the
RSP^WOS.
(2) Query tag
Definition: This field may be valued by the initiating system to identify the query,
and may be used to match response messages to the originating query. If
this field is valued, the responding system is required to echo it back as the
first field in the query acknowledgement segment (QAK).
Implementation: If the Query tag exists in the test result information referral
message, its copy is described.
(3) Patient Identifier List
Components: <ID Number(ST)>^<Check Digit(ST)>^<Check Digit
Scheme(ID)>^<Assigning Authority(HD)>^<Identifier Type
Code(ID)>^<Assigning Facility(HD)>^<Effective Date(DT)>^<Expiration
Date(DT)>^<Assigning Jurisdiction(CWE)>^<Assigning Agency or
Department(CWE)>
Implementation: In case of the test result information referral - the patient basis
(ZB5), this is used to identify the patient. Only the <ID Number(ST)> is
used. The ID Number should be within 20 characters. The other field
components are ignored. Doesn’t allow a referral of multiple patients.
(4) Container identifier
Components: <Entity identifier(ST)>^<Namespace ID(IS)>^<Universal
ID(ST)>^<Universal ID type(ID)>
Implementation: In case of the test result information referral - the specimen basis
(QBP^ZB7/RSP^ZB8) and the test order information referral
(QBP^WOS/RSP^WOS), this is used to identify the sample. The <Entity
identifier(ST)> means a sample barcode. The other components are Not

60
Communication Specifications

used.
BiOLiS Entity identifier
Required. Samples are identified with
Sample barcode mode
Entity identifier values.
Sample position mode Not used
(5) Position in carrier
Components: <Tray number(NM)>^<Position number(NM)>
Implementation: In case of the test result information referral – the specimen
basis (QBP^ZB7/RSP^ZB8) and the test order information referral
(QBP^WOS/RSP^WOS), this is used to identify the sample. The first
component displays the tray number and the second component displays
the position. Doesn’t allow the referral for multiple samples.
First Content Second Content
Component Component
1-30 For patient sample
1-50 Patient sample tray
31-45 For QC sample
61-66 Calibration tray 31-45 For QC sample
81-83 QC tray 1-45 For QC sample
Note: In case of the test result information referral – the specimen basis
(QBP^ZB7/RSP^ZB8) and the test order information referral
(QBP^WOS/RSP^WOS), the extraction condition of the combination of
[Container identifier] and [Position in carrier] is Not allowed. Set “null” for
which one of them.

61
V1.4.2

3.9.9. RCP - Response control parameter Segment


The RCP segment is used to restrict the amount of data that should be returned in
response to query.
All fields are ignored in this specifications.
SEQ LEN DT OPT RP# ITEM# ELEMENT NAME
1 1 ID N N 00027 Query priority
2 10 CQ N N 00031 Quantity limited request
3 250 CWE N N 01440 Response modality
4 26 TS N N 01441 Execution and delivery time
5 1 ID N N 01443 Modify indicator
6 512 SRT N N 01624 Sort-by field
7 256 ID N N 01594 Segment group inclusion

(1) Query priority


Definition: This field contains the time frame in which the response is expected.
Refer to HL7 Table 0091 - Query priority for valid values. Table values and
subsequent fields specify time frames for response.
Implementation: Not used
(2) Quantity limited request
Components: <Quantity(NM)>^<Units(CWE)>
Definition: This field contains the maximum length of the response that can be
accepted by the requesting system. Valid entries are numerical values (in
the first component) given in the units specified in the second component.
Default is LI (lines).
Refer to HL7 Table 0126 - Quantity limited request for valid entries for the
second component. In a segment pattern response, a line is defined as a
single segment.
Implementation: Not used
(3) Response modality
Components: <Identifier(ST)>^<Text(ST)>^<Name of coding
system(ID)>^<Alternate identifier(ST)>^<Alternate text(ST)>^<Name of
alternate coding system(ID)>^<Coding system version ID(ST)>^<Alternate
coding system version ID(ST)>^<Original text(ST)>
Definition: This field specifies the timing and grouping of the response message(s).
Refer to HL7 Table 0394 – Response modality for valid values.
Implementation: Not used
(4) Execution and delivery time
Components: <Time(DTM)>^<DEPRECATED-degree of precision(ID)>
Definition: This field specifies the time the response is to be returned. This field is
only valued when RCP-1-Query priority contains the value D (Deferred).
Implementation: Not used
(5) Modify indicator
Definition: This field specifies whether the subscription is new or is being modified.
Refer to HL7 Table 0395 - Modify indicator for valid values.
Implementation: Not used
(6) Sort-by field
Components: <Sort-by field(ST)>^<Sequencing(ID)>

62
Communication Specifications

Definition: For queries requesting a tabular response, this field specifies by which
fields the response is to be sorted, and the order(s) in which sorting is to be
performed.
Implementation: Not used
(7) Segment group inclusion
Definition: Specifies those optional segment groups which are to be included in the
response. Refer to HL7 Table 0391—Segment group for values for Segment
Group. This is a repeating field, to accommodate inclusion of multiple
segment groups. The default for this field, not present, means that all
relevant groups are included.
Implementation: Not used

63
V1.4.2

3.9.10. MSA - Message acknowledgment Segment


The MSA segment contains information sent while acknowledging another message.
SEQ LEN DT OPT RP# ITEM# ELEMENT NAME
1 2 ID R N 00018 Acknowledgment code
2 20 ST R N 00010 Message control ID
3 80 ST N N 00020 Text message
4 15 NM N N 00021 Expected sequence number
5 1 ID N N 00022 Delayed acknowledgment type
6 250 CWE N N 00023 Error condition

(1) Acknowledgment code


Definition: This field contains an acknowledgment code, see message processing
rules. Refer to HL7 Table 0008 - Acknowledgment code for valid values.
Implementation: As below.
Value Content
AA Application Accept
AE Application Error
AR Application Reject
(2) Message control ID
Definition: This field contains the message control ID of the message sent by the
sending system. It allows the sending system to associate this response with
the message for which it is intended.
Implementation: A copy of the Message control ID in the MSH segment of the
request message is described.
(3) Text message
Definition: This optional field further describes an error condition. This text may
be printed in error logs or presented to an end user.
Implementation: Not used
(4) Expected sequence number
Definition: This optional numeric field is used in the sequence number protocol.
Implementation: Not used
(5) Delayed acknowledgment type
Definition: This was denied in HL7 Version 2.2.
Implementation: Not used
(6) Error condition
Components: <Identifier(ST)>^<Text(ST)>^<Name of coding
system(ID)>^<Alternate identifier(ST)>^<Alternate text(ST)>^<Name of
alternate coding system(ID)>^<Coding system version ID(ST)>^<Alternate
coding system version ID(ST)>^<Original text(ST)>
Definition: This was denied in HL7 Version 2.4.
Implementation: Not used

64
Communication Specifications

3.9.11. ERR - Error Segment


The ERR segment is used to add error comments to acknowledgment messages.
SEQ LEN DT OPT RP# ITEM# ELEMENT NAME
1 493 ELD N N 00024 Error code and location
2 18 ERL N N 01812 Error location
3 705 CWE R N 01813 HL7 error code
4 2 ID R N 01814 Severity
5 705 CWE O N 01815 Application error code
6 80 ST O N 01816 Application error parameter
7 2048 TX N N 01817 Diagnostic information
8 250 TX N N 01818 User message
9 20 IS N N 01819 Inform person indicator
10 705 CWE N N 01820 Override type
11 705 CWE N N 01821 Override reason code
12 652 XTN N N 01822 Help desk contact point

(1) Error code and location


Components: <Segment ID(ST)>^<Segment sequence(NM)>^<Field
position(NM)>^<Code identifying error(CWE)>
Definition: This field identifies an erroneous segment in another message.
Retained for backward compatibility only as of v 2.5; refer to ERR-2 and
ERR-3 instead.
Implementation: Not used
(2) Error location
Components: <Segment ID(ST)>^<Segment sequence(NM)>^<Field
position(NM)>^<Field repetition(NM)>^<Component
number(NM)>^(Sub-component number(NM)>
Definition: Identifies the location in a message related to the identified error,
warning or message. If multiple repetitions are present, the error results
from the values in a combination of places.
Implementation: Not used
(3) HL7 error code
Components: <Identifier(ST)>^<Text(ST)>^<Name of coding
system(ID)>^<Alternate identifier(ST)>^<Alternate text(ST)>^<Name of
alternate coding system(ID)>^<Coding system version ID(ST)>^<Alternate
coding system version ID(ST)>^<Original text(ST)>
Definition: Identifies the HL7 (communications) error code. Refer to HL7 Table
0357 – Message Error Condition Codes for valid values.
Implementation: The Error codes are described in the <Identifier(ST)> as below:
Value Content Comment
0 Message accepted Success.
Segment sequence The message segment were not in the proper
100
error order, or required segment are missing.
Required field A required field is missing from a segment.
101
missing
102 Data type error The field contained data of the wrong data

65
V1.4.2

type, e.g. an NM field contained "FOO".


Table value not A field of data type ID or IS was compared
103 found against the corresponding table, and no match
was found.
Unsupported The message type is not supported. E.g.
200
message type OBX(2)
Application Rejection: A catchall for internal errors not
207 internal error explicitly covered by other codes. E.g. No
matching the MSA-3 Sending application
(4) Severity
Definition: Identifies the severity of an application error. Knowing if something is
Error, Warning or Information is intrinsic to how an application handles the
content. Refer to HL7 Table 0516 - Error severity for valid values. If ERR-3
has a value of "0", ERR-4 will have a value of "I".
Implementation: This is fixed as |I|.
(5) Application error code
Components: <Identifier(ST)>^<Text(ST)>^<Name of coding
system(ID)>^<Alternate identifier(ST)>^<Alternate text(ST)>^<Name of
alternate coding system(ID)>^<Coding system version ID(ST)>^<Alternate
coding system version ID(ST)>^<Original text(ST)>
Definition: Application specific code identifying the specific error that occurred.
Refer to User-Defined Table 0533 – Application Error Code for suggested
values.
Implementation: The segment number determined as an error (a serial number of
MSH as 1) is described in the <Identifier(ST)>. If no information exists, this
is described as “null”.
(6) Application error parameter
Definition: Additional information to be used, together with the Application Error
Code, to understand a particular error condition/warning/etc. This field can
repeat to allow for up to 10 parameters.
Implementation: The field number determined as the error is described. If no
information exists, this is described as “null”.
(7) Diagnostic information
Definition: This is information that may be used by help desk or other support
personnel to diagnose a problem.
Implementation: Not used
(8) User message
Definition: The text message to be displayed to the application user.
Implementation: Not used
(9) Inform person indicator
Definition: A code to indicate who (if anyone) should be informed of the error. This
field may also be used to indicate that a particular person should NOT be
informed of the error (e.g. Do not inform patient). Refer to User-defined
table 0517- Inform Person Code for suggested values.
Implementation: Not used
(10) Override type
Components: <Identifier(ST)>^<Text(ST)>^<Name of coding

66
Communication Specifications

system(ID)>^<Alternate identifier(ST)>^<Alternate text(ST)>^<Name of


alternate coding system(ID)>^<Coding system version ID(ST)>^<Alternate
coding system version ID(ST)>^<Original text(ST)>
Definition: Identifies what type of override can be used to override the specific
error identified. Refer to User-defined table 0518 Override Type for
suggested values.
Implementation: Not used
(11) Override reason code
Components: <Identifier(ST)>^<Text(ST)>^<Name of coding
system(ID)>^<Alternate identifier(ST)>^<Alternate text(ST)>^<Name of
alternate coding system(ID)>^<Coding system version ID(ST)>^<Alternate
coding system version ID(ST)>^<Original text(ST)>
Definition: Provides a list of potential override codes that can be used to override
enforcement of the application rule that generated the error. Refer to
User-defined table 0519 – Override Reason for suggested values.
Implementation: Not used
(12) Help desk contact point
Components: <DEPRECATED-telephone number(ST)>^<Telecommunication use
code(ID)>^<Telecommunication equipment type(ID)>^<Email
address(ST)>^<Country code(NM)>^<Area/City code(NM)>^<Local
number(NM)>^<Extension(NM)>^<Any text(ST)>^<Extension
prefix(ST)>^<Speed dial code(ST)>^<Unformatted telephone number(ST)>
Definition: Lists phone, e-mail, fax, and other relevant numbers for helpdesk
support related to the specified error.
Implementation: Not used

67
V1.4.2

3.9.12. EVN - Event type Segment


The EVN segment is used to communicate necessary trigger event information to
receiving applications.
SEQ LEN DT OPT RP# ITEM# ELEMENT NAME
1 3 ID N N 00099 Event type code
2 26 TS R N 00100 Recorded date/time
3 26 TS N N 00101 Date/Time planned event
4 3 IS N N 00102 Event reason code
5 250 XCN N N 00103 Operator ID
6 26 TS N N 01278 Event occurred
7 241 HD N N 01534 Event facility

(1) Event type code


Definition: This field has been retained for backward compatibility only.
Implementation: Not used
(2) Recorded date/time
Components: <Time(DTM)>^<DEPRECATED-degree of precision(ID)>
Definition: Most systems will default to the system date/time when the transaction
was entered, but they should also permit an override.
Implementation: This is described with the current time of the system,
“YYYYMMDDHHMMSS”.
(3) Date/Time planned event
Components: <Time(DTM)>^<DEPRECATED-degree of precision(ID)>
Definition: This field contains the date/time that the event is planned. We
recommend that PV2-8 - Expected Admit Date/Time, PV2-9 - Expected
Discharge Date/Time or PV2-47 - Expected LOA Return date/time be used
whenever possible.
Implementation: Not used
(4) Event reason code
Definition: This field contains the reason for this event. Refer to User-defined
Table 0062 - Event Reason for suggested values.
Implementation: Not used
(5) Operator ID
Components: <ID number(ST)>^<Family Name(FN)>^<Given
name(ST)>^<Second and further given name or initials
thereof(ST)>^<Suffix(e.g.,JR or
Ⅲ)(ST)>^<Prefix(e.g.,DR)(ST)>^<Degree(e.g.,MD)(IS)>^<Source
table(IS)>^<Assigning authority(HD)>^<Name type code(ID)>^<Identifier
check digit(ST)>^<Check digit scheme(ID)>^<Identifier type
code(ID)>^<Assigning facility(HD)>^<Name representation
code(ID)>^<Name context(CWE)>^<Name validity range(DR)>^<Name
assembly order(ID)>^<Effective date(TS)>^<Expiration
date(TS)>^<Professional suffix(ST)>^<Assigning
jurisdiction(CWE>^<Assigning agency or department(CWE)>
Definition: This field identifies the individual responsible for triggering the event.
Refer to User-defined Table 0188 - Operator ID for suggested values.
Implementation: Not used

68
Communication Specifications

(6) Event occurred


Components: <Time(DTM)>^<DEPRECATED-degree of precision(ID)>
Definition: This field contains the date/time that the event actually occurred. For
example, on a transfer (A02 transfer a patient), this field would contain the
date/time the patient was actually transferred. On a cancellation event, this
field should contain the date/time that the event being cancelled occurred.
Implementation: Not used
(7) Event facility
Components: <Namespace ID(IS)>^<Universal ID(ST>^<Universal ID type(ID)>
Definition: This field identifies the actual facility where the event occurred as
differentiated from the sending facility (MSH-4). It would be the facility at
which the Operator (EVN-5) has entered the event.
Implementation: Not used

69
V1.4.2

3.10. Data type


Only data types being used in this specifications are described as below:

Single type
Data type Data type name Length
ST String data 199
TX Text data 65536
NM Numeric 16
SI Sequence ID 4
ID Coded value for HL7 defined tables Variable
IS Coded value for user-defined tables 20
DT Date 8
DTM Date/time 24

Complex type
Data type Data type name
SRT Sort order
CQ Composite quantity with units
MO Money
SN Structured numeric
EI Entity identifier
HD Hierarchic designator
PT Processing type
VID Version identifier
TS Time stamp
CNN Composite ID number and name simplified
CWE Coded with exceptions
CX ID Extended composite ID with check digit
XCN Extended composite ID number and name for persons
EIP Entity identifier pair
ELD Error location and description
MOC Money and charge code
MSG Message type
NDL Name with date and location
OSD Order sequence definition
PRL Parent result link
SPS Specimen source
FN Family name
SAD Street address
XAD Extended address
XPN Extended person name
XTN Extended telecommunication number
NA Numeric array
DLN Driver’s license number
DR Date/time range
RI Repeat interval
70
Communication Specifications

3.10.1. ST - string data


SEQ Length Content
1 199 String data
String data is left justified with trailing blanks optional. Any displayable (printable)
ACSII characters (values between 20 and 7e).

3.10.2. TX - text data


SEQ Length Content
1 65536 Text data
String data is a sentence and is deemed to be displayed or printed as it is. Therefore,
its composition can include both a text code and a control code (CR,LF,Tab,etc...).

3.10.3. NM - numeric
SEQ Length Content
1 16 Numeric
A number represented as a series of ASCII numeric characters consisting of an
optional leading sign, the digits and an optional decimal point. A leading sign (+) can
be omitted. A place after the decimal point can be omitted.

3.10.4. SI - sequence ID
SEQ Length Content
1 4 Sequence ID
A non-negative integer in the form of a NM field.

3.10.5. ID - coded value for HL7 defined tables


SEQ Length Content
1 Coded value for HL7-defined tables

3.10.6. IS - coded value for user-defined tables


SEQ Length Content
1 20 Coded value for code tables defined in this specifications

3.10.7. DT - date
SEQ Length Content
1 8 Date
This is described as “YYYYMMDD”. In HL7, DD and MMDD can be omitted.
However, this omission is Not allowed in this specifications.

3.10.8. DTM - date/time


SEQ Length Content
1 24 Date/Time
This is described as “YYYYMMDDHHMMSS”. This omittance is Not allowed in this
specifications. In addition, Time is regarded as System time and Time zone is Not
supported.

71
V1.4.2

3.10.9. SRT - sort order


SEQ Length DT Content
1 12 ST Sort-by field
2 2 ID Sequencing
The explanation is omitted because the MO type is not used in this specifications.

3.10.10. CQ - composite quantity with units


SEQ Length DT Content
1 16 NM Quantity
2 483 CWE Units
The explanation is omitted because the CQ type have no significance in this
specifications.

3.10.11. MO - money
SEQ Length DT Content
1 16 NM Quantity
2 3 ID Denomination
The explanation is omitted because the MO is not used in this specifications.

3.10.12. SN - structured numeric


SEQ Length DT Content
1 2 ST Comparator
2 15 NM Numeric1
3 1 ST Separator/Suffix
4 15 NM Numeric2
The structured numeric data type is used to unambiguously express numeric clinical
results along with qualifications. This enables receiving systems to store the
components separately, and facilitates the use of numeric database queries. The
corresponding sets of values indicated with the <comparator> and <separator/suffix>
components are intended to be the authoritative and complete set of values.
If <num1> and <num2> are both non-null, then the separator/suffix must be
non-null. If the separator is “-”, the data range is inclusive of both ends.
For example, <num1> and <num2> are inclusive; e.g., <num1> - <num2> defines a
range of numbers x, such that: <num1> <=x<= <num2>. The <num1> is a numeric.
The <num2> is a numeric or “null”. The <separator/suffix> is “-”, “+”, “/”, “.” and “:”.

[The first component, Comparator (ST)]


Defined as greater than, less than, greater than or equal, less than or equal, equal,
and not equal, respectively (= ">" or "<" or ">=" or "<=" or "=" or "<>". If this
component is not valued, it defaults to equal ("=").
[The second component, Num1 (NM)]
Numeric
[The third component, Separator/Suffix (ST)]
”-“, “+”, “.” or “:”.
[The forth component, Num2 (NM)]
Numeric or null.

72
Communication Specifications

3.10.13. EI - entity identifier


SEQ Length DT Content
1 199 ST Entity identifier
2 20 IS Namespace ID
3 199 ST Universal ID
4 6 ID Universal ID type
Only the Entity identifier is used in this specifications. Refer to Chapter 3.9.
Segment Component about the use/usage in this specifications.

3.10.14. HD - hierarchic designator


SEQ Length DT Content
1 20 IS Namespace ID
2 199 ST Universal ID
3 6 ID Universal ID type
Only the Namespace ID is used in this specifications. Refer to Chapter 3.9. Segment
Component about the use/usage in this specifications.

3.10.15. PT - processing type


SEQ Length DT Content
1 1 ID Processing ID
2 1 ID Processing mode
This is omitted because the PT type is not used in this specifications.

3.10.16. VID - version identifier


SEQ Length DT Content
1 5 ID Version ID
2 483 CWE Internationalization Code
3 483 CWE International version ID
Only the Version ID is used in this specifications. Refer to Chapter 3.9. Segment
Component about the use/usage in this specifications.

3.10.17. TS - time stamp


SEQ Length DT Content
1 24 DTM Date/Time
2 1 ID Degree of precision
Only the Date/Time is used in this specifications. Refer to Chapter 3.9. Segment
Component about the use/usage in this specifications.

3.10.18. CNN - composite ID number and name simplified


SEQ Length DT Content
1 15 ST ID number
2 50 ST Family name
3 30 ST Given name
4 30 ST Second and further given name or initials thereof
5 20 ST Suffix(e.g.,JR or Ⅲ)
6 20 ST Prefix(e.g.,DR)

73
V1.4.2

7 5 IS Degree(e.g.,MD)
8 4 IS Source table
9 20 IS Assigning authority - Namespace ID
10 199 ST Assigning authority - Universal ID
11 6 ID Assigning authority - Universal ID type
The explanation is omitted because the CNN type is not used in this specifications.
3.10.19. CWE - coded with exceptions
SEQ Length DT Content
1 20 ST Identifier
2 199 ST Text
3 20 ID Name of coding system
4 20 ST Alternate identifier
5 199 ST Alternate text
6 20 ID Name of alternate coding system
7 10 ST Coding system version ID
8 10 ST Alternate coding system version ID
9 199 ST Original text
Only the Identifier and the Text are used in this specifications. Refer to Chapter 3.9.
Segment Component about the use/usage in this specifications.

3.10.20. CX - extended composite ID with check digit


SEQ Length DT Content
1 15 ST ID number
2 1 ST Check digit
3 3 ID Check digit scheme
4 227 HD Assigning authority
5 5 ID Identifier type code
6 227 HD Assigning facility
7 8 DT Effective date
8 8 DT Expiration date
9 705 CWE Assigning jurisdiction
10 705 CWE Assigning agency or department
Only the ID number is used in this specifications. Refer to Chapter 3.9. Segment
Component about the use/usage in this specifications.

3.10.21. XCN - extended composite ID number and name for persons


SEQ Length DT Content
1 15 ST ID number
2 194 FN Family name
3 30 ST Given name
4 30 ST Second and further given names or initials thereof
5 20 ST Suffix(e.g.,JR or Ⅲ)
6 20 ST Prefix(e.g.,DR)
7 5 IS Degree(e.g.,MD)
8 4 IS Source table
9 227 HD Assigning authority

74
Communication Specifications

10 1 ID Name type code


11 1 ST Identifier check digit
12 3 ID Check digit scheme
13 5 ID Identifier type code
14 227 HD Assigning facility
15 1 ID Name representation code
16 483 CWE Name content
17 53 DR Name validity range
18 1 ID Name assembly order
19 26 TS Effective date
20 26 TS Expiration date
21 199 ST Professional suffix
22 705 CWE Assigning jurisdiction
23 705 CWE Assigning agency or department
The explanation is omitted because the XCN type is not used in this specifications.

3.10.22. EIP - entity identifier pair


SEQ Length DT Content
1 427 EI Placer assigned identifier
2 427 EI Filler assigned identifier
The explanation is omitted because the EIP type is not used in this specifications.

3.10.23. ELD - error location and description


SEQ Length DT Content
1 3 ST Segment ID
2 2 NM Segment sequence
3 2 NM Field position
4 483 CWE Code identifying error
The explanation is omitted because the ELD type is not used in this specifications.

3.10.24. MOC - money and charge code


SEQ Length DT Content
1 20 MO Monetary amount
2 483 CWE Charge code
The explanation is omitted because the MOC type is not used in this specifications.
3.10.25. MSG - message type
SEQ Length DT Content
1 3 ID Message code
2 3 ID Trigger event
3 7 ID Message structure
Refer to Chapter 3.9. Segment Component about the use/usage in this specifications.

3.10.26. NDL - name with date and location


SEQ Length DT Content
1 406 CNN Name
2 26 TS Start date/time

75
V1.4.2

3 26 TS End date/time
4 20 IS Point of care
5 20 IS Room
6 20 IS Bed
7 227 HD Facility
8 20 IS Location status
9 20 IS Patient location type
10 20 IS Building
11 20 IS Floor
The explanation is omitted because the NDL type is not used in this specifications.

3.10.27. OSD - order sequence definition


SEQ Length DT Content
1 1 ID Sequence/Results flag
2 15 ST Placer order number: entity identifier
3 6 IS Placer order number: namespace ID
4 15 ST Filler order number; entity identifier
5 6 IS Filler order number: namespace ID
6 12 ST Sequence condition value
7 3 NM Maximum number of repeats
8 15 ST Placer order number: universal ID
9 6 ID Placer order number: universal ID type
10 15 ST Filler order number: universal ID
11 6 ID Filler order number: universal ID type
The explanation is omitted because the OSD type is not used in this specifications.
3.10.28. PRL - parent result link
SEQ Length DT Content
1 483 CWE Parent observation identifier
2 20 ST Parent observation sub-identifier
3 250 TX Parent observation value descriptor
The explanation is omitted because the PRL type is not used in this specifications.

3.10.29. SPS - specimen source


SEQ Length DT Content
1 705 CWE Specimen source name or code
2 705 CWE Additives
3 200 TX Specimen collection method
4 705 CWE Body site
5 705 CWE Site modifier
6 705 CWE Collection method modifier code
7 705 CWE Specimen role
The explanation is omitted because the SPS type is not used in this specifications.

3.10.30. FN - family name


SEQ Length DT Content
1 199 ST Surname

76
Communication Specifications

2 20 ST Own surname prefix


3 50 ST Own surname
4 20 ST Surname prefix from partner/spouse
5 50 ST Surname from partner/spouse
Only Surname is used in this specifications. Refer to Chapter 3.9. Segment
Component about the use/usage in this specifications.

3.10.31. SAD - street address


SEQ Length DT Content
1 120 ST Street or mailing address
2 50 ST Street name
3 12 ST Dwelling number
The explanation is omitted because the SAD type is not used in this specifications.

3.10.32. XAD - extended address


SEQ Length DT Content
1 184 SAD Street address
2 120 ST Other designation
3 50 ST City
4 50 ST State or province
5 12 ST Zip or postal code
6 3 ID Country
7 3 ID Address type
8 50 ST Other geographic designation
9 20 IS Country/Parish code
10 20 IS Census tract
11 1 ID Address representation code
12 53 DR Address validity range
13 26 TS Effective date
14 26 TS Expiration date
The explanation is omitted because the XAD type is not used in this specifications.

3.10.33. XPN - extended person name


SEQ Length DT Content
1 339 FN Family name
2 199 ST Given name
3 30 ST Second and further given names or initials thereof
4 20 ST Suffix (e.g.,JR or Ⅲ)
5 20 ST Prefix (e.g.,DR)
6 6 IS Degree (e.g.,MD)
7 1 ID Name type code
8 1 ID Name representation code
9 483 CWE Name context
10 53 DR Name validity range
11 1 ID Name assembly order
12 26 TS Effective date

77
V1.4.2

13 26 TS Expiration date
14 199 ST Professional suffix
Refer to Chapter 3.9. Segment Component about the use/usage in this specifications.

3.10.34. XTN - extended telecommunication number


SEQ Length DT Content
1 199 ST Telephone number
2 3 ID Telecommunication use code
3 8 ID Telecommunication equipment type
4 199 ST Email address
5 3 NM Country code
6 5 NM Area/City code
7 9 NM Local number
8 5 NM Extension
9 199 ST Any text
10 4 ST Extension prefix
11 6 ST Speed dial code
12 199 ST Unformatted telephone number
The explanation is omitted because the XAD type is not used in this specifications.

3.10.35. NA - numeric array


SEQ Length DT Content
1 16 NM Value1
2 16 NM Value2
3 16 NM Value3
4 16 NM Value4
...
This data type is used to represent a series (array) of numeric values. Refer to
Chapter 3.9. Segment Component about the use/usage in this specifications.

3.10.36. DLN - driver’s license number


SEQ Length DT Content
1 20 ST License number
2 20 IS Issuing state, province, country
3 24 DT Expiration date
The explanation is omitted because the DLN type is not used in this specifications.

3.10.37. DR - date/time range


SEQ Length DT Content
1 26 TS Range start date/time
2 26 TS Range end date/time
The explanation is omitted because the DR type is not used in this specifications.

3.10.38. RI - repeat interval


SEQ Length DT Content
1 6 IS Repeat pattern

78
Communication Specifications

2 199 ST Explicit time interval


The explanation is omitted because the RI type is not used in this specifications.

79
V1.4.2

4. Message Examples
4.1. Clinical Test Order
The order can be sent from the LIS to the BiOLiS when the order in the LIS was
determined. No example is in the first edition of this specifications.

4.2. Clinical Test Result


OUL^R23^OUL_R23

[VT]
MSH|^~¥&|^BiOLiS30i^||^Laboratory Information
System^||20160210^||OUL^R23^OUL_R23^^|20160210041339||2.5^&&&&&&
&&^&&&&&&&&||||||ASCII|||[CR]
PID|||0000999999^^^&&^^&&^^^&&&&&&&&^&&&&&&&&||&&&&^^^^^^
^^&&&&&&&&^^^&^&^||^||||||||||||||||||||||||||||||||[CR]
SPM||||SER^^^^^^^^|||||||||||||||||||||||||[CR]
SAC|||503050115^^^||||||||1^1^^|||||||||||||||||||||||||||||||||[C
R]
OBR|||||||||||||||||||||||||||||||||||||||||||||||||[CR]
OBX|1|CWE|1^Item001^^^^^^^|1|2.441^^^^^^^^|mg/dL^^^^^^^^|||||F||^
1|20160210040844^|||||[CR]
[FS][CR]

80
Communication Specifications

4.3. Patient Information Notification


ADT^A08^ADT_A01

[VT]
MSH|^~¥&|^Laboratory Information System||^BiOLiS30i||20160212||
ADT^A08^ADT_A01 |20160212||2.5||||||UNICODE UTF-8|||[CR]
EVN||20160212161713||||[CR]
PID|||0000777777||¥MEFBBBF¥¥XE38282E3828A¥^¥MEFBBBF¥¥XE381A8E
38197E3818A¥||19850303|M|||||||||||||||||||||||||||||||[CR]
[FS][CR]

ACK^A08^ACK

[VT]
MSH|^~¥¥&|^BiOLiS30i^||^Laboratory Information
System^||20160212^||ACK^A08^ACK^^|20160212175548||2.5^&&&&&&&&^
&&&&&&&&||||||ASCII|||[CR]
MSA|AA|20160212175548||||[CR]
[FS][CR]

4.4. Test Result Information Referral - Patient basis


No example in the first edition of this specifications.

4.5. Test Result Information Referral - Sample basis


No example in the first edition of this specifications.

81
V1.4.2

4.6. Test Order Information Referral


4.6.1. Sample Barcode Mode
QBP^WOS^QBP_Q11

[VT]
MSH|^~¥&|^BiOLiS30i^||^Laboratory Information
System^||20160210^||QBP^WOS^QBP_Q11^^|20160210052921||2.5^&&&&&
&&&^&&&&&&&&||||||ASCII|||[CR]
QPD|^^^^^^^^||^^^&&^^&&^^^&&&&&&&&^&&&&&&&&|160210000101^^
^|1^1^^[CR]
RCP|||||||[CR]
[FS][CR]

RSP^WOS^RSP_K11

[VT]
MSH|^~¥&|^Laboratory Information
System||^BiOLiS30i||20160210||RSP^WOS^RSP_K11|20160210||2.5||||||A
SCII|||[CR]
MSA|AA|20160210052921|||[CR]
QAK||OK|^^^^^^^^|||[CR]
QPD|^^^^^^^^|||160210000101||[CR]
SPM||||SER||||||||||||||||||||||||[CR]
OBR||||||||||||||||||||||[CR]
OBX|1||1^Item001||||||||[CR]
OBX|2||2^Item002||||||||[CR]
OBX|3||3^Item003||||||||[CR]
[FS][CR]

82
Communication Specifications

4.6.2. Sample Position Mode


QBP^WOS^QBP_Q11

[VT]
MSH|^~¥&|^BiOLiS30i^||^Laboratory Information
System^||20160212^||QBP^WOS^QBP_Q11^^|20160212111222||2.5^&&&&&&
&&^&&&&&&&&||||||ASCII|||[CR]
QPD|^^^^^^^^||^^^&&^^&&^^^&&&&&&&&^&&&&&&&&|160210000101^^^
|1^3^^[CR]
RCP|||||||[CR]
[FS][CR]

RSP^WOS^RSP_K11
[VT]
MSH|^~¥&|^Laboratory Information
System||^BiOLiS30i||20160212||RSP^WOS^RSP_K11|20160212||2.5||||||U
NICODE UTF-8|||[CR]
MSA|AA|20160212111222|||[CR]
QAK||OK|^^^^^^^^|||[CR]
QPD|^^^^^^^^||0000888888||1^3^^|[CR]
SPM||||SER||||||||||||||||||||||||[CR]
OBR||||||||||||||||||||||[CR]
OBX|1||2^Item002||||||||[CR]
OBX|3||6^Item006||||||||[CR]
[FS][CR]

83
V1.4.2

Communication Specifications
Version 1.4.2
Oct. 15, 2018
Printed in Japan

84

You might also like