Sie sind auf Seite 1von 248

MicroScan

LabPro software
Interface Implementation Guide
For use with LabPro software version 4.42 (and later)

9020-8006, Rev. B
Copyrights
No part of this work covered by the copyrights herein may be reproduced or copied in any form or by any means
(graphic, electronic, or mechanical; including photocopying, recording, typing, or information storage and retrieval
systems) without the written permission of the publisher.

Limitations and conditions


Software screen illustrations within this manual are representational only and may not exactly match the software.
Software screen illustrations are intended to identify the location of software screen elements and components. The
actual image and screen content might not be translated into all native languages.
The information in this guide was correct at the time of printing. However, Beckman Coulter continues to improve
products and reserves the right to change specifications, equipment, and maintenance procedures at any time without
notice. Because variance cannot be precluded entirely, we cannot guarantee full consistency. The information in this
publication is reviewed regularly and necessary corrections are included in subsequent editions.
Beckman Coulter has validated the provided instructions, reagents, instrument, software and customizable features for
this system to optimize product performance and meet product specifications. User-defined modifications are not
supported by Beckman Coulter as they may affect performance of the system and test results. It is the responsibility of
the user to validate any modifications made to these instructions, instruments, reagents or software provided by
Beckman Coulter.
If the system is used in a manner differently than specified by Beckman Coulter the protection provided by the
equipment may be impaired. See the warning and hazard statements in this guide.

Trademarks
Beckman Coulter, the stylized logo and the Beckman Coulter product and service names mentioned herein are
trademarks or registered trademarks of Beckman Coulter, Inc. in the United States and other countries.

Windows is a registered trademark of Microsoft Corporation.

LOINC is a registered trademark of the Regenstrief Institute.


Surveillance Data Link Network™ (SDLN™) is a trademark of International Health Management
Associates, Inc.

06/2016
9020-8006, Rev. B

Made in USA
Beckman Coulter, Inc. Beckman Coulter Eurocenter S.A.
250 S. Kraemer Blvd. 22, rue Juste-Olivier
Brea, CA 92821 USA Case Postale 1044
www.beckmancoulter.com CH-1260 Nyon 1, Switzerland
TEL: +41 (0) 22 365 36 11
© 2016 Beckman Coulter, Inc. All rights reserved. Spec: 9900-3929

2 9020-8006, Rev. B
Revision history
This document applies to the listed MicroScan software version. When a subsequent software
version affects the information in this document, a new document will be released to the
Beckman Coulter website.

Current version

Document: P/N 9020-8006, Rev. B

Publishing date: 06/2016

Supported software (version): LabPro Software v4.42 (and later) multi-regional.

Available languages: English

Summary of changes: Revision B includes test group/panel identifier codes, dilutions, and
MicroScan drug test updates to support LabPro software v4.42 and
panel updates for multi-regional and CE-IVD users.
Note that obsolete panel types were deleted from the “Test Group/
panel prompts and codes” section.

9020-8006, Rev. B LabPro Interface Implementation Guide 3


Revision history

Previous revisions

Document: P/N 9020-8006, Rev. A

Publishing date: 03/2016

Supported software (version): LabPro Software v4.42 (and later) US-IVD region.

Available languages: English

Summary of changes: Includes document structure and template changes, as well as,
updated content to support an updated conventional gram-negative
identification matrix and Trace Record enhancements for LabPro
software v4.42 for US-IVD region users.

Document: P/N 9020-7608, Rev. B


Publishing date: 02/2015

Supported software (version): LabPro Software v4.40 and v4.41

Available languages: English

Summary of changes: Includes document re-branding and minor revisions to support


LabPro v4.40 and v4.41 software.

Future document updates


For documentation updates, go to www.beckmancoulter.com, and then select Support >
Technical Documents. On the Technical Documents & Software Downloads page, you can
search for documents and download the latest applicable version.

Search suggestion

Search by keyword: LabPro Interface

Document category: Instrument IFU/Manual

4 LabPro Interface Implementation Guide 9020-8006, Rev. B


Contents

1 Preface . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .15
About this guide . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 16
Version compatibility and use . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 16
Additional information . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 16
Customer Technical Support contact information . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17
About the LabPro Interface program . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17
System-to-system interface . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17
About configuring the LabPro Interface . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 18
About LabPro Interface updates . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 18

2 Specifications, requirements, and considerations . . . . . . . . . . . . . . .19


Serial cable requirements . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20
Pin Assignments . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20
About custom serial cables . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20
Cabling for an LIS connection . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20
Serial ports on your computer . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21
Modem requirements . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22
About LabPro Interface configurable options . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 23
Programming considerations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 23
Key attributes for an ideal reciprocal interface . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24
Operation considerations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 25

3 Configuring the LabPro Interface . . . . . . . . . . . . . . . . . . . . . . . . . . . . .27


LabPro Interface configuration workflow . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 28
Device overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 30
Examples of device configurations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 30
About creating device configurations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 30
Three-layer protocol implementation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 31
LabPro Interface configuration windows and tools . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 31
About the Configure Communication Devices window . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 32

9020-8006, Rev. B LabPro Interface Implementation Guide 5


Contents

Device menu options . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 33


Toolbar options . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 33
About the Device Configuration dialog box . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 34
About adding a new device . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 35
Number of devices . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 35
Device names . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 35
Device guidelines . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 35
Device types . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 36
Adding a new device . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 37
Before adding a new device . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 37
Procedure . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 37
Editing the device configurations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 39
Before editing a device . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 39
Device configuration settings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 40
Procedure . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 41
Copying the device configurations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 42
About copying a device configuration to create a new device . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 42
Before copying a device . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 43
Procedure . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 43
Deleting a device . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 45
Before deleting a device . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 45
Procedure . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 45

4 Configuring the physical layer . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .47


About configuring the physical layer . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 48
Physical layer configuration options . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 48
Defining the physical layer for serial connection . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 48
Before configuring the physical layer for a serial connection . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 48
Procedure . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 49
Defining the physical layer for a modem connection . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 53
Procedure . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 53
Defining the physical layer for file transfer . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 57
Before you begin . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 57
Procedure . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 57
Defining the physical layer for an SDLN device . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 61
Procedure . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 61

6 LabPro Interface Implementation Guide 9020-8006, Rev. B


Contents

5 Configuring the data link layer . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .63


About the data link layer . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 64
Frames (LIS device type) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 65
Checksum type . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 65
Four types of checksum methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 66
Checksum calculations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 66
Conversions for each checksum method . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 67
Timeout delay . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 67
Line bidding and software flow control protocols . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 67
Protocol character definitions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 69
Using of prefix and suffix characters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 69
VA Vista configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 69
Defining the data link layer . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 70
Before defining the data link layer . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 70
Procedure . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 70

6 Configuring the message layer . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .73


Modifying data in the message layer . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 74
Before configuring data modifications . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 74
About the Data Modifications tab . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 75
About test processing features . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 76
Configuring test processing features . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 77
Specimen tagging . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 78
System-defined tags . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 79
User-defined tags . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 80
Using tags when searching for specimen in the database . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 80
Configuring specimen tagging . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 80
Device filter rules in the message layer . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 82
Key terms . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 82
Parameter list . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 83
Rules area . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 85
Conditions area . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 85
Defining a device filter rule . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 86
Before defining a filter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 86
Procedure . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 86
Data formatting criteria in the message layer . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 88
Site name . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 90
Messages and records . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 90

9020-8006, Rev. B LabPro Interface Implementation Guide 7


Contents

Delimiters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 91
Organism name format . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 92
Transmission Sort Order . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 92
Transmission of Interpretations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 93
Transmission of isolate results for combined test groups . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 94
Testing multiple test groups on one isolate . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 94
Transmission of combined test groups . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 94
Transmit with leading zeros . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 95
Date and time format . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 96
Defining data formatting criteria . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 96
Before selecting data formatting options . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 96
Procedure . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 97
Data suppressions in the message layer . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 101
When to suppress data . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 101
Data that is not transmitted with data suppression . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 102
Defining data suppressions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 103
Before configuring data suppressions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 103
Procedure . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 103
Cross-reference tables in the message layer . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 105
When to use cross-referencing . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 105
Cross-reference table rules . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 106
How cross referencing works . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 107
Send/Receive modes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 108
Data elements that can be cross-referenced . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 109
Data elements that cannot be cross referenced . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 109
Numeric only . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 110
Cross-Reference Tables area . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 110
Build area . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 110
Building cross-reference tables . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 111
Before building your cross-reference tables . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 111
Procedure . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 111
Deleting a cross-reference entry . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 114
Editing a cross-reference entry . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 114

7 Automatic communication features . . . . . . . . . . . . . . . . . . . . . . . . . .117


Auto-Transmit . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 118
About the Configure Automatic Transmit/Request window . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 119
Next send time . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 120

8 LabPro Interface Implementation Guide 9020-8006, Rev. B


Contents

Enabling and disabling Auto-Transmit . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 120


Selected times . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 120
Search type and criteria . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 120
Configuring Auto-Transmit . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 124
Before configuring Auto-Transmit . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 124
Procedure . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 124
Auto-Request . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 127
Next request time . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 127
Multiple device configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 127
Enabling and disabling Auto-Request . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 127
Selected times . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 127
Configuring Auto-Request . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 128
Before configuring Auto-Request . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 128
Procedure . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 128
Auto-Monitor . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 130
Multiple device configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 130
Enabling and disabling Auto-Monitor . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 130
Before enabling Auto-Monitor . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 130
Enabling Auto-Monitor . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 130
Disabling the Auto-Monitor . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 132

8 Device configuration detail report . . . . . . . . . . . . . . . . . . . . . . . . . . .133


Printing the Device Configuration Detail report . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 134
About the Device Configuration Detail report . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 134
Before printing the report . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 134
Viewing the report . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 134
Printing the report . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 135

9 Transmitting LabPro customization tables . . . . . . . . . . . . . . . . . . . .137


Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 138
Selecting custom data for transmit . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 138
SDLN data submission requirements . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 138
Transmitting custom data . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 139
Before transmitting custom data . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 139
Procedure . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 139
Stopping data transmission . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 141

9020-8006, Rev. B LabPro Interface Implementation Guide 9


Contents

Appendix A: Message layer - MicroScan record structure . . . . . . . . . .143


About the message layer - MicroScan record structure . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 145
MicroScan record and field rules . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 145
Record rules . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 145
Field rules . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 146
MicroScan record types and hierarchy . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 147
Hierarchical order . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 147
Transmission sort order . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 149
Block and sections definitions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 150
Sample record transmission flow . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 151
Sample remote request for download . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 151
Sample upload/download session . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 152
Sample upload session . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 153
Record format specifications . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 155
Header record (H) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 159
Header record attributes table . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 159
Header record field definitions table . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 160
Patient record (P) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 162
Patient record attributes table . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 162
Patient record field definitions table . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 164
Specimen record (B) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 166
Specimen record attributes table . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 166
Specimen record field definitions table . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 168
Isolate record (R) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 170
Transmitting multiple test groups/panels results to another healthcare computer . . . . . . . . . . . 171
Isolate record attributes table . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 172
Isolate record field definitions table . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 175
Test/MIC record (M) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 179
Test/MIC record attributes table . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 179
Test/MIC record field definitions table . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 181
Trace record (Q) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 184
Trace record attributes table . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 184
Trace record field definitions table . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 185
Comment record (C) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 186
Comment record attributes table . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 187
Comment record field definitions table . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 187
Free text record (F) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 188
Free text record attributes table . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 189

10 LabPro Interface Implementation Guide 9020-8006, Rev. B


Contents

Free text record field definitions table . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 189


Request record (A) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 190
Request record attributes table . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 190
Request record field definitions table . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 191
End record (L) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 192
End record attributes table . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 192
End record field definitions table . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 193
Transmitting customization records . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 194
Sample upload of customized tables . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 195
Customized institution record (K) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 196
Customized institution record attributes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 196
Customized institution record field definitions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 196
Customized ward record (W) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 197
Customized ward record attributes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 197
Customized ward record field definitions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 197
Customized service record (J) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 198
Customized service record attributes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 198
Customized service record field definitions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 198
Customized source record (X) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 199
Customized source record attributes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 199
Customized source record field definitions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 199
Customized physician record (Z) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 200
Customized physician record attributes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 200
Customized physician record field definition . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 200
Customized tech record (I) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 201
Customized tech record attributes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 201
Customized tech record field definitions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 201
Customized test record (D) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 202
Customized test record attributes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 202
Customized test record field definitions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 203
Customized organism record (O) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 204
Customized organism record attributes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 204
Customized organism record field definitions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 204
Customized patient comment record (G) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 205
Customized patient comment record attributes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 205
Customized patient comment record field definitions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 206
Customized specimen comment record (Y) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 207
Customized specimen comment record attributes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 207
Customized specimen comment record field definitions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 207

9020-8006, Rev. B LabPro Interface Implementation Guide 11


Contents

Customized isolate comment record (E) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 208


Customized isolate comment record attributes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 208
Customized isolate comment record field definitions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 209

Appendix B: Device type default values . . . . . . . . . . . . . . . . . . . . . . . . .211

Appendix C: Setup and installation tables . . . . . . . . . . . . . . . . . . . . . . .215


MicroScan record identifier codes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 216
ASCII character set values . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 217
Extended ASCII character set values . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 219
Checksum type . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 220
Protocol type . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 221
Gender . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 222
Patient status . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 222
Specimen status . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 222
Test results for beta lactamase, oxidase, indole or Thymidine-dependent strain . . . . . . . . . . . 223
Synergy screen results . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 223
ESBL results . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 223
Organism class/family . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 224
Organism set . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 224
Offline test interpretations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 224
Interpretations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 225
Comment/free text association . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 226
Error return codes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 226

Appendix D: Sample transmissions . . . . . . . . . . . . . . . . . . . . . . . . . . . . .227


Sample transmission block flow diagram . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 228
Sample transmission for an LIS device . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 228

Appendix E: Test group compatibility rules . . . . . . . . . . . . . . . . . . . . . .233

Appendix F: Tips for cross-referencing to LIS . . . . . . . . . . . . . . . . . . . .235

Appendix G: Test group/panel prompts and codes . . . . . . . . . . . . . . .237


Test group/panel prompts . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 237
Test group/panel identifier codes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 238

12 LabPro Interface Implementation Guide 9020-8006, Rev. B


Contents

Appendix H: MIC dilutions table . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .243

Appendix I: MicroScan pre-defined drug tests/extra test table . . . . .245


MicroScan drug tests . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 246

9020-8006, Rev. B LabPro Interface Implementation Guide 13


This page intentionally left blank

14 LabPro Interface Implementation Guide 9020-8006, Rev. B


1
Preface
This section includes these topics:

• About this guide (page 16)

• About the LabPro Interface program (page 17)

9020-8006, Rev. B LabPro Interface Implementation Guide 15


Preface

About this guide


This guide is intended for laboratory system administrators or information technology support
staff and Beckman Coulter Customer Technical Support technicians. Use the information in this
guide when configuring the LabPro Interface for a new system or software installation, or when
upgrading or modifying an existing system.

This guide includes information about the following LabPro Interface implementation topics:

• Hardware requirements.

• Descriptions of devices, and the physical, data link and message layers.

• A basic workflow and specific instructions for configuring devices and options for each layer.

• Transmitting LabPro customizations.

• Reference sections include reference information and tables you can use for configuring
devices and layers, as well as, setting up your specific healthcare system to work with LabPro
software. See the MicroScan Organism Reference Guide for a current list of organisms and
codes.

Version compatibility and use


This document supports LabPro software v4.42 (and later) (all regions)

Contact your Beckman Coulter representative for more information about specific version
availability in your region and any specific use restrictions or requirements.

Beckman Coulter MicroScan systems, LabPro software, and LabPro-MBT software are IVD
products and are intended for clinical use.

Additional information
This guide includes only information that applies to the configuration of the LabPro Interface.
See the following guides for additional, related information:

• LabPro Operator's Guide—provides information about MicroScan systems and LabPro


software functionality, safety, and system operation.

• LabPro Operator’s Guide v4.42 (and later) Addendum—provides new enhancements and
features included in the latest LabPro software.

• (LabPro-MBT users only) LabPro-MBT Software Operator’s Guide—provides information about


using LabPro-MBT software.

• MicroScan Organism Reference Guides—provide the current list of organisms and codes that
are available in this version of LabPro and LabPro-MBT software.

You should reference third-party documentation for specific procedures and details about
healthcare computer systems that you intend to connect to LabPro software using the LabPro
Interface program.

16 LabPro Interface Implementation Guide 9020-8006, Rev. B


Preface

Customer Technical Support contact information


If you are calling from the United States or Canada, call (800) 677-7226. If you are calling from
outside the United States or Canada, contact the Beckman Coulter Customer Technical Support
or your Beckman Coulter representative.

About the LabPro Interface program


The LabPro Interface program:

• Communicates via RS-232 serial port connections or file transfer protocol.

• Streamlines the laboratory process by providing efficient and accurate information sharing.
It eliminates duplicate data entry requirements for both LabPro and another healthcare
computer system.

• Transmits and receives patient, specimen, and isolate order information to/from the
laboratory system manually or automatically. Manual or automated requests for download of
test groups can be made to the laboratory system.

• Transmits datastream information in half-duplex ASCII text formatted records containing


variable length delimited fields.

• Provides line bidding (ENQ protocol) to prevent data collision.

• Provides record or character flow control via ACK/NAK, XON/XOFF, DTR/DSR and RTS/CTS
protocols.

• Includes full timeout and reset capabilities, if error conditions occur.

• Reports all LabPro Interface activity to the Interface Log. This log can be printed or viewed
on-screen.

• Supports record level checksum options for maximum data integrity. When used in
conjunction with ACK/NAK flow control protocol, the LabPro Interface program has the
capability for self-correcting.

System-to-system interface
The LabPro Interface program is independent of the various MicroScan instruments (WalkAway
and autoSCAN-4), and should be considered a laboratory system to laboratory system interface
rather than laboratory system to instrument interface.

To use the LabPro Interface program with a healthcare system (laboratory information system
(LIS), SDLN, or other system), a reciprocal program must be written that allows the healthcare
system to send/receive the data to/from LabPro software.

This guide provides reference information and the specifications needed to write the reciprocal
program.

9020-8006, Rev. B LabPro Interface Implementation Guide 17


Preface

About configuring the LabPro Interface


You configure the LabPro Interface by selecting a device type and customizing the selected
device. A device type can be an LIS or SDLN device. Most of the device settings can be
customized to match the healthcare system communication requirements.

See Configuring the LabPro Interface (page 27) for more information.

NOTE:
The Japan Device was specifically developed for Japan and should not be used by
non-Japanese customers.

The LabPro Interface program supports up to 25 different devices. The LabPro Interface program
provides the ability to store independent communication configurations for each device. This
makes it possible to transmit and receive information to and from multiple healthcare computer
applications.

Devices can be configured to share serial ports, use separate serial ports, or configured for file
import/export. Telephone modems can also be used for communications.

About LabPro Interface updates


As needed, Beckman Coulter updates the LabPro Interface program to reflect changes to LabPro
including expanded options, new test group updates, and database modifications.

Although impossible to guarantee, every attempt is made to maintain data stream compatibility
among different versions of LabPro. Whenever the LabPro Interface is updated, new
specifications are supplied to all customers prior to the software release date.

18 LabPro Interface Implementation Guide 9020-8006, Rev. B


2
Specifications, requirements, and
considerations
This section includes the following topics:

• Serial cable requirements (page 20)

• Modem requirements (page 22)

• About LabPro Interface configurable options (page 23)

• Programming considerations (page 23)

• Operation considerations (page 25)

9020-8006, Rev. B LabPro Interface Implementation Guide 19


Specifications, requirements, and considerations

Serial cable requirements


When using a serial connection, each computer’s serial port is connected using an RS-232 cable.
When connecting to an LIS, the LIS vendor provides the serial cable. Refer to your LIS vendor for
cabling information.

After you connect the computers, note the serial port where the cable is plugged.
This information is needed for configuring the LabPro Interface.

Pin Assignments
A serial connection uses either a 9-pin (DB9 Male) or 25-pin (DB25 Male) RS-232 serial port
connection. The cables must be connected to the serial port as follows:

• The LabPro computer transmit line must connect to the receive line of the other healthcare
computer system.

• The LabPro computer receive line must connect to the transmit line of the other healthcare
computer system.

• The LabPro computer ground line must connect to the receiving ground line of the other
healthcare computer system.

About custom serial cables


If you are creating a custom serial cable for use with the LabPro Interface, use the following serial
port pin assignments.

9-pin connector 25-pin connector


Pin Pin Pin assignment
2 3 Receive

3 2 Transmit

4 20 DTR+/- Data Term. Ready (Optional)

5 7 Ground

6 6 DSR Data Set Ready (Optional)

7 4 RTS+/- ready to Send (Optional)

8 5 CTS Clear to Send (Optional)

Cabling for an LIS connection


The cable for connecting the LabPro Interface to an LIS should be provided by the LIS vendor.
If this cable is not provided, use a 4 twisted-pair, 24 AWG, shielded, low capacitance cable.

20 LabPro Interface Implementation Guide 9020-8006, Rev. B


Specifications, requirements, and considerations

Serial ports on your computer


Several computer models are used for the LabPro system. Before you attempt to use the LabPro
Interface, the Laboratory Information System (LIS) must be connected to the LabPro computer.
If system is a LabPro Connect System, the Laboratory Information System (LIS) must be
connected to the LabPro database computer only.

The LabPro computers have multiple USB ports and only a few serial ports.

COM4 is the default for a serial connection and it is set as a serial port on all LabPro computers.
However, if a serial port is not available or multiple serial connections are needed, you can use a
USB-to-Serial conversion device to convert a USB port to a serial port.

When you plug this device into any of the USB ports the software automatically assigns the COM
port number.

A USB-to-Serial conversion device can connect to an RJ45 to Serial conversion device.

CAUTION
Do not use a USB to Serial conversion device to connect a WalkAway instrument.
The WalkAway instrument should connect to LabPro software through either COM 3 or COM 4.

IMPORTANT:
If a communication port other than COM4 is used, you must update the LabPro Interface
configuration in the LabPro system.

See Configuring the LabPro Interface (page 27) for more information.

9020-8006, Rev. B LabPro Interface Implementation Guide 21


Specifications, requirements, and considerations

Modem requirements
The following resources are required for using a modem connection:

• Two telephone (analog) lines, one in the lab for LabPro software and one on the receiving
computer. Set up these lines for single-user phone lines without call forwarding, phone mail
or any other features.

• An available serial port, one on each computer, or an internal modem that is configured as an
available serial port. Confirm the location of the serial port.

• If you are using external modems, use two telephone modems (Hayes compatible) with the
same data transfer capabilities. An internal modem can connect to an external modem.

• If you are using external modems, two modem cables are needed to connect the modems to
the available serial ports on the LabPro computer and the receiving computer.

After you connect the computers, configure the LabPro Interface for a modem connection.
Prior to configuring the LabPro Interface, identify the following information.

• The telephone number for the receiving modem. The telephone number is a required field
when defining the physical layer for a modem connection.

• The dial out, security or authorization numbers for dialing the receiving modem.

• The length of pauses between dialing the dial-out and security numbers. This pause is
expressed in seconds.

See Defining the physical layer for a modem connection (page 53) for instructions on configuring
the LabPro Interface for a modem connection.

22 LabPro Interface Implementation Guide 9020-8006, Rev. B


Specifications, requirements, and considerations

About LabPro Interface configurable options


The LabPro Interface program provides the following configurable options:

• All protocol, delimiter, and control characters can be redefined or suppressed, as required,
for individual implementations. The operator defines delimiters, as required, for individual
applications.

• Cross-referencing for all table-based fields (for example, wards, sources, MIC values,
organism codes, and interpretations). Many laboratory systems and instruments use the
concept of coded data elements.

See Cross-reference tables in the message layer (page 105) for more information.

• Data conversion and formatting options.

• Multiple formats for date and time fields.

• Suppression of data fields and non-required records for specific implementation (to optimize
transmission time) is available during upload operations.

Programming considerations
Developing a reciprocal interface program requires you to determine the customer needs and
the level of interface automation required to meet those needs. The LabPro Interface program
can accommodate the wide range of customer and laboratory system requirements.

The laboratory system programmer must make decisions regarding the flow of the interface
operation and determine how the LabPro Interface programs will affect the laboratory’s
workflow. The overall goal in implementing the LabPro Interface program is to decrease the work
effort for the technologist in the microbiology laboratory.

9020-8006, Rev. B LabPro Interface Implementation Guide 23


Specifications, requirements, and considerations

Key attributes for an ideal reciprocal interface


The ideal reciprocal interface should:

• Ensure accurate communication (data integrity) and provide recovery in case of transient
communication errors (for example, ACK/NAK protocol plus a checksum method).

• Report all transmission activity and errors for review or action by the operator.

• Make all patients, specimen, isolate and test group information available for transmission to
LabPro software.

If comprehensive demographic information is not provided during download, the laboratory


might have difficulty using some of the reporting and epidemiology options provided by
LabPro software.

If test group ordering information is not available during transmission, the operator must
enter this information manually in LabPro software before the tests are run.

• Allow download and upload operations that are initiated from the LIS or LabPro terminals
(via remote request operations).

• Allow configurable batch and/or dynamic download of information to LabPro software.

• Provide a comprehensive load list (a list of information to be transmitted) in which all the
information necessary for the microbiology test group order can be prompted on the
laboratory system (for example, the oxidase reaction and the beta-hemolysis reaction).
This helps the operator avoid mandatory data entry operations in LabPro software after
transmission.

• Make all LabPro test results uploaded to the laboratory system available, on demand, for
reporting on the laboratory system. These include MIC values, oxidase, beta-lactamase,
indole, synergy screens, B-hemolysis, thymidine-dependent strain, ESBL results, and
interpretations. This is important for laboratory systems that can calculate interpretations for
MIC results.

LabPro software provides advanced microbiology interpretation calculation facilities with


advanced result reporting and suppression options. If the reciprocal interface cannot accept
the LabPro interpretations, the laboratory might lose reporting flexibility previously available
to them.

• Provide comprehensive documentation describing the initial setup and daily operation of the
laboratory system’s reciprocal interface program supports a successful LabPro Interface
implementation. This should include documentation with a detailed section on error
occurrences and recovery procedures.

24 LabPro Interface Implementation Guide 9020-8006, Rev. B


Specifications, requirements, and considerations

Operation considerations
To facilitate customer workflow, the LabPro Interface Program enables you to perform the
following functions:

• Automatic/timed upload of demographic or test information from LabPro software to the


laboratory system.

• Operator controlled transmission of request record for download from LabPro software
connection to the laboratory system.

• Automatic/timed transmission of request record for download from LabPro software to the
laboratory system.

The LabPro Interface Program also enables you to customize codes, including: wards, sources,
patient comments, specimen comments, isolate comments, physicians, services, institutions,
organisms, tests, and tech IDs.

9020-8006, Rev. B LabPro Interface Implementation Guide 25


This page intentionally left blank

26 LabPro Interface Implementation Guide 9020-8006, Rev. B


3
Configuring the LabPro Interface
This section includes the following topics:

• LabPro Interface configuration workflow (page 28)

• Device overview (page 30)

• About the Configure Communication Devices window (page 32)

• About adding a new device (page 35)

• Adding a new device (page 37)

• Editing the device configurations (page 39)

• Copying the device configurations (page 42)

• Deleting a device (page 45)

English software screen images are included in this section to identify the locations
of window components and describe tools only. Where applicable, descriptions of
these components and tools are provided in all available languages, however, the
actual screen image and text content within these screen images are only provided
in English.

9020-8006, Rev. B LabPro Interface Implementation Guide 27


Configuring the LabPro Interface

LabPro Interface configuration workflow


This topic provides a typical workflow for configuring the LabPro Interface.

Add a new device configuration, or edit an existing device configuration.


See the following topics for more information:
• Adding a new device (page 37)
• Editing the device configurations (page 39)


Define the appropriate physical layer.
See the following topics for more information:
• Defining the physical layer for serial connection (page 48)
• Defining the physical layer for an SDLN device (page 61)
• Defining the physical layer for a modem connection (page 53)
• Defining the physical layer for file transfer (page 57)


Define the data link layer.
See Defining the data link layer (page 70) for more information.


Define the message layer.
See the following topics for more information:
• Configuring test processing features (page 77)
• Configuring specimen tagging (page 80)
• Defining a device filter rule (page 86)
• Data formatting criteria in the message layer (page 88)
• Defining data suppressions (page 103)
• Building cross-reference tables (page 111)


Workflow continues

28 LabPro Interface Implementation Guide 9020-8006, Rev. B


Configuring the LabPro Interface

Enable auto communication settings.


See the following topics for more information:
• Auto-Transmit (page 118)
• Auto-Request (page 127)
• Auto-Monitor (page 130)


Print Device Detail Report
See Printing the Device Configuration Detail report (page 134) for more
information.

end of workflow

9020-8006, Rev. B LabPro Interface Implementation Guide 29


Configuring the LabPro Interface

Device overview
A device contains all the customization required for communication between LabPro software
and another healthcare computer system. Devices can be configured to share serial ports, use
separate serial ports, use modems, or perform a file transfer.

Examples of device configurations


• When connecting serial ports using an RS-232 cable, use serial configuration for the device.

• When connecting serial ports using telephone modems, use modem configuration for the
device.

• When transferring information between computer systems that are not directly connected,
use the file configuration for the device.

• When transferring data to the SDLN product, use the SDLN configuration.

LABPRO NETWORKS ONLY:


Transmitting from a LabPro Connect computer using a device configuration for SDLN or file is
not supported.

About creating device configurations

LABPRO NETWORKS ONLY:


You can only create device configurations using the LabPro database computer.

You can create a maximum of 25 devices. Multiple devices can actively receive or send at the
same time, if they are configured to different serial ports. If you configure multiple devices to
the same serial port, only one device has exclusive access to the serial port while transmitting.
If multiple devices share a modem, each device must dial a different telephone number.
After creating a device, print the configurations and backup LabPro software. You can also edit
device configurations and delete a device.

30 LabPro Interface Implementation Guide 9020-8006, Rev. B


Configuring the LabPro Interface

Three-layer protocol implementation


The LabPro Interface is based on a three-layer protocol implementation: the Physical Layer, the
Data Link Layer, and the Message Layer. Each layer performs a set of functions and provides a set
of services. These layers define what connection is used between devices, how the data is
transmitted, and the content and structure of the data.

• Physical Layer. Defines the type of physical connection between LabPro software and
another healthcare computer system. This layer can be configured for file transfer, serial
connection, or modem communication. See Configuring the physical layer (page 47) for
more information.

• Data Link Layer. Handles the logical framing of the message. This layer establishes a link
connection, transfers the data, and releases the connection. The data link layer also performs
error detection and error recovery functions. See Configuring the data link layer (page 63) for
more information.

• Message Layer. Specifies how data is structured in the records that make up a message.
This layer performs basic manipulations of data, such as cross-referencing, data modification,
data suppressions, and data formatting, before the data is passed onto the database for
validation. See Configuring the message layer (page 73) for more information.

LabPro Interface configuration windows and tools


This topic describes the key windows, dialog boxes, and tools that you use to configure the
LabPro Interface. Additional properties windows and dialog boxes are described in this guide as
they appear in specific procedures.

NOTE:
English software screen images are included in this section to identify the locations of window
components and describe tools only. Where applicable, descriptions of these components and
tools are provided in all available languages, however, the actual screen image and text content
within these screen images are only provided in English.

9020-8006, Rev. B LabPro Interface Implementation Guide 31


Configuring the LabPro Interface

About the Configure Communication Devices window


The Configure Communication Devices window displays all defined devices, the status of those
devices, the next auto-transmit and auto-request times, and any error conditions. When the
LabPro Interface is receiving or sending data, a message flashes on the status bar.

You can configure all device settings from the Configure Communication Devices window.
For example, you can:

• Add a new device and configure device settings.

• Edit device configurations.

• Copy a device configuration.

• Configure auto-communications.

• Delete a device.

• Enable auto-monitor.

• Print the Device Configuration Report.

LABPRO NETWORKS ONLY:


Configuration of a device can only be performed on the LabPro database computer.

1
2
3

Item Description Item Description


Configure Communication Toolbar
1 Devices window 3

Device menu Configured device list


2 4

32 LabPro Interface Implementation Guide 9020-8006, Rev. B


Configuring the LabPro Interface

Device menu options

Command Function
Add Add a new device.

Edit Edit the selected device.

Copy Copy the device configurations to create a new device.

Auto-Communication Configure/enable/disable auto-transmit and auto-request.

Delete Delete the selected device.

View Queue View the Interface Queue.

Stop Transmission Stop the transmission for the selected device.

Enable Auto-Monitor Enable/disable auto-monitor.

Print Configuration Print the Device Configuration Report for the selected device or all devices.

Print Preview View the Device Configuration Report for the selected device.

Set all data as Transmitted Sets the transmission flag to true for all Specimens, Isolates, and Isolate
Test Groups for the selected device.

Toolbar options

Button Function
Add a new device.

Edit the selected device.

Delete the selected device.

Print the device configuration report for the selected device or for all devices.

9020-8006, Rev. B LabPro Interface Implementation Guide 33


Configuring the LabPro Interface

About the Device Configuration dialog box


The Device Configuration dialog box displays the device type, device name, and the different
layers of a device. Use this dialog box to configure a new device or edit the physical, data link or
message layer for a device.

This dialog box displays when you add a new device or edit an existing device.

LABPRO NETWORKS ONLY:


Devices must be configured on the LabPro database computer.

1
2
3

Item Description
Device Configuration dialog box
1

Device type (displays the device type you selected in the Configuration
2 Communications Devices window)

Device name
3

The Layer column displays the Physical, Data Link, and Messages layers.
4
The Selection column displays the selected layer option

34 LabPro Interface Implementation Guide 9020-8006, Rev. B


Configuring the LabPro Interface

About adding a new device


Each device type contains default settings to communicate with a specific type of healthcare
computer system. You can edit the settings to match the reciprocal system. For example, edit the
device configurations if there is a change in your workflow or changes in the sending or receiving
system.

See Device type default values (page 211) for the table listing the default settings for each device
type.

Number of devices
You can define up to 25 devices, but only one device per serial port may actively send or receive
data at a given time.

Device names
Each device you create has a name. Device names must be unique, descriptive of the receiving
system, and can be up to 32 characters.

Device guidelines
Consider the following when creating a device:

• Define filters for each device. Filters help ensure appropriate data is transmitted to the other
healthcare computer system by defining what types of patient results are transmitted.

See Device filter rules in the message layer (page 82) for more information.

• If the newly created device receives information that is initiated on the LIS, enable Auto-
Monitoring.

See Auto-Monitor (page 130) for more information.

• If the newly created device uses a Modem connection, configure the physical layer for the
correct telephone number and modem settings.

See About configuring the physical layer (page 48) for more information.

• If the newly created device uses a Serial connection, configure the physical layer for the
correct serial port.

See Configuring the physical layer (page 47) for more information.

• If the newly created device uses File transfer, configure the physical layer for the correct
import and export file names.

See Defining the physical layer for file transfer (page 57) for more information.

• If the newly created device connects to the VA Vista-LSI Interface, configure the data link
layer to use the VA Vista configuration.

