Data Model Libraries
    Preparing search index...

    IngredientSubstanceComponent Class

    FHIR Specification

    • Short: The substance that comprises this ingredient
    • Definition: The substance that comprises this ingredient.

    Hierarchy (View Summary)

    Implements

    Index

    Constructors

    Properties

    code: null | CodeableReference

    Ingredient.substance.code Element

    FHIR Specification

    • Short: A code or full resource that represents the ingredient substance
    • Definition: A code or full resource that represents the ingredient's substance.
    • FHIR Type: CodeableReference
    • Cardinality: 1..1
    • isModifier: false
    • isSummary: true

    Ingredient.substance.strength Element

    FHIR Specification

    • Short: The quantity of substance, per presentation, or per volume or mass, and type of quantity
    • Definition: The quantity of substance in the unit of presentation, or in the volume (or mass) of the single pharmaceutical product or manufactured item. The allowed repetitions do not represent different strengths, but are different representations - mathematically equivalent - of a single strength.
    • FHIR Type: BackboneElement
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: true

    Methods

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

      Parameters

      • sourceJson: Value

        JSON representing FHIR IngredientSubstanceComponent

      • OptionaloptSourceField: string

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

      Returns undefined | IngredientSubstanceComponent

      IngredientSubstanceComponent data model or undefined for IngredientSubstanceComponent

      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