Release 5

This page is part of the FHIR Specification (v5.0.0: R5 - STU). This is the current published version. For a full list of available versions, see the Directory of published versions

Orders and Observations icon Work GroupMaturity Level: 1 Trial UseSecurity Category: Patient Compartments: No defined compartments

Detailed Descriptions for the elements in the Transport resource.

Transport
Element IdTransport
Definition

Record of transport of item.

Short DisplayDelivery of item
Cardinality0..*
TypeDomainResource
Summaryfalse
Transport.identifier
Element IdTransport.identifier
Definition

Identifier for the transport event that is used to identify it across multiple disparate systems.

Short DisplayExternal identifier
NoteThis is a business identifier, not a resource identifier (see discussion)
Cardinality0..*
TypeIdentifier
Summaryfalse
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 IdTransport.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 DisplayFormal definition of transport
Cardinality0..1
Typecanonical(ActivityDefinition)
Requirements

Enables a formal definition of how the transport is to be performed, enabling automation.

Summarytrue
Transport.instantiatesUri
Element IdTransport.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 DisplayFormal definition of transport
Cardinality0..1
Typeuri
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.

Summarytrue
Transport.basedOn
Element IdTransport.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 DisplayRequest fulfilled by this transport
Cardinality0..*
TypeReference(Any)
Summarytrue
Transport.groupIdentifier
Element IdTransport.groupIdentifier
Definition

A shared identifier common to multiple independent Request instances that were activated/authorized more or less simultaneously by a single author. The presence of the same identifier on each request ties those requests together and may have business ramifications in terms of reporting of results, billing, etc. E.g. a requisition number shared by a set of lab tests ordered together, or a prescription number shared by all meds ordered at one time.

Short DisplayRequisition or grouper id
Cardinality0..1
TypeIdentifier
Requirements

Billing and/or reporting can be linked to whether multiple requests were created as a single unit.

Summarytrue
Transport.partOf
Element IdTransport.partOf
Definition

A larger event of which this particular event is a component or step.

Short DisplayPart of referenced event
Cardinality0..*
TypeReference(Transport)
HierarchyThis reference is part of a strict Hierarchy
Requirements

E.g. Drug administration as part of a procedure, procedure as part of observation, etc.

Summarytrue
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 IdTransport.status
Definition

A code specifying the state of the transport event.

Short Displayin-progress | completed | abandoned | cancelled | planned | entered-in-error
Cardinality0..1
Terminology BindingTransport Status (Required)
Typecode
Is Modifiertrue (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)
Summarytrue
Transport.statusReason
Element IdTransport.statusReason
Definition

An explanation as to why this transport is held, failed, was refused, etc.

Short DisplayReason for current status
Cardinality0..1
Terminology BindingTransport Status Reason (Example)
TypeCodeableConcept
Summarytrue
Comments

This applies to the current status. Look at the history of the transport to see reasons for past statuses.

Transport.intent
Element IdTransport.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 Displayunknown | proposal | plan | order | original-order | reflex-order | filler-order | instance-order | option
Cardinality1..1
Terminology BindingTransport Intent (Required)
Typecode
Summarytrue
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 IdTransport.priority
Definition

Indicates how quickly the Transport should be addressed with respect to other requests.

Short Displayroutine | urgent | asap | stat
Cardinality0..1
Terminology BindingRequestPriority (Required)
Typecode
Meaning if MissingIf missing, this transport should be performed with normal priority
Requirements

Used to identify the service level expected while performing a transport.

Summaryfalse
Transport.code
Element IdTransport.code
Definition

A name or code (or both) briefly describing what the transport involves.

Short DisplayTransport Type
Cardinality0..1
Terminology BindingTransport Codes (Example)
TypeCodeableConcept
Summarytrue
Comments

The title (eg "My Transports", "Outstanding Transports for Patient X") should go into the code.

Transport.description
Element IdTransport.description
Definition

A free-text description of what is to be performed.

Short DisplayHuman-readable explanation of transport
Cardinality0..1
Typestring
Summarytrue
Transport.focus
Element IdTransport.focus
Definition

The request being actioned or the resource being manipulated by this transport.

Short DisplayWhat transport is acting on
Cardinality0..1
TypeReference(Any)
Requirements

Used to identify the thing to be done.

Summarytrue
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 IdTransport.for
Definition

The entity who benefits from the performance of the service specified in the transport (e.g., the patient).

