Data Model Libraries
    Preparing search index...

    SupplyDelivery Class

    Record of delivery of what is supplied.

    FHIR Specification

    • Short: Delivery of bulk Supplies
    • Definition: Record of delivery of what is supplied.
    • FHIR Version: 4.0.1

    Hierarchy (View Summary)

    Implements

    Index

    Constructors

    Properties

    Methods

    parse getIdentifier setIdentifier addIdentifier hasIdentifier getBasedOn setBasedOn addBasedOn hasBasedOn getPartOf setPartOf addPartOf hasPartOf getStatusEnumType setStatusEnumType hasStatusEnumType getStatusElement setStatusElement hasStatusElement getStatus setStatus hasStatus getPatient setPatient hasPatient getType setType hasType getSuppliedItem setSuppliedItem hasSuppliedItem getOccurrence setOccurrence hasOccurrence getOccurrenceDateTimeType hasOccurrenceDateTimeType getOccurrencePeriod hasOccurrencePeriod getOccurrenceTiming hasOccurrenceTiming getSupplier setSupplier hasSupplier getDestination setDestination hasDestination getReceiver setReceiver addReceiver hasReceiver fhirType isEmpty 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 isRequiredFieldsEmpty isDataType isComplexDataType isPrimitive isBooleanPrimitive isStringPrimitive isNumberPrimitive isBigIntPrimitive isDateTimePrimitive copyValues initIdentifier initBasedOn initPartOf initReceiver

    Constructors

    Properties

    identifier?: Identifier[]

    SupplyDelivery.identifier Element

    FHIR Specification

    • Short: External identifier
    • Definition: Identifier for the supply delivery 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
    basedOn?: Reference[]

    SupplyDelivery.basedOn Element

    FHIR Specification

    • Short: Fulfills plan, proposal or order
    • Definition: A plan, proposal or order that is fulfilled in whole or in part by this event.
    • Requirements: Allows tracing of authorization for the event and tracking whether proposals/recommendations were acted upon.
    • FHIR Type: Reference
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: true
    partOf?: Reference[]

    SupplyDelivery.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
    supplydeliveryStatusEnum: SupplydeliveryStatusEnum

    FHIR CodeSystem: SupplydeliveryStatus

    status?: EnumCodeType

    SupplyDelivery.status Element

    FHIR Specification

    • Short: in-progress | completed | abandoned | entered-in-error
    • Definition: A code specifying the state of the dispense event.
    • Comment: This element is labeled as a modifier because the status contains codes that mark the resource as not currently valid.
    • 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: SupplydeliveryStatusEnum

    patient?: Reference

    SupplyDelivery.patient Element

    FHIR Specification

    • Short: Patient for whom the item is supplied
    • Definition: A link to a resource representing the person whom the delivered item is for.
    • FHIR Type: Reference
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: false

    SupplyDelivery.type Element

    FHIR Specification

    • Short: Category of dispense event
    • Definition: Indicates the type of dispensing event that is performed. Examples include: Trial Fill, Completion of Trial, Partial Fill, Emergency Fill, Samples, etc.
    • FHIR Type: CodeableConcept
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: false

    SupplyDelivery.suppliedItem Element

    FHIR Specification

    • Short: The item that is delivered or supplied
    • Definition: The item that is being delivered or has been supplied.
    • FHIR Type: BackboneElement
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: false
    occurrence?: IDataType

    SupplyDelivery.occurrence[x] Element

    @ChoiceDataTypesMeta('SupplyDelivery.occurrence[x]', ['dateTime','Period','Timing',]

    FHIR Specification

    • Short: When event occurred
    • Definition: The date or time(s) the activity occurred.
    • Comment: [The list of types may be constrained as appropriate for the type of event].
    • FHIR Types: 'dateTime', 'Period', 'Timing',
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: true
    supplier?: Reference

    SupplyDelivery.supplier Element

    FHIR Specification

    destination?: Reference

    SupplyDelivery.destination Element

    FHIR Specification

    • Short: Where the Supply was sent
    • Definition: Identification of the facility/location where the Supply was shipped to, as part of the dispense event.
    • FHIR Type: Reference
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: false
    receiver?: Reference[]

    SupplyDelivery.receiver Element

    FHIR Specification

    Methods

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

      Parameters

      • sourceJson: Value

        JSON representing FHIR SupplyDelivery

      • OptionaloptSourceField: string

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

      Returns undefined | SupplyDelivery

      SupplyDelivery data model or undefined for SupplyDelivery

      JsonError if the provided JSON is not a valid JSON object

    • 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 and only if the data model has required fields (min cardinality > 0) and at least one of those required fields in the instance is empty; false otherwise

    • Returns boolean

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