LIS communication protocol instruction

1
 Table of Contents

Chapter 1 Summary .................................................................................................................... 3

1.1 Explanation............................................................................................................... 3
1.2 Messages supported by the HL7 interface ................................................................. 3
1.3 Underlying protocol .................................................................................................. 3
1.4 Message packets encoding form ............................................................................... 3
Chapter 2 Communication........................................................................................................... 4
2.1 HL7 basic grammar ................................................................................................... 4
2.1.1 Message constructing principles ............................................................... 4
2.1.2 String transferring principles..................................................................... 5
2.2 Message grammar .................................................................................................... 5
2.3 Duplex communication ............................................................................................. 6
2.3.1 Count information upload ........................................................................ 6
2.3.2 QC information upload ............................................................................. 8
Chapter 3 Field definition ............................................................................................................ 9
3.1 MSH message head definitions ................................................................................. 9
3.2 PID message head definition ................................................................................... 10
3.3 PV1 message head definition .................................................................................. 11
3.4 OBR message head definition ................................................................................. 12
3.5 OBX message head definition ................................................................................. 14
3.5.1 Custom OBX definition ........................................................................... 14
3.6 MSA message head definition ................................................................................. 16
3.6.1 Confirmation code .................................................................................. 16
3.6.2 Error conditions...................................................................................... 17
Appendix A ............................................................................................................................... 19

2
 Chapter 1 Summary

1.1 Explanation
HL7 interface is a new feature for adapting to the current rapid development of laboratory
information system (LIS), it provides a channel of communication for the instrument and other
network based IP communication. LIS server can receive test data from the instrument using a
serial port connection including: Sample information request, sample test results and QC test
results. Meanwhile, the instrument receives the confirmation return by LIS server, which will be
described in the following connection. The data transfer protocol is defined based on HL7 v2.3.1.
This interface is only support data transfer between the instrument and LIS server.

1.2 Messages supported by the HL7 interface

HL7 is the digital data switching standard used for providing of care for inpatient. It is firstly
defined by America and now adopted by many countries. This interface is based on HL7 v2.3.1.
For details of the HL7, please see HL7 Interface Standards Version 2.3.1.
Because only part of the data is used by the HL7 interface of KT-6610 instrument, so only part
of message types, segment types and other data types that belong to HL7 standard is used in the
interface.

1.3 Underlying protocol

HL7 of top protocol is based on messages. The function of terminating the message is not
provided. In order to determine the message boundary, the underlying protocol is used (such
descriptions are also included in HL7 Interface Standards Version 2.3.1).
Communication level:
Messages are transmitted in the following format:
Block
Block is HL7 message.

1.4 Message packets encoding form

Message packets form is sent from HL7 protocol encoding in the Chinese version of
software, the user can select UTF-8; other languages default to UTF-8, users can not choose
other options.

3
 Chapter 2 Communication

2.1 HL7 basic grammar

2.1.1 Message constructing principles

Every HL7 message consists of several segments and ends up with the <CR> character.
Each segment consists of the segment name of three characters and field of changeable
characters, and each field consists of the component and subcomponent. For each message, the
separators of the field, component and subcomponent are defined in the MSH segment.
The five characters following MSH define the separators to distinguish each field,
component and subcomponent. Although they can be any non-text characters, HL7 standard
recommends the characters in the table below:

Table 1 Character table

Separator name Value Remark
Information segment (hex 0D) carriage return Terminates a segment record.
terminator character This value cannot be changed by
implementers.
Field separator | Separates two adjacent data
fields within a segment. It also
separates the segment ID from
the first data field in each
segment.
Component separator ^ Separates adjacent components
of data fields where allowed.
Subcomponent separator & Separates adjacent subcomp-
onents of data fields where
allowed. If there are no
subcomponents, this character
may be omitted.
Repetition separator ~ Separates multiple occurrences
of a field where allowed.
ESC \ Escape character for use with
any field represented by an ST,
TX or FT data type, or for use
with the data (fourth)
component of the ED data type
If no escape characters are used
in a message, this character may
be omitted. However, it must be
present if subcomponents are
used in the message.

