You are on page 1of 12

LIS Interface Description

A
A.1 LIS INTERFACE OVERVIEW ........................................................................ A-1
A.1.1 REAL TIME MODE................................................................................... A-1
A.1.1.1 Automatic Query Disabled ..................................................... A-1
A.1.1.2 Automatic Query Enabled ...................................................... A-1
A.2 BI-DIRECTIONAL INTERFACE DESCRIPTION ........................................... A-2
A.2.1 DATA RECORDS ..................................................................................... A-2
A.2.2 HEADER (“H”) RECORD.......................................................................... A-2
A.2.3 IDENTIFICATION (“I”) RECORD.............................................................. A-3
A.2.4 RESULT/ TEST ORDER REQUEST (“D”) RECORD ............................... A-3
A.2.5 ID-QUERY (“Q”) RECORD....................................................................... A-4
A.2.6 RESULT (“R”) RECORD .......................................................................... A-4
A.3 DATA TRANSFER COMMUNICATIONS PROTOCOL ................................. A-5
A.3.1 ACK/NAK PROTOCOL............................................................................. A-5
A.3.2 TRANSMISSION CONTROLS ................................................................. A-5
A.3.3 DESTINY PLUS SPECIFIC CONTROLS ................................................. A-5
A.3.4 DATA TRANSMISSION............................................................................ A-5
A.3.5 END OF TRANSMISSION........................................................................ A-6
A.3.6 QUERY..................................................................................................... A-6
A.3.7 DATA LINK ESCAPE ............................................................................... A-6
A.3.8 CHECKSUM ............................................................................................. A-6
A.3.9 TERMINATION CHARACTER SEQUENCE ............................................ A-6
A.4 LIS SETUP/PROTOCOL OPTIONS............................................................... A-6
A.4.1 TIMEOUT ................................................................................................. A-6
A.4.2 RESEND................................................................................................... A-6
A.4.3 AUTOMATIC QUERY............................................................................... A-7
A.5 REPEAT AFTER <NAK> ............................................................................... A-7
A.6 EXAMPLES.................................................................................................... A-7
A.6.1 AUTOMATIC QUERY AND DOWNLOAD OF TEST REQUESTS FROM
LIS ............................................................................................................ A-7
A.6.2 UPLOAD OF RESULTS FROM AMAX TO LIS (REAL-TIME MODE)...... A-7
A.6.3 ID QUERY (REAL TIME).......................................................................... A-8
A.7 TIPS ............................................................................................................... A-8
A.8 ASCII CODE CHART ..................................................................................... A-9

O.M.V.3.1.1 A-0
11/05/09
LIS Interface Description
A
A.1 LIS Interface Overview
The Destiny Plus software provides for communications with a Laboratory Information System
(LIS) using the serial port COM6 on the instrument. The protocol used to transfer data between
the instrument and the LIS is compatible with the protocols used by the other AMAX
instruments, AMAX 190/200 and AMAX 400. The Destiny Plus provides for emulating an AMAX
200 or an AMAX 400. Selecting “CS 100” for the protocol is equivalent to selecting the AMAX
400 protocol at this time.
While the protocols emulate the other AMAX instruments, the Destiny Plus does not match all of
the communications modes of these other instruments. The Destiny Plus operates continuously
in a real-time mode whenever the LIS communications is enabled. At this time, it does not have
the “batch” mode of operation found on the other instruments.
The following descriptions are based on the instrument identifying a new sample. A sample is
identified once the instrument knows its Identification Code. This may occur by the automatic
reading of a bar code on the sample by the bar code reader incorporated into the instrument or
by manual entry of the ID by the instrument operator. An “Unknown” sample ID will not initiate
the process to determine the test requisition data through the LIS. Unless the “Default Test
Orders” function has been enabled, the operator must manually assign the tests to be run if the
ID remains “Unknown”.

A.1.1 Real Time Mode


