Data Model Libraries
    Preparing search index...

    Class MedicationKnowledgeDefinitionalIngredientComponent

    MedicationKnowledgeDefinitionalIngredientComponent Class

    FHIR Specification

    • Short: Active or inactive ingredient
    • Definition: Identifies a particular constituent of interest in the product.

    Hierarchy (View Summary)

    Implements

    Index

    Constructors

    Properties

    item: null | CodeableReference

    MedicationKnowledge.definitional.ingredient.item Element

    FHIR Specification

    • Short: Substances contained in the medication
    • Definition: A reference to the resource that provides information about the ingredient.
    • FHIR Type: CodeableReference
    • Cardinality: 1..1
    • isModifier: false
    • isSummary: true

    MedicationKnowledge.definitional.ingredient.type Element

    FHIR Specification

    • Short: A code that defines the type of ingredient, active, base, etc
    • Definition: Indication of whether this ingredient affects the therapeutic action of the drug.
    • FHIR Type: CodeableConcept
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: false
    strength?: IDataType

    MedicationKnowledge.definitional.ingredient.strength[x] Element

    @ChoiceDataTypesMeta('MedicationKnowledge.definitional.ingredient.strength[x]', ['Ratio','CodeableConcept','Quantity',]

    FHIR Specification

    • Short: Quantity of ingredient present
    • Definition: Specifies how many (or how much) of the items there are in this Medication. For example, 250 mg per tablet. This is expressed as a ratio where the numerator is 250mg and the denominator is 1 tablet but can also be expressed a quantity when the denominator is assumed to be 1 tablet.
    • FHIR Types: 'Ratio', 'CodeableConcept', 'Quantity',
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: false

    Methods

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

      Parameters

      • sourceJson: Value

        JSON representing FHIR MedicationKnowledgeDefinitionalIngredientComponent

      • OptionaloptSourceField: string

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

      Returns undefined | MedicationKnowledgeDefinitionalIngredientComponent

      MedicationKnowledgeDefinitionalIngredientComponent data model or undefined for MedicationKnowledgeDefinitionalIngredientComponent

      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