Service Manual - VIDAS Range - BCI Connectivity For LIS - 161150-486 - B - MAR 3408

VIDAS® Range - BCI
Connectivity Service Manual
LIS Interface Driver Development Guide
EN
161150-486 - B - en - 2017-01 – P/N 161150-827
bioMérieux SA
376 Chemin de l’Orme
69280 Marcy-l’Etoile - France
Tel: 33 (0)4 78 87 20 00
Fax: 33 (0)4 78 87 20 90
www.biomerieux.com
Intellectual Property
BIOMERIEUX, the blue logo, BCI Link and VIDAS are used, pending and/or registered
trademarks belonging to bioMérieux, or one of its subsidiaries, or one of its companies.
Any other name or trademark is the property of its respective owner.
© 2017 bioMérieux SA
bioMérieux SA 673 620 399 RCS Lyon
Table of Contents
Introduction
Introduction to the System ........................................................................................ 1-1

Intended Use and Users. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-1
Warnings and Safety Messages. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-2
Statement Types . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-2
General Statements . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-3
System Overview ........................................................................................................ 2-1

Basic RS232 Configuration with BCI Link . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-1
VIDAS® PC RS232 Configuration (single instrument) . . . . . . . . . . . . . . . . . . . . . . . . . . 2-1
VIDAS® 3 RS232 Configuration (single instrument) . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-2
miniVIDAS® RS232 Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-3
FTP Configuration with BCI Link . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-4
Ideal bioMérieux Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-4
Other bioMérieux Configuration - Sub-Network Dedicated to VIDAS® Systems . . . . . . 2-5
RP5800 and RP5810 Computers Connector Panels . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-7
RS232 and FTP Specificities
RS232 Messages......................................................................................................... 3-1

Transport of RS232 Messages. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-1
Protocols. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-2
bioMérieux Literal Protocol ("Download" Mode). . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-2
bioMérieux Literal Protocol ("Upload" Mode) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-3
bioMérieux Literal Alternate Protocol ("Download" Mode) . . . . . . . . . . . . . . . . . . . . . . . 3-4
bioMérieux Literal Alternate Protocol ("Upload" Mode) . . . . . . . . . . . . . . . . . . . . . . . . . 3-4
Frame Message Examples . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-5
Managing Messages . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-6
Checksum Field Format . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-7
Configuration of the Connection . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-8
Example of an Analysis Request in RS232 Format . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-9
Example of an Analysis Result in RS232 Format. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-9
Example of an Analysis Result in RS232 Format on miniVIDAS® . . . . . . . . . . . . . . . . . . . . 3-9
RS232 System Specificities ....................................................................................... 4-1

Transport Process . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-1
Physical Link . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-1
Message Structure . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-2
Formatting Rules . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-3
161150-486 - B i BCI - VIDAS® Range

Table of Contents
Data Types . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-4

CMVA Parameter Specific Description. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-8
Differences due to the CMVA Parameter Update . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-8
RS232 miniVIDAS® System Specificities.................................................................. 5-1

Hardware Specificities . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-1
Communication Port . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-1
Cable . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-1
Formatting Rules . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-2
Data Types . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-3
Examples of RS232 Messages .................................................................................. 6-1

Example of an Analysis Request in RS232 Format . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-1
Particular Cases. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-1
Example of an Analysis Result in RS232 Format. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-1
Examples of connection Test Results (dummy files) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-3
Example of an Analysis Result in RS232 Format on miniVIDAS® . . . . . . . . . . . . . . . . . . . . 6-3
ASTM-XML (FTP) Messages ...................................................................................... 7-1

Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-1
Naming Rules . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-3
Analysis Request . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-3
Analysis Result . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-3
Attributes required for Test Dispatching . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-4
Transport of ASTM-XML (FTP) Messages . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-4
Managing FTP Sessions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-5
Opening a Session. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-5
Configuring Connections for Data Transfer . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-6
Shutting down a Session . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-6
Managing Analysis Requests (LIS to BCI) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-7
Description of the "STOR" Command . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-7
Examples of how the "STOR" Command is used . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-8
Algorithm for Sending Analysis Requests . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-10
Managing Results (BCI to LIS) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-11
Description of the "RETR" Command . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-11
Examples of how the "RETR" Command is used . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-12
Algorithm for Receipt of Results . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-13
FTP Commands supported by the Server . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-14
FTP Return Codes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-17
161150-486 - B ii BCI - VIDAS® Range

Table of Contents
Conventions to Follow in Writing Pseudocode . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-18

Introduction to XML Schema . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-19
Declaration of Types . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-19
Occurrence Constraints . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-19
VIDAS® PC XML Schema . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-20
VIDAS® 3 XML Schema . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-27
ASTM-XML System Specificities ............................................................................... 8-1

Data Types . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8-2
CMVA Parameter Specific Description. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8-10
Differences due to the CMVA Parameter Update . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8-10
Examples of ASTM-XML (FTP) Messages ................................................................ 9-1

Examples of Analysis Requests in ASTM-XML (FTP) Format . . . . . . . . . . . . . . . . . . . . . . . 9-1
Analysis Request for AI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9-1
Analysis Request for AI with bioMérieux and Systematic Dispatching Mode . . . . . . . . 9-2
Analysis Request for AI with Laboratory Dispatching Mode . . . . . . . . . . . . . . . . . . . . . 9-3
Examples of Analysis Results in ASTM-XML (FTP) Format . . . . . . . . . . . . . . . . . . . . . . . . 9-5
Quantitative Result. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9-5
Qualitative Result . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9-6
Error and Duplication Management ........................................................................ 10-1

Error Management in VIDAS® 3 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10-1
Error Management in VIDAS® PC . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10-2
Duplication Management . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10-2
BCI Simulators
Introduction to the BCI Simulators ......................................................................... 11-1

Purpose . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11-1
Content of the Master . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11-1
Installation Procedure .............................................................................................. 12-1

General Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12-1
Installing the BCI Simulator . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12-1
Uninstalling the BCI Simulator . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12-3
Preliminary Steps . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12-3
Uninstalling BCI Simulators . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12-3
161150-486 - B iii BCI - VIDAS® Range

Table of Contents
Principle of Operation .............................................................................................. 13-1

User Interface . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13-3
Opening BCI Simulators . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13-3
Description of the Interface . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13-4
Description of the Functionalities . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13-5
Defining Parameters for the Simulator Text Editors. . . . . . . . . . . . . . . . . . . . . . . . . . . 13-7
Sub-folders Architecture of the BCI Simulators Directory. . . . . . . . . . . . . . . . . . . . . . . . . . 13-8
LIS – RS232 SIMULATOR ......................................................................................... 14-1

Accessing the LIS Simulator and Setting Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14-1
Setting Parameters for the RS232 Connection (serial port and protocol) . . . . . . . . . . 14-1
Starting/Stopping the RS232 Communication Server . . . . . . . . . . . . . . . . . . . . . . . . . 14-4
Selecting a Protocol . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14-5
Communication Supervision. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14-6
Display Communication Tracking Data in Real Time. . . . . . . . . . . . . . . . . . . . . . . . . . 14-6
Initialize the List containing Communication Tracking Data. . . . . . . . . . . . . . . . . . . . . 14-7
Archiving Communication Tracking Data . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14-7
Using the Manual Protocol . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14-7
Transmission of Manual Commands . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14-8
Creating Scripts . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14-9
Executing Scripts . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14-11
Managing Analysis Requests in the "bioMérieux" Format . . . . . . . . . . . . . . . . . . . . . . . . 14-13
Presentation of the Editor . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14-13
Step 1: Create an Analysis Request . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14-14
Step 2: Complete the Analysis Request . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14-14
Step 3: Save the Analysis Request . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14-16
Step 4: Send an Analysis Request . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14-16
Setting Parameters for the "bioMérieux" Test Order Editor . . . . . . . . . . . . . . . . . . . . . . . 14-17
Definition of Attributes and Separator . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14-17
Definition of Attribute Types . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14-17
Definition of Attribute Labels . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14-18
Definition of Mandatory and Optional Attributes . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14-19
Example of the Definition of a Test Order Editor . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14-19
Managing Analysis Requests in "text" Format . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14-20
161150-486 - B iv BCI - VIDAS® Range

Table of Contents
LIS – FTP Simulator .................................................................................................. 15-1

Accessing the LIS Simulator and Setting Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15-1
Setting Parameters for the FTP Connection . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15-1
Managing Analysis Requests in "ASTM-XML" Format. . . . . . . . . . . . . . . . . . . . . . . . . . . . 15-3
Presentation of the Editor . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15-3
Step 1: Create an Analysis Request . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15-4
Step 2: Complete the Analysis Request . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15-4
Step 3: Save the Analysis Request . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15-9
Step 4: Send an Analysis Request . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15-9
Managing Analysis Requests in "text" Format . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15-10
Receiving Results. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15-11
Presentation of the Results Download Interface . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15-11
Downloading a Result . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15-12
AI Simulator............................................................................................................... 16-1
Parameter Setting and Connections. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 16-1
Setting Parameters for the AI Simulators. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 16-1
Opening and Closing a Session on an AI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 16-3
Updating the Configuration of the AI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 16-4
Receiving Analysis Requests sent by BCI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 16-5
Managing Results in "ASTM-XML" Format . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 16-6
Step 1: Create a Result Message . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 16-7
Step 2: Complete or Modify the Message using new Results . . . . . . . . . . . . . . . . . . . 16-7
Step 3: Save the Message . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 16-7
Step 4: Send the Message. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 16-7
Managing Results in "text" Format . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 16-8
Step 1: Create a Result Message . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 16-8
Step 2: Complete or Modify the Message with New Results . . . . . . . . . . . . . . . . . . . . 16-8
Step 3: Save the Message . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 16-8
Step 4: Send the Message. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 16-8
Managing Results in "bioMérieux" Format . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 16-9
Step 1: Create a Result Message . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 16-10
Step 2: Complete or Modify the Message using New Results . . . . . . . . . . . . . . . . . . 16-10
161150-486 - B v BCI - VIDAS® Range

Table of Contents
Step 3: Save the Message . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 16-10

Step 4: Send the Message. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 16-10
Setting Parameters for the "bioMérieux" Result Editor. . . . . . . . . . . . . . . . . . . . . . . . . . . 16-11
Appendices
Appendix A - Main Differences within the VIDAS® Range ......................................A-1
Appendix B - Message Field Format and Values .....................................................B-1

Codepage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .B-1
XML Encoding of Special Characters. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .B-1
bMx Interpretation Messages . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .B-2
English / French / German . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .B-2
Spanish / Italian / Portuguese . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .B-3
Polish / Turkish / Chinese . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .B-4
Greek / Japanese / Korean / Russian - VIDAS® 3 only . . . . . . . . . . . . . . . . . . . . . . . . .B-5
Qualitative Result Values . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .B-6
Authorized Patient Sex Field Values in bMx Messages . . . . . . . . . . . . . . . . . . . . . . . . . . . .B-7
Abnormal Flags (BMX and XML messages) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .B-7
VIDAS® Flags . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .B-7
VIDAS® 3 Flags . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .B-8
Appendix C - Glossary ...............................................................................................C-1
161150-486 - B vi BCI - VIDAS® Range

Introduction
1 Introduction to the System
Intended Use and Users
The content of this manual is based on the bioMérieux BCI Link version R4.0.0.
The BCI (bioMérieux Communication Interfaces) is a software used to establish

communications between bioMérieux® Analysis Instruments (AI) and Laboratory Information
(Management) System (LIS or LIMS) host computers.
This document describes the different stages in the development of the bioMérieux AI/LIS
interface.
This guide is particularly intended for field service engineers that need to configure the AI and
the BCI Link, in order to establish a connection with the LIS or LIMS.
Note: The screens and figures shown are intended as illustrations only and must not be interpreted
as actual representations of data, results or equipment.
Screens and equipment are not shown to scale.
161150-486 - B 1-1 BCI - VIDAS® Range

Warnings and Safety Messages Introduction to the System
Warnings and Safety Messages
The user documentation uses several types of statements to alert you to important
information. Important information is labeled in text and identified using symbols.
Statement Types
The statement types are Warning, Caution, Important, and Note. The following examples
define each statement type. The general caution symbol is used in these examples, but other
symbols may be used instead.
The warning messages in this manual mainly refer to:
WARNING
A Warning statement alerts the user to the possibility of injury, death, or

other serious adverse reactions associated with the use or misuse of the
device.
CAUTION: A Caution statement alerts the user to the possibility of a problem with
the device associated with its use or misuse. Such problems include device
malfunction, device failure, damage to the device, or damage to other property.
Where applicable, a Caution statement may include a precaution that should be
taken to avoid the hazard.
IMPORTANT: An Important statement relates to content presented in the user documentation. It is

used to reinforce the user’s understanding of selected information.
Note: A Note statement supplies additional information about a topic.
161150-486 - B 1-2 BCI - VIDAS® Range

General Statements Introduction to the System
General Statements
This section provides important statements that apply to all products. Equipment meets the
requirements and standards stated in the certificate supplied with it.
WARNING
Even when power is removed from the instrument, the potential exists for
electricity to be generated if components, such as assemblies that are
mounted on belts, are moved too quickly. Components should be moved
slowly to prevent the buildup of electricity. Failure to comply may result in
injury to personnel or damage to the instrument.
WARNING
Electronic equipment can be the source of electrical shocks.
Installation, service, and repair should only be performed by authorized and

qualified bioMérieux personnel.
WARNING
All power switches should be off when connecting or disconnecting cables
to or from power outlets to reduce the risk of electrical shock.
bioMérieux recommends connecting this instrument to a main power outlet

that is protected with a ground fault circuit interrupter to reduce the risk of
electrical shock.
IMPORTANT: Electrical or other connections should only be made using the accessories supplied
with the equipment.
Before undertaking electrical safety or other compliance testing on the instrument,

contact bioMérieux.
CAUTION: The computer and its operating system have been carefully configured
for optimal performance of the VIDAS® range systems. Altering the configuration
may severely hamper the usability of the instrument.
161150-486 - B 1-3 BCI - VIDAS® Range

2 System Overview
In this section, represents a network cable and an RS232 cable.
Basic RS232 Configuration with BCI Link
VIDAS® PC RS232 Configuration (single instrument)

The VIDAS® PC RS232 configuration (single instrument) includes:
• 1 VIDAS® PC.
• 1 or 2 VIDAS® instruments connected with a serial cable to the VIDAS® PC.
• The BCI Link software installed on the VIDAS® PC.
• 1 LIS computer connected with a serial cable (RS232) directly to the VIDAS® PC com port.
• VIDAS® PC and LIS can be connected to the laboratory network with a network cable.
Note: This last connection is not necessary but useful, for example for VILINK.
The following illustration describes a VIDAS® PC RS232 configuration.
Figure 2-1: VIDAS® PC RS232 Configuration (single instrument)
161150-486 - B 2-1 BCI - VIDAS® Range

Basic RS232 Configuration with BCI Link System Overview
VIDAS® 3 RS232 Configuration (single instrument)

The VIDAS® 3 RS232 configuration (single instrument) includes:
• 1 VIDAS® 3 computer connected with a network cable to the instrument and/or directly to the
local laboratory network.
• 1 VIDAS® 3 instrument connected with a network cable to the VIDAS® 3 computer or directly
to the local area network.
• The BCI Link software installed on the VIDAS® 3 computer.
• 1 LIS computer connected with a serial cable (RS232) directly to the VIDAS® 3 computer com
port.
The following illustration describes a VIDAS® 3 RS232 configuration.
Figure 2-2: VIDAS® 3 RS232 Configuration (single instrument)
161150-486 - B 2-2 BCI - VIDAS® Range

Basic RS232 Configuration with BCI Link System Overview
miniVIDAS® RS232 Configuration
IMPORTANT: miniVIDAS® is a standalone instrument that enables unidirectional transmission of test

results to the Laboratory Information System (LIS) or other host computer system
(= UPLOAD only, through a serial RS232 communication).
It is NOT possible to send any test requests to the miniVIDAS® instrument.
Note: For more detailed information about miniVIDAS®, refer to the miniVIDAS® Procedure
Manual, ref. 161150-093.
The following illustration describes a miniVIDAS® RS232 configuration.
Figure 2-3: miniVIDAS® RS232 Configuration
The miniVIDAS® RS232 configuration includes:
• 1 miniVIDAS® instrument
1 LIS computer connected with a serial cable (RS232) directly to the com port of the
miniVIDAS®.
The miniVIDAS® instrument is connected to the LIS computer through a communication cable
(P/N 186036-x) plugged into the COMPUTER port located at the back of the instrument.
161150-486 - B 2-3 BCI - VIDAS® Range

FTP Configuration with BCI Link System Overview
FTP Configuration with BCI Link
There are many different configurations that can be set to interconnect VIDAS® systems and
LIS/LIMS inside the Laboratory Network. The communication between them is performed by
the BCI Link software.
Since every Laboratory Network is different, this section suggests and describes ideal and
other bioMérieux configurations that can be realized.
Ideal bioMérieux Configuration

The best way to install only VIDAS® 3 systems with RP5810 computer is to connect directly
the computers on the customer network as shown below.
Figure 2-4: Ideal bioMérieux Configuration
As the VIDAS® 3 RP5810 computer owns two network boards, the connection between the
VIDAS® 3 RP5810 native board and the VIDAS® 3 instrument creates a physical sub-network.
In this case, no need to add a router.
Below in details, the components of this network:
• The Laboratory Network - This network is under the responsibility of the customer. Linked to
this network there is the LIS and the Internet access to allow the communication with the
VILINK server. The VIDAS® 3 RP5810 computers and other devices (printers, etc.) are
connected directly to this network, the VIDAS® 3 instruments are connected only to the
corresponding VIDAS® 3 RP5810 computer.
Note: The connector panels of the different computers are presented in Figure 2-6, Figure 2-7 and
Figure 2-8.
The BCI Link should be installed on the most recent computer.
In Figure 2-4 “Ideal bioMérieux Configuration” on page 2-4, there are 3 network connections
(2 VIDAS® 3 RP5810 computers and 1 printer).
161150-486 - B 2-4 BCI - VIDAS® Range

Other bioMérieux Configuration - Sub-Network Dedicated to VIDAS® Systems

The best way to install different VIDAS® systems is to create a VIDAS® sub-network (LAN -
Local Area Network) defined by the router distributed by bioMérieux connected to the
customer network (WAN - Wide Area Network).
Due to the firewall included in the router distributed by bioMérieux, bioMérieux ensures
VIDAS® data control and security within the sub-network defined by the router.
Figure 2-5: Other bioMérieux Configuration
The above picture is an example of a bioMérieux configuration.
161150-486 - B 2-5 BCI - VIDAS® Range

Below in details, the components of this network:
• The router firewall is the device that:

• creates the VIDAS® range sub-network dedicated to the VIDAS® systems,
• allows the communication with the customer network,
• ensures data control and security within the VIDAS® sub-network.
• The Laboratory Network - This network is under the responsibility of the customer. Linked to
this network there is the LIS and the Internet access to allow the communication with the
VILINK server. Other systems will be connected to the customer network and not the VIDAS®
sub-network.
• The VIDAS® range sub-network - All the VIDAS® systems and related devices (printers,
switches, etc.) are connected to this sub-network.
• The VIDAS® systems (VIDAS® PC and VIDAS® 3) - 1 to 4 systems can be connected to the
same BCI Link and under the same sub-network.
Note: The BCI Link should be installed on the most recent computer.
• One or more bioMérieux optional switches can be used to extend the physical connections.
In Figure “Other bioMérieux Configuration” on page 2-5, there are 5 network connections
(1 VIDAS® PC computer - 1 RP5800 or 1RP5810 -, 2 VIDAS® 3 computers - 1 RP5800 and
1RP5810 -, 1 VIDAS® 3 instrument and 1 printer).
The router can host a limited number of network connections, so a switch can be necessary to
complete the configuration.
161150-486 - B 2-6 BCI - VIDAS® Range

RP5800 and RP5810 Computers Connector Panels
Figure 2-6: VIDAS® PC RP5800 or VIDAS® PC RP5810 Computer Connector Panel
Figure 2-7: VIDAS® 3 RP5800 Computer Connector Panel
161150-486 - B 2-7 BCI - VIDAS® Range

Figure 2-8: VIDAS® 3 RP5810 Computer Connector Panel
161150-486 - B 2-8 BCI - VIDAS® Range

RS232 and FTP Specificities
3 RS232 Messages
Transport of RS232 Messages
The following table describes the control characters which are available for transporting
RS232 messages.
Table 3-1: Control Characters
Record or Character Description
This is the line request character. It establishes a session between the sending and
ENQ
receiving computers.
Upon receipt of a <GS> record, this character is sent to indicate successful

ACK transmission of the data packet. It is also used by the receiver to respond to receipt
of an <ENQ>.
This signals a negative response when a session is not possible or when a

NAK
transmission error was detected by a bad checksum or parity error.
This signals the start of a message packet. It is a single character record that
STX
expects no response from the target computer.
This record contains specific message information of up to 80 printable ASCII

RS characters per record. There can be any number of <RS> records in a data packet.
It does not expect a response from the target computer.
This record contains a checksum that determines if the packet was received
properly. Calculation of checksums begins with the first <RS> and ends with the
<GS> character.
Checksums are calculated by adding the values of appropriate characters,
GS
truncating the most significant part of the result (leaving an 8-bit number), and
converting this value to two ASCII characters representing the hexadecimal value
of the number. An <ACK> or <NAK> is always expected in response to this record
type.
This signals the end of a message packet. It is also a single character record that
ETX
expects no response from the target computer.
The sending computer sends this character to the receiver to signal the end of the
EOT
session.
161150-486 - B 3-1 BCI - VIDAS® Range

Protocols RS232 Messages
Protocols
There are 2 types of protocols: bioMérieux Literal and bioMérieux Literal (Alternate).
bioMérieux Literal Protocol ("Download" Mode)

Case #1: one analysis request
Basic message contents
Opening of a session by transmitting the ASCII control

character <ENQ>.
If the computer receiving the inquiry is ready to receive

data, it responds with the acknowledgment character
<ACK>. If it is not ready, it sends a <NAK> character.
A communications message begins with the ASCII start

character <STX>.
Subsequent records begin with the ASCII record separator

character <RS>. The <RS> records contain the text of the
message (max size of an RS block 80 bytes –Total of all
RSs= 1920 bytes max.).
A checksum checks that all the messages sent have been

received. The checksum must follow the <GS> separator.
The <ACK> character indicates successful transmission of

the data packet.
Communications messages end with the <ETX> character.
Sessions end when one of the computers receives an

<EOT> character.
Note: There can only be one <STX> and <ETX> character per data packet. At least one <RS>
record must be in the packet. There will always be one <GS> record per packet.
Case #2: more than one analysis request
There are 2 possibilities:
• Multiple sessions: The user opens a complete session for each analysis request (e.g. for 10
analysis requests: 10 <ENQ> to <EOT>-type sessions).
• Single session: The user opens an <ENQ> session, sends as many complete <STX> to
<ETX> blocks as there are analysis requests, and then closes the session (e.g. for 10
requests: 1 <ACK> session is opened, 10 <STX> to <ETX> blocks are sent and the <EOT>
session is closed).
161150-486 - B 3-2 BCI - VIDAS® Range

bioMérieux Literal Protocol ("Upload" Mode)

Case #1: one result
Upload from BCI to LIS
Opening of a session by transmitting the ASCII control

character <ENQ>.
If the LIS is not ready, it sends a <NAK> character. BCI will

try to upload several times (see details below).
A communications message begins with the ASCII start

character <STX>.
Subsequent records begin with the ASCII record separator

character <RS>. The <RS> records contain the text of the
message.
A checksum checks that all the messages sent have been

received. The checksum must follow the <GS> separator.
The <ACK> character indicates successful transmission of

the data packet.
Communications messages end with the <ETX> character.
Sessions end when one of the computers receives an

<EOT> character.
Case #2: more than one result
The Upload mode always functions in multiple sessions, that is to say with one result after
another. A complete <ENQ> to <EOT>-type message is systematically sent for each result.
If there are several results, each one is sent individually.
161150-486 - B 3-3 BCI - VIDAS® Range

bioMérieux Literal Alternate Protocol ("Download" Mode)

This protocol is similar to the bioMérieux Literal Protocol ("Download" Mode) protocol
described above, except for the <ACK> control which is sent AFTER the <ETX> control (and
not before), as illustrated below.
bioMérieux Literal Alternate Protocol ("Upload" Mode)

This protocol is similar to the bioMérieux Literal Protocol ("Upload" Mode) protocol described
above, except for the <ACK> control which is sent AFTER the <ETX> control (and not
before), as illustrated below.
161150-486 - B 3-4 BCI - VIDAS® Range

Frame Message Examples

Here are some examples of valid and invalid frames:
Example 1: Valid upload frame from LIS to VIDAS® system.
17:24:24 <= <ENQ>

17:24:24 => <ACK>
17:24:24 <= <STX>
17:24:24 <= <RS>mtmpr|pi123456|pndupont|pb01/01/
2013|psM|soC|si|ci001122334455|rtDD2|qd4|
17:24:24 <= <GS>85
17:24:24 => <ACK>
17:24:24 <= <ETX>
17:24:24 <= <EOT>
Example 2: Corresponding answer from VIDAS® system to LIS.
17:26:10 => <ENQ>

17:26:10 <= <ACK>
17:26:10 => <STX>
17:26:10 => <RS>mtrsl|pi123456|pndupont|pb01/01/
2013|psM|soC|si|ci001122334455|rtDD2|rnD-Dimer E
17:26:11 => <RS>xclusion|tt17:26|td08/01/2013|ql|qn16830.25 ng/ml|y3ng/
ml|qd4|ncvalid|idVIDAS3PC01
17:26:11 => <RS>|snVN00000|m4vidas|
17:26:11 => <GS>fb
17:26:11 <= <ACK>
17:26:11 => <ETX>
17:26:11 => <EOT>
Example 3: Invalid frame from LIS to VIDAS® system:
Same frame as example 1 except that the checksum <GS> is situated before the <RS>.
BCI does not reply <ACK>, then BCI does not transmit the request to the system.
17:40:12 <= <ENQ>

17:40:12 => <ACK>
17:40:12 <= <STX>
17:40:12 <= <GS>85
17:40:12 <= <RS>mtmpr|pi123456|pndupont|pb01/01/
2013|psM|soC|si|ci001122334455|rt DD2|qd4|
17:40:12 <= <ETX>
17:40:12 <= <EOT>
161150-486 - B 3-5 BCI - VIDAS® Range

