VISION ESR Analyzer

LIS Port Manual

Released V2.0

SHENZHEN YHLO BIOTECH CO., LTD.

No.5 Building, Lishan Industrial Area, Xinghai Road, Nanshan District
518054 Shenzhen, P. R. China
Tel : +86-755-26473359
Fax: +86-755-26473319
Web: www.szyhlo.com
Contents
Chapter 1 Introduction ................................................................................................................................... 3
1.1 Scope of Application ..................................................................................................................... 3
1.2 Port Form....................................................................................................................................... 3
Chapter 2 TCP/IP Protocol Port .................................................................................................................... 4
2.1 Basic Rules .................................................................................................................................... 4
2.2 Request Format.............................................................................................................................. 5
2.3 ACK .............................................................................................................................................. 5
2.4 VISION Requests .......................................................................................................................... 5
2.4.1 CONNECT ........................................................................................................................ 5
2.4.2 RESULT ............................................................................................................................ 6
2.4.3 RESULTS .......................................................................................................................... 7
2.5 LIS Request ................................................................................................................................... 8
2.5.1 GET ................................................................................................................................... 8
2.5.2 CODE ................................................................................................................................ 8
2.5.3 DATE ................................................................................................................................. 8
2.5.4 CODEDATE ...................................................................................................................... 9
2.5.5 LIST................................................................................................................................... 9
Chapter 3 XML File Port .............................................................................................................................. 10
3.1 XML Generation Rules ..................................................................................................................... 10
3.2 XML File Path ................................................................................................................................... 10
3.3 Naming Rule...................................................................................................................................... 10
3.4 XML File Format .............................................................................................................................. 11
3.5 XML File Reproduction .................................................................................................................... 12

2
 Chapter 1 Introduction
VISION LIS Port Manual is a description document of a protocol used by Vision
operating software to communicate with centralized LIS (Laboratory Information System).

1.1 Scope of Application

This LIS Port Manual is only applicable to LIS connection of full-automatic dynamic
ESR analyzer V1.3.6099.18945 and above versions.

1.2 Port Form

VISION has two forms of LIS ports:
1. TCP/IP protocol port
TCP/IP communication connection is established between the operating software and
LIS to achieve data interaction in accordance with this Document.
2. XML file port
LIS acquires XML files in the XML path described in this Document, and analyzes the
acquired data in the XML file format described in this Document.

3
 Chapter 2 TCP/IP Protocol Port
TCP/IP protocol (connection-oriented TCP) is used to transfer data between VISION
operating software and LIS. The entire protocol is text-based.

2.1 Basic Rules

1. Communication port
The default port for connection between VISION and LIS is 809, unless it is otherwise
configured.
2. Way of connection
LIS is used as the server, while VISION as the client.
3. Way of request
The protocol has two ways of requests:
A. VISION sends the request to the server.
B. LIS sends the request.
4. Start character of message (for protocol version 3 or above)
There is a start character at the start of every message (ASCII hex is expressed as 0x02)
5. End character of request
Each message is followed by a new-line character (\n, 0x0A).
6. Code format
All requests are encoded in UTF-8 transformation format. This allows the protocol to
display every character in the Unicode set.
7. Request parameter separator
Multiple request parameters in a single request are separated by a tab character (0x09)
8. Capital and small letters
Capital and small letters are not differentiated in a request.
9. Booleans
Booleans are represented with text strings (TURE and FLASE);
10. Floating-point
For floating-point data, a dot character “.” is used as decimal separator (0x2E).
11. Date
Dates are represented according to ISO 8601 standard (e.g. 2010-09-21T20:01:00Z).
12. Request acknowledgement
All requests except CLOSE will be acknowledged with an ACK.

4
2.2 Request Format
Parameter Description
A non-negative integer that identifies this request. This ID is unique
in the connection under the same context. All requests except
Request ID
CLOSE will be acknowledged with an ACK containing the same
Request ID.
A string, defining the type of request. The following chapters will
Request Type specify all requests sent by Vision software (CLOSE, CONNECT,
RESULT and RESULTS) and the LIS (GET and LIST).
Parameter 1 Most requests require the transmission of further information
… through a number of parameters. These can be any kind of data
types, depending on the request, but they are always represented as
Parameter N
strings and they never contain a tab character (0x09).
Table 0-1 Request format

2.3 ACK
Parameter Description
Request ID ID number.
Request Type Request type.
Table 0-2 ACK

2.4 VISION Requests

