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
| Page standards status: Trial-use | Maturity Level: 1 |
Definitions for the Transport resource
Guidance on how to interpret the contents of this table can be foundhere
| 0. 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. A resource that includes narrative, extensions, and contained resources. |
| Short | Delivery of itemA resource with narrative, extensions, and contained resources |
| Control | 0..* |
| Is Modifier | false |
| Must Support | false |
| Summary | false |
| Invariants | dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources (contained.contained.empty()) dom-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource (contained.where((('#'+id.trace('id') in %resource.descendants().select(reference | as(uri))) or descendants().where(reference='#' | as(uri)='#').exists()).not()).trace('unmatched', id).empty()) dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated (contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()) dom-5: If a resource is contained in another resource, it SHALL NOT have a security label (contained.meta.security.empty()) dom-6: A resource should have narrative for robust management (text.`div`.exists()) |
| 2. Transport.id | |
| Definition | The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. |
| Short | Logical id of this artifact |
| Comments | Within the context of the FHIR RESTful interactions, the resource has an id except for cases like the create and conditional update. Otherwise, the use of the resouce id depends on the given use case. |
| Control | 0..1 |
| Type | id |
| Is Modifier | false |
| Must Support | false |
| Summary | true |
| 4. Transport.meta | |
| Definition | The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource. |
| Short | Metadata about the resource |
| Control | 0..1 |
| Type | Meta |
| Is Modifier | false |
| Must Support | false |
| Summary | true |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 6. Transport.implicitRules | |
| Definition | A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc. |
| Short | A set of rules under which this content was created |
| Comments | Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of its narrative along with other profiles, value sets, etc. |
| Control | 0..1 |
| Type | uri |
| Is Modifier | true because This element is labeled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies its meaning or interpretation |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Must Support | false |
| Summary | true |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 8. Transport.language | |
| Definition | The base language in which the resource is written. |
| Short | Language of the resource content |
| Comments | Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute). |
| Control | 0..1 |
| Binding | The codes SHALL be taken from AllLanguageshttp://hl7.org/fhir/ValueSet/all-languages|6.0.0-ballot3 (required to http://hl7.org/fhir/ValueSet/all-languages|6.0.0-ballot3)IETF language tag for a human language |
| Type | code |
| Is Modifier | false |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Must Support | false |
| Summary | false |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 10. Transport.text | |
| Definition | A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety. |
| Short | Text summary of the resource, for human interpretation |
| Comments | Contained resources do not have a narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a "text blob" or where text is additionally entered raw or narrated and encoded information is added later. |
| Control | 0..1 This element is affected by the following invariants: dom-6 |
| Type | Narrative |
| Is Modifier | false |
| Must Support | false |
| Summary | false |
| Alternate Names | narrative, html, xhtml, display |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 12. Transport.contained | |
| Definition | These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, nor can they have their own independent transaction scope. This is allowed to be a Parameters resource if and only if it is referenced by a resource that provides context/meaning. |
| Short | Contained, inline Resources |
| Comments | This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags in their meta elements, but SHALL NOT have security labels. Contained resources may be a resource type defined in the FHIR specification, or an additional resource. |
| Control | 0..* This element is affected by the following invariants: dom-2, dom-4, dom-3, dom-5 |
| Type | Resource |
| Is Modifier | false |
| Must Support | false |
| Summary | false |
| Alternate Names | inline resources, anonymous resources, contained resources |
| 14. Transport.extension | |
| Definition | May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
| Short | Additional content defined by implementations |
| Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
| Control | 0..* |
| Type | Extension |
| Is Modifier | false |
| Must Support | false |
| Summary | false |
| Alternate Names | extensions, user content |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| Slicing | This element introduces a set of slices on Transport.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators: |
| 16. Transport.modifierExtension | |
| Definition | May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). |
| Short | Extensions that cannot be ignored |
| Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
| Control | 0..* |
| Type | Extension |
| Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the resource that contains them |
| Must Support | false |
| Summary | true |
| Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. |
| Alternate Names | extensions, user content |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| Slicing | This element introduces a set of slices on Transport.modifierExtension. The slices areUnordered and Open, and can be differentiated using the following discriminators: |
| 18. Transport.identifier | |
| Definition | Identifier for the transport event that is used to identify it across multiple disparate systems. |
| Short | External identifier |
| 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. |
| Note | This is a business identifier, not a resource identifier (see discussion) |
| Control | 0..* |
| Type | Identifier |
| 20. 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 | Formal definition of transport |
| Control | 0..1 |
| Type | canonical(ActivityDefinition) |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Summary | true |
| Requirements | Enables a formal definition of how the transport is to be performed, enabling automation. |
| 22. 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 | Request fulfilled by this transport |
| Control | 0..* |
| Type | Reference(Task, ServiceRequest, DeviceRequest, MedicationRequest, RequestOrchestration, SupplyRequest, VisionPrescription) |
| Summary | true |
| 24. Transport.partOf | |
| Definition | A larger event of which this particular event is a component or step. |
| Short | Part of referenced event |
| 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]. |
| Control | 0..* |
| Type | Reference(Transport) |
| Summary | true |
| Requirements | E.g. Drug administration as part of a procedure, procedure as part of observation, etc. |
| 26. Transport.status | |
| Definition | A code specifying the state of the transport event. |
| Short | preparation | in-progress | not-done | suspended | stopped | on-hold | completed | entered-in-error | unknown |
| Control | 0..1 |
| Binding | The codes SHALL be taken from TransportStatushttp://hl7.org/fhir/ValueSet/transport-status (required to http://hl7.org/fhir/ValueSet/transport-status)Status of the transport. |
| Type | code |
| Is Modifier | true because 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 |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Summary | true |
| 28. Transport.statusReason | |
| Definition | An explanation as to why this transport is held, failed, was refused, etc. |
| Short | Reason for current status |
| Comments | This applies to the current status. Look at the history of the transport to see reasons for past statuses. |
| Control | 0..1 |
| Binding | For example codes, see TransportStatusReasonhttp://hl7.org/fhir/ValueSet/transport-status-reason (example to http://hl7.org/fhir/ValueSet/transport-status-reason)Codes to identify the reason for current status. These will typically be specific to a particular workflow. |
| Type | CodeableConcept |
| Summary | true |
| 30. Transport.code | |
| Definition | A name or code (or both) briefly describing what the transport involves. |
| Short | Transport Type |
| Comments | The title (eg "My Transports", "Outstanding Transports for Patient X") should go into the code. |
| Control | 0..1 |
| Binding | For example codes, see TransportVShttp://hl7.org/fhir/ValueSet/transport (example to http://hl7.org/fhir/ValueSet/transport)Codes to identify what the transport involves. These will typically be specific to a particular workflow. |
| Type | CodeableConcept |
| Summary | true |
| 32. Transport.description | |
| Definition | A free-text description of what is to be performed. |
| Short | Human-readable explanation of transport |
| Control | 0..1 |
| Type | markdown |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Summary | true |
| 34. Transport.focus | |
| Definition | The resource representing the physical entity being transported. |
| Short | What transport is acting on, when it is not the subject of record |
| 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. |
| Control | 0..1 |
| Type | Reference(Resource) |
| Summary | true |
| Requirements | Used to identify the thing to be done. |
| 36. Transport.subject | |
| Definition | The entity who benefits from the performance of the service specified in the transport (such as patient or subject). |
| Short | Beneficiary of the Transport (such as patient or subject) |
| Comments | When the transport is a device for a patient this would be the Patient. |
| Control | 0..1 |
| Type | Reference(Resource) |
| Summary | true |
| 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 |
| 38. Transport.encounter | |
| Definition | The healthcare event (e.g. a patient and healthcare provider interaction) during which this transport was created. |
| Short | Healthcare event during which this transport originated |
| Control | 0..1 |
| Type | Reference(Encounter) |
| Summary | true |
| Requirements | For some transports it may be important to know the link between the encounter the transport originated within. |
| 40. Transport.period | |
| Definition | The period when the transport event is occurring or did occur. |
| Short | When transport is occurring/occurred |
| 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. |
| Control | 0..1 |
| Type | Period |
| Summary | true |
| 42. Transport.authoredOn | |
| Definition | The date and time this transport was created. |
| Short | Transport Creation Date |
| Control | 0..1 |
| Type | dateTime |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Requirements | Most often used along with lastUpdated to track duration of the transport to supporting monitoring and management. |
| Alternate Names | Created Date |
| 44. Transport.lastModified | |
| Definition | The date and time of last modification to this transport. |
| Short | Transport Last Modified Date |
| Control | 0..1 |
| Type | dateTime |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Summary | true |
| 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 |
| 46. Transport.performer | |
| Definition | Identifies the entity expected to perform the transport. |
| Short | Who or what performs the transport |
| Comments | Transports may be created with an owner not yet identified. |
| Control | 0..* |
| Type | Reference(Practitioner, PractitionerRole, Organization, CareTeam, HealthcareService, Patient, Device, RelatedPerson) |
| Summary | true |
| Requirements | Identifies who is expected to perform this transport. |
| Alternate Names | Performer, Executer |
| 48. Transport.location | |
| Definition | Principal physical location where this transport is performed. |
| Short | Where transport occurs |
| Control | 0..1 |
| Type | Reference(Location) |
| Summary | true |
| 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). |
| 50. Transport.insurance | |
| Definition | Insurance plans, coverage extensions, pre-authorizations and/or pre-determinations that may be relevant to the Transport. |
| Short | Associated insurance coverage |
| Control | 0..* |
| Type | Reference(Coverage, ClaimResponse) |
| 52. Transport.note | |
| Definition | Free-text information captured about the transport as it progresses. |
| Short | Comments made about the transport |
| Control | 0..* |
| Type | Annotation |
| 54. 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 | Key events in history 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. |
| Control | 0..* |
| Type | Reference(Provenance) |
| Alternate Names | Status History |
| 56. Transport.to | |
| Definition | The target location for the transport event. |
| Short | Destination location |
| Control | 1..1 |
| Type | Reference(Location) |
| Summary | true |
| 58. Transport.from | |
| Definition | The starting location for the transport event. |
| Short | Originating location |
| Control | 1..1 |
| Type | Reference(Location) |
| Summary | true |
| 60. Transport.reason | |
| Definition | A resource reference indicating why this transport needs to be performed. |
| Short | Why transport is needed |
| 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 |
| Control | 0..1 |
| Binding | For example codes, see TransportReasonhttp://hl7.org/fhir/ValueSet/transport-reason (example to http://hl7.org/fhir/ValueSet/transport-reason)Indicates why the transport is needed. E.g. Suspended because patient admitted to hospital. |
| Type | CodeableReference(Resource) |
| 62. Transport.priorTransport | |
| Definition | The immediately preceding Transport event. |
| Short | The most recent transport |
| Control | 0..1 |
| Type | Reference(Transport) |
Guidance on how to interpret the contents of this table can be foundhere
| 0. 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 | Delivery of item |
| Control | 0..* |
| 2. Transport.identifier | |
| Definition | Identifier for the transport event that is used to identify it across multiple disparate systems. |
| Short | External identifier |
| 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. |
| Note | This is a business identifier, not a resource identifier (see discussion) |
| Control | 0..* |
| Type | Identifier |
| 4. 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 | Formal definition of transport |
| Control | 0..1 |
| Type | canonical(ActivityDefinition) |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Requirements | Enables a formal definition of how the transport is to be performed, enabling automation. |
| 6. 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 | Request fulfilled by this transport |
| Control | 0..* |
| Type | Reference(Task, ServiceRequest, DeviceRequest, MedicationRequest, RequestOrchestration, SupplyRequest, VisionPrescription) |
| 8. Transport.partOf | |
| Definition | A larger event of which this particular event is a component or step. |
| Short | Part of referenced event |
| 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]. |
| Control | 0..* |
| Type | Reference(Transport) |
| Requirements | E.g. Drug administration as part of a procedure, procedure as part of observation, etc. |
| 10. Transport.status | |
| Definition | A code specifying the state of the transport event. |
| Short | preparation | in-progress | not-done | suspended | stopped | on-hold | completed | entered-in-error | unknown |
| Control | 0..1 |
| Binding | The codes SHALL be taken from TransportStatus (required to http://hl7.org/fhir/ValueSet/transport-status)Status of the transport. |
| Type | code |
| Is Modifier | true because 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 |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 12. Transport.statusReason | |
| Definition | An explanation as to why this transport is held, failed, was refused, etc. |
| Short | Reason for current status |
| Comments | This applies to the current status. Look at the history of the transport to see reasons for past statuses. |
| Control | 0..1 |
| Binding | For example codes, see TransportStatusReason (example to http://hl7.org/fhir/ValueSet/transport-status-reason)Codes to identify the reason for current status. These will typically be specific to a particular workflow. |
| Type | CodeableConcept |
| 14. Transport.code | |
| Definition | A name or code (or both) briefly describing what the transport involves. |
| Short | Transport Type |
| Comments | The title (eg "My Transports", "Outstanding Transports for Patient X") should go into the code. |
| Control | 0..1 |
| Binding | For example codes, see TransportVS (example to http://hl7.org/fhir/ValueSet/transport)Codes to identify what the transport involves. These will typically be specific to a particular workflow. |
| Type | CodeableConcept |
| 16. Transport.description | |
| Definition | A free-text description of what is to be performed. |
| Short | Human-readable explanation of transport |
| Control | 0..1 |
| Type | markdown |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 18. Transport.focus | |
| Definition | The resource representing the physical entity being transported. |
| Short | What transport is acting on, when it is not the subject of record |
| 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. |
| Control | 0..1 |
| Type | Reference(Resource) |
| Requirements | Used to identify the thing to be done. |
| 20. Transport.subject | |
| Definition | The entity who benefits from the performance of the service specified in the transport (such as patient or subject). |
| Short | Beneficiary of the Transport (such as patient or subject) |
| Comments | When the transport is a device for a patient this would be the Patient. |
| Control | 0..1 |
| Type | Reference(Resource) |
| 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 |
| 22. Transport.encounter | |
| Definition | The healthcare event (e.g. a patient and healthcare provider interaction) during which this transport was created. |
| Short | Healthcare event during which this transport originated |
| Control | 0..1 |
| Type | Reference(Encounter) |
| Requirements | For some transports it may be important to know the link between the encounter the transport originated within. |
| 24. Transport.period | |
| Definition | The period when the transport event is occurring or did occur. |
| Short | When transport is occurring/occurred |
| 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. |
| Control | 0..1 |
| Type | Period |
| 26. Transport.authoredOn | |
| Definition | The date and time this transport was created. |
| Short | Transport Creation Date |
| Control | 0..1 |
| Type | dateTime |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Requirements | Most often used along with lastUpdated to track duration of the transport to supporting monitoring and management. |
| Alternate Names | Created Date |
| 28. Transport.lastModified | |
| Definition | The date and time of last modification to this transport. |
| Short | Transport Last Modified Date |
| Control | 0..1 |
| Type | dateTime |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 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 |
| 30. Transport.performer | |
| Definition | Identifies the entity expected to perform the transport. |
| Short | Who or what performs the transport |
| Comments | Transports may be created with an owner not yet identified. |
| Control | 0..* |
| Type | Reference(Practitioner, PractitionerRole, Organization, CareTeam, HealthcareService, Patient, Device, RelatedPerson) |
| Requirements | Identifies who is expected to perform this transport. |
| Alternate Names | Performer, Executer |
| 32. Transport.location | |
| Definition | Principal physical location where this transport is performed. |
| Short | Where transport occurs |
| Control | 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). |
| 34. Transport.insurance | |
| Definition | Insurance plans, coverage extensions, pre-authorizations and/or pre-determinations that may be relevant to the Transport. |
| Short | Associated insurance coverage |
| Control | 0..* |
| Type | Reference(Coverage, ClaimResponse) |
| 36. Transport.note | |
| Definition | Free-text information captured about the transport as it progresses. |
| Short | Comments made about the transport |
| Control | 0..* |
| Type | Annotation |
| 38. 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 | Key events in history 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. |
| Control | 0..* |
| Type | Reference(Provenance) |
| Alternate Names | Status History |
| 40. Transport.to | |
| Definition | The target location for the transport event. |
| Short | Destination location |
| Control | 1..1 |
| Type | Reference(Location) |
| 42. Transport.from | |
| Definition | The starting location for the transport event. |
| Short | Originating location |
| Control | 1..1 |
| Type | Reference(Location) |
| 44. Transport.reason | |
| Definition | A resource reference indicating why this transport needs to be performed. |
| Short | Why transport is needed |
| 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 |
| Control | 0..1 |
| Binding | For example codes, see TransportReason (example to http://hl7.org/fhir/ValueSet/transport-reason)Indicates why the transport is needed. E.g. Suspended because patient admitted to hospital. |
| Type | CodeableReference(Resource) |
| 46. Transport.priorTransport | |
| Definition | The immediately preceding Transport event. |
| Short | The most recent transport |
| Control | 0..1 |
| Type | Reference(Transport) |
Guidance on how to interpret the contents of this table can be foundhere
| 0. 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 | Delivery of item |
| Control | 0..* |
| Is Modifier | false |
| Must Support | false |
| Summary | false |
| Invariants | dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources (contained.contained.empty())dom-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource ( contained.where((('#'+id.trace('id') in %resource.descendants().select(reference | as(uri))) or descendants().where(reference='#' | as(uri)='#').exists()).not()).trace('unmatched', id).empty())dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated ( contained.meta.versionId.empty() and contained.meta.lastUpdated.empty())dom-5: If a resource is contained in another resource, it SHALL NOT have a security label ( contained.meta.security.empty())dom-6: A resource should have narrative for robust management ( text.`div`.exists()) |
| 2. Transport.id | |
| Definition | The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. |
| Short | Logical id of this artifact |
| Comments | Within the context of the FHIR RESTful interactions, the resource has an id except for cases like the create and conditional update. Otherwise, the use of the resouce id depends on the given use case. |
| Control | 0..1 |
| Type | id |
| Is Modifier | false |
| Must Support | false |
| Summary | true |
| 4. Transport.meta | |
| Definition | The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource. |
| Short | Metadata about the resource |
| Control | 0..1 |
| Type | Meta |
| Is Modifier | false |
| Must Support | false |
| Summary | true |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 6. Transport.implicitRules | |
| Definition | A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc. |
| Short | A set of rules under which this content was created |
| Comments | Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of its narrative along with other profiles, value sets, etc. |
| Control | 0..1 |
| Type | uri |
| Is Modifier | true because This element is labeled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies its meaning or interpretation |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Must Support | false |
| Summary | true |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 8. Transport.language | |
| Definition | The base language in which the resource is written. |
| Short | Language of the resource content |
| Comments | Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute). |
| Control | 0..1 |
| Binding | The codes SHALL be taken from AllLanguages (required to http://hl7.org/fhir/ValueSet/all-languages|6.0.0-ballot3)IETF language tag for a human language |
| Type | code |
| Is Modifier | false |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Must Support | false |
| Summary | false |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 10. Transport.text | |
| Definition | A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety. |
| Short | Text summary of the resource, for human interpretation |
| Comments | Contained resources do not have a narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a "text blob" or where text is additionally entered raw or narrated and encoded information is added later. |
| Control | 0..1 This element is affected by the following invariants: dom-6 |
| Type | Narrative |
| Is Modifier | false |
| Must Support | false |
| Summary | false |
| Alternate Names | narrative, html, xhtml, display |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 12. Transport.contained | |
| Definition | These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, nor can they have their own independent transaction scope. This is allowed to be a Parameters resource if and only if it is referenced by a resource that provides context/meaning. |
| Short | Contained, inline Resources |
| Comments | This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags in their meta elements, but SHALL NOT have security labels. Contained resources may be a resource type defined in the FHIR specification, or an additional resource. |
| Control | 0..* This element is affected by the following invariants: dom-2, dom-4, dom-3, dom-5 |
| Type | Resource |
| Is Modifier | false |
| Must Support | false |
| Summary | false |
| Alternate Names | inline resources, anonymous resources, contained resources |
| 14. Transport.extension | |
| Definition | May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
| Short | Additional content defined by implementations |
| Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
| Control | 0..* |
| Type | Extension |
| Is Modifier | false |
| Must Support | false |
| Summary | false |
| Alternate Names | extensions, user content |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| Slicing | This element introduces a set of slices on Transport.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators: |
| 16. Transport.modifierExtension | |
| Definition | May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). |
| Short | Extensions that cannot be ignored |
| Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
| Control | 0..* |
| Type | Extension |
| Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the resource that contains them |
| Must Support | false |
| Summary | true |
| Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. |
| Alternate Names | extensions, user content |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| Slicing | This element introduces a set of slices on Transport.modifierExtension. The slices areUnordered and Open, and can be differentiated using the following discriminators: |
| 18. Transport.identifier | |
| Definition | Identifier for the transport event that is used to identify it across multiple disparate systems. |
| Short | External identifier |
| 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. |
| Note | This is a business identifier, not a resource identifier (see discussion) |
| Control | 0..* |
| Type | Identifier |
| 20. 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 | Formal definition of transport |
| Control | 0..1 |
| Type | canonical(ActivityDefinition) |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Summary | true |
| Requirements | Enables a formal definition of how the transport is to be performed, enabling automation. |
| 22. 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 | Request fulfilled by this transport |
| Control | 0..* |
| Type | Reference(Task, ServiceRequest, DeviceRequest, MedicationRequest, RequestOrchestration, SupplyRequest, VisionPrescription) |
| Summary | true |
| 24. Transport.partOf | |
| Definition | A larger event of which this particular event is a component or step. |
| Short | Part of referenced event |
| 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]. |
| Control | 0..* |
| Type | Reference(Transport) |
| Summary | true |
| Requirements | E.g. Drug administration as part of a procedure, procedure as part of observation, etc. |
| 26. Transport.status | |
| Definition | A code specifying the state of the transport event. |
| Short | preparation | in-progress | not-done | suspended | stopped | on-hold | completed | entered-in-error | unknown |
| Control | 0..1 |
| Binding | The codes SHALL be taken from TransportStatus (required to http://hl7.org/fhir/ValueSet/transport-status)Status of the transport. |
| Type | code |
| Is Modifier | true because 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 |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Summary | true |
| 28. Transport.statusReason | |
| Definition | An explanation as to why this transport is held, failed, was refused, etc. |
| Short | Reason for current status |
| Comments | This applies to the current status. Look at the history of the transport to see reasons for past statuses. |
| Control | 0..1 |
| Binding | For example codes, see TransportStatusReason (example to http://hl7.org/fhir/ValueSet/transport-status-reason)Codes to identify the reason for current status. These will typically be specific to a particular workflow. |
| Type | CodeableConcept |
| Summary | true |
| 30. Transport.code | |
| Definition | A name or code (or both) briefly describing what the transport involves. |
| Short | Transport Type |
| Comments | The title (eg "My Transports", "Outstanding Transports for Patient X") should go into the code. |
| Control | 0..1 |
| Binding | For example codes, see TransportVS (example to http://hl7.org/fhir/ValueSet/transport)Codes to identify what the transport involves. These will typically be specific to a particular workflow. |
| Type | CodeableConcept |
| Summary | true |
| 32. Transport.description | |
| Definition | A free-text description of what is to be performed. |
| Short | Human-readable explanation of transport |
| Control | 0..1 |
| Type | markdown |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Summary | true |
| 34. Transport.focus | |
| Definition | The resource representing the physical entity being transported. |
| Short | What transport is acting on, when it is not the subject of record |
| 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. |
| Control | 0..1 |
| Type | Reference(Resource) |
| Summary | true |
| Requirements | Used to identify the thing to be done. |
| 36. Transport.subject | |
| Definition | The entity who benefits from the performance of the service specified in the transport (such as patient or subject). |
| Short | Beneficiary of the Transport (such as patient or subject) |
| Comments | When the transport is a device for a patient this would be the Patient. |
| Control | 0..1 |
| Type | Reference(Resource) |
| Summary | true |
| 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 |
| 38. Transport.encounter | |
| Definition | The healthcare event (e.g. a patient and healthcare provider interaction) during which this transport was created. |
| Short | Healthcare event during which this transport originated |
| Control | 0..1 |
| Type | Reference(Encounter) |
| Summary | true |
| Requirements | For some transports it may be important to know the link between the encounter the transport originated within. |
| 40. Transport.period | |
| Definition | The period when the transport event is occurring or did occur. |
| Short | When transport is occurring/occurred |
| 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. |
| Control | 0..1 |
| Type | Period |
| Summary | true |
| 42. Transport.authoredOn | |
| Definition | The date and time this transport was created. |
| Short | Transport Creation Date |
| Control | 0..1 |
| Type | dateTime |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Requirements | Most often used along with lastUpdated to track duration of the transport to supporting monitoring and management. |
| Alternate Names | Created Date |
| 44. Transport.lastModified | |
| Definition | The date and time of last modification to this transport. |
| Short | Transport Last Modified Date |
| Control | 0..1 |
| Type | dateTime |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Summary | true |
| 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 |
| 46. Transport.performer | |
| Definition | Identifies the entity expected to perform the transport. |
| Short | Who or what performs the transport |
| Comments | Transports may be created with an owner not yet identified. |
| Control | 0..* |
| Type | Reference(Practitioner, PractitionerRole, Organization, CareTeam, HealthcareService, Patient, Device, RelatedPerson) |
| Summary | true |
| Requirements | Identifies who is expected to perform this transport. |
| Alternate Names | Performer, Executer |
| 48. Transport.location | |
| Definition | Principal physical location where this transport is performed. |
| Short | Where transport occurs |
| Control | 0..1 |
| Type | Reference(Location) |
| Summary | true |
| 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). |
| 50. Transport.insurance | |
| Definition | Insurance plans, coverage extensions, pre-authorizations and/or pre-determinations that may be relevant to the Transport. |
| Short | Associated insurance coverage |
| Control | 0..* |
| Type | Reference(Coverage, ClaimResponse) |
| 52. Transport.note | |
| Definition | Free-text information captured about the transport as it progresses. |
| Short | Comments made about the transport |
| Control | 0..* |
| Type | Annotation |
| 54. 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 | Key events in history 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. |
| Control | 0..* |
| Type | Reference(Provenance) |
| Alternate Names | Status History |
| 56. Transport.to | |
| Definition | The target location for the transport event. |
| Short | Destination location |
| Control | 1..1 |
| Type | Reference(Location) |
| Summary | true |
| 58. Transport.from | |
| Definition | The starting location for the transport event. |
| Short | Originating location |
| Control | 1..1 |
| Type | Reference(Location) |
| Summary | true |
| 60. Transport.reason | |
| Definition | A resource reference indicating why this transport needs to be performed. |
| Short | Why transport is needed |
| 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 |
| Control | 0..1 |
| Binding | For example codes, see TransportReason (example to http://hl7.org/fhir/ValueSet/transport-reason)Indicates why the transport is needed. E.g. Suspended because patient admitted to hospital. |
| Type | CodeableReference(Resource) |
| 62. Transport.priorTransport | |
| Definition | The immediately preceding Transport event. |
| Short | The most recent transport |
| Control | 0..1 |
| Type | Reference(Transport) |