Release 5 Ballot

This page is part of the FHIR Specification (v5.0.0-ballot: R5 Ballot - see ballot notes). The current version which supercedes this version is 5.0.0. For a full list of available versions, see the Directory of published versions

12.2 Resource Transport - Content

Orders and Observations icon Work GroupMaturity Level: 0 Trial UseSecurity Category: Patient Compartments: Not linked to any defined compartments

Record of transport of item.

This resource is an event resource from a FHIR workflow perspective - see Workflow. It is the intent of the Orders and Observation Workgroup to align this resource with the workflow pattern for event resources.

The Transport resource captures the requested movement and movement history of persons and items in the healthcare spectrum. The Transport resource documents the movement of a person or item. Since it follows the event pattern, it can be used in the request of a transport event, but it can be used in conjunction with the Task resource to operationalize a movement event in a workflow. While the current use cases are focused on the lab and the movement of patients, this resource will be easily extensible to handle the movement of anything in healthcare. Sample use cases for the laboratory are as follows:

  • Movement of a specimen between distinct healthcare locations (clinic to lab, lab to lab, lab to biorepository) without the use of a third-party transport system (e.g. a courier)
  • Movement of a specimen between distinct healthcare locations (clinic to lab, lab to lab, lab to biorepository) with the use of a third-party transport system (e.g. a courier)
  • Accessing the current location (tracking) and the complete location history (audit) for a given specimen.
Sample use cases involving patients include
  • Movement of a patient within a healthcare setting (changing floors of the hospital)
  • Movement of a patient between healthcare settings (moving a patient from one hospital to another)

With the emergence of IHE profiles on the movement of laboratory specimens (SET icon) and the growing needs around the movement of patients (documentation, scheduling, real-time updates), there is a need to capture the data around the movement of a patient or item in the healthcare setting. While the Task resource captures some of the data generated around a event, the Transport resource is built to capture the documentation along with the request/fulfillment of a transport event.

The Transport resource can be requested by a ServiceRequest or by a Task, as shown in the diagram below. Also, this resource is only for the documentation of the physical movement of material items (people, animals, things). To operationalize the movement of people and things, Task should be used. Provenance can be used to document the steps but that is for the resource aspect, not the actual movement history of the item.

Diagram showing Transport resource event flow
  • Implements: Event
  • Resource References: itself

Structure

NameFlagsCard.TypeDescription & Constraintsdoco
.. Transport TUDomainResourceDelivery of item

Elements defined in Ancestors: id, meta, implicitRules, language, text, contained, extension, modifierExtension
... identifier 0..*IdentifierExternal identifier

... instantiatesCanonical Σ0..1canonical(ActivityDefinition)Formal definition of transport
... instantiatesUri Σ0..1uriFormal definition of transport
... basedOn Σ0..*Reference(Any)Request fulfilled by this transport

... groupIdentifier Σ0..1IdentifierRequisition or grouper id
... partOf Σ0..*Reference(Transport | Contract)Part of referenced event

... status ?!Σ0..1codein-progress | completed | abandoned | cancelled | planned | entered-in-error
TransportStatus (Required)
... statusReason Σ0..1CodeableConceptReason for current status
TransportStatusReason (Example)
... intent Σ1..1codeunknown | proposal | plan | order | original-order | reflex-order | filler-order | instance-order | option
TransportIntent (Required)
... priority 0..1coderoutine | urgent | asap | stat
RequestPriority (Required)
... code Σ0..1CodeableConceptTransport Type
Transport Codes (Example)
... description Σ0..1stringHuman-readable explanation of transport
... focus Σ0..1Reference(Any)What transport is acting on
... for Σ0..1Reference(Any)Beneficiary of the Transport
... encounter Σ0..1Reference(Encounter)Healthcare event during which this transport originated
... completionTime Σ0..1dateTimeCompletion time of the event (the occurrence)
... authoredOn 0..1dateTimeTransport Creation Date
... lastModified Σ0..1dateTimeTransport Last Modified Date
... requester Σ0..1Reference(Device | Organization | Patient | Practitioner | PractitionerRole | RelatedPerson)Who is asking for transport to be done
... performerType 0..*CodeableConceptRequested performer
Procedure Performer Role Codes (Preferred)

... owner Σ0..1Reference(Practitioner | PractitionerRole | Organization | CareTeam | HealthcareService | Patient | Device | RelatedPerson)Responsible individual
... location Σ0..1Reference(Location)Where transport occurs
... reasonCode 0..1CodeableConceptWhy transport is needed
TransportReason (Example)
... reasonReference 0..1Reference(Any)Why transport is needed
... insurance 0..*Reference(Coverage | ClaimResponse)Associated insurance coverage

... note 0..*AnnotationComments made about the transport

... relevantHistory 0..*Reference(Provenance)Key events in history of the Transport

... restriction 0..1BackboneElementConstraints on fulfillment transports
.... repetitions 0..1positiveIntHow many times to repeat
.... period 0..1PeriodWhen fulfillment sought
.... recipient 0..*Reference(Patient | Practitioner | PractitionerRole | RelatedPerson | Group | Organization)For whom is fulfillment sought?

... input 0..*BackboneElementInformation used to perform transport

.... type 1..1CodeableConceptLabel for the input
TransportInputParameterType (Example)
.... value[x] 1..1*Content to use in performing the transport
... output 0..*BackboneElementInformation produced as part of transport

.... type 1..1CodeableConceptLabel for output
TransportOutputParameterType (Example)
.... value[x] 1..1*Result of output
... requestedLocation Σ1..1Reference(Location)The desired location
... currentLocation Σ1..1Reference(Location)The current location
... history 0..1Reference(Transport)Parent (or preceding) transport

doco Documentation for this format

See the Extensions for this resource

UML Diagram (Legend)

Transport (DomainResource)Identifier for the transport event that is used to identify it across multiple disparate systemsidentifier : Identifier [0..*]The URL pointing to a *FHIR*-defined protocol, guideline, orderset or other definition that is adhered to in whole or in part by this TransportinstantiatesCanonical : canonical [0..1] « ActivityDefinition »The URL pointing to an *externally* maintained protocol, guideline, orderset or other definition that is adhered to in whole or in part by this TransportinstantiatesUri : uri [0..1]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 labbasedOn : Reference [0..*] « Any »An identifier that links together multiple transports and other requests that were created in the same contextgroupIdentifier : Identifier [0..1]A larger event of which this particular event is a component or steppartOf : Reference [0..*] « Transport|Contract »A code specifying the state of the transport event (this element modifies the meaning of other elements)status : code [0..1] « null (Strength=Required)TransportStatus! »An explanation as to why this transport is held, failed, was refused, etcstatusReason : CodeableConcept [0..1] « null (Strength=Example)TransportStatusReason?? »Indicates the "level" of actionability associated with the Transport, i.e. i+R[9]Cs this a proposed transport, a planned transport, an actionable transport, etcintent : code [1..1] « null (Strength=Required)TransportIntent! »Indicates how quickly the Transport should be addressed with respect to other requestspriority : code [0..1] « null (Strength=Required)RequestPriority! »A name or code (or both) briefly describing what the transport involvescode : CodeableConcept [0..1] « null (Strength=Example)TransportCode?? »A free-text description of what is to be performeddescription : string [0..1]The request being actioned or the resource being manipulated by this transportfocus : Reference [0..1] « Any »The entity who benefits from the performance of the service specified in the transport (e.g., the patient)for : Reference [0..1] « Any »The healthcare event (e.g. a patient and healthcare provider interaction) during which this transport was createdencounter : Reference [0..1] « Encounter »Identifies the completion time of the event (the occurrence)completionTime : dateTime [0..1]The date and time this transport was createdauthoredOn : dateTime [0..1]The date and time of last modification to this transportlastModified : dateTime [0..1]The creator of the transportrequester : Reference [0..1] « Device|Organization|Patient| Practitioner|PractitionerRole|RelatedPerson »The kind of participant that should perform the transportperformerType : CodeableConcept [0..*] « null (Strength=Preferred)ProcedurePerformerRoleCodes? »Individual organization or Device currently responsible for transport executionowner : Reference [0..1] « Practitioner|PractitionerRole| Organization|CareTeam|HealthcareService|Patient|Device| RelatedPerson »Principal physical location where this transport is performedlocation : Reference [0..1] « Location »A description or code indicating why this transport needs to be performedreasonCode : CodeableConcept [0..1] « null (Strength=Example)TransportReason?? »A resource reference indicating why this transport needs to be performedreasonReference : Reference [0..1] « Any »Insurance plans, coverage extensions, pre-authorizations and/or pre-determinations that may be relevant to the Transportinsurance : Reference [0..*] « Coverage|ClaimResponse »Free-text information captured about the transport as it progressesnote : Annotation [0..*]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 transportrelevantHistory : Reference [0..*] « Provenance »The desired or final location for the transportrequestedLocation : Reference [1..1] « Location »The current location for the entity to be transportedcurrentLocation : Reference [1..1] « Location »The transport event prior to this onehistory : Reference [0..1] « Transport »RestrictionIndicates the number of times the requested action should occurrepetitions : positiveInt [0..1]Over what time-period is fulfillment soughtperiod : Period [0..1]For requests that are targeted to more than one potential recipient/target, to identify who is fulfillment is sought forrecipient : Reference [0..*] « Patient|Practitioner|PractitionerRole| RelatedPerson|Group|Organization »ParameterA code or description indicating how the input is intended to be used as part of the transport executiontype : CodeableConcept [1..1] « null (Strength=Example)TransportInputParameterType?? »The value of the input parameter as a basic typevalue[x] : * [1..1]OutputThe name of the Output parametertype : CodeableConcept [1..1] « null (Strength=Example)TransportOutputParameterType?? »The value of the Output parameter as a basic typevalue[x] : * [1..1]If the Transport.focus is a request resource and the transport is seeking fulfillment (i.e. is asking for the request to be actioned), this element identifies any limitations on what parts of the referenced request should be actionedrestriction[0..1]Additional information that may be needed in the execution of the transportinput[0..*]Outputs produced by the Transportoutput[0..*]

