OO Incubator Implementation Guide
0.1.0 - ci-build International flag

OO Incubator Implementation Guide, published by HL7 International / Orders and Observations. This guide is not an authorized publication; it is the continuous build for version 0.1.0 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/HL7/oo-incubator/ and changes regularly. See the Directory of published versions

Resource: Transport

Official URL: http://hl7.org/fhir/StructureDefinition/Transport Version: 0.1.0
Standards status: Trial-use Draft as of 2021-01-02 Maturity Level: 1 Computable Name: Transport
Other Identifiers: OID:2.16.840.1.113883.4.642.5.1071

Record of transport.

Scope and Usage

​This resource is an event resource from a FHIR workflow perspective - see Workflow. It is the intent of the Orders and Observation Workgroup to align this resource with the workflow pattern for event resources.

The Transport resource captures the requested movement and movement history of persons and items in the healthcare spectrum. The Transport resource documents the movement of a person or item. Since it follows the event pattern, it can be used in the request of a transport event, but it can be used in conjunction with the Task resource to operationalize a movement event in a workflow. While the current use cases are focused on the lab and the movement of patients, this resource will be easily extensible to handle the movement of anything in healthcare. Sample use cases for the laboratory are as follows:

  • Movement of a specimen between distinct healthcare locations (clinic to lab, lab to lab, lab to biorepository) without the use of a third-party transport system (e.g. a courier)
  • Movement of a specimen between distinct healthcare locations (clinic to lab, lab to lab, lab to biorepository) with the use of a third-party transport system (e.g. a courier)
  • Accessing the current location (tracking) and the complete location history (audit) for a given specimen.
Sample use cases involving patients include
  • Movement of a patient within a healthcare setting (changing floors of the hospital)
  • Movement of a patient between healthcare settings (moving a patient from one hospital to another)

Background and Context

With the emergence of IHE profiles on the movement of laboratory specimens (SET) and the growing needs around the movement of patients (documentation, scheduling, real-time updates), there is a need to capture the data around the movement of a patient or item in the healthcare setting. While the Task resource captures some of the data generated around an event, the Transport resource is built to capture the documentation along with the request/fulfillment of a transport event.

​

Boundaries and Relationships

The Transport resource can be requested by a ServiceRequest or by a Task, as shown in the diagram below. Also, this resource is only for the documentation of the physical movement of material items (people, animals, things). To operationalize the movement of people and things, Task should be used. Provenance can be used to document the steps but that is for the resource aspect, not the actual movement history of the item. During the movement of a patient, the business status (change in the level of care/patient class) might change. To allow for the capture of the current business status of the patient, the reason element should be used.

Diagram showing Transport resource event flow

Usages:

You can also check for usages in the FHIR IG Statistics

Formal Views of Resource Content

Description Differentials, Snapshots, and other representations.

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Transport 0..* DomainResource Delivery of item

Elements defined in Ancestors:id, meta, implicitRules, language, text, contained, extension, modifierExtension
... identifier 0..* Identifier External identifier
... instantiates Σ 0..1 canonical(ActivityDefinition) Formal definition of transport
... basedOn Σ 0..* Reference(Task | ServiceRequest | DeviceRequest | MedicationRequest | RequestOrchestration | SupplyRequest | VisionPrescription) Request fulfilled by this transport
... status ?!Σ 0..1 code preparation | in-progress | not-done | suspended | stopped | on-hold | completed | entered-in-error | unknown
Binding: TransportStatus (required): Status of the transport.
... statusReason Σ 0..1 CodeableConcept Reason for current status
Binding: TransportStatusReason (example): Codes to identify the reason for current status. These will typically be specific to a particular workflow.
... code Σ 0..1 CodeableConcept Transport Type
Binding: TransportVS (example): Codes to identify what the transport involves. These will typically be specific to a particular workflow.
... description Σ 0..1 markdown Human-readable explanation of transport
... focus Σ 0..1 Reference(Resource) What transport is acting on, when it is not the subject of record
... subject Σ 0..1 Reference(Resource) Beneficiary of the Transport (such as patient or subject)
... encounter Σ 0..1 Reference(Encounter) Healthcare event during which this transport originated
... period Σ 0..1 Period When transport is occurring/occurred
... authoredOn 0..1 dateTime Transport Creation Date
... lastModified Σ 0..1 dateTime Transport Last Modified Date
... performer Σ 0..* Reference(Practitioner | PractitionerRole | Organization | CareTeam | HealthcareService | Patient | Device | RelatedPerson) Who or what performs the transport
... location Σ 0..1 Reference(Location) Where transport occurs
... insurance 0..* Reference(Coverage | ClaimResponse) Associated insurance coverage
... note 0..* Annotation Comments made about the transport
... relevantHistory 0..* Reference(Provenance) Key events in history of the Transport
... to Σ 1..1 Reference(Location) Destination location
... from Σ 1..1 Reference(Location) Originating location
... reason 0..1 CodeableReference(Resource) Why transport is needed
Binding: TransportReason (example): Indicates why the transport is needed. E.g. Suspended because patient admitted to hospital.
... priorTransport 0..1 Reference(Transport) The most recent transport

