Download as pdf or txt
Download as pdf or txt
You are on page 1of 11

SEIS_F18_FormatC2

Free18 C2 format description


Rev 03

1 OBJECT
This document describes the data format protocol.
The functionalities have to match the software specifications of the Free18 analyser.

2 APPROVAL AND HISTORY

Révision Date Auteur Raison et nature de la modification Approbation


01 27/01/16 V. HEANEY Document creation
02 28/04/17 S. HADDAB Correction of units index, change company logo
03 25/10/17 S.CLANET Update document with missing interpretive messages

3 DIFFUSION / MISE A DISPOSITION

4 TERMINOLOGY AND ABBREVIATIONS


LIS : laboratory informatic system, HOST system

5 REFERENCES

6 SYSTEM OVERVIEW
The Free 18 analyser may communicate with a LIS system. The essential part of these communications is
the results sending.

ModEIS rev02 Copyright© C2 diagnostics. All Rights Reserved. Page 1/11


SEIS_F18_FormatC2
Free18 C2 format description
Rev 03

1 OBJECT .............................................................................................................................................................................. 1
2 APPROVAL AND HISTORY ........................................................................................................................................... 1
3 DIFFUSION / MISE A DISPOSITION .................................................................................................................... 1
4 TERMINOLOGY AND ABBREVIATIONS .................................................................................................................. 1
5 REFERENCES .................................................................................................................................................................... 1
6 SYSTEM OVERVIEW ...................................................................................................................................................... 1
7 GENERAL SPECIFICATIONS ...................................................................................................................................... 3
7.1 GENERIC PRINCIPLES ....................................................................................................................................... 3
7.1.1 Unit...................................................................................................................................................................... 3
7.2 FRAMES .................................................................................................................................................................. 4
7.2.1 RESULT SENDING.......................................................................................................................................... 4
7.2.1.1 Analysis result sending .......................................................................................................................... 4
7.2.1.2 Alarms list ................................................................................................................................................ 6
7.2.1.3 WBC interpretive message ................................................................................................................... 6
7.2.1.4 RBC interpretive message .................................................................................................................... 6
7.2.1.5 PLT interpretive report ........................................................................................................................ 7
7.2.2 CALIBRATION ................................................................................................................................................. 7
7.2.2.1 Sending calibration report ................................................................................................................... 7
7.2.2.2 Result ........................................................................................................................................................ 8
7.2.3 QC ........................................................................................................................................................................ 9
7.2.3.1 Result ........................................................................................................................................................ 9
7.2.4 Repeatability ....................................................................................................................................................10
7.3 CONTROL SUM ....................................................................................................................................................10
7.3.1 Algorithmic .......................................................................................................................................................10
7.3.2 C language source example implementation ...............................................................................................10

ModEIS rev02 Copyright© C2 diagnostics. All Rights Reserved. Page 2/11


SEIS_F18_FormatC2
Free18 C2 format description
Rev 03

7 GENERAL SPECIFICATIONS
It is a specific format designed by C2 to transfer data to an external system.
To ease the use of these data, the chosen format is text oriented and is compatible with CSV format.
The identifiers have to be in English.

7.1 Generic principles


The Free 18 begins its frame with the following header:
F18 COUNT;W;X;;Y;[CR]

Where :
W is the Free instrument number (2 chars maximum).
X is the Free serial number (13 chars).
Y is the user login, UTF8 coded.

The decimal separator is the dot.


The fields separator is the semicolon.
The lines separator and the end of frame indicator are the carriage return.
The atomic frames are :
• Results sending request with results sending
• Sending of calibration packet with calibration results
All the frames lines have to be emitted ( if there is no information, the parameter is left empty ).
All the identifier keywords (of frame or of parameter ) are in upper-case.
The following fields ( SID,PID, ID, blood type, operator, lot numbers ) are UTF8 encoded.
The DATE format is set to DD/MM/YYYY, time is set to HH:MM:SS in 24 hour mode.