XML Template

<Transport xmlns="http://hl7.org/fhir"> doco
 <!-- from Resource: id, meta, implicitRules, and language -->
 <!-- from DomainResource: text, contained, extension, and modifierExtension -->
 <identifier><!-- 0..* Identifier External identifier --></identifier>
 <instantiatesCanonical><!-- 0..1 canonical(ActivityDefinition) Formal definition of transport --></instantiatesCanonical>
 <instantiatesUri value="[uri]"/><!-- 0..1 Formal definition of transport -->
 <basedOn><!-- 0..* Reference(Any) Request fulfilled by this transport --></basedOn>
 <groupIdentifier><!-- 0..1 Identifier Requisition or grouper id --></groupIdentifier>
 <partOf><!-- 0..* Reference(Contract|Transport) Part of referenced event --></partOf>
 <status value="[code]"/><!-- 0..1 in-progress | completed | abandoned | cancelled | planned | entered-in-error -->
 <statusReason><!-- 0..1 CodeableConcept Reason for current status --></statusReason>
 <intent value="[code]"/><!-- 1..1 unknown | proposal | plan | order | original-order | reflex-order | filler-order | instance-order | option -->
 <priority value="[code]"/><!-- 0..1 routine | urgent | asap | stat -->
 <code><!-- 0..1 CodeableConcept Transport Type --></code>
 <description value="[string]"/><!-- 0..1 Human-readable explanation of transport -->
 <focus><!-- 0..1 Reference(Any) What transport is acting on --></focus>
 <for><!-- 0..1 Reference(Any) Beneficiary of the Transport --></for>
 <encounter><!-- 0..1 Reference(Encounter) Healthcare event during which this transport originated --></encounter>
 <completionTime value="[dateTime]"/><!-- 0..1 Completion time of the event (the occurrence) -->
 <authoredOn value="[dateTime]"/><!-- 0..1 Transport Creation Date -->
 <lastModified value="[dateTime]"/><!-- 0..1 Transport Last Modified Date -->
 <requester><!-- 0..1 Reference(Device|Organization|Patient|Practitioner|
   PractitionerRole|RelatedPerson) Who is asking for transport to be done --></requester>
 <performerType><!-- 0..* CodeableConcept Requested performer --></performerType>
 <owner><!-- 0..1 Reference(CareTeam|Device|HealthcareService|Organization|
   Patient|Practitioner|PractitionerRole|RelatedPerson) Responsible individual --></owner>
 <location><!-- 0..1 Reference(Location) Where transport occurs --></location>
 <reasonCode><!-- 0..1 CodeableConcept Why transport is needed --></reasonCode>
 <reasonReference><!-- 0..1 Reference(Any) Why transport is needed --></reasonReference>
 <insurance><!-- 0..* Reference(ClaimResponse|Coverage) Associated insurance coverage --></insurance>
 <note><!-- 0..* Annotation Comments made about the transport --></note>
 <relevantHistory><!-- 0..* Reference(Provenance) Key events in history of the Transport --></relevantHistory>
 <restriction>  <!-- 0..1 Constraints on fulfillment transports -->
  <repetitions value="[positiveInt]"/><!-- 0..1 How many times to repeat -->
  <period><!-- 0..1 Period When fulfillment sought --></period>
  <recipient><!-- 0..* Reference(Group|Organization|Patient|Practitioner|
    PractitionerRole|RelatedPerson) For whom is fulfillment sought? --></recipient>
 </restriction>
 <input>  <!-- 0..* Information used to perform transport -->
  <type><!-- 1..1 CodeableConcept Label for the input --></type>
  <value[x]><!-- 1..1 * Content to use in performing the transport --></value[x]>
 </input>
 <output>  <!-- 0..* Information produced as part of transport -->
  <type><!-- 1..1 CodeableConcept Label for output --></type>
  <value[x]><!-- 1..1 * Result of output --></value[x]>
 </output>
 <requestedLocation><!-- 1..1 Reference(Location) The desired location --></requestedLocation>
 <currentLocation><!-- 1..1 Reference(Location) The current location --></currentLocation>
 <history><!-- 0..1 Reference(Transport) Parent (or preceding) transport --></history>
</Transport>

JSON Template

