Sunteți pe pagina 1din 141

BCI Connectivity Service Manual

LIS Interface Driver Development


Guide

EN
161150-809 - A - en - 2016-12– P/N 161150-809

bioMérieux SA
376 Chemin de l’Orme
69280 Marcy-l’Etoile - France
Tél: 33 (0)4 78 87 20 00
Fax: 33 (0)4 78 87 20 90
www.biomerieux.com

Service Manual - VITEK 2 Systems - BCI Connectivity Service Manual - REF 161150-809_A - MAR 3284
General Information

The content of this document is based on the bioMérieux BCI Link version R4.1.0.

Please discard any previous copies of this document if relevant.

This document may contain information or references relating to certain bioMérieux products,
software or services which are not available in the country of release; this shall not mean that
bioMérieux intends to market such products, software or services in such country.

To request copies of publications or for any technical request / assistance, contact bioMérieux
or your local distributor (contact information available on www.biomerieux.com).

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.

Intellectual Property

BIOMERIEUX, the blue logo, BCI Link and VITEK 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.

© 2016 bioMérieux SA
bioMérieux SA 673 620 399 RCS Lyon

Service Manual - VITEK 2 Systems - BCI Connectivity Service Manual - REF 161150-809_A - MAR 3284
Table of Contents

Introduction

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


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

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


Basic RS232 Configuration with BCI Link . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-1
FTP Configuration with BCI Link . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-2
Ideal bioMérieux configuration - Sub-Network dedicated to VITEK® 2 Systems . . . . . . 2-2
Minimal Network Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-3

RS232 and FTP Details

RS232 Message Format and Protocol ...................................................................... 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-7
Checksum Field Format . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-8
Configuration of the Connection . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-9

RS232 Message Structure and Data Types .............................................................. 4-1


Message Structure . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-1
Formatting Rules . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-2
Download . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-2
Upload . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-2
Data Types . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-3
Download Fields . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-3
Upload Fields . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-4

RS232 Message Examples ......................................................................................... 5-1


LIS Message (Download) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-1
AI Message (Upload) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-2

161150-809 - A i BCI - VITEK® 2


Service Manual - VITEK 2 Systems - BCI Connectivity Service Manual - REF 161150-809_A - MAR 3284
Table of Contents

FTP-XML Message Format and Protocol .................................................................. 6-1


Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-1
Introduction to XML Schema . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-2
Declaration of Types . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-2
Occurrence Constraints . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-2
VITEK® 2 System XML Schema . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-2
Naming Rules . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-3
Analysis Request . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-3
Analysis Result . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-3
Test Dispatching Mode for VITEK® 2 Systems . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-4
Transport of FTP-XML Messages . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-4
Managing FTP Sessions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-5
Opening a Session. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-5
Configuring Connections for Data Transfer . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-6
Shutting down a Session . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-6
Managing Analysis Requests (LIS to BCI) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-7
Description of the "STOR" Command . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-7
Examples of how the "STOR" Command is used . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-8
Algorithm for Sending Analysis Requests . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-9
Managing Results (BCI to LIS) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-10
Description of the "RETR" Command . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-10
Examples of how the "RETR" Command is used . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-11
Algorithm for Receipt of Results . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-12
FTP Commands supported by the Server . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-13
FTP Return Codes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-16
Conventions to Follow in Writing Pseudocode . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-17

FTP-XML Message Structure and Data Types.......................................................... 7-1


Formatting Rules . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-1
Data Types . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-1

FTP-XML Message Examples .................................................................................... 8-1


LIS Messages (Download) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8-1
AI Messages (Upload) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8-1

BCI Simulators

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


Purpose . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9-1
Content of the Master . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9-1

161150-809 - A ii BCI - VITEK® 2


Service Manual - VITEK 2 Systems - BCI Connectivity Service Manual - REF 161150-809_A - MAR 3284
Table of Contents

Installation Procedure .............................................................................................. 10-1


General Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10-1
Installing the BCI Simulator . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10-1
Uninstalling the BCI Simulator . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10-3
Preliminary Steps . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10-3
Uninstalling BCI Simulators . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10-3

Principle of Operation .............................................................................................. 11-1


User Interface . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11-3
Opening BCI Simulators . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11-3
Description of the Interface . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11-4
Description of the Functionalities . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11-5
Defining Parameters for the Simulator Text Editors. . . . . . . . . . . . . . . . . . . . . . . . . . . 11-7
Sub-folders Architecture of the BCI Simulators Directory. . . . . . . . . . . . . . . . . . . . . . . . . . 11-8

LIS – RS232 SIMULATOR ......................................................................................... 12-1


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

161150-809 - A iii BCI - VITEK® 2


Service Manual - VITEK 2 Systems - BCI Connectivity Service Manual - REF 161150-809_A - MAR 3284
Table of Contents

Managing Analysis Requests in "text" Format . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12-20


Presentation of the Editor . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12-20
Step 1: Create an Analysis Request . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12-20
Step 2: Complete the Analysis Request . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12-20
Step 3: Save the Analysis Request . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12-20
Step 4: Send an Analysis Request . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12-20

LIS – FTP Simulator .................................................................................................. 13-1


Accessing the LIS Simulator and Setting Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13-1
Setting Parameters for the FTP Connection . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13-1
Managing Analysis Requests in "ASTM-XML" Format. . . . . . . . . . . . . . . . . . . . . . . . . . . . 13-3
Presentation of the Editor . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13-3
Step 1: Create an Analysis Request . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13-4
Step 2: Complete the Analysis Request . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13-4
Step 3: Save the Analysis Request . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13-9
Step 4: Send an Analysis Request . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13-9
Managing Analysis Requests in "text" Format . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13-10
Presentation of the Editor . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13-10
Step 1: Create an Analysis Request . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13-10
Step 2: Complete the Analysis Request . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13-10
Step 3: Save the Analysis Request . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13-10
Step 4: Send an Analysis Request . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13-10
Receiving Results. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13-11
Presentation of the Results Download Interface . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13-11
Downloading a Result . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13-12

AI Simulator............................................................................................................... 14-1
Parameter Setting and Connections. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14-1
Setting Parameters for the AI Simulators. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14-1
Opening and Closing a Session on an AI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14-3
Updating the Configuration of the AI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14-4
Receiving Analysis Requests sent by BCI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14-5
Managing Results in "ASTM-XML" Format . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14-6
Presentation of the Editor . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14-6
Step 1: Create a Result Message . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14-7
Step 2: Complete or Modify the Message using new Results . . . . . . . . . . . . . . . . . . . 14-7
Step 3: Save the Message . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14-7
Step 4: Send the Message. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14-7
Managing Results in "text" Format . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14-8
Presentation of the Editor . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14-8
Step 1: Create a Result Message . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14-8
Step 2: Complete or Modify the Message with New Results . . . . . . . . . . . . . . . . . . . . 14-8

161150-809 - A iv BCI - VITEK® 2


Service Manual - VITEK 2 Systems - BCI Connectivity Service Manual - REF 161150-809_A - MAR 3284
Table of Contents

Step 3: Save the Message . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14-8


Step 4: Send the Message. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14-8
Managing Results in "bioMérieux" Format . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14-9
Presentation of the Editor . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14-9
Step 1: Create a Result Message . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14-10
Step 2: Complete or Modify the Message using New Results . . . . . . . . . . . . . . . . . . 14-10
Step 3: Save the Message . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14-10
Step 4: Send the Message. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14-10
Setting Parameters for the "bioMérieux" Result Editor. . . . . . . . . . . . . . . . . . . . . . . . . . . 14-11

Appendices

Appendix A - Glossary ...............................................................................................A-1

161150-809 - A v BCI - VITEK® 2


Service Manual - VITEK 2 Systems - BCI Connectivity Service Manual - REF 161150-809_A - MAR 3284
Introduction

Service Manual - VITEK 2 Systems - BCI Connectivity Service Manual - REF 161150-809_A - MAR 3284
1 Introduction to the System

Intended Use and Users

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.

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 document 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-809 - A 1-1 BCI - VITEK® 2


Service Manual - VITEK 2 Systems - BCI Connectivity Service Manual - REF 161150-809_A - MAR 3284
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 or your local distributor.

CAUTION: The computer and its operating system have been carefully configured
for optimal performance of the VITEK® 2 system. Altering the configuration may
severely hamper the usability of the instrument.

161150-809 - A 1-2 BCI - VITEK® 2


Service Manual - VITEK 2 Systems - BCI Connectivity Service Manual - REF 161150-809_A - MAR 3284
2 System Overview

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

Basic RS232 Configuration with BCI Link

The VITEK® 2 Systems RS232 configuration includes:

• 1 VITEK® 2 Systems PC.


• 1 to 4 VITEK® 2 Systems instruments connected with a serial cable to the
VITEK® 2 Systems PC.
The instruments need to be all of the same type, either VITEK® 2 or VITEK® 2 Compact.
• The BCI Link software installed on the VITEK® 2 Systems PC.
• 1 LIS computer connected with a serial cable (RS232) directly to the VITEK® 2 Systems PC
com port, or connected via a laboratory network cable.

The following illustration describes a VITEK® 2 Systems RS232 configuration.

Figure 2-1: VITEK® 2 System RS232 Configuration

161150-809 - A 2-1 BCI - VITEK® 2


Service Manual - VITEK 2 Systems - BCI Connectivity Service Manual - REF 161150-809_A - MAR 3284
FTP Configuration with BCI Link System Overview

FTP Configuration with BCI Link

There are many different configurations that can be set to interconnect VITEK® 2 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 the ideal
bioMérieux configurations that can be realized.

Ideal bioMérieux configuration - Sub-Network dedicated to VITEK® 2 Systems


The best way to install VITEK® 2 Systems is to create a VITEK® 2 Systems sub-network
(LAN - Local Area Network) defined by the Checkpoint Safe@Office router (ref. 412915 -
Generic Sao 1000 Firewall kit) connected to the customer network (WAN - Wide Area
Network).

Due to the firewall included in the Safe@Office router, bioMérieux ensures VITEK® 2
Systems data control and security within the sub-network defined by the router.

Figure 2-2: Ideal bioMérieux Configuration

The above picture is an example of the ideal bioMérieux configuration. Below in details, the
components of this network:

• The router firewall is the device that:


• creates the VITEK® 2 Systems sub-network dedicated to the VITEK® 2 Systems,
• allows the communication with the customer network,
• ensures data control and security within the VITEK® 2 Systems sub-network.

161150-809 - A 2-2 BCI - VITEK® 2


Service Manual - VITEK 2 Systems - BCI Connectivity Service Manual - REF 161150-809_A - MAR 3284
FTP Configuration with BCI Link System Overview

• 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
VITEK® 2 Systems sub-network.
• The VITEK® 2 Systems sub-network - All the VITEK® 2 Systems and related devices
(printers, switches, etc.) are connected to this sub-network.
• The VITEK® 2 Systems - 1 to 4 systems can be connected to the same BCI Link and under
the same sub-network.
• One or more optional switches (ref. 412914 - Generic GS 900 8P Switch Kit) can be used to
extend the physical connections.
In Figure “Ideal bioMérieux Configuration” on page 2-2, there are 3 network connections
(2 VITEK® 2 Systems computers and 1 printer).
Other devices can aslo be connected. The router can only host 4 network connections, so a
switch is necessary to complete the configuration if you want to connect more than 4 devices.

Minimal Network Configuration


A different way of creating a network is to connect all the systems directly to the Laboratory
Network.

IMPORTANT: No router is used, so for security reasons, we recommend to apply this configuration
only if strictly required by the Laboratory policies.

As shown on Figure “Minimal Network Configuration” on page 2-3 all the VITEK® 2 Systems
and related devices (printers, switches, etc.) are directly connected to the Laboratory Network
(WAN). Internet, the VILINK server and the LIS should also be connected to this network.

Figure 2-3: Minimal Network Configuration

161150-809 - A 2-3 BCI - VITEK® 2


Service Manual - VITEK 2 Systems - BCI Connectivity Service Manual - REF 161150-809_A - MAR 3284
RS232 and FTP Details

Service Manual - VITEK 2 Systems - BCI Connectivity Service Manual - REF 161150-809_A - MAR 3284
3 RS232 Message Format and Protocol

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-809 - A 3-1 BCI - VITEK® 2


Service Manual - VITEK 2 Systems - BCI Connectivity Service Manual - REF 161150-809_A - MAR 3284
Protocols RS232 Message Format and Protocol

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-809 - A 3-2 BCI - VITEK® 2


Service Manual - VITEK 2 Systems - BCI Connectivity Service Manual - REF 161150-809_A - MAR 3284
Protocols RS232 Message Format and Protocol

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-809 - A 3-3 BCI - VITEK® 2


Service Manual - VITEK 2 Systems - BCI Connectivity Service Manual - REF 161150-809_A - MAR 3284
Protocols RS232 Message Format and Protocol

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-809 - A 3-4 BCI - VITEK® 2


Service Manual - VITEK 2 Systems - BCI Connectivity Service Manual - REF 161150-809_A - MAR 3284
Protocols RS232 Message Format and Protocol

Frame Message Examples

Patient Demographics and Test Request Sent from LIS to bioMérieux Computer for ID or
Susceptibility Test

Susceptibility Test Request and Results Sent from bioMérieux Computer to LIS

Test Results Sent from LIS to bioMérieux Computer (Organism and AST Offline Test)

161150-809 - A 3-5 BCI - VITEK® 2


