Vitalab Flexor-XL Host

Appendix
A. Appendix
VITAL SCIENTIFIC N.V. A-1

Appendix
A. Host Communication Handler configuration

The Host Communication Handler can be started by:
1. Select F5 Special functions from the main menu
2. Select F2 Install
3. Select Communication
4. Select F5 HostCom
The communication can be switched on and off in the Host Communication Handler. When on,
the port number can be selected. The factory settings are as follows:
Port OFF
Bits per second* 9600
Data bits* 8
Parity* None
Stop bits* 1
Flow control* None
* Can only be changed via the Host Communication Handler when a serial port is selected.
A-2 VITAL SCIENTIFIC N.V.

Appendix
Port Here it is possible to select whether the analyzer/host communica-

tion is active and, if it is to be activated, through which port num-
ber.
When a port is selected (1 to 8), the communication parameters

such as baud rate, parity etc., can be set.

Appendix
B. Interface Description
B.1 Scope
This document describes the interface and protocol between a host (Laboratory Information Sys-
tem) and the XL-PC.
B.2 Hardware Interface
The connection is done according to the RS232 standard.
The line signal definition is shown in the following table:
DB-9 DB-25 Signal name Direction Remarks

pin # pin #
5 7 SG Signal Ground
3 2 TX Transmit data output data from analyzer-PC to host
2 3 RX Receive data input data from host to analyzer-PC
7 4 RTS Request To Send output *
8 5 CTS Clear To Send input *
4 20 DTR Data Terminal Ready output *
6 6 DSR Data Set Ready input *
1 8 CD Carrier Detect input not used
9 22 RI Ring Indicator input not used
* function depending on the COM-port settings of the PC

Appendix
B.3 General Remarks
The analyzer-PC uses a proprietary communication protocol to connect it to a host computer. This
is a normal RS232 serial interface protocol, and the main properties are given here.
─ The analyzer-PC uses handshaking according to the settings of the COM-port used for the
communication with the host.
─ The settings of the COM-port (baud rate, start, stop and parity bits) can only be programmed in
the Analyzer Host Communication Program.
─ As start and stop indicators of requests and responses respectively STX and ETX are used.
─ No use is made of a checksum.
─ There is no initialization of a complete communication protocol as such. The host can simply
send requests for reagent positions, tests, software versions etcetera and the analyzer-PC will
respond with the corresponding answer. In order to check the communication the Echo request
function can be used.
─ The analyzer only works in the so-called Upload mode. This means that the host sends for
each individual sample a Request Sample to the analyzer-PC, which directly responds with a
Request sample indication and after finishing the request with a Result.
─ In case the analyzer works with more than one set of two reagent rotors the host must send
only test requests for the tests actually installed on the actual set of reagent rotors. The other
tests for this sample can then be requested later.
─ When the operator changes the reagent rotor set of the analyzer, or when an analyzer part is
disabled or enabled, a new Reagent Installation is automatically sent to the host, so the host
knows which tests can be requested.

Appendix
B.4 Transmission Format
General
In the format description in the next sections, the following assumptions have been made:
─ All communication is done through, and limited to the ASCII character set.
─ All boldface characters are sent as shown.

─ In the description the items are placed on multiple lines, this is only to clarify the format and this
is NOT the case in the actual messages. Here, all items follow each other directly.
─ All items are terminated with a semicolon.

─ Some parts have to be repeated a number of times. Those parts are preceded with italicized
text. This text is not a part of the format.
─ Items are described with their names and the length in between brackets, e.g. sample_ID(12).
─ Items can be optional. These items are placed between square brackets.
─ Items can have some comment. This comment is placed between square brackets.
Item format
In general, the items themselves – when sent to the analyzer – must not contain semicolons, be-
cause they are used for terminating the item. The next table (alphabetically sorted) gives more
specific limitations.
Item Type Length Limitation

