Vitalab LIS2-A Host

LIS2-A HOST-PC COMMUNICATION 3084-103-02
LIS2-A Host-PC communication

Selectra and Flexor Series
Document version: v1.9
VITAL SCIENTIFIC B.V.
Page 1 of 30
3084-103-02 LIS2-A HOST-PC COMMUNICATION
TABLE OF CONTENTS
1
Introduction ............................................................................................ 3
1.1
1.2
1.3
1.4
1.5
Hardware interfaces............................................................................... 4
2.1
2.2
General.......................................................................................................................................... 5
Frame format................................................................................................................................. 5
Messages ................................................................................................ 6
4.1
4.2
Serial port interface ....................................................................................................................... 4

Network interface .......................................................................................................................... 4
Data handling ......................................................................................... 5

3.1
3.2
Purpose ......................................................................................................................................... 3
Scope ............................................................................................................................................ 3
Definitions, acronyms and abbreviations ...................................................................................... 3
References.................................................................................................................................... 3
Overview ....................................................................................................................................... 3
General.......................................................................................................................................... 6
Record format ............................................................................................................................... 6
Messages to host ................................................................................... 8

5.1
5.2
5.3
5.4
5.5
5.6
5.7
5.8
Header (H) .................................................................................................................................... 8

Patient information record (P) ..................................................................................................... 10
Test order record (O) .................................................................................................................. 11
Result record (R)......................................................................................................................... 14
Comment record (C) ................................................................................................................... 17
Message Terminator Record (L) ................................................................................................. 19
Request information record (Q) .................................................................................................. 20
Manufacturer Information Record (M)......................................................................................... 21
5.8.1
Cuvette Blank information (B)...................................................................................... 21
5.8.2
Error History................................................................................................................. 22
5.8.3
Reagent installation (I)................................................................................................. 23
5.8.4
Extended version information ...................................................................................... 24
Appendix A Flags ........................................................................................ 25

Appendix B Units......................................................................................... 26
Appendix C ASCII CODE Chart .................................................................. 27
Appendix D Examples................................................................................. 28
D.1 Analyser messages ........................................................................................................................ 28
D.2 Host messages ............................................................................................................................... 29
Page 2 of 30
1 Introduction
1.1 Purpose
This document defines the interface between a Laboratory Information System (LIS) and an analyser.
The analyser can be a XL, E, Junior or Pro-series analyser. The LIS is in this document referred to as
Host.
1.2 Scope
The scope of this document is limited to defining the external interface of the PC at the analyser side.
1.3 Definitions, acronyms and abbreviations

Abbreviation
Host
LIS
Description
Computer that is part of the LIS and communicates with the analyser PC.
Laboratory Information System
Definition
Request buffer
Description
The list of samples and tests that have been ordered at the analyser. The samples
are not yet loaded onto the analyser. A request can be modified.
The list of samples and tests that are measured or currently being measured.
Result buffer
1.4 References
[1]
[2]
CLSI. Standard Specification for Low-Level Protocol to Transfer Messages Between Clinical
Laboratory Instruments and Computer Systems. CLSI document LIS1-A [ISBN 1-56238-489-9].
CLSI, 940 West Valley Road, Suite 1400, Wayne, Pennsylvania 19087-1898 USA, 2003.
CLSI. Standard Specification for Transferring Information Between Clinical Instruments and
Computer Systems. CLSI document LIS2-A [ISBN 1-56238-490-2]. CLSI, 940 West Valley Road,
Suite 1400, Wayne, Pennsylvania 19087-1898 USA, 2003.)
1.5 Overview
Chapter 2 defines the low-level interface between PC and Host.
Chapter 3 defines the format of the low-level frames transmitted between PC and Host.
Chapter 4 defines the general format of the high-level messages transmitted between PC and Host.
Chapter 5 defines the format of the individual messages that can be transmitted between PC and
Host.
Page 3 of 30
2 Hardware interfaces
2.1 Serial port interface

The characteristics for the physical layer of the communication are defined in CLSI standard LIS1-A
(See [1]), Section 5 Physical Layer for Serial Binary Data Exchange.
The line signal definition is shown in the following table:
DB-25
pin #
7
2
3
4
5
20
6
8
22
DB-9
pin #
5
3
2
7
8
4
6
1
9
SG
TD
RD
RTS
CTS
DTR
DSR
CD
RI
Signal name
Direction
Remarks
Signal Ground
Transmit data
Receive data
Request To Send
Clear To Send
Data Terminal Ready
Data Set Ready
Carrier Detect
Ring Indicator
output
input
output
input
output
input
input
input
data from analyser-PC to host

data from host to analyser-PC
*
*
*
*
not used
not used
The only pins really used are TX and RX, the usage of the rest (marked *) depends on the settings
of the COM-port of the analyser-PC.
The default setting for communication will be 9600 baud, 8 databits, no parity, 1 stopbit (8-N-1).
Warning:
The XON-XOFF protocol (which can be set by Windows) must NOT be used, because this can
interfere with the protocol.
2.2 Network interface

The characteristics for the physical layer of the communication are defined in CLSI standard LIS1-A
(See [1]), Section 7 Physical Layer for TCP/IP Data Interchange
Configuration of TCP/IP network adapter on the analyser is outside the scope of this document, refer
to the analyser manual.
For host communication the analyser allows setting host IP address and port number to define the
host socket. The analyser will connect to host socket after reset or as soon as communication is
enabled in system settings.
The connection will remain active as long as the PC application is running on the analyser. If for some
reason the TCP/IP connection is lost (e.g., because host system was restarted), then the analyser will
continuously try to reconnect.
Page 4 of 30
3 Data handling
3.1 General
The properties for the message sending and receiving are defined in CLSI standard LIS1-A (See [1]),
Section 6 Data Link Layer. The analyser software implements the standard and this section is only
intended to provide a short summary. For detailed information on error handling, time-out behavior and
contention, please refer to the standard.
The LIS1-A standard defines a line-bidding protocol that will define the receiver and sender for
communication. A system ready to send information will transmit an <ENQ> character. The receiver
will reply with <ACK> if it is ready to receive or <NAK> when it is busy. Refer to the state diagram in
Annex A1 of the standard [1].
After sender and receiver have been determined, the sender will transmit frames. Each frame starts
with an <STX> character and ends with <ETB> or <ETX> character, a checksum and <CR> <LF>.
The content of a frame is the message that is to be sent (see chapter 4).
The receiver will acknowledge the frame with <ACK> or <EOT>, or it may indicate an error by
responding with <NAK>. The <EOT> character indicates that the receiver has information to send and
requests that the line is returned to idle state. The sender may honor the <EOT> by responding with
<EOT> or it may ignore the <EOT> and send the next frame.
After the sender has transmitted an <EOT> character, the line is returned into idle state.
3.2 Frame format

