View raw Markdown
type: resource-definitionsresource: Transport

Transport Definitions

<a id="Transport"></a>

Transport

Delivery of item

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.

Cardinality: 0..*

Mappings: workflow=Event; rim=Supply[moodCode=RQO]; w5=workflow.order

<a id="Transport.identifier"></a>

Transport.identifier

External identifier

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

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.

Cardinality: 0..*

Type: Identifier

Mappings: workflow=Event.identifier; rim=.id

<a id="Transport.instantiates"></a>

Transport.instantiates

Formal definition of transport

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.

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

Cardinality: 0..1

Type: canonical

Summary: true

Mappings: workflow=Event.instantiatesCanonical; rim=.outboundRelationship[typeCode=DEFN].target

<a id="Transport.basedOn"></a>

Transport.basedOn

Request fulfilled by this transport

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.

Cardinality: 0..*

Type: Reference(Task, ServiceRequest, DeviceRequest, MedicationRequest, RequestOrchestration, SupplyRequest, VisionPrescription)

Summary: true

Mappings: workflow=Event.basedOn; rim=.outboundRelationship[typeCode=FLFS].target[moodCode=INT]

<a id="Transport.partOf"></a>

Transport.partOf

Part of referenced event

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

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

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

Cardinality: 0..*

Type: Reference(Transport)

Summary: true

Mappings: workflow=Event.partOf; v2=Varies by domain; rim=.inboundRelationship[typeCode=COMP].source[moodCode=EVN]

<a id="Transport.status"></a>

Transport.status

preparation | in-progress | not-done | suspended | stopped | on-hold | completed | entered-in-error | unknown

Definition: A code specifying the state of the transport event.

Cardinality: 0..1

Type: code

Binding: required:transport-status

Summary: true

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)

Mappings: workflow=Event.status; rim=.statusCode, also existence of fulfillment events

<a id="Transport.statusReason"></a>

Transport.statusReason

Reason for current status

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

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

Cardinality: 0..1

Type: CodeableConcept

Binding: example:transport-status-reason

Summary: true

Mappings: rim=.inboundRelationship[typeCode=SUBJ].source[classCode=CACT, moodCode=EVN, code="status change"].reasonCode

<a id="Transport.code"></a>

Transport.code

Transport Type

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

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

Cardinality: 0..1

Type: CodeableConcept

Binding: example:transport-code

Summary: true

Mappings: workflow=Event.code; w5=FiveWs.what[x]; rim=.code

<a id="Transport.description"></a>

Transport.description

Human-readable explanation of transport

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

Cardinality: 0..1

Type: markdown

Summary: true

Mappings: rim=.text

<a id="Transport.focus"></a>

Transport.focus

What transport is acting on, when it is not the subject of record

Definition: The resource representing the physical entity being transported.

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.

Requirements: Used to identify the thing to be done.

Cardinality: 0..1

Type: Reference(Resource)

Summary: true

Mappings: w5=FiveWs.what[x]; rim=.outboundRelationship[typeCode=SUBJ].target

<a id="Transport.subject"></a>

Transport.subject

Beneficiary of the Transport (such as patient or subject)

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

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

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.

Aliases: Patient

Cardinality: 0..1

Type: Reference(Resource)

Summary: true

Mappings: workflow=Event.subject; w5=FiveWs.subject; rim=.participation[typeCode=RCT].role

<a id="Transport.encounter"></a>

Transport.encounter

Healthcare event during which this transport originated

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

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

Cardinality: 0..1

Type: Reference(Encounter)

Summary: true

Mappings: workflow=Event.encounter; w5=FiveWs.context; rim=.inboundRelationship[typeCode=COMP].source[classCode=PCPR, moodCode=EVN]

<a id="Transport.period"></a>

Transport.period

When transport is occurring/occurred

Definition: The period when the transport event is occurring or did occur.

Comments: The status code allows differentiation of whether the timing reflects an ongoing event or historic one. Ongoing transports should not include an end in the Period.

Cardinality: 0..1

Type: Period

Summary: true

Mappings: workflow=Event.occurrence[x]; w5=FiveWs.done[x]; rim=.effectiveTime

<a id="Transport.authoredOn"></a>

Transport.authoredOn

Transport Creation Date

Definition: The date and time this transport was created.

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

Aliases: Created Date

Cardinality: 0..1

Type: dateTime

Mappings: w5=FiveWs.recorded; rim=.participation[typeCode=AUT].time

<a id="Transport.lastModified"></a>

Transport.lastModified

Transport Last Modified Date

Definition: The date and time of last modification to this transport.

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

Aliases: Update Date

Cardinality: 0..1

Type: dateTime

Summary: true

Mappings: rim=.inboundRelationship[typeCode=SUBJ, ].source[classCode=CACT, moodCode=EVN].effectiveTime

<a id="Transport.performer"></a>

Transport.performer

Who or what performs the transport

Definition: Identifies the entity expected to perform the transport.

Comments: Transports may be created with an owner not yet identified.

Requirements: Identifies who is expected to perform this transport.

Aliases: Performer, Executer

Cardinality: 0..*

Type: Reference(Practitioner, PractitionerRole, Organization, CareTeam, HealthcareService, Patient, Device, RelatedPerson)

Summary: true

Mappings: workflow=Event.performer.actor; w5=FiveWs.actor; rim=.participation[typeCode=PRF].role

<a id="Transport.location"></a>

Transport.location

Where transport occurs

Definition: Principal physical location where this transport is performed.

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

Cardinality: 0..1

Type: Reference(Location)

Summary: true

Mappings: w5=FiveWs.where[x]; rim=.participation[typeCode=LOC].role

<a id="Transport.insurance"></a>

Transport.insurance

Associated insurance coverage

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

Cardinality: 0..*

Type: Reference(Coverage, ClaimResponse)

Mappings: v2=IN1/IN2; rim=.outboundRelationship[typeCode=COVBY].target

<a id="Transport.note"></a>

Transport.note

Comments made about the transport

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

Cardinality: 0..*

Type: Annotation

Mappings: workflow=Event.note; rim=.inboundRelationship[typeCode=SUBJ, ].source[classCode=OBS, moodCode=EVN, code="annotation"].value(string)

<a id="Transport.relevantHistory"></a>

Transport.relevantHistory

Key events in history of the Transport

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.

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.

Aliases: Status History

Cardinality: 0..*

Type: Reference(Provenance)

Mappings: rim=.inboundRelationship(typeCode=SUBJ].source[classCode=CACT, moodCode=EVN]

<a id="Transport.to"></a>

Transport.to

Destination location

Definition: The target location for the transport event.

Cardinality: 1..1

Type: Reference(Location)

Summary: true

Mappings: w5=FiveWs.where[x]; rim=.participation[typeCode=LOC].role

<a id="Transport.from"></a>

Transport.from

Originating location

Definition: The starting location for the transport event.

Cardinality: 1..1

Type: Reference(Location)

Summary: true

Mappings: w5=FiveWs.where[x]; rim=.participation[typeCode=LOC].role

<a id="Transport.reason"></a>

Transport.reason

Why transport is needed

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

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.

Cardinality: 0..1

Type: CodeableReference

Binding: example:transport-reason

Mappings: workflow=Event.reason; w5=FiveWs.why[x]; rim=.outboundRelationship[typeCode=RSON].target

<a id="Transport.priorTransport"></a>

Transport.priorTransport

The most recent transport

Definition: The immediately preceding Transport event.

Cardinality: 0..1

Type: Reference(Transport)

Mappings: w5=FiveWs.why[x]; rim=.outboundRelationship[typeCode=RSON].target