The instrument is continuously looking for new samples being presented. Once a new sample
has been identified, the system will then attempt to identify the tests to be run on the sample. It
will do so by searching its internal database and communications buffer. If it identifies the
sample and tests requisitions within these areas, it makes the test assignments and resumes
looking for additional samples.
While the instrument is always prepared to communicate with the LIS, there are two distinct
communication methods that may be invoked. They are (1) “Automatic Query Disabled” and (2)
“Automatic Query Enabled”. These determine how the test requested data gets to the
instrument.
A.1.1.1 Automatic Query Disabled
In this method, the instrument will automatically request data on a new sample whenever the
instrument recognizes the sample through the sample ID and the instrument has determined
that it lacks data to determine the tests to be run on that particular sample. The instrument will
initiate a real-time query to the LIS requesting the test requisitions. This will happen any time the
instrument lacks the requisition data and LIS communications have been enabled, regardless if
Automatic Query has been selected.
The LIS will not be queried if the ID entered is already present in the “Worklist Archive”, the
sample’s data will be recalled from the archive. As “Automatic Query” is not enabled, the test
requisition data will not be in the communication buffer.
A “slow” responding LIS can have an adverse effect on the instrument throughput in this mode.
Enabling “Automatic Query” can reduce delays by having the data present in the instrument.
A.1.1.2 Automatic Query Enabled
If the “Automatic Query” is set to any value other than zero, the instrument will automatically
request of the LIS any pending sample/test requisitions at this interval. This information will be
stored by the instrument until needed. During the periodic query, data for any number of
samples may be transferred from the LIS in a group. This allows for the quicker identification of
test requisitions upon identifying a new sample as the data can be present in the instrument
already.

O.M.V.3.1.1 A-1
11/05/09
A LIS Interface Description
A.2 Bi-Directional Interface Description
All communications between the Destiny Plus and the LIS are composed of a series of records.
Six records are described. They are:
Header (“H”) Record – Sent once as the first record of each transmission session except when
a “Q” (Query) or “R” (Real-Time Result) is sent. It is used to identify the subsequent set of data.
If the LIS fails to send the Header, a “Missing Header” error is raised.
Identification (“I”) Record – Sent once for a particular sample preceding each series of “D”
records necessary to send all of the test orders or test results for that specific sample. A group
of Identification records may be associated with one Header record.
Result/Test Request (“D”) Record – Used to send test orders to the Destiny Plus. As the
Destiny Plus only uses the real-time transmission protocol, it is not used by the Destiny Plus to
send results to the LIS. As many “D” records as necessary may be used to transfer test requests
to the Destiny Plus. A typical transmission may look like:
H I D D I D D D I D I D D D D D I D - (Record types only shown)
The instrument, if it used a batch protocol, would use the “D” record to return results. Not using
the batch protocol, the Destiny Plus does not transmit the “D” record type.
ID-Query (“Q”) Record – The “Q” record is used for real-time, single sample query to the LIS
for test request information on that sample. The LIS would reply in the standard H I D D D
format.
Result (“R”) Record – The Destiny Plus uses the “R” record, in real-time, to transmit all results
to the LIS.
Start (“S”) Record – Specifically defined for the AMAX 400. Not defined for the Destiny Plus.
Not used within Destiny Plus communications.

A.2.1 Data Records


All data records are of the type Space Defined (SDF). Fields are space filled to complete the
proper character definitions for each field.
A “TEXT” field is any printable ASCII character including Hex 20 (Dec 32) = space through Hex
7E (Dec 126) = ~.
A “FLOAT” field contains the numbers 0 through 9 and the decimal point, “.”. The position of the
decimal point may be in any of the character positions. It must be in one of the positions.

A.2.2 Header (“H”) Record


Transmissions: LIS Destiny

Destiny NOT USED LIS


(Length 16 characters)
FIELD Data type Justified Number Char. Note
RECTYPE TEXT Left 1 “H”
Instrument ID:
Destiny Plus= “CS100”
WSID TEXT Left 5
This is set in the Protocol
Options screen for the LIS.
LDATE TEXT Left 10 Date of load list
Sent once at the beginning of each transmission session.
The record has a fixed length of 16 characters.

A-2 O.M.V.3.1.1
11/05/09
LIS Interface Description
A
A.2.3 Identification (“I”) Record
Transmissions: LIS Destiny

Destiny NOT USED LIS


