FHIR CI-Build

This is the Continuous Integration Build of FHIR (will be incorrect/inconsistent at times).
See the Directory of published versions icon

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.

Element Id Transport
Definition

The Transport resource represents the movement or transportation of individuals and items (such materials and equipment) within a healthcare setting. It encompasses both planned and completed transport events.

Short Display Delivery of item
Cardinality 0..*
Type DomainResource
Summary false
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.

Element Id Transport.instantiates
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
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(Task | ServiceRequest | DeviceRequest | MedicationRequest | RequestOrchestration | SupplyRequest | VisionPrescription)
Summary true
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)
Hierarchy This reference is part of a strict Hierarchy
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].

Element Id Transport.status
Definition

A code specifying the state of the transport event.

Short Display preparation | in-progress | not-done | suspended | stopped | on-hold | completed | entered-in-error | unknown
Cardinality 0..1
Terminology Binding Transport Status (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
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 Transport Status Reason (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.

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.

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
Element Id Transport.focus
Definition

The resource representing the physical entity being transported.

Short Display What transport is acting on, when it is not the subject of record
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.). When the transport is a device for a patient this would be the device.

Element Id Transport.subject
Definition

The entity who benefits from the performance of the service specified in the transport (such as patient or subject).

Short Display Beneficiary of the Transport (such as patient or subject)
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
Comments

When the transport is a device for a patient this would be the Patient.

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
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
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
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
Element Id Transport.performer
Definition

Identifies the entity expected to perform the transport.

Short Display Who or what performs the transport
Cardinality 0..*
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.

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
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
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
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.

Element Id Transport.to
Definition

The target location for the transport event.

Short Display Destination location
Cardinality 1..1
Type Reference(Location)
Summary true
Element Id Transport.from
Definition

The starting location for the transport event.

Short Display Originating location
Cardinality 1..1
Type Reference(Location)
Summary true
Element Id Transport.reason
Definition

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

Short Display Why transport is needed
Cardinality 0..1
Terminology Binding TransportReason:
Type CodeableReference(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.reasonCode if the data is free (uncoded) text.

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