Data Model Libraries
    Preparing search index...

    Class MedicationDispenseSubstitutionComponent

    MedicationDispenseSubstitutionComponent Class

    FHIR Specification

    • Short: Whether a substitution was performed on the dispense
    • Definition: Indicates whether or not substitution was made as part of the dispense. In some cases, substitution will be expected but does not happen, in other cases substitution is not expected but does happen. This block explains what substitution did or did not happen and why. If nothing is specified, substitution was not done.

    Hierarchy (View Summary)

    Implements

    Index

    Constructors

    Properties

    wasSubstituted: null | BooleanType

    MedicationDispense.substitution.wasSubstituted Element

    FHIR Specification

    • Short: Whether a substitution was or was not performed on the dispense
    • Definition: True if the dispenser dispensed a different drug or product from what was prescribed.
    • FHIR Type: boolean
    • Cardinality: 1..1
    • isModifier: false
    • isSummary: false

    MedicationDispense.substitution.type Element

    FHIR Specification

    • Short: Code signifying whether a different drug was dispensed from what was prescribed
    • Definition: A code signifying whether a different drug was dispensed from what was prescribed.
    • FHIR Type: CodeableConcept
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: false
    reason?: CodeableConcept[]

    MedicationDispense.substitution.reason Element

    FHIR Specification

    • Short: Why was substitution made
    • Definition: Indicates the reason for the substitution (or lack of substitution) from what was prescribed.
    • FHIR Type: CodeableConcept
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: false
    responsibleParty?: Reference[]

    MedicationDispense.substitution.responsibleParty Element

    FHIR Specification

    Methods

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

      Parameters

      • sourceJson: Value

        JSON representing FHIR MedicationDispenseSubstitutionComponent

      • OptionaloptSourceField: string

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

      Returns undefined | MedicationDispenseSubstitutionComponent

      MedicationDispenseSubstitutionComponent data model or undefined for MedicationDispenseSubstitutionComponent

      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 the instance is a FHIR complex or primitive datatype; false otherwise