Maximum fields length for fields shared among different frames


OPERATOR 10 chars
USER 10
LOT (CALI or QC) 8
SID 16
PID 16
ID 20

7.1.1 Unit
UNIT;u[CR]

Unit code value u Unit system


1 USA = standard
4 S.I.
7 S.I. MOD
3 OTHER

ModEIS rev02 Copyright© C2 diagnostics. All Rights Reserved. Page 3/11


SEIS_F18_FormatC2
Free18 C2 format description
Rev 03

7.2 FRAMES
7.2.1 RESULT SENDING
The Free18 sends the results to the host.

Free18 Host

F18 COUNT;1;200207-000451;;BILL[CR]
RESULT[CR] result frame
Analysis result sending

7.2.1.1 Analysis result sending

F18 COUNT;1;000000-000000;;ADMIN;
RESULT
DATE;14/01/2016
TIME;15:38:38
MODE;NORMAL
UNIT;1
SEQ;8;1
SID;1
PID;
ID;
TEST;LMG
TYPE;WB
BIRTH;01/01/1900
Gender;0
Doctor;
PATIENT COMMENT;
SN;000000-000000
OPERATOR; ML
PREL;OT
CYCLE;N
WBC;13.1 ;*; ;2.0 ;4.0 ;12.0 ;15.0 ;
LYMP;-----; ; ;15.0 ;25.0 ;50.0 ;55.0 ;
MIDP;-----; ; ;1.0 ;2.0 ;10.0 ;12.0 ;
GRAP;-----; ; ;45.0 ;50.0 ;80.0 ;85.0 ;
LYM;-----; ; ;0.8 ;1.0 ;5.0 ;5.5 ;

ModEIS rev02 Copyright© C2 diagnostics. All Rights Reserved. Page 4/11


SEIS_F18_FormatC2
Free18 C2 format description
Rev 03

MID;-----; ; ;0.0 ;0.1 ;1.0 ;1.1 ;


GRA;-----; ; ;1.5 ;2.0 ;8.0 ;9.0 ;
RBC;-----; ; ;2.50 ;4.00 ;6.20 ;7.00 ;
HGB;-----; ; ;8.5 ;11.0;17.0;19.0;
HCT;-----; ; ;25.0;35.0;55.0;60.0;
MCV;-----; ; ;70.0 ;80.0 ;100.0;120.0;
MCH;-----; ; ;25.0;26.0;34.0;35.0;
MCHC;-----; ; ;28.0;31.0;35.5;37.0;
RDW;-----; ; ;7.0 ;10.0;16.0;25.0;
RDW-SD;-----; ; ;25.9 ;37.0 ;46.0 ;71.9 ;
PLT;0 ;*; ;70 ;150 ;400 ;500 ;
MPV;-----; ; ;5.0 ;6.0 ;11.0 ;12.5 ;
PCT;-----; ; ;0.100;0.200;0.500;0.600;
PDW;-----; ; ;5.0 ;8.0 ;18.0;25.0;
PLCR;-----; ; ;8.0 ;12.0 ;42.0 ;60.0 ;
WBC CURVE ;128 values separated by semicolon
WBC THRESHOLDS;33;49;0;
RBC CURVE;128 values separated by semicolon
RBC THRESHOLDS;32;62
PLT CURVE;128 values separated by semicolon
PLT THRESHOLDS;72
ALARMS;W-CL;R-CL;QC-ND;INS-T;
INTERPRETIVE_WBC;
INTERPRETIVE_RBC;
INTERPRETIVE_PLT;
COMMENT;PCT and PDW are for Research Use Only;
END_RESULT;50210

7.2.1.1.1 Haematological parameter format

Id ; value ; flag A ; flag B ; low panic ;low ; high ;high panic [CR]
WBC; 11.0 ;A ;B ; 2.0 ; 4.0 ; 11.0 ; 15.0 [CR]

rank Fields Valeurs possibles


