Meril Autoquant 100 Astm-Protocol - Rev1.2

Download as pdf or txt
Download as pdf or txt
You are on page 1of 20

MERIL DIAGNOSTICS PVT LTD

AutoQuant 100

ASTM LIS Communication protocol

R&D
Meril Diagnostics PVT LTD

Product
Doc

AutoQuant 100
AutoQuant Application - LIS communication protocol

Version

1.2

Revision History
Date
09.Nov.2013
11 Nov. 2013

Version
1.0
1.1

12 Dec 2013

1.2

Description / Modifications
Draft created
Added TCP/IP, multiple data retrieval and
serial port cable configuration
Communication packets added

Author
Chandrakant
Chandrakant
Chandrakant

INDEX
1

Overview ................................................................................................................................... 3
1.1 Purpose: .............................................................................................................................. 3
1.2 Scope: ................................................................................................................................. 3
1.3 Conventions: ....................................................................................................................... 3
1.4 Primary Reference: ............................................................................................................. 3
2 Communication Specifications .................................................................................................. 4
2.1 Physical layer ...................................................................................................................... 4
2.1.1 INTERCONNECTION DIAGRAM-HARDWARE ........................................................... 4
2.1.2 Serial port configuration: ............................................................................................... 5
2.2 Data link layer ..................................................................................................................... 5
2.2.1 Communication Status.................................................................................................. 6
2.2.2 Transmission Characters .............................................................................................. 8
2.2.3 CHECKSUM CALCULATION ....................................................................................... 8
2.3 Record transmission protocol .............................................................................................. 8
2.3.1 Message Header Record .............................................................................................. 9
2.3.2 Patient Information Record ........................................................................................... 9
2.3.3 Test Order Record ...................................................................................................... 10
2.3.4 Result Record ............................................................................................................. 11
2.3.5 Comment Record ....................................................................................................... 12
2.3.6 Request Information Record ....................................................................................... 12
2.3.7 Message Terminator Record ...................................................................................... 13
3 Actual data Send and Receive through AutoQuant. ................................................................ 14
3.1 RECEIVE: ......................................................................................................................... 14
Select appropriate com-port , on which serial port of LIS is connected. ............................ 15
Baud Rate will be selectable during LIS communication. Same baud rate should be set at LIS
Software. ................................................................................................................................. 15
3.2 DATA UPLOAD(send) ....................................................................................................... 19

Product
Doc

AutoQuant 100
AutoQuant Application - LIS communication protocol

Version

1.2

1 Overview
1.1

Purpose:

This Document details the specifications for communication of Clinical Chemistry analyzer With LIS
Software using ASTM protocol. Explain the process for communication through instrument software
by user.
1.2

Scope:

Detailed information on operation of the system is beyond the scope of this document. The
information offered here is strictly to aid programmers in grasping very basic operational features of
the Analyzer LIS communication.
1.3

Conventions:

This document consists primarily of a series of examples that show the information needed to
successfully interface to the system. The basic concept of data transfer in this interface is the
exchange of data and control frames between the host system and the analyzer.
1.4

Primary Reference:

E1381 02
Low-Level Protocol to Transfer Messages between Clinical Laboratory Instruments and Computer
Systems.
E1394 97
Standard specifications for Transferring Information Between Clinical Instruments and Computer
Systems.

Product
Doc

AutoQuant 100
AutoQuant Application - LIS communication protocol

Version

1.2

2 Communication Specifications
Communication specifications are based on a layer protocol. The layers are:
Physical Layer
Data Link Layer
Presentation Layer
2.1

Physical layer

Specifies the sending and receiving of signals between the Analyzer PC and LIS PC through
Physical and electrical connections.
2.1.1

INTERCONNECTION DIAGRAM-HARDWARE

AutoQuant Analyzer

Analyzer PC

ASTM Communication Packets


Serial RS-232 or TCP/IP

LIS PC

