Difference between revisions of "Laboratory Specimen Handoff"

From IHE Wiki
Jump to navigation Jump to search
m (Updated transaction numbers)
 
(25 intermediate revisions by 2 users not shown)
Line 1: Line 1:
 
 
== Summary ==
 
== Summary ==
  
Passing of specimens between Laboratory Automation Systems (LAS) and Specimen Processing Devices (SPD) is an integral part of clinical laboratory operation.  In the absence of any industry guidance, such handoffs are currently defined on an ''ad hoc'' basis.  Implementers naturally turn to predecessor products for guidanceThis approach causes similar interfaces to be created within each organization, even though such interfaces share features with products from a variety of vendors.
+
Passing of specimens between Laboratory Automation Systems (LAS) and Specimen Processing Devices (SPD) is an integral part of clinical laboratory operation.  But current LAS and SPD vendors have little guidance on how to implement specimen handoffHL7 and CLSI AUTO3-A provide some direction, but do not provide specific guidance for individual handoff workflows.
  
There clearly exists a need for fully specified interface protocols to reduce the time and costs associated with managing sample handoff in clinical laboratoriesThe IHE-LAB Committee is the appropriate entity to create and promote such solutions.  Prior work by the Committee on the LDA profile is evidence of that need.
+
In the absence of any industry guidance, specimen handoffs are defined on an ''ad hoc'' basisThis approach tends to ensure that each vendor will take a unique path, even though specimen handoff interfaces share a high degree of commonality among most vendors.
  
This proposed profile will enable LAS and SPD to implement specimen handoff using standardized protocols, reducing the new product design burden for all parties.
+
There clearly exists a need for fully specified interface protocols to reduce the time and costs associated with managing specimen handoff in clinical laboratories.  The IHE-LAB Committee is the appropriate entity to create and promote such solutions.  Prior work by the Committee on the LDA profile is evidence of that need.
  
 +
The Laboratory Specimen Handoff (LSH) profile will provide standardized workflows for the most common laboratory specimen handoff use cases.
 +
<br />
  
== The Problem ==
+
== Benefits ==
  
Current LAS and SPD vendors have little guidance on how to implement specimen handoff interfaces between their equipmentHL7 and CLSI AUTO3-A provide some direction, but do not provide specific guidance for individual handoff workflows.
+
The LSH Profile will advance the IVD industry by providing a common, fully specified framework for the most common specimen handoff use cases, based on the collective experience of active participants from across the IVD industry.   
  
 +
Promoting a consistent understanding of specimen handoff will have a number of benefits. 
  
== Proposed Solution ==
+
#  Reduced design burden for Specimen Processing Devices
 +
#  Reduced design burden for the laboratory automation systems to which SPDs are attached
 +
#  Comprehends handoff pitfalls that may not be apparent to an individual development team
 +
#  Provide a generally accepted foundation upon which the industry can build
  
The proposed solution is a Laboratory Specimen Handoff (LSH) Profile.  The LSH Profile facilitates laboratory specimen passing by providing detailed message transactions used during handoff.
+
== Details ==
  
The LSH Integration Profile will cover the two most common handoff use cases in the clinical laboratory.  The LSH Profile will be implemented in phases, by use case, in order of commonality.
+
The Laboratory Specimen Handoff (LSH) Integration Profile facilitates laboratory specimen passing by providing detailed message transactions used during specimen handoff.
  
 +
The LSH Integration Profile will cover the two most common handoff use cases in the clinical laboratory.  Implementation will occur in phases, in order of commonality.
  
;Use Case 1 - Single-Specimen Point-in-Space Acquisition
 
  
:STM notifies SPD that a specimen container is ''en route'' to the SPD.  The SPD prepares for specimen arrival, typically receiving work order steps (by some means other than LSH).  Upon arrival, the STM presents the specimen for acquisition.  Acquisition is typically aspiration.  The SPD acquires the specimen from the container, without taking possession of the container.  Automation removes the specimen from the aspiration position.
+
:'''Use Case 1''' - Single-Specimen Point-in-Space Acquisition
  
 +
:The Specimen Transport Manager (STM) notifies SPD that a specimen container is ''en route'' to the SPD.  The SPD prepares for specimen arrival, typically receiving work order steps (by some means other than LSH).  Upon arrival, the STM presents the specimen for acquisition.  Acquisition is typically aspiration.  The SPD acquires the specimen from the container, without taking possession of the container.  Automation removes the specimen from the aspiration position.
  