Managing Messages RS232 Messages
Managing Messages
Reminder: each message contains control characters that are critical for LIS  BCI
communication (see Control Characters table on page 3-1).
The "<CR><LF>" (Carriage Return/Line Feed) option adds two additional control characters
after each control character so that some characters can be recognized (e.g.: <ENQ>
<CR><LF>).
This is not the default option. If you want to use it, select it as follows from the BCI Link
application:
1. Click to access the Software administration screen.

2. Activate the RS232 configuration tab.
3. Highlight the link you want to modify and click Update.
The RS232 Configuration Manager dialog box is displayed.
Figure 3-1: <CR><LF> Option
4. In the <CR><LF>, define the control characters to be followed by <CR><LF> and click OK
to validate and close the dialog box.
5. Click to save the configuration.
161150-486 - B 3-6 BCI - VIDAS® Range

Checksum Field Format RS232 Messages
Checksum Field Format
The checksum is a control value calculated to ensure that all characters transmitted have
been received.
The checksum consists of a two-digit ASCII representation of an eight-bit number. This

number is calculated by adding the value of all the characters beginning with the first <RS>
record and ending with the <GS> character. The number is then truncated leaving the least
significant eight bits which convert to two ASCII hexadecimal characters.
This example applies to incoming and outgoing checksums. (It also shows the use of record
terminators).
Note: Checksum characters sent by the bioMérieux computer are always lower case, but both upper
and lower case characters are accepted.
161150-486 - B 3-7 BCI - VIDAS® Range

Configuration of the Connection RS232 Messages
Configuration of the Connection
Configuration of the connection is performed on the serial port.
Note: For more detailed information on link configuration, refer to the BCI Link User Manual, ref.
4501-2122.
IMPORTANT: The LIS and AI must have identical serial port parameter settings (parity, speed, stop
bit).
The table below gives the parameters required for the configuration.
Parameters Description Possible Values Default Value
Port Serial port used by the link Between COM1 and Com 3
COM4
Baud Transfer speed Between 110 and 9600
256000 baud
Data bits Number of bits per character Between 4 and 8 bits. 8
Parity This bit is included as a simple means None, Even, Odd, none
of error checking Forced to 1 and
Forced to 0
Stop bits These bits are always represented by 1, 1,5 and 2. 1
a negative voltage. If no further
characters are transmitted, the line
stays in the negative (MARK)
condition. The transmission of the next
character frame, if any, is heralded by
a start bit of positive (SPACE) voltage
161150-486 - B 3-8 BCI - VIDAS® Range

Example of an Analysis Request in RS232 Format RS232 Messages
Example of an Analysis Request in RS232 Format
mtmpr|pi960297|pnBrown|pb1996/12/02|psM|soLAB1|si|ci218421|qd1|
Particular Cases
For analysis requests on assays with sub-assays (such as HIV5 or DUOLIS), only the main
assay is sent in the request. If sub-assays requests are sent, they are ignored.
mtmpr|pi201309|pndupond|pb1975/10/10|psM|soLAB06|si|ci2012|rtHIV5|qd1|
mtmpr|pi201310|pndupond|pb1975/10/10|psM|soLAB05|si|ci2013|rtLDUO|qd1|
Example of an Analysis Result in RS232 Format
mtrsl|pi200609|pndupond|pb1975/10/10|ps-
|so|si|ci11111111111122222|rtTSH|rnTSH|tt14:53|td2013/10/23|ql|qn0.80
uUI/ml|y3uUI/ml|qd1|nccalinc|idBMXHOST0|sn|m4db2bmx|
Example of an Analysis Result in RS232 Format on miniVIDAS®
mtrsl|<RS>pi|<RS>pn|<RS>si|<RS>ci7|<RS>rtHIV|<RS>rnHIV 1+2|
<RS>tt09:49|<RS>td07/22/98|<RS>qlNegatif|<RS>qn0.01|
Note: The presence of the <RS> character before each field is normal.
161150-486 - B 3-9 BCI - VIDAS® Range

4 RS232 System Specificities
The following section is based on VIDAS® PC software version VU_06 and VIDAS® 3
software version R1.2. It is used to define the meaning of annotations in English language.
• For RS232 configuration, use only standard (7 bits) ASCII characters.

• In the message data, never use the "|" (ASCII decimal code 124) and the "CR" (Carriage
Return, ASCII decimal code 13) characters.
Transport Process
Physical Link
A serial port is needed. If there is no serial port available, use a USB/Serial converter.
161150-486 - B 4-1 BCI - VIDAS® Range

Message Structure RS232 System Specificities
Message Structure
Figure 4-1: LIS/AI RS232 Message Structure
LIS Message
This message is sent by the LIS to the VIDAS® range system and contains the analysis
request to be performed.
A complete LIS (download) message is composed of the following fields (optional fields in
blue/italic):
mt | pi | pn | pb | ps | so | si | ci | rt | qd
AI Message
This message is sent by the VIDAS® range system to the LIS to report the result.
A complete AI (upload) message is made up of the following fields (optional fields in blue/
italic):
mt | pi | pn | pb | ps | so | si | ci | rt | rn | tt | td | ql | qn | y3 | qd | nc | id | sn | m4
Note: No specific field is expected to indicate the end of the messages.
161150-486 - B 4-2 BCI - VIDAS® Range

Formatting Rules RS232 System Specificities
Formatting Rules
Messages exchanged in both directions are formatted according to well defined formatting
rules:
• All messages are composed of a message type (a text mnemonic).
• All messages are composed of a set of message fields each composed of:
• A field tag (a text mnemonic) that is a unique two-character code (see Data Types on
page 4-4).
• A value (empty values are allowed for some fields)
• A vertical bar (|) terminator that ends each field.
• The date separator character is “/”.
• The time separator character is “:”.
• The decimal separator character is always “.” (dot), whatever the locale is.
• Configurable date patterns are: (DD/MM/YY, DD/MM/YYYY, MM/DD/YY, MM/DD/YYYY, YY/

MM/DD, YYYY/MM/DD).
For the date on 2 digits, the following rule will be applied (in download mode for birthDate
only): current date + 5.
• Supported sex values are language dependent (see Authorized Patient Sex Field Values in
bMx Messages on page B-7).
• Valid times must follow the HH:MM format.
• Field length is variable with a maximum size (see Data Types on page 4-4).
• Case of data is “as is”. This means that values are not case sensitive.
• See Codepage on page B-1 for more details about the codepage.
161150-486 - B 4-3 BCI - VIDAS® Range

Data Types RS232 System Specificities
Data Types
The table below lists all the possible fields with their associated characteristics. It applies to
both VIDAS® PC and VIDAS® 3 unless otherwise specified.
In this table:
 means that the field is managed

• In download (LIS to AI) that means that the field can be received.
• In upload (AI to LIS) that means that the field can be sent.
 means that the field is not managed.

• In download (LIS to AI) that means that the field cannot be received (if the field is in the
message, either the field will be ignored or an error will be generated).
• In upload (AI to LIS) that means that the field will never be sent.
Mandatory fields:
• In download (LIS to AI) that means that we expect these fields to be present.
• In upload (AI to LIS) that means that the fields will always be present.
Note: The order of the following table is not the expected order.
LIS AI to
Code Description Value Type / Format / Constraints Additional Information
to AI LIS
Header (Message data)

mt Message type • Type: StringL3 A message is always introduced by
  this field with the rsl or mpr value.
• Value: rsl (result) or mpr (request)
The mt field is a structural element in

Mandatory
RS232 and MUST be present, else
the message is rejected.
Patient Data
pi Patient identifier • Type: StringL17 The patient ID has to be unique. In
  other words, there can ONLY be ONE
Mandatory patient name/sex/birth date for a given
patient ID.
Note: If this field is missing, empty or too
long when sent by the LIS, the request is
rejected.
pn Patient name • Type: StringL30

 
Optional
Note: Truncated to 30 characters if too

long.
161150-486 - B 4-4 BCI - VIDAS® Range

LIS AI to
to AI LIS
pb Patient birth date • Type: Date

 
• Format: yyyy/mm/dd
Optional
Note: Ignored in case of invalid field

format.
ps Patient sex • Type: StringL1 Important: The authorized values for

  this attribute are language dependent.
• Value:
M: Male
See Authorized Patient Sex Field
F: Female
Values in bMx Messages on page B-7
-: Unknown
for detailed information.
Default value: -
The values described in the column
on the left apply when the English
Optional
language is configured.
Note: Only the first character is significant.
It is not case sensitive.
Specimen / Sample Data

so Sample origin • Type: StringL5 If this field is too long, empty or
  missing, the existing value in the
Optional VIDAS® PC system (potentially
entered by the user in the GUI), is left
Note: Truncated if too long. as is and not erased.
If empty or filled with spaces, the

VIDAS® 3 system sends "so|" instead
of "so |" or “so |”.
si Specimen • Type: N/A This field does not convey any
separator   information. It is used to structure the
Mandatory RS232 messages (in order to indicate
the beginning of specimen data).
Note: This field is always empty (no
value). No error management done on this
field (no alarm).
ci Sample ID • Type: StringL17 Contains the sample ID.
 
Mandatory For bioMérieux control tests (i.e.
Cx), this field contains both the
Note: If this field is missing, empty or too sample ID and the strip lot number
long when sent by the LIS, the request is separated by a blank character.
rejected. The format of the strip lot number is
yymmdd-v where yy is the year, mm
the month, dd the day and v the
version (0 or 2).
For quality control tests (i.e. QCx),

this field contains the quality control
identifier, that is to say a string with a
maximum length of 12 characters.
161150-486 - B 4-5 BCI - VIDAS® Range

LIS AI to
to AI LIS
LIS / AI Test / Assay Data

rt Short assay name • Type: StringL4 The analysis request is rejected
  (without raising any error) if the
Mandatory requested short assay name is not
supported or unknown by the system.
Note: Truncated if too long.
If the testIdentifier is missing or empty
in an analysis request, an error is
raised and the request is rejected.
rn Long assay name • Type: StringL40
 
Optional
qd Dilution VIDAS® PC VIDAS® 3 Important: If you do not activate the
  dilution option in the Connection
• Type: Integer • Type: Integer
configuration screen of VIDAS® 3,
• Value: from 1 • Value: from 1 and in the Configuration/Link_BCI
to 999 to 9999 screen of VIDAS® PC, the dilution
value sent by the LIS is ignored even
Optional Optional if it is present.
Note: If the requested test does not
support dilution (qualitative assays for Make sure this behavior meets the
instance), the field is simply ignored. customer’s expectations.
For analysis requests on quantitative

assays, if the dilution sent from the LIS is
invalid, the request is rejected.
Moreover, for analysis requests on

quantitative assays:
- If the dilution value is missing whereas a
value was expected (dilution option
activated in the Connection
configuration screen of VIDAS® 3, and in
the Configuration/Link_BCI screen of
VIDAS® PC), the analysis request is
rejected.
- Conversely, if the dilution value is
present whereas a value was not
expected, the dilution value is ignored
(default value=1 is used instead and no
error is raised).
Result Data
tt Test completion • Type: Time
time  
Format: hh:mm
Mandatory
td Test completion • Type: Date
date  
Format: yyyy/mm/dd
Mandatory
161150-486 - B 4-6 BCI - VIDAS® Range

LIS AI to
to AI LIS
ql Qualitative result • Type: StringL29 The values are determined with the
  message indexes of the assay files
• Value: see Qualitative Result
Values on page B-6 for associated with the thresholds.
information about the authorized
values
Mandatory
Note: This field can be empty for

quantitative assays. However, the ql field
and qn field are both sent to the LIS for
results on qualitative assays. In that case,
ql contains the TV value and qn the
interpretation.
qn Quantitative result • Type: StringL29 Qualitative: contains the test value

  with format X.XX (X.XX can be a
Mandatory negative value).
Note: May include spaces. Quantitative: contains “value unit”,

possibly “< value unit” or “> value unit”
with a space between “>” or “<” and
“value” and with a space between
“value” and “unit”.
Qualitative test made of multiple

sub-results with one global result
(such as HIV5): the field is empty.
y3 Unit • Type: StringL30 Contains “unit” associated with qn
(associated with   field.
qn) Optional
Note: This field is not sent from

VIDAS® PC for results on qualitative
assays (the y3 tag will not be sent at all in
this case).
nc VIDAS flags • Type: StringL15

 
• Value: see VIDAS® Flags on
page B-7 for detailed information
about possible values
Optional
Traceability Information
id Instrument ID • Type: StringL15 ID of the instrument on which the
  result is computed.
Optional
sn Serial number • Type: StringL20 Serial number filled in the
  configuration.
Optional
Note: May include spaces.
161150-486 - B 4-7 BCI - VIDAS® Range

CMVA Parameter Specific Description RS232 System Specificities
LIS AI to
to AI LIS
m4 Technologist • Type: StringL20 Name of the technician who runs the

  analysis.
Optional
Restrictions:
• The message has to respect the field order constraints.

• No space is permitted between field separator and field tag.
• The pipe character (|) is NOT allowed in the message data.
CMVA Parameter Specific Description
On the VIDAS® 3 system, from version V1.2, the CMVA parameter has been updated,
meaning:
• A new PTC code corresponding to this update

• A new CMVA management
Note: On the VIDAS® PC system, the CMVA parameter has not been updated.
Differences due to the CMVA Parameter Update
After the Update
For one CMVA test (patient or control) performed on the VIDAS® 3 system :
• 1 qualitative result is calculated automatically through the system (Avidity index) associated to
an interpretation (LOW/ INTERMED. / HIGH).
• The avidity index and the associated interpretation are sent in only one frame to the LIS
(see Figure 4-2).
Figure 4-2: Frame sent by AI to LIS with Avidity index and associated interpretation
161150-486 - B 4-8 BCI - VIDAS® Range

CMVA Parameter Specific Description RS232 System Specificities
Before the Update
For one CMVA test (patient or control) performed on the VIDAS® 3 system or on the
VIDAS® PC system :
• 2 quantitative results are given (doses).

• The doses are sent in two similar frames to the LIS (see Figure 4-3).
Figure 4-3: One of the two frames sent by AI to LIS with one dose value
• The avidity index is calculated manually through the system, according to the package insert
recommendation.
• Doses sent to the LIS cannot be used to determine the avidity index.
161150-486 - B 4-9 BCI - VIDAS® Range