4
 The first field of MSH includes every separator. Some field behind are empty because they
are optional and not used by HL7 interface. Detailed field definition and selection will be stated
in the following contents.
For message of any type, the segments behind MSH appear in the fixed order. The order will
be described in the following contents and the grammar is used to organize the segments order.
The segment appeared in [] is optional.
The segment appeared in {} can be repeated once or more.

2.1.2 String transferring principles

For the field data of ST, TX, FT, and CF, etc., separators may be contained in the string data like

remark, clinical diagnosis and customized gender etc. When coding, the separators in the original

strings shall be transferred into transferred character sequence; then, restore them when

decoding.

Table 2 Transferred meaning principles

Transferred character Original character

\F\ Field separator

\S\ Component separator

\T\ Subcomponent separator

\R\ Repetition separator

\E\ Transferred separator

\.br\ <CR>,i.e. end character of segment

2.2 Message grammar

HL7 supports many type of message, and 4 types of HL7 message is used in this article,

ORU^R01 is used for the transmission of the test results, ACK^R01 is used for confirmation,

ORM^O01 is used for the request of sample information, ORR^O02 is used for the response of

results.

5
2.3 Duplex communication

ORU^R01

PC LIS
ACK^R01

Figure 1 Communication figure

2.3.1 Count information upload

Table 3 PC->LIS

Name MSH PID PV1 OBR OBX

Table 4 LIS->PC

Name MSH MSA

The transmission of the test results

MSH|^~\&|Genrui|KT-6610|||20170712140022||ORU^R01|1275|P|2.3.1|||||CHA|UTF-8|||

PID|1||0706-ZY-190-11||name||19910606|M|||||||||||||||||||||||

PV1|1|clinic|internal medicine||||||||chuanghao|||||||||||

OBR|1|||||20170706110000|20170706181945|||inspection

||||20170706090000||||RD||RD||||HM||||||||Genrui||||||||

OBX|1|NM|^WBC^||0.01|10^9/L|4.00-10.00|L|||F||||||||

OBX|2|NM|^Neu#^||0.01|10^9/L|2.00-7.00|L|||F||e||||||

OBX|3|NM|^Lym#^||0.00|10^9/L|0.80-4.00|L|||F||e||||||

OBX|4|NM|^Mon#^||0.00|10^9/L|0.12-1.20|L|||F||e||||||

OBX|5|NM|^Eos#^||0.00|10^9/L|0.02-0.50|L|||F||e||||||

OBX|6|NM|^Bas#^||0.00|10^9/L|0.00-0.10||||F||e||||||

OBX|7|NM|^Neu%^||50.0|%|50.0-70.0||||F||E||||||

OBX|8|NM|^Lym%^||10.0|%|20.0-40.0|L|||F||E||||||

6
OBX|9|NM|^Mon%^||10.0|%|3.0-12.0||||F||E||||||

OBX|10|NM|^Eos%^||20.0|%|0.5-5.0|H|||F||E||||||

OBX|11|NM|^Bas%^||10.0|%|0.0-1.0|H|||F||E||||||

OBX|12|NM|^RBC^||0.09|10^12/L|3.50-5.50|L|||F||E||||||

OBX|13|NM|^HGB^||106|g/L|120-160|L|||F||||||||

OBX|14|NM|^HCT^||32.9|%|40.0-54.0|L|||F||||||||

OBX|15|NM|^MCV^||87.7|fL|80.0-100.0||||F||||||||

OBX|16|NM|^MCH^||28.2|pg|27.0-34.0||||F||||||||

OBX|17|NM|^MCHC^||322|g/L|320-360||||F||||||||

OBX|18|NM|^RDW-CV^||8.7|%|11.0-16.0|L|||F||||||||