;Use Case 2 - Single-Specimen Container Transfer
+
:'''Use Case 2''' - Single-Specimen Container Transfer
  
 
:SPD takes posession of specimen container.  Workflow TBD
 
:SPD takes posession of specimen container.  Workflow TBD
Line 33: Line 39:
 
;Additional Use Cases
 
;Additional Use Cases
  
:Additional phases may address other specimen handoff use cases.  A likely addition is "Multi-Specimen Container Transfer".
+
:Additional phases may address other specimen handoff use cases.  Likely additions are "Multi-Specimen Container Transfer" and "Assay Availability".
  
<br />
 
 
== Benefits ==
 
 
The LSH Profile will advance the IVD industry by providing a common, fully specified framework for the most common specimen handoff use cases, based on the collective experience of active participants from across the IVD industry. 
 
 
Promoting a consistent understanding of specimen handoff will have a number of benefits. 
 
 
#  Reduced design burden for individual product interfaces
 
#  Reduced design burden for equipment to which a variety of products may be attached
 
#  Comprehends common pitfalls that may not be apparent to a particular development team
 
#  Provide a generally accepted foundation upon which the industry can build
 
 
<br />
 
<br />
  
Line 52: Line 46:
  
 
=== Actors & Transactions ===
 
=== Actors & Transactions ===
<center>[[Image:LSH_Actors.png]]</center>
+
:[[Image:LSH_Actors.png]]
  
 
;Order Filler
 
;Order Filler
Line 68: Line 62:
  
  
Three actors will be affected by the LSH Integration Profile - Specimen Transport Managers (STM), Analyzers and Pre/Post Processors (PPP).  Examples of STM Actors are laboratory automation tracks and sample transport robots.  Analyzer Actors are typically in-vitro diagnostic devices.  Examples of PPP Actors are centrifuges and aliquotters.
+
Three actors will be affected by the LSH Integration Profile - Specimen Transport Managers (STM), Analyzers and Pre/Post Processors (PPP).  Examples of STM Actors are laboratory automation tracks and specimen transport robots.  Analyzer Actors are typically in-vitro diagnostic devices.  Examples of PPP Actors are centrifuges and aliquotters.
 
<br />
 
<br />
 
<br />
 
<br />
Line 75: Line 69:
 
== Standards and Systems ==
 
== Standards and Systems ==
  
'''Profile Status:''' Preliminary (Pre-Supplement)
+
'''Profile Status:''' Preliminary content below (Pre-Supplement)
  
