LIS-Link Operator Manual English-Rev 3 Final
LIS-Link Operator Manual English-Rev 3 Final
INTERFACE
OPERATOR MANUAL
dynex.com
LIS-Link
Operator Manual
Revision History
Manual Revision Revision Date
03 2023-02-15
Technical Support
For technical support please contact DYNEX Technologies.
At the end of life for the instrument, contact DYNEX technical support to
arrange for disposal.
All claims made in this manual have been made by DYNEX acting as the
responsible body for DYNEX branded products.
Copyright
Copyright© 2023 DYNEX Technologies, Inc. (DYNEX). All rights reserved. This material may not
be reproduced or copied, in whole or in part, without the written permission of DYNEX
Technologies, Inc.
Table of Contents
Chapter 1: Safety Information ............................................................................ 1
1.1 Intended Use ....................................................................................................... 1
1.2 Use of the Operator Manual ................................................................................ 1
1.3 Text Conventions Used in this Manual................................................................. 1
1.4 Symbols .............................................................................................................. 2
Chapter 2: Introduction ...................................................................................... 3
2.1 Workflow ............................................................................................................. 4
2.2 Connection Options ............................................................................................. 5
2.3 Communication Protocols .................................................................................... 5
2.3.1 References .................................................................................................... 6
2.4 System Requirements ......................................................................................... 6
2.4.1 PC Requirements – Windows 7 ..................................................................... 6
2.4.2 PC Requirements - Windows 10 (Professional Version) ................................ 7
2.5 Installation ........................................................................................................... 7
Chapter 3: LIS-Link Configuration ..................................................................... 9
3.1 Communications ................................................................................................ 10
3.2 Customize Defaults ........................................................................................... 12
3.3 Aborted Assays ................................................................................................. 13
3.4 Query Style........................................................................................................ 15
3.5 Name Mapping .................................................................................................. 15
3.5.1 Configuration ............................................................................................... 16
3.5.2 Select Result Types ..................................................................................... 16
3.5.3 Remove Name Mapping .............................................................................. 17
3.5.4 Entering a New Name Mapping ................................................................... 17
3.5.5 External Pipetting Plate................................................................................ 17
3.5.6 View and Edit Name Mapping ...................................................................... 20
3.6 Vendor............................................................................................................... 21
3.6.1 Remove Vendor ........................................................................................... 21
Chapter 4: Application Configuration ............................................................. 23
4.1 DSX and REVELATION DSX ............................................................................ 23
4.1.1 System Configuration................................................................................... 23
4.1.2 Entering a New Name Mapping ................................................................... 24
4.2 DS2 and DS-MATRIX ........................................................................................ 27
4.2.1 System Configuration................................................................................... 27
4.2.2 DS-Matrix Assay Names .............................................................................. 29
4.3 AGILITY ............................................................................................................ 29
4.3.1 System Configuration................................................................................... 29
Chapter 5: Quantiferon-TB (QFT)..................................................................... 33
5.1 Query for Test Orders (LIS-Link to Host) ........................................................... 33
5.2 Test Order Response from Host to LIS-Link ...................................................... 33
1.4 Symbols
Symbols are used in this manual to provide a ready visual reference. The symbols and their
purpose are shown in Table 2.
Chapter 2: Introduction
LIS-Link is an optional software package that can be installed on the DSX® Personal Computer
(PC), DS2® PC or AGILITY® instruments. It allows the Analyzer to communicate with the
laboratory host computer (LIS or LIMS) to download pending test orders and to upload
completed assay results. Lis-Link runs a Windows® service that starts when the PC starts.
Note: LIS-Link service can be started or stopped via Windows Task Manager.
LIS-Link provides a link between a customer’s LIMS and DYNEX’s REVELATION DSX®, DS-
MATRIX® and Agility applications. LIS-Link consumes a results file generated from the
instruments and allows the user to forward the results in the industry standard format to the
customer’s LIMS.
DS-Matrix
REVELATION DSX
AGILITY
LIMS XML File
2.1 Workflow
Listed below are the steps for using LIS-Link.
1. The user scans barcoded sample tubes.
- or -
The user manually enters sample identification information.
2. LIS-Link queries the host LIS or LIMS.
3. The host responds to LIS-Link with a correctly formatted set of test orders.
4. The DYNEX Analyzer processes the samples according to the steps of the assay
file and performs data reduction to create the results.
5. When the instrument has completed processing the samples and generating the
results, the results are posted to LIS-Link.
6. The user opens the LIS-Link Graphical User Interface (GUI), selects the assay
and initiates the transmission of results.
7. The user clicks an icon in LIS-Link to transmit the successfully imported results to
LIS Host.
LIS-Link provides a link between a customer’s LIMS and the following DYNEX instruments:
• Agility
• DSX
• DS2.
LIS-Link consumes a results file generated by REVELATION DSX, DS-MATRIX or Agility and
forwards the results in industry standard format to the customer’s LIMS.
When testing the software, the following steps must be followed in the listed order:
1. Query sent successfully from LIS-Link to LIS Host.
2. Orders received from LIS Host and posted in LIS-Link.
3. Sample IDs automatically checking off when an assay is added to the worklist.
These steps must all be performed in the specified order. If Sample IDs are not checked off
when creating a worklist (Figure 2, step 3), the worklist cannot be executed and the results will
not be generated. Steps 1 - 4 must be successfully executed before results can be transmitted
to the LIS Host.
Note: If the checkmarks are not automatically populated there is a problem,
generally with name mapping, between LIS-Link and the DYNEX instrument
operations application. Refer to Chapter 3.5.
The software has been modified to accommodate an external pipetting feature for LIS-Link
version 2.40 and greater. The feature runs the read-only assays specified by the external
pipetting systems and automatically posts the results in LIS-Link.
Note: DYNEX currently supports ONLY the RS-232 serial connection. All
instructions in DYNEX documentation assume that a serial connection
is being used.
2.3.1 References
In 2001, ASTM International Committee E31 restructured and transferred responsibility for
E31.13 standards to the National Committee for Clinical Laboratory Standards (NCCLS) (now
CLSI).
Table 3: CLSI Documents
Standard Number Description
“Specification for Low-Level Protocol to Transfer Messages Between
Clinical Laboratory Instruments and Computer Systems; Approved
CLSI LIS01-A2 Standard – Second Edition”
Replaces ASTM International Standard E1381.
“Specification for Transferring Information Between Clinical Laboratory
Instruments and Information Systems; Approved Standard – Second
CLSI LIS02-A2 Edition”
Replaces ASTM International Standard E1394.
recommended
• 10 gigabytes (GB) or larger hard drive with at least 100 megabytes (MB) of free space
• Microsoft Windows 7 Professional operating system (32- or 64-bit)
• Super Video Graphics Array (SVGA) compatible display adapter (card or built into
motherboard) with 24-bit (true-color setting) or more colors at 1024 x 768 or more
resolution
• Display properties should be set to a desktop area of at least 600 x 800 pixels and a
color palette of at least 256 colors
• Minimum 256 MB of Random Access Memory (RAM)
• Two RS-232 serial ports may be needed:
o LIS-Link
o Communication with DYNEX instrument
• One unused Universal Serial Bus (USB) port
• Mouse or other pointing device (i.e., trackball) supported by Microsoft Windows
• Microsoft Windows compatible printer (color recommended)
• Compatible sound card
• Network/Local Area Network (LAN) connection, 10/100 network interface (optional).
• 1.8 gigahertz (GHz) minimum processor clock speed required (2 GHz or higher
processor clock speed recommended).
• One unused RS-232 serial port is required for connecting the computer to LIS-Link
• One unused USB port or RS-232 port is required for connecting the computer to the
instrument
• Microsoft Windows compatible Compact Disk-Read Only Memory (CD-ROM) or Digital
Video Disk (DVD) drive.
2.5 Installation
Confirm that the DYNEX control instrument application has been installed and that the
instrument is fully operational and tested prior to the installation or setup of the LIS-Link
software. Instructions for the installation of the application is outside the scope of this document,
except for specific settings to enable LIS-Link functionality.
LIS-Link software is distributed on a Compact Disk (CD) or USB.
1. Log onto the PC using a login with Windows administrator privileges.
a. Installing from a CD:
• Insert the CD into the CD-ROM drive.
• Double-click on setup.exe.
• Follow instructions as they are displayed on the screen.
• Copy the zipped file from the USB to the desktop prior to installation.
• Unzip the file.
• Double-click on setup.exe.
• Follow the instructions that are displayed on the screen.
2. After installation has completed, reboot the PC.
Note: If the user is not familiar with installing a program from a zipped file, it is
recommended that the user contact their Information Technology (IT)
department for assistance.
The first time the software is run, the user MUST be logged on to the Windows PC as an
administrator. Routine operation of the DYNEX instrument and associated software does not
require Windows administrator privileges.
Both the DSX and DS2 control computers require a 9-pin RS-232 serial interface connector for
interfacing to a laboratory host LIS system. The Agility Universal Serial Bus (eBox) may have a
USB port with a USB/9-pin serial adaptor or a direct 9-pin RS-232 port.
Laboratory IT personnel are responsible for establishing the physical connection and enabling
communication between the Laboratory Host System (LIS Host) and the instrument control
computer. DYNEX recommends that the laboratory IT personnel perform preliminary tests to
assure that the connection is functional.
3.1 Communications
The Communications tab allows the user to enter the physical connection parameters for the
interface between the instrument and LIS Host computer.
Note: All settings, other than the COM port number, need to match the serial
communications settings used by LIMS.
Note: It may take some experimentation to identify the COM port to which the
serial cable is attached. Consult an internal IT professional who is familiar with
serial communications for assistance.
1. Click System → Configuration → Communications.
2. Figure 5 displays the recommended settings.
Important: Avoid using any serial COM port number above 9. (LIS-Link will
NOT be able to use any number above 9).
3. Select Serial if using a RS-232 cable or TCP/IP if using an Ethernet cable.
Note: DYNEX does NOT support the use of TCP/IP. We recommend using a
RS-232 cable.
4. Indicate whether hardware flow control is used to manage the flow of information
between the systems.
5. Set the Query Wait Time up to 10 minutes. This is the delay time the system will wait for
a completed message from the LIS Host.
Note: It is recommended to make “Send” the default selection. This sets the
transmission status of new results.
Note: Only query for sample IDs scanned is recommended for routine use.
Host. Name mapping in LIS-Link maps the name for an assay in one system to the name used
for that same assay in the other system.
3.5.1 Configuration
1. Click System → Configuration.
2. Click the Name Mappings tab.
3. Type an assay name used by the host computer in the LIMS Name field (e.g. CVM IgG).
Note: Name mapping that is currently associated with orders or results can
NOT be changed. Before a name mapping can be edited, the associated
orders or results need to be deleted from LIS-Link.
4. Type the corresponding assay file name in the Local Assay File Name field.
REVELATION DSX® assay file names must have a “.asy” extension. (e.g. cvmigg.asy).
DS2 and Agility do not require the extension.
5. Click .
Note: Procedures for specifying the manner in which assay results are
calculated are defined during assay definition. Refer to the REVELATION
DSX Operator Manual for more details.
1. Click to place a check mark next to each result type to be transmitted.
Note: Multiple selections are allowed. The final result is always a duplicate of
another selection, so duplicate data will be transmitted if final result and its
matching option are both marked.
Note: Deleting name mappings that are associated with orders or results will
remove the orders and results from the LIS-Link database.
Important: The assay mapping in DSX mode MUST be setup correctly for
LIS-LINK to work properly.
1. Click Tools → EppAssayMapping to ensure that the assay mapping for LIMS is correctly
configured. Ensure that the EPP File Type is set to DSX and the Lis Assay Name maps
to the correct assay in the DSX REVELATION Assay.
For example: If LIMS HOST mapping is RUBM, ensure that the LIS-LINK
mapping for REVELATION DSX assay in DSX EPP File Type matches
DSX_Rub_IgG.asy (Figure 10).
In external pipetting mode the Epp File Type is configured as TPL and the LIS Assay Name
maps to the EPP REVELATION DSX Assay.
In the LIMS assay name map (Figure 11), RUBG is mapped for external pipetting mode and
RUBM is mapped for DSX mode.
2. To find the local assay file name in DS-MATRIX, start a worklist and look in the assays
column on the right hand side of the screen (Figure 13) to identify the assay name
exactly as it must appear in the name mapping (no spaces, file extensions, etc.).
3. Open the Assay Editor and select Open to display a selectable listing of assay names in
the system.
4. To find the local assay file name in DSX REVELATION DSX, navigate to C://Program
Files/DYNEX Technologies/REVELATION DSX/Assays.
5. Identify the correct assay file. For DSX Revelation, use the name exactly as it is
displayed in this folder, complete with the “.asy” extension. For DS2 Matrix, the “.asy” file
extension is not used.
6. Enter the result types to be sent to the LIS by checking the appropriate boxes. Agility,
REVELATION DSX and DS-MATRIX applications use several modes of processing
data, each capable of generating results.
7. In addition, there is raw data and a generic “Final Result”. In most cases, the final result
will be sent across the interface. Some laboratories may also want to send raw OD data
or the results of intermediate processing. If more than the final results are transmitted,
the host system must be set to correctly receive and process multiple pieces of data for
each sample.
8. Click .
9. The mapped assay is displayed in the list on the left and the entry fields on the right will
clear.
Note: Name mapping cannot be edited if there are pending samples in the
LIS-Link software for the assay. Pending samples must be deleted from the
system prior to attempting to edit name mapping for the assay.
3.6 Vendor
During installation, two files are installed, Default Protocol.dll and Vendor DLL #1.dll. They affect
the way LIS-Link formats and interprets some specific transmissions to and from the LIS Host.
Vendor customizations to the LIS interface will be considered by DYNEX software development.
Once a customization is accepted the vendor's DLL file becomes a part of LIS-Link and is made
available for selection on the Vendor tab.
1. Click System → Configuration.
2. Click the Vendor tab
3. Approved vendors are listed in the Available Vendors panel. The Status column
indicates which vendor customization is currently in use.
Chapter 4: Application
Configuration
4.1 DSX and REVELATION DSX
LIS-Link allows the DSX to communicate with the LIS to download pending test orders and to
upload completed assay results.
It allows for DSX to send queries, consisting of barcode-scanned or manually entered sample
IDs (or a query for all orders) to the LIS. DSX accepts test orders from the LIS for the specific
P
samples and properly checks for which samples are to run when the user enters those orders in
the DSX worklist. Upon completion of the actual testing, the results are paired with the correct
patient orders and put in a holding queue for user confirmation and subsequent transmission to
the LIS.
Note: The LIS Service Information shows the installed version, installation
directory and the data directory selected during LIS-Link setup. Check the LIS-
Link configuration and verify that both programs have the same Data Directory
(Data Path in LIS-Link).
a. When interfacing with REVELATION DSX, include the “.asy” extension in assay
file names.
b. When interfacing with DS-MATRIX or Agility software, do not use the “.asy”
extension.
For example: If the name of the test used by the LIMS host is RUBM, ensure that
the LIS-LINK mapping for REVELATION DSX assay in DSX EPP File Type
matches DSX_Rub_IgG.asy (Figure 18).
In external pipetting mode the Epp File Type is configured as TPL and the LIS Assay Name
maps to the EPP REVELATION DSX Assay.
In the LIMS assay name map (Figure 11), RUBG is mapped for external pipetting mode and
RUBM is mapped for DSX mode.
3. To find the local assay file name in DSX REVELATION DSX, navigate to C://Program
Files/DYNEX Technologies/REVELATION DSX/Assays.
4. Identify the correct assay file; use the name exactly as it is displayed in this folder,
complete with “.asy” extension.
5. Enter the result types to send to LIS by checking the appropriate boxes. REVELATION
DSX and DS-MATRIX application can use up to four modes of processing data, each
capable of generating results.
6. In addition, there is raw data and a generic “Final Result”. In most cases, the final result
will be sent across the interface. Some laboratories may also want to send raw OD data
or the results of intermediate processing. If more than the final results are transmitted,
the host system should be set to correctly receive and process multiple data fields for
each sample’s test result.
7. Click .
8. The mapped assay is displayed in the list on the left and the entry fields on the right will
clear.
Note: Selecting Enable LIS Support will allow LIS-Link to support using LIS
on the sample batch when initiating the worklist (Chapter Chapter 5: ).
6. Ensure both Reprocessing Options are selected.
2. Open the Assay Editor and select Open to display a selectable listing of assay names in
the system.
4.3 AGILITY
LIS-Link provides a link between a customer’s LIMS and DYNEX’s Agility applications. LIS-Link
consumes a results file generated from Agility and forwards the results in the industry standard
format to the customer’s LIMS.
not enabled, click on the Configuration screen . Click the LIS-Link Mode drop-down
and select LIS_Link to enable the Check LIS and Select LIS buttons.
H|\^&|||LName||||||||1|20110531153846|
P|1|| Jones1234||
O|1| Jones1234||^^^QFT|R|20040205151351
P|2|| Scott2345||
O|1| Scott2345||^^^QFT|R|20040205151351
P|3|| Lampel3456||
O|1| Lampel3456||^^^QFT|R|20040205151351
P|4|| Smith4567||
O|1| Smith4567||^^^QFT|R|20040205151351
L|1|N
Even though only one test order is returned to LIS-Link, the software has been written to check
off the appended samples on the worklist so that all three tubes are processed.
This application uses the host name for the assay (QTF) and builds two additional names for
result record 2 and 3.
Result records 1-3 are identified by name and the code DF in field 7.
Result record 4 is the final result and is identified by the code FR in field 7.
6.1.1 System
The system option allows the following:
6.1.1.1 Configuration
Figure 30 shows the System Configuration dialog box.
6.1.1.2 Password
To change the login password for LIS-Link, perform the following steps:
6.1.1.3 Exit
To close the LIS-Link GUI, click System → Exit.
The application may also be closed by clicking in the upper right hand corner of the title bar.
6.1.2 Operations
The Operations menu is used to update result status codes and initiate result transfers to LIS
Host.
Note: This does not delete the result from the DYNEX instrument’s database.
6.1.3 Export Results Information to HTML File
This option copies result data to a user selectable filename.
1. Select Export Results Information to HTML File from the Operations drop-down menu
2. The following is displayed:
6. Click .
7. The Windows Save As dialog box opens.
Note: The decision radio button selections will be reset. (Refer to Chapter
6.3.1.)
4. Click .
5. The LIS Database Viewer screen is displayed.
Item Description
This table contains the data from completion of an assay test. Each
Results
entry corresponds to a sample in the Sample ID table.
Activity
When a line is selected in the content viewer, the data listed on the
Remove
selected line is removed from the database.
All the data from the selected table is removed.
If used on the Sample ID table all entries are removed from the
Remove all Sample ID, Test Run and Results Tables.
If used on the Test Run table all entries are removed from the Test
Run and Results tables.
Additional
A window that shows the data in the database. Each line may be
removed or the entire table deleted if the Remove and Remove All
Content Viewer
buttons are functional.
Individual fields are not editable.
Closes the Database Viewer.
Exit Note: Changes that have been made but are not saved will
be lost when exit is selected.
Help Loads the help file for the database viewer.
6.1.4 Help
The Help menu displays LIS-Link version information.
6.2 Toolbar
Table 12: Toolbar Icons
Icon Description
Send all results marked “send” to LIS.
Remove test results marked as deleted.
Shows most recent status updates and results from the DYNEX instrument
software.
Icon Description
Note: The Decision radio button selections will be removed when the
refresh is applied; to implement Decision radio-button selections to Send or
Delete results, apply the Decision status and send results to LIS before
refreshing the status updates. (See section 6.3.1.)
Allows for the user to configure the system.
6.3 Assays
Lists all assigned assay names. Assays containing results that are ready for disposition (aborted
or completed) appear in bold. The number of results pending disposition is shown in
parentheses after the assay name.
Note: Only decisions for completed assays may be modified. The default
decision (Send or Leave) is automatically selected for each result record
based on the Customize Defaults configuration setting or if the refresh button
is clicked.
4. If needed, select a different decision.
Note: The user may wait until all changes have been made and click Apply
All.
3. Check to make Delete Assay Run, Re-run Assay Run or Leave for User
Confirmation the default action when an assay is aborted (Table 14).
Table 14: Actions When Assay is Aborted
Action Description
Delete Assay Run The test order is deleted. No information will be sent to the LIS.
Re-run Assay Run The test order is automatically re-run.
No action will be taken until the user intervenes.
Leave for Confirmation
The test run status code is erred.
Chapter 7: Transmission of
Information to a Host System
This section describes the communication protocol for transmission of Control and Standard
results from the DYNEX Elisa analyzers to a laboratory LIS Host system using DYNEX LIS-Link
Software. It is a low-level data protocol description of the output format of the transmission to
the host.
Upon finding orders for the four samples, the host responds with the following message:
H|\^&|||DYNEXRD-LT||||||||1|20101208184458|
P|1||Jones1234||
O|1|Jones1234||^^^ProtC|R|20040205151351
P|2||Scott4567||
O|1|Scott4567||^^^ProtC|R|20040205151351
P|3||Federer2345||
O|1|Federer2345||^^^ProtC|R|20040205151351
P|4||Green6789||
O|1|Green6789||^^^ProtC|R|20040205151351
L|1|N
In this example, the LIS host found four orders for a ProtC assay for the four samples. When the
assay is completed it returns results to the host. In this case, the sample results come first.
There is no change to specimen data transfer.
H|\^&|||DYNEXRD-LT||||||||1|20101208190753
P|1||Jones1234
O|1|Jones1234||^^^ProtC|R|20101208184500
R|1|^^^ProtC|0.417 U/ml|U/ml||FR||F||||20101208190753|DYNEXRD-LT
P|2||Scott4567
O|1|Scott4567||^^^ProtC|R|20101208184500
R|1|^^^ProtC|161.537 U/ml|U/ml||FR||F||||20101208190753|DYNEXRD-LT
P|3||Federer2345
O|1|Federer2345||^^^ProtC|R|20101208184500
R|1|^^^ProtC|161.537 U/ml|U/ml||FR||F||||20101208190753|DYNEXRD-LT
P|4||Green6789
O|1|Green6789||^^^ProtC|R|20101208184500
R|1|^^^ProtC|161.537 U/ml|U/ml||FR||F||||20101208190753|DYNEXRD-LT
In the above example, there is no message terminator. The control and standard results will be
added at this point to the message and a terminator will end the entire message.
L|1|N
Note: LIS-Link does not recognize frames with numbers higher than 7.
The customer may see LIS-Link checking off only the first part of the list of samples.
Acronyms
Acronym Definition
CD Compact Disk
CD-ROM Compact Disk Read Only Memory
CLSI Clinical and Laboratory Standards Institute
DVD Digital Video Disk
eBox Electronic Box
EC European Community
ELISA Enzyme-Linked Immunosorbent Assay
EU European Union
GB Gigabyte
GHz Gigahertz
GUI Graphical User Interface
IT Information Technology
LAN Local Area Network
LIMS Laboratory Information Management System
LIS Laboratory Information System
MB Megabyte
NCCLS National Committee for Clinical Laboratory Standards
OS Operating System
PC Personal Computer
RAM Random Access Memory
RS-232 Recommended Standard-232
SoC System-on-a-Chip
SVGA Super Video Graphics Array
TB Tuberculosis
TCP/IP Transmission Control Protocol/Internet Protocol
UI User Interface
USB Universal Serial Bus
WDDM Windows Display Driver Model
XML eXtensible Markup Language
©2023 DYNEX Technologies, Inc. All Rights Reserved. | 91001020 | Item approved for Global Use.