(Length 121 characters)
FIELD Data type Justified Number Char. Note
RECTYPE TEXT Left 1 “I”
ID TEXT Left 20 ID-Code
NAME TEXT Left 40 Patient name, first and last
DEPT TEXT Left 20 Location (Ward)
NOTE TEXT Left 40 Patient Comment/Note
Sent once at the beginning of a group of “D” records to identify the sample.
The record has a fixed length of 121 characters.

A.2.4 Result/ Test Order Request (“D”) Record


Transmissions: LIS Destiny

Destiny NOT USED LIS


(Length 29 or 65 characters)
AMAX 400 Emulation:
FIELD Data type Justified Number Char. Note
RECTYPE TEXT Left 1 “D”
ID TEXT Left 20 Sample ID
REQ TEXT Left 8 Test Code
RESULT1 FLOAT Right 5 Result 1
RESULT2 FLOAT Right 5 Result 2
RESULT3 FLOAT Right 5 Result 3
MEASUN1 TEXT Left 5 Measuring unit 1
MEASUN2 TEXT Left 5 Measuring unit 2
MEASUN3 TEXT Left 5 Measuring unit 3
EMPTY TEXT Left 5 Blank (Not Used)
ECODE TEXT Left 1 Error code
AMAX 200 Emulation:
FIELD Data type Justified Number Char. Note
RECTYPE TEXT Left 1 “D”
ID TEXT Left 20 Sample ID
REQ TEXT Left 8 Test Code
RESULT1 FLOAT Right 5 Result 1
RESULT2 FLOAT Right 5 Result 2
RESULT3 FLOAT Right 5 Result 3
EMPTY TEXT Left 20 Blank (Not Used)
ECODE TEXT Left 1 Error code

Associated with an “I” record.

O.M.V.3.1.1 A-3
11/05/09
A LIS Interface Description
There may be multiple “D” records for each “I” record. One for each test requested on a
sample.
Transmissions from the LIS may truncate the “D” record to 29 characters (RECTYPE,
ID, REQ). Grayed positions above need not be sent.
Not used by Destiny Plus for transmission of results as Destiny Plus uses real-time
results reporting.
“REQ” (Test Code) is an 8-character field that is set in the Test Definition – Title screen
under “Host”. There are two user definable fields; Order Code and Result Code. The
LIS must use the Order Code to schedule the test on the instrument. The Destiny Plus
returns the results under the Result Code. The two names may be the same.

A.2.5 ID-Query (“Q”) Record


Transmissions: Destiny LIS
(Length 26 characters):
FIELD Data type Justified Number Char. Note
RECTYPE TEXT Left 1 “Q”
Instrument ID:
WSID TEXT Left 5
Destiny Plus= “CS100”
ID TEXT Left 20 Text “Sample-ID”

Sent by Destiny Plus to LIS to query for test requests for specific sample when the
requests are not present in the instrument.
The record has a fixed length of 26 characters.
The Destiny Plus expects a standard H I D D D format reply.

A.2.6 Result (“R”) Record


Transmissions: Destiny LIS
(Length 70 characters):
Field type Justified Number Char. Note
RECTYPE TEXT Left 1 “R”
Instrument ID:
WSID TEXT Left 5
Destiny Plus= “CS100”
ID TEXT Left 20 Sample ID
REQ TEXT Left 8 Test Code
RESULT1 FLOAT Right 5 Result 1
RESULT2 FLOAT Right 5 Result 2
RESULT3 FLOAT Right 5 Result 3
MEASUN1 TEXT Left 5 Measuring unit 1
MEASUN2 TEXT Left 5 Measuring unit 2
MEASUN3 TEXT Left 5 Measuring unit 3
RESALPHA TEXT Left 5 Blank (Not Used)
ECODE TEXT Left 1 Error Code

Sent in real-time by the Destiny Plus to transmit results to LIS.


The record has a fixed length of 70 characters.

A-4 O.M.V.3.1.1
11/05/09
LIS Interface Description
A
A.3 Data Transfer Communications Protocol
The following communications protocol is used for transmission in both directions. The Destiny
Plus operates in the real-time mode and is therefore in charge of the communications between it
and the LIS.

A.3.1 ACK/NAK Protocol


The basic communications utilizes an <ACK>/<NAK> protocol. Transmissions in either direction
- either acknowledged (<ACK>) or not acknowledged (<NAK>). The <ACK> means that the
transmission was received and understood. The <NAK> signifies that the transmission had
some error condition such as not being completely received or not understood. The protocol
allows for retries on transmissions that were <NAK>'d. Up to two retries may be made before the
transmission is aborted.

