This page is part of the FHIR Specification (v5.0.0-ballot: FHIR R5 Ballot Preview). The current version which supercedes this version is 5.0.0. For a full list of available versions, see the Directory of published versions
Orders and Observations Work Group | Maturity Level: 0 | Trial Use | Security Category: Patient | Compartments: Not linked to any defined compartments |
Detailed Descriptions for the elements in the Transport resource.
Transport | |
Element Id | Transport |
Definition | Record of transport of item. |
Short Display | Delivery of item |
Cardinality | 0..* |
Type | DomainResource |
Summary | false |
Transport.identifier | |
Element Id | Transport.identifier |
Definition | Identifier for the transport event that is used to identify it across multiple disparate systems. |
Short Display | External identifier |
Note | This is a business identifier, not a resource identifier (see discussion) |
Cardinality | 0..* |
Type | Identifier |
Summary | false |
Comments | This identifier is typically assigned by the dispenser, and may be used to reference the delivery when exchanging information about it with other systems. |
Transport.instantiatesCanonical | |
Element Id | Transport.instantiatesCanonical |
Definition | The URL pointing to a FHIR-defined protocol, guideline, orderset or other definition that is adhered to in whole or in part by this Transport. |
Short Display | Formal definition of transport |
Cardinality | 0..1 |
Type | canonical(ActivityDefinition) |
Requirements | Enables a formal definition of how the transport is to be performed, enabling automation. |
Summary | true |
Transport.instantiatesUri | |
Element Id | Transport.instantiatesUri |
Definition | The URL pointing to an externally maintained protocol, guideline, orderset or other definition that is adhered to in whole or in part by this Transport. |
Short Display | Formal definition of transport |
Cardinality | 0..1 |
Type | uri |
Requirements | Enables a formal definition of how the transport is to be performed (e.g. using BPMN, BPEL, XPDL or other formal notation to be associated with a transport), enabling automation. |
Summary | true |
Transport.basedOn | |
Element Id | Transport.basedOn |
Definition | BasedOn refers to a higher-level authorization that triggered the creation of the transport. It references a "request" resource such as a ServiceRequest or Transport, which is distinct from the "request" resource the Transport is seeking to fulfill. This latter resource is referenced by FocusOn. For example, based on a ServiceRequest (= BasedOn), a transport is created to fulfill a procedureRequest ( = FocusOn ) to transport a specimen to the lab. |
Short Display | Request fulfilled by this transport |
Cardinality | 0..* |
Type | Reference(Any) |
Summary | true |
Transport.groupIdentifier | |
Element Id | Transport.groupIdentifier |
Definition | An identifier that links together multiple transports and other requests that were created in the same context. |
Short Display | Requisition or grouper id |
Cardinality | 0..1 |
Type | Identifier |
Requirements | Billing and/or reporting can be linked to whether multiple requests were created as a single unit. |
Summary | true |
Transport.partOf | |
Element Id | Transport.partOf |
Definition | A larger event of which this particular event is a component or step. |
Short Display | Part of referenced event |
Cardinality | 0..* |
Type | Reference(Transport | Contract) |
Requirements | E.g. Drug administration as part of a procedure, procedure as part of observation, etc. |
Summary | true |
Comments | Not to be used to link an event to an Encounter - use Event.context for that. [The allowed reference resources may be adjusted as appropriate for the event resource]. |
Transport.status | |
Element Id | Transport.status |
Definition | A code specifying the state of the transport event. |
Short Display | in-progress | completed | abandoned | cancelled | planned | entered-in-error |
Cardinality | 0..1 |
Terminology Binding | TransportStatus (Required) |
Type | code |
Is Modifier | true (Reason: This element is labelled as a modifier because it is a status element that contains status entered-in-error which means that the resource should not be treated as valid) |
Summary | true |
Transport.statusReason | |
Element Id | Transport.statusReason |
Definition | An explanation as to why this transport is held, failed, was refused, etc. |
Short Display | Reason for current status |
Cardinality | 0..1 |
Terminology Binding | TransportStatusReason (Example) |
Type | CodeableConcept |
Summary | true |
Comments | This applies to the current status. Look at the history of the transport to see reasons for past statuses. |
Transport.intent | |
Element Id | Transport.intent |
Definition | Indicates the "level" of actionability associated with the Transport, i.e. i+R[9]Cs this a proposed transport, a planned transport, an actionable transport, etc. |
Short Display | unknown | proposal | plan | order | original-order | reflex-order | filler-order | instance-order | option |
Cardinality | 1..1 |
Terminology Binding | TransportIntent (Required) |
Type | code |
Summary | true |
Comments | This element is immutable. Proposed transports, planned transports, etc. must be distinct instances. In most cases, Transports will have an intent of "order". |
Transport.priority | |
Element Id | Transport.priority |
Definition | Indicates how quickly the Transport should be addressed with respect to other requests. |
Short Display | routine | urgent | asap | stat |
Cardinality | 0..1 |
Terminology Binding | RequestPriority (Required) |
Type | code |
Meaning if Missing | If missing, this transport should be performed with normal priority |
Requirements | Used to identify the service level expected while performing a transport. |
Summary | false |
Transport.code | |
Element Id | Transport.code |
Definition | A name or code (or both) briefly describing what the transport involves. |
Short Display | Transport Type |
Cardinality | 0..1 |
Terminology Binding | Transport Codes (Example) |
Type | CodeableConcept |
Summary | true |
Comments | The title (eg "My Transports", "Outstanding Transports for Patient X") should go into the code. |
Transport.description | |
Element Id | Transport.description |
Definition | A free-text description of what is to be performed. |
Short Display | Human-readable explanation of transport |
Cardinality | 0..1 |
Type | string |
Summary | true |
Transport.focus | |
Element Id | Transport.focus |
Definition | The request being actioned or the resource being manipulated by this transport. |
Short Display | What transport is acting on |
Cardinality | 0..1 |
Type | Reference(Any) |
Requirements | Used to identify the thing to be done. |
Summary | true |
Comments | If multiple resources need to be manipulated, use sub-transports. (This ensures that status can be tracked independently for each referenced resource.). |
Transport.for | |
Element Id | Transport.for |
Definition | The entity who benefits from the performance of the service specified in the transport (e.g., the patient). |
Short Display | Beneficiary of the Transport |
Cardinality | 0..1 |
Type | Reference(Any) |
Requirements | Used to track transports outstanding for a beneficiary. Do not use to track the transport owner or creator (see owner and creator respectively). This can also affect access control. |
Alternate Names | Patient |
Summary | true |
Transport.encounter | |
Element Id | Transport.encounter |
Definition | The healthcare event (e.g. a patient and healthcare provider interaction) during which this transport was created. |
Short Display | Healthcare event during which this transport originated |
Cardinality | 0..1 |
Type | Reference(Encounter) |
Requirements | For some transports it may be important to know the link between the encounter the transport originated within. |
Summary | true |
Transport.completionTime | |
Element Id | Transport.completionTime |
Definition | Identifies the completion time of the event (the occurrence). |
Short Display | Completion time of the event (the occurrence) |
Cardinality | 0..1 |
Type | dateTime |
Summary | true |
Transport.authoredOn | |
Element Id | Transport.authoredOn |
Definition | The date and time this transport was created. |
Short Display | Transport Creation Date |
Cardinality | 0..1 |
Type | dateTime |
Requirements | Most often used along with lastUpdated to track duration of the transport to supporting monitoring and management. |
Alternate Names | Created Date |
Summary | false |
Transport.lastModified | |
Element Id | Transport.lastModified |
Definition | The date and time of last modification to this transport. |
Short Display | Transport Last Modified Date |
Cardinality | 0..1 |
Type | dateTime |
Requirements | Used along with history to track transport activity and time in a particular transport state. This enables monitoring and management. |
Alternate Names | Update Date |
Summary | true |
Transport.requester | |
Element Id | Transport.requester |
Definition | The creator of the transport. |
Short Display | Who is asking for transport to be done |
Cardinality | 0..1 |
Type | Reference(Device | Organization | Patient | Practitioner | PractitionerRole | RelatedPerson) |
Requirements | Identifies who created this transport. May be used by access control mechanisms (e.g., to ensure that only the creator can cancel a transport). |
Summary | true |
Transport.performerType | |
Element Id | Transport.performerType |
Definition | The kind of participant that should perform the transport. |
Short Display | Requested performer |
Cardinality | 0..* |
Terminology Binding | Procedure Performer Role Codes (Preferred) |
Type | CodeableConcept |
Requirements | Use to distinguish transports on different activity queues. |
Summary | false |
Transport.owner | |
Element Id | Transport.owner |
Definition | Individual organization or Device currently responsible for transport execution. |
Short Display | Responsible individual |
Cardinality | 0..1 |
Type | Reference(Practitioner | PractitionerRole | Organization | CareTeam | HealthcareService | Patient | Device | RelatedPerson) |
Requirements | Identifies who is expected to perform this transport. |
Alternate Names | Performer; Executer |
Summary | true |
Comments | Transports may be created with an owner not yet identified. |
Transport.location | |
Element Id | Transport.location |
Definition | Principal physical location where this transport is performed. |
Short Display | Where transport occurs |
Cardinality | 0..1 |
Type | Reference(Location) |
Requirements | Ties the event to where the records are likely kept and provides context around the event occurrence (e.g. if it occurred inside or outside a dedicated healthcare setting). |
Summary | true |
Transport.reasonCode | |
Element Id | Transport.reasonCode |
Definition | A description or code indicating why this transport needs to be performed. |
Short Display | Why transport is needed |
Cardinality | 0..1 |
Terminology Binding | TransportReason: |
Type | CodeableConcept |
Summary | false |
Comments | This should only be included if there is no focus or if it differs from the reason indicated on the focus. |
Transport.reasonReference | |
Element Id | Transport.reasonReference |
Definition | A resource reference indicating why this transport needs to be performed. |
Short Display | Why transport is needed |
Cardinality | 0..1 |
Type | Reference(Any) |
Summary | false |
Comments | Transports might be justified based on an Observation, a Condition, a past or planned procedure, etc. This should only be included if there is no focus or if it differs from the reason indicated on the focus. Use the CodeableConcept text element in |
Transport.insurance | |
Element Id | Transport.insurance |
Definition | Insurance plans, coverage extensions, pre-authorizations and/or pre-determinations that may be relevant to the Transport. |
Short Display | Associated insurance coverage |
Cardinality | 0..* |
Type | Reference(Coverage | ClaimResponse) |
Summary | false |
Transport.note | |
Element Id | Transport.note |
Definition | Free-text information captured about the transport as it progresses. |
Short Display | Comments made about the transport |
Cardinality | 0..* |
Type | Annotation |
Summary | false |
Transport.relevantHistory | |
Element Id | Transport.relevantHistory |
Definition | Links to Provenance records for past versions of this Transport that identify key state transitions or updates that are likely to be relevant to a user looking at the current version of the transport. |
Short Display | Key events in history of the Transport |
Cardinality | 0..* |
Type | Reference(Provenance) |
Alternate Names | Status History |
Summary | false |
Comments | This element does not point to the Provenance associated with the current version of the resource - as it would be created after this version existed. The Provenance for the current version can be retrieved with a _revinclude. |
Transport.restriction | |
Element Id | Transport.restriction |
Definition | If the Transport.focus is a request resource and the transport is seeking fulfillment (i.e. is asking for the request to be actioned), this element identifies any limitations on what parts of the referenced request should be actioned. |
Short Display | Constraints on fulfillment transports |
Cardinality | 0..1 |
Requirements | Sometimes when fulfillment is sought, you don't want full fulfillment. |
Summary | false |
Transport.restriction.repetitions | |
Element Id | Transport.restriction.repetitions |
Definition | Indicates the number of times the requested action should occur. |
Short Display | How many times to repeat |
Cardinality | 0..1 |
Type | positiveInt |
Requirements | E.g. order that requests monthly lab tests, fulfillment is sought for 1. |
Summary | false |
Transport.restriction.period | |
Element Id | Transport.restriction.period |
Definition | Over what time-period is fulfillment sought. |
Short Display | When fulfillment sought |
Cardinality | 0..1 |
Type | Period |
Requirements | E.g. order that authorizes 1 year's services. Fulfillment is sought for next 3 months. |
Summary | false |
Comments | Note that period.high is the due date representing the time by which the transport should be completed. |
Transport.restriction.recipient | |
Element Id | Transport.restriction.recipient |
Definition | For requests that are targeted to more than one potential recipient/target, to identify who is fulfillment is sought for. |
Short Display | For whom is fulfillment sought? |
Cardinality | 0..* |
Type | Reference(Patient | Practitioner | PractitionerRole | RelatedPerson | Group | Organization) |
Summary | false |
Transport.input | |
Element Id | Transport.input |
Definition | Additional information that may be needed in the execution of the transport. |
Short Display | Information used to perform transport |
Cardinality | 0..* |
Requirements | Resources and data used to perform the transport. This data is used in the business logic of transport execution, and is stored separately because it varies between workflows. |
Alternate Names | Supporting Information |
Summary | false |
Transport.input.type | |
Element Id | Transport.input.type |
Definition | A code or description indicating how the input is intended to be used as part of the transport execution. |
Short Display | Label for the input |
Cardinality | 1..1 |
Terminology Binding | TransportInputParameterType: |
Type | CodeableConcept |
Requirements | Inputs are named to enable transport automation to bind data and pass it from one transport to the next. |
Alternate Names | Name |
Summary | false |
Comments | If referencing a BPMN workflow or Protocol, the "system" is the URL for the workflow definition and the code is the "name" of the required input. |
Transport.input.value[x] | |
Element Id | Transport.input.value[x] |
Definition | The value of the input parameter as a basic type. |
Short Display | Content to use in performing the transport |
Cardinality | 1..1 |
Type | * |
[x] Note | See Choice of Datatypes for further information about how to use [x] |
Summary | false |
Transport.output | |
Element Id | Transport.output |
Definition | Outputs produced by the Transport. |
Short Display | Information produced as part of transport |
Cardinality | 0..* |
Requirements | Resources and data produced during the execution the transport. This data is generated by the business logic of transport execution, and is stored separately because it varies between workflows. |
Summary | false |
Transport.output.type | |
Element Id | Transport.output.type |
Definition | The name of the Output parameter. |
Short Display | Label for output |
Cardinality | 1..1 |
Terminology Binding | TransportOutputParameterType: |
Type | CodeableConcept |
Requirements | Outputs are named to enable transport automation to bind data and pass it from one transport to the next. |
Alternate Names | Name |
Summary | false |
Transport.output.value[x] | |
Element Id | Transport.output.value[x] |
Definition | The value of the Output parameter as a basic type. |
Short Display | Result of output |
Cardinality | 1..1 |
Type | * |
[x] Note | See Choice of Datatypes for further information about how to use [x] |
Requirements | Transport outputs can take any form. |
Summary | false |
Transport.requestedLocation | |
Element Id | Transport.requestedLocation |
Definition | The desired or final location for the transport. |
Short Display | The desired location |
Cardinality | 1..1 |
Type | Reference(Location) |
Summary | true |
Transport.currentLocation | |
Element Id | Transport.currentLocation |
Definition | The current location for the entity to be transported. |
Short Display | The current location |
Cardinality | 1..1 |
Type | Reference(Location) |
Summary | true |
Transport.history | |
Element Id | Transport.history |
Definition | The transport event prior to this one. |
Short Display | Parent (or preceding) transport |
Cardinality | 0..1 |
Type | Reference(Transport) |
Summary | false |