Network Interface Specifications

Network interface specifications
Appendix B - Network Interfaces
B.1 Protocol specification
The software uses the ASTM E1394 protocol to implement communication.

All the communication information of software and LIS system is stored in the Catlog\online\log.
B.2 Control code specification
Table B.2-1 Control code specification

Character Description Corresponding ASCII
<ENQ> Inquiry 0x05
<ACK> Confirm Response 0x06
<STX> Beginning of document 0x02
<ETX> End of document 0x03
<CR> Home key 0x0D
<EOT> End of transmission 0x04
B.3 Basic communication format specification
<ENQ><STX>content<STX><EOT>
For example:
<ENQ><STX>TEST<STX><EOT>
Table B.3-1 Basic communication format specification

<ENQ> Inquiry 0x05
T Letter T 0x54
E Letter E 0x45
S Letter S 0x53
T Letter T 0x54
Operating Instructions Page B-1

B.4 Separator specification
The ASTM E1394 Agreement has defined 4 separators to distinguish the communication content.
Refer to Section 6.4 of E1394 for details. The following table shows the implication of each separator:
Table B.4-1 Separator specification

Separators Description Corresponding ASCII
<CR> Record separator 0x0D
| Field separator 0x7C
\ Repeating separator 0x5C
^ Component separator 0x5E
& Special separator 0x26
B.5 Message type specification
Table B.5-1 Message type specification

Message label Description
H Message header record
P Patient information record
O Test assay record
R Result record
Q Inquiry information record
L Message termination record
B.5.1 Message header (H)
Note:
The content in this section corresponds to Section 7 of ASTM E1394.
Message header records should be put in front of all transmission records and are used to describe some
protocols and basic transmission information.
Example:
H|\^&||PSWD|Maglumi 4000 Plus|||||LIS||P|E1394-97|20100323<CR>
Page B-2 Operating Instructions

Table B.5-2 Message header record

Maximum
Field E1394 ASTM field name Content Whether Required
length
1 7.1.1 Message type H 1 Yes
2 7.1.2 Separator definition |\^& 4 Yes
4 7.1.4 Password PSWD 20 No
Maglumi 4000
5 7.1.5 Transmitter name 20 Yes
Plus
10 7.1.10 Receiver name LIS 20 Yes
12 7.1.14 Processing method P 1 Yes
13 7.1.13 Protocol version No. E1394-97 10 Yes
14 7.1.14 Date YYYYMMDD 14 Yes
Attention:
1. There 14 fields in the protocol, it’s only listing the necessary fields of this software
here, and other fields could be complemented during the process of actual
communication and the software is able to identify automatically. The "|" separator is
also needed to separate different fields if values are not required for some of these
fields.
2. The <CR> separator at the end of message records is required. This separator must be
added at the end of each message record to indicate the end of each message record.
B.5.2 Patient information record (P)
Note:
Every patient’s related information should be described by this record.
Example:
P|1||||ABC|||F<CR>

Table B.5-3 Patient information record

Maximum
length
1 8.1.1 Message type P 1 Yes
2 8.1.2 Serial No. 1 6 Yes
6 8.1.6 Patient name ABC 30 No
9 8.1.9 Sex M, F, U 1 No
Attention:
1. Since only the first and second fields are required, patient information records in the
software are generally written in the P|1 <CR> format.
2. The protocol includes a total of 35 fields. Not all fields this software requires are
listed in the table. The rest of the fields can be added during the actual
communication process and can be automatically recognized by the software.
3. The <CR> separator at the end of the message records is required. This separator
must be added at the end of each message record to indicate the end of each message
record.
B.5.3 Test assay record (O)
Note:
Information of each test assay should be described by this record.
Example:
O|1|1234567||^^ÂLT|R<CR>

Table B.5-4 Test assay record

Maximum
length
1 9.1.1 Message type O 1 Yes
3 9.1.3 Sample Number 1234567 22 Yes
5 9.1.5 Test assay ^^ÂLT 30 Yes
6 9.1.6 Priority S, R 1 Yes
Attention:
1. In the fifth field “Test Assay” , the first three “^” are required and the following
ALT is the actual assay name.
2. In the 6th field “Priority”, S refers to STAT, R refers to routine, and R is generally
used.
record.
B.5.4 Result record (R)
Note:
All information about each test result should be described by this record.
Example:
R|1|^^ÂLT|115.3|pg/mL|0 to 200|N||||||20100326172956<CR>

Table B.5-5 Result record

