Professional Documents
Culture Documents
BA-88A LIS Interface Manual (v1.0)
BA-88A LIS Interface Manual (v1.0)
, , , , BeneView, WATO,
BeneHeart, are the trademarks, registered or otherwise, of Mindray in China
and other countries. All other trademarks that appear in this manual are used only
for informational or editorial purposes. They are the property of their respective
owners.
All information contained in this manual is believed to be correct. Mindray shall not
be liable for errors contained herein or for incidental or consequential damages in
connection with the furnishing, performance, or use of this manual.
Mindray is responsible for the effects on safety, reliability and performance of this
product, only if:
• the electrical installation of the relevant room complies with the applicable
national and local requirements; and
i
WARNING:
It is important for the hospital or organization that employs this
equipment to carry out a reasonable service/maintenance plan.
Neglect of this may result in machine breakdown or personal injury.
NOTE:
This equipment must be operated by skilled/trained clinical
professionals.
Warranty
THIS WARRANTY IS EXCLUSIVE AND IS IN LIEU OF ALL OTHER
WARRANTIES, EXPRESSED OR IMPLIED, INCLUDING WARRANTIES OF
MERCHANTABILITY OR FITNESS FOR ANY PARTICULAR PURPOSE.
Define:
• Main unit: Integrated facilities which implements the specified function
separately. General speaking, it should include power supply, control system and
some functional modules.
Exemptions
Mindray's obligation or liability under this warranty does not include any
transportation or other charges or liability for direct, indirect or consequential
damages or delay resulting from the improper use or application of the product
or the use of parts or accessories not approved by Mindray or repairs by
people other than Mindray authorized personnel.
ii
enough.
¾ Consumables: N/A
Return Policy
Return Procedure
In the event that it becomes necessary to return this product or part of this product
to Mindray, the following procedure should be followed:
2 Freight policy: The customer is responsible for freight charges when this
product is shipped to Mindray for service (this includes customs charges).
3 Return address: Please send the part(s) or equipment to the address offered
by the international Customer Service Department
Company Contact
Manufacturer: Shenzhen Mindray Bio-Medical Electronics Co., Ltd.
E-mail Address: [email protected]
EC Representative
EC-Representative: Shanghai International Holding Corp. GmbH(Europe)
Tel: 0049-40-2513175
Fax: 0049-40-255726
iii
Preface
1
Contents
Preface............................................................................................................................ 1
Who Should Read This Manual ...................................................................................... 1
What Can You Find in This Manual ................................................................................ 1
Conventions Used in This Manual .................................................................................. 1
Contents ..........................................................................................................i
1 Mindray HL7 Interface........................................................................1-1
1.1 Messages Compatible with HL7 Interface ........................................................ 1-1
1.2 HL7 Lower Layer Protocol ................................................................................ 1-1
1.3 Minimal Lower Layer Protocol(MLLP).......................................................... 1-2
1.4 Message Coding Mode ..................................................................................... 1-2
1.5 Channel No. Setup............................................................................................ 1-2
1.6 Parameter Setup for Serial Port Communication ............................................. 1-3
i
1 Mindray HL7 Interface
The LIS server can receive test data from BA-88A through serial port. The data
include: sample test result and QC test result. In the meantime BA-88A receives
the confirming information from LIS. The following will explain the connection in
details. All data are transmitted in format of HL7 v2.3.1.The interface only supports
the imbalanced transfer between BA-88A and LIS server.
Only portion of the messages, segments and other data defined are used for
Mindray HL7 interface that needs only part of these data.
Communication Layer
1-1
<SB> ddddd <EB><CR>
Where,
ASCII <VT>, namely <0x0B>, must not be confused with the SOH or STX in ASCII.
ASCII <FS>, namely <0x1C >, must not be confused with the ETX or EOT in ASCII.
1-2
Channel No. Setup: At the LIS server end, the user should set corresponding
channel No. in data dictionary on the basis of the information on BA-88A.
If the channel No. is not set, the software can not recognize the uploaded
information about test and control, displaying them as void or unknown.
The software can recognize the Test information, Qualitative description, and
Sample Type, etc, only when you set them in accordance with those set in the
system in Dictionary.
The channel No. of test information, qualitative description, and sample type should
be consistent with the index No. set on BA-88A in System-LIS setup.
1-3
2 Communication Custom
and HL7 Protocol
The manual covers two areas on the communication between BA-88A and the LIS:
test result transfer and the confirmation information return. The test results include:
sample test result and QC test result. When LIS server receives the data, it should
return confirmation information indicating when the sending is successful.
2.1 Introduction
This chapter introduces the message types (Ver. 2.3.1) used by Mindray HL7
interface.
NOTE
HL7 supports many types of messages, but only 2 of them are employed on the
Mindray HL7 interface. To upload test result, ORU^R01 message is used. To
confirm, ACK^R01 message is used. The following text will explain it in detail.
NOTE
For complete and detailed descriptions of HL7 message grammar, refer to the HL7
standard written by the HL7 standard committee.
2-1
Each HL7 message is composed of segments that end with <CR>.
Each segment consists of a name (three characters) and variable fields that are
composed of components and subcomponents. The separators of each element
are defined in the MSH segment in every message.
For instance,
MSH|^~\&|Mindray|BS-200|||20060427194802||ORU^R01|1|P|2.3.1||||0||ASCII|||
Where,
The five characters following MSH are defined as delimiters to separate the fields,
components and subcomponents. Although the characters can be any non-text
ones, the HL7 standard recommends you to use the following:
Character Description
| Field separator
^ Component separator
& Subcomponent separator
~ Repetition separator
\ Escape character
The order of the segments following MSH in every message is specially specified.
A segment is defined as optional or to be repeated by using the following grammar:
The uploading and confirming of the test result is indicated in the following figure.
2-2
Details are explained in the following.
ORU^R01 is used to transmit test results (sample test and QC test) to the LIS host.
-Patient information (patient name, gender, birth date, MRN, comment, reviewer
and etc.)
-Sample information (sample No., sample type, sender, Send D/T, Test D/T).
-Test result information (test No. test name, test result type, quantitative test result
–concentration, qualitative test result-Negative/Positive, unit, reference range,
abnormal symbol, test time and etc).
LIS can choose these items based on necessity. The details are in the following.
-Control information (number, No. name, lot No., mean, concentration, SD)
The LIS host is able to choose any of the information in the message as needed.
Details are explained in the following.
2-3
ACK Acknowledgment Description
- Field name
- Field length
- Description
All fields used in message segment are listed in following tables. Mindray HL7
interface protocol uses the following fields. Void represents the one which has no
meaning and not used.
The MSH segment of Mindray HL7 interface uses the following fields:
2-4
13 Sequence Number 15 Void and reserved.
14 Continuation Pointer 180 Void and reserved.
15 Accept 2 Void and reserved.
Acknowledgment
Type
16 Application 2 Type of application response, used as result
Acknowledgment type.0-patient test result; 1-calibration test result;
Type 2-QC test result; 3-whole plate test result. The field
will return unchanged in response message. It will be
void in other messages.
17 Country Code 2 Void and reserved.
18 Character Set 10 Character set. ASCII is used.
19 Principal Language 60 Void and reserved.
Of Message
20 Alternate Character 20 Void and reserved.
Set Handling
Scheme
Table 2.2 field in MSH segment
Comments: MSH segment applies to all messages. Fields 10 and 16 are integers,
while others are strings.
Comments: The segment only applies to the ACK^R01 messages. Fields 6 are
integers, while others are strings.
2-5
Note: Fields of MSA-6 are introduced as follows.
2-6
2 Patient ID 20 Void and reserved.
3# Patient Identifier List 20 MRN
4 Alternate Patient ID – PID 20 Void and reserved.
5# Patient Name 48 Name of patient
6 Mother’s Maiden Name 48 Void and reserved.
Comments: The PID segment only applies to the ORU^R01 messages. Field 1 is
an integer, while others are strings.
2-7
2.3.4 OBR Observation Request
OBR segment is used to transfer the order information of test report. When the
sample test result is transferred (MSH-16 is 0), the field used in Mindray HL7
interface is shown in the following table.
2-8
29 Parent 150 Void and reserved.
30 Transportation Mode 20 Void and reserved.
31 Reason for Study 300 Void and reserved.
32 Principal Result Interpreter 200 Void and reserved.
33 Assistant Result Interpreter 200 Void and reserved.
34 Technician 200 Void and reserved.
35 Transcriptionist 200 Void and reserved.
36 Scheduled Date/Time 26 Void and reserved.
37 Number of Sample Containers 4 Void and reserved.
38 Transport Logistics of 60 Void and reserved.
Collected Sample
39 Collector’s Comment 200 Void and reserved.
40 Transport Arrangement 60 Void and reserved.
Responsibility
41 Transport Arranged 30 Void and reserved.
42 Escort Required 1 Void and reserved.
43 Planned Patient Transport 200 Void and reserved.
Comment
44 Ordering Facility Name 60 Void and reserved.
45 Ordering Facility Address 106 Void and reserved.
46 Ordering Facility Phone 48 Void and reserved.
Number
47 Ordering Provider Address 106 Void and reserved.
Table 2.6 Field of sample test result used in ORU segment
Comments: The PID segment only applies to the ORU^R01 messages. Field 1 is an
integer, while others are strings.
When QC test results are transferred (MSH-16 is 2), the applied fields include:
2-9
8 Observation End Date/Time 26 Void and reserved.
9 Collection Volume 20 Rule
0:Westgard Multi-rule
2:TWIN-PLOT rule
2-10
36 Scheduled Date/Time 26 Void and reserved.
37 Number of Sample Containers 4 Void and reserved.
38 Transport Logistics of Collected 60 Void and reserved.
Sample
39 Collector’s Comment 200 Void and reserved.
40 Transport Arrangement 60 Void and reserved.
Responsibility
41 Transport Arranged 30 Void and reserved.
42 Escort Required 1 Void and reserved.
43 Planned Patient Transport Comment 200 Void and reserved.
44 Ordering Facility Name 60 Void and reserved.
45 Ordering Facility Address 106 Void and reserved.
46 Ordering Facility Phone Number 48 Void and reserved.
47 Ordering Provider Address 106 Void and reserved.
Table 2.7 Field of QC test result used in ORU segment
Comments: The segment only applies to the ORU^R01 messages. Fields 1, 9, 10 and 11
are integers; fields 18, 19 and 20 are double numbers; others are strings. The tests of each
control are sent as one message.
The OBX segment of Mindray HL7 interface uses the following fields as
indicated in Table 2.8
2-11
6 Units 90 Result unit channel No.
7 References Range 90 Reference range for test result.
(void for quantitative)
8 Abnormal Flags 5 Abnormity flag to indicate whether the test
result is normal or not.
H-high, L-low, N-normal (void for
quantitative)
9 Probability 5 Qualitative test result (void for quantitative )
Negative-0, weak positive-1, positive-2.
Others are define on the basis of customer’s
definition (it should be integral larger than
2).
10 Nature of Abnormal Test 2 Void and reserved.
11# Observe Result Status 1 Status of observation result, set to F-final
results.
12 Date Last Observe Normal Values 26 Void and reserved.
13 User Defined Access Checks 20 Original test result (void for qualitative)
14 Date/Time of the Observation 28 Inspection Date:
15 Producer's ID 60 Void and reserved.
16 Responsible Observer 80 Tester
17 Observation Method 60 Void and reserved.
Table 2.8 Field of sample test result used in OBX segment
Comments: The OBX segment only applies to the ORU^R01 messages. Fields 1
is integer; fields 5, 7 and 13 are double numbers; others are strings.
2-12
3 Communication Process
and Message Example
Where, <SB> means the start of the message and is <VT> in ASCII, that is 0x0B.
<EB> means the end of the message and is <FS> in ASCII, that is 0x1C.
The microplate reader sends test result to the LIS server. On BA-88A, the test
result include three categories: sample test, QC test, whole plate test. The
uploading and confirming of the test result is indicated in the following figure.
Figure 3.1 The communication between BA-88A and the LIS server
The following lines list multiple message examples of the HL7 protocol.
3-1
3.1 Sample Test Result
The tests of one sample can be sent as one message. The LIS host responses
accordingly when receiving the message.
3-2
lower limit
Quantitative reference
value
Abnormal symbol L-low
Original test result -13396.000000
Date 20090514162938 20090514142850
The sample test result report is shown as follows:
(1) The field of the message header-MSH appears on every report. The format is
the same. The meaning is shown as follows:
String set
(2) PID means patient information. The meaning of the field is as follows:
(3) The following explains the meaning of the fields –OBR and OBX:
Sample ID STAT or not Test time Send time Sample type Sender
|||||||||||||||||||||||||||||||<CR>
3-3
OBX|1| NM | 111 | ALT | -13396.000000 | 16 | 0.100000-1.500000 | L ||| F |
Result type
(quantitative)
R e s u l t
Quantitative test Quantitative Abnormal observation
Result unit result range
symbol status
Test No. Test name result
<EB><CR>
3-4
Unit 16 corresponding to the unit u/L
<SB>MSH|^~\&|||||20090519093550||ORU^R01|7|P|2.3.1|||| 2 ||ASCII|||<CR>
Test name Wildcard QC rule QC type Control number Control lot No.
Control
Control mean Control SD Test result Unit
level
<EB><CR>
3-5
<SB>MSH|^~\&||||| 20090514163006 || ACK^R01 | 7 | P | 2.3.1 |||| 0 || ASCII |||<CR>
In consistent with
Current message Fixed as P which means
Message type the message type of
time product
ORU
<EB><CR>
3-6
P/N: 046-000381-00(1.0)