Data Model Libraries
    Preparing search index...

    Class Transport

    Transport Class

    Record of transport.

    FHIR Specification

    • Short: Delivery of item
    • Definition: Record of transport of item.
    • FHIR Version: 5.0.0

    FHIR Transport

    Hierarchy (View Summary)

    Implements

    Index

    Constructors

    constructor

    Properties

    identifier? instantiatesCanonical? instantiatesUri? basedOn? groupIdentifier? partOf? transportStatusEnum status? statusReason? intent requestPriorityEnum priority? code? description? focus? for_? encounter? completionTime? authoredOn? lastModified? requester? performerType? owner? location? insurance? note? relevantHistory? restriction? input? output? requestedLocation currentLocation reason? history?

    Methods

    parse getIdentifier setIdentifier addIdentifier hasIdentifier getInstantiatesCanonicalElement setInstantiatesCanonicalElement hasInstantiatesCanonicalElement getInstantiatesCanonical setInstantiatesCanonical hasInstantiatesCanonical getInstantiatesUriElement setInstantiatesUriElement hasInstantiatesUriElement getInstantiatesUri setInstantiatesUri hasInstantiatesUri getBasedOn setBasedOn addBasedOn hasBasedOn getGroupIdentifier setGroupIdentifier hasGroupIdentifier getPartOf setPartOf addPartOf hasPartOf getStatusEnumType setStatusEnumType hasStatusEnumType getStatusElement setStatusElement hasStatusElement getStatus setStatus hasStatus getStatusReason setStatusReason hasStatusReason getIntentElement setIntentElement hasIntentElement getIntent setIntent hasIntent getPriorityEnumType setPriorityEnumType hasPriorityEnumType getPriorityElement setPriorityElement hasPriorityElement getPriority setPriority hasPriority getCode setCode hasCode getDescriptionElement setDescriptionElement hasDescriptionElement getDescription setDescription hasDescription getFocus setFocus hasFocus getFor setFor hasFor getEncounter setEncounter hasEncounter getCompletionTimeElement setCompletionTimeElement hasCompletionTimeElement getCompletionTime setCompletionTime hasCompletionTime getAuthoredOnElement setAuthoredOnElement hasAuthoredOnElement getAuthoredOn setAuthoredOn hasAuthoredOn getLastModifiedElement setLastModifiedElement hasLastModifiedElement getLastModified setLastModified hasLastModified getRequester setRequester hasRequester getPerformerType setPerformerType addPerformerType hasPerformerType getOwner setOwner hasOwner getLocation setLocation hasLocation getInsurance setInsurance addInsurance hasInsurance getNote setNote addNote hasNote getRelevantHistory setRelevantHistory addRelevantHistory hasRelevantHistory getRestriction setRestriction hasRestriction getInput setInput addInput hasInput getOutput setOutput addOutput hasOutput getRequestedLocation setRequestedLocation hasRequestedLocation getCurrentLocation setCurrentLocation hasCurrentLocation getReason setReason hasReason getHistory setHistory hasHistory fhirType isEmpty isRequiredFieldsEmpty copy toJSON getText setText hasText getContained setContained addContained hasContained getExtension setExtension hasExtension getExtensionByUrl addExtension removeExtension getModifierExtension setModifierExtension hasModifierExtension getModifierExtensionByUrl addModifierExtension removeModifierExtension resourceType getIdElement setIdElement hasIdElement getId setId hasId getMeta setMeta hasMeta getImplicitRulesElement setImplicitRulesElement hasImplicitRulesElement getImplicitRules setImplicitRules hasImplicitRules getLanguageElement setLanguageElement hasLanguageElement getLanguage setLanguage hasLanguage isResource isDataType isComplexDataType isPrimitive isBooleanPrimitive isStringPrimitive isNumberPrimitive isBigIntPrimitive isDateTimePrimitive copyValues initIdentifier initBasedOn initPartOf initPerformerType initInsurance initNote initRelevantHistory initInput initOutput

    Constructors

    Properties

    identifier?: Identifier[]

    Transport.identifier Element

    FHIR Specification

    • Short: External identifier
    • Definition: Identifier for the transport event that is used to identify it across multiple disparate systems.
    • Comment: This identifier is typically assigned by the dispenser, and may be used to reference the delivery when exchanging information about it with other systems.
    • FHIR Type: Identifier
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: false
    instantiatesCanonical?: CanonicalType

    Transport.instantiatesCanonical Element

    FHIR Specification

    • Short: Formal definition of transport
    • Definition: The URL pointing to a FHIR-defined protocol, guideline, orderset or other definition that is adhered to in whole or in part by this Transport.
    • Requirements: Enables a formal definition of how the transport is to be performed, enabling automation.
    • FHIR Type: canonical
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: true
    instantiatesUri?: UriType

    Transport.instantiatesUri Element

    FHIR Specification

    • Short: Formal definition of transport
    • Definition: The URL pointing to an externally maintained protocol, guideline, orderset or other definition that is adhered to in whole or in part by this Transport.
    • Requirements: Enables a formal definition of how the transport is to be performed (e.g. using BPMN, BPEL, XPDL or other formal notation to be associated with a transport), enabling automation.
    • FHIR Type: uri
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: true
    basedOn?: Reference[]

    Transport.basedOn Element

    FHIR Specification

    • Short: Request fulfilled by this transport
    • Definition: BasedOn refers to a higher-level authorization that triggered the creation of the transport. It references a "request" resource such as a ServiceRequest or Transport, which is distinct from the "request" resource the Transport is seeking to fulfill. This latter resource is referenced by FocusOn. For example, based on a ServiceRequest (= BasedOn), a transport is created to fulfill a procedureRequest ( = FocusOn ) to transport a specimen to the lab.
    • FHIR Type: Reference
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: true
    groupIdentifier?: Identifier

    Transport.groupIdentifier Element

    FHIR Specification

    • Short: Requisition or grouper id
    • Definition: A shared identifier common to multiple independent Request instances that were activated/authorized more or less simultaneously by a single author. The presence of the same identifier on each request ties those requests together and may have business ramifications in terms of reporting of results, billing, etc. E.g. a requisition number shared by a set of lab tests ordered together, or a prescription number shared by all meds ordered at one time.
    • Requirements: Billing and/or reporting can be linked to whether multiple requests were created as a single unit.
    • FHIR Type: Identifier
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: true
    partOf?: Reference[]

    Transport.partOf Element

    FHIR Specification

    • Short: Part of referenced event
    • Definition: A larger event of which this particular event is a component or step.
    • Comment: Not to be used to link an event to an Encounter - use Event.context for that. [The allowed reference resources may be adjusted as appropriate for the event resource].
    • Requirements: E.g. Drug administration as part of a procedure, procedure as part of observation, etc.
    • FHIR Type: Reference
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: true
    transportStatusEnum: TransportStatusEnum

    FHIR CodeSystem: TransportStatus

    TransportStatusEnum

    status?: EnumCodeType

    Transport.status Element

    FHIR Specification

    • Short: in-progress | completed | abandoned | cancelled | planned | entered-in-error
    • Definition: A code specifying the state of the transport event.
    • FHIR Type: code
    • Cardinality: 0..1
    • isModifier: true
    • isModifierReason: 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
    • isSummary: true

    CodeSystem Enumeration: TransportStatusEnum

    statusReason?: CodeableConcept

    Transport.statusReason Element

    FHIR Specification

    • Short: Reason for current status
    • Definition: An explanation as to why this transport is held, failed, was refused, etc.
    • Comment: This applies to the current status. Look at the history of the transport to see reasons for past statuses.
    • FHIR Type: CodeableConcept
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: true
    intent: null | CodeType

    Transport.intent Element

    FHIR Specification

    • Short: unknown | proposal | plan | order | original-order | reflex-order | filler-order | instance-order | option
    • Definition: 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, etc.
    • Comment: This element is immutable. Proposed transports, planned transports, etc. must be distinct instances. In most cases, Transports will have an intent of "order".
    • FHIR Type: code
    • Cardinality: 1..1
    • isModifier: false
    • isSummary: true
    requestPriorityEnum: RequestPriorityEnum

    FHIR CodeSystem: RequestPriority

    RequestPriorityEnum

    priority?: EnumCodeType

    Transport.priority Element

    FHIR Specification

    • Short: routine | urgent | asap | stat
    • Definition: Indicates how quickly the Transport should be addressed with respect to other requests.
    • Requirements: Used to identify the service level expected while performing a transport.
    • FHIR Type: code
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: false

    CodeSystem Enumeration: RequestPriorityEnum

    code?: CodeableConcept

    Transport.code Element

    FHIR Specification

    • Short: Transport Type
    • Definition: A name or code (or both) briefly describing what the transport involves.
    • Comment: The title (eg "My Transports", "Outstanding Transports for Patient X") should go into the code.
    • FHIR Type: CodeableConcept
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: true
    description?: StringType

    Transport.description Element

    FHIR Specification

    • Short: Human-readable explanation of transport
    • Definition: A free-text description of what is to be performed.
    • FHIR Type: string
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: true
    focus?: Reference

    Transport.focus Element

    FHIR Specification

    • Short: What transport is acting on
    • Definition: The request being actioned or the resource being manipulated by this transport.
    • Comment: If multiple resources need to be manipulated, use sub-transports. (This ensures that status can be tracked independently for each referenced resource.).
    • Requirements: Used to identify the thing to be done.
    • FHIR Type: Reference
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: true

    Private Optionalfor_

    for_?: Reference

    Transport.for Element

    FHIR Specification

    • Short: Beneficiary of the Transport
    • Definition: The entity who benefits from the performance of the service specified in the transport (e.g., the patient).
    • Requirements: Used to track transports outstanding for a beneficiary. Do not use to track the transport owner or creator (see owner and creator respectively). This can also affect access control.
    • FHIR Type: Reference
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: true
    encounter?: Reference

    Transport.encounter Element

    FHIR Specification

    • Short: Healthcare event during which this transport originated
    • Definition: The healthcare event (e.g. a patient and healthcare provider interaction) during which this transport was created.
    • Requirements: For some transports it may be important to know the link between the encounter the transport originated within.
    • FHIR Type: Reference
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: true
    completionTime?: DateTimeType

    Transport.completionTime Element

    FHIR Specification

    • Short: Completion time of the event (the occurrence)
    • Definition: Identifies the completion time of the event (the occurrence).
    • FHIR Type: dateTime
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: true
    authoredOn?: DateTimeType

    Transport.authoredOn Element

    FHIR Specification

    • Short: Transport Creation Date
    • Definition: The date and time this transport was created.
    • Requirements: Most often used along with lastUpdated to track duration of the transport to supporting monitoring and management.
    • FHIR Type: dateTime
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: false
    lastModified?: DateTimeType

    Transport.lastModified Element

    FHIR Specification

    • Short: Transport Last Modified Date
    • Definition: The date and time of last modification to this transport.
    • Requirements: Used along with history to track transport activity and time in a particular transport state. This enables monitoring and management.
    • FHIR Type: dateTime
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: true
    requester?: Reference

    Transport.requester Element

    FHIR Specification

    performerType?: CodeableConcept[]

    Transport.performerType Element

    FHIR Specification

    • Short: Requested performer
    • Definition: The kind of participant that should perform the transport.
    • Requirements: Use to distinguish transports on different activity queues.
    • FHIR Type: CodeableConcept
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: false
    owner?: Reference

    Transport.owner Element

    FHIR Specification

    location?: Reference

    Transport.location Element

    FHIR Specification

    • Short: Where transport occurs
    • Definition: Principal physical location where this transport is performed.
    • Requirements: Ties the event to where the records are likely kept and provides context around the event occurrence (e.g. if it occurred inside or outside a dedicated healthcare setting).
    • FHIR Type: Reference
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: true
    insurance?: Reference[]

    Transport.insurance Element

    FHIR Specification

    note?: Annotation[]

    Transport.note Element

    FHIR Specification

    • Short: Comments made about the transport
    • Definition: Free-text information captured about the transport as it progresses.
    • FHIR Type: Annotation
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: false
    relevantHistory?: Reference[]

    Transport.relevantHistory Element

    FHIR Specification

    • Short: Key events in history of the Transport
    • Definition: Links to Provenance records for past versions of this Transport that identify key state transitions or updates that are likely to be relevant to a user looking at the current version of the transport.
    • Comment: 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.
    • FHIR Type: Reference
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: false
    restriction?: TransportRestrictionComponent

    Transport.restriction Element

    FHIR Specification

    • Short: Constraints on fulfillment transports
    • Definition: 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 actioned.
    • Requirements: Sometimes when fulfillment is sought, you don't want full fulfillment.
    • FHIR Type: BackboneElement
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: false
    input?: TransportInputComponent[]

    Transport.input Element

    FHIR Specification

    • Short: Information used to perform transport
    • Definition: Additional information that may be needed in the execution of the transport.
    • Requirements: Resources and data used to perform the transport. This data is used in the business logic of transport execution, and is stored separately because it varies between workflows.
    • FHIR Type: BackboneElement
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: false
    output?: TransportOutputComponent[]

    Transport.output Element

    FHIR Specification

    • Short: Information produced as part of transport
    • Definition: Outputs produced by the Transport.
    • Requirements: Resources and data produced during the execution the transport. This data is generated by the business logic of transport execution, and is stored separately because it varies between workflows.
    • FHIR Type: BackboneElement
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: false
    requestedLocation: null | Reference

    Transport.requestedLocation Element

    FHIR Specification

    currentLocation: null | Reference

    Transport.currentLocation Element

    FHIR Specification

    • Short: The entity current location
    • Definition: The current location for the entity to be transported.
    • FHIR Type: Reference
    • Cardinality: 1..1
    • isModifier: false
    • isSummary: true
    reason?: CodeableReference

    Transport.reason Element

    FHIR Specification

    • Short: Why transport is needed
    • Definition: A resource reference indicating why this transport needs to be performed.
    • Comment: 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.
    • FHIR Type: CodeableReference
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: false
    history?: Reference

    Transport.history Element

    FHIR Specification

    Methods

    • Parse the provided Transport JSON to instantiate the Transport data model.

      Parameters

      • sourceJson: Value

        JSON representing FHIR Transport

      • OptionaloptSourceField: string

        Optional data source field (e.g. <complexTypeName>.<complexTypeFieldName>); defaults to Transport

      Returns undefined | Transport

      Transport data model or undefined for Transport

      JsonError if the provided JSON is not a valid JSON object

    • Assigns the provided Requester object value to the requester property.

      Parameters

      • value: undefined | Reference

        the requester object value

      Returns this

      this

      @ReferenceTargets('Transport.requester', ['Device','Organization','Patient','Practitioner','PractitionerRole','RelatedPerson',])

      InvalidTypeError for invalid data type or reference value

    • Assigns the provided Owner object value to the owner property.

      Parameters

      • value: undefined | Reference

        the owner object value

      Returns this

      this

      @ReferenceTargets('Transport.owner', ['Practitioner','PractitionerRole','Organization','CareTeam','HealthcareService','Patient','Device','RelatedPerson',])

      InvalidTypeError for invalid data type or reference value

    • Assigns the provided RequestedLocation object value to the requestedLocation property.

      Parameters

      • value: undefined | null | Reference

        the requestedLocation object value

      Returns this

      this

      @ReferenceTargets('Transport.requestedLocation', ['Location',])

      InvalidTypeError for invalid data type or reference value

    • Assigns the provided value to the text property.

      Parameters

      Returns this

      this

    • Returns boolean

      true if the text property exists and has a value; false otherwise

    • Assigns the provided Resource array value to the contained property.

      Parameters

      • value: undefined | IResource[]

        the contained array value

      Returns this

      this

    • Returns boolean

      true if the contained property exists and has a value; false otherwise

    • Assigns the provided array of Extension values to the extension property.

      Parameters

      • extension: undefined | IExtension[]

        array of Extensions

      Returns this

      this

    • Determines if the extension property exists.

      Parameters

      • Optionalurl: string

        the url that identifies a specific Extension

      Returns boolean

      true if an Extension has the provided url; false otherwise

      If the url is provided, determines if an Extension having the provided url exists. If the url is not provided, determines if the extension property exists and has any values.

      AssertionError for invalid url

    • Adds the provided Extension to the extension property array.

      Parameters

      • extension: undefined | IExtension

        the Extension value to add to the extension property array

      Returns this

      this

    • Removes the Extension having the provided url from the extension property array.

      Parameters

      • url: string

        the url that identifies a specific Extension to remove

      Returns void

      AssertionError for invalid url

    • Determines if the modifierExtension property exists.

      Parameters

      • Optionalurl: string

        the url that identifies a specific Extension

      Returns boolean

      true if an Extension has the provided url

      If the url is provided, determines if an Extension having the provided url exists. If the url is not provided, determines if the modifierExtension property exists and has any values.

      AssertionError for invalid url

    • Assigns the provided PrimitiveType value to the id property.

      Parameters

      • element: undefined | IdType

        the id value

      Returns this

      this

    • Returns undefined | string

      the id property value as a primitive value

    • Assigns the provided primitive value to the id property.

      Parameters

      • value: undefined | string

        the id value

      Returns this

      this

      PrimitiveTypeError for invalid primitive types

    • Returns boolean

      true if the id property exists and has a value; false otherwise

    • Assigns the provided value to the meta property.

      Parameters

      • value: undefined | Meta

        the meta value

      Returns this

      this

    • Returns boolean

      true if the meta property exists and has a value; false otherwise

    • Assigns the provided primitive value to the implicitRules property.

      Parameters

      • value: undefined | string

        the implicitRules value

      Returns this

      this

      PrimitiveTypeError for invalid primitive types

    • Returns undefined | string

      the language property value as a primitive value

    • Assigns the provided primitive value to the language property.

      Parameters

      • value: undefined | string

        the language value

      Returns this

      this

      PrimitiveTypeError for invalid primitive types

    • Returns boolean

      true if the language property exists and has a value; false otherwise

    • Returns boolean

      true if the instance is a FHIR complex or primitive datatype; false otherwise

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Methods
    parsegetIdentifiersetIdentifieraddIdentifierhasIdentifiergetInstantiatesCanonicalElementsetInstantiatesCanonicalElementhasInstantiatesCanonicalElementgetInstantiatesCanonicalsetInstantiatesCanonicalhasInstantiatesCanonicalgetInstantiatesUriElementsetInstantiatesUriElementhasInstantiatesUriElementgetInstantiatesUrisetInstantiatesUrihasInstantiatesUrigetBasedOnsetBasedOnaddBasedOnhasBasedOngetGroupIdentifiersetGroupIdentifierhasGroupIdentifiergetPartOfsetPartOfaddPartOfhasPartOfgetStatusEnumTypesetStatusEnumTypehasStatusEnumTypegetStatusElementsetStatusElementhasStatusElementgetStatussetStatushasStatusgetStatusReasonsetStatusReasonhasStatusReasongetIntentElementsetIntentElementhasIntentElementgetIntentsetIntenthasIntentgetPriorityEnumTypesetPriorityEnumTypehasPriorityEnumTypegetPriorityElementsetPriorityElementhasPriorityElementgetPrioritysetPriorityhasPrioritygetCodesetCodehasCodegetDescriptionElementsetDescriptionElementhasDescriptionElementgetDescriptionsetDescriptionhasDescriptiongetFocussetFocushasFocusgetForsetForhasForgetEncountersetEncounterhasEncountergetCompletionTimeElementsetCompletionTimeElementhasCompletionTimeElementgetCompletionTimesetCompletionTimehasCompletionTimegetAuthoredOnElementsetAuthoredOnElementhasAuthoredOnElementgetAuthoredOnsetAuthoredOnhasAuthoredOngetLastModifiedElementsetLastModifiedElementhasLastModifiedElementgetLastModifiedsetLastModifiedhasLastModifiedgetRequestersetRequesterhasRequestergetPerformerTypesetPerformerTypeaddPerformerTypehasPerformerTypegetOwnersetOwnerhasOwnergetLocationsetLocationhasLocationgetInsurancesetInsuranceaddInsurancehasInsurancegetNotesetNoteaddNotehasNotegetRelevantHistorysetRelevantHistoryaddRelevantHistoryhasRelevantHistorygetRestrictionsetRestrictionhasRestrictiongetInputsetInputaddInputhasInputgetOutputsetOutputaddOutputhasOutputgetRequestedLocationsetRequestedLocationhasRequestedLocationgetCurrentLocationsetCurrentLocationhasCurrentLocationgetReasonsetReasonhasReasongetHistorysetHistoryhasHistoryfhirTypeisEmptyisRequiredFieldsEmptycopytoJSONgetTextsetTexthasTextgetContainedsetContainedaddContainedhasContainedgetExtensionsetExtensionhasExtensiongetExtensionByUrladdExtensionremoveExtensiongetModifierExtensionsetModifierExtensionhasModifierExtensiongetModifierExtensionByUrladdModifierExtensionremoveModifierExtensionresourceTypegetIdElementsetIdElementhasIdElementgetIdsetIdhasIdgetMetasetMetahasMetagetImplicitRulesElementsetImplicitRulesElementhasImplicitRulesElementgetImplicitRulessetImplicitRuleshasImplicitRulesgetLanguageElementsetLanguageElementhasLanguageElementgetLanguagesetLanguagehasLanguageisResourceisDataTypeisComplexDataTypeisPrimitiveisBooleanPrimitiveisStringPrimitiveisNumberPrimitiveisBigIntPrimitiveisDateTimePrimitivecopyValuesinitIdentifierinitBasedOninitPartOfinitPerformerTypeinitInsuranceinitNoteinitRelevantHistoryinitInputinitOutput