analyser_part text 1 only L (left) or R (right)
batch_no text 10
calibrator_name text 15
control_name text 15
cuvet_av, cuvet_sd floating point number 6
cuvet_blank_val special 6 floating point number, or
LmpOvr (lamp over range error)
LmpUnd (the lamp under range error)
OverRn (the cuvette over range error)
UndrRn (the cuvette under range error)
date_of_birth text 11 same format as in system parameters, sepa-
rators must be non-alphanumeric
detailed_info special see Detailed_info (mono mode)/Detailed info
(dual mode), page A-17 and A-18
device_ID text 6
endpoint_xx floating point number 6
expiry_date text 11 same format as in system parameters, sepa-

Appendix
Item Type Length Limitation

flags text 23 see Normal flags, page A-8
lamp_av, lamp_sd floating point number 6
limit_flags text 3 see Limit flags, page A-10
measurement_date text 11 same format as in system parameters, sepa-
measurement_time text 5 24-hour notation (hh:mm)
nr_of_tests whole number 2 number
physician_name text 20
point_i digit 1 only 0 (next point not used) or 1 (next point
used)
raw_result floating point number 7
raw_units text 6 see Raw units, page A-11
reag_abs floating point number 7
reagent_batch_no text 10
Reagent_expiry_date date 11 Using ShortDateFormat from Windows re-
gional settings
reagent_test_count whole number 5 0..99999, -1 for blank or uninstalled tests
reagent_test_name text 4 blank for sample blank or uninstalled tests
request_tests_x text 32 string of 0’s (test not requested) or 1’s (test
requested)
result floating point number 7
sample_ID text 12
sample_name text 20
sex text 1 only M (male), F (female) or P (pediatric)
software_version text 6..18
status digit 1 meaning depending on the command
test_name text 4
type text 1 only N (normal), E (stat) or P (pediatric)
units text 6 see Units, page A-10
used_xx digit 1 only 0 (next point not used) or 1 (next point
used)
wavelength number 3

Appendix
B.5 Flags
Normal flags
These flags appear in a fixed order in a string. For every flag either a space is written or the re-
spective flag. If none of the flags is true a string is sent with 23 (compatible mode on) or 37 (com-
patible mode off) spaces.
pos. flag error
1 G general hardware error
2 R insufficient reagent
3 # insufficient sample
4 L lamp error/ISE electrode not calibrated
5 U underrange/underrange ISE electrode
6 O overrange/overrange ISE electrode
7 u underrange reference counter/underrange reference ISE electrode
8 o overrange reference counter/overrange reference ISE electrode
9 T cuvette temperature error/ISE temperature error
10 r rerun
11 * alinear error
12 M absorbance limit violation
13 D reagent absorbance deviation error
14 W westgard violation
15 A calibrator limit violation
16 C control limit violation
17 N reference limit violation
18 a reagent absorbance limit violation
19 I general ISE unit error
20 X concentration limit error
21 P prozone error
22 E result near cut-off
23 F test not performed because of disabled analyzer part

Appendix
The following flags are only sent in case the compatible mode is set off:
pos. flag error
24 + Reference high error
25 - Reference low error
26 Y Reference panic high error
27 y Reference panic low error
28 V Cutoff positive
29 v Cutoff negative
30 K Calibration out of high range
31 k Calibration out of low range
32 Z Dup-diff error
33 B Barcode not matching
34 b Barcode not scanned
35 H Calculation result division by zero
36 h Calculation result condition not satisfied
37 m Absorbance low limit error

Appendix
B.6 Limit flags
These flags appear in a fixed order in a string. For every flag either a space is written or the re-
spective flag. If none of the flags is true a string is sent with 3 spaces.
pos. flag error
1 H high limit
2 L low limit
3 P panic
B.7 Units
The next table shows all the possible units.
Unit Unit Unit
(no unit) mg/l mIU/ml
kU/l µg/l µIU/ml
U/l ng/l %
U/ml g/dl %.
µU/ml mg/dl % norm
µkat/l µg/dl m/24hr
mol/l ng/dl g/24hr
mmol/l mg/ml mg/24h
µmol/l µg/ml µg/24h
nmol/l ng/ml sec
fmol/g IU/l units
mEq/l IU/ml Abs
g/l mIU/l ratio