Product
Doc

2.1.2

AutoQuant 100
AutoQuant Application - LIS communication protocol

Version

1.2

Serial port configuration:

Standard serial port configuration as shown below can be used for LIS communication.
Serial cable used as communication medium ensures uninterrupted communication
channel.
Being a Peer-To-Peer type of communication medium, management of transmittable
packets is easier and taken care of by the host application.
The serial cable connecting the Host PC and LIMS PC must be a single chunk (without any
joints) and should be lesser than 15 meters in length.
Odd, Even, No parity can be used during communication against the default None
Data Length sets those can be used are 8
Start Bits are 1.

2.2

DB 9 (Host)

DB 9 (LIMS)

Data link layer

Specifies the sending and receiving of data by link connections and for each frame between
Analyzer PC and LIS PC .

Product
Doc

2.2.1

AutoQuant 100
AutoQuant Application - LIS communication protocol

Version

1.2

Communication Status

Transition is accomplished through the following three phases.


Establishment Phase
Establishes a communication line, and determines the direction of data transfer.
The sender sends an [ENQ] signal to the receiver To respond to the sender, the receiver performs
the following action:
ANALYZER

<ENQ>

LIS-PC

Returns an [ACK] signal when communications are enabled.


ANALYZER

<ACK>

LIS-PC

Returns a [NAK] if receiver is not ready (BUSY).


ANALYZER

<NACK>

LIS-PC

Transfer Phase
The sender transmits messages to the receiver until all messages are transferred.
ANALYZER

<STX> Frame 1 <ETB> C1 C2 <CR> <LF>

LIS-PC

<ACK>

<STX> Frame 2 <ETB> C1 C2 <CR> <LF>

<ACK>

Termination Phase
The sender notifies the receiver that all messages have been transferred.
After the termination phase, the status returns to neutral.
6

Product
Doc

AutoQuant 100
AutoQuant Application - LIS communication protocol

Version

1.2

The sender sends the <EOT> to inform the receiver that the message transmission has been
completed.
ANALYZER

<EOT>

LIS-PC

When the sender sends <EOT>, sender goes in to neutral status.


When the receiver receives <EOT>, receiver processes data packet and then gets into neutral
status.

Product
Doc

AutoQuant 100
AutoQuant Application - LIS communication protocol

Sr. #

CHAR

STX

HEX
VALUE
02

ETX

03

ACK

06

NACK

15

ENQ
(BOT)
EOT

8
9
10

2.2.3

1.2

Transmission Characters

2.2.2

Version

^
`
&
P,O,R,Q,C

17

5E(decimal
94)
60
38
--

Description
Receiver will slice data from this character
onwards for actual data evaluation.
Receiver will slice data up to this character
from STX for actual data evaluation.
Positive acknowledgment.
Character used to confirm correct and
complete string sent by the counterpart
Negative acknowledgment
Character used to confirm that string
received is incorrect or incomplete
Character used to initiate communication.
Character used to confirm that transmission
from the transmitting end is over.
Component Delimiter

Repeat Delimiter
Escape Delimiter
Record identification bytes
P -Patient Information Record
O -Test Order Record
R -Result Record
C -Comment Record
Q -Request Information Record

CHECKSUM CALCULATION

The checksum is the modulus 8 of the sum of ASCII values of the frame characters starting with and
including FN till character before <ETX> (in case of single frame) or <ETB> (in case of multiple
frames).

2.3

Record transmission protocol

Specifies the messages that are sent and received by the Analyzer PC and LIS PC.
ASTM data is sent or received in terms of packets.
Packet starts with the Header (H) and ends with the Terminator (L).
Packet without header and terminator is treated as invalid and will be ignored.
ASTM Record Types :

Product
Doc

AutoQuant 100
AutoQuant Application - LIS communication protocol

Sr No.
1
2
3
4
5
6
9

Record Type
Message Header Record
Patient Information Record
Test Order Record
Result Record
Comment Record
Request Information Record
Message Terminator Record

Version

1.2

Convention
H
P
O
R
C
Q
L

Fields marked as * are mandatory.


Message Header Record

2.3.1

Field
1*
2*
12

13
14

Message Header Record


Fields
Record Type ID
Delimiter Definition
Processing ID

Version No.
Date and Time of
message
Carriage Return

15*

Size
String format
H
|`^&
P : (Production) Treat message
as an active message to be
completed accordingto standard
processing.
ASTM version No. 1394-97
current date time
YYYYMMDDHHMMSS
<CR> End of the string

