This page is part of the FHIR Specification v4.1.0: R4B Ballot. About the R4B version of FHIR. The current version which supercedes this version is 5.0.0. For a full list of available versions, see the Directory of published versions . Page versions: R5 R4B
Biomedical Research and Regulation Work Group | Maturity Level: 1 | Trial Use | Security Category: Anonymous | Compartments: Not linked to any defined compartments |
An ingredient of a manufactured item or pharmaceutical product.
For an overview of this resource and others in the Medication Definition domain, also see the module page
A material used in the preparation of a medicinal/pharmaceutical product, within the context of a particular use or role.
An ingredient is part of a product, either alone or in combination with other ingredients. It is essentially a substance with the addition of the specific role it is playing in the product, or in preparation of the product which may include whether it is an active or inactive substance and what the strength is (the quantity of substance compared to the whole product). The ingredient is represented in the context of a given product, because its role and strength are a function of what it is used in/for. It is expected that the same substance used in a different role, or with a different strength, would be a different Ingredient resource instance. Resource instances may however be shared by very similar products (e.g. different pack sizes of the same "product").
Some other resources, such as Medication and Substance allow specifying a basic ingredient representation. When more detail is needed such as for manufacturing or regulatory use, use the Ingredient resource.
This resource is referenced by ActivityDefinition and AdministrableProductDefinition.
This resource does not implement any patterns.
Structure
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Ingredient | TU | DomainResource | An ingredient of a manufactured item or pharmaceutical product Elements defined in Ancestors: id, meta, implicitRules, language, text, contained, extension, modifierExtension | |
identifier | Σ | 0..1 | Identifier | An identifier or code by which the ingredient can be referenced |
role | Σ | 1..1 | CodeableConcept | A classification of the ingredient identifying its purpose within the product, e.g. active, inactive |
function | Σ | 0..* | CodeableConcept | 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 |
description | Σ | 0..1 | markdown | A general description of the ingredient, or any supporting text. May be used for an unstructured list of excipients |
allergenicIndicator | Σ | 0..1 | boolean | If the ingredient is a known or suspected allergen |
manufacturer | Σ | 0..* | Reference(Organization) | The organization that manufactures this ingredient |
substance | Σ | 0..1 | BackboneElement | The substance that comprises this ingredient |
code | Σ | 1..1 | CodeableReference(SubstanceDefinition | Substance) | A code or full resource that represents the ingredient substance |
strength | Σ | 0..* | BackboneElement | The quantity of substance in the unit of presentation, or in the volume (or mass) of the single pharmaceutical product or manufactured item. When there is a range of strengths, this represents the lower limit |
presentation | Σ | 0..1 | Ratio | The quantity of substance in the unit of presentation, or in the volume (or mass) of the single pharmaceutical product or manufactured item |
presentationHighLimit | ?!Σ | 0..1 | Ratio | An upper limit for the quantity of substance in the unit of presentation. When there is a range of strengths, this represents the upper limit |
presentationText | Σ | 0..1 | string | 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 |
concentration | Σ | 0..1 | Ratio | The strength per unitary volume (or mass) |
concentrationHighLimit | ?!Σ | 0..1 | Ratio | An upper limit for the strength per unitary volume (or mass), for when there is a range. The concentration attribute then becomes the lower limit |
concentrationText | Σ | 0..1 | string | 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 |
measurementPoint | Σ | 0..1 | string | For when strength is measured at a particular point or distance |
country | Σ | 0..* | CodeableConcept | The country or countries for which the strength range applies |
referenceStrength | Σ | 0..* | BackboneElement | Strength expressed in terms of a reference substance |
substance | Σ | 0..1 | CodeableReference(SubstanceDefinition | Substance) | Relevant reference substance |
strength | Σ | 1..1 | Ratio | Strength expressed in terms of a reference substance. When there is a range of strengths, this represents the lower limit |
strengthHighLimit | Σ | 0..1 | Ratio | Strength expressed in terms of a reference substance. When there is a range of strengths, this represents the upper limit |
measurementPoint | Σ | 0..1 | string | For when strength is measured at a particular point or distance |
country | Σ | 0..* | CodeableConcept | The country or countries for which the strength range applies |
specifiedSubstance | Σ | 0..* | BackboneElement | A specified substance that comprises this ingredient |
code | Σ | 1..1 | CodeableReference(SubstanceDefinition | Substance) | Substance as a 'specified substance', implying extra substance related characteristics |
group | Σ | 1..1 | CodeableConcept | The group of specified substance, e.g. group 1 to 4, where the group categorises the level of description of the substance according to standardised sets of properties |
confidentiality | Σ | 0..1 | CodeableConcept | Confidentiality level of the specified substance as the ingredient |
strength | Σ | 0..* | see strength | Quantity of the substance or specified substance present in the manufactured item or pharmaceutical product |
Documentation for this format |
UML Diagram (Legend)
XML Template
<Ingredient xmlns="http://hl7.org/fhir"> <!-- from Resource: id, meta, implicitRules, and language --> <!-- from DomainResource: text, contained, extension, and modifierExtension --> <identifier><!-- 0..1 Identifier An identifier or code by which the ingredient can be referenced --></identifier> <role><!-- 1..1 CodeableConcept A classification of the ingredient identifying its purpose within the product, e.g. active, inactive --></role> <function><!-- 0..* CodeableConcept 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 --></function> <description value="[markdown]"/><!-- 0..1 A general description of the ingredient, or any supporting text. May be used for an unstructured list of excipients --> <allergenicIndicator value="[boolean]"/><!-- 0..1 If the ingredient is a known or suspected allergen --> <manufacturer><!-- 0..* Reference(Organization) The organization that manufactures this ingredient --></manufacturer> <substance> <!-- 0..1 The substance that comprises this ingredient --> <code><!-- 1..1 CodeableReference(Substance|SubstanceDefinition) A code or full resource that represents the ingredient substance --></code> <strength> <!-- 0..* The quantity of substance in the unit of presentation, or in the volume (or mass) of the single pharmaceutical product or manufactured item. When there is a range of strengths, this represents the lower limit --> <presentation><!-- 0..1 Ratio The quantity of substance in the unit of presentation, or in the volume (or mass) of the single pharmaceutical product or manufactured item --></presentation> <presentationHighLimit><!-- 0..1 Ratio An upper limit for the quantity of substance in the unit of presentation. When there is a range of strengths, this represents the upper limit --></presentationHighLimit> <presentationText value="[string]"/><!-- 0..1 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 --> <concentration><!-- 0..1 Ratio The strength per unitary volume (or mass) --></concentration> <concentrationHighLimit><!-- 0..1 Ratio An upper limit for the strength per unitary volume (or mass), for when there is a range. The concentration attribute then becomes the lower limit --></concentrationHighLimit> <concentrationText value="[string]"/><!-- 0..1 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 --> <measurementPoint value="[string]"/><!-- 0..1 For when strength is measured at a particular point or distance --> <country><!-- 0..* CodeableConcept The country or countries for which the strength range applies --></country> <referenceStrength> <!-- 0..* Strength expressed in terms of a reference substance --> <substance><!-- 0..1 CodeableReference(Substance|SubstanceDefinition) Relevant reference substance --></substance> <strength><!-- 1..1 Ratio Strength expressed in terms of a reference substance. When there is a range of strengths, this represents the lower limit --></strength> <strengthHighLimit><!-- 0..1 Ratio Strength expressed in terms of a reference substance. When there is a range of strengths, this represents the upper limit --></strengthHighLimit> <measurementPoint value="[string]"/><!-- 0..1 For when strength is measured at a particular point or distance --> <country><!-- 0..* CodeableConcept The country or countries for which the strength range applies --></country> </referenceStrength> </strength> </substance> <specifiedSubstance> <!-- 0..* A specified substance that comprises this ingredient --> <code><!-- 1..1 CodeableReference(Substance|SubstanceDefinition) Substance as a 'specified substance', implying extra substance related characteristics --></code> <group><!-- 1..1 CodeableConcept The group of specified substance, e.g. group 1 to 4, where the group categorises the level of description of the substance according to standardised sets of properties --></group> <confidentiality><!-- 0..1 CodeableConcept Confidentiality level of the specified substance as the ingredient --></confidentiality> <strength><!-- 0..* Content as for Ingredient.substance.strength Quantity of the substance or specified substance present in the manufactured item or pharmaceutical product --></strength> </specifiedSubstance> </Ingredient>
JSON Template
{ "resourceType" : "Ingredient", // from Resource: id, meta, implicitRules, and language // from DomainResource: text, contained, extension, and modifierExtension "identifier" : { Identifier }, // An identifier or code by which the ingredient can be referenced "role" : { CodeableConcept }, // R! A classification of the ingredient identifying its purpose within the product, e.g. active, inactive "function" : [{ CodeableConcept }], // 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 "description" : "<markdown>", // A general description of the ingredient, or any supporting text. May be used for an unstructured list of excipients "allergenicIndicator" : <boolean>, // If the ingredient is a known or suspected allergen "manufacturer" : [{ Reference(Organization) }], // The organization that manufactures this ingredient "substance" : { // The substance that comprises this ingredient "code" : { CodeableReference(Substance|SubstanceDefinition) }, // R! A code or full resource that represents the ingredient substance "strength" : [{ // The quantity of substance in the unit of presentation, or in the volume (or mass) of the single pharmaceutical product or manufactured item. When there is a range of strengths, this represents the lower limit "presentation" : { Ratio }, // The quantity of substance in the unit of presentation, or in the volume (or mass) of the single pharmaceutical product or manufactured item "presentationHighLimit" : { Ratio }, // An upper limit for the quantity of substance in the unit of presentation. When there is a range of strengths, this represents the upper limit "presentationText" : "<string>", // 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 "concentration" : { Ratio }, // The strength per unitary volume (or mass) "concentrationHighLimit" : { Ratio }, // An upper limit for the strength per unitary volume (or mass), for when there is a range. The concentration attribute then becomes the lower limit "concentrationText" : "<string>", // 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 "measurementPoint" : "<string>", // For when strength is measured at a particular point or distance "country" : [{ CodeableConcept }], // The country or countries for which the strength range applies "referenceStrength" : [{ // Strength expressed in terms of a reference substance "substance" : { CodeableReference(Substance|SubstanceDefinition) }, // Relevant reference substance "strength" : { Ratio }, // R! Strength expressed in terms of a reference substance. When there is a range of strengths, this represents the lower limit "strengthHighLimit" : { Ratio }, // Strength expressed in terms of a reference substance. When there is a range of strengths, this represents the upper limit "measurementPoint" : "<string>", // For when strength is measured at a particular point or distance "country" : [{ CodeableConcept }] // The country or countries for which the strength range applies }] }] }, "specifiedSubstance" : [{ // A specified substance that comprises this ingredient "code" : { CodeableReference(Substance|SubstanceDefinition) }, // R! Substance as a 'specified substance', implying extra substance related characteristics "group" : { CodeableConcept }, // R! The group of specified substance, e.g. group 1 to 4, where the group categorises the level of description of the substance according to standardised sets of properties "confidentiality" : { CodeableConcept }, // Confidentiality level of the specified substance as the ingredient "strength" : [{ Content as for Ingredient.substance.strength }] // Quantity of the substance or specified substance present in the manufactured item or pharmaceutical product }] }
Turtle Template
@prefix fhir: <http://hl7.org/fhir/> . [ a fhir:Ingredient; fhir:nodeRole fhir:treeRoot; # if this is the parser root # from Resource: .id, .meta, .implicitRules, and .language # from DomainResource: .text, .contained, .extension, and .modifierExtension fhir:Ingredient.identifier [ Identifier ]; # 0..1 An identifier or code by which the ingredient can be referenced fhir:Ingredient.role [ CodeableConcept ]; # 1..1 A classification of the ingredient identifying its purpose within the product, e.g. active, inactive fhir:Ingredient.function [ CodeableConcept ], ... ; # 0..* 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:Ingredient.description [ markdown ]; # 0..1 A general description of the ingredient, or any supporting text. May be used for an unstructured list of excipients fhir:Ingredient.allergenicIndicator [ boolean ]; # 0..1 If the ingredient is a known or suspected allergen fhir:Ingredient.manufacturer [ Reference(Organization) ], ... ; # 0..* The organization that manufactures this ingredient fhir:Ingredient.substance [ # 0..1 The substance that comprises this ingredient fhir:Ingredient.substance.code [ CodeableReference(Substance|SubstanceDefinition) ]; # 1..1 A code or full resource that represents the ingredient substance fhir:Ingredient.substance.strength [ # 0..* The quantity of substance in the unit of presentation, or in the volume (or mass) of the single pharmaceutical product or manufactured item. When there is a range of strengths, this represents the lower limit fhir:Ingredient.substance.strength.presentation [ Ratio ]; # 0..1 The quantity of substance in the unit of presentation, or in the volume (or mass) of the single pharmaceutical product or manufactured item fhir:Ingredient.substance.strength.presentationHighLimit [ Ratio ]; # 0..1 An upper limit for the quantity of substance in the unit of presentation. When there is a range of strengths, this represents the upper limit fhir:Ingredient.substance.strength.presentationText [ string ]; # 0..1 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:Ingredient.substance.strength.concentration [ Ratio ]; # 0..1 The strength per unitary volume (or mass) fhir:Ingredient.substance.strength.concentrationHighLimit [ Ratio ]; # 0..1 An upper limit for the strength per unitary volume (or mass), for when there is a range. The concentration attribute then becomes the lower limit fhir:Ingredient.substance.strength.concentrationText [ string ]; # 0..1 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:Ingredient.substance.strength.measurementPoint [ string ]; # 0..1 For when strength is measured at a particular point or distance fhir:Ingredient.substance.strength.country [ CodeableConcept ], ... ; # 0..* The country or countries for which the strength range applies fhir:Ingredient.substance.strength.referenceStrength [ # 0..* Strength expressed in terms of a reference substance fhir:Ingredient.substance.strength.referenceStrength.substance [ CodeableReference(Substance|SubstanceDefinition) ]; # 0..1 Relevant reference substance fhir:Ingredient.substance.strength.referenceStrength.strength [ Ratio ]; # 1..1 Strength expressed in terms of a reference substance. When there is a range of strengths, this represents the lower limit fhir:Ingredient.substance.strength.referenceStrength.strengthHighLimit [ Ratio ]; # 0..1 Strength expressed in terms of a reference substance. When there is a range of strengths, this represents the upper limit fhir:Ingredient.substance.strength.referenceStrength.measurementPoint [ string ]; # 0..1 For when strength is measured at a particular point or distance fhir:Ingredient.substance.strength.referenceStrength.country [ CodeableConcept ], ... ; # 0..* The country or countries for which the strength range applies ], ...; ], ...; ]; fhir:Ingredient.specifiedSubstance [ # 0..* A specified substance that comprises this ingredient fhir:Ingredient.specifiedSubstance.code [ CodeableReference(Substance|SubstanceDefinition) ]; # 1..1 Substance as a 'specified substance', implying extra substance related characteristics fhir:Ingredient.specifiedSubstance.group [ CodeableConcept ]; # 1..1 The group of specified substance, e.g. group 1 to 4, where the group categorises the level of description of the substance according to standardised sets of properties fhir:Ingredient.specifiedSubstance.confidentiality [ CodeableConcept ]; # 0..1 Confidentiality level of the specified substance as the ingredient fhir:Ingredient.specifiedSubstance.strength [ See Ingredient.substance.strength ], ... ; # 0..* Quantity of the substance or specified substance present in the manufactured item or pharmaceutical product ], ...; ]
Structure
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Ingredient | TU | DomainResource | An ingredient of a manufactured item or pharmaceutical product Elements defined in Ancestors: id, meta, implicitRules, language, text, contained, extension, modifierExtension | |
identifier | Σ | 0..1 | Identifier | An identifier or code by which the ingredient can be referenced |
role | Σ | 1..1 | CodeableConcept | A classification of the ingredient identifying its purpose within the product, e.g. active, inactive |
function | Σ | 0..* | CodeableConcept | 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 |
description | Σ | 0..1 | markdown | A general description of the ingredient, or any supporting text. May be used for an unstructured list of excipients |
allergenicIndicator | Σ | 0..1 | boolean | If the ingredient is a known or suspected allergen |
manufacturer | Σ | 0..* | Reference(Organization) | The organization that manufactures this ingredient |
substance | Σ | 0..1 | BackboneElement | The substance that comprises this ingredient |
code | Σ | 1..1 | CodeableReference(SubstanceDefinition | Substance) | A code or full resource that represents the ingredient substance |
strength | Σ | 0..* | BackboneElement | The quantity of substance in the unit of presentation, or in the volume (or mass) of the single pharmaceutical product or manufactured item. When there is a range of strengths, this represents the lower limit |
presentation | Σ | 0..1 | Ratio | The quantity of substance in the unit of presentation, or in the volume (or mass) of the single pharmaceutical product or manufactured item |
presentationHighLimit | ?!Σ | 0..1 | Ratio | An upper limit for the quantity of substance in the unit of presentation. When there is a range of strengths, this represents the upper limit |
presentationText | Σ | 0..1 | string | 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 |
concentration | Σ | 0..1 | Ratio | The strength per unitary volume (or mass) |
concentrationHighLimit | ?!Σ | 0..1 | Ratio | An upper limit for the strength per unitary volume (or mass), for when there is a range. The concentration attribute then becomes the lower limit |
concentrationText | Σ | 0..1 | string | 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 |
measurementPoint | Σ | 0..1 | string | For when strength is measured at a particular point or distance |
country | Σ | 0..* | CodeableConcept | The country or countries for which the strength range applies |
referenceStrength | Σ | 0..* | BackboneElement | Strength expressed in terms of a reference substance |
substance | Σ | 0..1 | CodeableReference(SubstanceDefinition | Substance) | Relevant reference substance |
strength | Σ | 1..1 | Ratio | Strength expressed in terms of a reference substance. When there is a range of strengths, this represents the lower limit |
strengthHighLimit | Σ | 0..1 | Ratio | Strength expressed in terms of a reference substance. When there is a range of strengths, this represents the upper limit |
measurementPoint | Σ | 0..1 | string | For when strength is measured at a particular point or distance |
country | Σ | 0..* | CodeableConcept | The country or countries for which the strength range applies |
specifiedSubstance | Σ | 0..* | BackboneElement | A specified substance that comprises this ingredient |
code | Σ | 1..1 | CodeableReference(SubstanceDefinition | Substance) | Substance as a 'specified substance', implying extra substance related characteristics |
group | Σ | 1..1 | CodeableConcept | The group of specified substance, e.g. group 1 to 4, where the group categorises the level of description of the substance according to standardised sets of properties |
confidentiality | Σ | 0..1 | CodeableConcept | Confidentiality level of the specified substance as the ingredient |
strength | Σ | 0..* | see strength | Quantity of the substance or specified substance present in the manufactured item or pharmaceutical product |
Documentation for this format |
XML Template
<Ingredient xmlns="http://hl7.org/fhir"> <!-- from Resource: id, meta, implicitRules, and language --> <!-- from DomainResource: text, contained, extension, and modifierExtension --> <identifier><!-- 0..1 Identifier An identifier or code by which the ingredient can be referenced --></identifier> <role><!-- 1..1 CodeableConcept A classification of the ingredient identifying its purpose within the product, e.g. active, inactive --></role> <function><!-- 0..* CodeableConcept 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 --></function> <description value="[markdown]"/><!-- 0..1 A general description of the ingredient, or any supporting text. May be used for an unstructured list of excipients --> <allergenicIndicator value="[boolean]"/><!-- 0..1 If the ingredient is a known or suspected allergen --> <manufacturer><!-- 0..* Reference(Organization) The organization that manufactures this ingredient --></manufacturer> <substance> <!-- 0..1 The substance that comprises this ingredient --> <code><!-- 1..1 CodeableReference(Substance|SubstanceDefinition) A code or full resource that represents the ingredient substance --></code> <strength> <!-- 0..* The quantity of substance in the unit of presentation, or in the volume (or mass) of the single pharmaceutical product or manufactured item. When there is a range of strengths, this represents the lower limit --> <presentation><!-- 0..1 Ratio The quantity of substance in the unit of presentation, or in the volume (or mass) of the single pharmaceutical product or manufactured item --></presentation> <presentationHighLimit><!-- 0..1 Ratio An upper limit for the quantity of substance in the unit of presentation. When there is a range of strengths, this represents the upper limit --></presentationHighLimit> <presentationText value="[string]"/><!-- 0..1 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 --> <concentration><!-- 0..1 Ratio The strength per unitary volume (or mass) --></concentration> <concentrationHighLimit><!-- 0..1 Ratio An upper limit for the strength per unitary volume (or mass), for when there is a range. The concentration attribute then becomes the lower limit --></concentrationHighLimit> <concentrationText value="[string]"/><!-- 0..1 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 --> <measurementPoint value="[string]"/><!-- 0..1 For when strength is measured at a particular point or distance --> <country><!-- 0..* CodeableConcept The country or countries for which the strength range applies --></country> <referenceStrength> <!-- 0..* Strength expressed in terms of a reference substance --> <substance><!-- 0..1 CodeableReference(Substance|SubstanceDefinition) Relevant reference substance --></substance> <strength><!-- 1..1 Ratio Strength expressed in terms of a reference substance. When there is a range of strengths, this represents the lower limit --></strength> <strengthHighLimit><!-- 0..1 Ratio Strength expressed in terms of a reference substance. When there is a range of strengths, this represents the upper limit --></strengthHighLimit> <measurementPoint value="[string]"/><!-- 0..1 For when strength is measured at a particular point or distance --> <country><!-- 0..* CodeableConcept The country or countries for which the strength range applies --></country> </referenceStrength> </strength> </substance> <specifiedSubstance> <!-- 0..* A specified substance that comprises this ingredient --> <code><!-- 1..1 CodeableReference(Substance|SubstanceDefinition) Substance as a 'specified substance', implying extra substance related characteristics --></code> <group><!-- 1..1 CodeableConcept The group of specified substance, e.g. group 1 to 4, where the group categorises the level of description of the substance according to standardised sets of properties --></group> <confidentiality><!-- 0..1 CodeableConcept Confidentiality level of the specified substance as the ingredient --></confidentiality> <strength><!-- 0..* Content as for Ingredient.substance.strength Quantity of the substance or specified substance present in the manufactured item or pharmaceutical product --></strength> </specifiedSubstance> </Ingredient>
JSON Template
{ "resourceType" : "Ingredient", // from Resource: id, meta, implicitRules, and language // from DomainResource: text, contained, extension, and modifierExtension "identifier" : { Identifier }, // An identifier or code by which the ingredient can be referenced "role" : { CodeableConcept }, // R! A classification of the ingredient identifying its purpose within the product, e.g. active, inactive "function" : [{ CodeableConcept }], // 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 "description" : "<markdown>", // A general description of the ingredient, or any supporting text. May be used for an unstructured list of excipients "allergenicIndicator" : <boolean>, // If the ingredient is a known or suspected allergen "manufacturer" : [{ Reference(Organization) }], // The organization that manufactures this ingredient "substance" : { // The substance that comprises this ingredient "code" : { CodeableReference(Substance|SubstanceDefinition) }, // R! A code or full resource that represents the ingredient substance "strength" : [{ // The quantity of substance in the unit of presentation, or in the volume (or mass) of the single pharmaceutical product or manufactured item. When there is a range of strengths, this represents the lower limit "presentation" : { Ratio }, // The quantity of substance in the unit of presentation, or in the volume (or mass) of the single pharmaceutical product or manufactured item "presentationHighLimit" : { Ratio }, // An upper limit for the quantity of substance in the unit of presentation. When there is a range of strengths, this represents the upper limit "presentationText" : "<string>", // 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 "concentration" : { Ratio }, // The strength per unitary volume (or mass) "concentrationHighLimit" : { Ratio }, // An upper limit for the strength per unitary volume (or mass), for when there is a range. The concentration attribute then becomes the lower limit "concentrationText" : "<string>", // 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 "measurementPoint" : "<string>", // For when strength is measured at a particular point or distance "country" : [{ CodeableConcept }], // The country or countries for which the strength range applies "referenceStrength" : [{ // Strength expressed in terms of a reference substance "substance" : { CodeableReference(Substance|SubstanceDefinition) }, // Relevant reference substance "strength" : { Ratio }, // R! Strength expressed in terms of a reference substance. When there is a range of strengths, this represents the lower limit "strengthHighLimit" : { Ratio }, // Strength expressed in terms of a reference substance. When there is a range of strengths, this represents the upper limit "measurementPoint" : "<string>", // For when strength is measured at a particular point or distance "country" : [{ CodeableConcept }] // The country or countries for which the strength range applies }] }] }, "specifiedSubstance" : [{ // A specified substance that comprises this ingredient "code" : { CodeableReference(Substance|SubstanceDefinition) }, // R! Substance as a 'specified substance', implying extra substance related characteristics "group" : { CodeableConcept }, // R! The group of specified substance, e.g. group 1 to 4, where the group categorises the level of description of the substance according to standardised sets of properties "confidentiality" : { CodeableConcept }, // Confidentiality level of the specified substance as the ingredient "strength" : [{ Content as for Ingredient.substance.strength }] // Quantity of the substance or specified substance present in the manufactured item or pharmaceutical product }] }
Turtle Template
@prefix fhir: <http://hl7.org/fhir/> . [ a fhir:Ingredient; fhir:nodeRole fhir:treeRoot; # if this is the parser root # from Resource: .id, .meta, .implicitRules, and .language # from DomainResource: .text, .contained, .extension, and .modifierExtension fhir:Ingredient.identifier [ Identifier ]; # 0..1 An identifier or code by which the ingredient can be referenced fhir:Ingredient.role [ CodeableConcept ]; # 1..1 A classification of the ingredient identifying its purpose within the product, e.g. active, inactive fhir:Ingredient.function [ CodeableConcept ], ... ; # 0..* 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:Ingredient.description [ markdown ]; # 0..1 A general description of the ingredient, or any supporting text. May be used for an unstructured list of excipients fhir:Ingredient.allergenicIndicator [ boolean ]; # 0..1 If the ingredient is a known or suspected allergen fhir:Ingredient.manufacturer [ Reference(Organization) ], ... ; # 0..* The organization that manufactures this ingredient fhir:Ingredient.substance [ # 0..1 The substance that comprises this ingredient fhir:Ingredient.substance.code [ CodeableReference(Substance|SubstanceDefinition) ]; # 1..1 A code or full resource that represents the ingredient substance fhir:Ingredient.substance.strength [ # 0..* The quantity of substance in the unit of presentation, or in the volume (or mass) of the single pharmaceutical product or manufactured item. When there is a range of strengths, this represents the lower limit fhir:Ingredient.substance.strength.presentation [ Ratio ]; # 0..1 The quantity of substance in the unit of presentation, or in the volume (or mass) of the single pharmaceutical product or manufactured item fhir:Ingredient.substance.strength.presentationHighLimit [ Ratio ]; # 0..1 An upper limit for the quantity of substance in the unit of presentation. When there is a range of strengths, this represents the upper limit fhir:Ingredient.substance.strength.presentationText [ string ]; # 0..1 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:Ingredient.substance.strength.concentration [ Ratio ]; # 0..1 The strength per unitary volume (or mass) fhir:Ingredient.substance.strength.concentrationHighLimit [ Ratio ]; # 0..1 An upper limit for the strength per unitary volume (or mass), for when there is a range. The concentration attribute then becomes the lower limit fhir:Ingredient.substance.strength.concentrationText [ string ]; # 0..1 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:Ingredient.substance.strength.measurementPoint [ string ]; # 0..1 For when strength is measured at a particular point or distance fhir:Ingredient.substance.strength.country [ CodeableConcept ], ... ; # 0..* The country or countries for which the strength range applies fhir:Ingredient.substance.strength.referenceStrength [ # 0..* Strength expressed in terms of a reference substance fhir:Ingredient.substance.strength.referenceStrength.substance [ CodeableReference(Substance|SubstanceDefinition) ]; # 0..1 Relevant reference substance fhir:Ingredient.substance.strength.referenceStrength.strength [ Ratio ]; # 1..1 Strength expressed in terms of a reference substance. When there is a range of strengths, this represents the lower limit fhir:Ingredient.substance.strength.referenceStrength.strengthHighLimit [ Ratio ]; # 0..1 Strength expressed in terms of a reference substance. When there is a range of strengths, this represents the upper limit fhir:Ingredient.substance.strength.referenceStrength.measurementPoint [ string ]; # 0..1 For when strength is measured at a particular point or distance fhir:Ingredient.substance.strength.referenceStrength.country [ CodeableConcept ], ... ; # 0..* The country or countries for which the strength range applies ], ...; ], ...; ]; fhir:Ingredient.specifiedSubstance [ # 0..* A specified substance that comprises this ingredient fhir:Ingredient.specifiedSubstance.code [ CodeableReference(Substance|SubstanceDefinition) ]; # 1..1 Substance as a 'specified substance', implying extra substance related characteristics fhir:Ingredient.specifiedSubstance.group [ CodeableConcept ]; # 1..1 The group of specified substance, e.g. group 1 to 4, where the group categorises the level of description of the substance according to standardised sets of properties fhir:Ingredient.specifiedSubstance.confidentiality [ CodeableConcept ]; # 0..1 Confidentiality level of the specified substance as the ingredient fhir:Ingredient.specifiedSubstance.strength [ See Ingredient.substance.strength ], ... ; # 0..* Quantity of the substance or specified substance present in the manufactured item or pharmaceutical product ], ...; ]
See the Profiles & Extensions and the alternate definitions: Master Definition XML + JSON, XML Schema/Schematron + JSON Schema, ShEx (for Turtle) + see the extensions & the dependency analysis
Search parameters for this resource. The common parameters also apply. See Searching for more information about searching in REST, messaging, and services.
Name | Type | Description | Expression | In Common |
function | token | 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 | Ingredient.function | |
identifier | token | An identifier or code by which the ingredient can be referenced | Ingredient.identifier | |
manufacturer | reference | The organization that manufactures this ingredient | Ingredient.manufacturer (Organization) | |
role | token | A classification of the ingredient identifying its purpose within the product, e.g. active, inactive | Ingredient.role | |
specified-substance D | reference | Reference to a resource (by instance) | Ingredient.specifiedSubstance.code.reference | |
specified-substance-code D | token | Reference to a concept (by class) | Ingredient.specifiedSubstance.code.concept | |
specified-substance-definition D | reference | Reference to a resource (by instance) | Ingredient.specifiedSubstance.code.reference | |
substance D | reference | Reference to a resource (by instance) | Ingredient.substance.code.reference | |
substance-code D | token | Reference to a concept (by class) | Ingredient.substance.code.concept | |
substance-definition D | reference | Reference to a resource (by instance) | Ingredient.substance.code.reference |