Appendix
B.8 Raw units
The next table shows all the possible raw units.
Raw unit
Abs
dAbs/m
dAbs
B.9 Message format
The messages can be divided in 3 types:
• commands (from host to analyser-PC)

• the response on above commands (from analyser-PC to host)
• the spontaneous responces (from analyser-PC to host)
For all messages, then next applies:
• STX: the ASCII 2 (decimal) character

• ETX: the ASCII 3 (decimal) character
• CR: the ASCII 13 (decimal) character
• LF: the ASCII 10 (decimal) character
• command/response: can contain the characters 32 to 126 (decimal), the characters 0 to 31 and
127 to 255 (decimal) are not used.
Format of commands from host to analyser-PC
The format of commands from host to analyser-PC is:
STX { command } ETX
Format of (spontaneous) responces from analyser-PC to host
The format of (spontaneous) responces from analyser-PC to host is:
STX { (spontaneous) response } ETX CR LF

Appendix
B.10 Messages to Host
Result (R)
Explanation
This message is sent automatically by the analyzer, if the tests of a sample are completed or if the
operator presses Ctrl-F1 in the Evaluate Samples menu, in which case a result message is sent for
the sample currently displayed on screen.
If in the Installation - Communications menu "Extended result:" is set to "yes", the extended result
message is sent instead of the result message.
Normal/stat/pediatric result
Direction analyzer Æ host

Message R;
device_id;
type;
sample_id;
sample_name;
date_of_birth;
sex;
physician_name;
measurement_date;
measurement_time;
nr_of_tests;
The next 8 lines are repeated <nr_of_tests> times:
analyser_part;
test_name;
reagent_batch_no;
reagent_expiry_date;
result;
flags;
limit_flags;
units;

Appendix
Control result

Message R;
device_id;
C;
control_name;
batch_no;
expiry_date;
;
;
measurement_date;
measurement_time;
nr_of_tests;
analyser_part;
test_name;
reagent_batch_no;
result;
flags;
limit_flags;
units;
Calibrator result

Message R;
device_id;
S;
calibrator_name;
batch_no;
expiry_date;
;
;
measurement_date;
measurement_time;
nr_of_tests;
analyser_part;
test_name;
reagent_batch_no;
result;
flags;
limit_flags;
units;

Appendix
Blank result

Message R;
device_id;
B;
Blank;
;
;
;
;
measurement_date;
measurement_time;
nr_of_tests;
analyser_part;
test_name;
reagent_batch_no;
result;
flags;
limit_flags;
units;
Extended result (X)
Normal/stat/pediatric extended result

Message X;
device_id;
type;
sample_id;
sample_name;
date_of_birth;
sex;
physician_name;
measurement_date;
measurement_time;
nr_of_tests;
analyser_part;
test_name;
reagent_batch_no;
result;
flags;
limit_flags;
units;
reag_abs;
raw_result;
raw_units;
detailed_info

Appendix
Control extended result

Message X;
device_id;
C;
control_name;
batch_number;
expiry_date;
;
;
measurement_date;
measurement_time;
nr_of_tests;
analyser_part;
test_name;
reagent_batch_no;
result;
flags;
limit_flags;
units;
reag_abs;
raw_result;
raw_units;
detailed_info
Calibrator extended result

Message X;
device_id;
S;
calibrator_name(15);
batch_no;
expiry_date;
;
;
measurement_date;
measurement_time;
nr_of_tests;
analyser_part;
test_name;
reagent_batch_no;
result;
flags;
limit_flags;
units;
reag_abs;
raw_result;
raw_units;
detailed_info

Appendix
Blank extended result

Message X;
device_id;
B;
Blank;
;
;
;
;
measurement_date;
measurement_time;
nr_of_tests;
analyser_part;
test_name;
reagent_batch_no;
result;
flags;
limit_flags;
units;
reag_abs;
raw_result;
raw_units;
detailed_info

Appendix
Detailed_info (mono mode)
Kinetic test
Detailed info K;
The next 2 lines are repeated 22 times (all measurement points):
used_i; [point _i used for computation]

point_i;
Twopoint test
Detailed info T;