5 RS232 miniVIDAS® System Specificities
Hardware Specificities
Communication Port
The communication port labeled COMPUTER and located at the rear side of the machine has
to be used. On miniVIDAS®, the connector is a DB9 male.
Cable
The cable is the same as the one used for the VIDAS BCI. Cross the wires 2 and 3. The
required connector for the miniVIDAS® side is a DB9 female.
Message Structure
The message is sent by miniVIDAS® to the LIS to report a result.
The message format is fixed and all the available fields are transmitted.
Figure 5-1: miniVIDAS® Message Format
A complete AI (upload) message for miniVIDAS® is made up of the following fields (optional
fields in blue/italic:
mt | pi | pn | si | ci | rt | rn | qd | tt | td | ql | qn
161150-486 - B 5-1 BCI - VIDAS® Range

Formatting Rules RS232 miniVIDAS® System Specificities
Formatting Rules
Messages are formatted according to well defined formatting rules.
All messages are composed of:
• The mtrsl header code.
• A set of message fields each composed of:

• A field tag (a text mnemonic) that is a unique two-character code (see Data Types on
page 5-3).
• A value (empty values are allowed for some fields)
• A vertical bar (|) terminator that ends each field.
• Date and time separator characters are configurable is “/”.
• The decimal separator character is always “.” (dot), whatever the locale is.
• Date pattern follows the US format: MM/DD/YY.
• Field length is variable with a maximum size ((see Data Types on page 5-3).
• Case of data is “as is”. This means that values are not case sensitive.
161150-486 - B 5-2 BCI - VIDAS® Range

Data Types RS232 miniVIDAS® System Specificities
Data Types
The table below lists all the possible fields with their associated characteristics.
Header
mt Message type • Type: StringL3 A message is always introduced by this
• Value: rsl (result) field with the rsl value
Mandatory
Patient Data
pi Patient identifier Always empty Always empty because corresponding
information does not exist on miniVIDAS®
pn Patient name Always empty Always empty because corresponding
information does not exist on miniVIDAS®
si Specimen separator • Type: N/A This field does not convey any
information and is kept for compatibility
Mandatory only.
Note: This field is always empty (no value). No error management done on this field
(no alarm).
ci Sample ID • Type: StringL12
Mandatory
Test Order Data
rt Short assay name • Type: StringL4
Mandatory
Note: Truncated to 4 characters if longer.
rn Long assay name • Type: StringL40
Mandatory
qd Dilution • Type: IntegerL4
Optional
Result
tt Test completion time • Type: TimeL5
• Format: hh:mm
Mandatory
td Test completion date • Type: DateL8 US format.
• Format: mm/dd/yy
Mandatory
161150-486 - B 5-3 BCI - VIDAS® Range

Data Types RS232 miniVIDAS® System Specificities
ql Qualitative result • Type: StringL29
Mandatory
Note: Can be empty in case of quantitative

test only.
qn Quantitative result • Type: StringL29
Mandatory
161150-486 - B 5-4 BCI - VIDAS® Range

6 Examples of RS232 Messages
Example of an Analysis Request in RS232 Format
mtmpr|pi960297|pnBrown|pb1996/12/02|psM|soLAB1|si|ci218421|qd1|
Particular Cases
For analysis requests on assays with sub-assays (such as HIV5 or DUOLIS), only the
main assay is sent in the request. If sub-assays requests are sent, they are ignored.
mtmpr|pi201309|pndupond|pb1975/10/10|psM|soLAB06|si|ci2012|rtHIV5|qd1|
mtmpr|pi201310|pndupond|pb1975/10/10|psM|soLAB05|si|ci2013|rtLDUO|qd1|
Example of an Analysis Result in RS232 Format
Particular Cases
• For results consisting of multiple sub-results and global results (such as HIV5), the
global results, the antibody (AB) and antigen (AG) are uploaded to the LIS as shown below.
• For the global result:
mtrsl|pi5060|pnroger|pb1968/01/05|psM|so1|si|ci200601100|rtHIV5|rnHIV DUO
Ultra|tt10:05|td2006/04/06|qlNEGATIVE|qn|qd1|ncvalid|idVIDAS3PC01|sndasa10|m4bmx|
• The antibody (AB) and antigen (AG) are uploaded:

mtrsl|pi5060|pnroger|pb1968/01/05|psM|so1|si|ci200601100|rtAB|rnHIV DUO
Ultra|tt10:05|td2006/04/06|qlNEGATIVE|qn0.17|qd1|ncvalid|
idVIDAS3PC01|sndasa10|m4bmx|
mtrsl|pi5060|pnroger|pb1968/01/05|psM|so1|si|ci200601100|rtAG|rnHIV DUO
Ultra|tt10:05|td2006/04/06|qlNEGATIVE|qn0.14|qd1|ncvalid|
idVIDAS3PC01|sndasa10|m4bmx|
• In case of an undetermined interpretation (qn = ND):

mtrsl|pi2050|pnyolande|pb1968/05/01|psF|so2|si|ci2006010503|rtAG|rnHIV DUO
Ultra|tt10:05|td2003/04/02|qlPOSITIVE|qnND|qd1|ncvalid|id
VIDAS3PC01|sndasa10|m4bmx|
• Particular case of results on qualitative assays (TXG)

mtrsl|pi960297|pnBrown|pb1996/12/02|psM|soLAB1|si|ci218421|rtTXG|rnTOXO IgG
II|tt14:29|td2013/10/23|qlEquivoque|qn4 UI/ml|y3UI/ml|qd1|ncvalid|idBMXHOST0
|sn|m4db2bmx|
161150-486 - B 6-1 BCI - VIDAS® Range

Example of an Analysis Result in RS232 Format Examples of RS232 Messages
• Particular case of results on quantitative assays (TSH)

• For results consisting of multiple sub-results without global results (such as DUOLIS),
the sub-results are uploaded to the LIS as described below.
• For the first sub-result:
mtrsl|pi|pn|pb|ps|so1|si|ci|rtDLMO|rn DUO Listeria monocytogenes |tt|td|ql|qn|y3|qd|nc|
• For the second sub-result:

mtrsl|pi|pn|pb|ps|so1|si|ci|rtDLIS |rn DUO Listeria spp|tt|td|ql|qn|y3|qd|nc|
File: result_hiv5_line1.txt
Blocks: Header, Patient, Specimen, Order, Result, Traceability.
mtrsl|pi#12345|pn|pb|ps-|so|si|ci#12345|rtHIV5|rnHIV DUO
Ultra|tt16:03|td11/03/2011|qlPOSITIVE|qn|qd1|ncconthnor|
idVIDAS3PC01|snVN1234|m4vidas|
mtrsl|pi#12345|pn|pb|ps-|so|si|ci#12345|rtAB|rnHIV DUO
Ultra|tt16:03|td11/03/2011|qlPOSITIVE|qn1.47|qd1|ncconthnor|
mtrsl|pi#12345|pn|pb|ps-|so|si|ci#12345|rtAG|rnHIV DUO
Ultra|tt16:03|td11/03/2011|qlPOSITIVE|qnND|qd1|ncconthnor|
• Particular case of results on dual assays (TXGA)

For DUAL assays (such as TXGA), only the test results are sent to the LIS (the reference
results are not sent).
mtrsl|pi201309|pndupond|pb1975/10/10|psM|soLAB06|si|ci2012|rtTXGA|rnToxo IgG
Avidity|tt15:11|td2013/10/23|qlINVALIDE|qnINVALIDE|qd1
|ncconthnor|idBMXHOST0|sn|m4db2bmx|
• Particular cases of control results

In order to send (bioMérieux) control results, the ci field won’t contain only the sample ID, but
it will contain also the strip number, separated by a space.
mtrsl|pi|pn|pb|ps|so|si|ciC2 041003-1|rtTXG|rnTOXO IgG II|tt08:19|td25/04/2006

|qlNegative|qn2 UI/ml|y3UI/ml|qd1|ncvalid|idVIDASPC|sn|m4bmx|
161150-486 - B 6-2 BCI - VIDAS® Range

Examples of connection Test Results (dummy files) Examples of RS232 Messages
• Particular case of results of quality controls

Except for the fact that the ci field containing usually the sample ID will be replaced by the
QC’s ID, the sending of quality control result is similar to sending patient analysis result
(except that patient data are empty in case of quality control results).
mtrsl|pi|pn|pb|ps|so|si|ciQC1|rtP24|rnHIV P24 II|tt14:45|td2013/10/24|qlPOSITIF|qn47.3

pg/mlAgP24|y3pg/ml AgP24|qd1|ncvalid|idBMXHOST0|sn|m4db2bmx|
• Particular case of simplified demography mode (VIDAS® PC only)

In simplified demography mode, the pn and pi fields take the value of the ci field.
• The following results in complete demography mode:

mtrsl|piId patient|pnNom Patient|pb1983/04/12|psM|soORIG|si|ciId echantillon|rtTXG|rnTOXO
IgGII|tt13:49|td2014/02/14|qlEquivoque|qn4 UI/ml|y3UI/ml|qd1|ncvalid
|idBMXHOST0|sn|m4db2bmx|
• becomes in simplified mode:

mtrsl|piId echantillon|pnId echantillon|pb1983/04/12|psM|soORIG|si|ciId
echantillon|rtTXG|rnTOXO IgGII|tt13:49|td2014/02/14|qlEquivoque|qn4 UI/ml|y3UI/
ml|qd1|ncvalid|idBMXHOST0|sn|m4db2bmx|
Examples of connection Test Results (dummy files)
These are test messages configured in the bcinet.properties file.
Default dummy file name and content are:
• bcinet.dummyfile.rs232.name=bmx_000000-000000_0
• bcinet.dummyfile.rs232.content=mtbis
Example of an Analysis Result in RS232 Format on miniVIDAS®
mtrsl|<RS>pi|<RS>pn|<RS>si|<RS>ci7|<RS>rtHIV|<RS>rnHIV 1+2|
<RS>tt09:49|<RS>td07/22/98|<RS>qlNegatif|<RS>qn0.01|
Note: The presence of the <RS> character before each field is normal.
161150-486 - B 6-3 BCI - VIDAS® Range

7 ASTM-XML (FTP) Messages
Description
ASTM-XML messages are based on a subset of ASTM attributes defined in the specification
ASTM 1394-97 and structured using XML formalism. To avoid any ambiguity in the
interpretation of messages, an XML schema is used to check the syntax and ensure that the
messages follow several semantic rules.
For further details on XML schema, refer to the Introduction to XML Schema on page 7-19.
The purpose of the XML schema is to define two main elements which are
"LisMessageType", for the definition of analysis requests, and "AIMessageType" for the
definition of results.
Each XML element derived from the ASTM specification is preceded by a comment indicating
the section in which the attribute definition can be found. For example, the definition of the
patient identifier is presented as follows:
 Chapter 8.1.4 of the ASTM specification describes the patient identifier

<xsd:element name="patientIdentifier" type="StringL12"/>
The reference schema is available from the BCI software structure:

\lib_server\resources\xml\astm.xsd.
ISO-8859-1 and UTF-8 type of character encoding should be used by default.
Systems in the VIDAS® range only support this type of character encoding.
IMPORTANT: Character encoding forms such as UTF-16 or UCS-2, which use two or more fixed
bytes, are not supported by BCI Link for optimization reasons. Only variable width
encoding forms which can code the first 255 characters on a single-byte are accepted
by BCI Link (Shift-JIS, UTF-8, ISO-8859-1, etc.).
Note: The XML parser in charge of interpreting the bioMérieux result frame must manage:
• The CDATA section

• The 5 predefined XML entity references (< >&'") to replace the illegal
XML characters
• The references to Unicode entities ("&#nnn;")
161150-486 - B 7-1 BCI - VIDAS® Range

Description ASTM-XML (FTP) Messages
Example 1: result with a value at "<0.5 ng/ml" - sent by the AI to the LIS
• If the result is not interpreted:

<result>
<value><![CDATA[< 0.5|]]></value>
<unit>UI/ml</unit>
<comment>
<source>I</source>
<text><![CDATA[The result contains a "< ", so it
is surrounded with a CDATA clause]]></text>
<type>G</type>
</comment>
</result>
• If the result is interpreted:

<result>
<value><![CDATA[< 0.5|NEGATIVE]]></value>
<unit>UI/ml</unit>
<comment>
<source>I</source>
<text><![CDATA[The result contains a "< ", so it
is surrounded with a CDATA clause]]></text>
<type>G</type>
</comment>
</result>
Example 2: result with a value at ">0.5 ng/ml" – sent by the AI to the LIS
<result>
<value>> 0.5</value>
<unit>UI/ml</unit>
<comment>
<source>I</source>
<text>The result contains a character "greater
than", it is replaced by its entity: ></text>
<type>G</type>
</comment>
</result>
161150-486 - B 7-2 BCI - VIDAS® Range

Naming Rules ASTM-XML (FTP) Messages
Naming Rules
Analysis Request
Analysis request files sent by the LIS must be named as follows:
FTP Account name_YYMMDD_HHMMSS_s.xml
Where:
• FTP Account name is the name of the FTP account created in the BCI Link configuration
menu.
• YYMMDD means Year, Month, Day.
• HHMMSS means Hour, Minute, Second.
• s is the sequence between 0 and 99. This is used if the LIS sends more than one analysis
request (in the same second).
Analysis Result
Analysis result files sent by the AI must be named as follows:
AI name_YYMMDD_HHMMSS_s.xml
Where:
• AI name is the name of the Automat connected to BCI Link.

• YYMMDD means Year, Month, Day.
• HHMMSS means Hour, Minute, Second.
• s is the sequence between 0 and 99. This is used if the AI sends more than one analysis result
(in the same second).
161150-486 - B 7-3 BCI - VIDAS® Range

Attributes required for Test Dispatching ASTM-XML (FTP) Messages
Attributes required for Test Dispatching
Messages sent by the LIS and used by BCI Link (according to the dispatcher configuration)
are described below.
• Systematic dispatching
No information required. BCI Link sends the LIS message to all the AI connected (single
connection configuration).
• Laboratory dispatching
The analysis requests sent by the LIS should contain the name of the AI
(instrumentSectionId) on which the test is to be performed. If the AI is unknown, the request
is rejected and an error is generated by BCI Link as it cannot read the test code
(shortAssayName). It is only used by the AI.
• bioMérieux dispatching
Analysis requests sent by the LIS should contain the test code shortAssayName and the type
of test ActionCode. If the type of test is not provided it is considered as a routine test
(ActionCode = ‘N’). BCI Link needs both items to send the request according to the
dispatcher configuration.
Transport of ASTM-XML (FTP) Messages
Messages are transported by TCP/IP using the standard FTP protocol. From a strictly
"communications" point of view, the BCI Link software is an FTP server and the LIS is an
FTP client. In other words, the interface driver should integrate an FTP client who is capable
of downloading files containing the analysis requests and uploading files containing the
results.
The FTP protocol requires two connections for communication, a "control connection" and a
"data connection". The control connection is used to exchange FTP commands and the data
connection to transfer data.
The transmission mode is a "Stream" mode, i.e. the file is simply transferred as a series of
bytes. There are no limitations for the data representation.
The “file type” structure is used. The EOF (End Of File) sequence is implicitly marked by the
closing of the connection. All the transmitted bytes are therefore data bytes.
There is no existing mechanism to detect lost or erroneous bits for a transferred file; this
type of error is managed at TCP level. The FTP server does not implement a recovery
procedure following an error. If transfer is interrupted, the client must resend the complete
file.
IMPORTANT: The aim of this section is to define the specificities of the FTP protocol as part of the
LIS – BCI interface. It does not provide information on the FTP protocol.
For further details on the FTP protocols, refer to the standard RFC0959.
161150-486 - B 7-4 BCI - VIDAS® Range

Managing FTP Sessions ASTM-XML (FTP) Messages
Managing FTP Sessions
Opening a Session
The FTP connects to the FTP client BCI server using an identifier and a password which are
recognized (i.e. defined as an active FTP account). Refer to the BCI Link User Manual, ref.
4501-2122 for more detailed information.
A session can be opened by sending the command:
Connecting to the < FTP server>

< 220 Service ready for new user
1. USER <user name>
< 331 User name okay, need password
2. PASS <user password>
< 230 User logged in, proceed
Note: Only valid FTP accounts are authorized to connect to BCI Link, anonymous FTP accounts do
not exist.
The following table describes the command sequence that an FTP client should use to set up
a new FTP session.
# Command Setting Return Code

1 TCP/IP Connection • IP address or computer name • 220: connection established
• Port number (21 by default) • 221: connection error
• 421: connection refused - too many open
sessions (max=10) or unexpected error
2 USER • FTP account identifier • 331: identifier OK, need password
• 221 or 421: unexpected error
3 PASS • FTP account password • 230: session created
• 530: incorrect identifier or password
• 221 or 421: unexpected error
161150-486 - B 7-5 BCI - VIDAS® Range

Managing FTP Sessions ASTM-XML (FTP) Messages
Configuring Connections for Data Transfer

Type of transfer:
To optimize transfer time and avoid encoding problems, it is preferable to use binary transfers
rather than ASCII transfers by sending the following command to the FTP server after
connection: TYPE I.
If this is successful, the return code is 200. If an error occurs, the return code is 501. This
configuration is valid for the duration of the session or until the command TYPE A is sent to
return to ASCII mode.
Transfer mode (active / passive):
The BCI allows connections in active or passive mode for the transfer of files.
Active mode
Opening of the data connection is initiated by the BCI Link server using the parameters of the
PORT command previously transmitted by the client.
This command has the following parameters: h1, h2, h3, h4, p1, p2. The first 4 parameters
represent the Internet address and the last 2 represent the port for a byte in ASCII
representation (refer to the RFC0959 standard).
Note: The server does not implement a default port for the data connection. The client has to send
the PORT command beforehand.
Passive mode
Opening of the data connection is initiated by the client for data transfer. To initiate transfer in
passive mode, the FTP client must send the following command to the FTP server: PASV. The
server will then return the IP address and the port number on which the client should establish
the connection for data transfer.
Note: By default, the server runs in active mode which may cause problems with systems which are
behind firewalls. Only use passive mode for configurations with a firewall.
The PASV command is only valid for the next data transfer; this is why it must systematically
be sent before each data transfer.
Shutting down a Session

The FTP server does not manage session "time outs". In theory, an FTP session can remain
open indefinitely. In practice, it is recommended to open a session each time an analysis
request is downloaded on the server (see section about Managing Analysis Requests (LIS to
BCI) on page 7-7) and to have a "permanent" session for downloading results (see section
about Managing Results (BCI to LIS) on page 7-11).
A session can be shut down by sending the QUIT command to the FTP server.
Note: Shutting down a session enables only the control connection to be shut down; transfer
connection shutdown is initiated by the server following data transfer.
161150-486 - B 7-6 BCI - VIDAS® Range

Managing Analysis Requests (LIS to BCI) ASTM-XML (FTP) Messages
Managing Analysis Requests (LIS to BCI)
Description of the "STOR" Command

The analysis requests must be downloaded in the directory "\download" on the FTP server.
Any attempt to write in a directory other than the "download" directory is refused by the
server.
To download the contents of a file to the server’s current directory, use the command FTP:
STOR <Name of file>. After the "STOR" command has been issued, the FTP server may
send one of the following return codes:
Code Message Explanation

550 Requested action not taken, This error occurs when you try to send a file which has the
not a file same name as a directory on the server, e.g. STOR/
download.
550 Requested action not taken, This error occurs when you try to download a file in a
no access directory other than the "download" directory, e.g. STOR/
upload/myFile
451 Requested action aborted: This error occurs when you send a file without respecting the
Incorrect format, waited rules for naming it as defined in BCI. The format for naming a
for: < FTP account> file should be < FTP account>_yymmdd_hhmmss_
_yymmdd_hhmmss_ <sequence>.xml.
<sequence>.xml file name The FTP account is the name of the account validated in the
and received: <myFile> BCI configuration and the sequence is an integer between 0
and 99 which is used to identify several files sent in the same
second. For example, the LIS sends 3 separate files on
December 31 2004 at 12h30 and 20 seconds, the files should
be named as follows:
 <account FTP>_041231_123020_0.xml
 <account FTP>_041231_123020_1.xml
 <account FTP>_041231_123020_2.xml
Since the FTP server does not manage file uniqueness,

naming them in this way will avoid involuntary overwriting of
files in the "download" folder.
421 Service not available, This error occurs in cases where:
closing control connection • Connection for data transfer failed (in active or passive
mode). Check that the parameters defined during creation
of the connection (Internet address and port number) are
correct.
• Connection for data transfer is suddenly cut off (power cut,
connection shut down by the client, etc.).
150 Opening data connection - This message is sent to the client before transfer begins. It
transfer mode: <Binary mode indicates that connection has been correctly established and
or Ascii mode>: that the transfer mode will be binary or ASCII.
226 Transfer complete : The server sends this code to indicate that transfer is
complete and that the connection will soon be shut down.
161150-486 - B 7-7 BCI - VIDAS® Range

Examples of how the "STOR" Command is used

Example 1:
The FTP command sequence below enables the following actions to occur in succession:
• Establish an FTP session in active mode

• Send an analysis request, following the BCI rules for naming files
• Shut down the session

USER <user name>
PASS <user password>
CWD /download
< 250 Requested file action okay, completed
TYPE I
< 200 Command okay
PORT h1,h2,h3,h4,p1,p2
< 200 Command okay
STOR labo_030909_153020_0.xml
< 150 Opening data connection - transfer mode: Binary mode
< 226 Transfer complete
QUIT
< 221 Service closing control connection
161150-486 - B 7-8 BCI - VIDAS® Range

Example 2:
• Establish an FTP session in passive mode

• Send an analysis request, following the BCI rules for naming files, with the complete path

USER <user name>
TYPE I
< 200 Command okay
> PASV
< 227 Entering Passive Mode (h1,h2,h3,h4,p1,p2)
STOR /download/labo_030909_153020_0.xml
QUIT
161150-486 - B 7-9 BCI - VIDAS® Range

Algorithm for Sending Analysis Requests

The following algorithm describes the main steps for managing transfer of analysis requests
coming from the LIS computer. This algorithm is written in pseudocode, i.e. the algorithm gives
a description of the tasks to be performed but without language syntax. Refer to the section
describing the Conventions to Follow in Writing Pseudocode on page 7-18.
The principle of this algorithm consists in finding, in a given reference system, all the analysis
requests to be transferred. If new requests exist, an FTP session is initiated and the files are
sent following the rules for naming files. This algorithm does not take into account the possible
errors that the server may return.
// Finding the analysis requests in a table

File[] fileList = getWorkListToSend() ;
IF fileList not empty THEN {
// Opening an FTP connection
openFTPConnection(ftpHostname, portNumber);
// Opening a new session
startFTPSession(login, pwd);
// Transfer: binary mode
setBinaryMode();
// finding current date and time
DateTime dateAndTime = getSystemDateTime();
// Managing sequence number using a counter
Integer counter = 0;
// sending files
FOR i=0 to fileList.length() {
// creating a file name to send to the FTP server
String fileName = ftpAccountName + “_” + dateAndTime.getYear() +
dateAndTime.getMonth()+ dateAndTime.getDay() + “_” + dateAndTime.getHours() +
dateAndTime.getMinutes() + dateAndTime.getSeconds() + “_” + counter + “.xml”;
// Sending the file: give the file name and its content
sendFileByFTP(filename, fileList[i].getContentAsBytes());
IF (getSystemDateTime().getSeconds() == dateAndTime.getSeconds())
THEN {
counter = counter + 1;
} ELSE {
counter = 0;
} // end IF
} // end FOR
// send QUIT command
endFtpSession();
} // end IF
161150-486 - B 7-10 BCI - VIDAS® Range

Managing Results (BCI to LIS) ASTM-XML (FTP) Messages
Managing Results (BCI to LIS)
Description of the "RETR" Command

The results are available in the "\upload" directory on the FTP server. Any attempt to upload
from a directory other than the "upload" directory is refused by the server.
To upload the contents of a file to the server’s current directory, use the command FTP : RETR
<File name>. Following a "RETR" command, the FTP server may send one of the following
return codes:
Code Message Explanation

550 Requested action not This error occurs when you try to upload a file which has the
taken, not a file same name as a directory on the server, e.g. RETR /upload
550 Requested action not This error occurs when you try to upload a file from a directory
taken, no access other than the "upload" directory, e.g. RETR/download/
monFichier.
550 Requested action not This error occurs when you try to upload a file which cannot be
taken, file not found found on the server.
451 Requested action This error occurs when you try to upload a file whose name
aborted: Illegal upload does not match the naming rules, as defined in BCI.
- should uploaded files
having the following
definition: <analysis
system
name>_yymmdd_hhmmss_<se
quence>.xml
421 Service not available, This error occurs in cases where:
closing control • connection for data transfer failed (in active or passive
connection mode). Check that the parameters defined during creation of
the connection (Internet address and port number) are
correct.
• connection for data transfer is suddenly cut off (power cut,
connection shut down by the client, etc.).
150 Opening data This message is sent to the client before transfer begins. It
connection - transfer indicates that connection has been correctly established and
mode: <Binary mode or that the transfer mode will be binary or ASCII.
Ascii mode>
226 Transfer complete The server sends this code to indicate that transfer is complete
and that the connection will soon be shut down.
161150-486 - B 7-11 BCI - VIDAS® Range

Examples of how the "RETR" Command is used

Example 1:
• Establish an FTP session in active mode

• Download a result, following the BCI rules for naming files
Connecting to < FTP server>
USER <user name>
CWD /upload
< 250 Requested file action okay, completed
TYPE I
< 200 Command okay
< 200 Command okay
RETR system1_030909_153020_0.xml
QUIT
Example 2:
• Establish an FTP session in passive mode

• Upload a result, following the BCI rules for naming files, with the complete path
Connecting to < FTP server>
USER <user name>
TYPE I
< 200 Command okay
PASV
< 227 Entering Passive Mode (h1,h2,h3,h4,p1,p2)
RETR /upload/system1_030909_153020_0.xml
QUIT
161150-486 - B 7-12 BCI - VIDAS® Range

Algorithm for Receipt of Results

The following algorithm describes the main steps for managing the receipt of results. This
algorithm is written in pseudocode, i.e. the algorithm gives a description of the tasks to be
performed but without language syntax. Refer to the section describing the Conventions to
Follow in Writing Pseudocode on page 7-18.
The principle of this algorithm consists in opening a session, periodically scanning the
"upload" directory (every 10 to 30 seconds) and uploading new results.
endFtpSession();
// Opening an FTP connection
openFTPConnection(ftpHostname, portNumber);
// Opening a new session
startFTPSession(login, pwd);
// Transfer: binary mode
setBinaryMode();
LOOP {
// Scanning file names in the upload directory
// Send FTP command : NLST /upload
String[] fileNames = getResultFileNames();
// Transfer all the available files
FOR i=0 to fileNames.length() {
// transfering the file using the RETR upload/filename[i] command
getFile(fileNames[i]);
} // end FOR
// Waiting for a time period (in seconds) shorter than the time required for //
scanning the FTP account. This period depends on the BCI Link //configuration
// it is recommended to set the frequency value between 10 and 30
wait(30);
} // end LOOP
// send QUIT command
endFtpSession();
161150-486 - B 7-13 BCI - VIDAS® Range

FTP Commands supported by the Server ASTM-XML (FTP) Messages
FTP Commands supported by the Server
The following table lists all the FTP commands supported by the server.
FTP
Description
Command
CHANGE WORKING DIRECTORY

This command allows the user to change the working directory of the remote system (retrieval
CWD or downloading of files) without altering the current session parameters. The transfer
parameters also remain unchanged. The argument is a valid access path in the local file
system language.
LIST
This command causes the server to send a list. If the pathname specifies a directory or another
group of files, the server should transfer a list of files in the specified directory or group. If the
LIST pathname specifies a file, then the server should send current information on the file. A null
argument implies the user’s current working directory. The data transfer is over the data
connection in ASCII type. These data may be hard to use automatically in a program, but may
be useful to a human user.
NAME LIST
This command causes a directory listing to be sent from server to user site. The pathname
should specify a directory or other system-specific file group descriptor; a null argument implies
NLST the current directory. The server will return a stream of file names and no other information. The
data will be transferred in ASCII type over the data connection as valid pathname strings
separated by <CRLF> or <NL>. This command is intended to return information that can be
used by a program to further process the files automatically.
NO ACTION
NOOP It simply prompts the server to send an "OK" reply. This command is useful for checking that the
server is operating correctly.
PASSWORD
The argument field is a Telnet string specifying the user’s password. This command must
immediately be preceded by the USER command, and completes the user’s identification for
PASS access control. Since the password is "sensitive" information, it is preferable to "mask" it as the
user types it, and to avoid it being displayed on the screen. However, it seems that the server
has no means of preventing the password from being disclosed. It is therefore the responsibility
of FTP clients to avoid explicit storage of the password and its display.
161150-486 - B 7-14 BCI - VIDAS® Range

PASSIVE
This command requests the server to "listen" on a data port and to wait for a connection rather
PASV
than initiate one upon receipt of a transfer command. The response to this command includes
the host and port address this server is listening to.
DATA PORT
The argument is a host port specification for the data port to be used in data connection. This
command and its associated responses are obligatory before transfer in active mode. The
argument is the concatenation of a fully qualified TCP/IP address, i.e. a 32-bit Internet address
PORT and a 16-bit TCP port address. This address information is divided into 8-bit fields, and the
value of each field is transmitted as a decimal number (in character string representation). The
fields are separated by commas. A PORT command is thus of the general form:
where h1 is the high order 8 bits of the Internet host address.
PRINT WORKING DIRECTORY

PWD
This command causes the name of the current working directory to be returned in the reply.
XPWD Identical to the PWD command.
LOGOUT
QUIT
This command terminates a USER session and closes the control connection.
RETRIEVE
This command causes the server to transfer a copy of the file, specified in the pathname, to the
RETR
server at the other end of the data connection. The status and contents of the file at the server
site will be unaffected.
STORE
This command causes the server to accept the data transferred via the data connection and to
STOR store the data as a file at the server site. If the file specified in the pathname exists at the server
site, then its contents will be replaced by the data being transferred. A new file is created at the
server site if the file specified in the pathname does not already exist.
SYSTEM
SYST This command is used to return the type of operating system which hosts the FTP server.
Whatever the OS, this command returns a single "UNIX" value.
TYPE
This argument specifies the type of representation for data used. This command manages a
TYPE single parameter:
I : binary transfer
A : ASCII transfer
161150-486 - B 7-15 BCI - VIDAS® Range

USER NAME
This argument field is a Telnet string identifying the user. The user identifier is that which is
required by the server for access to the file system of the server host. This command will
normally be the first command transmitted by the user after the control connections are made.
USER
The password is also required by the server. The server will accept a new USER command at
any time. This cancels any reference to the user, the password and the previous account by
restarting the session opening sequence. All the transfer parameters remain unchanged and
any file transfer in progress will be completed with the old session parameters.
HELP
HELP
Returns the list of commands accepted by the server.
IMPORTANT: A connection to an FTP server for transferring data must be done with the use of a
client. The client may seemingly use a set of commands which differs from the server’s
ones; these commands are Command Aliases, a shorthand for actual commands.
These command aliases vary from one client to another.
Here is a list of common Command aliases contained in many Clients and their equivalents:
Alias Equivalent Alias Equivalent
! QUIT mget RETR (used to automate the

retrieval of multiple files)
ascii TYPE A mls LIST (list contents of
multiple directories)
binary TYPE Ɩ mdir LIST (list contents of
multiple directories)
bye QUIT mput STOR (Stores multiple files)
cd CWD put STOR
dir LIST pwd PWD
get RETR quit QUIT
Is NLIST recv RETR
send STOR type TYPE
remotehelp HELP user USER
161150-486 - B 7-16 BCI - VIDAS® Range

FTP Return Codes ASTM-XML (FTP) Messages
FTP Return Codes
Below is a list of the FTP return codes with an explanation of what each means.
Code Explanation
150 File status okay; about to open data connection.
200 Command okay.
202 Command not implemented, superfluous at this site.
215 Name system type. Where name is an official system name from the list in the Assigned
Numbers document.
220 Service ready for new user.
221 Service closing control connection.
226 Closing data connection. Requested file action successful (for example, file transfer or
abort).
227 Entering Passive Mode (h1,h2,h3,h4,p1,p2).
230 User logged in.
250 Requested file action completed.
257 "PATHNAME" created.
331 User name okay, need password.
421 Service not available, closing control connection. This may be a reply to any command if
the service knows it must shut down.
425 Can’t open data connection.
451 Requested action aborted. Local error in processing.
500 Syntax error, command unrecognized. This may include errors such as command line
too long.
501 Syntax error in parameters or arguments.
530 Not logged in.
550 Requested action not taken. File unavailable (e.g., file not found, no access).
161150-486 - B 7-17 BCI - VIDAS® Range

Conventions to Follow in Writing Pseudocode ASTM-XML (FTP) Messages
Conventions to Follow in Writing Pseudocode
Below is a list of the conventions to follow.
Characters / Keywords Explanation
LOOP Describes an infinite loop, the code executed in the loop is enclosed in
brackets.
FOR var=MinValue to MaxValue Iteration on a variable var initialized at a minimum value (MinValue)
and iterated until the MaxValue (MaxValue exclusive) is reached.
The code to be executed for each iteration is enclosed in brackets.
IF condition THEN..ELSE The code enclosed in brackets which follows the THEN clause is only
executed if the condition is checked.
If the condition is not checked and an ELSE clause exists, the code
enclosed in brackets which follows the ELSE clause, is executed.
var = value Assigns a value "value" to a variable "var".
A == B Tests equality between two variables A and B.
// comment A green line preceded by the character "//" represents a comment.
Return = function (argument1, The functions that perform operations can be defined with or without
argument2, ..) arguments and can return a value. For functions without an argument,
the syntax is MyFunction().
object.function(argument1, ..) Syntax applied to object-oriented languages. The function "function"
is applied to the object "object".
161150-486 - B 7-18 BCI - VIDAS® Range

Introduction to XML Schema ASTM-XML (FTP) Messages
Introduction to XML Schema
XML schema is a language used to formally describe the content of an XML message. It is
derived from the works of the W3C consortium (World Wide Web) ; all the publications
(specifications, tutorials, etc.) are available at http://www.w3.org/XML/Schema.
The following two sections describe the notation used for the declaration of XML element
types and cardinalities.
Declaration of Types
In XML schema, there is a basic difference between complex types, which allow elements in
their content and may carry attributes, and simple types which cannot have element content
and cannot carry attributes.
New complex types are defined using the complexType element and such definitions typically
contain a set of element declarations, element references, and attribute declarations. The
declarations are not themselves types, but rather an association between a name and the
constraints which govern the appearance of that name in documents governed by the
associated schema. Elements are declared using the element element and attributes are
declared using the attribute element.
For example, USAddress is defined as a complex type, and within the definition of USAddress
we see five element declarations and each element is simple type: (string or decimal):
<xsd:complexType name="USAddress" >

<xsd:sequence>
<xsd:element name="name" type="xsd:string"/>
<xsd:element name="street" type="xsd:string"/>
<xsd:element name="city" type="xsd:string"/>
<xsd:element name="state" type="xsd:string"/>
<xsd:element name="zip" type="xsd:decimal"/>
</xsd:sequence>
</xsd:complexType>
Occurrence Constraints
An element is defined as optional by means of the value of the minOccurs attribute which is 0.
In general, an element is required to appear when the value of minOccurs is 1 or more. The
maximum number of times an element may appear is determined by the value of a maxOccurs
attribute in its declaration.
This value may be a positive integer such as 41, or the term unbounded to indicate there is no
maximum number of occurrences. The default value for both the minOccurs and maxOccurs
attributes is 1. Thus, when an element is declared without a maxOccurs attribute, the element
may not occur more than once. If both attributes are omitted, the element must appear exactly
once.
161150-486 - B 7-19 BCI - VIDAS® Range

VIDAS® PC XML Schema ASTM-XML (FTP) Messages
VIDAS® PC XML Schema
<?xml version="1.0" encoding="UTF-8"?>

<xsd:schema xmlns:xsd="http://www.w3.org/2001/XMLSchema">





<xsd:annotation id="general">
<xsd:documentation xml:lang="en">
Definition of ASTM-XML messages beteewn LIS and bioMerieux Analysis Instruments
direction LIS -> AI: use lisMessage
direction AI -> LIS: use aiMessage
This document contains material which is confidential and proprietary of bioMerieux
SA.
</xsd:documentation>
</xsd:annotation>

<xsd:element name="lisMessage" type="LisMessageType"/>
<xsd:complexType name="LisMessageType">
<xsd:sequence>

<xsd:element name="header" type="LisHeaderType"/>
<xsd:element name="request" type="RequestRecord" maxOccurs="unbounded"/>
</xsd:sequence>
</xsd:complexType>
<xsd:complexType name="LisHeaderType">
<xsd:sequence>
<xsd:element name="senderName" type="StringL20" minOccurs="0"/>

<xsd:element name="processingIdentifier" type="processingIdentifierType"
default="P" minOccurs="0"/>

<xsd:element name="version" type="xsd:string" fixed="1394-97"/>

<xsd:element name="dateTime" type="AstmDateTimeType"/>
</xsd:sequence>
</xsd:complexType>
<xsd:complexType name="RequestRecord">
<xsd:sequence>
<xsd:element name="patientInformation" type="PatientInformationRecord"/>
<xsd:element name="testOrder" type="LisTestOrderRecord" minOccurs="0"
maxOccurs="unbounded"/>
</xsd:sequence>
</xsd:complexType>
<xsd:complexType name="PatientInformationRecord">
<xsd:all>
161150-486 - B 7-20 BCI - VIDAS® Range


<xsd:element name="lastName" type="StringL30" minOccurs="0"/>
<xsd:element name="firstName" type="StringL30" minOccurs="0"/>
<xsd:element name="birthdate" type="AstmDateType" minOccurs="0"/>
<xsd:element name="sex" type="sexType" minOccurs="0"/>

<xsd:element name="physicianIdentifier" type="StringL20" minOccurs="0"/>

<xsd:element name="specimentType" type="StringL20" minOccurs="0"/>
<xsd:element name="comment" type="commentType" minOccurs="0"/>
</xsd:all>
</xsd:complexType>
<xsd:complexType name="TestRecord">
<xsd:all>

<xsd:element name="priority" type="priorityType" minOccurs="0"/>

<xsd:element name="actionCode" type="actionCodeType" minOccurs="0"/>
<xsd:element name="universalIdentifier" type="universalIdentifierType"/>

<xsd:element name="instrumentSectionId" type="StringL30" minOccurs="0"/>
</xsd:all>
</xsd:complexType>
<xsd:complexType name="universalIdentifierType">
<xsd:sequence>
<xsd:element name="testIdentifier" type="StringL4"/>
<xsd:element name="dilution" type="IntegerFrom1To999" minOccurs="0"/>
</xsd:sequence>
</xsd:complexType>
<xsd:complexType name="commentType">
<xsd:all>
161150-486 - B 7-21 BCI - VIDAS® Range



<xsd:element name="source" type="commentSourceType"/>

<xsd:element name="text" type="StringL100"/>

<xsd:element name="type" type="xsd:string" fixed="G"/>
</xsd:all>
</xsd:complexType>

<xsd:element name="aiMessage" type="AIMessageType"/>
<xsd:complexType name="AIMessageType">
<xsd:sequence>
<xsd:element name="header" type="AIheaderType"/>
<xsd:element name="requestResult" type="RequestResultRecord"
</xsd:sequence>
</xsd:complexType>
<xsd:complexType name="AIheaderType">
<xsd:complexContent>
<xsd:extension base="LisHeaderType">
<xsd:sequence>
<xsd:element name="instrumentName" type="StringL30"/>
<xsd:element name="serialNumber" type="StringL30" minOccurs="0"/>
</xsd:sequence>
</xsd:extension>
</xsd:complexContent>
</xsd:complexType>
<xsd:complexType name="RequestResultRecord">
<xsd:sequence>
<xsd:element name="testOrder" type="AiTestOrderRecord" minOccurs="0"
</xsd:sequence>
</xsd:complexType>
<xsd:complexType name="AiTestOrderRecord">
<xsd:sequence>
<xsd:element name="test" type="AiTestRecord" minOccurs="0"
</xsd:sequence>
</xsd:complexType>
<xsd:complexType name="AiTestRecord">
<xsd:sequence>
request -->
<xsd:element name="universalIdentifier" type="completeUniversalIdentifierType"/
>
161150-486 - B 7-22 BCI - VIDAS® Range


<xsd:element name="result" type="resultRecord" minOccurs="1"
</xsd:sequence>
</xsd:complexType>

<xsd:complexType name="completeUniversalIdentifierType">
<xsd:extension base="universalIdentifierType">
<xsd:sequence>
<xsd:element name="testName" type="StringL40"/>
<xsd:element name="tubePosition" type="IntegerFrom1ToInfinite" minOccurs="0"/>
<xsd:element name="testVersion" type="StringL2" minOccurs="0"/>
</xsd:sequence>
</xsd:extension>
</xsd:complexType>
<xsd:complexType name="resultRecord">
<xsd:sequence>

<xsd:element name="value" type="xsd:string"/>

<xsd:element name="unit" type="StringL30" minOccurs="0"/>

<xsd:element name="range" type="thresholdType" minOccurs="0"/>

<xsd:element name="abnormalFlags" type="StringL8" minOccurs="0"

<xsd:element name="resultStatus" type="resultStatusType" minOccurs="0"
default="F"/>

<xsd:element name="operatorName" type="StringL20" minOccurs="0"/>

<xsd:element name="resultDateTime" type="AstmDateTimeType"/>
<xsd:element name="bmxResultData" type="ManufacturerInformationRecord"
minOccurs="0"/>
</xsd:sequence>
</xsd:complexType>
<xsd:complexType name="ManufacturerInformationRecord">
<xsd:sequence>

<xsd:element name="containerType" type="StringL20" minOccurs="0"/>

<xsd:element name="disposable" type="DisposableType" minOccurs="0"

<xsd:element name="controlThresholdUnit" type="StringL30" minOccurs="0"/>
<xsd:element name="controlThresholdMinValue" type="StringL20" minOccurs="0"/>
<xsd:element name="controlThresholdMaxValue" type="StringL20" minOccurs="0"/>
</xsd:sequence>
</xsd:complexType>
161150-486 - B 7-23 BCI - VIDAS® Range

<xsd:complexType name="DisposableType">
<xsd:all>

<xsd:element name="reference" type="StringL20" minOccurs="0"/>

<xsd:element name="lotNumber" type="StringL20" minOccurs="0"/>
</xsd:all>
</xsd:complexType>



<xsd:simpleType name="thresholdType">
<xsd:restriction base="xsd:string">
<xsd:pattern value="[0-9]*\sto\s[0-9]*"/>
</xsd:restriction>
</xsd:simpleType>


<xsd:simpleType name="processingIdentifierType">
<xsd:enumeration value="P"/>
<xsd:enumeration value="T"/>
<xsd:enumeration value="D"/>
<xsd:enumeration value="Q"/>
</xsd:restriction>
</xsd:simpleType>


<xsd:simpleType name="priorityType">
<xsd:enumeration value="S"/>
<xsd:enumeration value="R"/>
</xsd:restriction>
</xsd:simpleType>


<xsd:simpleType name="actionCodeType">
<xsd:enumeration value="N"/>
<xsd:enumeration value="A"/>
</xsd:restriction>
</xsd:simpleType>


<xsd:simpleType name="sexType">
<xsd:enumeration value="U"/>
<xsd:enumeration value="M"/>
<xsd:enumeration value="F"/>
</xsd:restriction>
</xsd:simpleType>


<xsd:simpleType name="resultStatusType">
<xsd:enumeration value="C"/>
<xsd:enumeration value="X"/>
161150-486 - B 7-24 BCI - VIDAS® Range

<xsd:enumeration value="I"/>
</xsd:restriction>
</xsd:simpleType>


<xsd:simpleType name="commentSourceType">
<xsd:enumeration value="L"/>
</xsd:restriction>
</xsd:simpleType>


<xsd:simpleType name="IntegerFrom1To999">
<xsd:restriction base="xsd:nonNegativeInteger">
<xsd:minInclusive value="1"/>
<xsd:maxInclusive value="999"/>
</xsd:restriction>
</xsd:simpleType>


<xsd:simpleType name="IntegerFrom1ToInfinite">
</xsd:restriction>
</xsd:simpleType>


<xsd:simpleType name="AstmDateTimeType">
<xsd:annotation id="javadateformat1">
<xsd:appinfo>yyyyMMddHHmmss</xsd:appinfo>
</xsd:annotation>

<xsd:pattern value="[1-9][0-9]{3}((0[1-9])|(1[0-2]))((0[1-9])|([1-2][0-9])|(3[0-
1]))(0[0-9]|1[0-9]|2[0-3])([0-5][0-9]){2}"/>
</xsd:restriction>
</xsd:simpleType>