'''Documents:''' [http://www.ihe.net/Technical_Framework/index.cfm#laboratory IHE Laboratory Technical Framework:]
+
'''Documents:'''  
:* [http://www.ihe.net/Technical_Framework/upload/ihe_lab_tf_rel2.pdf Vol. 1]
 
:* [http://www.ihe.net/Technical_Framework/upload/ihe_lab_tf_rel2-2.pdf Vol. 2]
 
 
'''Underlying Standards:'''
 
'''Underlying Standards:'''
 
:* [http://www.hl7.org HL7]
 
:* [http://www.hl7.org HL7]
 
:* [http://webstore.ansi.org/RecordDetail.aspx?sku=CLSI+AUTO5-A CLSI AUTO5-A] (HL7 Chapter 13)
 
:* [http://webstore.ansi.org/RecordDetail.aspx?sku=CLSI+AUTO5-A CLSI AUTO5-A] (HL7 Chapter 13)
 
  
 
== Use Cases ==
 
== Use Cases ==
Line 89: Line 80:
 
=== Use Case 1 - Single-Specimen Point-in-Space Acquisition ===
 
=== Use Case 1 - Single-Specimen Point-in-Space Acquisition ===
 
<br />
 
<br />
<center>[[Image:SSPA_Sequence.png]]</center>
+
:[[Image:SSPA_Sequence.png]]
  
 
'''Steps'''
 
'''Steps'''
Line 98: Line 89:
 
#:
 
#:
 
#  STM optionally sends "Status Request" to Device
 
#  STM optionally sends "Status Request" to Device
##  LSH.1 transaction
+
##  LAB-41 transaction
 
##  STM may send a "Status Request" message unsolicited at any time, to trigger a "Status Update" message
 
##  STM may send a "Status Request" message unsolicited at any time, to trigger a "Status Update" message
 
#:<br />
 
#:<br />
 
#:
 
#:
 
#  Device sends Status Update to STM
 
#  Device sends Status Update to STM
##  LSH.2 transaction
+
##  LAB-42 transaction
##  Trigger is either the Device status change or the receipt of a Status Request (LSH.1)
+
##  Trigger is either the Device status change or the receipt of a Status Request (LAB-41)
 
#:<br />
 
#:<br />
 
#:
 
#:
Line 110: Line 101:
 
##  The meaning of "arrives" is system-dependent
 
##  The meaning of "arrives" is system-dependent
 
###  May mean first awareness by STM system, physical arrival at an STM subsystem, or any other point during STM handling
 
###  May mean first awareness by STM system, physical arrival at an STM subsystem, or any other point during STM handling
 +
#:<br />
 +
#:
 +
#  STM Creates a Specimen Transport Plan
 +
##  Determines that SPD is a destination in the plan
 
#:<br />
 
#:<br />
 
#:
 
#:
 
#  STM sends "Prepare for Specimen Acquisition" to Device
 
#  STM sends "Prepare for Specimen Acquisition" to Device
##  LSH.3/Command transaction
+
##  LAB-43/Command transaction
 
##  Includes container identifier (SID)
 
##  Includes container identifier (SID)
 
##  Optionally includes container information
 
##  Optionally includes container information
Line 133: Line 128:
 
##  Extensions -
 
##  Extensions -
 
###    No WOS for specimen
 
###    No WOS for specimen
####    Send "Prepare Complete" message rejecting specimen due to malformed message
+
####    Send "Prepare Complete" message rejecting specimen due to unknown specimen (no WOS)
 
####    STM does not present specimen
 
####    STM does not present specimen
 
####    Use case ends
 
####    Use case ends
Line 145: Line 140:
 
#:
 
#:
 
#  Device sends "Prepare Complete" to STM
 
#  Device sends "Prepare Complete" to STM
##  LSH.3/Response transaction
+
##  LAB-43/Response transaction
 
##  Extensions -
 
##  Extensions -
 
###    Message malformed at application level
 
###    Message malformed at application level
Line 170: Line 165:
 
#:
 
#:
 
#  STM sends "Start Specimen Acquisition" to Device
 
#  STM sends "Start Specimen Acquisition" to Device
##  LSH.3/Command transaction
+
##  LAB-43/Command transaction
 
##  STM may not move container between sending this message and receiving the "Specimen Acquisition Complete" message (Step 10)
 
##  STM may not move container between sending this message and receiving the "Specimen Acquisition Complete" message (Step 10)
 
##  Includes container identifier (SID)
 
##  Includes container identifier (SID)
Line 221: Line 216:
 
#:
 
#:
 
#  Device sends "Specimen Acquisition Complete" to STM
 
#  Device sends "Specimen Acquisition Complete" to STM
##    LSH.3/Response transaction
+
##    LAB-43/Response transaction
 
##    STM may assume that all Device apparatus is removed from the container envelope, and will remain removed until the next "Start Specimen Acquisition" message
 
##    STM may assume that all Device apparatus is removed from the container envelope, and will remain removed until the next "Start Specimen Acquisition" message
 
###    Only exception is an "Obstruction Error"
 
###    Only exception is an "Obstruction Error"
Line 232: Line 227:
 
##    Container is now under the control of the STM
 
##    Container is now under the control of the STM
 
#:<br />
 
#:<br />
#:
+
<br />
#  Device processes the acquired specimen
+
 
##    Typically, Device provides WOS updates as they become available
+
=== Use Case 2 - Single-Specimen Container Transfer ===
 +
<br />
 +
This workflow is TBD.
 
<br />
 
<br />
  
 
== Transactions ==
 
== Transactions ==
 
<br />
 
<br />
=== LSH.1 Status Request ===
+
=== LAB-41 Status Request ===
  
 
The Status Request transaction defines the message used by the Specimen Transport Handler (STH) to request Device status with respect to specimens arriving on the track interface.
 
The Status Request transaction defines the message used by the Specimen Transport Handler (STH) to request Device status with respect to specimens arriving on the track interface.
Line 246: Line 243:
  
 
==== Interaction Diagram ====
 
==== Interaction Diagram ====
 
''(TBD)''
 
 
<br />
 
<br />
 +
:[[Image:LSH1_Interaction_Diagram.png‎]]
 
<br />
 
<br />
  
Line 269: Line 265:
 
| '''Responsibility''' &<nowiki />nbsp; || STH    || Provide request for status
 
| '''Responsibility''' &<nowiki />nbsp; || STH    || Provide request for status
 
|-
 
|-
|                                      || Device  || Acknowledge request, and initiate a Status Update transaction (LSH.2)
+
|                                      || Device  || Acknowledge request, and initiate a Status Update transaction (LAB-42)
 
|}
 
|}
 
<br />
 
<br />
Line 275: Line 271:
 
==== HL7 2.5.1 Implementation ====
 
==== HL7 2.5.1 Implementation ====
  
HL7 2.5.1, Chapter 13, specifies the ESR^U02 Message for status requests.  Its usage in LSH.1 is shown below.
+
HL7 2.5.1, Chapter 13, specifies the ESR^U02 Message for status requests.  Its usage in LAB-41 is shown below.
 
<br />
 
<br />
  
Line 303: Line 299:
 
<br />
 
<br />
  
=== LSH.2 Status Update ===
+
=== LAB-42 Status Update ===
  
 
The Status Update transaction defines the message used to report Device status to the Specimen Transport Handler (STH), with respect to specimens arriving on the track interface.
 
The Status Update transaction defines the message used to report Device status to the Specimen Transport Handler (STH), with respect to specimens arriving on the track interface.
Line 310: Line 306:
  
 
==== Interaction Diagram ====
 
==== Interaction Diagram ====
 
''(TBD)''
 
 
<br />
 
<br />
 +
:[[Image:LSH.2_Interaction_Diagram.png]]
 
<br />
 
<br />
  
 
==== Interaction Model ====
 
==== Interaction Model ====
 
{|
 
{|
| '''Trigger'''  || colspan="2" | Device status changes, or the Device receives a Status Request (LSH.1).   
+
| '''Trigger'''  || colspan="2" | Device status changes, or the Device receives a Status Request (LAB-41).   
 
|-
 
|-
 
| <br />
 
| <br />
Line 339: Line 334:
 
==== HL7 2.5.1 Implementation ====
 
==== HL7 2.5.1 Implementation ====
  
HL7 2.5.1, Chapter 13, specifies the ESU^U01 Message for status updates.  Its usage in LSH.2 is shown below.
+
HL7 2.5.1, Chapter 13, specifies the ESU^U01 Message for status updates.  Its usage in LAB-42 is shown below.
 
<br />
 
<br />
  
Line 370: Line 365:
  
  
=== LSH.3 Command ===
+
=== LAB-43 Command/Response ===
 +
 
 +
==== LAB-43 Command ====
  
 
The Command transaction defines the Specimen Transport Handler (STH) message used to command the Device to prepare for specimen processing.
 
The Command transaction defines the Specimen Transport Handler (STH) message used to command the Device to prepare for specimen processing.
Line 376: Line 373:
 
<br />
 
<br />
  
==== Interaction Diagram ====
+
===== Interaction Diagram =====
 
 
''(TBD)''
 
 
<br />
 
<br />
 +
:[[Image:LSH.3_Command_Interaction_Diagram.png]]
 
<br />
 
<br />
  
==== Interaction Model ====
+
===== Interaction Model =====
 
{|
 
{|
 
| '''Trigger'''  || colspan="2" | STH needs to command the Device to perform an LAS operation  
 
| '''Trigger'''  || colspan="2" | STH needs to command the Device to perform an LAS operation  
Line 400: Line 396:
 
| '''Responsibility''' &<nowiki />nbsp; || STH    || Provide Device command
 
| '''Responsibility''' &<nowiki />nbsp; || STH    || Provide Device command
 
|-
 
|-
|                                      || Device  || Acknowledge message, and provide an LSH.3 Response when command is complete
+
|                                      || Device  || Acknowledge message, and provide an LAB-43 Response when command is complete
 
|}
 
|}
 
<br />
 
<br />
  
==== HL7 2.5.1 Implementation ====
+
===== HL7 2.5.1 Implementation =====
  
HL7 2.5.1, Chapter 13, specifies the EAC^U07 Message for equipment commands.  Its usage in LSH.3 is shown below.
+
HL7 2.5.1, Chapter 13, specifies the EAC^U07 Message for equipment commands.  Its usage in LAB-43 is shown below.
 
<br />
 
<br />
  
===== ESU^U01 Message =====
+
====== EAC^U07 Message ======
  
 
<div style="margin-left: 20px">
 
<div style="margin-left: 20px">
Line 420: Line 416:
 
   <tr><td>{</td>          <td>-- COMMAND Begin</td>  <td>M</td>    <td>[1..1]</td>      </tr>
 
   <tr><td>{</td>          <td>-- COMMAND Begin</td>  <td>M</td>    <td>[1..1]</td>      </tr>
 
   <tr><td>&nbsp; ECD</td> <td>Equipment Command Detail</td>  <td>M</td>  <td>[1..1]</td> </tr>
 
   <tr><td>&nbsp; ECD</td> <td>Equipment Command Detail</td>  <td>M</td>  <td>[1..1]</td> </tr>
   <tr><td>&nbsp; SAC</td> <td>Specimen Container Detail</td> <td>M</td>  <td>[1..1]</td> </tr>
+
   <tr><td>&nbsp; SAC</td> <td>Specimen Container Detail</td> <td>RE</td>  <td>[0..1]</td> </tr>
 
   <tr><td>}</td>          <td>-- COMMAND End</td>  <td>M</td>    <td>[1..1]</td>        </tr>
 
   <tr><td>}</td>          <td>-- COMMAND End</td>  <td>M</td>    <td>[1..1]</td>        </tr>
 
</table>
 
</table>
 
</div>
 
</div>
  
===== ACK^U01 Message =====
+
<br />
 +
#  SAC
 +
##  Required if STM knows SID.  Otherwise, optional.
 +
##  Include container dimensions, if known
 +
#  EQU.3 (Equipment State)
 +
##  ''Review codes provided in table.  Determine of we need to augment with new codes.''
 +
###    ''Coordinate with Dmytro on this.  He has experience in this area.''
 +
#  ECD.2 (Remote Control Command)
 +
##  PS - Prepare for Specimen
 +
##  SA - Start Specimen Acquisition
 +
##  Allow command option to only send ACK^U07 on error
 +
##  Enhanced acknowledge mode
 +
#:<br />
 +
#:
 +
 
 +
====== ACK^U07 Message ======
  
 
<div style="margin-left: 20px">
 
<div style="margin-left: 20px">
Line 439: Line 450:
 
<br />
 
<br />
  
 
+
==== LAB-43 Response ====
=== LSH.3 Response ===
 
  
 
The Command transaction defines the Analyzer response used to communicate the outcome of a command from the Specimen Transport Handler (STH).
 
The Command transaction defines the Analyzer response used to communicate the outcome of a command from the Specimen Transport Handler (STH).
Line 446: Line 456:
 
<br />
 
<br />
  
==== Interaction Diagram ====
+
===== Interaction Diagram =====
 
 
''(TBD)''
 
 
<br />
 
<br />
 +
:[[Image:LSH.3_Response_Interaction_Diagram.png]]
 
<br />
 
<br />
  
==== Interaction Model ====
+
===== Interaction Model =====
 
{|
 
{|
 
| '''Trigger'''  || colspan="2" | Device needs to communicate the outcome of a command.  
 
| '''Trigger'''  || colspan="2" | Device needs to communicate the outcome of a command.  
Line 474: Line 483:
 
<br />
 
<br />
  
==== HL7 2.5.1 Implementation ====
+
===== HL7 2.5.1 Implementation =====
  
HL7 2.5.1, Chapter 13, specifies the EAR^U08 Message for equipment commands.  Its usage in LSH.3 is shown below.
+
HL7 2.5.1, Chapter 13, specifies the EAR^U08 Message for equipment commands.  Its usage in LAB-43 is shown below.
 
<br />
 
<br />
  
===== EAR^U08 Message =====
+
====== EAR^U08 Message ======
  
 
<div style="margin-left: 20px">
 
<div style="margin-left: 20px">
Line 495: Line 504:
 
</table>
 
</table>
 
</div>
 
</div>
 +
<br />
  
===== ACK^U08 Message =====
+
====== ACK^U08 Message ======
  
 
<div style="margin-left: 20px">
 
<div style="margin-left: 20px">

Latest revision as of 07:35, 9 November 2018

Summary

Passing of specimens between Laboratory Automation Systems (LAS) and Specimen Processing Devices (SPD) is an integral part of clinical laboratory operation. But current LAS and SPD vendors have little guidance on how to implement specimen handoff. HL7 and CLSI AUTO3-A provide some direction, but do not provide specific guidance for individual handoff workflows.

In the absence of any industry guidance, specimen handoffs are defined on an ad hoc basis. This approach tends to ensure that each vendor will take a unique path, even though specimen handoff interfaces share a high degree of commonality among most vendors.

There clearly exists a need for fully specified interface protocols to reduce the time and costs associated with managing specimen handoff in clinical laboratories. The IHE-LAB Committee is the appropriate entity to create and promote such solutions. Prior work by the Committee on the LDA profile is evidence of that need.

The Laboratory Specimen Handoff (LSH) profile will provide standardized workflows for the most common laboratory specimen handoff use cases.

Benefits

The LSH Profile will advance the IVD industry by providing a common, fully specified framework for the most common specimen handoff use cases, based on the collective experience of active participants from across the IVD industry.

Promoting a consistent understanding of specimen handoff will have a number of benefits.

  1. Reduced design burden for Specimen Processing Devices
  2. Reduced design burden for the laboratory automation systems to which SPDs are attached
  3. Comprehends handoff pitfalls that may not be apparent to an individual development team
  4. Provide a generally accepted foundation upon which the industry can build

Details

The Laboratory Specimen Handoff (LSH) Integration Profile facilitates laboratory specimen passing by providing detailed message transactions used during specimen handoff.

The LSH Integration Profile will cover the two most common handoff use cases in the clinical laboratory. Implementation will occur in phases, in order of commonality.


Use Case 1 - Single-Specimen Point-in-Space Acquisition
The Specimen Transport Manager (STM) notifies SPD that a specimen container is en route to the SPD. The SPD prepares for specimen arrival, typically receiving work order steps (by some means other than LSH). Upon arrival, the STM presents the specimen for acquisition. Acquisition is typically aspiration. The SPD acquires the specimen from the container, without taking possession of the container. Automation removes the specimen from the aspiration position.
Use Case 2 - Single-Specimen Container Transfer
SPD takes posession of specimen container. Workflow TBD


Additional Use Cases
Additional phases may address other specimen handoff use cases. Likely additions are "Multi-Specimen Container Transfer" and "Assay Availability".


Systems Affected

Actors & Transactions

LSH Actors.png
Order Filler
Receives the laboratory work for each patient. Produces Work Orders.
Automation Manager
Container for all lab automation features, inclusive of Analyzer Manager, Process Manager and Specimen Transport Manager
The internals of this actor are intentionally vague, as they are out of scope for IHE-LAB activities.
Analzyer
Instrument that automates IVD testing.
Pre/Post Processor
Device that automates specimen preparation.


Three actors will be affected by the LSH Integration Profile - Specimen Transport Managers (STM), Analyzers and Pre/Post Processors (PPP). Examples of STM Actors are laboratory automation tracks and specimen transport robots. Analyzer Actors are typically in-vitro diagnostic devices. Examples of PPP Actors are centrifuges and aliquotters.


Standards and Systems

Profile Status: Preliminary content below (Pre-Supplement)

Documents: Underlying Standards:

Use Cases


Use Case 1 - Single-Specimen Point-in-Space Acquisition


SSPA Sequence.png

Steps

  1. Device status changes, and is available to process STM specimens
    1. Device available for STM specimens is a prerequisite for use case

  2. STM optionally sends "Status Request" to Device
    1. LAB-41 transaction
    2. STM may send a "Status Request" message unsolicited at any time, to trigger a "Status Update" message

  3. Device sends Status Update to STM
    1. LAB-42 transaction
    2. Trigger is either the Device status change or the receipt of a Status Request (LAB-41)

  4. Specimen arrives at STM
    1. The meaning of "arrives" is system-dependent
      1. May mean first awareness by STM system, physical arrival at an STM subsystem, or any other point during STM handling

  5. STM Creates a Specimen Transport Plan
    1. Determines that SPD is a destination in the plan

  6. STM sends "Prepare for Specimen Acquisition" to Device
    1. LAB-43/Command transaction
    2. Includes container identifier (SID)
    3. Optionally includes container information
    4. Should be sent as soon as practical to allow Device to have maximum preparation time. Actual requirement will vary by implementation
    5. Multiple "Prepare for Specimen Acquisition" messages may be received before a specimen container arrives
    6. Extensions -
      1. Message malformed at application level
        1. Send "Prepare Complete" message rejecting specimen due to malformed message
        2. STM does not present specimen
        3. Use case ends
      2. Device not in a state to receive specimens from automation
        1. Send "Prepare Complete" message rejecting specimen due to invalid Device state
        2. STM does not present specimen
        3. Use case ends

  7. Device prepares to receive the specimen
    1. Preparation behavior is out of scope for this use case. Typically, Device queries for, and receives, Work Order Steps and schedules the specimen per the internal scheduling algorithm
    2. Extensions -
      1. No WOS for specimen
        1. Send "Prepare Complete" message rejecting specimen due to unknown specimen (no WOS)
        2. STM does not present specimen
        3. Use case ends
      2. At least one WOS can be performed, but not all WOS
        1. (analyze this further. not strictly necessary, but may have value when, say, reagent for one assay is depleted)
        2. Send "Prepare Complete" message accepting specimen, but indicating only partial capability
        3. Continue with use case
      3. "Prepare Complete" is not received
        1. (Consider options - Specimen is in an unknown state)

  8. Device sends "Prepare Complete" to STM
    1. LAB-43/Response transaction
    2. Extensions -
      1. Message malformed at application level
        1. Send "Prepare Complete" message rejecting specimen due to malformed message
        2. STM does not present specimen
        3. Use case ends
      2. Device not in a state to receive specimens from automation
        1. Send "Prepare Complete" message rejecting specimen due to invalid Device state
        2. STM does not present specimen
        3. Use case ends

  9. STM positions specimen for acquisition by Device
    1. Extensions-
      1. Error prevents specimen from being positioned (e.g. mechanical error)
        1. Use case continues at Step 9, with STM sending "Start Specimen Acquisition" with "Cancel"
          1. Clears specimen from LD
          2. LD also (still) sends "Specimen Acquisition Complete" message when specimen is cleared
        2. STM does not present specimen
      2. "Start Specimen Acquisition" is not received by Device
        1. Device will no longer consider specimen valid, and will reject specimen if it arrives
        2. Use case ends

  10. STM sends "Start Specimen Acquisition" to Device
    1. LAB-43/Command transaction
    2. STM may not move container between sending this message and receiving the "Specimen Acquisition Complete" message (Step 10)
    3. Includes container identifier (SID)
    4. STM starts an Acquisition timeout timer
    5. Extensions-
      1. Message malformed at application level
        1. Send "Specimen Acquisition Complete" message rejecting specimen due to malformed message
        2. Use case ends
      2. Device not in a state to receive specimens from automation
        1. Send "Specimen Acquisition Complete" message rejecting specimen due to invalid Device state
        2. Use case ends
      3. Device is not aware of the specimen
        1. No "Prepare for Specimen Acquisition" was received, or "Prepare for Specimen Acquisition" was received but "Start Specimen Acquisition" did not arrive within time constraint
        2. Send "Specimen Acquisition Complete" message rejecting specimen due to unknown specimen
        3. Use case ends
      4. Missed scheduling window
        1. Specimen presented too late for aspiration
        2. Optional, Device implementation may or may not have an arrival time dependency
        3. Send "Specimen Acquisition Complete" message rejecting specimen due to missed scheduling window
        4. Use case ends

  11. Device acquires specimen
    1. Device only manipulates specimen
    2. Container is not moved
    3. Extensions-
      1. Device detects a non-recoverable error that potentially obstructs specimen movement
        1. Device stops acquiring specimen
        2. Device stops movement within the mechanical envelope of the container
        3. Device sends "Specimen Acquisition Complete" message indicating an obstruction error
        4. STM initiates no movement within the mechanical envelope of the container
        5. Use case ends
          1. User intervention is required to resolve the issue
          2. STM may not move container
      2. Device detects a specimen error
        1. Does not include obstructions
          1. Device mechanics can still move safely
        2. Device stops acquiring specimen
        3. Device sends "Specimen Acquisition Complete" message indicating a specimen error
          1. Includes error type, if known
            1. Insufficient Specimen
            2. Bubble in Specimen
            3. Clotted Specimen
            4. Other
          2. Use case ends
            1. STM may remove specimen
      3. "Specimen Acquisition Complete" is not received by STM
        1. (Consider options - Specimen is in an unknown state - Power could have been removed with pipettor in the specimen)

  12. Device sends "Specimen Acquisition Complete" to STM
    1. LAB-43/Response transaction
    2. STM may assume that all Device apparatus is removed from the container envelope, and will remain removed until the next "Start Specimen Acquisition" message
      1. Only exception is an "Obstruction Error"
    3. Extensions-
      1. Message malformed at application level
        1. (Consider options - Specimen is in an unknown state - Power could have been removed with pipettor in the specimen)

  13. STM continues with specimen transport plan
    1. Container is now under the control of the STM


Use Case 2 - Single-Specimen Container Transfer


This workflow is TBD.

Transactions


LAB-41 Status Request

The Status Request transaction defines the message used by the Specimen Transport Handler (STH) to request Device status with respect to specimens arriving on the track interface.

Interaction Diagram


LSH1 Interaction Diagram.png


Interaction Model

Trigger Specimen Transport Handler (STH) has a need to obtain the Device status with respect to track specimens

Direction STH > Device

Roles STH Keep track of Device's status to know when it can process specimens from the track
Device   Provides status for track interface

Responsibility   STH Provide request for status
Device Acknowledge request, and initiate a Status Update transaction (LAB-42)


HL7 2.5.1 Implementation

HL7 2.5.1, Chapter 13, specifies the ESR^U02 Message for status requests. Its usage in LAB-41 is shown below.

ESR^U02 Message
Segment ID Meaning Usage Cardinality
MSH Message Header M [1..1]
EQU Equipment Detail M [1..1]
ACK^U02 Message
Segment ID Meaning Usage Cardinality
MSH Message Header M [1..1]
MSA Message Acknowledge M [1..1]
[{ERR}] Error C(M/X) [0..*]



LAB-42 Status Update

The Status Update transaction defines the message used to report Device status to the Specimen Transport Handler (STH), with respect to specimens arriving on the track interface.

Interaction Diagram


LSH.2 Interaction Diagram.png


Interaction Model

Trigger Device status changes, or the Device receives a Status Request (LAB-41).

Direction Device > STH

Roles Device   Keep the STH updated with current status
STH Keep track of Device's status to know when it can process specimens from the track

Responsibility   Device Provide Device LAS status
STH Acknowledge message, and update STH behavior based on Device status


HL7 2.5.1 Implementation

HL7 2.5.1, Chapter 13, specifies the ESU^U01 Message for status updates. Its usage in LAB-42 is shown below.


ESU^U01 Message
Segment ID Meaning Usage Cardinality
MSH Message Header M [1..1]
EQU Equipment Detail M [1..1]


ACK^U01 Message
Segment ID Meaning Usage Cardinality
MSH Message Header M [1..1]
MSA Message Acknowledge M [1..1]
[{ERR}] Error C(M/X) [0..*]




LAB-43 Command/Response

LAB-43 Command

The Command transaction defines the Specimen Transport Handler (STH) message used to command the Device to prepare for specimen processing.

Interaction Diagram


LSH.3 Command Interaction Diagram.png


Interaction Model
Trigger STH needs to command the Device to perform an LAS operation

Direction STH > Device

Roles STH Initiate device commands
Device   Respond to STH commands

Responsibility   STH Provide Device command
Device Acknowledge message, and provide an LAB-43 Response when command is complete


HL7 2.5.1 Implementation

HL7 2.5.1, Chapter 13, specifies the EAC^U07 Message for equipment commands. Its usage in LAB-43 is shown below.

EAC^U07 Message
Segment ID Meaning Usage Cardinality
MSH Message Header M [1..1]
EQU Equipment Detail M [1..1]
{ -- COMMAND Begin M [1..1]
  ECD Equipment Command Detail M [1..1]
  SAC Specimen Container Detail RE [0..1]
} -- COMMAND End M [1..1]


  1. SAC
    1. Required if STM knows SID. Otherwise, optional.
    2. Include container dimensions, if known
  2. EQU.3 (Equipment State)
    1. Review codes provided in table. Determine of we need to augment with new codes.
      1. Coordinate with Dmytro on this. He has experience in this area.
  3. ECD.2 (Remote Control Command)
    1. PS - Prepare for Specimen
    2. SA - Start Specimen Acquisition
    3. Allow command option to only send ACK^U07 on error
    4. Enhanced acknowledge mode

ACK^U07 Message
Segment ID Meaning Usage Cardinality
MSH Message Header M [1..1]
MSA Message Acknowledge M [1..1]
[{ERR}] Error C(M/X) [0..*]



LAB-43 Response

The Command transaction defines the Analyzer response used to communicate the outcome of a command from the Specimen Transport Handler (STH).

Interaction Diagram


LSH.3 Response Interaction Diagram.png


Interaction Model
Trigger Device needs to communicate the outcome of a command.

Direction Device > STH

Roles Device   Provide a response to STH commands when commands are complete
STH Confirm the device response

Responsibility   Device Provide command response
STH Acknowledge message, and update STH behavior based on Device response


HL7 2.5.1 Implementation

HL7 2.5.1, Chapter 13, specifies the EAR^U08 Message for equipment commands. Its usage in LAB-43 is shown below.

EAR^U08 Message
Segment ID Meaning Usage Cardinality
MSH Message Header M [1..1]
EQU Equipment Detail M [1..1]
{ -- COMMAND Begin M [1..1]
  ECD Equipment Command Detail M [1..1]
  SAC Specimen Container Detail M [1..1]
  ECR Equipment Command Response M [1..1]
} -- COMMAND End M [1..1]


ACK^U08 Message
Segment ID Meaning Usage Cardinality
MSH Message Header M [1..1]
MSA Message Acknowledge M [1..1]
[{ERR}] Error C(M/X) [0..*]