Service Manual - VITEK 2 Systems - BCI Connectivity Service Manual - REF 161150-809_A - MAR 3284
Protocols RS232 Message Format and Protocol

ID Result Sent from LIS to bioMérieux Computer (Patient and Isolate Information)

161150-809 - A 3-6 BCI - VITEK® 2


Service Manual - VITEK 2 Systems - BCI Connectivity Service Manual - REF 161150-809_A - MAR 3284
Managing Messages RS232 Message Format and Protocol

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-809 - A 3-7 BCI - VITEK® 2


Service Manual - VITEK 2 Systems - BCI Connectivity Service Manual - REF 161150-809_A - MAR 3284
Checksum Field Format RS232 Message Format and Protocol

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-809 - A 3-8 BCI - VITEK® 2


Service Manual - VITEK 2 Systems - BCI Connectivity Service Manual - REF 161150-809_A - MAR 3284
Configuration of the Connection RS232 Message Format and Protocol

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.

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 1200
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-809 - A 3-9 BCI - VITEK® 2


Service Manual - VITEK 2 Systems - BCI Connectivity Service Manual - REF 161150-809_A - MAR 3284
4 RS232 Message Structure and Data Types

Message Structure

Figure 4-1: LIS/AI RS232 Message Structure

LIS Message (download)

This message is sent by the LIS to the VITEK® 2 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 | si | s0 | s1 | s3 | ci | c0 | ct | cn | zz |

AI Message (upload)

This message is sent by the VITEK® 2 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 | si | s0 | s1 | s3 | ci | c0 | ct | cn | ta | rt | rr | t1 | o1 | o2 | af | ap | ra | a1 | a2 | a3 | a4
| an | zz |

Note: No specific field is expected to indicate the end of the messages.

161150-809 - A 4-1 BCI - VITEK® 2


Service Manual - VITEK 2 Systems - BCI Connectivity Service Manual - REF 161150-809_A - MAR 3284
Formatting Rules RS232 Message Structure and Data Types

Formatting Rules

Messages exchanged in both directions are formatted according to well defined formatting
rules.

Download
• Applications messages are divided into fields and must be logically complete. The first field is
the message type, which dictates the number and types of remaining fields in the message.
• A complete message is made up of the message type and all its related fields.
• Data is separated into five groups: patient, specimen, culture (or exam), tests, and results.
Each group contains a specific set of fields.
• Each field has a fixed size in the database. If the database receives a value larger than its
fixed size, the field will be truncated to fit. All fields are left-justified and truncated except the
exam id (ci) field. It is right-justified and truncated.
• Fields from one group cannot be used in another. The beginning of each group is marked by a
specific field, a patient ID (pi) for patient demographics, a specimen separator (si) for
specimen data, (ci) for culture/exam data, (ta) for tests and (ra) for results.
• Field values shorter than defined do not need to be padded to the maximum size.
• A terminator ends each field. The default terminator is the vertical bar ( | ).

IMPORTANT: The decimal separator should always be “.” (dot), whatever the locale is.

Upload
• A BCI upload is when test results are sent from the bioMérieux computer to the host LIS
computer. All BCI application messages are complete, with each message divided into fields.
• The first field is the message type. It establishes the number and types of remaining fields
within the message. A complete message contains a message type and all the fields that
message type requires.
• Each field is assigned a unique two-character code. A field cannot be larger than its maximum
size. Depending on the needs of the host LIS computer, each field may or may not be padded
with spaces to fill out its maximum size.
For more details on message format, see the Data Types section below.

161150-809 - A 4-2 BCI - VITEK® 2


Service Manual - VITEK 2 Systems - BCI Connectivity Service Manual - REF 161150-809_A - MAR 3284
Data Types RS232 Message Structure and Data Types

Data Types

The table below lists all the possible fields with their associated characteristics.

In this table:

•  means that the field is mandatory.


•  UPLOAD means that the field can be sent (AI to LIS)
•  DOWNLOAD means that the field can be received (LIS to AI)
•  UPLOAD / DOWNLOAD means that the field can be sent and received

Note: The order of the following table is not the expected order.

Download Fields
Demographic Fields show the fields that bioMérieux computers recognize in a demographics
(mpr) message type.

For VITEK® 2, the first maximum field size shown is listed.

Maximum
Code Description Type Required Direction
Length

mt Message Type CODE 3


  UPLOAD / DOWNLOAD
pi Patient ID CODE 16
  UPLOAD / DOWNLOAD
pv Patient Alternate ID CODE 16  UPLOAD / DOWNLOAD
pn Patient Name CODE 40  UPLOAD / DOWNLOAD
pl Patient Location Code CODE 40  UPLOAD / DOWNLOAD
pp Patient Physician Code CODE 15  UPLOAD / DOWNLOAD
pc Patient Comment Code CODE 6  UPLOAD / DOWNLOAD
w1 Patient Wild 1 CODE 16  UPLOAD / DOWNLOAD
si Specimen Separator SEPARATOR 0
  UPLOAD / DOWNLOAD
ss Specimen Source Code CODE 15  UPLOAD / DOWNLOAD
s1 Specimen Collection DATE 20  UPLOAD / DOWNLOAD
Date
s2 Specimen Collection TIME 20  UPLOAD / DOWNLOAD
Time
sc Specimen Comment CODE 6  UPLOAD / DOWNLOAD
Code

161150-809 - A 4-3 BCI - VITEK® 2


Service Manual - VITEK 2 Systems - BCI Connectivity Service Manual - REF 161150-809_A - MAR 3284
Data Types RS232 Message Structure and Data Types

Maximum
Code Description Type Required Direction
Length

ci Lab ID CODE 20
  UPLOAD / DOWNLOAD
ct Culture Type Code CODE 40  UPLOAD / DOWNLOAD
t1 Isolate Number CODE 2  UPLOAD / DOWNLOAD
o1 Final Organism Code CODE 15  UPLOAD / DOWNLOAD
o2 Final Organism Name CODE 60  UPLOAD / DOWNLOAD
ba Offline Test Separator SEPARATOR 0  DOWNLOAD
b1 Offline Test Code CODE 15  DOWNLOAD
b2 Offline Test name CODE 60  DOWNLOAD
zz Result End SEPARATOR 0  UPLOAD / DOWNLOAD
b3 Offline Test Result Code CODE 15  DOWNLOAD

The pn field contains the entire patient name. In many cases, the pn field is downloaded with
the last name, followed by a comma, and then the first name.
Example: |pnDoe, Jane|.

Upload Fields

Maximum
Code Description Type Required Direction
Length

mt Message Type CODE 3


  UPLOAD / DOWNLOAD
ii Instrument Code CODE 2  UPLOAD
is Instrument Serial CODE 80  UPLOAD
Number
it Test Group Code CODE 2  UPLOAD
pi Patient ID CODE 16
  UPLOAD / DOWNLOAD
pv Patient Alternate ID CODE 16  UPLOAD / DOWNLOAD
pn Patient Name CODE 40  UPLOAD / DOWNLOAD
pl Patient Location Code CODE 40  UPLOAD / DOWNLOAD

161150-809 - A 4-4 BCI - VITEK® 2


Service Manual - VITEK 2 Systems - BCI Connectivity Service Manual - REF 161150-809_A - MAR 3284
Data Types RS232 Message Structure and Data Types

Maximum
Code Description Type Required Direction
Length

p2 Patient Location Name CODE 40  UPLOAD


pp Patient Physician Code CODE 15  UPLOAD / DOWNLOAD
p5 Patient Physician Name CODE 40  UPLOAD
pc Patient Comment Code CODE 6  UPLOAD / DOWNLOAD
pt Patient Comment text CODE 800  UPLOAD
w1 Patient Wild 1 CODE 16  UPLOAD / DOWNLOAD
si Specimen Separator SEPARATOR 0
  UPLOAD / DOWNLOAD
s0 Specimen System Code CODE 8  UPLOAD
ss Specimen Source Code CODE 15  UPLOAD / DOWNLOAD
s5 Specimen Comment CODE 26  UPLOAD
Name
s1 Specimen Collection DATE 20  UPLOAD / DOWNLOAD
Date
s2 Specimen Collection TIME 20  UPLOAD / DOWNLOAD
Time
s3 Specimen Receipt Date DATE 20  UPLOAD
s4 Specimen Receipt Time TIME 20  UPLOAD
sc Specimen Comment CODE 6  UPLOAD / DOWNLOAD
Code
sn Specimen Comment CODE 800  UPLOAD
Text
ci Lab ID CODE 20
  UPLOAD / DOWNLOAD
c0 Lab ID System Code CODE 8  UPLOAD
ct Culture Type Code CODE 40  UPLOAD / DOWNLOAD
cn Culture Type Name CODE 40  UPLOAD
ta Test Separator SEPARATOR 0  UPLOAD
rt Test Type Code CODE 20  UPLOAD
rr Isolate System Code CODE 8  UPLOAD
t4 Test Status Code CODE 2  UPLOAD

161150-809 - A 4-5 BCI - VITEK® 2


Service Manual - VITEK 2 Systems - BCI Connectivity Service Manual - REF 161150-809_A - MAR 3284
Data Types RS232 Message Structure and Data Types

Maximum
Code Description Type Required Direction
Length

t5 Test Status Name CODE 16  UPLOAD


r1 Isolate Initial Reading DATE 20  UPLOAD
Date
r2 Isolate Initial Reading TIME 20  UPLOAD
Time
r3 Isolate Final Call Date DATE 20  UPLOAD
r4 Isolate Final Call Time TIME 20  UPLOAD
ts Card Data Separator SEPARATOR 0  UPLOAD
tu Card Type Code CODE 8  UPLOAD
tp Card Barcode CODE 18  UPLOAD
tg Card Lot Number CODE 40  UPLOAD
te Card Expiration Date DATE 20  UPLOAD
th Card Initial Reading DATE 20  UPLOAD
Date
tk Card Initial Reading TIME 20  UPLOAD
Time
td Card Final Call Date DATE 20  UPLOAD
tm Card Final Call Time TIME 20  UPLOAD
tq Card Setup Tech Code CODE 20  UPLOAD
tr Card Setup Tech Name CODE 30  UPLOAD
t1 Isolate Number CODE 2  UPLOAD / DOWNLOAD
o1 Final Organism Code CODE 15  UPLOAD / DOWNLOAD
o2 Final Organism Name CODE 60  UPLOAD / DOWNLOAD
o3 Final Bionumber CODE 16  UPLOAD
o4 Organism Quantity CODE 6  UPLOAD
Code
o5 Organism Quantity CODE 20  UPLOAD
Name
mc McFarland CODE 5  UPLOAD

161150-809 - A 4-6 BCI - VITEK® 2


Service Manual - VITEK 2 Systems - BCI Connectivity Service Manual - REF 161150-809_A - MAR 3284
Data Types RS232 Message Structure and Data Types

Maximum
Code Description Type Required Direction
Length

mn McFarland Range mmin CODE 5  UPLOAD


mx McFarland Range Max CODE 5  UPLOAD
o9 Percent Probability FLOAT 8  UPLOAD
oc ID Confidence Name CODE 255  UPLOAD
ac AES Confidence Name CODE 40  UPLOAD
af Antibiotic Family Name CODE 40  UPLOAD
ap Phenotype Names CODE 800  UPLOAD
ra Result Separator SEPARATOR 0  UPLOAD
ar Suppressed Antibiotic INDICATOR 0  UPLOAD
Flag
ad Deduced Antibiotic Flag INDICATOR 0  UPLOAD
a1 Antibiotic Code CODE 15  UPLOAD
a2 Antibiotic Name CODE 60  UPLOAD
at Suppressed MIC Flag INDICATOR 0  UPLOAD
a3 Result MIC CODE 8  UPLOAD
a4 Final Interpretation CODE 10  UPLOAD
zz Result End SEPARATOR 0  UPLOAD / DOWNLOAD
nc User Comment Code CODE 6  UPLOAD
nd User Comment CODE 800  UPLOAD
ae Disabled With Comment INDICATOR 0  UPLOAD
Antibiotic Flag
an Not Expertised CODE 10  UPLOAD
Interpretation

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.

161150-809 - A 4-7 BCI - VITEK® 2


Service Manual - VITEK 2 Systems - BCI Connectivity Service Manual - REF 161150-809_A - MAR 3284
5 RS232 Message Examples

LIS Message (Download)

The sending of information from the LIS (Host) to VITEK® 2 Systems (AI).

The VITEK® 2 Systems PC supports three types of download packets. They are:

• Patient and specimen only


• Test results only. Test results include organism and AST offline tests.
• Patient, specimen, and test results.
Applications layer messages can be any of the types described in the Download Messages
and the Required Field Types. They can have one or more field types associated with the
patient, specimen, and exam data and must be in this order:

1. Patient ID and optional patient demographics.


2. Specimen separator and optional specimen data.
3. Test information can be included in the download, followed by the repeating results of the
test. Each result for the same test must be preceded by a result separator, and different
tests must be preceded by a test separator. Multiple tests are allowed.
To download multiple specimens for a single patient, repeat items two through five in
sequence. To download multiple exams for a single specimen (VITEK® 2 only), repeat items
three through five. To download multiple tests, repeat item five.

Note: There can be only one patient per mtmpr message.

The following examples contain sample packets of test data. Line breaks are for example
purposes only. There are no line breaks or carriage returns in a data packet unless <CR><LF>
characters are entered.

• Patient Demographics and Specimen Only

mtmpr|pi1001|pnpatient1,One|pl1West|ppph3|p|si
|sssback|s108/31/2003|s201:34|ci100106|ctcsf3|zz|