Maximum Whether
Field E1394 ASTM field name Content
length Required
1 10.1.1 Message type R 1 Yes
3 10.1.3 Test assay ^^ÂLT 10 Yes
4 10.1.4 Result 115.3 12 No
5 10.1.5 Unit pg/mL 10 No
6 10.1.6 Reference Range 0 to 200 30 No
7 10.1.7 Result mark L,H,N 1 No
YYYYMMD
13 10.1.13 Test completion time 14 No
DHHMMSS
Attention:
1. In the third field “test assay” , the first three “^” are required and the last ALT is the
actual assay name.
2. In the 7th field “Result flag”, L refers to lower than normal range, H refers to higher
than normal range, N refers to normal.
record.

B.5.5 Enquiry information record (Q)
Note:
This is used to request assay information related to sample from LIS.
Example:
Q|1|^1234567||ALL||||||||O<CR>
Table B.5-6 Enquiry information record

Maximum Whether
length Required
1 12.1.1 Message type Q 1 Yes
3 12.1.3 Sample Number ^1234567 22 Yes
5 12.1.5 All test assays All 10 Yes
Request information
13 10.1.13 O 1 Yes
status
Attention:
1. In the third field “Sample No.”, the initial “^” is required and the following 1234567
is the actual sample number.
record.

B.5.6 Message termination record (L)
Note:
This is used in the last transmission record, indicating transmission completed.
Example:
L|1|N<CR>
Table B.5-7 Message termination record

Maximum Whether
length Required
1 13.1.1 Message type L 1 Yes
3 13.1.3 End code N 1 Yes
Attention:
The <CR> separator at the end of the message records is required. This separator must
be added at the end of each message record to indicate the end of each message record.

B.6 Example description
B.6.1 Enquire test assay
When the user inserts the sample rack into the sample area, the software will request sample related
lab test information from LIS system through the following messages after the instrument scanning the
barcode of sample.
Message content:
--><ENQ>
<--<ACK>
--><STX>
<--<ACK>
-->H|\^&||PSWD| Maglumi 4000 Plus |||||Lis||P|E1394-97|20100323<CR>
Q|1|^1234567||ALL||||||||O<CR>
L|1|N<CR>
<--<ACK>
--><ETX>
<--<ACK>
--><EOT>
<--<ACK>
Table B.6-1Character implication

--> Software sending
<-- Software receiving
<ENQ> Inquiry 0x05
<ACK> Confirm Response 0x06
<CR> Home key 0x0D
Where:
H|\^&||PSWD| Maglumi 4000 Plus |||||Lis||P|E1394-97|20100323<CR>

Q|1|^1234567||ALL||||||||O<CR>
L|1|N<CR>

This is a string of message that ASTM E1394 requesting sample related reagent and the above text is
the enquire of 1234567 sample related reagent.
Attention:
1. The <ACK> in the above transmitted content is returned by the LIS
system, which requires sending the corresponding <ACK> command in
the written position, otherwise the software will regard that LIS system
as disconnected.
2. After LIS system receiving the message, it should return to the test
assay information.
B.6.2 Return to test assay
After LIS system receiving the enquire of test assay from the software, it should return to test
assay information.
Message content:
<--<ENQ>
--><ACK>
<--<STX>
--><ACK>
<--H|\^&||PSWD| Maglumi 4000 Plus |||||Lis||P|E1394-97|20100319<CR>
P|1<CR>
O|1|1234567||^^^CA125|R<CR>
O|2|1234567||^^^CA153|R<CR>
O|3|1234567||^^^CYFRA211|R<CR>
O|4|1234567||^^^FT3|R<CR>
O|5|1234567||^^^FT4|R<CR>
O|6|1234567||^^^T3|R<CR>
O|7|1234567||^^^TG|R<CR>
O|8|1234567||^^^TGA|R<CR>
L|1|N<CR>
--><ACK>
<--<ETX>
--><ACK>
<--<EOT>
--><ACK>
Where:

H|\^&||PSWD| Maglumi 4000 Plus|||||Lis||P|E1394-97|20100319<CR>

