Data Model Libraries
    Preparing search index...

    Class SupplyDeliverySuppliedItemComponent

    SupplyDeliverySuppliedItemComponent Class

    FHIR Specification

    • Short: The item that is delivered or supplied
    • Definition: The item that is being delivered or has been supplied.

    Hierarchy (View Summary)

    Implements

    Index

    Constructors

    Properties

    quantity?: Quantity

    SupplyDelivery.suppliedItem.quantity Element

    FHIR Specification

    • Short: Amount supplied
    • Definition: The amount of the item that has been supplied. Unit of measure may be included.
    • FHIR Type: Quantity
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: false
    item?: IDataType

    SupplyDelivery.suppliedItem.item[x] Element

    @ChoiceDataTypesMeta('SupplyDelivery.suppliedItem.item[x]', ['CodeableConcept','Reference',]

    FHIR Specification

    • Short: Medication, Substance, Device or Biologically Derived Product supplied
    • Definition: Identifies the medication, substance, device or biologically derived product being supplied. This is either a link to a resource representing the details of the item or a code that identifies the item from a known list.
    • FHIR Types: 'CodeableConcept', 'Reference',
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: false

    Methods

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

      Parameters

      • sourceJson: Value

        JSON representing FHIR SupplyDeliverySuppliedItemComponent

      • OptionaloptSourceField: string

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

      Returns undefined | SupplyDeliverySuppliedItemComponent

      SupplyDeliverySuppliedItemComponent data model or undefined for SupplyDeliverySuppliedItemComponent

      JsonError if the provided JSON is not a valid JSON object

    • 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; 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 modifierExtension property exists and has any values.

      AssertionError for invalid url

    • Returns undefined | string

      the id property value

    • Assigns the provided value to the id property.

      Parameters

      • value: undefined | string

        the id value

      Returns this

      this

      PrimitiveTypeError for invalid value

    • Returns boolean

      true if id exists and has a value; false otherwise

    • 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

    • Determines if the extension property exists.

      Parameters

      • url: string

        the url that identifies a specific Extension

      Returns undefined | IExtension

      an Extension having 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 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

    • 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