6 0 888 KB
No.: R.RD-0110-01
LIS Communication Protocol (F 8 Series Automatic Hematology Analyzer)
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 1.1 Document Upgrade Record Version No. Version No.
01
Date of creation
March 30, 2020
Date of creation
Reason
Contents
Version No.
Date of creation
Reason
Contents
4/ 55
Chapter 2 Descriptions of LIS Communication Protocol 2.1 HL7 Interface Overview maccura now has different types of medical devices, such as F 800, G 01, U 2000 and P100. These devices communicate with LIS (Laboratory Information System) via Ethernet/serial interface to send observational results on observation instruments to LIS or receive sample request information from LIS. 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 Instrument software sends messages via network interface/serial interface. The communication process can be divided into three phases as follows.
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.
2.1.2 Data sending For instrument software, message sending is synchronous with message receiving. In detail, while sending a message, the software will always wait for an acknowledgment message. If an acknowledgment message is received within 10s, the process of message sending is completed and then the software will start sending the next message. If no acknowledgment message is received after 10s, the software deems a failure to send the message. Then it will skip this message and directly send the next message. 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.
2.2 HL7 Message Layer Protocol 2.2.1 HL7 upper layer message protocol The communication of sample results and other related data information complies with UTF-8 coded character strings. 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. Some HL7 message samples are presented as follows: MSH|^~\&|F 800|1268-1478a123|PC-1 LIS|PC-1|20180123075742||ORU^R01|1|P|2.4||||||UTF-8 PID|1||987654321||Mark||19810506000000|M OBR|1|123456789||maccura|Y||||0 OBX|0|NM|00008^XR QCR Mean^99MRC|FT4|3.1400000000000001||||||F 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
2.2.2 HL7 lower layer message protocol Known as a byte stream protocol, TCP/IP does not provide any message boundary. While serving as an upper layer protocol, HL7 is based on messages. It does not provide a message termination mechanism. In order to determine message boundaries, we have applied MLLP (Minimal Lower Layer Protocol) (you can find the corresponding description in HL7 Interface Standards Version 2.4). Messages are sent in the format below: ddddd Where, = Start Block character (1 byte) ASCII , also . Do not confuse with SOH or STX in ASCII. ddddd = Data (variable number of bytes) dddd is defined as the valid data of HL7 message and expressed through UTF-8 coded character string.
6/ 55
= End Block character (1 byte) ASCII , also . Do not confuse with ASCII character ETX or EOT.
= Carriage Return (1 byte) ASCII carriage return, also .
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 . 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, MSH|^~\&|F 800|1268-1478a123|PC-1 LIS|PC-1|20180123075742||ORU^R01|1|P|2.4||||||UTF-8
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
&
Sub 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.
3.1.2 String escape rules Escape separators may appear in ST, TX, FT, CT and other types of field data, such as remarks, diagnosis information, user-defined gender and other string data. Convert the separators in the original string into escape character sequences while encoding and restore them while decoding. The escape rules used by the HL7 interface are described as follows:
8/ 55
Escape character sequence
Original characters
\F\
Field separator
\S\
Component separator
\T\
Sub component separator
\R\
Repetition separator
\E\
Escape character
\X000d\
, also the terminator of a segment
Note: ‘\’ in the escape string sequence represents an escape separator with its value defined in the MSH segment.
3.2 HL7 Data Types All data information in a message is represented by different HL7 type fields. At present, only some of communication protocols provided by the HL7 standard have been used. For details, please refer to Subsection 0.
3.3 Message Types In the process of communication, four message structures, including ORU^R01, ACK^R01, QRY^Q01 and DSR^Q01, are involved in the HL7 communication protocol.
3.3.1 Reporting of observational results ORU^R01 and ACK^R01 appear in pair to send sample observational results (or quality control data) to LIS. See the schematic diagram below:
Instrument
9/ 55
Message ORU^R01: Mainly used for the transmission of observational results and quality control (QC) data. ORU
Observational Results (Unsolicited)
MSH
Descriptions Message Header
{ PID
Patient Information
{ OBR
Sample Information
{[OBX]}
Test Data
} }
Message ACK^R01: Acknowledge any received message ORU^R01. ACK
Acknowledgment
Descriptions
MSH
Message Header
MSA
Message Acknowledgment
Note: The segment in [ ] is optional and the segment in {} can be repeated once or several times.
3.3.2 Request information query QRY^Q01 and DSR^Q01 appear in pair to acquire sample request information from LIS. See the schematic diagram below:
Instrument
Message QRY^Q01: Used to query the necessary sample request information in LIS.
10/ 55
QRY
Query Message
Descriptions
MSH
Message Header
QRD
Query Definition
[QRF]
Query Filter
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. DSR
Display Response Message Descriptions
MSH
Message Header
MSA
Message Acknowledgment
[ERR]
Error
[QAK]
Query Acknowledgment
[QRD]
Query Definition
[QRF]
Query Filter
{DSP}
Display Data Segment
[DSC]
Continuation Pointer
Note: The segment in [ ] is optional and the segment in {} can be repeated once or several times.
3.4 Segment Descriptions The definition of fields contained in each segment will be detailed in the following list. A row in the table corresponds to a field in the segment. The meaning of each row in the table is given as follows: 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 ↑
Segment name
|
|987654321||Mark||19810506000000|M ↑ Field 1
Field 3
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. 4. Recommended maximum length: It is also the length recommended by the HL7 standard. However, the actual transmission length exceeds this value during actual message transmissions. Therefore, use separators as identifiers to read message fields while parsing a message. 5.
Descriptions: Descriptions about actual values of each field.
6.
Example: Example of actual values of each field.
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: MSH|^~\&|F 800|1268-1478a123|PC-1 LIS|PC-1|20180123075742||ORU^R01|1|P|2.4||||||UTF-8
See the table below for the definition of each field in a MSH segment: Table 1 Definitions of MSH Fields No.
Field name
Data type
Recommended maximum length
Descriptions
Example
1
Field Seperator
ST
1
It contains the first field separator following segment name to determine the value of other field separators in a message.
|
2
Encoding Characters
ST
4
It contains component separator, repetition separator, escape separator and sub component separator.
^~\&
3
Sending application
HD
180
Model of sending facility, select one of the following values:
F 800
12/ 55
F 800: Hematology analyzer G 01: Glycosylated hemoglobin analyzer U 2000: Urine analyzer P 100: C-reactive protein analyzer P300: Urine biochemical analyzer i 1000: Immunoassay equipment i 3000: Immunoassay equipment RIS: Intermediate
4
Sending Facility
HD
180
Serial number of sending facility
xxxx-xxxxxx
7
Date/Time Of Message
TS
26
Message creation date and time (YYYYMMDDHHmmSS), subject to the time of UTC+0.
20180123075742
9
Message Type
CM
7
Message type, for example “Message Type^Event Type”.
ORU^R01
10
Message Control ID
ST
20
Message control ID, used to uniquely identify a message.
1
11
Processing ID
PT
3
Message processing ID, values:
P
“P”: Sample test result and sample request information query; “Q”: QC test result; In ACK message, it is consistent with the 13/ 55
previously received message. 12
Version ID
VID
60
HL7 version number, also “2.4”
2.4
18
Character Set
ID
10
Character set, value “UTF-8”; communication messages are represented by UTF-8 encoded strings.
UTF-8
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: Table 2 Definitions of MSA Fields No.
Field name
Data type
Recommended maximum length
Descriptions
Example
1
Acknowledgement Code
ID
2
Acknowledgment code.
AA
“AA”: Accepted; “AE”: Error; "AR”: Rejected;
2
Message Control ID
ST
20
Message control ID, the same as MSH-10 in the corresponding received message.
1
6
Error Condition
CE
100
Error condition (status code). Refer to Table 3 for the value.
0
14/ 55
Table 3 List of Error Codes Status codes (MSA-6)
Status texts (MSA-3)
Succeeded: 0
Descriptions/Remarks AA
Message accepted
Error status codes:
Succeeded
AE
8
Query Result Empty
The query result is empty and no valid is record is found
100
Segment sequence error
The sequence of segments in a message is not correct or any required segment is missing
101
Required field missing
Any required field in a segment is missing
102
Data type error
The data type of field is incorrect, for example, the number becomes a character
103
Table value not found
Table value is not found and will not be used temporarily
Rejection status codes:
AR
200
Unsupported message type
The message type is not supported
201
Unsupported event code
The event code is not supported
15/ 55
202
Unsupported processing id
The processing ID is not supported
203
Unsupported version id
The version ID is not supported
204
Unknown key identifier
Unknown keyword identifier, for example transmission of patient information that does not exist
205
Duplicate key identifier
Repeated keywords exist
206
Application record locked
Service cannot be executed at application storage level, for example database is locked
207
Application internal error
Other unknown errors in an application
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: Table 4 Definition of PID Fields No.
Field name
Data type
Recommended maximum length
Descriptions
Example
1
Set ID – PID
SI
4
Serial number, used to identify different PID segments in a message
1
3
Patient Identifier List
CX
20
Medical record No.
987654321
16/ 55
4
Alternate Patient ID – PID
CX
20
Bed No.
2
5
Patient Name
XPN
48
Patient name
Mark
6
Mother’s Maiden Name
XPN
10
Patient age and age unit
37&Y
Y: Year M: Month D: Day H: Hour
7
Date/Time of Birth
TS
26
Patient’s date of birth, for example YYYYMMDDHHmmSS.
19810506000000
8
Sex
IS
1
Genders.
M
“M”: Male “F”: Female “U”: Unknown 11
Patient
XAD
106
Patient address
No.1, Xiyuan Avenue, Chengdu
13
Phone Number – Home
XTN
40
Phone number
13666666666
22
Ethnic Group
CE
80
Ethnicity
Han
23
Birth Place
ST
60
Place of birth (native place)
Chengdu, Sichuan
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): Table 5 Definition of OBR Fields (Sample Observation Results) No.
Field name
Data type
Recommended maximum length
Descriptions
Example
1
Set ID – OBR
SI
10
Serial number, used to determine different OBR segments in a message
1
2
Placer Order Number
EI
22
Sample barcode
123456789
3
Filler Order Number
EI
22
Sample No.
2
4
Universal Service ID
CE
200
Universal service identifier, use manufacturer name^model
maccura
5
Priority
ID
2
Emergency or not, Y (Yes) or N (No)
Y
6
Requested Date/time
TS
26
Sample collection time (form: YYYYMMDDHHmmSS), subject to the time of UTC+0.
20180124080000
7
Observation Date/Time
TS
26
Sample observation time (form: YYYYMMDDHHmmSS), subject to the time of UTC+0.
20180124100000
8
Observation End Date/Time
TS
26
End time of sample observation (form: YYYYMMDDHHmmSS),
20180124100500
18/ 55
subject to the time of UTC+0. 9
Collection Volume
CQ
20
Manual dilution factor of sample
2
10
Collector Identifier
XCN
60
Sample bit, consist of sample rack number^sample position
1^3
The test mode is the combination of different equipment test modes. All modes are connected through “+”. The test modes of F 800 include: CBC DIFF RET AWS
13
Relevant clinical information
ST
60
PCF
CBC+A1C+CRP
Test modes of G 01 equipment: A1C
Test mode of U 2000 equipment: CHEM SED
Test modes of P 100 equipment: CRP
14
Specimen Received Date/Time
TS
26
Time of sending sample for observation (form: YYYYMMDDHHmmSS), subject to the time of UTC+0.
20180124090000
19/ 55
15
Specimen Source
SPS
300
Sample type, the default values are as follows:
serum
Serum Plasma Whole blood Urine CSF Other 16
Ordering Provider
XCN
120
Referring physician
Li Si
17
Order Callback Phone Number
XCN
40
Referring department
Internal medicine
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): Table 6 Definition of OBR Fields (QC Test Results) No.
Field name
Data type
Recommended maximum length
Descriptions
Example
1
Set ID – OBR
SI
10
Serial number, used to determine different OBR segments in a message
1
2
Placer Order Number
EI
22
Control solution number
123456789
4
Universal Service ID
CE
200
Universal service identifier, use manufacturer name^model
maccura
20/ 55
7
Observation Date/Time
TS
26
Time of starting QC test (form: YYYYMMDDHHmmSS), subject to the time of UTC+0.
20180124100000
11
Specimen Action Code
ID
50
Control solution type
12
Danger Code
CE
60
QC method
13
Relevant Clinical Info
ST
300
Control solution name
14
Specimen Received Date/Time
TS
26
Shelf life of control solution (form: YYYYMMDDHHmmSS), subject to the time of UTC+0.
20180124080000
15
Specimen Source
SPS
300
Control solution batch number
1000
17
Order Callback Phone Number
XCN
40
Control solution concentration level
H: High; M: Medium; L: Low;
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: Table 7 Definition of OBX Fields No.
Field name
Data type
Recommended maximum length
Descriptions
Example
21/ 55
1
Set ID OBX
SI
10
Serial number, used to identify different OBX segments in a message.
1
2
Value Type
ID
3
Data types of observation result. Select one of the following values:
NM
ST: String; NM: Number; ED: Compressed data, for example image and byte array; WR: IP alarm information (string actually); 3
Observation Identifier
CE
590
Observation item identification.
6690-2^WBC^LN
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. Note: ID and EncodeSys are used to determine a unique observation parameter. However, Name only serves as description and cannot be used as an identification. 4
Observation Sub-ID
ST
20
Item name
WBC
5
Observation
*
65535
The data of observation
5.32
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
6
Units
CE
90
Unit of observation items. All observation items are expressed with ISO standard units. See Subsection 0for the units used in communications.
10*9/L
7
References Range
ST
90
Range of observation results, form: “Lower limit of reference range Upper limit of reference range”, or “Lower limit of reference range”.
10.00-11.00
8
Abnormal Flags
IS
5
Sign of observation results with the following values:
L
“N”: Normal “H”: The result is higher than the upper limit of reference range “L”: The result is lower than the lower limit of reference range 9
Probability
ST
5
Qualitative observation result values (negative (-), positive (+), weak positive (+-), etc.)
+
23/ 55
10
Nature of Abnormal Test
ID
20
Qualitative reference values
5
11
Observe Result Status
ID
1
Status of observation results. Value “F” - (Final Result) indicates the final result.
F
14
Date/Time of the Observation
TS
26
Observation time (form: YYYYMMDDHHmmSS), subject to the time of UTC+0.
20180124080000
15
Producer's ID
CE
60
Examining department
Internal medicine
16
Responsible Observer
XCN
80
Examining physician
Wang Wu
17
Observation Method
CE
60
QC target value
3.0
18
Equipment Instance Identifier
QC standard deviation
1.0
EI
60
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: Table 8 Definition of QRD Fields No.
Field name
Data type
Recommended maximum length
Descriptions
Example
1
Query Date/Time
TS
26
Current query generation time (form: YYYYMMDDHHmmSS),
20180124022123
24/ 55
subject to the time of UTC+0. 2
Query Format Code
ID
1
Query format code, R (record-oriented format)
R
3
Query Priority
ID
1
Query priority, select I (Immediate)
I
4
Query ID
ST
10
Query ID, indicate different queries
1
7
Quantity Limited Request
CQ
10
Quantity limit requirement, select RD (Records)
RD
8
Who Subject Filter
XCN
60
Sample barcode/number
123456789
9
What Subject Filter
CE
60
Requirements of query result with the following values:
OTH
ASSAY_RESULT: Acquire the latest result of the observation item; OTH: No special requirements for query results; 12
Query Results Level
ID
1
Level of query results, select T (Full result)
T
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 No.
Field name
Data type
Recommended maximum length
Descriptions
1
Where Subject Filter
ST
20
Requester location filter, also equipment model, select one of the following values:
Example
F 800: Hematology analyzer G 01: Glycosylated hemoglobin analyzer U 2000: Urine analyzer P 100: C-reactive protein analyzer
F 800
P 300: Urine biochemical analyzer i 1000: Immunoassay equipment i 3000: Immunoassay equipment RIS: Intermediate LMS: Line Management System
2
When Data Start Date/Time
TS
26
Start of sample receiving time (form: YYYYMMDDHHmmSS), subject to the time of UTC+0.
20180124022123
3
When Data End Date/Time
TS
26
End of sample receiving time (form: YYYYMMDDHHmmSS), subject to the time of UTC+0.
20180124032123
4
What User
ST
60
Sample rack number
Rack001
26/ 55
Qualifier 5
Other QRY ST Subject Filter
60
Slot position number, also the location of sample tube on sample rack.
1
6
Which Date/Time Qualifier
ID
12
Target type, select RCT (Specimen receipt date/time, receipt of specimen in filling ancillary(Lab))
RCT
7
Which Date/Time Status Qualifier
ID
12
Target status, select COR (Corrected only (no final with corrections))
COR
8
Date/Time Selection Qualifier
ID
12
Date/Time selection qualifier, select ALL (All values within the range)
ALL
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: Table 10 Definition of ERR Fields No.
Field name
Data type
Recommended maximum length
Descriptions
Example
1
Error Code and Location
ELD
80
Error codes and locations
203
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: Table 11 Definition of QAK Fields No.
Field name
Data type
Recommended maximum length
Descriptions
Example
1
Query Tag
ST
32
Query tag, select SR (indicating the sample request information)
SR
2
Query Response Status
ID
2
Query response status.
OK
OK: Data is found and no error has occurred NF: Data is not found and no error has occurred AE: Application error AR: Application rejection
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: Table 12 Definition of DSP Fields No.
Field name
Data type
Recommended maximum length
Descriptions
Example
1
Set ID – DSP
SI
4
Type code, used to determine the type of sample properties.
1
2
Display Level
SI
4
Level of display
28/ 55
3
Data Line
*
300
Data line, contents obtained through queries
4
Logical Break Point
ST
2
Logical break point
5
Result ID
TX
20
Result ID
BingLiHao1
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. Type code
Items
Values
1
Medical record No.
string
2
Bed No.
string
3
Patient name
string
4
Date of birth
string, form: YYYYMMDDHHmmSS (year, month, day, hour, minute, second), for example 20171222093625
5
Gender
char, M: Male; F: Female; U: Unknown
6
Blood type
7
Ethnicity
string,O、A、B、AB
string
29/ 55
8
Patient address
string
9
Postcode
string
10
Phone number
string
11
Sample position
string, consist of sample rack number~sample position
12
Sample collection time
string, UTC+0, form: YYYYMMDDHHmmSS (year, month, day, hour, minute, second), for example 20171222093625
13
Marital status
string
14
Religious belief
string
15
Patient type
string, outpatient; inpatient; other
16
Medical insurance account number
string
17
Charge type
string, own; insurance
18
Ethnicity
string
19
Native place (place of birth)
string
20
Country
string
21
Sample barcode
string
22
Sample No.
string, also sample number or LIS short number.
23
Sample submission time
string, UTC+0, form: YYYYMMDDHHmmSS (year, month, day, hour, minute, second), for example 20171222093625
24
Emergency?
char, Y: Yes, N: No
25
Manual dilution factor
float
26
Sample type
string, select one of the following values:
30/ 55
Serum Plasma Whole blood Urine CSF Other 27
Referring physician
string
28
Referring department
string
string, the test mode during initial sample observation, also the combination of different equipment test modes, all modes are spaced with “+”. F 800 has the following test modes: CBC DIFF RET AWS PCF
Test modes of G 01 equipment: A1C
29
Test modes
Test mode of U 2000 equipment: CHEM SED
Test modes of P 100 equipment: CRP
Example value of the field is given as follows: 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
31
Re-examination mode
It has the same value with the field “measurement mode” (type code: 29), indicating the measurement mode during sample re-examination.
32
Patient age
Int Char, select the following values: Y: Year
33
Unit of patient age
M: Month D: Day H: Hour
1000
Item information
string, describe the information of items to be tested for the sample, format: Item number~Item name~Dilution factor~Normal range of observation result values~Unit of observation result values~Re-examination?~Latest observation results of item
See Subsection 0for the value of item number. Item number is a required field but other fields are optional and the continuous “~” at the end of the value can be omitted. Note 1: For i 1000, i 3000, P 300, RIS and LMS, this field is required. Note 2: If the value of QRD-9 is ASSAY_RESULT, this field is required and the latest test results of the item should be provided.
…
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. Table 13 Definition of DSC Fields No.
Field name
Data type
Recommended maximum length
Descriptions
Example
32/ 55
1
Continuation pointer
ST
180
Continuation pointer. If this field is empty, it indicates that the current data is the last piece of data. Otherwise, there is subsequent data information.
N
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 4.1
Reporting of sample observational results 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. (1) Example of sample message MSH|^~\&|F 800|1268-1478a123|||20180123075742||ORU^R01|1|P|2.4||||||UTF-8 PID|1||987654321||Mark||19810506000000|M OBR|1|123456789||maccura|Y||||0 OBX|0|NM|6690-2^WBC^LN|WBC|3.14|10*3/uL|||||F OBX|1|ST|704-7^BAS#^LN|TSH|+||||||F OBX|2|ED|F800-IMG1^DIFF image^99MRC||^Image^BMP^Base64^.…DIFF histogram data… ||||||F OBX|3|ED|F800-IMG2^WPC image^99MRC||^Image^BMP^Base64^...WPC histogram data…||||||F OBX|4|ED|F800-WARN2^NEUTROPENIA^99MRC||Neutropenia||||||F
(2) Example of sample response message 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: MSH|^~\&|||F 800|1268-1478a123|20180123075743||ACK^R01|1|P|2.4||||||UTF-8 MSA|AA|1
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 MSH|^~\&|||F 800|1268-1478a123|20180123075743||ACK^R01|1|P|2.4||||||UTF-8 MSA|AR|1|Application record locked|||206
Note: The ID (MSH-10) of the response message must be the same as that of the sample message;
4.2
Reporting of QC Results
(1) Example of QC message MSH|^~\&|F 800|1268-1478a123|||20180123075742||ORU^R01|1|Q|2.4||||||UTF-8 OBR|1|123456789||maccura|||20180124100000||||||level1|20200124080000|1000|L OBX|0|NM|6690-2^WBC^LN|WBC|3.14|10*3/uL|||||F||||3.0|1.0
34/ 55
(2) Example of QC response message The only difference between QC response message and sample response message lies in that the value of field MSH-11 is Q. The following is an X-R QC message ACK. MSH|^~\&|||F 800|1268-1478a123|20180123075743||ACK^R01|1|Q|2.4||||||UTF-8 MSA|AA|1
Note: The ID (MSH-10) of the response message must be the same as that of the QC message;
4.3
Query the Request Information of the Sample with Specified Barcode (1) Example of query request 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. MSH|^~\&|F 800|1268-1478a123| | |20180125062608||QRY^Q01|1|P|2.4||||||UTF-8 QRD|20180125062608|R|I|a47d7494-0b97-46bc-a0fe-aa491a844c2f|||^RD|SampleID1|OTH|||T QRF| F 800|||||RCT|COR|ALL
(2) Example of query request response message LIS query request message contains sample number. After receiving the message, LIS queries the patient and sample information response corresponding to the sample. MSH|^~\&|||F 800|1268-1478a123|20180125062610||DSR^Q01|1|P|2.4||||||UTF-8 MSA|AA|1 QRD|20180125062608|R|I|a47d7494-0b97-46bc-a0fe-aa491a844c2f|||^RD|SampleID1|OTH|||T QRF| F 800|||||RCT|COR|ALL DSP|1||BingLiHao1 DSP|2||ChuangHao1 DSP|3||Name1 DSP|4||19870609102137 DSP|5||M DSP|6||A DSP|7||ZhongZu1 DSP|8||DiZhi1 DSP|9||CountryCode1 DSP|10||HomePhoneNumber1 DSP|11||SamplePosition1
35/ 55
DSP|12||20171221080102 DSP|13||HunYin1 DSP|14||ZongJiao1 DSP|15||InPatient DSP|16||SheBaoZhangHao1 DSP|17||own DSP|18||MinZu1 DSP|19||JiGuan1 DSP|20||GuoJia1 DSP|21||TiaoMa1 DSP|22||YangBenHao1 DSP|23||20171221080102 DSP|24||Y DSP|25||1.1 DSP|26||serum DSP|27||Doctor1 DSP|28||Department1 DSP|29||CBC DSP|30||31 DSP|31||Y
Note: The ID (MSH-10) of the response message must be the same as that of the query request message;
If no valid record is found, the response message is as follows: MSH|^~\&|||F 800|1268-1478a123|20180125062610||DSR^Q01|1|P|2.4||||||UTF-8 MSA|AE|8
4.4
Query the Request Information of the Sample in Specified Period
(1) Example of query request message 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. MSH|^~\&|F 800|1268-1478a123| | |20180125062608||QRY^Q01|1|P|2.4||||||UTF-8 QRD|20180125062608|R|I|a47d7494-0b97-46bc-a0fe-aa491a844c2f|||^RD| |OTH|||T QRF| F 800|20180125000000|20180125235959|||RCT|COR|ALL
(2) Example of query request response message
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: MSH|^~\&|||F 800|1268-1478a123|20180125062610||DSR^Q01|1|P|2.4||||||UTF-8 MSA|AA|1 QRD|20180125062608|R|I|a47d7494-0b97-46bc-a0fe-aa491a844c2f|||^RD| |OTH|||T QRF| F 800|20180125000000|20180125235959|||RCT|COR|ALL DSP|1||BingLiHao1 DSP|2||ChuangHao1 DSP|3||Name1 DSP|4||19870609102137 DSP|5||M DSP|6||A DSP|7||ZhongZu1 DSP|8||DiZhi1 DSP|9||CountryCode1 DSP|10||HomePhoneNumber1 DSP|11||SamplePosition1 DSP|12||20171221080102 DSP|13||HunYin1 DSP|14||ZongJiao1 DSP|15||InPatient DSP|16||SheBaoZhangHao1 DSP|17||own DSP|18||MinZu1 DSP|19||JiGuan1 DSP|20||GuoJia1 DSP|21||TiaoMa1 DSP|22||YangBenHao1 DSP|23||20171221080102 DSP|24||Y DSP|25||1.1 DSP|26||serum DSP|27||Doctor1 DSP|28||Department1 DSP|29||CBC DSP|30||31 DSP|31||Y DSC|1
37/ 55
Note: The ID (MSH-10) of the first response message must be the same as that of the query request message;
The second response message is shown as follows: MSH|^~\&|||F 800|1268-1478a123|20180125062610||DSR^Q01|2|P|2.4||||||UTF-8 MSA|AA|1 QRD|20180125062608|R|I|a47d7494-0b97-46bc-a0fe-aa491a844c2f|||^RD| |OTH|||T QRF| F 800|20180125000000|20180125235959|||RCT|COR|ALL DSP|1||BingLiHao2 DSP|2||ChuangHao2 DSP|3||Name2 DSP|4||19970609112137 DSP|5||F DSP|6||B DSP|7||ZhongZu2 DSP|8||DiZhi2 DSP|9||CountryCode2 DSP|10||HomePhoneNumber2 DSP|11||SamplePosition2 DSP|12||20171221080102 DSP|13||HunYin2 DSP|14||ZongJiao2 DSP|15||InPatient DSP|16||SheBaoZhangHao2 DSP|17||own DSP|18||MinZu2 DSP|19||JiGuan2 DSP|20||GuoJia2 DSP|21||TiaoMa2 DSP|22||YangBenHao2 DSP|23||20171221080102 DSP|24||N DSP|25||2.2 DSP|26||urine DSP|27||Doctor2 DSP|28||Department2 DSP|29||CBC+DIFF+CRP DSP|30||21 DSP|31||Y DSC|1
The last response message is as follows. Note that it has no DSC segment.
38/ 55
MSH|^~\&|||F 800|1268-1478a123|20180125062610||DSR^Q01|3|P|2.4||||||UTF-8 MSA|AA|1 QRD|20180125062608|R|I|a47d7494-0b97-46bc-a0fe-aa491a844c2f|||^RD| |OTH|||T QRF| F 800|20180125000000|20180125235959|||RCT|COR|ALL DSP|1||BingLiHao3 DSP|2||ChuangHao3 DSP|3||Name3 DSP|4||20170609112137 DSP|5||F DSP|6||B DSP|7||ZhongZu3 DSP|8||DiZhi3 DSP|9||CountryCode3 DSP|10||HomePhoneNumber3 DSP|11||SamplePosition3 DSP|12||20171221080102 DSP|13||HunYin3 DSP|14||ZongJiao3 DSP|15||InPatient DSP|16||SheBaoZhangHao3 DSP|17||own DSP|18||MinZu3 DSP|19||JiGuan3 DSP|20||GuoJia3 DSP|21||TiaoMa3 DSP|22||YangBenHao3 DSP|23||20171221080102 DSP|24||Y DSP|25||3.3 DSP|26||plasma DSP|27||Doctor3 DSP|28||Department3 DSP|29||A1C+CBC+DIFF+AWS+CRP DSP|30||11 DSP|31||Y
If no valid record is found, the response message is as follows: MSH|^~\&|||F 800|1268-1478a123|20180125062610||DSR^Q01|1|P|2.4||||||UTF-8 MSA|AE|8
39/ 55
Appendix A: Definition of HL7 Data Types CE - Code Element ^ ^ ^ ^ ^
⚫
CM – Composite
The format of the union consisting of other data fields that have respective meanings is defined by specific fields.
⚫
CX - Extended composite ID with check digit
^ ^ ^ < assigning authority (HD)> ^ ^ < assigning facility (HD)> ^ ^
⚫
ED – Encapsulate Data
^ ^ ^ ^
⚫
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
^ ^
⚫
IS - Coded value for user-defined tables
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.
⚫
ID - Coded values for HL7 tables
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
A number represented as a series of ASCII numeric characters consisting of an optional leading sign (+ or -), the digits and an optional decimal point.
⚫
PL - Person location
^ ^ ^ ^ < location status (IS)> ^ ^ ^ ^
⚫
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
YYYY[MM[DD[HHMM[SS[.S[S[S[S]]]]]]]][+/-ZZZZ] ^
41/ 55
⚫
VID - Version identifier
^ ^
⚫
XCN - Extended composite ID number and name
^ ^ ^ ^ ^ ^ ^ ^ ^ ^ ^ ^ ^ ^ ^ ^ ^
⚫
XPN - Extended person name
^ & ^ ^ ^ ^ ^ ^ ^ ^
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. B.1. OBX segment of F 800 equipment Data item
Type
Unit
descriptions
(OBX-2
(OBX-6)
Code (ID)
Name
Example of OBX-3
Corre
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
NM
10*12/L
789-8
RBC
789-8^RBC^LN
CBC
NM
g/L
718-7
HGB
718-7^HGB^LN
CBC
Hematocrit
NM
%
4544-3
HCT
4544-3^HCT^LN
CBC
Mean corpuscular
NM
fL
62242-3
MCV
62242-3^MCV^LN
CBC
NM
pg
62243-1
MCH
62243-1^MCH^LN
CBC
NM
g/L
62246-4
MCHC
62246-4^MCHC^L
CBC
blood cells Number of red blood cells Hemoglobin concentration
volume Mean corpuscular hemoglobin content Mean corpuscular 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
coefficient of red
62247-2^RDW-CV
CBC
^LN
blood cell distribution width Platelet
NM
fL
32207-3
PDW
32207-3^PDW^LN
CBC
NM
fL
32623-1
MPV
32623-1^MPV^LN
CBC
distribution width Average platelet volume 43/ 55
Number of large
NM
10*9/L
34167-7
P-LCC
platelets Platelet-large cell
34167-7^P-LCC^L
CBC
N NM
%
48386-7
P-LCR
ratio
48386-7^P-LCR^L
CBC
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%
nucleated red
19048-8^NRBC%
CBC
^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 Number of
N NM
10*9/L
742-7
MONO#
monocytes
742-7^MONO#^L
DIFF
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 Percentage of
LN NM
%
71678-7
LYMPH%
lymphocytes Percentage of
DIFF
%^LN NM
%
71677-9
MONO%
monocytes Eosinophil
71678-7^LYMPH 71677-9^MONO%
DIFF
^LN NM
%
71679-5
EO%
71679-5^EO%^LN
DIFF
NM
%
706-2
BAS%
706-2^BAS%^LN
DIFF
NM
10*9/L
53115-2
IG#
53115-2^IG#^LN
DIFF
NM
%
71695-1
IG%
71695-1^IG%^LN
DIFF
NM
%
17849-1
RET%
17849-1^RET%^L
RET
percentage Basophil percentage Number of immature granulocytes Percentage of immature granulocytes Reticulocyte percentage Reticulocyte
N NM
10*9/L
60474-4
RET#
number Immature
60474-4^RET#^L
RET
N NM
%
33516-6
IRF
33516-6^IRF^LN
RET
NM
%
82591-9
LFR
82591-9^LFR^LN
RET
reticulocyte ratio Ratio of reticulocytes with low fluorescence
44/ 55
intensity Ratio of
NM
%
82592-7
MFR
82592-7^MFR^LN
RET
NM
%
51642-7
HFR
51642-7^HFR^LN
RET
NM
%
71694-4
RET-He
71694-4^RET-He^
RET
reticulocytes with medium fluorescence intensity Ratio of reticulocytes with high fluorescence intensity Hemoglobin content of
LN
reticulocytes Immature platelet
NM
%
71693-6
IPF
71693-6^IPF^LN
PCF
NM
10*9/L
F800-ST1
WBC-A
F800-ST1^WBC-A
AWS
ratio (index) White blood cell count calculated
^99MRC
from FCA channel Total number of
NM
10*9/L
F800-ST2
TNC-A
nucleated cells
F800-ST2^TNC-A
AWS
^99MRC
calculated from FCA channel Intermediate data of observation results (WBC, RBC, PLT histogram and scattergram data) WDF histogram
ED
bitmap data WNR histogram
ED
bitmap data RBC histogram
ED
bitmap data PLT histogram
ED
bitmap data WPC histogram
ED
bitmap data RET histogram
ED
bitmap data PLTF histogram
ED
bitmap data
N/A N/A N/A N/A N/A N/A N/A
F800-IMG1 F800-IMG2 F800-IMG3
WDF
F800-IMG1^WDF
image
image^99MRC
WNR
F800-IMG2^WNR
image
image^99MRC
RBC image
F800-IMG3^RBC image^99MRC
F800-IMG4
PLT image
F800-IMG4^PLT image^99MRC
F800-IMG5 F800-IMG6
WPC
F800-IMG5^WPC
image
image^99MRC
RET image
F800-IMG6^RET image^99MRC
F800-IMG7
PLTF
F800-IMG7^PLTF
image
image^99MRC
N/A N/A N/A N/A N/A N/A N/A
IP alarm information Leukocyte scattergram
WBC ABN WR
N/A
F800-WARN1
abnormal Neutrophil decreased
SCATTER GRAM
WR
N/A
F800-WARN2
F800-WARN1^W BC ABN SCATTERGRAM^
N/A
99MRC
NEUTROP
F800-WARN2^NE
ENIA
UTROPENIA^99M
N/A
45/ 55
RC Neutrophil increased Lymphopenia decreased Lymphocyte increased Monocyte increased Eosinophil increased Basophils increased Leukocyte count decreased White blood cell count increased
WR
WR
WR
WR
WR
WR
WR
WR
N/A
N/A
N/A
N/A
N/A
N/A
N/A
N/A
F800-WARN3
F800-WARN4
F800-WARN5
F800-WARN6
F800-WARN7
F800-WARN8
F800-WARN9
F800-WARN10
WR
N/A
F800-WARN11
increased
WR
N/A
F800-WARN12
WR
N/A
F800-WARN13
lymphocytes?
lymphocyte Left shift abnormal? Red blood cell
LYMPHOC YTOSIS MONOCYT OSIS EOSINOP HILIA BASOPHIL IA LEUKOCY TOPENIA LEUKOCY TOSIS
MRC F800-WARN4^LY MPHOPENIA^99
N/A
MRC F800-WARN5^LY MPHOCYTOSIS^
N/A
99MRC F800-WARN6^M ONOCYTOSIS^99
N/A
MRC F800-WARN7^EO SINOPHILIA^99M
N/A
RC F800-WARN8^BA SOPHILIA^99MR
N/A
C F800-WARN9^LE UKOCYTOPENIA
N/A
^99MRC F800-WARN10^L EUKOCYTOSIS^9
N/A
9MRC
NRBC
RBC
PRESENT
PRESENT^99MR
N/A
IG
G
PRESENT
PRESENT^99MR
N/A
C
Primitive
Atypical
ENIA
N/A
F800-WARN12^I
increased
cells/abnormal
LYMPHOP
UTROPHILIA^99
C
Immature granulocyte
HILIA
F800-WARN3^NE
F800-WARN11^N
Nucleated red blood cell
NEUTROP
WR
WR WR
N/A
N/A N/A
F800-WARN14
F800-WARN15 F800-WARN16
BLASTSO
F800-WARN13^B
R
LASTSOR
ABNLYMP
ABNLYMPHO
HO S
S^99MRC
ATYPICAL LYMPHO S LEFT SHIFT S RBC ABN
N/A
F800-WARN14^A TYPICALLYMPH
N/A
O S^99MRC F800-WARN15^L EFT SHIFT
N/A
S^99MRC F800-WARN16^R
N/A 46/ 55
histogram
DISTRIBU
BC ABN
abnormal
TION
DISTRIBUTION^9 9MRC
Bimodal erythrocyte
Reticulocyte increased Red blood cell size uneven
Microcytosis
Macrocytosis
Hypopigmentation
Anaemia Erythrocyte increased
Erythrocyte agglutination?
WR
WR
WR
WR
WR
WR
WR
WR
N/A
N/A
N/A
N/A
N/A
N/A
N/A
N/A
F800-WARN17
F800-WARN18
F800-WARN19
F800-WARN20
F800-WARN21
F800-WARN22
F800-WARN23
F800-WARN24
DIMORPHI
F800-WARN17^DI
C
MORPHIC
POPULATI
POPULATION^99
ON
MRC
RETICULO CYTOSIS ANISOCYT OSIS MICROCY TOSIS MACROC YTOSIS HYPOCHR OMIA ANEMIA ERYTHRO CYTOSIS RBC
WR
N/A
F800-WARN25
AGGLUTI NATION S TURBIDIT
Chyle?
WR
N/A
F800-WARN26
Y OR HGB INTERF S
Iron deficiency?
Hemoglobin abnormal? Red blood cell fragment?
WR
WR
WR
N/A
N/A
N/A
F800-WARN27
F800-WARN28
F800-WARN29
F800-WARN18^R ETICULOCYTOSI F800-WARN19^A NISOCYTOSIS^9 F800-WARN20^M ICROCYTOSIS^9 F800-WARN21^M ACROCYTOSIS^
N/A
99MRC F800-WARN22^H YPOCHROMIA^9
N/A
9MRC F800-WARN23^A NEMIA^99MRC
N/A
F800-WARN24^E RYTHROCYTOSI
N/A
S^99MRC F800-WARN25^R BC AGGLUTINATION
N/A
S^99MRC F800-WARN26^T URBIDITY OR HGB INTERF
N/A
S^99MRC ON DEFICIENCY
CY S
S^99MRC
TS
N/A
9MRC
DEFICIEN
FRAGMEN
N/A
9MRC
F800-WARN27^IR
DEFECT S
N/A
S^99MRC
IRON
HGB
N/A
N/A
F800-WARN28^H GB DEFECT
N/A
S^99MRC F800-WARN29^F RAGMENT
N/A
S^99MRC
47/ 55
Platelet histogram abnormal
Platelet decreased
Platelet increased
Platelet agglutination?
PLT ABN WR
N/A
F800-WARN30
TION
WR
WR
WR
N/A
F800-WARN31
N/A
F800-WARN32
N/A
F800-WARN33
Reticulocyte scattergram
DISTRIBU
N/A
F800-WARN34
F800-WARN31^T
OCYTOPE
HROMBOCYTOP
NIA
ENIA^99MRC
THROMB
F800-WARN32^T
OCYTOSI
HROMBOCYTOSI
S
S^99MRC
CLUMPS
SCATTER
Platelet
PLT ABN N/A
F800-WARN35
abnormal Primitive cell? Abnormal lymphocytes?
SCATTER GRAM
WR
WR
N/A
F800-WARN36
N/A
F800-WARN37
N/A
N/A
N/A
F800-WARN33^P
PLT
GRAM
WR
DISTRIBUTION^9
THROMB
abnormal
scattergram
LT ABN 9MRC
RET ABN WR
F800-WARN30^P
BLASTS S
LT
N/A
CLUMPS^99MRC F800-WARN34^R ET ABN SCATTERGRAM^
N/A
99MRC F800-WARN35^P LT ABN SCATTERGRAM^
N/A
99MRC F800-WARN36^B LASTS S^99MRC
N/A
F800-WARN37^A
ABN LYMPHO S
BN LYMPHO
N/A
S^99MRC
B.2. OBX segment of G 01 equipment Data item
Typ
Unit
Code
descriptions
e
(OBX-6)
(ID)
Name
Example of OBX-3 fields
Correspon ding test
(OB
mode
X-2) Data items of observation results A1c
NM
%
G01-1
A1c NGSP
concentration
G01-1^A1c
A1C
NGSP^99MRC
value under NGSP standard A1c
NM
concentration
mmol/mo
G01-2
A1c IFCC
l
G01-2^A1c
A1C
IFCC^99MRC
value under IFCC standard Average blood
NM
mmol/L
G01-3
A1c eAG
G01-3^A1c eAG^99MRC
A1C
glucose concentration
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 NGSP
G01-8^P3
P3 area ratio
NM
%
G01-8
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
00 Alarm code
WR
Raw data
ED
N/A N/A
Area^99MRC
G01-10
Alarm
G01-1001^Alarm
01
Code
Code^99MRC
G01-10
Raw Data
G01-1002^Raw
02 Result data
ED
Hemoglobin
ED
N/A N/A
image
A1C A1C A1C
Data^99MRC
G01-10
Result
G01-1003^Result
03
Data
Data^99MRC
G01-10
Hb Image
G01-1004^Hb
04
A1C A1C
Image^99MRC
B.3. OBX segment of U 2000 equipment Data item
Type
Unit
Code
descriptions
(OBX-
(OBX-
(ID)
2)
6)
Name
Example of OBX-3 fields
Correspondi ng test mode
Data items of observation results pH
ST
U2000-1
pH
U2000-1^PH^99MRC
CHEM
Specific
ST
U2000-2
SG
U2000-2^SG^99MRC
CHEM
Urobilinogen
ST
U2000-3
URO
U2000-3^URO^99MRC
CHEM
Vitamin C
ST
U2000-4
VC
U2000-4^VC^99MRC
CHEM
A/C ratio
ST
U2000-5
ACR
U2000-5^AC^99MRC
CHEM
Bilirubin
ST
U2000-6
BIL
U2000-6^BIL^99MRC
CHEM
density
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
GLU
U2000-11^GLU^99MRC
CHEM
MA
U2000-12^MA^99MRC
CHEM
KET
U2000-13^KET^99MRC
CHEM
LEU
U2000-14^LEU^99MRC
CHEM
NIT
U2000-15^NIT^99MRC
CHEM
COLOR
U2000-16^COLOR^99MRC
CHEM
TURB
U2000-17^TURB^99MRC
CHEM
CRYS
U2000-18^CRYS^99MRC
SED
HYA
U2000-19^HYA^99MRC
SED
BACT
U2000-20^BACT^99MRC
SED
BYST
U2000-21^BYST^99MRC
SED
MUCS
U2000-22^MUCS^99MRC
SED
NEC
U2000-23^NEC^99MRC
SED
PAT
U2000-24^PAT^99MRC
SED
RBC
U2000-25^RBC^99MRC
SED
SEC
U2000-26^SEC^99MRC
SED
SPRM
U2000-27^SPRM^99MRC
SED
U2000-2
UNKNOW
U2000-28^UNKNOWN^99M
SED
8
N
RC
U2000-2
WBC
U2000-29^WBC^99MRC
0 Glucose
ST
U2000-1 1
Micro-albumi
ST
n Acetone
U2000-1 2
ST
U2000-1 3
White blood
ST
cell Nitrite
U2000-1 4
ST
U2000-1 5
Chrominance
ST
U2000-1 6
Turbidity
ST
U2000-1 7
Crystal
ST
U2000-1 8
Transparent
ST
tube type Bacteria
U2000-1 9
ST
U2000-2 0
Microzyme
ST
U2000-2 1
Viscose silk
ST
U2000-2 2
Non-squamo
ST
us epithelial
U2000-2 3
cells Pathological
ST
tube type Red blood
4 ST
cell Squamous
U2000-2 5
ST
epithelial cell Sperm
U2000-2
U2000-2 6
ST
U2000-2 7
Unknown White blood
ST ST
SED
50/ 55
cell Leukocyte
9 ST
U2000-3
mass Urinary tract
WBCC
U2000-30^WBCC^99MRC
SED
UTI
U2000-31^UTI^99MRC
SED
0 ST
U2000-3
infection
1
B.4. OBX segment of P 100 equipment Data item
Type
Unit
descriptions
(OBX-2)
(OBX-6)
Code (ID)
Name
Example of OBX-3
Corresponding
fields
test mode
71426-1^CRP^LN
CRP
Data items of observation results C-reactive
NM
mg/L
71426-1
CRP
protein
51/ 55
Appendix C: Unit of Observation Items All observation items are expressed in ISO standard units. Table 14 Unit of Observation Items Unit of parameters displayed on software interface
Unit of observation items (OBX-6)
10^12/L
10*12/L
10^9/L
10*9/L
10^6/uL
10*6/uL
10^4/uL
10*4/uL
10^3/uL
10*3/uL
10^2/uL
10*2/uL
mL/L
mL/L
/nL
/nL
/pL
/pL
g/L
g/L
g/dL
g/dL
L/L
L/L
mmol/L
mmol/L
%
%
fL
fL
um^3
um3
pg
pg
fmol
fmol
amol
amol
Year (unit of age)
yr
Month (unit of age)
Mo
Day (unit of age)
d
Hour (unit of age)
hr
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. D.1 Byte array 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. D.2 jpg image 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. D.3 png image 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: Raw data: Binary data:
0x15
0xA3
00010101
10100011
0x4B 01001011
The 6-bit group obtained after division: 000101
011010
001101
001011
Corresponding coded values:
0x05
0x1A
0x0D
0x0B
Corresponding characters:
F
a
N
L
Table 15 Base64 Mapping Value/Code
Value/Code
Value/Code
Value/Code
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
15
P
32
g
49
x
16
Q
33
h
50
y
(pad) =
(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: ① Raw data: Binary data:
0x0A 00001010
Data obtained by filling:
00001010
00000000
The 6-bit group obtained after division: 000010
00000000 100000
000000
000000
Corresponding coded values:
0x02
0x20
0x00
0x00
Corresponding characters:
C
g
=
=
② Raw data: Binary data:
0x0A
0x0B
00001010
00001011
Data obtained by filling:
00001010
00001011
The 6-bit group obtained after division: 000010
00000000 100000
101100
000000
Corresponding coded values:
0x02
0x20
0x2C
0x00
Corresponding characters:
C
g
s
=
55/ 55