SH - BX4000 Online Interface
SH - BX4000 Online Interface
SH - BX4000 Online Interface
Software Specifications
BX-4000 Host Interface
Host Interface Specifications Version SP-E7233-0A
Revision History
REV DATE REVISION HIGHLIGHT
- Aug.,2011 Initial issue
Host Interface Specifications Version SP-E7233-0A
Table of Contents
1. Introduction ............................................................................................................. 1
1.1 System configuration...................................................................................................... 1
2. Low level control ..................................................................................................... 2
2.1 Physical Layer ................................................................................................................ 2
2.1.1 Communication specifications ................................................................................ 2
2.1.2 Connectors .............................................................................................................. 2
2.1.3 Pin assignment ....................................................................................................... 2
2.1.4 Interface signals ...................................................................................................... 2
2.1.5 Cable specifications ................................................................................................ 3
2.2 Data Link Layer ................................................................................................................... 4
2.2.1 Summary of transmission control characters ......................................................... 4
2.2.2 Message composition ............................................................................................. 4
2.2.3 Transmission procedure ......................................................................................... 5
2.2.4 Status transition table .................................................................................................. 7
3. High level control .................................................................................................... 9
3.1 Command Record .......................................................................................................... 9
3.2 Data Character Code ..................................................................................................... 9
3.3 Sequence Number ......................................................................................................... 9
3.4 H: Message Header Record ........................................................................................ 10
3.5 P: Patient Information Record .......................................................................................11
3.6 O: Test Order Record ................................................................................................... 12
3.7 R: Result Record .......................................................................................................... 15
3.8 C: Comment Record .................................................................................................... 20
3.9 Q: Request Information Record ................................................................................... 20
3.10 L: Message Terminator Record .................................................................................... 21
3.11 S: Scientific Record ...................................................................................................... 21
3.12 M: Manufacturer Information Record ........................................................................... 21
4. Communication sequence .................................................................................... 22
4.1 Communication Modes ..................................................................................................... 22
5. Communication Sequence.................................................................................... 24
5.1 Batch Sequence ........................................................................................................... 24
5.1.1 Batch transmission of result to Host ..................................................................... 24
5.1.2 Inquiry to host for order and response.................................................................. 26
5.2 Real-time Sequence..................................................................................................... 27
5.2.1 Real-time inquiry to Host for one sample and its response.................................. 27
5.2.2 Real-time transmission of result to Host for one sample...................................... 28
5.4 Error Handling .............................................................................................................. 29
5.4.1 Transmission error ............................................................................................ 249
5.4.2 Reception Error ................................................................................................... 32
5.4.3 Retry over.............................................................................................................. 33
Host Interface Specifications Version SP-E7233-0A
1. Introduction
This document specifies the communication scheme between the BX-4000 Clinical Chemistry Analyzer
(hereinafter called Analyzer) and the Host Computer (hereinafter called Host). The construction of this
on-line system enables communication between the Analyzer and the Host, and retrieval of the
measurement results from the Analyzer in response to an external order. This on-line system defines each
item as a protocol within the conformity of the following standards:
Lower level (Low level control): ASTM E1381-95
High level (High level control): ASTM E1394-91
On Line System
Host Computer
Clinical Chemistry
Analyzer
RS232C
1/33
Host Interface Specifications Version SP-E7233-0A
2.1.2 Connectors
Connector on the Analyzer is a D-sub 9pin Male.
Connector at the Analyzer side of cable is a D-sub 9pin Female.
2/33
Host Interface Specifications Version SP-E7233-0A
The cable for host communication is RS-232C with the following cable connection.
CD 1 CD
RD 2 RD
TD 3 TD
DTR 4 DTR
GND 5 GND
DSR 6 DSR
RTS 7 RTS
CTS 8 CTS
RI 9 RI
Analyzer Host
3/33
Host Interface Specifications Version SP-E7233-0A
Note 1: FN is the sequence number assigned to each frame and the ASCII text (0, 1, 2, 3, 4, 5, 6and 7) is
cyclically used. For re-transmission, the same sequence number is used. When divide by ETB,
it will be processed as new sequence number. Default setting is “1”.
At reception of message with same sequence number, handle as duplicate of re-transmission and
discard the message.
Messages divided with ETB will have new sequence number. Initial value shall be “1”.
Note 2: TEXT is the division of ASCII text message itself and the number of characters for one text is
limited to less than 240 characters (including “CR”) and below. Addition of “CR” is optional
settings. It is possible to set from details setting on System Parameters => System (F9).
Note 3: ETX code (ASCII code: 03H) or ETB code (ASCII code: 17H).
Note 4: In the checksum (Hex) frame, calculate the sum of bits of each message from FN to ETX
excluding STX and use last two digits. When check sum do not match, discard the message.
4/33
Host Interface Specifications Version SP-E7233-0A
Where the text exceeds 240 bytes, it can be divided with ETB (ASCII code: 17H).
S E S E
C C C L C C C L
T ..... T
1 2 R F
T ..... T
1 2 R F
X B X B
S E
C C C C L
.......... T .... R
T
1 2 R F
X X
2.3.3.1
Transmission of data from Analyzer to Host.
The control codes are shown in < > in the following figure.
Host Analyzer
<ENQ> 1) <ENQ>
<ACK> 2) <ACK>
Data 1 3) <STX><FN><TEXT><ETB><C1><C2><CR><LF>
<ACK> 4) <ACK>
<STX><FN><TEXT><ETB><C1><C2><CR><LF>
<ACK>
5/33
Host Interface Specifications Version SP-E7233-0A
2.3.3.2
Transmission of data from Host to analyzre
The control codes are shown in < > in the following figure.
Host Analyzer
1) <ENQ>
<ENQ>
<ACK> 2) <ACK>
Data 1
3) <STX><FN><TEXT><ETB><C1><C2><CR><LF>
<ACK>
4) <ACK>
<STX><FN><TEXT><ETB><C1><C2><CR><LF>
<ACK>
6/33
Host Interface Specifications Version SP-E7233-0A
7/33
Host Interface Specifications Version SP-E7233-0A
Data
Data
Send data reception
NAK Data Timer timeout reception
Status timeout interruption
reception reception T1: 15 sec timeout
T2: 15 sec timeout
T3: 30 sec
T4: 15 sec
Initialization No action No action No action No action No action No action
Stop T1 timer
Send ENQ
Establishing Send EOT
Restart T1 No action No action No action No action
connection Status to
timer
“Initialization”
Connected No action No action No action No action No action No action
Stop T2 timer
Send data
Send EOT
Waiting again
No action No action Return data No action No action
response Restart T2
Status to
timer
“Initialization”
Stop T3 timer
Restart T3
Discard
timer
Data corrupted
No action Data reception No action No action No action
reception received data
Send
Status to
ACK/NAK
“Initialization”
Stop T3 timer
Discard
Completing
corrupted
data No action No action No action No action No action
received data
reception
Status to
“Initialization”
Stop T4 timer
Initialization-
No action No action No action No action No action Status to
2
“Initialization”
Note 1: Wait timer between characters are 100ms. At time out, the action will be the same as receiving
NAK.
Note 2: At data re-transmission, sequence number should be the same as original data transmission.
Note 3: At data reception, characters before STX and after ETB and ETX should be discarded.
Note 4: All received data without sequential sequence number should be discarded.
Note 5: Maximum retry of data re-transmission is five times. After the fifth retry, EOT will be sent and
change status to initialization. Error must be displayed in this condition.
Note 6: Host should return status to Initialization after no connection for 20 seconds from the analyzer.
Note 7: Maximum retry for ENQ is ten. After the tenth retry, generate an error then start over.
8/33
Host Interface Specifications Version SP-E7233-0A
9/33
Host Interface Specifications Version SP-E7233-0A
Process
Max. upon This system Process on transmission
Field # Designation Omission
digits reception used/unused from Analyzer
from Host
1) Record type 1 Abandoned used disapproved Record type "H"
Delimiters established in
2) Delimiter 4 Abandoned used disapproved this system (|, back slash, ^
and &)
Message
3) 0 - unused - -
control ID
Access
4) 0 - unused - -
password
Name of Name of Analyzer defined
5) 32 Abandoned used disapproved
Analyzer in this system
Address of
6) 0 - unused - -
sender
Reserved
7) 0 - unused - -
field
Telephone
8) number of 0 - unused - -
sender
Characteristic
9) 0 - unused - -
of sender
10) Recipient ID 0 - unused - -
Note or
11) special 0 - unused - -
instruction
12) Process ID 0 - unused - -
13) Version No. 0 - unused - -
Date and time at
14) Date & time 14 Abandoned used disapproved transmission.
YYYYMMDDHHMMSS
Meanings of “used/unused”:
used: data available at transmit side;
unused: no data at transmit side.
Meanings of “Omission”:
disapproved: omission is not approved;
approved: omission is approved.
-: The item is not used in this system and thus must be omitted.
10/33
Host Interface Specifications Version SP-E7233-0A
11/33
Host Interface Specifications Version SP-E7233-0A
belo Classification,
w(*4) Location, Ward and
Bed No.
Nature of Alternative
27) Diagnostic Code and 0 - unused -
Classifiers
Alternative Diagnostic
28) 0 - unused -
Code and Classifiers
29) Patient Religion 0 - unused -
30) Marital Status 0 - unused -
31) Isolation Status 0 - unused -
32) Language 0 - unused -
33) Hospital Service 0 - unused -
34) Hospital Institution 0 - unused -
35) Dosage Category 0 - unused -
*1 When “Date of Birth” is abbreviated, “G2” will be used for normal range.
*2 When “Sex” is abbreviated, “Unknown” will be used for “Sex”.
When “Unknown” is selected as “Sex”, “Male” will be used for normal range
*3 Blood type should be as follows;
12/33
Host Interface Specifications Version SP-E7233-0A
Send as received
8) Date and time of sample YYYYMMDDHH
14 used disapproved or manually
extraction MMSS
entered
Date and time of
9) completion of sample 0 - unused -
extraction
10) Extracted volume 0 - unused -
Name who extracted
11) 0 - unused -
sample
12) Treatment code 0 - unused -
13) Danger code 0 - unused -
Relevant clinical
14) 0 - unused -
information
Date and time of receipt
15) 0 - unused -
of sample
16) Specimen Descriptor 0 - unused -
17) Specimen Type 0 See note below *2 used approved Send as received
18) Specimen Source 0 - unused -
19) Ordering Physician 0 - unused -
Physician’s Telephone
20) 0 - unused -
Number
21) Users Field No.1 0 - unused -
22) Users Field No.2 0 - unused -
Date/Time Results
23) Reported or Last 0 - unused -
Modified
Instrument Charge to
24) 0 - unused -
Computer System
25) Instrument Section ID 0 - unused -
26) Report Types 0 - unused -
27) Reserved Field 0 - unused -
Location or Ward of
28) 0 - unused -
Specimen Collection
Nosocomial Infection
29) 0 - unused -
Flag
30) Specimen Service 0 - unused -
31) Specimen Institution 0 - unused -
*1 Universal Test ID for test order record when ISE of ASTM is separated.
Universal Test ID Description
00 No order
01 – 60 Clinical Chemistry (*Note)
61 ISE (Na)
62 ISE (K)
63 ISE (Cl)
64 Diluted ISE (Na)
65 Diluted ISE (K)
66 Diluted ISE (Cl)
81 Serum Information (H, L, I)
91 - 98 Profile 1 to 8
Universal Test ID for test order record when ISE of ASTM is not separated.
Universal Test ID Description
00 No order
01 – 60 Clinical Chemistry
61 ISE (Na, K, Cl)
13/33
Host Interface Specifications Version SP-E7233-0A
*Note. Analyzer transmit Universal Test ID with zero suppress when Universal Test ID is from “1” to “9”.
Use delimiter “^” for delimiting test ID and use “¥” for multiple entry of test ID.
(Example 1) In case of order test ID No.1
O|1|001||^^^1
Describe test ID on the each part which is delimited by “^” when ASTM is not complied.
(Example 1) In case of order test ID No.1
O|1|001||1
*2 Specimen Type
Specimen Type Description
01 COMMON
02 SERUM
03 URINE
04 PLASMA
When “Specimen Type” is abbreviated, “Common” will be used.
14/33
Host Interface Specifications Version SP-E7233-0A
Process
Process on
Max. upon This system
Field # Designation Omission transmission from
digits reception used/unused
Analyzer
from Host
1) Record type 1 Abandoned used disapproved Record type “R”
Sequence
2) 6 Abandoned used disapproved Serial number (1 –)
number
Universal Test Method code 0 - 3999
3) 5 Abandoned used disapproved
ID Refer to the table below
zzzzzzzzzz9.99999
Decimal place which is
entered in Chemistry
Test results
parameter.
4) (Concentration 17 Abandoned used disapproved
value)
“*****” should be
transmitted when result is
“*****”.
5) Unit 8 Abandoned used disapproved Unit for results
Range of
6) 0 - unused - -
reference value
Followings will be sent.
Technical range code,
Normal range code,
7) Flag 42 Abandoned used disapproved Error flag code,
Rerun result flag code,
QC flag code 1 – 10.
Refer to the table below
Conditions for
8) the range of 0 - unused - -
reference value
9) Status 0 - unused - -
Date when
10) reference value 0 - unused - -
is changed
Operator
11) 0 - unused - -
identification
Date and time
of
12) 0 - unused - -
commencement
of test
Date and time
13) of completion 14 Abandoned used disapproved YYYYMMDDHHMMSS
of test
Instrument
14) 0 - unused -
Identification
15/33
Host Interface Specifications Version SP-E7233-0A
16/33
Host Interface Specifications Version SP-E7233-0A
Transmission
Description Priority Display
code
A Error occurred 1 Error flag
> Technical range over "High" 2 >
< Technical range over "Low" 2 <
H Normal range over "High" 3 H
L Normal range over "High" 3 L
N Normal 4 no display
LL Unused - -
HH Unused - -
U Unused - -
D Unused - -
B Unused - -
W Unused - -
Note: The length of data varies with the details setting on System Parameters => System (F9)
17/33
Host Interface Specifications Version SP-E7233-0A
Code Display
00 - Normal
01 SS Sample short
02 SS Sample liquid level detection out of range at aspiration.
03 SI1 Sample liquid level not detected at aspiration
04 SI1 Sample liquid level detection out of range at dispensation
05 SI2 Sample short (diluted sample)
06 SI2 Sample liquid level detection out of range at aspiration (diluted sample)
07 R1S R1 short
08 R1S R1 liquid level detection out of range at aspiration
09 R2S R2 short
10 R2S R2 liquid level detection out of range at aspiration
15 DS Diluent short
16 DS Diluent liquid level detection out of range at aspiration
17 WS Wash solution short
18 WS Wash solution liquid level detection out of range at aspiration
19 R1B R1 reagent bottle not registered.
20 R1S R1 reagent no inventory
21 R2B R2 reagent bottle not registered.
22 R2S R2 reagent no inventory
27 DB Diluent bottle not registered.
28 DS Diluent no inventory
29 WB Wash solution bottle not registered.
30 WS Wash solution no inventory
31 EST Sampling stop due to error
32 LOT Reagent lot number mismatch
33 SPW SPT wash failure
34 R1W RPT wash between methods failed (R1)
35 R2W RPT wash between methods failed (R2)
38 SPS SPT clot
40 TE1 IRU temperature less than 35 degrees centigrade.
41 TE2 IRU temperature more than 39 degrees centigrade.
42 TE3 RCU temperature more than 15 degrees centigrade.
50 EXP Measured with expired reagent
51 STB Measured with expired onboard stability reagent
52 CTO Terms of validity of calibration is expired
53 CXP Control expired
54 SXP Calibrator expired
60 IE1 No response from ISE module.
61 IE2 No measurement results from ISE module.
62 IE ISE unit abnormal
70 CA? Concentration calculation failure
71 OVR Calibrator out of valid range error
72 LIN Linearity Limit error
73 PRO Prozone Limit error
74 AB1 Absorbance Limit1 error
75 AB2 Absorbance Limit2 error
18/33
Host Interface Specifications Version SP-E7233-0A
Code Display
76 DUP Duplicate Limit error
77 SEN Sensitivity Limit error
78 CAL Calibration failed
82 STM Sample type mismatch
83 CLT Reagent lot mismatch
84 CLM Measurement is not performed due to reagent mismatch.
Note: Only methods that are set as “Warning” or “Error” on QC -> QC setting of UI software will be
valid. All items set as “Inactive” at QC, QC settings screen will be set to “00”.
Note: Results for non QC measurements such as normal, emergency and standards will have “00” for
all 10 fields.
19/33
Host Interface Specifications Version SP-E7233-0A
20/33
Host Interface Specifications Version SP-E7233-0A
21/33
Host Interface Specifications Version SP-E7233-0A
4. Communication sequence
22/33
Host Interface Specifications Version SP-E7233-0A
The following table describes the result output functions for each communication mode.
23/33
Host Interface Specifications Version SP-E7233-0A
5. Communication Sequence
Following is the example of communication on On-line batch mode with result transmission operation.
5.1.1.1 Analyzer will check communication status with Host at beginning of each round.
Host Analyzer
Communication check from
Analyzer to Host
<ENQ>
1. Reply inquiry (initial
<-------------------------------------------------- communication check *1)
<ACK>
2. Reply from host
---------------------------------------------------->
<EOT>
3. Link open
<---------------------------------------------------
*1 When reply from the host is <NAK> or no response, analyzer will re-try for 6 times. If <NAK> or no
reply continues for 6 times, analyzer will generate error message and will not proceed with the round.
Host Analyzer
24/33
Host Interface Specifications Version SP-E7233-0A
25/33
Host Interface Specifications Version SP-E7233-0A
The following is an example of communication when test order acquisition operation was done at test
ordering screen at online batch mode.
The test order acquired will be added or over written to the existing order after it is confirmed and edited.
Example of communication
Host Analylzer
Inquiry from Analyzer to
Host
1. Message Header Record
H|¥^&|||Analyzer|||||||||20010111055300<CR>
←
Q|1|ALL||||||||||N<CR> 2. Request Information
← Record
L|1<CR> 3. Message Terminator
← Record
Response from Host
4. Message Header
H|¥^&|||Host|||||||||20010111055303<CR>
Record
→
5. Patient Information P|1|PID2734|||Patient Name||19630501|M|Race1||||
Record AttenPhID|1234567890123<CR>
→
6. Test Order Record O|1|001||^^^1¥^^^^03<CR>
→
7. Comment Record C|1|I|TestOrder1|G<CR>
→
26/33
Host Interface Specifications Version SP-E7233-0A
The inquiry is made at online real-time mode during run to obtain test order from Host.
5.2.1.1 Analyzer will check communication status with Host at beginning of each round.
Host Analyzer
Communication check from
Analyzer to Host
Host Analyzer
Inquiry from Analyzer to
Host
1. Message Header Record
H|¥^&|||Analyzer|||||||||20010111055300<CR>
←
Q|1|910000000001||||||||||N<CR> 2. Request Information
← Record
L|1<CR> 3. Message Terminator
← Record
Response from Host
4. Message Header
Record H|¥^&|||Host|||||||||20010111055303<CR>
→
5. Patient Information P|1|PID2734|||Patient Name ||19630501|M|Race1||||
Record AttenPhID|1234567890123<CR>
→
6. Test Order Record O|1|910000000001||^^^01¥^^^3<CR>
→
8. Message L|1<CR>
Terminator Record →
Note: When there is no order for inquired sample, return order information with empty universal test ID
field
Note: When rerun is not required at host rerun mode, return order information with empty universal test ID
field (“00”). However, auto rerun is performed for the method which is set as auto rerun.
Note: Comment information can be omitted.
27/33
Host Interface Specifications Version SP-E7233-0A
The result is transmitted to Host when results for a sample is obtained during run. This transmission is
performed at online real-time mode and online batch mode.
Example of transmission
Host Analyzer
1. Message Header Record
H|¥^&|||Analyzer|||||||||20010111055300<CR>
←
P|1|PID2734|||Patient Name||19630501|M|Race1|||| 2. Patient Information
AttenPhID|1234567890123<CR> Record
←
O|1|910000000001||^^^1<CR> 3. Test Order Record
←
C|1|I|TestOrder1|G<CR> 4. Comment Record
←
28/33
Host Interface Specifications Version SP-E7233-0A
When transmission of a message has caused an error, re-transmission of the message will be carried out
from high level message.
The buffered data will be save at reception of higher level message.
Host Analyzer
1. Message Header Record
H|¥^&|||Analyzer|||||||||20010111055300<CR>
←
P|1|PID2734|||Patient Name||19630501|M|Race1|||| 2. Patient Information
AttenPhID|1234567890123<CR> Record
←
O|1|001||^^^1<CR> 3. Test Order Record
←
C|1|I|TestOrder1|G<CR> 4. Comment Record
←
29/33
Host Interface Specifications Version SP-E7233-0A
5) 1) 2) 3) 4) 5)
6) 1) 2) 3) 4) 5) 6)
7) 1) 2) 3) 4) 5) 6) 7)
8) 1) 2) 3) 4) 5) 6) 7) 8)
9) 1) 8) 9)
10) 1) 8) 9) 10)
11) 1) 8) 9) 10) 11)
12) 1) 8) 9) 10) 11) 12)
13) 1) 12) 13)
14) 1) 12) 13) 14)
15) 1) 12) 13) 14) 15)
16) 1) 12) 13) 14) 15) 16)
30/33
Host Interface Specifications Version SP-E7233-0A
When message “4)” is not received for T1 time out time after transmitting “3)”, it will be handled as
described on the table below. For the messages 5) to 14) will be handled as an error in case message is not
received for T2 time out time.
Host Analyzer
4. Message Header
Record H|¥^&|||Host|||||||||20010111055303<CR>
→
5. Patient Information P|1|PID2734|||Patient Name ||19630501|M|Race1||||
Record AttenPhID|1234567890123<CR>
→
6. Test Order Record O|1|001||^^^01¥^^^3<CR>
→
7. Comment Record C|1|I|TestOrder1|G<CR>
→
31/33
Host Interface Specifications Version SP-E7233-0A
5.4.2.2 Error during test order inquiry for a sample at real-time mode
Host Analyzer
4. Message Header
Record H|¥^&|||Host|||||||||20010111055303<CR>
→
5. Patient Information P|1|PID2734|||Patient Name ||19630501|M|Race1||||
Record AttenPhID|1234567890123<CR>
→
6. Test Order Record O|1|910000000001||^^^1¥^^^3<CR>
→
7. Comment Record C|1|I|TestOrder1|G<CR>
→
32/33
Host Interface Specifications Version SP-E7233-0A
End.
33/33