doco Documentation for this format

Terminology Bindings (Differential)

Path Status Usage ValueSet Version Source
Transport.status Base required Transport Status 📦6.0.0-ballot3 FHIR Std.
Transport.statusReason Base example Transport Status Reason 📦6.0.0-ballot3 FHIR Std.
Transport.code Base example Transport Value Set 📦0.1.0 This IG
Transport.reason Base example Transport Reason Codes 📦0.1.0 This IG 
<Transport xmlns="http://hl7.org/fhir"> ​​doco
 ​<id value="[id]"/><!-- 0..1 ​* ​Logical id of this artifact  -->
 ​<meta><!-- ​I 0..1 ​* ​Metadata about the resource  --></meta>
 ​<implicitRules value="[uri]"/><!-- ​I 0..1 ​* ​A set of rules under which this content was created  -->
 ​<language value="[code]"/><!-- ​I 0..1 ​* Language of the resource content  -->
 ​<text><!-- ​I 0..1 ​* ​Text summary of the resource, for human interpretation  --></text>
 ​<contained><!-- 0..* ​* ​Contained, inline Resources  --></contained>
 ​<extension><!-- See Extensions  ​Additional content defined by implementations  --></extension>
 ​<modifierExtension><!-- ​I 0..* ​* ​Extensions that cannot be ignored  --></modifierExtension>
 <identifier><!-- 0..* ​* ​External identifier  --></identifier>
 <instantiates value="[canonical]"/><!-- 0..1 ​* ​Formal definition of transport  -->
 <basedOn><!-- 0..* ​* ​Request fulfilled by this transport  --></basedOn>
 <partOf><!-- 0..* ​* ​Part of referenced event  --></partOf>
 <status value="[code]"/><!-- 0..1 ​* preparation | in-progress | not-done | suspended | stopped | on-hold | completed | entered-in-error | unknown  -->
 <statusReason><!-- 0..1 ​* Reason for current status  --></statusReason>
 <code><!-- 0..1 ​* Transport Type  --></code>
 <description value="[markdown]"/><!-- 0..1 ​* ​Human-readable explanation of transport  -->
 <focus><!-- 0..1 ​* ​What transport is acting on, when it is not the subject of record  --></focus>
 <subject><!-- 0..1 ​* ​Beneficiary of the Transport (such as patient or subject)  --></subject>
 <encounter><!-- 0..1 ​* ​Healthcare event during which this transport originated  --></encounter>
 <period><!-- 0..1 ​* ​When transport is occurring/occurred  --></period>
 <authoredOn value="[dateTime]"/><!-- 0..1 ​* ​Transport Creation Date  -->
 <lastModified value="[dateTime]"/><!-- 0..1 ​* ​Transport Last Modified Date  -->
 <performer><!-- 0..* ​* ​Who or what performs the transport  --></performer>
 <location><!-- 0..1 ​* ​Where transport occurs  --></location>
 <insurance><!-- 0..* ​* ​Associated insurance coverage  --></insurance>
 <note><!-- 0..* ​* ​Comments made about the transport  --></note>
 <relevantHistory><!-- 0..* ​* ​Key events in history of the Transport  --></relevantHistory>
 <to><!-- 1..1 ​* ​Destination location  --></to>
 <from><!-- 1..1 ​* ​Originating location  --></from>
 <reason><!-- 0..1 ​* Why transport is needed  --></reason>
 <priorTransport><!-- 0..1 ​* ​The most recent transport  --></priorTransport>
</Transport>

