Data Model Libraries
    Preparing search index...

    Class MedicationKnowledgeMedicineClassificationComponent

    MedicationKnowledgeMedicineClassificationComponent Class

    FHIR Specification

    • Short: Categorization of the medication within a formulary or classification system
    • Definition: Categorization of the medication within a formulary or classification system.

    Hierarchy (View Summary)

    Implements

    Index

    Constructors

    Properties

    type_: null | CodeableConcept

    MedicationKnowledge.medicineClassification.type Element

    FHIR Specification

    • Short: The type of category for the medication (for example, therapeutic classification, therapeutic sub-classification)
    • Definition: The type of category for the medication (for example, therapeutic classification, therapeutic sub-classification).
    • FHIR Type: CodeableConcept
    • Cardinality: 1..1
    • isModifier: false
    • isSummary: false
    source?: IDataType

    MedicationKnowledge.medicineClassification.source[x] Element

    @ChoiceDataTypesMeta('MedicationKnowledge.medicineClassification.source[x]', ['string','uri',]

    FHIR Specification

    • Short: The source of the classification
    • Definition: Either a textual source of the classification or a reference to an online source.
    • FHIR Types: 'string', 'uri',
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: false
    classification?: CodeableConcept[]

    MedicationKnowledge.medicineClassification.classification Element

    FHIR Specification

    • Short: Specific category assigned to the medication
    • Definition: Specific category assigned to the medication (e.g. anti-infective, anti-hypertensive, antibiotic, etc.).
    • FHIR Type: CodeableConcept
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: false

    Methods

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

      Parameters

      • sourceJson: Value

        JSON representing FHIR MedicationKnowledgeMedicineClassificationComponent

      • OptionaloptSourceField: string

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

      Returns undefined | MedicationKnowledgeMedicineClassificationComponent

      MedicationKnowledgeMedicineClassificationComponent data model or undefined for MedicationKnowledgeMedicineClassificationComponent

      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