Service Manual - Vidas Range - BCI Connectivity for LIS - 161150-486 - B - MAR 3408 PDF

Preview

Summary

bioMérieux SA 376 Chemin de l’Orme 69280 Marcy-l’Etoile - France Tel: 33 (0)4 78 87 20 00 Fax: 33 (0)4 78 87 20 90 biomerieux161150-486 - B - en - 2017-01 – P/N 161150-ENVIDAS® Range - BCI Connectivity Service ManualLIS Interface Driver Development GuideIntellectual PropertyBIOMERIEUX, the blue logo...

Description

VIDAS® Range - BCI Connectivity Service Manual

LIS Interface Driver Development Guide

161150-486 - B - en - 2017-01 – P/N 161150-827

EN

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

Intellectual Property BIOMERIEUX, the blue logo, BCI Link and VIDAS are used, pending and/or registered trademarks belonging to bioMérieux, or one of its subsidiaries, or one of its companies. Any other name or trademark is the property of its respective owner. © 2017 bioMérieux SA bioMérieux SA 673 620 399 RCS Lyon

Table of Contents Introduction Introduction to the System ........................................................................................ 1-1 Intended Use and Users. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-1 Warnings and Safety Messages. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-2 Statement Types . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-2 General Statements . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-3

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

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

RS232 System Specificities ....................................................................................... 4-1 Transport Process . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-1 Physical Link . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-1 Message Structure . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-2 Formatting Rules . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .4-3 161150-486 - B

i

BCI - VIDAS® Range

Table of Contents

Data Types . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .4-4 CMVA Parameter Specific Description. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-8 Differences due to the CMVA Parameter Update . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-8

RS232 miniVIDAS® System Specificities.................................................................. 5-1 Hardware Specificities . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-1 Communication Port . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-1 Cable . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-1 Message Structure . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-1 Formatting Rules . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .5-2 Data Types . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .5-3

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

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

ii

BCI - VIDAS® Range

Table of Contents

Conventions to Follow in Writing Pseudocode . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-18 Introduction to XML Schema . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-19 Declaration of Types . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-19 Occurrence Constraints . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-19 VIDAS® PC XML Schema . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-20 VIDAS® 3 XML Schema . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-27

ASTM-XML System Specificities ............................................................................... 8-1 Message Structure . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8-1 Data Types . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .8-2 CMVA Parameter Specific Description. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8-10 Differences due to the CMVA Parameter Update . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8-10

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

Error and Duplication Management ........................................................................ 10-1 Error Management in VIDAS® 3. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10-1 Error Management in VIDAS® PC . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10-2 Duplication Management . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10-2

BCI Simulators Introduction to the BCI Simulators ......................................................................... 11-1 Purpose . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .11-1 Content of the Master . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11-1

Installation Procedure .............................................................................................. 12-1 General Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12-1 Installing the BCI Simulator . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12-1 Uninstalling the BCI Simulator . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12-3 Preliminary Steps . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12-3 Uninstalling BCI Simulators . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12-3

161150-486 - B

iii

BCI - VIDAS® Range

Table of Contents

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

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

161150-486 - B

iv

BCI - VIDAS® Range

Table of Contents

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