The format of frames is:
For intermediate frames:
<STX>
FN
text
<ETB>
C1
C2
<CR>
<LF>
text
<ETX>
C1
C2
<CR>
<LF>
For end frame:

<STX>
<STX>
FN
text
<ETB>
<ETX>
C1
C2
<CR>
<LF>
=
=
=
=
=
=
=
=
=
FN
Start of Text transmission control character (ASCII 2)

Single Digit Frame number ASCII 0 to 7, starting with 1
Body of message, refer to following chapters
End of Transmission Block transmission control character (ASCII 23)
End of Text transmission control character (ASCII 3)
Most significant character of checksum 0 to 9 and A to F
Least significant character of checksum 0 to 9 and A to F
Carriage Return ASCII character (ASCII 13)
Line Feed ASCII character (ASCII 10)
The total size of a frame shall not exceed 64,000 bytes. Messages longer than 64,000 bytes are split
into multiple frames. A frame can contain only a single message.
The Frame number must start with the ASCII character 1 for the first frame that is transmitted after
the <ENQ> character.
Page 5 of 30
4 Messages
4.1 General
This section describes the format of messages between the analyser and the host. These messages
are formatted according to the LIS2-A standard (See [2]).
Messages are can be sent spontaneously or as a response to a query for information.
Each message consists of one or more records, each record is terminated with a carriage return
character (ASCII 13). The following example shows the flow of control of a message from a sender to
a receiver. The characters below ASCII 32 are written in the notation: STX (ASCII 2). The complete
ASCII code chart is provided in Appendix C, for more examples, refer to Appendix D.
Sender:
Receiver:
Sender:
Receiver:
Sender: EOT
E
A
NQ
CK
TX1H|\^&|||SELE||||1.0|||P|LIS2-A|20060126163201 RQ|1|^12936A||ALL||||||||OCRL|1|FCRETX23CRLF
A
CK
A host may transmit more fields and records than are specified in this document. The analyser shall
ignore those fields and records.
If the analyser receives a message that does not contain the required fields, it will ignore the message.
The analyser does not verify the correct sequential numbering of records from the host. However, the
record sequence number and record type fields are required fields by standard LIS2-A and are
included in the message. (In contrast, the frame number as defined in Chapter 3 (LIS1-A) must be
sequentially numbered and is checked by the analyser. Incorrect frame numbering will lead to rejection
of the frame.)
4.2 Record format

The message format texts follow standard LIS2-A (see [2]).
All records are formatted with delimiters. For the host protocol, the following delimiters are used:
Field delimiter: Vertical bar (|) Latin-1 (124)
Repeat delimiter: Backslash (\) Latin-1 (96)
Component delimiter: Caret (^) Latin-1 (94)
Escape delimiter: ampersand (&) Latin-1 (38)
The following escape sequences are recognized and transmitted by the analyser:
&F&
&S&
&R&
&E&
imbedded Field delimiter character

imbedded Component delimiter character
imbedded repeat field delimiter character
imbedded escape delimiter character
In cases where fields are limited to a maximum (e.g., sample_ID, patient name), this maximum applies
to the number of characters without replacing imbedded field delimiters by their escape sequence.
Example: Sample ID 15\a is transmitted as 15&R&a; but the number of characters for maximum
limit is 4.
Page 6 of 30

Except for the record-ID, the text fields are case-sensitive. This means that the analyser performs all
text comparisons sensitive the the case of the text field. For instance a request containing a character
s in the priority field, will not be interpreted as S (STAT) and a test request Asat will not match with
a test called ASAT on the analyser.
Page 7 of 30
5 Messages to host
This section describes the messages that are sent from the analyser to the host. For host
implementation, the minimally required fields are marked yes, unmarked fields are optional.
The numbering of the fields is indentical to the numbering used in the CLSI LIS2A standard [2].
5.1 Header (H)

Every message contains a header record. The header record contains the following fields:
Field
Analyser
(Transmitted to
host)
H
|\^&
Host
Received
from host
H
|\^&
Comment
Required
7.1.1
7.1.2
Record Type ID
Delimiter Definition
7.1.3
7.1.4
7.1.5
Message Control ID
Access Password
Sender Name or ID
<empty>
<empty>
device_id^
software_version
<ignored>
<ignored>
<ignored>
or
host_id
7.1.6
7.1.7
7.1.8
Sender Street Address

Reserved Field
Sender Telephone
Number
Characteristics of
Sender
Receiver ID
<empty>
<empty>
<empty>
<ignored>
<ignored>
<ignored>
1.7
<ignored>
Version number of host protocol.
host_id
host_id: text identifying the host

(see note below)
Comment or Special
Instructions
Processing ID
Version No.
Date and Time of
Message
<empty>
<ignored>
or
device_id
<ignored>
P
LIS2-A
current date/time
<ignored>
<ignored>
<ignored>
7.1.9
7.1.10
7.1.11
7.1.12
7.1.13
7.1.14
yes
yes
Other field delimiters are not

supported.
device_id: text defined in

communication parameters of
analyser application.
software_version: text containing
current software version of
sending application.
host_id: text identifying the host
(see note below)
YYYYMMDDHHMMSS
Device ID
The field device_id is used to identify the analyser and can be used as extra security that the tests are
performed on the correct analyser. It can be up to 20 characters long.
7.1.5 Sender Name or ID
If a host_id is defined in the analyser application, and a host_id is present in the received message,
then the message will be ignored if the host_id in the received message is not equal to the host_id in
the analyser application. A field may contain more components, these will be ignored. Note that if the
host_id in the message or the host_id in the analyser application is empty, this rule does not apply.
7.1.10 Received ID
if a device_id is defined in the analyser application, and a device_id is present in the received
message, then the message will be ignored if the device_id in the received message is not equal to
the device_id in the analyser application. A field may contain more components, these will be ignored.
Note that if the device_id in the message or the device_id in the analyser application is empty, this rule
does not apply.
Example header from analyser:
Page 8 of 30

