Data Model Libraries
    Preparing search index...

    Class MedicationKnowledgeAdministrationGuidelinesComponent

    MedicationKnowledgeAdministrationGuidelinesComponent Class

    FHIR Specification

    • Short: Guidelines for administration of the medication
    • Definition: Guidelines for the administration of the medication.

    Hierarchy (View Summary)

    Implements

    Index

    Constructors

    Properties

    MedicationKnowledge.administrationGuidelines.dosage Element

    FHIR Specification

    • Short: Dosage for the medication for the specific guidelines
    • Definition: Dosage for the medication for the specific guidelines.
    • FHIR Type: BackboneElement
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: false
    indication?: IDataType

    MedicationKnowledge.administrationGuidelines.indication[x] Element

    @ChoiceDataTypesMeta('MedicationKnowledge.administrationGuidelines.indication[x]', ['CodeableConcept','Reference',]

    FHIR Specification

    • Short: Indication for use that apply to the specific administration guidelines
    • Definition: Indication for use that apply to the specific administration guidelines.
    • FHIR Types: 'CodeableConcept', 'Reference',
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: false

    MedicationKnowledge.administrationGuidelines.patientCharacteristics Element

    FHIR Specification

    • Short: Characteristics of the patient that are relevant to the administration guidelines
    • Definition: Characteristics of the patient that are relevant to the administration guidelines (for example, height, weight, gender, etc.).
    • FHIR Type: BackboneElement
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: false

    Methods

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

      Parameters

      • sourceJson: Value

        JSON representing FHIR MedicationKnowledgeAdministrationGuidelinesComponent

      • OptionaloptSourceField: string

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

      Returns undefined | MedicationKnowledgeAdministrationGuidelinesComponent

      MedicationKnowledgeAdministrationGuidelinesComponent data model or undefined for MedicationKnowledgeAdministrationGuidelinesComponent

      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