F 8 Series & F9000X LIS Communication Protocol
F 8 Series & F9000X LIS Communication Protocol
RD-0110-01
1/ 55
Table of Contents
Chapter 1 Upgrade Record .................................................................................................. 4
1.1 Document Upgrade Record .............................................................................. 4
Chapter 2 Descriptions of LIS Communication Protocol................................................. 5
2.1 HL7 Interface Overview .................................................................................... 5
2.1.1 Connection ........................................................................................................ 5
2.1.2 Data sending..................................................................................................... 5
2.1.3 Disconnection ................................................................................................... 6
2.2 HL7 Message Layer Protocol ........................................................................... 6
2.2.1 HL7 upper layer message protocol .................................................................. 6
2.2.2 HL7 lower layer message protocol ................................................................... 6
Chapter 3 Introductions of HL7........................................................................................... 8
3.1 Basic Syntax of HL7 ......................................................................................... 8
3.1.1 Message structure rules ................................................................................... 8
3.1.2 String escape rules ........................................................................................... 8
3.2 HL7 Data Types ................................................................................................ 9
3.3 Message Types................................................................................................. 9
3.3.1 Reporting of observational results .................................................................... 9
3.3.2 Request information query ............................................................................. 10
3.4 Segment Descriptions ..................................................................................... 11
3.4.1 MSH ................................................................................................................ 12
3.4.2 MSA ................................................................................................................ 14
3.4.3 PID .................................................................................................................. 16
3.4.4 OBR ................................................................................................................ 17
3.4.5 OBX ................................................................................................................ 21
3.4.6 QRD ................................................................................................................ 24
3.4.7 QRF ................................................................................................................ 25
3.4.8 ERR ................................................................................................................ 27
3.4.9 QAK ................................................................................................................ 27
3.4.10 DSP................................................................................................................. 28
3.4.11 DSC ................................................................................................................ 32
Chapter 4 Example of complete message ....................................................................... 34
4.1 Reporting of sample observational results ..................................................... 34
4.2 Reporting of QC Results................................................................................. 34
2/ 55
4.3 Query the Request Information of the Sample with Specified Barcode......... 35
4.4 Query the Request Information of the Sample in Specified Period ............... 36
Appendix A: Definition of HL7 Data Types ....................................................................... 40
Appendix B: OBX-3 Parameter Type Codes .................................................................... 43
Appendix C: Unit of Observation Items ............................................................................ 52
Appendix D: OBX-5 Observation Result Data .................................................................. 53
Appendix E: Base64 Encoding Flows............................................................................... 54
3/ 55
Chapter 1 Upgrade Record
Reason
Contents
Reason
Contents
4/ 55
Chapter 2 Descriptions of LIS Communication
Protocol
The definition of this communication protocol is based on the HL7 standard (an electronic
data exchange standard in the medical field). The standard was originally defined by the
US-based Health Level Seven Committee and has been widely adopted by many countries.
The definition of this protocol is based on HL7 v2.4. Please refer to HL7 Interface Standards
Version 2.4 for the details about HL7.
Communication process
2.1.1 Connection
After startup, the instrument software will automatically connect to LIS server. Upon
successful connection, the software will maintain the link to ensure data can be sent at any
time. In case of disconnection when the software is still running, the software will try to
reconnect to the server.
While intending to query the sample request information, the instrument will send a query
message, which contains such information as sample number and period of time. LIS will
query the sample information according to sample number, period of time and other related
information and make a response using HL7 messages. Then the instrument software
performs subsequent operations according to the received message. If no response
message is received 10s after the query message is sent, a query failure has occurred.
5/ 55
2.1.3 Disconnection
When the instrument software quits operation, it will automatically close the communication
link. While changing any communication setting, the software will also close the current link
and connect to LIS according to the latest settings.
Message strings are organized according to the HL7 standard. In detail, a message consists
of multiple segments, each message is divided into multiple fields, each field is divided into
multiple components and each component is divided into multiple sub components.
Segment, field, component and sub component are spaced by separators.
PID|1||987654321||Mark||19810506000000|M
OBR|1|123456789||maccura|Y||||0
OBX|1|ST|704-7^BAS#^LN|TSH|+||||||F
OBX|2|ED|706-2^BAS%^LN|AFP|^Application^Octer-stream^Base64^AQIDBAUGBxE6S1xtfo+g/v8=||||||F
Where,
ASCII <VT>, also <0x0B>. Do not confuse with SOH or STX in ASCII.
dddd is defined as the valid data of HL7 message and expressed through UTF-8 coded
character string.
6/ 55
<EB> = End Block character (1 byte)
ASCII <FS>, also <0x1C>. Do not confuse with ASCII character ETX or EOT.
7/ 55
Chapter 3 Introductions of HL7
3.1 Basic Syntax of HL7
3.1.1 Message structure rules
A HL7 message consists of some segments. Each segment ends with character <CR>.
Each segment consists of a three-character segment name and a variable number of fields.
Each field comprises components and sub components. Separators are defined in the MSH
segment of each message for field, component and sub-component.
For example,
Where,
The five characters following MSH define the separators that differentiate fields,
components and sub components. These characters can be any non-text characters.
However, the HL7 standard recommends the characters in the following table:
Character Meaning
| Field separator
^ Component separator
~ Repetition separator
\ Escape character
The first field of MSH contains all the separators. Some of the following fields are empty
because they are optional and not used by the HL7 interface of instrument software.
Detailed field definitions and selections are given in other chapters.
For any type of message, the segments following MSH have constant sequences, which will
be detailed in the following sections.
8/ 55
Escape character Original characters
sequence
Note: ‘\’ in the escape string sequence represents an escape separator with its value defined
in the MSH segment.
Instrument
9/ 55
Message ORU^R01: Mainly used for the transmission of observational results and quality
control (QC) data.
Note: The segment in [ ] is optional and the segment in {} can be repeated once or several times.
Instrument
Message QRY^Q01: Used to query the necessary sample request information in LIS.
10/ 55
QRY Query Message Descriptions
Message DSR^Q01: Mainly used to send and display query results. In detail, LIS is enabled
to send the necessary sample request information to instruments.
[ERR] Error
Note: The segment in [ ] is optional and the segment in {} can be repeated once or several times.
1. No.: A HL7 segment starts with a three-character segment name. Each field separator
is followed by the contents of one field and the number indicates the sequence of a field in
the HL7 segment.
Example:
PID | 1 | |987654321||Mark||19810506000000|M
↑ ↑ ↑
Note: MSH segments differ slightly. The field separator closely following the segment name is regarded as
the first field to describe the value of the field separator used for the entire message.
11/ 55
2. Field name: Logical meaning of a field.
3. Data type: These fields are of HL7 standard types and their structures are described in
Subsection 0.
3.4.1 MSH
The segment MSH (Message Header) contains the basic information of HL7 message, such
as message separator value, message type and message encoding mode. It is also the first
segment of each HL7 message.
Example message:
See the table below for the definition of each field in a MSH segment:
12/ 55
F 800: Hematology analyzer
G 01: Glycosylated
hemoglobin analyzer
i 1000: Immunoassay
equipment
i 3000: Immunoassay
equipment
RIS: Intermediate
In ACK message, it is
consistent with the
13/ 55
previously received
message.
3.4.2 MSA
MSA (Message Acknowledgment) segment contains message acknowledgment
information.
Example message:
MSA|AA|1
See the table below for the definition of each field in a MSA segment:
“AE”: Error;
"AR”: Rejected;
14/ 55
Table 3 List of Error Codes
Succeeded: AA
15/ 55
202 Unsupported processing id The processing ID is not
supported
3.4.3 PID
PID (Patient Identification) segment contains the basic information of a patient.
Example message:
PID|1||987654321||Mark|37&Y|19810506000000|M
See the table below for the definition of each field in a PID segment:
16/ 55
4 Alternate CX 20 Bed No. 2
Patient ID
– PID
D: Day
H: Hour
8 Sex IS 1 Genders. M
“M”: Male
“F”: Female
“U”: Unknown
3.4.4 OBR
OBR (Observation Request) segment mainly contains observation report information.
Example message:
17/ 55
OBR|1|123456789||maccura|Y||||0
See the table below for the definition of each field in OBR during the transmission of
patient’s sample observation results (when MSH-11 is P):
18/ 55
subject to the time of
UTC+0.
CBC
DIFF
RET
AWS
Relevant
PCF
13 clinical ST 60 CBC+A1C+CRP
information Test modes of G 01
equipment:
A1C
CHEM
SED
CRP
19/ 55
15 Specimen SPS 300 Sample type, the default serum
Source values are as follows:
Serum
Plasma
Whole blood
Urine
CSF
Other
See the table below for the definition of each field in OBR during the transmission of item
QC test results (when MSH-11 is Q):
20/ 55
7 Observation TS 26 Time of starting QC test 20180124100000
Date/Time (form:
YYYYMMDDHHmmSS),
subject to the time of
UTC+0.
12 Danger CE 60 QC method
Code
3.4.5 OBX
OBX (Observation Result) segment mainly contains the parameter information of
observation results.
Example message:
OBX|1|NM|6690-2^WBC^LN |WBC|5.32|10*9/L|10.00-11.00|L|||F
See the table below for the definition of each field in an OBX segment:
21/ 55
1 Set ID - SI 10 Serial number, used to 1
OBX identify different OBX
segments in a message.
ST: String;
NM: Number;
Its form is
“ID^Name^EncodeSys”.
ID is the observation item
identification, Name is the
description of observation
items and EncodeSys is
the encoding system of
observation items. Refer
to Subsection 0for the
encoding values of each
observation item.
22/ 55
Value results can be number,
string, byte array, image
data, etc. See Subsection
0for the specific value of
each field. Byte array and
image data are converted
by Base64 encoding
method. See Subsection
0 for the encoding method
“N”: Normal
23/ 55
10 Nature of ID 20 Qualitative reference 5
Abnormal values
Test
3.4.6 QRD
QRD (Query Definition) segment mainly contains query parameter information.
Example message:
QRD|20180124022123|R|I|1|||9999^RD|123456789|OTH|||T
See the table below for the definition of each field in a QRD segment:
24/ 55
subject to the time of
UTC+0.
ASSAY_RESULT: Acquire
the latest result of the
observation item;
OTH: No special
requirements for query
results;
3.4.7 QRF
QRF (Query Filter) segment is used together with QRD to further refine the original query
contents.
Example message:
QRF|F 800|20180124022123|20180124032123|||RCT|COR|ALL
See the table below for the definition of each field in a QRF segment:
25/ 55
Table 9 Definition of QRF Fields
i 1000: Immunoassay
equipment
i 3000: Immunoassay
equipment
RIS: Intermediate
26/ 55
Qualifier
3.4.8 ERR
ERR (Error) segment is used to add error descriptions to acknowledge messages.
Example message:
ERR|203
See the table below for the definition of each field in an ERR segment:
3.4.9 QAK
QAK (Query Acknowledgment) segment contains some information that follows query
response.
Example message:
27/ 55
QAK|SR|OK
See the table below for the definition of each field in a QAK segment:
3.4.10 DSP
DSP (Display Data) segment is used to display the sample request information and patient
information obtained through queries. It can be repeated.
Example message:
DSP|1||BingLiHao1
See the table below for the definition of each field in a DSP segment:
28/ 55
3 Data Line * 300 Data line, contents obtained BingLiHao1
through queries
5 Result ID TX 20 Result ID
Field DSP-1 has designated the type of sample property and field DSP-3 indicates the value
of sample property.
See the table below for the type code and value of each property for the sample request
information. Where, sample barcode (type code: 21) and sample number (type code: 22)
are required properties.
As for those devices using modes to differentiate sample measurement tasks, such as F
800, G01, U 2000 and P 100, test mode (type code: 29) will be a required property.
With regard to the devices using items to be tested to differentiate sample measurement
tasks, such as i 1000, i 3000 and P 300, item information (type code: 1000) will be a
required property. When the sample contains more than one item to be tested, the
number will steadily increase from 1000 with the maximum increment of 100.
For RIS (intermediate) and LMS (Line Management System), both test mode (type code: 29)
and item information (type code: 1000) are required properties.
6 Blood type
string,O、A、B、AB
7 Ethnicity string
29/ 55
8 Patient address string
9 Postcode string
18 Ethnicity string
20 Country string
30/ 55
Serum
Plasma
Whole blood
Urine
CSF
Other
28 Referring string
department
CBC
DIFF
RET
AWS
PCF
A1C
29 Test modes
Test mode of U 2000 equipment:
CHEM
SED
CRP
CRP+CBC+DIFF+A1C
Note: For F 800, G 01, U 2000, P 100, RIS and LMS, this field is
required.
31/ 55
30 Re-examination? char, Y: Yes, N: No
Y: Year
D: Day
H: Hour
1000 Item information string, describe the information of items to be tested for the
sample, format:
Note 1: For i 1000, i 3000, P 300, RIS and LMS, this field is required.
… Item information string, describe the information of items to be tested for the
sample, have the same format as above.
3.4.11 DSC
DSC (Continuation Pointer Segment) is used to indicate whether it is the latest data
message in the response message.
32/ 55
1 Continuation ST 180 Continuation pointer. If this field is N
pointer empty, it indicates that the current
data is the last piece of data.
Otherwise, there is subsequent
data information.
While querying sample request information, one DSR information can only respond to one
piece of sample information. When multiple pieces of sample information exist, DSC
segment can be added after the DSR message to indicate the existence of subsequent
sample information.
33/ 55
Chapter 4 Example of complete message
Taking the sample as a unit, the instrument software sends sample observation results to
LIS server. In other words, a sample and the observation results contained herein are sent
as a message. After judging the message, LIS server makes a corresponding response.
<SB>MSH|^~\&|F 800|1268-1478a123|||20180123075742||ORU^R01|1|P|2.4||||||UTF-8<CR>
PID|1||987654321||Mark||19810506000000|M<CR>
OBR|1|123456789||maccura|Y||||0<CR>
OBX|0|NM|6690-2^WBC^LN|WBC|3.14|10*3/uL|||||F<CR>
OBX|1|ST|704-7^BAS#^LN|TSH|+||||||F<CR>
OBX|2|ED|F800-IMG1^DIFF image^99MRC||^Image^BMP^Base64^.…DIFF histogram data… ||||||F<CR>
OBX|3|ED|F800-IMG2^WPC image^99MRC||^Image^BMP^Base64^...WPC histogram data…||||||F<CR>
OBX|4|ED|F800-WARN2^NEUTROPENIA^99MRC||Neutropenia||||||F<CR>
<EB><CR>
After receiving the message, LIS server firstly judges the conformity and type of this
message and then make corresponding response. The response under normal conditions is
shown as follows:
<SB>MSH|^~\&|||F 800|1268-1478a123|20180123075743||ACK^R01|1|P|2.4||||||UTF-8<CR>
MSA|AA|1<CR>
<EB><CR>
If LIS server detects an error in the received ORU message, the corresponding error code
can be set in the MSA segment and then returned. If the rejection error (error code 206)
occurs to LIS server, the ACK message in response is
<SB>MSH|^~\&|||F 800|1268-1478a123|20180123075743||ACK^R01|1|P|2.4||||||UTF-8<CR>
MSA|AR|1|Application record locked|||206<CR>
<EB><CR>
Note: The ID (MSH-10) of the response message must be the same as that of the sample message;
34/ 55
<EB><CR>
The only difference between QC response message and sample response message lies in
that the value of field MSH-11 is Q.
<SB>MSH|^~\&|||F 800|1268-1478a123|20180123075743||ACK^R01|1|Q|2.4||||||UTF-8<CR>
MSA|AA|1<CR>
<EB><CR>
Note: The ID (MSH-10) of the response message must be the same as that of the QC message;
The value of MSH-9 message type field is QRY^Q01. Fill QRD-8 with sample number. In this
example, fill the field with SampleID1.
LIS query request message contains sample number. After receiving the message, LIS
queries the patient and sample information response corresponding to the sample.
<SB>MSH|^~\&|||F 800|1268-1478a123|20180125062610||DSR^Q01|1|P|2.4||||||UTF-8<CR>
MSA|AA|1<CR>
QRD|20180125062608|R|I|a47d7494-0b97-46bc-a0fe-aa491a844c2f|||^RD|SampleID1|OTH|||T<CR>
QRF| F 800|||||RCT|COR|ALL<CR>
DSP|1||BingLiHao1<CR>
DSP|2||ChuangHao1<CR>
DSP|3||Name1<CR>
DSP|4||19870609102137<CR>
DSP|5||M<CR>
DSP|6||A<CR>
DSP|7||ZhongZu1<CR>
DSP|8||DiZhi1<CR>
DSP|9||CountryCode1<CR>
DSP|10||HomePhoneNumber1<CR>
DSP|11||SamplePosition1<CR>
35/ 55
DSP|12||20171221080102<CR>
DSP|13||HunYin1<CR>
DSP|14||ZongJiao1<CR>
DSP|15||InPatient<CR>
DSP|16||SheBaoZhangHao1<CR>
DSP|17||own<CR>
DSP|18||MinZu1<CR>
DSP|19||JiGuan1<CR>
DSP|20||GuoJia1<CR>
DSP|21||TiaoMa1<CR>
DSP|22||YangBenHao1<CR>
DSP|23||20171221080102<CR>
DSP|24||Y<CR>
DSP|25||1.1<CR>
DSP|26||serum<CR>
DSP|27||Doctor1<CR>
DSP|28||Department1<CR>
DSP|29||CBC<CR>
DSP|30||31<CR>
DSP|31||Y<CR>
<EB><CR>
Note: The ID (MSH-10) of the response message must be the same as that of the query request
message;
<SB>MSH|^~\&|||F 800|1268-1478a123|20180125062610||DSR^Q01|1|P|2.4||||||UTF-8<CR>
MSA|AE|8<CR>
<EB><CR>
The value of MSH-9 message type field is QRY^Q01. Fill QRF-2 with the start time of
receiving sample and QRF-3 with the end time of receiving sample.
36/ 55
The LIS query request message contains the sample receiving period. After receiving the
request, LIS queries the patient corresponding to the sample and responds to the sample
information. Each response message contains the complete information of one sample. If
multiple pieces of sample information exist, use DSC section to indicate whether there is
any subsequent sample information.
If there are three samples that have met criteria in the specified period, three messages will
be continuously given as response. The first response message is as follows:
<SB>MSH|^~\&|||F 800|1268-1478a123|20180125062610||DSR^Q01|1|P|2.4||||||UTF-8<CR>
MSA|AA|1<CR>
QRD|20180125062608|R|I|a47d7494-0b97-46bc-a0fe-aa491a844c2f|||^RD| |OTH|||T<CR>
QRF| F 800|20180125000000|20180125235959|||RCT|COR|ALL<CR>
DSP|1||BingLiHao1<CR>
DSP|2||ChuangHao1<CR>
DSP|3||Name1<CR>
DSP|4||19870609102137<CR>
DSP|5||M<CR>
DSP|6||A<CR>
DSP|7||ZhongZu1<CR>
DSP|8||DiZhi1<CR>
DSP|9||CountryCode1<CR>
DSP|10||HomePhoneNumber1<CR>
DSP|11||SamplePosition1<CR>
DSP|12||20171221080102<CR>
DSP|13||HunYin1<CR>
DSP|14||ZongJiao1<CR>
DSP|15||InPatient<CR>
DSP|16||SheBaoZhangHao1<CR>
DSP|17||own<CR>
DSP|18||MinZu1<CR>
DSP|19||JiGuan1<CR>
DSP|20||GuoJia1<CR>
DSP|21||TiaoMa1<CR>
DSP|22||YangBenHao1<CR>
DSP|23||20171221080102<CR>
DSP|24||Y<CR>
DSP|25||1.1<CR>
DSP|26||serum<CR>
DSP|27||Doctor1<CR>
DSP|28||Department1<CR>
DSP|29||CBC<CR>
DSP|30||31<CR>
DSP|31||Y<CR>
DSC|1<CR>
37/ 55
<EB><CR>
Note: The ID (MSH-10) of the first response message must be the same as that of the query request
message;
<SB>MSH|^~\&|||F 800|1268-1478a123|20180125062610||DSR^Q01|2|P|2.4||||||UTF-8<CR>
MSA|AA|1<CR>
QRD|20180125062608|R|I|a47d7494-0b97-46bc-a0fe-aa491a844c2f|||^RD| |OTH|||T<CR>
QRF| F 800|20180125000000|20180125235959|||RCT|COR|ALL<CR>
DSP|1||BingLiHao2<CR>
DSP|2||ChuangHao2<CR>
DSP|3||Name2<CR>
DSP|4||19970609112137<CR>
DSP|5||F<CR>
DSP|6||B<CR>
DSP|7||ZhongZu2<CR>
DSP|8||DiZhi2<CR>
DSP|9||CountryCode2<CR>
DSP|10||HomePhoneNumber2<CR>
DSP|11||SamplePosition2<CR>
DSP|12||20171221080102<CR>
DSP|13||HunYin2<CR>
DSP|14||ZongJiao2<CR>
DSP|15||InPatient<CR>
DSP|16||SheBaoZhangHao2<CR>
DSP|17||own<CR>
DSP|18||MinZu2<CR>
DSP|19||JiGuan2<CR>
DSP|20||GuoJia2<CR>
DSP|21||TiaoMa2<CR>
DSP|22||YangBenHao2<CR>
DSP|23||20171221080102<CR>
DSP|24||N<CR>
DSP|25||2.2<CR>
DSP|26||urine<CR>
DSP|27||Doctor2<CR>
DSP|28||Department2<CR>
DSP|29||CBC+DIFF+CRP<CR>
DSP|30||21<CR>
DSP|31||Y<CR>
DSC|1<CR>
<EB><CR>
The last response message is as follows. Note that it has no DSC segment.
38/ 55
<SB>MSH|^~\&|||F 800|1268-1478a123|20180125062610||DSR^Q01|3|P|2.4||||||UTF-8<CR>
MSA|AA|1<CR>
QRD|20180125062608|R|I|a47d7494-0b97-46bc-a0fe-aa491a844c2f|||^RD| |OTH|||T<CR>
QRF| F 800|20180125000000|20180125235959|||RCT|COR|ALL<CR>
DSP|1||BingLiHao3<CR>
DSP|2||ChuangHao3<CR>
DSP|3||Name3<CR>
DSP|4||20170609112137<CR>
DSP|5||F<CR>
DSP|6||B<CR>
DSP|7||ZhongZu3<CR>
DSP|8||DiZhi3<CR>
DSP|9||CountryCode3<CR>
DSP|10||HomePhoneNumber3<CR>
DSP|11||SamplePosition3<CR>
DSP|12||20171221080102<CR>
DSP|13||HunYin3<CR>
DSP|14||ZongJiao3<CR>
DSP|15||InPatient<CR>
DSP|16||SheBaoZhangHao3<CR>
DSP|17||own<CR>
DSP|18||MinZu3<CR>
DSP|19||JiGuan3<CR>
DSP|20||GuoJia3<CR>
DSP|21||TiaoMa3<CR>
DSP|22||YangBenHao3<CR>
DSP|23||20171221080102<CR>
DSP|24||Y<CR>
DSP|25||3.3<CR>
DSP|26||plasma<CR>
DSP|27||Doctor3<CR>
DSP|28||Department3<CR>
DSP|29||A1C+CBC+DIFF+AWS+CRP<CR>
DSP|30||11<CR>
DSP|31||Y<CR>
<EB><CR>
<SB>MSH|^~\&|||F 800|1268-1478a123|20180125062610||DSR^Q01|1|P|2.4||||||UTF-8<CR>
MSA|AE|8<CR>
<EB><CR>
39/ 55
Appendix A: Definition of HL7 Data Types
CE - Code Element
<identifier (ST)> ^ <text (ST)> ^ <name of coding system (IS)> ^ <alternate identifier(ST)> ^
<alternate text (ST)> ^ <name of alternate coding system (IS)>
⚫ CM – Composite
The format of the union consisting of other data fields that have respective meanings is
defined by specific fields.
<ID (ST)> ^ <check digit (ST)> ^ <code identifying the check digit scheme employed(ID)> ^
< assigning authority (HD)> ^ <identifier type code (ID)> ^ < assigning facility (HD)> ^
<effective date (DT)> ^ <expiration date (DT)>
⚫ ED – Encapsulate Data
<source application (HD)> ^ <type of data (ID)> ^ <data sub type (ID)> ^ <encoding (ID)> ^
<data (ST)>
⚫ EI - Entity Identifier
⚫ FC – Financial Class
⚫ FT - Formatted text
This data type is derived from the string data type by allowing the addition of embedded
formatting instructions. These instructions are limited to those that are intrinsic and
independent of the circumstances under which the field is being used.
⚫ HD - Hierarchic designator
40/ 55
<namespace ID (IS)> ^ <universal ID (ST)> ^ <universal ID type (ID)>
The value of such a field follows the formatting rules for an ST field except that it is drawn
from a site-defined (or user-defined) table of legal values. There shall be an HL7 table
number associated with IS data types.
The value of such a field follows the formatting rules for an ST field except that it is drawn
from a table of legal values. There shall be an HL7 table number associated with ID data
types.
⚫ NM – Numeric
⚫ PL - Person location
<point of care (IS)> ^ <room (IS)> ^ <bed (IS)> ^ <facility (HD)> ^ < location status (IS)> ^
<person location type (IS)> ^ <building (IS)> ^ <floor (IS)> ^ <location description (ST)>
⚫ PT - Processing type
⚫ SI - Sequence ID
A non-negative integer in the form of an NM field. The uses of this data type are defined
in the chapters defining the segments and messages in which it appears.
⚫ ST – String
⚫ TS - Time stamp
41/ 55
⚫ VID - Version identifier
<ID number (ST)> ^ <family name (FN)> ^ <given name (ST)> ^ <second and further given
names or initials thereof (ST)> ^ <suffix (e.g., JR or III) (ST)> ^ <prefix (e.g., DR) (ST)> ^
<degree (e.g., MD) (ST)> ^ <source table (IS)> ^ <assigning authority (HD)> ^ <name type
code (ID)> ^ <identifier check digit (ST)> ^ <code identifying the check digit scheme
employed (ID)> ^ <identifier type code (IS)> ^ <assigning facility (HD)> ^ <name
representation code (ID)> ^ <name context (CE)> ^ <name validity range (DR)> ^ <name
assembly order (ID)>
<family name (FN)> ^ <given name (ST)> & <second and further given names or initials
thereof (ST)> ^ <suffix (e.g., JR or III) (ST)> ^ <prefix (e.g., DR) (ST)> ^ <degree (e.g., MD)
(IS)> ^ <name type code (ID) > ^ <name representation code (ID)> ^ <name context (CE)> ^
<name validity range (DR)> ^ <name assembly order (ID)>
42/ 55
Appendix B: OBX-3 Parameter Type Codes
Each OBX segment contains one check parameter or other data item information. OBX-2
indicates the HL7 data type of carried data items. OBX-3 (Observation Identifier) is the
identifier of data item with the expression of “ID^Name^EncodeSys”. OBX-5 contains the
value of data item and OBX-6 contains ISO standard units for parameter items.
The value range of OBX segment for F 800, G 01, U 2000 and P 100 is respectively
described in the following subsections.
Data item Type Unit Code (ID) Name Example of OBX-3 Corre
descriptions (OBX-2 (OBX-6) fields spond
) ing
test
mode
Data items of observation results
Number of white NM 10*9/L 6690-2 WBC 6690-2^WBC^LN CBC
blood cells
Number of red NM 10*12/L 789-8 RBC 789-8^RBC^LN CBC
blood cells
Hemoglobin NM g/L 718-7 HGB 718-7^HGB^LN CBC
concentration
Hematocrit NM % 4544-3 HCT 4544-3^HCT^LN CBC
Mean corpuscular NM fL 62242-3 MCV 62242-3^MCV^LN CBC
volume
Mean corpuscular NM pg 62243-1 MCH 62243-1^MCH^LN CBC
hemoglobin
content
Mean corpuscular NM g/L 62246-4 MCHC 62246-4^MCHC^L CBC
hemoglobin N
concentration
Platelets NM 10*9/L 777-3 PLT 777-3^PLT^LN CBC
Standard NM fL 21000-5 RDW-SD 21000-5^RDW-SD CBC
deviation of red ^LN
cell distribution
width
Variation NM % 62247-2 RDW-CV 62247-2^RDW-CV CBC
coefficient of red ^LN
blood cell
distribution width
Platelet NM fL 32207-3 PDW 32207-3^PDW^LN CBC
distribution width
Average platelet NM fL 32623-1 MPV 32623-1^MPV^LN CBC
volume
43/ 55
Number of large NM 10*9/L 34167-7 P-LCC 34167-7^P-LCC^L CBC
platelets N
Platelet-large cell NM % 48386-7 P-LCR 48386-7^P-LCR^L CBC
ratio N
Thrombocytocrit NM % 51637-7 PCT 51637-7^PCT^LN CBC
Number of NM 10*9/L 30392-5 NRBC# 30392-5^NRBC#^ CBC
nucleated red LN
blood cells
Percentage of NM % 19048-8 NRBC% 19048-8^NRBC% CBC
nucleated red ^LN
blood cells
Neutrophil number NM 10*9/L 751-8 NEUT# 751-8^NEUT#^LN DIFF
Number of NM 10*9/L 731-0 LYMPH# 731-0^LYMPH#^L DIFF
lymphocytes N
Number of NM 10*9/L 742-7 MONO# 742-7^MONO#^L DIFF
monocytes N
Eosinophil number NM 10*9/L 711-2 EO# 711-2^EO#^LN DIFF
Basophil number NM 10*9/L 704-7 BAS# 704-7^BAS#^LN DIFF
Percentage of NM % 71676-1 NEUT% 71676-1^NEUT%^ DIFF
neutrophils LN
Percentage of NM % 71678-7 LYMPH% 71678-7^LYMPH DIFF
lymphocytes %^LN
Percentage of NM % 71677-9 MONO% 71677-9^MONO% DIFF
monocytes ^LN
Eosinophil NM % 71679-5 EO% 71679-5^EO%^LN DIFF
percentage
Basophil NM % 706-2 BAS% 706-2^BAS%^LN DIFF
percentage
Number of NM 10*9/L 53115-2 IG# 53115-2^IG#^LN DIFF
immature
granulocytes
Percentage of NM % 71695-1 IG% 71695-1^IG%^LN DIFF
immature
granulocytes
Reticulocyte NM % 17849-1 RET% 17849-1^RET%^L RET
percentage N
Reticulocyte NM 10*9/L 60474-4 RET# 60474-4^RET#^L RET
number N
Immature NM % 33516-6 IRF 33516-6^IRF^LN RET
reticulocyte ratio
Ratio of NM % 82591-9 LFR 82591-9^LFR^LN RET
reticulocytes with
low fluorescence
44/ 55
intensity
Ratio of NM % 82592-7 MFR 82592-7^MFR^LN RET
reticulocytes with
medium
fluorescence
intensity
Ratio of NM % 51642-7 HFR 51642-7^HFR^LN RET
reticulocytes with
high fluorescence
intensity
Hemoglobin NM % 71694-4 RET-He 71694-4^RET-He^ RET
content of LN
reticulocytes
Immature platelet NM % 71693-6 IPF 71693-6^IPF^LN PCF
ratio (index)
White blood cell NM 10*9/L F800-ST1 WBC-A F800-ST1^WBC-A AWS
count calculated ^99MRC
from FCA channel
Total number of NM 10*9/L F800-ST2 TNC-A F800-ST2^TNC-A AWS
nucleated cells ^99MRC
calculated from
FCA channel
Intermediate data of observation results (WBC, RBC, PLT histogram and scattergram data)
WDF histogram ED F800-IMG1 WDF F800-IMG1^WDF
N/A N/A
bitmap data image image^99MRC
WNR histogram ED F800-IMG2 WNR F800-IMG2^WNR
N/A N/A
bitmap data image image^99MRC
RBC histogram ED F800-IMG3 RBC image F800-IMG3^RBC
N/A N/A
bitmap data image^99MRC
PLT histogram ED F800-IMG4 PLT image F800-IMG4^PLT
N/A N/A
bitmap data image^99MRC
WPC histogram ED F800-IMG5 WPC F800-IMG5^WPC
N/A N/A
bitmap data image image^99MRC
RET histogram ED F800-IMG6 RET image F800-IMG6^RET
N/A N/A
bitmap data image^99MRC
PLTF histogram ED F800-IMG7 PLTF F800-IMG7^PLTF
N/A N/A
bitmap data image image^99MRC
IP alarm information
F800-WARN1^W
Leukocyte WBC ABN
BC ABN
scattergram WR N/A F800-WARN1 SCATTER N/A
SCATTERGRAM^
abnormal GRAM
99MRC
Neutrophil NEUTROP F800-WARN2^NE
WR N/A F800-WARN2 N/A
decreased ENIA UTROPENIA^99M
45/ 55
RC
F800-WARN3^NE
Neutrophil NEUTROP
WR N/A F800-WARN3 UTROPHILIA^99 N/A
increased HILIA
MRC
F800-WARN4^LY
Lymphopenia LYMPHOP
WR N/A F800-WARN4 MPHOPENIA^99 N/A
decreased ENIA
MRC
F800-WARN5^LY
Lymphocyte LYMPHOC
WR N/A F800-WARN5 MPHOCYTOSIS^ N/A
increased YTOSIS
99MRC
F800-WARN6^M
Monocyte MONOCYT
WR N/A F800-WARN6 ONOCYTOSIS^99 N/A
increased OSIS
MRC
F800-WARN7^EO
Eosinophil EOSINOP
WR N/A F800-WARN7 SINOPHILIA^99M N/A
increased HILIA
RC
F800-WARN8^BA
Basophils BASOPHIL
WR N/A F800-WARN8 SOPHILIA^99MR N/A
increased IA
C
F800-WARN9^LE
Leukocyte count LEUKOCY
WR N/A F800-WARN9 UKOCYTOPENIA N/A
decreased TOPENIA
^99MRC
F800-WARN10^L
White blood cell LEUKOCY
WR N/A F800-WARN10 EUKOCYTOSIS^9 N/A
count increased TOSIS
9MRC
F800-WARN11^N
Nucleated red
NRBC RBC
blood cell WR N/A F800-WARN11 N/A
PRESENT PRESENT^99MR
increased
C
F800-WARN12^I
Immature
IG G
granulocyte WR N/A F800-WARN12 N/A
PRESENT PRESENT^99MR
increased
C
BLASTSO F800-WARN13^B
Primitive
R LASTSOR
cells/abnormal WR N/A F800-WARN13 N/A
ABNLYMP ABNLYMPHO
lymphocytes?
HO S S^99MRC
F800-WARN14^A
Atypical ATYPICAL
WR N/A F800-WARN14 TYPICALLYMPH N/A
lymphocyte LYMPHO S
O S^99MRC
F800-WARN15^L
Left shift LEFT
WR N/A F800-WARN15 EFT SHIFT N/A
abnormal? SHIFT S
S^99MRC
Red blood cell WR N/A F800-WARN16 RBC ABN F800-WARN16^R N/A
46/ 55
histogram DISTRIBU BC ABN
abnormal TION DISTRIBUTION^9
9MRC
DIMORPHI F800-WARN17^DI
Bimodal C MORPHIC
WR N/A F800-WARN17 N/A
erythrocyte POPULATI POPULATION^99
ON MRC
F800-WARN18^R
Reticulocyte RETICULO
WR N/A F800-WARN18 ETICULOCYTOSI N/A
increased CYTOSIS
S^99MRC
F800-WARN19^A
Red blood cell ANISOCYT
WR N/A F800-WARN19 NISOCYTOSIS^9 N/A
size uneven OSIS
9MRC
F800-WARN20^M
MICROCY
Microcytosis WR N/A F800-WARN20 ICROCYTOSIS^9 N/A
TOSIS
9MRC
F800-WARN21^M
MACROC
Macrocytosis WR N/A F800-WARN21 ACROCYTOSIS^ N/A
YTOSIS
99MRC
F800-WARN22^H
HYPOCHR
Hypopigmentation WR N/A F800-WARN22 YPOCHROMIA^9 N/A
OMIA
9MRC
F800-WARN23^A
Anaemia WR N/A F800-WARN23 ANEMIA N/A
NEMIA^99MRC
F800-WARN24^E
Erythrocyte ERYTHRO
WR N/A F800-WARN24 RYTHROCYTOSI N/A
increased CYTOSIS
S^99MRC
F800-WARN25^R
RBC
Erythrocyte BC
WR N/A F800-WARN25 AGGLUTI N/A
agglutination? AGGLUTINATION
NATION S
S^99MRC
F800-WARN26^T
TURBIDIT
URBIDITY OR
Chyle? WR N/A F800-WARN26 Y OR HGB N/A
HGB INTERF
INTERF S
S^99MRC
IRON F800-WARN27^IR
Iron deficiency? WR N/A F800-WARN27 DEFICIEN ON DEFICIENCY N/A
CY S S^99MRC
F800-WARN28^H
Hemoglobin HGB
WR N/A F800-WARN28 GB DEFECT N/A
abnormal? DEFECT S
S^99MRC
F800-WARN29^F
Red blood cell FRAGMEN
WR N/A F800-WARN29 RAGMENT N/A
fragment? TS
S^99MRC
47/ 55
F800-WARN30^P
PLT ABN
Platelet histogram LT ABN
WR N/A F800-WARN30 DISTRIBU N/A
abnormal DISTRIBUTION^9
TION
9MRC
THROMB F800-WARN31^T
Platelet decreased WR N/A F800-WARN31 OCYTOPE HROMBOCYTOP N/A
NIA ENIA^99MRC
THROMB F800-WARN32^T
Platelet increased WR N/A F800-WARN32 OCYTOSI HROMBOCYTOSI N/A
S S^99MRC
F800-WARN33^P
Platelet PLT
WR N/A F800-WARN33 LT N/A
agglutination? CLUMPS
CLUMPS^99MRC
F800-WARN34^R
Reticulocyte RET ABN
ET ABN
scattergram WR N/A F800-WARN34 SCATTER N/A
SCATTERGRAM^
abnormal GRAM
99MRC
F800-WARN35^P
Platelet PLT ABN
LT ABN
scattergram WR N/A F800-WARN35 SCATTER N/A
SCATTERGRAM^
abnormal GRAM
99MRC
F800-WARN36^B
Primitive cell? WR N/A F800-WARN36 BLASTS S N/A
LASTS S^99MRC
F800-WARN37^A
Abnormal ABN
WR N/A F800-WARN37 BN LYMPHO N/A
lymphocytes? LYMPHO S
S^99MRC
48/ 55
A1a area ratio NM % G01-4 A1a NGSP G01-4^A1a A1C
NGSP^99MRC
A1b area ratio NM % G01-5 A1b NGSP G01-5^A1b A1C
NGSP^99MRC
F area ratio NM % G01-6 F NGSP G01-6^F NGSP^99MRC A1C
LA1c area ratio NM % G01-7 LA1c G01-7^LA1c A1C
NGSP NGSP^99MRC
P3 area ratio NM % G01-8 P3 NGSP G01-8^P3 A1C
NGSP^99MRC
P4 area ratio NM % G01-9 P4 NGSP G01-9^P4 A1C
NGSP^99MRC
A0 area ratio NM % G01-10 A0 NGSP G01-10^A0 A1C
NGSP^99MRC
V area ratio NM % G01-11 V NGSP G01-11^V NGSP^99MRC A1C
S area ratio NM % G01-12 S NGSP G01-12^S A1C
NGSP^99MRC
C area ratio NM % G01-13 C NGSP G01-13^C A1C
NGSP^99MRC
UK area ratio NM % G01-14 UK NGSP G01-14^UK A1C
NGSP^99MRC
Intermediate data of observation results (histogram and scattergram data).
Total area NM N/A G01-10 Total Area G01-1000^Total A1C
00 Area^99MRC
Alarm code WR N/A G01-10 Alarm G01-1001^Alarm A1C
01 Code Code^99MRC
Raw data ED N/A G01-10 Raw Data G01-1002^Raw A1C
02 Data^99MRC
Result data ED N/A G01-10 Result G01-1003^Result A1C
03 Data Data^99MRC
Hemoglobin ED N/A G01-10 Hb Image G01-1004^Hb A1C
image 04 Image^99MRC
49/ 55
Occult blood ST U2000-7 BLD U2000-7^BLD^99MRC CHEM
Protein ST U2000-8 PRO U2000-8^PRO^99MRC CHEM
Urine calcium ST U2000-9 Ca U2000-9^CA^99MRC CHEM
Creatinine ST U2000-1 Cr U2000-10^CR^99MRC CHEM
0
Glucose ST U2000-1 GLU U2000-11^GLU^99MRC CHEM
1
Micro-albumi ST U2000-1 MA U2000-12^MA^99MRC CHEM
n 2
Acetone ST U2000-1 KET U2000-13^KET^99MRC CHEM
3
White blood ST U2000-1 LEU U2000-14^LEU^99MRC CHEM
cell 4
Nitrite ST U2000-1 NIT U2000-15^NIT^99MRC CHEM
5
Chrominance ST U2000-1 COLOR U2000-16^COLOR^99MRC CHEM
6
Turbidity ST U2000-1 TURB U2000-17^TURB^99MRC CHEM
7
Crystal ST U2000-1 CRYS U2000-18^CRYS^99MRC SED
8
Transparent ST U2000-1 HYA U2000-19^HYA^99MRC SED
tube type 9
Bacteria ST U2000-2 BACT U2000-20^BACT^99MRC SED
0
Microzyme ST U2000-2 BYST U2000-21^BYST^99MRC SED
1
Viscose silk ST U2000-2 MUCS U2000-22^MUCS^99MRC SED
2
Non-squamo ST U2000-2 NEC U2000-23^NEC^99MRC SED
us epithelial 3
cells
Pathological ST U2000-2 PAT U2000-24^PAT^99MRC SED
tube type 4
Red blood ST U2000-2 RBC U2000-25^RBC^99MRC SED
cell 5
Squamous ST U2000-2 SEC U2000-26^SEC^99MRC SED
epithelial cell 6
Sperm ST U2000-2 SPRM U2000-27^SPRM^99MRC SED
7
Unknown ST U2000-2 UNKNOW U2000-28^UNKNOWN^99M SED
8 N RC
White blood ST U2000-2 WBC U2000-29^WBC^99MRC SED
50/ 55
cell 9
Leukocyte ST U2000-3 WBCC U2000-30^WBCC^99MRC SED
mass 0
Urinary tract ST U2000-3 UTI U2000-31^UTI^99MRC SED
infection 1
51/ 55
Appendix C: Unit of Observation Items
52/ 55
Appendix D: OBX-5 Observation Result Data
Observation results can be data types such as numbers, strings, byte arrays and images.
The following subsections describe their formats respectively.
The value of data type field in OBX-2 field is “ED” and the value of OBX-5 data field shows
the form of “^Application^Octer-stream^Base64^……Byte Array Data……”. Where,
“^Application^Octer-stream^Base64” indicates the transmission of byte array data that first
goes through gzip compression and then Base64 transcoding.
bmp image
The value of OBX-2 data type field is “ED” and the value of OBX-5 data field shows the form
of “^Image^BMP^Base64^……bmp image data……”. Where “^Image^BMP^Base64”
indicates the transmission of bmp image data that first goes through gzip compression and
then Base64 transcoding.
The value of OBX-2 data type field is “ED” and the value of OBX-5 data field shows the form
of “^Image^JPG^Base64^……jpg image data……”. Where “^Image^JPG^Base64” indicates
the transmission of jpg image data that first goes through gzip compression and then
Base64 transcoding.
The value of OBX-2 data type field is “ED” and the value of OBX-5 data field shows the form
of “^Image^PNG^Base64^……png image data……”. Where “^Image^PNG^Base64”
indicates the transmission of png image data that first goes through gzip compression and
then Base64 transcoding.
53/ 55
Appendix E: Base64 Encoding Flows
(1) Take three adjacent bytes (also 24bit) to be encoded from the data stream, divide them
into four 6-bit groups from left to right and then obtain corresponding ASCII strings after
mapping according to Table 15. See the following contents:
The 6-bit group obtained after division: 000101 011010 001101 001011
Corresponding characters: F a N L
0 A 17 R 34 i 51 z
1 B 18 S 35 j 52 0
2 C 19 T 36 k 53 1
3 D 20 U 37 l 54 2
4 E 21 V 38 m 55 3
5 F 22 W 39 n 56 4
6 G 23 X 40 o 57 5
7 H 24 Y 41 p 58 6
8 I 25 Z 42 q 59 7
9 J 26 a 43 r 60 8
10 K 27 b 44 s 61 9
11 L 28 c 45 t 62 +
12 M 29 d 46 u 63 /
13 N 30 e 47 v
54/ 55
14 O 31 f 48 w (pad) =
15 P 32 g 49 x
16 Q 33 h 50 y
(2) Repeat the encoding in Step (1) till the data stream encoding is completed.
When the remaining data is less than 3 bytes, fill 0 on the right side to make it up. If all the
6-bit groups obtained by encoding are composed of padding bits, they will be mapped to ‘=’
character. It can be known that there are two ‘=’ characters in the obtained coded string
when the remaining data has only one byte, and there is one ‘=’ character in the obtained
coded string when the remaining data has two bytes. The example of these two cases is
shown as follows:
The 6-bit group obtained after division: 000010 100000 000000 000000
Corresponding characters: C g = =
The 6-bit group obtained after division: 000010 100000 101100 000000
Corresponding characters: C g s =
55/ 55