Data Model Libraries
    Preparing search index...

    Class MedicationKnowledgeDefinitionalComponent

    MedicationKnowledgeDefinitionalComponent Class

    FHIR Specification

    • Short: Minimal definition information about the medication
    • Definition: Along with the link to a Medicinal Product Definition resource, this information provides common definitional elements that are needed to understand the specific medication that is being described.

    Hierarchy (View Summary)

    Implements

    Index

    Constructors

    Properties

    definition?: Reference[]

    MedicationKnowledge.definitional.definition Element

    FHIR Specification

    doseForm?: CodeableConcept

    MedicationKnowledge.definitional.doseForm Element

    FHIR Specification

    • Short: powder | tablets | capsule +
    • Definition: Describes the form of the item. Powder; tablets; capsule.
    • Comment: When Medication is referenced from MedicationRequest, this is the ordered form. When Medication is referenced within MedicationDispense, this is the dispensed form. When Medication is referenced within MedicationAdministration, this is administered form.
    • FHIR Type: CodeableConcept
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: false
    intendedRoute?: CodeableConcept[]

    MedicationKnowledge.definitional.intendedRoute Element

    FHIR Specification

    • Short: The intended or approved route of administration
    • Definition: The intended or approved route of administration.
    • FHIR Type: CodeableConcept
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: false

    MedicationKnowledge.definitional.ingredient Element

    FHIR Specification

    • Short: Active or inactive ingredient
    • Definition: Identifies a particular constituent of interest in the product.
    • FHIR Type: BackboneElement
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: true

    MedicationKnowledge.definitional.drugCharacteristic Element

    FHIR Specification

    • Short: Specifies descriptive properties of the medicine
    • Definition: Specifies descriptive properties of the medicine, such as color, shape, imprints, etc.
    • FHIR Type: BackboneElement
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: false

    Methods

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

      Parameters

      • sourceJson: Value

        JSON representing FHIR MedicationKnowledgeDefinitionalComponent

      • OptionaloptSourceField: string

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

      Returns undefined | MedicationKnowledgeDefinitionalComponent

      MedicationKnowledgeDefinitionalComponent data model or undefined for MedicationKnowledgeDefinitionalComponent

      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