Cytometro BD FACSLink LIS Interface
Cytometro BD FACSLink LIS Interface
Solution
bdbiosciences.com
23-11040-00 Rev A
September 2009
The information in this guide is subject to change without notice. BD Biosciences reserves the right to change its products and services at
any time to incorporate the latest technological developments. Although this guide has been prepared with every precaution to ensure
accuracy, BD Biosciences assumes no liability for any errors or omissions, nor for any damages resulting from the application or use of
this information. BD Biosciences welcomes customer input on corrections and suggestions for improvement.
BD, BD Logo and all other trademarks are property of Becton, Dickinson and Company. © 2009 BD
All other company and product names might be trademarks of the respective companies with which they are associated.
BD FACSCanto, BD FACSCanto II, and BD FACSCalibur are Class I (1) Laser Products.
History
Chapter 4: Reference 27
Managing user accounts . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 28
Viewing and modifying configurations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 31
Viewing and modifying driver properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 36
Viewing and managing connections . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 41
Viewing and managing the connection status . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 44
BD worklist formats . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 46
Worklist toolbar options . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 47
Importing and exporting workspaces . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 48
Saving or deleting workspaces . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 50
Chapter 5: Troubleshooting 51
Error messages . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 52
Software issues . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 53
1
About the BD FACSLink LIS Interface Solution
This section includes these topics:
z Limitations (page 3)
Description The BD™ FACSLink LIS Interface Solution is a software application that uses
Data Innovations’ Instrument Manager software and the BD FACSLink driver to
read BD Multiset™, BD HLA-B27, and BD FACSCanto™ clinical software result
files into ASTM and HL7 formats and transfer the results data to Laboratory
Information Systems (LIS). Worklists in Data Innovations’ Instrument Manager
are compatible with BD FACSCanto Version 2.2 and 2.4 software,
BD FACSCalibur™, and BD FACS™ Sample Prep Assistant II (SPA II) and Sample
Prep Assistant III (SPA III) instruments.
The BD FACSLink LIS Interface Solution allows the lab manager to review and
designate which test results are released to the LIS. BD FACSLink provides a
readable audit trail file for traceability between the original files and the
transferred results files.
Instrument Manager The BD FACSLink LIS Interface Solution has the same system and compatibility
Compatibility requirements as Data Innovations’ Instrument Manager software.
See Data Innovations’ Instrument Manager Help for a specific list of system
requirements and compatibilities.
z The network administrator should indicate the base result location by using
UNC paths, not Windows drive letter mapping.
See Data Innovations’ Instrument Manager Help for more information about
configuration.
Chapter 1: About the BD FACSLink LIS Interface Solution 3
See the Reference (page 27) section for overview information about the BD
FACSLink driver configuration and connections, as well as information about
worklist formats and Specimen Management settings.
Related publications For detailed user information, see Data Innovations’ Instrument Manager
documentation included on the software CD, or Data Innovations’ Instrument
Manager Help.
Limitations
BD Biosciences delivers software and workstations that are intended for running
the instruments supplied by BD Biosciences. It is the responsibility of the buyer/
user to ensure that all added electronic files including software and transport
media are virus free. If the workstation is used for Internet access or purposes
other than those specified by BD Biosciences, it is the buyer/user’s responsibility to
install and maintain up-to-date virus protection software. BD Biosciences does not
make any warranty with respect to the workstation remaining virus free after
installation. BD Biosciences is not liable for any claims related to or resulting from
the buyer/user's failure to install and maintain virus protection.
Technical support
If additional assistance is required, contact your local BD Biosciences technical
support representative or supplier.
z Selecting a data criterion for the Case Number data column (page 15)
BD FACSLink workflow
About this topic This topic shows a typical BD FACSLink workflow.
Typical workflow Your facility’s standard operating procedure might require a different workflow.
This information is provided as an example.
Chapter 2: Building worklists and transferring results 7
4. Click Logon.
The Status Display dialog displays the current status of all instrument
connections.
The Status Detail dialog provides details for a specific instrument connection.
See Viewing and managing connections (page 41) for more information, or
see Data Innovations’ Instrument Manager Help.
z Sample Name. Patient Name. This data column is populated by the LIS. You
can view or edit a patient name associated with the current Specimen ID.
z Panel. Select a single Panel. If multiple panels are required, you can select
them using the Panel Selection dialog.
SPA connections might only have a single panel ordered for a specific
Specimen ID in a single worklist.
z Carousel ID. Enter a value after entering the first Specimen ID of a new
worklist. If the current carousel is full, enter a new Carousel ID. You can
build multiple carousels at the same time using different carousel IDs.
z Unique Carousel ID. SPA worklists only. Enter a unique ID to be used with
the worklist. If your unique ID contains special characters, they are not
included in the file name of your exported worklist.
z Primary Rack Pos. SPA worklists only. Enter the primary rack position.
Data column guidelines z The same Specimen ID, Sample Name, and Case Number cannot be present in
one carousel for SPA III or BD FACSCalibur worklists.
z The same Specimen ID, Sample Name, and Case Number cannot be present in
a BD FACSCanto worklist.
z Two rows with the same Specimen ID cannot be present in one carousel for a
SPA II worklist.
z If more than one panel is added from the same Specimen ID, the previously
selected panel is highlighted (yellow) in the Panel Selection dialog.
Building a worklist
About this topic This topic describes how to build a worklist by entering data into the data
columns.
Before you begin The BD FACSLink driver and Data Innovations’ Instrument Manager are
designed to allow data input using a barcode scanner. Information that is linked to
a barcode should populate data entry columns when you scan a barcode.
Some barcode scanners’ default settings require you to scan, then press the >,
Enter, or Tab keys to populate the data columns. See your barcode scanner
documentation for information about configuring your scanner to automatically
populate the data immediately after a scan.
The list of worklist types that appears is based on the currently established
instrument connections. For example, BD FACSCanto Software v2.2
worklists require an established BD FACSCanto v2.2 connection. See Viewing
and managing connections (page 41) for more information.
– SPA v3.0.1-FACSCalibur
– SPA v4.0-FACSCalibur
3. Manually enter the specimen ID into the Specimen ID data column in the
Data entry row, or scan the specimen ID to populate the data columns with
data from the LIS. Always enter your specimen ID in the data column before
you enter data in any other data column.
See About worklist data columns (page 11) for details about each data
column.
After you enter the specimen ID, the following dialog appears.
14 BD FACSLink LIS Interface Solution Quick Start Guide
– If the specimen has pending panels associated with it, the panel data
populates the Panel data column. Continue with step 5.
– If a specimen does not have any pending panels associated with it, the
Panel Selection for Specimen ID dialog appears.
b. Click OK.
5. Add or modify data in the other data columns as appropriate, or delete single
rows of data.
To delete a row of data from the Data entry row, select the row, then press
Delete on the keyboard. The row is deleted.
6. If you require a custom data criterion as the Case Number in this worklist, see
Selecting a data criterion for the Case Number data column (page 15) for
more information.
7. Press Enter in a data column in the Data entry row to commit the data to the
worklist.
This is an optional procedure. The default case number is based on the Specimen
ID plus an incremental number. The data in the column is populated by the LIS. If
you want to customize this criterion, you should make this selection before you
commit data to the worklist. See Building a worklist (page 12), step 5.
Data
Element field
3. Click OK.
The selected data criterion is applied to the Case Number data column.
Exporting a worklist
About this topic This topic describes how to export a worklist.
Requirement Store all exported BD FACSLink worklist files in a network shared folder
accessible by the BD workstation.
Exported worklist size for Worklists for BD FACS Sample Prep Assistant (SPA, SPA II, and SPA III) and and
each connection BD FACSCalibur connections can include only one carousel. BD FACSCanto
worklists can hold up to 200 samples or five carousels.
3. Click Delete.
See Releasing or rejecting results data (page 25) for more information.
2. Type a path in the Result File field, or click Browse to open the Open dialog
and browse for a result file path.
Any results data in the results file are transferred to Specimen Management,
even if the specimen is not in the Instrument Manager database.
You can keep the Help window open while you use the
software or print the information directly from the window.
Before you begin The BD FACSLink default result transfer rule “Hold all tests for verification”
must be applied to all instrument connections to review and release results data to
the LIS. This should be performed during initial configuration. See Data
Innovations’ Instrument Manager Rules Manual or the Data Innovations’
Instrument Manager Help for more information.
The default view is unique to BD FACSLink. The last used workspace (unique
to each user account) appears as the default.
4. Click Open.
Refreshing the results If the Specimen Management Workspace window is already open and you recently
data transferred results from a worklist to Specimen Management, you should refresh
the workspace to display all recent results data.
The Specimen Worksheet pane and the Test Worksheet pane refresh.
2. Click and drag the sort blocks to create a sorting hierarchy appropriate for
your needs. For example, you can drag the Test Code Sub ID into the first
position to serve as the primary sort criterion.
3. Select one of the sort blocks to sort the data based on the specific criterion, for
example, select Case Number to sort by case number.
Differentiating similar To ensure that you have the most current data, even when multiple sets of similar
data data appear, select the Collection Date/Time sort block to sort data by date and
time to differentiate between the sets of similar data.
Considerations for You decide which data is reviewed, released, or rejected from the Specimen
releasing data to LIS Management Workspace window. Your facility’s review and release procedures
should determine how results are released or rejected.
Verify that the results for the panels match the results in the reports generated
from BD FACSCanto clinical software (for the BD FACSCanto system), or BD
Multiset software/HLA-B27 software (for the BD FACSCalibur system).
– If the data is acceptable, you can release it to the LIS. Select Action >
Release.
– If the data is not acceptable, you can reject it. Select Action > Reject
Result.
26 BD FACSLink LIS Interface Solution Quick Start Guide
More information See Data Innovations’ Instrument Manager Help for more information.
2. Click Add.
This locale determines the text, field names, and button names for the BD
FACSLink driver.
7. If applicable, define the default instrument or cluster to which this user has
access. In the Default Instrument or Cluster field, select an available
instrument or cluster for this user ID.
Selecting the Supervisor checkbox allows the user to add new dictionary
entries throughout Instrument Manager without having to go to the
Dictionary Editor. See Data Innovations’ Instrument Manager Help for more
information.
9. Under Accessible Options, select the options you want to apply to this user
ID:
See Data Innovations’ Instrument Manager Help for details about Accessible
Options.
10. When you are finished with your selections, click Close.
2. Edit the values in the fields as described in Adding users (page 28).
2. Click Delete.
3. Click Yes.
More information See Data Innovations’ Instrument Manager Help for more information.
Chapter 4: Reference 31
The configurations are set up according to the instruments and connections you
require at your facility. If you need to edit the configuration or instrument
connections, contact your laboratory instrument or network administrator first.
z Contact BD Biosciences service and support. See Technical support (page 4).
2. In the Restore From Directory field, select the location of the directory that
contains the instrument driver configuration file you want to restore.
3. In the Configuration Name field, type the name of the configuration that is
associated with the driver you want to restore, for example, FACSCanto
II_SN123.
The configuration appears in the Configuration Editor list and is available for
selection.
34 BD FACSLink LIS Interface Solution Quick Start Guide
2. Navigate to the target directory where you want to save the configuration file.
3. Click Save.
Copying an instrument To copy the properties of an existing instrument driver and create a new one:
driver 1. In the Configuration Editor dialog, click an instrument configuration in the
list.
2. Click Copy.
More information See Data Innovations’ Instrument Manager Help for more information.
36 BD FACSLink LIS Interface Solution Quick Start Guide
Description The driver is the software interface between the BD instrument and Data
Innovations’ Instrument Manager. Drivers require configurations that are specific
to each BD instrument.
Viewing driver properties To view the driver properties for a specific configuration:
1. In the main Instrument Manager window, select Configuration >
Configuration Editor.
2. Click Properties.
Typically, you do not need to select any options on this tab. However, you
can modify the data formats for the order specimen ID and the result
specimen ID formats using the following options:
z Strip Leading Zeros. Removes leading zeros from the specimen ID.
– Driver configuration. Use this tab to select the instrument type you want
to use for this configuration, set the base result and worklist directory
paths, and modify the way directory paths are described. The product
version for this driver appears in the Product Version field.
– SPA v3.0.1. Select this option to build, save, export, delete, print, and
open SPA II (SPA software version 3.0.1) format worklists. Exported
worklists are saved as XML files in the base worklist directory.
– SPA v4.0. Select this option to build, save, export, delete, print, and open
SPA III (SPA software version 4.0) format worklists.
– FACSCanto v2.4. Reads and processes CSV result files. Select this option
to build, save, export, delete, print, and open BD FACSCanto format
worklists.
– FACSCanto v2.2. Reads and processes CSV result files. Select this option
to build, save, export, delete, print, and open BD FACSCanto format
worklists.
– FACSCalibur. Reads and processes EXP result files. Select this option to
build, save, export, delete, print, and open BD FACSCalibur format
worklists.
Exported worklists are saved as XML files in the Base Worklist Directory.
Chapter 4: Reference 39
Viewing or changing The base directories can be configured to accommodate your instrument
directories configuration and specific workflow. Results data is stored on the specific
instrument. The base worklist data is stored on the Instrument Manager server.
– Clear the checkbox to make the Base Result Directory the full result
directory.
To change the result directory location (where instrument results data is stored)
for this instrument:
Under Base Result Directory, select a directory.
You can also click Browse to open the Browse For Folder dialog.
Navigate to the appropriate folder, click the folder name, and then click OK.
2. Navigate to the appropriate folder, click the folder name, and then click OK.
40 BD FACSLink LIS Interface Solution Quick Start Guide
This determines how long the software pauses after checking for result
messages to parse and order messages to send. The default is 10 seconds.
Chapter 4: Reference 41
2. Click Properties.
42 BD FACSLink LIS Interface Solution Quick Start Guide
– Connection Name. Displays the connection name. You can create a new
connection name by typing over the existing name.
z Select the Explode Coded Entries for this Connection checkbox to send
a comment or a full description of the result code to the connection (in
addition to sending codes). This is typically used for LIS connections.
The LIS must be capable of receiving the full description. You can
explode the following codes: Patient Comments, Specimen Comments,
Test Comments, and Test Results.
Chapter 4: Reference 43
More information See Data Innovations’ Instrument Manager Help for more information.
Related topics z Viewing and managing the connection status (page 44)
44 BD FACSLink LIS Interface Solution Quick Start Guide
The connection starts and the status changes from Off to On in the Status
column. If you are using a TCP/IP connection, the status might temporarily
appear as Connecting if the TCP/IP link is not established.
The connection stops and the status changes from On to Off in the Status
column. This only stops the selected connection. It does not remove the
connection from the list.
Status detail dialog This dialog includes the following fields and buttons:
options
– Driver. This field displays the current driver version.
– Status. This field displays the current status from the Status Display
dialog, the date, and the time.
– Device. This field describes the network device used for this connection.
– Last Message Sent. This field describes the last communication or message
sent.
– Clear SendQ. Click this button to clear all messages in the send queue.
– Clear Errors. Click this button to clear any error messages in the field.
More information See Data Innovations’ Instrument Manager Help for more information.
BD worklist formats
About this topic This topic describes the different worklist formats for BD instruments.
SPA worklist format The BD SPA worklist is in XML format. This worklist displays one carousel per
file. The following categories are included in this format:
BD FACSCanto worklist The BD FACSCanto worklist is in XML format. This worklist displays five
format carousels per file. All tags listed in the table are mandatory even if they have a null
value.
BD FACSCalibur worklist The BD FACSCalibur worklist is in a text file, tab delimited format. This worklist
format displays one carousel per file. Each line in the file is a separate sample. All
columns listed in the table are mandatory. If the value is null, a "." is displayed in
that column unless otherwise specified ("Required to have a value").
Descriptions The following figure describes the tools in the BD FACSLink Manager toolbar.
– New. Click this tool to select an instrument type and to create a new,
blank worklist file.
– Close. Click this tool to close the open worklist without saving.
– Save. Click this tool to save the current worklist with a default name.
– Save As. Click this tool to save the current worklist with a different name.
– Worklist Options. Click this tool to select data elements to populate the
Case Number field.
– Use large icons. Click this tool to make the toolbar icons larger.
2. In the Import From Directory field, select the directory where the workspace
file is located. Workspace files have a .smw file extension.
4. Click Import.
4. Click Save.
More information See Data Innovations’ Instrument Manager Help for more information.
3. Click Delete.
More information See Data Innovations’ Instrument Manager Help for more information.
Error messages
About this topic This topic describes how to view and clear error messages.
Viewing error messages Error messages appear in the Status Detail dialog. See Viewing and managing
connections (page 41) for more information.
Clearing error messages To clear any error messages in the Last Message Received table, click Clear Errors.
Chapter 5: Troubleshooting 53
Software issues
About this topic This topic describes possible software problems and how to correct them.
File not selected to be The Load Result button was clicked and a Select a worklist, then click Load Result
processed. worklist has not been selected to be again.
processed.
File selected does not The Load Result button was clicked and a Select an appropriate worklist, then
have <value> file type file with an incorrect extension was selected click Load Result again.
to be processed.
Thin client license All available thin client licenses are open. Close another instance, or wait for
exceeded another licensed user to close their thin
client.
Barcode scanner error The barcode scanner does not scan the Make sure that the Caps Lock, Shift
barcode. and Control keys are off on the
keyboard.
Need more information fast?
Information about this product is also available in your
software's Help system.
You can keep the Help window open while you use the
software or print the information directly from the window.