9020-8006, Rev. B LabPro Interface Implementation Guide 35


Configuring the LabPro Interface

See About the data link layer (page 64) for more information.

• If you are creating multiple devices that are similar, consider creating one device and then
use copy to create the other devices. You can then edit the configurations on the new
devices.

Device types
The receiving healthcare computer system (LIS, SDLN) determines the device type. For example, if
you are connecting to an LIS, then select LIS as your device type.

The following table provides descriptions of each device type.

Device type Description


LIS device type Contains the default configuration settings to transmit to and from an LIS. You
may edit the default settings to match your LIS and your computer connection.
See your LIS User’s Manual for the correct configuration settings.

SDLN device type The Surveillance Data Link Network (SDLN) is a Windows-based epidemiology
and surveillance resource, which is accessed via the internet.
This device type allows the export of customization, patient demographic,
specimen, and test results to a file for use with the SDLN Data Transfer software.
This data is then sent to International Health Management Associates, Inc. (IHMA),
for posting on their website. The data is available via a secure internet access for
reporting, graphing, and comparing to your region and others.
When selecting this device type the default configurations are set for an SDLN file
export. The data is written to two separate files on the hard drive: patient data and
custom data. The file names are predefined.
See the SDLN User’s Manual for more information.

36 LabPro Interface Implementation Guide 9020-8006, Rev. B


Configuring the LabPro Interface

Adding a new device


This procedure explains how to add a new device.

Before adding a new device


• Check the user guide for the other healthcare computer system to determine configuration
guidelines.

• If possible, print the customization from the other healthcare computer system.

Procedure

LABPRO NETWORKS ONLY:


You can only create device configurations using the LabPro database computer.

To add a new device:

1. On the LabPro Command Center, click Utilities.

2. In the Utilities window, select Configuration > Interface.

3. Enter the password if requested.

The Configure Communication Devices window displays.

4. Click Add and then select the appropriate device type on the menu.

9020-8006, Rev. B LabPro Interface Implementation Guide 37


Configuring the LabPro Interface

The Device Configuration dialog box displays.

5. In the Device Name box, type the appropriate name for the device.

Device Name requirements


• The device name can be up to 32 characters.
• The device name must be unique and descriptive of the reciprocal system—for
example, your LIS vendor name.
• The device name cannot contain any leading spaces, begin with a $ sign, or
contain any of the following characters: . / * ? < > | "

6. Complete one of the following actions:

• Click OK to accept the default settings. The window closes and the Configure
Communications Devices window displays.
• If the default settings need editing, select the appropriate layer and click Configure.
See Editing the device configurations (page 39) for more information.

See Device type default values (page 211) for default settings for each device type.

IMPORTANT:
If using a serial connection or modem Defining the physical layer for a modem
connection (page 53) for more information.

7. Always enable the auto-monitor if the device receives information from another healthcare
computer system and a request for data is not transmitted from the LabPro Interface.

If you configure the device for file transfer, see Defining the physical layer for file transfer
(page 57) for more information.

38 LabPro Interface Implementation Guide 9020-8006, Rev. B


Configuring the LabPro Interface

Editing the device configurations


This topic provides a procedure for editing the device configurations. It also includes a table that
you can use to help locate the device settings in the configuration program. Periodically, you
might need to edit device configuration settings.

Before editing a device


• Identify the device that needs editing.

• Make sure the device status is idle.

• Identify the setting that needs editing.

• See Device configuration settings (in this section) to determine which device layers to access.

LABPRO NETWORKS ONLY:


You must be on the LabPro database computer to edit a device configuration. You cannot edit
a device configuration if transmissions are in the Interface queue or if the Manual Transmit or
Transmit Custom Data window is open on a LabPro Connect or laboratory computer
connected to the LabPro network.

9020-8006, Rev. B LabPro Interface Implementation Guide 39


Configuring the LabPro Interface

Device configuration settings


Use this table to help locate the settings in the configuration program.

Device configuration settings


Physical layer Data link layer Message layer
Serial/Modem: Checksum Data Modifications:

Connection Timeout Delay Test Processing


setting

General Line Bidding: 1 Specimen Tagging


Settings

Baud Rate Enquiry Filters

Data Bits Software Flow Control: 1 Data Formatting:

Parity Ack/Nak Site Name

Stop Bits Xon/Xoff Field Delimiter

Hardware Flow Protocol Character Definitions1 String Delimiter


Control:

Modem Settings:

Dial Out # Timeout Delay Transmission Sort Order

Telephone # Use String delimiter in null fields

Security # Use String delimiter in single character


fields

Redial Attempts Organism Name Format

File: Transmission Sort Order

File import Transmission of Interpretations


name

File export Date Format


name
Time Format

Data Suppressions

Cross-reference:

Numeric only

40 LabPro Interface Implementation Guide 9020-8006, Rev. B


Configuring the LabPro Interface

Procedure
To edit device configurations:

1. On the LabPro Command Center, click Utilities.

2. In the Utilities window, select Configuration > Interface.

3. Enter the password if requested.

The Configuration Communication Devices window displays.

4. Click the device you want to edit. The device name is highlighted.

Make sure the device status is idle.

• If the device is in another status (for example, Transmitting), wait until the transmission is
complete and the status returns to idle.
• If necessary, you can stop a device that is sending data. To stop a transmission, right-click
on the device and click Stop on the menu.
• If the following message displays:
“This device is in use on <client computer name(s)>”

close the Manual Transmit or Transmit Custom Data window on the listed computer.

• If the following message displays:


“This device is in use on <client computer name(s)>”

wait until the transmission in the Interface queue is complete and the status returns
to idle.

5. Click Edit on the toolbar.

9020-8006, Rev. B LabPro Interface Implementation Guide 41


Configuring the LabPro Interface

The Device Configuration dialog box displays.

6. Click the appropriate layer you want to edit and then click Configure.

More information
See the following topics for more device configuration information:

• Configuring the physical layer (page 47)

• Configuring the data link layer (page 63)

• Configuring the message layer (page 73)

Copying the device configurations


This topic describes copying a device configuration to create a new device. It also provides a
procedure for copying the device configurations.

About copying a device configuration to create a new device


You can create a new device by copying the configurations of an existing device. This option is
useful when creating similar devices or multiple devices to the same healthcare computer system.
After creating a new device by copying another device configuration, you might need to edit
some of the configurations.

• If using a serial connection, identify the correct serial port for the new device.

• If using modems, identify the telephone number for the receiving modem.

• If using file transfer, identify the correct import and export file names.

This option copies all the device configurations in the physical, data link and message layer as
well as the Interface Log error suppressions configuration. The Auto-Communication
configurations and the Auto-Monitor status are not copied.

42 LabPro Interface Implementation Guide 9020-8006, Rev. B


Configuring the LabPro Interface

Before copying a device


• Do not add the new device. LabPro software creates the new device during the copy process.

• Make sure that the device you are copying from is configured correctly and transmits without
errors.

• Identify which settings if any need editing after the copy takes place.

Procedure
To copy the device configurations:

1. On the LabPro Command Center, click Utilities.

2. In the Utilities window, select Configuration > Interface.

3. Enter the password if requested.

The Configuration Communication Devices window displays.

4. Click the device you want to copy. The device name is highlighted.

Make sure the device status is idle.

• If the device is in another status, such as Transmitting, wait until the transmission is
complete and the status returns to idle.
• If necessary, you can stop a device that is sending data.
To stop a transmission, right-click on the device and click Stop on the menu.

5. On the Device menu click Copy.

9020-8006, Rev. B LabPro Interface Implementation Guide 43


Configuring the LabPro Interface

The Copy Device Configuration dialog box displays.

6. In the Device Name box, type the appropriate name for the device.

Device name requirements


The device name:
• Can be up to 32 characters.
• Must be unique and descriptive of the reciprocal system
(for example, your LIS vendor name). Do not use the same name as
the original device you copied.
• Cannot contain any leading spaces, begin with a $ sign, or contain
any of the following characters: . / * ? < > | “

7. Click OK to accept the configurations copied from the previous device.

The window closes and the Configure Communications Devices window displays.

8. If the settings need editing, select the appropriate layer and then click Configure.

See Editing the device configurations (page 39) for more information.

44 LabPro Interface Implementation Guide 9020-8006, Rev. B


Configuring the LabPro Interface

Deleting a device
This topic describes how to delete a device. Occasionally, you may need to delete a device.
Deleting a device has no effect on the other devices. When a device is deleted queued
transmissions are also deleted.

Before deleting a device


Make sure the device is idle. The device cannot be sending data, receiving data, or in a
waiting state.

LABPRO NETWORKS ONLY:


You must be on the LabPro database computer to delete a device configuration. You cannot
delete a device configuration if transmissions are in the Interface queue or if the Manual
Transmit or Transmit Customer Data window is open on a LabPro Connect or laboratory
computer connected to the LabPro network.

Procedure
To delete a device:

1. On the LabPro Command Center, click Utilities.

2. In the Utilities window, select Configuration > Interface.

3. Enter the password, if requested.

The Configure Communications Devices window displays.

4. Click the device you want to delete.

Make sure the device status is idle.

9020-8006, Rev. B LabPro Interface Implementation Guide 45


Configuring the LabPro Interface

• If the device is in another state, wait until the transmission is complete and the status
returns to idle.
• If necessary, you can stop a device that is sending data. To stop transmission, right-click
on the device and click Stop on the menu.
• If the following message displays:
“This device is in use on <client computer name(s)>”

close the Manual Transmit or Transmit Customer Data window on the listed computer.

• If the following message displays:


“This device is in use on <client computer name(s)>”

wait until the transmission in the Interface queue is complete and the status returns
to idle.

5. On the toolbar, click Delete.

A confirmation message displays.

6. In the confirmation message dialog, click Yes.

If the device is in use, the following message displays:

“Device is transmitting data, wait until device is idle before deleting.”

46 LabPro Interface Implementation Guide 9020-8006, Rev. B


4
Configuring the physical layer
This section includes the following topics:

• About configuring the physical layer (page 48)

• Defining the physical layer for serial connection (page 48)

• Defining the physical layer for a modem connection (page 53)

• Defining the physical layer for file transfer (page 57)

• Defining the physical layer for an SDLN device (page 61)

English software screen images are included in this section to identify the locations
of window components and describe tools only. Where applicable, descriptions of
these components and tools are provided in all available languages, however, the
actual screen image and text content within these screen images are only provided
in English.

9020-8006, Rev. B LabPro Interface Implementation Guide 47


Configuring the physical layer

About configuring the physical layer


The physical layer defines the type of physical connection between LabPro software and
another healthcare computer system. The physical layer default settings are dependent upon the
device type.

See Device type default values (page 211) for the default settings for each device type.

Physical layer configuration options


• Configure the physical layer as Serial, if you are using a direct cable connection.

See Defining the physical layer for serial connection (page 48) for more information.

• Configure the physical layer as Modem, if you are transmitting data via an external or
internal modem.

See Defining the physical layer for a modem connection (page 53) for more information.

• Configure the physical layer for File, if you are transmitting data to or from a disk or file.

See Defining the physical layer for file transfer (page 57) for more information.

• The SDLN device is automatically configured as File and the file names are predefined for
you.

See Defining the physical layer for an SDLN device (page 61) for more information.

Defining the physical layer for serial connection


When a serial cable is used as the connection between LabPro software and another healthcare
computer system, you might need to edit the default settings (baud rate, data bits, parity, stop
bit, and hardware flow control) to match the receiving system.

See Serial cable requirements (page 20) for more information.

If the receiving system uses only software flow controls and not hardware flow controls, see
Configuring the data link layer (page 63) for more information.

Before configuring the physical layer for a serial connection


Before configuring the physical layer for a serial connection:

• See the healthcare computer system documentation for information about proper
configuration guidelines.

• Review the serial cable requirements.

See Serial cable requirements (page 20) for more information.

48 LabPro Interface Implementation Guide 9020-8006, Rev. B


Configuring the physical layer

• Confirm the serial port used for the serial connection and the serial ports used by the printer
and the serial WalkAway instrument.

See Pin Assignments (page 20) for more information.

• If possible, print out the customization from the other healthcare computer system.

Procedure
To define a serial connection:

1. Use the Configure Communication Devices window to add or edit a LabPro Interface
device.

See Adding a new device (page 37) or Editing the device configurations (page 39).

2. In the Device Configuration dialog box, in the Physical layer row of the table, click the arrow
in the Selection column to display a list.

3. Select Serial.

Serial displays in the Physical Layer Selection column.

4. Click Configure.

9020-8006, Rev. B LabPro Interface Implementation Guide 49


Configuring the physical layer

The Serial Physical Layer Properties dialog box displays.

2
3
4 5

Item Description Item Description


Serial Physical Layer dialog box General Settings box
1 4

Settings/Flow Control tab Hardware Flow Control box


2 5

Connect box
3

5. In the Connect box, click the arrow to display a list of COM ports.

6. If the COM port is different from the default, click the appropriate COM port from the list.

IMPORTANT:
If No Ports Available displays, there are no available COM ports. Click OK to exit the
Serial Physical Layer Properties dialog box and consult your computer manual to
establish an available port.

50 LabPro Interface Implementation Guide 9020-8006, Rev. B


Configuring the physical layer

7. In the General Settings area, modify the following settings to match the receiving healthcare
computer system.

Table 4-A: Settings/Flow Control - General Settings


Setting Description
Baud Rate The speed data is transmitted. The baud rate must match on both LabPro software
and the other healthcare computer system.
Valid entries are 300, 600, 1200, 2400, 4800, 9600, 19200, 38400, 57600, or
115200.
See the reciprocal system documentation for the correct settings.

Data Bits The number of bits that represent one character of data. The data bits on both
LabPro software and the other healthcare computer system must match. Valid
entries are 7 or 8.
See the reciprocal system documentation for the correct settings.

Parity A function that detects errors in transmission. The parity on both LabPro software
and the other healthcare computer system must match. Valid entries are None,
Odd, or Even.
See the reciprocal system documentation for the correct settings.

Stop Bits Identifies the end of each data byte or character. The stop bit duration on both
LabPro software and the other healthcare computer system must match. Valid
entries are 1 or 2 periods in length.
See the reciprocal system documentation for the correct settings.

9020-8006, Rev. B LabPro Interface Implementation Guide 51


Configuring the physical layer

8. In the Hardware Flow Control area, select a control check box to match the receiving
healthcare computer system settings.

Table 4-B: Settings/Flow Control - Hardware Flow Control


Setting Description
Request To Send/ Clear If the reciprocal system uses only software flow control (for example,
To Send XON/XOFF, ACK/NAK), do not select a check box in this area.
(RTS/CTS)
This hardware protocol uses the RS-232 RTS/CTS signal lines to control
character flow. When the buffer of the receiving system is close to full,
the RTS line is set to low.
The sender responds by detecting that its CTS (Clear to Send) line has
changed state and waits for the CTS line to toggle back (via RTS high
reset from the receiver) before sending any further data.

Data Terminal Ready/ If the reciprocal system uses ENQ along with hardware flow control,
Data Set Ready (DTR/ click the RTS/CTS or DTR/DSR check box and then go to the data link
DSR) layer and select ENQ.
The Line bidding and software flow control options are located in the
data link layer.
This hardware protocol uses the RS-232 DTR/DSR signal lines to control
character flow. When the buffer of the receiving system is close to full it
sets the DTR line to low (-12V).
The sender should respond by detecting that its DSR line has changed
state and waits for the DSR line to toggle back (via DTR high reset from
receiver) before sending any further data.

The Line bidding and software flow control options are located in the data link layer.

See About the data link layer (page 64) for more information.

9. Click OK to validate any changes and then close the dialog box.

10. In the Device Configuration dialog box, click OK to save changes.

52 LabPro Interface Implementation Guide 9020-8006, Rev. B


Configuring the physical layer

Defining the physical layer for a modem connection


If you do not have a serial connection available for the LabPro Interface, and want to use an
analog phone line to establish connection to the Healthcare system, you can configure the
physical layer to use a modem connection.

See Modem requirements (page 22) for more information.

Procedure
To define a modem connection:

1. Use the Configure Communication Devices window to add or edit a LabPro Interface
device. See Adding a new device (page 37) or Editing the device configurations (page 39).

2. In the Device Configuration dialog box, in the Physical layer row of the table, click the arrow
in the Selection column to display a list.

3. Select Modem.

Modem displays in the Selection column.

4. Click Configure

9020-8006, Rev. B LabPro Interface Implementation Guide 53


Configuring the physical layer

The Modem Physical Layer Properties dialog box displays. If a modem is not installed, a
message displays: “No modem connection found.”

1
2
3

4 5

Item Description Item Description


Modem Physical Layer dialog box General Settings box
1 4

Settings/Flow Control tab Hardware Flow Control box


2 5

Connect box
3

5. Click the Settings/Flow Control tab and then click the Connect arrow and select the
appropriate Modem.

IMPORTANT:
This lists includes the installed Modems on your system. If the list does not display a
modem, click OK to exit the Modem Physical Layer dialog box, and install your
modem with the Windows operating system.

6. In the General Settings box, click the arrow for each of the following settings to match the
receiving modem specifications:

• Baud Rate
• Data Bits
• Parity
• Stop Bits

54 LabPro Interface Implementation Guide 9020-8006, Rev. B


Configuring the physical layer

See Table 4-A: Settings/Flow Control - General Settings (page 51) for more information about
these settings.

7. In the Hardware Flow Control area, select the check box for the control that matches the
receiving healthcare computer system.

• If the reciprocal system uses only software flow control, (for example, XON/XOFF, ACK/
NAK) do not select a check box in this area.
• If the reciprocal system uses ENQ along with hardware flow control, click RTS/CTS or
DTR/DSR, then go to the Data Link Layer and select ENQ.
The line bidding and software flow control options are located in the data link layer.
See Defining the data link layer (page 70) for more information.

See Table 4-B: Settings/Flow Control - Hardware Flow Control (page 52) for more information
about these settings.

8. Click OK to apply the settings.

9. Click the Modem Settings tab.

1
2
3 7
4

9020-8006, Rev. B LabPro Interface Implementation Guide 55


Configuring the physical layer

Item Description Item Description


Modem Physical Layer Security # box
1 dialog box 5

Modem Settings tab Redial Attempts box


2 6

Dial Out # box Wait boxes (used for dial out and
3 7 redial properties)

Telephone # box
4

10. In the Dial Out # box, type the number to access an outside line.
Enter this number if the Modem is accessing an outside line and you use an access number at
your facility. For example, if you dial 9 to access an outside line before dialing a number,
enter 9.

11. In the Dial Out Wait box, type the number of seconds to pause after dialing the dial out
number.

Enter the number of seconds to wait, if you need to pause between dialing the dial out
number and the telephone number.

12. In the Telephone # box, type the telephone number for the reciprocal modem.
The telephone number is a required entry. In the United States, type 1, the area code, and
telephone number if accessing a long distance number. Do not include commas, periods, or
dashes.

13. In the Telephone # Wait box, type the number of seconds to pause after dialing the
telephone number.

Enter the number of seconds to wait, if you need to pause between dialing the telephone
number and the security number or authorization code.

14. In the Security # box enter the security code.


Enter this number if you use a security number or authorization code when dialing the
telephone number. For example, if you dial a security number after a long distance number.

15. In the Redial Attempts area, enter the number of times the LabPro Interface should attempt
to redial the receiving modem before canceling the transmission.

16. In the Redial Wait box, enter the number of minutes to wait before the modem attempts a
redial.

17. Click OK to validate any changes and then close the window.
18. In the Device Configuration dialog box, click OK to save changes.

56 LabPro Interface Implementation Guide 9020-8006, Rev. B


Configuring the physical layer

Defining the physical layer for file transfer


The LabPro Interface supports the ability to receive or import data from a file and to transmit or
export data to a file. The file capability allows data transfer between systems based on an ASCII
formatted file transfer.

You define the path and file name, which is on a disk, an external drive, or the hard drive. Use file
transfer as a backup method of communication in the event the cable or modem connections fail.

LABPRO NETWORKS ONLY:


All transmissions for a device configured as File need to be initiated on the LabPro database
computer. Transmit Patient Data, Custom Data and Requesting Data options are not
supported by the LabPro Connect system.

When you use a file to transmit data between LabPro software and another healthcare computer
system, define the Physical Layer as File. The Physical Layer is automatically set to File when you
select SDLN for the Device Type.

See Defining the physical layer for an SDLN device (page 61) for more information.

The file name extensions are always .exp, and are automatically appended by the LabPro
Interface. This naming convention prevents LabPro software files from being inadvertently
overwritten.

NOTE:
When you define the physical layer as File, the data link layer is automatically set
to Null.

Before you begin


• Identify the import and export path and file name.

• Before configuring the physical layer for an SDLN device, make sure the Device Type is
SDLN. The Device Configuration dialog box displays the device type as SDLN.

Procedure
To define the physical layer for file transfer:

1. Use the Configure Communication Devices window to add or edit a LabPro Interface
device. See Adding a new device (page 37) or Editing the device configurations (page 39).

2. In the Device Configuration dialog box, in the Physical layer row of the table, click the arrow
in the Selection column to display a list.

9020-8006, Rev. B LabPro Interface Implementation Guide 57


Configuring the physical layer

3. Select File.

The following message displays:

“This change will cause other layers to be set to default settings. Continue?”

4. Click Yes.

5. Click Configure.

The File Physical Layer Properties dialog box displays.

1
2
3

4 5

58 LabPro Interface Implementation Guide 9020-8006, Rev. B


Configuring the physical layer

Item Description Item Description


File Physical Layer dialog box Export File Name box
1 4

File Settings tab Browse [...] buttons


2 5

Import File Name box


3

6. Click OK to accept the default path and file names and return to the Device Configuration
dialog box, or click Browse [...] and select a different import file or export file.

The Open dialog box displays. Only files with an .exp extension display.

Select the appropriate file from the list, or type the name of the file in the File name box, and
then click Open.

If Then
The file does not exist Type the file name in the File name box.
LabPro software creates the file and appends an .exp extension to
the file name.

The file exists on a 1. Click the Look in arrow or click My Computer and then click
different path the appropriate drive.
2. Select or type the appropriate file name and then click Open.

The file exists on a floppy 1. Insert the disk into the drive.
disk 2. Click the Look in arrow or click My Computer, and select the
appropriate drive.
3. Select the file from the list and then click Open.
The file does not exist on 1. Insert the disk into the drive.
the floppy disk 2. Click the Look in arrow or click My Computer and then select
the appropriate drive.
The default file name displays in the File name box, or type the
appropriate file name.
3. Click Open. LabPro software creates the file on the disk.

9020-8006, Rev. B LabPro Interface Implementation Guide 59


Configuring the physical layer

ABOUT FILE NAMES


File names can contain up to 255 characters. File names cannot contain any leading
spaces, begin with a $ sign, or contain any of the following characters: . / * ? < > | “

The LabPro Interface appends an .exp extension to the file name for both the import and
export Files. You can import data from and export data to the same file.

7. Click the OK to validate changes and then close the window.

8. In the Device Configuration dialog box, click OK to save changes.

60 LabPro Interface Implementation Guide 9020-8006, Rev. B


Configuring the physical layer

Defining the physical layer for an SDLN device


Surveillance Data Link Network (SDLN) is a Windows-based epidemiology and surveillance
online resource accessed via the internet. When you select an SDLN device type, the physical
layer is automatically defined as File.

The path and file name for patient data and customization exports are defined for you.
The Patient Data File Name is SDLN.exp. The Custom Export File name is SDLN.cus.

LABPRO NETWORKS ONLY:


All transmissions for a device configured as a SDLN device need to be initiated on the LabPro
database computer. Transmit Patient Data, Custom Data and Requesting Data options are
not supported by the LabPro Connect system.

Procedure
To define a SDLN device:

1. Use the Configure Communication Devices window to add or edit a LabPro Interface
device. See Adding a new device (page 37) or Editing the device configurations (page 39).

2. In the Device Configuration dialog box, in the Layer column, click Physical.

3. Click Configure.

9020-8006, Rev. B LabPro Interface Implementation Guide 61


Configuring the physical layer

The SLDN File Physical Layer dialog box displays.

1
2
3

4 5

Item Description Item Description


SDLN File Physical Layer dialog Custom Export File Name box
1 box 4

File Settings tab Browse [...] buttons


2 5

Patient Data Export File Name box


3

The Physical Layer is defined as SDLN when you select SDLN for the device type.
Both the Patient Data Export File Name and Custom Export File Name are automatically
defined and cannot be changed.

4. Complete one of the following actions:

• Click OK to accept the default path and file name


• Click Browse [...]. The Open dialog box displays. Navigate to a different path and then
click Open.
5. In the SDLN File Physical Layer dialog box, click OK.

62 LabPro Interface Implementation Guide 9020-8006, Rev. B


5
Configuring the data link layer
This section includes the following topics:

• About the data link layer (page 64)

• Defining the data link layer (page 70)

English software screen images are included in this section to identify the locations
of window components and describe tools only. Where applicable, descriptions of
these components and tools are provided in all available languages, however, the
actual screen image and text content within these screen images are only provided
in English.

9020-8006, Rev. B LabPro Interface Implementation Guide 63


Configuring the data link layer

About the data link layer


The methods for error detection, error recovery, sending and receiving messages are found in the
data link layer. Checksum type, timeout delay, line bidding, software flow control protocol, and
protocol characters definitions are defined in this layer.

The data link layer interacts with higher layers in terms of sending and receiving “messages,”
handling data link connection and release requests, and reporting the data link status.

The data link layer is automatically set to Null and cannot be edited when an SDLN device type is
selected or when the physical layer is configured for file transfer.

See the following topics for more information:

• Frames (LIS device type) (page 65)

• Checksum type (page 65)

• Four types of checksum methods (page 66)

• Checksum calculations (page 66)

• Conversions for each checksum method (page 67)

• Timeout delay (page 67)

• Line bidding and software flow control protocols (page 67)

• Protocol character definitions (page 69)

• Using of prefix and suffix characters (page 69)

• VA Vista configuration (page 69)

64 LabPro Interface Implementation Guide 9020-8006, Rev. B


Configuring the data link layer

Frames (LIS device type)


Messages (records) are sent in frames. Each frame contains a maximum of 255 characters
including frame overhead. LabPro software does not support multiple frames for a single record.

If a message is transmitted or received that exceeds the 255 character limit, an error displays in
the Interface Log.

An <STX> precedes each record with the record content following. Each record ends with a
<CR><LF>, and an optional 2-byte printable checksum. The frame is terminated by an <ETX>.

Example:

<STX>Patient Record<CR><LF>C1 C2<ETX>

<STX>Specimen Record<CR><LF>C1 C2 <ETX>

where C1 C2 denote optional checksum bytes

Checksum type
The Checksum is a value used to help ensure data is transmitted without errors. Checksumming is
a simple error-detection scheme in which each transmitted message is accompanied by a
numerical value, which is computed based on the characters in the message. The value
accompanies data transferred from one system to another.

On the receiving end, the checksum is recomputed based on the data received and compared
with the value that was sent with the data. If the two numbers match, the data is considered
correct. If they do not match, a checksum error displays in the Interface Log. If you use
checksums, the LabPro Interface and the other healthcare computer system must use the same
method.

When you use the ACK/NAK protocol in conjunction with the checksums, the LabPro Interface
has the capability for self-correcting transient errors that may periodically occur by retransmitting
the record.

9020-8006, Rev. B LabPro Interface Implementation Guide 65


Configuring the data link layer

Four types of checksum methods

Method Description
SUM-HEX Each character/byte or an individual record (including the STX, CR and LF) is
internally SUMmed (added) with a temporary byte variable, which has an initial
value of zero.
Any arithmetic carryover from summing is ignored via modulo 256. After the
entire record is SUMmed, the calculated byte value is converted into a two-
character hexadecimal representation.

SUM-ASCII Each character/byte or an individual record (including the STX, CR and LF) is
internally SUMmed (added) with a temporary byte variable, which has an initial
value of zero.
After the entire record is SUMmed, the calculated value is converted into the
decimal equivalent of each nibble (4 bits) of the byte and an offset of 64 is added
to each nibble to create two printable characters. The character representing the
most significant nibble is always transmitted first.

XOR-HEX Each character/byte of an individual record (including the STX, CR and LF) is
internally XORed (exclusive OR) with a temporary byte variable, which has an initial
value of zero.
After the entire record is XORed, the calculated byte value is converted into a
two-character hexadecimal representation.

XOR-ASCII Each character/byte of an individual record (including the STX, CR and LF) is
internally XORed (exclusive OR) with a temporary byte variable, which has an initial
value of zero.
After the entire record is XORed, the calculated value is converted into the decimal
equivalent of each nibble (4 bits) of the byte and an offset of 64 is added to each
nibble to create two printable characters. The character representing the most
significant nibble is always transmitted first.

Checksum calculations
The following table shows the calculations performed for this end record:

<STX>L,L,Y,0<CR><LF>

• The Char column identifies each character of this record.

• The Sum column identifies the decimal equation and cumulative summation value.

66 LabPro Interface Implementation Guide 9020-8006, Rev. B


Configuring the data link layer

• The XOR column identifies the binary equivalent and resulting XOR value.

Char Sum XOR


Decimal Sum Binary XOR
equivalent value equivalent value
STX 2 2 00000010 00000010

L 76 78 01001100 01001110

, 44 122 00101100 01100010

L 76 198 01001100 00101110

, 44 242 00101100 00000010

Y 89 331 01011001 01011011

, 44 375 00101100 01110111

0 48 423 00110000 01000111

CR 13 436 00001101 01001010

LF 10 446 00001010 01000000

Conversions for each checksum method


The following table provides the conversion for each checksum method.

Method Conversion for <STX>L,L,Y,0<CR><LF>


Sum Hex 446-1(256) = 190 (decimal) = BE (hex)

Sum ASCII B (hex) = 11 (decimal) + 64 = 75 = Char K


(Offset 64) E (hex) = 14 (decimal) + 64 = 78 = Char N

XOR Hex 01000000 (binary) = 40 (hex)

XOR ASCII 0100 (binary) = 4 (hex) = 4 (decimal) + 64 = 68 = Char D


(Offset 64) 0000 (binary) = 0 (hex) = 0 (decimal) + 64 = 64 = Char @

Timeout delay
When using certain software protocols, if the LabPro Interface does not receive an
acknowledgment or a request is not answered within the defined period of time, an error occurs.
If you are using a modem, consider using 90 seconds for your timeout period.

Line bidding and software flow control protocols


The line bidding and software flow control protocols, when used, prevent collision and buffer
overflow during transmission.

9020-8006, Rev. B LabPro Interface Implementation Guide 67


Configuring the data link layer

The following is a list of the Line Bidding and Software Control Protocols available in the Data
Link Layer.

Protocol Description
ENQ A line bidding protocol, which is used at the beginning of each transmission session to
detect if the line is in use. When the sender wishes to begin transmission, it sends an
ENQ character and waits for an ACK or NAK response.
If an ACK character is received, the sender has control of the line and can begin
transmission. If a NAK character is received, the sender should wait a specified period of
time (default is 10 seconds) and reissue the ENQ request. If after three ENQ requests, the
receiver is not available, the sender timeouts.
When using the ENQ protocol option and request for download function, the healthcare
computer application waits 10 seconds between receiving the end of transmission
following the request record and the sending of the (ENQ).

XON/XOFF A communication protocol that keeps the receiver in synchronization with the sender.
When the buffer in the receiving device is close to full, it sends a “transmit off” or XOFF
signal to the sending device, telling it to stop transmitting.
The sender must stop sending data within a reasonable time (1 to 10 characters) in
response to the XOFF request. When the receiving device is ready to accept more, it
sends the sending device a “transmit on” or XON signal to start again.

ACK/NAK A record level protocol and the protocol most commonly used at MicroScan instrument
installations. At the end of every transmitted record block, the sender waits to receive an
ACK or NAK character before transmitting the next record.
If an ACK character or acknowledgement is received, the sender transmits the next
record. If a NAK, or any non-ACK, character is received, the sender assumes that the
receiver has detected an error in the record (via checksum analysis) and the sender
retransmits the last record.
The sender transmits an individual record up to 10 times (once for each NAK received).
If after 10 times (or 9 retransmissions) the record has not been successfully received, the
receiver should timeout. The sender also timeouts and reports the error.

IMPORTANT:
The use of ACK/NAK and checksum options is highly recommended. At least one hardware or
software flow control protocol must be implemented for communication operations to
function properly. You can select more than one hardware and/or software protocol.

CAUTION
ENQ cannot be the only protocol selected; it must be used with one or more of the other four
protocols (hardware: RTS/CTS, DTS/DTR, software: ACK/NAK or XON/XOFF). ENQ should be
used in addition to ACK/NAK.

68 LabPro Interface Implementation Guide 9020-8006, Rev. B


Configuring the data link layer

Protocol character definitions


In the data link layer for the LIS device, you can assign ASCII characters for each protocol
character definition. You can edit the protocol characters to match the receiving system.

See Device type default values (page 211) for the default control characters for each device.

NOTE:
If CR or LF are set to None, the LabPro Interface Program will not operate correctly
during communication operations.

Using of prefix and suffix characters


XON/XOFF, ACK/NAK, ENQ can be optionally transmitted with a user-defined 1-byte prefix and
up to a three-byte suffix.

For operating systems that cannot recognize single character (non-terminated) input, this feature
can be used to transmit the XON/XOFF/ACK/NAK/ENQ protocols in a record format versus a
single character format. However, the LabPro Interface only accepts/receives the XON/XOFF and
ACK/NAK protocol, during upload operations, as a single character.

VA Vista configuration
The VA Vista-LSI Interface system requires a special configuration of the data link layer. Using this
configuration enables LabPro software and the VA Vista-LSI Interface system to communicate
successfully. This configuration is not indicated for VA systems that use the Data Innovation
gateway.

9020-8006, Rev. B LabPro Interface Implementation Guide 69


Configuring the data link layer

Defining the data link layer


The procedures in this section describe how to define the data link layer.

Before defining the data link layer


Make sure:

• The device type is an LIS.

• The physical layer is defined as serial or modem.

See the user’s guide for your healthcare computer system for more information about the
appropriate configuration settings.

Procedure
To select checksums and control characters for LIS Devices:

1. Use the Configure Communication Devices window to add or edit a LabPro Interface
device. See Adding a new device (page 37) or Editing the device configurations (page 39).

2. In the Device Configuration dialog box, click Data Link.

Note that MicroScan is the default selection.

3. Click Configure.

70 LabPro Interface Implementation Guide 9020-8006, Rev. B


Configuring the data link layer

The MicroScan Data Link Layer Properties window displays.

1
2

3 4

Item Description Item Description


MicroScan Data Link Layer Properties Line Bidding and Flow Control Protocol
1 window 5 box

Data Link Layer tab Protocol Character Definitions box


2 6

Checksum Type list Use VA Vista configuration check box


3 7

Timeout Delay box


4

4. In the Checksum Type list, select the appropriate checksum type.

Valid checksum type options:


None, SUM-ASCII, SUM-HEX, XOR-ASCII and XOR-HEX.

9020-8006, Rev. B LabPro Interface Implementation Guide 71


Configuring the data link layer

5. In the Timeout Delay box, type the appropriate number of seconds.

Valid timeout delay entries:


• 15 – 999 seconds.
• 90 seconds is recommended if using modems.