P|1<CR>
O|1|1234567||^^^CA125|R<CR>
O|2|1234567||^^^CA153|R<CR>
O|3|1234567||^^^CYFRA211|R<CR>
O|4|1234567||^^^FT3|R<CR>
O|5|1234567||^^^FT4|R<CR>
O|6|1234567||^^^T3|R<CR>
O|7|1234567||^^^TG|R<CR>
O|8|1234567||^^^TGA|R<CR>
L|1|N<CR>
This is a string of message that LIS system of ASTM E139 returning to sample related test assay
information, the above text is the 1234567 sample related reagent CA125. CA153, CYFRA211, FT3, FT4,
T3, TG, TGA returned by LIS system.
Attention:
The <ACK> in the above transmitted content is returned by the LIS system, which
requires sending the corresponding <ACK> command in the written position,
otherwise the software will regard that LIS system as disconnected.
B.6.3 Send test result
Message content:
--><ENQ>
<--<ACK>
--><STX>
<--<ACK>
-->H|\^&||PSWD| Maglumi 4000 Plus |||||Lis||P|E1394-97|20100326<CR>
P|1<CR>
O|1|1234567||^^^CYFRA211<CR>
R|1|^^^CYFRA211|0.8|ng/mL|0 to 7|N||||||20100326172956<CR>
L|1|N<CR>
<--<ACK>
--><ETX>
<--<ACK>
--><EOT>
<--<ACK>

Where:
H|\^&||PSWD| Maglumi 4000 Plus |||||Lis||P|E1394-97|20100326<CR>

P|1<CR>
O|1|1234567||^^^CYFRA211<CR>
R|1|^^^CYFRA211|0.8|ng/mL|0 to 7|N||||||20100326172956<CR>
L|1|N<CR>
This is a string of messages that the ASTM E1394 sends test result to the LIS system, the above test is
indicating the software is sending the test result of reagent CYFRA211 related to 1234567 sample to the
LIS system.
Attention:
The <ACK> in the above transmitted content is returned by the LIS system, which
requires sending the corresponding <ACK> command in the written position,
otherwise the software will regard that LIS system as disconnected.

Network Interface Specifications

Uploaded by

Document Information

Copyright

Available Formats

Share this document

Share or Embed Document

Sharing Options

Did you find this document useful?

Is this content inappropriate?

Copyright:

Available Formats

Network Interface Specifications

Uploaded by

Copyright:

Available Formats

Network interface specifications

Appendix B - Network Interfaces

B.1 Protocol specification

The software uses the ASTM E1394 protocol to implement communication.

B.2 Control code specification

Table B.2-1 Control code specification

B.3 Basic communication format specification

Table B.3-1 Basic communication format specification

Operating Instructions Page B-1

B.4 Separator specification

Table B.4-1 Separator specification

B.5 Message type specification

Table B.5-1 Message type specification

B.5.1 Message header (H)

Page B-2 Operating Instructions

Table B.5-2 Message header record

1 7.1.1 Message type H 1 Yes

2 7.1.2 Separator definition |\^& 4 Yes

4 7.1.4 Password PSWD 20 No

10 7.1.10 Receiver name LIS 20 Yes

12 7.1.14 Processing method P 1 Yes

13 7.1.13 Protocol version No. E1394-97 10 Yes

14 7.1.14 Date YYYYMMDD 14 Yes

B.5.2 Patient information record (P)

Operating Instructions Page B-3

Table B.5-3 Patient information record

1 8.1.1 Message type P 1 Yes

2 8.1.2 Serial No. 1 6 Yes

6 8.1.6 Patient name ABC 30 No

B.5.3 Test assay record (O)

Page B-4 Operating Instructions

Table B.5-4 Test assay record

1 9.1.1 Message type O 1 Yes

2 9.1.2 Serial No. 1 6 Yes

3 9.1.3 Sample Number 1234567 22 Yes

5 9.1.5 Test assay ^^^ALT 30 Yes

6 9.1.6 Priority S, R 1 Yes

B.5.4 Result record (R)

Operating Instructions Page B-5

Table B.5-5 Result record

1 10.1.1 Message type R 1 Yes

2 10.1.2 Serial No. 1 5 Yes

3 10.1.3 Test assay ^^^ALT 10 Yes

4 10.1.4 Result 115.3 12 No

5 10.1.5 Unit pg/mL 10 No

6 10.1.6 Reference Range 0 to 200 30 No

7 10.1.7 Result mark L,H,N 1 No

Page B-6 Operating Instructions

B.5.5 Enquiry information record (Q)

Table B.5-6 Enquiry information record

1 12.1.1 Message type Q 1 Yes

2 12.1.2 Serial No. 1 6 Yes

3 12.1.3 Sample Number ^1234567 22 Yes

5 12.1.5 All test assays All 10 Yes

Operating Instructions Page B-7

B.5.6 Message termination record (L)

Table B.5-7 Message termination record

1 13.1.1 Message type L 1 Yes

2 13.1.2 Serial No. 1 6 Yes

3 13.1.3 End code N 1 Yes

Page B-8 Operating Instructions

B.6 Example description

B.6.1 Enquire test assay

Table B.6-1Character implication