2.4.1 CONNECT
The CONNECT request will be sent by VISION software immediately after TCP has been
successfully connected. It will send 3 parameters to the server.
Parameter Description
This protocol has two versions; the parameter is always 1 in the versions
prior to V1.3.6099.18945.
Protocol version As for V1.3.6099.18945 and later versions, the parameter shall be the LIS
protocol version set in the software option (1 or 2). Version 2 can acquire
the information related to quality control.
Client version The version number of software at the user interface.
This parameter uniquely identifies one installation of Vision software. It
never changes, even when the software is updated, and can be used by the
Client ID LIS to associate results to the specific installation where they are stored.
This is useful to keep track of result transmission history and prevent
reception of duplicate results from Vision software.
Table 0-3 CONNECT

5
2.4.2 RESULT
If the protocol version is 3 and the vision uploads the result positively, LIS will send ACK with
the same frame number in response after reception; if no response is received within 2 seconds,
vision will deem the result hasn‟t been uploaded successfully.
When the server will send the result data request, VISION will send RESULT in response. It
contains all the data associated with a sample processed on the Vision. It has 12 parameters in
the following format:
Parameter Description
A 0-based result index that uniquely identifies the result on this specific
installation of Vision software. This information, together with the client ID
received with the CONNECT request, uniquely identifies the result when
Result index
multiple installations of VISION software are connected to the same LIS.
Note: If the protocol version is 3 and vision uploads the result positively, it
will be always -1.
Instrument A string containing the serial number of the instrument on which the sample
serial number was analyzed.
ISO 8601 representation of the date and time when the analysis was
Time completed. If multiple samples are analyzed in the same batch, they will all
report the same value in this field.
An integer number between 1 and 32, representing the physical position of
Position
the sample tube inside the instrument at the time of analysis.
The sample code either scanned with an external barcode scanner or
Sample code manually entered by the user. When the protocol version is 2, the sample
code also refers to the batch number of QC products.
A floating-point number representing the initial height (measured in mm) of
the sample detected by the instrument, which is the actual height of the blood
Sample height column inside the tube. This parameter can be useful to flag abnormal results.
The user is allowed to detect any samples which blood level is below 20 mm
on the instrument, but the recommended height is more than 20 mm.
A floating-point number between 1 and 140, indicating the detected ESR
ESR
value (measured in mm/h).
A floating-point number between 1 and 140, indicating the ESR value
Corrected ESR corrected using Manley's nomogram depending on the average temperature
measured during detection.
Minimum A floating-point number, representing the minimum temperature (measured
temperature in degree Celsius) measured during testing.
Maximum A floating-point number, representing the maximum temperature (measured
temperature in degree Celsius) measured during testing.
RANDOM A Boolean value indicating whether or not the sample is run in RANDOM
flag mode (this flag is True in this mode).
Unfinished Samples run in RANDOM mode can be stopped and the current result is
flag stored before the analysis is complete if the result is already stable. This flag

6
 is Ture if the result comes from a sample stopped in this way.
This is QC result flag. A Boolean value, indicating the result is quality
IsQC control result or sample result. (True representing QC result). Newly added
for protocol version 2.
QC product The QC product level is C1\C2. 0 represents the sample; 1 represents C1; and
level 2 represents C2. Newly added for protocol version 2.
Reference mean value of QC product. If the reference mean value of this
Reference
batch of QC products isn‟t input, it will be 0. When the result is the sample, it
mean value
will be 0. Newly added for protocol version 2.
The standard deviation of QC product. If the standard deviation of this batch
SD of QC products isn‟t input, it will be 0. When the result is the sample, it will
be 0. Newly added for protocol version 2.
Table 0-4 RESULT

2.4.3 RESULTS
Parameter Description
An integer representing how many results are stored on this installation.
The LIS can use this information to check whether or not all results are
Total Samples
already stored in its database and eventually send a GET request to
retrieve new results.
Current Samples An integer representing how many samples are tested on this cycle.
An integer representing how many QC results are stored on this
installation. The LIS can use this information to check whether or not all
Total QC
QC results are already stored in its database and eventually send a GET
request to retrieve new QC results. Newly added for protocol version 2.
An integer representing how many QC products are tested on this cycle.
Current QC
Newly added for protocol version 2.
Table 0-5 RESULTS

7
2.5 LIS Request
2.5.1 GET
The GET request is sent by LIS to retrieve all specified results. After the ACK, Vision software
will send one or more results, according to the specified range.

Parameter Description
Sample type flag 1 represents the result of sample; 0 represents the QC result. Newly added
for protocol version 2.
Start index An integer representing the start index (inclusive) of the result range that
the LIS wants to retrieve.
End index An integer representing the end index (inclusive) of the result range that
the LIS wants to retrieve.
Table 0-6 GET

2.5.2 CODE
The CODE request is sent by LIS to retrieve all specified sample code results. After the ACK,
Vision software will send one or more results, according to the specified range.
Parameter Description
A string representing the code of sample that the LIS wants to retrieve. When the
Sample ID
protocol version is 2, it is used to retrieve the batch number of the QC product.
Table 0-7 CODE

