Release 4B Snapshot #1
Medication DefinitionThis page is part of the FHIR Specification v4.3.0-snapshot1: R4B Snapshot to support the Jan 2022 Connectathon. About the R4B version of FHIR. The current officially released version is 4.3.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.
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 |
 status | ?!Σ | 1..1 | code | draft | active | retired | unknown PublicationStatus (Required) |
 for | Σ | 0..* | Reference(MedicinalProductDefinition | AdministrableProductDefinition | ManufacturedItemDefinition) | The product which this ingredient is a constituent part of |
| 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 |
| allergenicIndicator | Σ | 0..1 | boolean | If the ingredient is a known or suspected allergen |
  manufacturer | Σ | 0..* | BackboneElement | An organization that manufactures this ingredient |
 role | Σ | 0..1 | Coding | The way in which this manufacturer is associated with the ingredient. For example whether it is a possible one (others allowed), or an exclusive authorized one for this ingredient. Note that this is not the manufacturing process role IngredientManufacturerRole (Required) |
 manufacturer | Σ | 1..1 | Reference(Organization) | An organization that manufactures this ingredient |
 substance | Σ | 1..1 | BackboneElement | The substance that comprises this ingredient |
 code | Σ | 1..1 | CodeableReference(SubstanceDefinition) | 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 |
 presentation[x] | Σ | 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 | |
