Data Model Libraries
    Preparing search index...

    Class IngredientSubstanceStrengthComponent

    IngredientSubstanceStrengthComponent Class

    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 Ingredient

    Hierarchy (View Summary)

    Implements

    Index

    Constructors

    constructor

    Properties

    presentation? textPresentation? concentration? textConcentration? basis? measurementPoint? country? referenceStrength?

    Methods

    parse getPresentation setPresentation hasPresentation getPresentationRatio hasPresentationRatio getPresentationRatioRange hasPresentationRatioRange getPresentationCodeableConcept hasPresentationCodeableConcept getPresentationQuantity hasPresentationQuantity getTextPresentationElement setTextPresentationElement hasTextPresentationElement getTextPresentation setTextPresentation hasTextPresentation getConcentration setConcentration hasConcentration getConcentrationRatio hasConcentrationRatio getConcentrationRatioRange hasConcentrationRatioRange getConcentrationCodeableConcept hasConcentrationCodeableConcept getConcentrationQuantity hasConcentrationQuantity getTextConcentrationElement setTextConcentrationElement hasTextConcentrationElement getTextConcentration setTextConcentration hasTextConcentration getBasis setBasis hasBasis getMeasurementPointElement setMeasurementPointElement hasMeasurementPointElement getMeasurementPoint setMeasurementPoint hasMeasurementPoint getCountry setCountry addCountry hasCountry getReferenceStrength setReferenceStrength addReferenceStrength hasReferenceStrength fhirType isEmpty copy toJSON getModifierExtension setModifierExtension hasModifierExtension getModifierExtensionByUrl addModifierExtension removeModifierExtension getId setId hasId getExtension setExtension hasExtension getExtensionByUrl addExtension removeExtension isRequiredFieldsEmpty isResource isDataType isComplexDataType isPrimitive isBooleanPrimitive isStringPrimitive isNumberPrimitive isBigIntPrimitive isDateTimePrimitive copyValues initCountry initReferenceStrength

    Constructors

    Properties

    presentation?: IDataType

    Ingredient.substance.strength.presentation[x] Element

    @ChoiceDataTypesMeta('Ingredient.substance.strength.presentation[x]', ['Ratio','RatioRange','CodeableConcept','Quantity',]

    FHIR Specification

    • Short: The quantity of substance in the unit of presentation
    • Definition: The quantity of substance in the unit of presentation, or in the volume (or mass) of the single pharmaceutical product or manufactured item. Unit of presentation refers to the quantity that the item occurs in e.g. a strength per tablet size, perhaps 'per 20mg' (the size of the tablet). It is not generally normalized as a unitary unit, which would be 'per mg').
    • FHIR Types: 'Ratio', 'RatioRange', 'CodeableConcept', 'Quantity',
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: true
    textPresentation?: StringType

    Ingredient.substance.strength.textPresentation Element

    FHIR Specification

    • Short: Text of either the whole presentation strength or a part of it (rest being in Strength.presentation as a ratio)
    • Definition: A textual represention of either the whole of the presentation strength or a part of it - with the rest being in Strength.presentation as a ratio.
    • FHIR Type: string
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: true
    concentration?: IDataType

    Ingredient.substance.strength.concentration[x] Element

    @ChoiceDataTypesMeta('Ingredient.substance.strength.concentration[x]', ['Ratio','RatioRange','CodeableConcept','Quantity',]

    FHIR Specification

    • Short: The strength per unitary volume (or mass)
    • Definition: The strength per unitary volume (or mass).
    • FHIR Types: 'Ratio', 'RatioRange', 'CodeableConcept', 'Quantity',
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: true
    textConcentration?: StringType

    Ingredient.substance.strength.textConcentration Element

    FHIR Specification

    • Short: Text of either the whole concentration strength or a part of it (rest being in Strength.concentration as a ratio)
    • Definition: A textual represention of either the whole of the concentration strength or a part of it - with the rest being in Strength.concentration as a ratio.
    • FHIR Type: string
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: true
    basis?: CodeableConcept

    Ingredient.substance.strength.basis Element

    FHIR Specification

    • Short: A code that indicates if the strength is, for example, based on the ingredient substance as stated or on the substance base (when the ingredient is a salt)
    • Definition: A code that indicates if the strength is, for example, based on the ingredient substance as stated or on the substance base (when the ingredient is a salt).
    • FHIR Type: CodeableConcept
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: true
    measurementPoint?: StringType

    Ingredient.substance.strength.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. There are products where strength is measured at a particular point. For example, the strength of the ingredient in some inhalers is measured at a particular position relative to the point of aerosolization.
    • FHIR Type: string
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: true
    country?: CodeableConcept[]

    Ingredient.substance.strength.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
    referenceStrength?: IngredientSubstanceStrengthReferenceStrengthComponent[]

    Ingredient.substance.strength.referenceStrength Element

    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.
    • FHIR Type: BackboneElement
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: true

    Methods

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

      Parameters

      • sourceJson: Value

        JSON representing FHIR IngredientSubstanceStrengthComponent

      • OptionaloptSourceField: string

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

      Returns undefined | IngredientSubstanceStrengthComponent

      IngredientSubstanceStrengthComponent data model or undefined for IngredientSubstanceStrengthComponent

      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

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Methods
    parsegetPresentationsetPresentationhasPresentationgetPresentationRatiohasPresentationRatiogetPresentationRatioRangehasPresentationRatioRangegetPresentationCodeableConcepthasPresentationCodeableConceptgetPresentationQuantityhasPresentationQuantitygetTextPresentationElementsetTextPresentationElementhasTextPresentationElementgetTextPresentationsetTextPresentationhasTextPresentationgetConcentrationsetConcentrationhasConcentrationgetConcentrationRatiohasConcentrationRatiogetConcentrationRatioRangehasConcentrationRatioRangegetConcentrationCodeableConcepthasConcentrationCodeableConceptgetConcentrationQuantityhasConcentrationQuantitygetTextConcentrationElementsetTextConcentrationElementhasTextConcentrationElementgetTextConcentrationsetTextConcentrationhasTextConcentrationgetBasissetBasishasBasisgetMeasurementPointElementsetMeasurementPointElementhasMeasurementPointElementgetMeasurementPointsetMeasurementPointhasMeasurementPointgetCountrysetCountryaddCountryhasCountrygetReferenceStrengthsetReferenceStrengthaddReferenceStrengthhasReferenceStrengthfhirTypeisEmptycopytoJSONgetModifierExtensionsetModifierExtensionhasModifierExtensiongetModifierExtensionByUrladdModifierExtensionremoveModifierExtensiongetIdsetIdhasIdgetExtensionsetExtensionhasExtensiongetExtensionByUrladdExtensionremoveExtensionisRequiredFieldsEmptyisResourceisDataTypeisComplexDataTypeisPrimitiveisBooleanPrimitiveisStringPrimitiveisNumberPrimitiveisBigIntPrimitiveisDateTimePrimitivecopyValuesinitCountryinitReferenceStrength