1
4
1

10
14
1

Table 7 : Message Header Record


Example String:
H|\^&||||||||||P|E 1394-97|20100705071134<CR>
2.3.1.1 About Delimiters
1
2
3
4
2.3.2

|
`
^
&

Field Delimiter (Alt + 124)


Repeat Delimeter (Alt + 96)
Component Delimeter (Alt + 94)
Escape Delimeter (Alt + 38)

Patient Information Record


Field
1*
2*
3

Patient Information Record


Fields
Patient Record
Sequence Number
Practice Assigned Patient

Size
String format
P
Frame Number (only 1 digit)
Patient ID

1
1
40
9

Product
Doc

AutoQuant 100
AutoQuant Application - LIS communication protocol

ID
Patient Name

8
9
11

BirthDate
Patient Sex
Patient Address

13

Patient Telephone No.

14

Attending Physician ID

17
18

Height
Weight

36*

Carriage Return

Version

1.2

Name of the Patient (Last Name^First


Name^Middle Name^Title ) .
If Patient Name contains single quote i.e.
then it will get replaced by ` while
saving data.
YYYYMMDDHHMMSS
M/F/U (Male/Femal/Other)
Street Address^City^State^Zip^Country
Code
If Patient Address contains single quote
i.e. then it will get replaced by ` while
saving data.
Phone1`Phone2`Phone3 (It may contain
areacode ,countrycode,beeper
number,hours to call) e.g.
+912212345678`+912212345679
(Ordering Physician`Attending
Physician`Referring Physician)
If Physician ID contains single quote i.e.
then it will get replaced by ` while saving
data.
Height/Weight and Unit are separated by
component delimiter. 1.2^M
(default unit is cms for ht and Kg for wt).
<CR>

30

14
1
50

20

40

8
7
1

Table 8 : Patient Information Record


Example String:
P|1|patient1|||VICHARE^PAT1^V||19710704|M||ANDHERI^MAHARASHTRA|RES1|8756873`694
749387948|NENE^RAM|||1.2^M|23<CR>
Important: 2.3.3

Test Order Record


Field
1*
2*
3*

Test Order Record


Fields
Test Order Identifier
Sequence Number
Speciman ID

Size
String format
O
Frame No.
Sample ID^Container No. (Samp1^01)

1
1
25

Values of Container No:


1 = TUBE (10 ml) Default Value
3 = TUBE (5-7 ml)
10

Product
Doc

AutoQuant 100
AutoQuant Application - LIS communication protocol

5*
6*

Universal Test ID
Priority

8
11

Speciman collection Date


and Time
Collector ID

12*

Action Code

15
16*

Date/ Time Speciman


Received
Specimen Descriptor

32*

Carriage Return

Version

1.2

Test Name (^^^ALB`^^^ALP`^^^LIVER)


S /A : Stat OR As soon as possible [i.e.
Emergency]
R : Routine
Actual date and time , the sample was
collected (YYYYMMDDHHMMSS)
The person and facility which collected the
speciman.
If Collector ID contains single quote i.e.
then it will get replaced by ` while saving
data.
A : Add the requested tests or batteries to
the existing sample
N : New requests accompanying a new
sample
P : Pending sample (Add but don't
schedule)
C : Cancel request for the battery or tests
named (Delete Test)
Date and Time recorded by laboratory

250
1

Sample Type : Blood, Urine, Serum,


Plasma, CSF (Not Case-Sensitive)
<CR>

14
20

14

Example String:
O|1|020100030286||^^^GLU`^^^UREA|R||||||A||||SERUM<CR>
Important
Speciman collection Date and Time:
If YYYYMMDD part is not Numeric then Analyzer Software will save the data received with Sample
Collection Date same as System Date.
Result Record