| presentationRatio | Ratio | |||
| presentationRatioRange | RatioRange | |||
| 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[x] | Σ | 0..1 | The strength per unitary volume (or mass) | |
| concentrationRatio | Ratio | |||
| concentrationRatioRange | RatioRange | |||
| 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) | Relevant reference substance |
| strength[x] | Σ | 1..1 | Strength expressed in terms of a reference substance | |
| strengthRatio | Ratio | |||
| strengthRatioRange | RatioRange | |||
| 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 |
| 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> <status value="[code]"/><!-- 1..1 draft | active | retired | unknown --> <for><!-- 0..* Reference(AdministrableProductDefinition| ManufacturedItemDefinition|MedicinalProductDefinition) The product which this ingredient is a constituent part of --></for> <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> <allergenicIndicator value="[boolean]"/><!-- 0..1 If the ingredient is a known or suspected allergen --> <manufacturer> <!-- 0..* An organization that manufactures this ingredient --> <role><!-- 0..1 Coding The way in which this manufacturer is associated with the ingredient. For example whether it is a possible one (others allowed), or an exclusive authorized one for this ingredient. Note that this is not the manufacturing process role
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
"status" : "<code>", // R! draft | active | retired | unknown
"for" : [{ Reference(AdministrableProductDefinition|
ManufacturedItemDefinition|MedicinalProductDefinition) }], // The product which this ingredient is a constituent part of
"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
"allergenicIndicator" : <boolean>, // If the ingredient is a known or suspected allergen
"manufacturer" : [{ // An organization that manufactures this ingredient
"role" : { Coding }, // The way in which this manufacturer is associated with the ingredient. For example whether it is a possible one (others allowed), or an exclusive authorized one for this ingredient. Note that this is not the manufacturing process role
"manufacturer" : { Reference(Organization) } // R! An organization that manufactures this ingredient
}],
"substance" : { // R! The substance that comprises this ingredient
"code" : { CodeableReference(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
// presentation[x]:
The quantity of substance in the unit of presentation, or in the volume (or mass) of the single pharmaceutical product or manufactured item. One of these 2:
"presentationRatio" : { Ratio },
"presentationRatioRange" : { RatioRange },
"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[x]: The strength per unitary volume (or mass). One of these 2:
"concentrationRatio" : { Ratio },
"concentrationRatioRange" : { RatioRange },
"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(SubstanceDefinition) }, // Relevant reference substance
// strength[x]: Strength expressed in terms of a reference substance. One of these 2:
"strengthRatio" : { Ratio },
"strengthRatioRange" : { RatioRange },
"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
}]
}]
}
}
Turtle Template
@prefix fhir: <http://hl7.org/fhir/> .
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 |
| status | ?!Σ | 1..1 | code | draft | active | retired | unknown PublicationStatus (Required) |
| for | Σ | 0..* | Reference(MedicinalProductDefinition | AdministrableProductDefinition | ManufacturedItemDefinition) | The product which this ingredient is a constituent part of |
| 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 |
| allergenicIndicator | Σ | 0..1 | boolean | If the ingredient is a known or suspected allergen |
| manufacturer | Σ | 0..* | BackboneElement | An organization that manufactures this ingredient |
| role | Σ | 0..1 | Coding | The way in which this manufacturer is associated with the ingredient. For example whether it is a possible one (others allowed), or an exclusive authorized one for this ingredient. Note that this is not the manufacturing process role IngredientManufacturerRole (Required) |
| manufacturer | Σ | 1..1 | Reference(Organization) | An organization that manufactures this ingredient |
| substance | Σ | 1..1 | BackboneElement | The substance that comprises this ingredient |
| code | Σ | 1..1 | CodeableReference(SubstanceDefinition) | 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 |
| presentation[x] | Σ | 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 | |
| presentationRatio | Ratio | |||
| presentationRatioRange | RatioRange | |||
| 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[x] | Σ | 0..1 | The strength per unitary volume (or mass) | |
| concentrationRatio | Ratio | |||
| concentrationRatioRange | RatioRange | |||
| 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) | Relevant reference substance |
| strength[x] | Σ | 1..1 | Strength expressed in terms of a reference substance | |
| strengthRatio | Ratio | |||
| strengthRatioRange | RatioRange | |||
| 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 |
| Documentation for this format | ||||
XML Template
<Ingredient xmlns="http://hl7.org/fhir">
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
"status" : "<code>", // R! draft | active | retired | unknown
"for" : [{ Reference(AdministrableProductDefinition|
ManufacturedItemDefinition|MedicinalProductDefinition) }], // The product which this ingredient is a constituent part of
"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
"allergenicIndicator" : <boolean>, // If the ingredient is a known or suspected allergen
"manufacturer" : [{ // An organization that manufactures this ingredient
"role" : { Coding }, // The way in which this manufacturer is associated with the ingredient. For example whether it is a possible one (others allowed), or an exclusive authorized one for this ingredient. Note that this is not the manufacturing process role
"manufacturer" : { Reference(Organization) } // R! An organization that manufactures this ingredient
}],
"substance" : { // R! The substance that comprises this ingredient
"code" : { CodeableReference(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
// presentation[x]:
The quantity of substance in the unit of presentation, or in the volume (or mass) of the single pharmaceutical product or manufactured item. One of these 2:
"presentationRatio" : { Ratio },
"presentationRatioRange" : { RatioRange },
"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[x]: The strength per unitary volume (or mass). One of these 2:
"concentrationRatio" : { Ratio },
"concentrationRatioRange" : { RatioRange },
"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(SubstanceDefinition) }, // Relevant reference substance
// strength[x]: Strength expressed in terms of a reference substance. One of these 2:
"strengthRatio" : { Ratio },
"strengthRatioRange" : { RatioRange },
"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
}]
}]
}
}
Turtle Template
@prefix fhir: <http://hl7.org/fhir/> .
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
| Path | Definition | Type | Reference |
|---|---|---|---|
| Ingredient.status | Required | PublicationStatus | |
| Ingredient.manufacturer.role | Required | http://hl7.org/fhir/ValueSet/ingredient-manufacturer-role |
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 |
| for | reference | The product which this ingredient is a constituent part of | Ingredient.for (AdministrableProductDefinition, ManufacturedItemDefinition, MedicinalProductDefinition) | |
| 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 | |
| role | token | A classification of the ingredient identifying its purpose within the product, e.g. active, inactive | Ingredient.role | |
| 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 |
FHIR ®© HL7.org 2011+. FHIR R4B Ballot #1 hl7.fhir.core#4.3.0-snapshot1 generated on Mon, Dec 20, 2021 14:14+1100.
Links: Search |
Version History |
Table of Contents |
QA Page |
Compare to R4 |
|
Propose a change