Data Model Libraries
    Preparing search index...

    Class Ingredient

    Ingredient Class

    An ingredient of a manufactured item or pharmaceutical product.

    FHIR Specification

    • Short: An ingredient of a manufactured item or pharmaceutical product
    • Definition: An ingredient of a manufactured item or pharmaceutical product.
    • FHIR Version: 5.0.0

    FHIR Ingredient

    Hierarchy (View Summary)

    Implements

    Index

    Constructors

    constructor

    Properties

    identifier? publicationStatusEnum status for_? role function_? group? allergenicIndicator? comment? manufacturer? substance

    Methods

    parse getIdentifier setIdentifier hasIdentifier getStatusEnumType setStatusEnumType hasStatusEnumType getStatusElement setStatusElement hasStatusElement getStatus setStatus hasStatus getFor setFor addFor hasFor getRole setRole hasRole getFunction setFunction addFunction hasFunction getGroup setGroup hasGroup getAllergenicIndicatorElement setAllergenicIndicatorElement hasAllergenicIndicatorElement getAllergenicIndicator setAllergenicIndicator hasAllergenicIndicator getCommentElement setCommentElement hasCommentElement getComment setComment hasComment getManufacturer setManufacturer addManufacturer hasManufacturer getSubstance setSubstance hasSubstance fhirType isEmpty isRequiredFieldsEmpty copy toJSON getText setText hasText getContained setContained addContained hasContained getExtension setExtension hasExtension getExtensionByUrl addExtension removeExtension getModifierExtension setModifierExtension hasModifierExtension getModifierExtensionByUrl addModifierExtension removeModifierExtension resourceType getIdElement setIdElement hasIdElement getId setId hasId getMeta setMeta hasMeta getImplicitRulesElement setImplicitRulesElement hasImplicitRulesElement getImplicitRules setImplicitRules hasImplicitRules getLanguageElement setLanguageElement hasLanguageElement getLanguage setLanguage hasLanguage isResource isDataType isComplexDataType isPrimitive isBooleanPrimitive isStringPrimitive isNumberPrimitive isBigIntPrimitive isDateTimePrimitive copyValues initFor initFunction initManufacturer

    Constructors

    Properties

    identifier?: Identifier

    Ingredient.identifier Element

    FHIR Specification

    • Short: An identifier or code by which the ingredient can be referenced
    • Definition: The identifier(s) of this Ingredient that are assigned by business processes and/or used to refer to it when a direct URL reference to the resource itself is not appropriate.
    • FHIR Type: Identifier
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: true
    publicationStatusEnum: PublicationStatusEnum

    FHIR CodeSystem: PublicationStatus

    PublicationStatusEnum

    status: null | EnumCodeType

    Ingredient.status Element

    FHIR Specification

    • Short: draft | active | retired | unknown
    • Definition: The status of this ingredient. Enables tracking the life-cycle of the content.
    • Comment: Allows filtering of ingredient that are appropriate for use versus not.
    • FHIR Type: code
    • Cardinality: 1..1
    • isModifier: true
    • isModifierReason: This is labeled as "Is Modifier" because applications should not use a retired {{title}} without due consideration
    • isSummary: true

    CodeSystem Enumeration: PublicationStatusEnum

    Private Optionalfor_

    for_?: Reference[]

    Ingredient.for Element

    FHIR Specification

    role: null | CodeableConcept

    Ingredient.role Element

    FHIR Specification

    • Short: Purpose of the ingredient within the product, e.g. active, inactive
    • Definition: A classification of the ingredient identifying its purpose within the product, e.g. active, inactive.
    • FHIR Type: CodeableConcept
    • Cardinality: 1..1
    • isModifier: false
    • isSummary: true

    Private Optionalfunction_

    function_?: CodeableConcept[]

    Ingredient.function Element

    FHIR Specification

    • Short: Precise action within the drug product, e.g. antioxidant, alkalizing agent
    • Definition: A classification of the ingredient identifying its precise purpose(s) in the drug product. This extends the Ingredient.role to add more detail. Example: antioxidant, alkalizing agent.
    • FHIR Type: CodeableConcept
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: true
    group?: CodeableConcept

    Ingredient.group Element

    FHIR Specification

    • Short: A classification of the ingredient according to where in the physical item it tends to be used, such the outer shell of a tablet, inner body or ink
    • Definition: A classification of the ingredient according to where in the physical item it tends to be used, such the outer shell of a tablet, inner body or ink.
    • FHIR Type: CodeableConcept
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: true
    allergenicIndicator?: BooleanType

    Ingredient.allergenicIndicator Element

    FHIR Specification

    • Short: If the ingredient is a known or suspected allergen
    • Definition: If the ingredient is a known or suspected allergen. Note that this is a property of the substance, so if a reference to a SubstanceDefinition is used to decribe that (rather than just a code), the allergen information should go there, not here.
    • FHIR Type: boolean
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: true
    comment?: MarkdownType

    Ingredient.comment Element

    FHIR Specification

    • Short: A place for providing any notes that are relevant to the component, e.g. removed during process, adjusted for loss on drying
    • Definition: A place for providing any notes that are relevant to the component, e.g. removed during process, adjusted for loss on drying.
    • FHIR Type: markdown
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: false
    manufacturer?: IngredientManufacturerComponent[]

    Ingredient.manufacturer Element

    FHIR Specification

    • Short: An organization that manufactures this ingredient
    • Definition: The organization(s) that manufacture this ingredient. Can be used to indicate: 1) Organizations we are aware of that manufacture this ingredient 2) Specific Manufacturer(s) currently being used 3) Set of organisations allowed to manufacture this ingredient for this product Users must be clear on the application of context relevant to their use case.
    • FHIR Type: BackboneElement
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: true
    substance: null | IngredientSubstanceComponent

    Ingredient.substance Element

    FHIR Specification

    • Short: The substance that comprises this ingredient
    • Definition: The substance that comprises this ingredient.
    • FHIR Type: BackboneElement
    • Cardinality: 1..1
    • isModifier: false
    • isSummary: true

    Methods

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

      Parameters

      • sourceJson: Value

        JSON representing FHIR Ingredient

      • OptionaloptSourceField: string

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

      Returns undefined | Ingredient

      Ingredient data model or undefined for Ingredient

      JsonError if the provided JSON is not a valid JSON object

    • Assigns the provided Reference array value to the for_ property.

      Parameters

      • value: undefined | Reference[]

        the for array value

      Returns this

      this

      @ReferenceTargets('Ingredient.for', ['MedicinalProductDefinition','AdministrableProductDefinition','ManufacturedItemDefinition',])

      InvalidTypeError for invalid data type or reference value

    • Add the provided Reference value to the for_ array property.

      Parameters

      Returns this

      this

      @ReferenceTargets('Ingredient.for', ['MedicinalProductDefinition','AdministrableProductDefinition','ManufacturedItemDefinition',])

      InvalidTypeError for invalid data type or reference value

    • Assigns the provided value to the text property.

      Parameters

      Returns this

      this

    • Returns boolean

      true if the text property exists and has a value; false otherwise

    • Assigns the provided Resource array value to the contained property.

      Parameters

      • value: undefined | IResource[]

        the contained array value

      Returns this

      this

    • Returns boolean

      true if the contained property exists and has a value; false otherwise

    • Assigns the provided array of Extension values to the extension property.

      Parameters

      • extension: undefined | IExtension[]

        array of Extensions

      Returns this

      this

    • 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

    • 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

    • 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

      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

    • Assigns the provided PrimitiveType value to the id property.

      Parameters

      • element: undefined | IdType

        the id value

      Returns this

      this

    • Returns undefined | string

      the id property value as a primitive value

    • Assigns the provided primitive value to the id property.

      Parameters

      • value: undefined | string

        the id value

      Returns this

      this

      PrimitiveTypeError for invalid primitive types

    • Returns boolean

      true if the id property exists and has a value; false otherwise

    • Assigns the provided value to the meta property.

      Parameters

      • value: undefined | Meta

        the meta value

      Returns this

      this

    • Returns boolean

      true if the meta property exists and has a value; false otherwise

    • Assigns the provided primitive value to the implicitRules property.

      Parameters

      • value: undefined | string

        the implicitRules value

      Returns this

      this

      PrimitiveTypeError for invalid primitive types

    • Returns undefined | string

      the language property value as a primitive value

    • Assigns the provided primitive value to the language property.

      Parameters

      • value: undefined | string

        the language value

      Returns this

      this

      PrimitiveTypeError for invalid primitive types

    • Returns boolean

      true if the language property exists and has a value; 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
    parsegetIdentifiersetIdentifierhasIdentifiergetStatusEnumTypesetStatusEnumTypehasStatusEnumTypegetStatusElementsetStatusElementhasStatusElementgetStatussetStatushasStatusgetForsetForaddForhasForgetRolesetRolehasRolegetFunctionsetFunctionaddFunctionhasFunctiongetGroupsetGrouphasGroupgetAllergenicIndicatorElementsetAllergenicIndicatorElementhasAllergenicIndicatorElementgetAllergenicIndicatorsetAllergenicIndicatorhasAllergenicIndicatorgetCommentElementsetCommentElementhasCommentElementgetCommentsetCommenthasCommentgetManufacturersetManufactureraddManufacturerhasManufacturergetSubstancesetSubstancehasSubstancefhirTypeisEmptyisRequiredFieldsEmptycopytoJSONgetTextsetTexthasTextgetContainedsetContainedaddContainedhasContainedgetExtensionsetExtensionhasExtensiongetExtensionByUrladdExtensionremoveExtensiongetModifierExtensionsetModifierExtensionhasModifierExtensiongetModifierExtensionByUrladdModifierExtensionremoveModifierExtensionresourceTypegetIdElementsetIdElementhasIdElementgetIdsetIdhasIdgetMetasetMetahasMetagetImplicitRulesElementsetImplicitRulesElementhasImplicitRulesElementgetImplicitRulessetImplicitRuleshasImplicitRulesgetLanguageElementsetLanguageElementhasLanguageElementgetLanguagesetLanguagehasLanguageisResourceisDataTypeisComplexDataTypeisPrimitiveisBooleanPrimitiveisStringPrimitiveisNumberPrimitiveisBigIntPrimitiveisDateTimePrimitivecopyValuesinitForinitFunctioninitManufacturer