SUITPlus Protocol Description v4.0
SUITPlus Protocol Description v4.0
SUITPlus Protocol Description v4.0
Version History
Version Date Author Comment
1.0 21-12-2011 Olivier Released version
Kaulmann
2.0 22-05-2012 Olivier 1. Adaptation of the chapter 1: Introduction
Kaulmann
2. Adaptation of the chapter 2.1.5: Restricted message codes:
Deletion of "ETB" from the table "Restricted message codes".
SUITplus is not limited on the string length. "ETB" is not use with
SUITplus.
1 Introduction....................................................................7
4 Appendixes ..................................................................29
4.1 Appendix A: Information concerning the graphic-files management ..... 29
4.2 Appendix B: Examples of Logfiles ......................................................... 30
4.2.1 Query from Extended IPU to LIS: .......................................................... 30
4.2.2 Order from LIS to Extended IPU when order exists: ............................. 30
4.2.3 Reply from LIS to Extended IPU when no order exists: ........................ 30
4.2.4 Result from Extended IPU to LIS with graph info .................................. 31
4.2.5 Quality Control log files.......................................................................... 34
4.3 Appendix C: Host codes ........................................................................ 38
4.3.1 Haematology discipline.......................................................................... 38
4.3.1.1 Diagnostic parameter ................................................................ 38
4.3.1.2 Research parameter.................................................................. 40
4.3.1.3 Services parameter ................................................................... 43
June 2014 - Version 4.0
1 Introduction
This document describes the Communication Specifications of
the enhanced Sysmex Universal Interface SUITplus.
3 Note:
SUITplus supports a 1-Line or a 2-Line connection to LIS.
When using a 1-Line connection the orders, results and
queries will be done on the same channel.
When using a 2-Line connection the orders and queries
will be done at one channel, the results will be sent at the
other channel. Generally a 2-Line connection is preferred.
When doing queries to LIS a 2-Line connection it is even
mandatory.
2 SUIT Interface
[NAK] 2. [NAK] 2.
3.
10 sec.
…
4. [ENQ]
June 2014 - Version 4.0
2. [ENQ] [ENQ] 2.
3 Note:
LIS should act as slave. A change of these roles has to be
agreed between the deployment staff of Sysmex and LIS.
S: [ENQ]
R: [ACK]
S: [EOT]
June 2014 - Version 4.0
2.1.4 Timeouts
2.2 Protocol
2.2.1 Orders
SUITplus supports two modes for getting the order by LIS:
1. LIS send the order automatically to Extended IPU when its
registered in LIS
2. LIS send the order to Extended IPU after a query was done
LIS has to support both modes and switching between these
modes has to be possible. This flexibility is needed because
the use of the modes depends on the analyzer the customer
uses and can be changed by modifying the configuration in the
laboratory.
When sending the orders to Extended IPU you can either send
the codes for each parameter to Extended IPU or the codes for
profiles. Refer to chapter Appendix C: Host codes, page 38 to
implement the same codes at your site.
When sending orders for body fluids to Extended IPU it is
mandatory to fill the field collection source (OBR-16,
subfield 2).
Refer to table "Table Codes for Body Fluids" for using the
correct collection source code.
A log file example is currently under construction.
One sample number cannot include orders for different
sections like haematology, coagulation or urine analysis.
Each section needs its own order and its unique sample
number
The logic order of records for sending orders to Extended IPU
is like this. This structure is independent if we operate in query-
mode or download-mode
SUITplus Com. Direction HOST
ENQ
ACK
H: Header Record
ACK
P: Patient Record
Repeat
ACK as many
C: Patient Comment Record times as
ACK the No. of
OBR: Order Record patients
ACK
C: Order Comment Record
June 2014 - Version 4.0
ACK
L: End Mark Record
ACK
EOT
2.2.2 Results
ENQ
ACK
H: Header Record
ACK
P: Patient Record
Repeat as ACK
many times C: Patient Comment Record
as the No.
ACK
of samples
OBR: Order Record
ACK
C: Order Comment Record
ACK
OBX: Test Result Record
ACK
C: Result Comment Record
ACK
L: End Mark Record
ACK
EOT
3 Note:
The different comment records are set at the following
position:
– the Patient Comment Record in the Patient Free Comment
– Order Comment Record in the Order Free Comment
– Sample Comments, IP Messages (incl. Rule Messages)
and Graphic Data information (File Name) in the Result
Comment Record.
Analyser graphics can be downloaded via shared folder
(optional) Details about this are described at chapter "4.1
Appendix A: Information concerning the graphic-files
management".
June 2014 - Version 4.0
3 Message Format
3 Note:
Mandatory Fields described in Bold Text
Field HOST HOST
Field Field
Field Description Length to from
Code Name
(bytes) SUIT SUIT
H H-1 Segment “H” fixed
1 Y Y
type ID
^~\& H-2 Delimiter Definition of Separators
definition | : Field Separator (7Ch)
^ : Component Separator (5Eh)
~: Repeat Symbol (7Eh) 5 Y Y
\: Escape Symbol (5Ch)
&:Sub-component Separator (26h)
- “\” and “&” Not used.
H-3 Not in use
- - -
H-12
VER H-13 Version Regulated Version Number
“SUITplus1.0” Fixed (ASTM E1238- 20 Y Y
94)
DT H-14 Date and Message Created Date/Time
time of Format:YYYYMMDDHHMM 12 Y Y
message
Mandatory Fields: H-1, H-2, H-13, H-14
June 2014 - Version 4.0
3 Note:
Mandatory Fields described in Bold Text
Field HOST HOST
Field
Field Field Name Description Length to from
Code
(bytes) SUIT SUIT
P P-1 Segment “P” Fixed.
1 Y Y
type ID
SEQ P-2 Trans- Sequence Number.
mission Sequential from “1” and increase
4 Y Y
sequence by one per patient.
number
PID P-3 Practice Patient ID.
assigned 100 Y Y
patient ID
P-4 Not in use - -
APID P-5 Alter-native Alternative ID.
100 Y Y
patient ID Use as Public Insurance ID.
NAME P-6 Patient name Patient Name FN^LN
FN : First Name 100 Y Y
LN : Last Name
MN P-7 Mother's Mother’s Maiden Name
Maiden 100 Y Y
name
B/D P-8 Birth Date Date of Birth
8 Y Y
Format: YYYYMMDD
SEX P-9 Patient sex Gender
M: Male, 1 Y Y
F: Female,
U: Unknown
P-10 Not in use
- - -
P-16
HT P-17 Patient Height:
height cm (w/ decimals) 6 Y Y
or
June 2014 - Version 4.0
feet^inch
3 Note:
Mandatory Fields described in Bold Text
Field HOST HOST
Field
Field Field Name Description Length to from
Code
(bytes) SUIT SUIT
OBR OBR-1 Segment type ID “OBR” Fixed. 3 Y Y
SEQ OBR-2 Sequence number Sequence Number
Sequential per OBR record in 4 Y Y
the Patient segment
ONO OBR-3 Requester Sample No. (Barcode No.)*
specimen ID or (HOST side) 100 Y N
accession number
SNO OBR-4 Producer Sample No. (Barcode No.)*
specimen ID or (SUIT side) 100 N Y
accession number
TESTID OBR-5 Observation Test Item
battery ID Code^Name
When ordering multiple orders,
use the Repeat character, “~”, 2000 Y Y
to proceed as below:
Code1^Name1~Code2^Name2
~Code3^Name3 ~ …
PRI OBR-6 Priority Processing Priority Level:
1 Y Y
S: STAT / Urgent
OBR-7 Requested date- Not in use
- -
time
CLDT OBR-8 Specimen Sample Collection Date/Time
collection or Format:YYYYMMDDHHMM
12 Y Y
observation date-
time
OBR-9 observation end- Not in use
- -
time
CVLM OBR-10 Collection volume Collection Volume (Urine etc.):
5 Y Y
Unit ml
OBR-11 CollectorID Not in use - -
June 2014 - Version 4.0
3
June 2014 - Version 4.0
Note:
Mandatory Fields: OBR-1, OBR-2, OBR-3, OBR-5, OBR-12,
OBR-15.
3 Note:
OBR-16 is mandatory for Bodyfluids
Table Codes for Body fluids
10^&~tel^1
~
ReagentCode^LotNo^SerialNo
OBX-11 Not in use - -
ORST OBX-12 Observation Test Result Status
result status ^ Latest Operation
Test Result Status:
P: Preliminary Report
F: Final Result
I: Pending
22
C: Revision Report N Y
(1^20)
Latest Operation:
Edit : input or edit
Validate : manual validate
Count : count at pad menu
Manual Send : send manually
June 2014 - Version 4.0
(N/A) : others
16 is empty
Analytical Mode:
METH S-3 20 N Y
Method “Manual” or “Closed”
S-14
- Not in use - -
S-15
Analysis
Measurement Date/Time
DT S-16 Date and 12 N Y
YYYYMMDDHHMM
time
June 2014 - Version 4.0
3 Note:
Mandatory Fields described in Bold Text
Appendixes
4 Appendixes
Example:
S:STX]6C|6||PNG&R&20110808&R&2011_08_08_11_02_2a
361165-10b7-496a-b4ce-
dc8a373b6f89_PLT.PNG[0Dh][ETX]55[0Dh][0Ah]
Refer log file example at chapter "4.2.4 Result from Extended
IPU to LIS with graph info".
Number^100125^02|Support[0Dh][ETX]65[0Dh][0Ah]
01-10-2012 10:14:09 606 : S: [ACK]
01-10-2012 10:14:09 626 : R: [STX]1OBX|4|NM|MCH^MCH|D|30.0^|pg|27.0-
33.5||||F^Validate|201210011014|||XN-20^Serial Number^100125^02|Support[0Dh][ETX]99[0Dh][0Ah]
R: [ACK]
Method 2:
Another method consists that the user will send the quality by
using the QC-Charts of the analyzer. In this case the file
number of the charts will be used as sample number.
E.g.: 11 for the file no. 11
S: [ENQ]
R: [ACK]
S: [STX]1H|^~\&| | | | | | | | | | |A.2|200506271532[CR][ETX]35[CR][LF]
R: [ACK]
S: [STX]2S|1|Manual|A2424| | | QC| | | | 11|WBC|2.27| | | 20050627153207|[CR][ETX]54[CR][LF]
R: [ACK]
S: [STX]3S|2|Manual|A2424| | | QC| | | | 11|RBC|2.30| | | 20050627153207|[CR][ETX]4B[CR][LF]
R: [ACK]
S: [STX]4S|3|Manual|A2424| | | QC| | | | 11|HGB|6.0| | | 20050627153207|[CR][ETX]18[CR][LF]
R: [ACK]
S: [STX]5S|4|Manual|A2424| | | QC| | | | 11|HCT|17.6| | | 20050627153207|[CR][ETX]60[CR][LF]
R: [ACK]
S: [STX]6S|5|Manual|A2424| | | QC| | | | 11|MCV|76.5| | | 20050627153207|[CR][ETX]6D[CR][LF]
R: [ACK]
S: [STX]7S|6|Manual|A2424| | | QC| | | | 11|MCH|26.1| | | 20050627153207|[CR][ETX]58[CR][LF]
R: [ACK]
S: [STX]0S|7|Manual|A2424| | | QC| | | | 11|MCHC|34.1| | | 20050627153207|[CR][ETX]94[CR][LF]
R: [ACK]
S: [STX]1S|8|Manual|A2424| | | QC| | | | 11|PLT|54| | | 20050627153207|[CR][ETX]0E[CR][LF]
R: [ACK]
S: [STX]2S|9|Manual|A2424| | | QC| | | | 11|NEUT%|44.9| | | 20050627153207|[CR][ETX]E7[CR][LF]
R: [ACK]
S: [STX]3S|10|Manual|A2424| | | QC| | | | 11|LYMPH%|37.0| | | 20050627153207|[CR][ETX]57[CR][LF]
R: [ACK]
S: [STX]4S|11|Manual|A2424| | | QC| | | | 11|MONO%|10.6| | | 20050627153207|[CR][ETX]05[CR][LF]
R: [ACK]
S: [STX]5S|12|Manual|A2424| | | QC| | | | 11|EO%|7.5| | | 20050627153207|[CR][ETX]37[CR][LF]
R: [ACK]
S: [STX]6S|13|Manual|A2424| | | QC| | | | 11|BASO%|60.8| | | 20050627153207|[CR][ETX]FC[CR][LF]
R: [ACK]
S: [STX]7S|14|Manual|A2424| | | QC| | | | 11|NEUT#|1.02| | | 20050627153207|[CR][ETX]08[CR][LF]
R: [ACK]
S: [STX]0S|15|Manual|A2424| | | QC| | | | 11|LYMPH#|0.84| | | 20050627153207|[CR][ETX]59[CR][LF]
R: [ACK]
S: [STX]1S|16|Manual|A2424| | | QC| | | | 11|MONO#|0.24| | | 20050627153207|[CR][ETX]04[CR][LF]
R: [ACK]
S: [STX]2S|17|Manual|A2424| | | QC| | | | 11|EO#|0.17| | | 20050627153207|[CR][ETX]63[CR][LF]
R: [ACK]
S: [STX]3S|18|Manual|A2424| | | QC| | | | 11|BASO#|1.38| | | 20050627153207|[CR][ETX]FA[CR][LF]
R: [ACK]
S: [STX]4S|19|Manual|A2424| | | QC| | | | 11|IG%|10.1| | | 20050627153207|[CR][ETX]5F[CR][LF]
R: [ACK]
S: [STX]5S|20|Manual|A2424| | | QC| | | | 11|IG#|0.23| | | 20050627153207|[CR][ETX]59[CR][LF]
R: [ACK]
S: [STX]6S|21|Manual|A2424| | | QC| | | | 11|NRBC%|100.0| | | 20050627153207|[CR][ETX]1E[CR][LF]
R: [ACK]
S: [STX]7S|22|Manual|A2424| | | QC| | | | 11|NRBC#|2.38| | | 20050627153207|[CR][ETX]FA[CR][LF]
R: [ACK]
S: [STX]0S|23|Manual|A2424| | | QC| | | | 11|RDW-SD|42.7| | | 20050627153207|[CR][ETX]5D[CR][LF]
June 2014 - Version 4.0
R: [ACK]
S: [STX]1S|24|Manual|A2424| | | QC| | | | 11|RDW-CV|15.3| | | 20050627153207|[CR][ETX]5D[CR][LF]
R: [ACK]
S: [STX]2S|25|Manual|A2424| | | QC| | | | 11|PDW|9.1| | | 20050627153207|[CR][ETX]68[CR][LF]
R: [ACK]
S: [STX]3S|26|Manual|A2424| | | QC| | | | 11|MPV|9.8| | | 20050627153207|[CR][ETX]79[CR][LF]
R: [ACK]
S: [STX]4S|27|Manual|A2424| | | QC| | | | 11|P-LCR|19.6| | | 20050627153207|[CR][ETX]15[CR][LF]
R: [ACK]
S: [STX]5S|28|Manual|A2424| | | QC| | | | 11|PCT|0.05| | | 20050627153207|[CR][ETX]95[CR][LF]
R: [ACK]
S: [STX]6S|29|Manual|A2424| | | QC| | | | 11|RET%|6.92| | | 20050627153207|[CR][ETX]CC[CR][LF]
R: [ACK]
RS: [STX]7S|30|Manual|A2424| | | QC| | | | 11|RET#|0.1592| | | 20050627153207|[CR][ETX]23[CR][LF]
R: [ACK]
S: [STX]0S|31|Manual|A2424| | | QC| | | | 11|IRF|36.6| | | 20050627153207|[CR][ETX]8E[CR][LF]
R: [ACK]
S: [STX]1S|32|Manual|A2424| | | QC| | | | 11|LFR|63.4| | | 20050627153207|[CR][ETX]91[CR][LF]
R: [ACK]
S: [STX]2S|33|Manual|A2424| | | QC| | | | 11|MFR|29.7| | | 20050627153207|[CR][ETX]99[CR][LF]
R: [ACK]
S: [STX]3S|34|Manual|A2424| | | QC| | | | 11|HFR|6.9| | | 20050627153207|[CR][ETX]63[CR][LF]
R: [ACK]
S: [STX]4S|35|Manual|A2424| | | QC| | | | 11|RET-HE|20.7| | | 20050627153207|[CR][ETX]54[CR][LF]
R: [ACK]
S: [STX]5S|36|Manual|A2424| | | QC| | | | 11|IPF|22.2| | | 20050627153207|[CR][ETX]8D[CR][LF]
R: [ACK]
S: [STX]6S|37|Manual|A2424| | | QC| | | | 11|BASO-X|112.4| | | 20050627153207|[CR][ETX]8C[CR][LF]
R: [ACK]
S: [STX]7S|38|Manual|A2424| | | QC| | | | 11|BASO-Y|123.6| | | 20050627153207|[CR][ETX]93[CR][LF]
R: [ACK]
S: [STX]0S|39|Manual|A2424| | | QC| | | | 11|DIFF-X|152.8| | | 20050627153207|[CR][ETX]84[CR][LF]
R: [ACK]
S: [STX]1S|40|Manual|A2424| | | QC| | | | 11|DIFF-Y|62.5| | | 20050627153207|[CR][ETX]4B[CR][LF]
R: [ACK]
S: [STX]2S|41|Manual|A2424| | | QC| | | | 11|NRBC-X|197.5| | | 20050627153207|[CR][ETX]91[CR][LF]
R: [ACK]
S: [STX]3S|42|Manual|A2424| | | QC| | | | 11|NRBC-Y|131.7| | | 20050627153207|[CR][ETX]8A[CR][LF]
R: [ACK]
S: [STX]4S|43|Manual|A2424| | | QC| | | | 11|IMI#|1182| | | 20050627153207|[CR][ETX]B5[CR][LF]
R: [ACK]
S: [STX]5S|44|Manual|A2424| | | QC| | | | 11|IMI-DC|503.9| | | 20050627153207|[CR][ETX]7B[CR][LF]
R: [ACK]
S: [STX]6S|45|Manual|A2424| | | QC| | | | 11|IMI-RF|164.1| | | 20050627153207|[CR][ETX]89[CR][LF]
R: [ACK]
S: [STX]7S|46|Manual|A2424| | | QC| | | | 11|RBC-O|2.21| | | 20050627153207|[CR][ETX]03[CR][LF]
R: [ACK]
S: [STX]0S|47|Manual|A2424| | | QC| | | | 11|PLT-O|66| | | 20050627153207|[CR][ETX]BF[CR][LF]
R: [ACK]
S: [STX]1S|48|Manual|A2424| | | QC| | | | 11|RBC-Y|152.5| | | 20050627153207|[CR][ETX]41[CR][LF]
...
June 2014 - Version 4.0
PLT-I
TC-PMN%
TC-MN%
TC-EO%
TC-HF
TC-HF%
3 Note:
Please check with your Sysmex representative for the
used parameters at the respective installation.
WPC-FL-H2#
3 Note:
Please check with your Sysmex representative for the
June 2014 - Version 4.0
R_USRRBC2 USER_RBC 2
R_USRRBC3 USER_RBC 3
R_USRRBC4 USER_RBC 4
R_USRRBC5 USER_RBC 5
3 Note:
Please check with your Sysmex representative for the
used parameters at the respective installation.
June 2014 - Version 4.0
3 Note:
Please check with your Sysmex representative for the
used parameters at the respective installation.
3 Note:
Please check with your Sysmex representative for the
used parameters at the respective installation.
June 2014 - Version 4.0
Due to the fact that that the profile codes as well as the related
test names from the coagulation analyzers are customizable
we recommend you to contact the site where the analyzer will
be installed for the exact test codes and test names.
However please find below a table with the different test code
and test name which are the default manufacturer settings.
As mention these codes can be customized
3 Note:
Please check with your Sysmex representative for the
used parameters at the respective installation.
June 2014 - Version 4.0
XN-Series
UF-1000i\
XE-2100D
XE-2100L
XS-1000i/
XT-2000i
XT-4000i
Flagname
XE-2100
XE-5000
XT1800i
XS-800i
UF500i
(IP messages)
WBC_Abn_Scattergram
NRBC_Abn_Scattergram
Neutropenia
Neutrophilia
Lymphopenia
Lymphocytosis
Leukocytopenia
Leukocytosis
Monocytosis
Eosinophilia
Basophilia
NRBC_Present
IG_Present
RBC_Abn_Distribution
Dimorphic_Population
Anisocytosis
Microcytosis
Macrocytosis
Hypochromia
Anemia
Erythrocytosis
RET_Abn_Scattergram
Reticulocytosis
PLT_Abn_Scattergram
PLT_Abn_Distribution
Thrombocytopenia
Thrombocytosis
Blasts?
Immature_Gran?
NRBC?
Left_Shift?
Atypical_Lympho?
June 2014 - Version 4.0
RBC_Lyse_Resistance?
Abn_Lympho/L-Blasts?
Abn_Lympho/Blasts?
Blasts/Abn_Lympho?
XN-Series
UF-1000i\
XE-2100D
XE-2100L
XS-1000i/
XT-2000i
XT-4000i
Flagname
XE-2100
XE-5000
XT1800i
XS-800i
UF500i
(IP messages)
Abn_Lympho?
RBC_Agglutination?
Turbidity/HGB_Interference?
Iron_Deficiency?
HGB_Defect?
Fragments?
PLT_Clumps?
PLT_Clumps(S)?
Debris high
Discriminator error RBC/XTAL
Discriminator error RBC/BACT
Discriminator error RBC/YLC
Urine conductivity abnormal
Carry-over?
1
Only available with the IG Master software
XN-Series
UF-1000i\
XE-2100D
XE-2100L
XS-1000i/
XT-2000i
XT-4000i
XE-2100
XE-5000
XT1800i
XS-800i
Flagname
UF500i
ACTION_MESSAGE_RET
ACTION_MESSAGE_NRBC
ACTION_MESSAGE_Delta
ACTION_MESSAGE_DIFF
Positive_Diff
Positive_Morph
Positive_Count
Error_Func
Error_Result
ACTION_MESSAGE_WBC
ACTION_MESSAGE_RBC
ACTION_MESSAGE_Delta_WBC
ACTION_MESSAGE_Delta_HGB
ACTION_MESSAGE_Delta_MCV
ACTION_MESSAGE_Delta_PLT
June 2014 - Version 4.0
ACTION_MESSAGE_Sample_Mixing
_Failure?
a. H-13: version
1H|^~\&|||||||||||SUITplus1.0|201201171613
a. OBX-16: ProducersID
2OBX|1|NM|WBC^WBC|D|6.10^|10*3/µl|9.90-
28.20||||F^|201201171614|||XN-20^A1000^100125^02|
2OBX|1|NM|WBC^WBC|D|6.10^|10*3/µl|9.90-
28.20||||F^|201201171614|||XN-20^A1000^100125^02|
d. OBX-6: Result-Comment
Mutiple result comment management:
5OBX|3|NM|HGB^HGB|D|15.1^&~T|g/dL|14.2-21.7||||
F^Validate|201201171630|||XN-
20^A1000^100125^02|Distributor
e. OBX-10: Reagent Information
2OBX|1|NM|WBC^WBC|D|6.10^|10*3/µl|9.90-28.20||
NR^Z1234^A1000~WN^Z1234^A1000||F^|20120117163
7|||XN-20^A1000^100125^02|
Description
NR ReagentCode
Z1234 LotNo
A1000 SerialNo
WBC
June 2014 - Version 4.0
RULE
6. “ETB”
SUITplus has no limitation in the string length. SUITplus does
not generate an [ETB] after 240 characters. SUITplus do not
uses "ETB"
5OBR|1||10000000|WBC^WBC~RBC^RBC~HGB^HGB~
HCT^HCT~MCV^MCV~MCH^MCH~MCHC^MCHC~PLT
^PLT~RDW-CV^RDW-CV~RDW-SD^RDW-
SD~MPV^MPV~P-LCR^P-
LCR~PDW^PDW~PCT^PCT~NEUT#^NEUT#~LYMPH#^
LYMPH#~MONO#^MONO#~EO#^EO#~BASO#^BASO#
~IG#^IG#~HFLC#^HFLC#~NEUT%^NEUT%~LYMPH%^
LYMPH%~MONO%^MONO%~EO%^EO%~BASO%^BA
SO%~IG%^IG%~HFLC%^HFLC%~NRBC#^NRBC#~NR
BC%^NRBC%~RET#^RET#~RET%^RET%~IRF^IRF~H
FR^HFR~LFR^LFR~MFR^MFR~RET-HE^RET-
HE~MICROR^MicroR~IPF^IPF~RPI^RPI~H-IPF^H-
IPF|S||201201020951||||||||^COLL|DOCTOR^Doctor
Name|555555|CLINIC^|WARD^|||201201020951||001|||X
N