6. In the Line Bidding and Flow Control Protocol box, click the appropriate check boxes.

Line Bidding and Flow Control protocol guidelines:


• Use ENQ in addition to ACK/NAK.
• ENQ cannot be the only protocol selected. Use ENQ with any of the
other four protocols (XON/XOFF, ACK/NAK, RTS/CTS, or DTR/DSR).
• If hardware flow control is used, go to the Physical Layer Properties
window and then select RTS/CTS or DTR/DSR.
• Do not make a selection if only hardware flow control is used.

7. Change the default ASCII characters to match the receiving healthcare computer system.

In the Protocol Character Definitions area, click the Lookup button on the appropriate
protocol control character and then select the ASCII value from the list.

Or, type the ASCII numerical value and press Tab to complete the entry.

8. Click the Use VA Vista configuration check box, if appropriate.

9. Click Apply to show changes.

10. Click OK to validate any changes and then close the window.
11. In the Device Configuration dialog box, click OK to save changes.

72 LabPro Interface Implementation Guide 9020-8006, Rev. B


6
Configuring the message layer
This section includes the following topics:

• Modifying data in the message layer (page 74)

• About test processing features (page 76)

• Configuring test processing features (page 77)

• Specimen tagging (page 78)

• Device filter rules in the message layer (page 82)

• Defining a device filter rule (page 86)

• Data formatting criteria in the message layer (page 88)

• Defining data formatting criteria (page 96)

• Data suppressions in the message layer (page 101)

• Defining data suppressions (page 103)

• Cross-reference tables in the message layer (page 105)

• Building cross-reference tables (page 111)

English software screen images are included in this section to identify the locations
of window components and describe tools only. Where applicable, descriptions of
these components and tools are provided in all available languages, however, the
actual screen image and text content within these screen images are only provided
in English.

9020-8006, Rev. B LabPro Interface Implementation Guide 73


Configuring the message layer

Modifying data in the message layer


This procedure describes how to define the data modification features. You can modify the
following features in the MicroScan Message Layer window Data Modifications tab.

• Test Processing (for inserting test information not received from the LIS)

• Specimen Number Tagging (for appending a tag to specimen numbers received from the
LIS).

You can configure the modification of data before it is received into LabPro software or sent to
another healthcare computer system

You can also filter data by test group. See Device filter rules in the message layer (page 82) for
more information about message filters.

Before configuring data modifications


• Check with your LIS vendor about specimen number handling.

• Determine if the oxidase reaction is transmitted by the LIS for gram-negative organisms.

• Determine if the indole reaction is transmitted by the LIS for anaerobic organisms.

• Determine if the beta hemolysis reaction is transmitted by the LIS for Streptococcacae.

74 LabPro Interface Implementation Guide 9020-8006, Rev. B


Configuring the message layer

About the Data Modifications tab

1
2
5
3

Item Description Item Description


MicroScan Message Layer window Specimen Number Tagging box
1 4

Data Modifications tab Filter button


2 5

Test Processing box


3

9020-8006, Rev. B LabPro Interface Implementation Guide 75


Configuring the message layer

About test processing features


LabPro software requires an oxidase reaction for processing conventional dried gram-negative
identification or combo panels and uses the indole reaction for processing the MicroScan Rapid
Anaerobe ID panel. Some LIS systems do not download the oxidase reaction with gram-negative
test group orders or the indole reaction with anaerobe test group orders.

When you download a conventional gram-negative combo or ID panel from your LIS system
without an oxidase reaction, LabPro software prompts you for an oxidase result before you can
print bar codes. LabPro software also prompts you in the Patient Order Entry window, if you edit
the isolate before reading the panel manually or on the auto-SCAN-4.

If your LIS does not send the oxidase reaction for gram-negative panels and you do not
want to manually enter the result, configure the device to default the oxidase reaction
to “No Test”.

When the default “No Test” is the test result, LabPro software prompts you for an oxidase result
only if the reaction is required for organism identification after the panel is processed. You can
also configure the LabPro Interface to insert the default “No Test” for the indole reaction for
MicroScan Rapid Anaerobe ID panels.

See Configuring test processing features (page 77) for more information on setting the “No Test”
defaults.

76 LabPro Interface Implementation Guide 9020-8006, Rev. B


Configuring the message layer

Configuring test processing features


To configure test processing features in the message layer:

1. Use the Configure Communication Devices window to add or edit a LabPro Interface
device. See Adding a new device (page 37) or Editing the device configurations (page 39).

2. In the Device Configuration dialog box, click Message.

3. Click Configure.

The Message Layer Properties window displays.

4. Click the Data Modifications tab.

5. In the Test Processing area, select one or both of the following check boxes:

• Default Oxidase to ‘No Test’


• Default Rapid Anaerobe Indole to ‘No Test’

9020-8006, Rev. B LabPro Interface Implementation Guide 77


Configuring the message layer

Specimen tagging
LabPro software requires that all specimen numbers be unique. The specimen number combined
with the collect date makes each number unique.

If your LIS provides specimen or accession numbers that repeat on a regular basis and the collect
date is not transmitted, you must configure the LIS interface to automatically append a non-
numeric “tag” as a suffix to all downloaded specimen numbers. The specimen tag makes each
specimen unique within the LabPro database and can be system-generated or user-defined.

Specimen tagging is LabPro device specific (you configure each LabPro Interface device with a
specific tag). When you configure a LabPro Interface device for tagging, the device receives the
specimen and appends the specified tag before LabPro software stores the specimen number.

When the same device transmits the specimen, the tag is removed. The tag is not removed if the
specimen is transmitted by another device that is not configured for tagging.

If LabPro software receives specimens from an LIS and stores the specimen numbers with tags,
consider the following when you are defining a SDLN device type:

If Then
You configure another LabPro device with The device removes the tags before sending data.
the same specimen number tagging The receiving system receives a different specimen
number than what is stored in LabPro software and the
numbers might repeat.

You configure another LabPro device The device does not remove the tags before sending.
without specimen tagging The receiving system receives the same specimen
number that is stored in LabPro software.

You configure another LabPro device with a The device removes only the defined number of tags.
different type or number of tags

CAUTION
When the number is transmitted back to the LIS, the Interface removes the number of tagged
letters defined for that device. When a specimen is transmitted via a device that is configured
for tagging (any alpha characters in the tagged position), up to the number of tags defined for
the device, are removed. This is important if the LIS sends specimens ending with alpha
characters.

78 LabPro Interface Implementation Guide 9020-8006, Rev. B


Configuring the message layer

System-defined tags
A specimen tag is a system-defined or user-defined suffix containing up to three characters.
Keep in mind; after the LabPro Interface applies the tag, the specimen number cannot exceed
20 characters. If a specimen number exceeds 20 characters, the LabPro Interface rejects the
specimen record, does not store the specimen, and an error displays in the Interface Log.

System-defined tags are alpha characters, which the device codes by year, quarter, month, week,
or day of week. The year tag assigns a letter A for the base year, which you define and increments
alphabetically for each subsequent year. Tags are appended in the order they are selected.

The LabPro Interface uses the following logic when appending tags:

Year Quarter
Base year A 1st A
Base year + 1 B 2nd B
Base year + 2 C 3rd C
Base year + 3 D 4th D
Base year + 4 E
Up to Base year + 25 Z

Month Week Day


January A July G 1-7 A Sun A
February B August H 8 - 14 B Mon B
March C September I 15 - 21 C Tue C
April D October J 22 - 28 D Wed D
May E November K 29 - 31 E Thu E
June F December L Fri F
Sat G

Example

Select a system-defined suffix in the following order: year, quarter, and week. Next, select the
base year as 2015 and today’s date is January 22, 2015 (the fourth week of the month), of the first
quarter, of the base year.

The LabPro Interface assigns the tag A for the base year; another A for the first quarter of the
year; and a D for the fourth week of the month. As a result, when the LabPro Interface receives
any specimen number during the fourth week of January 2015, the device tags a suffix of AAD.
In this example, LabPro software stores specimen # 202 as 202AAD.

9020-8006, Rev. B LabPro Interface Implementation Guide 79


Configuring the message layer

User-defined tags
User-defined tags are characters that you select. When defining a user-defined tag, you
determine the order and characters to use for the tag. The LabPro Interface can apply up to three
user-defined tags. The order in which you select the tags is the order the LabPro Interface applies
the tags.

The appropriate tag characters are:

A – Z (uppercase), :, _, ;, <, =, >, ?, \, {, }, |, ~, [, ], `, @, ^

Using tags when searching for specimen in the database


When searching for specimens in the database include the tag in your search.

Configuring specimen tagging


To configure specimen tags in the message layer:

1. Use the Configure Communication Devices window to add or edit a LabPro Interface
device. See Adding a new device (page 37) or Editing the device configurations (page 39).

2. In the Device Configuration dialog box, click Message.

3. Click Configure.

The Message Layer Properties window displays.

4. Click the Data Modifications tab.

80 LabPro Interface Implementation Guide 9020-8006, Rev. B


Configuring the message layer

5. In the Specimen Number Tagging box, click Suffix.

6. Click the Tag 1 arrow and select the appropriate tag type from the list. You can configure up
to three separate tags. You must select tags in order (Tag 1, Tag 2, Tag 3).

• If you select User-defined, type the appropriate tag in the Enter user tag text box.
• Enter one character per tag.
See User-defined tags (page 80) for more information about appropriate tag characters.

• If you select Year, type the year in the Enter Base year text box. You cannot enter a date
in the future or a date later than the current year minus 25 years.
7. Click the Tag 2 and Tag 3 arrows, if appropriate, and select the appropriate tag type from the
corresponding list.

8. Click Apply to show any changes.

9. Click OK to validate any changes and then close the window.

10. In the Device Configuration dialog box, click OK to save any changes.

9020-8006, Rev. B LabPro Interface Implementation Guide 81


Configuring the message layer

Device filter rules in the message layer


The LabPro Interface has a filtering function that you can use to ensure proper data is transmitted
to the appropriate healthcare computer system. Configure filters separately for each device.

When defining a filter, you must first select a parameter, or category and then define the
conditions for the parameter. You can select as many parameters and conditions as you wish.
By creating a filter, you are specifying what data is transmitted via each device.

Key terms

Term Definition
Filter The LabPro Interface searches and retrieves only the specific information
defined in the filter rule.
A filter consists of parameters and conditions that select specific
information from the database.

Cell Located in the Rules area of the Filter Rules dialog box, cells contain
selected parameters and defined conditions.

AND and OR labels The LabPro Interface automatically positions AND and OR labels
between and within cells in the Rules area as follows:
• AND displays between each cell
• OR displays between each parameter within a cell.
This feature helps you build a filter easily as you are not required to
insert the ANDs and ORs in the equation.

Defined Parameter A parameter is a category of information with defined conditions such as


codes or statuses. Each selected parameter must include at least one
condition to produce a filter.
You cannot repeat a parameter within the same filter rule.

Include blanks condition You can select this condition for many of the available parameters.
Selecting this option causes LabPro software to search for and include
fields that contain no information.
If you select the Include blank value, the condition always displays at the
end of the conditions for a particular parameter.

82 LabPro Interface Implementation Guide 9020-8006, Rev. B


Configuring the message layer

Parameter list
Appropriate parameters for filters display in the Select Parameters List. This list includes 15
parameters. Each parameter is available for defining specific conditions, or filtering criteria.
The following table describes the type of conditions you can set up for each parameter.

Parameter Definition
Admit Status A patient can have an admit status of inpatient, outpatient, or not
indicated (by using Include Blank Value). Use Admit Status to transmit
only inpatient or outpatient results.
If you do not use Admit Status as a parameter, then all results regardless
of patient status are transmitted.

Attending Physician/Group, You can set up filters that use these parameters for laboratories that
Institution/Group, Patient service multiple facilities or serve as regional laboratories. This ensures
Ward/Group, Requesting that only the appropriate data is transmitted to the correct healthcare
Physician/Group, Service, or system.
the Ward of Isolation /Group
You can combine these parameters within cells as OR or define between
cells as AND statements.

Isolate Status The status of an isolate can be either preliminary or final. An isolate can
have multiple test groups depending on the types of test run on the
isolate.
When all of the test groups associated with the isolate are completed,
then the isolate is updated to final.
Use the isolate status filter, for each device, to transmit only preliminary
or final results.
For example, if you only want final isolates regardless of the specimen
status, then select Isolate Status as Final. A specimen might have
isolates in different states, preliminary and final.
In this case, only the isolates that are final for the specimen are
transmitted and any preliminary isolates for the same specimen are not
transmitted.
If you do not use this status as a parameter, final and preliminary isolate
results are transmitted.

9020-8006, Rev. B LabPro Interface Implementation Guide 83


Configuring the message layer

Specimen Status The status of a specimen can be either preliminary or final.


A specimen can have multiple isolates.
When all of the isolates associated with the specimen are final,
LabPro software updates the specimen from preliminary to final.
Use specimen status as a parameter, for each device, to transmit only
preliminary or final results.
If you do not use this status as a parameter, then final and preliminary
specimen results are transmitted.

Test Group Status Use Test Group Status to select specimens and their isolates with test
groups at a particular status. Isolates can have multiple Test Groups
depending on the types of test run on the isolate.
These test groups can have different statuses: no data, ID-hold, ID/24
hour hold, 24-hour hold, MIC-hold, preliminary or completed.
Note: Preliminary status only applies to offline test groups.
The Test Group Status specifies that only a particular status is
transmitted. If an isolate has multiple Test Groups, only the Test Groups
meeting the status criteria are transmitted.
You can select multiple test group statuses.

CAUTION
If you are combining multiple test groups in a single isolate and are using the All test groups
in a single isolate record option to transmit the combined test group results, do not use
Test Group Status as a filter parameter.

84 LabPro Interface Implementation Guide 9020-8006, Rev. B


Configuring the message layer

Rules area
This area is the primary area for building your filter. As you select parameters from the list
(by placing a parameter in a cell), you can also select associated conditions from the Conditions
area (at the right of the Rules area). As you select parameters, the conditions for each parameter
display in the Conditions area.

Depending on how you want to define a filter, a cell can contain one or multiple parameters.

When you build a filter, note that ANDs display between cells and ORs display between multiple
parameters within a cell.

You can add blank cells and then position parameters in these cells as required. Adding blank
cells requires you to copy and paste parameters into a cell. Or, you can select parameters.
LabPro software automatically creates cells as needed (depending on the method you use to
select the parameter).

Conditions area
When you focus on a parameter in a cell (indicated in blue text), the corresponding condition
pane displays in the Conditions area in the lower-right corner of the Filter Rules dialog box.
As you select conditions for that parameter, the condition displays (in abbreviated form) under
the appropriate parameter in the Rules area.

9020-8006, Rev. B LabPro Interface Implementation Guide 85


Configuring the message layer

Defining a device filter rule


This procedure describes how to define a device filter rule.

Before defining a filter


• Customize the code tables in LabPro software.

• Create and configure the LabPro Interface device.

Procedure
To define a filter rule in the message layer:

1. Use the Configure Communication Devices window to add or edit a LabPro Interface
device. See Adding a new device (page 37) or Editing the device configurations (page 39).

2. In the Device Configuration dialog box, click Message.

3. Click Configure.

The Message Layer Properties window displays.

4. Click the Data Modifications tab.

5. Click Filter.

86 LabPro Interface Implementation Guide 9020-8006, Rev. B


Configuring the message layer

The Filter Rules–Edit dialog box displays.

2 3

Item Description

1 Parameters area

2 Rules area

3 Conditions area

6. Select a parameter using one of these methods:

• Click and drag. Click and drag a parameter to the first cell in the Rules area.

Note that one blank cell is always available when you build the filter.

Continue by clicking and dragging a parameter to the same cell or to an open area below
the first cell. Each time you click and drag a parameter to the open area, LabPro software
creates a new cell for your selected parameter.

• Double-click: Double-click a parameter in the Parameters list and LabPro software


positions that parameter in a selected cell in the Rules area.

9020-8006, Rev. B LabPro Interface Implementation Guide 87


Configuring the message layer

If no cells exist in the Rules area, click and drag a parameter to the Rules area, LabPro
software positions that parameter in a newly created cell.

You can right-click a cell and then Add, Clear or Delete a cell, or Delete, Copy, Cut and
Paste parameters. You cannot delete the original cell located at the top of the Rules area.

7. Continue to select parameters as needed and define conditions.

8. Click Save.

Data formatting criteria in the message layer


Healthcare computer systems expect to receive data in a specific format.

The transmission format includes:

• Type of delimiters

• Organism name

• Sort order of the data for transmission

• How to transmit the interpretations

• How combined test groups are transmitted

• Date and time

88 LabPro Interface Implementation Guide 9020-8006, Rev. B


Configuring the message layer

Use the Data Formatting tab in the MicroScan Message Layer Properties window to define
the data formatting criteria.

1
2

5 10

7
11
8

Item Description Item Description


MicroScan Message Layer Properties Transmission of Interpretations box
1 window 7

Data Formatting tab Transmission of Results for Combined Test


2 8 Groups box

Site Name, (Define) Field Delimiter, and Transmit with Leading Zeros box
3 (Define) String Delimiter fields 9

9020-8006, Rev. B LabPro Interface Implementation Guide 89


Configuring the message layer

Item Description Item Description


Use string delimiter check boxes (to Date Format box
4 enable the defined string delimiter) 10

Organism Name Format box Time Format box


5 11

Transmission Sort Order box


6

See the following topics for more information about the window options.

Site name
You can specify a site name up to 40 characters long. The LabPro Interface transmits the site
name as part of the header record and prints the site name on the Configuration Report.

Messages and records


The LabPro Interface transmits data by sending messages to another healthcare computer system
and receives messages from an LIS. Messages are a series of records that usually start with a
Header Record (H) and end with an End Record (L).

A record is a subdivision or subsection of a message and consists of a string of characters starting


with an identifier, which is a capital ASCII alphabet character (A to Z) and ending with a carriage
return and line feed.

There are different record types (for example, patient, specimen, isolate, test/MIC, comment, and
free text). Records are divided into fields separated by delimiters.

A field is a group of characters that define a specific piece of information within a record, such as
a patient’s name, patient ID number, ward, or date of birth.

90 LabPro Interface Implementation Guide 9020-8006, Rev. B


Configuring the message layer

Delimiters
A delimiter is an ASCII character that separates pieces of data and tells the receiving system how
to parse the data.

• Field Delimiter. A single character that separates adjacent fields in a record.


Field delimiters are required and should never be set to None. If a field delimiter is not set
correctly, the LabPro Interface cannot parse and store the data in the database.

• String Delimiter. A single ASCII character that distinguishes the data within a field.
String delimiters allow data that might contain a field delimiter to transmit without errors.

For example, if a comma ‘,’ is the field delimiter then do not use a comma ‘,’ in any field or
text transmitted, unless you use string delimiters.

The field and string delimiters use ASCII characters 1 to 126, but cannot be the same
character.

The following example shows an abbreviated patient record containing 10 fields.


Field 6 of the ‘P’ record is the date of birth. The field delimiter in this example is a comma (,)
and the string delimiter is double quotation mark (").

"P","Field 2","4215689","Doe","John","2001-01-26","","","","Field 10"[CR][LF]

The first field is the record Patient date of birth


identifier field

9020-8006, Rev. B LabPro Interface Implementation Guide 91


Configuring the message layer

This format uses the following types of delimiters (these delimiters are all required and should
not be set to None).

Delimiter type Description


Field Delimiter A single character, excluding <CR>, that is used to separate adjacent fields in
a record.

Repeat Delimiter A single character, excluding <CR> and the field delimiter value, that is used
to separate a number of descriptions belonging to the same group in a field.

Component A single character, excluding <CR> and the field and repeat delimiter values,
Delimiter that is used to separate data elements of fields of a hierarchical or qualifier
nature, for example the components of a street address.

Escape Delimiter A single character, excluding <CR> and the field, repeat, and component
delimiter values, that is used within a text field to signify special case
operations.
In the following message header, you will see the Field Delimiter is set to bar
( | ), the Repeat Delimiter to ( \ ), the Component Delimiter to ( ^ ), and the
Escape Delimiter to ( & ).
1H||\^&|||LabPro^4.40|||||||P|LIS2-A

NOTE:
Do not use alphanumeric characters as delimiters. They typically appear within field
content and (in some cases) have special uses.

Organism name format


Use the Data Formatting tab on the MicroScan Message Layer Properties window to select to
transmit the organism name with the long, formal name (Escherichia coli), or the short description
(E. coli).

Japan Devices send the organism code only.

Transmission Sort Order


The Transmission Sort Order determines the order the LabPro Interface transmits a message to
the other healthcare computer system.

If you select Patient ID as the sort order, when a patient has more than one specimen in a given
transmission the patient record is sent only once followed by all the specimen records associated
with the patient.

If you select Specimen Number as the sort order, then when a patient has more than one
specimen in a given transmission the patient record repeats with each specimen record

92 LabPro Interface Implementation Guide 9020-8006, Rev. B


Configuring the message layer

Transmission of Interpretations
There are three types of interpretations:

• Systemic

• Urine

• User-defined

The LabPro Interface uses three separate fields for transmitting interpretations:

• Systemic interpretation field

• Urine interpretation field

• User-defined (offline) interpretation field

When you test a urine source on a MicroScan test group/panel, LabPro software generates two
interpretations: urine interpretations and systemic interpretations; however, LabPro software does
not display the systemic interpretations for a urine source, but stores them internally.

If you test a systemic source on a MicroScan test group/panel, LabPro software displays the
systemic interpretations. LabPro software generates user-defined interpretations for user-defined
test.

The LabPro Interface transmits interpretations in two ways.

• Each Interpretation in separate fields. For urine sources, the LabPro Interface transmits
urine interpretations in the urine interpretation field and systemic interpretation in the
systemic interpretation field of the test/MIC record.

For systemic or non-urine sources, the LabPro Interface transmits the interpretations in the
systemic interpretation field. The LabPro Interface transmits user-defined (offline)
interpretations in the user-defined (offline) interpretation field.

Select Each Interpretation in separate fields, if the receiving healthcare computer system
accepts the separate interpretation fields.

• Appropriate interpretation in systemic field. The LabPro Interface transmits the urine and
user-defined interpretation in the systemic interpretation field, does not transmit the
systemic interpretation on urine sources and repeats the user-defined interpretation in the
user-defined interpretation field.

Select Appropriate interpretation in systemic field, if the receiving healthcare computer


system only accepts interpretations in the systemic interpretation field.

9020-8006, Rev. B LabPro Interface Implementation Guide 93


Configuring the message layer

Transmission of isolate results for combined test groups


An order can consist of either one test group or multiple test groups. A test group is a MicroScan
panel, test or user-defined tests. The LabPro Interface transmits one order record followed by all
test/MIC records for all the combined test groups.

IMPORTANT
If you order more than one test group on an isolate, it is important to specify how the LabPro
Interface transmits these results to ensure that data is received correctly and not overwritten
on the receiving system.

Testing multiple test groups on one isolate


You can test multiple test groups on one isolate by:

• Combining a MicroScan combo panel with a user-defined test group or groups.

• Combining a MicroScan ID only test group/panel with a MicroScan MIC panel and/or a
user-defined test group or groups.

• Combining a MicroScan MIC panel with a user-defined test group or groups.

• Combining two or more user-defined test groups.

When you send results to another healthcare computer system, the LabPro Interface transmits
the isolate record, which contains the test group and organism information followed by the
corresponding test/MIC records, which contain the MICs and interpretations for the drug test.
LabPro Interface transmits one test/MIC record for each drug test.

See Messages and records (page 90) for more information.

Transmission of combined test groups


The LabPro Interface transmits results of combined test groups in one of two ways.

• Each test group in separate isolate records. LabPro Interface transmits a separate isolate
record for each test group. The corresponding test/MIC records follow each isolate record.
Therefore, the number of isolate records transmitted corresponds to the number of test
groups ordered.

• All test groups in a single isolate record. LabPro Interface transmits only one isolate record
followed by all the test/MIC records for all the combined test groups.

CAUTION
When using this option, do not use Test Group Status as a filter parameter.

94 LabPro Interface Implementation Guide 9020-8006, Rev. B


Configuring the message layer

When you enable the option All test groups in a single isolate record, the following logic
determines how LabPro Interface transmits the results to another healthcare computer
system.

LabPro Interface transmits in


the test group fields of the LabPro Interface transmits the
Combined Test Groups isolate (R) record: associated test/MIC record:
ID only test group/panel + MIC panel code, description and MIC panel drug test results.
MIC panel test group status date.

ID only test group/panel + ID panel code, description, and test Offline drug test results for all
offline test groups group status date. offline test groups.

ID only test group/panel + MIC panel code, description, and MIC panel drug test results
MIC panel + offline test test group status date. followed by the offline drug test
groups results for all offline test groups.

Combo panel + offline test Combo panel code, description, Combo panel drug test results
groups and test group status date. followed by results for all offline
test groups.

MIC panel + offline test MIC panel code, description, and MIC panel drug test results
groups test group status date. followed by results for all offline
test groups.

Multiple offline test groups Code, description, and test group Offline drug test results for all
status date for one of the offline offline groups.
test groups ordered.

Transmit with leading zeros


The LabPro Interface transmits the isolate number in the same format that is stored in the
database. Some laboratory information systems send a single digit isolate number to LabPro but
expect to receive a two digit or a leading zero on the isolate number.

For example, the LIS sends isolate number 1 to LabPro, but when the LabPro Interface transmits
the results back, the LIS expects to receive the isolate number as 01.

When you enable this option, LabPro Interface transmits all isolate numbers 0 through 9 with a
leading zero. LabPro does not add a leading zero to isolate numbers with two or more digits.
For example, an isolate number stored in LabPro as 1 is transmitted as 01; an isolate number
stored as 10 is transmitted as 10.

9020-8006, Rev. B LabPro Interface Implementation Guide 95


Configuring the message layer

Date and time format


Check the receiving system to determine what Date Format and Time Format to use.

• The date format options for all devices are YYMMDD, YYYYMMDD, DDMMYY, DDMMYYYY,
MMDDYY, and MMDDYYYY.

• The time format options for most devices are HHMMSS 24 Hours, HHMMSS AM/PM, HHMM
24 Hour or HHMM AM/PM. Both date and time formatting include the selection of
delimiters.

The date and time format must match on both the sending and receiving systems. This date and
time format is only for transmissions and may differ from what is customized in LabPro.

Defining data formatting criteria


This procedure describes how to define data formatting criteria.

Before selecting data formatting options


• Check the user’s guide for the other healthcare computer system for the proper data
formatting guidelines.

• Refer to the user’s guide for the other healthcare computer system to determine what
delimiters are used.

• Determine if the other healthcare computer system expects string delimiters in a null or blank
field.

• Determine if the other healthcare computer system expects string delimiters in a single
character field. A single character field is defined as a field that can only contain one
character, such as Y or N.

• If LabPro orders consist of more than one test group, determine the best method for
transmitting the results.

• Determine if short or long organism name is expected.

• Refer to the user’s guide of the reciprocal system to determine what date and time format is
used.

• Determine if the other healthcare computer system sends single digit isolate numbers
without a leading zero but expects to receive a single digit isolate number with a leading
zero.

96 LabPro Interface Implementation Guide 9020-8006, Rev. B


Configuring the message layer

Procedure
To define data formatting criteria for an LIS Device:

1. Use the Configure Communication Devices window to add or edit a LabPro Interface
device. See Adding a new device (page 37) or Editing the device configurations (page 39).

2. In the Device Configuration dialog box, click Message.

3. Click Configure.

The Message Layer Properties window displays.

9020-8006, Rev. B LabPro Interface Implementation Guide 97


Configuring the message layer

4. Click the Data Formatting tab.

5. In the Site Name box, type the name of your facility.

Site Name guidelines


The Site Name can be up to 40 characters, is transmitted in the header record, and
displays on the Interface Configuration Report.

6. Click the Field Delimiter lookup button and then click the appropriate delimiter.

Or, type the ASCII number and press the Tab key to complete the entry.

Field Delimiter guidelines


The field delimiter is a required field and must be a different character than the
string delimiter.

98 LabPro Interface Implementation Guide 9020-8006, Rev. B


Configuring the message layer

7. Click the String Delimiter lookup button and then click the appropriate delimiter.

Or, type the ASCII number and press the Tab key to complete the entry.

String Delimiter guidelines


The string delimiter must be different from the field delimiter.
If string delimiters are not used in the reciprocal system, click None.

8. Select the Use string delimiter in null fields check box, if the reciprocal system expects
delimiters transmitted when a field is null.

Consider this option only if you use string delimiters.

9. Select the Use string delimiter in single character fields check box, if the reciprocal system
expects a field with a single character to be transmitted with delimiters.

Consider this option only if you use string delimiters.

10. In the Organism Name Format box, click the appropriate organism name format.
11. In the Transmission Sort Order box, click the appropriate transmission sort order.
12. In the Transmission of Interpretations box, click the appropriate transmission of
interpretations.

13. In the Transmission of Results for Combined Test Groups box, click the appropriate
selection.

This option applies only to those facilities that test more than one test group in a LabPro
order or per isolate.

14. In the Transmit with Leading Zeros box, click the Isolate number check box.
This option applies only if the reciprocal system expects to receive a leading zero on single
digit isolate numbers.

15. Click the Date Format arrow and then click the appropriate date format for sending and
receiving data.

The LabPro Interface date and time format is for the LabPro Interface only and might be
different from what is displayed or printed in LabPro software.

16. Click the Date Delimiter arrow and then click the appropriate date format delimiter.
If the reciprocal system does not use date delimiters, click None.

17. Click the Time Format arrow and then click the appropriate time format for sending and
receiving data.

18. Click the Time Delimiter arrow and then click the appropriate time format delimiter.

9020-8006, Rev. B LabPro Interface Implementation Guide 99


Configuring the message layer

If the reciprocal system does not use time delimiters, click None.

19. Click Apply to show any changes.


20. Click OK to validate any changes and then close the window.
21. In the Device Configuration dialog box, click OK to save any changes.

100 LabPro Interface Implementation Guide 9020-8006, Rev. B


Configuring the message layer

Data suppressions in the message layer


This topic describes data suppression in the message layer.

You can suppress certain records or data elements from transmitting to another healthcare
computer system.

NOTE
Specific data records might be suppressed by default (for example, Isolate Trace Record).
For instances of default suppressed data, you can un-suppress this data as needed.

Data suppression is based on a record hierarchy. In each area the highest record of the hierarchy
is listed first: Patient Record, Specimen Record, Isolate Record and Drug Test Record.

The underlying entries are either fields in the highest record, or associated records transmitted
with the highest record. For example, the patient record area contains individual fields: first/last
name, service description, attending physician description, patient ward description, and
institution description.

The patient comment and the patient free text records are associated records that transmit with
the patient record. If you suppress the highest record in the area, all underlying descriptions and
records are suppressed.

Descriptions are actually fields within the record. When you suppress the description, the LabPro
Interface still transmits the code. For example, if you suppress patient ward description, the
patient ward code transmits but not the description.

When to suppress data


• Suppress MICs when the LIS accepts only interpretations from LabPro. You can choose to
suppress MIC values for:

– Standard panels, which include MicroScan Pos and Neg Combo or MIC panels and
user-defined (offline) tests.
– MicroScan Pos and Neg breakpoint panels.
– All panels by selecting both options.
• Suppress interpretations when your LIS performs the interpretation of the MIC values.

• Suppress the ‘=’ sign from the MIC value when the MIC field on the LIS is limited or the LIS
does not accept the “=” sign.

The following MIC values are nine characters in length. Suppressing the “=” sign will truncate
the value to eight characters. <=.12/.06, <=.25/.12, <=0.5/.25, <=.06/1.2, <=.12/2.4, <=.25/
4.7, <=0.5/9.5.

• Suppress Non-Reportable Test Records when you do not want to transmit suppressed or
non-formulary drug tests.

9020-8006, Rev. B LabPro Interface Implementation Guide 101


Configuring the message layer

• The Isolate Trace Record is suppressed by default. If you un-suppress the Isolate Trace
Record, the datastream will contain a Q record. Confirm that the Q record has been
implemented by your LIS vendor before you un-suppress this record.

Data that is not transmitted with data suppression


The following table lists data that is not transmitted when certain records are suppressed.

When you suppress The LabPro Interface does not transmit


Header Record The header record.

Patient record All records and fields in the patient record area, which includes any listed
fields or records.

Specimen record All records and fields in the specimen record area, which includes any listed
fields or records.

User-defined test group The isolate records containing the user-defined test group as well as the
record user-defined drug test records.

Isolate record All the records and fields in the isolate record area, along with the drug test
records.

Comment record The reportable and non-reportable comment records.

Non-Reportable Test Results for antimicrobics that have been suppressed or removed from the
Records Formulary.

End Record The end record. LabPro sends an <EOT> to end transmission.

Synergy Interpretations The streptomycin and gentamicin synergy screen interpretation results in the
isolate record.

Synergy test records The streptomycin and gentamicin synergy screen results as drug test
records.

Trace Record The isolate to instrument trace records.

102 LabPro Interface Implementation Guide 9020-8006, Rev. B


Configuring the message layer

NOTE:
LabPro Interface transmits the gentamicin and streptomycin synergy screen results in the
isolate record and as drug test records. The isolate record contains the synergy interpretations;
the drug test record contains the MIC value and interpretation.

• To suppress synergy screen results from transmitting to another healthcare computer


system, either build a drug suppression rule in LabPro software and suppress
Non-Reportable Test Records or suppress both Synergy Interpretations in the isolate record
area and Synergy Test Record in the drug test record area.
• To transmit synergy screen results in only the isolate record, suppress Synergy test records
in the drug test record area.
• To transmit synergy screen results only as a drug test record, suppress Synergy
Interpretations in the isolate record area.

Defining data suppressions


This procedure describes how to select data suppression criteria.

Before configuring data suppressions


Check with the other healthcare computer system for the appropriate records or fields to
suppress.

Procedure
To define data suppressions:

1. In the Device Configuration dialog box, click Message.

2. Click Configure.

9020-8006, Rev. B LabPro Interface Implementation Guide 103


Configuring the message layer

The Message Layer Properties window displays.

3. Click the Data Suppressions tab.

1
2

3 6
4 7

5 8

Item Description Item Description


MicroScan Message Layer Properties Isolate Records
1 window 5

Data Suppression tab End Record


2 6

Header Record Specimen Records


3 7

Patient Records Drug Test Records


4 8

4. Select check boxes to suppress specific records or fields.

• To suppress an entire category of records, select the category check box


(for example, select the Patient Record check box).
• To suppress individual records, select the specific check box, (for example, select the
Organism Description check box).

104 LabPro Interface Implementation Guide 9020-8006, Rev. B


Configuring the message layer

5. Click OK and then close the window.

6. In the Device Configuration dialog box, click OK to save any changes.

Cross-reference tables in the message layer


Many laboratory systems and instruments use the concept of coded data elements.
LabPro software includes pre-defined (system-defined) and customer-defined (user-defined)
data elements.

LabPro software data elements


Pre-defined (system-defined) Customer-defined (user-defined)
Drug tests Wards

Organisms Sources

Interpretations Patient comments

MIC values Specimen comments

Test groups Isolate comments

Admit status Physicians

Gender Services

Institutions

Tech ID

The customer can also create additional entries to the drug test, organism, and test group tables.

The cross-referencing function enables data element codes defined in LabPro software to be
associated with the healthcare computer system’s data element codes and vice versa.

If the code is exactly the same on both systems, cross-referencing is not required.
Each data element can be selected individually for cross-referencing.

When to use cross-referencing


Use cross-referencing when codes are transmitted between LabPro software and another
healthcare computer system and:

• You prefer to use a different code in LabPro software than the code used in the other
healthcare computer system.

• The code from another healthcare system differs from LabPro code. This also includes
uppercase to mixed case. All LabPro codes are uppercase.

• LabPro software receives codes from another healthcare system that exceed eight characters.

9020-8006, Rev. B LabPro Interface Implementation Guide 105


Configuring the message layer

• The other healthcare system expects only numeric codes and non-numeric codes exist in the
LabPro customization tables.

• The other healthcare system expects codes less than 8 characters.

• The other healthcare computer system does not accept a drug test result without an
interpretation. You can cross-reference a blank LabPro interpretation to an appropriate value
accepted by the other healthcare computer system.

• You are associating multiple values to a single value rather than strictly one-to-one
correspondence. The customer can associate several healthcare computer system codes with
a single LabPro code for use during receiving operations, or associate several LabPro codes
to a single healthcare computer system code for use during sending operations.

Cross-reference table rules


The following rules apply to the cross-reference tables:

• LabPro codes are one to eight characters in length and all are uppercase.

• Healthcare computer system codes may be up to 32 characters long and in mixed case.

• It is also possible for the customer to cross-reference a LabPro code to null, or a healthcare
computer system code of null to a specific LabPro code.

• Each cross-reference table should contain all data values that apply to a particular data
element, where the code is different between LabPro software and the healthcare computer
system.

• For each data value, the table contains the LabPro code and description plus its
corresponding healthcare computer system code.

• If a data value is cross-referenced, all occurrences of that data value are cross-referenced in
all records in which that data value displays. For example, if ward codes are cross-referenced,
then the patient and specimen records are affected since they each contain a ward code field.

• If string delimiters are used, the LabPro Interface considers all codes as alphanumeric text
and includes string delimiters in the transmission for each value. The customer can selectively
set a data element to a numeric data type, so that string delimiters are not transmitted.
Numeric data fields contain only the following characters: 0 to 9 and + or – as the first
character.

106 LabPro Interface Implementation Guide 9020-8006, Rev. B


Configuring the message layer

How cross referencing works


When a code is received in LabPro software, LabPro software searches the appropriate
cross-reference table.

• If an exact match is found, the associated LabPro code is saved.

• If a match is not found, the system searches for a match in the respective data element
customization table.

• If an exact match is found, the data is saved in the LabPro database.

• If no match is found in either table, the data item is not saved and a “code not found”
error message displays in the Interface Log.

This error message can be suppressed if you are using an LIS Device type.

Example

The following example shows two cross-reference tables (source and physicians). The code for
Dr. Paul Davis is PD1 in the LabPro database and PDavis in the LIS database. When both systems
transmit the physician code for Paul Davis, the cross-reference table converts PD1 to PDavis
when sending from the LabPro Interface to the LIS. The cross-reference table converts PDavis to
PD1 when receiving from the LIS to LabPro software.

Cross-reference tables are specific for each device. Therefore, if you have more than one device
type, you need to build appropriate cross-reference tables for each device.

See Tips for cross-referencing to LIS (page 235) for more information on building cross-reference
tables when transmitting to an LIS.

9020-8006, Rev. B LabPro Interface Implementation Guide 107


Configuring the message layer

Send/Receive modes
There are two modes for cross-referencing:

• Send (from LabPro Interface)

• Receive (to LabPro software)

Using send mode

Use the Send mode to convert a LabPro code to a code that is transmitted to another healthcare
computer system. For example, in LabPro software, three organism codes (1, 51 and 851)
represent three biotypes of E. coli. However, the LIS might have only one code (ECOLI). You can
build a cross-reference to transmit the organism code ECOLI to the LIS, in place of 1, 51 and 851.

Using receive mode

Use the Receive mode to convert a code transmitted from an LIS to a LabPro code.
For example, if the LIS sends multiple codes for a single source in LabPro software, build a cross-
reference table to convert the incoming codes from the LIS to a single code in LabPro software.

Examples

The following examples show the use of the Receive and Send modes. The Device Code column
represents the code that is sent or received from the other healthcare computer system.
The LabPro Code and LabPro Description columns represent what is sent or received in
LabPro software.

Receive Mode converts the code from the LIS to a LabPro code.

Device Code LabPro Code LabPro Description


LEFT EAR EAR Ear

RIGHT EAR EAR Ear

EYE CULTURE EYE Eye

Send Mode converts the LabPro code to the other healthcare computer system code.

LabPro Code LabPro Description Device Code


1 E. coli ECOLI

51 E. coli LYS-ORN ECOLI

851 E. coli ECOLI

586 E. coli O157:H7 ECOLIO157

108 LabPro Interface Implementation Guide 9020-8006, Rev. B


Configuring the message layer

Data elements that can be cross-referenced


The following list identifies data elements that can be cross-referenced.

Physician codes include:

• Attending and requesting physicians

• Ward codes (ward of isolation and patient ward)

• Tech codes (isolate and specimen tech)

Available (X)
Available data elements for cross-referencing
Send Receive
Admit Status Codes X X

Drug Test Codes X

Gender Codes X X

Institution Codes X X

Interpretation Values X

Isolate Comment Codes X X

MIC Dilutions X

Organism Codes X X

Patient Comment Codes X X

Physician Codes X X

Service Codes X X

Source Codes X X

Specimen Comment Codes X X

Tech ID Codes X X

Test Group Codes X X

Ward Code X X

Data elements that cannot be cross referenced


The LabPro Interface does not receive drug test codes, interpretations, or MIC values.
Cross-referencing is not available in the receive mode for these three data elements.

9020-8006, Rev. B LabPro Interface Implementation Guide 109


Configuring the message layer

Numeric only
The Numeric Only option is for sending only and is only applicable if you are using string
delimiters. Use the Numeric Only option, when the other healthcare computer system expects a
numerical code without string delimiters.

The device code must be in whole numbers (0 – 9) and can include one of the following
characters:

• a minus sign (-) to designate a negative number.

• a positive sign (+) to designate a positive number.

• a decimal point (.) along with a whole number.

If you select this option, all codes in the selected LabPro customization table must be a numeric
code or cross-referenced to a numeric device code. If not, an error might occur on the receiving
system.

IMPORTANT:
If you build the cross-reference table before selecting the Numeric Only option, the LabPro
Interface gives a warning that all non-numeric entries will be deleted from that cross-
reference table. Also any non-numeric codes in the selected LabPro customization table
that are not cross-referenced to a numeric code are not transmitted.

Cross-Reference Tables area


Appropriate tables for cross-referencing along with the Numeric Only option display in the
Cross-Reference Tables area. The list of tables is dependent upon the mode:

• The Send mode lists 16 tables.

• The Receive mode lists 13 tables.

Build area
This area is the focal point for building your cross-reference tables. When the focus is in the build
area, you can type in your entry or select from the LabPro code list or the LabPro Description list.

You can also sort the entries by clicking on the column headings (LabPro Code, LabPro
Description or Device Code) as you build your cross-references, the auto-sort function sorts the
entries by the selected column.

110 LabPro Interface Implementation Guide 9020-8006, Rev. B


Configuring the message layer

Building cross-reference tables


This procedure describes how to build cross-reference tables and edit and delete cross-reference
table entries.

Before building your cross-reference tables


• Check the user’s guide for the other healthcare computer system for the proper cross-
reference guidelines. Some laboratory information systems require certain data elements to
be cross-referenced on their system and certain data elements in LabPro software.

• Print out the codes from the other healthcare computer system and compare them with the
codes in LabPro software. Determine which codes are transmitted between your reciprocal
system and LabPro software and need cross-referencing.

• Determine if cross-referencing is for sending or receiving.

See Tips for cross-referencing to LIS (page 235) for a list of panel and drug test codes.

See Setup and installation tables (page 215) for tables listing all pre-defined LabPro
customization tables for organisms, test groups, drug tests, MIC dilutions, interpretations,
gender, admit status, additional test results, and synergy screen interpretation results.

Procedure
To build cross-reference tables:

1. In the Device Configuration dialog box, click Message.

2. Click Configure.

The Message Layer Properties window displays.

9020-8006, Rev. B LabPro Interface Implementation Guide 111


Configuring the message layer

3. Click the Cross Referencing tab.

2
3

4
5

Item Description Item Description


MicroScan Message Layer Properties Cross reference tables list
1 window 4

Cross Referencing tab LabPro Code and Description box


2 5

Send and Receive buttons


3

4. In the Cross-Reference Tables list, click the appropriate data element.

5. Choose one of the following actions:

• Click Send to cross-reference codes transmitted to another healthcare computer system.


If you select Send, multiple LabPro codes can be cross-referenced to one Device Code.
• Click Receive to cross-reference codes received from another healthcare computer
system. If you select Receive, multiple Device Codes can be cross-referenced to one
LabPro code.
6. Select the Numeric Only check box, if appropriate.

112 LabPro Interface Implementation Guide 9020-8006, Rev. B


Configuring the message layer

When you select Numeric Only, you can only enter device codes with these characters: +, -,
0-9 and a decimal point. All codes in the selected LabPro customization table, if not cross-
referenced, should be numeric.

7. Click in the build area. Arrows appear in the LabPro Code and LabPro Description cells.

8. In the LabPro Code or LabPro Description box, click the LabPro Code or LabPro
Description arrow and then click an item in the associated table.

Or, type the code or description. The LabPro code and description displays as an entry in the
grid.

NOTE:
When cross-referencing Interpretations, you can select <<null>> from the code list.

9. In the Device Code box, type up to 32 characters for the device code, or press Tab to leave
the device code blank.

LabPro software automatically builds the reciprocal entry. If you build multiple to one
cross-references, LabPro software automatically builds the reciprocal cross-reference for the
first entry.

When the device code is left blank, <<null>> displays in the Device Code cell.

10. Press Insert to go to a new line. Complete all entries for the selected data element.

About sorting table entries


You can sort the table entries in ascending or descending order by Device Code,
LabPro Code or LabPro Description.
Click the column heading to determine the sort order. The table entries
automatically sort as you enter data.

11. Click another data element to build another cross-reference table. Repeat steps 4 through 9
until completed.

12. Complete one of the following actions:


• To save changes and return to the Device Configuration dialog box, click OK.
• To close the window without saving changes, click Cancel. Canceling does not affect any
applied changes.
13. In the Device Configuration dialog box, click OK.

9020-8006, Rev. B LabPro Interface Implementation Guide 113


Configuring the message layer

Deleting a cross-reference entry


To delete a cross-reference entry:

1. In the Message Layer Properties window, click the Cross-Reference tab.

2. Click the data element in the Cross-Reference Tables list.

3. Click Send or Receive.

4. Right-click any cell for the entry you want to delete and then click Delete on the menu.

A confirmation message displays.

5. In the confirmation dialog box, click OK.

NOTE:
If multiple codes are cross-referenced to a single code, check the reciprocal table to
ensure all entries are deleted.

6. Click OK to validate and return to the Device Configuration dialog box.

7. In the Device Configuration dialog box, click OK to save any changes.

Editing a cross-reference entry


To edit a cross-reference entry:

1. In the Message Layer Properties window, click the Cross-Reference tab.

2. In the Cross-Reference Tables list, click the data element.

3. Click Send or Receive.

NOTE:
You can only edit the LabPro Code in the Receive mode and the Device Code in the
Send mode.

4. Complete one of the following actions:

• To edit a LabPro Code in the Receive mode, click the LabPro Code or LabPro
Description arrow and then click an item in the associated table.
Or

Type the appropriate code or description in the LabPro Code or LabPro Description box.

• To edit a Device Code in the Send mode, click in the Device Code cell and then type the
appropriate code.

114 LabPro Interface Implementation Guide 9020-8006, Rev. B


Configuring the message layer

5. Click OK to validate.

6. In the Device Configuration dialog box, click OK to save any changes.

NOTE:
If multiple codes are cross-referenced to a single code, check the reciprocal table.
You might need to delete and re-enter any entries that were not updated.

9020-8006, Rev. B LabPro Interface Implementation Guide 115


This page intentionally left blank

116 LabPro Interface Implementation Guide 9020-8006, Rev. B


7
Automatic communication features
This section includes the following topics:

• Auto-Transmit (page 118)

• Auto-Request (page 127)

• Auto-Monitor (page 130)

English software screen images are included in this section to identify the locations
of window components and describe tools only. Where applicable, descriptions of
these components and tools are provided in all available languages, however, the
actual screen image and text content within these screen images are only provided
in English.

9020-8006, Rev. B LabPro Interface Implementation Guide 117


Automatic communication features

Auto-Transmit
This topic describes the Auto-Transmit feature and provides a procedure configuring
auto-communication for sending data.

You can configure a device to automatically transmit data to another healthcare computer
system. You can configure multiple devices for auto-transmit. If this is done and more than one
device is configured to the same port, select an appropriate time interval that prevents conflict
with another device.

Consider your workflow when selecting auto-transmission times and determine the times or
intervals the transmissions will occur. If the majority of panels are completed at a certain time
each day, consider setting that time for auto-transmission. If your panels are completed in
batches throughout the day, consider setting multiple times for auto-transmission.

When configuring for auto-transmission, select data by using one of several different criteria or
search types. For example:

• Admission number

• Range of collect dates

• Patient ID numbers

• Specimen numbers

• Specimen status dates

• Isolate status dates

• Test group status dates

You can choose to search for only active specimens or to search the entire database. You can also
choose to not transmit data that was previously sent. After the LabPro Interface searches the
database, the defined filter is applied.

See Device filter rules in the message layer (page 82) for more information.

118 LabPro Interface Implementation Guide 9020-8006, Rev. B


Automatic communication features

About the Configure Automatic Transmit/Request window

2 3

Item Description Item Description


Configure Automatic Transmit/Request Search type and criteria tools
1 window 4

Auto-Transmit box. Auto-Request box.


2 5
Use these tools to Enable/disable auto- Use these tools to Enable/disable auto-
transmit, specify, and select auto- request. specify, and select auto-request
transmit times. times.

View Filter button.


3
Click this button to view the filter rule
criteria.

These options are described in detail in the following topics.

9020-8006, Rev. B LabPro Interface Implementation Guide 119


Automatic communication features

Next send time


After you configure Auto-Transmit, the Configure Communication Devices window and the
Interface Monitor display the next time a transmission occurs for that device under the heading
Next Send Time.

Enabling and disabling Auto-Transmit


You can enable or disable Auto-Transmit at any time. When you disable Auto-Transmit, LabPro
software retains, but ignores, the selected times and search criteria.

Selected times
Auto-transmissions occur at the times you specify.

If you schedule multiple device at the same time for Auto-Transmit, LabPro software queues the
transmissions at the scheduled times and starts transmitting in the order queued.

You can view the queued transmissions in the Interface Queue. LabPro software displays the next
scheduled transmission time on the Interface Monitor and the Configure Communication
Devices window.

Search type and criteria


Before transmitting data, the LabPro Interface must find the specimens in the LabPro database.
In the Configure Automatic Transmit/Request window, you can specify the data to transmit.

The following table describes the search criteria.

Search type and criteria


Search type Function
Admission # Locates patient data by a single or multiple admission numbers.
This option is useful if you have multiple devices and specific admission
numbers are sent to each healthcare system.

Collect Date Locates specimens that were collected within the specified date range based
on the date of transmission.

Isolate Status Date Locates the most recent date the isolate status changed. Isolate status can be
either preliminary or final.
If you define a filter for the device and the filter specifies an isolate status
(for example, final), then the LabPro Interface only searches for final isolate
results that are within the specified date range.
If you do not define a device filter, or the filter does not specify an isolate
status, the LabPro Interface searches all isolates regardless of status within the
specified date range.

120 LabPro Interface Implementation Guide 9020-8006, Rev. B


Automatic communication features

Search type and criteria (continued)


Search type Function
Patient ID Locates patient data by a single patient ID, a range, or multiple ranges of
patient ID numbers.
This option is useful if you have multiple devices and a specific range of
patient ID numbers are sent to each healthcare system.

Specimen # Locates a single specimen, a range or multiple ranges of specimen numbers.


When selected, the LabPro Interface searches for specimens within the
specified range.
This option is useful if you have multiple devices and a specific range of
specimen numbers are sent to each healthcare system.

Specimen Status Date Locates the most recent date the specimen status changed. Specimen status
can be either preliminary or final.
If you define a filter for the device and the filter specifies a specimen status
(for example, final), then the LabPro Interface only searches for final results
within the specified date range.
If you do not define a device filter, or the filter does not specify a specimen
status, the LabPro Interface searches all specimens regardless of status within
the specified date range.

9020-8006, Rev. B LabPro Interface Implementation Guide 121


Automatic communication features

Search type and criteria (continued)


Search type Function
Test Group Status Date Searches by test group status date. Isolates can have multiple test groups
depending on the types of test run on the isolate. These test groups can have
different statuses: no data, ID-hold, ID/24 hour hold, 24-hour hold, MIC-hold,
preliminary or completed.
The status date is updated whenever the status of the test group changes.
The Test Group Status Date reflects the most recent date the test group
status changed.
If you define a filter for a device and the filter specifies a test group status
(for example, completed), the LabPro Interface only searches for completed
test group results within the specified date range.
If you do not define a device filter, or the filter does not specify a test group
status, the LabPro Interface searches all test groups regardless of the status
within the specified date range.

Active specimen only Searches only active specimens. If not selected, the search includes all active
and inactive specimens.

CAUTION
If you reuse specimen numbers, then select active specimens
only option to prevent old data being sent across the LabPro
Interface.

Retransmit data Retransmits previously transmitted data.


previously sent
Select this check box to retransmit data that was previously sent from this
device.
Clear this check box to prevent re transmission of any previously transmitted
data (even if it matches filter criteria).
The LabPro Interface keeps track, by device, whether or not a specimen,
isolate, or test group was sent to a device.
Editing specimen or isolate data causes the LabPro Interface to transmit the
data again.

Days Prior to transmission date

If a date criteria is selected for the search type when configuring auto-transmission, you must
enter the number of days prior to the transmission date.

For example, if the search is for the Test Group Status Date, and you set the number of days prior
to transmission to three, then (at the time of transmission) the LabPro Interface counts back three
days (excluding today).

122 LabPro Interface Implementation Guide 9020-8006, Rev. B


Automatic communication features

View filter

If a filter is configured for the selected device, you can view the filter rule criteria. View the filter
rule criteria prior to configuring auto-transmission to ensure the search type is appropriate for
the data you wish to transmit.

See Modifying data in the message layer (page 74) for more information

9020-8006, Rev. B LabPro Interface Implementation Guide 123


Automatic communication features

Configuring Auto-Transmit
You can configure auto-transmission from the Configure Communication Devices window or
the Interface Monitor.

Before configuring Auto-Transmit


Before configuring Auto-Transmit, complete the following tasks:

• Test to make sure you can transmit data between LabPro and the reciprocal system.

• Determine the time or times transmissions will occur.

• Set the scheduled backup, auto print, and auto-transmit times at least five
minutes apart.

• Determine if filters are defined for the device.

Procedure
To configure Auto-Transmit:

1. On the LabPro Command Center, click Utilities.

2. In the Utilities window, select Configuration > Interface.

3. Enter the password if requested.

The Configure Communication Devices window displays.

4. Click the appropriate device in the device list.

5. On the Device menu, click Auto-Communication.

124 LabPro Interface Implementation Guide 9020-8006, Rev. B


Automatic communication features

The Configure Automatic Transmit/Request dialog box displays.

6. Select the Enable Auto-Transmit check box.

7. In the Time box, type the time (24-hour format HHMM), or various times to transmit data,
and then press Enter.

The specified times in the Selected Times list.

8. In the Search Type area, click a search type option.

The associated search criteria requirement displays in the Selection Criteria area.

Selection criteria
Search type Search criteria requirements
Admission # Individual admission numbers (can include blank values).

Collect Date Days prior to transmission date.

Isolate Status Date Days prior to transmission date.

9020-8006, Rev. B LabPro Interface Implementation Guide 125


Automatic communication features

Selection criteria (continued)


Search type Search criteria requirements
Patient ID Individual patient ID numbers.

Specimen # Specimen range.

Specimen Status Date Days prior to transmission date.

Test Group Status Date Days prior to transmission date.

See Search type and criteria (page 120) for a more detailed description of the search type.

9. Enter the search criteria for a specific search type in any of the following ways:

• If the search criteria can be selected from a table, click the Lookup button, locate an entry
in the table, and then double-click the entry.
• Type the information in each search criteria box and then press Enter.
• If a search requires a date, type the number of days prior to the transmission date
to search.
For example, if you want specimens that become final on the day transmission occurs,
type 0 in the Days prior to transmission date box. The date range displays below the
text box.

• If the search criteria is admission # or patient ID, type the patient ID or admission number
to transmit.
10. Click Active specimen only if appropriate.
11. Click Retransmit data previously sent if appropriate.
12. Click OK to save the configuration.

126 LabPro Interface Implementation Guide 9020-8006, Rev. B


Automatic communication features

Auto-Request
This topic describes the auto-request feature and provides a procedure for configuring
auto-communication to request data.

Certain laboratory information systems require LabPro software to send a request for download
before the LIS transmits orders. You can configure the LabPro Interface to automatically send a
request for download at specific times.

Next request time


When auto-request is enabled, the next scheduled time to send a request record is displayed in
the Configure Communication Devices window and the Interface Monitor in the Next
Request Time column (for the device).

Multiple device configuration


You can configure multiple devices for Auto-Request. If this is done and more than one device is
configured to the same port, select an appropriate time interval that avoids conflict with another
device.

Enabling and disabling Auto-Request


You can enable or disable Auto-Request at any time. When Auto-Request is disabled, the
selected times are retained but ignored.

Selected times
Consider your workflow when selecting Auto-Request times.

• If the majority of panels are set up at a certain time each day, consider setting that specific
time for Auto-Request.

• If your panels are set up in batches throughout the day consider setting multiple times for
Auto-Request.

When an auto-request is made, the LIS downloads the information from the load list created on
the LIS.

9020-8006, Rev. B LabPro Interface Implementation Guide 127


Automatic communication features

Configuring Auto-Request
You can configure Auto-Request from the Configure Communication Devices window or the
Interface Monitor.

Before configuring Auto-Request


Before configuring Auto-Request, complete the following tasks:

• Test to make sure you can transmit data between LabPro and the reciprocal system.

• Determine the time or times transmissions will occur.

• Set the scheduled backup, auto print, and auto-transmit times at least five
minutes apart.

Procedure
To configure Auto-Request:

1. On the LabPro Command Center, click Utilities.

2. In the Utilities window, select Configuration > Interface.

3. Enter the password if requested.

The Configure Communication Devices window displays.

4. Click the appropriate device in the device list.

5. On Device menu, click Auto-Communication.

128 LabPro Interface Implementation Guide 9020-8006, Rev. B


Automatic communication features

The Configure Automatic Transmit/Request dialog box displays.

6. Select the Enable Auto-Request check box.

7. In the Time box, type the time (24-hour format HHMM), or various times to send a request
for data, and then press Enter.

The specified times in the Selected Times list.

8. Click OK to save the configuration.

9020-8006, Rev. B LabPro Interface Implementation Guide 129


Automatic communication features

Auto-Monitor
This topic describes the Auto-Monitor feature and provides procedures for enabling and
disabling Auto-Monitor.

When you initiate a download from your LIS, the LabPro device must monitor the line for
incoming messages. Auto-Monitor must be enabled to monitor (listen for) incoming messages.

When you create a new device, Auto-Monitor is disabled by default. If the Auto-Monitor is
disabled and a request for download is not used, the device cannot receive data from another
healthcare computer system.

Multiple device configuration


You can enable Auto-Monitor on multiple devices, if they are on different serial ports. If you have
multiple devices on a single serial port, only one device can have the Auto-Monitor enabled.

Enabling and disabling Auto-Monitor


Auto-Monitor can be enabled and disabled as needed and can be accessed from the Configure
Communication Devices window or from the Interface Monitor.

Before enabling Auto-Monitor


Before configuring Auto-Monitor, complete the following tasks:

• Test to make sure you can transmit data between LabPro and the reciprocal system.

• Identify the serial ports each connected device.

Enabling Auto-Monitor
To enable Auto-Monitor:

1. On the LabPro Command Center, select Utilities > Configuration > Interface.

2. Enter the password (if requested).

130 LabPro Interface Implementation Guide 9020-8006, Rev. B


Automatic communication features

The Configure Communications Devices window displays.

3. Select the appropriate device.

4. On the Device menu, click Enable Auto-Monitor.

When enabled, a check mark displays on the menu and next to the device name in the
Configure communication Devices window.

AUTO-MONITOR AND PORT ASSIGNMENT CONFLICTS


If another device is assigned to the same serial port with auto-monitor enabled, a
message displays and describes which device and serial port has auto-monitor
enabled.

Click OK to return to the Configure Communication Devices window. Auto-monitor


will not be enabled on the selected device.

To correct this, you need to disable auto-monitor on the first device and then enable
auto-monitor on the appropriate device.

9020-8006, Rev. B LabPro Interface Implementation Guide 131


Automatic communication features

Disabling the Auto-Monitor


To disable Auto-Monitor:

1. In the Configure Communication Devices window, click the device.

2. On the Device menu, click Enable Auto-Monitor to clear the Enable Auto-Monitor
check box.

Auto-Monitor is disabled and the check mark is cleared from the Configure
Communication Devices window.

132 LabPro Interface Implementation Guide 9020-8006, Rev. B


8
Device configuration detail report
This section includes the following topic:

• Printing the Device Configuration Detail report (page 134)

English software screen images are included in this section to identify the locations
of window components and describe tools only. Where applicable, descriptions of
these components and tools are provided in all available languages, however, the
actual screen image and text content within these screen images are only provided
in English.

9020-8006, Rev. B LabPro Interface Implementation Guide 133


Device configuration detail report

Printing the Device Configuration Detail report


This procedure describes the Device Configuration Detail report and how to view and
print it.

About the Device Configuration Detail report


The Device Configuration Detail Report shows device name, device type, the LabPro Interface
software version, the LabPro software version, and all of the configuration settings for each
device. After creating or editing a device, print the device configuration and retain it for future
reference.

Print the Device Configuration Detail Report from the Interface Monitor or from the Configure
Communication Device window. You can print the report for all devices, or for only the selected
device. The Print Preview printing option only displays the report for the selected device.

IMPORTANT
If needed, you can email or FAX this Device Configuration Detail Report to the Beckman
Coulter Customer Technical Support for troubleshooting transmission problems.

Before printing the report


Make sure the printer is connected to the computer and the printer is powered on.

Viewing the report


To view the device configuration report:

1. On the LabPro Command Center, click Utilities.

2. In the Utilities window, select Configuration > Interface.

3. Enter the password if requested.

134 LabPro Interface Implementation Guide 9020-8006, Rev. B


Device configuration detail report

The Configure Communication Devices window displays.

4. In the Configure Communication Devices window, click a device.

5. On the Device menu, click Print Preview.

The Device Configuration Detail Report displays.

Printing the report


To print the device configuration report:

1. In the Configure Communication Devices window, click the device.

2. On the Device menu, under Print Configuration, click one of the following options:

• Selected Device prints the configuration for the highlighted device.


• Print All prints the configuration for all devices.
3. In the Print dialog box, click OK.

9020-8006, Rev. B LabPro Interface Implementation Guide 135


This page intentionally left blank

136 LabPro Interface Implementation Guide 9020-8006, Rev. B


9
Transmitting LabPro customization tables
This section includes the following topics:

• Overview (page 138)

• Selecting custom data for transmit (page 138)

• Transmitting custom data (page 139)

• Stopping data transmission (page 141)

English software screen images are included in this section to identify the locations
of window components and describe tools only. Where applicable, descriptions of
these components and tools are provided in all available languages, however, the
actual screen image and text content within these screen images are only provided
in English.

9020-8006, Rev. B LabPro Interface Implementation Guide 137


Transmitting LabPro customization tables

Overview
You cannot transmit LabPro customization tables with the Japan Device. You can transmit the
LabPro customization tables to another healthcare computer system. This reduces the need to
manually enter custom data on both systems. This is typically performed when the other
healthcare computer system is the Surveillance Data Link Network (SDLN).

Selecting custom data for transmit


When you transmit custom data, the LabPro Interface transmits the code, the description, and the
cross-referenced code (if applicable).

LabPro can transmit the following customization tables:

• Institutions • Physicians • Techs


• Isolate Comments • Services • Drug Tests
• Organisms • Sources • Wards
• Patient Comments • Specimen Comments

SDLN data submission requirements


When submitting SDLN data to the International Health Management Associates, Inc. (IHMA), the
custom data must be submitted along with the patient data.

The file name for transferring custom data via a SDLN device type is SDLN.CUS. The file name for
transferring patient data is SDLN.EXP.

The following custom data must be transferred when submitting patient data:

• Drug tests

• Wards

• Sources

• Services

• Institutions

• Organisms

These data categories are the defaults for an SDLN device type.

138 LabPro Interface Implementation Guide 9020-8006, Rev. B


Transmitting LabPro customization tables

Transmitting custom data


This procedure describes how to transmit custom data.

Before transmitting custom data


Before transmitting custom data, ensure that:

• Customization in LabPro software is complete.

• Cross-reference tables are built. The cross-referenced code is transmitted when you transmit
custom data.

Procedure
To transmit custom data:

1. On the LabPro Command Center, click Interface.

The Interface Monitor displays.

2. Click the appropriate device to select it.

3. On the Device menu, click Transmit Custom Data.

9020-8006, Rev. B LabPro Interface Implementation Guide 139


Transmitting LabPro customization tables

The Transmit Custom Data window displays.

1
2

Item Description Item Description


Transmit Custom Data window RUO check box.
1 3
This check box indicates the transmission of
RUO information (LabPro-MBT RUO users
only). This is not for clinical use.

Data category list Send All or Active Only buttons


2 4

4. Complete one of the following actions.

• Accept the default selections, and go to the next step. The LabPro Interface retains the
default settings for each device type.
• Select data category check boxes to include data in the transmission.
• Clear data category check boxes to exclude data in the transmission.
5. Complete one of the following actions.

• Click All to send active and inactive codes.


If you are sending patient or specimen data with inactive codes, consider sending all
codes to the receiving system. For example, some codes might be inactive by the time
you send quarterly data to IHMA for the SDLN product.

• Click Active Only to send only active codes.


If you are sending patient or specimen data with only active codes, consider transmitting
only the active codes.

6. Click Transmit.

140 LabPro Interface Implementation Guide 9020-8006, Rev. B


Transmitting LabPro customization tables

Stopping data transmission


It is possible to stop the transfer of data from LabPro software to the laboratory system in
mid-transmission. When invoked, the program immediately terminates the transmission by
sending an <EOT>.

9020-8006, Rev. B LabPro Interface Implementation Guide 141


This page intentionally left blank

142 LabPro Interface Implementation Guide 9020-8006, Rev. B


Appendix A

Message layer - MicroScan record structure


This section includes the following topics:

• About the message layer - MicroScan record structure (page 145)

• MicroScan record and field rules (page 145)

• MicroScan record types and hierarchy (page 147)

• Sample record transmission flow (page 151)

• Record format specifications (page 155)

• Header record (H) (page 159)

• Patient record (P) (page 162)

• Specimen record (B) (page 166)

• Isolate record (R) (page 170)

• Test/MIC record (M) (page 179)

• Trace record (Q) (page 184)

• Comment record (C) (page 186)

• Free text record (F) (page 188)

• Request record (A) (page 190)

• End record (L) (page 192)

• Transmitting customization records (page 194)

• Sample upload of customized tables (page 195)

• Customized institution record (K) (page 196)

• Customized ward record (W) (page 197)

9020-8006, Rev. B LabPro Interface Implementation Guide 143


Message layer - MicroScan record structure

• Customized service record (J) (page 198)

• Customized source record (X) (page 199)

• Customized physician record (Z) (page 200)

• Customized tech record (I) (page 201)

• Customized test record (D) (page 202)

• Customized organism record (O) (page 204)

• Customized patient comment record (G) (page 205)

• Customized specimen comment record (Y) (page 207)

• Customized isolate comment record (E) (page 208)

144 LabPro Interface Implementation Guide 9020-8006, Rev. B


Message layer - MicroScan record structure

About the message layer - MicroScan record structure


Data transmitted to or from the LabPro Interface Program is grouped into records.
Each record contains ASCII printable text of a variable length format. A field delimiter and an
optional string delimiter for alphanumeric type fields delimit each variable length field. As noted
in each record type definition, individual fields are appropriate for download, upload, or both
operations. Some data elements can be repeated in different records.

MicroScan record and field rules


The following rules must be considered when defining the information to be transmitted to the
LabPro Interface.

Record rules
Each record follows these rules:

• Ignore unknown or unexpected record types.

• An identifier code is the first field for each record type.

See MicroScan record identifier codes (page 216) for a list of record identifiers values.

• If a record type is suppressed, then that record and all dependent records are also
suppressed.

See Data suppressions in the message layer (page 101) for more information.

• The LabPro Interface Program accepts partial records during receipt of transmission.

For example, if the last field applicable for a download operation is Field 10, and there are 20
fields in the record, it is not required that you specify the delimiters for the remaining fields.
However, you should send the entire record with the remaining field delimiters. This allows
LabPro to insert default values into blank fields as transmitted by the healthcare computer
application.

• The LabPro Interface Program always transmits the entire record during upload.

• To ensure smooth transition to future updates, no assumption should be made about the
number of fields per record or end of record positions, except for the rule that no frame shall
exceed 255 characters in length.

Beckman Coulter reserves the right to append undefined fields to existing records, and
expects no adverse effect with an existing reciprocal interface as a result.

• Request, test/MIC, and customization records are not applicable for download to LabPro.

See the individual record usage notes for additional record rules.

• A record must begin with an <STX> character.

9020-8006, Rev. B LabPro Interface Implementation Guide 145


Message layer - MicroScan record structure

• A record’s logical end is a <CR><LF> combination followed by the optional checksum bytes
and an <ETX> character.

• Each message is terminated with an end of transmission character <EOT> or an end of


transmission record.

• The maximum length for any record is 255 characters, which includes control and checksum
characters.

• The field delimiter is a required field in the header record.

• Use of string delimiters is optional but recommended. The string delimiter can be set to
None.

See the Defining data formatting criteria (page 96) for more information.

• All records, except the header record and the request record, have a record sequence field in
the transmission record.

During upload, each record within a patient data block transmits a sequence number in the
second field. The numbering starts with one and continues to increment by one until it is
replaced by a different record type of the same or higher level.

This number represents how many records of this type (within the individual section) were
transmitted. An L appearing in this field signifies that this is the last record of this type
associated with the preceding patient, specimen, or isolate section. Use of this field is strictly
arbitrary.

Field rules
Each field follows these rules:

• ASCII characters 0 through 31, 127, and 255 are not usable within the message text data
fields.

• Required non-code text fields received with lengths greater than the length specified in the
record attributes tables are truncated before storage and a warning message is entered in the
Interface Log.

• If upon receipt, a required field’s transmitted data exceeds the field’s maximum specified
length, the field and its record are rejected. An error message displays in the Interface Log.

• A code field that is not cross-referenced and is received with a length greater than the
maximum length specified is rejected, and an error message is recorded in the Interface Log.
The customer can suppress this type of error message.

• Code fields are rejected if they are not cross-referenced and if they are not found in the
LabPro customization tables. If the field is not a required field, the record is stored.

• A customizable field delimiter separates all fields.

• A customizable string delimiter can optionally enclose non-numeric fields.

• An option is available to exclude string delimiters for single character fields.

146 LabPro Interface Implementation Guide 9020-8006, Rev. B


Message layer - MicroScan record structure

• If string delimiters are used, and the string delimiter character is detected within the field
contents, the embedded delimiter is doubled (for example, if delimiter = ‘ , then Sally’s -->
‘Sally”s’).

• Customize null or suppressed non-numeric fields to transmit as a null field or as two string
delimiters.

• When a field is suppressed, the field delimiter transmits, but the field content is null.

• Many data elements are not applicable for download usage. See the individual field
definitions for more information.

MicroScan record types and hierarchy


Data transmitted to or from the LabPro Interface program is grouped into records and then
arranged in hierarchical order. This hierarchical order identifies the relationships of records to one
another. For example, a record at a hierarchy level 2 is associated with the previous record at
hierarchy level 1.

Hierarchical order
Records follow this hierarchy:

Table A-1: Example of Records hierarchical order


Level 0 - Header Record
Level 1 - Patient Record
Level 2 - Patient Comment Record
Patient Free Text Record
Specimen Record
Level 3 - Specimen Comment Records
Specimen Free Text Record
Isolate Records
Level 4 - Isolate Comment Records
Isolate Free Text Records
Trace Records
Test/MIC Records
Level 0 - End Record

Comment and free text records can occur at multiple levels within the hierarchy.
The positioning of these records in the record hierarchy determines whether each record is
associated with a patient, specimen, or isolate.

9020-8006, Rev. B LabPro Interface Implementation Guide 147


Message layer - MicroScan record structure

For example, a comment record at level 4 is associated with the previous isolate record at level 3.
The comment and free text association fields also provide this association information.

The following table lists each record type supported by the LabPro Interface program with the
associated record type ID and description. This table also describes the hierarchy level of each
record.

Table A-2: Hierarchy


Hierarchy Record type Description
Level 0 Header (H) Identifies the message.

Level 1 Patient 1 Record (P) General information about Patient 1.

Level 2 Patient Comment Record (C) Relates to previous patient record.

Level 2 Patient Free Text Record (F) Relates to previous patient record.

Level 2 Specimen 1 Record (B) Information about Specimen 1 of previous


patient record.

Level 3 Specimen Comment Record (C) Relates to previous specimen record.

Level 3 Specimen Free Text Record (F) Relates to previous specimen record.

Level 3 Isolate 1 Record (R) Information about Isolate 1 of the previous


specimen record. Contains order for first test
group/panel.

Level 4 Isolate Comment Record (C) Relates to the previous isolate record.

Level 4 Isolate Free Text Record (F) Relates to the previous isolate record.

Level 4 Trace Record (Q) Relates to the panel contained in the previous
isolate record.

Level 4 Test/MIC Record (M) Relates to the panel contained in the previous
isolate record.

Level 3 Isolate 1 Record (R) Information about Isolate 1 of the previous


specimen record. Contains order for second
test group/panel on Isolate 1.

Level 4 Trace Record (Q) Relates to the panel contained in the previous
isolate record.

Level 4 Test/MIC Record (M) Relates to the panel contained in the previous
isolate record.

Level 3 Isolate 2 Record (R) Information about Isolate 2 of the previous


specimen record. Contains order for first test
group/panel.

Level 4 Isolate Comment Record (C) Relates to the previous isolate record.

Level 4 Isolate Free Text Record (F) Relates to the previous isolate record.

Level 4 Trace Record (Q) Relates to the panel contained in the previous
isolate record.

148 LabPro Interface Implementation Guide 9020-8006, Rev. B


Message layer - MicroScan record structure

Table A-2: Hierarchy (continued)


Hierarchy Record type Description
Level 4 Test/MIC Record (M) Relates to the panel contained in the previous
isolate record.

Level 2 Specimen 2 Record (B) Information about Specimen 2 of patient 1.

Level 0 End Record (L) End of transmission flag = N.

Level 1 Patient 2 Record (P) General information about Patient 2.

Level 2 Specimen 1 Record (B) Information about Specimen 1 of Patient 2

Level 0 End Record (L) This is the last record of this sample
transmission. The end record is optional, and
can be used to terminate the transmission.
There are two ways to signal end of
transmission:
• Send an <EOT> character following this
record.
• Set the end of transmission flag in this the
end record to true (Y).

Transmission sort order


Transmissions are customizable to either send by patient ID sequence or specimen number
sequence. This affects the transmission only when there are multiple specimens for the same
patient ID.

Transmissions are sorted by:

• Patient ID. All specimen records associated with the previous patient record are transmitted
before the next patient record. Each patient record is transmitted only once. There is no limit
to the number of specimens per patient.

• Specimen Number. The patient record is transmitted before each specimen record.
Therefore, the same patient record is repeated for each specimen associated with it.

9020-8006, Rev. B LabPro Interface Implementation Guide 149


Message layer - MicroScan record structure

Block and sections definitions

Table A-3: Block and section definitions


Block or section Definition
Patient Block Begins with a patient record and can be terminated by an end record.
The patient block contains all the records within the patient, specimen, and
isolate sections. Multiple patient blocks can be transmitted in a message.

Patient Section Includes a patient record, one or more optional patient comment records, and/
or an optional patient free text record.

Specimen Section Includes a specimen record, one or more optional specimen comment records,
and/or an optional specimen free text record.

Isolate Section Includes one or more isolate records for the same isolate, one or more optional
isolate comment records, and/or an optional isolate free text record, and one or
more optional test/MIC records and one or more optional trace records.
LabPro software can receive multiple isolate records for the same isolate
number. This allows multiple test groups (panels) to be ordered for the same
isolate.
Comment, free text, and test/MIC records associated with a test group follow
the isolate record that identifies the test group. If multiple isolate records are
sent for the same isolate, the isolate comments and isolate free text records are
sent only once.
LabPro software is customizable to send test group results by:
• Sending multiple isolate records for the same isolate number.
• Combining multiple test groups so that only a single isolate record is
transmitted.

150 LabPro Interface Implementation Guide 9020-8006, Rev. B


Message layer - MicroScan record structure

Sample record transmission flow


Use these abbreviations in the following sample transmissions.

Table A-4: Sample transmission abbreviations


Abbreviation Description
(R) This record can be repeated consecutively. For example, multiple
comments per specimen.

(opt.) Optional record displays when available/enabled.

(MIC) Minimum Inhibitory Concentration.

<ENQ> Line bid from the sender.

<ACK> Response from the receiver.

<EOT> End of transmission flag.

The following examples show:

• A sample upload or download session. This session shows a transmission with two test
groups ordered for one isolate. An isolate record is transmitted for each test group. When
LabPro Interface transmits the results to another healthcare computer system, the test/MIC
records follow the corresponding isolate record.

• A sample upload session. This session shows a LabPro transmission with the combined
results of two test groups for one isolate. For this transmission the customer selects the All
test groups in a single isolate record option. LabPro software combines the test group
results so that only one isolate record is transmitted followed by the corresponding test/MIC
records.

All examples are shown using ENQ and ACK/NAK line bidding and software flow control.

Sample remote request for download


<ENQ>
<ACK>
<STX> Site/Header Record (opt.) <CR><LF>C1 C2<ETX>
<ACK>
<STX> Request Record <CR><LF>C1 C2<ETX>
<ACK>
<STX> End Record (opt.) <CR><LF>C1 C2<ETX>
<ACK>
<EOT>

9020-8006, Rev. B LabPro Interface Implementation Guide 151


Message layer - MicroScan record structure

Sample upload/download session


This example shows multiple test groups for a single isolate with each test group in separate
isolate records.

<ENQ>
<ACK>
<STX> Site/Header Record (opt.) <CR><LF>C1 C2<ETX>
<ACK>

Beginning of Patient Block

Beginning of Patient Section


<STX> Patient Record 1<CR><LF>C1 C2<ETX>
<ACK>
<STX> Patient Comment Record 1 (opt.) (R)<CR><LF>C1 C2<ETX>
<ACK>
<STX> Patient Free Text (opt.) <CR><LF>C1 C2<ETX>
<ACK>
End of Patient Section

Beginning of Specimen Section


<STX> Specimen Record 1 (opt.) <CR><LF>C1 C2<ETX>
<ACK>
<STX> Specimen Comment Records (opt.) (R) <CR><LF>C1 C2<ETX>
<ACK>
<STX> Specimen Free Text (opt.) <CR><LF>C1 C2<ETX>
<ACK>
End of Specimen Section

Beginning of Isolate Section


<STX> Isolate 1 (Test Order 1) Record 1 (opt.) (R) <CR><LF>C1 C2<ETX>
<ACK>
<STX> Isolate Comment Record 1(opt.) (R)<CR><LF>C1 C2<ETX>
<ACK>
<STX> Isolate Free Text (opt.) <CR><LF>C1 C2<ETX>
<ACK>
<STX> Trace Records for Test order 1 (opt.) (R)<CR><LF>C1 C2<ETX>
<ACK>
<STX> Test/MIC Records for test order 1 (opt.) (R)<CR><LF>C1 C2<ETX>
<ACK>
<STX> Isolate 1 (Test Order 2) Record 2 (opt.) (R) <CR><LF>C1 C2<ETX>
<ACK>
<STX> Trace Records for Test order 2 (opt.)(R)<CR><LF>C1 C2<ETX>
<ACK>
<STX> Test/MIC Records for test order 2 (opt.) (R)<CR><LF>C1 C2<ETX>
End of Isolate Section

152 LabPro Interface Implementation Guide 9020-8006, Rev. B


Message layer - MicroScan record structure

End of Patient Block

<STX> End Record (opt.) <CR><LF>C1 C2<ETX>


<ACK>
<EOT>

Sample upload session


This example shows multiple test groups for a single isolate with all test group information
combined in one isolate record.

<ENQ>
<ACK>
<STX> Site/Header Record (opt.) <CR><LF>C1 C2<ETX>
<ACK>

Beginning of Patient Block

Beginning of Patient Section


<STX> Patient Record 1<CR><LF>C1 C2<ETX>
<ACK>
<STX> Patient Comment Record 1 (opt.) (R)<CR><LF>C1 C2<ETX>
<ACK>
<STX> Patient Free Text (opt.) <CR><LF>C1 C2<ETX>
<ACK>
End of Patient Section

Beginning of Specimen Section


<STX> Specimen Record 1 (opt.) <CR><LF>C1 C2<ETX>
<ACK>
<STX> Specimen Comment Records (opt.) (R) <CR><LF>C1 C2<ETX>
<ACK>
<STX> Specimen Free Text (opt.) <CR><LF>C1 C2<ETX>
<ACK>
End of Specimen Section

9020-8006, Rev. B LabPro Interface Implementation Guide 153


Message layer - MicroScan record structure

Beginning of Isolate Section


<STX> Isolate 1 (Information for the appropriate test group) Record 1 (opt.) (R) <CR><LF>C1 C2<ETX>
<ACK>
<STX> Isolate Comment Record 1(opt.) (R)<CR><LF>C1 C2<ETX>
<ACK>
<STX> Isolate Free Text (opt.) <CR><LF>C1 C2<ETX>
<ACK>
<STX> Trace Records for Test order 1 (opt.)(R)<CR><LF>C1 C2<ETX>
<ACK>
<STX> Test/MIC Records for test group 1 (opt.) (R) <CR><LF>C1 C2<ETX>
<ACK>
<STX> Trace Records for Test order 2 (opt.)(R)<CR><LF>C1 C2<ETX>
<ACK>
<STX> Test/MIC Records for test group 2 (opt.) (R) <CR><LF>C1 C2<ETX>
<ACK>
End of Isolate Section

End of Patient Block

<STX> End Record (opt.) <CR><LF>C1 C2<ETX>


<ACK>
<EOT>

Transmission of patient blocks repeat until all information requested or selected has been sent. At
that time, the LabPro Interface program sends an <EOT> unless this is suppressed. If the LabPro
Interface program is receiving data, it expects to receive an <EOT>, or a properly set end record.
Otherwise, it reports a timeout error to the Interface Log.

Notes

• Test/MIC records. Used for upload only.

• End record. Signifies that all information associated with the previous patient has been sent.

• <EOT>. Sent once per logical transmission, flags end of transmission and release of line.

154 LabPro Interface Implementation Guide 9020-8006, Rev. B


Message layer - MicroScan record structure

Record format specifications


This section defines each heading used in all subsequent record attribute tables.

Table A-5: Attribute heading definitions


Attribute heading Heading definition
Seq (Sequence) The ordinal position of each data field and components within a record.

Description The description of the field used in LabPro. This generally corresponds to the field label that
the customer sees.
One of the following statements might also display in this column:
• (Based on LabPro defined data) - indicates LabPro defined table which includes the
appropriate data for this record and provides a link to the table in this document.
• (Based on user-defined data) - indicates that this record uses user-defined data.
Tables are either vendor coded or user-defined, or in the case of organisms, tests, and test
groups (panels) the individual customer can add codes to the predefined database.
See Setup and installation tables (page 215) for more information.

Len (Length) The maximum length of a particular field in the LabPro database.
Fields received with lengths greater than the maximum will be truncated before storage,
unless such fields are cross-referenced.
Certain fields are not subject to truncation, and if their length is exceeded an error message
will occur. An example of such a field would be the patient ID. Field lengths listed are
specified for use with LabPro database requirements only.
If possible, no assumption should be made by the reciprocal LabPro Interface program about
the maximum length of any string or numeric field.

XR Indicates whether the data elements may be subject to cross-referencing.


(Cross-reference) The maximum number of characters that can be cross-referenced is 32.
Cross-referencing can be used when a code field size of another healthcare computer
system exceeds the maximum field length (usually eight) in LabPro software, and/or when
the codes have different meanings on the two systems. Cross-referencing also allows for
many-to-one relationships.
Cross-referencing can be used to convert the case of a value when required or to convert the
field to a numeric field type that would not use string delimiters during transmission.

Case Indicates if non-numeric field contents are in:


• U (upper case only)
• L (lower case only)
• M (mixed case)
Code fields are case sensitive. If codes between the two systems differ only in case, cross-
referencing might be required.

9020-8006, Rev. B LabPro Interface Implementation Guide 155


Message layer - MicroScan record structure

Table A-5: Attribute heading definitions (continued)


Attribute heading Heading definition
DT (Data Type) The type or format of data for a specific field. Each individual field has a designated data
type. If data is received from another healthcare computer system that does not conform to
the data type, LabPro may reject the data. See the next page for a list of designated data
types.
Note: Any coded data field that is subject to cross-referencing may change the Data Type
from ST to NM depending on if the customer selects the Numeric Only flag when enabling
the cross-reference table for a given data element.
If the field is flagged as a numeric field when data is transmitted, the data element will not
contain string delimiters (if they are normally used).
If the LabPro Interface detects any alpha characters in such a flagged field, the LabPro
Interface transmits a null field and an error displays in the Interface Log.

156 LabPro Interface Implementation Guide 9020-8006, Rev. B


Message layer - MicroScan record structure

Table A-5: Attribute heading definitions (continued)


Attribute heading Heading definition
DT (Data Type) Data
type Data type
(continued)
code name Definition/comments
DT Date YYYYMMDD, YYMMDD, MMDDYYYY, MMDDYY, DDMMYYYY,
DDMMYY
Can also include the following delimiters: :, /, ., \, -, ;
If string delimiters are used, the date field transmits with string
delimiters only if delimiters are used within the date.
All dates must be transmitted in the same format. If the date is
unknown, a blank field should be transmitted.

FT Formatted Essentially the same as ST data type, but leading spaces are
Text preserved and trailing spaces are trimmed. No other formatting
characters are supported.

IS Coded Coded values from user-defined tables.


values

NM Numeric 0 - 9, ., +, -

SI Sequence ID 1 - n or L to indicate last record of that type.

ST String Text field. Leading and trailing spaces are stripped.

TM Time HHMM, HHMMSS


Can also include a trailing am or pm indicator. LabPro software
accepts am or pm in upper or lower case, but transmits only in
lower case.
Can also include the following delimiters: :, /, ., \, -, ;
If string delimiters are used, the time field transmits with string
delimiters only if delimiters are used within the time. All times
must be transmitted in the same format.
Times between 0000 and 0959 require the leading zero.

ZID Coded Coded values from LabPro defined table. Follows the same rules
values for formatting as for an ST data type.

ZYN Y = Yes Use for responses that can be only Y or N.


N = No

9020-8006, Rev. B LabPro Interface Implementation Guide 157


Message layer - MicroScan record structure

Table A-5: Attribute heading definitions (continued)


Attribute heading Heading definition
Opt Up This indicates if a field is:
(Optionality)
• R (required for upload)
• O (optional for upload)
• C (conditionally required for upload)
If C, the conditions are listed in the definition associated with the field.

An * indicates that the field can be suppressed by the customer during upload.
When a field is suppressed, the field delimiter is still transmitted but the field content is null.
Note: If a field is indicated as required for upload (for example, comment code), a customer
could potentially cross-reference a value to <<null>>.
LabPro software does not display an error in this situation; however, the receiving system
might indicate an error if it was designated as a required field for upload from LabPro
software.

Opt Dn This indicates if a field is:


(Optionality)
• R (required for download)
• O (optional for download)
• C (conditionally required for download)
If C, the conditions are listed in the definition associated with the field.
A blank space indicates that this is an upload only field and if a value is downloaded for this
field the LabPro Interface program ignores it.

More information
See MicroScan pre-defined drug tests/extra test table (page 245) for more information about
determining the field mappings for LabPro software. This appendix includes a table of field
equivalencies between the LabPro record structure and those of the CLSI LIS2-A (ASTM-1394)
and HL7 standards

158 LabPro Interface Implementation Guide 9020-8006, Rev. B


Message layer - MicroScan record structure

Header record (H)

THIS RECORD IS OPTIONAL (NOT REQUIRED FOR DOWNLOAD OR UPLOAD OPERATIONS)

The header record allows the sender to reprogram the LabPro Interface device configuration.
LabPro automatically conforms to those settings that display as downloadable (field delimiter,
string delimiter, delimit character flag). The header record contains information about the sender
and receiver.

This record:

• Identifies the field and string delimiter values to be used for the communication session.

• Allows the LabPro Interface program to identify itself before upload. See Site Name in the
following table.

The header record always uses ASCII 44, a comma (,), as a field delimiter and ASCII 34, double
quotes (“), as a string delimiter. The header record delimits character fields regardless of
customized settings.

Header record attributes table


See Record format specifications (page 155) for more information about each column/code.

Table A-6: Header record attributes


Seq Field Name Len XR Case DT Opt Up Opt Dn
1 Record ID 1 N U ZID R R
(Based on LabPro defined data)
Table C-1: MicroScan record
identifier codes (page 216)

2 Site Name 40 N M ST O

3 Not Used

4 Interface Name 40 N M ST R

5 Interface Version Number 8 N M ST R

6 Field Delimiter 1 N ST R R
(Based on LabPro defined data)
Table C-2: ASCII character set
values (page 217)

7 String Delimiter 1 N ST C C
(Based on LabPro defined data)
Table C-2: ASCII character set
values (page 217)

8 Delimit Character Flag 1 N U ZYN R

9020-8006, Rev. B LabPro Interface Implementation Guide 159


Message layer - MicroScan record structure

Table A-6: Header record attributes (continued)


Seq Field Name Len XR Case DT Opt Up Opt Dn
9 Checksum Type 1 N U ZID R
(Based on LabPro defined data)
Table C-5: Checksum type
(page 220).

10 Protocol Type 1 N U ZID R


(Based on LabPro defined data)
Table C-6: Protocol type
(page 221).

11 Timeout Period, in seconds 3 N NM R

12 Null Fields Allowed Flag 1 N U ZYN R

13 Not Used

14 Reserved

Header record field definitions table

Table A-7: Header record field definitions


Seq # Field Name Field Definition
1 Record ID Identifier of the record. The identifier for the header record is
always H.

2 Site Name User-defined identification for the laboratory. This field is not
used by LabPro with download operations. The identifier can be
used by a receiving system to recognize the source of the
transmission.

3 Not Used

4 Interface Name The name of the LabPro Interface Program. The value is always
LabPro.

5 Interface Version Number LabPro Interface Program version number currently installed.

6 Field Delimiter The ASCII character that is used as the field delimiter during the
communication session to follow.

7 String Delimiter The ASCII character that is used as a string delimiter during the
communication session to follow. This field is conditionally
required for download and upload operations. If a string
delimiter is being used then it must be transmitted. If a string
delimiter is not used then the field is null.

160 LabPro Interface Implementation Guide 9020-8006, Rev. B


Message layer - MicroScan record structure

Table A-7: Header record field definitions (continued)


Seq # Field Name Field Definition
8 Delimit Character Flag Y or N value to indicate if single character fields will include
string delimiters, if used:
Y (Yes) indicates a single character field will include the string
delimiters.
N (No) indicates a single character field will not include the
string delimiters.

9 Checksum Type A numeric value indicating which checksum method is used by


the LabPro Interface program.
See Checksum type (page 220) for acceptable values.

10 Protocol Type A numeric value indicating which flow control protocol(s) is


used by the LabPro Interface program. See Protocol type
(page 221) for acceptable values.

11 Timeout Period, in A numeric value for the LabPro Interface timeout delay period
seconds in seconds.

12 Null Fields Allowed Flag Y or N value to indicate if string delimiters (if used) will be
transmitted for a null field:
Y (Yes) indicates that the LabPro Interface program will transmit
only the field delimiter.
N (No) indicates that the LabPro Interface program will transmit
the field delimiter and string delimiters.

13 Not Used N/A

14 Reserved N/A

9020-8006, Rev. B LabPro Interface Implementation Guide 161


Message layer - MicroScan record structure

Patient record (P)

THIS RECORD IS REQUIRED FOR DOWNLOAD OPERATIONS

The patient record contains the patient demographic information. This is the first record within a
patient block and is required for download.

The customer can suppress the patient record during upload. If suppressed, any associated
patient comment and patient free text records are also suppressed.

The customer can select the transmission sort order as either patient ID or specimen number (this
applies to upload only):

When sorted by patient ID:

• All specimen records associated with patient ID are transmitted before the next patient
record is transmitted.

• The patient record is only transmitted once.

• There is no limit to the number of specimens per patient.

When sorted by specimen number:

• The patient record is transmitted prior to each specimen record.

• The same patient record is repeated for each associated specimen.

Patient record attributes table


See Record format specifications (page 155) for more information about each column/code.

Table A-8: Patient record attributes


Seq Field Name Len XR Case DT Opt Up Opt Dn
1 Record ID 1 N U ZID R R
(Based on LabPro defined data)
Table C-1: MicroScan record
identifier codes (page 216)

2 Record Sequence Number 4 N SI R

3 Patient ID Number 20 N U ST R R

4 Patient Last Name 32 N M ST O* O

5 Patient First Name 32 N M ST O* O

6 Date of Birth 10 N DT O O

162 LabPro Interface Implementation Guide 9020-8006, Rev. B


Message layer - MicroScan record structure

Table A-8: Patient record attributes (continued)


Seq Field Name Len XR Case DT Opt Up Opt Dn
7 Gender 1 Y U ZID O O
(Based on LabPro defined data)
Table C-7: Gender (page 222)

8 Not Used

9 Admit Date 10 N DT O O

10 Discharge Date 10 N DT O O

11 Room Number 8 N M ST O O

12 Attending Physician Code 8 Y U IS O O


(Based on a user-defined data)

13 Attending Physician Description 32 N M ST O*

14 Patient Ward Code 8 Y U IS O O


(Based on a user-defined data)

15 Patient Ward Description 32 N M ST O*

16 Service Code 8 Y U IS O O
(Based on a user-defined data)

17 Service Description 32 N M ST O*

18 Institution Code 8 Y U IS O O
(Based on a user-defined data)

19 Institution Description 32 N M ST O*

20 Patient Free Text Record To Follow 1 N U ZYN R

21 DOB <1/1/1900 or > 12/31/1999 1 N U ZYN C C


flag

22 Admit Status 1 Y U ZID O O


(Based on LabPro defined data)
Table C-8: Patient status
(page 222)

23 Not Used

24 Number of Patient Comment 2 N NM R


Records to Follow

25 Admission Number 20 N U ST O O

9020-8006, Rev. B LabPro Interface Implementation Guide 163


Message layer - MicroScan record structure

Patient record field definitions table

Table A-9: Patient record field definitions


Seq # Field Name Field Definition
1 Record ID The identifier of the record. The identifier for the patient
record is always P.
See MicroScan record identifier codes (page 216) for more
information.

2 Record Sequence Number The sequential occurrence number of the patient record.
This number represents the numerical sequence of a patient
record within the transmission message.
An L appearing in this field signifies that this is the last patient
record being transmitted.
See MicroScan record and field rules (page 145) for more
information on record sequence numbering

3 Patient ID Number The primary identifier used by the facility to uniquely identify
the patient (for example, medical record number or master
patient index number).
The account/visit number can also be used, but it is not
recommended. The account/visit number can be transmitted
in Field 25 of the patient record.

4 Patient Last Name The last name of the patient. If patient name has suffixes, such
as Jr., Sr., II, those suffixes should be concatenated with the last
name information as last-name space suffix-for example,
Smith Jr.

5 Patient First Name The first name of the patient. If the patient name has a middle
name or initial, the middle name should be concatenated with
the first name information as first-name space middle-
initial-for example, Robert M.

6 Date of Birth Patient’s date of birth. If a two-digit year format is used, Field
21 of this record must also be transmitted.

7 Gender Patient’s gender.


See Gender (page 222) for more information.

8 Not used

9 Admit Date Date of admission or patient registration.

10 Discharge Date Date patient was discharged. It is also used for the date of a
non-admitted patient visit to the emergency room or end-
date of an outpatient visit with the facility.

11 Room Number Patient’s room number, which can contain the bed identifier.

12 Attending Physician Code Code for the patient’s attending physician.

164 LabPro Interface Implementation Guide 9020-8006, Rev. B


Message layer - MicroScan record structure

Table A-9: Patient record field definitions (continued)


Seq # Field Name Field Definition
13 Attending Physician Name of the patient’s attending physician.
Description

14 Ward Code Code for patient’s current ward/location/nursing unit.

15 Ward Description Description of patient’s current ward/location/nursing unit.

16 Service Code Code for the service currently assigned to the patient.

17 Service Description Description of service currently assigned to the patient.

18 Institution Code Code for the institution where the patient is located.

19 Institution Description Description of the institution where the patient is located.

20 Patient Free Text Record to Y or N value to indicate if a patient free text record will be
Follow Flag included with this patient block.
Y (Yes) indicates that a patient free text record will follow.
N (No) indicates that a patient free text record will not follow.

21 DOB Y or N value to indicate if the patient’s date of birth (DOB) is


<1/1/1900 or >12/31/1999 prior to January 1, 1900, or later than December 31, 1999. This
Flag field is conditionally required. If the LIS is using a two-digit
year date format (YY), this flag must be transmitted.
Y (Yes) indicates that the patient’s DOB is prior to January 1,
1900, or later than December 31, 1999.
N (No) indicates the patient’s DOB is between January 1, 1900
and December 31, 1999.
This field is ignored when using a four-digit year format
(YYYY).

22 Admit Status A value to indicate if the patient is an inpatient or outpatient.


See Patient status (page 222) for more information.

23 Not Used N/A

24 Number of Patient Number of patient comment records that will follow in this
Comment Records to Follow patient section.

25 Admission Number Account/visit number for the patient’s encounter at the facility.

9020-8006, Rev. B LabPro Interface Implementation Guide 165


Message layer - MicroScan record structure

Specimen record (B)

THIS RECORD IS REQUIRED FOR DOWNLOAD OPERATIONS

The specimen record contains permanent specimen identification and demographic data that is
unique to the specimen. It is transmitted after the patient record and any optional patient
comment and/or patient free text records, and prior to specimen comment records or specimen
free text records.

The customer can suppress the specimen record during upload. If the specimen record is flagged
for upload suppression, the associated specimen comment and specimen free text records are
also suppressed automatically.

Specimen record attributes table


See Record format specifications (page 155) for more information about each column/code.

Table A-10: Specimen record attributes


Seq Field Name Len XR Case DT Opt Up Opt Dn
1 Record ID 1 N U ZID R R
(Based on LabPro defined data)
Table C-1: MicroScan record
identifier codes (page 216)

2 Record Sequence Number 4 N SI R

3 Specimen Number 20 N U ST R R

4 Patient ID Number 20 N U ST R R

5 Requesting Physician Code 8 Y U IS O O


(Based on a user-defined data)

6 Requesting Physician Description 32 N M ST O*

7 Source Code 8 Y U IS O O
(Based on a user-defined data)

8 Source Description 32 N M ST O*

9 Urine Source Flag 1 N U ZYN R

10 Date Specimen Collected 10 N DT O O

11 Time Specimen Collected 11 N TM O O

12 Request Date 10 N DT O O

13 Receive Date 10 N DT O O

14 Receive Time 11 N TM O O

166 LabPro Interface Implementation Guide 9020-8006, Rev. B


Message layer - MicroScan record structure

Table A-10: Specimen record attributes (continued)


Seq Field Name Len XR Case DT Opt Up Opt Dn
15 Not Used

16 Not Used

17 Specimen Status 1 N U ZID R


(Based on LabPro defined data)
Table C-9: Specimen status
(page 222)

18 Number of Specimen Comment 2 N NM R


Records to Follow

19 Specimen Free Text To Follow Flag 1 N U ZYN R

20 Ward of Isolation Code 8 Y U IS O O


(Based on a user-defined data)

21 Ward of Isolation Description 32 N M ST O*

22 Tech ID Code 8 Y U IS O O
(Based on a user-defined data)

23 Tech Description 32 N M ST O*

24 Not Used

9020-8006, Rev. B LabPro Interface Implementation Guide 167


Message layer - MicroScan record structure

Specimen record field definitions table

Table A-11: Specimen record field definitions


Seq # Field Name Field Definition
1 Record ID The identifier of the record. The identifier for the specimen
record is always B.

2 Record Sequence Number Sequence number of the specimen record. This number
represents the numerical sequence of a specimen record
within the transmitted patient block.
An L appearing in this field signifies that this is the last
specimen record associated with the preceding patient.

3 Specimen Number The identifier for the individual specimen. The specimen
number must be unique.
If the healthcare computer system uses repeating specimen
numbers, the customer can enable a LabPro Interface function
to automatically add a one to three character tag to the
downloaded number to make that number unique.
This tag is removed automatically when uploading the data to
the same device.
LabPro uses the specimen number and collection date as joint
keys to accommodate those LIS systems that use repeating
specimen numbers.
If the LIS uses repeating specimen numbers, it is important
that those systems download the specimen collect date.
A duplicate specimen number + date collected will be
rejected, if associated with the same patient ID numbers.

4 Patient ID Number This is a repeat of the patient ID Number in Field 3 of the


patient record. The patient ID number transmitted in this field
must be an exact match to Field 3 of the P record. If not, the
specimen will be rejected.

5 Requesting Physician Code Code for the physician that ordered the culture procedure.

6 Requesting Physician Description or name of the physician that ordered the culture
Description procedure.

7 Specimen Source Code Code for the source of the specimen. It is highly
recommended that you download this field. LabPro treats the
specimen and MIC interpretations as non-urine if the source
code is not downloaded.

8 Specimen Source Description of the source of the specimen.


Description

168 LabPro Interface Implementation Guide 9020-8006, Rev. B


Message layer - MicroScan record structure

Table A-11: Specimen record field definitions (continued)


Seq # Field Name Field Definition
9 Urine Source Flag Y or N value to indicate if the specimen source must be
considered as a urine specimen:
Y (Yes) indicates the specimen is considered a urine source.
N (No) indicates the specimen is considered a non-urine
source.

10 Date Specimen Collected Date the specimen was collected. Although this is an optional
field, it is recommended that this date be downloaded from
the LIS. This is critical for those systems that use repeating
specimen numbers. See the information regarding the
specimen number in Field 3.
This field cannot be updated through the LabPro Interface. If a
new collect date is received for an existing specimen, LabPro
will create a new specimen.

11 Time Specimen Collected Time the specimen was collected.

12 Request Date Date the procedure was ordered.

13 Received Date Date the laboratory received the specimen.

14 Received Time Time the laboratory received the specimen.

15 Not Used N/A

16 Not Used N/A

17 Specimen Status A code indicating the status of the specimen.


See Specimen status (page 222) for more information.

18 Number of Specimen A numerical value that indicates the total number of specimen
Comment Records to Follow comment records being sent for this specimen.

19 Specimen Free Text To Y or N value indicates if there is a specimen free text record to
Follow Flag follow:
• Y (Yes) indicates that a free text record will follow this
specimen.
• N (No) indicates that a free text record will not follow this
specimen.

20 Ward of Isolation Code Code for the ward/location/nursing unit where the patient was
located at the time the specimen was collected.

21 Ward of Isolation Description for the ward/location/nursing unit where the


Description patient was located at the time the specimen was collected.

22 Tech ID Code Code for the technologist performing the test on this
specimen.

23 Tech Description Description or name of the technologist performing the test


on this specimen.

24 Not Used

9020-8006, Rev. B LabPro Interface Implementation Guide 169


Message layer - MicroScan record structure

Isolate record (R)

THIS RECORD IS REQUIRED FOR DOWNLOAD OPERATIONS

Use this record to communicate the specific test groups ordered for an isolate. The record might
contain other information regarding the isolate, such as the oxidase reaction and organism
identification. The isolate record follows specimen record and any optional specimen comment
and/or specimen free text records.

The isolate record contains two types of prompts: identification and biochemical information
relating to the isolate or organism. These prompts are associated with predefined LabPro test
groups.

LabPro requires this additional information to complete the identification of an organism, and/or
to provide the correct interpretations. These biochemical tests are not performed on the
MicroScan instrumentation. It is desirable that the laboratory system has the capability of
downloading the results of these “prompts.”

• If the information is not received from the LIS, the customer may need to enter those results
manually after the specimen or isolate has been transmitted to LabPro.

• MIC panels typically are flagged for the organism prompt.

• If the customer is ordering an ID-only test group/panel along with an MIC panel for the same
isolate, LabPro automatically associates the organism ID with the MIC panel.

• The organism prompt is required only when the MIC panel is ordered for an isolate without
ordering an ID test group/panel. For more information on prompts,

See Test group/panel prompts and codes (page 237) for more information.

LabPro can receive multiple isolate records for the same isolate number. This allows multiple test
groups to be ordered on the same isolate. For example, LabPro can receive one isolate record to
order an ID only test group/panel and a second isolate record is to order an MIC panel, both
isolate records must have the same isolate and specimen number.

LabPro validates the acceptable combination of test groups ordered. If LabPro encounters an
unacceptable combination, an error message displays in the Interface Log.

See Test group compatibility rules (page 233) for more information on valid test group
combinations.

The isolate record can be suppressed during upload. If the isolate record is flagged for upload
suppression, the associated isolate comment, isolate free text records, and test/MIC Records are
also suppressed.

Isolate records containing user-defined (offline) test groups may be selectively suppressed. If
suppressed, test/MIC records associated with the user-defined test group are also suppressed.

170 LabPro Interface Implementation Guide 9020-8006, Rev. B


Message layer - MicroScan record structure

Transmitting multiple test groups/panels results to another


healthcare computer
LabPro can transmit multiple test groups/panels results to another healthcare computer system
in two ways:

• Multiple isolate records with the same isolate number but with different test group/panel
codes. The test/MIC records, for the corresponding test group, follow each isolate record.

• Combine the test groups so that only one isolate record is transmitted followed by all the
associated test/MIC records.

When the customer uses the option to transmit combined test groups into one isolate record,
the following logic determines how LabPro Interface transmits the results to another healthcare
computer system:

LabPro Interface transmits the


LabPro Interface transmits in associated test/MIC records:
the test group fields of the (in alphabetical order within each test
Combined Test Groups isolate (R) record: group)
ID only test group/panel + MIC MIC test group code, description, MIC panel drug test results.
panel and status date.

ID only test group/panel + offline ID test group code, description, Offline drug test results for all offline test
test groups and status date. groups.

ID only test group/panel + MIC MIC test group, description, and MIC panel drug test results followed by
panel + offline test groups status date. the offline results for all offline test
groups.

Combo panel + offline test Combo panel test group code, Combo panel drug test results followed
groups description, and status date. by results for all offline test groups.

MIC panel + offline test groups MIC test group code, description, MIC panel drug test results followed by
and status date. results for all offline test groups.

Multiple offline test groups Code, description, and status date Offline drug test results for all offline
for first offline test group ordered. groups.

9020-8006, Rev. B LabPro Interface Implementation Guide 171


Message layer - MicroScan record structure

Isolate record attributes table


See Record format specifications (page 155) for more information about each column/code.

Table A-12: Isolate record attributes


Seq Field Name Len XR Case DT Opt Up Opt Dn
1 Record ID 1 N U ZID R R
(Based on LabPro defined data)
Table C-1: MicroScan record
identifier codes (page 216)

2 Record Sequence Number 4 N U SI R

3 Isolate Number 3 N U ST R R

4 Specimen Number 20 N U ST R R

5 Test Group Code 8 Y U ZID or O O


IS
(Based on LabPro defined data)
Table E-1: Test group compatibility
rules (page 233)

6 Test Group Description 32 N M ST O*

7 Test Group Status Date 10 N DT R

8 Not used

9 Nosocomial Infection Source Flag 1 N U ZYN R O

10 Not Used

11 Not Used

12 Organism Code 9 Y U ZID O O


or
(Based on LabPro defined data) See
IS
the MicroScan Organism Reference
Guide for more information.

13 Organism Name Description 20 N M ST O*


or
52

14 Biotype Number 36 N ST O*

15 Beta Lactamase Test Result 1 N U ZID O O


(Based on LabPro defined data)
Table C-10: Test results for beta
lactamase, oxidase, indole or
Thymidine-dependent strain
(page 223)

172 LabPro Interface Implementation Guide 9020-8006, Rev. B


Message layer - MicroScan record structure

Table A-12: Isolate record attributes (continued)


Seq Field Name Len XR Case DT Opt Up Opt Dn
16 Oxidase/Indole Reaction Result 1 N U ZID O O
(Based on LabPro defined data)
Table C-10: Test results for beta
lactamase, oxidase, indole or
Thymidine-dependent strain
(page 223)

17 Streptomycin Synergy Screen 1 N U ZID O


Result
(Based on LabPro defined data)
Table C-11: Synergy screen results
(page 223)

18 Gentamicin Synergy Screen Result 1 N U ZID O


(Based on LabPro defined data)
Table C-11: Synergy screen results
(page 223)

19 Thymidine Dependent Strain 1 N U ZID O


Result
(Based on LabPro defined data)
Table C-10: Test results for beta
lactamase, oxidase, indole or
Thymidine-dependent strain
(page 223)

20 Not Used

21 Reserved

22 Beta Hemolytic Flag 1 N U ZYN O O

23 Not Used

24 Not Used

25 Exclude Result from Epidemiology 1 N U ZYN R O


Flag

26 Not Used

27 Not Used

28 ESBL Result 3 N M ZID O O


(Based on LabPro defined data)
Table C-12: ESBL results
(page 223)

29 Number of Trace Records to 2 N NM R


Follow

30 Number of Test/MIC Records to 2 N NM R


Follow Flag

9020-8006, Rev. B LabPro Interface Implementation Guide 173


Message layer - MicroScan record structure

Table A-12: Isolate record attributes (continued)


Seq Field Name Len XR Case DT Opt Up Opt Dn
31 Not Used

32 Isolate Free Text Record to Follow 1 N U ZYN R


Flag

33 Not Used

34 Organism Class 1 N NM O O
(Based on LabPro defined data)
Table C-13: Organism class/family
(page 224)

35 Organism Set 1 N NM R
(Based on LabPro defined data)
Table C-14: Organism set
(page 224)

36 Not Used

37 Number of Isolate Comments to 2 N NM R


follow

38 Isolate Status 1 N U ZID R


(Based on LabPro defined data)
Table C-9: Specimen status
(page 222)

39 Isolate Tech ID Code 8 Y U IS O O


(Based on a user-defined data)

40 Isolate Tech Description 32 N M ST O*

174 LabPro Interface Implementation Guide 9020-8006, Rev. B


Message layer - MicroScan record structure

Isolate record field definitions table

Table A-13: Isolate record field definitions


Seq # Field Name Field Definition
1 Record ID The identifier of the record. The identifier for the isolate
record is always R.

2 Record Sequence Number Sequence number of the isolate record. This number
represents the numerical sequence of an isolate record within
the specimen section. An L appearing in this field signifies
that this is the last isolate record associated with the
preceding specimen.

3 Isolate Number The identifier of the isolate. The customer can customize
LabPro to append a leading zero to the isolate numbers 0 - 9
prior to sending to the LIS.

4 Specimen Number A repeat of the specimen number in field 3 of the specimen


record.
The specimen number transmitted in this field must be an
exact match to field 3 of the B record. If not, the isolate is
rejected.

5 Test Group Code Code for the test group/panel. A test group can be a
predefined MicroScan panel or MBTID test group or a user-
defined (offline) test group. A user-defined (offline) test group
is defined by the customer and is not a MicroScan panel.
See Test group/panel prompts and codes (page 237) for a list
of the predefined MicroScan test groups/panels.
For upload, when using the combine test group option All
test groups in a single isolate record, this field contains only
one of the test group codes for the associated test/MIC
records.
See Transmission of isolate results for combined test groups
(page 94) for the combined test group logic.

6 Test Group Description Description of the test group/panel.

7 Test Group Status Date Date when the test group’s status last changed.

8 Not Used N/A

9 Nosocomial Infection Y or N value to indicate if the isolate was hospital or


Source Flag community acquired:
Y (Yes) indicates nosocomial or hospital acquired.
N (No) indicates community acquired or unknown.
If no value is received, LabPro automatically sets the flag to N.

10 Not Used N/A

11 Not Used N/A

9020-8006, Rev. B LabPro Interface Implementation Guide 175


Message layer - MicroScan record structure

Table A-13: Isolate record field definitions (continued)


Seq # Field Name Field Definition
12 Organism Code Code for the isolated organism. Gram-positive test groups
require a family designation (Streptococcaceae or
Micrococcaceae).
If you do not use Field 34, organism class, of the isolate
record, use the organism code to send a generic organism in a
known family or the actual species name.
See Organism class/family (page 224) for more information.

13 Organism Description Name of the organism identified. The length of this field is
determined by the Organisms Name Format Flag set in the
Interface Configuration.
See Defining data formatting criteria (page 96) for more
information.
If the Short Description (short name) is selected in LabPro, the
field length is 16 characters.
If the Long Description (long name) is selected in LabPro, the
field length is 48 characters.

14 Biotype Number The biotype number of the organism identified in the


previous field.
It is computed by LabPro, based on the biochemical test
results associated with the respective ID or Combo panel.
LabPro and the panel type used determine the format of this
number. The biotype number from LabPro is always numeric,
but might contain dashes (-) within the set of numbers.
LabPro-MBT Users: The Universal Unique Identification
(UUID) number is sent in this field if the ID comes from the
Bruker system. This number is alpha-numeric and contains
dashes (-). The UUID is 36 characters long.

15 Beta Lactamase Test Result The result of the beta-lactamase test performed on the isolate.
See Interpretations (page 225) for acceptable values.

16 Oxidase/Indole Reaction The result of the oxidase or indole (for anaerobes) test
performed on the isolate.
See Interpretations (page 225) for acceptable values.

17 Streptomycin Synergy Interpretation of the Streptomycin Synergy Screen for the


Screen Result isolate.
This field has been retained for backward compatibility.
The Streptomycin Synergy Screen interpretation can also be
sent as a test/MIC Record with a designated test code of STS.
The customer can configure the LabPro Interface to send the
Streptomycin Synergy Screen result in an M record.
See Interpretations (page 225) for acceptable values.

176 LabPro Interface Implementation Guide 9020-8006, Rev. B


Message layer - MicroScan record structure

Table A-13: Isolate record field definitions (continued)


Seq # Field Name Field Definition
18 Gentamicin Synergy Screen Interpretation of the Gentamicin Synergy Screen for the
Result isolate.
This field has been retained for backward compatibility.
The Gentamicin Synergy Screen interpretation can also be sent
as a test/MIC Record with a designated test code of GMS.
The customer can configure the LabPro Interface to also send
the Gentamicin Synergy Screen result in an M record. For
acceptable values, see Table 9 in Appendix C.

19 Thymidine Dependent The result of the Thymidine Growth Well. Some bacteria
Strain Result require thymidine for growth. These bacteria may exhibit false
susceptibility to the sulfonamides due to the presence of
thymidine phosphorylase in the Mueller-Hinton broth.
If an organism does not grow in the TFG growth well, do not
report an MIC for Trimethoprim/Sulfamethoxazole or
Sulfamethoxazole. This will be reported only for gram-positive
panels.
See Interpretations (page 225) for acceptable values.

20 Not Used N/A

21 Reserved N/A

22 Beta-Hemolytic Flag Y or N value indicates if the isolate produces beta-hemolysis.


The result is transmitted only for Streptococcaceae isolates:
Y (Yes) indicates the isolate is beta-hemolytic.
N (No) indicates the isolate is non-beta-hemolytic.

23 Not Used N/A

24 Not Used N/A

25 Excluded Result From Y or N value indicates if the MIC interpretations for this isolate
Epidemiology Flag should be included when generating epidemiology reports.
Y (Yes) indicates the data is not used in epidemiology reports.
N (No) indicates the data is included in epidemiology reports.
For example, this flag is set to Y for proficiency type
specimens or environmental specimens.

26 Not Used N/A

27 Not Used N/A

28 ESBL Result The result of an ESBL confirmation test performed on the


isolate.
See Interpretations (page 225) for acceptable values.

29 Number of Trace Records to Total number of trace records that will be sent for this isolate.
follow

9020-8006, Rev. B LabPro Interface Implementation Guide 177


Message layer - MicroScan record structure

Table A-13: Isolate record field definitions (continued)


Seq # Field Name Field Definition
30 Number of Test/MIC Number of test/MIC records associated with the test group
Records to Follow (Field 5) that follows this isolate record.
For upload only, when combining test groups into one isolate
record, this number reflects all the test/MIC records
transmitted for the isolate.
See Test/MIC record (M) (page 179) for more information.

31 Not Used N/A

32 Isolate Free Text Record To Y or N value indicates if there is an isolate free text record to
Follow Flag follow:
Y (Yes) indicates a free text record will follow this isolate.
N (No) indicates a free text record will not follow this isolate.

33 Not Used N/A

34 Organism Class Class or grouping of the organism isolated.


See Test group/panel prompts and codes (page 237) for
values and the organism code definition and prompts tables.
The organism class is only important when sending orders to
the LabPro system. The field should be ignored when the LIS
or another healthcare computer system receives and
processes the result information.

35 Organism Set A secondary grouping of the organism isolated.


See Interpretations (page 225) for acceptable values.

36 Not Used N/A

37 Number of Isolate Total number of isolate comment records that will be sent for
Comments to follow this isolate.

38 Isolate Status The result status of the specific isolate.


See Interpretations (page 225) for acceptable values.

39 Tech Code Code for the technologist associated with this isolate.

40 Tech Description Name of the technologist associated with this isolate.

178 LabPro Interface Implementation Guide 9020-8006, Rev. B


Message layer - MicroScan record structure

Test/MIC record (M)


The test/MIC record is used to communicate the MIC and susceptibility interpretation values for
an individual drug test and determines whether these results should appear on a chartable
patient report.

The test/MIC record follows an isolate record and any optional isolate comment and/or isolate
free text records. A test/MIC record is sent for each drug test in the test group, therefore, multiple
test/MIC records are usually transmitted for each isolate.

If multiple test group/panels are ordered on a single isolate, LabPro Interface transmits the
results in the following ways:

• Multiple isolate records with the same isolate number but with different test group/panel
codes. The test/MIC records, for the corresponding test group, follow each isolate record.

• The customer configures LabPro to combine multiple test groups, only one isolate record is
transmitted. All associated test/MIC records follow the single isolate record.

See Isolate record (R) (page 170) for more information about the transmit order of these test/
MIC records.

• There is no limit on the number of test/MIC records that may be transmitted for a single
isolate/test group. The test/MIC record can be suppressed for upload operations.

Test/MIC record attributes table


See Record format specifications (page 155) for more information about each column/code.

Table A-14: Test/MIC record attributes


Seq Field Name Len XR Case DT Opt Up Opt Dn
1 Record ID 1 N U ZID R
(Based on LabPro defined data)
Table C-1: MicroScan record
identifier codes (page 216)

2 Record Sequence Number 4 N U SI R

3 Drug Test Code 8 Y U ZID or R


IS
(Based on LabPro defined data)
Table I-1: MicroScan drug tests
(page 246)

4 Drug Test Description 32 N M ST O*

5 MIC Value 10 Y ST O*
(Based on LabPro defined data)
Table H-1: MIC dilutions (page 243)

6 User-defined (Offline) Drug Test 1 N U ZYN O


Flag

9020-8006, Rev. B LabPro Interface Implementation Guide 179


Message layer - MicroScan record structure

Table A-14: Test/MIC record attributes (continued)


Seq Field Name Len XR Case DT Opt Up Opt Dn
7 User-defined (Offline) Drug Test 4 Y U ZID O
Interpretation
(Based on LabPro defined data)
Table C-14: Organism set
(page 224)

8 CLSI Systemic Interpretation 4 Y M ZID O


(Based on LabPro defined data)
Table C-15: Interpretations
(page 225)

9 CLSI Urine Interpretation 4 Y M ZID O


(Based on LabPro defined data)
Table C-15: Interpretations
(page 225)

10 Not Used

11 Not Used

12 Not Used

13 Not Used

14 Not Used

15 Not Used

16 Not Used

17 Not Used

18 Not Used

19 Not Used

20 Not Used

21 Not Used

22 Not Used

23 Not Used

24 Not Used

25 Not Used

26 Result Suppressed Flag 1 N U ZYN R

180 LabPro Interface Implementation Guide 9020-8006, Rev. B


Message layer - MicroScan record structure

Test/MIC record field definitions table

Table A-15: Test/MIC record field definitions


Seq # Field Name Field Definition
1 Record ID The identifier of the record. The identifier for the test/MIC
record is always M.

2 Record Sequence Number The sequence number of the test/MIC record. This number
represents the numerical sequence of a test/MIC record within
the isolate/test group section.
An L appearing in this field signifies that this is the last test/
MIC record of this type associated with the preceding isolate/
test group.

3 Drug Test Code The code of a LabPro predefined drug test or the code of a
user-defined (offline) drug test. A user-defined (offline) drug
test is defined by the customer and is not run on a MicroScan
panel. The data type for this field may be either ZID or IS. The
value in Field 6 will determine which data type and table that
should be referenced.
If Field 6 value = N, the data type is ZID.
If Field 6 value = Y, the data type is IS and is a user-defined
table.
All drug test codes are uppercase. If the receiving system
requires codes in mixed case, cross-referencing may be
defined in LabPro to convert uppercase to mixed case. User-
defined (offline) drug test results can be selectively
suppressed by the customer.

4 Drug Test Description The description of the drug test.

5 MIC Value The MIC value of the organism’s susceptibility to the


antimicrobic (drug test), expressed in mcg/mL. Numeric
values might be preceded with <, <=, or >. Ratio type drugs
might also include a “/” between the numeric values. The MIC
value is optionally transmitted for any test group containing
drug tests.
See MIC dilutions table (page 243) for more information.

6 User-defined (Offline) Drug Y or N to indicate if the drug test code in Field 3 is identified
Test Flag as a user-defined (offline) drug test.
Y (Yes) entry indicates that this is a user-defined (offline) drug
test.
N (No) entry indicates that this is a predefined drug test.
Test/MIC records for the user-defined (offline) drug test may
be suppressed.

9020-8006, Rev. B LabPro Interface Implementation Guide 181


Message layer - MicroScan record structure

Table A-15: Test/MIC record field definitions (continued)


Seq # Field Name Field Definition
7 User-defined (Offline) Drug The susceptibility interpretation for a user-defined (offline)
Test Interpretations drug test. Single field interpretation reporting is available.
When this option is enabled, this value will also be
transmitted in Field 8.
To enable this function select Appropriate Interpretation in
Systemic Field in the Message Layer.
See Data formatting criteria in the message layer (page 88) for
more information.

8 CLSI Systemic The drug test’s systemic susceptibility interpretation based on


Interpretations the breakpoints established by the CLSI standards for the
identified organism and antimicrobic.

9 CLSI Urine Interpretation The drug’s urine susceptibility interpretation based on the
breakpoints established by the CLSI standards for the
identified organism and antimicrobic.
Drugs identified as being appropriate only for urinary
infections will not have a systemic interpretation. Single field
interpretation reporting is available.
When this option is enabled, the correct CLSI interpretation is
transmitted in the CLSI systemic interpretation field and this
field is ignored.
To enable this function select Appropriate Interpretation in
Systemic Field in the Message Layer.
See Data formatting criteria in the message layer (page 88) for
more information.

10 Not Used N/A

11 Not Used N/A

12 Not Used N/A

13 Not Used N/A

14 Not Used N/A

15 Not Used N/A

16 Not Used N/A

17 Not Used N/A

18 Not Used N/A

19 Not Used N/A

20 Not Used N/A

21 Not Used N/A

22 Not Used N/A

182 LabPro Interface Implementation Guide 9020-8006, Rev. B


Message layer - MicroScan record structure

Table A-15: Test/MIC record field definitions (continued)


Seq # Field Name Field Definition
23 Not Used N/A

24 Not Used N/A

25 Not Used N/A

26 Result Suppressed Flag Y or N value to indicate the reportability of the drug test.
This field indicates that the drug test and results should be
suppressed from the chartable patient report.
Drug tests can be flagged for suppression based upon user-
defined drug suppression rules or by clearing the drug from
the Formulary Definition table.
Y (Yes) entry indicates that the results should not appear on
the chartable patient report.
N (No) entry indicates that the results should appear on a
chartable patient report.

9020-8006, Rev. B LabPro Interface Implementation Guide 183


Message layer - MicroScan record structure

Trace record (Q)


The trace record is used to communicate instrument traceability.

• The trace record follows the Isolate Record after Isolate Comment Records and Isolate Free
Text Records and before Test/MIC Records.

• The trace record relates to the panel contained in the previous isolate record.

• The trace record type can be selected for suppression for upload operations and is
suppressed by default.

Trace record attributes table


See Record format specifications (page 155) for more information about each column/code.

Table A-16: Trace record attributes


Seq Field Name Len XR Case DT Opt Up Opt Dn
1 Record ID 1 N U ZID R
(Based on LabPro defined data)
Table C-1: MicroScan record
identifier codes (page 216)

2 Record Sequence Number 4 N U SI R

3 Trace Type 50 N U ST R

4 Trace ID 50 N U ST R

5 Serial # 256 N U ST R

6 Trace Date 10 N U DT R

7 Test Group Code 8 Y U ZID or O


IS

8 Test Group Description 32 N M ST O

184 LabPro Interface Implementation Guide 9020-8006, Rev. B


Message layer - MicroScan record structure

Trace record field definitions table

Table A-17: Trace record field definitions


Seq # Field Name Field Definition
1 Record ID The identifier of the record. The identifier for the trace record
is always Q.

2 Record Sequence Number The sequence number of the trace record. This number
represents the numerical sequence of a trace record within
the isolate section.
An L appearing in this field signifies that this is the last trace
record of this type associated with the preceding isolate.

3 Trace Type The Predefined trace type “INSTRUMENT.”

4 Trace ID The instrument type or manual user that read a panel


included in the isolate.
WA. Indicates that the isolate results were recorded by a
WalkAway instrument identified by the serial number in the
record.
AS4. Indicates that the isolate results were recorded by an
autoSCAN-4 instrument identified by the serial number in the
record.
MBT. Indicates that the isolate results were recorded by an
MBT instrument identified by the serial number in the record.
Manual. Indicates that the isolate results were recorded by a
manual read identified by the Windows user name in the
record.

5 Serial # The serial number of the instrument or Windows user name of


a manual user that read a panel included in the isolate.

9020-8006, Rev. B LabPro Interface Implementation Guide 185


Message layer - MicroScan record structure

Table A-17: Trace record field definitions (continued)


Seq # Field Name Field Definition
6 Trace Date Date/time the instrument or manual user read a panel
included in the isolate.

7 Test Group Code Code for the test group/panel. A test group can be a
predefined MicroScan panel or MBTID test group or a user-
defined (offline) test group.
A user-defined (offline) test group is defined by the customer
and is not a MicroScan panel.
For a list of the predefined MicroScan test groups/panels, see
Test group/panel identifier codes (page 238)
For upload, when using the combine test group option (All
test groups in a single isolate record), this field contains
only one of the test group codes for the associated test/MIC
records.
For the combined test group logic, see Transmitting multiple
test groups/panels results to another healthcare computer
(page 171) for more information.

8 Test Group Description Description of the test group/panel.

Comment record (C)


The comment record is used to communicate coded predefined textual information regarding a
patient, specimen, or isolate.

The positioning in the record sequence, as well as the comment association flag determines
whether the comment is related to the patient, specimen, or isolate.

• Patient comment records are transmitted immediately after a patient record and before or
after any patient free text record.

• Specimen comment records are transmitted immediately after a specimen record and before
or after any specimen free text record.

• Isolate comments are transmitted immediately after the first isolate record and before any
isolate free text record and any test/MIC records. If there are multiple isolate records for the
same isolate, the records follow any test/MIC records for the first isolate/test group
combination.

Each comment record type, (patient, specimen, or isolate) can be individually selected for
suppression for upload operations. The customer can send all comments or only those flagged as
reportable.

186 LabPro Interface Implementation Guide 9020-8006, Rev. B


Message layer - MicroScan record structure

Comment record attributes table


See Record format specifications (page 155) for more information about each column/code.

Table A-18: Comment record attributes


Seq Field Name Len XR Case DT Opt Up Opt Dn
1 Record ID 1 N U ZID R R
(Based on LabPro defined data)
Table C-1: MicroScan record
identifier codes (page 216)

2 Record Sequence Number 4 N U SI R

3 Comment Code 8 Y U IS R R
(Based on a user-defined data)

4 Not Used

5 Comment Description 32 N M ST O*

6 Not Used

7 Comment Association Flag 1 N U ZID R


(Based on LabPro defined data)
Table C-16: Comment/free text
association (page 226)

8 Reportable Comment Flag 1 N U ZYN R

Comment record field definitions table

Table A-19: Comment record field definitions


Seq # Field Name Field Definition
1 Record ID The identifier of the record. The identifier for the comment
record is always C.

2 Record Sequence Number The sequence number of the comment record. This number
represents the numerical sequence of a comment record
within the patient, specimen, or isolate section.
An L appearing in this field signifies that this is the last
comment record associated with the preceding patient,
specimen, or isolate.

3 Comment Code The code for the comment.


Note: Patient comments, specimen comments, and isolate
comments may have the same code.
The same comment code may be discerned by examination of
the Comment Association Flag value or by the sequence of the
comment record within the patient block.

9020-8006, Rev. B LabPro Interface Implementation Guide 187


Message layer - MicroScan record structure

Table A-19: Comment record field definitions (continued)


Seq # Field Name Field Definition
4 Not Used N/A

5 Comment Description The text of the comment.

6 Not Used N/A

7 Comment Association This field indicates if the comment record is associated with a
patient, specimen or isolate.
See Comment/free text association (page 226)for defined
values.

8 Reportable Comment Flag Y or N value to indicate if the comment is reportable. This field
indicates that the comment will be suppressed from the
chartable patient report:
• Y (Yes) entry indicates that the comment will appear on the
chartable patient report.
• N (No) entry indicates that the comment will not appear
on a chartable patient report.

Free text record (F)

THIS RECORD IS OPTIONAL FOR UPLOAD OPERATIONS ONLY

The free text record is used to communicate non-coded textual information regarding a patient,
specimen, or isolate.

Free text records are optional and are transmitted only when free text is available. Each free text
record type (patient, specimen, or isolate) can be individually selected for suppression for upload
operations.

• Patient free text record applies to the patient and is transmitted immediately after the patient
record or optional patient comment records.

• Specimen free text record is transmitted after a specimen record or after optional specimen
comment records, and before any isolate records.

• Isolate free text record is transmitted after the isolate record or any optional isolate comment
records and before any test/MIC records associated with an isolate.

Only one free text record of each type (patient, specimen, or isolate) may be transmitted per
patient. If more than one of each type is received in the same message only the first one
transmitted is saved.

A new free text record is rejected if any existing free text for that record association exists in the
database.

188 LabPro Interface Implementation Guide 9020-8006, Rev. B


Message layer - MicroScan record structure

Free text record attributes table


See Record format specifications (page 155) for more information about each column/code.

Table A-20: Free text record attributes


Seq Field Name Len XR Case DT Opt Up Opt Dn
1 Record ID 1 N U ZID R R
(Based on LabPro defined data)
Table C-1: MicroScan record
identifier codes (page 216)

2 Record Sequence Number 4 N U SI R

3 Text Association 1 N U ZID R


(Based on LabPro defined data)
Table C-16: Comment/free text
association (page 226)

4 Free Text 150 N M FT R R

Free text record field definitions table

Table A-21: Free text record field definitions


Seq # Field Name Field Definition
1 Record ID The identifier of the record. The identifier for the free text
record is
always F.

2 Record Sequence Number The sequence number of the free text record. Since only one
free text record can be associated with a patient or specimen
or isolate, an L will always appear in this field.

3 Text Association This field indicates the hierarchical association of the text
record.
The free text may be associated with a patient, specimen, or
isolate.
See Comment/free text association (page 226) acceptable
values.

4 Free Text The text for the patient, specimen or isolate free text record.

9020-8006, Rev. B LabPro Interface Implementation Guide 189


Message layer - MicroScan record structure

Request record (A)


The request record is used to transmit a “request for download” to another healthcare computer
system. It is generally used for those systems that do not initiate a download on the LIS.

When the request record is sent to another healthcare computer system, LabPro expects
acknowledgment or information from the receiver.

When the request (for download) record is transmitted to another healthcare computer system,
that system should wait approximately 10 seconds between receiving the end of transmission
and initiating the download transmission.

If no data is to be sent by the receiver, the receiver system should send an end record with the
error return code set to a value of 1. For details, see the next section, “End Record.”

Request record attributes table


See Record format specifications (page 155) for more information about each column/code.

Table A-22: Request record attributes


Seq Field Name Len XR Case DT Opt Up Opt Dn
1 Record ID 1 N U ZID R
(Based on LabPro defined data)
Table C-1: MicroScan record
identifier codes (page 216)

2 Reserved

3 Range Type Definition 1 N U ZID R

4 Not Used

5 Not Used

6 Test Type Qualifier 1 N U ZID R

7 Repeat Transmission OK Flag 1 N U ZYN R

8 Reserved

9 Not Used

190 LabPro Interface Implementation Guide 9020-8006, Rev. B


Message layer - MicroScan record structure

Request record field definitions table

Table A-23: Patient record field definitions


Seq # Field Name Field Definition
1 Record ID The identifier of the record. The identifier for the request
record is always A.

2 Reserved

3 Range Type Definition The character A is transmitted. This indicates that (A)ll
specimens to be transmitted should be sent.

4 Not Used N/A

5 Not Used N/A

6 Test Type Qualifier The value in this field is a qualifier for the download request.
For LIS operations, this field should be ignored and all
applicable data should be transmitted. The field value will
always be A.

7 Repeat Transmission OK Indicates that information previously transmitted should not


Flag be retransmitted. This field always contains N.

8 Reserved N/A

9 Not Used N/A

9020-8006, Rev. B LabPro Interface Implementation Guide 191


Message layer - MicroScan record structure

End record (L)

THIS RECORD IS REQUIRED FOR UPLOAD OPERATIONS AND RECOMMENDED FOR


DOWNLOAD OPERATIONS

The end record is optional and can be used to indicate that all data for a patient has been sent
and/or that all data has been transmitted for this communication session.

• The end record (unless suppressed) is sent after each patient data block during upload
operations. This is recommended, but not required for download operations.

• End record can be suppressed for upload operations.

If this is the last record of the transmission, then the transmission must be terminated. There are
two ways to signal end of transmission:

• Send an <EOT> character following this record.

• Set the end of transmission flag in this record to Y.

If the transmission is not terminated properly, the LabPro Interface program reports a timeout
error.

End record attributes table


See Record format specifications (page 155) for more information about each column/code.

Table A-24: End record attributes


Seq Field Name Len XR Case DT Opt Up Opt Dn
1 Record ID 1 N U ZID R R
(Based on LabPro defined data)
Table C-1: MicroScan record
identifier codes (page 216)

2 Record Sequence Number 4 N U SI R

3 End of Transmission Flag 1 N U ZYN R O

4 Error Return Code 2 N NM O O


(Based on LabPro defined data)
Table C-17: Error return codes
(page 226)

192 LabPro Interface Implementation Guide 9020-8006, Rev. B


Message layer - MicroScan record structure

End record field definitions table

Table A-25: Patient record field definitions


Seq # Field Name Field Definition
1 Record ID The identifier of the record. The identifier for the end record is
always L.

2 Record Sequence Number The sequence number for the end record. This number
represents the numerical sequence of an end record within the
transmission message.
An L appearing in this field signifies that this is the last patient
block transmitted, in the message. When this record is used as
the end of transmission, the value of this field is always L.

3 End of Transmission Flag Y or N to indicate if this is the end of a patient block or to


signify the end of transmission. If the record is used to indicate
the end of a patient data block, the value is N except when the
last patient block has been transmitted.

4 Error Return Code A numeric indicator of a transmission error.


See Error return codes (page 226) for valid entries.

9020-8006, Rev. B LabPro Interface Implementation Guide 193


Message layer - MicroScan record structure

Transmitting customization records


Many data elements frequently need to be defined on both the sending and receiving systems.
In some cases, the codes for these data elements may be the same on both systems, and at other
times the codes might be different.

Building these tables manually can be time consuming. LabPro provides the ability to transmit a
number of different coded data element tables, that are defined by the customer or predefined
in LabPro, to another system.

LabPro can transmit the following customization tables.

• Institutions • Physicians
• Wards • Techs
• Services • Drug Tests
• Sources • Organisms
• Patient Comments • Specimen Comments
• Isolate Comments

When transmitting customization records, the customer may send all records or only those that
are flagged as active. The customer determines this at the time the customization data is selected
for transmission. One or more customization tables can be selected for transmission in a single
communication session.

When transmitting multiple customization tables, an end record, unless suppressed, is sent after
all records for a given table are transmitted. The sequence of the table blocks is determined by
LabPro, and the tables selected by the customer.

Customization records have no hierarchical relationship. Customization records are never


combined in a message containing patient, specimen, isolate or test/MIC records.
All customization records are for upload only.

194 LabPro Interface Implementation Guide 9020-8006, Rev. B


Message layer - MicroScan record structure

Sample upload of customized tables


LabPro determines the sequence of the table blocks and which tables the customer has selected.

Use these abbreviations in the following sample transmission:

• (R) - This record can be repeated consecutively. For example, multiple comments
per specimen.

• (opt.) - Optional record displays when available/enabled.

All examples are shown using ENQ/ACK and ACK/NAK protocol.

<STX> Header Record (opt.)<CR><LF>C1 C2<ETX>


<ACK>
<STX> Ward Table records (R)<CR><LF>C1 C2<ETX>
<ACK>
<STX> End record (opt.)<CR><LF>C1 C2<ETX>
<ACK>
<STX> Source Table records (R) <CR><LF>C1 C2<ETX>
<ACK>
<STX> End record (opt.)<CR><LF>C1 C2<ETX>
<ACK>
<STX> Patient Comment Table records (R)<CR><LF>C1 C2<ETX>
<ACK>
<STX> End record (opt.)<CR><LF>C1 C2<ETX>
<ACK>
<STX> Specimen Comment Table records (R) <CR><LF>C1 C2<ETX>
<ACK>
<STX> End record (opt.)<CR><LF>C1 C2<ETX>
<ACK>
<STX> Isolate Comment Table records (R) <CR><LF>C1 C2<ETX>
<ACK>
<STX> End record (opt.)<CR><LF>C1 C2<ETX>
<ACK>
<STX> Physician Table records (R) <CR><LF>C1 C2<ETX>
<ACK>
<STX> End record (opt.)<CR><LF>C1 C2<ETX>
<ACK>
<STX> Service Table records (R) <CR><LF>C1 C2<ETX>
<ACK>
<STX> End record (opt.)<CR><LF>C1 C2<ETX>
<ACK>
<STX> Institution Table records (R) <CR><LF>C1 C2<ETX>
<ACK>
<STX> End record (opt.)<CR><LF>C1 C2<ETX>
<ACK>
<STX> Test Table records (R) <CR><LF>C1 C2<ETX>
<ACK>
<STX> End record (opt.)<CR><LF>C1 C2<ETX>
<ACK>
<STX> Organism Table records (R) <CR><LF>C1 C2<ETX>
<ACK>
<STX> End record (opt.)<CR><LF>C1 C2<ETX>

9020-8006, Rev. B LabPro Interface Implementation Guide 195


Message layer - MicroScan record structure

<ACK>
<STX> Tech Table records (R) <CR><LF>C1 C2<ETX>
<ACK>
<STX> End record (opt.)<CR><LF>C1 C2<ETX>
< EOT>

Customized institution record (K)


The customized institution record can be transmitted to another healthcare computer system.
The customer can send all institutions or only those flagged as active.

Customized institution record attributes


See Record format specifications (page 155) for more information about each column/code.

Table A-26: Customized institution record attributes


Seq Field Name Len XR Case DT Opt Up Opt Dn
1 Record ID 1 N U ZID R
(Based on LabPro defined data)
Table C-1: MicroScan record
identifier codes (page 216)

2 Cross-Reference Value 32 N M ST R

3 Institution Code 8 N U IS R

4 Institution Description 32 N M ST R

Customized institution record field definitions

Table A-27: Customized institution record field definitions


Seq # Field Name Field Definition
1 Record ID The identifier of the record. The identifier for the customized
institution record is always K.

2 Cross-Reference Value The user-defined cross-reference value for the healthcare


computer system’s respective institution code. If no cross-
reference value exists for an institution code, the LabPro
institution code is redundantly transmitted in this field.

3 Institution Code The code for an institution as defined by the customer in LabPro
software.

4 Institution Description The description of the institution as defined by the customer in


LabPro software.

196 LabPro Interface Implementation Guide 9020-8006, Rev. B


Message layer - MicroScan record structure

Customized ward record (W)


The customized ward record can be transmitted to another healthcare computer system.
The customer can send all wards or only those flagged as active.

Customized ward record attributes


See Record format specifications (page 155) for more information about each column/code.

Table A-28: Customized ward record attributes


Seq Field Name Len XR Case DT Opt Up Opt Dn
1 Record ID 1 N U ZID R
(Based on LabPro defined data)
Table C-1: MicroScan record
identifier codes (page 216)

2 Cross-Reference Value 32 N M ST R

3 Ward Code 8 N U IS R

4 Ward Description 32 N M ST R

Customized ward record field definitions

Table A-29: Customized ward record field definitions


Seq # Field Name Field Definition
1 Record ID The identifier of the record. The identifier for the customized
ward record is always W.

2 Cross-Reference Value The user-defined cross-reference value for the healthcare


computer systems respective ward code. If no cross-reference
value exists for a ward code, the LabPro ward code is
redundantly transmitted in this field.

3 Ward Code The code for a ward as defined by the customer in LabPro
software.

4 Ward Description The description of the ward as defined by the customer in


LabPro software.

9020-8006, Rev. B LabPro Interface Implementation Guide 197


Message layer - MicroScan record structure

Customized service record (J)


The customized service record can be transmitted to another healthcare computer system.
The customer can send all services or only those flagged as active.

Customized service record attributes


See Record format specifications (page 155) for more information about each column/code.

Table A-30: Customized service record attributes


Seq Field Name Len XR Case DT Opt Up Opt Dn
1 Record ID 1 N U ZID R
(Based on LabPro defined data)
Table C-1: MicroScan record
identifier codes (page 216)

2 Cross-Reference Value 32 N M ST R

3 Service Code 8 N U IS R

4 Service Description 32 N M ST R

Customized service record field definitions

Table A-31: Customized service record field definitions


Seq # Field Name Field Definition
1 Record ID The identifier of the record. The identifier for the customized
service record is always J.

2 Cross-Reference Value The user-defined cross-reference value for the healthcare


computer systems respective service code.
If no cross-reference value exists for a service code, the LabPro
service code is redundantly transmitted in this field.

3 Service Code The code for a service as defined by the customer in LabPro
software.

4 Service Description The description of the service as defined by the customer in


LabPro software.

198 LabPro Interface Implementation Guide 9020-8006, Rev. B


Message layer - MicroScan record structure

Customized source record (X)


The customized source record can be transmitted to another healthcare computer system.
The customer can select to send all sources or only those flagged as active.

Customized source record attributes


See Record format specifications (page 155) for more information about each column/code.

Table A-32: Customized source record attributes


Seq Field Name Len XR Case DT Opt Up Opt Dn
1 Record ID 1 N U ZID R
(Based on LabPro defined data)
Table C-1: MicroScan record
identifier codes (page 216)

2 Cross-Reference Value 32 N M ST R

3 Source Code 8 N U IS R

4 Source Description 32 N M ST R

5 Urine Source Flag 1 N U ZYN R

Customized source record field definitions

Table A-33: Customized source record field definitions


Seq # Field Name Field Definition
1 Record ID The identifier of the record. The identifier for the customized
source record is always X.

2 Cross-Reference Value The user-defined cross-reference value for the healthcare


computer systems respective source code.
If no cross-reference value exists for a source code, the LabPro
source code is redundantly transmitted in this field.

3 Source Code The code for the source as defined by the customer in LabPro
software.

4 Source Description The description of the source as defined by the customer in


LabPro software.

5 Urine Source Flag Y or N to indicate if the source should be considered as urine.


Y (Yes) indicates that the source should be considered as
urine.
N (No) indicates that the source should not be considered as
urine.

9020-8006, Rev. B LabPro Interface Implementation Guide 199


Message layer - MicroScan record structure

Customized physician record (Z)


The customized physician record can be transmitted to another healthcare computer system.
The customer can send all physicians or only those flagged as active.

Customized physician record attributes


See Record format specifications (page 155) for more information about each column/code.

Table A-34: Customized physician record attributes


Seq Field Name Len XR Case DT Opt Up Opt Dn
1 Record ID 1 N U ZID R
(Based on LabPro defined data)
Table C-1: MicroScan record
identifier codes (page 216)

2 Cross-Reference Value 32 N M ST R

3 Physician Code 8 N U IS R

4 Physician Description 32 N M ST R

Customized physician record field definition

Table A-35: Customized physician record field definitions


Seq # Field Name Field Definition
1 Record ID The identifier of the record. The identifier for the customized
physician record is always Z.

2 Cross-Reference Value The user-defined cross-reference value for the healthcare


computer system's respective physician code.
If no cross-reference value exists for a physician code, the
LabPro physician code is redundantly transmitted in this field.

3 Physician Code The physician code as defined by the customer in LabPro


software.

4 Physician Description The physician name as defined by the customer in LabPro


software.

200 LabPro Interface Implementation Guide 9020-8006, Rev. B


Message layer - MicroScan record structure

Customized tech record (I)


The customized tech record can be transmitted to another healthcare computer system.
The customer can send all techs or only those flagged as active.

Customized tech record attributes


See Record format specifications (page 155) for more information about each column/code.

Table A-36: Customized tech record attributes


Seq Field Name Len XR Case DT Opt Up Opt Dn
1 Record ID 1 N U ZID R
(Based on LabPro defined data)
Table C-1: MicroScan record
identifier codes (page 216)

2 Cross-Reference Value 32 N M ST R

3 Tech Code 8 N U IS R

4 Tech Description 32 N M ST R

Customized tech record field definitions

Table A-37: Customized tech record field definitions


Seq # Field Name Field Definition
1 Record ID The identifier of the record. The identifier for the customized
tech record is always I.

2 Cross-Reference Value The user-defined cross-reference value for the healthcare


computer system's respective tech code.
If no cross-reference value exists for a tech code, the LabPro
tech code is redundantly transmitted in this field.

3 Tech Code The Tech Code as defined by the customer in LabPro software.

4 Tech Description The tech name as defined by the customer in LabPro software.

9020-8006, Rev. B LabPro Interface Implementation Guide 201


Message layer - MicroScan record structure

Customized test record (D)


The customized test record can be transmitted to another healthcare computer system.
All records for drug tests, either defined by the customer or predefined in LabPro, are
transmitted.

Customized test record attributes


See Record format specifications (page 155) for more information about each column/code.

Table A-38: Customized test record attributes


Seq Field Name Len XR Case DT Opt Up Opt Dn
1 Record ID 1 N U ZID R
(Based on LabPro defined data)
Table C-1: MicroScan record
identifier codes (page 216)

2 Cross-Reference Value 32 N M ST R

3 Drug Test Code 8 N U ZID R


or
IS

4 Drug Test Description 32 N M ST R

5 Suppressed from Reports Flag 1 N U ZYN R

6 User-Defined (Offline) Drug Test 1 N U ZYN R


Flag

7 Not Used

8 Not Used

9 Not Used

10 Not Used

11 Not Used

12 Not Used

13 Not Used

14 Not Used

15 Not Used

16 Not Used

202 LabPro Interface Implementation Guide 9020-8006, Rev. B


Message layer - MicroScan record structure

Customized test record field definitions

Table A-39: Customized test record field definitions


Seq # Field Name Field Definition
1 Record ID The identifier of the record. The identifier for the customized
test record is always D.

2 Cross-Reference Value The user-defined cross-reference value for the healthcare


computer system’s respective drug test code. If no cross-
reference value exists for a drug test code, the LabPro drug
test code is redundantly transmitted in this field.

3 Drug Test Code The code for a drug test as defined by the customer or
predefined in LabPro:
If the drug test code data type is ZID, the user-defined (offline)
drug test flag will have a value of N.
If the user-defined (offline) drug test flag is Y, the drug test
code data type is IS.

4 Drug Test Description The description of the drug test as defined by the customer or
predefined in LabPro.

5 Suppressed from Reports Y or N to indicate if this test and its results are suppressed
Flag from the formulary.
Y (Yes) indicates this test and its results are suppressed from
the formulary and should not appear on chartable patient
reports.
N (No) indicates this test is on the formulary and the results
may appear on chartable patient reports.
Note: This flag does not indicate a conditional suppression,
which is based on patient/specimen demographics or isolate
results.
Conditional suppression flagging is handled in the test/MIC
(M) record from patient results.

6 User-defined (Offline) Drug Y or N to indicate if the drug test is a user-defined (offline)


Test Flag drug test or is predefined in LabPro:
Y (Yes) indicates the drug test is a user-defined test.
N (No) indicates the drug test is a predefined drug test.

7 Not Used N/A

8 Not Used N/A

9 Not Used N/A

10 Not Used N/A

11 Not Used N/A

12 Not Used N/A

9020-8006, Rev. B LabPro Interface Implementation Guide 203


Message layer - MicroScan record structure

Table A-39: Customized test record field definitions (continued)


Seq # Field Name Field Definition
13 Not Used N/A

14 Not Used N/A

15 Not Used N/A

16 Not Used N/A

Customized organism record (O)


The customized organism record can be transmitted to another healthcare computer system.
The customer can send all organisms or only those flagged as active.

Customized organism record attributes


See Record format specifications (page 155) for more information about each column/code.

Table A-40: Customized organism record attributes


Seq Field Name Len XR Case DT Opt Up Opt Dn
1 Record ID 1 N U ZID R
(Based on LabPro defined data)
Table C-1: MicroScan record
identifier codes (page 216)

2 Organism Code 9 N U ZID or R


IS

3 Organism Short Name Description 20 N M ST R

4 Organism Long Name Description 52 N M ST R

5 Cross-reference Value 32 N M ST R

Customized organism record field definitions

Table A-41: Customized organism record field definitions


Seq # Field Name Field Definition
1 Record ID The identifier of the record. The identifier for the customized
organism record is always O.

2 Organism Code The code for an organism as defined by the customer or


predefined in LabPro.

204 LabPro Interface Implementation Guide 9020-8006, Rev. B


Message layer - MicroScan record structure

Table A-41: Customized organism record field definitions (continued)


Seq # Field Name Field Definition
3 Organism Short Name The short or abbreviated name description of the organism as
Description defined by the customer or predefined in LabPro.

4 Organism Long Name The long name description of the organism as defined by the
Description customer or predefined in LabPro.

5 Cross-Reference Value The user-defined cross-reference value for the healthcare


computer system’s respective organism code.
If no cross-reference value exists for an organism code, the
LabPro organism code is redundantly transmitted in this field.
The cross-reference value might be alphanumeric.

Customized patient comment record (G)


The customized patient comment record can be transmitted to another healthcare computer
system. The customer can send all patient comments or only those flagged as active.

Customized patient comment record attributes


See Record format specifications (page 155) for more information about each column/code.

Table A-42: Customized patient comment record attributes


Seq Field Name Len XR Case DT Opt Up Opt Dn
1 Record ID 1 N U ZID R
(Based on LabPro defined data)
Table C-1: MicroScan record
identifier codes (page 216)

2 Cross-Reference Value 32 N M ST R

3 Patient Comment Code 8 N U IS R

4 Not Used

5 Patient Comment Description 32 N M ST R

6 Patient Comment Reportable Flag 1 N U ZYN R

9020-8006, Rev. B LabPro Interface Implementation Guide 205


Message layer - MicroScan record structure

Customized patient comment record field definitions

Table A-43: Customized patient comment record field definitions


Seq # Field Name Field Definition
1 Record ID The identifier of the record. The identifier for the customized
patient comment record is always G.

2 Cross-Reference Value The user-defined cross-reference value for the healthcare


computer system’s respective patient comment code.
If no cross-reference value exists for a patient comment code,
the LabPro patient comment code is redundantly transmitted
in this field.

3 Patient Comment Code The code for a patient comment as defined by the customer in
LabPro software.

4 Not Used N/A

5 Patient Comment The full text of the patient comment as defined by the
Description customer in LabPro software.

6 Patient Comment Y or N to indicate if this patient comment should be printed on


Reportable Flag chartable patient reports.
Y (Yes) indicates the patient comment should appear on
chartable patient reports.
N (No) indicates the patient comment should not be included
on chartable patient reports.

206 LabPro Interface Implementation Guide 9020-8006, Rev. B


Message layer - MicroScan record structure

Customized specimen comment record (Y)


The customized specimen comment record can be transmitted to another healthcare computer
system. The customer can select to send either all specimen comments or only those flagged as
active.

Customized specimen comment record attributes


See Record format specifications (page 155) for more information about each column/code.

Table A-44: Customized specimen comment record attributes


Seq Field Name Len XR Case DT Opt Up Opt Dn
1 Record ID 1 N U ZID R
(Based on LabPro defined data)
Table C-1: MicroScan record
identifier codes (page 216)

2 Cross-Reference Value 32 N M ST R

3 Specimen Comment Code 8 N U IS R

4 Not Used

5 Specimen Comment Description 32 N M ST R

6 Specimen Comment Reportable 1 N U ZYN R


Flag

Customized specimen comment record field definitions

Table A-45: Customized specimen comment record field definitions


Seq # Field Name Field Definition
1 Record ID The identifier of the record. The identifier for the customized
specimen comment record is always Y.

2 Cross-Reference Value The user-defined cross-reference value for the healthcare


computer system’s respective specimen comment code.
If no cross-reference value exists for a specimen comment
code, the LabPro specimen comment code is redundantly
transmitted in this field.

3 Specimen Comment Code The code for a specimen comment as defined by the
customer in LabPro software.

9020-8006, Rev. B LabPro Interface Implementation Guide 207


Message layer - MicroScan record structure

Table A-45: Customized specimen comment record field definitions (continued)


Seq # Field Name Field Definition
4 Not Used N/A

5 Specimen Comment The full text of the specimen comment as defined by the
Description customer in LabPro software.

6 Specimen Comment Y or N to indicate if this specimen comment should be printed


Reportable Flag on chartable patient reports.
Y (Yes) indicates the specimen comments should appear on
chartable patient reports.
N (No) indicates the specimen comments should not be
included on chartable patient reports.

Customized isolate comment record (E)


The customized isolate comment record can be transmitted to another healthcare computer
system. The customer can send all isolate comments or only those flagged as active.

Customized isolate comment record attributes


See Record format specifications (page 155) for more information about each column/code.

Table A-46: Customized isolate comment record attributes


Seq Field Name Len XR Case DT Opt Up Opt Dn
1 Record ID 1 N U ZID R
(Based on LabPro defined data)
Table C-1: MicroScan record
identifier codes (page 216)

2 Cross-Reference Value 32 N M ST R

3 Isolate Comment Code 8 N U IS R

4 Not Used

5 Isolate Comment Description 32 N M ST R

6 Isolate Comment Reportable Flag 1 N U ZYN R

208 LabPro Interface Implementation Guide 9020-8006, Rev. B


Message layer - MicroScan record structure

Customized isolate comment record field definitions

Table A-47: Patient record field definitions


Seq # Field Name Field Definition
1 Record ID The identifier of the record. The identifier for the customized
isolate comment record is always E.

2 Cross-Reference Value The user-defined cross-reference value for the healthcare


computer system's respective isolate comment code.
If no cross-reference value exists for an isolate comment code,
the LabPro isolate comment code is redundantly transmitted
in this field.

3 Isolate Comment Code The code for an isolate comment as defined by the customer
in LabPro software.

4 Not Used N/A

5 Isolate Comment The full text of the isolate comment as defined by the
Description customer in LabPro software.

6 Isolate Comment Y or N to indicate if this isolate comment should be printed


Reportable Flag on chartable patient reports.
Y (Yes) indicates the isolate comments should appear on
chartable patient reports.
N (No) indicates the isolate comments should not be included
on chartable patient reports.

9020-8006, Rev. B LabPro Interface Implementation Guide 209


This page intentionally left blank

210 LabPro Interface Implementation Guide 9020-8006, Rev. B


Appendix B

Device type default values


This table contains the configuration default values for each device type.

Table B-1: Device type default values


Configuration option LIS SDLN
PHYSICAL LAYER Serial File
File Name Patient Data Export File Name:
SDLN.EXP
Custom Export File Name:
SDLN.CUS

Connect Comm 4

Baud Rate 9600

Data Bits 8

Parity None

Stop Bits 1

Hardware Flow Control None

DATA LINK LAYER MicroScan Null


Checksum None

Time Out 15

Line Bidding and Software Flow Control XON/XOFF

Start of Record ASCII #2 {STX} ASCII #2 {STX}

End of Text ASCII #3 {ETX} ASCII #3 {ETX}

End of Trans ASCII #4 {EOT}

Carriage Return ASCII #13 {CR} ASCII #13 {CR}

9020-8006, Rev. B LabPro Interface Implementation Guide 211


Device type default values

Table B-1: Device type default values (continued)


Configuration option LIS SDLN
Line Feed ASCII #10 {LF} ASCII #10 {LF}

XON Character ASCII #17 {DC1}

XOFF Character ASCII #19 {DC3}

Ack ASCII #6 {ACK}

Neg Ack ASCII #21 {NAK}

Enquiry ASCII #5 {ENQ}

Prefix None None

Suffix 1 None None

Suffix 2 None None

Suffix 3 None None

Cancel ASCII #24 {CAN} ASCII #24 {CAN}

Maximum number of bytes in frame text

Use <CR> before <ETB>

Use <LF> character

Message Layer MicroScan MicroScan


Data Formatting

Field Delimiter ASCII #44 {,} ASCII #124 {|}

String Delimiter ASCII #34 {“} None

Component delimiter

Repeat delimiter

Escape delimiter

Use string delimiters in null fields Disabled Disabled

Use String Delimiter in single character Disabled Disabled


fields

Organism Name Format Long Description Long Description

Transmission Sort Order Patient ID Specimen number

Transmission of Systemic and Urine Each interpretation Each interpretation in separate


Interpretations in separate field field

Transmission of Results for Combined Test Each test group in Each test group in separate isolate
Groups separate isolate records
records

Date Format YYYYMMDD YYYYMMDD

212 LabPro Interface Implementation Guide 9020-8006, Rev. B


Device type default values

Table B-1: Device type default values (continued)


Configuration option LIS SDLN
Date Delimiter NONE NONE

Time Format HHMM 24 Hour HHMM 24 Hour

Time Delimiter NONE NONE

Data Suppressions Isolate Trace Record Patient First/Last Name


Specimen and Isolate Free Text
Records
User-defined Test Group Record
User-defined Test Record
Patient and Isolate Comment
Records
Specimen and Isolate Tech
Descriptions
Isolate Trace Record

Custom Data Transmitted None All (Active and inactive)


Institutions
Organism Names
Services
Sources
Drug Tests
Wards

INTERFACE LOG
Configure Error suppressions None None

Configure auto-delete 1 day 1 day

*Setting cannot be changed.

9020-8006, Rev. B LabPro Interface Implementation Guide 213


This page intentionally left blank

214 LabPro Interface Implementation Guide 9020-8006, Rev. B


Appendix C

Setup and installation tables


This section includes the following topics:

• MicroScan record identifier codes (page 216)

• ASCII character set values (page 217)

• Extended ASCII character set values (page 219)

• Checksum type (page 220)

• Protocol type (page 221)

• Gender (page 222)

• Patient status (page 222)

• Specimen status (page 222)

• Test results for beta lactamase, oxidase, indole or Thymidine-dependent strain (page 223)

• Synergy screen results (page 223)

• ESBL results (page 223)

• Organism class/family (page 224)

• Organism set (page 224)

• Offline test interpretations (page 224)

• Interpretations (page 225)

• Comment/free text association (page 226)

• Error return codes (page 226)

9020-8006, Rev. B LabPro Interface Implementation Guide 215


Setup and installation tables

MicroScan record identifier codes

Table C-1: MicroScan record identifier codes


Value Description

A Request Record

B Specimen Record

C Comment Record

D Test Customization

E Isolate Comment Customization

F Free Text Record

G Patient Comment Customization

H Header Record

I Tech Customization

J Service Customization

K Institution Customization

L End Record

M Test/MIC Record

O Organism Customization

P Patient Record

Q Trace Record

R Result/Isolate Record

T Therapy Customization

W Ward Customization

X Source Customization

Y Specimen Comment Customization

Z Physician Customization

216 LabPro Interface Implementation Guide 9020-8006, Rev. B


Setup and installation tables

ASCII character set values

Table C-2: ASCII character set values


Dec Hex Value Dec Hex Value Dec Hex Value Dec Hex Value
000 00 ^@ <NUL> 032 20 <SPC 064 40 @ 096 60 `
>