Short DisplayBeneficiary of the Transport
Cardinality0..1
TypeReference(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 NamesPatient
Summarytrue
Transport.encounter
Element IdTransport.encounter
Definition

The healthcare event (e.g. a patient and healthcare provider interaction) during which this transport was created.

Short DisplayHealthcare event during which this transport originated
Cardinality0..1
TypeReference(Encounter)
Requirements

For some transports it may be important to know the link between the encounter the transport originated within.

Summarytrue
Transport.completionTime
Element IdTransport.completionTime
Definition

Identifies the completion time of the event (the occurrence).

Short DisplayCompletion time of the event (the occurrence)
Cardinality0..1
TypedateTime
Summarytrue
Transport.authoredOn
Element IdTransport.authoredOn
Definition

The date and time this transport was created.

Short DisplayTransport Creation Date
Cardinality0..1
TypedateTime
Requirements

Most often used along with lastUpdated to track duration of the transport to supporting monitoring and management.

Alternate NamesCreated Date
Summaryfalse
Transport.lastModified
Element IdTransport.lastModified
Definition

The date and time of last modification to this transport.

Short DisplayTransport Last Modified Date
Cardinality0..1
TypedateTime
Requirements

Used along with history to track transport activity and time in a particular transport state. This enables monitoring and management.

Alternate NamesUpdate Date
Summarytrue
Transport.requester
Element IdTransport.requester
Definition

The creator of the transport.

Short DisplayWho is asking for transport to be done
Cardinality0..1
TypeReference(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).

Summarytrue
Transport.performerType
Element IdTransport.performerType
Definition

The kind of participant that should perform the transport.

Short DisplayRequested performer
Cardinality0..*
Terminology BindingProcedure Performer Role Codes (Preferred)
TypeCodeableConcept
Requirements

Use to distinguish transports on different activity queues.

Summaryfalse
Transport.owner
Element IdTransport.owner
Definition

Individual organization or Device currently responsible for transport execution.

Short DisplayResponsible individual
Cardinality0..1
TypeReference(Practitioner | PractitionerRole | Organization | CareTeam | HealthcareService | Patient | Device | RelatedPerson)
Requirements

Identifies who is expected to perform this transport.

Alternate NamesPerformer; Executer
Summarytrue
Comments

Transports may be created with an owner not yet identified.

Transport.location
Element IdTransport.location
Definition

Principal physical location where this transport is performed.

Short DisplayWhere transport occurs
Cardinality0..1
TypeReference(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).

Summarytrue
Transport.insurance
Element IdTransport.insurance
Definition

Insurance plans, coverage extensions, pre-authorizations and/or pre-determinations that may be relevant to the Transport.

Short DisplayAssociated insurance coverage
Cardinality0..*
TypeReference(Coverage | ClaimResponse)
Summaryfalse
Transport.note
Element IdTransport.note
Definition

Free-text information captured about the transport as it progresses.

Short DisplayComments made about the transport
Cardinality0..*
TypeAnnotation
Summaryfalse
Transport.relevantHistory
Element IdTransport.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 DisplayKey events in history of the Transport
Cardinality0..*
TypeReference(Provenance)
Alternate NamesStatus History
Summaryfalse
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 IdTransport.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 DisplayConstraints on fulfillment transports
Cardinality0..1
Requirements

Sometimes when fulfillment is sought, you don't want full fulfillment.

Summaryfalse
Transport.restriction.repetitions
Element IdTransport.restriction.repetitions
Definition

Indicates the number of times the requested action should occur.

Short DisplayHow many times to repeat
Cardinality0..1
TypepositiveInt
Requirements

E.g. order that requests monthly lab tests, fulfillment is sought for 1.

Summaryfalse
Transport.restriction.period
Element IdTransport.restriction.period
Definition

Over what time-period is fulfillment sought.

Short DisplayWhen fulfillment sought
Cardinality0..1
TypePeriod
Requirements

E.g. order that authorizes 1 year's services. Fulfillment is sought for next 3 months.

Summaryfalse
Comments

Note that period.high is the due date representing the time by which the transport should be completed.

Transport.restriction.recipient
Element IdTransport.restriction.recipient
Definition

For requests that are targeted to more than one potential recipient/target, to identify who is fulfillment is sought for.

Short DisplayFor whom is fulfillment sought?
Cardinality0..*
TypeReference(Patient | Practitioner | PractitionerRole | RelatedPerson | Group | Organization)
Summaryfalse
Transport.input
Element IdTransport.input
Definition

Additional information that may be needed in the execution of the transport.

Short DisplayInformation used to perform transport
Cardinality0..*
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 NamesSupporting Information
Summaryfalse
Transport.input.type
Element IdTransport.input.type
Definition

A code or description indicating how the input is intended to be used as part of the transport execution.

Short DisplayLabel for the input
Cardinality1..1
Terminology BindingTransportInputParameterType:
TypeCodeableConcept
Requirements

Inputs are named to enable transport automation to bind data and pass it from one transport to the next.

Alternate NamesName
Summaryfalse
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 IdTransport.input.value[x]
Definition

The value of the input parameter as a basic type.

Short DisplayContent to use in performing the transport
Cardinality1..1
Type*
[x] NoteSee Choice of Datatypes for further information about how to use [x]
Summaryfalse
Transport.output
Element IdTransport.output
Definition

Outputs produced by the Transport.

Short DisplayInformation produced as part of transport
Cardinality0..*
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.

Summaryfalse
Transport.output.type
Element IdTransport.output.type
Definition

The name of the Output parameter.

Short DisplayLabel for output
Cardinality1..1
Terminology BindingTransportOutputParameterType:
TypeCodeableConcept
Requirements

Outputs are named to enable transport automation to bind data and pass it from one transport to the next.

Alternate NamesName
Summaryfalse
Transport.output.value[x]
Element IdTransport.output.value[x]
Definition

The value of the Output parameter as a basic type.

Short DisplayResult of output
Cardinality1..1
Type*
[x] NoteSee Choice of Datatypes for further information about how to use [x]
Requirements

Transport outputs can take any form.

Summaryfalse
Transport.requestedLocation
Element IdTransport.requestedLocation
Definition

The desired or final location for the transport.

Short DisplayThe desired location
Cardinality1..1
TypeReference(Location)
Summarytrue
Transport.currentLocation
Element IdTransport.currentLocation
Definition

The current location for the entity to be transported.

Short DisplayThe entity current location
Cardinality1..1
TypeReference(Location)
Summarytrue
Transport.reason
Element IdTransport.reason
Definition

A resource reference indicating why this transport needs to be performed.

Short DisplayWhy transport is needed
Cardinality0..1
Terminology BindingTransportReason:
TypeCodeableReference(Any)
Summaryfalse
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.reasonCode if the data is free (uncoded) text.

Transport.history
Element IdTransport.history
Definition

The transport event prior to this one.

Short DisplayParent (or preceding) transport
Cardinality0..1
TypeReference(Transport)
Summaryfalse