OBX|19|NM|^RDW-SD^||32.0|fL|35.0-56.0|L|||F||||||||

OBX|20|NM|^PLT^||144|10^9/L|100-300||||F||||||||

OBX|21|NM|^MPV^||9.4|fL|6.5-12.0||||F||||||||

OBX|22|NM|^PDW^||16.4||9.0-17.0||||F||||||||

OBX|23|NM|^PCT^||0.135|%|0.108-0.282||||F||||||||

OBX|24|NM|^P-LCC^||37|10^9/L|30-90||||F||||||||

OBX|25|NM|^P-LCR^||25.8|%|11.0-45.0||||F||||||||

OBX|26|IS|^Blood Mode^||whole blood||||||F||||||||

OBX|27|IS|^Test Mode^||CBC+DIFF||||||F||||||||

OBX|28|IS|^Ref Group^||man||||||F||||||||

OBX|29|IS|^Age^||26|years old|||||F||||||||

OBX|30|IS|^Remarks^||remark||||||F||||||||

OBX|31|ED|^DIFFScatter_BMP^||bitmap data||||||F||||||||

OBX|32|ED|^WBCScatter_BMP^||bitmap data||||||F||||||||

OBX|33|ED|^RBCHistogram_BMP^||bitmap data||||||F||||||||

OBX|34|ED|^PLTHistogram_BMP^||bitmap data||||||F||||||||

Note:
1. The parameters’ units and values are transmitting by actual values, the above are examples.

WBCHistogram BMP indicates WBC Histogram data, BMP indicates the JPG bitmap is transmitted,

DATA indicates the data type is transmitted.

RBCHistogram BMP indicates RBC Histogram data, BMP indicates the JPG bitmap is transmitted,

DATA indicates the data type is transmitted.

7
PLTHistogram BMP indicates PLT Histogram data, BMP indicates the JPG bitmap is transmitted,

DATA indicates the data type is transmitted.

DIFFHistogram BMP indicates the scattergram data JPG of DIFF.

Respond information of LIS

MSA|AA|1275||||

Note: After the instrument sends the count information, it will wait for the response as above,
and the response will be retransmitted within 3 seconds if it doesn’t be received. You can turn off
this operation by setting the instrument as no wait response.

2.3.2 QC information upload

Not available, to be added

8
 Chapter 3 Field definition

3.1 MSH message head definitions

Table 5 MSH fields definition table

No. Max length Field Name Actual values

1 1 Field Separator |

2 4 Encoding Characters ^~\&

3 180 Sending application KT-6610

4 180 Sending Facility Genrui

5 180 Receiving application NULL

6 180 Receiving Facility NULL

7 26 Date/Time Of 20130115112030

Message

8 40 Privacy NULL

9 13 Message Type ORU^R01

10 20 Message Control ID 1

11 3 Sample type P

12 60 HL7 Version ID 2.3.1

13 15 Serial number 1

14 180 Continuous pointer （ GUID Globally

unique identifier）

15 2 Acceptance （AL: always confirm,

confirmation type NE: never, ER: error）

16 2 Application （AL: always confirm,

confirmation type NE: never, ER: error）

17 3 Country code CHA

18 16 Character Set Unicode

19 250 Main language Null

20 20 Operations planning Null

9
 another character set

21 10 Uniformity declare ID Null

3.2 PID message head definition

Table 6 PID fields definition table

No. Max length Field Name Actual values

1 4 Set ID 1

2 Null

3 20 Patient ID（To be used Patient ID （ Sample

as QC lot No. in the No.）

message of QC）

4 20 Alternative Patient ID Medical record No.

5 250 Patient Name &LName&&&

6 250 Mother's maiden Null

name

7 26 Date/Time of Birth Date/Time

8 1 gender F:female 、 M:male 、

O:Other

9 250 Patient Aliases Null

10 250 Race Null

11 250 Patient address Null