001 01 ^A <SOH> 033 21 ! 065 41 A 097 61 A

002 02 ^B <STX> 034 22 " 066 42 B 098 62 B

003 03 ^C <ETX> 035 23 # 067 43 C 099 63 C

004 04 ^D <EOT> 036 24 $ 068 44 D 100 64 D

005 05 ^E <ENQ> 037 25 % 069 45 E 101 65 E

006 06 ^F <ACK> 038 26 & 070 46 F 102 66 F

007 07 ^G <BEL> 039 27 ' 071 47 G 103 67 G

008 08 ^H <BS> 040 28 ( 072 48 H 104 68 H

009 09 ^I <HT> 041 29 ) 073 49 I 105 69 I

010 0A ^J <LF> 042 2A * 074 4A J 106 6A J

011 0B ^K <VT> 043 2B + 075 4B K 107 6B K

012 0C ^L <FF> 044 2C , 076 4C L 108 6C L

013 0D ^M <CR> 045 2D - 077 4D M 109 6D M

014 0E ^N <SO> 046 2E . 078 4E N 110 6E N

015 0F ^O <SI> 047 2F / 079 4F O 111 6F O

016 10 ^P <DLE> 048 30 0 080 50 P 112 70 P

017 11 ^Q <DC1> 049 31 1 081 51 Q 113 71 Q