​
{​​doco
  "resourceType" : "Transport",
  "id" : "<id>", // 0..1 ​Logical id of this artifact
  "meta" : { Meta }, // ​I 0..1 ​Metadata about the resource
  "implicitRules" : "<uri>", // ​I 0..1 ​A set of rules under which this content was created
  "language" : "<code>", // ​I 0..1 Language of the resource content
  "text" : { Narrative }, // ​I 0..1 ​Text summary of the resource, for human interpretation
  "contained" : [{ ​Resource }], // 0..* ​Contained, inline Resources
  (Extensions - see JSON page)
  (Modifier Extensions - see JSON page)
  "identifier" : [{ Identifier }], // 0..* ​External identifier
  "instantiates" : "<canonical(ActivityDefinition)>", // 0..1 ​Formal definition of transport
  "basedOn" : [{ Reference(DeviceRequest|MedicationRequest|
   RequestOrchestration|ServiceRequest|SupplyRequest|Task|VisionPrescription) }], // 0..* ​Request fulfilled by this transport
  "partOf" : [{ Reference(Transport) }], // 0..* ​Part of referenced event
  "status" : "<code>", // 0..1 preparation | in-progress | not-done | suspended | stopped | on-hold | completed | entered-in-error | unknown
  "statusReason" : { CodeableConcept }, // 0..1 Reason for current status
  "code" : { CodeableConcept }, // 0..1 Transport Type
  "description" : "<markdown>", // 0..1 ​Human-readable explanation of transport
  "focus" : { Reference(Resource) }, // 0..1 ​What transport is acting on, when it is not the subject of record
  "subject" : { Reference(Resource) }, // 0..1 ​Beneficiary of the Transport (such as patient or subject)
  "encounter" : { Reference(Encounter) }, // 0..1 ​Healthcare event during which this transport originated
  "period" : { Period }, // 0..1 ​When transport is occurring/occurred
  "authoredOn" : "<dateTime>", // 0..1 ​Transport Creation Date
  "lastModified" : "<dateTime>", // 0..1 ​Transport Last Modified Date
  "performer" : [{ Reference(CareTeam|Device|HealthcareService|Organization|
   Patient|Practitioner|PractitionerRole|RelatedPerson) }], // 0..* ​Who or what performs the transport
  "location" : { Reference(Location) }, // 0..1 ​Where transport occurs
  "insurance" : [{ Reference(ClaimResponse|Coverage) }], // 0..* ​Associated insurance coverage
  "note" : [{ Annotation }], // 0..* ​Comments made about the transport
  "relevantHistory" : [{ Reference(Provenance) }], // 0..* ​Key events in history of the Transport
  "to" : { Reference(Location) }, // 1..1 ​Destination location
  "from" : { Reference(Location) }, // 1..1 ​Originating location
  "reason" : { CodeableReference(Resource) }, // 0..1 Why transport is needed
  "priorTransport" : { Reference(Transport) } // 0..1 ​The most recent transport
}

​
@prefix fhir: <http://hl7.org/fhir/> .doco


[ a fhir:Transport;
  fhir:nodeRole fhir:treeRoot; # if this is the parser root

  fhir:id [ id ] ; # 0..1 Logical id of this artifact
  fhir:meta [ Meta ] ; # 0..1 ​I Metadata about the resource
  fhir:implicitRules [ uri ] ; # 0..1 ​I A set of rules under which this content was created
  fhir:language [ code ] ; # 0..1 ​I Language of the resource content
  fhir:text [ Narrative ] ; # 0..1 ​I Text summary of the resource, for human interpretation
  fhir:contained  ( [ Resource ] ... ) ; # 0..* Contained, inline Resources
  fhir:extension  ( [ Extension ] ... ) ; # 0..* ​I Additional content defined by implementations
  fhir:modifierExtension  ( [ Extension ] ... ) ; # 0..* ​I Extensions that cannot be ignored
  fhir:identifier  ( [ Identifier ] ... ) ; # 0..* External identifier
  fhir:instantiates [ canonical(ActivityDefinition) ] ; # 0..1 Formal definition of transport
  fhir:basedOn  ( [ Reference(DeviceRequest|MedicationRequest|RequestOrchestration|ServiceRequest|
  SupplyRequest|Task|VisionPrescription) ] ... ) ; # 0..* Request fulfilled by this transport
  fhir:partOf  ( [ Reference(Transport) ] ... ) ; # 0..* Part of referenced event
  fhir:status [ code ] ; # 0..1 preparation | in-progress | not-done | suspended | stopped | on-hold | completed | entered-in-error | unknown
  fhir:statusReason [ CodeableConcept ] ; # 0..1 Reason for current status
  fhir:code [ CodeableConcept ] ; # 0..1 Transport Type
  fhir:description [ markdown ] ; # 0..1 Human-readable explanation of transport
  fhir:focus [ Reference(Resource) ] ; # 0..1 What transport is acting on, when it is not the subject of record
  fhir:subject [ Reference(Resource) ] ; # 0..1 Beneficiary of the Transport (such as patient or subject)
  fhir:encounter [ Reference(Encounter) ] ; # 0..1 Healthcare event during which this transport originated
  fhir:period [ Period ] ; # 0..1 When transport is occurring/occurred
  fhir:authoredOn [ dateTime ] ; # 0..1 Transport Creation Date
  fhir:lastModified [ dateTime ] ; # 0..1 Transport Last Modified Date
  fhir:performer  ( [ Reference(CareTeam|Device|HealthcareService|Organization|Patient|Practitioner|
  PractitionerRole|RelatedPerson) ] ... ) ; # 0..* Who or what performs the transport
  fhir:location [ Reference(Location) ] ; # 0..1 Where transport occurs
  fhir:insurance  ( [ Reference(ClaimResponse|Coverage) ] ... ) ; # 0..* Associated insurance coverage
  fhir:note  ( [ Annotation ] ... ) ; # 0..* Comments made about the transport
  fhir:relevantHistory  ( [ Reference(Provenance) ] ... ) ; # 0..* Key events in history of the Transport
  fhir:to [ Reference(Location) ] ; # 1..1 Destination location
  fhir:from [ Reference(Location) ] ; # 1..1 Originating location
  fhir:reason [ CodeableReference(Resource) ] ; # 0..1 Why transport is needed
  fhir:priorTransport [ Reference(Transport) ] ; # 0..1 The most recent transport
]