<xsd:simpleType name="AstmDateType">
<xsd:appinfo>yyyyMMdd</xsd:appinfo>
</xsd:annotation>

1]))"/>
</xsd:restriction>
</xsd:simpleType>


<xsd:simpleType name="StringL2">
161150-486 - B 7-25 BCI - VIDAS® Range

<xsd:maxLength value="2"/>
</xsd:restriction>
</xsd:simpleType>
</xsd:restriction>
</xsd:simpleType>
</xsd:restriction>
</xsd:simpleType>
</xsd:restriction>
</xsd:simpleType>
</xsd:restriction>
</xsd:simpleType>
</xsd:restriction>
</xsd:simpleType>
</xsd:restriction>
</xsd:simpleType>
</xsd:restriction>
</xsd:simpleType>
</xsd:restriction>
</xsd:simpleType>
</xsd:restriction>
</xsd:simpleType>
</xsd:schema>
161150-486 - B 7-26 BCI - VIDAS® Range

VIDAS® 3 XML Schema ASTM-XML (FTP) Messages
VIDAS® 3 XML Schema
<?xml version="1.0" encoding="UTF-8"?>

<xsd:schema xmlns:xsd="http://www.w3.org/2001/XMLSchema">





<xsd:annotation id="general">
<xsd:documentation xml:lang="en">
Definition of ASTM-XML messages beteewn LIS and bioMerieux Analysis Instruments
direction LIS -> AI: use lisMessage
direction AI -> LIS: use aiMessage
This document contains material which is confidential and proprietary of bioMerieux
SA.
</xsd:documentation>
</xsd:annotation>

<xsd:element name="lisMessage" type="LisMessageType"/>
<xsd:complexType name="LisMessageType">
<xsd:sequence>
<xsd:element name="header" type="LisHeaderType"/>
<xsd:element name="request" type="RequestRecord" maxOccurs="unbounded"/>
</xsd:sequence>
</xsd:complexType>
<xsd:complexType name="LisHeaderType">
<xsd:sequence>
<xsd:element name="senderName" type="StringL20" minOccurs="0"/>

<xsd:element name="processingIdentifier" type="processingIdentifierType"
default="P" minOccurs="0"/>

<xsd:element name="version" type="xsd:string" fixed="1394-97"/>

<xsd:element name="dateTime" type="AstmDateTimeType"/>
</xsd:sequence>
</xsd:complexType>
<xsd:complexType name="RequestRecord">
<xsd:sequence>
<xsd:element name="testOrder" type="LisTestOrderRecord" minOccurs="0"
</xsd:sequence>
</xsd:complexType>
<xsd:complexType name="PatientInformationRecord">
<xsd:all>
161150-486 - B 7-27 BCI - VIDAS® Range


<xsd:element name="lastName" type="StringL30" minOccurs="0"/>
<xsd:element name="firstName" type="StringL30" minOccurs="0"/>
<xsd:element name="birthdate" type="AstmDateType" minOccurs="0"/>
<xsd:element name="sex" type="sexType" minOccurs="0"/>

<xsd:element name="physicianIdentifier" type="StringL20" minOccurs="0"/>

<xsd:element name="specimentType" type="StringL30" minOccurs="0"/>

<xsd:element name="relevantClinicalInformation" type="xsd:string"
minOccurs="0"/>
</xsd:all>
</xsd:complexType>
<xsd:complexType name="TestRecord">
<xsd:all>
request -->
<xsd:element name="universalIdentifier" type="universalIdentifierType"/>

<xsd:element name="instrumentSectionId" type="StringL30" minOccurs="0"/>
</xsd:all>
</xsd:complexType>
<xsd:complexType name="universalIdentifierType">
<xsd:sequence>
<xsd:element name="testIdentifier" type="StringL4"/>
<xsd:element name="dilution" type="IntegerFrom1To9999" minOccurs="0"/>
161150-486 - B 7-28 BCI - VIDAS® Range



<xsd:element name="userFieldNo1" type="StringL40" minOccurs="0"/>

<xsd:element name="userFieldNo2" type="StringL40" minOccurs="0"/>
</xsd:sequence>
</xsd:complexType>
<xsd:complexType name="commentType">
<xsd:all>

<xsd:element name="source" type="commentSourceType"/>

<xsd:element name="text" type="StringL280"/>

<xsd:element name="type" type="xsd:string" fixed="G"/>
</xsd:all>
</xsd:complexType>

<xsd:element name="aiMessage" type="AIMessageType"/>
<xsd:complexType name="AIMessageType">
<xsd:sequence>
<xsd:element name="header" type="AIheaderType"/>
<xsd:element name="requestResult" type="RequestResultRecord"
</xsd:sequence>
</xsd:complexType>
<xsd:complexType name="AIheaderType">
<xsd:extension base="LisHeaderType">
<xsd:sequence>
<xsd:element name="instrumentName" type="StringL30"/>
<xsd:element name="serialNumber" type="StringL30" minOccurs="0"/>
</xsd:sequence>
</xsd:extension>
</xsd:complexType>
<xsd:complexType name="RequestResultRecord">
<xsd:sequence>
<xsd:element name="testOrder" type="AiTestOrderRecord" minOccurs="0"
</xsd:sequence>
</xsd:complexType>
<xsd:complexType name="AiTestOrderRecord">
<xsd:sequence>
<xsd:element name="test" type="AiTestRecord" minOccurs="0"
</xsd:sequence>
</xsd:complexType>
161150-486 - B 7-29 BCI - VIDAS® Range

<xsd:complexType name="AiTestRecord">
<xsd:sequence>
request -->
<xsd:element name="universalIdentifier" type="completeUniversalIdentifierType"/
>

<xsd:element name="result" type="resultRecord" minOccurs="1"
</xsd:sequence>
</xsd:complexType>

<xsd:complexType name="completeUniversalIdentifierType">
<xsd:extension base="universalIdentifierType">
<xsd:sequence>
<xsd:element name="testName" type="StringL40"/>
<xsd:element name="tubePosition" type="IntegerFrom1ToInfinite" minOccurs="0"/>
<xsd:element name="testVersion" type="StringL6" minOccurs="0"/>
</xsd:sequence>
</xsd:extension>
</xsd:complexType>
<xsd:complexType name="resultRecord">
<xsd:sequence>

<xsd:element name="value" type="xsd:string"/>

<xsd:element name="unit" type="StringL30" minOccurs="0"/>

<xsd:element name="range" type="thresholdType" minOccurs="0"/>

<xsd:element name="abnormalFlags" type="StringL8" minOccurs="0"

<xsd:element name="resultStatus" type="resultStatusType" minOccurs="0"
default="F"/>

<xsd:element name="operatorName" type="StringL20" minOccurs="0"/>

<xsd:element name="startDateTime" type="AstmDateTimeType" minOccurs="0"/>

<xsd:element name="resultDateTime" type="AstmDateTimeType"/>
<xsd:element name="bmxResultData" type="ManufacturerInformationRecord"
minOccurs="0"/>
</xsd:sequence>
</xsd:complexType>
161150-486 - B 7-30 BCI - VIDAS® Range

<xsd:complexType name="ManufacturerInformationRecord">
<xsd:sequence>

<xsd:element name="containerType" type="StringL20" minOccurs="0"/>

<xsd:element name="disposable" type="DisposableType" minOccurs="0"

<xsd:element name="extraResultData" type="xsd:string" minOccurs="0"/>

<xsd:element name="controlThresholdUnit" type="StringL30" minOccurs="0"/>
<xsd:element name="controlThresholdMinValue" type="StringL20" minOccurs="0"/>
<xsd:element name="controlThresholdMaxValue" type="StringL20" minOccurs="0"/>
</xsd:sequence>
</xsd:complexType>
<xsd:complexType name="DisposableType">
<xsd:all>

<xsd:element name="reference" type="StringL40" minOccurs="0"/>

<xsd:element name="disposableType" type="StringL40" minOccurs="0"/>

<xsd:element name="lotNumber" type="StringL40" minOccurs="0"/>

<xsd:element name="expirationDate" type="AstmDateType" minOccurs="0"/>
</xsd:all>
</xsd:complexType>



<xsd:simpleType name="thresholdType">
<xsd:pattern value="[0-9]*\sto\s[0-9]*"/>
</xsd:restriction>
</xsd:simpleType>

<xsd:simpleType name="processingIdentifierType">
<xsd:enumeration value="T"/>
<xsd:enumeration value="D"/>
</xsd:restriction>
</xsd:simpleType>

<xsd:simpleType name="priorityType">
161150-486 - B 7-31 BCI - VIDAS® Range

</xsd:restriction>
</xsd:simpleType>

<xsd:simpleType name="actionCodeType">
<xsd:enumeration value="A"/>
</xsd:restriction>
</xsd:simpleType>

<xsd:simpleType name="sexType">
<xsd:enumeration value="U"/>
</xsd:restriction>
</xsd:simpleType>


<xsd:simpleType name="resultStatusType">
<xsd:enumeration value="C"/>
<xsd:enumeration value="X"/>
</xsd:restriction>
</xsd:simpleType>

<xsd:simpleType name="commentSourceType">
<xsd:enumeration value="L"/>
161150-486 - B 7-32 BCI - VIDAS® Range

</xsd:restriction>
</xsd:simpleType>


<xsd:simpleType name="IntegerFrom1To9999">
<xsd:maxInclusive value="9999"/>
</xsd:restriction>
</xsd:simpleType>


<xsd:simpleType name="IntegerFrom1ToInfinite">
</xsd:restriction>
</xsd:simpleType>


<xsd:simpleType name="AstmDateTimeType">
<xsd:appinfo>yyyyMMddHHmmss</xsd:appinfo>
</xsd:annotation>

1]))(0[0-9]|1[0-9]|2[0-3])([0-5][0-9]){2}"/>
</xsd:restriction>
</xsd:simpleType>


<xsd:simpleType name="AstmDateType">
<xsd:appinfo>yyyyMMdd</xsd:appinfo>
</xsd:annotation>

1]))"/>
</xsd:restriction>
</xsd:simpleType>


</xsd:restriction>
</xsd:simpleType>
</xsd:restriction>
</xsd:simpleType>
161150-486 - B 7-33 BCI - VIDAS® Range

</xsd:restriction>
</xsd:simpleType>
</xsd:restriction>
</xsd:simpleType>
</xsd:restriction>
</xsd:simpleType>
</xsd:restriction>
</xsd:simpleType>
</xsd:restriction>
</xsd:simpleType>
</xsd:restriction>
</xsd:simpleType>
</xsd:restriction>
</xsd:simpleType>
</xsd:restriction>
</xsd:simpleType>
</xsd:restriction>
</xsd:simpleType>
</xsd:restriction>
</xsd:simpleType>
</xsd:schema>
161150-486 - B 7-34 BCI - VIDAS® Range

8 ASTM-XML System Specificities
Message Structure
LIS Message
This message is sent by the LIS to the VIDAS® range system and contains one or several
analysis request(s) to be performed.
AI Message
This message is sent by the VIDAS® range system to the LIS to report one or more result(s).
Figure 8-1: LIS/AI ASTM-XML Message Structure
161150-486 - B 8-1 BCI - VIDAS® Range

Data Types ASTM-XML System Specificities
Data Types
The table below lists all the possible fields with their associated characteristics. It applies to
both VIDAS® PC and VIDAS® 3 unless otherwise specified.
In this table:
 means that the field is managed

• In download (LIS to AI) that means that the field can be received.
• In upload (AI to LIS) that means that the field can be sent.
 means that the field is not managed.

• In download (LIS to AI) that means that the field cannot be received (if the field is in the
message, either the field will be ignored or an error will be generated).
• In upload (AI to LIS) that means that the field will never be sent.
Mandatory fields:
• In download (LIS to AI) that means that we expect these fields to be present.
• In upload (AI to LIS) that means that the fields will always be present.
Note: Unspecified fields are simply ignored.
LIS AI to Description / Additional

Attribute Value Type / Format / Constraints
to AI LIS Information
LIS Header / AI Header (Message header)

SenderName • Type: StringL20 Sender identification:
  • LIS to AI: the LIS can set any
Optional value. If no value is sent, this field
remains empty.
Note: As it is an optional field, no alarm • AI to LIS: the value returned is
management is done on this field. always “bioMerieux”.
ProcessingIdentifier • Type: StringL1
 
• Values:
P: Production
Q: QC
T: Training
D: Debug
Default value = P
Optional
Note: As it is an optional field, no alarm

management is done on this field.
However, if an invalid value is sent
(different from P, Q, T or D), the value is
simply ignored.
161150-486 - B 8-2 BCI - VIDAS® Range


Version VIDAS® PC VIDAS® 3 ASTM version used to create XML

  messages.
• Type: String • Type: String The value sent by the LIS must be
• Value: 1394-97 • Value: 1394-97 the same as the one sent by the AI
and is always “1394-97”. If not, it is
Optional Mandatory ignored.
Note: As it is an
optional field, no
alarm management
is done on this
field.
DateTime VIDAS® PC VIDAS® 3 Date and time of the message.

 
• Type: Date/ • Type: Date/
Time Time
• Format: • Format:
yyyyMMddHH yyyyMMddHH
mmss mmss
Optional Mandatory
InstrumentName • Type: StringL30 Name of the workstation (hostname)
  on which the message has been built
Mandatory only for AI messages (typically “BMXHOST1” for
VIDAS® PC and “VIDAS3PC01” for
VIDAS® 3).
serialNumber • Type: StringL30 Serial number of the instrument used
  to perform the analysis.
Optional
On VIDAS® PC, this value is filled in
the configuration.
Implementation note for VIDAS® 3:

for technical reasons, a system CAN
not connect to the BCI if the serial
number is not known. Therefore, the
connection from the VIDAS® 3 to the
BCI cannot be established unless the
VIDAS® 3 has been successfully
connected at least once in its lifetime
with a real instrument.
Patient Data
PatientIdentifer • Type: StringL17 The patient ID has to be unique. In
  other words, there can ONLY be ONE
Mandatory patient name/sex/birth date for a
given patient ID.
Note: An error is logged if the value sent
for this field is too long, missing or
unknown.
161150-486 - B 8-3 BCI - VIDAS® Range


LastName • Type: StringL30

 
Optional

long.
birthdate • Type: DateL8

 
• Format: yyyyMMdd
Optional
Note: Ignored in case of invalid format.
PatientSex • Type: StringL1

 
• Value:
U: Unknown
M: Male
F: Female
Default value = U
Optional
Note: Only the first character is

significant. It is not case sensitive.
If the value sent is invalid, the “-” value is

used.
Location • Type: StringL5 Corresponds to the so field in

  RS232.
Optional

long when received from the LIS.
If the field is empty or missing, the

existing value in the VIDAS® PC system
(potentially entered by the user in the
GUI) is left as-is and not erased.

SpecimenIdentifier • Type: StringL17 Contains the sample ID.
 
Mandatory For bioMérieux control tests
(i.e. Cx), this field contains both the
sample ID and the strip lot number
separated by a blank character.
The format of the strip lot number is
yymmdd-v where yy is the year, mm
the month, dd the day and v the
version (0 or 2).
For quality control tests (i.e. QCx),

this field contains the quality control
identifier, that is to say a string with a
maximum length of 12 characters.
161150-486 - B 8-4 BCI - VIDAS® Range


Comment • Type: StringL280 Comment associated to the

  specimen.
Optional
Note: Due to the XML structure, the
comment attribute is embedded inside a
Note: A LIS should send P and G
respectively as source and type, even if text tag, alongside a source and a type
tag.
in practice other values are accepted by
the system with no error.
Example:
If the field is empty or missing, the <comment>
®
existing value in the VIDAS PC system <source>P</source>
(potentially entered by the user in the <text>a comment</text>
GUI) is left as-is and not erased. <type>G</type>
</comment>
LIS / AI Test / Assay Data
TestIdentifier • Type: StringL4 Short assay name.
 
Mandatory The analysis request is rejected
(without raising any error) if the
Note: Truncated if too long. requested short assay name is not
supported by the system.
If the field is missing in an analysis

request, an error is raised and the
request is rejected.
TestName • Type: StringL40 Long assay name.
 
Mandatory
161150-486 - B 8-5 BCI - VIDAS® Range


Dilution VIDAS® PC VIDAS® 3 Important: If you do not activate the

  dilution option in the Connection
• Type: Integer • Type: Integer
configuration screen of VIDAS® 3,
Value: from 1 to Value: from 1 to and in the Configuration/Link_BCI
999 9999 screen of VIDAS® PC, the dilution
value sent by the LIS is ignored even
Optional Optional if it is present.
Mandatory for
quantitative test if Make sure this behavior meets the
corresponding customer’s expectations.
option is
activated in the
VIDAS® PC
system.
Note: If the requested test does not
support dilution (qualitative assays for
instance), the field is simply ignored.
For analysis requests on quantitative

assays, if the dilution sent from the LIS is
invalid, the request is rejected.
Moreover, for analysis requests on

quantitative assays:
- If the dilution value is missing whereas a
value was expected (dilution option
activated in the Connection
configuration screen of VIDAS® 3, and
in the Configuration/Link_BCI screen of
VIDAS® PC), the analysis request is
rejected.
- Conversely, if the dilution value is
present whereas a value was not
expected, the dilution value is ignored
(default value=1 is used instead and no
error is raised).
actionCode • Type: StringL1

 
• Value: always N
161150-486 - B 8-6 BCI - VIDAS® Range


Result Data
value • Type: String It corresponds to the TV or dose.
 
• Structure: The decimal separator is always the
dot.
<prefix> + <number> + “|” +
<interpretation>
The interpretation, if any, is always
where:
separated by a “I” character.
<prefix> may be the “<”, “>”
character or empty.
The “I” separator is mandatory.
<number> is a number
<interpretation> corresponds to
the result interpretation and is
optional.
• Value: see bMx Interpretation

Messages on page B-2 for
detailed information about
authorized values
Mandatory
unit • Type: StringL30
 
Optional
No unit value is sent from the system for

results on qualitative assays.
AbnormalFlags • Type: StringL8 1 single flag associated to the result.

 
• Value: see VIDAS® Flags on
page B-7 for detailed
information about possible
values
Optional
AbnormalFlags VIDAS® 3 ONLY Additional flags associated to the
  result.
• Type: StringL8
• Value: see VIDAS® 3 Flags on Important: the VIDAS® PC system
page B-8 for detailed does NOT support this attribute.
information about possible
values
Optional
161150-486 - B 8-7 BCI - VIDAS® Range


resultStatus • Type: StringL1 Only X and F status are managed.

 
• Value:
Note that a final result (F) may not
C: Correction of previously
have any result value (returned value
transmitted results
will be I).
P: Preliminary results
F: Final results
Results, final or not, may have
X: Order cannot be done
abnormal flags.
I: Pending results in instrument
S: Partial results
M: Result in a MIC level
R: Result was previously transmitted
N: Result record contains necessary
information to run a new order
Default value = F
Optional
OperatorName • Type: StringL20 Name of the operator logged when
  the result is computed.
Optional
ResultDateTime • Type: Date/Time Date/Time of the result
 
• Format: yyyyMMddHHmmss
Optional
Manufacturer Data
reference • Type: StringL40 Disposable ID (i.e. barcode of a strip,
  spr or diluent involved in the test
Optional result).
DisposableType VIDAS® 3 ONLY A value is always returned.

 
• Type: StringL40
• Value:
VIDAS_STRIP for a strip
VIDAS_SPR for a spr
VIDAS_DILUANT for a diluent
VIDAS_PRETREATMENT_REAGE
NT for reagents
VIDAS_DILUTION_CUPS for cups
VIDAS_TIPS for tips
Optional
lotNumber • Type: StringL40 Lot number of the strip, spr or diluent
  involved in the test result.
Optional
A value is always returned.
161150-486 - B 8-8 BCI - VIDAS® Range


expirationDate VIDAS® 3 ONLY Expiration date of the disposable.

 
• Type: Date/Time
• Format: yyyyMMdd
Optional
161150-486 - B 8-9 BCI - VIDAS® Range

CMVA Parameter Specific Description ASTM-XML System Specificities
CMVA Parameter Specific Description
On the VIDAS® 3 system, from version V1.2, the CMVA parameter has been updated,
meaning:
• A new PTC code corresponding this update

• A new CMVA management
Note: On the VIDAS® PC system, the CMVA parameter has not been updated.
Differences due to the CMVA Parameter Update
After the Update
For one CMVA test (patient or control) performed on the VIDAS® 3 system:
• 1 qualitative result is calculated automatically through the system (Avidity index) associated to
an interpretation (LOW/ INTERMED. / HIGH).
• The avidity index and the associated interpretation are sent in only one .xml file to the LIS
(see Figure 8-2).
Figure 8-2: XML file sent by AI to LIS with Avidity index and associated interpretation
161150-486 - B 8-10 BCI - VIDAS® Range