018 12 ^R <DC2> 050 32 2 082 52 R 114 72 R

019 13 ^S <DC3> 051 33 3 083 53 S 115 73 S

020 14 ^T <DC4> 052 34 4 084 54 T 116 74 T

021 15 ^U <NAK> 053 35 5 085 55 U 117 75 U

022 16 ^V <SYN> 054 36 6 086 56 V 118 76 V

023 17 ^W <ETB> 055 37 7 087 57 W 119 77 W

024 18 ^X <CAN> 056 38 8 088 58 X 120 78 X

025 19 ^Y <EM> 057 39 9 089 59 Y 121 79 Y

026 1A ^Z <SUB> 058 3A : 090 5A Z 122 7A Z

9020-8006, Rev. B LabPro Interface Implementation Guide 217


Setup and installation tables

Table C-2: ASCII character set values (continued)


Dec Hex Value Dec Hex Value Dec Hex Value Dec Hex Value
027 1B ^[ <ESC> 059 3B ; 091 5B [ 123 7B {

028 1C ^\ <FS> 060 3C < 092 5C \ 124 7C |

029 1D ^] <GS> 061 3D = 093 5D ] 125 7D }

030 1E ^^ <RS> 062 3E > 094 5E ^ 126 7E ~

031 1F ^_ <US> 063 3F ? 095 5F _ 127 7F <DEL>

