Data Model Libraries
    Preparing search index...

    Class IngredientSubstanceStrengthReferenceStrengthComponent

    IngredientSubstanceStrengthReferenceStrengthComponent Class

    FHIR Specification

    • Short: Strength expressed in terms of a reference substance
    • Definition: Strength expressed in terms of a reference substance. For when the ingredient strength is additionally expressed as equivalent to the strength of some other closely related substance (e.g. salt vs. base). Reference strength represents the strength (quantitative composition) of the active moiety of the active substance. There are situations when the active substance and active moiety are different, therefore both a strength and a reference strength are needed.

    Hierarchy (View Summary)

    Implements

    Index

    Constructors

    Properties

    substance?: CodeableReference

    Ingredient.substance.strength.referenceStrength.substance Element

    FHIR Specification

    strength: null | IDataType

    Ingredient.substance.strength.referenceStrength.strength[x] Element

    @ChoiceDataTypesMeta('Ingredient.substance.strength.referenceStrength.strength[x]', ['Ratio','RatioRange',]

    FHIR Specification

    • Short: Strength expressed in terms of a reference substance
    • Definition: Strength expressed in terms of a reference substance.
    • FHIR Types: 'Ratio', 'RatioRange',
    • Cardinality: 1..1
    • isModifier: false
    • isSummary: true
    measurementPoint?: StringType

    Ingredient.substance.strength.referenceStrength.measurementPoint Element

    FHIR Specification

    • Short: When strength is measured at a particular point or distance
    • Definition: For when strength is measured at a particular point or distance.
    • FHIR Type: string
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: true
    country?: CodeableConcept[]

    Ingredient.substance.strength.referenceStrength.country Element

    FHIR Specification

    • Short: Where the strength range applies
    • Definition: The country or countries for which the strength range applies.
    • FHIR Type: CodeableConcept
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: true

    Methods

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

      Parameters

      • sourceJson: Value

        JSON representing FHIR IngredientSubstanceStrengthReferenceStrengthComponent

      • OptionaloptSourceField: string

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

      Returns undefined | IngredientSubstanceStrengthReferenceStrengthComponent

      IngredientSubstanceStrengthReferenceStrengthComponent data model or undefined for IngredientSubstanceStrengthReferenceStrengthComponent

      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