1 Parameter id WBC
2 Parameter value in the selected unit 5.84
+ + + + + (5 plus) if overrange
----- (5 dashes) if unvalid result
3 Flag A • Nothing
• ‘*’ if result is rejected (counting or measure
rejection) or invalidating fault.
• ‘S’ : suspicion
4 Flag B Nothing
D : Higher than reportable limits (1)

‘L’ Result < panic value


‘l’ Result < normal value
‘h’ Result > normal value
‘H’ Result > panic value

ModEIS rev02 Copyright© C2 diagnostics. All Rights Reserved. Page 5/11


SEIS_F18_FormatC2
Free18 C2 format description
Rev 03

5 Low Panic value 2.0


6 Low value 4.0
7 High value 6.0
8 High panic value 8.0

(1) in the case field 2 is set to +++++

7.2.1.2 Alarms list


S-UP FAIL
QC NOT DONE
QC FAIL
INS-T
L1
L2
L3
L5
R1
R2
P1
P2
P3
W_CL
R_CL

7.2.1.3 WBC interpretive message


LEU>
LEU<
LYM>
LYM<
GRA>
GRA<
MON>
LIC
EOS>
NO_INTERPRETATION

7.2.1.4 RBC interpretive message


ANE
ERY>
MICRO
MACRO
MICR>
MACR>
ANIS>
HYPOCR
COLDAGG

ModEIS rev02 Copyright© C2 diagnostics. All Rights Reserved. Page 6/11


SEIS_F18_FormatC2
Free18 C2 format description
Rev 03

NO_INTERPRETATION

7.2.1.5 PLT interpretive report


THR>
THR<
MICROP
MACROP
PLTAGGR
SCHITZ
MICROC
CELLD
NO_INTERPRETATION

7.2.2 CALIBRATION

Free18 Host

F18;1;200207-000451;;BILL[CR]
Sending calibration report
CALIBRATION

7.2.2.1 Sending calibration report

F18 COUNT;1;321214-000016;;BIOLO;
CALIBRATION
DATE;26/01/2016
TIME;12:16:27
OPERATOR;BIOLO
ITEM_CALI;3 ;;number of results for the calib.
COEFF
WBC;1.144 ;;factor values..
RBC;0.866
HGB;0.993
MCV;0.981
PLT;0.982
MPV;1.139
TARGET
UNIT;1
LOT;PLUS016

ModEIS rev02 Copyright© C2 diagnostics. All Rights Reserved. Page 7/11


SEIS_F18_FormatC2
Free18 C2 format description
Rev 03

LOT DATE;19/01/2016
LOT TIME;18:31:48
EXPIRY DATE;05/02/2016
OPERATOR;SEB ;;operator who added the lot
SOURCE;O
WBC;9.9 ;0.0 ;;target and ranges
RBC;4.78 ;0.0
HGB;13.8;0.0
MCV;83.8 ;0.0
PLT;232 ;0.0
MPV;9.5 ;0.0
END_CALI;62691 ;;CRC

F18 COUNT;W;X;;Y;[CR]

Where :
W is the Free instrument number (2 chars maximum).
X is the Free serial number (13 chars).
Y is the user login, UTF8 coded.

Following by the N results used for the calibration.

7.2.2.2 Result
F18 COUNT;1;321214-000016;;BIOLO;
RESULT
DATE;26/01/2016
TIME;10:04:42
MODE;CALIBRATION ;;type of result
UNIT;1
SEQ;1;0
TEST;LMG
OPERATOR;BA
PREL;OT
CYCLE;N
WBC;10.0 ; ; ;
RBC;4.88 ; ; ;
HGB;13.6; ; ;
MCV;84.9 ; ; ;
PLT;237 ; ; ;
MPV;9.8 ; ; ;
END_RESULT;20253

ModEIS rev02 Copyright© C2 diagnostics. All Rights Reserved. Page 8/11


SEIS_F18_FormatC2
Free18 C2 format description
Rev 03

7.2.3 QC

Free18 Host