12 4 Country code Null

13 250 Phone Number - Null

Home

14 250 Phone Number - Null

Business

15 250 Primary Language Null

16 250 Marital Status Null

17 250 Religion Null

18 250 Patient Account Null

10
 Number

19 16 SSN Number - Patient Null

20 25 Driver's License Null

Number - Patient

21 250 Mother's Identifier Null

22 250 Ethnic Group Null

23 250 Birth Place Null

24 1 Multiple Birth Null

Indicator

25 2 Birth Order Null

26 250 Citizenship Null

27 250 Veterans Military Null

Status

28 26 Nationality Null

29 26 Patient Death Date Null

and Time

30 1 Patient Death Null

Indicator

3.3 PV1 message head definition

Table 7 PV1 fields definition table

No. Max length Field Name Actual values

1 4 Set ID 1

2 10 Patient Class clinic

3 80 Assigned Patient Department

Location
Admission Type
4 2 Null
Pre-admission
5 250 number Null
Prior Patient Location
6 80 Null
Attending Doctor
7 250 Null

11
 Referring Doctor
8 250 Null
Consulting Doctor
9 250 Null
Hospital Service
10 3 Null
Temporary Location
11 80 Null
Pre-admission Test
12 2 Indicator Null
Re-admission
13 2 Indicator Null
Admit Source
14 6
Ambulatory Status
15 2
VIP Indicator
16 2
Admitting Doctor
17 250
Patient Type
18 2
Visit Number
19 250
Financial Class
20 50
Charge Price Indicator
21 2

3.4 OBR message head definition

Table 8 OBR fields definition table

No. Max Length Name Actual values

Set ID
1 4 1
Placer Order Number
2 22 Null
Filler Order Number
3 22 Null
Universal Service ID
4 250 Null
Priority
5 2 Null
Requested Date/time
6 26 Inspecting time
Observation
7 26 Date/Time Proving time
Observation End
8 26 Date/Time Checking time
Collection Volume
9 20 Null
Collector Identifier
10 250 inspector
Specimen Action Code
11 1 Null
Danger Code
12 250 Null

12
13 20 Null
Specimen Received
14 26 Date/Time Sampling time
Specimen Source
15 300 Null
Ordering Provider
16 250 Null
Order Callback Phone
17 250 Number Null
Placer Field 1
18 60 Null
Placer Field 2
19 60 Null
Filler Field 1 +
20 60 Null
Filler Field 2 +
21 60 Null
Results Rpt/Status
22 26 Chng - Date/Time + Null
Charge to Practice+
23 40 Null
Diagnostic
24 10 department ID HM
Result Status
25 1 Null
Parent Result +
26 400 Null
Quantity/Timing
27 200 Null
Result Copies To
28 250 Null
Parent No.
29 200 Null
Transportation Mode
30 20 Null
Check original
31 250 Null
Principal Result
32 200 Interpreter Genrui
Assistant Result
33 200 Interpreter Null
Technician
34 200 Null
Registrar
35 200 Null
Scheduled Date/Time
36 26 Null
Number of Sample
37 4 Containers Null
Transport Logistics of
38 250 Collected Sample Null
Collector’s Comment
39 250 Null

13
3.5 OBX message head definition
Table 9 OBX fields definition table

No. Max Length NAME Actual values

Set ID
1 4 Serial number
Value Type
2 2 NM
Observation Identifier
3 250 ^PCT^
Observation Sub-ID
4 20 Null
Observation Value
5 65536 Value
Units
6 250 Units
References Range
7 60 Reference range
Abnormal Flags
8 5 L: Low、H: High、Null:

normal
Nature of Abnormal
9 2 Test Null

10 Null
Observ Result Status
11 1 F
User Defined Access
13 20 Checks Null- unedited

O– Expired reagent

E–Active editing

e– Passive editing
Date/Time of the
14 26 Observation Null
Producer's ID
15 250 Null
Responsible Observer
16 250 Null
Observation Method
17 250 Null
Device identifier
18 22 Null