{doco
  "resourceType" : "Transport",
  // from Resource: id, meta, implicitRules, and language
  // from DomainResource: text, contained, extension, and modifierExtension
  "identifier" : [{ Identifier }], // External identifier
  "instantiatesCanonical" : "<canonical(ActivityDefinition)>", // Formal definition of transport
  "instantiatesUri" : "<uri>", // Formal definition of transport
  "basedOn" : [{ Reference(Any) }], // Request fulfilled by this transport
  "groupIdentifier" : { Identifier }, // Requisition or grouper id
  "partOf" : [{ Reference(Contract|Transport) }], // Part of referenced event
  "status" : "<code>", // in-progress | completed | abandoned | cancelled | planned | entered-in-error
  "statusReason" : { CodeableConcept }, // Reason for current status
  "intent" : "<code>", // R!  unknown | proposal | plan | order | original-order | reflex-order | filler-order | instance-order | option
  "priority" : "<code>", // routine | urgent | asap | stat
  "code" : { CodeableConcept }, // Transport Type
  "description" : "<string>", // Human-readable explanation of transport
  "focus" : { Reference(Any) }, // What transport is acting on
  "for" : { Reference(Any) }, // Beneficiary of the Transport
  "encounter" : { Reference(Encounter) }, // Healthcare event during which this transport originated
  "completionTime" : "<dateTime>", // Completion time of the event (the occurrence)
  "authoredOn" : "<dateTime>", // Transport Creation Date
  "lastModified" : "<dateTime>", // Transport Last Modified Date
  "requester" : { Reference(Device|Organization|Patient|Practitioner|
   PractitionerRole|RelatedPerson) }, // Who is asking for transport to be done
  "performerType" : [{ CodeableConcept }], // Requested performer
  "owner" : { Reference(CareTeam|Device|HealthcareService|Organization|
   Patient|Practitioner|PractitionerRole|RelatedPerson) }, // Responsible individual
  "location" : { Reference(Location) }, // Where transport occurs
  "reasonCode" : { CodeableConcept }, // Why transport is needed
  "reasonReference" : { Reference(Any) }, // Why transport is needed
  "insurance" : [{ Reference(ClaimResponse|Coverage) }], // Associated insurance coverage
  "note" : [{ Annotation }], // Comments made about the transport
  "relevantHistory" : [{ Reference(Provenance) }], // Key events in history of the Transport
  "restriction" : { // Constraints on fulfillment transports
    "repetitions" : "<positiveInt>", // How many times to repeat
    "period" : { Period }, // When fulfillment sought
    "recipient" : [{ Reference(Group|Organization|Patient|Practitioner|
    PractitionerRole|RelatedPerson) }] // For whom is fulfillment sought?
  },
  "input" : [{ // Information used to perform transport
    "type" : { CodeableConcept }, // R!  Label for the input
    // value[x]: Content to use in performing the transport. One of these 54:
    "valueBase64Binary" : "<base64Binary>"
    "valueBoolean" : <boolean>,
    "valueCanonical" : "<canonical>",
    "valueCode" : "<code>",
    "valueDate" : "<date>",
    "valueDateTime" : "<dateTime>",
    "valueDecimal" : <decimal>,
    "valueId" : "<id>",
    "valueInstant" : "<instant>",
    "valueInteger" : <integer>,
    "valueInteger64" : "<integer64>",
    "valueMarkdown" : "<markdown>",
    "valueOid" : "<oid>",
    "valuePositiveInt" : "<positiveInt>",
    "valueString" : "<string>",
    "valueTime" : "<time>",
    "valueUnsignedInt" : "<unsignedInt>",
    "valueUri" : "<uri>",
    "valueUrl" : "<url>",
    "valueUuid" : "<uuid>",
    "valueAddress" : { Address },
    "valueAge" : { Age },
    "valueAnnotation" : { Annotation },
    "valueAttachment" : { Attachment },
    "valueCodeableConcept" : { CodeableConcept },
    "valueCodeableReference" : { CodeableReference },
    "valueCoding" : { Coding },
    "valueContactPoint" : { ContactPoint },
    "valueCount" : { Count },
    "valueDistance" : { Distance },
    "valueDuration" : { Duration },
    "valueHumanName" : { HumanName },
    "valueIdentifier" : { Identifier },
    "valueMoney" : { Money },
    "valuePeriod" : { Period },
    "valueQuantity" : { Quantity },
    "valueRange" : { Range },
    "valueRatio" : { Ratio },
    "valueRatioRange" : { RatioRange },
    "valueReference" : { Reference },
    "valueSampledData" : { SampledData },
    "valueSignature" : { Signature },
    "valueTiming" : { Timing },
    "valueContactDetail" : { ContactDetail },
    "valueDataRequirement" : { DataRequirement },
    "valueExpression" : { Expression },
    "valueParameterDefinition" : { ParameterDefinition },
    "valueRelatedArtifact" : { RelatedArtifact },
    "valueTriggerDefinition" : { TriggerDefinition },
    "valueUsageContext" : { UsageContext },
    "valueAvailability" : { Availability },
    "valueExtendedContactDetail" : { ExtendedContactDetail },
    "valueDosage" : { Dosage },
    "valueMeta" : { Meta },
  }],
  "output" : [{ // Information produced as part of transport
    "type" : { CodeableConcept }, // R!  Label for output
    // value[x]: Result of output. One of these 54:
    "valueBase64Binary" : "<base64Binary>"
    "valueBoolean" : <boolean>,
    "valueCanonical" : "<canonical>",
    "valueCode" : "<code>",
    "valueDate" : "<date>",
    "valueDateTime" : "<dateTime>",
    "valueDecimal" : <decimal>,
    "valueId" : "<id>",
    "valueInstant" : "<instant>",
    "valueInteger" : <integer>,
    "valueInteger64" : "<integer64>",
    "valueMarkdown" : "<markdown>",
    "valueOid" : "<oid>",
    "valuePositiveInt" : "<positiveInt>",
    "valueString" : "<string>",
    "valueTime" : "<time>",
    "valueUnsignedInt" : "<unsignedInt>",
    "valueUri" : "<uri>",
    "valueUrl" : "<url>",
    "valueUuid" : "<uuid>",
    "valueAddress" : { Address },
    "valueAge" : { Age },
    "valueAnnotation" : { Annotation },
    "valueAttachment" : { Attachment },
    "valueCodeableConcept" : { CodeableConcept },
    "valueCodeableReference" : { CodeableReference },
    "valueCoding" : { Coding },
    "valueContactPoint" : { ContactPoint },
    "valueCount" : { Count },
    "valueDistance" : { Distance },
    "valueDuration" : { Duration },
    "valueHumanName" : { HumanName },
    "valueIdentifier" : { Identifier },
    "valueMoney" : { Money },
    "valuePeriod" : { Period },
    "valueQuantity" : { Quantity },
    "valueRange" : { Range },
    "valueRatio" : { Ratio },
    "valueRatioRange" : { RatioRange },
    "valueReference" : { Reference },
    "valueSampledData" : { SampledData },
    "valueSignature" : { Signature },
    "valueTiming" : { Timing },
    "valueContactDetail" : { ContactDetail },
    "valueDataRequirement" : { DataRequirement },
    "valueExpression" : { Expression },
    "valueParameterDefinition" : { ParameterDefinition },
    "valueRelatedArtifact" : { RelatedArtifact },
    "valueTriggerDefinition" : { TriggerDefinition },
    "valueUsageContext" : { UsageContext },
    "valueAvailability" : { Availability },
    "valueExtendedContactDetail" : { ExtendedContactDetail },
    "valueDosage" : { Dosage },
    "valueMeta" : { Meta },
  }],
  "requestedLocation" : { Reference(Location) }, // R!  The desired location
  "currentLocation" : { Reference(Location) }, // R!  The current location
  "history" : { Reference(Transport) } // Parent (or preceding) transport
}

Turtle Template

@prefix fhir: <http://hl7.org/fhir/> .doco


