Appendix E:
OsmoPRO MAX LIS Specification
88
OsmoPRO MAX Automated Osmometer User Guide
•
If a timeout occurs, the termination phase begins for
the instrument, and the entire message is re-queued
for transmission.
•
If a reply of
<ACK>
is received, the transmission was
successful and a new frame can be sent.
•
If a reply of
<NAK>
is received, there was an error
during transmission or in the checksum calculation.
The frame should be retransmitted within six retries. If
the limit of six is reached, the message should be
re-queued for transmission.
•
If a reply of
<EOT>
(ASCII decimal 4) is received, the
receiver requests termination of the transmission. In
the instrument, this causes the transmission to end
and the message is re-queued as above.
Termination phase:
The sender transmits an
<EOT>
character to indicate all frames have been sent. Both the
sender and the receiver consider the link to be in the
neutral state after the exchange of the
<EOT>
character.
Message Layer
The message layer describes content of messages based
on the LIS2-A2 standard. Any restrictions and
exemptions will be noted when applicable.
Message Content
The following limitations and specifications apply to the
message content:
•
Allowed characters are in single byte, eight bit values
(Latin-1 character set) in the decimal ranges of
32 to 126 and 128 to 254, plus decimal values 7, 9, 11,
12, and 13. Some fields may be UTF8-encoded as
indicated.
•
The maximum field length within a record is noted in
the detailed specification.
•
The instrument as a sender always uses the following
suggested delimiters:
–
ӏ
as
field delimiter
–
\
as
repeat delimiter
–
^
as component delimiter
–
&
as
escape character
•
The instrument as a receiver handles any other valid
set of delimiters (see LIS2-A2 section 5.4).
•
The instrument does not transmit
null
values to
indicate that the value has not changed since the last
transmission, and does not use received
null
values.
•
Any received fields not required by the instrument are
ignored and are not covered in this guide.
•
The following record types are not sent by the
instrument and are ignored if received:
–
Comment
(C)
–
Scientific
(S)
–
Information
(M)
•
All date/time fields are specified as
YYYYMMDDHHMMSS
where
HH
is a 24-hour time.
•
Universal test ID fields indicate the test type or the
quality control type.
Record Field Contents
In the examples below, the overhead characters of
<STX>
and frame number at the front and checksum
plus
<CR><LF>
at the end are not shown.
Optional fields and UTF8-encoded fields are indicated.
Header Record
The fields used in this record are as specified in LIS2-A2:
6.1
Record type ID—
H
identifies the record as a
message header record.
6.2
Delimiter definition—The five Latin-1 characters
immediately following the
H
record type ID define the
delimiters used throughout the subsequent records of
the message.
–
The second character in the header record is the
field delimiter
.
–
The third character is the
repeat delimiter
.
–
The fourth character is the
component delimiter
.
–
The fifth character is the
escape character
.
6.5
Sender ID—This text field defines the sender. In
OsmoPRO MAX osmometers, this is defined by the
instrument type and the software version.
6.10
Receiver—Text field containing the name of the
receiver. This field is used to verify that the
transmission is for the receiver. In the instrument, this
text is the word
LIS
.
6.12
Processing ID—Message processing where
P
= Patient (sample test data) and
Q
= quality control.
Example
H|\^&|||OsmoPRO_MAX^V1.0|||||LIS||P|LIS2-
A2|20161110082005<CR><ETX>
