Data Model Libraries
    Preparing search index...

    Class MedicationKnowledgeDefinitionalDrugCharacteristicComponent

    MedicationKnowledgeDefinitionalDrugCharacteristicComponent Class

    FHIR Specification

    • Short: Specifies descriptive properties of the medicine
    • Definition: Specifies descriptive properties of the medicine, such as color, shape, imprints, etc.

    Hierarchy (View Summary)

    Implements

    Index

    Constructors

    Properties

    MedicationKnowledge.definitional.drugCharacteristic.type Element

    FHIR Specification

    • Short: Code specifying the type of characteristic of medication
    • Definition: A code specifying which characteristic of the medicine is being described (for example, colour, shape, imprint).
    • FHIR Type: CodeableConcept
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: false
    value?: IDataType

    MedicationKnowledge.definitional.drugCharacteristic.value[x] Element

    @ChoiceDataTypesMeta('MedicationKnowledge.definitional.drugCharacteristic.value[x]', ['CodeableConcept','string','Quantity','base64Binary','Attachment',]

    FHIR Specification

    • Short: Description of the characteristic
    • Definition: Description of the characteristic.
    • Comment: The description should be provided as a CodeableConcept, SimpleQuantity or an image. The description can be a string only when these others are not available.
    • FHIR Types: 'CodeableConcept', 'string', 'Quantity', 'base64Binary', 'Attachment',
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: false

    Methods

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

      Parameters

      • sourceJson: Value

        JSON representing FHIR MedicationKnowledgeDefinitionalDrugCharacteristicComponent

      • OptionaloptSourceField: string

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

      Returns undefined | MedicationKnowledgeDefinitionalDrugCharacteristicComponent

      MedicationKnowledgeDefinitionalDrugCharacteristicComponent data model or undefined for MedicationKnowledgeDefinitionalDrugCharacteristicComponent

      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