218 LabPro Interface Implementation Guide 9020-8006, Rev. B


Setup and installation tables

Extended ASCII character set values


LabPro supports the following characters from the extended ASCII character set.

Table C-3: Extended ASCII character set values


Dec Hex Value Dec Hex Value Dec Hex Value
128 80 Ç 146 92 Æ 165 A5 Ñ

129 81 ü 147 93 ô 166 A6 ª

130 82 é 148 94 ö 167 A7 º

131 83 â 149 95 ò 168 A8 ¿

132 84 ä 150 96 û 170 AA ¬

133 85 à 151 97 ù 171 AB ½

134 86 å 152 98 ÿ 172 AC ¼

135 87 ç 153 99 Ö 173 AD ¡

136 88 ê 154 9A Ü 174 AE «

137 89 ë 155 9B ¢ 175 AF »

138 8A è 156 9C £ 225 E1 ß

139 8B ï 157 9D ¥ 230 E6 µ

140 8C î 160 A0 á 241 F1 ±

141 8D ì 161 A1 í 246 F6 ÷

142 8E Ä 162 A2 ó 248 F8 °

143 8F Å 163 A3 ú 250 FA ·

144 90 É 164 A4 ñ 253 FD ²

145 91 æ

NOTE:
LabPro forces non-numeric text in the specimen number, patient ID, and isolate number fields
to upper case.

If the LabPro Interface receives the lower case characters indicated by the shaded cells in the
patient ID, specimen number, or isolate number fields an error occurs and LabPro stores and
displays the lower case characters as upper case.

When the LabPro Interface transmits specimen numbers, patient ID numbers, and isolate
numbers with these characters back to the LIS they are converted as indicated in the following
table.

9020-8006, Rev. B LabPro Interface Implementation Guide 219


Setup and installation tables

Table C-4: Converted ASCII character values


Extended ASCII character Converted ASCII value
131, 133, 160 65 (A)

136, 137, 138 69 (E)

139, 140, 141, 161 73 (I)

147, 149, 162 79 (O)

150, 151, 163 85 (U)

Checksum type

Table C-5: Checksum type


Value Description

Null None

1 XOR-ASCII

2 SUM-ASCII

3 XOR-HEX

4 SUM-HEX

220 LabPro Interface Implementation Guide 9020-8006, Rev. B


Setup and installation tables

Protocol type

Table C-6: Protocol type


Value Description

1 XON/XOFF

2 ACK/NAK

3 XON/XOFF + ACK/NAK

4 DTR/DSR

5 XON/XOFF + DTR/DSR

6 ACK/NAK + DTR/DSR

7 XON/XOFF + ACK/NAK + DTR/DSR

8 RTS/CTS

9 XON/XOFF + RTS/CTS

10 ACK/NAK + RTS/CTS

11 XON/XOFF + ACK/NAK + RTS/CTS

12 DTR/DSR + RTS/CTS

13 XON/XOFF + DTR/DSR + RTS/CTS

14 ACK/NAK + DTR/DSR + RTS/CTS

15 XON/XOFF + ACK/NAK + DTR/DSR + RTS/CTS

17 XON/XOFF + ENQ

18 ACK/NAK + ENQ

19 XON/XOFF + ACK/NAK + ENQ

20 DTR/DSR + ENQ

21 XON/XOFF + DTR/DSR + ENQ

22 ACK/NAK + DTR/DSR + ENQ

23 XON/XOFF + ACK/NAK + DTR/DSR + ENQ

24 RTS/CTS + ENQ

25 XON/XOFF + RTS/CTS + ENQ

26 ACK/NAK + RTS/CTS + ENQ

27 XON/XOFF + ACK/NAK + RTS/CTS + ENQ

28 DTR/DSR + RTS/CTS + ENQ

9020-8006, Rev. B LabPro Interface Implementation Guide 221


Setup and installation tables

Table C-6: Protocol type (continued)


Value Description

29 XON/XOFF + DTR/DSR + RTS/CTS + ENQ

30 ACK/NAK + DTR/DSR + RTS/CTS + ENQ

XON/XOFF + ACK/NAK + DTR/DSR + RTS/CTS


31 + ENQ

Gender

Table C-7: Gender


Value Description

F Female

M Male

Patient status

Table C-8: Patient status


Value Description

I Inpatient

O Outpatient

Specimen status

Table C-9: Specimen status


Value Description

F Finalized

P Preliminary

222 LabPro Interface Implementation Guide 9020-8006, Rev. B


Setup and installation tables

Test results for beta lactamase, oxidase, indole or


Thymidine-dependent strain

Table C-10: Test results for beta lactamase, oxidase, indole or Thymidine-dependent strain
Description LIS Device Value
Negative N, R, 0
Positive P, S, Y, 1

Synergy screen results

Table C-11: Synergy screen results


Description Value
Resistant R
Susceptible S

ESBL results

Table C-12: ESBL results


Description LIS device value
Negative Neg
Positive Pos
Suspected Sus

9020-8006, Rev. B LabPro Interface Implementation Guide 223


Setup and installation tables

Organism class/family

Table C-13: Organism class/family


Value LIS device type

0
Streptococcaceae, Gram Neg Bacilli,
1 Fermenter, Fastidious, or Yeast

Staph and Related Genera, (for Anaerobe)


2 Gram Pos Bacilli, or Non-Fermenter

3 Cocci (for Anaerobe)

4 Clostridia (for Anaerobe)

9 Other

Organism set

Table C-14: Organism set


Value Description

1 Gram Negative

2 Gram Positive

3 Anaerobe

4 Fastidious

6 Yeast

9 Other

Offline test interpretations

Offline test interpretations


Value Description

I Intermediate

N/R Not Reported

R Resistant

S Susceptible

224 LabPro Interface Implementation Guide 9020-8006, Rev. B


Setup and installation tables

Interpretations

Table C-15: Interpretations


Value Notes

BLAC Beta-lactamase positive. For reciprocal interface use, BLac may be accepted as R (resistant).

Indicates the organism is a suspected ESBL-producing organism. Confirmatory tests are needed to
differentiate ESBL from other beta-lactamases. For reciprocal interface use, EBL? may be accepted as R
EBL? (resistant).

Indicates the organism is confirmed as an extended-spectrum beta-lactamase (ESBL) producing


organism. The ESBL interpretations (ESBL, EBL? and R*) may be enabled using the LabPro Panel
Processing Customization. ESBL rules are NOT enabled when LabPro is installed. For reciprocal interface
ESBL use, ESBL may be accepted as R (resistant).

I Intermediate

IB appears in place of S for gram-negative organisms known to possess inducible beta lactamases.
Potentially they may become resistant to all beta-lactam drugs. Monitoring of patients during/after
therapy is recommended. Avoid other combined beta-lactam drugs.

IB The IB interpretation may be enabled using the LabPro Panel Processing Customization.

N/R Not reported

R Resistant

Indicates resistance to a specific drug based on another drug. Example: resistance to cephalosporins due
to extended-spectrum beta-lactamases (ESBL). For Synergy Plus Pos panels, resistance to ampicillin
R* based on resistance to oxacillin.

S Susceptible

Indicates the organism is susceptible to a specific drug based on another drug. Example: For Synergy
Plus Pos panels, susceptible to amoxacillin/clavulanate based on susceptible result for both penicillin and
S* oxacillin.

The TFG interpretation only appears for gram-positive organisms when the TFG growth well is negative.
This will occur only with Sulfamethoxazole and Trimethoprim/Sulfamethoxazole. For reciprocal interface
TFG use, TFG may be accepted as N/R (not reported).

<null> In the event that an interpretation is not calculated, LabPro sends a blank interpretation field.

The POS interpretation appears for both the Cefoxitin Screen (CfxS) > 4 or Inducible Clindamycin test
(ICd) >4/0.5.
The Cefoxitin Screen is intended to determine the susceptibility of staphylococci to the penicillinase-
stable beta-lactams.
The Inducible Clindamycin test is intended to detect inducible clindamycin resistance in staphylococci
that are intermediate or resistant to erythromycin and susceptible or intermediate to clindamycin.
POS Results of ICd are equivalent to the D-zone disk approximation test.

NEG The NEG interpretation appears for both the Cefoxitin Screen ≤ 4 or Inducible Clindamycin test ≤4/0.5.

9020-8006, Rev. B LabPro Interface Implementation Guide 225


Setup and installation tables

The CLSI interpretations can be cross-referenced.

NOTE:
Interpretation guidelines outlining MIC breakpoints and exceptions are detailed in the Adult
Therapy Guide Legend.

Comment/free text association

Table C-16: Comment/free text association


Value Description

B Specimen

P Patient

R Isolate

Error return codes

Table C-17: Error return codes


Value Description

0 No error

1 No information found

2 Error in request

3 User stopped transmission

4 Undefined error occurred

226 LabPro Interface Implementation Guide 9020-8006, Rev. B


Appendix D

Sample transmissions
This section includes the following topics:

• Sample transmission block flow diagram (page 228)

• Sample transmission for an LIS device (page 228)

9020-8006, Rev. B LabPro Interface Implementation Guide 227


Sample transmissions

Sample transmission block flow diagram


Patient ID 94257264792
Patient Comment Records
Patient Free Text Record

Specimen # 2003237:12579
Specimen Comment Records
Specimen Free Text Record
Isolate 1 with Test Group NC27
Test Records Associated with Test Group NC27
Isolate 2 with Test Group PC14
Test Records Associated with Test Group PC14
Isolate 2 with Test Group ADDL3
Test Records Associated with Test Group ADDL3
Specimen # 2003248:135871
Isolate 1 with Test Group NID2
Isolate 1 with Test Group NMP3
Test Records Associated with Test Group NMP3

Sample transmission for an LIS device


The following transmission represents a set of results transmitted by LabPro to another
healthcare computer system when using an LIS Device.