[ a fhir:Transport;
  fhir:nodeRole fhir:treeRoot; # if this is the parser root

  # from Resource: .id, .meta, .implicitRules, and .language
  # from DomainResource: .text, .contained, .extension, and .modifierExtension
  fhir:Transport.identifier [ Identifier ], ... ; # 0..* External identifier
  fhir:Transport.instantiatesCanonical [ canonical(ActivityDefinition) ]; # 0..1 Formal definition of transport
  fhir:Transport.instantiatesUri [ uri ]; # 0..1 Formal definition of transport
  fhir:Transport.basedOn [ Reference(Any) ], ... ; # 0..* Request fulfilled by this transport
  fhir:Transport.groupIdentifier [ Identifier ]; # 0..1 Requisition or grouper id
  fhir:Transport.partOf [ Reference(Contract|Transport) ], ... ; # 0..* Part of referenced event
  fhir:Transport.status [ code ]; # 0..1 in-progress | completed | abandoned | cancelled | planned | entered-in-error
  fhir:Transport.statusReason [ CodeableConcept ]; # 0..1 Reason for current status
  fhir:Transport.intent [ code ]; # 1..1 unknown | proposal | plan | order | original-order | reflex-order | filler-order | instance-order | option
  fhir:Transport.priority [ code ]; # 0..1 routine | urgent | asap | stat
  fhir:Transport.code [ CodeableConcept ]; # 0..1 Transport Type
  fhir:Transport.description [ string ]; # 0..1 Human-readable explanation of transport
  fhir:Transport.focus [ Reference(Any) ]; # 0..1 What transport is acting on
  fhir:Transport.for [ Reference(Any) ]; # 0..1 Beneficiary of the Transport
  fhir:Transport.encounter [ Reference(Encounter) ]; # 0..1 Healthcare event during which this transport originated
  fhir:Transport.completionTime [ dateTime ]; # 0..1 Completion time of the event (the occurrence)
  fhir:Transport.authoredOn [ dateTime ]; # 0..1 Transport Creation Date
  fhir:Transport.lastModified [ dateTime ]; # 0..1 Transport Last Modified Date
  fhir:Transport.requester [ Reference(Device|Organization|Patient|Practitioner|PractitionerRole|RelatedPerson) ]; # 0..1 Who is asking for transport to be done
  fhir:Transport.performerType [ CodeableConcept ], ... ; # 0..* Requested performer
  fhir:Transport.owner [ Reference(CareTeam|Device|HealthcareService|Organization|Patient|Practitioner|
  PractitionerRole|RelatedPerson) ]; # 0..1 Responsible individual
  fhir:Transport.location [ Reference(Location) ]; # 0..1 Where transport occurs
  fhir:Transport.reasonCode [ CodeableConcept ]; # 0..1 Why transport is needed
  fhir:Transport.reasonReference [ Reference(Any) ]; # 0..1 Why transport is needed
  fhir:Transport.insurance [ Reference(ClaimResponse|Coverage) ], ... ; # 0..* Associated insurance coverage
  fhir:Transport.note [ Annotation ], ... ; # 0..* Comments made about the transport
  fhir:Transport.relevantHistory [ Reference(Provenance) ], ... ; # 0..* Key events in history of the Transport
  fhir:Transport.restriction [ # 0..1 Constraints on fulfillment transports
    fhir:Transport.restriction.repetitions [ positiveInt ]; # 0..1 How many times to repeat
    fhir:Transport.restriction.period [ Period ]; # 0..1 When fulfillment sought
    fhir:Transport.restriction.recipient [ Reference(Group|Organization|Patient|Practitioner|PractitionerRole|RelatedPerson) ], ... ; # 0..* For whom is fulfillment sought?
  ];
  fhir:Transport.input [ # 0..* Information used to perform transport
    fhir:Transport.input.type [ CodeableConcept ]; # 1..1 Label for the input
    # Transport.input.value[x] : 1..1 Content to use in performing the transport. One of these 54
      fhir:Transport.input.valueBase64Binary [ base64Binary ]
      fhir:Transport.input.valueBoolean [ boolean ]
      fhir:Transport.input.valueCanonical [ canonical ]
      fhir:Transport.input.valueCode [ code ]
      fhir:Transport.input.valueDate [ date ]
      fhir:Transport.input.valueDateTime [ dateTime ]
      fhir:Transport.input.valueDecimal [ decimal ]
      fhir:Transport.input.valueId [ id ]
      fhir:Transport.input.valueInstant [ instant ]
      fhir:Transport.input.valueInteger [ integer ]
      fhir:Transport.input.valueInteger64 [ integer64 ]
      fhir:Transport.input.valueMarkdown [ markdown ]
      fhir:Transport.input.valueOid [ oid ]
      fhir:Transport.input.valuePositiveInt [ positiveInt ]
      fhir:Transport.input.valueString [ string ]
      fhir:Transport.input.valueTime [ time ]
      fhir:Transport.input.valueUnsignedInt [ unsignedInt ]
      fhir:Transport.input.valueUri [ uri ]
      fhir:Transport.input.valueUrl [ url ]
      fhir:Transport.input.valueUuid [ uuid ]
      fhir:Transport.input.valueAddress [ Address ]
      fhir:Transport.input.valueAge [ Age ]
      fhir:Transport.input.valueAnnotation [ Annotation ]
      fhir:Transport.input.valueAttachment [ Attachment ]
      fhir:Transport.input.valueCodeableConcept [ CodeableConcept ]
      fhir:Transport.input.valueCodeableReference [ CodeableReference ]
      fhir:Transport.input.valueCoding [ Coding ]
      fhir:Transport.input.valueContactPoint [ ContactPoint ]
      fhir:Transport.input.valueCount [ Count ]
      fhir:Transport.input.valueDistance [ Distance ]
      fhir:Transport.input.valueDuration [ Duration ]
      fhir:Transport.input.valueHumanName [ HumanName ]
      fhir:Transport.input.valueIdentifier [ Identifier ]
      fhir:Transport.input.valueMoney [ Money ]
      fhir:Transport.input.valuePeriod [ Period ]
      fhir:Transport.input.valueQuantity [ Quantity ]
      fhir:Transport.input.valueRange [ Range ]
      fhir:Transport.input.valueRatio [ Ratio ]
      fhir:Transport.input.valueRatioRange [ RatioRange ]
      fhir:Transport.input.valueReference [ Reference ]
      fhir:Transport.input.valueSampledData [ SampledData ]
      fhir:Transport.input.valueSignature [ Signature ]
      fhir:Transport.input.valueTiming [ Timing ]
      fhir:Transport.input.valueContactDetail [ ContactDetail ]
      fhir:Transport.input.valueDataRequirement [ DataRequirement ]
      fhir:Transport.input.valueExpression [ Expression ]
      fhir:Transport.input.valueParameterDefinition [ ParameterDefinition ]
      fhir:Transport.input.valueRelatedArtifact [ RelatedArtifact ]
      fhir:Transport.input.valueTriggerDefinition [ TriggerDefinition ]
      fhir:Transport.input.valueUsageContext [ UsageContext ]
      fhir:Transport.input.valueAvailability [ Availability ]
      fhir:Transport.input.valueExtendedContactDetail [ ExtendedContactDetail ]
      fhir:Transport.input.valueDosage [ Dosage ]
      fhir:Transport.input.valueMeta [ Meta ]
  ], ...;
  fhir:Transport.output [ # 0..* Information produced as part of transport
    fhir:Transport.output.type [ CodeableConcept ]; # 1..1 Label for output
    # Transport.output.value[x] : 1..1 Result of output. One of these 54
      fhir:Transport.output.valueBase64Binary [ base64Binary ]
      fhir:Transport.output.valueBoolean [ boolean ]
      fhir:Transport.output.valueCanonical [ canonical ]
      fhir:Transport.output.valueCode [ code ]
      fhir:Transport.output.valueDate [ date ]
      fhir:Transport.output.valueDateTime [ dateTime ]
      fhir:Transport.output.valueDecimal [ decimal ]
      fhir:Transport.output.valueId [ id ]
      fhir:Transport.output.valueInstant [ instant ]
      fhir:Transport.output.valueInteger [ integer ]
      fhir:Transport.output.valueInteger64 [ integer64 ]
      fhir:Transport.output.valueMarkdown [ markdown ]
      fhir:Transport.output.valueOid [ oid ]
      fhir:Transport.output.valuePositiveInt [ positiveInt ]
      fhir:Transport.output.valueString [ string ]
      fhir:Transport.output.valueTime [ time ]
      fhir:Transport.output.valueUnsignedInt [ unsignedInt ]
      fhir:Transport.output.valueUri [ uri ]
      fhir:Transport.output.valueUrl [ url ]
      fhir:Transport.output.valueUuid [ uuid ]
      fhir:Transport.output.valueAddress [ Address ]
      fhir:Transport.output.valueAge [ Age ]
      fhir:Transport.output.valueAnnotation [ Annotation ]
      fhir:Transport.output.valueAttachment [ Attachment ]
      fhir:Transport.output.valueCodeableConcept [ CodeableConcept ]
      fhir:Transport.output.valueCodeableReference [ CodeableReference ]
      fhir:Transport.output.valueCoding [ Coding ]
      fhir:Transport.output.valueContactPoint [ ContactPoint ]
      fhir:Transport.output.valueCount [ Count ]
      fhir:Transport.output.valueDistance [ Distance ]
      fhir:Transport.output.valueDuration [ Duration ]
      fhir:Transport.output.valueHumanName [ HumanName ]
      fhir:Transport.output.valueIdentifier [ Identifier ]
      fhir:Transport.output.valueMoney [ Money ]
      fhir:Transport.output.valuePeriod [ Period ]
      fhir:Transport.output.valueQuantity [ Quantity ]
      fhir:Transport.output.valueRange [ Range ]
      fhir:Transport.output.valueRatio [ Ratio ]
      fhir:Transport.output.valueRatioRange [ RatioRange ]
      fhir:Transport.output.valueReference [ Reference ]
      fhir:Transport.output.valueSampledData [ SampledData ]
      fhir:Transport.output.valueSignature [ Signature ]
      fhir:Transport.output.valueTiming [ Timing ]
      fhir:Transport.output.valueContactDetail [ ContactDetail ]
      fhir:Transport.output.valueDataRequirement [ DataRequirement ]
      fhir:Transport.output.valueExpression [ Expression ]
      fhir:Transport.output.valueParameterDefinition [ ParameterDefinition ]
      fhir:Transport.output.valueRelatedArtifact [ RelatedArtifact ]
      fhir:Transport.output.valueTriggerDefinition [ TriggerDefinition ]
      fhir:Transport.output.valueUsageContext [ UsageContext ]
      fhir:Transport.output.valueAvailability [ Availability ]
      fhir:Transport.output.valueExtendedContactDetail [ ExtendedContactDetail ]
      fhir:Transport.output.valueDosage [ Dosage ]
      fhir:Transport.output.valueMeta [ Meta ]
  ], ...;
  fhir:Transport.requestedLocation [ Reference(Location) ]; # 1..1 The desired location
  fhir:Transport.currentLocation [ Reference(Location) ]; # 1..1 The current location
  fhir:Transport.history [ Reference(Transport) ]; # 0..1 Parent (or preceding) transport
]