F18 COUNT;1;200207-000451;BILL[CR]
Sending QC result
QC

7.2.3.1 Result
F18 COUNT;1;321214-000016;;BIOLO;
RESULT
DATE;26/01/2016
TIME;14:42:00
MODE;QC ;; type of result
UNIT;1
SEQ;1223
LOT;B115H ;;QC Lot
LOT DATE;23/11/2015
LOT TIME;08:35:22
LEVEL;H
EXPIRY DATE;05/02/2016
USER;AJ
OPERATOR;BIOLO
PREL;OT
CYCLE;N
WBC;0.0 ; ; ;18.0 ;23.0 ;
LYMP;-----; ; ;7.5 ;19.5 ;
MIDP;-----; ; ;0.7 ;6.7 ;
GRAP;-----; ; ;74.8 ;90.8 ;
LYM;-----; ; ;1.6 ;4.0 ;
MID;-----; ; ;0.1 ;1.5 ;
GRA;-----; ; ;15.3 ;18.7 ;
RBC;0.01 ; ; ;5.63 ;6.23 ;
HGB;0.0 ; ; ;18.2;19.8;
HCT;-----; ; ;48.2;53.0;
MCV;-----; ; ;80.3 ;90.3 ;

ModEIS rev02 Copyright© C2 diagnostics. All Rights Reserved. Page 9/11


SEIS_F18_FormatC2
Free18 C2 format description
Rev 03

MCH;-----; ; ;29.6;34.6;
MCHC;-----; ; ;34.6;40.6;
RDW;-----; ; ;8.2 ;14.2;
RDW-SD;-----; ; ;29.1 ;41.1 ;
PLT;0 ; ; ;468 ;588 ;
MPV;-----; ; ;7.3 ;13.3 ;
END_RESULT;13554

7.2.4 Repeatability
No emissions.

7.3 Control sum


The control sum is a CRC code : CRC-16.

7.3.1 Algorithmic
The used souce code is available here below( C code ).
It allows to generate standard CRC-16.

This algorithm is mainly used in embedded systems ( like hard disk controller).
For best performance, compute is done from a seek table with 16 values.
Here is the CRC computation:

CRC = 0xFFFF
For each nibble :
Work on high weight nibble :
Index = byte EXCLUSIVE OR CRC
Index = Index AND 000F
CRC = Table(Index) EXCLUSIVE OR (CRC divided by 16)
Work on low weight nibble :
Index = byte divided by 16
Index = Index EXCLUSIVE OR CRC
Index = Index AND 000F
CRC = Table(Index) EXCLUSIVE OR (CRC divided by 16)

7.3.2 C language source example implementation


Seek table declaration :
static const unsigned short ausCrcTab1[] =
{
0x0000, 0xCC01,0xD801,0x1400,0xF001,0x3C00,0x2800,0xE401,
0xA001,0x6C00,0x7800,0xB401,0x5000,0x9C01,0x8801,0x4400,
};

CRC computation :

unsigned short calc_crc(unsigned char *pucData, long lSize)


{
unsigned short usAcc1 = 0xFFFF;

while ( lSize > 0 )

ModEIS rev02 Copyright© C2 diagnostics. All Rights Reserved. Page 10/11


SEIS_F18_FormatC2
Free18 C2 format description
Rev 03

{
/* gestion par quartet du calcul */
usAcc1 = ausCrcTab1[(*pucData ^ usAcc1) & 15] ^ (usAcc1 >> 4);
usAcc1 = ausCrcTab1[((*pucData >> 4) ^ usAcc1) & 15] ^ (usAcc1 >> 4);

pucData++;
lSize--;
}

return(usAcc1);
}

^ : EXCLUSIVE OR
>> : logical right shift.
& : logical and.

This CRC is computed form the beginning sent data until the end of line ([CR] included ) preceding the
checksum line ( identifier + value ).

ModEIS rev02 Copyright© C2 diagnostics. All Rights Reserved. Page 11/11

You might also like