3.5.1 Custom OBX definition

Table 10 Custom fields table

No. Field Observation Identifier Remark

OBX Test Mode Text type CBC+DIFF、

CBC

14
OBX Ref Group Parameter Group

OBX Age Age

OBX Blood Mode Whole blood 、

pre-dilution、

peripheral whole

blood

OBX Remarks Remark information

OBX Blood Type Blood type

OBX ESR ESR

OBX WBCScatter_BMP WBC Histogram,JPG is

transmitted in the

form of bitmap

OBX WBCScatter_DATA WBC Histogram is

transmitted in the

form of raw data, not

available

OBX RBCHistogram_BMP RBC Histogram,JPG is

transmitted in the

form of bitmap

OBX RBCHistogram_DATA RBC Histogram is

transmitted in the

form of raw data, not

available

OBX PLTHistogram_BMP PLT Histogram, JPG is

transmitted in the

form of bitmap

OBX PLTHistogram_DATA PLT Histogram is

transmitted in the

form of raw data, not

available

OBX DIFFScatter_BMP Diff scatter,JPG is

15
 transmitted in the

form of bitmap

3.6 MSA message head definition

Table 11 MSA fields definition table

No. Max Length NAME Actual Values

1 2 Acknowledgment Shown in the

Code following table

2 20 Message Control ID The same as the

request of message

control ID

3 80 Text message Null

4 15 Expect series No. Null

5 1 Delay Null

acknowledgment type

6 250 Error Condition

3.6.1 Confirmation code

Table 12 Confirmation code table

Value Note

AA Original mode: Application Accept – Enhanced mode: Application acknowledgment:

Accept

AE Original mode: Application Error – Enhanced mode: Application acknowledgment:

Error

AR Enhanced mode: Application acknowledgment: Reject

CA Original mode: Application Error – Enhanced mode: Application acknowledgment:

Error

CE Enhanced mode: Accept acknowledgment: Commit Error

CR Enhanced mode: Accept acknowledgment: Commit Reject

16
3.6.2 Error conditions

Table 13 Error conditions table

Error status code Error status text Note

Success

0 Message accepted Successful. Selected, means

AA transmission is successful,

used to return ‘1’ status code

to system.

Errors Error

100 Segment sequence error Segment order in the message

is wrong, or necessary

segment lost

101 Required field missing Necessary field lost in a

segment

102 Data type error Segment data type error, e.g.

NM field contains ‘FOO’

103 Table value not found Table value is not found; not

used temporarily

Rejection status code:

200 Unsupported message type Message type is not supported

201 Unsupported event code Event code is not supported

202 Unsupported processing id Processing ID is not supported

203 Unsupported version id Version ID is not supported

204 Unknown key identifier Unknown key identifier, e.g.

transmitting the patient

information that is not exited

205 Duplicate key identifier Repeated key words existed

206 Application record locked Issues cannot be executed at

application program saving

level, e.g. database is locked

17
207 Application internal Other interior errors of

error application program

18
 Appendix A
Figure 1 Communication figure ............................................................................................ 6

Table 1 Character table ........................................................................................................ 4

Table 2 Transferred meaning principles................................................................................. 5

Table 3 PC->LIS ..................................................................................................................... 6

Table 4 LIS->PC ..................................................................................................................... 6

Table 5 MSH fields definition table ....................................................................................... 9

Table 6 PID fields definition table ....................................................................................... 10

Table 7 PV1 fields definition table....................................................................................... 11

Table 8 OBR fields definition table ...................................................................................... 12

Table 9 OBX fields definition table ...................................................................................... 14

Table 10 Custom fields table ............................................................................................... 14

Table 11 MSA fields definition table ................................................................................... 16

Table 12 Confirmation code table ....................................................................................... 16

Table 13 Error conditions table ........................................................................................... 17

19