CMVA Parameter Specific Description ASTM-XML System Specificities
Before the Update
For one CMVA test (patient or control) performed on the VIDAS® 3 system or on the
VIDAS® PC system:
• 2 quantitative results are given (doses).

• The doses are sent in two similar .xml files to the LIS (see Figure 8-3).
Figure 8-3: One of the two XML files sent by AI to LIS with one dose value
• The avidity index is calculated manually through the system, according to the package insert
recommendation.
• Doses sent to the LIS cannot be used to determine the avidity index.
161150-486 - B 8-11 BCI - VIDAS® Range

9 Examples of ASTM-XML (FTP) Messages
Examples of Analysis Requests in ASTM-XML (FTP) Format
IMPORTANT: By default, all messages are compatible with all the systems in the VIDAS® range,
except if specified otherwise.
Note: The result value is a code which is not translated except for Chinese.
Analysis Request for AI

<?xml version="1.0" encoding="ISO-8859-1"?>
<lisMessage>
<header>
<version>1394-97</version>
<dateTime>20020101000000</dateTime>
</header>
<request>
<patientInformation>
<patientIdentifier>net#1524</patientIdentifier>
<lastName>lastname</lastName>
<sex>U</sex>
</patientInformation>
<testOrder>
<specimen>
<specimenIdentifier>net#0053</
specimenIdentifier>
</specimen>
<test>
<universalIdentifier>
<testIdentifier>TES</testIdentifier>
<dilution>1</dilution>
</universalIdentifier>
</test>
</testOrder>
</request>
</lisMessage>
161150-486 - B 9-1 BCI - VIDAS® Range

Examples of Analysis Requests in ASTM-XML (FTP) Format Examples of ASTM-XML (FTP) Messages
Analysis Request for AI with bioMérieux and Systematic Dispatching Mode
<?xml version="1.0" encoding="ISO-8859-1" ?>

<lisMessage xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:noNamespaceSchemaLocation="ASTM.xsd">
<header>
</header>
<request>
<patientIdentifier>200607230010</patientIdentifier>
<lastName>EWAN</lastName>
<birthdate>20011022</birthdate>
<sex>M</sex>
<location>LAB03</location>
…..….. </patientInformation>
<testOrder>
<specimen>
<specimenIdentifier>001020050908</specimenIdentifier>
</specimen>
<test>
<testIdentifier>FER</testIdentifier>
</universalIdentifier></Instrument section ID>
<actionCode>A</actionCode>
</test>
</testOrder>
</request>
</lisMessage>
161150-486 - B 9-2 BCI - VIDAS® Range

Analysis Request for AI with Laboratory Dispatching Mode

<header>
</header>
<request>
<sex>M</sex>
<testOrder>
<specimen>
</specimen>
<test>
<testIdentifier>FER</testIdentifier>
<InstrumentSectionId>BMXHOST0</InstrumentSectionId>
</test>
</testOrder>
</request>
</lisMessage>
Note: The <InstrumentSectionId> indicates the instrument ID towards which the analysis request
must be sent.
161150-486 - B 9-3 BCI - VIDAS® Range

Particular Cases
Analysis Request on assays with sub-assays (HIV5 or DUOLIS)

<header>
</header>
<request>
<sex>M</sex>
<testOrder>
<specimen>
</specimen>
<test>
<testIdentifier>HIV5</testIdentifier>
</test>
</testOrder>
</request>
</lisMessage>
161150-486 - B 9-4 BCI - VIDAS® Range

Examples of Analysis Results in ASTM-XML (FTP) Format Examples of ASTM-XML (FTP) Messages
Examples of Analysis Results in ASTM-XML (FTP) Format
Quantitative Result
<?xml version="1.0" encoding="ISO-8859-1"?>

<aiMessage>
<header>
<senderName>bioMerieux</senderName>
<instrumentName>VIDAS02</instrumentName>
<serialNumber>123</serialNumber>
</header>
<requestResult>
<lastName>dupont</lastName>
<sex>U</sex>
<location>lab01</location>
<testOrder>
<specimen>
</specimen>
<test>
<actionCode>N</actionCode>
<testIdentifier>TXG</testIdentifier>
<testName>TOXO IgG II</testName>
<result>
<value>4|EQUIVOCAL</value>
<unit>UI/ml</unit>
<abnormalFlags>valid</abnormalFlags>
<resultStatus>F</resultStatus>
<operatorName>vidas</operatorName>
<resultDateTime>20110311163131</resultDateTime>
</result>
</test>
</testOrder>
</requestResult>
</aiMessage>
161150-486 - B 9-5 BCI - VIDAS® Range

Qualitative Result
File: result_qualitative.xml
<test>
<testIdentifier>RBM</testIdentifier>
<testName>RUB IgM</testName>
<result>
<value>15.90|POSITIVE</value>
</result>
</test>
Particular Cases
Invalid Results
Note: The interpretation is a code and is NOT translated.
This message is the type of message returned by the system when a request has not been
taken in account (rejected request).
File: result_invalid_invalid_request.xml
<requestResult>
<test>
<testIdentifier>TES</testIdentifier>
<result>
<value>|</value>
<resultStatus>X</resultStatus>
</result>
</test>
</requestResult>
161150-486 - B 9-6 BCI - VIDAS® Range

This message is the type of message returned by the system when a result has not been
computed (for any reason, invalid reading, no calibration, etc.)
File: result_INVALID_no_result.xml
<test>
<result>
<value>INVALID|INVALID</value>
<abnormalFlags>conthnor</abnormalFlags>
</result>
</test>
Control out of Range on Qualitative Assays
<test>
<testIdentifier>TXGA</testIdentifier>
<testName>TOXO IgG Avidity</testName>
<result>
<value>1.003|HIGH</value>
<operatorName>db2bmx</operatorName>
</result>
</test>
161150-486 - B 9-7 BCI - VIDAS® Range

Results on Assays with Sub-assays (HIV5)
For results made of multiple sub-results and global results (such as HIV5), several results are
uploaded to the LIS.
• For the main result, the following rules are applied:

• "Short assay name": value of the main assay.
• "Long assay name": value of the main assay.
• "Qualitative result": value of the main assay.
• "Quantitative result": no value.
• For the sub results (antibody AB and antigen AG), the following rules are applied:
• "Short assay name": value of the current sub-assay.
• "Long assay name": value of the main assay
• "Qualitative result": value of the main assay.
• "Quantitative result": value of current sub-assay.
File: result_hiv5_line1.xml
<test>
<testIdentifier>HIV5</testIdentifier>
<testName>HIV DUO Ultra</testName>
<result>
<value>|POSITIVE</value>
</result>
</test>
161150-486 - B 9-8 BCI - VIDAS® Range

<test>
<testIdentifier>AB</testIdentifier>
<result>
</result>
</test>
<test>
<testIdentifier>AG</testIdentifier>
<result>
<value>ND|POSITIVE</value>
</result>
</test>
161150-486 - B 9-9 BCI - VIDAS® Range

Results on Assays with Sub-assays (LDUO)
For results made of multiple sub-results without global results (such as DUOLIS), each sub-
results are uploaded to the LIS.
File: result_lduo_line1.xml
<test>
<testIdentifier>DLMO</testIdentifier>
<testName>DUO Listeria monocytogenes</testName>
<result>
<value>0.03|NEGATIVE</value>
<abnormalFlags>calinc</abnormalFlags>
</result>
</test>
File: result_lduo_line2.xml
<test>
<testIdentifier>DLIS</testIdentifier>
<testName>DUO Listeria spp</testName>
<result>
<abnormalFlags>calinc</abnormalFlags>
</result>
</test>
161150-486 - B 9-10 BCI - VIDAS® Range

Additional Flags associated to Results
Note: Not compatible with VIDAS®PC.
This happens when the second abnormalFlags configuration field is checked to send more
result flags to LIS.
<test>
<result>
<abnormalFlags>manpipet</abnormalFlags>
<abnormalFlags>cabspr</abnormalFlags>
<abnormalFlags>cabstrip</abnormalFlags>
<abnormalFlags>stabexp</abnormalFlags>
</result>
</test>
161150-486 - B 9-11 BCI - VIDAS® Range

Results of Controls for TXG
Results of Controls for P24
Results of Quality Controls
161150-486 - B 9-12 BCI - VIDAS® Range

Examples of Connection Test Results (dummy files)
These are test messages configured in the bcinet.properties file.
Default dummy file name and content are:
bcinet.dummyfile.ftp.name=bmx_000000_000000_0.xml
bcinet.dummyfile.ftp.content=dummy message
bcinet.dummyfile.rs232.name=bmx_000000_000000_0
bcinet.dummyfile.rs232.content=mtbis
According to the selected interface, the message content is defined by the content
parameter.
Note: For more information about test messages, refer to BCI Link User Manual, ref. 4501-2122.
161150-486 - B 9-13 BCI - VIDAS® Range

Complete/Simplified Demography Mode (VIDAS® PC only)
In simplified demography mode, the “lastname” and “patientIdentifier” fields take the value of
the “specimenIdentifier”.
Complete Demography Mode
161150-486 - B 9-14 BCI - VIDAS® Range

Simplified Demography Mode
161150-486 - B 9-15 BCI - VIDAS® Range

Traceability Information associated to Results
Note: Not compatible with VIDAS®PC.
Some information may or may not be present, even if the analysis has been fully completed.
Under some circumstances, the VIDAS® 3 analyzer may not send any information for some
kind of disposable types or may not know some data on a specific disposable (for example,
expiration date).
Example 1: Traceability Information on VIDAS_SPR and VIDAS_STRIP associated to a Result
<result>
<value>23.53|</value>
<unit>ug/l</unit>
<bmxResultData>
<disposable>
<reference>CPODK1</reference>
<disposableType>VIDAS_SPR</disposableType>
<lotNumber>CPO</lotNumber>
<expirationDate>20140210</expirationDate>
</disposable>
<disposable>
<reference>C6PNB1AP2</reference>
<disposableType>VIDAS_STRIP</disposableType>
<lotNumber>140210-0</lotNumber>
</disposable>
</bmxResultData>
</result>
161150-486 - B 9-16 BCI - VIDAS® Range

Example 2: Traceability Information on VIDAS_SPR and VIDAS_STRIP and

VIDAS_PRETREATMENT_REAGENT (control) associated to a Result
<result>
<unit>mUI/ml</unit>
<bmxResultData>
<disposable>
<reference>CPRK9F</reference>
<lotNumber>CPR</lotNumber>
</disposable>
<disposable>
<reference>C7JZO14PG</reference>
</disposable>
<disposable>
<reference>1047940</reference>
<disposableType>VIDAS_PRETREATMENT_REAGENT</disposableType>
<lotNumber>1047940</lotNumber>
</disposable>
</bmxResultData>
</result>
Example 3: Traceability Information on VIDAS_SPR and VIDAS_STRIP and

VIDAS_PRETREATMENT_REAGENT (control) and VIDAS_DILUANT associated to a Result

<aiMessage>
<header>
<senderName>bioMerieux</senderName>
<instrumentName>1013</instrumentName>
<serialNumber>1013</serialNumber>
</header>
<requestResult>
<patientIdentifier>1839-1906</patientIdentifier>
<lastName />
<sex>U</sex>
<location />
161150-486 - B 9-17 BCI - VIDAS® Range

<testOrder>
<specimen>
</specimen>
<test>
<testIdentifier>T3</testIdentifier>
<testName>T3</testName>
<result>
<unit>nmol/l</unit>
<bmxResultData>
<disposable>
<reference>CSQIUJ</reference>
<lotNumber>CSQ</lotNumber>
</disposable>
<disposable>
<reference>ANCPV1QP5</reference>
</disposable>
<disposable>
<reference>20121114-1</reference>
<disposableType>VIDAS_DILUANT</disposableType>
</disposable>
<disposable>
<disposableType>VIDAS_DILUTION_CUPS</disposableType>
</disposable>
</bmxResultData>
</result>
</test>
</testOrder>
</requestResult>
</aiMessage>
161150-486 - B 9-18 BCI - VIDAS® Range

Example 4: Incomplete VIDAS_SPR Traceability Information
<result>
<value>INVALID|INVALID</value>
<unit>ug/l</unit>
<bmxResultData>
<disposable>
<reference>?</reference>
</disposable>
<disposable>
<reference>C6PLN1AP</reference>
</disposable>
<disposable>
<disposableType>VIDAS_PRETREATMENT_REAGENT</disposableType>
</disposable>
</bmxResultData>
</result>
161150-486 - B 9-19 BCI - VIDAS® Range

10 Error and Duplication Management
There are two ways of tracing errors:
• Error: the error is displayed in the system user interface, that is to say that the user is
notified about the problem.
Note: The exact error code and severity level (red/orange) of each alarm are not described here.
Refer to the BCI Link User Manual, ref. 4501-2122, for more detailed information.
• Log: the error is traced in the log file for BCI but the user is NOT notified about the problem.
The tables below sum up the software behavior while receiving invalid analysis request from
the BCI.
Error Management in VIDAS® 3
Case Notification Consequence

Wrong field separator or message Error Test is NOT created
structure
Needless field None Test is created
Optional field missing Log Test is created
Mandatory field missing Error Test is NOT created
Optional field too long Error Test is created (field is truncated)
Mandatory field too long (rt only) Error Test is created (field is truncated)
Mandatory field pi o ci too long Error Test is NOT created
Optional field empty None Test is created
Mandatory field empty Error Test is NOT created
Optional field format is invalid Log Test is created
Dilution missing or invalid for a test Error Test is NOT created
that allows dilution if dilution field
selected
Patient ID with existing and Refer to the Duplication Management section on page 10-2.
different patient information
When a test is rejected, an invalid result is returned by the VIDAS® 3 system.
161150-486 - B 10-1 BCI - VIDAS® Range

Error Management in VIDAS® PC Error and Duplication Management
Error Management in VIDAS® PC
Case Notification Consequence

Message type missing None Test is NOT created
Patient name too long Log Test is created (field is truncated)
Patient date of birth invalid None Test is created (field is ignored)
Sample origin too long Log Test is created (field is truncated)
Sample origin contains spaces None Test is created (spaces are deleted)
Unknown short assay name Log Test is NOT created
Invalid dilution factor Error Test is NOT created
Patient sex value too long Log Test is created (“-” default value is assigned)
Patient sex value different from the value None Test is created
saved on VIDAS®PC (if the “allowLisDemographyChange” option
is activated, a message is displayed asking
the user whether or not he wants to update
the patient data)
Patient sex value unknown Log Test is created (“-” default value is assigned)
Mandatory field missing Error Test is NOT created
Patient ID or sample ID too long Error Test is NOT created
Unsupported dilution ratio Error Test is NOT created
Short assay name too long Log Value is truncated.
Once truncated, message is rejected if short
assay name is unknown.
Duplication Management
Duplication case 1:
A request comes from the LIS with a known patient ID but with a name and/or sex and/
or birth date different from those stored in the database.
The user is notified and has to choose between:
• Update the demography with the information received from the LIS.
• Keep the demography as it is.
In all cases, a log is created and patient data changes are traced:
- Using a “green” alarm (error code 7001) in the VIDAS® 3 database

- Displaying a user message in VIDAS® PC
WARNING
In case of updating the demography with the information received from the
LIS, the modified field (patient name and/or patient sex and/or patient
birthdate) will be updated for all results connected to this patient ID.
161150-486 - B 10-2 BCI - VIDAS® Range

Duplication Management Error and Duplication Management
Duplication case 2:
A request comes from the LIS with a sample ID that is in the job list or has been used in
the day.
Note: A sample ID represents a unique sample if it has been created/edited either the current day or
the day before (i.e. in the last 24 hours till the end of the day) or if it is present in the job list.
In case of modification of the sample data, the data will be updated without any user
notification. No new sample will be created.
In case of modification of the patient ID associated to the sample, the request is rejected if the
sample has already been computed. If it has not been computed yet, the user is notified and
has to choose between:
• Update the patient ID with the information received from the LIS
• Keep the patient ID as it is (If a result has already been obtained, the request is refused)
In all the cases, a log is created and patient ID changes are traced:
- Using a “green” alarm (error code 7002) in the VIDAS® 3 database

- Displaying a user message in VIDAS® PC
Duplication case 3:
A request comes from the LIS with a sample ID and test and dilution that already exist.
No new request is created.
Duplication case 4:
A request comes from the LIS with a known sample ID and update of the sample origin
data.
The request is updated accordingly.
Duplication case 5:
A request comes from the LIS with a known sample ID and update of the patient name
data.
User notification to update (or not) the patient demography.
Duplication case 6:
Same request comes twice from the LIS.
The request is updated but nothing changes (silent update).
Duplication case 7:
A request comes from the LIS with a sample ID, patient ID, patient name, test and
sample origin data that already exist BUT with different dilution value and/or different
test.
A new request is created.
161150-486 - B 10-3 BCI - VIDAS® Range

BCI Simulators
11 Introduction to the BCI Simulators
Purpose
This installation procedure describes the standalone installation for the BCI Simulators
product, version 4.0.0.
This procedure is intended for use by bioMérieux representatives and partner computer
companies who are responsible for developing connections.
• Minimum Hardware configuration:

PC Pentium III – 256 Mo RAM
• Targets:
BCI Simulator runs on Windows XP SP1 and higher.
• Restrictions:
Depending on the selected Windows display, some graphical widgets of BCI LINK may not
display properly. In this case, go back to the original Windows display:
1. Right-click on your desktop.
2. Select Properties.
3. Activate the Appearance tab.
4. From the Windows and Buttons menu, select Windows Classic.
5. Click OK.
Content of the Master
The following table describes the content of the BCI Simulators components
(BCI SIMULATORS R2.Ø.ØX.X.X directory).
Software / Component Location on the media

BCI Simulators R2.Ø.ØX.X.X including \simulators
Java Runtime Environment 1.6.0_20
161150-486 - B 11-1 BCI - VIDAS® Range

12 Installation Procedure
IMPORTANT: Before starting an installation, update or uninstallation procedure, log in as

administrator or use a login with appropriate authorizations on the computer.
The Windows version must be based on XP (including XP embedded) or higher.
BCI Link must NOT already be installed on the system. If it is, a WARNING message will
be displayed at the beginning of the installation procedure.
General Description
As a convention, in this document the notation “[…]” is used to designate the disk defined for
installing the software (e.g. “C:\” or “D:\”) and “M:” is used to designate the CD or DVD drive.
Recommendation: in order to simulate real configurations, it is advisable to install the

Simulators on a dedicated PC, which hosts no BCI software.
Installing the BCI Simulator
IMPORTANT: When installing the BCI Simulators master, all the data located in the "BCI Simulators"
directory will be erased (ex: worklist, results...).
1. Insert the master into the CD-ROM or DVD drive.

2. Select BCI SIMULATOR > BCI SIMULATORS R4.0.0 and launch the setup.exe file.
The following BCI Simulator Setup Wizard is displayed.
Figure 12-1: BCI Simulator Setup Wizard
3. Click Next to start the installation.

The default folder path is displayed.
4. Click Next.
The following Environment Variables Configuration screen is displayed.
161150-486 - B 12-1 BCI - VIDAS® Range

Installing the BCI Simulator Installation Procedure
Figure 12-2: Environment Variables Configuration
5. Check that the Nameservice port is set to 29000 and click Next.
The Ready to install screen is displayed.
6. Click Install.
The installation starts automatically. The progress bar is displayed.
When installation is finished the following window is displayed.
Figure 12-3: BCI Simulator Setup completed
7. Click Finish to close the window.

Installation is now complete.
161150-486 - B 12-2 BCI - VIDAS® Range

Uninstalling the BCI Simulator Installation Procedure
Uninstalling the BCI Simulator
Preliminary Steps
Note: Before starting an uninstallation procedure, log in as administrator or use a login with
appropriate authorizations on the computer.
• Stop the BCI Simulator application if necessary.

• Log in as an administrator.
Uninstalling BCI Simulators

1. From the Windows Start menu, select All Programs > BCI Simulator >
Uninstall BCI Simulator.
A message is displayed asking you to confirm the uninstallation of the BCI Simulator (the
uninstaller removes all the BCI Simulator components).
2. Click Yes to confirm the uninstallation.

3. The uninstallation starts automatically. Wait until the process is finished.
A message is displayed to confirm that the BCI Simulator was successfully removed.
4. Click OK to close the message.

The BCI Simulator uninstallation process is now finished.
161150-486 - B 12-3 BCI - VIDAS® Range

13 Principle of Operation
The following table lists the main functions of each simulator.
Type of simulation Features
Simulation of a LIS system:

- Editing of analysis requests in ASTM-XML format, including help with
entry, and syntactic and semantic control of messages.
LIS simulator (FTP - Free editing (no format constraints) of analysis requests.
communication)
- Transmission of analysis requests to BCI Link.
- Receipt of results from BCI Link.
This simulator works with BCI Link.
Simulation of a LIS system:

- Editing of analysis requests in bioMérieux format, including help with
entry, and syntactic and semantic control of messages.
- Free editing (no format constraints) of analysis requests.
LIS simulator (RS232
communication) - Transmission of analysis requests to BCI Link.
- Receipt of results from BCI Link.
- Supervision of exchanges on the RS232 line.
This simulator only works with BCI RS232 or BCI Link.
LIS simulator (ASTM

Not used in the VIDAS® Range.
communication)
Simulation of 1 to 20 AIs. Each system has the following functionalities:

- Request BCI to open a work session.
- Request BCI to close a work session.
- Edit results in ASTM-XML format, including help with entry, and
syntactic and semantic control of messages.
AI simulator - Edit results in bioMérieux format, including help with entry, and
syntactic and semantic control of messages.
- Free editing (no format constraints) of results.
- Transmit results to BCI.
- Receive analysis requests from BCI.
This simulator works with BC RS232 and BCI Link.
161150-486 - B 13-1 BCI - VIDAS® Range

Principle of Operation
The simulators can be used separately to enable the following configurations:
• LIS FTP simulator only: BCI LINK is connected to one or more bioMérieux systems and to
the LIS simulator. This configuration is used to test communication between BCI LINK and a
bioMérieux AI without connecting to a client LIS (a LIS FTP simulator is used).
• LIS RS232 simulator only: BCI LINK is connected to a bioMérieux system and to the LIS
simulator. This configuration is used to test communication between BCI LINK and a
bioMérieux AI without connecting to a client LIS (a LIS RS232 simulator is used).
• LIS ASTM simulator only: BCI LINK is connected to a bioMérieux system and to the LIS
simulator. This configuration is used to test communication between BCI LINK and a
bioMérieux AI without connecting to a client LIS (a LIS ASTM simulator is used).
• AI simulator only: BCI is connected to the client LIS and to one or more AI simulators
(connection of several AI is only supported by BCI LINK). This configuration is used to test
communication between a BCI product and the LIS without connecting to a bioMérieux AI (an
instrument simulator is used).
• LIS simulator (RS232 or FTP) and AI simulator: A BCI is connected to an LIS simulator and
to one or more AI simulators. This configuration enables the use of BCI LINK, outside an
operating context. The latter configuration is only used for training or support on the BCI
products.
IMPORTANT: The BCI Simulator software requires a minimum screen resolution of 800 x 600 pixels.
Note: To run the BCI Simulators, use the shortcut created by the installation program or run \BCI
Simulators\bin\run.wsf.
161150-486 - B 13-2 BCI - VIDAS® Range

User Interface Principle of Operation
User Interface
Opening BCI Simulators

1. From the computer desktop, double-click .
The session opens on the following Select instrument dialog box.
Figure 13-1: Opening BCI Simulators
2. Select the instrument and click OK.

The BCI Simulators interface is displayed.
161150-486 - B 13-3 BCI - VIDAS® Range

Description of the Interface
4
3
5 6
Figure 13-2: BCI Simulators Interface
1 — The navigation bar consists of four icons which respectively give access to the LIS
RS232 simulator, the LIS ASTM simulator, the LIS FTP simulator and the AI simulator
(refer to the corresponding sections for more information about the functionalities of the
different simulators).
Note:The LIS ASTM simulator is not used in the VIDAS® Range
2 — The sub-navigation bar gives access to all the functionalities linked with the simulator
selected in the navigation bar.
3 — The action bar offers possible actions for the selected functionality.
4 — The work area.
5 — The clock gives the date and time of the system.
6 — The information area displays the name and version of the software.
161150-486 - B 13-4 BCI - VIDAS® Range

Description of the Functionalities
The LIS RS232 simulator is used to produce analysis requests in different formats,
transmit them to BCI Link, and receive results from bioMérieux analysis
instruments.
This simulator has the following functionalities:
Management of analysis requests in the "bioMérieux" format:
an editor is used to create, save, edit and transmit analysis
requests in the bioMérieux format. It includes data entry help tools,
and ensures a syntactic and semantic control of any errors
contained in the messages edited.
Management of "text" messages: an editor is used to create,
save, edit and transmit analysis requests in a free format called
“text” format.
Supervision of the communication: for real time monitoring of
data interchange between the simulator and the BCI Link.
LIS connection, which is used to configure the RS232 connection
(configuration of the serial connection and the protocol used).
The LIS ASTM simulator is used to produce analysis requests without format
constraints (free editing), transmit them to BCI Link and receive results from
bioMérieux analysis instruments.
Management of "ASTM" messages: an editor is used to create,
save, edit and transmit analysis requests in an ASTM E1394
format.
“text” format.
Supervision of the communication: for real time monitoring of
data interchange between the simulator and the BCI Link.
LIS connection, which is used to configure the protocol type and
the TCP/IP information.
161150-486 - B 13-5 BCI - VIDAS® Range

The LIS FTP simulator is used to produce analysis requests in different formats,
transmit them to BCI Link, and receive results from bioMérieux analysis
instruments.
Management of analysis requests in "ASTM-XML" format: an
editor is used to create, save, edit and transmit analysis requests in
the ASTM-XML format. It includes data entry help tools, and
ensures a syntactic and semantic control of any errors contained in
the messages edited.
“text” format.
Reception of results sent by BCI Link: this is used to view the list
of results available in the "upload" directory, and to locally download
them to the LIS simulator.
LIS connection: this is used to view connection parameters and
test the corresponding connection. A window enables FTP errors to
be viewed if the connection fails.
The AI simulator is used to receive analysis requests from BCI Link, elaborate
results in different formats using analysis requests received, and transmits the
results to BCI.
Management of analysis requests in "ASTM-XML" format: an
editor is used to create, save, edit and transmit analysis requests in
the ASTM-XML format. It includes data entry help tools, and
ensures a syntactic and semantic control of any errors contained in
the messages edited.
save, edit and transmit results in a free format called “text” format.
Management of results in the "bioMérieux" format: an editor is
used to create, save, edit and transmit results in the bioMérieux
format. It includes data entry help tools, and ensures a syntactic
and semantic control of any errors contained in the messages
edited.
Management of AI sessions: this enables you to close an analysis
instrument/BCI Link session.
Receipt of analysis requests from BCI: analysis requests transmitted by BCI are
automatically stored locally on the simulator.
161150-486 - B 13-6 BCI - VIDAS® Range