point_i;
Monochromatic endpoint test
Detailed info M;
endpoint_1;
endpoint_2;
; [42 times]
Note: both endpoints are measured at the same wavelength.
Bichromatic endpoint test
Detailed info B;
endpoint_1;
endpoint_2;
; [42 times]
ISE test
Detailed info I;
; [44 times]

Appendix
Detailed info (dual mode)
Kinetic test
Detailed info k;

point_i;
; [2 times]
Twopoint test
Detailed info t;
used_i; [point_i used for computation]

point_i;
; [2 times]
Monochromatic endpoint
Detailed info m;
used_r_abs_1a; [endpoint_abs_1a used for computation]
endpoint_abs_1a;
used_r_abs_1b; [endpoint_abs_1b used for computation]
endpoint_abs_1b;
used_ep_1a; [endpoint_1a used for computation]
endpoint_1a;
used_ep_1b; [endpoint_1b used for computation]
endpoint_1b;
endpoint_2a;
endpoint_2b;
; [32 times]
Note: all point pairs (e.g. 1a/1b) are measured at the same wavelength.

Appendix
Bichromatic endpoint
Detailed info b;
used_r_abs_1a; [endpoint_abs_1a used for computation]
endpoint_abs_1a;
used_r_abs_1b; [endpoint_abs_1b used for computation]
endpoint_abs_1b;
endpoint_1a;
endpoint_1b;
endpoint_2a;
endpoint_2b;
; [32 times]
ISE test
Detailed info I;
;
Reagent installation (I)
This message is sent (automatically) by the analyzer-PC, when the operator has changed the re-
agent installation, one or more reagent batch numbers, the run mode, the reagent disk (menu) or
when an analyzer part is disabled or enabled.
With a disabled analyzer part, all 32 test_names for that part are empty.

Message I;
device_id;
L;
The next 3 lines are repeated 32 times (left instrument part):
reagent_test_name; [blank for sample blank or uninstalled tests]

reagent_batch_no; [blank for sample blank or uninstalled tests]
reagent_expiry_date; [blank for sample blank or uninstalled tests]
R;
The next 3 lines are repeated 32 times (right instrument part):
reagent_test_name; [blank for sample blank or uninstalled tests]


Appendix
Blank result (B)
This message is sent by the analyzer when the operator press Ctrl-F1 in the Rotor/System/ISE -
Blank Rotor menu. The blank results of the selected filter and the selected analyzer half are sent.

Format B;
device_id;
instrument_part;
wavelength;
The next line is repeated 48 times (all cuvettes):
cuvet_blank_val;
cuvet_av;
cuvet_sd;
lamp_av;
lamp_sd;

Appendix
B.11 Commands to Analyzer
Echo request (E)
This message can be used as a test feature.
Command
Direction host Æ analyzer

Command E;
Response

Response e;
device_id;
status; [0 = success
7 = failed: message length error
8 = failed: overrun error
9 = failed: parity, framing or break error]
Get software version (V)
Command

Command V;
Response

Response v;
device_id;
9 = failed: parity, framing or break error
software_version;
Get reagent installation (I)
Command

Command I;

Appendix
Response

Response i;
device_id;
L;
The next 3 lines are repeated 32 times (for left instrument part):
test_name; [blank for sample blank or uninstalled tests]

R;
The next 3 lines are repeated 32 times (for left instrument part):
test_name; [blank for sample blank or uninstalled tests]

Get reagent test counters (N)
Command

Command N;
Response
When a left and/or right analyser part is disabled, the reagent_test_counters of all 32 reagent positions
of that side are -1.

Response n;
device_id;
L;
The next line is repeated 32 times (for left instrument part):
reagent_test_count;
R;
The next line is repeated 32 times (for right instrument part):
reagent_test_count;

Appendix
Request sample (Q)
Only Normal, Stat and Pediatric samples can be requested. Control, Calibrators and Blanks sample
requests are done manually.
The maximum buffer size of the analyzer is 199.
Command

Command Q;
sample_id;
[type;] [default: N]
[sample_name;] [default: empty]
[date_of_birth;] [default: empty]
[sex;] [default: M]
[physician_name] [default: empty]
request_tests_left;
request_tests_right; [sample blank tests are done automatically and cannot
be requested,
ISE tests are always done together, but do not need to
be requested together]
Response