Changes since R4

This resource did not exist in Release 3

This analysis is available as XML or JSON.

Structure

NameFlagsCard.TypeDescription & Constraintsdoco
.. Transport TUDomainResourceDelivery of item

Elements defined in Ancestors: id, meta, implicitRules, language, text, contained, extension, modifierExtension
... identifier 0..*IdentifierExternal identifier

... instantiatesCanonical Σ0..1canonical(ActivityDefinition)Formal definition of transport
... instantiatesUri Σ0..1uriFormal definition of transport
... basedOn Σ0..*Reference(Any)Request fulfilled by this transport

... groupIdentifier Σ0..1IdentifierRequisition or grouper id
... partOf Σ0..*Reference(Transport | Contract)Part of referenced event

... status ?!Σ0..1codein-progress | completed | abandoned | cancelled | planned | entered-in-error
TransportStatus (Required)
... statusReason Σ0..1CodeableConceptReason for current status
TransportStatusReason (Example)
... intent Σ1..1codeunknown | proposal | plan | order | original-order | reflex-order | filler-order | instance-order | option
TransportIntent (Required)
... priority 0..1coderoutine | urgent | asap | stat
RequestPriority (Required)
... code Σ0..1CodeableConceptTransport Type
Transport Codes (Example)
... description Σ0..1stringHuman-readable explanation of transport
... focus Σ0..1Reference(Any)What transport is acting on
... for Σ0..1Reference(Any)Beneficiary of the Transport
... encounter Σ0..1Reference(Encounter)Healthcare event during which this transport originated
... completionTime Σ0..1dateTimeCompletion time of the event (the occurrence)
... authoredOn 0..1dateTimeTransport Creation Date
... lastModified Σ0..1dateTimeTransport Last Modified Date
... requester Σ0..1Reference(Device | Organization | Patient | Practitioner | PractitionerRole | RelatedPerson)Who is asking for transport to be done
... performerType 0..*CodeableConceptRequested performer
Procedure Performer Role Codes (Preferred)

... owner Σ0..1Reference(Practitioner | PractitionerRole | Organization | CareTeam | HealthcareService | Patient | Device | RelatedPerson)Responsible individual
... location Σ0..1Reference(Location)Where transport occurs
... reasonCode 0..1CodeableConceptWhy transport is needed
TransportReason (Example)
... reasonReference 0..1Reference(Any)Why transport is needed
... insurance 0..*Reference(Coverage | ClaimResponse)Associated insurance coverage

... note 0..*AnnotationComments made about the transport

... relevantHistory 0..*Reference(Provenance)Key events in history of the Transport

... restriction 0..1BackboneElementConstraints on fulfillment transports
.... repetitions 0..1positiveIntHow many times to repeat
.... period 0..1PeriodWhen fulfillment sought
.... recipient 0..*Reference(Patient | Practitioner | PractitionerRole | RelatedPerson | Group | Organization)For whom is fulfillment sought?

... input 0..*BackboneElementInformation used to perform transport

.... type 1..1CodeableConceptLabel for the input
TransportInputParameterType (Example)
.... value[x] 1..1*Content to use in performing the transport
... output 0..*BackboneElementInformation produced as part of transport

.... type 1..1CodeableConceptLabel for output
TransportOutputParameterType (Example)
.... value[x] 1..1*Result of output
... requestedLocation Σ1..1Reference(Location)The desired location
... currentLocation Σ1..1Reference(Location)The current location
... history 0..1Reference(Transport)Parent (or preceding) transport

doco Documentation for this format

See the Extensions for this resource

UML Diagram (Legend)

Transport (DomainResource)Identifier for the transport event that is used to identify it across multiple disparate systemsidentifier : Identifier [0..*]The URL pointing to a *FHIR*-defined protocol, guideline, orderset or other definition that is adhered to in whole or in part by this TransportinstantiatesCanonical : canonical [0..1] « ActivityDefinition »The URL pointing to an *externally* maintained protocol, guideline, orderset or other definition that is adhered to in whole or in part by this TransportinstantiatesUri : uri [0..1]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 labbasedOn : Reference [0..*] « Any »An identifier that links together multiple transports and other requests that were created in the same contextgroupIdentifier : Identifier [0..1]A larger event of which this particular event is a component or steppartOf : Reference [0..*] « Transport|Contract »A code specifying the state of the transport event (this element modifies the meaning of other elements)status : code [0..1] « null (Strength=Required)TransportStatus! »An explanation as to why this transport is held, failed, was refused, etcstatusReason : CodeableConcept [0..1] « null (Strength=Example)TransportStatusReason?? »Indicates the "level" of actionability associated with the Transport, i.e. i+R[9]Cs this a proposed transport, a planned transport, an actionable transport, etcintent : code [1..1] « null (Strength=Required)TransportIntent! »Indicates how quickly the Transport should be addressed with respect to other requestspriority : code [0..1] « null (Strength=Required)RequestPriority! »A name or code (or both) briefly describing what the transport involvescode : CodeableConcept [0..1] « null (Strength=Example)TransportCode?? »A free-text description of what is to be performeddescription : string [0..1]The request being actioned or the resource being manipulated by this transportfocus : Reference [0..1] « Any »The entity who benefits from the performance of the service specified in the transport (e.g., the patient)for : Reference [0..1] « Any »The healthcare event (e.g. a patient and healthcare provider interaction) during which this transport was createdencounter : Reference [0..1] « Encounter »Identifies the completion time of the event (the occurrence)completionTime : dateTime [0..1]The date and time this transport was createdauthoredOn : dateTime [0..1]The date and time of last modification to this transportlastModified : dateTime [0..1]The creator of the transportrequester : Reference [0..1] « Device|Organization|Patient| Practitioner|PractitionerRole|RelatedPerson »The kind of participant that should perform the transportperformerType : CodeableConcept [0..*] « null (Strength=Preferred)ProcedurePerformerRoleCodes? »Individual organization or Device currently responsible for transport executionowner : Reference [0..1] « Practitioner|PractitionerRole| Organization|CareTeam|HealthcareService|Patient|Device| RelatedPerson »Principal physical location where this transport is performedlocation : Reference [0..1] « Location »A description or code indicating why this transport needs to be performedreasonCode : CodeableConcept [0..1] « null (Strength=Example)TransportReason?? »A resource reference indicating why this transport needs to be performedreasonReference : Reference [0..1] « Any »Insurance plans, coverage extensions, pre-authorizations and/or pre-determinations that may be relevant to the Transportinsurance : Reference [0..*] « Coverage|ClaimResponse »Free-text information captured about the transport as it progressesnote : Annotation [0..*]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 transportrelevantHistory : Reference [0..*] « Provenance »The desired or final location for the transportrequestedLocation : Reference [1..1] « Location »The current location for the entity to be transportedcurrentLocation : Reference [1..1] « Location »The transport event prior to this onehistory : Reference [0..1] « Transport »RestrictionIndicates the number of times the requested action should occurrepetitions : positiveInt [0..1]Over what time-period is fulfillment soughtperiod : Period [0..1]For requests that are targeted to more than one potential recipient/target, to identify who is fulfillment is sought forrecipient : Reference [0..*] « Patient|Practitioner|PractitionerRole| RelatedPerson|Group|Organization »ParameterA code or description indicating how the input is intended to be used as part of the transport executiontype : CodeableConcept [1..1] « null (Strength=Example)TransportInputParameterType?? »The value of the input parameter as a basic typevalue[x] : * [1..1]OutputThe name of the Output parametertype : CodeableConcept [1..1] « null (Strength=Example)TransportOutputParameterType?? »The value of the Output parameter as a basic typevalue[x] : * [1..1]If the Transport.focus is a request resource and the transport is seeking fulfillment (i.e. is asking for the request to be actioned), this element identifies any limitations on what parts of the referenced request should be actionedrestriction[0..1]Additional information that may be needed in the execution of the transportinput[0..*]Outputs produced by the Transportoutput[0..*]