A.3.2 Transmission Controls


In addition to <ACK> and <NAK>, the protocol also makes use of a number of other ASCII
control functions. These are:
<STX> ASCII code 02h Start of Text
<ETX> ASCII code 03h End of Text
<EOT> ASCII code 04h End of Transmission
<ENQ> ASCII code 05h Enquiry
<DLE> ASCII code 10h Data Link Escape
These, along with the data records defined in Section A2, control the transfer of data between
the instrument and the LIS.

A.3.3 Destiny Plus Specific Controls


Two additional transmission controls are specifically defined for the Destiny Plus. They are:
<CHKS> Checksum (2 ASCII characters). The checksum is calculated summing the
ASCII codes of all characters between<STX> and <ETX>. The modulo 256
of the sum is converted to its hexadecimal form and transmitted as ASCII
characters. If the checksum is longer than one byte, only the lower byte is
used for the checksum.
<TC> Termination Character sequence. This consists of a free programmable
command sequence indicating termination of transmission. It may be up to
two user-definable character strings. This causes the receiving unit to begin
processing the transmission. The LIS is expected to use the same
termination characters.
These and the other controls above will combine to form a robust communications protocol.

A.3.4 Data Transmission


Data transmission, using one of the previously defined records (H, I, D, Q or R), always takes
the same format. This is:
<STX> [Data Record………]<ETX> <CHKS><TC>
The same sequence exists for transmissions in either direction for the transfer of any of the data
records.
There may only be two replies to a transmission of this sort:
<ACK> <TC> or <NAK><TC>
The acknowledge <ACK> reply will cause the transmitting unit to continue to its next sequence.
An not acknowledged <NAK> reply will cause a retransmission if two retries have not already
been attempted.

O.M.V.3.1.1 A-5
11/05/09
A LIS Interface Description
A.3.5 End of Transmission
The end of transmission <EOT> is issued at the end of a series of transfers to signify that all of
the data has been transferred. It takes the form:
<EOT><TC>
The <EOT> should not be acknowledged, <ACK>.

A.3.6 Query
The enquiry <ENQ> is issued to start the transfer of data from the LIS to the Destiny Plus. It is
always used to request data from the LIS. Its use can be triggered by the “Automatic Query” at
periodic intervals or by a real-time ID Query when an unknown sample is presented to the
instrument.
The <ENQ> should not be acknowledged, <ACK>. A data record or <EOT> is expected as a
reply.

A.3.7 Data Link Escape


The data link escape <DLE> is issued at the start of a communication process for uploading
results or to do a real-time query of the LIS.

A.3.8 Checksum
The checksum <CHKS> is two ASCII characters representing the hex value from H00 to HFF.
The checksum is calculated summing the ASCII codes of all characters between<STX> and
<ETX>. The modulo256 of the sum is converted to its hexadecimal form and the ASCII
representation of the hex number is sent. If the checksum is longer than one byte, only the lower
byte is used for the checksum.

A.3.9 Termination Character Sequence


The termination character sequence, <TC>, consists of a free programmable command
sequence indicating termination of transmission. It may be up to two user-definable character
strings. It causes the receiving unit to begin processing the transmission. The LIS is expected to
use the same termination characters.

A.4 LIS Setup/Protocol Options


The following Protocol Options control the manner in which the LIS interface behaves.

A.4.1 Timeout
Each data transfer must be acknowledged within “Timeout” seconds (1 to 20 seconds). Failing to
do so will cause the transmission to be aborted. If the “Resend” parameter is set, the Destiny
Plus will retry the transmission at the end of the Resend period. If the Resend = 0, the
instrument will not retry the transmission.

A.4.2 Resend
The “Resend” parameter establishes the delay in seconds before the instrument will retry
sending results to the LIS. A retry occurs if the Destiny Plus receives a <NAK> or if a “Timeout”
occurs. When either of these occurs, the “Resend Delay” will start. At the end of the delay, the
transmission will be resent. If the “Resend” is set to zero, there will be no retry and the
transmission will be discarded.