Defining Parameters for the Simulator Text Editors

The text editors’ properties file is located in:
\lib\properties\simulator\messages.properties.
To modify the properties for configuration of the text editors:
• Edit this file using a text editor (Notepad.exe or Wordpad.exe).
Note: The simulator.defaultSubDirectory and simulator.fileExtension properties

should be updated according to the BCI product used.
SCHEMA_SOURCE=<Location of the default XML-schema for editing ASTM-

XML messages.
NEW_LIS_MESSAGE=<Name of the message file used to create ASTM-XML.
analysis requests. This message template can be modified to
correspond as far as possible to the LIS "type" message>.
NEW_AS_MESSAGE==<Name of the message file used to create new ASTM-
XML results>. This message template can be modified to correspond as far as possible
to the bioMérieux system "type" message.
simulator.defaultInputDir= <Used by LIS simulators: default
directory in which LIS simulator analysis requests are stored>. The
default directory is lis_worklist.
simulator.defaultOutputDir=<Used by LIS simulators: default
directory in which BCI results are stored>. The default directory is
lis_results.
simulator.defaultInputInstrumentDir. <Used by instrument
simulators: default directory in which BCI analysis requests are
stored>. The default directory is instr_worklist.
simulator.defaultOutputInstrumentDir. <Used by instrument
simulators: default directory in which results are stored>. The
default directory is instr_results.
simulator.astm.subdirectory=<Default subdirectory in which astm-xml
format messages are stored>. The default directory is astm_xml. This means
that analysis requests in astm-xml format are stored under
\lis_worklist\astm_xml and results under \lis_results\astm_xml>.
simulator.scriptsDir=< Default directory in which the scripts used
by the LIS RS232 simulator are stored>.
simulator.dataDir==< Default directory in which the data files used
by the LIS RS232 simulator are stored>.
simulator.ftp.subdirectory=<default subdirectory in which the BCI
messages received by the ftp protocol are stored>.
simulator.astm.subdirectory and simulator.bmx.subdirectory=<same as
simulator.ftp.subdirectory for “astm” and “bmx” protocols >
simulator.ftp.messagePrefix=<the expected beginning of a file
received with the FTP protocol>.
simulator.astm.messagePrefix and simulator.bmx.messagePrefix=<same
as simulator.ftp.messagePrefix for “astm” and “bmx” protocols >
161150-486 - B 13-7 BCI - VIDAS® Range

Sub-folders Architecture of the BCI Simulators Directory Principle of Operation
simulator.ftp.fileExtension=<the extension of the file received by

the FTP protocol if the messagePrefix match the expected one >
simulator.astm.fileExtension and simulator.bmx.fileExtension=<same
as simulator.ftp.fileExtension for “astm” and “bmx” protocols >
ENCODING_TYPE=<Type of encoding used for messages (whatever the
format)>. "ISO-8859-1" encoding is used by default.
Sub-folders Architecture of the BCI Simulators Directory
The BCI Simulators directory is shown below.
Figure 13-3: BCI Simulators Directory
161150-486 - B 13-8 BCI - VIDAS® Range

14 LIS – RS232 SIMULATOR
Accessing the LIS Simulator and Setting Parameters
Setting Parameters for the RS232 Connection (serial port and protocol)
To define parameters for a BCI RS232 or BCI Link connection when communication is
stopped:
1. Click to access the RS232 connection parameters.
Figure 14-1: Setting RS232 Connection Parameters
2. Select the Protocol you want to use in the corresponding drop-down list.
3. Define the parameters of the Serial Port based on the selected configuration.
Note: The serial port to be set is the one used on BCI Simulators host computer.
4. Configure the selected protocol.
5. Click to save the new configuration.
IMPORTANT: The new configuration must be saved before communication is started since the
software takes into account the saved configuration and not the configuration
displayed on the screen.
161150-486 - B 14-1 BCI - VIDAS® Range

Accessing the LIS Simulator and Setting Parameters LIS – RS232 SIMULATOR
The parameters of the LIS simulator in ASCII format are automatically exported during the
save. The export file is located in: \config\configuration.bmx.txt.
The simulator offers the 3 bMx communication protocols used for BCI RS232 or BCI Link:
• Standard bioMérieux protocol: "bioMérieux literal"

The parameters of this protocol are the same as those of BCI RS232 or BCI Link. For more
detailed information, refer to the corresponding documentation.
The simulator has an additional option called Protocol mode which is used to define the type
of transmission. Single session mode is used to transmit the application messages in a
single session (a single ENQ..EOT sequence). Multiple session mode is used to send one
ENQ..EOT sequence per application message.
Transmission of two application messages in "multiple session":

12:26:07=> <ENQ>
12:26:07<= <ACK>
12:26:07=> <STX>
12:26:07=> <RS>mtmpr|pi1232|pnza|psMale|si|ci12131|rtHIV
12:26:07=> <GS>7c
12:26:07<= <ACK>
12:26:07=> <ETX>
12:26:07=> <EOT>
12:26:07=> <ENQ>
12:26:07<= <ACK>
12:26:07=> <STX>
12:26:07=> <GS>1d
12:26:07<= <ACK>
12:26:07=> <ETX>
12:26:07=> <EOT>
Transmission of two application messages in "single session":
12:25:49=> <ENQ>
12:25:49<= <ACK>
12:25:49=> <STX>
12:25:49=> <GS>7c
12:25:49<= <ACK>
12:25:49=> <ETX>
12:25:49=> <STX>
12:25:49=> <GS>1d
12:25:49<= <ACK>
12:25:49=> <ETX>
12:25:49=> <EOT>
161150-486 - B 14-2 BCI - VIDAS® Range

• Alternate bioMérieux protocol: "bioMérieux literal alternate"

The literal alternate and literal protocols are similar except for the following parameters:
- Literal: <GS>xx<ACK><ETX><EOT>
- Literal alternate: <GS>xx<ETX><ACK><EOT>
• Manual bioMérieux protocol: "bioMérieux manual": this protocol is used to manually

transmit the control characters used in the bioMérieux protocols and to execute the scripts
based on these protocol commands. The "bioMérieux manual" protocol has only one
parameter which is the response time of the host computer.
Restrictions of the serial driver: The connection driver under Windows does not support the
following configurations:
- Parity MARK / SPACE.
- Value 1.5 for the "stop bit" option.
- Speed 14400 and 56000 or greater.
161150-486 - B 14-3 BCI - VIDAS® Range

Starting/Stopping the RS232 Communication Server

The RS232 communication server is started as follows:
1. Click to access the Supervision screen.
Figure 14-2: Starting/Stopping RS232 Connection
2. Click or to respectively start or stop the communication server.

3. Check the Communication status of the server after starting or stopping.
The following server statuses are possible:
• Off: the server has not been started. Communication with the host computer is not
possible.
• Is ready: communication has started but there is no data interchange.
• Is downloading: data are being sent by the simulator.
• Is uploading: data are being sent by the host computer.
• Out of order: an error has occurred with the server.
Note: A common error is the use of a serial port that is already being used for another application
(make sure you follow the procedure described in the Setting Parameters for the RS232
Connection (serial port and protocol) section on page 14-1.
161150-486 - B 14-4 BCI - VIDAS® Range

Selecting a Protocol
To use one of the protocols in the list of bioMérieux protocols, proceed as follows:
1. From the configuration screen, select the protocol you want on the configuration screen
(refer to the Setting Parameters for the RS232 Connection (serial port and
protocol) section on page 14-1).
2. Check that the parameters for this protocol are correct. If not, modify the values as
required and save the configuration so that it is taken into account.
3. Stop the communication server if necessary, and then restart it to take into account
selection of the new protocol. This is done using the supervision screen (refer to the
Starting/Stopping the RS232 Communication Server section on page 14-4).
4. Check the status of the server on the supervision screen (Status: "Is ready").
Note: For the literal alternate and literal bioMérieux protocols, you can define the size of the <RS>
and <STX>..<ETX> blocks which, by default, are 80 and 1920 respectively.
The messages.properties file allows you to modify these values:
# record max length and application message max length

bmx_messages.max_block_size=1920
bmx_messages.max_record_size=80
However, it is recommended to keep these default values.
161150-486 - B 14-5 BCI - VIDAS® Range

Communication Supervision LIS – RS232 SIMULATOR
Communication Supervision
Display Communication Tracking Data in Real Time

Data conveyed between the LIS simulator and the BCI RS232 or BCI Link host can be viewed
at any time.
The supervision screen (refer to the Starting/Stopping the RS232 Communication

Server section on page 14-4) displays the sent/received commands in chronological order
(last command at the top of the list).
The supervision screen displays the following data:
1 4
2 3
Figure 14-3: Supervision Screen Display
1 — Command transmission/reception time.

2 — Message direction [ => = transmission (green) and <= = reception (blue)].
3 — Control character transmitted or received. An empty control < > indicates that the
BCI RS232 or BCI Link host did not respond on time.
Note: You may need to increase the delays and time out (refer to the Setting Parameters for the
RS232 Connection (serial port and protocol) section on page 14-1).
4 — Data associated with a control character. If the message is longer than the line
displayed, three suspension points are added to the end of the line and the complete
message appears in a popup window when the mouse is moved along the line.
Two other types of messages are displayed in this field:
- End communication: indicates that transmission or reception of a message is
completed.
- FAILED OPERATION, <error message>: indicates that an error has occurred

during execution of the protocol. For example, transmission of <RS> after a
<ENQ><ACK> sequence generates the following error message for the literal
bioMérieux protocol: FAILED OPERATION, incorrect control – expected
<STX>, <EOT>
Any non-printable characters (between 0 and 32) are displayed in <ASCII code>
form like the protocol control characters.
161150-486 - B 14-6 BCI - VIDAS® Range

Using the Manual Protocol LIS – RS232 SIMULATOR
Initialize the List containing Communication Tracking Data
Delete Deletes any tracking data displayed on the screen.
IMPORTANT: This action does not delete tracking data contained in the log file (refer to the Archiving
Communication Tracking Data section below).
Archiving Communication Tracking Data

A log file is located in the \logs directory. The rule for naming log files is the following
realtime_rs232_Simu_x.txt. where x is a number (0 is always the more recent file). This
file is automatically updated when new tracking data is displayed on the supervision screen.
The data contained in this file are identical to the data managed in the tracking window on the
supervision screen.
Using the Manual Protocol
The manual protocol is used to manually send control characters and data to the system
hosting BCI RS232 or BCI Link and execute the command sequences using script files. It is
used in particular to send erroneous messages.
To access these functionalities, select the "bioMérieux manual" protocol (refer to the
Selecting a Protocol section on page 14-5).
Commands and scripts are executed using the supervision screen. When the communication
server is started using the "bioMérieux manual" protocol, the supervision screen offers:
• A virtual on-screen keyboard which is used to send the commands available in the
bioMérieux protocols (literal or literal alternate protocol),
• Two active action icons: one for loading a script file and the other for executing the loaded
script.
2
4
5
3
Figure 14-4: bioMérieux Manual Protocol selected
1 — Script name.
2 — Communication tracking data window.
3 — Virtual on-screen keyboard.
4 — Load script icon.
5 — Run script icon.
161150-486 - B 14-7 BCI - VIDAS® Range

Transmission of Manual Commands

The virtual on-screen keyboard is used to send control characters. Communication can be
monitored by viewing the communication tracking data window located above the virtual on-
screen keyboard.
Figure 14-5: Figure 4: Virtual on-screen Keyboard
The keyboard is easy-to-use:
• Click on the character to be transmitted which will then be displayed in the communication
tracking data window.
The computer hosting BCI Link can now respond, and the response will be displayed in the
Checksum management
Checksum management is automatic. Checksum calculation starts when the first <RS> is sent
and ends when the <GS> is sent. The calculated value is automatically transmitted when you
click the GS button.
To simulate a checksum error:
• Activate the Faulty checksum option. This option transmits the value "00" after the <GS>
control is sent.
<RS> command management

Apart from transmission of control characters, the keyboard is used to send control characters
associated with the <RS> command.
To do so:
1. Place the data in a text file.

2. Click the Load data button to load the data.
3. Click the RS button so that the simulator can systematically transmit the data that is in the
data file.
Note: If there is no file or if the file does not contain any data, the <RS> command is sent without
data.
161150-486 - B 14-8 BCI - VIDAS® Range

Creating Scripts
A script is a series of tasks which are used to send commands and manage the BCI RS232 or
BCI Link host responses.
The simulator does not have a script editor. Statements are defined using a text editor such as
Notepad. You are informed of any syntactic or semantic errors when the script is executed.
The following table shows the possible statements:
Command Description Mandatory attributes

name: This command is used to send a control to NAME: command name. It
myCommandName, send: the BCI RS232 or BCI Link host along with must be defined and unique
ControlToSend, data: any data. In case of failure, the command for the complete script.
dataToSend, retries: can be retried several times (retries) SEND: control to be sent.
count, interval: with an interval of time between each retry
(interval).
inSeconds
Example of transmission of an RS
command with data:
name: cmd1, send: RS,
data:mtmpr|pi1232||si|ci234|rtHIV|
Note: The data sent are the group of characters

between the character ":" after the keyword
"data" and the next "," character. This means
that spaces are taken into account and data
must not contain commas.
name: myCommandName, This command is used to check that control NAME: command name. It
receive: Control, goto: character and indicate the task to be must be defined and unique
commandName. performed if the control received is not the for the complete script.
expected control. RECEIVE: control expected
For example, the following command: by the LIS host, Simulators
name: cmd2 receive: ACK goto: host or BCI Link host.
cmd1
indicates that reception of an "ACK" control
is expected. If the simulator receives an
ACK, it moves on to the next task, otherwise
it executes the task whose name is
indicated by the statement "goto:" and
continues performing the task from this line.
name: myCommandName, This command specifies the time, in ALL

wait: delayInSeconds. seconds, before the next command is
executed.
# comment line Lines preceded by the character "#" N/A

represent a comment line.
161150-486 - B 14-9 BCI - VIDAS® Range

Example of a script used to simulate transmission of two messages in a single session,

according to the bioMérieux literal protocol:
## Example of literal protocol
name: task1, send:ENQ, retries:3, interval:5

## Wait for ACK answer, if the answer is different than ACK,
## goto task1 otherwise go to the next task
name: task2, receive: ACK, goto: task1
name: task3, send: STX
name: task4, send: RS, data:mtmpr|pi123|psMale|si|ci34|, retries:3,

interval:2
name: task5, send: GS, data:3b
## if the checksum is not valid, go to the first RS
name: task7, send: ETX
name: task8, send: STX

name: task9, send: RS, data:mtmpr|pi1234|pnSmith
John|psMale|pb1998/10/10|so1|si|ci345|qd100|, retries:3, interval:2
name: task10, send: GS, data:6c
## if the checksum is not valid, go to the first RS
name: task12, send: ETX

name: task13, send: EOT
161150-486 - B 14-10 BCI - VIDAS® Range

Executing Scripts
To execute a script, proceed as follows:
1. Click to load the text file containing the script you want to execute.
The Loaded script file name is displayed in the message bar above the communication
2. Click to execute the currently loaded script.
Note: During the execution of the script, errors may occur. In this case, execution is stopped and an
error message is displayed. Click OK to close it.
The following errors may occur:
• The script file is not loaded:

The following error message is displayed: Impossible to execute script: no script file loaded.
• The loaded script file does not exist or does not contain any tasks:
The simulator tries to execute the script; the trace "End communication" is displayed in the
tracking data window. It indicates that no tasks were performed.
• Several tasks have the same name:

In the case of several identical tasks (identical "name:" value), the following error message is
displayed: Several tasks have the same name: <name>.
• A mandatory "name:" field is missing:

The following error message is displayed: Missing mandatory field "name:" - line: {line
number}.
• A mandatory "send:" or "wait:" or "receive:" field is missing

The following error message is displayed: Missing mandatory field "send:", "wait:", "receive:" -
line: {line number}.
• Incorrect value for a waiting period or the number of retries (a numerical value is
expected in both cases):
The following error message is displayed: Invalid sleeping period and/or retries count - line:
{line number}.
• Incorrect value for a waiting period (a numerical value is expected, indicating the
number of seconds):
The following error message is displayed: Invalid sleeping period - line: {line number}.
• Invalid control – command for "Send": the control is not managed by the selected
protocol.
The following error message is displayed: Invalid control for "send:" field -line: {line number}.
161150-486 - B 14-11 BCI - VIDAS® Range

• Invalid control – command for "Receive": the control is not managed by the selected
protocol.
The following error message is displayed: Invalid control for "receive:" field -line: {line number}.
• Unknown task: the "goto:" statement points to an unknown task.

The following error message is displayed: The “goto" field points to an unknown task named:
"xxxx"-line: {line number}.
• General error:
If a reader error occurs, the following error message is displayed: Error while reading script
file.
The file does not need to be loaded after each modification. The simulator automatically
rereads the script as saved before executing it.
161150-486 - B 14-12 BCI - VIDAS® Range

Managing Analysis Requests in the "bioMérieux" Format LIS – RS232 SIMULATOR
Managing Analysis Requests in the "bioMérieux" Format
The following sections present the graphic editor used to produce analysis requests in the
"bioMérieux" format and describe the different stages in the production of an analysis request
and its transmission to BCI RS232 or BCI Link.
Presentation of the Editor
3
2
Figure 14-6: Graphic editor –"bioMérieux" format
1 — Analysis request display field.
Each line corresponds to a test order (patient, specimen, test, etc.). Any errors that may
occur are displayed in the error display field.
2 — Clear button.
Used to delete the error messages.
3 — Error display field.

Displays all errors entered in the editor or displayed when the analysis request is loaded.
161150-486 - B 14-13 BCI - VIDAS® Range

Step 1: Create an Analysis Request

There are two possibilities for creating an analysis request:
Create · Creates a new empty analysis request.
Open · Opens an existing analysis request. This enables you to open a

file browser and select an existing message to modify it.
The file browser suggests the "\lis_worklist\bioMerieux"
default directory, which is the storage directory for existing
messages. Any errors in the analysis request are displayed in the
error display window. If a file contains more than 20 test orders and
does not follow the bioMérieux format: loading is refused.
Step 2: Complete the Analysis Request

In the analysis request display field:
1. Select the analysis request you want.

2. Right-click to open the following drop-down menu.
Figure 14-7: Figure 6: Analysis Request Management drop-down menu
3. Select one of the following functions:

Add Adds a test order.
Update Updates the selected test order.
Note: The shortcut for this command is double-click on the line to be modified.
Duplicate Duplicates the selected test order.

Delete Deletes the selected test order.
161150-486 - B 14-14 BCI - VIDAS® Range

Add/Update a test order:
These actions are used to open a test order editor. In the case of an update, the editor already
contains the data for the selected test order.
The test order editor can be configured to have the fields for a specific bioMérieux system
(refer to the Setting Parameters for the "bioMérieux" Test Order Editor section on page 14-17
for more details about the configuration of the editor).
Using the following editor:
Figure 14-8: Entering Test Order Values
1. Define the required parameters.

2. Click OK to confirm.
Data entry is checked and a message is displayed in case an error has been entered.
• Click YES to confirm that the analysis request is recorded with the error included,
OR
• Click NO and correct the errors before reconfirming.
Errors are displayed in chronological order in the error display field. Each line includes an error
and its corresponding information:
1 — The time (hh:mm) the error occurred.

2 — Line number of the test order to which the error is linked.
3 — Description of the error.
1 2
3
Figure 14-9: Error Display Field
The editor detects the following errors:
- “Missing mandatory attribute”

- Wrong format for optional attribute”
- Wrong format for mandatory attribute”
- Character string too long for optional attribute”
- Character string too long for mandatory attribute”
- The input message does not follow the bMx message format“
This message occurs if a test order does not follow the order of the fields when
the analysis request is loaded.
161150-486 - B 14-15 BCI - VIDAS® Range

Duplicate a test order
The duplicated test order is added to the end of the test order list. It can then be printed and its
values modified.
Delete a test order
The selected test order is definitively deleted from the analysis request after confirmation of
deletion.
Step 3: Save the Analysis Request

There are two possibilities for saving an analysis request during creation:
· Saves the analysis request in the previously loaded file.

Save This is only possible for an existing analysis request. Otherwise, it
will be identical to Save as.
· Saves the analysis request in a new file.

This opens a file browser for selecting the directory and name of
Save as the file in which the message will be stored. The default directory
in which messages are saved is
"\lis_worklist\bioMerieux".
Step 4: Send an Analysis Request
· Sends an analysis request to BCI.

Send This icon is only active if the communication server is running and
becomes inactive during the time required for transmission of the
message.
Note: Refer to the Communication Supervision section on page 14-6 for more detailed information
about communication.
161150-486 - B 14-16 BCI - VIDAS® Range

Setting Parameters for the "bioMérieux" Test Order Editor LIS – RS232 SIMULATOR
Setting Parameters for the "bioMérieux" Test Order Editor
The editor dedicated to the display and entry of test orders is fully user-definable through
properties files. Parameters are taken into account when the application is started.
In the following, “theSystem” refer to a folder that contains the pattern data of one system.
The list of system will be automatically displayed while the simulator starts.
Definition of Attributes and Separator

Attributes:
The attributes.worklist property enables you to declare the list of attributes that are to
be managed in the editor and is located in the properties file:
<simu>\simuRoot\patterns\theSystem\rs232\bmx_editors_labels.properties
Example: attributes.worklist=mt,pi,pn,ps,pb,so,si,ci,rt,qd indicates 10

attributes to be managed by the editor.
Separator:
The properties file contains a property which indicates the attribute separator:
bmxMessage.separator. The upright slash "|" is the default separator. This property is
declared in the property file:
\lib_server\properties\simulator\messages.properties.
Definition of Attribute Types

The declaration of the attribute types used in the editor is in the properties file:
<simu>\simuRoot\patterns\theSystem\rs232\bMx_editor_fields_and_
types.properties
The syntax is the following: <attribute name>=Type of attribute
The editor manages the following types of attributes:
• Character strings: STRING:<string length>.

For example, declaration of the patient name "pn", which is a string of 25 characters, is:
pn=STRING:25
By default, character strings ≤ 50 are presented in an entry field consisting of a single row. For
character strings ≥ 50, the entry field includes several rows, each of which is 25 characters
long; only four rows are visible. These default values can be modified using the properties in
the following file: messages.properties
# Max string length for use of a JTextField (if length > , we use a
JTextArea)
bmxMessage.string.maxTextField.length=50
# Number of characters by column in a JTextArea
bmxMessage.string.TextArea.columns=25
# Number of characters by in a JTextArea
bmxMessage.string.TextArea.rows=4
161150-486 - B 14-17 BCI - VIDAS® Range

• Separator: there are record separators such as the sample separator for VIDAS® named
"si". This attribute type is defined by a character string with a length of 0.
Example: si=STRING:0. This type is represented in the editor by a check box.
• Enumeration: ENUM: val1, val2, val3.
This is used to declare a set of defined values for a given attribute. For example, the "mt"
attribute which determines the direction of the message has the value "mpr" for an analysis
request and "rsl" for results. This attribute can be declared as follows: mt=ENUM: mpr,
rsl. This type is represented as a drop down list showing all the values defined for this type.
• Numeric values: INTEGER: min: val1 max: val2.
This is used to declare a whole numeric value. You can define a minimum and/or maximum
(optional) value. For example, an unbounded numeric sample identifier is declared as follows:
ci=INTEGER: (the character ":" is mandatory). To declare a dilution attribute named "qd" from
0 to 1000, the declaration is qd=INTEGER: min:0 max:1000.
• Date and time: DATETIME: <format>, the format is described using ASCII symbols with the
following signification:
Symbol Description Example
y Year – 1 digit yyyy -> 2004, yy -> 04

MM Month of the year from 1 to 12
dd Day of the month
hh Time am/pm 1..12
HH Time 0..24
mm Minutes 0..60
ss Seconds 0..60
a Marker am/pm
‘ Text delimiter "yyyy.MM.dd 'at' hh:mm:ss" -> 1996.07.10 at 15:08:56
For example:
• to express a date with 4 digits for the year:DATETIME:dd/MM/yyyy

• to declare a time: DATETIME:HH:mm:ss
Definition of Attribute Labels

Each attribute, declared in the following file:
"bMx_editor_mandatory_fields_for_worklists.properties" must have a label
which is used for displaying in the editor.
The list of labels is defined in the file:

<simu>\simuRoot\patterns\theSystem\rs232\bMx_editor_labels.properties.
The labels are in English and are declared as follows:

label.<attribute name>=attribute label
Example: label.pi=Patient identifier.
161150-486 - B 14-18 BCI - VIDAS® Range

Definition of Mandatory and Optional Attributes

Each attribute declared in the file:
"bMx_editor_mandatory_fields_for_worklists.properties" must be defined as a
mandatory or optional attribute when the test order is entered.
The file:
<simu>\simuRoot\patterns\theSystem\rs232\bMx_editor_mandatory_fields_for_
worklists.properties
contains the following information for each attribute:
• .<attribute name>=M for a mandatory attribute

• .<attribute name>=O for an optional attribute.
Example of the Definition of a Test Order Editor

The following table is used to get the following Add a test order dialog box.
messages bMx_editor_labels bMx_editor_fields_and_ bMx_editor_mandatory_
types fields_for_worklists
attributes.work label.mt=Direction mt=ENUM:mpr,rsl mt=M
list=mt,pi,pn,p label.pi=Patient pi=STRING:12 pi=M
s,pb,so,si,ci,r identifier pn=STRING:15 pn=O
t,qd,sc label.pn=Patient name pb=DATETIME:yyyy/MM/dd pb=O
label.pb=Birthdate ps=ENUM:Male,Female,Unkno ps=O
label.ps=Patient Sex wn so=O
label.so=Sample so=STRING:5 si=M
origin ci=STRING:12 ci=M
label.ci=Sample si=STRING:0 rt=M
identifier sc=STRING:300 qd=O
label.si=Sample rt=STRING:4 sc=O
separator qd=INTEGER:min:0 max:999
label.rt=Short
assayname
label.qd=Dilution
label.sc=Comment
Figure 14-10: Test Order dialog box
161150-486 - B 14-19 BCI - VIDAS® Range