XML Template

<Transport xmlns="http://hl7.org/fhir"> doco
 <!-- from Resource: id, meta, implicitRules, and language -->
 <!-- from DomainResource: text, contained, extension, and modifierExtension -->
 <identifier><!-- 0..* Identifier External identifier --></identifier>
 <instantiatesCanonical><!-- 0..1 canonical(ActivityDefinition) Formal definition of transport --></instantiatesCanonical>
 <instantiatesUri value="[uri]"/><!-- 0..1 Formal definition of transport -->
 <basedOn><!-- 0..* Reference(Any) Request fulfilled by this transport --></basedOn>
 <groupIdentifier><!-- 0..1 Identifier Requisition or grouper id --></groupIdentifier>
 <partOf><!-- 0..* Reference(Contract|Transport) Part of referenced event --></partOf>
 <status value="[code]"/><!-- 0..1 in-progress | completed | abandoned | cancelled | planned | entered-in-error -->
 <statusReason><!-- 0..1 CodeableConcept Reason for current status --></statusReason>
 <intent value="[code]"/><!-- 1..1 unknown | proposal | plan | order | original-order | reflex-order | filler-order | instance-order | option -->
 <priority value="[code]"/><!-- 0..1 routine | urgent | asap | stat -->
 <code><!-- 0..1 CodeableConcept Transport Type --></code>
 <description value="[string]"/><!-- 0..1 Human-readable explanation of transport -->
 <focus><!-- 0..1 Reference(Any) What transport is acting on --></focus>
 <for><!-- 0..1 Reference(Any) Beneficiary of the Transport --></for>
 <encounter><!-- 0..1 Reference(Encounter) Healthcare event during which this transport originated --></encounter>
 <completionTime value="[dateTime]"/><!-- 0..1 Completion time of the event (the occurrence) -->
 <authoredOn value="[dateTime]"/><!-- 0..1 Transport Creation Date -->
 <lastModified value="[dateTime]"/><!-- 0..1 Transport Last Modified Date -->
 <requester><!-- 0..1 Reference(Device|Organization|Patient|Practitioner|
   PractitionerRole|RelatedPerson) Who is asking for transport to be done --></requester>
 <performerType><!-- 0..* CodeableConcept Requested performer --></performerType>
 <owner><!-- 0..1 Reference(CareTeam|Device|HealthcareService|Organization|
   Patient|Practitioner|PractitionerRole|RelatedPerson) Responsible individual --></owner>
 <location><!-- 0..1 Reference(Location) Where transport occurs --></location>
 <reasonCode><!-- 0..1 CodeableConcept Why transport is needed --></reasonCode>
 <reasonReference><!-- 0..1 Reference(Any) Why transport is needed --></reasonReference>
 <insurance><!-- 0..* Reference(ClaimResponse|Coverage) Associated insurance coverage --></insurance>
 <note><!-- 0..* Annotation Comments made about the transport --></note>
 <relevantHistory><!-- 0..* Reference(Provenance) Key events in history of the Transport --></relevantHistory>
 <restriction>  <!-- 0..1 Constraints on fulfillment transports -->
  <repetitions value="[positiveInt]"/><!-- 0..1 How many times to repeat -->
  <period><!-- 0..1 Period When fulfillment sought --></period>
  <recipient><!-- 0..* Reference(Group|Organization|Patient|Practitioner|
    PractitionerRole|RelatedPerson) For whom is fulfillment sought? --></recipient>
 </restriction>
 <input>  <!-- 0..* Information used to perform transport -->
  <type><!-- 1..1 CodeableConcept Label for the input --></type>
  <value[x]><!-- 1..1 * Content to use in performing the transport --></value[x]>
 </input>
 <output>  <!-- 0..* Information produced as part of transport -->
  <type><!-- 1..1 CodeableConcept Label for output --></type>
  <value[x]><!-- 1..1 * Result of output --></value[x]>
 </output>
 <requestedLocation><!-- 1..1 Reference(Location) The desired location --></requestedLocation>
 <currentLocation><!-- 1..1 Reference(Location) The current location --></currentLocation>
 <history><!-- 0..1 Reference(Transport) Parent (or preceding) transport --></history>
</Transport>

JSON Template

{doco
  "resourceType" : "Transport",
  // from Resource: id, meta, implicitRules, and language
  // from DomainResource: text, contained, extension, and modifierExtension
  "identifier" : [{ Identifier }], // External identifier
  "instantiatesCanonical" : "<canonical(ActivityDefinition)>", // Formal definition of transport
  "instantiatesUri" : "<uri>", // Formal definition of transport
  "basedOn" : [{ Reference(Any) }], // Request fulfilled by this transport
  "groupIdentifier" : { Identifier }, // Requisition or grouper id
  "partOf" : [{ Reference(Contract|Transport) }], // Part of referenced event
  "status" : "<code>", // in-progress | completed | abandoned | cancelled | planned | entered-in-error
  "statusReason" : { CodeableConcept }, // Reason for current status
  "intent" : "<code>", // R!  unknown | proposal | plan | order | original-order | reflex-order | filler-order | instance-order | option
  "priority" : "<code>", // routine | urgent | asap | stat
  "code" : { CodeableConcept }, // Transport Type
  "description" : "<string>", // Human-readable explanation of transport
  "focus" : { Reference(Any) }, // What transport is acting on
  "for" : { Reference(Any) }, // Beneficiary of the Transport
  "encounter" : { Reference(Encounter) }, // Healthcare event during which this transport originated
  "completionTime" : "<dateTime>", // Completion time of the event (the occurrence)
  "authoredOn" : "<dateTime>", // Transport Creation Date
  "lastModified" : "<dateTime>", // Transport Last Modified Date
  "requester" : { Reference(Device|Organization|Patient|Practitioner|
   PractitionerRole|RelatedPerson) }, // Who is asking for transport to be done
  "performerType" : [{ CodeableConcept }], // Requested performer
  "owner" : { Reference(CareTeam|Device|HealthcareService|Organization|
   Patient|Practitioner|PractitionerRole|RelatedPerson) }, // Responsible individual
  "location" : { Reference(Location) }, // Where transport occurs
  "reasonCode" : { CodeableConcept }, // Why transport is needed
  "reasonReference" : { Reference(Any) }, // Why transport is needed
  "insurance" : [{ Reference(ClaimResponse|Coverage) }], // Associated insurance coverage
  "note" : [{ Annotation }], // Comments made about the transport
  "relevantHistory" : [{ Reference(Provenance) }], // Key events in history of the Transport
  "restriction" : { // Constraints on fulfillment transports
    "repetitions" : "<positiveInt>", // How many times to repeat
    "period" : { Period }, // When fulfillment sought
    "recipient" : [{ Reference(Group|Organization|Patient|Practitioner|
    PractitionerRole|RelatedPerson) }] // For whom is fulfillment sought?
  },
  "input" : [{ // Information used to perform transport
    "type" : { CodeableConcept }, // R!  Label for the input
    // value[x]: Content to use in performing the transport. One of these 54:
    "valueBase64Binary" : "<base64Binary>"
    "valueBoolean" : <boolean>,
    "valueCanonical" : "<canonical>",
    "valueCode" : "<code>",
    "valueDate" : "<date>",
    "valueDateTime" : "<dateTime>",
    "valueDecimal" : <decimal>,
    "valueId" : "<id>",
    "valueInstant" : "<instant>",
    "valueInteger" : <integer>,
    "valueInteger64" : "<integer64>",
    "valueMarkdown" : "<markdown>",
    "valueOid" : "<oid>",
    "valuePositiveInt" : "<positiveInt>",
    "valueString" : "<string>",
    "valueTime" : "<time>",
    "valueUnsignedInt" : "<unsignedInt>",
    "valueUri" : "<uri>",
    "valueUrl" : "<url>",
    "valueUuid" : "<uuid>",
    "valueAddress" : { Address },
    "valueAge" : { Age },
    "valueAnnotation" : { Annotation },
    "valueAttachment" : { Attachment },
    "valueCodeableConcept" : { CodeableConcept },
    "valueCodeableReference" : { CodeableReference },
    "valueCoding" : { Coding },
    "valueContactPoint" : { ContactPoint },
    "valueCount" : { Count },
    "valueDistance" : { Distance },
    "valueDuration" : { Duration },
    "valueHumanName" : { HumanName },
    "valueIdentifier" : { Identifier },
    "valueMoney" : { Money },
    "valuePeriod" : { Period },
    "valueQuantity" : { Quantity },
    "valueRange" : { Range },
    "valueRatio" : { Ratio },
    "valueRatioRange" : { RatioRange },
    "valueReference" : { Reference },
    "valueSampledData" : { SampledData },
    "valueSignature" : { Signature },
    "valueTiming" : { Timing },
    "valueContactDetail" : { ContactDetail },
    "valueDataRequirement" : { DataRequirement },
    "valueExpression" : { Expression },
    "valueParameterDefinition" : { ParameterDefinition },
    "valueRelatedArtifact" : { RelatedArtifact },
    "valueTriggerDefinition" : { TriggerDefinition },
    "valueUsageContext" : { UsageContext },
    "valueAvailability" : { Availability },
    "valueExtendedContactDetail" : { ExtendedContactDetail },
    "valueDosage" : { Dosage },
    "valueMeta" : { Meta },
  }],
  "output" : [{ // Information produced as part of transport
    "type" : { CodeableConcept }, // R!  Label for output
    // value[x]: Result of output. One of these 54:
    "valueBase64Binary" : "<base64Binary>"
    "valueBoolean" : <boolean>,
    "valueCanonical" : "<canonical>",
    "valueCode" : "<code>",
    "valueDate" : "<date>",
    "valueDateTime" : "<dateTime>",
    "valueDecimal" : <decimal>,
    "valueId" : "<id>",
    "valueInstant" : "<instant>",
    "valueInteger" : <integer>,
    "valueInteger64" : "<integer64>",
    "valueMarkdown" : "<markdown>",
    "valueOid" : "<oid>",
    "valuePositiveInt" : "<positiveInt>",
    "valueString" : "<string>",
    "valueTime" : "<time>",
    "valueUnsignedInt" : "<unsignedInt>",
    "valueUri" : "<uri>",
    "valueUrl" : "<url>",
    "valueUuid" : "<uuid>",
    "valueAddress" : { Address },
    "valueAge" : { Age },
    "valueAnnotation" : { Annotation },
    "valueAttachment" : { Attachment },
    "valueCodeableConcept" : { CodeableConcept },
    "valueCodeableReference" : { CodeableReference },
    "valueCoding" : { Coding },
    "valueContactPoint" : { ContactPoint },
    "valueCount" : { Count },
    "valueDistance" : { Distance },
    "valueDuration" : { Duration },
    "valueHumanName" : { HumanName },
    "valueIdentifier" : { Identifier },
    "valueMoney" : { Money },
    "valuePeriod" : { Period },
    "valueQuantity" : { Quantity },
    "valueRange" : { Range },
    "valueRatio" : { Ratio },
    "valueRatioRange" : { RatioRange },
    "valueReference" : { Reference },
    "valueSampledData" : { SampledData },
    "valueSignature" : { Signature },
    "valueTiming" : { Timing },
    "valueContactDetail" : { ContactDetail },
    "valueDataRequirement" : { DataRequirement },
    "valueExpression" : { Expression },
    "valueParameterDefinition" : { ParameterDefinition },
    "valueRelatedArtifact" : { RelatedArtifact },
    "valueTriggerDefinition" : { TriggerDefinition },
    "valueUsageContext" : { UsageContext },
    "valueAvailability" : { Availability },
    "valueExtendedContactDetail" : { ExtendedContactDetail },
    "valueDosage" : { Dosage },
    "valueMeta" : { Meta },
  }],
  "requestedLocation" : { Reference(Location) }, // R!  The desired location
  "currentLocation" : { Reference(Location) }, // R!  The current location
  "history" : { Reference(Transport) } // Parent (or preceding) transport
}