CAUTION!
If the “Resend” value is other than zero, the instrument will never stop
attempting to communicate with the LIS. The “Resend” value should be set
such that the LIS has sufficient time to reply.

A-6 O.M.V.3.1.1
11/05/09
LIS Interface Description
A
A.4.3 Automatic Query
The “Automatic Query” is the parameter establishing the period in seconds between the periodic
automatic sample queries from the instrument to the LIS. This query is of the form <ENQ> and
not of the form of the ID-Query Record of Section A2.5. The “Automatic Query” allows a method
for the LIS to send test requisitions to the instrument prior to the sample being presented to the
instrument. If the parameter is set to zero, the “Automatic Query” is inhibited.

A.5 Repeat after <NAK>


Data strings refused with a <NAK> will be resent up to two (2) times after a delay that is
established by the “Resend” parameter. After sending the record for the third time, original and
two retries, the transmission will be aborted.

A.6 Examples
A.6.1 Automatic Query and Download of Test Requests from LIS
Sender Transmission Description
AMAX: <ENQ> <TC> Automatic query
LIS: <STX> [H………] <ETX> <CHKS> <TC> Header record
AMAX: <ACK> <TC>
AMAX: <ENQ> <TC> Query
LIS: <STX> [I………] <ETX> <CHKS> <TC> Identification record
AMAX: <ACK> <TC>
AMAX: <ENQ> <TC> Query
LIS: <STX> [D………] <ETX> <CHKS> <TC> Test request
AMAX: <ACK> <TC>
AMAX: <ENQ> <TC> Query
LIS: <STX> [D………] <ETX> <CHKS> <TC> Test request
AMAX: <ACK> <TC>
AMAX: <ENQ> <TC> Query
LIS: <STX> [I………] <ETX> <CHKS> <TC> Identification record
AMAX: <ACK> <TC>
AMAX: <ENQ> <TC> Query.
LIS: <STX> [D………] <ETX> <CHKS> <TC> Test request
AMAX: <ACK> <TC>
AMAX: <ENQ> <TC> Query
LIS: <STX> [D………] <ETX> <CHKS> <TC> Test request
AMAX: <ACK> <TC>
AMAX: <ENQ> <TC> Query
LIS: <EOT> <TC> End of Transmission
The Destiny will perform an “Automatic Query” at a period determined by the value set in
the “Automatic Query” option (0 to 300 seconds). A value of 0, will disable the “Automatic
Query” mode.

A.6.2 Upload of Results from AMAX to LIS (Real-Time Mode)


Sender Transmission Description
AMAX: <DLE> <TC>
LIS: <ACK> <TC> Acknowledge
AMAX: <STX> [R………] <ETX> <CHKS> <TC> Results
LIS: <ACK> <TC>
AMAX: <STX> [R………] <ETX> <CHKS> <TC> Results
LIS: <ACK> <TC>
AMAX: <EOT> <TC> End of Transmission

O.M.V.3.1.1 A-7
11/05/09
A LIS Interface Description
If the Destiny Plus does not receive an acknowledgement from the LIS within “Resend”
seconds (0 to 60 seconds), it will resend the data. If “Resend” is set to 0, it will discard the
data.

A.6.3 ID Query (Real Time)


The “Automatic Query” is used to fill the internal buffer within the Destiny Plus. If the Destiny
Plus recognizes a new sample ID, bar-code or manual entry, it will look in its internal buffer to
determine the test requisition for the sample. If the ID is not present in the buffer, it will start a
real-time ID Query to obtain the data.
If the Protocol Option – “Automatic Query” is set to 0, there will never be an automatic query; the
buffer will always be empty and the Destiny Plus must always do a real-time ID Query.
Sender Transmission Description
AMAX: <DLE> <TC>
LIS: <ACK> <TC>
AMAX: <STX> [Q………] <ETX> <CHKS> <TC> Query record
LIS: <ACK> <TC>
AMAX: <EOT> <TC> End of
Transmission

LIS answers with patient data:


Sender Transmission Description
AMAX: <ENQ> <TC> Query
LIS: <STX> [H………] <ETX> <CHKS> <TC> Header record
AMAX: <ACK> <TC>
AMAX: <ENQ> <TC> Query
LIS: <STX> [I………] <ETX> <CHKS> <TC> Identification
record
AMAX: <ACK> <TC>
AMAX: <ENQ> <TC> Query
LIS: <STX> [D………] <ETX> <CHKS> <TC> Test request
AMAX: <ACK> <TC>
AMAX: <ENQ> <TC> Query
LIS: <STX> [D………] <ETX> <CHKS> <TC> Test request
AMAX: <ACK> <TC>
AMAX: <ENQ> <TC> Query
LIS: <EOT> <TC> End of
Transmission

A.7 TIPS
The following are suggested tips that may be helpful in understanding the LIS interface of the
Destiny Plus:
The LIS is polled by the Destiny Plus; the LIS may therefore only transmit within its own
time frame after it has received an <ENQ><TC>.
The “H” record is meant to identify the subsequent set of data. It, therefore, includes the
WSID and the current date.
If the LIS fails to send an “H” record as the first record, the “Missing Header” error will be
raised.
The “I” record is the only valid record that may be sent after an “H” record.
“D” records must always refer to preceding “I” records.
When using “D” records to send test orders, they may be truncated after the “REQ” field.

A-8 O.M.V.3.1.1
11/05/09
LIS Interface Description
A
As Destiny Plus uses the real-time mode only, it currently does not use “H”, “I”, or “D”
records when sending.
When the LIS or Destiny Plus has no additional data to send, it should send an
<EOT><TC>.
The LIS may transmit test orders in advance whenever it receives an <ENQ><TC>.
Records are sent to the LIS in a <DLE> . . . <EOT> frame.

A.8 ASCII Code Chart


HEX DEC CHR CTRL HEX DEC CHR HEX DEC CHR HEX DEC CHR
0 0 NUL ^@ 20 32 SP 40 64 @ 60 96 `
1 1 SOH ^A 21 33 ! 41 65 A 61 97 a
2 2 STX ^B 22 34 " 42 66 B 62 98 b
3 3 ETX ^C 23 35 # 43 67 C 63 99 c
4 4 EOT ^D 24 36 $ 44 68 D 64 100 d
5 5 ENQ ^E 25 37 % 45 69 E 65 101 e
6 6 ACK ^F 26 38 & 46 70 F 66 102 f
7 7 BEL ^G 27 39 ' 47 71 G 67 103 g
8 8 BS ^H 28 40 ( 48 72 H 68 104 h
9 9 HT ^I 29 41 ) 49 73 I 69 105 i
0A 10 LF ^J 2A 42 * 4A 74 J 6A 106 j
0B 11 VT ^K 2B 43 + 4B 75 K 6B 107 k
0C 12 FF ^L 2C 44 , 4C 76 L 6C 108 l
0D 13 CR ^M 2D 45 4D 77 M 6D 109 m
0E 14 SO ^N 2E 46 . 4E 78 N 6E 100 n
0F 15 SI ^O 2F 47 / 4F 79 O 6F 111 o
10 16 DLE ^P 30 48 0 50 80 P 70 112 p
11 17 DC1 ^Q 31 49 1 51 81 Q 71 113 q
12 18 DC2 ^R 32 50 2 52 82 R 72 114 r
13 19 DC3 ^S 33 51 3 53 83 S 73 115 s
14 20 DC4 ^T 34 52 4 54 84 T 74 116 t
15 21 NAK ^U 35 53 5 55 85 U 75 117 u
16 22 SYN ^V 36 54 6 56 86 V 76 118 v
17 23 ETB ^W 37 55 7 57 87 W 77 119 w
18 24 CAN ^X 38 56 8 58 88 X 78 120 x
19 25 EM ^Y 39 57 9 59 89 Y 79 121 y
1A 26 SUB ^Z 3A 58 : 5A 90 Z 7A 122 z
1B 27 ESC 3B 59 ; 5B 91 [ 7B 123 {
1C 28 FS 3C 60 < 5C 92 \ 7C 124 |
1D 29 GS 3D 61 = 5D 93 ] 7D 125 }
1E 30 RS 3E 62 > 5E 94 ^ 7E 126 ~
1F 31 US 3F 63 ? 5F 95 _ 7F 127 DEL

O.M.V.3.1.1 A-9
11/05/09

You might also like