H|\^&|||SELXL^2.1.0||||1.0|HOST||P|LIS2-A|20060120153902
Page 9 of 30
5.2 Patient information record (P)

The patient record contains the patient information. Every request from the host starts with a patient
record, followed by one or more order records (see section 5.3). Results from the analyser start with a
patient record, followed by one or more order records, where each order record is followed by one or
more result records (see section 5.4). Full examples are provided in Appendix D Examples.
Field
8.1.1
8.1.2
Record Type ID
Sequence Number
8.1.3
Practice Assigned
Patient ID
Laboratory Assigned
Patient ID
Patient ID No. 3
Patient Name
Mothers Maiden Name
Birthdate
Patient Sex
8.1.4
8.1.5
8.1.6
8.1.7
8.1.8
8.1.9
Analyser
(Transmitted
to host)
P
number
Host
Received
from host
P
<ignored>
<empty>
<ignored>
<empty>
<ignored>
<empty>
sample_name
<empty>
date_of_birth
M
F
U
<ignored>
sample_name
<ignored>
date_of_birth
<empty>
M
F
U
Comment
Required
yes
yes
Sequential number starting with

1 and continuing until the last
patient in the message
maximum 20 characters
YYYYMMDD
The contents of this field define
the applicable reference limits:
M: male
F: female
U: pediatric
Default: M
8.1.9 Patient Sex

On the instrument, the operator may rename male, female and pediatric, this does not have an
effect on the characters used in the host protocol. These are fixed to M, F and U respectively.
Example patient information record from analyser:
P|1||||Henry Johnson||19650714|M
Page 10 of 30
5.3 Test order record (O)

The order record contains information on the test to be performed for the preceding patient record (see
5.2).
Field
Analyser
(Transmitted
to host)
O
number
Host
Received
from host
O
<ignored>
Comment
Required
9.4.1
9.4.2
Record Type ID
Sequence Number
9.4.3
Specimen ID
<empty>
sample ID
<empty>
sample ID
9.4.4
Instrument Specimen ID
<empty>
Calibr. name
Control name
BLANK
<empty>
Calibr. name
Control name
BLANK
9.4.5
Universal Test ID
<empty>
^^âbbr_test
9.4.6
Priority
S
A
R
<empty>
S
A
R
9.4.7
Requested/Ordered Date
and Time
Specimen Collection
Date and Time
Collection End Time
Collection Volume
Collector ID
Action Code
<empty>
<ignored>
<empty>
<ignored>
<empty>
<empty>
<empty>
<empty>
<empty>
<empty>
<ignored>
<ignored>
<ignored>
<empty>
N
A
C
<ignored>
<ignored>
<empty>
<ignored>
sample type
BLANK
CALIBRATOR
CONTROL
Name
<empty>
sample type
See notes below
<empty>
name
Max 20 characters. In case this

field contains multiple
components, only the first
component is used.
9.4.8
9.4.9
9.4.10
9.4.11
9.4.12
9.4.13
9.4.14
9.4.16
Danger Code
Relevant Clinical
Information
Date/Time Specimen
Received
Specimen Descriptor
9.4.17
Ordering Physician
9.4.18
Physicians Telephone
Number
User Field No. 1
User Field No. 2
Laboratory Field No. 1
9.4.15
9.4.19
9.4.20
9.4.21
<empty>
<ignored>
<empty>
<empty>
<empty>
<ignored>
<ignored>
<ignored>
yes
yes
yes
yes

order for the patient
Maximum 12 characters
Empty for calibrator, control and
blanks.
For analyser samples like
calibrators, controls, and blank
measurements, the specimen ID
field (9.4.3) will be empty to
avoid conflicts. This field
identifies calibrator by name;
control by name or blank.
See notes below
Abbreviated test name max 4
characters long.
Host may send multiple requests
in single order record by use of
repeat delimiter.
See notes below
S (Stat)
A (ASAP / Pediatric)
R (Normal)
All other will be treated as R.
Default: R
Empty and other will be treated

as N
See notes below
Page 11 of 30
9.4.22
9.4.23
9.4.24
9.4.25
9.4.26
Laboratory Field No. 2

Date/Time Results
Reported or Last
Modified
Instrument Charge to
Computer System
Instrument Section ID
Report Types
<empty>
<empty>
<ignored>
<ignored>
<empty>
<ignored>
<empty>
F
X
I
<ignored>
<empty>
O
Q
Y
Z
see notes below
9.4.4 Instrument Specimen ID

When a calibrator, control or blank is requested from the host, fields with sample information will be
ignored.
9.4.5 Universal Test ID

To request ISE tests, the value for abbr_test must be ISE. The analyser reports ISE results as a
single Order record and separate result records for each ISE result, containing ^^ÎSE^K,
^^ÎSE^Na, etc. in the result record.
Example ISE result from analyser:
O|1|12935-C|||R|||||||||||Dr. Carnegy|||||||||FCR
R|1|^^ÎSE^K|4.2|mmol/l||||F||||20060120153902CR
R|2|^^ÎSE^Na|139|mmol/l||||F||||20060120153902CR
R|3|^^ÎSE^Cl|111|mmol/l||||F||||20060120153902CR
9.4.12 Action code
N
New request: If a request with the same Sample ID already exists, that request will
overwritten. If the sample is in process or ready, and still loaded, a new request is
made and the name, birthdate, etc. must be equal to the sample that is in process.
A
Additional requests: The contents of the order record will be appended to an existing
sample request on the analyser. This means that the set of test requests is extended
with the test requests in the order record. If a request does not exist or was already
started a new request is created.
C
Cancel: will remove the entire sample request from the request buffer. The contents of
field (9.4.5) will be ignored if C is specified.
If an action code is not provided the order will be treated as a New Request.
9.4.16 Specimen Descriptor
This (optional) field contains in full text the sample type. For instance if the sample is urine, this field
contains Urine. The text is compared case sensitive to the sample types defined on the insturment. If
the sample type is not known or not defined, it will default to Normal.
When transmitted by the analyser, this field can contain any of the defined sample types or the fixed
texts BLANK, CALIBRATOR or CONTROL.
Example Order record with sample type:
O|1|12935-C|||R||||||||||Urine|Dr. Carnegy|||||||||FCR
9.1.26 Report Type (transmitted by analyser):
F
Final: Indicates a result is following and that it is the last result for the sample.
I
Intermediate: Indicates a result is following and that the sample still has active
measurements.
X
Used to indicate a request to measure is not accepted by the analyser. The request
may be rejected for the following reasons:
- Sample_ID already exists, but demographic information doesnt match, i.e., Patient
name and birth date are not equal to an existing request.
Page 12 of 30

