Data Model Libraries
    Preparing search index...

    Class MedicinalProductIngredientSpecifiedSubstanceComponent

    MedicinalProductIngredientSpecifiedSubstanceComponent Class

    FHIR Specification

    • Short: A specified substance that comprises this ingredient
    • Definition: A specified substance that comprises this ingredient.

    Hierarchy (View Summary)

    Implements

    Index

    Constructors

    Properties

    code: null | CodeableConcept

    MedicinalProductIngredient.specifiedSubstance.code Element

    FHIR Specification

    • Short: The specified substance
    • Definition: The specified substance.
    • FHIR Type: CodeableConcept
    • Cardinality: 1..1
    • isModifier: false
    • isSummary: true
    group: null | CodeableConcept

    MedicinalProductIngredient.specifiedSubstance.group Element

    FHIR Specification

    • Short: The group of specified substance, e.g. group 1 to 4
    • Definition: The group of specified substance, e.g. group 1 to 4.
    • FHIR Type: CodeableConcept
    • Cardinality: 1..1
    • isModifier: false
    • isSummary: true
    confidentiality?: CodeableConcept

    MedicinalProductIngredient.specifiedSubstance.confidentiality Element

    FHIR Specification

    • Short: Confidentiality level of the specified substance as the ingredient
    • Definition: Confidentiality level of the specified substance as the ingredient.
    • FHIR Type: CodeableConcept
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: true

    MedicinalProductIngredient.specifiedSubstance.strength Element

    FHIR Specification

    • Short: Quantity of the substance or specified substance present in the manufactured item or pharmaceutical product
    • Definition: Quantity of the substance or specified substance present in the manufactured item or pharmaceutical product.
    • FHIR Type: BackboneElement
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: true

    Methods

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

      Parameters

      • sourceJson: Value

        JSON representing FHIR MedicinalProductIngredientSpecifiedSubstanceComponent

      • OptionaloptSourceField: string

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

      Returns undefined | MedicinalProductIngredientSpecifiedSubstanceComponent

      MedicinalProductIngredientSpecifiedSubstanceComponent data model or undefined for MedicinalProductIngredientSpecifiedSubstanceComponent

      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