IQ200 Family Protocol 300-4941JB
IQ200 Family Protocol 300-4941JB
IQ200 Family Protocol 300-4941JB
PN 300-4941JB
February 2020
Original Instructions
Revision History
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 Web
site. For labeling updates, go to www.beckmancoulter.com and download the latest version of the manual
or system help for your instrument.
PN 300-4941JB iii
Revision History
iv PN 300-4941JB
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 manufacturer’s 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).
PN 300-4941JB v
Safety Notice
Alerts for Warning and Caution
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 system’s 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.
vi PN 300-4941JB
Contents
Introduction, xv
Purpose, xv
Standards/Protocols, xv
vii
Contents
Glossary
Related Documents
viii
Illustrations
Illustrations
ix
Tables
Tables
x
Tables
xi
Tables
xii
Tables
xiii
Tables
xiv
Introduction
Purpose
The Laboratory Information System (LIS) feature of the iQ200 Automated Urinalysis System,
iRICELL Series, iChemVELOCITY, iQ Workcell, and iWARE Software allows an external laboratory
computer to communicate with the System Manager through a serial connection.
The iQ200 Automated Urinalysis System, iRICELL Series, iChemVELOCITY, iQ Workcell, and 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 Transfer Protocol which consists of two parts:
· Physical Layer (see ASTM Physical Layer in CHAPTER 1, ASTM: Low-Level Protocol).
· Data Link Layer (see Data Link Layer in CHAPTER 1, ASTM: Low-Level Protocol).
• Iris-defined XML
— Message Content (see Message Content in CHAPTER 2, Iris-defined XML: High-Level
Protocol) which contains the specifications for each of the records that are used to pass
information between the instrument and the laboratory computer.
Standards/Protocols
• The iRICELL Series with System Manager Software facilitates the connection of the iQ200
microscopy analyzer and the iChemVELOCITY a workcell configuration.
• The iQ Workcell Series with System Manager Software facilitates the connection of the iQ200
microscopy analyzer and the ARKRAY Aution Max AX-4030 as a workcell configuration.
• The iQ200 Automated Urinalysis System, iRICELL Series, iChemVELOCITY, and iQ Workcell can
be interfaced over Serial connection only.
• The iQ200 Automated Urinalysis System, iRICELL Series, iChemVELOCITY, and iQ Workcell do
not have the capability for TCP/IP nor remote access.
PN 300-4941JB xv
Introduction
Standards/Protocols
xvi PN 300-4941JB
CHAPTER 1
ASTM: Low-Level Protocol
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.
Protocol: EIA-232-D
Pin Instrument LIS Port Configuration Laboratory Computer Cable Must Be Provided
Provided on DB-9 Male on 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.
PN 300-4941JB 1-1
ASTM: Low-Level Protocol
Data Link Layer
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-2 PN 300-4941JB
ASTM: Low-Level Protocol
Data Link Layer 1
*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 the 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.
Acknowledgments
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
PN 300-4941JB 1-3
ASTM: Low-Level Protocol
Data Link Layer
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.
1-4 PN 300-4941JB
ASTM: Low-Level Protocol
Data Link Layer 1
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>.
PN 300-4941JB 1-5
ASTM: Low-Level Protocol
Data Link Layer
Expected
1-6 PN 300-4941JB
ASTM: Low-Level Protocol
Data Link Layer 1
PN 300-4941JB 1-7
ASTM: Low-Level Protocol
Data Link Layer
1-8 PN 300-4941JB
ASTM: Low-Level Protocol
Data Link Layer 1
PN 300-4941JB 1-9
ASTM: Low-Level Protocol
Data Link Layer
1-10 PN 300-4941JB
CHAPTER 2
Iris-defined XML: High-Level Protocol
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
Table 2.1 element IRISPing
Elements
SA
PN 300-4941JB 2-1
Iris-defined XML: High-Level Protocol
Message Content
Diagram
2-2 PN 300-4941JB
Iris-defined XML: High-Level Protocol
Message Content 2
PN 300-4941JB 2-3
Iris-defined XML: High-Level Protocol
Message Content
Type xs:string
Properties isRef: 0
Use: required
Annotation Documentation: Analysis DateTime String
Type xs:string
Properties isRef: 0
Use: required
Annotation Documentation: Report DateTime String
Type xs:integer
Properties isRef: 0
Use: required
Annotation Documentation: Rack position (tube number
in the rack)
Type xs:integer
Properties isRef: 0
Use: required
Annotation Documentation: Sequence Number
2-4 PN 300-4941JB
Iris-defined XML: High-Level Protocol
Message Content 2
Type xs:integer
Properties isRef: 0
Use: required
Annotation Documentation: Rack Sequence Number (rack
ID)
Type xs:integer
Properties isRef: 0
Use: required
Annotation Documentation: Dilution numerator
Type xs:integer
Properties isRef: 0
Use: required
Annotation Documentation: Dilution denominator
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)
Type xs:string
PN 300-4941JB 2-5
Iris-defined XML: High-Level Protocol
Message Content
Properties isRef: 0
Use: required
Annotation Documentation: Chemistry DateTime String
Type xs:string
Properties isRef: 0
Use: required
Annotation Documentation: Microscopy DateTime with the time zone info (YYYY-MM-DD
HH:MM:SStz, where an example of tz is “-8:00” for Pacific time)
Type xs:string
Properties isRef: 0
Use: required
Annotation Documentation: Microscopy DateTime String
Diagram
2-6 PN 300-4941JB
Iris-defined XML: High-Level Protocol
Message Content 2
Diagram
Properties isRef: 0
minOcc: 1
maxOcc: 2
Content: complex
Children AR
Annotation Documentation: Analysis Category
PN 300-4941JB 2-7
Iris-defined XML: High-Level Protocol
Message Content
Properties isRef: 0
Annotation Documentation: Chemistry dipstick lot
Diagram
Type xs:string
Properties isRef: 0
Use: required
Annotation Documentation: Mnemonic uniquely
identifying the analyte
2-8 PN 300-4941JB
Iris-defined XML: High-Level Protocol
Message Content 2
Type xs:string
Properties isRef: 0
Use: required
Annotation Documentation: Short Name
Type xs:string
Properties isRef: 0
Use: required
Annotation Documentation: Long Name
Type xs:string
Properties isRef: 0
Use: required
Annotation Documentation: Normal Range
Diagram
FLags
Type xs:string
Properties isRef: 0
minOcc: 0
maxOcc: 1
Content: simple
Annotation Documentation: FLags
PN 300-4941JB 2-9
Iris-defined XML: High-Level Protocol
Message Content
Diagram
Properties isRef: 0
minOcc: 0
maxOcc: 1
Content: complex
Children tag
Annotation Documentation: LIS Tags as generated by iWARE
Diagram
Properties isRef: 0
minOcc: 1
maxOcc: unbounded
Content: complex
Properties isRef: 0
Use: required
Annotation Documentation: Name of the rule
Properties isRef: 0
Use: required
Annotation Documentation: Rule output text
2-10 PN 300-4941JB
Iris-defined XML: High-Level Protocol
Message Content 2
Diagram
Properties isRef: 0
minOcc: 0
maxOcc: 1
Content: complex
Children reportTag
Annotation Documentation: Report Tags as generated by iWARE
Diagram
Properties isRef: 0
minOcc: 1
maxOcc: unbounded
Content: complex
PN 300-4941JB 2-11
Iris-defined XML: High-Level Protocol
Message Content
Properties isRef: 0
Use: required
Annotation Documentation: Name of the rule
Properties isRef: 0
Use: required
Annotation Documentation: Rule output text
Properties isRef: 0
Use: required
Annotation Documentation: Has the rule been modified since the specimen was tagged
(Yes/No)?
Diagram
Properties isRef: 0
minOcc: 0
maxOcc: 1
Content: complex
Children validationTag
Annotation Documentation: Validation Tags are generated by iWARE
2-12 PN 300-4941JB
Iris-defined XML: High-Level Protocol
Message Content 2
Diagram
Properties isRef: 0
minOcc: 1
maxOcc: unbounded
Content: complex
Properties isRef: 0
Use: required
Annotation Documentation: Name of the rule
Properties isRef: 0
Use: required
Annotation Documentation: Has the rule been modified
since the specimen was tagged (Yes/No)?
Diagram
Operator comment
Type xs:string
Properties isRef: 0
minOcc: 0
maxOcc: 1
Content: simple
Annotation Documentation: Operator comment
PN 300-4941JB 2-13
Iris-defined XML: High-Level Protocol
Message Content
Diagram
APR ReVision
Type xs: tring
Properties isRef: 0
Content: simple
Annotation Documentation: APR ReVision
Diagram
Properties isRef: 0
minOcc: 0
maxOcc: 1
Content: complex
Children SI
Annotation Documentation: Selected images
Diagram
Properties isRef: 0
minOcc: 1
maxOcc: unbounded
Content: complex
Annotation Documentation: Selected Image
2-14 PN 300-4941JB
Iris-defined XML: High-Level Protocol
Message Content 2
Properties isRef: 0
Use: required
Annotation Documentation: Location of image on the instrument
Properties isRef: 0
Use: required
Annotation Documentation: The long name of the classification of the image
Properties isRef: 0
Use: required
Annotation Documentation: Annotation from operator, may be blank
Diagram
Properties isRef: 0
minOcc: 0
maxOcc: 1
Content: complex
Children XE
Annotation Documentation: AUDit trail
PN 300-4941JB 2-15
Iris-defined XML: High-Level Protocol
Message Content
Diagram
Properties isRef: 0
minOcc: 1
maxOcc: unbounded
Content: complex
Children ED
Annotation Documentation: Acceptor Entry
Properties isRef: 0
Use: required
Annotation Documentation: Operator
Properties isRef: 0
Use: required
Annotation Documentation: date/time
2-16 PN 300-4941JB
Iris-defined XML: High-Level Protocol
Message Content 2
Properties isRef: 0
Annotation Documentation: Comment (if the operator changed it)
PN 300-4941JB 2-17
Iris-defined XML: High-Level Protocol
Message Content
Diagram
Properties isRef: 0
minOcc: 0
maxOcc: unbounded
Content: complex
Annotation Documentation: Edit Detail
Properties isRef: 0
Use: required
Annotation Documentation: Short Name of the analyte changed
Properties isRef: 0
Use: required
Annotation Documentation: Analyte result before the change
Properties isRef: 0
Use: required
Annotation Documentation: Analyte result after the change
2-18 PN 300-4941JB
Iris-defined XML: High-Level Protocol
Message Content 2
Diagram
Properties isRef: 0
Content: complex
Annotation Documentation: System Configuration
PN 300-4941JB 2-19
Iris-defined XML: High-Level Protocol
Message Content
Diagram
Signature Line
Properties isRef: 0
minOcc: 0
maxOcc: 1
Annotation Documentation: Signature Line
Elements
SIQ
Table 2.72 Element SIQ
Diagram
Elements
SI
2-20 PN 300-4941JB
Iris-defined XML: High-Level Protocol
Message Content 2
Diagram
PN 300-4941JB 2-21
Iris-defined XML: High-Level Protocol
Message Content
Diagram
Properties isRef: 0
minOcc: 0
maxOcc: 1
Content: complex
Children RC
Annotation Documentation: RawChems holding the raw chemistry values from the LIS Host
Diagram
2-22 PN 300-4941JB
Iris-defined XML: High-Level Protocol
Message Content 2
Properties isRef: 0
minOcc: 12
maxOcc: 13
Content: complex
Annotation Documentation: Individual chemistry result in the element text, 12 or 13 (ascorbic
is optional)
PN 300-4941JB 2-23
Iris-defined XML: High-Level Protocol
Message Content
Diagram
Properties isRef: 0
minOcc: 0
maxOcc: 1
Content: complex
Annotation Documentation: DEMOGraphics from the LIS Host
2-24 PN 300-4941JB
Iris-defined XML: High-Level Protocol
Message Content 2
PN 300-4941JB 2-25
Iris-defined XML: High-Level Protocol
Message Content
The LIS host responds to the instrument’s Specimen Information Query with the UNKID
message when the host does not recognize the supplied specimen identifier.
Elements
UNKID
Table 2.87 Element UNKID
Diagram
The LIS Host did not recognize the specimen ID (UNKnown ID); the unrecognized
ID is in the element text.
Type xs:string
Properties Content: simple
Annotation Documentation: The LIS Host did not recognize the specimen ID (UNKnown ID);
the unrecognized ID is in the element text
Elements
ChemQC
2-26 PN 300-4941JB
Iris-defined XML: High-Level Protocol
Message Content 2
Diagram
PN 300-4941JB 2-27
Iris-defined XML: High-Level Protocol
Message Content
Children PF QCR CM
Annotation Documentation: ChemistryQualityControl root element
Type xs:string
Properties isRef: 0
Use: required
Annotation Documentation: The control name, e.g., “CA”
Type xs:string
Properties isRef: 0
Use: required
Annotation Documentation: The system ID
Properties isRef: 0
Use: required
Annotation Documentation: Operator
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)
Type xs:string
Properties isRef: 0
Use: required
Annotation Documentation: Analysis DateTime String
Type xs:string
2-28 PN 300-4941JB
Iris-defined XML: High-Level Protocol
Message Content 2
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)
Type xs:string
Properties isRef: 0
Use: required
Annotation Documentation: Report DateTime String
Type xs:string
Properties isRef: 0
Use: required
Annotation Documentation: Control lot
Type xs:string
Properties isRef: 0
Use: required
Annotation Documentation: Lot expiration
Type xs:string
Properties isRef: 0
Use: required
Annotation Documentation: Dipstick lot ID
Type xs:string
Properties isRef: 0
Use: required
Annotation Documentation: Dipstick lot expiration
PN 300-4941JB 2-29
Iris-defined XML: High-Level Protocol
Message Content
Type xs:integer
Properties isRef: 0
Use: optional
Annotation Documentation: Rack position (tube number in
the rack)
Type xs:string
Properties isRef: 0
Use: required
Annotation Documentation: Pass (P) or Fail (F)
Diagram
Type xs:string
Properties isRef: 0
minOcc: 0
maxOcc: unbounded
Content: simple
Diagram
2-30 PN 300-4941JB
Iris-defined XML: High-Level Protocol
Message Content 2
Properties isRef: 0
minOcc: 1
maxOcc: unbounded
Content: complex
Annotation Documentation: QC Result
Type xs:string
Properties isRef: 0
Use: required
Annotation Documentation: Short Name of the analyte
Properties isRef: 0
Use: required
Annotation Documentation: Long Name of the analyte
Properties isRef: 0
Use: required
Annotation Documentation: Lower Limit
Properties isRef: 0
Use: required
Annotation Documentation: Upper Limit
PN 300-4941JB 2-31
Iris-defined XML: High-Level Protocol
Message Content
Properties isRef: 0
Use: optional
Annotation Documentation: Unit of measure (if not already in result)
Diagram
Operator comment
Type xs:string
Properties isRef: 0
minOcc: 0
maxOcc: 1
Content: simple
Annotation Documentation: Operator comment
Elements
CQC
2-32 PN 300-4941JB
Iris-defined XML: High-Level Protocol
Message Content 2
Diagram
PN 300-4941JB 2-33
Iris-defined XML: High-Level Protocol
Message Content
Type xs:string
Properties isRef: 0
Use: required
Annotation Documentation: The control ID
Type xs:string
Properties isRef: 0
Use: required
Annotation Documentation: The system ID
Properties isRef: 0
Use: required
Annotation Documentation: Operator
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)
2-34 PN 300-4941JB
Iris-defined XML: High-Level Protocol
Message Content 2
Type xs:string
Properties isRef: 0
Use: required
Annotation Documentation: Analysis DateTime String
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)
Type xs:string
Properties isRef: 0
Use: required
Annotation Documentation: Report DateTime String
Type xs:string
Properties isRef: 0
Use: required
Annotation Documentation: Control lot
Type xs:string
Properties isRef: 0
Use: required
Annotation Documentation: Lot expiration
Type xs:string
Properties isRef: 0
Use: required
Annotation Documentation: Product ID of the control
PN 300-4941JB 2-35
Iris-defined XML: High-Level Protocol
Message Content
Type xs:integer
Properties isRef: 0
Use: required
Annotation Documentation: Mean value
Type xs:integer
Properties isRef: 0
Use: optional
Annotation Documentation: Maximum negative count (the maximum count for a negative
control)
Type xs:integer
Properties isRef: 0
Use: optional
Annotation Documentation: Rack position (tube number in the rack)
Type xs:integer
Properties isRef: 0
Use: optional
Annotation Documentation: Sequence Number
Type xs:integer
Properties isRef: 0
Use: optional
Annotation Documentation: Rack Sequence Number (rack
ID)
Diagram
2-36 PN 300-4941JB
Iris-defined XML: High-Level Protocol
Message Content 2
Type xs:string
Properties isRef: 0
minOcc: 0
maxOcc: unbounded
Content: simple
Diagram
Minimum to pass
Type xs:integer
Properties isRef: 0
Content: simple
Annotation Documentation: Minimum to pass
Diagram
Maximum to pass
Type xs:integer
Properties isRef: 0
Content: simple
Annotation Documentation: Maximum to pass
Diagram
Actual count
Type xs:integer
Properties isRef: 0
Content: simple
Annotation Documentation: Actual count
PN 300-4941JB 2-37
Iris-defined XML: High-Level Protocol
Message Content
Diagram
Diagram
Diagram
Operator comment
Type xs:string
Properties isRef: 0
minOcc: 0
maxOcc: 1
Content: simple
Annotation Documentation: Operator comment
2-38 PN 300-4941JB
Iris-defined XML: High-Level Protocol
Message Content 2
Elements
BFQC
PN 300-4941JB 2-39
Iris-defined XML: High-Level Protocol
Message Content
Diagram
2-40 PN 300-4941JB
Iris-defined XML: High-Level Protocol
Message Content 2
Type xs:string
Properties isRef: 0
Use: required
Annotation Documentation: The control ID
Type xs:string
Properties isRef: 0
Use: required
Annotation Documentation: The system ID
Properties isRef: 0
Use: required
Annotation Documentation: Operator
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)
PN 300-4941JB 2-41
Iris-defined XML: High-Level Protocol
Message Content
Type xs:string
Properties isRef: 0
Use: required
Annotation Documentation: Analysis DateTime String
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)
Type xs:string
Properties isRef: 0
Use: required
Annotation Documentation: Report DateTime String
Type xs:string
Properties isRef: 0
Use: required
Annotation Documentation: Control lot
Type xs:string
Properties isRef: 0
Use: required
Annotation Documentation: Lot expiration
Type xs:string
Properties isRef: 0
Use: required
Annotation Documentation: Product ID of the control
2-42 PN 300-4941JB
Iris-defined XML: High-Level Protocol
Message Content 2
Type xs:integer
Properties isRef: 0
Use: required
Annotation Documentation: Mean RBC value
Type xs:integer
Properties isRef: 0
Use: required
Annotation Documentaion: Mean nucleated value
Type xs:integer
Properties isRef: 0
Use: optional
Annotation Documentation: Rack position (tube number
in the rack)
Type xs:integer
Properties isRef: 0
Use: optional
Annotation Documentation: Sequence Number
Type xs:integer
Properties isRef: 0
Use: optional
Annotation Documentation: Rack Sequence Number (rack
ID)
Diagram
PN 300-4941JB 2-43
Iris-defined XML: High-Level Protocol
Message Content
Type xs:string
Properties isRef: 0
minOcc: 0
maxOcc: unbounded
Content: simple
Diagram
Diagram
Diagram
2-44 PN 300-4941JB
Iris-defined XML: High-Level Protocol
Message Content 2
Diagram
Diagram
Diagram
Diagram
PN 300-4941JB 2-45
Iris-defined XML: High-Level Protocol
Message Content
Diagram
Diagram
Operator comment
Type xs:string
Properties isRef: 0
minOcc: 0
maxOcc: 1
Content: simple
Annotation Documentation: Operator comment
2-46 PN 300-4941JB
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,Test
Identifiers/Upload Codes.
PN 300-4941JB A-1
Additional Tables
A-2 PN 300-4941JB
Additional Tables
LOINC Codes A
LOINC Codes
PN 300-4941JB A-3
Additional Tables
LOINC Codes
A-4 PN 300-4941JB
Additional Tables
LOINC Codes A
Table A.3 iChemVELOCITY, AX-4280, AX-4030, and iChem100 Urine Chemistry Analyzers
PN 300-4941JB A-5
Additional Tables
LOINC Codes
Table A.3 iChemVELOCITY, AX-4280, AX-4030, and iChem100 Urine Chemistry Analyzers (Continued)
A-6 PN 300-4941JB
Additional Tables
LOINC Codes A
Table A.3 iChemVELOCITY, AX-4280, AX-4030, and iChem100 Urine Chemistry Analyzers (Continued)
PN 300-4941JB A-7
Additional Tables
LOINC Codes
A-8 PN 300-4941JB
APPENDIX B
Sample Messages
The communications consists of ASCII-encoded XML messages transmitted between the instrument
system manager and the laboratory information system (LIS) over an ASTM-E 1381-95 low-level
protocol.
Messages from the instrument fall into one of two categories: reports or queries. Reports are
informational, expecting no response from the LIS. Queries, however, expect a reply from the LIS.
The only time the host sends a message to the instrument is in reply to a query.
The messages are in Unicode and ASCII-encoded. ASCII encoding takes the hexadecimal
representation of each byte of the Unicode message and sends that representation in ASCII. For
example, “CAT” has a non-Unicode hexadecimal representation as 434154, which in Unicode is
430041005400, so it would be transmitted as “430041005400”.
The following are examples of messages transmitted between the System Manager and the
laboratory information system.
Verification Example
Communication:
<stx>13C004900520049005300500069006e0067002F003E00D00A00<ETX>C4<cr><lf>
Data: <IRISPing/><cr><lf>
Communication:
<stx>13C005300490051003E0037003000370031003000390030003100380037003C002F00530049005100
3E000D000A00<etx><89<cr><lf>
Data: <<SIQ>7071090187</SIQ><cr><lf>
Data:
PN 300-4941JB B-1
Sample Messages
Specimen Information Response for Unrecognized Specimen Identifier Example
Data:
<UNKID>1529934</UNKID>
B-2 PN 300-4941JB
Sample Messages
Specimen Analysis Report Example B
PN 300-4941JB B-3
Sample Messages
Chemistry Control Report Example
Data:
Data:
Data:
B-4 PN 300-4941JB
Sample Messages
Body Fluid Control Report Example B
PN 300-4941JB B-5
Sample Messages
Body Fluid Control Report Example
B-6 PN 300-4941JB
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.
ASTM — The American Society for Testing Frame — A subdivision of a message, used to
and Materials allow periodic communication
housekeeping, such as error checks and
ASCII — American Standard Code for acknowledgement.
Information Interchange
[frame number] — Single digit frame
[C1] — The most significant character of number "0" to "7." Starts with "1."
Checksum.
<LF> — Line Feed
[C2] — The least significant character of
Checksum. LIS — Laboratory Information System.
(Laboratory computer)
Communications Packet — All framing
required for transmission of data. This <NAK> — Negative Acknowledgment
framing includes:
<STX> — Start of Frame
<STX>[frame number][DATA] [<ETB> or
<ETX>][C1][C2]<LF>. Unicode — Unicode is a standard for the
consistent encoding, representation, and
Component Field — A single data element or handling of text expressed in most of the
data elements that express a finer aggregate world’s writing systems.
or extension of data elements which
precede it. Components cannot contain Upload — The transmission of data from the
repeat fields. Instrument to the LIS
[DATA] — The data contents of the record. XML — Extensible Markup Language
<ENQ> — Inquire
PN 300-4941JB Glossary-1
Glossary
Glossary-2 PN 300-4941JB
Related Documents
Your documentation can be found on our
website at www.beckmancoulter.com.
• System Overview
• Operation Principles
• Startup
• Quality Control
• Sample Analysis
• Data Review
• Manual Orders
• Shutdown
• Setup
• Troubleshooting
• Quality Assurance
• Cleaning Procedures
• Replacement/Adjustment Procedures
• iWARE Expert System
• iQ Body Fluids Module
• Auto-Release
• Appendices
• Abbreviations
• Glossary
• References
• Index
• Warranty
Host Transmission
PN 300-4941