- No space for request, i.e., the request buffer is full.
No results will be transmitted for the request.
9.1.26 Report Type (received by analyser):
The field will be ignored if action code (field 12) is C.
O, Q, <empty> The requests will replace an existing sample request.
Y, Z
A Host can use these values in response to a host query to indicate that a Sample ID
is not known at the host. Depending on implementation, a message may be shown on
the screen of the analyser. See also Section 5.6, Field 13.1.3.
<others>
The record will be ignored.
Limitations:
The sample ID in the order record is used to identify the sample request on the analyser, cancelling
the order means that the sample request including patient information is deleted from the analyser.
If the analyser is active when the request is received and the sample is already loaded on the
analyser, the requested test is automatically started. This behaviour is intended for reflex tests
transmitted from host.
If a request (identified with a sample ID) has a name, birth date or other demographic information that
conflicts with a request on the analyser, the request will be rejected by the analyser.
Example order record from analyser:
O|1|12934-A||^^^CHOL|R|||||||||||Dr. Carnegy|||||||||FCR
Page 13 of 30
5.4 Result record (R)

For every order record the analyser will report 1 or more result records.
Field
Analyser
(Transmitted to
host)
10.1.1
10.1.2
Record Type ID
Sequence Number
R
number
10.1.3
Universal Test ID
^^âbbr_test^full_test
10.1.4
result
10.1.5
10.1.6
Data or Measurement
Value
Units
Reference Ranges
10.1.7
Result Abnormal Flags
Host
(Received
from host)
Sequential number starting with 1 and

continuing until the last result for the
patient.
Abbreviated test name up to 4 characters
long;
Full test name up to 15 characters long.
See notes below
See notes below
units
cutoff_reference^
low_reference_limit^
high_reference_limit
normalcy_flags^
instrument_flags
This record
is always
ignored
when
received
from host
10.1.8
10.1.9
Nature of Abnormality
Testing
Result Status
10.1.14
Date of Change
Operator Identification
Date/Time Test Started
Date/Time Test
Completed
Instrument Identification
Page 14 of 30
See Appendix B
All components are floating point values.
cutoff_reference contains the relevant
reference value for positive/negative
reporting.
low_reference_limit and
high_reference_limit define the applicable
reference range (male/female/pediatric)
for the sample.
See notes below
normalcy flags:
L : Below low reference limit
LL: Below low panic limit
H : Above high reference limit
HH: Above high panic limit
< : Below absolute limit
> : Above absolute limit
Instrument flags:
See Appendix A for an overview of
possible values
<empty>
F
I
X
10.1.10
10.1.11
10.1.12
10.1.13
Comment
<empty>
<empty>
<empty>
meas_datetime
analyser_section^
reagent_batch_nr^
reagent_expiry_date
F indicates a final result

I indicates a result is pending (Field
10.1.4 will contain BUSY or ------)
X indicates the order cannot be done, it
will be transmitted immediately upon
request to perform tests that are not
known at the analyser, the result will
show UNKNOWN.
YYYYMMDDHHMMSS
analyser _section:
(XL-series only:)
L: Left analyser part
R: Right analyser part
reagent_batch_nr and
reagent_expiry_date contains the batch
number and expiry date of the first
reagent of the test.

10.1.3 Universal Test ID
For ISE results, the field is formatted as follows:
^^ÎSE^K
^^ÎSE^Na
^^ÎSE^Cl
^^ÎSE^CO2
Refer to section 5.3 field 9.4.5 for an example.
10.1.4 Data or Measurement value
The field can contain the following:
Floating point
number
REJECT
BUSY
-----> n.nnnn
< n.nnnn
UNKNOWN
The measured value in human readable format, the decimal separator is a period (.)
The test was rejected (either automatically by the analyser, or manually by the operator)
The test is being measured at the analyser.
The test is waiting for operator input. On screen displayed as *INFO*.
Measurement above assay range. Where n.nnn is a floating point value representing the
highest concentration level defined in the test parameters.
Measurement below analytical sensitivity. Where n.nnnn is a floating point value representing
the lowest concentration level defined in the test parameters.
The test request was unknown at the analyser. Results records reporting UNKNOWN to the
host will not show in the result list of the analyser.
10.1.6 Reference ranges

When a control result is reported to the host, the reference ranges are replaced with control limits as
follows:
Control target^Confrol low limit^Control high limit
For blank and calibrator results, this field will be empty.
10.1.7 Result abnormal flags
The component normalcy_flags will specify < or > if the value is outside a range other than a
reference range. The component instrument_flags will provide more detail of the range that was
exceeded. The following table lists the instrument flags and the normalcy flags that will be set
accordingly:
Instrument flags
n
Reference low error
y
Reference panic low error
N
Reference high error
Y
Reference panic high error
<
Absorbance low limit error
U
Measurement counter underrange
u
Reference counter underrange
v
Measurement below low calibration limit
x
Measurement below analytical sensitivity
>
Absorbance high limit violation
O
Measurement counter overrange
o
Reference counter overrange
V
Measurement above high calibration limit
X
Measurement above assay range
Normalcy flag
L
LL
H
HH
<
>
General
By default the analyser sends the results to the host as soon as they become available. This means
that the analyser will send multiple result messages for a single sample (1 for each test result). It also
means that if there is a tests that requires operator attention (the test has an *INFO*), then this test will
not hold back sending of results. The field Report Type (9.1.26) is used to indicate if the sample has
still has active tests that are being measured, or if it is the last test for the sample.
Alternatively, the option Collate Results may be set in the analyser, in which case the analyser will not
send the test results for a sample, until all tests for that sample are completed. It will then send all
results in a single message.
Page 15 of 30
In case the test measurement is performed with a repeat value > 1 (The test must have been
requested at the analyser console, since the host request does not support specifying a repeat value),
each individual measurement is reported to the host. The host can identify these results as different
measurement by inspecting the value of the measurement date/time field (Field 10.1.13).
Example result record from analyser:
R|1|^^^C300^+Cocaine 300|0.276|dAbs/m|0.301|^||F||||20060120153902|L^Z2820^20060701CR
Page 16 of 30
5.5 Comment record (C)

