Cell Dyn 3700 Host Interface

28
HOST INTERFACE SPECIFICATION CELL-DYN ® 3700 SYSTEM includes Reticulocyte Parameters LIST NO. 02H33-01 REVISION B ABBOTT DIAGNOSTICS DIVISION Abbott Laboratories Abbott Park, IL 60064

description

Cell Dyn 3700 Host Interface Specifications

Transcript of Cell Dyn 3700 Host Interface

  • HOST INTERFACE SPECIFICATION

    CELL-DYN 3700 SYSTEM

    includes Reticulocyte Parameters

    LIST NO. 02H33-01 REVISION B

    ABBOTT DIAGNOSTICS DIVISION Abbott Laboratories

    Abbott Park, IL 60064

  • HOST INTERFACE SPECIFICATION

    CELL-DYN 3700 SYSTEM

    includes Reticulocyte Parameters

    Abbott Laboratories 1999, 2000 Abbott Diagnostics Division Abbott Park, IL 60064 02H33-01B October 2000

  • CELL-DYN 3700 System Host Interface Specification with Reticulocyte Option i 02H33-01B October 2000

    Table of Contents

    1.0 INTRODUCTION .................................................................................................1 1.1 Purpose ...................................................................................................1 1.2 Definitions and Conventions.....................................................................1 1.3 Scope.......................................................................................................1

    2.0 DATA...................................................................................................................1 2.1 General Message Form............................................................................1 2.2 Instrument Messages...............................................................................2 2.3 Host Messages ......................................................................................19

    3.0 RS-232 TRANSPORT .......................................................................................22 3.1 Mechanical Interface ..............................................................................22 3.2 Electrical Interface..................................................................................22 3.3 Data Link................................................................................................22

  • ii CELL-DYN 3700 System Host Interface Specification with Reticulocyte Option 02H33-01B October 2000

    NOTES

  • CELL-DYN 3700 System Host Interface Specification with Reticulocyte Option 02H33-01B October 2000 1

    1.0 INTRODUCTION 1.1 Purpose

    This document describes the communication methods and interface characteristics of Abbott CELL-DYN 3700 automated hematology analyzer when connected to a Host.

    1.2 Definitions and Conventions The Host is an external computer or data collection system. The Instrument is the Abbott CELL-DYN 3700 System. Data transferred from the Host to the Instrument is called Host Data. Data transferred from the Instrument to the Host is called Instrument Data. Numeric equivalents of characters are shown as hexadecimal values.

    1.3 Scope This document is divided into two major sections, DATA and RS-232 TRANSPORT. The DATA section describes 2 communication protocols: one for transmitting data while in Hematology mode and one for transmitting data while in Retic mode. The RS-232 TRANSPORT section describes the means by which the Instrument and Host transfer data to each other.

    2.0 DATA This section describes the data that is transferred from the Host to the Instrument and from the Instrument to the Host. The syntax and meaning of communication messages is described without reference to the underlying transport mechanism.

    2.1 General Message Form 2.1.1 Messages

    Data is communicated in discrete, independent messages. Each message comprises one or more fields composed of printable ASCII characters.

    2.1.2 Flow Control Flow control characters are used to respond to the receipt of messages. These

    are the non-printable ASCII characters ACK, NAK, DEL, and CAN. 2.1.3 Syntax and Functional Error Response The Instrument accepts all messages that the Host successfully transmits. If a

    Host message contains syntax or functional errors, the appropriate flow control character is sent to the Host. Symmetrically, the appropriate flow control character is sent by the Host in response to an Instrument message that contains syntax or functional errors.

  • CELL-DYN 3700 System Host Interface Specification with Reticulocyte Option 02H33-01B October 2000 2

    2.1.4 Syntax of Host and Instrument Messages Although Host and Instrument messages convey different information, they share a common syntax: 2.1.4.1 Each message is partitioned into fields separated by commas.

    2.1.4.2 All fields are of fixed length.

    2.1.4.3 Text fields begin and end in double quotation marks (") and use the blank character to occupy empty positions. RTC message type floating point values are transmitted as text.

    2.1.4.4 Numeric floating point fields are right-justified, and zeroes are used to fill the empty positions. Numeric integer fields are right-justified, and zeroes are used to fill empty positions.

    2.1.4.5 Flag fields are numeric fields consisting of a single character.

    2.1.4.6 Empty fields 2.1.4.6.1 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).

    2.1.4.6.2 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 5 part diff for Background counts, so Fields 11 through 15 in the Count Data message are reported as "-" characters.

    2.1.4.7 Spare Fields 2.1.4.7.1 Spare numeric fields (5 characters except for

    Sequence Number which is 4 characters) consist of five (5) zeroes.

    2.1.4.7.2 Spare flag fields consist of a single zero.

    2.1.4.8 Instrument messages convey results that may be out of range. Out-of-range numeric fields are filled with the ">" character (3E hex).

    2.2 Instrument Messages 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.

  • CELL-DYN 3700 System Host Interface Specification with Reticulocyte Option 02H33-01B October 2000 3

    2.2.1 Instrument Transmission Modes 2.2.1.1 Run Menu Automatic Transmit Mode 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 Instrument to transmit histogram data in the automatic transmit mode. If histogram transmission is not requested, then only the count data is transmitted.

    2.2.1.2 Data Log Menu Transmit Mode On the Data Log Menu, the operator may request transmission of

    results from a block of samples. Only count data is transmitted.

    2.2.1.3 Display Specimen Menu Transmit Mode On the Display Specimen Menu, the operator may request transmission

    of results from the specimen being displayed. Only count data is transmitted.

    2.2.2 Message Identification Segment Hematology Mode In the Hematology Mode, the Identification Segment of each message gives the message type and identifies the specimen.

    2.2.2.1 Message Type Field I 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 seven message types are as follows:

    WBC Histogram Message 1: "WB31"

    WBC Histogram Message 2: "WB2"

    RBC Histogram Message: "RBC"

    PLT Histogram Message: "PLT"

    WIC Histogram Message: "WIC"

    Count Data Message: " " (3 blanks) Retic Data Message: "RTC"

    2.2.2.2 Sequence Number Field 2 The sequence number is the second field in the Identification Segment.

    It is automatically generated by the Instrument, and it occupies a numeric field of four (4) characters.

    2.2.2.3 Vet Package On Field 3 Vet Package On is the third field in the Identification Segment. This field has a 1 if the veterinary package is turned on, or a 0 if it is not. The meaning of field 6 is a function of the setting of this flag.

  • CELL-DYN 3700 System Host Interface Specification with Reticulocyte Option 02H33-01B October 2000 4

    2.2.2.4 Specimen Type - Field 4 The specimen type is the fourth 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: Electrical background

    4: Calibrator (for calibration) 5: Whole-blood calibrator (for calibration) 6: Latex

    7: MPV latex (for calibration) 8: Resistant RBC

    9: Auxiliary

    2.2.2.5 Specimen ID Field 5 The specimen ID is the fifth field in the Identification Segment. For patient samples, the specimen ID is entered by the operator on the Instrument, while for other samples, such as controls and background samples, the specimen ID is supplied by the Instrument. In either case, it occupies a text field of twelve (12) characters plus the enclosing double quotation marks.

    2.2.2.6 Name (Specimen or Animal) Field 6 The name is the sixth field in the Identification Segment. It occupies a text field of sixteen (16) characters plus the enclosing double quotation marks. If the Vet Package is on (field 3) then the name is the name of the animal. If the Vet Package is off, then the name is the patient name for sample types of patient, and it is undefined otherwise.

    2.2.2.7 Operator ID Field 7 The operator ID is the seventh field in the Identification Segment. It occupies a text field of three (3) characters plus the enclosing double quotation marks.

    2.2.2.8 Specimen Date Field 8 The specimen date is the eighth field in the Identification Segment. It is generated by the Instrument when the specimen is run. It occupies a text field of eight (8) characters plus the enclosing double quotation marks in a format that depends upon a choice made in the Date/Time Submenu in the Setup Menu by the operator: "month/ day/year", "day/month/year", "year/month/day", or "year/day/month".

  • CELL-DYN 3700 System Host Interface Specification with Reticulocyte Option 02H33-01B October 2000 5

    2.2.2.9 Specimen Time Field 9 The specimen time is the final field in the Identification Segment. It is generated by the Instrument when the specimen is run. It occupies a text field of five (5) characters plus the enclosing double quotation marks, and its format is "HH:MM", where HH is the hour (from 00 to 23) and MM is the minute. The 24-hour method of representing time is used.

    2.2.3 Results Segment Hematology Mode The Results Segment contains numeric data and flags generated by the Instrument. There are two different Result Segment forms, one for h istogram and one for count data.

    2.2.3.1 Results Segment of a Histogram Message 2.2.3.1.1 Scale Factor Field 10

    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 five (5) zero characters.

    2.2.3.1.2 Channel Data Fields 11 through 74 The channel data fields are normalized counts from every fourth channel of the 256 channels used internally in the Instrument. The channel data appear in numeric fields three (3) characters in length.

    2.2.3.1.3 Histogram Message Example STX [Start of text] "WB1" [message type] 0416, [sequence no.] 0, [vet package on/off] 0, [specimen type] "-------------" [specimen ID] "--------------------" [specimen name] "stc", [operator ID] "01/25/89", [specimen date] "14:08", [specimen time] 00000, [scale factor]

  • CELL-DYN 3700 System Host Interface Specification with Reticulocyte Option 02H33-01B October 2000 6

    000, [channel 2 data] 000, [channel 6 data] 000, [channel 10 data] 018, [channel 14 data] 024, [channel 18 data]

    052, [channel 22 data] 096, [channel 26 data] 112, [channel 30 data] 098, [channel 34 data] 070, [channel 38 data] 051, [channel 42 data] 038, [channel 46 data] 033, [channel 50 data] 029, [channel 54 data] 023, [channel 58 data] 024, [channel 62 data] 023, [channel 66 data] 019, [channel 70 data] 018, [channel 74 data] 021, [channel 78 data] 022, [channel 82 data] 025, [channel 86 data] 024, [channel 90 data] 025, [channel 94 data] 032, [channel 98 data] 033, [channel 102 data] 034, [channel 106 data] 036, [channel 110 data] 033, [channel 114 data] 033, [channel 118 data] 042, [channel 122 data] 054, [channel 126 data] 058, [channel 130 data]

  • CELL-DYN 3700 System Host Interface Specification with Reticulocyte Option 02H33-01B October 2000 7

    056, [channel 134 data] 065, [channel 138 data] 072, [channel 142 data] 074, [channel 146 data] 077, [channel 150 data] 081, [channel 154 data] 085, [channel 158 data] 085, [channel 162 data] 080, [channel 166 data] 066, [channel 170 data] 059, [channel 174 data] 054, [channel 178 data] 043, [channel 182 data] 042, [channel 186 data] 037, [channel 190 data] 026, [channel 194 data] 022, [channel 198 data] 020, [channel 202 data] 016, [channel 206 data] 010, [channel 210 data] 006, [channel 214 data] 006, [channel 218 data] 005, [channel 222 data] 002, [channel 226 data] 001, [channel 230 data] 002, [channel 234 data] 002, [channel 238 data] 001, [channel 242 data] 001, [channel 246 data] 001, [channel 250 data] 000, [channel 254 data] F7 [checksum] 1 ETX [end of text] 1 The checksum is shown for example only.

  • CELL-DYN 3700 System Host Interface Specification with Reticulocyte Option 02H33-01B October 2000 8

    2.2.3.2 Results Segment of a Count Data Message

    2.2.3.2.1 Conversion of Count Data Fields Each blood parameter in the Count Data message (fields 10 through 31) 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. The hemoglobin parameters (HGB, MCH, and MCHC) must also be multiplied by 0.6206 when modified SI units are being used.

    2.2.3.2.2 WBC Count Field 10

    2.2.3.2.3 NEU Count Field 11

    2.2.3.2.4 LYM Count Field 12

    2.2.3.2.5 MONO Count Field 13

    2.2.3.2.6 EOS Count Field 14

    2.2.3.2.7 BASO Count Field 15

    2.2.3.2.8 RBC Count Field 16

    2.2.3.2.9 HGB Value Field 17

    2.2.3.2.10 HCT Value Field 18

    2.2.3.2.11 MCV Value Field 19

    2.2.3.2.12 MCH Value Field 20

    2.2.3.2.13 MCHC Value Field 21

    2.2.3.2.14 RDW Value Field 22

    2.2.3.2.15 PLT Count Field 23

    2.2.3.2.16 MPV Value Field 24

    2.2.3.2.17 PCT Value Field 25

    2.2.3.2.18 PDW Value Field 26

    2.2.3.2.19 NEU % Value Field 27

  • CELL-DYN 3700 System Host Interface Specification with Reticulocyte Option 02H33-01B October 2000 9

    2.2.3.2.20 LYM % Value Field 28

    2.2.3.2.21 MONO % Value Field 29

    2.2.3.2.22 EOS % Value Field 30

    2.2.3.2.23 BASO % Value Field 31

    2.2.3.2.24 Moving Average Flag Field 32 The moving-average 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.

    2.2.3.2.25 DFLT Flag Field 33 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.

    2.2.3.2.26 Blast flag Field 34 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.

    2.2.3.2.27 Variant Lym Flag Field 35 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.

    2.2.32.28 DFLT Flag Neutrophil Qualifier Field 36 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.

    2.2.3.2.29 DFLT Flag Eosinophil Qualifier Field 37 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.

    2.2.3.2.30 DFLT Flag Lymphocyte Qualifier Field 38 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.

    2.2.3.2.31 IG Flag Field 39 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.

    2.2.3.2.32 Band flag Field 40 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.

  • CELL-DYN 3700 System Host Interface Specification with Reticulocyte Option 02H33-01B October 2000 10

    2.2.3.2.33 DFLT Flag Monocyte Qualifier Field 41 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.

    2.2.3.2.34 DFLT Flag Basophil Qualifier Field 42 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.

    2.2.3.2.35 IG/Band Flag Field 43 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.

    2.2.3.2.36 FWBC Flag Field 44 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.

    2.2.3.2.37 WBC Count Flag Field 45 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.

    2.2.3.2.38 Nucleated RBC Flag Field 46 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.

    2.2.3.2.39 DLTA Flag Field 47 This flag is in a numeric field of one character. A 1 indicates that there is a WIC WOC delta and that a DLTA flag is set. A 0 indicates that a WIC WOC delta does not exist and that the flag is not set.

    2.2.3.2.40 NWBC Flag Field 48 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.

    2.2.3.2.41 RBC MORPH Flag Field 49 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.

    2.2.3.2.42 RRBC Flag Field 50 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.

    2.2.3.2.43 Spare Flag Field 51 This flag is in a numeric field of one character. Its value is undefined at this time.

  • CELL-DYN 3700 System Host Interface Specification with Reticulocyte Option 02H33-01B October 2000 11

    2.2.3.2.44 Platelet Recount Flag Field 52 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.

    2.2.3.2.45 Spare Flag Field 53 This flag is in a numeric field of one character. Its value is undefined at this time.

    2.2.3.2.46 LRI Flag Field 54 The LRI flag is a numeric field of one character. A 0 means the flag is not set, and a 1 means that is it set.

    2.2.3.2.47 URI Flag Field 55 The URI flag is a numeric field of one character. A 0 means the flag is not set, and a 1 means that it is set.

    2.2.3.2.48 RBC Count Time Field 56 The RBC count time is an integer in a five-character numeric field. It represents the RBC count time in milliseconds.

    2.2.3.2.49 RBC Upper Meniscus Time Field 57 The RBC upper meniscus time is an integer in a five-character numeric field. It represents the RBC upper meniscus time in milliseconds.

    2.2.3.2.50 RBC Recount Upper Time Field 58 The RBC recount upper time is an integer in a five-character numeric field. It represents the RBC recount time in milliseconds.

    2.2.3.2.51 RBC Recount Upper Meniscus Time - Field 59 The RBC recount upper meniscus time is an integer in a five-character numeric field. It represents the RBC recount upper meniscus time in milliseconds.

    2.2.3.2.52 WIC Count Time Field 60 The WIC count time is an integer in a five-character numeric field. It represents the WIC count time in milliseconds.

    2.2.3.2.53 WIC Upper Meniscus Time Field 61 The WIC upper meniscus time is an integer in a five-character numeric field. It represents the WIC upper meniscus time in milliseconds.

  • CELL-DYN 3700 System Host Interface Specification with Reticulocyte Option 02H33-01B October 2000 12

    2.2.3.2.54 Spare Fields Field 62, 63 Both of these fields are integers in five-character numeric fields. Their values are undefined at this time.

    2.2.3.2.55 WIC WBC Concentration Field 64 The WIC WBC concentration is a numeric field with 5 characters, including a decimal point. It represents the WIC derived WBC concentration.

    2.2.3.2.56 WOC WBC Concentration Field 65 The WOC WBC concentration is a numeric field with 5 characters, including a decimal point. It represents the WOC derived WBC concentration.

    2.2.3.2.57 Limits Set Field 66 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.

    2.2.3.2.58 Sample Mode Field 67 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.

    2.2.3.2.59 RBC Metering Fault Flag Field 68 The RBC metering fault flag is a numeric field of one character. A 0 indicates that there was no metering fault, a 1 indicates a flow error, and a 2 indicates a clog error.

    2.2.3.2.60 WIC Metering Fault Flag Field 69 The WIC metering fault flag is a numeric field of one character. A 0 indicates that there was no metering fault, a 1 indicates a flow error, and a 2 indicates a clog error.

    2.2.3.2.61 Sampling Error/Incomplete Aspiration Flag Field 70 This is a numeric field of one character. A 0 indicates that there was no sampling error, while a 1 indicates that there was such an error.

  • CELL-DYN 3700 System Host Interface Specification with Reticulocyte Option 02H33-01B October 2000 13

    2.2.3.2.62 Count Data Message Example

    STX [Start of text] ".. ", [message type] 0416, [sequence no.] 0, [Vet package on/off] 0, [specimen type] "------------", [specimen ID] "---------------------", [specimen name] "stc", [operator ID] "01/25/95", [specimen date] "14:08", [specimen time] 05.00, [WBC count] 03.20, [NEU count] 01.20, [LYM count] 0.300, [MONO count] 0.200, [EOS count] 0.100, [BASO count] 04.94, [RBC count] 015.3, [HGB value] 043.1, [HCT value] 092.3, [MCV value] 031.0, [MCH value] 034.4, [MCHC value] 012.0, [RDW value] 00177, [PLT count] 010.7, [MPV value] 01.90, [PCT value] 019.2, [PDW value] 064.0, [NEU % value] 024.0, [LYM % value] 06.00, [MONO % value] 04.00, [EOS % value]

  • CELL-DYN 3700 System Host Interface Specification with Reticulocyte Option 02H33-01B October 2000 14

    02.00, [BASO % value] 1, [moving average flag] 1, [DFLT flag] 0, [Blast flag] 0, [Variant Lymph flag] 1, [DFLT Flag Neutrophil Qualifier] 1, [DFLT Flag Eosinophil Qualifier] 0, [DFLT Flag Lymphocyte Qualifier] 0, [IG flag] 0, [Band flag] 0, [DFLT Flag Monocyte Qualifier] 0, [DFLT Flag Basophil Qualifier] 0, [IG/Bands flag] 0, [FWBC flag] 1, [WBC count flag] 0, [Nucleated RBC flag] 0, [DLTA flag] 0, [NWBC flag] 1, [RBC morphology flag] 0, [RRBC flag] 0, [spare flag] 0, [Platelet Recount flag] 0, [spare flag] 1, [LRI flag] 0, [URI flag] 07761, [RBC count time] 02473, [RBC upper meniscus time] 00000, [RBC Recount time] 00000, [RBC Recount upper meniscus time] 02445, [WIC count time] 01223, [WIC upper meniscus time] 00000, [spare field] 00000, [spare field]

  • CELL-DYN 3700 System Host Interface Specification with Reticulocyte Option 02H33-01B October 2000 15

    05.00, [WIC WBC concentration]

    04.80, [WOC WBC concentration]

    3, [limits set]

    1, [sample mode]

    0, [RBC metering fault flag]

    1, [WIC metering fault flag]

    0, [Sampling Error/incomplete aspiration flag]

    F7 [checksum] 1

    ETX [end of text] 1 The checksum is shown for example only.

    2.2.4 Message ldentification Segment Retic Mode This section applies only to Reticulocyte samples. The Identification Segment of each message gives the message type and identifies the specimen.

    2.2.4.1 Message Type Field 1 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 as follows: Retic Data Message: "RTC"

    2.2.4.2 Sequence Number Field 2 The Sequence Number is the second field in the Identification Segment. It is automatically generated by the Instrument, and it occupies a numeric field of four (4) characters.

    2.2.4.3 Vet Package On Field 3 Vet Package On is the third field in the Identification Segment. It occupies a numeric field of one (1) character. This field has a 1 if the Veterinary Package is turned on, or a 0 if it is not. At this time, Vet Package is not available for the Retic mode.

    2.2.4.4 Specimen Type Field 4 The Specimen Type is the fourth field in the Identification Segment. It

    occupies a numeric field of one character whose value gives the specimen Type as follows: 0: Patient type 1: QC sample type 2: Background type

  • CELL-DYN 3700 System Host Interface Specification with Reticulocyte Option 02H33-01B October 2000 16

    2.2.4.5 Specimen ID Field 5 The Specimen ID is the fifth field in the Identification Segment. For patient samples, the Specimen ID is entered by the operator on the Instrument, while for other samples, such as controls and background samples, the Specimen ID is supplied by the Instrument. In either case, it occupies a text field of twelve (12) characters plus the enclosing double quotation marks.

    2.2.4.6 Specimen Name Field 6 The Specimen Name is the sixth field in the Identification Segment. It occupies a text field of sixteen (16) characters plus the enclosing double quotation marks. It is undefined except for patient samples.

    2.2.4.7 Specimen Sex Field 7 The Specimen Sex is the seventh field in the Identification Segment. It consists of one (1) character "M" or "F" plus the enclosing double quotation marks. If not entered by the operator, Specimen Sex is transmitted as a "-" character (2D hex) plus the enclosing double quotation marks.

    2.2.4.8 Specimen Date of Birth (DOB) Field 8 The Specimen Date of Birth is the eighth field in the Identification Segment. It occupies a text field of eight (8) characters plus the enclosing double quotation marks in a format that depends on a choice made in the Date/Time Submenu in the Setup Menu by the operator: "month/day/year", "day/month/year", "year/month/day", or "year/day/month".

    2.2.4.9 Dr. Name Field 9 The Dr. Name is the ninth field in the Identification Segment. It occupies a text field of twenty two (22) characters plus the enclosing double quotation marks.

    2.2.4.10 Operator ID Field 10 The Operator ID is the tenth field in the Identification Segment. It occupies text field of three (3) characters plus the enclosing double quotation marks.

    2.2.4.11 Specimen Date Field 11 The Specimen Date is the eleventh field in the Identification Segment. It is generated by the Instrument when the specimen is run. I t occupies a text field of eight (8) characters plus the enclosing double quotation marks in a format that depends on a choice made in the Date/Time Submenu in the Setup Menu by the operator: "month/ day/year", "day/month/year", "year/month/day", or "year/day/month".

  • CELL-DYN 3700 System Host Interface Specification with Reticulocyte Option 02H33-01B October 2000 17

    2.2.4.12 Specimen Time Field 12 The Specimen Time is the final field in the Identification Segment. It is generated by the Instrument when the specimen is run. It occupies a text field of five (5) characters plus the enclosing double quotation marks, and its format is "HH:MM", where HH is the hour (from 00 to 23) and MM is the minute. The 24-hour method of representing time is used.

    2.2.5 Results Segment Retic Mode

    2.2.5.1 Count Data Message Each parameter in the Count Data message (fields 13 through 17) is transmitted in a text field of four (4) digits plus a floating decimal point and enclosing double quotation marks (a total of 7 characters). Fields 18 through 22, which are also text fields, are spare fields. Retic% Field 13 Retic Abs Field 14 RBC Count Field 15 Background Count Field 16 Note: If the Specimen Type is Background, Field 16 will contain the background count. Otherwise, Field 16 will contain "0.000". Immature Reticulocyte Fraction Field 17 Spare Field 18 Spare Field 19 Spare Field 20 Spare Field 21 Spare Field 22

    2.2.5.2 Retic Flags

    2.2.5.2.1 Retic Flow Error Flag Field 23

    This flag is a numeric field of one (1) character. A 1 indicates a flow error, while a 0 indicates no flow error.

    2.2.5.2.2 Fragile RBCs Flag Field 24

    This flag is a numeric field of one (1) character. A 1 indicates the presence of fragile RBCs, while a 0 indicates no fragile RBCs.

    2.2.5.2.3 Too Few Events Flag Field 25

    This flag is a numeric field of one (1) character. A 1 indicates too few cells, while a 0 indicates sufficient cells are present.

  • CELL-DYN 3700 System Host Interface Specification with Reticulocyte Option 02H33-01B October 2000 18

    2.2.5.2.4 Excessive Nucleated Cells (ENC) Flag Field 26

    This flag is a numeric field of one (1) character. A 1 indicates an ENC error, while a 0 indicates no ENC error.

    2.2.5.2.5 Excessive RBC Loss (ERL) Flag Field 27

    This flag is a numeric field of one (1) character. A 1 indicates an ERL error, while a 0 indicates no ERL error.

    2.2.5.2.6 No Hematology Data Warning Flag Field 28

    This flag is a numeric field of one (1) character. A 1 indicates no hematology data was found, while a 0 indicates hematology was found.

    2.2.5.2.7 Spare Fields

    Fields 29 through 32 are spare fields. Each consists of a numeric field of one (1) character. Field 29 0 [Spare flag] Field 30 0 [Spare flag] Field 31 0 [Spare flag] Field 32 0 [Spare flag]

    2.2.5.3 Retic Data Message Example

    STX [Start of text] "RTC", [message type] 0416, [sequence no.] 0, [Vet package on/off] 0, [specimen type] "----------------", [specimen ID] "-------------------", [specimen name] "M", [specimen sex] "10/25/75", [specimen DOB] "----------------------" [Dr name] "stc", [operator ID] "01/25/95", [specimen date] "14:08", [specimen time]

  • CELL-DYN 3700 System Host Interface Specification with Reticulocyte Option 02H33-01B October 2000 19

    "1.000", [Retic%l "50.00", [Retic Abs] "5.000", [RBC count] "0.000", [Background count] "0.010", [Immature Reticulocyte Fraction] "0.000", [spare field] "0.000", [spare field] "0.000", [spare field] "0.000", [spare field] "0.000", [spare field] 1 , [Flow error] 0, [Fragile RBCs] 0, [Too few events] 0, [ENC] 0, [ERL] 0, [No hematology data] 0, [spare flag] 0, [spare flag] 0, [spare flag] 0, [spare flag] F7 [checksum]1 ETX [end of text] 1 The checksum is shown for example only.

    2.3 Host Messages 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 work list is not altered.

    2.3.1 Instrument Reception Mode To prepare the Instrument to receive work list messages from the Host, the operator should turn the bar code option on in the Work List menu, then go to the Work List Set Up menu and choose the desired association for the bar code ID (4-digit CELL-DYN 3700 System bar code or Laboratory Specimen ID). When the bar code option is off, the Instrument considers all Host messages to contain syntax errors.

  • CELL-DYN 3700 System Host Interface Specification with Reticulocyte Option 02H33-01B October 2000 20

    2.3.2 Host Message Format

    2.3.2.1 Four-Digit Bar Code Field 1 This is a text field of four characters plus enclosing quotation marks, giving the four-digit bar code to be used for the given specimen, if any. The format requirements for this field are as follows: if the work list is set up on the Instrument to use four-digit bar codes, this field must be filled with characters which are digits; if four-digit bar codes are not being used, this field must be filled with either the "-" character or digits (the value is ignored).

    2.3.2.2 Specimen ID Field 2 This is a text field of twelve characters plus enclosing quotation marks, giving the specimen ID to be used for the given specimen, if any. If four-digit bar codes are being used, this field may be filled with the "-" character to signify that no other specimen ID is required. Otherwise, if this field is filled with the "-" character or is blank, the Instrument will conclude that the message contains a syntax error.

    2.3.2.3 Specimen Name Field 3 This is a text field of sixteen characters plus enclosing quotation marks, giving the specimen name to be used for the given specimen, if any. If there is no specimen name, this field should be filled with the "-" character.

    2.3.2.4 Limit Set Field 4 This is a numeric field of one character, giving the limit 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 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.

    2.3.2.5 Parameter Set Field 5 This is a numeric field of one 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.

  • CELL-DYN 3700 System Host Interface Specification with Reticulocyte Option 02H33-01B October 2000 21

    2.3.2.6 Doctor Name Field 6 This is an optional field that, if used, must be followed by the Date of Birth field, otherwise the message will be rejected. This is a text field of 22 characters plus enclosing quotation marks, giving the name of the patients Doctor for the given specimen. If there is no Doctor Name, this field should be filled with the "-" character, however, any printable character string shall be accepted.

    2.3.2.7 Date of Birth Field 7 This is an optional field that, if used, must be preceded by the Doctor Name field, otherwise the message will be rejected. This is a text field of 8 characters of form mm/dd/yy plus enclosing quotation marks, giving the patients date of birth for the given specimen. If there is no Date of Birth, this field must be represented as --/--/--, otherwise the Instrument will conclude that the message contains a syntax error.

    2.3.3 Short Entry Work List Message Example

    STX [Start of text] "1135", [four-digit bar code] "237-45-7789", [specimen ID] "Smith, Richard", [specimen Name] 0, [limit set] 3, [parameter set] F7 [checksum] 1 ETX [end of text] 1 The checksum is shown for example only.

    2.3.4 Long Entry Work List Message Example

    STX [Start of text] "1135", [four-digit bar code]

    "237-45-7789", [specimen ID] "Smith, Richard", [specimen Name] 0, [limit set] 3, [parameter set] "Jones, Henry", [doctor name] "09/30/45", [date of birth] F7 [checksum] 1 ETX [end of text]

    1 The checksum is shown for example only.

  • CELL-DYN 3700 System Host Interface Specification with Reticulocyte Option 02H33-01B October 2000 22

    3.0 RS-232 TRANSPORT 3.1 Mechanical Interface

    The Instrument provides a standard DB9 male connector mounted on the back panel. The RS-232C interface is configured as DTE (Data Terminal Equipment). A cable is available for converting the 9-pin interface to a standard 25-pin interface.

    Pins on the DB9 connector: Pin 1: Carrier Detect (CD), an input (not used) Pin 2: Receive Data (RxD), an input Pin 3: Transmit Data (TxD), an output Pin 4: Data Terminal Ready (DTR), an output Pin 5: Signal Ground Pin 6: Data Set Ready (DSR), an input Pin 7: Request to Send (RTS), an output Pin 8: Clear to Send (CTS), an input Pin 9: Ring Indicator (RI), an input (not used)

    Further information on the physical interface can be obtained from the "IBM Technical Reference, Options and Adapters" (Copyright IBM Corporation).

    3.2 Electrical Interface Voltage levels and electrical characteristics are defined by the EIA RS-232C 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.

    3.3 Data Link 3.3.1 Symmetrical Interface

    The communication is full duplex; the Host and the Instrument may begin transmitting at any time except as restricted by error control and recovery.

    3.3.2 Asynchronous Serial The transmission of data by the Instrument is in an asynchronous, bit-serial format, using the ASCII character set. A setup menu is provided for specifying the number of bits per character (seven or eight), the number of stop bits (one or two), the parity (even, odd, or none), and the baud rate (300, 600, 1200, 2400, 4800, or 9600).

  • CELL-DYN 3700 System Host Interface Specification with Reticulocyte Option 02H33-01B October 2000 23

    3.3.3 Message Frame Each data message (defined in section 2) 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, respectively. The ASCII standard defines these as STX and ETX. The operator can choose alternative unprintable characters, but this document uses "STX" and "ETX" as synonyms for the start and stop characters, whatever their values. 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.

    3.3.4 Error Recovery Response From Host 3.3.4.1 Between-Transmission Time-Out

    The time-out interval after transmission of one message is programmable from 0.1 second to 9.9 seconds in increments of 0.1 second.

    3.3.4.2 Release for Next 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.

    3.3.4.3 Retransmission 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. A message will be sent by the Instrument a maximum of twice. After this, the same conditions prevail as after a time-out.

    3.3.5 Response to Host The Host should wait for one of these three responses before it sends another message to the Instrument.

    3.3.5.1 NAK Response If the Instrument receives a message that fails its test for integrity (see section 3.3.3), it sends a NAK (15 hex) character to signal the Host that it should transmit the message again.

  • CELL-DYN 3700 System Host Interface Specification with Reticulocyte Option 02H33-01B October 2000 24

    3.3.5.2 DEL Response If the Instrument receives a message that passes its test for integrity but has an incorrect format (see section 2.3), 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 bar code identification (4-digit specimen ID, as chosen by the operator) matches an entry already in the work list, then it sends a DEL character to reject the message.

    3.3.5.3 CAN Response If the Instrument receives a message that passes the integrity test but the bar code option is off or the work list is full, it sends a CAN (18 hex) character to reject the message.

    3.3.5.4 ACK Response If the Instrument receives a message that passes its test for integrity and does not need to be rejected for the reasons cited in sections 3.3.5.1 through 3.3.5.3, it sends an ACK (06 hex) character to signal the Host that it is ready to receive the next message.

    3.3.6 XON/XOFF and CTS 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 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.

    Front CoverTable of ContentsIntroductionDataGeneral Message FormInstrument MessagesHost Messages

    RS-232 TransportMechanical InterfaceElectrical InterfaceData Link