Turtle Template

@prefix fhir: <http://hl7.org/fhir/> .doco


[ a fhir:Transport;
  fhir:nodeRole fhir:treeRoot; # if this is the parser root

  # from Resource: .id, .meta, .implicitRules, and .language
  # from DomainResource: .text, .contained, .extension, and .modifierExtension
  fhir:Transport.identifier [ Identifier ], ... ; # 0..* External identifier
  fhir:Transport.instantiatesCanonical [ canonical(ActivityDefinition) ]; # 0..1 Formal definition of transport
  fhir:Transport.instantiatesUri [ uri ]; # 0..1 Formal definition of transport
  fhir:Transport.basedOn [ Reference(Any) ], ... ; # 0..* Request fulfilled by this transport
  fhir:Transport.groupIdentifier [ Identifier ]; # 0..1 Requisition or grouper id
  fhir:Transport.partOf [ Reference(Contract|Transport) ], ... ; # 0..* Part of referenced event
  fhir:Transport.status [ code ]; # 0..1 in-progress | completed | abandoned | cancelled | planned | entered-in-error
  fhir:Transport.statusReason [ CodeableConcept ]; # 0..1 Reason for current status
  fhir:Transport.intent [ code ]; # 1..1 unknown | proposal | plan | order | original-order | reflex-order | filler-order | instance-order | option
  fhir:Transport.priority [ code ]; # 0..1 routine | urgent | asap | stat
  fhir:Transport.code [ CodeableConcept ]; # 0..1 Transport Type
  fhir:Transport.description [ string ]; # 0..1 Human-readable explanation of transport
  fhir:Transport.focus [ Reference(Any) ]; # 0..1 What transport is acting on
  fhir:Transport.for [ Reference(Any) ]; # 0..1 Beneficiary of the Transport
  fhir:Transport.encounter [ Reference(Encounter) ]; # 0..1 Healthcare event during which this transport originated
  fhir:Transport.completionTime [ dateTime ]; # 0..1 Completion time of the event (the occurrence)
  fhir:Transport.authoredOn [ dateTime ]; # 0..1 Transport Creation Date
  fhir:Transport.lastModified [ dateTime ]; # 0..1 Transport Last Modified Date
  fhir:Transport.requester [ Reference(Device|Organization|Patient|Practitioner|PractitionerRole|RelatedPerson) ]; # 0..1 Who is asking for transport to be done
  fhir:Transport.performerType [ CodeableConcept ], ... ; # 0..* Requested performer
  fhir:Transport.owner [ Reference(CareTeam|Device|HealthcareService|Organization|Patient|Practitioner|
  PractitionerRole|RelatedPerson) ]; # 0..1 Responsible individual
  fhir:Transport.location [ Reference(Location) ]; # 0..1 Where transport occurs
  fhir:Transport.reasonCode [ CodeableConcept ]; # 0..1 Why transport is needed
  fhir:Transport.reasonReference [ Reference(Any) ]; # 0..1 Why transport is needed
  fhir:Transport.insurance [ Reference(ClaimResponse|Coverage) ], ... ; # 0..* Associated insurance coverage
  fhir:Transport.note [ Annotation ], ... ; # 0..* Comments made about the transport
  fhir:Transport.relevantHistory [ Reference(Provenance) ], ... ; # 0..* Key events in history of the Transport
  fhir:Transport.restriction [ # 0..1 Constraints on fulfillment transports
    fhir:Transport.restriction.repetitions [ positiveInt ]; # 0..1 How many times to repeat
    fhir:Transport.restriction.period [ Period ]; # 0..1 When fulfillment sought
    fhir:Transport.restriction.recipient [ Reference(Group|Organization|Patient|Practitioner|PractitionerRole|RelatedPerson) ], ... ; # 0..* For whom is fulfillment sought?
  ];
  fhir:Transport.input [ # 0..* Information used to perform transport
    fhir:Transport.input.type [ CodeableConcept ]; # 1..1 Label for the input
    # Transport.input.value[x] : 1..1 Content to use in performing the transport. One of these 54
      fhir:Transport.input.valueBase64Binary [ base64Binary ]
      fhir:Transport.input.valueBoolean [ boolean ]
      fhir:Transport.input.valueCanonical [ canonical ]
      fhir:Transport.input.valueCode [ code ]
      fhir:Transport.input.valueDate [ date ]
      fhir:Transport.input.valueDateTime [ dateTime ]
      fhir:Transport.input.valueDecimal [ decimal ]
      fhir:Transport.input.valueId [ id ]
      fhir:Transport.input.valueInstant [ instant ]
      fhir:Transport.input.valueInteger [ integer ]
      fhir:Transport.input.valueInteger64 [ integer64 ]
      fhir:Transport.input.valueMarkdown [ markdown ]
      fhir:Transport.input.valueOid [ oid ]
      fhir:Transport.input.valuePositiveInt [ positiveInt ]
      fhir:Transport.input.valueString [ string ]
      fhir:Transport.input.valueTime [ time ]
      fhir:Transport.input.valueUnsignedInt [ unsignedInt ]
      fhir:Transport.input.valueUri [ uri ]
      fhir:Transport.input.valueUrl [ url ]
      fhir:Transport.input.valueUuid [ uuid ]
      fhir:Transport.input.valueAddress [ Address ]
      fhir:Transport.input.valueAge [ Age ]
      fhir:Transport.input.valueAnnotation [ Annotation ]
      fhir:Transport.input.valueAttachment [ Attachment ]
      fhir:Transport.input.valueCodeableConcept [ CodeableConcept ]
      fhir:Transport.input.valueCodeableReference [ CodeableReference ]
      fhir:Transport.input.valueCoding [ Coding ]
      fhir:Transport.input.valueContactPoint [ ContactPoint ]
      fhir:Transport.input.valueCount [ Count ]
      fhir:Transport.input.valueDistance [ Distance ]
      fhir:Transport.input.valueDuration [ Duration ]
      fhir:Transport.input.valueHumanName [ HumanName ]
      fhir:Transport.input.valueIdentifier [ Identifier ]
      fhir:Transport.input.valueMoney [ Money ]
      fhir:Transport.input.valuePeriod [ Period ]
      fhir:Transport.input.valueQuantity [ Quantity ]
      fhir:Transport.input.valueRange [ Range ]
      fhir:Transport.input.valueRatio [ Ratio ]
      fhir:Transport.input.valueRatioRange [ RatioRange ]
      fhir:Transport.input.valueReference [ Reference ]
      fhir:Transport.input.valueSampledData [ SampledData ]
      fhir:Transport.input.valueSignature [ Signature ]
      fhir:Transport.input.valueTiming [ Timing ]
      fhir:Transport.input.valueContactDetail [ ContactDetail ]
      fhir:Transport.input.valueDataRequirement [ DataRequirement ]
      fhir:Transport.input.valueExpression [ Expression ]
      fhir:Transport.input.valueParameterDefinition [ ParameterDefinition ]
      fhir:Transport.input.valueRelatedArtifact [ RelatedArtifact ]
      fhir:Transport.input.valueTriggerDefinition [ TriggerDefinition ]
      fhir:Transport.input.valueUsageContext [ UsageContext ]
      fhir:Transport.input.valueAvailability [ Availability ]
      fhir:Transport.input.valueExtendedContactDetail [ ExtendedContactDetail ]
      fhir:Transport.input.valueDosage [ Dosage ]
      fhir:Transport.input.valueMeta [ Meta ]
  ], ...;
  fhir:Transport.output [ # 0..* Information produced as part of transport
    fhir:Transport.output.type [ CodeableConcept ]; # 1..1 Label for output
    # Transport.output.value[x] : 1..1 Result of output. One of these 54
      fhir:Transport.output.valueBase64Binary [ base64Binary ]
      fhir:Transport.output.valueBoolean [ boolean ]
      fhir:Transport.output.valueCanonical [ canonical ]
      fhir:Transport.output.valueCode [ code ]
      fhir:Transport.output.valueDate [ date ]
      fhir:Transport.output.valueDateTime [ dateTime ]
      fhir:Transport.output.valueDecimal [ decimal ]
      fhir:Transport.output.valueId [ id ]
      fhir:Transport.output.valueInstant [ instant ]
      fhir:Transport.output.valueInteger [ integer ]
      fhir:Transport.output.valueInteger64 [ integer64 ]
      fhir:Transport.output.valueMarkdown [ markdown ]
      fhir:Transport.output.valueOid [ oid ]
      fhir:Transport.output.valuePositiveInt [ positiveInt ]
      fhir:Transport.output.valueString [ string ]
      fhir:Transport.output.valueTime [ time ]
      fhir:Transport.output.valueUnsignedInt [ unsignedInt ]
      fhir:Transport.output.valueUri [ uri ]
      fhir:Transport.output.valueUrl [ url ]
      fhir:Transport.output.valueUuid [ uuid ]
      fhir:Transport.output.valueAddress [ Address ]
      fhir:Transport.output.valueAge [ Age ]
      fhir:Transport.output.valueAnnotation [ Annotation ]
      fhir:Transport.output.valueAttachment [ Attachment ]
      fhir:Transport.output.valueCodeableConcept [ CodeableConcept ]
      fhir:Transport.output.valueCodeableReference [ CodeableReference ]
      fhir:Transport.output.valueCoding [ Coding ]
      fhir:Transport.output.valueContactPoint [ ContactPoint ]
      fhir:Transport.output.valueCount [ Count ]
      fhir:Transport.output.valueDistance [ Distance ]
      fhir:Transport.output.valueDuration [ Duration ]
      fhir:Transport.output.valueHumanName [ HumanName ]
      fhir:Transport.output.valueIdentifier [ Identifier ]
      fhir:Transport.output.valueMoney [ Money ]
      fhir:Transport.output.valuePeriod [ Period ]
      fhir:Transport.output.valueQuantity [ Quantity ]
      fhir:Transport.output.valueRange [ Range ]
      fhir:Transport.output.valueRatio [ Ratio ]
      fhir:Transport.output.valueRatioRange [ RatioRange ]
      fhir:Transport.output.valueReference [ Reference ]
      fhir:Transport.output.valueSampledData [ SampledData ]
      fhir:Transport.output.valueSignature [ Signature ]
      fhir:Transport.output.valueTiming [ Timing ]
      fhir:Transport.output.valueContactDetail [ ContactDetail ]
      fhir:Transport.output.valueDataRequirement [ DataRequirement ]
      fhir:Transport.output.valueExpression [ Expression ]
      fhir:Transport.output.valueParameterDefinition [ ParameterDefinition ]
      fhir:Transport.output.valueRelatedArtifact [ RelatedArtifact ]
      fhir:Transport.output.valueTriggerDefinition [ TriggerDefinition ]
      fhir:Transport.output.valueUsageContext [ UsageContext ]
      fhir:Transport.output.valueAvailability [ Availability ]
      fhir:Transport.output.valueExtendedContactDetail [ ExtendedContactDetail ]
      fhir:Transport.output.valueDosage [ Dosage ]
      fhir:Transport.output.valueMeta [ Meta ]
  ], ...;
  fhir:Transport.requestedLocation [ Reference(Location) ]; # 1..1 The desired location
  fhir:Transport.currentLocation [ Reference(Location) ]; # 1..1 The current location
  fhir:Transport.history [ Reference(Transport) ]; # 0..1 Parent (or preceding) transport
]

Changes since Release 4

This resource did not exist in Release 3

This analysis is available as XML or JSON.

 

Additional definitions: Master Definition XML + JSON, XML Schema/Schematron + JSON Schema, ShEx (for Turtle) + see the extensions, the spreadsheet version & the dependency analysis

PathDefinitionTypeReference
Transport.status

Status of the transport

RequiredTransportStatus
Transport.statusReason

Status reason of the transport.

ExampleTransportStatusReason
Transport.intent

Distinguishes whether the transport is a proposal, plan or full order.

RequiredTransportIntent
Transport.priority

Identifies the level of importance to be assigned to actioning the request.

RequiredRequestPriority
Transport.code

Codes indicating the type of action that is expected to be performed

ExampleTransportCode
Transport.performerType

This example value set defines the set of codes that can be used to indicate a role of a procedure performer.

PreferredProcedurePerformerRoleCodes
Transport.reasonCode Example??
Transport.input.type Example??
Transport.output.type Example??

Search parameters for this resource. The common parameters also apply. See Searching for more information about searching in REST, messaging, and services.

NameTypeDescriptionExpressionIn Common
identifiertokenExternal identifierTransport.identifier
status Ntokenin-progress | completed | entered-in-errorTransport.status