The format of the comment record depends on the context in which it is received or transmitted.
Comments for Test order record (O)
Following a test order record there can be a comment record containing a specific comment for the
sample.
Field
Analyser
(Transmitted to host)
Host
(Received from
host)
11.1.1
11.1.2
Record Type ID
Sequence Number
C
1
C
<ignored>
11.1.3
11.1.4
11.1.5
Comment Source
Comment Text
Comment Type
I
text
G
<ignored>
Text
<ignored>
Comment

comment on this level.
See below
If the instrument receives a comment record following the test order record, the text from the comment
record will be placed in the sample comment record. If multiple comment records are received, only
the last comment record will be copied into the sample comment record, thereby overwriting any
previously received comments.
The instrument will store only the first 100 characters of the received comment text.
Page 17 of 30
Comments for Result records (R)

If 'extended results' is enabled in communication settings, the instrument will add comment records
following the result record. These comment records contain raw result information for the transmitted
result.
Field
Analyser
Host
(Received from
host)
The comment
record following
the result record
is always
ignored when
received from
host
11.1.1
11.1.2
Record Type ID
Sequence Number
C
1
11.1.3
11.1.4
11.1.5
Comment Source
Comment Text
Comment Type
I
code^text
G
Comment

comment on this level.
See below
C|<sequence number>|I|M01^<abs_result>^<abs_units>|G
<abs_result>
Calculated absorbance value based on raw measurements.
<abs_units>
Relevant absorbance units (Abs, dAbs, dAbs/m)
C|<sequence number>|I|M02^<seconds>^<raw_result>^<used>|G
seconds
Time at which measurement was performed. This is a floating point value.
raw_result
floating point value specifying the raw absorbance measurement by the
analyser
used
0 or 1: 1 indicates the point is used by the analyser to calculate the
concentration; 0 indicates the measurement was not used.
The field Comment Text is repeated for every raw measurement point.
In case a test repeat is set in the test parameters, the raw measurements are sent for each repeat.
With a test repeat of 3, this means that 6 comment records will be appended for each result.
Raw results from the ISE are reported in the format as they are received from the ISE unit. Currently
the ISE units reports only final results. Only an M01 field will be transmitted.
Example:
C|1|I|M01^0.276^dAbs/m|G
C|2|I|M02^24.5^0.2313^0\M02^51^0.2320^0\M02^77.5^0.7123^0\[additional values
skipped for brevity]|G
Page 18 of 30
5.6 Message Terminator Record (L)

Every message must be terminated with a Message Terminator record. Since every frame can only
contain 1 message, this also terminates the frame (See 3.2).
Field
13.1.1
13.1.2
13.1.3
Record Type ID
Sequence Number
Termination Code
Analyser
(Transmitted
to host)
L
1
F
Host
Received
from host
L
<ignored>
Q
I
Comment
Required
yes
yes
Always 1
When Termination Code (13.1.3) received from host is Q or I then this is taken to mean that the host
has no information on the sample ID in the last request. Depending on implementation, a message
may be shown on screen.
Page 19 of 30
5.7 Request information record (Q)

Field
Analyser
(Transmitted
to host)
Q
1
Host
Received
from host
Q
<ignored>
12.1.1
12.1.2
Record Type ID
Sequence Number
12.1.3
Starting Range ID
Number
^sample_ID
^sample_ID
or
ALL
12.1.4
Ending Range ID
Number
Universal Test ID
<empty>
<ignored>
ALL
<ignored>
Nature of Request Time

Limits
Beginning Request
Results Date and Time
Ending Request Results
Date and Time
Requesting Physician
Name
Requesting Physician
Telephone Number
User Field No. 1
User Field No. 2
Request Information
Status Codes
<empty>
<ignored>
<empty>
<ignored>
<empty>
<ignored>
<empty>
<ignored>
<empty>
<ignored>
<empty>
<empty>
O
<ignored>
<ignored>
<ignored>
12.1.5
12.1.6
12.1.7
12.1.8
12.1.9
12.1.10
12.1.11
12.1.12
12.1.13
Comment
Required
yes
yes
yes

request for this message
In case ALL is received by the
analyser; the analyser will
(re)send the last 100 results in
the result buffer.
Only a single sample ID can be
requested in each query record.
By default ALL results for a
sample are transmitted.
Whenever the analyser encounters a new sample ID for which it can not find a request in the request
buffer, it sends a request information record to the host system, requesting to send test orders and
demographics. The analyser will never cancel an outstanding request.
When the analyser receives a request it will always respond by sending all results for the requested
sample ID as they are at that time. These results may be Final (F) or in analyser pending (I).
Page 20 of 30
5.8 Manufacturer Information Record (M)

This record is used for custom information exchange not covered in the CLSI protocol LIS2A. These
include:
- Sending cuvette blank information to the host
- Requesting full version information of all analyser parts
- Downloading error history information from analyser
- Reagent installation information and statistics
These information records are always level 1 records
Field
15.1.1
15.1.2
Record Type ID
Sequence Number
Analyser
Host
(Received from
host)
M
1
M
<ignored>
Comment
Only 1 manufacturer information

record is allowed for each
message.
5.8.1 Cuvette Blank information (B)

The cuvette blank information is sent by the analyser when the operator presses Ctrl+F1 in the Blank
Rotor menu. The blank results of the selected filter (and for XL-series: analyser half) are sent to the
host.
If the host requests blank information by sending an M|1|B, then all blank information, for all cuvettes
and all wavelengths is transmitted to the host.
Field
Analyser
(Transmitted to
host)
Host
(Received
from host)
B
<ignored>
<ignored>
<ignored>
<ignored>
<ignored>
3
4
Manufacturer Record Type ID

