Cell-Dyn 3200 SYSTEM Host Interface Specification: To Host Table of Contents
Cell-Dyn 3200 SYSTEM Host Interface Specification: To Host Table of Contents
1
©998, 1999 ABBOTT DIAGNOSTICS DIVISION
Abbott Laboratories
Abbott Park, IL 60064
Table of Contents
1.0 INTRODUCTION ................................................................................................................. 1
1.1 Purpose ........................................................................................................................ 1
1.2 Definitions and Conventions ......................................................................................... 1
1.3 Scope ........................................................................................................................... 1
2.0 DATA................................................................................................................................... 3
2.1 General Message Form ................................................................................................ 3
2.1.1 Messages ........................................................................................................... 3
2.1.2 Syntax and Functional Error Response............................................................... 3
2.1.3 Syntax of Instrument Messages .......................................................................... 3
2.2 Instrument Messages.................................................................................................... 4
2.2.1 Instrument Transmission Modes ......................................................................... 4
2.2.1.1 Run Menu Automatic Transmit Mode .................................................... 4
2.2.1.2 Data Log Menu Transmit Mode ............................................................. 4
2.2.1.3 Display Specimen Menu Transmit Mode ............................................... 4
2.2.2 Message Identification Segment......................................................................... 4
2.2.2.1 Message Type — Field 1....................................................................... 4
2.2.2.2 Instrument Type — Field 2 .................................................................... 5
2.2.2.3 Serial Number — Field 3 ....................................................................... 5
2.2.2.4 Sequence Number — Field 4 ................................................................ 5
2.2.2.5 Spare Field — Field 5............................................................................ 5
2.2.2.6 Specimen Type — Field 6 ..................................................................... 5
2.2.2.7 Next (Specimen) ID — Field 7............................................................... 5
2.2.2.8 Specimen Name — Field 8.................................................................... 6
2.2.2.9 Patient ID — Field 9 .............................................................................. 6
2.2.2.10 Specimen Sex — Field 10 ................................................................... 6
2.2.2.11 Specimen DOB — Field 11 ................................................................. 6
2.2.2.12 Dr. Name — Field 12........................................................................... 6
2.2.2.13 Operator ID — Field 13 ....................................................................... 6
2.2.2.14 Specimen Date — Field 14.................................................................. 6
2.2.2.15 Specimen Time — Field 15 ................................................................. 7
2.2.2.16 Collection Date — Field 16.................................................................. 7
2.2.2.17 Collection Time — Field 17 ................................................................. 7
2.2.2.18 Comment — Field 18 .......................................................................... 7
2.2.3 Results Segment................................................................................................. 7
2.2.3.1 Results Segment of a Histogram Message ........................................... 7
2.2.3.2 Results Segment of a Count Data Message........................................ 11
1.1 Purpose
This document describes the communication methods and interface characteristics of the
CELL-DYN 3200 automated hematology analyzer when connected to a Host.
The Host is an external computer or data collection system. The "Instrument" is the Abbott
CELL-DYN 3200.
Data transferred from the Host to the Instrument is called Host Data. Data transferred
from the Instrument to the Host is called Instrument Data.
1.3 Scope
This document is divided into two major sections. The Data section describes the
communication messages. The RS232 Transport section describes the means by which
the Instrument and Host transfer data to each other.
This section describes the data that is transferred between the Instrument and the Host.
The syntax and meaning of communication messages is described without reference to the
underlying transport mechanism.
2.1.1 Messages
The Instrument accepts all messages that the Host successfully transmits. If a Host
message contains syntax or functional errors, the message is rejected by the
Instrument and the appropriate flow control character is sent to the Host (refer to
Section 3.3.4.2).
Although Host and Instrument messages convey different information, they share a
common syntax:
1. Each message is partitioned into fields. Each field ends with a comma.
3. Text fields begin and end in double quotation marks ("), are left-justified between
the quotation marks, and use the blank character to occupy empty positions.
4. Values reported in numeric floating point fields and in numeric integer fields are
right-justified, and zeroes are used to fill empty positions.
5. Values in numeric floating point fields are reported with a precision based on the
ranges listed below. Zeros are used to fill empty positions.
*Precision is the number of significant digits to the right of the decimal point.
7. Empty fields
a) Text fields which are defined, such as Dr. Name, but which are empty
because the operator did not input data are filled with the "-" character (2D
hex).
b) Numeric fields which are defined but which have no data reported by the
Instrument are filled with the "-" character (2D hex). Example: there is no
Instrument messages are transmitted by the Instrument to the Host. All of these contain
result data. Each message comprises an identification segment followed by a results
segment.
The operator may select automatic transmit mode in the Setup Menu. This mode
allows the automatic transmission of results during the RUN cycle. The operator
may also request the System to transmit histogram data in the automatic transmit
mode. If histogram transmission is not requested, then only the count data is
transmitted.
On the Data Log Menu, the operator may request transmission of results from a
block of samples. Only count data is transmitted.
On the Display Specimen Menu, the operator may request transmission of results
from the specimen being displayed. Only count data is transmitted.
The Identification Segment of each message gives the message type and identifies
the specimen.
The Message Type is the first field in the Identification Segment. It occupies an
alphanumeric field of three (3) characters plus the enclosing double quotation
marks. The six message types are as follows:
The Instrument Type number is the second field sent in the Identification
Segment. It occupies an alphanumeric text field of seven (7) characters plus
the enclosing double quotation marks. The string for the CELL-DYN 3200CS is
sent as "CD3200C" and for the CELL-DYN 3200SL as "CD3200S".
The Serial Number of the instrument is the third field in the Identification
Segment. It occupies an alphanumeric field of twelve (12) characters plus the
double quotation marks. It is not available in this release, so the field is
transmitted as twelve "-" characters plus the enclosing double quotation marks.
This field consists of one character. Its value is undefined at this time.
The Specimen Type is the sixth field in the Identification Segment. It occupies a
numeric field of one character whose value gives the specimen type as follows:
0: Patient
1: QC sample
2: Background
3: Fragile WBC
4: Calibrator
5: Whole blood
6: Latex
7: Unused
8: Resistant RBC
The Next Specimen ID is the seventh field in the Identification Segment. For
patient samples (including Patient, Fragile WBC, and Resistant RBC), the
The Patient ID is the ninth field in the Identification Segment. It occupies a text
field of sixteen (16) characters plus the enclosing double quotation marks.
The Specimen Sex is the tenth field in the Identification Segment. It occupies a
text field of one character plus the enclosing double quoatation marks. The
values are language-specific: English, Japanese, Italian, French, and
Portugese will return "M" or "F" if set. Spanish will return "H" or "M" if set.
German will return "M" or "W" if set. If Specimen Sex is not entered by the
operator, this field is transmitted as a "-" character plus the enclosing double
quotation marks.
The Specimen Date of Birth (DOB) is the eleventh field in the Identification
Segment. It occupies a text field of ten (10) characters plus the enclosing
double quotation marks. The DOB format always uses the mm/dd/yyyy format
regardless of the format selected by the operator in the Setup Menu. Four
digits are used for the year. If DOB is not entered by the operator or received
from the Host, this field is transmitted as --/--/---- plus the enclosing double
quotation marks.
The Dr. Name is the twelfth field in the Identification Segment. It occupies an
alphanumeric field of twenty two (22) characters plus the enclosing double
quotation marks. If Dr. Name is not entered by the operator, this field is
transmitted as 22 "-" characters plus the enclosing double quotation marks.
The Collection Date field is the sixteenth field in the Identification Segment.
This field gives the date the specimen was collected. It occupies an
alphanumeric field of ten (10) characters plus the enclosing double quotation
marks. The Collection Date format always uses the mm/dd/yyyy format
regardless of the format selected by the operator in the Setup Menu. If
Collection Date is not entered, the field is transmitted as --/--/---- plus the
enclosing double quotation marks.
The Collection Time field is the seventeenth field in the Identification Segment.
It occupies an alphanumeric field of five (5) characters plus the enclosing
double quotation marks. The format is two digits, a colon, and two digits. The
first two-digit set represents the hour (from 00 to 23) and the second two-digit
set represents the minutes. This field gives the time the specimen was
collected. If Collection Time is not entered, this field is transmitted as --:-- plus
the enclosing double quotation marks.
The Comment field is the eighteenth and final field in the Identification
Segment. It occupies an alphanumeric field of sixteen (16) characters plus the
enclosing double quotation marks. If no comment is entered by the operator,
this field is transmitted as 16 "-" characters plus the enclosing double quotation
marks.
The Results Segment contains numeric data and flags generated by the
Instrument. There are two different Results Segment forms, one for histogram data
messages, and one for count data messages. Each of these Results Segment
forms is preceded by the first 18 fields of the Message Identification Segment.
The scale factor is a number that holds the full-range value for the following
normalized histogram data. The scale factor is a numeric field, five (5)
characters in length, with an implied decimal point after its fourth character.
At present the scale factor is not implemented, and so it is always
transmitted as a zero value.
The channel data fields are normalized counts from every fourth channel of
the 256 channels used internally in the System. The channel data appears
in numeric fields three (3) characters in length.
0, [spare field]
0, [specimen type]
"----------------", [comment]
Each blood parameter in the Count Data message (fields 19 through 40) is
transmitted in a numeric field of five (5) characters, one of which is usually a
floating decimal point. The values are sent in US units. Conversion to other
units is the responsibility of the Host.
This flag (X bar B) is a numeric field of one character. A 1 indicates that the
specimen was included in the X bar B RBC batch, while a 0 indicates that it was
not included.
This flag is in a numeric field of one character. A 1 indicates that the flag is set,
while a 0 indicates that it is not set.
This flag is in a numeric field of one character. A 1 indicates that the flag is set,
while a 0 indicates that it is not set.
This flag is in a numeric field of one character. A 1 indicates that the flag is set,
while a 0 indicates that it is not set.
This flag is in a numeric field of one character. A 1 indicates that the flag is set,
while a 0 indicates that it is not set.
This flag is in a numeric field of one character. A 1 indicates that the flag is set,
while a 0 indicates that it is not set.
This flag is in a numeric field of one character. A 1 indicates that the flag is
set, while a 0 indicates that it is not set.
This flag is in a numeric field of one character. A 1 indicates that the flag is
set, while a 0 indicates that it is not set.
This flag is in a numeric field of one character. A 1 indicates that the flag is
set, while a 0 indicates that it is not set.
This flag is in a numeric field of one character. A 1 indicates that the flag is
set, while a 0 indicates that it is not set.
This flag is in a numeric field of one character. A 1 indicates that the flag is
set, while a 0 indicates that it is not set.
This flag is in a numeric field of one character. A 1 indicates that the flag is set,
while a 0 indicates that it is not set.
This flag is in a numeric field of one character. A 1 indicates that the flag is set,
while a 0 indicates that it is not set.
This flag is in a numeric field of one character. A 1 indicates that the flag is set,
while a 0 indicates that it is not set.
This flag is in a numeric field of one character. A 1 indicates that the flag is set,
while a 0 indicates that it is not set.
This flag is in a numeric field of one character. A 1 indicates that the flag is set,
while a 0 indicates that it is not set.
This flag is in a numeric field of one character. A 1 indicates that the flag is set,
while a 0 indicates that it is not set.
This flag is in a numeric field of one character. A 1 indicates that the flag is set,
while a 0 indicates that it is not set.
This flag is in a numeric field of one character. Its value is undefined at this
time.
This flag is in a numeric field of one character. A 1 indicates that the flag is set,
while a 0 indicates that it is not set.
This flag is in a numeric field of one character. Its value is undefined at this
time.
This flag is a numeric field of one character. A 0 means the flag is not set, and
a 1 means that is it set.
This flag is a numeric field of one character. A 0 means the flag is not set, and
a 1 means that it is set.
These fields are all integers in five-character numeric fields. Their values are
undefined at this time.
The Limits Set is a numeric field of one character. It indicates which set of
patient limits (1 to 4) was in effect for the given patient specimen.
The Sample Mode is a numeric field of one character. A 0 indicates that the
specimen was taken in Open Sample Mode; a 1 indicates Closed Sample
Mode.
This field is a numeric field of one character. Its value is undefined at this time.
This flag is a numeric field of one character. A 1 indicates that there was a flow
error, while a 0 indicates that there was no flow error.
This flag is a numeric field of one character. A 1 indicates that there was a flow
error, while a 0 indicates that there was no flow error.
This flag is a numeric field of one character. A 1 indicates that there was a flow
error, while a o indicates that there was no flow error.
0, [spare field]
0, [specimen type]
"----------------", [comment]
1, [DFLT flag]
0, [Blast flag]
0, [IG flag]
0, [Band flag]
0, [IG/Bands flag]
0, [FWBC flag]
0, [DLTA flag]
0, [NWBC flag]
0, [RRBC flag]
1, [LRI flag]
0, [URI flag]
- - - - -, [NOC concentration]
3, [limits set]
1, [sample mode]
0, [spare flag]
0, [Sampling Error/incomplete
aspiration flag]
Host messages are transmitted by the Host to the Instrument. The Instrument uses Host
messages to add entries to the work list. However, if a Host message contains syntax or
functional errors, the operator is alerted through the user interface, and the work list is not
altered.
Because the work list is always ON, the Instrument is able to receive work list
messages (records) from the Host at any time provided there is data in the Specimen
ID field. If a record sent by the Host contains a blank Specimen ID, the Instrument
treats that message as containing syntax errors and rejects the message.
This is a text field of twelve (12) characters plus enclosing quotation marks, giving
the specimen ID to be used for the given specimen. This field must contain either
a bar code or other Specimen ID, otherwise the Instrument will reject the entire
record.
Specimen Name is a text field of twenty eight (28) characters plus enclosing
quotation marks. If Specimen Name is not entered by the operator, this field will
be transmitted as 28 "-" characters plus the enclosing double quotation marks.
Patient ID is a text field of sixteen (16) characters plus the enclosing double
quotation marks.
The Specimen Sex is a text field of one character plus the enclosing double
quotation marks. The values are language-specific: English, Japanese, Italian,
French, and Portugese should transmit "M" or "F". Spanish should transmit "H" or
"M". German should transmit "M" or "W". If Specimen Sex is not entered by the
operator, this field is transmitted as a "-" character plus the enclosing double
quotation marks.
Collection Date is an alphanumeric field of ten (10) characters plus the enclosing
double quotation marks. The Collection Date format always uses the mm/dd/yyyy
format regardless of the format selected by the operator in the Setup Menu. If
Collection Date is not entered, the field is transmitted as --/--/---- plus the enclosing
double quotation marks.
Collection Time is an alphanumeric field of five (5) characters plus the enclosing
double quotation marks. The format is two digits, a colon, and two digits. The first
two-digit set represents the hour (from 00 to 23) and the second two-digit set
represents the minutes. This field gives the time the specimen was collected. If
Collection Time is not entered, this field is transmitted as --:-- plus the enclosing
double quotation marks.
Dr. Name is an alphanumeric field of twenty two (22) characters plus the enclosing
double quotation marks. If Dr. Name is not entered by the operator, this field is
transmitted as 22 "-" characters plus the enclosing double quotation marks.
This is a numeric field of one (1) character, giving the limit set to be used for the
given specimen. Valid values range from 0 to 6, with 0 signifying that the
Instrument should use the default limit set value as specified on the Work List Set
Up menu. If this field does not contain a valid value, the Instrument will conclude
that the message contains a syntax error.
This is a numeric field of one (1) character, giving the parameter set to be used for
the given specimen. Valid values range from 0 to 4, with 0 signifying that the
Instrument should use the default parameter set value as specified on the Work
List Set Up menu. If this field does not contain a valid value, the Instrument will
conclude that the message contains a syntax error.
0, [limit set]
3, [parameter set]
The Instrument provides a standard DB9 male connector mounted on the back panel. The
RS232C interface is configured as DTE (Data Terminal Equipment). A commercial cable
or adapter can be obtained for converting the 9-pin interface to a standard 25-pin interface.
Further information on the physical interface can be obtained from the publication "IBM
Technical Reference, Options and Adapters" (Copyright IBM Corporation).
Voltage levels and electrical characteristics are defined by the EIA RS232C specification.
The maximum recommended cable length is 30 meters, or 100 feet. The maximum
workable cable length may differ from that figure because of environmental factors, the
selected baud rate, and the nature of the equipment being connected.
The communication is full duplex; the Host and the Instrument may begin transmitting
at any time except as restricted by error control and recovery.
Each data message is transported in a frame composed of the start character, data
message, checksum, and the stop character. All characters are printable ASCII
values except the start and stop, which have the default values two and three,
The checksum is provided for the receiver to verify message integrity. It is generated
by taking the modulo 256 sum of the characters in the data message. The checksum
includes all characters in the message except itself, the STX, and the ETX. The two-
digit ASCII-hexadecimal representation of the checksum is placed immediately before
the ETX.
If the Instrument receives a message that passes its test for integrity (refer to
Section 3.3.3) and does not need to be rejected for the reasons cited in Section
3.3.4.2, it sends an ACK (06 hex) character to signal the Host that it is ready to
receive the next message. The ACK should not be embedded in a data message
sent by the instrument.
If the Instrument detects an error in the message, it will send one of the following
three error responses to the Host.
If the instrument receives a message that fails its test for integrity, it sends a
NAK (15 hex) character to signal the Host that it should transmit the message
again.
If the Instrument receives a message that passes its test for integrity but has
an incorrect format (refer to Section 2.3.2, Host Message Format), then it
sends a DEL (7F hex) character to reject the message.
If the Instrument receives a message that passes its test for integrity but the
Specimen ID identification matches an entry already in the Work List, then it
sends a DEL character to reject the message.
If the Instrument receives a message that passes its test for integrity but the
Work List is full, it sends a CAN (18 hex) character to reject the message.
The Host can release the Instrument to send the next message by sending an
ACK (06 hex) before the time-out interval passes. Otherwise, the Instrument will
send the next message automatically if the selected time-out interval passes.
If for any reason the Host requires retransmission of the message, it signals the
Instrument by sending a NAK (15 hex) before expiration of the time-out interval.
The NAK character may be sent, and the Instrument will retransmit, a maximum of
two times. After this, the Instrument will send the next message when the time-out
interval has passed.
Two methods of transmission control are provided: XON/XOFF and CTS (hardware
handshake). To use XON/XOFF control, the Host must transmit an XOFF character
(13 hex) to the Instrument while the Host still has room for at least two additional
characters from the Instrument and must transmit an XON character (11 hex) to
cause the Instrument to resume transmission. To use the CTS control, the Host must
set the CTS signal false while the Host still has room for at least two additional
characters and must set CTS true again to cause transmission to resume. There is a
two-second time-out for XON/XOFF control. Transmission will automatically resume
two seconds after an XON/XOFF character is received even if no XON character
follows it. There is no time-out with CTS control.