Response q;
device_id;
status; [0 = success: request created or tests added to
existing request with the same sample number
etc.
1 = failed: sample number already exists, but
demographic information doesn't match, or
request in use by the operator
2 = failed: no space for request
3 = failed: one or more tests requested, which have
not been installed
6 = failed: syntax error in type, date or sex
sample_id;
type;
sample_name;
date_of_birth;
sex;
physician_name;
request_tests_left;
request_tests_right;

Appendix
Delete requested sample (D)
Command

Command D;
Sample_id;
Response

Response d;
device_id;
1 = failed: sample number not found, already loaded
or in use by the operator
sample_id;
The next part only when status = 0
type;
sample_name;
date_of_birth;
sex;
physician_name;

Appendix
Ask sample result (R)
Command

Command R;
sample_id;
Response

Response r;
device_id;
status; [0 = success (sample ready or unloaded)
1 = success (sample loaded or still in process)
2 = failed: sample number still in request buffer (not yet loaded)
3 = failed: sample number not found
sample_id;
The next part only when status = 0 or 1
type;
sample_id;
date_of_birth;
sex;
physician_name;
measurement_date; [empty when the sample is not yet ready]
measurement_time; [empty when the sample is not yet ready]
nr_of_tests;
analyser_part;
test_name;
reagent_batch_no;
result; [BUSY when result not yet ready]
flags;
limit_flags;
units;

Appendix

Vitalab Flexor-XL Host

Uploaded by

Document Information

Original Description:

Original Title

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 Flexor-XL Host

Uploaded by

Copyright:

Available Formats

Appendix

VITAL SCIENTIFIC N.V. A-1

A. Host Communication Handler configuration

1. Select F5 Special functions from the main menu

Bits per second* 9600

Flow control* None

A-2 VITAL SCIENTIFIC N.V.

Port Here it is possible to select whether the analyzer/host communica-

When a port is selected (1 to 8), the communication parameters

VITAL SCIENTIFIC N.V. A-3

B.2 Hardware Interface

The connection is done according to the RS232 standard.

The line signal definition is shown in the following table:

DB-9 DB-25 Signal name Direction Remarks

3 2 TX Transmit data output data from analyzer-PC to host

2 3 RX Receive data input data from host to analyzer-PC

7 4 RTS Request To Send output *

8 5 CTS Clear To Send input *

4 20 DTR Data Terminal Ready output *

6 6 DSR Data Set Ready input *

1 8 CD Carrier Detect input not used

9 22 RI Ring Indicator input not used

* function depending on the COM-port settings of the PC

A-4 VITAL SCIENTIFIC N.V.

B.3 General Remarks

VITAL SCIENTIFIC N.V. A-5

B.4 Transmission Format

─ All boldface characters are sent as shown.

─ All items are terminated with a semicolon.

Item Type Length Limitation

A-6 VITAL SCIENTIFIC N.V.

Item Type Length Limitation

VITAL SCIENTIFIC N.V. A-7

pos. flag error

1 G general hardware error

4 L lamp error/ISE electrode not calibrated

5 U underrange/underrange ISE electrode

6 O overrange/overrange ISE electrode

7 u underrange reference counter/underrange reference ISE electrode

8 o overrange reference counter/overrange reference ISE electrode

9 T cuvette temperature error/ISE temperature error

12 M absorbance limit violation

13 D reagent absorbance deviation error

15 A calibrator limit violation

16 C control limit violation

17 N reference limit violation

18 a reagent absorbance limit violation

19 I general ISE unit error

20 X concentration limit error

22 E result near cut-off

23 F test not performed because of disabled analyzer part

A-8 VITAL SCIENTIFIC N.V.

pos. flag error

24 + Reference high error

25 - Reference low error

26 Y Reference panic high error

27 y Reference panic low error

30 K Calibration out of high range

31 k Calibration out of low range

33 B Barcode not matching

34 b Barcode not scanned

35 H Calculation result division by zero