• Patient Demographics, Specimen, and Test Results (Organism)

mtmpr|pi193301|pnHo, Ida|pl4|ppsu|
si|ssu|s102/21/1994|s208:40|ci020517|ctr|ta|rt
gni|t11|o1promir|zz|

• Patient Demographics, Specimen, and Test Results (Organism and AST Offline Test)

mtmpr|pi10113|pnPatient113, One
113|pl1West|ppph1|si|ssrtIV|s108/31/2003|s201:33|ci1011
3|ctblood|t11|o1staaur|o2Staph aureus|b1Bla|b2Beta
Lactamase|b3Pos|zz|

161150-809 - A 5-1 BCI - VITEK® 2


Service Manual - VITEK 2 Systems - BCI Connectivity Service Manual - REF 161150-809_A - MAR 3284
AI Message (Upload) System Installation and Configuration

AI Message (Upload)

Refer to the following files for examples of messages sent by VITEK® 2 System to the LIS.

• ID Card Only (default fields enabled)

mtrsl|iiV2|is185634909990|itID|pi123456789|pnDoe,
Jane|pl8west|p28west|ppDr. Smith|p5Dr. Smith|pccom1|
ptcom1|si|s075|ssCalf|s5Calf|s111/13/2016|s311/13/2016|
ci601|c075|ctWound|cnWound|ta|rtGN|rr178457|t4F|t5Final
|t11|o1promir|o2Proteus mirabilis|o30007001340442230|
o998|zz|

• AST GN Card

mtrsl|iiV2|is185634909990|itSU|pi3534345345335345|pnDoe,
John|si|s054|s111/13/2016|s218:00|s311/13/2016|s418:00
|ci203|c054|ctblood|cnblood|ta|rtAST-GN04|rr170658|t4F
|t5Final|t11|o1esccol|o2Escherichia coli|afQUINOLONES|
apWILD|afBETA-LACTAMS|apWILD|afFURANES|apWILD|afAMINO-
GLYCOSIDES|apWILD|afTRIMETHOPRIM/SULFONAMIDES|
apTRIMETHOPRIM RESISTANT|apWILD|ra|a1am|a2Ampicil-
lin|a34|a4S|anS|ra|a1ams|a2Ampicillin/Sulbactam|a34|
a4S|anS|ra|a1pip|a2Piperacillin|a3<=4|a4S|anS|ra|a1tzp
|a2Piperacillin/Tazobactam|a3<=4|a4S|anS|ra|a1cz|
a2Cefazolin|a3<=4|a4S|anS|ra|a1rox|a2Cefuroxime|a34|a4S
|anS|ra|a1roxa|a2Cefuroxime Axetil |a34|a4S|anS|ra|
a1cte|a2Cefotetan|a3<=4|a4S|anS|ra|a1taz|a2Ceftazidime|
a3<=1|a4S|anS|ra|a1ctr|a2Ceftriaxone|a3<=1|a4S|anS|ra
|a1fep|a2Cefepime|a3<=1|a4S|anS|ra|a1azm|a2Aztreonam|
a3<=1|a4S|anS|ra|a1imi|a2Imipenem|a3<=1|a4S|anS|ra
|a1an|a2Amikacin|a3<=2|a4S|anS|ra|a1gm|a2Gentamicin|
a3<=1|a4S|anS|ra|a1tob|a2Tobramycin|a3<=1|a4S|anS|ra|
a1cip|a2Ciprofloxacin|a3<=0.25|a4S|anS|ra|a1lev|
a2Levofloxacin|a3<=0.25|a4S|anS|ra|a1ftn|
a2Nitrofurantoin|a3<=16|a4S|anS|ra|a1sxt|a2Trimethoprim/
Sulfamethoxazole|a3<=20|a4S|anS|zz|

161150-809 - A 5-2 BCI - VITEK® 2


Service Manual - VITEK 2 Systems - BCI Connectivity Service Manual - REF 161150-809_A - MAR 3284
AI Message (Upload) System Installation and Configuration

• AST GP Card with AST Offline Test (Beta lactamase)