This transmission uses SUM-ASCII checksum method with null fields allowed and single character
field delimiters suppressed. The field delimiter is ASCII-44 (,) and the string delimiter is ASCII-34
("). Line bidding protocol (ENQ) was used in conjunction with the ACK/NAK software protocol.
The sort order is by Patient ID.

<ENQ>
<ACK>
<STX>"H","Community Hosp. Microbiology
Laboratory","","LabPro","3.01",",","""","N","2","18",15,"Y","",""<CR><LF>BC<ETX>
<ACK>
<STX>P,"L","94257264792","Smith","John R.",19760821,M, ,20030904,20030906,"456B",
"JR","Randolph,John","4E","4East","MED","Medicine","WH","Westside Hospital",Y,N,I, ,2,
"254871365"<CR><LF>AO<ETX>
<ACK>
<STX>C,"1","PEN", , "Patient Allergic to Penicillin", , P,Y<CR><LF>EK<ETX>
<ACK>
<STX>C,"L","NRPC, , "non reportable patient comment", , P,N<CR><LF>CL<ETX>
<ACK>
<STX>F,"L",P,"this is an example of patient free text"<CR><LF>FG<ETX>
<ACK>
<STX>B,"1","2003237:12579","94257264792","RMJ","Jones, Robert
M.","U","Urine",Y,20030825,0730,20030905,20030825,1025 , , ,F,2,Y,"3W","3West","BW","B
Wood",<CR><LF>E@<ETX>
<ACK>
<STX>C,"1","AMP", "Patient taking Ampicillin", B,Y<CR><LF>IK<ETX>
<ACK>
<STX>C,"L","NRSC", ,"Nonreportable specimen comment", ,B,N<CR><LF>E@<ETX>
<ACK>
<STX>F,"L",B,"this is an example of specimen free text"<CR><LF>KH<ETX>
<ACK>
<STX>R,"1","1","2003237:12579","NUC45"," Neg/Urine Combo 45",20030906, ,N , , ," 52","

228 LabPro Interface Implementation Guide 9020-8006, Rev. B


Sample transmissions

Shigella sp.", , ,N, , , , , , , , ,N, , , , ,20, ,N, ,1,1, ,0,F,<CR><LF>EN<ETX>,


<ACK>
<STX>"M","1","A/S","Amp/Sulbactam","<8/4",N, ,"S", , , , , , , , , , , , , , , , ,
,N<CR><LF>@E<ETX>
<ACK>
<STX>"M","2","AM","Ampicillin",">16",N, ,"R", , , , , , , , , , , , , , , , , ,N<CR><LF>@I<ETX>
<ACK>
<STX>"M","3","AUG","Amox/KClav",">16/8",N, ,"R", , , , , , , , , , , , , , , , , ,N<CR><LF>CO<ETX>
<ACK>
<STX>"M","4","AZT","Aztreonam","16",N, ,"I", , , , , , , , , , , , , , , , , ,N<CR><LF>@D<ETX>
<ACK>
<STX>"M","5","CAX","Ceftriaxone","<8",N, ,"S", , , , , , , , , , , , , , , , , ,N<CR><LF>@N<ETX>
<ACK>
<STX>"M","6","CAZ","Ceftazidime","4",N, ,"S", , , , , , , , , , , , , , , , , ,N<CR><LF>BN<ETX>
<ACK>
<STX>M,"7","CAZ/CA","Ceft/K Clav","2",N, , , , , , , , , , , , , , , , , , , ,N<CR><LF>NC<ETX>
<ACK>
<STX>"M","8","CFT","Cefotaxime","8",N, ,"S", , , , , , , , , , , , , , , , , ,N<CR><LF>DE<ETX>
<ACK>
<STX>"M","9","CFT/CA","Cefotaxime/KClavulanate",">4",N, , , , , , , , , , , , , , , , , , ,
,N<CR><LF>AB<ETX>
<ACK>
<STX>"M","10","CP","Ciprofloxacin","<1",N, ,"S", , , , , , , , , , , , , , , , , ,N<CR><LF>GG<ETX>
<ACK>
<STX>"M","11","CPE","Cefepime","<8",N,,"S", , , , , , , , , , , , , , , , , ,N<CR><LF>EA<ETX>
<ACK>
<STX>"M","12","ETP","Ertapenem","4",N, ,"I", , , , , , , , , , , , , , , , , ,N<CR><LF>@J<ETX>
<ACK>
<STX>"M","13","GAT","Gatifloxacin","<2",N, ,"S", , , , , , , , , , , , , , , , , ,N<CR><LF>DJ<ETX>
<ACK>
<STX>"M","14","GEM","Gemifloxacin","<0.25",N, ,"S", , , , , , , , , , , , , , , , , ,N<CR><LF>FF<ETX>
<ACK>
<STX>"M","15","IMP","Imipenem","<4",N, ,"S", , , , , , , , , , , , , , , , , ,N<CR><LF>EA<ETX>
<ACK>
<STX>"M","16","LVX","Levofloxacin","<2",N, ,"S", , , , , , , , , , , , , , , , , ,N<CR><LF>ED<ETX>
<ACK>
<STX>"M","17","P/T","Pip/Tazo","<16",N, ,"S", , , , , , , , , , , , , , , , , ,N<CR><LF>FG<ETX>
<ACK>
<STX>"M","18","T/S","Trimeth/Sulfa","<2/38",N, ,"S", , , , , , , , , , , , , , , , , ,N<CR><LF>@E<ETX>
<ACK>
<STX>"M","19","TE","Tetracycline","<4",N, ,"S", , , , , , , , , , , , , , , , , ,N<CR><LF>@G<ETX>
<ACK>
<STX>"M","L","TIM","Ticar/KClav","<16",N, ,"S", , , , , , , , , , , , , , , , , ,N<CR><LF>BA<ETX>
<ACK>
<STX>R,"2","2","2003237:12579","PC29","Pos Combo 29",20030906, N , ,"151","S.
epidermidis", ,P, , , ,P, , , , , ,N, , , , ,21, ,N, ,2,2, ,0,F, ,<CR><LF>FN<ETX>
<ACK>
<STX>M,”1","A/S","Amp/Sulbactam","<8/4",N, ,"R", , , , , , , , , , , , , , , , , ,N<CR><LF>@D<ETX>
<ACK>
<STX>"M","2","AM","Ampicillin","8",N, ,"R", , , , , , , , , , , , , , , , , ,N<CR><LF>@H<ETX>
<ACK>
<STX>"M","3","AUG","Amox/KClav","<4/2",N, ,"R", , , , , , , , , , , , , , , , , ,N<CR><LF>@D<ETX>
<ACK>
<STX>"M","4","C","Chloramphenicol","<8",N, ,"S", , , , , , , , , , , , , , , , , ,N<CR><LF>@H<ETX>
<ACK>
<STX>"M","5","CAX","Ceftriaxone",">32",N, ,"R", , , , , , , , , , , , , , , , , ,N<CR><LF>CD<ETX>
<ACK>
<STX>"M","6","CD","Clindamycin","<0.5",N, ,"S", , , , , , , , , , , , , , , , , ,N<CR><LF>DL<ETX>
<ACK>
<STX>"M","7","CFZ","Cefazolin","<8",N, ,"R", , , , , , , , , , , , , , , , , ,N<CR><LF>@E<ETX>
<ACK>

9020-8006, Rev. B LabPro Interface Implementation Guide 229


Sample transmissions

<STX>"M","8","DAP","Daptomycin","<0.5",N, ,"S", , , , , , , , , , , , , , , , , ,N<CR><LF>GC<ETX>


<ACK>
<STX>"M","9","E","Erythromycin",">4",N, ,"R", , , , , , , , , , , , , , , , , ,N<CR><LF>GO<ETX>
<ACK>
<STX>"M","10","GM","Gentamicin","<4",N, ,"S", , , , , , , , , , , , , , , , , ,N<CR><LF>@M<ETX>
<ACK>
<STX>"M","11","IMP","Imipenem",">8",N, ,"R", , , , , , , , , , , , , , , , , ,N<CR><LF>EJ<ETX>
<ACK>
<STX>"M","12","LVX","Levofloxacin",">4",N, ,"R", , , , , , , , , , , , , , , , , ,N<CR><LF>EE<ETX>
<ACK>
<STX>"M","13","LZD","Linezolid","<1",N, ,"S", , , , , , , , , , , , , , , , , ,N<CR><LF>C@<ETX>
<ACK>
<STX>"M","14","MER","Meropenem",">8",N, ,"R", , , , , , , , , , , , , , , , , ,N<CR><LF>BI<ETX>
<ACK>
<STX>"M","15","MXF","Moxifloxacin",">4",N, ,"R", , , , , , , , , , , , , , , , , ,N<CR><LF>D@<ETX>
<ACK>
<STX>"M","16","OX","Oxacillin",">2",N, ,"R", , , , , , , , , , , , , , , , , ,N<CR><LF>GA<ETX>
<ACK>
<STX>"M","17","RIF","Rifampin","<1",N, ,"S", , , , , , , , , , , , , , , , , ,N<CR><LF>DG<ETX>
<ACK>
<STX>"M","18","SYN","Synercid","<0.5",N, ,"S", , , , , , , , , , , , , , , , , ,N<CR><LF>E@<ETX>
<ACK>
<STX>"M","19","T/S","Trimeth/Sulfa","<0.5/9.5",N, ,"S", , , , , , , , , , , , , , , , , ,N<CR><LF>CD<ETX>
<ACK>
<STX>"M","20","TE","Tetracycline","<4",N, ,"S", , , , , , , , , , , , , , , , , ,N<CR><LF>@M<ETX>
<ACK>
<STX>"M","L","VA","Vancomycin","2",N, ,"S", , , , , , , , , , , , , , , , , ,N<CR><LF>GK<ETX>
<ACK>
<STX>R,"L","2","2003237:12579","ADDL3","Additional Drug Test Group
3", 20030906,N, , "151", "S. epidermidis", , , , , ,N, , , 7,N, 1, 2, 0, F, <CR><LF>KF<ETX>
<ACK>
<STX>M,"1","CEFT","Ceftibuten","0.004",Y,"S", , , , , , , , , , , , , , , , , , ,N<CR><LF>DN<ETX>
<ACK>
<STX>M,"2","GAT","Gatifloxacin","0.006",Y,"I", , , , , , , , , , , , , , , , , , ,N<CR><LF>MA<ETX>\
<ACK>
<STX>M,"3","CFD","Cefadroxil", ,Y,"S", , , , , , , , , , , , , , , , , , ,Y<CR><LF>LJ<ETX>
<ACK>
<STX>M,"L","GEM","Gemifloxacin", ,Y,"R", , , , , , , , , , , , , , , , , , ,N<CR><LF>NB<ETX>
<ACK>
<STX>B,"2","2003248:135871","94257264792","CA","Anderson, Catherine","EYE","Eye",
N,20030905,0946,20030904,20030905,1154 , ,F,O,N,"3W","3West" , ,<CR><LF>FG<ETX>
<ACK>
<STX>R,"1","1","2003248:135871","NID2","Neg ID 2",20030906, ,N, , ,"12”,"Citrobacter freundii", ,
, , , , , , N, , , 0 ,N, 1, 1, 0, F, <CR><LF>GF<ETX>
<ACK>
<STX>R,"L","1","2003248:135871”,"NMP3","Neg MIC Plus 3",20030906 , N , ,"12","Citrobacter
freundii" , , , , , ,N, , , 20,N, 1, 1, 0, F, <CR><LF>IE<ETX>
<ACK>
<STX>M,"1","A/S","Amp/Sulbactam","2/1",N, ,"IB", , , , , , , , , , , , , , , , , ,N<CR><LF>IL<ETX>
<ACK>
<STX>M,"2","AUG","Amox/K Clav","4/2",N, ,"IB", , , , , , , , , , , , , , , , ,,N<CR><LF>HF<ETX>
<ACK>
<STX>M,"3","AZ","Azlocillin",">64",N, , , , , , , , , , , , , , , , , , , ,N<CR><LF>NE<ETX>
<ACK>
<STX>M,"4","AZT","Aztreonam","2",N, ,"IB", , , , , , , , , , , , , , , , , ,N<CR><LF>CC<ETX>
<ACK>
<STX>M,"5","CAX","Ceftriaxone","4",N, ,"IB", , , , , , , , , , , , , , , , , ,N<CR><LF>NJ<ETX>
<ACK>
<STX>M,"6","CAZ","Ceftazidime","16",N, ,"I", , , , , , , , , , , , , , , , , ,N<CR><LF>LK<ETX>
<ACK>
<STX>M,"7","CFP","Cefoperazone","8",N, ,"IB", , , , , , , , , , , , , , , , , ,N<CR><LF>EF<ETX>

230 LabPro Interface Implementation Guide 9020-8006, Rev. B


Sample transmissions

<ACK>
<STX>M,"8","CFT","Cefotaxime","32",N, ,"I", , , , , , , , , , , , , , , , , ,N<CR><LF>FJ<ETX>
<ACK>
<STX>M,"9","CFX","Cefoxitin","4",N, ,"IB", , , , , , , , , , , , , , , , , ,N<CR><LF>BD<ETX>
<ACK>
<STX>M,"10","CP","Ciprofloxacin","0.5",N, ,"S", , , , , , , , , , , , , , , , , ,N<CR><LF>LM<ETX>
<ACK>
<STX>M,"11","CPD","Cefpodoxime","1",N, ,”IB", , , , , , , , , , , , , , , , ,N<CR><LF>@J<ETX>
<ACK>
<STX>M,"12","CPE","Cefepime","<=2",N, ,"S", , , , , , , , , , , , , , , , ,N<CR><LF>OI<ETX>
<ACK>
<STX>M,"13","CZ","Ceftizoxime","8",N, ,"IB", , , , , , , , , , , , , , , , ,N<CR><LF>NM<ETX>
<ACK>
<STX>M,"14","IMP","Imipenem","1",N, ,"S", , , , , , , , , , , , , , , , , ,N<CR><LF>JE<ETX>
<ACK>
<STX>M,"15","MER","Meropenem","2",N, ,"S", , , , , , , , , , , , , , , , , ,N<CR><LF>AI<ETX>
<ACK>
<STX>M,"16","MZ","Mezlocillin","64",N, ,"I", , , , , , , , , , , , , , , , , ,N<CR><LF>NE<ETX>
<ACK>
<STX>M,"17","NT","Netilmicin","4",N, ,“S", , , , , , , , , , , , , , , , , , ,N<CR><LF>CO<ETX>
<ACK>
<STX>M,"18","P/T","Pip/Tazo","16",N, ,"IB", , , , , , , , , , , , , , , , ,N<CR><LF>LF<ETX>
<ACK>
<STX>M,"19","SFX","Sparfloxacin","0.5",N, ,"S", , , , , , , , , , , , , , , , ,N<CR><LF>LM<ETX>
<ACK>
<STX>M,"L","TIM","Ticar/K Clav","64",N, ,"I", , , , , , , , , , , , , , , , , ,N<CR><LF>IN<ETX>
<ACK>
<STX>L,"L",Y,O<CR><LF>@B<ETX>
<ACK>
<EOT>

9020-8006, Rev. B LabPro Interface Implementation Guide 231


This page intentionally left blank

232 LabPro Interface Implementation Guide 9020-8006, Rev. B


Appendix E

Test group compatibility rules


The following test groups can be ordered together for a single isolate.

Table E-1: Test group compatibility rules


Order this test group With one of these test groups

Dried Overnight Neg ID Dried Overnight Neg MIC

Rapid Neg MIC

MicroScan rapID/S plus Neg MIC

Rapid Neg ID Dried Overnight Neg MIC

Rapid Neg MIC

MicroScan rapID/S plus Neg MIC

Dried Overnight Pos ID Dried Overnight Pos MIC

MICroSTREP plus

Rapid Pos ID Dried Overnight Pos MIC

MICroSTREP plus

MBTID Dried Overnight Neg MIC

Dried Overnight Pos MIC

MICroSTREP plus

One or more user-defined test groups can be added with any of the above combinations or
ordered independently as long as a drug test is not repeated between any user-defined test
groups. No combination of MicroScan defined MIC or Combo panels can be ordered on a single
isolate.

9020-8006, Rev. B LabPro Interface Implementation Guide 233


Test group compatibility rules

This compatibility logic is not expected to be included in the LIS reciprocal interface. LabPro
imposes this logic prior to data storage. It is provided here only to give guidance to the user who
might be defining equivalent entities on the LIS to test groups and drug tests.

• Gram-positive panels may not be combined with gram-negative panels.

• Combo panels may only be combined with user-defined test groups.

• MBTID test group may not be combined with Combo panels, Neg ID panels or Pos ID panels.

234 LabPro Interface Implementation Guide 9020-8006, Rev. B


Appendix F

Tips for cross-referencing to LIS


The following table gives some tips for cross-referencing LabPro software to a Laboratory
Information System (LIS).

Table F-1: Cross referencing tips


Data Element LIS
Admit Status N/A

Wards If your Laboratory Information System transmits a hospital identifier suffix with
the ward code, cross-reference wards in LabPro software.
Check with your LIS vendor to see if this is appropriate.

Sources If your Laboratory Information System has numerous sources and not all the
sources are desirable in LabPro software, cross-reference multiple LIS source
codes to a single LabPro source code.

Comments Consult your LIS vendor to determine whether or not comments from LabPro
software are accepted in the LIS.

Physicians N/A

Services N/A

Institutions N/A

Drug Tests See MicroScan pre-defined drug tests/extra test table (page 245) for more
information.

9020-8006, Rev. B LabPro Interface Implementation Guide 235


Tips for cross-referencing to LIS

Table F-1: Cross referencing tips (continued)


Data Element LIS
Organisms The LIS should contain the same organisms that can be identified by LabPro
software. If you add organisms to LabPro software do not forget to add these to
the LIS as well.
In several instances LabPro software has multiple numbers for the same organism
name. You might want to cross-reference these to a single organism.
For example, the code 1, 51 and 851 apply to E.coli.
This code is a text field in LabPro software. If the receiving system expects to
receive this code as a numeric field, set the Numeric Flag for the table in the
Message Layer under Cross-Referencing.

Interpretations The LabPro Interface transmits BLAC, N/R, TFG, IB, ESBL, EBL?, R*, S*, POS and NEG
along with S, I, and R for interpretations. Confirm that the LIS accepts these
interpretations.
If your LIS does not accept these interpretations then disable the ESBL and IB
flags or cross-reference to an appropriate interpretation.
For certain bug/drug combinations, the LabPro Interface transmits a MIC without
an interpretation. If your LIS does not accept a blank interpretation value, you can
cross-reference a blank to a value acceptable to the LIS.

MIC Dilution Levels All MIC values reported with a sign “<” are transmitted as “<=”. You can suppress
the “=” sign on the Data Suppression tab in the MicroScan Message Layer
Properties window.
Some combination drugs may have a MIC value that exceeds 8 characters.
If the LIS has limited space for MIC reporting, cross-reference any MIC value that
exceeds eight characters to a value acceptable by the LIS. For example, <=.12/.06,
<=.25/.12, <=0.5/.25, <=.06/1.2, <=.12/2.4, <=.25/4.7, <=0.5/9.5.
Note: Piperacillin/Tazobactam MIC results are transmitted as a whole number not
a ratio.
If your LIS does not accept a MIC value of N/R, cross-reference N/R to a blank or
to a value that cannot be mistaken for a true MIC. A MIC with a value of N/R can
occur for the following:
• When the LabPro Interface transmits a Kirby-Bauer result, a N/R is inserted
for the MIC value.
• You manually set an MIC to N/R. Appears as “N/R (MIC value)” in the
software.
• If you automatically, or manually, complete a Synergies plus panel before
all drugs are complete, LabPro software inserts an N/R in place of the MIC
for the pending drugs.

Test Groups N/A

Gender N/A

Tech ID N/A

236 LabPro Interface Implementation Guide 9020-8006, Rev. B


Appendix G

Test group/panel prompts and codes


Test group/panel prompts

Table G-1: Test group/panel prompts


Prompts Field in MicroScan R record
O = Oxidase 16

F = Family / Organism Class 34

B = Beta Hemolysis 22

OG = Organism 12

OG1 = Send species if organism is 12


unknown

IND = Indole 16

9020-8006, Rev. B LabPro Interface Implementation Guide 237


Test group/panel prompts and codes

Test group/panel identifier codes


The following table lists all MicroScan panels. Some panels might not be available in your
country.

Table G-2: Test group/panel identifier codes


Code Test group/panel description Prompt Catalog #
UC1S Combo Orina 1S O B1016-82
HNID HNID B1012-10B
MBTID MALDI Biotyper ID
MF4J MICroFAST 4J J1016-80
MF4J+BL MICroFAST 4J+BL OG
MF7J MICroFAST 7J J1016-84
MSP1 MICroSTREP plus 1 OG1 B1027-201
MSP1M MICroSTREP plus 1 Manual OG1 B1027-201
MSP2 MICroSTREP plus 2 OG1 B1027-202
MSP2M MICroSTREP plus 2 Manual OG1 B1027-202
MSP3 MICroSTREP plus 3 OG1 B1016-89A
MSP5 MICroSTREP plus 5 OG1 B1016-95
MSP5M MICroSTREP plus 5 Manual OG1 B1016-95
MSP6C MICroSTREP plus 6 CLSI OG1 B1016-170
MSP6CM MICroSTREP plus 6 CLSI Manual OG1 B1016-170
MSP6E MICroSTREP plus 6 EUCAST OG1 B1016-170
MSP6EM MICroSTREP plus 6 EUCAST Manual OG1 B1016-170
NBC30 Neg Breakpoint Combo 30 O B1017-306
NBC34 Neg Breakpoint Combo 34 o B1017-404
NBC39 Neg Breakpoint Combo 39 O B1016-131
NBC41 Neg Breakpoint Combo 41 O B1017-408
NBC42 Neg Breakpoint Combo 42 O B1016-137
NBC43 Neg Breakpoint Combo 43 O B1016-144
NBC44 Neg Breakpoint Combo 44 O B1017-411
NBC45 Neg Breakpoint Combo 45 O B1016-153
NBC46 Neg Breakpoint Combo 46 O B1016-162
NBC47 Neg Breakpoint Combo 47 O B1017-417
NBC48 Neg Breakpoint Combo 48 O B1016-169
NBC49C Neg Breakpoint Combo 49 CLSI O B1016-179
NBC49E Neg Breakpoint Combo 49 EUCAST O B1016-179
NBC50 Neg Breakpoint Combo 50 O B1016-189

238 LabPro Interface Implementation Guide 9020-8006, Rev. B


Test group/panel prompts and codes

Table G-2: Test group/panel identifier codes


Code Test group/panel description Prompt Catalog #
NBC623J Neg Breakpoint Combo 6.23J O J1016-623J
NBC1J Neg Breakpoint Combo 1J O J1016-0004
NC31 Neg Combo 31 O B1017-301
NC32 Neg Combo 32 O B1017-302
NC44 Neg Combo 44 O B1017-401
NC50 Neg Combo 50 O B1017-406
NC53 Neg Combo 53 O B1016-142
NC54 Neg Combo 54 O B1016-143
NC58 Neg Combo 58 O B1016-158
NC63 Neg Combo 63 O B1016-166
NC66 Neg Combo 66 O B1016-171
NC67 Neg Combo 67 O B1017-421
NC68 Neg Combo 68 O B1017-422
NC72 Neg Combo 72 O B1016-180
NC80 Neg Combo 80 O B1016-184
NC311E Neg Combo 3.11E O J1016-311E
NC312C Neg Combo 3.12C O J1016-312C
NC312J Neg Combo 3.12J O J1016-312J
NC611B Neg Combo 6.11B O J1016-611B
NCEN1C Neg Combo EN1C O J1016-0002
NCEN1J Neg Combo EN1J O J1016-0001
NCIN1J Neg Combo IN1J O J1016-0006
NCNF1J Neg Combo NF1J O J1016-0005
NCOU1J Neg Combo OU1J O J1016-0007
NCEN1T Neg Combo EN1T O J1016-0009
NC70C Neg Entero Combo 70 CLSI O B1016-177
NC70E Neg Entero Combo 70 EUCAST O B1016-177
NC47 Neg Fermenter Combo 47 B1016-126
NID2 Neg ID 2 O B1017-27
NM36 Neg MIC 36 OG B1016-132
NM37 Neg MIC 37 OG B1016-147
NM38 Neg MIC 38 OG B1017-412
NM39 Neg MIC 39 OG B1016-155
NM40 Neg MIC 40 OG B1016-163
NM42 Neg MIC 42 OG B1017-419
NM43 Neg MIC 43 OG B1017-420

9020-8006, Rev. B LabPro Interface Implementation Guide 239


Test group/panel prompts and codes

Table G-2: Test group/panel identifier codes


Code Test group/panel description Prompt Catalog #
NM45 Neg MIC 45 OG B1017-424
NM46 Neg MIC 46 OG B1017-425
NM44C Neg MIC 44 CLSI OG B1016-175
NM44E Neg MIC 44 EUCAST OG B1016-175
NM632J Neg MIC 6.32J OG J1016-632J
NMEN1J Neg MIC EN 1J OG J1016-0003
NM-EN47 Neg MIC EN 47 OG B1016-185
NM-EN48 Neg MIC EN 48 OG B1016-186
NM-EN49 Neg MIC EN 49 OG B1016-187
NM-NF50C Neg MIC NF 50 CLSI OG B1016-188
NM-NF50E Neg MIC NF 50 EUCAST OG B1016-188
NM1J Neg MIC 1J OG J1016-0012
NC71C Neg Non Entero Combo 71 CLSI OG B1016-178
NC71E Neg Non Entero Combo 71 EUCAST OG B1016-178
NCNF2T Neg Combo NF2T O J1016-0014
NUC33 Neg/Urine Combo 33 O B1017-303
NUC35 Neg/Urine Combo 35 O B1017-305
NUC46 Neg/Urine Combo 46 O B1017-403
NUC51 Neg Urine Combo 51 O B1017-407
NUC52 Neg Urine Combo 52 O B1016-141
NUC55 Neg Urine Combo 55 O B1017-409
NUC56 Neg/Urine Combo 56 O B1016-150
NUC57 Neg Urine Combo 57 O B1016-156
NUC59 Neg Urine Combo 59 O B1016-159
NUC60 Neg Urine Combo 60 O B1017-413
NUC61 Neg Urine Combo 61 O B1017-414
NUC62 Neg Urine Combo 62 O B1017-416
NUC69C Neg Urine Combo 69 CLSI O B1016-176
NUC69E Neg Urine Combo 69 EUCAST O B1016-176
NUC73 Neg Urine Combo 73 O B1017-423
NUC74 Neg Urine Combo 74 O B1017-426
NUC75 Neg Urine Combo 75 O B1017-427
NUC76 Neg Urine Combo 76 O B1017-428
NUC77 Neg Urine Combo 77 O B1017-429
NUC78 Neg Urine Combo 78 O B1017-430
NUC79 Neg Urine Combo 79 O B1017-431

240 LabPro Interface Implementation Guide 9020-8006, Rev. B


Test group/panel prompts and codes

Table G-2: Test group/panel identifier codes


Code Test group/panel description Prompt Catalog #
PBC20 Pos Breakpoint Combo 20 F, B B1017-202
PBC23 Pos Breakpoint Combo 23 F, B B1017-206
PBC27 Pos Breakpoint Combo 27 F, B B1016-133
PBC28 Pos Breakpoint Combo 28 F, B B1016-138
PBC29 Pos Breakpoint Combo 29 F, B B1016-145
PBC32 Pos Breakpoint Combo 32 F, B B1016-152
PBC32B Pos Breakpoint Combo 3.2B F, B J1016-302B
PBC32J Pos Breakpoint Combo 3.2J F, B J1016-302J
PBC33 Pos Breakpoint Combo 33 F, B B1016-164
PC1A Pos Combo 1A F, B B1016-1A
PC20 Pos Combo 20 F, B B1017-200
PC21 Pos Combo 21 F, B B1017-201
PC29 Pos Combo 29 F, B B1017-209
PC31 Pos Combo 31 F, B B1016-139
PC31C Pos Combo 3.1C F, B J1016-301C
PC31J Pos Combo 3.1J F, B J1016-301J
PC32 Pos Combo 32 F, B B1016-140
PC33 Pos Combo 33 F, B B1017-211
PC34 Pos Combo 34 F, B B1017-214
PC1T Pos Combo 1T F, B J1016-0011
PC36 Pos Strep Combo 36 F, B B1016-154
PC37 Pos Combo 37 F, B B1016-160
PC38 Pos Combo 38 F, B B1016-161
PC39 Pos Combo 39 F, B B1016-167
PC41 Pos Combo 41 F, B B1016-172
PC42C Pos Combo 42 CLSI F, B B1016-174
PC42E Pos Combo 42 EUCAST F, B B1016-174
PC43 Pos Combo 43 F, B B1017-217
PC44 Pos Combo 44 F, B B1017-218
PC61B Pos Combo 6.1B F, B J1016-601B
PID3 Pos ID 3 F, B B1017-221
PM21 Pos MIC 21 OG B1016-106
PM26 Pos MIC 26 OG B1017-210
PM28 Pos MIC 28 OG B1016-146
PM29 Pos MIC 29 OG B1017-212
PM31 Pos MIC 31 OG B1016-157

9020-8006, Rev. B LabPro Interface Implementation Guide 241


Test group/panel prompts and codes

Table G-2: Test group/panel identifier codes


Code Test group/panel description Prompt Catalog #
PM32 Pos MIC 32 OG B1016-165
PM33C Pos MIC 33 CLSI OG B1016-173
PM33E Pos MIC 33 EUCAST OG B1016-173
PM33J Pos MIC 3.3J OG J1016-303J
PM34 Pos MIC 34 OG B1017-216
PM-STA35 Pos MIC STA 35 B1016-181
PM-STA36 Pos MIC STA 36 B1016-182
PM-E37C Pos MIC E 37 CLSI B1016-183
PM-E37E Pos MIC E 37 EUCAST B1016-183
PC30 Pos Staph Combo 30 B1016-135
PC28 Pos Strep Combo 28 B1016-124
RAID Rapid Anaerobe ID F, IND B1017-2
RNID3 Rapid Neg ID 3 B1017-110
RNID4 Rapid Neg ID 4 B1017-165
RPID2 Rapid Pos ID 2 B1017-166
RYID Rapid Yeast ID B1017-70

242 LabPro Interface Implementation Guide 9020-8006, Rev. B


Appendix H

MIC dilutions table


Each of the values listed in this table may also be preceded by one of the following comparators:
“<=”, or “>”. MIC values may be cross-referenced.

Table H-1: MIC dilutions


All possible MIC values (listed in ascending order)
0.002 0.125 1/.5 8/4 96

0.003 0.19 1/4 8/152 100

0.004 .12/.06 1/19 12 128

0.006 .12/2.4 1.5 16 192

0.008 0.25 2 16/2 256

0.012 .25/.12 2/1 16/8 384

0.016 .25/4 2/4 16/304 500

0.023 .25/4.7 2/38 24 512

0.03 .25/4.75 3 25 768

0.032 0.38 4 32 1000

0.047 0.5 4/0.5 32/16 1024

0.064 0.5/.25 4/2 32/608 2000

.06/1.2 0.5/4 4/4 48 N/R

0.06 0.5/9.5 4/76 64

0.094 0.75 6 64/2

0.12 1 8 64/4

9020-8006, Rev. B LabPro Interface Implementation Guide 243


This page intentionally left blank

244 LabPro Interface Implementation Guide 9020-8006, Rev. B


Appendix I

MicroScan pre-defined
drug tests/extra test table
The following tables list the CLSI LIS5-A standard and LOINC equivalent codes. They are not part
of the LabPro database files. The listed codes are based on MIC methodology.

CLSI and LOINC provide unique codes for each drug tested by minimum inhibitory concentration
(MIC), agar diffusion (KB), gradient strip, and minimum lethal/bacteriocidal concentration (MLC/
MBC) methodologies.

CLSI – Clinical and Laboratory Standards Institute. LIS5-A.

LOINC Version 2.54.

9020-8006, Rev. B LabPro Interface Implementation Guide 245


MicroScan pre-defined drug tests/extra test table

MicroScan drug tests

Table I-1: MicroScan drug tests


Code Drug test name LIS5-A equivalent code LOINC equivalent code
A/S Amp/Sulbactam 87186.53 32-3
ABK Arbekacin 53818-1
AK Amikacin 87186.1 12-5
AM Ampicillin 87186.2 28-1
AMX Amoxicillin 87186.59 16-6
AUG Amox/K Clav 87186.3 20-8
AZ Azlocillin 87186.4 40-6
AZI Azithromycin 87186.61 36-4
AZT Aztreonam 87186.43 44-8
BSE BLSE
C Chloramphenicol 87186.17 173-5
C/S Cefoperazone/Sulbactam 54167-2
141-2 (non-meningitis)
CAX Ceftriaxone 87186.14
31140-7 (meningitis)
CAZ Ceftazidime 87186.44 133-9
CAZ/CA Ceftazidime/K. Clavulanate 35775-6
CB Carbenicillin 87186.5 60-4
CD Clindamycin 87186.18 193-3
CDN Cefdinir 23637-2
CF Cephalothin 87186.16 161-0
CFC Cefonicid 87186.9 96-8
CFE Cefixime 87186.66 80-2
CFM Cefamandole 87186.6 68-7
CFP Cefoperazone 87186.11 100-8
CFR Cefaclor 87186.64 84-4
CFS Cefsulodin 87186.56 128-9
108-1 (non-meningitis)
CFT Cefotaxime 87186.12
31138-1 (meningitis)
CFT/CA Cefotaxime/K. Clavulanate 35770-7
CFX Cefoxitin 87186.39 116-4
CFXS Cefoxitin Screen
CFZ Cefazolin 87186.8 76-0
CL Colistin 205-5
CLA Clarithromycin 87186.72 189-1

246 LabPro Interface Implementation Guide 9020-8006, Rev. B


MicroScan pre-defined drug tests/extra test table

Table I-1: MicroScan drug tests


Code Drug test name LIS5-A equivalent code LOINC equivalent code
CN Cinoxacin 87186.71 181-8
CP Ciprofloxacin 87186.41 185-9
CPD Cefpodoxime 120-6
CPE Cefepime 6644-9
CPT Ceftaroline 73627-2
CRM Cefuroxime 87186.15 145-3
CTN Cefotetan 87186.55 112-3
CZ Ceftizoxime 87186.13 137-0
DAP Daptomycin 35788-9
DOR Doripenem 56031-8
DOX Doxycycline 87186.80 225-3
E Erythromycin 87186.19 233-7
ECAZ ESBL Ceftazidime
ECFT ESBL Cefoxtaxime
ESA ESBL-a Scrn
ESB ESBL-b Scrn
ETP Ertapenem 35801-0
FA Fusidic Acid 262-6
FD Nitrofurantoin 87186.26 363-2
FOS Fosfomycin 25653-7
GAT Gatifloxacin 31036-7
GEM Gemifloxacin 35815-0
GM Gentamicin 87186.21 267-5
GMS Gent. Synergy 7018-5
GRX Grepafloxacin 23639-8
ICD Inducible Clindamycin
IMP Imipenem 87186.34 279-0
K Kanamycin 87186.86 291-5
KS Kanamycin Synergy 7024-3
LIN Lincomycin 87186.87 299-8
LMF Lomefloxacin 87186.88 303-8
LOR Loracarbef 307-9
LVX Levofloxacin 20396-8
LZD Linezolid 29254-0
MEC Mecillinam
MER Meropenem 6652-2

9020-8006, Rev. B LabPro Interface Implementation Guide 247


MicroScan pre-defined drug tests/extra test table

Table I-1: MicroScan drug tests


Code Drug test name LIS5-A equivalent code LOINC equivalent code
MIN Minocycline 87186.24 or 94 335-0
MUP Mupirocin 35823-4
MXF Moxifloxacin 31037-5
MZ Mezlocillin 87186.23 331-9
NA Nalidixic Acid 87186.97 351-7
NT Netilmicin 87186.42 359-0
NXN Norfloxacin 87186.48 367-3
OFL Ofloxacin 87186.49 375-6
OX Oxacillin 87186.27 383-0
P Penicillin 87186.28 6932-8
P/T Pip/Tazo 412-7
PEF Pefloxacin 87186.50 390-5
PI Piperacillin 87186.29 408-5
PPA Pipemidic Acid 404-4
PRS Pristinamycin 35834-1
RIF Rifampin 87186.31 428-3
SFX Sparfloxacin 20397-6
ST Streptomycin 87136.111 460-6
STS Strep. Synergy 6933-6
SX Sulfamethoxazole 468-9
SYN Synercid 23641-4
T Trimethoprim 87186.116 512-4
T/S Trimeth/Sulfa 87186.36 516-5
TE Tetracycline 87186.33 496-0
TEI Teicoplanin 87186.51 484-6
TGC Tigecycline 42355-8
TI Ticarcillin 87186.52 500-9
TIM Ticar/K Clav 87186.35 504-1
TO Tobramycin 87186.37 508-2
TVA Trovafloxacin 23643-0
VA Vancomycin 87186.38 524-9

248 LabPro Interface Implementation Guide 9020-8006, Rev. B

Das könnte Ihnen auch gefallen