2.3.4

Field
1*
2*
3*
4*
5
6

Result Record
Fields
Result Record Identifier
Sequence Number
Universal Test ID
Data or Measurement
Value
Units
Reference Ranges

Size
String format
R
Frame No.
Test Name (^^^ALB)
Result value

1
1
8
10

ISO 2955
Lower limit to Upper limit

20
30
11

Product
Doc

7*
8
9

13*

AutoQuant 100
AutoQuant Application - LIS communication protocol

Result Abnormal Flags


Nature of Abnormality
Testing
Result Status

Date / Time Test


Completed
Carriage Return

N :Generic Normal Range was applied


to all patients
C : Correction of previously
transmitted results (Patient Report)
F : Final Results
Result Date in YYYYMMDDHHMMSS
format
<CR>

15*
Example String:
R|1|^^^ALP|200|IU/L|DEFAULT|A|N|F||||20100513113450<CR>
R|2|^^^AMY|93|U/L|DEFAULT|N|N|F||||20100513113535<CR>
2.3.5

Version

1.2

50
1

14
1

Comment Record
Field
1*
2*

Comment Record
Fields
Comment Record Identifier
Sequence Number

3*

Comment Source

4*
5*

Comment Text
Comment Type

6*

Carriage Return

Size
String format
C
Frame No.
L : Computer System (LIS)
I : Instrument (ASTM)
Code ^Comment Text
G : Generic/Free text comment
T: Test Name comment
<CR>

1
1
1
1000
1
1

Table 11 : Comment Record


Example String:
C|1|I| Test ALB Does Not Exist For SampleID 01010125.|G<CR>
2.3.6

Request Information Record


Field
1*
2*
3*
6

13*

Request Information Record


Fields
Request Record Identifier
Sequence Number
Starting Range ID Number
Nature of Request Time
Limits

Request Information Status


Codes
15*
Carriage Return
Example String:

Size

String format
Q
Frame No.
SampleID1`SampleID2
S : Sample Collection Date
R : Result Test Date
O : Requesting test orders and
demographics only
<CR>

1
1
115
14
14
1
1
12

Product
Doc

AutoQuant 100
AutoQuant Application - LIS communication protocol

Version

1.2

Q|1|^020100030279`020100030321`020100030304`020100030297|||S|||||||O<CR>
2.3.7

Message Terminator Record


Message Terminator Record

Field
1*
2*
3*

Fields
Message Terminator
Record Identifier
Sequence Number
Termination Code

Size
String format
L

1
N : Normal Termination

1
1

Table 12: Message Terminator Record


Example String:
L|1|N<CR>

2.4
2.4.1

2.4.2

Data packets format examplePatient Request (Host to LIS)

Patient Details (LIS to Host)