Managing Analysis Requests in "text" Format LIS – RS232 SIMULATOR
Managing Analysis Requests in "text" Format
The following sections present the graphic editor used to produce analysis requests in text
format and describe the different stages in the production of an analysis request and its
transmission to BCI.

This text editor is similar to the Microsoft® Notepad (or WordPad) which allows free data entry,
and which has neither syntactic nor semantic constraints.
The editor has four standard keyboard shortcuts:
· Copy [Ctrl] + [C] Copies selected text to the buffer store.

· Cut [Ctrl] + [X] Cuts selected text to the buffer store.
Pastes the text contained in the buffer store to the
· Paste [Ctrl] + [V]
editor, at the position indicated by the cursor.
· Select all [Ctrl] + [A] Selects the content of the editor.
This editor can be used to send messages in a format other than the bioMérieux format. It can
also be used in "expert mode" as a bioMérieux format analysis request editor, to enter
messages more rapidly using the Copy/Paste command on existing messages (with no
control).

· Creates a new empty analysis request (clear the analysis

Create request display field if necessary).
· Opens an existing analysis request and allows you to

modify it.
This enables you to open a file browser and select an existing
Open
message. The file browser suggests the "\lis_worklist"
messages.

• Use the text editor to enter the message you want to send.

This step is identical to saving messages in the bioMérieux format as described in Step 3:
Save the Analysis Request on page 14-16.

This step is identical to sending messages in the bioMérieux format as described in Step 4:
Send an Analysis Request on page 14-16.
161150-486 - B 14-20 BCI - VIDAS® Range

15 LIS – FTP Simulator
Prerequisite: Prior to using the LIS-FTP simulator, check the proper setting of the properties in the
message.properties file (refer to the Defining Parameters for the Simulator Text
Editors section on page 13-7).
Accessing the LIS Simulator and Setting Parameters
Setting Parameters for the FTP Connection

The file containing the properties of the FTP account is located in:
\lib_server\properties\simulator\ftp.properties.
To modify the parameters of the FTP account contained in this file:
1. Edit the file using a text editor (NotePad.exe or WordPad.exe) as shown in the description
below.
2. Enter the new parameters between "<" and ">".
simulator.bciServer=<IP address or name of BCI Link application

host computer>
simulator.bciport=<Port number of FTP server>.

Default value is 21. In case of doubt, check the value in BCI Link, accessible using the
configuration panel of the BCI Link application.
simulator.user=<The identifier belongs to an active FTP account

defined in BCI Link>.
simulator.pwd=<The password belongs to an active FTP account

defined in BCI Link>.
simulator.putDirectory =<Directory in which BCI Link analysis

requests are placed>.
The default directory is download.
simulator.getDirectory =<Directory in which BCI Link results are

stored>.
The default directory is upload.
161150-486 - B 15-1 BCI - VIDAS® Range

Accessing the LIS Simulator and Setting Parameters LIS – FTP Simulator
To test the new parameters entered:
1. Click and then to access the FTP connection parameters.
Figure 15-1: Setting Parameters for the FTP Connection
2. Click to take into account the new properties.

3. Check that the properties entered in the text editor are identical to the parameters
displayed in the FTP parameters display field.
4. Check that no errors have appeared in the FTP errors display field.
If none are detected, then connection is successful and will be displayed on the BCI Link
supervision screen.
Note: New properties must be saved in the text editor before testing the FTP connection.
161150-486 - B 15-2 BCI - VIDAS® Range

Managing Analysis Requests in "ASTM-XML" Format LIS – FTP Simulator
Managing Analysis Requests in "ASTM-XML" Format
The following sections present the graphic editor used to produce analysis requests in ASTM-
XML format and describe the different stages in the production of an analysis request and its
transmission to BCI Link.
1
2
Figure 15-2: "ASTM-XML" Format Editor
1 — Display field for the XML message generated from data entered in the editor in tree
structure mode. The areas in red indicate the parts of the XML message which contain
errors compared to the XML schema.
2 — Editor for producing an XML message in tree structure mode. Each time a tree node is
entered or modified, the display field is updated to show the XML source. Any error that
may occur is displayed in the error display field.
3 — Error display field for errors entered.
161150-486 - B 15-3 BCI - VIDAS® Range


Create · Creates a new analysis request.

This enables you to create an analysis request using a template
(refer to section about Defining Parameters for the Simulator
Text Editors on page 13-7 to define the location of a template
using the NEW_LIS_MESSAGE property).
Open · Opens an existing analysis request. This enables you to open a

file browser and select an existing message to modify it.
The file browser suggests the "\lis_worklist\astm_xml"
messages.

The editor enables you to view messages as a tree structure. The figure below shows the
organization of the different elements that can be found in an ASTM-XML message tree:
Figure 15-3: ASTM-XML Message Tree Structure
• Root node: the root node is the top node in the structure. It has no parent. All other nodes are
children or descendants of the root node.
• Child node: the child node is the immediate descendant of a node. For example "dateTime"
is the child node of "header" which itself is the child node of the "lisMessage" root node.
• Node value: Numerical value associated with an immediate descendant node. For example,
the value of node "dateTime" is "2002010100000099".
• Parent node: The parent node is the immediate ancestor of a node (except the root node).
For example "request" is the parent node of the "PatientInformation", and
"testOrder" nodes.
161150-486 - B 15-4 BCI - VIDAS® Range

Add a node:
This is used to add a child node to the selected node. To do so:
1. Select the node to which you want to add a child node.

2. Right-click and select Add node in the drop-down menu. The list of possible nodes is
displayed. The mandatory nodes are indicated in red.
The following example describes how to add a "patient name" field to a request.
1. Select the "PatientInformation" parent node containing the patient information.

2. Right-click and select Add node.
3. In the dialog box that is displayed, select the "lastName" node.

The "patientIdentifier" is displayed in red as it is the only mandatory element for
defining a patient.
Note: All the possible nodes are displayed, even those which are already defined in the message.
Mandatory nodes (in red) are always preselected.
4. Click OK to add the node.

The node is then added below the existing children nodes for the selected node.
161150-486 - B 15-5 BCI - VIDAS® Range

Insert a node:
This is used to insert a node at the same level as the selected node. To do so:
1. Select the node.

2. Right-click and select Insert node in the drop-down menu. The list of possible nodes is
displayed. The mandatory nodes are indicated in red.
The following example describes how to insert a "patient name" field immediately after the
patient identifier.
1. Select the "patientIdentifier" node.

2. Right-click and select Insert node.
3. In the dialog box that is displayed, select the "lastName" node.
Note: All the possible nodes are displayed, even those which are already defined in the message.
Mandatory nodes (in red) are always preselected.
4. Click OK to insert the node.

The node is then inserted after the selected node.
161150-486 - B 15-6 BCI - VIDAS® Range

Set a node value:
This is used to assign a value to the selected node. To do so:
1. Select the node.

2. Right-click and select Set value in the drop-down menu.
In the case of free data entry, an alpha-numeric string can be entered. If the value is from an
enumerated type, a dialog box is displayed showing a list of possible values.
Note: An alphanumeric string not conform to the XLM schema may be entered. In this case, the
value is in red.
The two examples below respectively describe the procedure to follow in the two above
mentioned cases.
Entry of a patient name (free data entry):
1. Select the value to be assigned.
Note: Note: The question marks "???" indicate that the value has not yet been assigned and that
data entry is free.
2. In the dialog box that is displayed, select the "patientIdentifier" node.

3. Right-click on the value to set and select Set value.
4. Enter the value and quit the entry field to confirm.
161150-486 - B 15-7 BCI - VIDAS® Range

Entering the sex (value from an enumerated type):
1. Select the value to be assigned.
Note: The dots "…" indicate that the value entered is from an enumerated type.
2. Right-click on the value to set and select Set value.
3. Select the value from the list displayed.
4. Click OK.
161150-486 - B 15-8 BCI - VIDAS® Range

Remove a node:
This is used to delete a selected node. To do so:
1. Select the node.

2. Right-click and select Remove node in the drop-down menu.
The selected node is then deleted from the tree.

There are two possibilities for saving an analysis request during creation:
· Saves the analysis request in the previously loaded file.

Save This is only possible for an existing analysis request. Otherwise, it
will be identical to Save as.
· Saves the analysis request in a new file.

Save as This opens a file browser for selecting the directory and name of
the file in which the message will be stored. The default directory
in which messages are saved is "\ lis_worklist\astm_xml ".

· Sends the newly saved file to BCI Link.
This only succeeds if the parameter settings for the FTP client are
correct (refer to the Setting Parameters for the FTP
Connection section on page 15-1) and if the file containing the
Send
analysis request has been named following the rules imposed by
BCI. Before sending the message, the simulator automatically
opens a new FTP session, which it then closes once the message
has been sent.
Note: In case of incorrect parameter settings or incorrect file name, an error message is displayed.
161150-486 - B 15-9 BCI - VIDAS® Range

Managing Analysis Requests in "text" Format LIS – FTP Simulator
Managing Analysis Requests in "text" Format
The following sections present the graphic editor used to produce analysis requests in text
format and describe the different stages in the production of an analysis request and its
transmission to BCI Link.

This text editor is similar to the Microsoft® Notepad which allows free data entry, and which
has neither syntactic nor semantic constraints.
The editor has four standard keyboard shortcuts:
· Copy [Ctrl] + [C] Copies selected text to the buffer store.

· Cut [Ctrl] + [X] Cuts selected text to the buffer store.
Pastes the text contained in the buffer store to the
· Paste [Ctrl] + [V]
editor, at the position indicated by the cursor.
· Select all [Ctrl] + [A] Selects the content of the editor.
This editor can be used to send messages in a format other than the ASTM-XML format. It can
also be used in "expert mode" as an XML editor, to enter XML messages more rapidly using
the Copy/Paste command on existing messages (with no control), or to simulate error in the
XML schema as the "Sex" value (other than F,M,U).

Create · Creates a new analysis request.
Open · Opens an existing analysis request.

This enables you to open a file browser and select an existing
message to modify it.
The file browser suggests the "\lis_worklist\astm_xml"
messages.

Use the text editor to enter the message you want to send.

This step is identical to saving messages in ASTM-XML format as described in Step 3: Save
the Analysis Request on page 15-9.

This step is identical to sending messages in ASTM-XML format as described in Step 4: Send
an Analysis Request on page 15-9.
161150-486 - B 15-10 BCI - VIDAS® Range

Receiving Results LIS – FTP Simulator
Receiving Results
This function is used to download results stored in BCI Link upload directory.
Presentation of the Results Download Interface
1
2
Figure 15-4: Results Download Interface
1 — List of downloaded results. These are messages stored in the

\lis_results\astm_xml directory on the simulator.
2 — List of results and file in the BCI Link "\upload" directory which can be downloaded by
the LIS.
3 — Area for viewing the content of the message selected from the "local messages" list.
Note: This editor does not manage the different encoding forms.
The messages are displayed in the ISO-8859-1 encoding form.
161150-486 - B 15-11 BCI - VIDAS® Range

Downloading a Result
The results are displayed in the BCI results area.
Figure 15-5: Downloading Results
To download a result:
1. Click to update the list of BCI Link results.

This update is required to view the last results sent by the AIs.
2. In the BCI results area, select the result you want to download.
3. Click to download the selected result.
161150-486 - B 15-12 BCI - VIDAS® Range

When downloading is completed, the lists are updated as follows:
1
2
Figure 15-6: Update after Downloading
1 — The message is displayed in the list of local messages. Select the message if you want
to view its contents.
2 — A new empty file, called confirmation file, is created on BCI Link upload directory. This
empty file indicates that the LIS (laboratory) has downloaded the file. The results file and
the confirmation file are then automatically deleted by BCI Link.
Note: The file can continue to be downloaded until it is deleted.
3 — Contents of the selected local message is displayed.
161150-486 - B 15-13 BCI - VIDAS® Range

16 AI Simulator
Parameter Setting and Connections
The AI simulator is mainly used to simulate the sending of results from an AI to the LIS.
Setting Parameters for the AI Simulators

The file containing the properties of the AIs is located in:
\lib_server\properties\simulator\instruments.properties.
Edit this file using a text editor (Notepad or Wordpad) to modify the standard configuration.
The file is configured as follows:
• simulator.instruments=<List of the AI simulator identifiers separated by a comma>

The default configuration includes twenty AIs:
simulator.instruments=SYSTEM1,SYSTEM2,SYSTEM3,SYSTEM4,SYSTEM5
IMPORTANT: The maximum number of systems is 20 for BCI Link.

An AI simulator identifier must consist of letters (A.Z and a.z) and digits (0...9) only.
• Characteristics must be defined for each AI declared in the list.

• Properties: the types of tests managed by the system are declared in this section and
separated by a comma.
• Type: bioMérieux AI type (VIDAS, VIDIA, VITEK, bmx_simulator, etc.).
• Format: format used for the messages. The default format is ASTM-XML.
• Link: must be set to "lis".
• SerialNumber: system serial number (optional).
To associate a characteristic to a system, declare the following line:
<System identifier>.< Name of the characteristic>=value.
The following example describes the characteristics for the system called SYSTEM1:
SYSTEM1.properties=TEST1,TEST2,TEST3
SYSTEM1.type=vidas
SYSTEM1.format=ASTM-XML
SYSTEM1.link=lis
SYSTEM1.serialNumber=12
In case of communication with BCI Link without the routing option, the list of tests and the
presentation format can be omitted as shown in the following example:
SYSTEM1.properties=
SYSTEM1.format=
161150-486 - B 16-1 BCI - VIDAS® Range

Parameter Setting and Connections AI Simulator
IMPORTANT: If the simulator.instruments property is modified, the simulator must be shut down
and restarted to allow the new values to be taken into account. On the other hand, the
other properties are automatically taken into account before a new connection.
Remember to save the new properties using the text editor before testing the AI
connection.
Special case of an AI called "bmx_simulator" in simulator.instruments:
It is essential not to modify the configuration of the LIS systems so that you can detect
problems with a bioMérieux system which no longer receives analysis requests or to simulate
the sending of results to the LIS during the installation.
Diagnosis is made as follows:
• An AI simulator substitutes for the bioMérieux system. In this particular case, the
instruments.properties file must be completed by inserting the properties of the
substituted system.
OR
• An AI simulator does not substitute for the bioMérieux system but is declared with the type
"bmx_simulator": Therefore, it does not appear in the BCI Link dispatching table at the time
of connection and does not disrupt the laboratory configuration.
This type of simulation allows for the following two scenarios:

- The simulator is managed by BCI Link as long as it is connected. After
disconnection, BCI no longer manages the analysis request, pending a
hypothetical reconnection of the simulator. The simulator is in fact erased from the
BCI Link memory when the session is closed.
- If BCI Link has the dispatch option, all the tests are sent to the simulator.
BCI Link does not take into account the AI configuration table.
161150-486 - B 16-2 BCI - VIDAS® Range

Opening and Closing a Session on an AI

To open a new AI session:
1. Click to display the AI connections.
2. Click the analysis system connection.

3. Select the Analysis system.
4. Click to connect the bioMérieux analysis system.

5. If the request to open a session is successful, the arrows indicating the status of the
connection change from red to green, as shown below.
Otherwise, the simulator opens a dialog box indicating the nature of the problem.
The interface displays the list of systems defined in the properties file. The identifier and
the type of link are indicated for each system.
Figure 16-1: AI Opening Session
To close a session:
1. Select a connected AI.
2. Click to close the session.
161150-486 - B 16-3 BCI - VIDAS® Range

Updating the Configuration of the AI

The simulator offers the possibility to update the list of configured test types for the system
without closing a session and opening a new one.
To do so:
1. Modify the list of tests for system in the instruments.properties file.
2. Click to display the AI connections.
Figure 16-2: Updating the Configuration of the AI
3. Select the system with a valid session and a list of tests that has been modified.
4. Click to update the test types in BCI.
Note: This function is only used for a BCI Link connection with the dispatch option.
161150-486 - B 16-4 BCI - VIDAS® Range

Receiving Analysis Requests sent by BCI AI Simulator
Receiving Analysis Requests sent by BCI
There is no graphic interface for this functionality. The analysis requests sent by BCI are
stored in the directory: "\instr_worklist\<default directory defined by
simulator.defaultSubDirectory property and contained in
messages.properties>".
To distinguish the recipients of the analysis request, the simulator applies the following
naming rule when recording the request from the LIS:
<Analysis system name>_yymmdd_hhmmss_<index>.xml
(the xml suffix is used by default even for a text file.
The latter can be modified using a messages.properties property called

simulator.fileExtension).
Consequently, if a request is intended for several systems, the simulator creates as many files
as there are connected systems.
To simulate connection problems, define a value other than Success for the Return code
parameter in the XML result simulator.
As soon as BCI tries to send a message (whichever AI is the recipient), an error is sent back to
BCI, and transmission of the analysis request fails.
Figure 16-3: Changing Configuration of a modified AI
Note: Select Failure in one case only: to simulate a connection error.
161150-486 - B 16-5 BCI - VIDAS® Range

Managing Results in "ASTM-XML" Format AI Simulator
Managing Results in "ASTM-XML" Format
The following sections present the graphic editor used to produce results in ASTM-XML format
and describe the different stages in the production of results and their transmission to
BCI Link.

The following figure presents the editor used to construct results in “ASTM-XML" format. This
editor is identical to the one used to construct analysis requests. However, the "ASTM-XML"
format requires the selection of the AI before results are sent to BCI Link in order to identify
the AI responsible for sending the message.
1 3
Figure 16-4: "ASTM-XLM" Format Editor
1 — Display field for the XML message generated from data entered in the editor in tree
structure mode. The areas in red indicate the parts of the XML message which contain
errors.
2 — Selection of the AI responsible for sending results.
3 — Editor for producing an XML message in tree structure mode. Each time a tree node is
entered or modified, the display field is updated to show the XML source. Any error that
may occur is displayed in the error display field.
4 — Error display field for errors entered in the tree structure editor.
161150-486 - B 16-6 BCI - VIDAS® Range

Managing Results in "ASTM-XML" Format AI Simulator
Step 1: Create a Result Message

There are three possibilities for creating a message:
Create · Creates a new message using a template.

This enables you to create a new message containing results
using a template (refer to section about Defining Parameters for
the Simulator Text Editors section on page 13-7 to define the
location of a template using the NEW_AS_MESSAGE property).
Open · Opens an existing analysis request to attach results to it.

This enables you to open a file browser and select an analysis
request from the list of messages sent by BCI.
The file browser suggests the "\instr_worklist\astm_xml"
default directory, which is the storage directory for analysis
requests sent by BCI.
OR
· Opens a message already containing results.

This enables you to open a file browser and select a message
containing results, from the list of results already created and
located in the directory "\instr_results\astm_xml".
Step 2: Complete or Modify the Message using new Results

The XML editor has the same functionalities as the editor used to manage analysis requests
(refer to Step 2: Complete the Analysis Request on page 15-4).
Step 3: Save the Message

This step is identical to saving an analysis request as described in Step 3: Save the Analysis
Request on page 15-9.
The file name to be used is described in section about Receiving Analysis Requests sent by
BCI on page 16-5.
Note: Only the default directory used to save the results is different. It is called "\instr_results".
Step 4: Send the Message
Send · Sends the newly saved file to BCI.
Note: The AI defined as the sender must have an open and valid session.
In case of failure, an error message is displayed and describe the error.
IMPORTANT: Before sending a message, check the name of the file appearing at the top of the
screen.
161150-486 - B 16-7 BCI - VIDAS® Range

Managing Results in "text" Format AI Simulator
Managing Results in "text" Format
The following sections present the graphic editor used to produce a results message in text
format and describe the different stages in the production of a results message and its
transmission to BCI.

The editor used to construct results in "text" format is identical to the editor used to construct
analysis requests in text format (refer to the Managing Analysis Requests in "ASTM-XML"
Format section on page 15-3). However, this editor requires the selection of the AI before
results are sent to BCI in order to identify the AI responsible for sending the message.

This step is identical to what is described in Step 1: Create an Analysis Request on page 15-
10.
Step 2: Complete or Modify the Message with New Results

Use the text editor to enter the message you want to send.

This step is identical to what is described in Step 3: Save the Analysis Request on page 15-
10.

This step is identical to what is described in Step 3: Save the Analysis Request on page 15-
10.
161150-486 - B 16-8 BCI - VIDAS® Range

Managing Results in "bioMérieux" Format AI Simulator
Managing Results in "bioMérieux" Format
The following sections present the graphic editor used to produce results in the "bioMérieux"
format and describe the different stages in the production of results and their transmission
using BCI RS232 or BCI Link.

The following figure presents the editor used to construct results in "bioMérieux" format. This
editor is identical to the one used to construct analysis requests. However, the "bioMérieux"
format requires the selection of the AI before results are sent using BCI RS232 or BCI Link in
order to identify the sender of the message.
1
4
Figure 16-5: "bioMérieux" Format Editor
1 — Message display field.
Each line corresponds to a result. Any errors that may occur are displayed in
the error display field.
2 — Instrument drop-down list.
Allows to select the sender of the message (AI).
3 — Error display field.
Displays the errors entered in the editor or displayed during loading of results.
4 — Clear button.
Allows to delete the error messages.
161150-486 - B 16-9 BCI - VIDAS® Range

Managing Results in "bioMérieux" Format AI Simulator

There are three possibilities for creating a results message:
Create · Creates a new message using an empty message.
Open · Opens an existing analysis request to attach results to it.

This enables you to open a file browser and select an analysis
request from the list of messages sent by BCI RS232 or
BCI Link.
The file browser suggests the
"\instr_worklist\bioMerieux" default directory, which is
the storage directory for analysis requests sent by BCI RS232 or
BCI Link.
OR
· Opens a message already containing results.

This enables you to open a file browser and select a message
containing results, from the list of results already created and
located in the directory "\instr_results\bioMerieux".
Step 2: Complete or Modify the Message using New Results

The bioMérieux editor has the same functionalities as the editor used to manage analysis
requests (refer to Step 2: Complete the Analysis Request on page 15-4).

This step is identical to saving an analysis request (refer to Step 3: Save the Analysis
Request on page 15-9).
The message must be saved as a text file, using any file name.
Note: Only the default directory used to save results is different; it is called
"\instr_results\bioMerieux".
Send · Sends the newly saved file to BCI.
Note: The AI defined as the sender must have an open and valid session.
In case of failure, an error message is displayed and describe the error.
IMPORTANT: Before sending a message, check the name of the file appearing at the top of the
screen.
161150-486 - B 16-10 BCI - VIDAS® Range

Setting Parameters for the "bioMérieux" Result Editor AI Simulator
Setting Parameters for the "bioMérieux" Result Editor
The editor dedicated to the display and entry of results is fully user-definable using the same
property files as for Setting Parameters for the "bioMérieux" Test Order Editor (page 14-17).
However, declaration of the results editor’s specific attributes and declaration of the optional
and mandatory attributes differ.
The list of attributes to be managed for a result is declared in the properties file
<simu>\simuRoot\patterns\theSystem\rs232\bMx_editors_labels.properties by
means of the attributes.result property.
For example, attributes.result=mt,pi,pn,ps,pb,so,si,ci,rt,rn,tt,

td,ql,qn,y3,qd enables you to specify the attributes that the editor should manage. These
attributes are most often the attributes defined for a test order plus the attributes defining a
result.
The list of mandatory and optional fields is located in the file

<simu>\simuRoot\patterns\theSystem\rs232\bMx_editor_mandatory_fields_
for_results.properties.
161150-486 - B 16-11 BCI - VIDAS® Range

Appendices
A Appendix - Main Differences within the VIDAS® Range
Assuming that the VIDAS® 3 configuration is correctly done:
• All the messages accepted by VIDAS® PC are accepted by VIDAS® 3.

• All the results sent by VIDAS® 3 are understandable by the LIS (as if they were sent by
VIDAS®PC).
Note: While VIDAS® 3 can be configured to be compatible with a given VIDAS® PC existing LIS, the
default VIDAS® 3 configuration may be different from the default VIDAS® PC configuration.
General Information
VIDAS®PC VIDAS® 3 miniVIDAS®
Communication Bidirectional Bidirectional Unidirectional

Direction
Protocol FTP and RS232 FTP and RS232 RS232 only
Stop Bits 1 or 2 1 or 2 1
Language The OS language is used to If a connection language is The miniVIDAS® language

Management translate the transmitted results. configured in the VIDAS®3 can be configured under
Connection configuration Utility Menu >
menu, it is used to translate Configuration Menu >
the transmitted data, Select Language.
regardless of the OS
language.
Codepage ISO-8859-1 or UTF-8 ISO-8859-1 or UTF-8 Always in ASCII-7
Behavior in The message sent to BCI Link to The message sent to BCI Link
CORBA establish the communication to establish the communication
Communication uses the ISO-8859-1 encoding uses the UTF-8 encoding
format. format.
VIDAS® PC sends only the list of VIDAS® 3 sends to BCI Link

enabled assays to BCI Link, as the list of enabled and visible
there is no notion of visibility in assays in order to fill the
VIDAS® PC. routing table in case of
bioMérieux dispatching mode.
bMx Control bMx control (C1, C2, etc.) are bMx control (C1, C2, etc.) are bMx control (C1, C2, etc.)
Management sent sent are not sent by miniVIDAS®
HIV5 HIV5 AB and AG are sent HIV5 AB and AG are sent HIV5 AB and AG are not
Management sent by miniVIDAS®
161150-486 - B A-1 BCI - VIDAS® Range

Appendix - Main Differences within the VIDAS® Range
CMVA All versions: Before 1.2 version:

Management
For one CMVA test (patient or For one CMVA test (patient or
control), 2 doses (quantitative control), 2 doses (quantitative
result) are sent in 2 frames result) are sent in 2 frames
(RS232) or in 2 .xml files (FTP) (RS232) or in 2 .xml files (FTP)
which cannot be used to which cannot be used to
determine the Avidity index. determine the Avidity index.
The Avidity index is calculated The Avidity index is calculated

manually through the system, manually through the system,
according to the package insert according to the package
recommendation. insert recommendation.
After 1.2 version:
New PTC code.
The Avidity index is calculated

automatically through the
system.
For one CMVA test (patient or

control), the Avidity index and
the associated interpretation
are sent in 1 frame (RS232) or
in 1 .xml file (FTP).
Display Modes Results sent from VIDAS® PC Display modes do not exist. Display modes do not exist.
change depending on the
chosen display mode:
• Industry mode
• Simplified demography mode
• Complete demography mode