Differential View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Transport 0..* DomainResource Delivery of item

Elements defined in Ancestors:id, meta, implicitRules, language, text, contained, extension, modifierExtension
... identifier 0..* Identifier External identifier
... instantiates Σ 0..1 canonical(ActivityDefinition) Formal definition of transport
... basedOn Σ 0..* Reference(Task | ServiceRequest | DeviceRequest | MedicationRequest | RequestOrchestration | SupplyRequest | VisionPrescription) Request fulfilled by this transport
... status ?!Σ 0..1 code preparation | in-progress | not-done | suspended | stopped | on-hold | completed | entered-in-error | unknown
Binding: TransportStatus (required): Status of the transport.
... statusReason Σ 0..1 CodeableConcept Reason for current status
Binding: TransportStatusReason (example): Codes to identify the reason for current status. These will typically be specific to a particular workflow.
... code Σ 0..1 CodeableConcept Transport Type
Binding: TransportVS (example): Codes to identify what the transport involves. These will typically be specific to a particular workflow.
... description Σ 0..1 markdown Human-readable explanation of transport
... focus Σ 0..1 Reference(Resource) What transport is acting on, when it is not the subject of record
... subject Σ 0..1 Reference(Resource) Beneficiary of the Transport (such as patient or subject)
... encounter Σ 0..1 Reference(Encounter) Healthcare event during which this transport originated
... period Σ 0..1 Period When transport is occurring/occurred
... authoredOn 0..1 dateTime Transport Creation Date
... lastModified Σ 0..1 dateTime Transport Last Modified Date
... performer Σ 0..* Reference(Practitioner | PractitionerRole | Organization | CareTeam | HealthcareService | Patient | Device | RelatedPerson) Who or what performs the transport
... location Σ 0..1 Reference(Location) Where transport occurs
... insurance 0..* Reference(Coverage | ClaimResponse) Associated insurance coverage
... note 0..* Annotation Comments made about the transport
... relevantHistory 0..* Reference(Provenance) Key events in history of the Transport
... to Σ 1..1 Reference(Location) Destination location
... from Σ 1..1 Reference(Location) Originating location
... reason 0..1 CodeableReference(Resource) Why transport is needed
Binding: TransportReason (example): Indicates why the transport is needed. E.g. Suspended because patient admitted to hospital.
... priorTransport 0..1 Reference(Transport) The most recent transport

doco Documentation for this format

Terminology Bindings (Differential)

Path Status Usage ValueSet Version Source
Transport.status Base required Transport Status 📦6.0.0-ballot3 FHIR Std.
Transport.statusReason Base example Transport Status Reason 📦6.0.0-ballot3 FHIR Std.
Transport.code Base example Transport Value Set 📦0.1.0 This IG
Transport.reason Base example Transport Reason Codes 📦0.1.0 This IG

 

Other representations of resource: CSV, Excel

Notes:

Name Type Description Expression
identifier token

External identifier

 Transport.identifier
patient reference

Search by subject - a patient

 Transport.subject.where(resolve() is Patient)
status token

in-progress | completed | entered-in-error

 Transport.status
subject reference

Search for subject

 Transport.subject