Generated Narrative: StructureDefinition Transport Last updated: 2021-01-02 08:58:31+1100 Name Flags Card. Type Description & Constraints Transport 0..* DomainResource Delivery of item Elements defined in Ancestors:id, meta, implicitRules, language, <a href="http://hl7.org/fhir/R5/domainresource.html" title="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.">text, contained, <a href="http://hl7.org/fhir/R5/domainresource.html" title="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.">extension, <a href="http://hl7.org/fhir/R5/domainresource.html" title="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.#xA;#xA;Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).">modifierExtension #xD; identifier 0..* Identifier External identifier #xD; instantiates Σ 0..1 canonical(ActivityDefinition) Formal definition of transport #xD; <a href="StructureDefinition-Transport-definitions.html#Transport.basedOn" title="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.">basedOn Σ 0..* Reference(Task | ServiceRequest | DeviceRequest | MedicationRequest | RequestOrchestration | SupplyRequest | VisionPrescription) Request fulfilled by this transport #xD; partOf Σ 0..* Reference(Transport) Part of referenced event #xD; status ?!Σ 0..1 code preparation | in-progress | not-done | suspended | stopped | on-hold | completed | entered-in-error | unknown Binding: TransportStatus (required): Status of the transport. #xD; statusReason Σ 0..1 CodeableConcept Reason for current status Binding: TransportStatusReason (example): Codes to identify the reason for current status. These will typically be specific to a particular workflow. #xD; code Σ 0..1 CodeableConcept Transport Type Binding: TransportVS (example): Codes to identify what the transport involves. These will typically be specific to a particular workflow. #xD; description Σ 0..1 markdown Human-readable explanation of transport #xD; focus Σ 0..1 Reference(Resource) What transport is acting on, when it is not the subject of record #xD; subject Σ 0..1 Reference(Resource) Beneficiary of the Transport (such as patient or subject) #xD; encounter Σ 0..1 Reference(Encounter) Healthcare event during which this transport originated #xD; period Σ 0..1 Period When transport is occurring/occurred #xD; authoredOn 0..1 dateTime Transport Creation Date #xD; lastModified Σ 0..1 dateTime Transport Last Modified Date #xD; performer Σ 0..* Reference(Practitioner | PractitionerRole | Organization | CareTeam | HealthcareService | Patient | Device | RelatedPerson) Who or what performs the transport #xD; location Σ 0..1 Reference(Location) Where transport occurs #xD; insurance 0..* Reference(Coverage | ClaimResponse) Associated insurance coverage #xD; note 0..* Annotation Comments made about the transport #xD; relevantHistory 0..* Reference(Provenance) Key events in history of the Transport #xD; to Σ 1..1 Reference(Location) Destination location #xD; from Σ 1..1 Reference(Location) Originating location #xD; reason 0..1 CodeableReference(Resource) Why transport is needed Binding: TransportReason (example): Indicates why the transport is needed. E.g. Suspended because patient admitted to hospital. #xD; priorTransport 0..1 Reference(Transport) The most recent transport #xD; Documentation for this format
HL7 International / Orders and Observations
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.
If the resource is contained in another resource, it SHALL NOT contain nested Resources
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()
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()
If a resource is contained in another resource, it SHALL NOT have a security label
When a resource has no narrative, only systems that fully understand the data can display the resource to a human safely. Including a human readable representation in the resource makes for a much more robust eco-system and cheaper handling of resources by intermediary systems. Some ecosystems restrict distribution of resources to only those systems that do fully understand the resources, and as a consequence implementers may believe that the narrative is superfluous. However experience shows that such eco-systems often open up to new participants over time.
A resource should have narrative for robust management
Supply[moodCode=RQO],Entity. Role,or Act,Entity,Role,or Act
The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
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.
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.
All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
A set of rules under which this content was created
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.
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.
This element is labeled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies its meaning or interpretation
The base language in which the resource is written.
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).
Text summary of the resource, for human interpretation
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.
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.
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.
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](http://build.fhir.org/resource.html#additional).
Extensions are always sliced by (at least) url
Additional content defined by implementations
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.
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.
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).
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](http://build.fhir.org/extensibility.html#modifierExtension).
Modifier extensions are expected to modify the meaning or interpretation of the resource that contains them
Identifier for the transport event that is used to identify it across multiple disparate systems.
This identifier is typically assigned by the dispenser, and may be used to reference the delivery when exchanging information about it with other systems.
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.
Enables a formal definition of how the transport is to be performed, enabling automation.
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.
A larger event of which this particular event is a component or step.
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].
E.g. Drug administration as part of a procedure, procedure as part of observation, etc.
preparation | in-progress | not-done | suspended | stopped | on-hold | completed | entered-in-error | unknown
A code specifying the state of the transport event.
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
.statusCode, also existence of fulfillment events
An explanation as to why this transport is held, failed, was refused, etc.
This applies to the current status. Look at the history of the transport to see reasons for past statuses.
Codes to identify the reason for current status. These will typically be specific to a particular workflow.
.inboundRelationship[typeCode=SUBJ].source[classCode=CACT, moodCode=EVN, code="status change"].reasonCode
A name or code (or both) briefly describing what the transport involves.
The title (eg "My Transports", "Outstanding Transports for Patient X") should go into the code.
Codes to identify what the transport involves. These will typically be specific to a particular workflow.
A free-text description of what is to be performed.
What transport is acting on, when it is not the subject of record
The resource representing the physical entity being transported.
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.
Beneficiary of the Transport (such as patient or subject)
The entity who benefits from the performance of the service specified in the transport (such as patient or subject).
When the transport is a device for a patient this would be the Patient.
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.
Healthcare event during which this transport originated
The healthcare event (e.g. a patient and healthcare provider interaction) during which this transport was created.
For some transports it may be important to know the link between the encounter the transport originated within.
.inboundRelationship[typeCode=COMP].source[classCode=PCPR, moodCode=EVN]
The period when the transport event is occurring or did occur.
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.
The date and time this transport was created.
Most often used along with lastUpdated to track duration of the transport to supporting monitoring and management.
The date and time of last modification to this transport.
Used along with history to track transport activity and time in a particular transport state. This enables monitoring and management.
.inboundRelationship[typeCode=SUBJ, ].source[classCode=CACT, moodCode=EVN].effectiveTime
Identifies the entity expected to perform the transport.
Transports may be created with an owner not yet identified.
Identifies who is expected to perform this transport.
Principal physical location where this transport is performed.
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).
Insurance plans, coverage extensions, pre-authorizations and/or pre-determinations that may be relevant to the Transport.
Free-text information captured about the transport as it progresses.
.inboundRelationship[typeCode=SUBJ, ].source[classCode=OBS, moodCode=EVN, code="annotation"].value(string)
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.
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.
.inboundRelationship(typeCode=SUBJ].source[classCode=CACT, moodCode=EVN]
The target location for the transport event.
The starting location for the transport event.
A resource reference indicating why this transport needs to be performed.
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.
Indicates why the transport is needed. E.g. Suspended because patient admitted to hospital.
The immediately preceding Transport event.