2.5.3 DATE
The DATE request is sent by LIS to retrieve all results in date range. After the ACK, Vision
software will send one or more results, according to the specified range. When the protocol
version is 2, it is used to retrieve the sample result and QC product result.

Parameter Description
A string representing the starting date from which the LIS wants to retrieve the
result. The date format of the string is “yyyy-MM-dd HH:mm:ss”; Time system
Date From
is 24 hour Clock. (Other date formats aren‟t supported).
E.g.: “2015-08-01 13:20:59”.
A string representing the ending date to which LIS wants to retrieve the result.
The date format is “yyyy-MM-dd HH:mm:ss”; Time system is 24 hour Clock.
Date To
(Other date formats aren‟t supported).
E.g.: “2015-08-01 14:20:59”.
Table 0-8 DATE

8
2.5.4 CODEDATE
The CODEDATE request is sent by LIS to retrieve all results in date range with the specified
sample code. After the ACK, Vision software will send one or more results, according to the
specified range. When the protocol version is 2, it is used to retrieve the QC result in date range
with the batch number of specified QC products.

Parameter Description
A string representing the code of sample that the LIS wants to retrieve.
Sample ID When the protocol version is 2, this parameter can also refer to the
batch number of QC products.
A string representing the starting date from which the LIS wants to
retrieve the result. The date format of string is “yyyy-MM-dd
Date From HH:mm:ss”; Time system is 24 hour Clock. (Other date formats aren‟t
supported).
E.g.: “2015-08-01 13:20:59”.
A string representing the ending date to which the LIS wants to
retrieve the result. The date format is “yyyy-MM-dd HH:mm:ss”;
Date To
Time system is 24 hour Clock. (Other date formats aren‟t supported).
E.g.: “2015-08-01 14:20:59”.
Table 0-9 CODEDATE

2.5.5 LIST
The LIST request is sent by LIS to retrieve the result count. It has no parameters.
After the ACK, Vision software will send a RESULTS request with the quantity of sample
results stored in its database.
Parameter Description
Quantity of sample results Integer.
Quantity of QC results Integer. Newly added for protocol version 2.
Table 0-10 Return to RESULTS

9
 Chapter 3 XML File Port

3.1 XML Generation Rules

1. XML generation path: C:\Users\Lenovo\AppData\Roaming\VISION\Host.
Attention: Lenovo: This is the login name and is varied for different PCs.
2. One sample generates one XML file.
3. The XML File will be generated automatically in the corresponding path after finishing the
cycle.

3.2 XML File Path

1. In the Host folder‟s subdirectory, the folder is named by result date, i.e. all the samples‟
xml files are stored in same folder with same date.

Figure 1 XML File Path

3.3 Naming Rule

2. Naming rule: Date + Sample code + Position
A. Date, Sample code and Position are separated by “_”.
B. Date format: “yyyy-MM-dd-HH-mm-ss.ff”
Note: Date accuracy is millisecond.
C. Sample Code: The special character will be replaced by „S‟ if sample code contains
the special character which is not allowed by the Windows directory.
D. Position: Sample test position on the instrument.

10
 Figure 2 Naming Rules

3.4 XML File Format

Key Description
Sample ID Sample code.
Instrument Instrument code.
Blood Level Blood level.
ESR ESR value in sample analysis.
Corrected ESR Corrected ESR value.
Time Testing time of result.
Position Testing position of sample.
Minimum Temperature Minimum temperature measured during testing.
Maximum Temperature Maximum temperature measured during testing.
IsRandom Radom flag. A Boolean value indicating whether or not the sample is
run in RANDOM mode (this flag is Ture in this mode).
IsUnfinished Samples run in RANDOM mode can be stopped and the current result
is stored before the analysis is complete if the result is already stable.
This flag is Ture if the result comes from a sample stopped in this way.
IsQC This is QC result flag. A Boolean value, indicating the result is quality
control result or sample result. (True representing QC result).
Level The QC product level. 0 represents the sample; 1 represents C1; and 2
represents C2.
Mean Value Reference mean value of QC product. If the reference mean value of
this batch of QC products isn‟t input, it will be 0.
Offset The standard deviation of QC product. If the standard deviation of this
batch of QC products isn‟t input, it will be 0.
0-1 XML File Format

The example about XML result is shown as follows:

11
 <?xml version="1.0" encoding="UTF-8"?>
<Result IsUnfinished="false" IsRandom="true" MaximumTemperature="0"
MinimumTemperature="0" CorrectedESR="14mm/h" ESR="6mm/h"
BloodLevel="1.8 mm" Time="2016-03-04T13:54:44.7941434+08:00"
Position="4" Instrument="VISION-C1" SampleID="162" IsQC="true"
Level="1" MeanValue="0" Offset="0"/>

3.5 XML File Reproduction

The file must be exported by hand if the file disappears due to some abnormal operation
after the cycle is finished.

12