<ENQ>(LIS to Host)
<ACK> (Host-> LIS)
<STX>1H|`^&||****|TBM-LIMS|Seepz||||||E-139497|20131205090513<CR>P|1|PAT1|LPAT1|LPAT13 |Joshi^Pramila^V||19710704|M|W|ANDHE
RI^MAHARASHTRA|RES1|8756873`69749387948|`NENE^RAM|SP1|SP2|1.2^M|23|PDIG1|PACT
MED|DIET|PR1|PR2|20080929`20080929|OP|ANDHERI|NAltDig|AltDig|H|M|ARP|marathi|HpSer|
HpInst|A<CR>C|1|L|Patient
Information|G<CR>O|1|Pat1|IPat1|^^^ABCD1`^^^ALB`^^^TBIL|R|20080929|20080929|2008092
9|200^ml|preeta|N|DngC|RCIInfo|20080929|SERUM|`NENE^RAM|233245354|||LB1|LB2|2008092
9|566|B1|O|RES1|WARD1|NIF|SPSER|SPINST<CR>L|1|N<CR><ETX>6B<CR><LF> (LIS to
Host)
<ACK> (Host-> LIS)
<EOT> (LIS to Host)
2.4.3

Result Packet (Host to LIS)

<ENQ><ACK>
<STX>1H|\^&|||Meril^3.6^11052213||||||||E-1394-97|20131203141051<CR><ETX>28<CR><LF><ACK>
<STX>2P|1||||Chan Du|||M||||||25^Y<CR><ETX>49<CR><LF><ACK>

13

Product
Doc

AutoQuant 100
AutoQuant Application - LIS communication protocol

Version

1.2

<STX>3R|1|^^^TP|10.00|g/dL|0^0|||N|F||||20131203141051<CR><ETX>0F<CR><LF><ACK>
<STX>4R|2|^^^ALB|5.00|g/dL|0^0|||N|F||||20131203141051<CR><ETX>10<CR><LF><ACK>
<STX>5L|1|N<CR><ETX>06<CR><LF><ACK>
<EOT> <ACK>

Actual data Send and Receive through AutoQuant.

3.1

RECEIVE:

For TCP/IP settings, go to Maintenance > parameter settings > Enter password > enter TCP/IP
details with port number > Select.

For serial port or TCP/IP communication, Go to Schedule screen, click the button shown below

14

Product
Doc

AutoQuant 100
AutoQuant Application - LIS communication protocol

Version

1.2

LIS information window will open.


For Serial port:
Select the port number and Baud rate.

Select appropriate com-port , on which serial port of LIS is connected.

Baud Rate will be selectable during LIS communication. Same baud rate should
be set at LIS Software.

For TCP/IP:
Select TCP/IP and confirm the IP address and IP port. Start receiving directly.

15

Product
Doc

AutoQuant 100
AutoQuant Application - LIS communication protocol

Version

1.2

Click on Receive button as highlighted in above screen.


On click patient Input Dialog will open. As displayed below

16

Product
Doc

AutoQuant 100
AutoQuant Application - LIS communication protocol

Version

1.2

Enter patient ID for patient information to be receive and click on save. Multiple patient ID can
be saved similarly.

After save Receive button will be enabled as shown in below screen.

Click on Receive, as highlighted in above screen.

17

Product
Doc

AutoQuant 100
AutoQuant Application - LIS communication protocol

Version

1.2

Application will send all patient ID data to LIS, in Response LIS will send patient information &
test order. Application will store this data & displayed in screen as shown below.

All details are shown in respective fields, Instrument sample ID and position will be
automatically taken up by the software based on already scheduled or run samples for that
day. User has to confirm all the details. If required to change Position and container type,
user can select that patient, change position and type, click OK, modified information will be
reflected for that sample.
Data will be reflected in list. Click Save to schedule the details.
Patient information receive process is completed. Work list can be seen as below.

18

Product
Doc

3.2

AutoQuant 100
AutoQuant Application - LIS communication protocol

Version

1.2

User can run the schedule as per normal procedure.

DATA UPLOAD(send)

After Run completion, results are displayed on report screen as displayed below.

Select Patient ID to send the results to LIS. Add information (details) if required, click save and click
on Data upload button as displayed in above screen. If required, multiple patient data can be
selected by dragging mouse over required IDs.
It will ask for LIS communication details select the fields as per below screen.

19

Product
Doc

AutoQuant 100
AutoQuant Application - LIS communication protocol

Version

1.2

LIS Port has to be selected.


Click on Select. Data will be uploaded to LIS.
Completion message will be displayed in screen.

20

You might also like