mtrsl|iiV2|is185634909990|itSU|pi123456789|pnDoe,
Jane|pl8west|p28west|ppDr. Smith|p5Dr. Smith|pccom1
|ptcom1|si|s067|sssrc1|s5src1|s111/17/2015|s201:03|s311/
17/2015|s401:03|sccom2|sncom2|ci1002|c067|ctUrine|
cnUrine|ta|rtAST-GP66|rr162684|t4F|t5Final|t11|o1staaur
|o2Staphylococcus aureus|afGLYCOPEPTIDES|apWILD|
afRIFAMYCINES|apRESISTANT (LOW LEVEL)|apWILD|
afQUINOLONES|apWILD|afTETRACYCLINES|apTARGET
MODIFICATION (TET M)|apPARTIALLY RESISTANT (EFFLUX TET
K)|afBETA-LACTAMS|apMODIFICATION OF PBP (mecA)|afFURANES
|apWILD|afOXAZOLIDINONE|apWILD|afAMINOGLYCOSIDES|
apRESISTANT KAN TOB (ANT(4')(4"))|apWILD|apRESISTANT KAN
(APH(3')-III)|afTRIMETHOPRIM/SULFONAMIDES|apTRIMETHOPRIM
RESISTANT|apWILD|afMACROLIDES/LINCOSAMIDES/
STREPTOGRAMINS|apRESISTANT (EFFLUX)|apMLSB INDUCIBLE|ra|
a1Bla|a2Beta-Lactamase|a3Pos|a4+|an+|ra|a1oxsf|
a2Cefoxitin Screen|a3Pos|a4+|an+|ra|a1peng|a2Benzylpeni-
cillin|a30.25|a4R|anR|ra|a1ox|a2Oxacillin|a31|a4R|anS
|ra|a1gm|a2Gentamicin|a3<=0.5|a4S|anS|ra|a1cip|
a2Ciprofloxacin|a3<=0.5|a4S|anS|ra|a1lev|a2Levofloxacin|
a30.5|a4S|anS|ra|a1mxf|a2Moxifloxacin|a3<=0.25|a4S|anS
|ra|a1e|a2Erythromycin|a3>=8|a4R|anR|ra|a1cc|
a2Clindamycin|a3<=0.25|a4R|anS|ra|a1qda|a2Quinupristin/
Dalfopristin|a30.5|a4S|anS|ra|a1lnz|a2Linezolid|a32|a4S
|anS|ra|a1vas|a2VRSA Screen|a3Neg|a4-|an-|ra|a1va|
a2Vancomycin|a3<=1|a4S|anS|ra|a1tet|a2Tetracycline|
a3>=16|a4R|anR|ra|a1ftn|a2Nitrofurantoin|a3<=16|a4S
|anS|ra|a1rif|a2Rifampicin|a3<=0.5|a4S|anS|ra|a1sxt
|a2Trimethoprim/Sulfamethoxazole|a3<=10|a4S|anS|zz|

161150-809 - A 5-3 BCI - VITEK® 2


Service Manual - VITEK 2 Systems - BCI Connectivity Service Manual - REF 161150-809_A - MAR 3284
AI Message (Upload) System Installation and Configuration

• AST Card with Infection Sites (breakpoint categories)


The specificity of this type of message is displayed in blue in the image below.

mtrsl|iiV2|is185634909990|itSU|pi123456789|pnDoe,
Jane|pl8west|p28west|ppDr. Smith|p5Dr. Smith|
pccom1|ptcom1|si|s080|ssExpectorated|s5Expectorated
|s111/13/2016|s311/13/2016|ci502|c080|ctSputum|cnSputum
|ta|rtAST-ST01|rr178753|t4F|t5Final|t11|o1strpne|
o2Streptococcus pneumoniae|afQUINOLONES|apWILD|afTETRA-
CYCLINES|apWILD|afBETA-LACTAMS|apWILD|afOXAZOLIDI-
NONE|apWILD|afTRIMETHOPRIM/SULFONAMIDES|apWILD|
apRESISTANT|afMACROLIDES/LINCOSAMIDES/STREPTOGRAM-
INS|apRESISTANT (MLSB)|ra|a1peng04|a2Benzylpenicillin
(pneumonia)|a3<=0.06|a4S|anS|ra|a1peng05|
a2Benzylpenicillin (oral)|a3<=0.06|a4S|anS|ra|a1peng02|
a2Benzylpenicillin (meningitis)|a3<=0.06|a4S|anS|ra|
a1peng03|a2Benzylpenicillin (other)|a3<=0.06|a4|an|ra
|a1tax02|a2Cefotaxime (meningitis)|a3<=0.12|a4S|anS|ra
|a1tax03|a2Cefotaxime(other)|a3<=0.12|a4S|anS|ra|a1ctr02
|a2Ceftriaxone (meningitis)|a3<=0.12|a4S|anS|ra|a1ctr03
|a2Ceftriaxone (other)|a3<=0.12|a4S|anS|ra|a1lev|
a2Levofloxacin|a3<=0.25|a4S|anS|ra|a1e|a2Erythromycin|
a3>=8|a4R|anR|ra|a1cc|a2Clindamycin|a3>=1|a4R|anR|ra
|a1lnz|a2Linezolid|a3<=2|a4S|anS|ra|a1tet|a2Tetracycline
|a3<=0.25|a4S|anS|ra|a1sxt|a2Trimethoprim/
Sulfamethoxazole|a320|a4I|anI|zz|

161150-809 - A 5-4 BCI - VITEK® 2


Service Manual - VITEK 2 Systems - BCI Connectivity Service Manual - REF 161150-809_A - MAR 3284
AI Message (Upload) System Installation and Configuration

• Preliminary AST
The specificity of this type of message is displayed in blue in the image below.

mtrsl|iiV2|is123456789099|itSU|pi123456789|pnDoe, Jane|
pl8west|p28west|ppDr. Smith|p5Dr. Smith|pccom1|ptcom1|si
|s081|ssRight leg|s5Right leg|s111/13/2016|s311/13/
2016|ciPrelim|c081|ctWound|cnWound|ta|rtAST-GP55|
rr178890|t4P|t5Preliminary|ncimi|ndPossible
VISA phenotype. Confirm vancomycin MIC.|t11|o1staaur|
o2Staphylococcus aureus|afGLYCOPEPTIDES|apHETERO-
VISA|afQUINOLONES|apWILD|afTETRACYCLINES|apTARGET
MODIFICATION (TET M)|apPARTIALLY RESISTANT (EFFLUX TET
K)|afBETA-LACTAMS|apMODIFICATION OF PBP (mecA)|afFURANES
|apWILD|afAMINOGLYCOSIDES|apRESISTANT KAN TOB
(ANT(4')(4"))|apWILD|apRESISTANT KAN (APH(3')-
III)|afPHENICOLS|apWILD|ra|a1Bla|a2Beta-Lactamase|a3Pos
|a4+|an+|ra|a1peng|a2Benzylpenicillin|a3>=0.5|a4R|anR|
ra|a1ams|a2Ampicillin/Sulbactam|a3<=2|a4R|anS|ra|a1ox
|a2Oxacillin|a3>=4|a4R|anR|ra|a1gm|a2Gentamicin|a3<=0.5|
a4S|anS|ra|a1cip|a2Ciprofloxacin|a3<=0.5|a4S|anS|ra|
a1lev|a2Levofloxacin|a31|a4S|anS|ra|a1nor|a2Norfloxacin|
a34|a4S|anS|ra|a1ofx|a2Ofloxacin|a31|a4S|anS|ra|a1va|
a2Vancomycin|a32|a4S|anS|ra|a1tet|a2Tetracycline|a3>=16
|a4R|anR|ra|a1ftn|a2Nitrofurantoin|a332|a4S|anS|ra|a1c|
a2Chloramphenicol|a38|a4S|anS|zz|

161150-809 - A 5-5 BCI - VITEK® 2


Service Manual - VITEK 2 Systems - BCI Connectivity Service Manual - REF 161150-809_A - MAR 3284
AI Message (Upload) System Installation and Configuration

• AST GN with an Extension Panel


The specificity of this type of message is displayed in blue in the image below.

mtrsl|iiV2|is123456789099|itSU|pi3534345345335345|pnDoe,
John|si|s069|ssClean Catch|s5Clean Catch|s111/10/
2016|s208:00|s311/10/2016|s408:00|ci103|c069|ctUrine|
cnUrine|ta|rtAST-NSE7|rr174608|t4F|t5Final|t11|o1esccol|
o2Escherichia coli|ra|a1esbl|a2ESBL|a3Neg|a4-|an-
|ra|a1pip|a2Piperacillin|a3<=4|a4S|anS|ra|a1rox|
a2Cefuroxime|a3>=64|a4R|anR|ra|a1roxa|a2Cefuroxime
Axetil|a3>=64|a4R|anR|ra|a1cfm|a2Cefixime|a3>=4|a4R|anR
|ra|a1ctr|a2Ceftriaxone|a316|a4I|anI|ra|a1fep|a2Cefepime
|a3<=1|a4S|anS|ra|a1azm|a2Aztreonam|a32|a4S|anS|ra|
a1mem|a2Meropenem|a3<=0.25|a4S|anS|ra|a1lev|
a2Levofloxacin|a31|a4S|anS|ra|a1mxf|a2Moxifloxacin|a32
|a4S|anS|ra|a1mn|a2Minocycline|a38|a4I|anI|ra|a1tet
|a2Tetracycline|a3>=16|a4R|anR|ra|ar|a1tgc|a2Tigecycline
|a3>=8|a4R|anR|ra|a1c|a2Chloramphenicol|a3>=64|a4R|
anR|ra|a1tmp|a2Trimethoprim|a3>=16|a4R|anR|ra|a1am|
a2Ampicillin|a3>=32|a4R|anR|ra|a1amc|a2Amoxicillin/
Clavulanic Acid|a3>=32|a4R|anR|ra|a1tic|a2Ticarcillin|
a316|a4S|anS|ra|a1tzp|a2Piperacillin/Tazobactam|a3<=4
|a4S|anS|ra|a1cf|a2Cefalotin|a3>=64|a4R|anR|ra|a1fox
|a2Cefoxitin|a3>=64|a4R|anR|ra|a1tax|a2Cefotaxime|a38|
a4S|anS|ra|a1taz|a2Ceftazidime|a32|a4S|anS|ra|ar|a1etp
|a2Ertapenem|a3>=8|a4R|anR|ra|a1imi|a2Imipenem|a32|
a4S|anS|ra|a1an|a2Amikacin|a3<=2|a4S|anS|ra|a1gm|
a2Gentamicin|a3<=1|a4S|anS|ra|a1net|a2Netilmicin|a3<=1
|a4S|anS|ra|a1tob|a2Tobramycin|a3<=1|a4S|anS|ra|a1na
|a2Nalidixic Acid|a3>=32|a4R|anR|ra|a1cip|
a2Ciprofloxacin|a3<=0.25|a4S|anS|ra|a1nor|a2Norfloxa-
cin|a31|a4S|anS|ra|a1ofx|a2Ofloxacin|a31|a4S|anS|ra|
a1ftn|a2Nitrofurantoin|a3>=512|a4R|anR|ra|a1sxt|
a2Trimethoprim/Sulfamethoxazole|a3>=320|a4R|anR|zz|

161150-809 - A 5-6 BCI - VITEK® 2


Service Manual - VITEK 2 Systems - BCI Connectivity Service Manual - REF 161150-809_A - MAR 3284
AI Message (Upload) System Installation and Configuration

• AST GN with Deduced Antibiotics


The specificity of this type of message is displayed in blue in the image below.

mtrsl|iiV2|is185634909990|itSU|pi123456789|pnDoe, Jane|
pl8west|p28west|ppDr. Smith|p5Dr. Smith|pccom1|ptcom1|si
|s074|ssRight shoulder|s5Right shoulder|s111/13/2016|
s311/13/2016|ci602|c074|ctWound|cnWound|ta|rtAST-N017|
rr178454|t4F|t5Final|t11|o1esccol|o2Escherichia
coli|afQUINOLONES|apWILD|afBETA-LACTAMS|apWILD|afFURANES
|apWILD|afAMINOGLYCOSIDES|apWILD|afTRIMETHOPRIM/
SULFONAMIDES|apTRIMETHOPRIM RESISTANT|apWILD|ra|a1am|
a2Ampicillin|a3<=2|a4S|anS|ra|a1amc|a2Amoxicillin/
Clavulanic Acid|a3<=2|a4S|anS|ra|a1tic|a2Ticarcillin|
a3<=8|a4S|anS|ra|a1tzp|a2Piperacillin/Tazobactam|a3<=4
|a4S|anS|ra|a1cf|a2Cefalotin|a38|a4S|anS|ra|a1fox|
a2Cefoxitin|a3<=4|a4S|anS|ra|a1tax|a2Cefotaxime|a3<=1
|a4S|anS|ra|a1taz|a2Ceftazidime|a3<=1|a4S|anS|ra|a1imi
|a2Imipenem|a3<=1|a4S|anS|ra|a1an|a2Amikacin|a3<=2|a4S
|anS|ra|a1gm|a2Gentamicin|a3<=1|a4S|anS|ra|a1net
|a2Netilmicin|a3<=1|a4S|anS|ra|a1tob|a2Tobramycin|a3<=1
|a4S|anS|ra|a1na|a2Nalidixic
Acid|a3<=2|a4S|anS|ra|a1cip|a2Ciprofloxacin|a3<=0.25|
a4S|anS|ra|a1nor|a2Norfloxacin|a3<=0.5|a4S|anS|ra|a1ofx|
a2Ofloxacin|a3<=0.25|a4S|anS|ra|a1ftn|a2Nitrofurantoin|
a3<=16|a4S|anS|ra|a1sxt|a2Trimethoprim/
Sulfamethoxazole|a3<=20|a4S|anS|ra|ad|a1ctr|
a2Ceftriaxone|a3|a4S|an|zz|

161150-809 - A 5-7 BCI - VITEK® 2


Service Manual - VITEK 2 Systems - BCI Connectivity Service Manual - REF 161150-809_A - MAR 3284
AI Message (Upload) System Installation and Configuration

• AST GN with an FDA Coded Comment for a Product Limitation


The specificity of this type of message is displayed in blue in the image below.

mtrsl|iiV2|is185634909990|itSU|pi123456789|pnDoe, Jane|
pl8west|p28west|ppDr. Smith|p5Dr. Smith|pccom1|ptcom1
|si|s084|ssClean catch|s5Clean catch|s111/13/2016|s311/
13/2016|ci604|c084|ctUrine|cnUrine|ta|rtAST-
N017|rr179173|t4F|t5Final|ncBMX001|ndAMPICILLIN: Perform
an alternative method of testing prior to reporting of
results.|t11|o1entaer|o2Enterobacter aerogenes|
afQUINOLONES|apRESISTANT|afBETA-LACTAMS|apEXTENDED
SPECTRUM BETA-LACTAMASE|afFURANES|apWILD|
afAMINOGLYCOSIDES|apRESISTANT GEN TOB NET (AAC(3)-
II)|afTRIMETHOPRIM/SULFONAMIDES|apRESISTANT|ra|ae|a1am
|a2Ampicillin|a3>=32|a4R|anR|ra|a1amc|a2Amoxicillin/
Clavulanic Acid|a34|a4R|anS|ra|a1tic|a2Ticarcillin|
a3>=128|a4R|anR|ra|a1tzp|a2Piperacillin/Tazobactam|a3<=4
|a4S|anS|ra|a1cf|a2Cefalotin|a3>=64|a4R|anR|ra|a1fox
|a2Cefoxitin|a38|a4R|anS|ra|a1tax|a2Cefotaxime|a3>=64
|a4R|anR|ra|a1taz|a2Ceftazidime|a332|a4R|anR|ra|a1imi
|a2Imipenem|a3<=1|a4S|anS|ra|a1an|a2Amikacin|a34|a4S
|anS|ra|a1gm|a2Gentamicin|a3>=16|a4R|anR|ra|a1net|
a2Netilmicin|a3>=32|a4R|anR|ra|a1tob|a2Tobramycin|a3>=16
|a4R|anR|ra|a1na|a2Nalidixic
Acid|a3>=32|a4R|anR|ra|a1cip|a2Ciprofloxacin|a32|a4I|anI
|ra|a1nor|a2Norfloxacin|a32|a4S|anS|ra|a1ofx|a2Ofloxacin
|a34|a4I|anI|ra|a1ftn|a2Nitrofurantoin|a3<=16|a4S|anS|ra
|a1sxt|a2Trimethoprim/Sulfamethoxazole|a3>=320|a4R|anR
|zz|

161150-809 - A 5-8 BCI - VITEK® 2


Service Manual - VITEK 2 Systems - BCI Connectivity Service Manual - REF 161150-809_A - MAR 3284
AI Message (Upload) System Installation and Configuration

• AST GN with a Coded Comment


The specificity of this type of message is displayed in blue in the image below.

mtrsl|iiV2|is123456789099|itSU|pi123456789|pnDoe, Jane|
pl8west|p28west|ppDr. Smith|p5Dr. Smith|pccom1|ptcom1|si
|s085|ssKnee|s5Knee|s111/13/2016|s311/13/2016|ci901|c085
|ctWound|cnWound|ta|rtAST-GP55|rr179784|t4F|t5Final|
ncimi|ndPossible VISA phenotype. Confirm vancomycin
MIC.|t11|o1staaur|o2Staphylococcus aureus|
afGLYCOPEPTIDES|apHETERO-VISA|afRIFAMYCINES|apRESISTANT
(HIGH LEVEL)|afQUINOLONES|apWILD|afTETRACYCLINES|
apTARGET MODIFICATION (TET M)|apPARTIALLY RESISTANT
(EFFLUX TET K)|afBETA-LACTAMS|apMODIFICATION OF PBP
(mecA)|afFURANES|apWILD|afAMINOGLYCOSIDES|apRESISTANT
KAN TOB (ANT(4')(4"))|apWILD|apRESISTANT KAN (APH(3')-
III)|afPHENICOLS|apWILD|afMACROLIDES/LINCOSAMIDES/
STREPTOGRAMINS|apMLSB CONSTITUTIVE|ra|a1Bla|
a2Beta-Lactamase|a3Pos|a4+|an+|ra|a1peng|
a2Benzylpenicillin|a3>=0.5|a4R|anR|ra|a1ams|
a2Ampicillin/Sulbactam|a3<=2|a4R|anS|ra|a1ox|a2Oxacillin
|a3>=4|a4R|anR|ra|a1gm|a2Gentamicin|a3<=0.5|a4S|anS|ra|
a1cip|a2Ciprofloxacin|a3<=0.5|a4S|anS|ra|a1lev|
a2Levofloxacin|a31|a4S|anS|ra|a1nor|a2Norfloxacin|a34
|a4S|anS|ra|a1ofx|a2Ofloxacin|a31|a4S|anS|ra|a1e|
a2Erythromycin|a34|a4I|anI|ra|a1cc|a2Clindamycin|a3>=8
|a4R|anR|ra|a1va|a2Vancomycin|a32|a4S|anS|ra|a1tet
|a2Tetracycline|a3>=16|a4R|anR|ra|a1ftn|
a2Nitrofurantoin|a332|a4S|anS|ra|a1c|a2Chloramphenicol
|a38|a4S|anS|ra|a1rif|a2Rifampicin|a38|a4R|anR|zz|

161150-809 - A 5-9 BCI - VITEK® 2


Service Manual - VITEK 2 Systems - BCI Connectivity Service Manual - REF 161150-809_A - MAR 3284
AI Message (Upload) System Installation and Configuration

• AST GN with EUCAST Interpretations (IE and (-))


The specificity of this type of message is displayed in blue in the image below.

mtrsl|iiV2|is185634909990|itSU|pi3534345345335345|pnDoe,
John|si|s087|ssClean Catch|s5Clean Catch|s111/14/2016|
s215:00|s311/14/2016|s415:00|ci603|c087|ctUrine|cnUrine|
ta|rtAST-N017|rr179890|t4F|t5Final|r111/13/2016|r213:50
|r311/14/2016|r405:48|ts|tuAST-N017|tp1393995001127894|
tg139399500|te11/21/2017|th11/13/2016|tk13:50|td11/14/
2016|tm05:48|tqLaboratory Superviso|trLaboratory
Supervisor|t11|o1acicba|o2Acinetobacter calcoaceticus|
mn0.50|mx0.63|acConsistent|afQUINOLONES|apWILD|afBETA-
LACTAMS|apWILD (CEPHALOSPORINASE)|afFURANES|apWILD|
afAMINOGLYCOSIDES|apRESISTANT (GEN NET AMI)|
afTRIMETHOPRIM/SULFONAMIDES|apRESISTANT|ra|a1am|
a2Ampicillin|a3(-)|a4(-)|an(-)|ra|a1amc|a2Amoxicillin/
Clavulanic Acid|a3(-)|a4(-)|an(-)|ra|a1tic|a2Ticarcillin
|a332|a4IE|anIE|ra|a1tcc|a2Ticarcillin/Clavulanic
Acid|a332|a4IE|anIE|ra|a1tzp|a2Piperacillin/Tazobactam|
a38|a4IE|anIE|ra|a1fox|a2Cefoxitin|a3(-)|a4(-)|an(-)
|ra|a1tax|a2Cefotaxime|a3(-)|a4(-)|an(-)|ra|a1taz|
a2Ceftazidime|a3(-)|a4(-)|an(-)|ra|a1an|a2Amikacin|a316
|a4SDD|anSDD|ra|a1gm|a2Gentamicin|a34|a4S|anS|ra|a1net
|a2Netilmicin|a316|a4R|anR|ra|a1tob|a2Tobramycin|a3<=1
|a4S|anS|ra|a1cip|a2Ciprofloxacin|a3<=0.25|a4S|anS|ra|
a1nor|a2Norfloxacin|a3(-)|a4(-)|an(-)|ra|a1ofx|
a2Ofloxacin|a3(-)|a4(-)|an(-)|ra|a1ftn|a2Nitrofurantoin
|a3(-)|a4(-)|an(-)|ra|a1sxt|a2Trimethoprim/
Sulfamethoxazole|a3160|a4R|anR|zz|

161150-809 - A 5-10 BCI - VITEK® 2


Service Manual - VITEK 2 Systems - BCI Connectivity Service Manual - REF 161150-809_A - MAR 3284
AI Message (Upload) System Installation and Configuration

• AST GN with a Suppressed Antibiotic


The specificity of this type of message is displayed in blue in the image below.

mtrsl|iiV2|is123456789099|itSU|pi3534345345335345|pnDoe,
John|si|s089|ssSputum|s5Sputum|s111/15/2016|s208:00|
s311/15/2016|s408:00|ci104|c089|ctResp|cnResp|ta|rtAST-
GN09|rr181471|t4F|t5Final|t12|o1klpnsp|o2Klebsiella
pneumoniae|afQUINOLONES|apRESISTANT|afBETA-LACTAMS|
apCARBAPENEMASE (+ OR - ESBL)|apIMPERMEABILITY CARBA
(+ESBL OR +HL AmpC)|afFURANES|apRESISTANT|afAMINOGLYCO-
SIDES|apRESISTANT TOB NET AMI (AAC(6'))|afTRIMETHOPRIM/
SULFONAMIDES|apRESISTANT|ra|a1am|a2Ampicillin|a3>=32
|a4R|anR|ra|a1ams|a2Ampicillin/Sulbactam|a3>=32|a4R|anR
|ra|a1pip|a2Piperacillin|a3>=128|a4R|anR|ra|a1tzp|
a2Piperacillin/Tazobactam|a3>=128|a4R|anR|ra|a1cz|
a2Cefazolin|a3>=64|a4R|anR|ra|a1rox|a2Cefuroxime|a3>=64
|a4R|anR|ra|a1roxa|a2Cefuroxime Axetil|a3>=64|a4R|anR
|ra|a1cte|a2Cefotetan|a3>=64|a4R|anR|ra|a1taz|
a2Ceftazidime|a3>=64|a4R|anR|ra|a1ctr|a2Ceftriaxone|
a3>=64|a4R|anR|ra|a1fep|a2Cefepime|a3>=64|a4R|anR|ra|at|
a1azm|a2Aztreonam|a3<=1|a4R|anS|ra|a1imi|a2Imipenem|
a3>=16|a4R|anR|ra|a1mem|a2Meropenem|a3>=16|a4R|anR|ra|ar
|a1an|a2Amikacin|a332|a4I|anI|ra|ar|a1gm|a2Gentamicin|
a3<=1|a4S|anS|ra|a1tob|a2Tobramycin|a3>=16|a4R|anR|ra
|a1cip|a2Ciprofloxacin|a3>=4|a4R|anR|ra|a1lev|
a2Levofloxacin|a3>=8|a4R|anR|ra|a1ftn|a2Nitrofurantoin|
a3>=512|a4R|anR|ra|a1sxt|a2Trimethoprim/Sulfamethoxazole
|a3>=320|a4R|anR|zz|

161150-809 - A 5-11 BCI - VITEK® 2


Service Manual - VITEK 2 Systems - BCI Connectivity Service Manual - REF 161150-809_A - MAR 3284
AI Message (Upload) System Installation and Configuration

• AST GN with a Suppressed MIC


The specificity of this type of message is displayed in blue in the image below.

mtrsl|iiV2|is123456789099|itSU|pi3534345345335345|pnDoe,
John|si|s089|ssSputum|s5Sputum|s111/15/2016|s208:00
|s311/15/2016|s408:00|ci104|c089|ctResp|cnResp|ta|rtAST-
GN09|rr181471|t4F|t5Final|t12|o1klpnsp|o2Klebsiella
pneumoniae|afQUINOLONES|apRESISTANT|afBETA-LACTAMS|
apCARBAPENEMASE (+ OR - ESBL)|apIMPERMEABILITY CARBA
(+ESBL OR +HL AmpC)|afFURANES|apRESISTANT|
afAMINOGLYCOSIDES|apRESISTANT TOB NET AMI (AAC(6'))|
afTRIMETHOPRIM/SULFONAMIDES|apRESISTANT|ra|a1am|
a2Ampicillin|a3>=32|a4R|anR|ra|a1ams|a2Ampicillin/
Sulbactam|a3>=32|a4R|anR|ra|a1pip|a2Piperacillin|a3>=128
|a4R|anR|ra|a1tzp|a2Piperacillin/Tazobactam|a3>=128|a4R|
anR|ra|a1cz|a2Cefazolin|a3>=64|a4R|anR|ra|a1rox|
a2Cefuroxime|a3>=64|a4R|anR|ra|a1roxa|a2Cefuroxime
Axetil|a3>=64|a4R|anR|ra|a1cte|a2Cefotetan|a3>=64|a4R
|anR|ra|a1taz|a2Ceftazidime|a3>=64|a4R|anR|ra|a1ctr
|a2Ceftriaxone|a3>=64|a4R|anR|ra|a1fep|a2Cefepime|a3>=64
|a4R|anR|ra|at|a1azm|a2Aztreonam|a3<=1|a4R|anS|ra|a1imi|
a2Imipenem|a3>=16|a4R|anR|ra|a1mem|a2Meropenem|a3>=16|
a4R|anR|ra|ar|a1an|a2Amikacin|a332|a4I|anI|ra|ar|a1gm|
a2Gentamicin|a3<=1|a4S|anS|ra|a1tob|a2Tobramycin|a3>=16|
a4R|anR|ra|a1cip|a2Ciprofloxacin|a3>=4|a4R|anR|ra|a1lev|
a2Levofloxacin|a3>=8|a4R|anR|ra|a1ftn|a2Nitrofurantoin|
a3>=512|a4R|anR|ra|a1sxt|a2Trimethoprim/Sulfamethoxazole
|a3>=320|a4R|anR|zz|

161150-809 - A 5-12 BCI - VITEK® 2


Service Manual - VITEK 2 Systems - BCI Connectivity Service Manual - REF 161150-809_A - MAR 3284
AI Message (Upload) System Installation and Configuration

• AST GN with Non-default Fields Enabled

mtrsl|iiV2|is185634909990|itSU|pi3534345345335345|pnDoe,
John|si|s054|s111/13/2016|s218:00|s311/13/2016|s418:00|
ci203|c054|ctblood|cnblood|ta|rtAST-GN04|rr170658|t4F
|t5Final|r110/03/2016|r209:37|r310/03/2016|r415:33|ts|
tuAST-GN04|tp1013693401218376|tg101369340|te01/23/2017
|th10/03/2016|tk09:37|td10/03/2016|tm15:33|tqLaboratory
Superviso|trLaboratory Supervisor|t11|o1esccol|
o2Escherichia coli|o4mod6|o53+|mc0.59|mn0.50|mx0.63|
acConsistent|afQUINOLONES|apWILD|afBETA-LACTAMS|apWILD|
afFURANES|apWILD|afAMINOGLYCOSIDES|apWILD|afTRIMETHOPRIM
/SULFONAMIDES|apTRIMETHOPRIM RESISTANT|apWILD|ra|a1am
|a2Ampicillin|a34|a4S|anS|ra|a1ams|a2Ampicillin/
Sulbactam|a34|a4S|anS|ra|a1pip|a2Piperacillin|a3<=4|a4S
|anS|ra|a1tzp|a2Piperacillin/Tazobactam|a3<=4|a4S|anS|ra
|a1cz|a2Cefazolin|a3<=4|a4S|anS|ra|a1rox|a2Cefuroxime|
a34|a4S|anS|ra|a1roxa|a2Cefuroxime
Axetil|a34|a4S|anS|ra|a1cte|a2Cefotetan|a3<=4|a4S|anS
|ra|a1taz|a2Ceftazidime|a3<=1|a4S|anS|ra|a1ctr|
a2Ceftriaxone|a3<=1|a4S|anS|ra|a1fep|a2Cefepime|a3<=1
|a4S|anS|ra|a1azm|a2Aztreonam|a3<=1|a4S|anS|ra|a1imi
|a2Imipenem|a3<=1|a4S|anS|ra|a1an|a2Amikacin|a3<=2|a4S|
anS|ra|a1gm|a2Gentamicin|a3<=1|a4S|anS|ra|a1tob|
a2Tobramycin|a3<=1|a4S|anS|ra|a1cip|a2Ciprofloxacin|
a3<=0.25|a4S|anS|ra|a1lev|a2Levofloxacin|a3<=0.25|a4S|
anS|ra|a1ftn|a2Nitrofurantoin|a3<=16|a4S|anS|ra|a1sxt
|a2Trimethoprim/Sulfamethoxazole|a3<=20|a4S|anS|zz|

161150-809 - A 5-13 BCI - VITEK® 2


Service Manual - VITEK 2 Systems - BCI Connectivity Service Manual - REF 161150-809_A - MAR 3284
6 FTP-XML Message Format and Protocol

Description

FTP-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 6-2.

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.

ISO-8859-1 and UTF-8 type of character encoding should be used by default.

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 (&lt; &gt;&amp;&apos;&quot;) to replace the illegal
XML characters
• The references to Unicode entities ("&#nnn;")

161150-809 - A 6-1 BCI - VITEK® 2


Service Manual - VITEK 2 Systems - BCI Connectivity Service Manual - REF 161150-809_A - MAR 3284
Introduction to XML Schema System Installation and Configuration

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.

VITEK® 2 System XML Schema


The VITEK® 2 System XML schema can be found in the Vitek2.xsd file attached to this
document. To access this XSD file:

1. Click on the left side of the screen.


2. Double-click on the XSD file to open it or right-click to save it.

161150-809 - A 6-2 BCI - VITEK® 2


Service Manual - VITEK 2 Systems - BCI Connectivity Service Manual - REF 161150-809_A - MAR 3284
Naming Rules System Installation and Configuration

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.


By default, it is VITEK2 but it can be changed in BCI Config within VITEK® 2 Systems.

• 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-809 - A 6-3 BCI - VITEK® 2


Service Manual - VITEK 2 Systems - BCI Connectivity Service Manual - REF 161150-809_A - MAR 3284
Test Dispatching Mode for VITEK® 2 Systems System Installation and Configuration

Test Dispatching Mode for VITEK® 2 Systems

VITEK® 2 Systems supports one type of test dispatching.

In BCI Link General Configuration, set the dispatching mode to Legacy BCI RS232
Dispatching.

Transport of FTP-XML 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-809 - A 6-4 BCI - VITEK® 2


Service Manual - VITEK 2 Systems - BCI Connectivity Service Manual - REF 161150-809_A - MAR 3284
Managing FTP Sessions System Installation and Configuration

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.

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-809 - A 6-5 BCI - VITEK® 2


Service Manual - VITEK 2 Systems - BCI Connectivity Service Manual - REF 161150-809_A - MAR 3284
Managing FTP Sessions System Installation and Configuration

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 6-7) and to have a "permanent" session for downloading results (see section
about Managing Results (BCI to LIS) on page 6-10).

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-809 - A 6-6 BCI - VITEK® 2


Service Manual - VITEK 2 Systems - BCI Connectivity Service Manual - REF 161150-809_A - MAR 3284
Managing Analysis Requests (LIS to BCI) System Installation and Configuration

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-809 - A 6-7 BCI - VITEK® 2


Service Manual - VITEK 2 Systems - BCI Connectivity Service Manual - REF 161150-809_A - MAR 3284
Managing Analysis Requests (LIS to BCI) System Installation and Configuration

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

Connecting to the < FTP server>


< 220 Service ready for new user
USER <user name>
< 331 User name okay, need password
PASS <user password>
< 230 User logged in, proceed
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

Example 2:

The FTP command sequence below enables the following actions to occur in succession:

• Establish an FTP session in passive mode


• Send an analysis request, following the BCI rules for naming files, with the complete path
• Shut down the session
Connecting to the < FTP server>
< 220 Service ready for new user
USER <user name>
< 331 User name okay, need password
PASS <user password>
< 230 User logged in, proceed
TYPE I
< 200 Command okay
> PASV
< 227 Entering Passive Mode (h1,h2,h3,h4,p1,p2)
STOR /download/labo_030909_153020_0.xml
< 150 Opening data connection - transfer mode: Binary mode
< 226 Transfer complete
QUIT
< 221 Service closing control connection

161150-809 - A 6-8 BCI - VITEK® 2


Service Manual - VITEK 2 Systems - BCI Connectivity Service Manual - REF 161150-809_A - MAR 3284
Managing Analysis Requests (LIS to BCI) System Installation and Configuration

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 6-17.

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-809 - A 6-9 BCI - VITEK® 2


Service Manual - VITEK 2 Systems - BCI Connectivity Service Manual - REF 161150-809_A - MAR 3284
Managing Results (BCI to LIS) System Installation and Configuration

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-809 - A 6-10 BCI - VITEK® 2


Service Manual - VITEK 2 Systems - BCI Connectivity Service Manual - REF 161150-809_A - MAR 3284
Managing Results (BCI to LIS) System Installation and Configuration

Examples of how the "RETR" 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


• Download a result, following the BCI rules for naming files
• Shut down the session
Connecting to < FTP server>
< 220 Service ready for new user
USER <user name>
< 331 User name okay, need password
PASS <user password>
< 230 User logged in, proceed
CWD /upload
< 250 Requested file action okay, completed
TYPE I
< 200 Command okay
PORT h1,h2,h3,h4,p1,p2
< 200 Command okay
RETR system1_030909_153020_0.xml
< 150 Opening data connection - transfer mode: Binary mode
< 226 Transfer complete
QUIT
< 221 Service closing control connection
Example 2:

The FTP command sequence below enables the following actions to occur in succession:

• Establish an FTP session in passive mode


• Upload a result, following the BCI rules for naming files, with the complete path
• Shut down the session
Connecting to < FTP server>
< 220 Service ready for new user
USER <user name>
< 331 User name okay, need password
PASS <user password>
< 230 User logged in, proceed
TYPE I
< 200 Command okay
PASV
< 227 Entering Passive Mode (h1,h2,h3,h4,p1,p2)
RETR /upload/system1_030909_153020_0.xml
< 150 Opening data connection - transfer mode: Binary mode
< 226 Transfer complete
QUIT
< 221 Service closing control connection

161150-809 - A 6-11 BCI - VITEK® 2


Service Manual - VITEK 2 Systems - BCI Connectivity Service Manual - REF 161150-809_A - MAR 3284
Managing Results (BCI to LIS) System Installation and Configuration

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 6-17.

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-809 - A 6-12 BCI - VITEK® 2


Service Manual - VITEK 2 Systems - BCI Connectivity Service Manual - REF 161150-809_A - MAR 3284
FTP Commands supported by the Server System Installation and Configuration

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-809 - A 6-13 BCI - VITEK® 2


Service Manual - VITEK 2 Systems - BCI Connectivity Service Manual - REF 161150-809_A - MAR 3284
FTP Commands supported by the Server System Installation and Configuration

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:
PORT h1,h2,h3,h4,p1,p2
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-809 - A 6-14 BCI - VITEK® 2


Service Manual - VITEK 2 Systems - BCI Connectivity Service Manual - REF 161150-809_A - MAR 3284
FTP Commands supported by the Server System Installation and Configuration

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-809 - A 6-15 BCI - VITEK® 2


Service Manual - VITEK 2 Systems - BCI Connectivity Service Manual - REF 161150-809_A - MAR 3284
FTP Return Codes System Installation and Configuration

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-809 - A 6-16 BCI - VITEK® 2


Service Manual - VITEK 2 Systems - BCI Connectivity Service Manual - REF 161150-809_A - MAR 3284
Conventions to Follow in Writing Pseudocode System Installation and Configuration

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-809 - A 6-17 BCI - VITEK® 2


Service Manual - VITEK 2 Systems - BCI Connectivity Service Manual - REF 161150-809_A - MAR 3284
7 FTP-XML Message Structure and Data Types

LIS Message

This message is sent by the LIS to the VITEK® 2 System and contains one or several analysis
request(s) to be performed.

AI Message

This message is sent by the VITEK® 2 System to the LIS to report one or more result(s).

Formatting Rules

Messages exchanged in both directions are formatted according to well defined formatting
rules.

IMPORTANT: The decimal separator should always be “.” (dot), whatever the locale is.

For more details on message format, see the Data Types section below.

Data Types

Data fields sent by the LIS and not defined in the table below will not be processed by the
VITEK® 2 System.

Note: The VITEK® 2 System will not be adversely impacted by the receipt of fields not defined in the
table below. Unspecified fields are simply ignored.

For ALL fields, the “|” character is not allowed, if “|” is sent, the system will drop the message and Alarm.
1
= Truncation only applies to download fields.

BCI Net VITEK


BCI Net XML
Message Field
Message Max Truncated1 Notes
Type Length

HEADER INFORMATION
header/senderName lisMessage 16 RIGHT Upload: VITEK® sends Analysis System name.
aiMessage
Download: Not used by VITEK®.
header/processingIdentifier lisMessage 2 RIGHT Upload: VITEK® hard-coded to send “P”
aiMessage (Production).

Download: Not used by VITEK®.


header/version lisMessage 20 RIGHT Upload: VITEK® hard-coded to send “1394-97”
aiMessage (ASTM Version).

Download: Not used by VITEK®.


header/dateTime lisMessage 14 RIGHT Upload: VITEK® hard-coded to send current day
aiMessage timestamp.

Download: Not used by VITEK®.

161150-809 - A 7-1 BCI - VITEK® 2


Service Manual - VITEK 2 Systems - BCI Connectivity Service Manual - REF 161150-809_A - MAR 3284
Data Types FTP-XML Message Structure and Data Types

BCI Net VITEK


BCI Net XML
Message Field
Message Max Truncated1 Notes
Type Length

header/instrumentName aiMessage 2 N/A VITEK® hard-coded to send “V2”.


header/serialNumber aiMessage 12 N/A VITEK® Instrument Serial Number is a 12 digit
HEX number.
PATIENT INFORMATION
lisMessage/request
aiMessage/requestHeader
patientInformation/ lisMessage 16 RIGHT See Download Notes: 1,2
patientIdentifier aiMessage See Upload Notes: 1
patientInformation/lastName lisMessage 40 RIGHT See Download Notes: 1,2,3
aiMessage
See Upload Notes: 1
patientInformation/comment/ lisMessage 6 RIGHT Upload: Data is dynamically generated by
code aiMessage truncating the first 6 characters of the comment
text.

See Download Notes: 1

See Upload Notes: 1


patientInformation/comment/ aiMessage 800 N/A See Upload Notes: 1
text
patientInformation/comment/ aiMessage 1 N/A Upload: If Patient Comment exists, VITEK® hard-
source coded to always send “P”.

See Upload Notes: 1


patientInformation/comment/ aiMessage 1 N/A Upload: If Patient Comment exists, VITEK® hard-
type coded to always send “G”.

See Upload Notes: 1


patientInformation/ lisMessage 16 RIGHT See Download Notes: 1,3
patientVisitNumber aiMessage
See Upload Notes: 1
patientInformation/ lisMessage 15 RIGHT Upload: Data is dynamically generated by
physicianIdentifier aiMessage truncating the first 15 characters of the Physician
name.

See Download Notes: 1

See Upload Notes: 1


patientInformation/ aiMessage 40 N/A See Upload Notes: 1
physicianName
patientInformation/location lisMessage 40 RIGHT Upload: Data is dynamically generated by
aiMessage truncating the first 6 characters of the Location
name.

See Download Notes: 1

See Upload Notes: 1

161150-809 - A 7-2 BCI - VITEK® 2


Service Manual - VITEK 2 Systems - BCI Connectivity Service Manual - REF 161150-809_A - MAR 3284
Data Types FTP-XML Message Structure and Data Types

BCI Net VITEK


BCI Net XML
Message Field
Message Max Truncated1 Notes
Type Length

patientInformation/ aiMessage 40 N/A See Upload Notes: 1


locationText
TEST ORDER INFORMATION
lisMessage/request/testOrder
aiMessage/requestHeader/testOrder
isolateNumber lisMessage 2 LEFT Attribute for accession number (accession
aiMessage number = LabId + IsolateNumber). Used to
identify an isolate.

Upload: Always sent with isolate result data.

Download: Required if sending Organism and/or


Offline Test Information.
isolateRelativeIdentifier aiMessage 8 N/A This attribute can be used to resolve isolates with
the same accession number.
SPECIMEN INFORMATION
specimen/specimenIdentifier lisMessage 20 LEFT Specimen ID is truncated at 20 characters, then
aiMessage leading zeros are removed.

See Download Notes: 1,5

See Upload Notes: 2


specimen/ aiMessage 8 N/A This attribute can be used to resolve isolates with
specimenRelativeIdentifier the same accessionNumber.
specimen/collectedDateTime lisMessage 14 RIGHT Optional, if sending must meet formatting
aiMessage requirements.

See Download Notes: 1,6

See Upload Notes: 2


specimen/specimenType lisMessage 40 RIGHT Upload: Data is dynamically generated by
aiMessage truncating the first 15 characters of the Specimen
Type Text.

See Download Notes: 1,7

See Upload Notes: 2


specimen/specimenTypeText aiMessage 40 N/A See Upload Notes: 2

specimen/specimenSource lisMessage 15 RIGHT Upload: Data is dynamically generated by


aiMessage truncating the first 15 characters of the Specimen
Source Text.

See Download Notes: 1

See Upload Notes: 2


specimen/ aiMessage 26 N/A See Upload Notes: 2
specimenSourceText

161150-809 - A 7-3 BCI - VITEK® 2


Service Manual - VITEK 2 Systems - BCI Connectivity Service Manual - REF 161150-809_A - MAR 3284
Data Types FTP-XML Message Structure and Data Types

BCI Net VITEK


BCI Net XML
Message Field
Message Max Truncated1 Notes
Type Length

specimen/comment/code lisMessage 6 RIGHT Upload: Data is dynamically generated by


aiMessage truncating the first 6 characters of the comment
text.

See Download Notes: 1

See Upload Notes: 2


specimen/comment/text aiMessage 800 N/A See Upload Notes: 2

specimen/comment/source aiMessage 1 N/A Upload: If Specimen Comment exists, VITEK®


hard-coded to always send “P”.

See Upload Notes: 2


specimen/comment/type aiMessage 1 N/A Upload: If Specimen Comment exists, VITEK®
hard-coded to always send “G”.

See Upload Notes: 2


TEST RESULT INFORMATION
test/universalIdentifier/ aiMessage 15 N/A VITEK® Code for Susceptibility (AST) Tests or
testIdentifier Identification Tests.

Upload: VITEK® hard-coded to always send


“AST” or “ID”.
test/universalIdentifier/ aiMessage 8 N/A This is the name of the VITEK® Card for the
testName displayed results.
• For ID cards it can be GN (Gram Negative) or
GP (Gram Positive).
• For AST cards it will be the card name
(AST-N017, AST-GN04, etc.).
• For a SuperFlex card, the Superflex card name
is used (AST-NSE3 for example).
test/result/resultStatus aiMessage 1 N/A Isolate Status Code - F or P

test/result/resultStatusText aiMessage 16 N/A Isolate Status Text - Final or Preliminary


(Language Translated)
test/result/startDateTime aiMessage 14 N/A Isolate Creation timestamp

test/result/resultDateTime aiMessage 14 N/A Isolate Final Call timestamp

test/result/userComment/ aiMessage 6 N/A User custom and/or VITEK® 2 System


comment/code predefined code and comment. User custom
test/result/userComment/ aiMessage 800 N/A code and comment are managed in the VITEK®
comment/text 2 System Advanced Reporting Tool Configuration
Coded Comment Management.
test/result/userComment/ aiMessage 1 N/A Upload: If test result comment exists, VITEK®
comment/source hard-coded to always send “P”.
test/result/userComment/ aiMessage 1 N/A Upload: If test result comment exists, VITEK®
comment/type hard-coded to always send “G”.
test/result/bmxResultData/ aiMessage 20 N/A Hard-coded values of VITEK-AST-CARD and
disposable/disposableType VITEK-ID-CARD are used.

161150-809 - A 7-4 BCI - VITEK® 2


Service Manual - VITEK 2 Systems - BCI Connectivity Service Manual - REF 161150-809_A - MAR 3284
Data Types FTP-XML Message Structure and Data Types

BCI Net VITEK


BCI Net XML
Message Field
Message Max Truncated1 Notes
Type Length

test/result/bmxResultData/ aiMessage 8 N/A VITEK Card Name.


disposable/reference
test/result/bmxResultData/ aiMessage 18 N/A VITEK Card Barcode.
disposable/
disposableIdentifier
test/result/bmxResultData/ aiMessage 40 N/A VITEK Card Lot Number (will not be greater than
disposable/lotNumber length 10 at this time)
test/result/bmxResultData/ aiMessage 8 N/A VITEK Card expiration date.
disposable/expirationDate
test/result/bmxResultData/ aiMessage 14 N/A VITEK Card first reading timestamp.
disposable/
disposableStartDateTime
test/result/bmxResultData/ aiMessage 14 N/A VITEK Card final reading timestamp.
disposable/
disposableFinalDateTime
test/result/bmxResultData/ aiMessage 20 N/A Data is dynamically generated by truncating the
disposable/ first 20 characters of the operator lastName.
disposableSetupTechnologis
tName
test/result/bmxResultData/ aiMessage 30 N/A Name of the laboratory personnel that prepared
disposable/ the VITEK Card.
disposableSetupTechnologis
tText
VITEK TEST RESULT INFORMATION
.../test/result/value
identification/ aiMessage 255 N/A ID Confidence Value (Language Translated)
identificationConfidence
identification/bioNumber aiMessage 16 N/A Unique number assigned by Knowledge Base for
an organism.
identification/probability aiMessage 8 N/A Percent Probability that the organism was
correctly identified.
identification/ aiMessage 15 N/A BCI host code for the organism.
significantTaxon/code
identification/ aiMessage 60 N/A Organism Name.
significantTaxon/name
identification/ aiMessage 6 N/A mod1-mod12 match common bioMérieux shared
significantTaxonModifier/ KB values.
code
identification/ aiMessage 20 N/A
significantTaxonModifier/text
mcfarland/mcFarlandValue aiMessage 5 N/A User entered McFarland value for this isolate.

mcfarland/ aiMessage 5 N/A Minimum acceptable McFarland value for this


mcFarlandRangeMin class of card (GN has a range, YST has another
range, etc.).
If the McFarland value is below the minimum
value range, the customer may want to review
the result.

161150-809 - A 7-5 BCI - VITEK® 2


Service Manual - VITEK 2 Systems - BCI Connectivity Service Manual - REF 161150-809_A - MAR 3284
Data Types FTP-XML Message Structure and Data Types

BCI Net VITEK


BCI Net XML
Message Field
Message Max Truncated1 Notes
Type Length

mcfarland/ aiMessage 5 N/A Maximum acceptable McFarland value for this


mcFarlandRangeMax class of card (GN has a range, YST has another
range, etc.).
If the McFarland value is above the maximum
value range, the customer may want to review
the result.
ast/antibiotic/ aiMessage 5 N/A Flag indicating when a Drug (or Test) is
suppressedDrug suppressed from Reporting.
ast/antibiotic/deducedDrug aiMessage 5 N/A Flag indicating when a Drug result is a deduced
value (not physically present on the VITEK ID
card).
ast/antibiotic/ aiMessage 5 N/A Flag indicating the Drug is a disabled-with-
disabledWithCommentDrug comment (disabled product limitation) drug.
ast/antibiotic/code aiMessage 15 N/A BCI host code for the antibiotic.

ast/antibiotic/name aiMessage 60 N/A Antibiotic name (Language Translated)

ast/antibiotic/highMic/ aiMessage 8 N/A MIC Range Symbol (Greater Than, Less Than,
micSign etc.).
ast/antibiotic/highMic/ aiMessage 8 N/A MIC Value
micValue
ast/antibiotic/highMic/ aiMessage 5 N/A Flag indicating when a Drug’s MIC value is
suppressedMic suppressed (Blanked out).
ast/antibiotic/category aiMessage 10 N/A Final Antibiotic Interpretation from AES
(S - Susceptible, R - Resistance,
I - Indeterminate, IE - Insufficient Evidence for
Interpretation, (-) - Treatment not effective
against tested organism).
ast/antibiotic/ aiMessage 10 N/A Preliminary Antibiotic Interpretation from AST
nonExpertCatergory Engine (S - Susceptible, R - Resistance,
I - Indeterminate, IE - Insufficient Evidence for
Interpretation, (-) - Treatment not effective
against tested organism).
expertFinding/ aiMessage 12 N/A AES Confidence Value code, AES Category Call
code.
expertFinding/ aiMessage 40 N/A Drug Family Name (Language Translated)
resistanceMechanism/
drugFamily
expertFinding/ aiMessage 800 N/A Resistance mechanism phenotype name
resistanceMechanism/ (Language Translated)
phenotype
OFFLINE TEST INFORMATION
test/universalIdentifier/ lisMessage 15 RIGHT BCI host code for the OfflineTest.
testIdentifier
Beta-Lactamase (Bla) is the only OfflineTest
supported in VITEK 5.01.

Unrecognized OfflineTest codes will be marked


invalid by VITEK.

161150-809 - A 7-6 BCI - VITEK® 2


Service Manual - VITEK 2 Systems - BCI Connectivity Service Manual - REF 161150-809_A - MAR 3284
Data Types FTP-XML Message Structure and Data Types

BCI Net VITEK


BCI Net XML
Message Field
Message Max Truncated1 Notes
Type Length

test/universalIdentifier/ lisMessage 60 RIGHT OfflineTest Name (VITEK 5.01 only supports


testName Beta-Lactamase).
test/result/value/ lisMessage 15 RIGHT Unrecognized OfflineTest codes will be marked
identification/ invalid by VITEK.
significantTaxon/code
test/result/value/ lisMessage 60 RIGHT Organism name.
identification/
significantTaxon/name
test/result/value/offlineTest/ lisMessage 15 RIGHT BCI host code for the OfflineTest Result.
resultCode
Unrecognized OfflineTest Result codes will be
marked invalid by VITEK.

FTP Download Notes (LisMessage - LIS to VITEK® 2 Systems)

1. Patient and Specimen messages are validated and processed even if VITEK® is operating
in Demoless mode (Patient Demographics disabled).
2. The PatientIdentifier becomes a required field if additional Patient fields exist in the
download message or if a valid Specimen exists in the download message.
3. If the download record is missing the Patient first name and last name, but contains the
Patient Identifier; the VITEK® application will create Patient Name field containing “<>”.
4. The Alternate Patient Id is NOT required, but must be unique against all other Alternate
Patient Ids.
5. The SpecimenIdentifier (LabID) a required field for all download message types.
6. If the download record is missing the Specimen collectionDateTime, but contains the
Specimen Identifier; the VITEK® application will create a Specimen Collection Date and
Specimen Collection Time using the date and time of the download event.
7. If the download record is missng the Specimen Type, but contains the Specimen Identifier;
the VITEK® application will create a Specimen Type field containing “<>”.

FTP Upload Notes (AIMessage - VITEK® 2 Systems to LIS)

1. If VITEK® is operating in Demoless mode (Patient Demographics disabled), Patient


information will NOT be present in the upload message.
2. If VITEK® is operating in Demoless mode (Patient Demographics disabled), Specimen
information (except for SpecimenId, and IsolateNumber), will NOT be present in any
Upload Result message

161150-809 - A 7-7 BCI - VITEK® 2


Service Manual - VITEK 2 Systems - BCI Connectivity Service Manual - REF 161150-809_A - MAR 3284
8 FTP-XML Message Examples

You will find examples of request and result messages in the XML files attached to this
document.

To access these XML files:

1. Click on the left side of the screen.


2. Double-click on the fileyou want to open or right-click to save it.

LIS Messages (Download)

Refer to the following files for examples of messages sent by the LIS to the VITEK® 2 System:

• Patient specimen organism and AST offline test


Download_patient_specimen_organism.xml

• Patient and specimen only


Download_patient_only.xml

• Organism and offline test only


Download_org_and_offline_test_only.xml

AI Messages (Upload)

Refer to the following files for examples of messages sent by the VITEK® 2 System to the LIS:

• ID card only
ID_GN_only.xml

• AST GN
AST_GN_only.xml

• AST GP with AST offline test


AST_GP_only.xml

161150-809 - A 8-1 BCI - VITEK® 2


Service Manual - VITEK 2 Systems - BCI Connectivity Service Manual - REF 161150-809_A - MAR 3284
AI Messages (Upload) FTP-XML Message Examples

• Preliminary AST (GP)


Preliminary_(AST_GP).xml

The specificity of this type of message is displayed in blue in the image below.

161150-809 - A 8-2 BCI - VITEK® 2


Service Manual - VITEK 2 Systems - BCI Connectivity Service Manual - REF 161150-809_A - MAR 3284
AI Messages (Upload) FTP-XML Message Examples

• AST GP with multiple breakpoint categories (infection sites)


AST_ GP_with_infection_sites_(breakpoint_category).xml

The specificity of this type of message is displayed in blue in the image below.

161150-809 - A 8-3 BCI - VITEK® 2


Service Manual - VITEK 2 Systems - BCI Connectivity Service Manual - REF 161150-809_A - MAR 3284
AI Messages (Upload) FTP-XML Message Examples

• AST GN with external panel mate (multiple AST cards)


AST_GN_with_extension_panel_mates_(multiple_AST_cards).xml

The specificity of this type of message is displayed in blue in the image below.

161150-809 - A 8-4 BCI - VITEK® 2


Service Manual - VITEK 2 Systems - BCI Connectivity Service Manual - REF 161150-809_A - MAR 3284
AI Messages (Upload) FTP-XML Message Examples

• AST GN suppressed antiobiotic


AST_GN_with_suppressed_drug.xml

The specificity of this type of message is displayed in blue in the image below.

161150-809 - A 8-5 BCI - VITEK® 2


Service Manual - VITEK 2 Systems - BCI Connectivity Service Manual - REF 161150-809_A - MAR 3284
AI Messages (Upload) FTP-XML Message Examples

• AST GN suppressed MIC


AST_GN_with_suppressed_drug.xml

The specificity of this type of message is displayed in blue in the image below.

161150-809 - A 8-6 BCI - VITEK® 2


Service Manual - VITEK 2 Systems - BCI Connectivity Service Manual - REF 161150-809_A - MAR 3284
AI Messages (Upload) FTP-XML Message Examples

• AST GN deduced antibiotic


AST_GN_deduced_antibiotic.xml

AST_GN_deduced_antibiotic_2.xml

The specificity of this type of message is displayed in blue in the image below.

161150-809 - A 8-7 BCI - VITEK® 2


Service Manual - VITEK 2 Systems - BCI Connectivity Service Manual - REF 161150-809_A - MAR 3284
AI Messages (Upload) FTP-XML Message Examples

• AST GN product limitation (bioART disable with comment)


AST_ GN_ bioART_ product_ limitation_ (disable_ with_ comment).xml

The specificity of this type of message is displayed in blue in the image below.

161150-809 - A 8-8 BCI - VITEK® 2


Service Manual - VITEK 2 Systems - BCI Connectivity Service Manual - REF 161150-809_A - MAR 3284
AI Messages (Upload) FTP-XML Message Examples

• AST GN bioART coded comment


AST_GN_coded_comment.xml

The specificity of this type of message is displayed in blue in the image below.

• AST GN EUCAST special interpretations (IE and (-))


AST_GN_EUCAST_interpretations.xml

The specificity of this type of message is displayed in blue in the image below.

161150-809 - A 8-9 BCI - VITEK® 2


Service Manual - VITEK 2 Systems - BCI Connectivity Service Manual - REF 161150-809_A - MAR 3284
BCI Simulators

Service Manual - VITEK 2 Systems - BCI Connectivity Service Manual - REF 161150-809_A - MAR 3284
9 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-809 - A 9-1 BCI - VITEK® 2


Service Manual - VITEK 2 Systems - BCI Connectivity Service Manual - REF 161150-809_A - MAR 3284
10 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 10-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-809 - A 10-1 BCI - VITEK® 2


Service Manual - VITEK 2 Systems - BCI Connectivity Service Manual - REF 161150-809_A - MAR 3284
Installing the BCI Simulator Installation Procedure

Figure 10-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 10-3: BCI Simulator Setup completed

7. Click Finish to close the window.


Installation is now complete.

161150-809 - A 10-2 BCI - VITEK® 2


Service Manual - VITEK 2 Systems - BCI Connectivity Service Manual - REF 161150-809_A - MAR 3284
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-809 - A 10-3 BCI - VITEK® 2


Service Manual - VITEK 2 Systems - BCI Connectivity Service Manual - REF 161150-809_A - MAR 3284
11 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 VITEK® 2 System.
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-809 - A 11-1 BCI - VITEK® 2


Service Manual - VITEK 2 Systems - BCI Connectivity Service Manual - REF 161150-809_A - MAR 3284
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-809 - A 11-2 BCI - VITEK® 2


Service Manual - VITEK 2 Systems - BCI Connectivity Service Manual - REF 161150-809_A - MAR 3284
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 11-1: Opening BCI Simulators

2. Select the instrument and click OK.


The BCI Simulators interface is displayed.

161150-809 - A 11-3 BCI - VITEK® 2


Service Manual - VITEK 2 Systems - BCI Connectivity Service Manual - REF 161150-809_A - MAR 3284
User Interface Principle of Operation

Description of the Interface

4
3

5 6

Figure 11-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 VITEK® 2 System.
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-809 - A 11-4 BCI - VITEK® 2


Service Manual - VITEK 2 Systems - BCI Connectivity Service Manual - REF 161150-809_A - MAR 3284
User Interface Principle of Operation

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.

Note: Not used in the VITEK® 2 Range

This simulator has the following functionalities:


Management of "ASTM" messages: an editor is used to create,
save, edit and transmit analysis requests in an ASTM E1394
format.
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 protocol type and
the TCP/IP information.

161150-809 - A 11-5 BCI - VITEK® 2


Service Manual - VITEK 2 Systems - BCI Connectivity Service Manual - REF 161150-809_A - MAR 3284
User Interface Principle of Operation

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.
This simulator has the following functionalities:
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.
Management of "text" messages: an editor is used to create,
save, edit and transmit analysis requests in a free format called
“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.
This simulator has the following functionalities:
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.
Management of "text" messages: an editor is used to create,
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-809 - A 11-6 BCI - VITEK® 2


Service Manual - VITEK 2 Systems - BCI Connectivity Service Manual - REF 161150-809_A - MAR 3284
User Interface Principle of Operation

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-809 - A 11-7 BCI - VITEK® 2


Service Manual - VITEK 2 Systems - BCI Connectivity Service Manual - REF 161150-809_A - MAR 3284
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 11-3: BCI Simulators Directory

161150-809 - A 11-8 BCI - VITEK® 2


Service Manual - VITEK 2 Systems - BCI Connectivity Service Manual - REF 161150-809_A - MAR 3284
12 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 12-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-809 - A 12-1 BCI - VITEK® 2


Service Manual - VITEK 2 Systems - BCI Connectivity Service Manual - REF 161150-809_A - MAR 3284
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=> <RS>mtmpr|pi1232|pnza|psMale|si|ci234|rtHIV
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=> <RS>mtmpr|pi1232|pnza|psMale|si|ci12131|rtHIV
12:25:49=> <GS>7c
12:25:49<= <ACK>
12:25:49=> <ETX>
12:25:49=> <STX>
12:25:49=> <RS>mtmpr|pi1232|pnza|psMale|si|ci234|rtHIV
12:25:49=> <GS>1d
12:25:49<= <ACK>
12:25:49=> <ETX>
12:25:49=> <EOT>

161150-809 - A 12-2 BCI - VITEK® 2


Service Manual - VITEK 2 Systems - BCI Connectivity Service Manual - REF 161150-809_A - MAR 3284
Accessing the LIS Simulator and Setting Parameters LIS – RS232 SIMULATOR

• 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-809 - A 12-3 BCI - VITEK® 2


Service Manual - VITEK 2 Systems - BCI Connectivity Service Manual - REF 161150-809_A - MAR 3284
Accessing the LIS Simulator and Setting Parameters LIS – RS232 SIMULATOR

Starting/Stopping the RS232 Communication Server


The RS232 communication server is started as follows:

1. Click to access the Supervision screen.

Figure 12-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 12-1.

161150-809 - A 12-4 BCI - VITEK® 2


Service Manual - VITEK 2 Systems - BCI Connectivity Service Manual - REF 161150-809_A - MAR 3284
Accessing the LIS Simulator and Setting Parameters LIS – RS232 SIMULATOR

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 12-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 12-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-809 - A 12-5 BCI - VITEK® 2


Service Manual - VITEK 2 Systems - BCI Connectivity Service Manual - REF 161150-809_A - MAR 3284
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 12-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 12-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 12-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-809 - A 12-6 BCI - VITEK® 2


Service Manual - VITEK 2 Systems - BCI Connectivity Service Manual - REF 161150-809_A - MAR 3284
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 12-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 12-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-809 - A 12-7 BCI - VITEK® 2


Service Manual - VITEK 2 Systems - BCI Connectivity Service Manual - REF 161150-809_A - MAR 3284
Using the Manual Protocol LIS – RS232 SIMULATOR

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 12-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
tracking data window.

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-809 - A 12-8 BCI - VITEK® 2


Service Manual - VITEK 2 Systems - BCI Connectivity Service Manual - REF 161150-809_A - MAR 3284
Using the Manual Protocol LIS – RS232 SIMULATOR

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-809 - A 12-9 BCI - VITEK® 2


Service Manual - VITEK 2 Systems - BCI Connectivity Service Manual - REF 161150-809_A - MAR 3284
Using the Manual Protocol LIS – RS232 SIMULATOR

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: task6, receive: ACK, goto: task5
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: task11, receive: ACK, goto: task9

name: task12, send: ETX


name: task13, send: EOT

161150-809 - A 12-10 BCI - VITEK® 2


Service Manual - VITEK 2 Systems - BCI Connectivity Service Manual - REF 161150-809_A - MAR 3284
Using the Manual Protocol LIS – RS232 SIMULATOR

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
tracking data window.

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-809 - A 12-11 BCI - VITEK® 2


Service Manual - VITEK 2 Systems - BCI Connectivity Service Manual - REF 161150-809_A - MAR 3284
Using the Manual Protocol LIS – RS232 SIMULATOR

• 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-809 - A 12-12 BCI - VITEK® 2


Service Manual - VITEK 2 Systems - BCI Connectivity Service Manual - REF 161150-809_A - MAR 3284
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 12-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-809 - A 12-13 BCI - VITEK® 2


Service Manual - VITEK 2 Systems - BCI Connectivity Service Manual - REF 161150-809_A - MAR 3284
Managing Analysis Requests in the "bioMérieux" Format LIS – RS232 SIMULATOR

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 12-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-809 - A 12-14 BCI - VITEK® 2


Service Manual - VITEK 2 Systems - BCI Connectivity Service Manual - REF 161150-809_A - MAR 3284
Managing Analysis Requests in the "bioMérieux" Format LIS – RS232 SIMULATOR

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 12-17
for more details about the configuration of the editor).

Using the following editor:

Figure 12-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 12-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-809 - A 12-15 BCI - VITEK® 2


Service Manual - VITEK 2 Systems - BCI Connectivity Service Manual - REF 161150-809_A - MAR 3284
Managing Analysis Requests in the "bioMérieux" Format LIS – RS232 SIMULATOR

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 12-6 for more detailed information
about communication.

161150-809 - A 12-16 BCI - VITEK® 2


Service Manual - VITEK 2 Systems - BCI Connectivity Service Manual - REF 161150-809_A - MAR 3284
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-809 - A 12-17 BCI - VITEK® 2


Service Manual - VITEK 2 Systems - BCI Connectivity Service Manual - REF 161150-809_A - MAR 3284
Setting Parameters for the "bioMérieux" Test Order Editor LIS – RS232 SIMULATOR

• Separator: there are record separators such as the sample separator for VITEK® 2 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-809 - A 12-18 BCI - VITEK® 2


Service Manual - VITEK 2 Systems - BCI Connectivity Service Manual - REF 161150-809_A - MAR 3284
Setting Parameters for the "bioMérieux" Test Order Editor LIS – RS232 SIMULATOR

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 12-10: Test Order dialog box

161150-809 - A 12-19 BCI - VITEK® 2


Service Manual - VITEK 2 Systems - BCI Connectivity Service Manual - REF 161150-809_A - MAR 3284
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.

Presentation of the Editor


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).

Step 1: Create an Analysis Request


There are two possibilities for creating an analysis request:

· 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"
default directory, which is the storage directory for existing
messages.

Step 2: Complete the Analysis Request


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

Step 3: Save the Analysis Request


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

Step 4: Send an Analysis Request


This step is identical to sending messages in the bioMérieux format as described in Step 4:
Send an Analysis Request on page 12-16.

161150-809 - A 12-20 BCI - VITEK® 2


Service Manual - VITEK 2 Systems - BCI Connectivity Service Manual - REF 161150-809_A - MAR 3284
13 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 11-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-809 - A 13-1 BCI - VITEK® 2


Service Manual - VITEK 2 Systems - BCI Connectivity Service Manual - REF 161150-809_A - MAR 3284
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 13-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-809 - A 13-2 BCI - VITEK® 2


Service Manual - VITEK 2 Systems - BCI Connectivity Service Manual - REF 161150-809_A - MAR 3284
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.

Presentation of the Editor

1
2

Figure 13-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-809 - A 13-3 BCI - VITEK® 2


Service Manual - VITEK 2 Systems - BCI Connectivity Service Manual - REF 161150-809_A - MAR 3284
Managing Analysis Requests in "ASTM-XML" Format LIS – FTP Simulator

Step 1: Create an Analysis Request


There are two possibilities for creating an analysis request:

Create · Creates a new analysis request.


This enables you to create an analysis request using a template
(refer to the Defining Parameters for the Simulator Text
Editors section on page 11-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"
default directory, which is the storage directory for existing
messages.

Step 2: Complete the Analysis Request


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 13-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-809 - A 13-4 BCI - VITEK® 2


Service Manual - VITEK 2 Systems - BCI Connectivity Service Manual - REF 161150-809_A - MAR 3284
Managing Analysis Requests in "ASTM-XML" Format LIS – FTP Simulator

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-809 - A 13-5 BCI - VITEK® 2


Service Manual - VITEK 2 Systems - BCI Connectivity Service Manual - REF 161150-809_A - MAR 3284
Managing Analysis Requests in "ASTM-XML" Format LIS – FTP Simulator

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-809 - A 13-6 BCI - VITEK® 2


Service Manual - VITEK 2 Systems - BCI Connectivity Service Manual - REF 161150-809_A - MAR 3284
Managing Analysis Requests in "ASTM-XML" Format LIS – FTP Simulator

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-809 - A 13-7 BCI - VITEK® 2


Service Manual - VITEK 2 Systems - BCI Connectivity Service Manual - REF 161150-809_A - MAR 3284
Managing Analysis Requests in "ASTM-XML" Format LIS – FTP Simulator

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-809 - A 13-8 BCI - VITEK® 2


Service Manual - VITEK 2 Systems - BCI Connectivity Service Manual - REF 161150-809_A - MAR 3284
Managing Analysis Requests in "ASTM-XML" Format LIS – FTP Simulator

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.

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.


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 ".

Step 4: Send an Analysis Request


· 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 13-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-809 - A 13-9 BCI - VITEK® 2


Service Manual - VITEK 2 Systems - BCI Connectivity Service Manual - REF 161150-809_A - MAR 3284
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.

Presentation of the Editor


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).

Step 1: Create an Analysis Request


There are two possibilities for creating an analysis request:

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"
default directory, which is the storage directory for existing
messages.

Step 2: Complete the Analysis Request


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

Step 3: Save the Analysis Request


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

Step 4: Send an Analysis Request


This step is identical to sending messages in ASTM-XML format as described in Step 4: Send
an Analysis Request on page 13-9.

161150-809 - A 13-10 BCI - VITEK® 2


Service Manual - VITEK 2 Systems - BCI Connectivity Service Manual - REF 161150-809_A - MAR 3284
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 13-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-809 - A 13-11 BCI - VITEK® 2


Service Manual - VITEK 2 Systems - BCI Connectivity Service Manual - REF 161150-809_A - MAR 3284
Receiving Results LIS – FTP Simulator

Downloading a Result
The results are displayed in the BCI results area.

Figure 13-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-809 - A 13-12 BCI - VITEK® 2


Service Manual - VITEK 2 Systems - BCI Connectivity Service Manual - REF 161150-809_A - MAR 3284
Receiving Results LIS – FTP Simulator

When downloading is completed, the lists are updated as follows:

1
2

Figure 13-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-809 - A 13-13 BCI - VITEK® 2


Service Manual - VITEK 2 Systems - BCI Connectivity Service Manual - REF 161150-809_A - MAR 3284
14 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-809 - A 14-1 BCI - VITEK® 2


Service Manual - VITEK 2 Systems - BCI Connectivity Service Manual - REF 161150-809_A - MAR 3284
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-809 - A 14-2 BCI - VITEK® 2


Service Manual - VITEK 2 Systems - BCI Connectivity Service Manual - REF 161150-809_A - MAR 3284
Parameter Setting and Connections AI Simulator

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 14-1: AI Opening Session

To close a session:

1. Select a connected AI.

2. Click to close the session.

161150-809 - A 14-3 BCI - VITEK® 2


Service Manual - VITEK 2 Systems - BCI Connectivity Service Manual - REF 161150-809_A - MAR 3284
Parameter Setting and Connections AI Simulator

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 14-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-809 - A 14-4 BCI - VITEK® 2


Service Manual - VITEK 2 Systems - BCI Connectivity Service Manual - REF 161150-809_A - MAR 3284
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 14-3: Changing Configuration of a modified AI

Note: Select Failure in one case only: to simulate a connection error.

161150-809 - A 14-5 BCI - VITEK® 2


Service Manual - VITEK 2 Systems - BCI Connectivity Service Manual - REF 161150-809_A - MAR 3284
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.

Presentation of the Editor


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 14-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-809 - A 14-6 BCI - VITEK® 2


Service Manual - VITEK 2 Systems - BCI Connectivity Service Manual - REF 161150-809_A - MAR 3284
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 the Defining Parameters for the
Simulator Text Editors section on page 11-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 13-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 13-9.

The file name to be used is described in section about Receiving Analysis Requests sent by
BCI on page 14-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-809 - A 14-7 BCI - VITEK® 2


Service Manual - VITEK 2 Systems - BCI Connectivity Service Manual - REF 161150-809_A - MAR 3284
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.

Presentation of the Editor


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 13-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.

Step 1: Create a Result Message


This step is identical to what is described in Step 1: Create an Analysis Request on page 13-
10.

Step 2: Complete or Modify the Message with New Results


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

Step 3: Save the Message


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

Step 4: Send the Message


This step is identical to what is described in Step 4: Send an Analysis Request on page 13-10.

161150-809 - A 14-8 BCI - VITEK® 2


Service Manual - VITEK 2 Systems - BCI Connectivity Service Manual - REF 161150-809_A - MAR 3284
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.

Presentation of the Editor


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 14-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-809 - A 14-9 BCI - VITEK® 2


Service Manual - VITEK 2 Systems - BCI Connectivity Service Manual - REF 161150-809_A - MAR 3284
Managing Results in "bioMérieux" Format AI Simulator

Step 1: Create a Result Message


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 13-4).

Step 3: Save the Message


This step is identical to saving an analysis request (refer to Step 3: Save the Analysis
Request on page 13-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".

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-809 - A 14-10 BCI - VITEK® 2


Service Manual - VITEK 2 Systems - BCI Connectivity Service Manual - REF 161150-809_A - MAR 3284
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 12-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-809 - A 14-11 BCI - VITEK® 2


Service Manual - VITEK 2 Systems - BCI Connectivity Service Manual - REF 161150-809_A - MAR 3284
Appendices

Service Manual - VITEK 2 Systems - BCI Connectivity Service Manual - REF 161150-809_A - MAR 3284
A 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-809 - A A-1 BCI - VITEK® 2


Service Manual - VITEK 2 Systems - BCI Connectivity Service Manual - REF 161150-809_A - MAR 3284
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 Management tool

A data management tool is a software that will only receive information from MYLA® in order
to compute statistics and reports.

It must be able to receive results and can optionally receive request (forwarded by MYLA®).

Data representation

Type of description used to structure messages for data transfer between analysis instruments
and the laboratory information systems.

161150-809 - A A-2 BCI - VITEK® 2


Service Manual - VITEK 2 Systems - BCI Connectivity Service Manual - REF 161150-809_A - MAR 3284
Appendix - Glossary

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.

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.

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 MYLA® and will expect to
receive results from MYLA®

MYLA®

Product name of the microbiology middleware solution.

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.

161150-809 - A A-3 BCI - VITEK® 2


Service Manual - VITEK 2 Systems - BCI Connectivity Service Manual - REF 161150-809_A - MAR 3284
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.

161150-809 - A A-4 BCI - VITEK® 2


Service Manual - VITEK 2 Systems - BCI Connectivity Service Manual - REF 161150-809_A - MAR 3284
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.

161150-809 - A A-5 BCI - VITEK® 2


Service Manual - VITEK 2 Systems - BCI Connectivity Service Manual - REF 161150-809_A - MAR 3284
Revision History

This section contains a summary of changes made to each released revision of this document starting with
part number 161150-809 - 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.
• Not all versions may be available in all languages.

Release Date Part Number Change Type Change Summary

2016-12 161150-809 - A N/A First publication

Service Manual - VITEK 2 Systems - BCI Connectivity Service Manual - REF 161150-809_A - MAR 3284
Service Manual - VITEK 2 Systems - BCI Connectivity Service Manual - REF 161150-809_A - MAR 3284

S-ar putea să vă placă și