Appendix - Main Differences within the VIDAS® Range
Message Format
<RS> Character <RS> character at the <RS> character at the <RS> character before
Position beginning of the message beginning of the message each field of the message.
(after <STX>) and every 80 (after <STX>) and every 80
characters if message length characters if message length
exceeds 80 characters. exceeds 80 characters.
Dilution Possible dilution value from 0 Possible dilution value from 0 Possible dilution value from
to 999 to 9999 0 to 999
Separators Does not allow configuration of: Does not allow configuration of: Possible values:
• the date separator: “/” is • the date separator: “/” is • date separator: . : / ,
used used • time separator: . : / ,
• the time separator: “:” is • the time separator: “:” is • field terminator: ! @ # $
used used
%^&*()-=+<>/?
• the field separator: “|” is • the field separator: “|” is []\|{}
used used
Error Management
Mandatory Field When a mandatory field is When a mandatory field is

Error missing, empty or too long, the missing, empty or too long,
analysis request is rejected but the analysis request is
no alarm is raised. rejected and an alarm is
systematically raised.
Optional Field When an optional field is too When an optional field is too
Error long in an analysis request, it is long in an analysis request, it
truncated but no warning is is truncated and a warning is
raised. systematically raised.

B Appendix - Message Field Format and Values
Codepage
The two codepages used by the VIDAS® PC and the VIDAS® 3 computers are:
• ISO-8859-1 for English, French, German, Italian, Spanish, Portuguese, Polish and Turkish.
• UTF-8 for Chinese.
The codepage is used:
• To decode incoming RS232 messages.

• To encode outgoing messages (ASTM/XML and RS232).
The messages coming from or going to the VIDAS® PC systems must be encoded/decoded
according to the selected communication protocol.
Note: To decode ASTM/XML messages, VIDAS® 3 uses the encoding specified in the XML
message.
Limitations: In the VIDAS® 3 user interface, the user can type any characters. If the LIS is
configured in ISO-8859-1, some characters cannot be encoded, they will be replaced by a “?”
character and the message will be sent to the LIS.
XML Encoding of Special Characters
Encoding used on VIDAS®PC, for the result is as follows:
• “< 0.10” the XML will be: “<value><![CDATA[< 0.10|]]></value>”

• “> 26.00” the XML will be: “<value>> 26.00|</value>”
VIDAS® 3 has to be backward compatible with the implementation used in VIDAS®PC.
However, it would be better that the LIS understands all the possible encodings supported by
XML.
For example “< 16” can be encoded as “<![CDATA[< 16]]>” or as “< 16”. It would be
better that the LIS supports both configurations.
For more information, visit http://www.w3.org/TR/REC-xml/.
161150-486 - B B-1 BCI - VIDAS® Range

bMx Interpretation Messages Appendix - Message Field Format and Values
bMx Interpretation Messages

For BMX/XML messages, the interpretation messages (RS232, RS232/XML for Chinese) sent
by the VIDAS® 3 system are localized and may be configured in the Connection
configuration menu.
In the VIDAS® PC system, the localization of these messages depends on the OS language
and cannot be configured.
English / French / German

LIS Code sent to BCI Link
Code Label
English French German
0 Positive Positive Positif Positiv
1 Equivocal Equivocal Equivoque Diskrepant
2 Negative Negative Negatif Negativ
3 Reactive Reactive Réactif Reaktiv
4 Non-Reactive Non-Reactive Non réactif Nichtreaktiv
5 Low Positive Low Positive Pos Faible Schwach Pos.
6 POSITIVE POSITIVE POSITIF POSITIV
7 NEGATIVE NEGATIVE NEGATIF NEGATIV
8 positive positive positif positiv
9 equivocal equivocal équivoque diskrepant
10 negative negative négatif negativ
11 Border. R Border. R Pos lim. Grenzwert
12 LOW LOW FAIBLE GERINGE
13 INTERMED. INTERMED. INTERMED. INTERMED.
14 HIGH HIGH FORT HOHE
15 OK OK OK OK
16 Invalid Invalid Invalide Ungueltig
17 Border. R Border. R Pos lim. Positiv
18 Nondetectable Nondetectable Nondetectable Nondetectable
19 VALID Valid Valide Gueltig
20 IND. ZONE IND ZONE ZONE IND. IND.BEREICH
101 Standard Standard Standard Standard
103 VALID RECAL Valid recal Recal valide Gueltige rekal
104 INVALID RECAL Invalid recal Recal invalide Ungueltige rekal
6005 VALID A Valid A A valide Gueltig A
6006 VALID B Valid B B valide Gueltig B
6007 VALID A/B Valid A/B A/B valide Gueltig A/B
9001 INVALID INVALID INVALIDE UNGUELTIG
9002 ND ND ND ND
9003 N/A N/A N/A N/A

Spanish / Italian / Portuguese

Code Label
Spanish Italian Portuguese
0 Positive Positivo Positivo Positivo
1 Equivocal Equívoco Dubbio Equívoco
2 Negative Negativo Negativo Negativo
3 Reactive Reactivo Reattivo Reactivo
4 Non-Reactive No reactivo Non reattivo Não reactivo
5 Low Positive Pos. Débil Positivo debole Pos. Fraco
6 POSITIVE POSITIVO POSITIVO POSITIVO
7 NEGATIVE NEGATIVO NEGATIVO NEGATIVO
8 positive positivo positivo positivo
9 equivocal equívoco dubbio equívoco
10 negative negativo negativo negativo
11 Border. R Pos. lim. Pos.lim. Pos. lim.
12 LOW DEBIL DEBOLE FRACO
13 INTERMED. INTERMED. INTERMED. INTERMED.
14 HIGH FUERTE FORTE FORTE
15 OK OK OK OK
16 Invalid Invalido Non valido Inválido
17 Border. R Pos. lim. Pos.lim. Pos. lim.
18 Nondetectable No detectable Non rilevabile Não detectável
19 VALID Valido Valida Válido
20 IND. ZONE ZONA IND ZONA. INDET. ZONA INDETER
101 Standard Estándar Standard Calibrador
103 VALID RECAL Recal valida Recal valida Recal válida
104 INVALID RECAL Recal invalida Recal non valida Recal inválida
6005 VALID A valido A A Valida A válido
6006 VALID B valido B B Valida B válido
6007 VALID A/B valido A/B A/B Valida A/B válido
9001 INVALID INVALIDO NON VALIDO INVÁLIDO
9002 ND ND ND ND
9003 N/A N/A N/A N/A

Polish / Turkish / Chinese

Code Label
Polish Turkish Chinese
0 Positive Dodatni Pozitif 阳性
1 Equivocal Watpliwy Supheli 灰区
2 Negative Ujemny Negatif 阴性
3 Reactive Reaktywny Reaktif 反应的
4 Non-Reactive Nie reaktywny Reaktif Degil 不反应的
5 Low Positive Niski Dodatni Dusuk Pozitif 弱阳性
6 POSITIVE DODATNI POZITIF 阳性
7 NEGATIVE UJEMNY NEGATIF 阴性
8 positive dodatni pozitif 阳性
9 equivocal watpliwy supheli 灰区
10 negative ujemny negatif 阴性
11 Border. R Graniczne R Sinirda R 灰区阳性边界
12 LOW NISKI DUSUK 低
13 INTERMED. POSREDNI ORTA 中等
14 HIGH WYSOKI YUKSEK 高
15 OK OK OK 可以
16 Invalid Niepoprawny Gecersiz 无效
17 Border. R Graniczne R Sinirda R 灰区阳性边界
18 Nondetectable Niewykrywalny Tesp. edilmez 不能检测
19 VALID Poprawny GECERLI 有效
20 IND. ZONE Pole nieokr. IND.ALAN 不确定区域
101 Standard Standard Standart 标准
103 VALID RECAL Dobra rekalib GECERLI TK 有效重定标
104 INVALID RECAL Zla rekalib GECERSIZ TK 无效重定标
6005 VALID A Poprawne A A GECERLI 有效 A
6006 VALID B Poprawne B B GECERLI 有效 B
6007 VALID A/B Poprawne A/B A/B GECERLI 有效 A/B
9001 INVALID NIEPOPRAWNY GECERSIZ 无效
9002 ND ND ND 未定义
9003 N/A Nie dotyczy N/A 不适用

Greek / Japanese / Korean / Russian - VIDAS® 3 only

Code Label
Greek Japanese Korean Russian
0 Positive Θετικό 陽性 양성 Положит.
1 Equivocal Αμφίβολο 判定保留 불확실 Спорный
2 Negative Αρνητικό 陰性 음성 Отрицат.
3 Reactive Δραστικό 反応性 반응성 Реакцион
4 Non-Reactive Μη δραστικό 非反応性 비반응성 Нереакцион.
5 Low Positive Χαμ. θετικό 弱陽性 저양성 Слабополож.
6 POSITIVE ΘΕΤΙΚΟ 陽性 양성 ПОЛОЖИТ.
7 NEGATIVE ΑΡΝΗΤΙΚΟ 陰性 음성 ОТРИЦАТ.
8 positive θετικό 陽性 양성 положит.
9 equivocal αμφίβολο 判定保留 불확실 спорный
10 negative αρνητικό 陰性 음성 отрицат.
11 Border. R Οριακά Θ 陽性の限界 경계선 . 우측 Поч. пол.
12 LOW ΧΑΜΗΛΗ 低 낮음 НИЗКАЯ
13 INTERMED. ΟΡΙΑΚΗ 中 중간 ПРОМЕЖУТ.
14 HIGH ΥΨΗΛΗ 高 높음 ВЫС.
15 OK OK OK 확인 ОК
16 Invalid Άκυρο 無効 무효 Недейст.
17 Border. R Οριακά Θ 陽性の限界 경계선 . 우측 Поч. пол.
18 Nondetectable Μη ανιχνεύσ. 検出不能 검출 불가능 Необнаружив.
19 VALID ΕΓΚΥΡΟ 有効 유효 ДЕЙСТ.
20 IND. ZONE ΑΠΡ. ΖΩΝΗ 不確定域 비측정 영역 НЕОПР ЗОН
101 Standard Πρότυπο 基準 표준물질 Стандарт
103 VALID RECAL Έγκ. επαναβ. 有効な再キャリブレーション 유효한 재캘리브레이션 Дейс пов кал
104 INVALID RECAL Άκυρη επαναβ. 無効な再キャリブレーション 무효한 재캘리브레이션 Недейс пов кал
6005 VALID A Έγκυρο Α 有効な A 유효 A Действ A
6006 VALID B Έγκυρο Β 有効な B 유효 B Действ B
6007 VALID A/B Έγκυρο Α/Β 有効な A/B 유효 A/B Действ A/B
9001 INVALID ΑΚΥΡΟ 無効 무효 НЕДЕЙСТ.
9002 ND ND ND ND ND
9003 N/A N/A 該当なし 해당 사항 없음 Н/Д

Qualitative Result Values Appendix - Message Field Format and Values
Qualitative Result Values
The authorized qualitative values for both VIDAS® PC and VIDAS® 3 systems are the same in
all languages except Chinese, as described in the table below.
VIDAS® LIS Code sent to BCI Link LIS Code sent to BCI Link
(all languages except Chinese) in Chinese
Code Label
0 Positive POSITIVE 阳性
1 Equivocal EQUIVOCAL 灰区
2 Negative NEGATIVE 阴性
3 Reactive REACTIVE 反应的
4 Non-Reactive NONREACTIVE 不反应的
5 Low Positive LOWPOSITIVE 弱阳性
6 POSITIVE POSITIVE 阳性
7 NEGATIVE NEGATIVE 阴性
8 positive POSITIVE 阳性
9 equivocal EQUIVOCAL 灰区
10 negative NEGATIVE 阴性
11 Border. R BORDERR 灰区阳性边界
12 LOW LOW 低
13 INTERMED. INTERMEDIATE 中等
14 HIGH HIGH 高
15 OK OK 可以
16 Invalid INVALID 无效
17 Border. R BORDERR 灰区阳性边界
18 Nondetectable NONDETECTABLE 不能检测
19 VALID VALID 有效
20 IND. ZONE INDZONE 不确定区域
101 Standard STANDARD 标准
103 VALID RECAL VALIDRECAL 有效重定标
104 INVALID RECAL INVALIDRECAL 无效重定标
6005 VALID A VALIDA 有效 A
6006 VALID B VALIDB 有效 B
6007 VALID A/B VALIDAB 有效 A/B
9001 INVALID INVALID 无效
9002 ND ND 未定义
9003 N/A NA 不适用

Authorized Patient Sex Field Values in bMx Messages Appendix - Message Field Format and Values
Authorized Patient Sex Field Values in bMx Messages
The authorized sex values for both VIDAS® PC and VIDAS® 3 systems depend on the
configured language as described in the table below.
Mnemonic Male Female Unknown
VIDAS® PC / VIDAS® 3
English M F -
French M F -
Italian M F -
German M W -
Spanish H M -
Portuguese M F -
Polish M K -
Turkish E K -
Chinese 男女 -
VIDAS® 3 only
Russian M Ж -
Greek A Γ -
Japanese M F -
Korean M F -
Abnormal Flags (BMX and XML messages)
Two different sets of flags can be sent to LIS: VIDAS® flags and VIDAS® 3 flags.
VIDAS® Flags
The first group of flags is used for both VIDAS® PC and VIDAS® 3 unless otherwise specified.
Mnemonic Designation Condition
lotexp (VIDAS® PC only) lot expired If lot has expired
calexp (VIDAS® PC only) calibration expired If calibration has expired
contneff control not realized If controls are missing

calinc calibration not completed If calibration is invalid or missing
conthwst control out of westgard QCx with a footnote_id (example: ##, **, $%1, etc.)
conthnor control out of range Cx with a footnote_id (example: ##, **, $%1, etc.)
valid calibration validated In other cases
Note: The previous table indicates the priority, lotexp has the highest priority.

Abnormal Flags (BMX and XML messages) Appendix - Message Field Format and Values
VIDAS® 3 Flags
The second group of flags is ONLY available for VIDAS® 3 and XML messages.
Mnemonic Designation Condition
stabexp expired on-board stability If sample stays for too long on board
manpipet manual pipetting mode If analysis has been done with a manual pipetting
cabstrip CAB strip not read If the strip barcode could not be read by the
instrument
cabspr CAB spr not read If the spr barcode could not be read by the
instrument
nodecalc P24N result validity is subject to the If the single assay test P24 screening result is not
calculation of the titer decrease retrieved by the VIDAS® 3 system, the titer
because not done by the VIDAS® 3 decrease value cannot be calculated automatically
system and the P24N % result is sent to the LIS subject to
the calculation manually done by the customer to
validate or invalidate the result

C Appendix - Glossary
AI
Analysis instrument or analysis system.
bioMérieux AI = TEMPO®, VIDAS® & VITEK®, etc.
Analysis request
A message produced by the LIS containing one or more analysis requests. An analysis
request consists of one or more tests for a specific type of analysis. These analysis requests
can be attributed to one or more AIs.
Applications message
The bioMérieux computer will never send more than one applications message per session,
but it can receive more than one per session.
An applications message contains patient, specimen, and exam demographics and results. It
must always be complete so that the receiving applications layer can process the message
correctly. The applications message starts with mt and ends with either the next mt (if there
are multiple applications messages per session) or with an <EOT> or <GS>.
ASCII
American Standard Code for Information Interchange.
ASTM
American Society for Testing and Materials.
ASTM E1394
Standard specification for transferring information between clinical instruments and computer
systems, published in the early 90’s by the E31 committee and the American Society for
Testing and Materials.
 Reference Web site: http://www.nccls.org
ASTM_XML representation
Specifications of messages relating to the transfer of data between the bioMérieux analyzers
and the LIS. This specification, elaborated by bioMérieux, is based on the ASTM 1394
attributes with an XML message structure.
Attribute
Characteristic element.
BCI
bioMérieux Communication Interfaces.
161150-486 - B C-1 BCI - VIDAS® Range

Appendix - Glossary
bioMérieux format
Proprietary format, for the presentation of analysis requests and results, used in the
BCI RS232 or BCI Link messages.
bioMérieux protocol
Proprietary RS232 communication protocol.
BMX
Abbreviation for bioMérieux.
CLSI
Clinical and Laboratory Standards Institute (CLSI, formerly NCCLS) is an international,

interdisciplinary, nonprofit, standards-developing, and educational organization that promotes
the development and use of voluntary consensus standards and guidelines within the health
care community. Mostly followed in North America area.
Communication connection of socket
Represents a bi-directional interface between two applications on the same machine or on two
separate machines (inter-process communication).
Communication message
The communications layer sends an applications message through one or more

communications messages. The communications layer divides the applications message into
1,920 character blocks and sends each block consecutively. Adding the ASCII control
characters <STX>, <RS>, <GS>, and <ETX> to each block of the applications message
creates the communications messages. These characters describe the beginning and end of a
communications message and establish control of transmission errors.
A communications message always has an <STX> indicating the start of the message and an
<ETX> indicating the end. Each block is further subdivided by the <RS> character into records
from one to eighty characters long. The <GS> character marks the beginning of transmission
error control information. In order to handle transmission errors effectively, there is always one
<GS> character in a communications message.
Data representation
Type of description used to structure messages for data transfer between analysis instruments
and the laboratory information systems.
Field
A field is a discrete unit of information such as a patient name, sex, primary physician, etc.
Each field is preceded by a code that describes the type of field and also implies its length. All
fields end with one to three user-defined terminating characters (chosen from a subset of
ASCII characters). Each field has a maximum length in characters. BCI Link will accept data
that are less than or equal to the maximum number of allowable characters. Most fields that
are longer than the number of significant characters are truncated and the text is left-justified.
Note: The only exception is the exam ID (ci), which is truncated and right justified.

Appendix - Glossary
FTP
The FTP service is based on a client / server, architecture and is used to transfer files between
heterogeneous machines. It is based on the TCP/IP network protocols.
For further information, refer to the standard RFC 0959 - http://www.rfcs.org.
GAS
Global Access Server (GAS) is a solution provided by Axeda. It enables remote sessions to be
processed outside of the main platform system (as VILINK® server).
During global access sessions, the remote connections are processed through the Global
Access Server located closest to the remote asset and best equipped to support the
connection. It improves remote access performance by using optimized communication
protocol (direct SSL) on 443 port (standard port).
HIS
Hospital Information System
IIOP protocol
Communication protocol which integrates and networks applications of different origins.
IT
Information Technology
LIMS
Laboratory Information Management Systems – mainly used in industry scope
LIS
Laboratory Information Systems. A LIS will send analysis request to AI and will expect to
receive results from AI
N/A
Not Applicable
Packet
All records associated with a <GS> record are called a packet. At the end of a packet, the
sending computer waits for the receiver to send an acknowledgment that it received the
packet.

Appendix - Glossary
Properties file
Similar to a configuration file, a properties file contains the values for some of the
characteristics of the software. These values are read and used by the software itself.
Declaration of a property is defined as follows: property name=valu.
To declare a comment in a properties file, place the ‘#’ character at the beginning of the line.
‘\’ is a forbidden character. In a property value it should be used as: ‘\\’.

Example of a declaration with a comment:
# This property defines the access path for the temporary directory
tempDirectory=c:\\temp\\
A properties file always has the suffix “properties”.
Record
A communications message consists of one or more records. A record contains 1 to 80 ASCII

characters. All records begin with one of the following ASCII control characters: <STX>,
<ETX>, <RS>, or <GS>. Each record type can be terminated by the new line sequence
<CR><LF>.
Note: The new line sequence is optional and not included in the size of the record.
Results message
A message produced by an AI which attaches information to the analysis requests contained

in the analysis request. This information includes all the useful or essential data corresponding
to the results of the analyses.
RS232
Abbreviation of "Recommended standard – 232C", standard interface for connection of serial

drivers.
Session
A session consists of a connection between the host and a bioMérieux computer. Data
transfer in a single session can only go in one direction at a time. The initiator of the session is
the sender and the other computer is the receiver. The ASCII line request character <ENQ>
starts the session. <EOT> signals the end of the message and session.
Socket
Communication connection.
Specimen ID
Unique identifier used by the lab to identify a clinical specimen.
TBD
To Be Defined.

Appendix - Glossary
TCP/IP
Transport Control Protocol / Internet Protocol.
Test order
A series of tests to be performed for a sample. An analysis request consists of a series of test orders.
Type of test
Type of analysis that an AI is capable of performing on a sample using a reagent kit and an
analysis procedure.
XLS
MS Excel file extension
XML
Abbreviation of "Extensible Markup Language". XML is a markup specification language for

structuring documents.
 Reference Web site: http://www.w3.org/XML/
XML schema
A method for describing XML document, mainly including a description of all the data types
(XML element and attribute) and the document structure. Tools are used to validate an XML
source with an XML schema.
 Reference Web site: http://www.w3.org/XML/Schema.

Revision History
This section contains a summary of changes made to each released revision of this document starting with
part number 161150-486 - A.
Change type categories:
N/A Not applicable (First publication)

Correction Correction of documentation anomalies
Technical change Addition, revision and/or removal of information related to the product
Administrative Implementation of non-technical changes noticeable to the user
Note: Minor typographical, grammar, and formatting changes are not included in the revision history.
Release Date Part Number Change Type Change Summary
2017-01 161150-486 B Technical change Update of the miniVIDAS® RS232 configuration illustration
(Section 2 > System Overview > Basic RS232 Configuration with
BCI Link > miniVIDAS® RS232 Configuration)
Update of information relating to the FTP configuration

(Section 2 > System Overview > FTP Configuration with BCI Link)
Addition of a section relating to other bioMérieux configuration

(Section 2 > System Overview > FTP Configuration with BCI Link >
Other bioMérieux Configuration)
Removal of the Minimal Network Configuration section (Section 2 >

System Overview > FTP Configuration with BCI Link > Minimal
Network Configuration)
Addition of a section relating to the different connection details

(Section 2 > System Overview > FTP Configuration with BCI Link >
RP5800 and RP5810 Computers Connector Panels)
Udpate of the VIDAS® 3 software version (Section 4 > RS232

System Specificities)
Addition of information relating to the new CMVA parameter

(Section 4 > RS232 System Specificities > CMVA Parameter
Specific Description)
Update of the actionCode and expirationDate attributes (Section 8 >

ASTM-XML System Specificities > Data Types )
Addition of information relating to the new CMVA parameter

(Section 8 > ASTM-XML System Specificities > CMVA Parameter
Specific Description)
Addition of a warning relating to the update of the demography

(Section 10 > Error and Duplication Management > Duplication
Management)
Addition of information relating to the CMVA management

(Appendix A > Main Differences within the VIDAS® Range >
General Information)
Revision History
Release Date Part Number Change Type Change Summary
2014-06 161150-486 A N/A First publication

Service Manual - VIDAS Range - BCI Connectivity For LIS - 161150-486 - B - MAR 3408

Загружено:

Сведения о документе

Оригинальное название

Авторское право

Доступные форматы

Поделиться этим документом

Поделиться или встроить документ

Параметры публикации

Этот документ был вам полезен?

Это неприемлемый материал?

Авторское право:

Доступные форматы

Service Manual - VIDAS Range - BCI Connectivity For LIS - 161150-486 - B - MAR 3408

Загружено:

Авторское право:

Доступные форматы

VIDAS® Range - BCI

Connectivity Service Manual

LIS Interface Driver Development Guide

Any other name or trademark is the property of its respective owner.

Introduction to the System ........................................................................................ 1-1

System Overview ........................................................................................................ 2-1

RS232 and FTP Specificities

RS232 Messages......................................................................................................... 3-1

RS232 System Specificities ....................................................................................... 4-1

161150-486 - B i BCI - VIDAS® Range

Data Types . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-4

RS232 miniVIDAS® System Specificities.................................................................. 5-1

Examples of RS232 Messages .................................................................................. 6-1

ASTM-XML (FTP) Messages ...................................................................................... 7-1

161150-486 - B ii BCI - VIDAS® Range

Conventions to Follow in Writing Pseudocode . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-18

ASTM-XML System Specificities ............................................................................... 8-1

Examples of ASTM-XML (FTP) Messages ................................................................ 9-1

Error and Duplication Management ........................................................................ 10-1

Introduction to the BCI Simulators ......................................................................... 11-1

Installation Procedure .............................................................................................. 12-1

161150-486 - B iii BCI - VIDAS® Range

Principle of Operation .............................................................................................. 13-1

LIS – RS232 SIMULATOR ......................................................................................... 14-1

161150-486 - B iv BCI - VIDAS® Range

LIS – FTP Simulator .................................................................................................. 15-1

161150-486 - B v BCI - VIDAS® Range

Step 3: Save the Message . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 16-10

Appendix A - Main Differences within the VIDAS® Range ......................................A-1

Appendix B - Message Field Format and Values .....................................................B-1

Appendix C - Glossary ...............................................................................................C-1

161150-486 - B vi BCI - VIDAS® Range

Intended Use and Users

The BCI (bioMérieux Communication Interfaces) is a software used to establish

Screens and equipment are not shown to scale.

161150-486 - B 1-1 BCI - VIDAS® Range

Warnings and Safety Messages

The warning messages in this manual mainly refer to:

A Warning statement alerts the user to the possibility of injury, death, or

IMPORTANT: An Important statement relates to content presented in the user documentation. It is

Note: A Note statement supplies additional information about a topic.

161150-486 - B 1-2 BCI - VIDAS® Range

Installation, service, and repair should only be performed by authorized and

bioMérieux recommends connecting this instrument to a main power outlet

Before undertaking electrical safety or other compliance testing on the instrument,

161150-486 - B 1-3 BCI - VIDAS® Range

In this section, represents a network cable and an RS232 cable.

Basic RS232 Configuration with BCI Link

VIDAS® PC RS232 Configuration (single instrument)

The following illustration describes a VIDAS® PC RS232 configuration.

Figure 2-1: VIDAS® PC RS232 Configuration (single instrument)

161150-486 - B 2-1 BCI - VIDAS® Range

VIDAS® 3 RS232 Configuration (single instrument)

The following illustration describes a VIDAS® 3 RS232 configuration.

Figure 2-2: VIDAS® 3 RS232 Configuration (single instrument)

161150-486 - B 2-2 BCI - VIDAS® Range

miniVIDAS® RS232 Configuration

IMPORTANT: miniVIDAS® is a standalone instrument that enables unidirectional transmission of test

It is NOT possible to send any test requests to the miniVIDAS® instrument.

The following illustration describes a miniVIDAS® RS232 configuration.

Figure 2-3: miniVIDAS® RS232 Configuration

The miniVIDAS® RS232 configuration includes:

161150-486 - B 2-3 BCI - VIDAS® Range