Analyser part
5
6
Wavelength
Cuvette blank value
B
<empty>
L
R
<wavelength>
<value>
7
8
9
10
Cuvette average
Cuvette Standard Deviation
Lamp average
Lamp Standard Deviation
<value>
<value>
<value>
<value>
<ignored>
<ignored>
Comment
E / Junior: <empty>
XL-Series: Left or Right analyser
part.
Wavelength in nanometers.
Absorbance value for each
cuvette, the value is repeated 48
times.
Example message with cuvette blank information

H|\^&|||SELXL^2.1.0||||1.0|||P|LIS2-A|20051221153902CR
M|1|B|L|340|0.1029\0.1030\0.1041\0.1032<44 values skipped for brevity>|0.1033
|0.0012|0.0291|0.0009CR
C
L|1|F R
Page 21 of 30
5.8.2 Error History

Note: this record is primarily intended for use by Vital Scientific BV during production and service of
the analyser and is subject to change.
The error history is only transmitted to the host after the host has requested the error history. The host
performs an error history request by sending an M|1|H record.
The following fields are appended to the Manufacturer Information Record:
Field
3
4

Error History record
Action code
Component
error_datetime
error_message
operator_action
Content
YYYYMMDDHHMMSS
text
digit
Analyser
(Transmitted to
host)
Host
(Received
from host)
H
error_datetime^
error_message^
operator_action
<empty>
H
<ignored>
Length
14
5
1
<empty>
C
Comment
Field is repeated for each item in

error history
C: Clear error history
Comment
date and time of error
Error code (e.g., E102)
A code identifying the action of the operator:
0 None
1 Check Again
2 Acknowledge
3 Reset System
4 Specific Reset
5 Remain Inactive
6 Halt
7 Analyser side reset
Example message with error history:

H|\^&|||SELXL^2.1.0||||1.0|||P|LIS2-A|20051221153902CR
M|1|H|20050827151007Ê12^0\20050827151210Ê17^0\20051009101247Ê13^6CR
L|1|F CR
Page 22 of 30
5.8.3 Reagent installation (I)

Reagent Installation information is sent automatically from the analyser to the host whenever the
reagent configuration on the analyser changes. Alternatively the host can request reagent installation
information by sending a M|1|I record.
The following fields are appended to the Manufacturer Information Record:
Field
3
4

Reagent installation information
Analyser
(Transmitted to
host)
Host
(Received
from host)
I
position^
abbr_test^
full_test^
reagent_nr^
reagent_batch^
reagent_expiry^
test_count
I
<ignored>
Component
position
Content
text
Max Length
3
abbr_test
full_test
reagent_nr
reagent_batch
reagent_expiry
test_count
text
text
number
text
YYYYMMDD
number
4
15
1
10
8
Comment
Field is repeated for each

installed reagent
Comment
Text/Number identifying reagent position:
For Junior: 1..30
For E: 1..32
For XL-Series: L1..L32, R1..R32
Abbreviated test name
Full test name
1..3 for reagent 1..3
reagent batch number
Reagent Expiry date
Total test count for installed reagent
The location of reagents used for normal operation of the analyser (e.g., HCL and NEEDLE RINSE)
and shared reagents (e.g., SHARED BUFFER) are not reported to the host.
Reagents are reported ordered by position of the reagents on the rotor.
Example:
The following message indicates 2 tests are installed on the analyser; +Cocaine 150 and LSD.
Reagent 1 for +Cocaine 150 is on position 1; Reagent 3 on position 2. For LSD reagent 1 is located
on rotor position 5 and reagent 3 is located on position 6. +Cocaine 150 has executed a total of 290
tests; while LSD has been used for 165 tests.
H|\^&|||JUNIOR^2.1.0||||1.0|||P|LIS2-A|20060120162301CR
M|1|I|1^+C15^+Cocaine 150^1^^^290\2^+C15^+Cocaine 150^3^^^290\
5^LSD^LSD^1^^^165\6^LSD^LSD^3^^^165CR
C
L|1|F R
Page 23 of 30
5.8.4 Extended version information

Note: this record is primarily intended to be used by Vital Scientific BV during production and service
of the analyser and is subject to change.
The extended version information is only transmitted to the host after the host has performed a request
by sending an M|1|V record.
Extended version information can be used to request version information for all parts used in the
analyser.
Field
3
4

Version information
Component
part
Content
number
version
text
Analyser
(Transmitted to
host)
Host
(Received from
host)
V
part^
version
V
<ignored>
Length
2
Comment
Field is repeated for each

analyser part
Comment
Unique number identifying the analyser part:
1 PC release description
2 PC release version
3 PC application version
4 PC application date
5 CCB version (XL-series only)
6 Sample Disc Version
7 Barcode version (XL-series only)
8 (Left) Master version
9 (Left) Master Date
10 (Left) Pipettor version
11 (Left) Measurement unit version
12 (Left) Sample arm version
13 (Left) Reagent arm version (XL and E-series only)
14 (Left) Reagent discs version (XL and E-series only)
15 (Left) Wash arm version
16 Right master version (XL-series only)
17 Right master date (XL-series only)
18 Right Pipettor version (XL-series only)
19 Right Meas. Unit version (XL-series only)
20 Right Sample arm version (XL-series only)
21 Right Reagent arm version (XL-series only)
22 Right Reagent disc version (XL-series only)
23 Right wash arm version (XL-series only)
Text describing version or date as it was received from the
analyser.
Example response with version information:

H|\^&|||XL400^4.0.0||||1.7|Host||P|LIS2-A|20080103120702 CR
M|1|V|1^XL Analyser 4.0\2^4.0.0\3^4.0.0\4^20071225\5^XL/VTLV1.3.1\
6^DSC P0.03
\7^\8^XL/DRY V1.1.0(DUAL)\9^14-APR-2004 13:49\
10^DIL V1.10
\11^MDS V1.10
\12^SA V1.10
\13^RA V1.20
\
14^DSC V1.10
\15^WA V1.11
\16^XL/DRY V1.1.0(DUAL)\
17^14-APR-2004 13:49\18^DIL V1.10
\19^MDS V1.10
\
20^SA V1.10
\21^RA V1.20
\22^DSC V1.10
\23^WA V1.11 CR
L|1|F CR
Page 24 of 30
Appendix A Flags
When there are irregularities during the measurement of a test, the analyser will flag the result with a single
character describing the nature of the irregularity. There may be multiple flags added to a result. The flags
may appear in random order.
The analyser will transmit these flags to the host in the result record field 10.1.7.2 as described in section
5.4.
Flag
*
#
A
a
B
b
C
D
E
F
G
H
h
I
K
k
L
M
m
N+
NO
o
P
R
r
T
U
u
V
v
W
X
x
Y
y
Z
Error description
Alinearity error
Insufficient sample
Calibrator point absorbance violation
Reagent absorbance limit violation
Barcode not matching (XL-series only)
Barcode not scanned (XL-series only)
Control limit violation
Reagent absorbance deviation error/substrate depletion error
Cut-off result near limit
Test not performed because of disabled analyser part
General hardware error
Calculated result division by zero
Calculated result condition not satisfied
General ISE unit error
Measurement above high calibration limit
Measurement below low calibration limit
Lamp error if combined with O, o, U, u flag; otherwise ISE electrode not calibrated
Absorbance high limit violation
Absorbance low limit error
High reference limit violation
Low reference limit violation
Measurement counter overrange
Reference counter overrange
Prozone error
Insufficient reagent
Rerun
Cuvette temperature error
Measurement counter underrange
Reference counter underrange
Cutoff positive
Cutoff negative
Westgard violation
Measurement above assay range
Measurement below analytical sensitivity
Reference panic high error
Reference panic low error
Dup-diff error
Page 25 of 30
Appendix B Units
The next table shows all the possible units.
<empty>
kU/l
U/l
U/ml
U/ml
kat/l
mol/l
mmol/l
mol/l
nmol/l
fmol/g
mEq/l
g/l
mg/l
g/l
ng/l
g/dl
mg/dl
g/dl
ng/dl
mg/ml
g/ml
ng/ml
IU/l
IU/ml
mIU/l
mIU/ml
IU/ml
%
% norm
m/24hr
g/24hr
mg/24h
g/24h
sec
units
Abs
ratio
dAbs
dAbs/m
Table 1: Available units in analyser

Character codes used for the special characters (Per mille sign; Latin-1 137) and (micro sign; Latin-1
181) depend on the codepage that is currently active in the PC application on the analyser. The transmitted
code may differ based on the language that is used for the user interface.
Page 26 of 30
Appendix C ASCII CODE Chart

