Beruflich Dokumente
Kultur Dokumente
Introduction
This guide incorporates all information from the 2010 Host Interface
Training Guide – Novice Level and is intended to serve as a replacement once
the advanced level training is completed.
Scope This guide is only applicable to the 2010 host interface, software version
03-12.
Caution! This guide serves as a supplement to the Roche Response Center host
interface training and is not for customer use. This document can be used in
conjunction with the Elecsys 2010 Advanced Level Host Interface CBT.
For further When in doubt of the information provided or if there is a need for further
information detail, refer to the 2010 host interface document, operator’s manual, or
Systems Support department.
Definitions In all examples and formats, a diamond (à) is used to represent a space.
Introduction There are several host parameters on the 2010 that impact the
communications between the host and analyzer. This section reviews these
parameters including how to set them.
Setting All host parameters on the 2010 are configured using the software.
parameters
Use the steps below to access host parameters.
Step Action
1 Touch the Util tab.
2 Touch the Interface Setup tab.
3 Press the appropriate button until desired setting is
displayed.
Screen The screen below shows the display when Interface Setup tab is pressed.
The on setting activates the communication port while the off setting
deactivates the communication port.
Baud rate Baud rate can be set to 2400, 4800, 9600 or 19200.
Upload options Results can be set to upload with or without a printout and automatically or
manually. To set the upload options, use the steps below.
Step Action
1 Press Util tab.
2 Press Documentation Setup tab.
3 Select Printout, Upload, or Print/Upload under Document
Options.
4 Select Automatic On or Automatic Off under Automatic Options.
Note: If the 2010 is set to upload, results will not be deleted until they are
upload to the host.
ASTM standards The low-level protocol, E1381-91, describes how the data is transmitted
between the 2010 and host. This standard provides rules for how the two
systems talk to each other. Refer to the Protocol section for more details.
The high-level protocol, E1394-91, relates to the packet content and format of
the data that is transmitted. This standard provides rules for the sentence
structure. Refer to the Transmission Packets section for more information.
The 2010 implementation of these two standards and related terminology are
summarized in this document. Detailed specifications can be found in the
Elecsys 2010 Host Interface Manual.
ASTM The following terms are used in the ASTM standard and 2010 specification.
terminology
Term Definition
Field One specific attribute of a record or patient.
Record A group of fields describing one aspect of a
message or patient.
Message A group of records describing a patient and
its related data.
Message This diagram shows the relationship between a message, record and field.
diagram
MESSAGE RECORD FIELD
Header Record Sequence
Number
Patient Record Patient ID
Order Record Patient Name Patient Name
Results Record Patient Sex
Terminator Patient Location
Record
Message This example shows how fields, records and messages are related.
example
Field
3L|1[CR]
Message
Messages Messages are a combination of records that are used to transmit data about a
patient. This table lists the different messages used in the ASTM standard.
Message Use
Test Selection Request 2010 asking for test selections
Test Selection Download Host sending test selections
Results Request Host asking for specific results
Measured Data 2010 sending results
Records Records describe one aspect of a message or patient. This table lists the
different records used.
Messages and This table shows the combination of records used for each message.
records
Message order This example shows the various records that can be used to create a message
and how the hierarchy is used.
Delimiters Delimiters are used to separate information. Delimiter characters are defined
by the host and transmitted in the Message Header record. The table below
lists the delimiters used in the ASTM standard but any character may serve as
a delimiter.
Delimiter The message below provides an example of how delimiters are used.
example
1H|\^&| | | | | | | | | |P| |[CR] Component
Record delimiters
2P|1[CR] delimiters
3O|1|000004|40^0^4^^SAMPLE^REDUCED|^^^10^0\^^^50^0\^^^20^0
\^^^30^0|R|19970425085218| | | | |N| | | | | | | | | | | | | |Q[CR]
Repeat
4L|1|F[CR] Delimiter
Field
delimiters
General notes The Message Header record is used by the host and 2010 at the beginning of
every message. This record identifies the sender and defines the delimiters
used in the message.
Because the field delimiters have not been defined, a field delimiter does not
separate the first and second fields of the Message Header record.
Message Header Below is the content of the Message Header record. Framing and delimiters
record content are not included in the table.
Processing IDs This table lists the possible processing IDs and the definition of each. The
processing ID is used to indicate the purpose of the message. The host is not
required to send the Processing ID.
ID Name Use
P or null Production This is the normal processing ID and
message should be processed according to
protocol. The 2010 will send a P.
D Debugging Message is initiated for debugging
purposes.
Message Header Below is an example of a Message Header record sent by the 2010.
record example
1
Data Frame Record Delimiter Field Field Field
Start Number Type ID Definition Delimiter Delimiter Delimiter
STX 1 H |\^& | | |
Example 1 The previous Message Header record example transmitted the following
details information.
Message Header Below is an example of a Message Header record sent by the host. In this
record example example, there is no data after the sender name so the remaining fields are not
2 sent.
Example 2 The previous Message Header record example transmitted the following
details information.
Introduction The Message Terminator record is the last record in every message. It is used
by both the 2010 and host. The 201 will send errors concerning the protocol
in the Message Terminator Record.
Message Below is the content of the Message Terminator record. Framing and
Terminator delimiters are not included in the table.
record content
Termination The table below gives the various termination codes that are used in the
codes Message Terminator record. The Message Terminator record is used to give
additional information about the message transmission. These codes can be
used for troubleshooting protocol issues.
Code Definition
N or Null normal end
E unknown system or packet content error
F last request for information processed
I no information available for last query
Q error in last request for information
Message Below is an example of a Message Terminator record sent by the 2010. In this
Terminator example, there is no Termination Code field because the message ended
record example normally.
Example details The previous Message Terminator record example transmitted the following
information.
Introduction The Patient Information record is used by the host and 2010 to send
information about a specific patient.
The Patient Information record is always a level 1 record and will precede a
Test Order record if one is present.
Patient Below is the content of the Patient Information record. Framing and
Information delimiters are not included in the table.
record content
Note: The 2010 only recognizes the Laboratory Assigned Patient ID field. All
other fields are ignored.
Patient Below is an example of a Patient Information record sent by the host. In this
Information example, there is no data after the Laboratory Assigned Patient ID field so the
record remaining fields are not sent.
example 1
Data Frame Record Field Sequence Field Field
Start Number Type ID Delimiter Number Delimiter Delimiter
STX 2 P | 1 | |
Example 1 The previous Patient Information record example transmitted the following
details information.
Patient Below is an example of a Patient Information record sent by the host. In this
Information example, there is no data after the Laboratory Assigned Patient ID field so the
record remaining fields are sent empty with only field delimiters.
example 2
Data Frame Record Field Sequence Field Field
Start Number Type ID Delimiter Number Delimiter Delimiter
STX 2 P | 1 | |
Patient Below is an example of a Patient Information record sent by the host. In this
Information example, there is no Patient ID.
record
example 3
Data Frame Record Field Sequence
Start Number Type ID Delimiter Number
STX 2 P | 1
Example 3 The previous Patient Information record example transmitted the following
details information.
Introduction The Test Order record is used by the 2010 and host to transmit the test
selections for a specific sample. This record can also be used by the host to
cancel test selections for a sample.
The Test Order record is always a level 2 record and follows the Patient
Information record. It will also precede a Result record if one is present.
Note: The host must echo the same patient information contained in the
Request Information record when responding to a query.
Test Order Below is the content of the Test Order record. Framing and delimiters are not
record content included in the table.
Instrument This table details the components of the Instrument Specific ID.
specific ID
Component Valid Entries
sequence number 2010 sequence number
carrier number Rack or sample disk number
rack system: 1-9999
disk system: 0-9
position in carrier Position in rack or sample disk
rack system: 1-5
disk system: 1-30
format not used by 2010
data carrier type Sample type: CONTROL or SAMPLE
container type Sample volume: NORMAL (75 or 100mm tube) or
REDUCED (all other tube sizes)
container cap type not used by 2010
initial volume in ml not used by 2010
Universal test This table details the components of the Universal Test ID.
ID
Component Valid Entries
universal test ID not used by 2010
test name not used by 2010
test ID type not used by 2010
2010 test number Three digit Elecsys test code
* first two digits are test code defined in reagent
barcode and listed on test conditions screen (1-99)
* last digit represents generation (0-2)
See appendix A in Elecsys 2010 Host Manual
auto-dilution factor null or 0: sample not to be diluted
1, 2, 3, 5, 7, 9, 10: see Auto-dilution factor table
pre-dilution factor 0: sample not pre-diluted
1: sample pre-diluted
Test Order Below is an example of a Test Order record from the host. In this example,
record there is no data after the Report Types field so remaining fields are not sent.
example
Data Frame Record Field Sequence Field Specimen
Start Number Type ID Delimiter Number Delimiter ID
STX 3 O | 1 | 000083
Introduction The Result record is used by the 2010 to transmit the results to the host.
The Result record is always a level 3 record and will always be preceded by a
Test Order record.
Result record Below is the content of the Result record. Framing and delimiters are not
content included in the table.
Universal test This table details the components of the Universal Test ID.
ID
Component Valid Entries
universal test ID not used by 2010
test name not used by 2010
test ID type not used by 2010
2010 test number Three digit Elecsys test code
* first two digits are test code defined in reagent
barcode and listed on test conditions screen (1-99)
* last digit represents generation (0-2)
See appendix A in Elecsys 2010 Host Manual
auto-dilution factor null or 0: sample not to be diluted
1, 2, 3, 5, 7, 9, 10: see Auto-dilution factor table
pre-dilution factor 0: sample not pre-diluted
1: sample pre-diluted
Result record Below is an example of a Result record from the 2010. In this example, there
example is no Instrument ID field so the last field is the field delimiter.
Example details The previous Result Record example transmitted the following information.
Introduction The Comment record is used by the 2010 and host to transmit information
specific to the previous record.
Comment Below is the content of the Comment record. Framing and delimiters are not
record content included in the table.
Example details The previous Comment record example transmitted the following
information.
Introduction The Request Information record is used by the 2010 and host to request
demographics, test selections or test results for specific patients, specimens,
tests or dates.
Request Below is the content of the Request Information record. Framing and
Information delimiters are not included in the table.
record content
Range ID This table details the components of the Starting and Ending Range ID
Number.
Query data The following table shows what data is sent by the 2010 when querying
Universal test This table details the components of the Universal Test ID. When sent by the
ID host as a query for a sample’s results, ALL is used.
Component Valid Entries
universal test ID not used by 2010
test name not used by 2010
test ID type not used by 2010
2010 test number Three digit Elecsys test code
* first two digits are test code defined in reagent
barcode and listed on test conditions screen (1-99)
* last digit represents generation (0-2)
See appendix A in Elecsys 2010 Host Manual
auto-dilution factor null or 0: sample not to be diluted
1, 2, 3, 5, 7, 9, 10: see Auto-dilution factor table
pre-dilution factor 0: sample not pre-diluted
1: sample pre-diluted
Example details The previous Request Information record example transmitted the following
information.
Introduction ASTM allows for records that can be defined by the manufacturer to transmit
data not found in other records. These are the Manufacturer Specific records.
The main use of these records is the LSM. Refer to host manual for details.
Disabling These records are disabled by default starting with version 03-08, data disk 14.
records It is recommended that the host keep them disabled.
Record types The table below lists the Manufacturer Specific records used by the 2010.
Record Description
Action Confirmation Confirmation of processing actions
Action Request Request for instrument action
Calibrator Parameters Calibrator parameter definition
Calibration Request Request for calibration
Diluent Parameters Diluent parameter definition
Instrument Configuration Instrument specific configuration
Instrument Status General status information
Log File Transfer of message information
Processing Message Fast warnings and system events
Control Parameters Control parameter definition
Result Context Data on reagent lot used for
measurement
Raw Result Transfer of raw results
Service Data Instrument specific service data
Sample Status Sample specific status
Test Application Roche accessible part of application
Test Conditions User accessible part of application
Substance Data General substance information
Introduction The 2010 and host use packets to communicate. This section provides details
on the structure and use of these packets.
General notes • Messages are transmitted in one or more packets dependent on size.
• Most host vendors transmit one record per packet.
• Each packet has the same general format.
• Packet length is a maximum of 247 bytes.
• There are 7 bytes of delimiters, checksum and identifiers.
• There is a maximum of 240 data byes.
Packet format The format below is a general format for all frames.
Frame Number Each packet has a frame number from zero to seven for error recovery.
Packets within one complete message are numbered starting with 1 and going
to 7 then continuing with 0, 1 etc.
Data This portion of the packet is dependent on the record type. See specific
format sections for details.
Data End Each packet ends with an ETX (ASCII 03) or ETB (ASCII 23). The end packet
will always have a data end of ETX and the remaining packets will have a data
end of ETB.
Checksum Each packet has a checksum specific for the data in that packet. See the
Checksum section for calculation.
End Code All packets terminate with CR (carriage return) and LF (line feed).
Start of End of
Text Data Text End Code
[STX]1H|\^&| | |ASTM-Host[CR][ETX]59[CR][LF]
Introduction This section reviews the protocol used by the 2010 to transmit messages. It
summarizes how the 2010 implements the ASTM low level protocol.
Protocol rules The following are general rules of the 2010 protocol.
1. Information flows in one direction at a time.
2. Either the host or 2010 may initiate communications.
3. Only one device at a time can be a receiver.
4. Only one device at a time can be a sender.
5. When data is not being transferred, both devices are considered to be idle.
6. When idle, all but an ENQ is ignored.
Control packets Control packets consist of control characters used to control the flow of
information between the 2010 and host. The table below details the packets.
Establishment In the Establishment phase the device wishing to be sender will send an ENQ
phase letting the other device know it wants control of the communication line.
Transfer phase Records are transmitted by the sender in the Transfer phase.
Termination Control of the line is relinquished by the sender in the Termination phase and
phase both devices return to the idle state.
Phase diagram The diagram below further defines the four phases.
Timing This table provides the times that are used by the sender and receiver and any
actions that may occur in response to a time out.
Introduction The 2010 can receive test selections from the host in response to a query or
prior to a sample being identified by the 2010. This section describes both
methods.
Query mode In the query mode, test selections are sent in response to a query from the
2010. The 2010 will send a query for the sample after the sample is identified.
This requires START to be pressed. Sample scan will not initiate
communications with the host. Requests are only sent for samples without
test selections assigned at the 2010.
Initiating test Use the following steps to initiate a test selection query from the 2010.
selection query
Step Action
1 Load samples on the sample disk or in sample racks.
2 Press START.
Query example The following data shows how the host and 2010 interact in query mode. The
first box shows the query from the 2010 for test selections and the second box
shows the download of test selections from the host in response to the query.
Message
E2010[ENQ] Establishment Phase
Header HOST[ACK]
Record E2010[STX]1H|\^&| | | | | | | | | |P| |[CR][ETX]05[CR][LF]
HOST[ACK]
Transfer Phase
Request E2010[STX]2Q|1|^000083^135^0^1^^SAMPLE^NOR
Information MAL| |ALL| | | | | | | |O[CR][ETX]FE[CR][LF]
Record HOST[ACK]
Message E2010[STX]3L|1[CR][ETX]3C[CR][LF]
Terminator HOST[ACK]
Record E2010[EOT] Termination Phase
Message
HOST[ENQ]
E2010[ACK] Establishment Phase
Header
Record HOST[STX]1H|\^&| | |ASTM-Host[CR][ETX]59[CR][LF]
E2010[ACK]
HOST[STX]2P|1[CR][ETX]3F[CR][LF]
Transfer Phase
Patient E2010[ACK]
Record HOST[STX]3O|1|000083|135^0^1^^SAMPLE^NORMAL
\^^^10^0\^^^150^0|R| | | | | |N| | | | | | | | | | | | | |Q[CR]
[ETX]F9[CR][LF]
Message HOST[STX]4L|1[CR][ETX]3D[CR][LF]
Terminator E2010[ACK]
Record HOST[EOT] Termination Phase
Unrequested In the unrequested mode, test selections are sent when the host is ready to
send them. Test selections are sent before a sample is identified. When the
2010 identifies the sample, it will run what is assigned at the instrument
instead of sending a query.
Unrequested The following data shows how the host and 2010 interact in unrequested
example mode. The box shows the test selection download from the host. Remember
that there is no query from the 2010.
Message
HOST[ENQ]
E2010[ACK] Establishment Phase
Header
Record HOST[STX]1H|\^&| | |ASTM-Host[CR][ETX]59[CR][LF]
E2010[ACK]
HOST[STX]2P|1[CR][ETX]3F[CR][LF]
Transfer Phase
Patient E2010[ACK]
Record HOST[STX]3O|1|000083|135^0^1^^SAMPLE^NORMAL
\^^^10^0\^^^150^0|R| | | | | |N| | | | | | | | | | | | | |Q[CR]
[ETX]F9[CR][LF]
Message HOST[STX]4L|1[CR][ETX]3D[CR][LF]
Terminator E2010[ACK]
Record HOST[EOT] Termination Phase
Automatic In automatic mode, results for a sample are sent as soon as all results for the
sample are completed.
Manual The operator can initiate transmission of results from the 2010. All results
can be sent or just one sample’s.
Query The host can request results for a specific sample from the 2010 by sending a
Request Information record. The 2010 will send the results at the next
available time.
Result example No matter which method is used, automatic, manual or query, the
transmission of the result looks the same.
The following data shows how the host and 2010 interact when results are
being sent to the host from the 2010.
E2010[ENQ]
Message HOST[ACK] Establishment Phase
Header
E2010[STX]1H|\^&| | | | | | | | | |P| |[CR][ETX]05[CR][LF]
Record
HOST[ACK]
E2010[STX]2P|1| | | | | | | | | | | | | | | | | | | | | | | | | |
Transfer Phase
Patient
Record | | | |[CR][ETX]3B[CR][LF]
HOST[ACK]
E2010[STX]3O|1|000083|135^0^1^^SAMPLE^NOR
Order MAL|ALL|R|19980403090614| | | | |X| | | | | | | | |
Record
| | | | |O| | | | |CR][ETX]79[CR][LF]
HOST[ACK]
E2010[STX]4R|1|^^^10^0|2.73|ulU/ml|0.270^4.20|N| |F| |
|19980403090641|19980403092503|
Result [CR][ETX]B7[CR][LF]
Records HOST[ACK]
Transfer Phase
E2010[STX]5R|2|^^^150^0|7.43|ulU/ml|0.110^198.0|N| |
F| | |19980403090723|19980403092545|
[CR][ETX]24[CR][LF]
HOST[ACK]
Message E2010[STX]6L|1[CR][ETX]3F[CR][LF]
Terminator HOST[ACK]
Record E2010[EOT] Termination Phase
Introduction The 2010 works with a combination of query and unrequested test selecting.
Implementation is not based upon switch settings. This section describes the
workflow of the 2010 analyzer in regard to the host interface.
STEP 2
If test selections are available at
the 2010, these are run. Step 3
If no test selections are
STEP 1 found, a query is sent to the
Sample is placed on analyzer host, else go to Step 5.
and barcode is read.
Step 5
Sample is processed.
Step 4
The host responds with
Step 6 appropriate test selections.
Results are
transmitted to host.
Details This table gives more details on the 2010 workflow.
Step Action
1 The sample is placed on the analyzer and the barcode is read.
2 If test selections are available for this sample, they are used.
3 If test selections are not available, a query is sent to the host.
Sample scan Be aware that pressing sample scan does not initiate communications with the
host. This is only done after start is pressed.
Introduction The 2010 uses a standard checksum calculation. This section provides an
example and the general rules about the 2010 checksum calculation.
Calculation The table below shows the standard checksum calculation steps.
Step Action
1 Add decimal values of data from frame number to ETX.
2 Take sum from Step 1 modulo 256.
3 Convert value from Step 2 to hexadecimal.
Note: The checksum is used on messages only. Control packets do not use a
checksum.
Location The 2010 has a standard 9 pin male connector on the left-hand side of the
analyzer as shown in the picture below. Older 2010’s may have female
connectors.
Caution! Turn off the 2010 at the circuit breaker prior to connecting or disconnecting
the host cable. If not, damage can occur to the 2010.
The Elecsys 2010 Host Interface Manual states that the 2010 does not have to
be jumpered. We have found that things work better if the 2010 end of the
cable is indeed jumpered as shown above.
Introduction This section describes what troubleshooting tools are available on the 2010
and provides troubleshooting tips including details on interface alarms.
Loop back test There is not a loop back test on the 2010.
Flowchart This flowchart shows a basic troubleshooting process for the 2010 interface.
Receive call that host
is not working
Has it Test
No Yes Results Yes No
worked selections Error
getting to getting to
before? messages?
2010? host?
Yes No No Yes
No No
Yes
Yes Yes
Alarm codes There are twelve different host interface alarms on the 2010. The table below
further defines the codes and provides possible solutions.
Test selection This is an example of a message transmission in which the 2010 has read a
request example sample’s barcode and sent a request for test selections to the host.
Test selection This is an example of a message transmission in which the host is sending test
download selections to the 2010 for a specific sample.
example
Sample result This is an example of a message transmission in which the 2010 is sending
upload example results to the host for a specific sample.
Control result This is an example of a message transmission in which the 2010 is sending
upload example control results to the host.
Purpose This document is to be used as a review of the Elecsys 2010 host interface,
advanced level training. Answers can be found in the next section. Send
completed test records, including completed Training Acknowledgement
form, to the TSS Trainer.
2. The host must echo what information from the Request Information
record when sending test selections in response to a query?
a) Patient information
b) Sample information
c) Test information
Questions (continued)
7. What is a group of records?
a) Packet
b) Message
c) Frame
(continued)
14. What three methods can be used to get results from the 2010 to the host?
a) Automatic, Manual, Unrequested
b) Automatic, Manual, Query
c) Automatic, Print/Upload, Query
15. In Automatic results transmissions, results for a sample are sent when all
of the results are available for that sample. What settings are required?
a) Automatic ON and Print/Upload or Upload
b) Automatic OFF and Print/Upload or Upload
c) Automatic ON and Print/Upload or Upload or Printout
16. In manual results transmission, results for a sample are sent when
requested by the operator. What settings are required?
a) Automatic ON and Print/Upload or Upload
b) Automatic OFF and Print/Upload or Upload
c) Automatic ON and Print/Upload or Upload or Printout
17. When the 2010 sends an ENQ and the host responds with an ACK, what
is happening?
a) The 2010 has successfully relinquished control of the transmission
line and the idle phase has been entered
b) The 2010 has successfully transmitted a data packet
c) The 2010 has successfully bid for control of the transmission line and
the transfer phase has been entered
Answers 1. A
2. B
3. C
4. B
5. A
6. C
7. B
8. B
9. A
10. B
11. C
12. B
13. A
14. B
15. A
16. B
17. C
18. A
19. C
20. B
I acknowledge that I have received, read, completed and understood the Advanced Level training
materials for the Elecsys 2010.
I understand that the execution and return of this acknowledgement is an official record that I
have successfully completed this training and that this record will become a permanent part of
my training record.
Date: ___________________________________________________________