IQ 200 Host Transmission Manual Rev JA
IQ 200 Host Transmission Manual Rev JA
IQ 200 Host Transmission Manual Rev JA
300-4941 Revision JA
iQ200 Automated Urinalysis Series
iRICELL Automated Urinalysis Workcells
iChemVelocity
iWARE Software
This document applies to the latest software listed and higher versions. When a subsequent software version affects the
information in this document, a new issue will be released to the Beckman Coulter website. For labeling updates, go to
www.beckmancoulter.com and download the latest version of the manual or system help for your instrument.
Safety Notice
Read all product manuals and consult with Beckman Coulter-trained personnel before attempting
to operate instrument. Do not attempt to perform any procedure before carefully reading all
instructions. Always follow product labeling and manufacturers recommendations. If in doubt as
to how to proceed in any situation, contact your Beckman Coulter representative.
Beckman Coulter, Inc. urges its customers to comply with all national health and safety standards
such as the use of barrier protection. This may include, but is not limited to, protective eyewear,
gloves, and suitable laboratory attire when operating or maintaining this or any other automated
laboratory analyzer.
WARNING
WARNING indicates a potentially hazardous situation which, if not avoided, could
result in death or serious injury. May be used to indicate the possibility of
erroneous data that could result in an incorrect diagnosis (does not apply to all
products).
CAUTION
CAUTION indicates a potentially hazardous situation, which, if not avoided, may
result in minor or moderate injury. It may also be used to alert against unsafe
practices. May be used to indicate the possibility of erroneous data that could
result in an incorrect diagnosis (does not apply to all products).
Safety Notice
WARNING
Risk of operator injury if:
All doors, covers and panels are not closed and secured in place prior to and
during instrument operation.
The integrity of safety interlocks and sensors is compromised.
Instrument alarms and error messages are not acknowledged and acted upon.
You contact moving parts.
You mishandle broken parts.
Doors, covers and panels are not opened, closed, removed and/or replaced
with care.
Improper tools are used for troubleshooting.
To avoid injury:
Keep doors, covers and panels closed and secured in place while the
instrument is in use.
Take full advantage of the safety features of the instrument.
Acknowledge and act upon instrument alarms and error messages.
Keep away from moving parts.
Report any broken parts to your Beckman Coulter Representative.
Open/remove and close/replace doors, covers and panels with care.
Use the proper tools when troubleshooting.
CAUTION
System integrity could be compromised and operational failures could occur if:
This equipment is used in a manner other than specified. Operate the
instrument as instructed in the product manuals.
You introduce software that is not authorized by Beckman Coulter into your
computer. Only operate your systems software with software authorized by
Beckman Coulter.
You install software that is not an original copyrighted version. Only use
software that is an original copyrighted version to prevent virus
contamination.
CAUTION
If you purchased this product from anyone other than Beckman Coulter or an
authorized Beckman Coulter distributor, and, it is not presently under a Beckman
Coulter service maintenance agreement, Beckman Coulter cannot guarantee that
the product is fitted with the most current mandatory engineering revisions or
that you will receive the most current information bulletins concerning the
product. If you purchased this product from a third party and would like further
information concerning this topic, call your Beckman Coulter Representative.
Contents
Revision History
Safety Notice
Introduction
APPENDIX C: Glossary
Introduction
Purpose
The Laboratory Information System (LIS) feature of the iQ200 Automated Urinalysis System,
iRICELLSeries, iChemVelocity, iWARE Software allows an external laboratory
computer to communicate with the System Manager through a serial connection.
The iQ200 Automated Urinalysis System, iRICELLSeries, iChemVelocity, iWARE
Software make an interface standard available:
American Society for Testing and Materials (ASTM)
The ASTM 1381-95 interface standard is used as low-level protocol and Iris defined XML is used as high-level
protocol:
ASTM 1381-95
Low-Level Protocol which consists of two parts:
Physical Layer (see ASTM Physical Layer in CHAPTER 1, ASTM 1381-95: Low-Level
Protocol).
Data Link Layer (see Data Link Layer in CHAPTER 1, ASTM 1381-95: Low-Level Protocol).
The iRICELL Series with System Manager Software facilitates the connection of the
iQ200 microscopy analyzer and the iChemVelocity a workcell configuration.
To accomplish a successful interface between the System Manager and the laboratory computer, a
compatible environment, both physical and logical, must be established. At the lowest level, the
physical connections must be defined and the behavior of both the sender and receiver of
information must be specified.
The Low-Level Protocol to use for transferring messages between the Instrument and the laboratory
computer is the ASTM 1381-95).
Pin Instrument LIS Port Configuration Laboratory Computer Cable Must Provide on
Provided on DB-9 Male DB-9 Female
2 RXD TXD
3 TXD RXD
5 Ground Ground
NOTE Connection from computer to computer usually requires a Null Modem Cable as indicated in the
above table.
9 8 7 6
Ground on pin 5 TXD on pin 2
RXD on pin 3
The data link layer has procedures for link connection and release, delimiting and
synchronism, sequential control, error detection, and error recovery as specified in ASTM
1381-95. There are three distinct phases in transferring information between the System
Manager and the laboratory computer. The three phases assure the actions of sender and
receiver are coordinated. The three phases are establishment, transfer, and termination.
The data link layer uses a character-oriented protocol to send messages between directly
connected systems. The data link mode of operation is one-way transfer of information with
alternate supervision. Information flows in one direction at a time. Replies occur after
information is sent, never at the same time. It is a simple stop-and-wait protocol. At times the
two systems are actively operating to transfer information. The remainder of the time the
data link is in a neutral state.
Establishment Phase
The establishment phase determines the direction of information flow and prepares the
receiver to accept information. A system, which does not have information to send, normally
monitors the data link to detect the establishment phase. It acts as a receiver, waiting for the
other system.
The system with information available initiates the establishment phase. After the sender
determines the data link is in a neutral state, it transmits the <ENQ> transmission control
character. The receiver ignores any character other than <ENQ> while in the neutral state.
Sender will ignore any responses to the <ENQ> other than <ACK>, <NAK>, or <ENQ>
*1 Line Contention condition - Receiver also has information available and sent the ENQ at the
same time as the sender.
*2 If Sender is the Instrument, wait 1 second and then begin establishment phase by sending <ENQ>.
If Sender is the laboratory computer, the laboratory computer goes into a neutral state for a
minimum of 20 seconds or until the receive message session from the System Manager is complete.
Transfer Phase
During the transfer phase, the sender transmits messages to the receiver. The transfer phase
continues until all messages are sent. Messages are sent in frames. Each frame contains a maximum
of 247 characters (including frame overhead). Messages longer than 247 characters are divided
between two or more frames. Multiple messages are never combined in a single frame. Every
message must begin in a new frame. There are two types of frames: intermediate and end. The
intermediate frames terminate with the character <ETB>, checksum, <CR><LF>. End frames
terminate with <ETX>, checksum, <CR><LF>. A message containing 247 characters or less is sent in
a single end frame. Longer messages are sent in intermediate frames with the last part of the
message sent in the end frame.
Frame Number
The frame number permits the receiver to distinguish between new and retransmitted frames. It is
a single digit sent immediately after the <STX> character. The frame number is an ASCII digit
ranging from 0 to 7. The frame number begins at 1 with the first frame of the Transfer phase. The
frame number is incremented by one for every new frame transmitted. After 7, the number rolls
over to 0, and continues in this fashion.
Checksum
The checksum permits the receiver to detect a defective frame. The checksum is encoded as
two characters, which are sent after the <ETB>, or <ETX> character. The checksum is
computed by adding the binary values of the characters, keeping the least significant eight bits
of the result. The checksum is initialized to zero with the <STX> character. The first character
used in computing the checksum is the frame number. Each character in the message text is
added to the checksum (modulo 256). The computation for the checksum does not include
<STX>, the checksum characters, or the trailing <CR><LF>. The checksum is an integer
represented by eight bits; it can be considered as two groups of four bits. The groups of four
bits are converted to the ASCII characters of the hexadecimal representation. The two ASCII
characters are transmitted as the checksum, with the most significant character first.
Acknowledgements
After a frame is sent, the sender stops transmitting until a reply is received. The receiver
replies to each frame. When it is ready to receive the next frame, it transmits one of three
replies to acknowledge the last frame. This reply must be transmitted within the timeout
period. (See Timeouts for additional information.) A reply of <ACK> signifies the last frame
was received successfully and the receiver is prepared to receive another frame. The sender
must increment the frame number and either send a new frame or terminate. A reply of
<NAK> signifies the last frame was not successfully received and the receiver is prepared to
receive the frame again. A reply of <EOT> signifies that the last frame was successfully
received; the receiver is prepared to receive another frame, but is a request to the sender to
stop transmitting.
Receiver Interrupts
The receiver interrupt is a means for the receiver to request the sender to stop transmitting
messages as soon as possible. During the transfer phase, if the receiver responds to a frame
with an <EOT> in place of the usual <ACK>, the sender must interpret this reply as a receiver
interrupt request. The <EOT> is a positive acknowledgement of the end frame, signifies the
receiver is prepared to receive next frame, and is a request to the sender to stop transmitting.
The sender does not have to stop transmitting after receiving the receiver interrupt request.
If the sender chooses to ignore the <EOT>, the receiver must re-request the interrupt for the
request to remain valid. If the sender chooses to honor the receiver interrupt request, it must
first enter the termination phase to return the data link to the neutral state. This gives the
receiver an opportunity to enter the establishment phase and become the sender. The
original sender must not enter the establishment phase for at least 15 seconds or until the
receiver has sent a message and returned the data link to the neutral state.
Termination Phase
The termination phase returns the data link to the clear or neutral state. The sender notifies
the receiver that all messages have been sent. The sender transmits the <EOT> transmission
control character and then regards the data link to be in a neutral state. Upon receiving <EOT>,
the receiver also regards the data link to be in a neutral state.
Defective Frames
A receiver checks every frame to guarantee it is valid. A reply of <NAK> is transmitted for invalid
frames. Upon receiving the <NAK>, the sender retransmits the last frame with the same frame
number. In this way, transmission errors are detected and automatically corrected. The receiver
ignores any characters occurring before the <STX> or <EOT> or after the end of the block character
<ETB> or <ETX> when checking the frame. A frame should be rejected because:
1. Any character errors are detected (parity error, framing error, etc.)
2. The frame checksum does not match the checksum computed on the received frame
3. The frame number is not the same as the last accepted frame or one number higher (modulo 8).
Upon receiving a <NAK> or any character except an <ACK> or <EOT> (a <NAK> condition), the sender
increments a retransmit counter and retransmits the frame. If this counter shows a single frame
was sent and not accepted six times, the sender must abort this message by proceeding to the
termination phase. An abort should be extremely rare, but it provides a mechanism to escape from
a condition where the transfer phase cannot continue.
Timeouts
The sender and receiver both use timers to detect loss of coordination between them. If a reply of
an <ACK, <NAK>, or <ENQ> is not received within 15 seconds, a timeout occurs. After a timeout, the
sender enters the termination phase.
Receivers that cannot process messages fast enough to keep up with a sender may cause message
buffer overflows in the sender. A sender can normally store at least one complete message. Storage
space for more than one outgoing message is desirable but optional.
Restricted Characters
The data link protocol is designed for sending character-based message text. Restrictions are placed
on which characters may appear in the message text. The restrictions make it simpler for senders
and receivers to recognize replies and frame delimiters. Additional characters are restricted to
avoid interfering with software controls for devices such as multiplexers.
An <LF> character is not permitted to appear in the message text; it can appear only as the last
character of a frame. None of the ten transmission control characters, the <LF> format effector
control character, or four device control characters may appear in message text. The restricted
characters are: <SOH>, <STX>, <ETX>, <EOT>, <ENQ>, <ACK>, <DLE>, <NAK>, <SYN>, <ETB>, <LF>,
<DC1>, <DC2>, <DC3>, and <DC4>.
Expected
Delay Request Session (NAK): Sender Receiver
Establishment Phase <ENQ> --->
<--- <NAK>
(Delay 10 seconds)
<ENQ> --->
<--- <ACK>
Transfer Phase <STX> [frame number] [DATA] <ETX> [C1] [C2] <CR> <LF> --->
frames continue until <--- <ACK>
entire message sent
Termination Phase <EOT> ---> No Response
Expected
Failure SessionPhase
Establishment (Max <NAK>s): Sender
<ENQ> ---> Receiver
(Delay 10 seconds) <--- <NAK>
<ENQ> --->
(Delay 10 seconds) <--- <NAK>
<ENQ> --->
(Delay 10 seconds) <--- <NAK>
<ENQ> --->
(Delay 10 seconds) <--- <NAK>
<ENQ> --->
(Delay 10 seconds) <--- <NAK>
<ENQ> --->
(Delay 10 seconds) <--- <NAK>
Termination Phase <EOT> ---> No Response
Expected
Failure SessionPhase
Establishment (No Response) Sender
<ENQ> ---> Receiver
(Time-out after 15 No Response
seconds)
Termination Phase <EOT> ---> No Response
Expected
Retransmission Request (Multiple <NAK>s): Sender Receiver
Establishment Phase <ENQ> --->
<--- <ACK>
Transfer Phase <STX> [frame number] [DATA] <ETX> [C1] [C2] <CR> <LF> --->
<--- <NAK>
<STX> [frame number] [DATA] <ETX> [C1] [C2] <CR> <LF> --->
<--- <NAK>
<STX> [frame number] [DATA] <ETX> [C1] [C2] <CR> <LF> --->
<--- <NAK>
<STX> [frame number] [DATA] <ETX> [C1] [C2] <CR> <LF> --->
<--- <NAK>
<STX> [frame number] [DATA] <ETX> [C1] [C2] <CR> <LF> --->
<--- <NAK>
<STX> [frame number] [DATA] <ETX> [C1] [C2] <CR> <LF> --->
frames continue until <--- <ACK>
entire message sent
Termination Phase <EOT> ---> No Response
Expected
This section conforms with Iris defined XML message layer. The intent of this section
is to develop a complete understanding of the particular records and fields as
supported by the Instrument.
Message Content
Elements
IRISPing
element IRISPing
annotation documentation
Used for verification of the communications connection between the IRIS
instrument and the LIS. The instrument sends the IRISPing element, upon
receipt of which the LIS sends one back. The LIS never instigates the
exchange.
2. Specimen Analysis Report Message
The instrument reports patient specimen results with the Specimen Analysis Report
message.
Elements
SA
element SA
diagram
annotation documentation
SpecimenAnalysis root element.
attribute SA/@BF
type restriction of xs:string
properties isRef 0
use required
facets Kind Value annotation
enumeration URN documentation
urine
enumeration CSF documentation
cerebrospinal fluid
enumeration PLE documentation
pleural fluid
enumeration PER documentation
peritoneal fluid
enumeration PED documentation
peritoneal dialysate
enumeration PEL documentation
peritoneal lavage
enumeration PCA documentation
pericardial fluid
enumeration SER documentation
serous fluid
enumeration SYN documentation
synovial fluid
annotation documentation
Specimen type (Body Fluid type)
attribute SA/@ID
type xs:string
properties isRef 0
use required
annotation documentation
The specimen identifier
attribute SA/@SID
type xs:string
properties isRef 0
use required
annotation documentation
The system ID
attribute SA/@OP
type xs:string
properties isRef 0
use required
annotation documentation
Operator
attribute SA/@ADT
type xs:string
properties isRef 0
use required
annotation documentation
Analysis DateTime with time zone info (YYYY-MM-DD HH:MM:SStz, where an example
of tz is "-8:00" for Pacific time)
attribute SA/@ADTS
type xs:string
properties isRef 0
use required
annotation documentation
Analysis DateTime String
attribute SA/@RDT
type xs:string
properties isRef 0
use required
annotation documentation
Report DateTime with time zone info (YYYY-MM-DD HH:MM:SStz, where an example of
tz is "-8:00" for Pacific time)
attribute SA/@RDTS
type xs:string
properties isRef 0
use required
annotation documentation
Report DateTime String
attribute SA/@RP
type xs:integer
properties isRef 0
use required
annotation documentation
Rack position (tube number in the rack)
attribute SA/@SQN
type xs:integer
properties isRef 0
use required
annotation documentation
Sequence Number
attribute SA/@RSQN
type xs:integer
properties isRef 0
use required
annotation documentation
Rack Sequence Number (rack ID)
attribute SA/@DILN
type xs:integer
properties isRef 0
use required
annotation documentation
Dilution numerator
attribute SA/@DILD
type xs:integer
properties isRef 0
use required
annotation documentation
Dilution denominator
attribute SA/@IMP
type restriction of xs:integer
properties isRef 0
use required
facets Kind Value annotation
minInclusive 0
maxInclusive 1
annotation documentation
Imported 1=yes, 0=no
attribute SA/@CDT
type xs:string
properties isRef 0
use required
annotation documentation
Chemistry DateTime with time zone info (YYYY-MM-DD HH:MM:SStz, where an
example of tz is "-8:00" for Pacific time)
attribute SA/@CDTS
type xs:string
properties isRef 0
use required
annotation documentation
Chemistry DateTime String
attribute SA/@REDT
type xs:string
properties isRef 0
use required
annotation documentation
Microscopy DateTime with time zone info (YYYY-MM-DD HH:MM:SStz, where an
example of tz is "-8:00" for Pacific time)
attribute SA/@REDTS
type xs:string
properties isRef 0
use required
annotation documentation
Microscopy DateTime String
element SA/PF
diagram
type xs:string
properties isRef 0
minOcc 0
maxOcc unbounded
content simple
annotation documentation
PreFace (lab information)
element SA/AC
diagram
properties isRef 0
minOcc 1
maxOcc 2
content complex
children AR
annotation documentation
Analysis Category
attribute SA/AC/@AT
type restriction of xs:string
properties isRef 0
use required
facets Kind Value annotation
enumeration Chemistry
enumeration Sediment
annotation documentation
Analysis Type
attribute SA/AC/@AS
type restriction of xs:string
properties isRef 0
use required
facets Kind Value annotation
enumeration Done
enumeration Not Done
annotation documentation
Analysis State
attribute SA/AC/@SO
type restriction of xs:string
properties isRef 0
use required
annotation documentation
Analysis category SOurce
attribute SA/AC/@DSLOT
properties isRef 0
annotation documentation
Chemistry dipstick lot
element SA/AC/AR
diagram
properties isRef 0
minOcc 1
maxOcc unbounded
content complex
annotation documentation
Analyte Result
attribute SA/AC/AR/@Key
type xs:string
properties isRef 0
use required
annotation documentation
Mnemonic uniquely identifying the analyte
attribute SA/AC/AR/@SN
type xs:string
properties isRef 0
use required
annotation documentation
Short Name
attribute SA/AC/AR/@LN
type xs:string
properties isRef 0
use required
annotation documentation
Long Name
attribute SA/AC/AR/@AF
type restriction of xs:integer
properties isRef 0
use required
facets Kind Value annotation
minInclusive 0
maxInclusive 1
annotation documentation
Abnormal Flag
attribute SA/AC/AR/@NR
type xs:string
properties isRef 0
use required
annotation documentation
Normal Range
element SA/FL
diagram
type xs:string
properties isRef 0
minOcc 0
maxOcc 1
content simple
annotation documentation
FLags
element SA/tags
diagram
properties isRef 0
minOcc 0
maxOcc 1
content complex
children tag
annotation documentation
LIS Tags as generated by iWARE
element SA/tags/tag
diagram
properties isRef 0
minOcc 1
maxOcc unbounded
content complex
attribute SA/tags/tag/@name
properties isRef 0
use required
annotation documentation
name of the rule
attribute SA/tags/tag/@result
properties isRef 0
use required
annotation documentation
rule output text
attribute SA/tags/tag/@ruleModified
type restriction of xs:string
properties isRef 0
use required
facets Kind Value annotation
enumeration Yes
enumeration No
annotation documentation
Has the rule been modified since the specimen was tagged (Yes/No)?
element SA/reportTags
diagram
properties isRef 0
minOcc 0
maxOcc 1
content complex
children reportTag
annotation documentation
Report Tags as generated by iWARE
element SA/reportTags/reportTag
diagram
properties isRef 0
minOcc 1
maxOcc unbounded
content complex
attribute SA/reportTags/reportTag/@RuleName
properties isRef 0
use required
annotation documentation
name of the rule
attribute SA/reportTags/reportTag/@RuleTaggingResult
properties isRef 0
use required
annotation documentation
rule output text
attribute SA/reportTags/reportTag/@RuleModified
properties isRef 0
use required
annotation documentation
Has the rule been modified since the specimen was tagged (Yes/No)?
element SA/validationTags
diagram
properties isRef 0
minOcc 0
maxOcc 1
content complex
children validationTag
annotation documentation
Validation Tags as generated by iWARE
element SA/validationTags/validationTag
diagram
properties isRef 0
minOcc 1
maxOcc unbounded
content complex
attribute SA/validationTags/validationTag/@RuleName
properties isRef 0
use required
annotation documentation
name of the rule
attribute SA/validationTags/validationTag/@RuleModified
properties isRef 0
use required
annotation documentation
Has the rule been modified since the specimen was tagged (Yes/No)?
element SA/CM
diagram
type xs:string
properties isRef 0
minOcc 0
maxOcc 1
content simple
annotation documentation
Operator comment
element SA/ARV
diagram
type xs:string
properties isRef 0
content simple
annotation documentation
APR ReVision
element SA/SEL_IMGS
diagram
properties isRef 0
minOcc 0
maxOcc 1
content complex
children SI
annotation documentation
Selected images
element SA/SEL_IMGS/SI
diagram
properties isRef 0
minOcc 1
maxOcc unbounded
content complex
annotation documentation
Selected Image
attribute SA/SEL_IMGS/SI/@img
properties isRef 0
use required
annotation documentation
Location of image on the instrument
attribute SA/SEL_IMGS/SI/@call
properties isRef 0
use required
annotation documentation
The long name of the classification of the image
attribute SA/SEL_IMGS/SI/@note
properties isRef 0
use required
annotation documentation
Annotation from operator, may be blank
element SA/AUD
diagram
properties isRef 0
minOcc 0
maxOcc 1
content complex
children XE
annotation documentation
AUDit trail
element SA/AUD/XE
diagram
properties isRef 0
minOcc 1
maxOcc unbounded
content complex
children ED
annotation documentation
Acceptor Entry
attribute SA/AUD/XE/@OP
properties isRef 0
use required
annotation documentation
Operator
attribute SA/AUD/XE/@dt
properties isRef 0
use required
annotation documentation
date/time
attribute SA/AUD/XE/@EdFL
type restriction of xs:string
properties isRef 0
annotation documentation
Edit FLags (did the operator clear any flags, T/F?)
attribute SA/AUD/XE/@EdDEMOG
type restriction of xs:string
properties isRef 0
annotation documentation
Edit DEMOGraphics (did the operator edit any demographics, T/F?)
attribute SA/AUD/XE/@EdID
type restriction of xs:string
properties isRef 0
annotation documentation
Edit ID (did the operator alter the specimen ID, T/F?)
attribute SA/AUD/XE/@CM
properties isRef 0
annotation documentation
Comment (if the operator changed it)
element SA/AUD/XE/ED
diagram
properties isRef 0
minOcc 0
maxOcc unbounded
content complex
annotation documentation
Edit Detail
attribute SA/AUD/XE/ED/@SN
properties isRef 0
use required
annotation documentation
Short Name of the analyte changed
attribute SA/AUD/XE/ED/@FROM
properties isRef 0
use required
annotation documentation
Analyte result before the change
attribute SA/AUD/XE/ED/@TO
properties isRef 0
use required
annotation documentation
Analyte result after the change
element SA/SysCfg
diagram
properties isRef 0
content complex
annotation documentation
System Configuration
attribute SA/SysCfg/@MicroPresent
type restriction of xs:string
properties isRef 0
use required
facets Kind Value annotation
enumeration T
enumeration F
attribute SA/SysCfg/@AXPresent
type restriction of xs:string
properties isRef 0
use required
facets Kind Value annotation
enumeration T
enumeration F
attribute SA/SysCfg/@iChem200Present
type restriction of xs:string
properties isRef 0
use required
facets Kind Value annotation
enumeration T
enumeration F
element SA/SL
diagram
properties isRef 0
minOcc 0
maxOcc 1
annotation documentation
Signature Line
Elements
SIQ
element SIQ
diagram
annotation documentation
Specimen Information Query, contains the specimen identifier for which to retrieve
information from the LIS host
Elements
SI
element SI
diagram
annotation documentation
Specimen Information; contents are the specified specimen's identifier
attribute SI/@BF
type restriction of xs:string
properties isRef 0
use required
facets Kind Value annotation
enumeration URN documentation
urine
enumeration CSF documentation
cerebrospinal fluid
enumeration PLE documentation
pleural fluid
enumeration PER documentation
peritoneal fluid
enumeration PED documentation
peritoneal dialysate
enumeration PEL documentation
peritoneal lavage
enumeration PCA documentation
pericardial fluid
enumeration SER documentation
serous fluid
enumeration SYN documentation
synovial fluid
annotation documentation
Specimen type (Body Fluid type)
attribute SI/@WO
type restriction of xs:string
properties isRef 0
use required
facets Kind Value annotation
enumeration skip documentation
skip microscopy
enumeration gate documentation
use internal gating parameters to determine whether to run
microscopy
enumeration run documentation
run microscopy
enumeration micro- documentation
only only run microscopy
enumeration chem- documentation
only only run chemistry
annotation documentation
Work Order
element SI/RCS
diagram
properties isRef 0
minOcc 0
maxOcc 1
content complex
children RC
annotation documentation
RawChems holding the raw chemistry values from the LIS Host
element SI/RCS/RC
diagram
properties isRef 0
minOcc 12
maxOcc 13
content complex
annotation documentation
Individual chemistry result in the element text; 12 or 13 (ascorbic is optional)
attribute SI/RCS/RC/@Key
type restriction of xs:string
properties isRef 0
use required
facets Kind Value annotation
enumeration BLD documentation
Blood
enumeration BIL documentation
Bilirubin
enumeration URO documentation
Urobilinogen
enumeration KET documentation
Ketone
enumeration GLU documentation
Glucose
enumeration PRO documentation
Protein
enumeration NIT documentation
Nitrite
enumeration LEU documentation
Leukocyte esterase
enumeration PH documentation
pH
enumeration SG documentation
Specific Gravity
enumeration COL documentation
Color
enumeration CLA documentation
Clarity
enumeration ASA documentation
Ascorbic Acid
element SI/DEMOG
diagram
properties isRef 0
minOcc 0
maxOcc 1
content complex
annotation documentation
DEMOGraphics from the LIS Host
attribute SI/DEMOG/@LName
type restriction of xs:string
properties isRef 0
annotation documentation
Last name
attribute SI/DEMOG/@FName
type restriction of xs:string
properties isRef 0
annotation documentation
First name
attribute SI/DEMOG/@MName
type restriction of xs:string
properties isRef 0
annotation documentation
Middle name
attribute SI/DEMOG/@DOB
type restriction of xs:string
properties isRef 0
annotation documentation
Date of birth (YYYY-MM-DD)
attribute SI/DEMOG/@Loc
type restriction of xs:string
properties isRef 0
annotation documentation
Location
attribute SI/DEMOG/@RecNum
type restriction of xs:string
properties isRef 0
annotation documentation
Medical record number
attribute SI/DEMOG/@Gender
type restriction of xs:string
properties isRef 0
annotation documentation
Gender (M/F)
Elements
UNKID
element UNKID
diagram
type xs:string
annotation documentation
The LIS Host did not recognize the specimen ID (UNKnown ID); the unrecognized ID is in
the element text
Elements
ChemQC
element ChemQC
diagram
children PF QCR CM
annotation documentation
ChemistryQualityControl root element.
attribute ChemQC/@NAME
type xs:string
properties isRef 0
use required
annotation documentation
The control name, e.g., "CA"
attribute ChemQC/@SID
type xs:string
properties isRef 0
use required
annotation documentation
The system ID
attribute ChemQC/@OP
properties isRef 0
use required
annotation documentation
Operator
attribute ChemQC/@ADT
type xs:string
properties isRef 0
use required
annotation documentation
Analysis DateTime with time zone info (YYYY-MM-DD HH:MM:SStz, where an example
of tz is "-8:00" for Pacific time)
attribute ChemQC/@ADTS
type xs:string
properties isRef 0
use required
annotation documentation
Analysis DateTime String
attribute ChemQC/@RDT
type xs:string
properties isRef 0
use required
annotation documentation
Report DateTime with time zone info (YYYY-MM-DD HH:MM:SStz, where an example of
tz is "-8:00" for Pacific time)
attribute ChemQC/@RDTS
type xs:string
properties isRef 0
use required
annotation documentation
Report DateTime String
attribute ChemQC/@LOT
type xs:string
properties isRef 0
use required
annotation documentation
Control lot
attribute ChemQC/@EXPIR
type xs:string
properties isRef 0
use required
annotation documentation
Lot expiration
attribute ChemQC/@DSID
type xs:string
properties isRef 0
use required
annotation documentation
Dipstick lot ID
attribute ChemQC/@DSEXPIR
type xs:string
properties isRef 0
use required
annotation documentation
Dipstick lot expiration
attribute ChemQC/@RP
type xs:integer
properties isRef 0
use optional
annotation documentation
Rack position (tube number in the rack)
attribute ChemQC/@STATUS
type xs:string
properties isRef 0
use required
annotation documentation
Pass (P) or Fail (F)
element ChemQC/PF
diagram
type xs:string
properties isRef 0
minOcc 0
maxOcc unbounded
content simple
element ChemQC/QCR
diagram
properties isRef 0
minOcc 1
maxOcc unbounded
content complex
annotation documentation
QC Result
attribute ChemQC/QCR/@SN
type xs:string
properties isRef 0
use required
annotation documentation
Short Name of the analyte
attribute ChemQC/QCR/@LN
properties isRef 0
use required
annotation documentation
Long Name of the analyte
attribute ChemQC/QCR/@ISTATUS
type restriction of xs:string
properties isRef 0
use required
facets Kind Value annotation
enumeration P
enumeration F
enumeration -
annotation documentation
Pass (P), Fail (F), ignore (-)
attribute ChemQC/QCR/@LL
properties isRef 0
use required
annotation documentation
Lower Limit
attribute ChemQC/QCR/@UL
properties isRef 0
use required
annotation documentation
Upper Limit
attribute ChemQC/QCR/@UNIT
properties isRef 0
use optional
annotation documentation
Unit of measure (if not already in result)
element ChemQC/CM
diagram
type xs:string
properties isRef 0
minOcc 0
maxOcc 1
content simple
annotation documentation
Operator comment
Elements
CQC
element CQC
diagram
annotation documentation
CountQualityControl root element.
attribute CQC/@CCType
type restriction of xs:string
properties isRef 0
use required
facets Kind Value annotation
enumeration +L
enumeration -L
enumeration +L2
enumeration -L2
annotation documentation
+L=Primary Positive Count Control; -L=Primary Negative Count Control; +L2=Secondary
Positive Count Control; -L2=Secondary Negative Count Control
attribute CQC/@ID
type xs:string
properties isRef 0
use required
annotation documentation
The control ID
attribute CQC/@SID
type xs:string
properties isRef 0
use required
annotation documentation
The system ID
attribute CQC/@OP
properties isRef 0
use required
annotation documentation
Operator
attribute CQC/@ADT
type xs:string
properties isRef 0
use required
annotation documentation
Analysis DateTime with time zone info (YYYY-MM-DD HH:MM:SStz, where an example
of tz is "-8:00" for Pacific time)
attribute CQC/@ADTS
type xs:string
properties isRef 0
use required
annotation documentation
Analysis DateTime String
attribute CQC/@RDT
type xs:string
properties isRef 0
use required
annotation documentation
Report DateTime with time zone info (YYYY-MM-DD HH:MM:SStz, where an example of
tz is "-8:00" for Pacific time)
attribute CQC/@RDTS
type xs:string
properties isRef 0
use required
annotation documentation
Report DateTime String
attribute CQC/@LOT
type xs:string
properties isRef 0
use required
annotation documentation
Control lot
attribute CQC/@EXPIR
type xs:string
properties isRef 0
use required
annotation documentation
Lot expiration
attribute CQC/@PRODID
type xs:string
properties isRef 0
use required
annotation documentation
Product ID of the control
attribute CQC/@MEAN
type xs:integer
properties isRef 0
use required
annotation documentation
Mean value
attribute CQC/@MNC
type xs:integer
properties isRef 0
use optional
annotation documentation
Maximum negative count (the maximum count for a negative control)
attribute CQC/@RP
type xs:integer
properties isRef 0
use optional
annotation documentation
Rack position (tube number in the rack)
attribute CQC/@SQN
type xs:integer
properties isRef 0
use optional
annotation documentation
Sequence Number
attribute CQC/@RSQN
type xs:integer
properties isRef 0
use optional
annotation documentation
Rack Sequence Number (rack ID)
element CQC/PF
diagram
type xs:string
properties isRef 0
minOcc 0
maxOcc unbounded
content simple
element CQC/MIN
diagram
type xs:integer
properties isRef 0
content simple
annotation documentation
Minimum to pass
element CQC/MAX
diagram
type xs:integer
properties isRef 0
content simple
annotation documentation
Maximum to pass
element CQC/COUNT
diagram
type xs:integer
properties isRef 0
content simple
annotation documentation
Actual count
element CQC/STATUS
diagram
properties isRef 0
content simple
facets Kind Value annotation
enumeration P
enumeration F
annotation documentation
Pass (P) or Fail (F)
element CQC/REF
diagram
type xs:double
properties isRef 0
content simple
annotation documentation
Run Equivalency Factor
element CQC/CM
diagram
type xs:string
properties isRef 0
minOcc 0
maxOcc 1
content simple
annotation documentation
Operator comment
8. Body Fluid Control Report Message
The instrument reports body fluid control results with the Body Fluid Control Report
message.
Elements
BFQC
element BFQC
diagram
annotation documentation
BodyFluidQualityControl root element.
attribute BFQC/@BFCType
type restriction of xs:string
properties isRef 0
use required
facets Kind Value annotation
enumeration BGC
enumeration BL1
enumeration BL2
annotation documentation
BGC=BFA Background Check; BL1=BFA Level I Control; BL2=BFA Level II Control
attribute BFQC/@ID
type xs:string
properties isRef 0
use required
annotation documentation
The control ID
attribute BFQC/@SID
type xs:string
properties isRef 0
use required
annotation documentation
The system ID
attribute BFQC/@OP
properties isRef 0
use required
annotation documentation
Operator
attribute BFQC/@ADT
type xs:string
properties isRef 0
use required
annotation documentation
Analysis DateTime with time zone info (YYYY-MM-DD HH:MM:SStz, where an example
of tz is "-8:00" for Pacific time)
attribute BFQC/@ADTS
type xs:string
properties isRef 0
use required
annotation documentation
Analysis DateTime String
attribute BFQC/@RDT
type xs:string
properties isRef 0
use required
annotation documentation
Report DateTime with time zone info (YYYY-MM-DD HH:MM:SStz, where an example of
tz is "-8:00" for Pacific time)
attribute BFQC/@RDTS
type xs:string
properties isRef 0
use required
annotation documentation
Report DateTime String
attribute BFQC/@LOT
type xs:string
properties isRef 0
use required
annotation documentation
Control lot
attribute BFQC/@EXPIR
type xs:string
properties isRef 0
use required
annotation documentation
Lot expiration
attribute BFQC/@PRODID
type xs:string
properties isRef 0
use required
annotation documentation
Product ID of the control
attribute BFQC/@RBCMEAN
type xs:integer
properties isRef 0
use required
annotation documentation
Mean RBC value
attribute BFQC/@NUCMEAN
type xs:integer
properties isRef 0
use required
annotation documentation
Mean nucleated value
attribute BFQC/@RP
type xs:integer
properties isRef 0
use optional
annotation documentation
Rack position (tube number in the rack)
attribute BFQC/@SQN
type xs:integer
properties isRef 0
use optional
annotation documentation
Sequence Number
attribute BFQC/@RSQN
type xs:integer
properties isRef 0
use optional
annotation documentation
Rack Sequence Number (rack ID)
element BFQC/PF
diagram
type xs:string
properties isRef 0
minOcc 0
maxOcc unbounded
content simple
element BFQC/RBCMIN
diagram
type xs:integer
properties isRef 0
content simple
annotation documentation
Minimum RBC to pass
element BFQC/RBCMAX
diagram
type xs:integer
properties isRef 0
content simple
annotation documentation
Maximum RBC to pass
element BFQC/RBCCOUNT
diagram
type xs:integer
properties isRef 0
content simple
annotation documentation
Actual RBC count
element BFQC/NUCMIN
diagram
type xs:integer
properties isRef 0
content simple
annotation documentation
Minimum NUC to pass
element BFQC/NUCMAX
diagram
type xs:integer
properties isRef 0
content simple
annotation documentation
Maximum NUC to pass
element BFQC/NUCCOUNT
diagram
type xs:integer
properties isRef 0
content simple
annotation documentation
Actual NUC count
element BFQC/STATUS
diagram
properties isRef 0
content simple
facets Kind Value annotation
enumeration P
enumeration F
annotation documentation
Pass (P) or Fail (F)
element BFQC/REF
diagram
type xs:double
properties isRef 0
content simple
annotation documentation
Run Equivalency Factor
element BFQC/CM
diagram
type xs:string
properties isRef 0
minOcc 0
maxOcc 1
content simple
annotation documentation
Operator comment
APPENDIX A
Additional Tables
The following table lists the Test Identifiers/Upload codes (in the Test column) for all tests that
correspond to each Simple Panel that makes up the Predefined Panel listed in
Table A.1, Predefined Panel Identifiers
Panel Specimen
Type Tests Description
UA Chemistry Urine BLD Blood
BIL Bilirubin
URO Urobilinogen
KET Ketone
GLU Glucose
PRO Protein
NIT Nitrite
LEU Leukocytes
PH pH
SG Specific Gravity
COL Color
CLA Clarity
ASA Ascorbic Acid
Table A.1 Test Identifiers/Upload codes (Continued)
Panel Specimen
Type Tests Description
UA Microscopy Urine ART Artifact
RBC Red Blood Cell
BLD = Blood; BIL = Bilirubin; URO = Urobilinogen;
DRBC Dysmorphic
KET Red Blood
= Ketone; GLU Cell= Glucose; PRO = Protein;
WBC NIT
White = Nitrite; LEU = Leukocytes; PH = pH;
Blood Cell
SG = Specific Gravity; COL = Color; CLA = Clarity
WBCC White Blood Cell Clump
ASA = Ascorbic Acid
BACT Bacteria
BYST Budding Yeast
HYST Hyphae Yeast
SQEP Squamous Epithelial
TREP Transitional Epithelial
REEP Renal Epithelial
OVFB Oval Fat Body
FAT Fat
MUCS Mucous
RBCC Red Blood Cell Clump
SPRM Sperm
TRCH Trichomonas
NSE Non-Squamous Epithelial
UNCC Unclassified Cast
HYAL Hyaline Cast
EPIC Epithelial Cast
WBCT White Blood Cell Cast
RBCT Red Blood Cell Cast
GRAN Granular Cast
CELL Cellular Cast
BROAD Broad Cast
FATC Fatty Cast
WAXY Waxy Cast
UNCX Unclassified Crystal
TPO4 Triple Phosphate Crystal
CAOX Calcium Oxalate
CAPH Calcium Phosphate Crystal
CACB Calcium Carbonate
URIC Uric Acid Crystal
LEUC Leucine Crystal
CYST Cystine Crystal
TYRO Tyrosine Crystal
AMOR Amorphous Crystal
UNCL Unclassified
ASP All Small Particle
Body Fluid Cerebrospinal RBC Red Blood Cells
Fluid
NUCL Nucleated Cells
Pleural Fluid
Peritoneal UNCX Crystal
dialysate BACT Bacteria
Peritoneal
lavage
Pericardial
Fluid
Serious Fluid
Synovial Fluid
LOINC Codes
Sample Messages
The following are examples of messages transmitted between the System Manager and
the laboratory information system.
Verification Example
Communication:
<stx>13C004900520049005300500069006E0067002F003E000D000A00<etx>C4<cr><lf>
Data: <IRISPing/><cr><lf>
<stx>13C005300490051003E0037003000370031003000390030003100380037003C002F0053004900
51003E000D000A00<etx>89<cr><lf>
Data: <<SIQ>7071090187</SIQ><cr><lf>
Specimen Information Response Example
Data:
<?xml version="1.0"?><SI BF="URN" WO="run">7071090187<DEMOG LName="DOE"
FName="JOHN" MName="" DOB="1933-04-05" Loc="TESTING" RecNum="257314" Gender="M"
/></SI>
Data:
<UNKID>1529934</UNKID>
Data:
Glossary
This glossary is a collection of specialized terms and their meanings that are either used in
this manual or related to the information in it. If a term has more than one meaning, all
meanings relevant to this manual are included.
<ACK>
Acknowledgment
[C1]
The most significant character of Checksum
[C2]
The least significant character of Checksum
<CR>
Carriage Return
[DATA]
The data contents of the record
<ENQ>
Inquire
<EOT>
End of Transmission
<ETB>
End of Transmission Block. For use only when a single record is too large to fit into one
frame.
<ETX>
End of Text. Required at the end of each record.
Frame
A subdivision of a message, used to allow periodic communication housekeeping such as error
checks and acknowledgement
[frame number]
Single digit frame number 0 to 7. Starts with 1.
<LF>
Line feed
<NAK>
Negative Acknowledgment
<STX>
Start of Frame
Analyzer
iQ200 Automated Urinalysis Series, iRICELL Automated Urinalysis workcells, iChemVelocity
analyzer
ASTM
The American Society for Testing and Materials
ASCII
American Standard Code for Information Interchange
XML
Extensible Markup Language
Unicode
Unicode is a standard for the consistent encoding, representation, and handling of text
expressed in most of the world's writing systems.
Communications Packet
All framing required for transmission of data. This framing includes:
<STX>[frame number][DATA] [<ETB> or <ETX>][C1][C2] <LF>.
Component Field
A single data element or data elements that express a finer aggregate or extension of data
elements which precede it. Components cannot contain repeat fields.
LIS
Laboratory Information System. (Laboratory computer)
Download
The transmission of data from the LIS to the analyzer workstation
WO
Work Order
Upload
The transmission of data from the Instrument to the LIS