000
001
002
003
004
005
006
007
008
009
010
011
012
013
014
015
NUL
SOH
STX
ETX
EOT
ENQ
ACK
BEL
BS
HT
LF
VT
FF
CR
SO
SI
016
017
018
019
020
021
022
023
024
025
026
027
028
029
030
031
DLE
DC1
DC2
DC3
DC4
NAK
SYN
ETB
CAN
EM
SUB
ESC
FS
GS
RS
US
032
033
034
035
036
037
038
039
040
041
042
043
044
045
046
047
SP
!
#
$
%
&
(
)
*
+
,
.
/
048
049
050
051
052
053
054
055
056
057
058
059
060
061
062
063
0
1
2
3
4
5
6
7
8
9
:
;
<
=
>
?
064
065
066
067
068
069
070
071
072
073
074
075
076
077
078
079
@
A
B
C
D
E
F
G
H
I
J
K
L
M
N
O
080
081
082
083
084
085
086
087
088
089
090
091
092
093
094
095
P
Q
R
S
T
U
V
W
X
Y
Z
[
\
]
^
_
096
097
098
099
100
101
102
103
104
105
106
107
108
109
110
111
`
a
b
c
d
e
f
g
h
i
j
k
l
m
n
o
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
Table 2: 7-bit ASCII code chart
Page 27 of 30
p
q
r
s
t
u
v
w
x
y
z
{
|
}
~
DEL
Appendix D Examples
The following shows the flow of control of a message from a sender to a received. In this case the sender is
the analyser performing a query request at the host (See example 4)
E
Sender:
NQ
Receiver: ACK
S
C
Sender:
TX1H|\^&|||SELE||||1.0|||P|LIS2-A|20060126163201 RQ|1|^12936C
C E
C L
A||ALL||||||||O RL|1|F R TX23 R F
Receiver: ACK
E
Sender:
OT
For readability the encapsulation of messages has been removed from the following examples.
D.1 Analyser messages

Example 1.1 Standard result from analyser
The following example shows results send by the analyser based on the host request from example 2.1.
When the first result is ready (GLUC), the analyser sends the following message to the host:
H|\^&|||SELE||||1.0|||P|LIS2-A|20060126162409CR
P|1||||Lindsey Blake||19650917|FCR
O|1|12934-A|||R|||||||||||Dr. Carnegy|||||||||ICR
R|1|^^^GLUC^Glucose|8.1|mmol/l|^4.0^6.9|H^N||F||||20060126162405CR
L|1|FCR
For the second result (+C15), the analyser sends the following message to the host:
H|\^&|||SELE||||1.0|||P|LIS2-A|20060126162503CR
O|1|12934-A|||R|||||||||||Dr. Carnegy|||||||||FCR
R|1|^^^+C15^+Cocaine 150|0.321|dAbs/m|0.231|^+||F||||20060126162459
|^3T797^20070601CR
C
L|1|F R
Example 1.2 Result from analyser as answer to host query
The same information as above can also be transmitted based on a query from the host or by pressing
Ctrl+F1 in while the sample is selected on screen. All the results for a sample are then contained in a single
message.
H|\^&|||SELJR||||1.0|||P|LIS2-A|20060126162409CR
O|1|12934-A|||R|||||||||||Dr. Carnegy|||||||||FCR
R|1|^^^GLUC^Glucose|8.1|mmol/l|^4.0^6.9|H^N||F||||20060126162405CR
R|2|^^^+C15^+Cocaine 150|0.321|dAbs/m|0.231|^+||F||||20060126162459CR
|^3T797^20070601CR
C
L|1|F R
Example 1.3 Analyser query
This example shows a message that is sent by the analyser to query the host for information for a sample ID
12936-A.
H|\^&|||SELXL||||1.0|||P|LIS2-A|20060126163201CR
Q|1|^12936-A||ALL||||||||OCR
L|1|FCR
Page 28 of 30
Example 1.4 Analyser result message for calibration of Valproic Acid assay
H|\^&|||SELE||||1.0|||P|LIS2-A|20060127081927CR
P|1|||||||CR
O|1||VPA Calibrator||R||||||||||||||||||||FCR
R|1|^^^VPA^Valproic Acid|0.2258|dAbs/m||||F||||20060127081456CR
L|1|FCR
Example 1.5 Analyser result message for ISE measurements
H|\^&|||SELE||||1.0|||P|LIS2-A|20060120153907CR
P|1||||Jonathan Kardon||19650917|MCR
O|1|12939-C|||R||||||||||||||||||||FCR
R|1|^^ÎSE^K|4.2|mmol/l||||F||||20060120153902CR
R|2|^^ÎSE^Na|139|mmol/l||||F||||20060120153902CR
R|3|^^ÎSE^Cl|111|mmol/l||||F||||20060120153902CR
L|1|FCR
D.2 Host messages

The following examples are provided to show how a host may communicate with the analyser. Fields that will
be ignored by the analyser are mostly left empty in these examples, but these may contain actual data when
sent from the host.
Example 2.1 Standard host request
The host requests a series of tests to be performed on a number of samples.
H|\^&|||LABLIS|||||||P|LIS2-A|20060126155702CR
O|1|12934-A||^^^GLUC\^^^+C15|R|||||||||||Dr. Carnegy|||||||||OCR
L|1CR
Example 2.2 Minimal host request
This example presents a minimal host request for two tests (CREA & CHOL) to be performed on a sample
with ID 123
H|\^&CR
P|1CR
O|1|123||^^^CREA\^^^CHOLCR
L|1CR
Page 29 of 30
Example 2.3 Complex host request

The following shows a complex request from the host. Various methods are used to specify the tests to be
performed:
H|\^&|||LABLIS|||||||P|LIS2-A|20060126155702CR
P|1||||First SampleCR
O|1|12940||^^^GLUC\^^^CHOL|RCR
P|2||||Stat SampleCR
O|1|12941||^^^GLUC|SCR
O|2|12941||^^^CHOL|RCR
P|3||||ASAP SampleCR
O|1|12942||^^^GLUC|ACR
L|1|FCR
Note: The second sample request (Sample ID 12941), contains two order records: One test to be performed
immediately (STAT), and one test to be performed as routine (normal). Since the priority in the analyser is
set at sample level, the priority in the second test request will overwrite the priority in the first test request. All
tests will be executed at normal priority, not STAT.
Example 2.4 Host response on analyser query
Upon an analyser query the host may respond in several ways. This example shows a complete response
with some fields that will be ignored by the analyser, but the host may also respond with requests as shown
in examples 1 and 3.
H|\^&|28319|PWD|HostSystem|||319 555-456||SELE||P|LIS2-A|20060126170103CR
P|1|12936|12936||John Dibbly||19710702|M||||MNYCR
O|1|12936-A||^^^CREA|R|20060126150557|||||N|||||Dr. Carnegy|||||||||QCR
L|1|FCR
Example 2.4 Host response on analyser query if sample ID is unknown
If the sample ID is not known at the host, the host may respond with the following message:
H|\^&CR
L|1|ICR
Or a more extensive reply:
H|\^&|28320||HostSystem|||||||||20060126170103CR
P|1CR
O|1|12936-A|||||||||||||||||||||||ZCR
L|1|FCR
A response from a host is not required, the query will time-out on the analyser after a few seconds.
Example 2.5 Sample request cancelled by host
Complete request is deleted:
H|\^&CR
P|1CR
O|1|12934-A|||||||||CCR
L|1|FCR
Example 2.6 Host queries results from analyser:
H|\^&CR
Q|1|^12940-ACR
L|1CR
**** End of Document ***
Page 30 of 30

Vitalab LIS2-A Host

Uploaded by

Copyright:

Available Formats

Vitalab LIS2-A Host

Uploaded by

Document Information

Original Description:

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

Vitalab LIS2-A Host

Uploaded by

Copyright:

Available Formats

What are the different types of records that can be sent from the analyzer to the host?

What are the different types of records that can be sent from the analyzer to the host?

What information is contained in the Patient Information Record (P)?

What information is contained in the Patient Information Record (P)?

LIS2-A HOST-PC COMMUNICATION 3084-103-02

LIS2-A Host-PC communication

VITAL SCIENTIFIC B.V.

3084-103-02 LIS2-A HOST-PC COMMUNICATION

Serial port interface ....................................................................................................................... 4

Data handling ......................................................................................... 5

Messages to host ................................................................................... 8

Header (H) .................................................................................................................................... 8

Appendix A Flags ........................................................................................ 25

VITAL SCIENTIFIC B.V.

LIS2-A HOST-PC COMMUNICATION 3084-103-02

1.3 Definitions, acronyms and abbreviations

VITAL SCIENTIFIC B.V.

3084-103-02 LIS2-A HOST-PC COMMUNICATION

2.1 Serial port interface

data from analyser-PC to host

2.2 Network interface

VITAL SCIENTIFIC B.V.

LIS2-A HOST-PC COMMUNICATION 3084-103-02

3.2 Frame format

For end frame:

Start of Text transmission control character (ASCII 2)

VITAL SCIENTIFIC B.V.

3084-103-02 LIS2-A HOST-PC COMMUNICATION

4.2 Record format

imbedded Field delimiter character

VITAL SCIENTIFIC B.V.

LIS2-A HOST-PC COMMUNICATION 3084-103-02

VITAL SCIENTIFIC B.V.

3084-103-02 LIS2-A HOST-PC COMMUNICATION

5.1 Header (H)

Sender Street Address

Version number of host protocol.

host_id: text identifying the host

Other field delimiters are not

device_id: text defined in

VITAL SCIENTIFIC B.V.

LIS2-A HOST-PC COMMUNICATION 3084-103-02

VITAL SCIENTIFIC B.V.

3084-103-02 LIS2-A HOST-PC COMMUNICATION

5.2 Patient information record (P)

Sequential number starting with

8.1.9 Patient Sex

VITAL SCIENTIFIC B.V.

LIS2-A HOST-PC COMMUNICATION 3084-103-02

5.3 Test order record (O)

See notes below

Max 20 characters. In case this

VITAL SCIENTIFIC B.V.

Sequential number starting with

Empty and other will be treated

3084-103-02 LIS2-A HOST-PC COMMUNICATION

Laboratory Field No. 2

see notes below

9.4.4 Instrument Specimen ID