Release 5 Draft Ballot

This is the Continuous Integration Build of FHIR (will be incorrect/inconsistent at times).
See the Directory of published versions

15.9 Resource Ingredient - Content

Biomedical Research and Regulation Work GroupMaturity Level: 1 Trial UseSecurity 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

NameFlagsCard.TypeDescription & Constraintsdoco
.. Ingredient TUDomainResourceAn ingredient of a manufactured item or pharmaceutical product
Elements defined in Ancestors: id, meta, implicitRules, language, text, contained, extension, modifierExtension
... identifier Σ0..1IdentifierAn identifier or code by which the ingredient can be referenced
... status ?!Σ1..1codedraft | active | retired | unknown
PublicationStatus (Required)
... for Σ0..*Reference(MedicinalProductDefinition | AdministrableProductDefinition | ManufacturedItemDefinition)The product which this ingredient is a constituent part of
... function Σ0..*CodeableConceptA 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
... group Σ0..1CodeableConceptA 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
... allergenicIndicator Σ0..1booleanIf the ingredient is a known or suspected allergen
... manufacturer Σ0..*BackboneElementAn organization that manufactures this ingredient
.... role Σ0..1CodingThe 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..1Reference(Organization)An organization that manufactures this ingredient
... substance Σ1..1BackboneElementThe substance that comprises this ingredient
.... code Σ1..1CodeableReference(SubstanceDefinition)A code or full resource that represents the ingredient substance
.... strength Σ0..*BackboneElementThe 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..1The quantity of substance in the unit of presentation, or in the volume (or mass) of the single pharmaceutical product or manufactured item
...... presentationRatioRatio
...... presentationRatioRangeRatioRange
...... presentationCodeableConceptCodeableConcept
...... presentationQuantityQuantity
..... presentationText Σ0..1stringA 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..1The strength per unitary volume (or mass)
...... concentrationRatioRatio
...... concentrationRatioRangeRatioRange
...... concentrationCodeableConceptCodeableConcept
...... concentrationQuantityQuantity
..... concentrationText Σ0..1stringA 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
..... basis Σ0..1CodeableConceptA 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)
..... measurementPoint Σ0..1stringFor when strength is measured at a particular point or distance
..... country Σ0..*CodeableConceptThe country or countries for which the strength range applies
..... referenceStrength Σ0..*BackboneElementStrength expressed in terms of a reference substance
...... substance Σ0..1CodeableReference(SubstanceDefinition)Relevant reference substance
...... strength[x] Σ1..1Strength expressed in terms of a reference substance
....... strengthRatioRatio
....... strengthRatioRangeRatioRange
....... strengthQuantityQuantity
...... measurementPoint Σ0..1stringFor when strength is measured at a particular point or distance
...... country Σ0..*CodeableConceptThe country or countries for which the strength range applies

doco Documentation for this format

UML Diagram (Legend)

Ingredient (DomainResource)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 appropriateidentifier : Identifier [0..1]The status of this ingredient. Enables tracking the life-cycle of the content (this element modifies the meaning of other elements)status : code [1..1] « null (Strength=Required)PublicationStatus! »The product which this ingredient is a constituent part offor : Reference [0..*] « MedicinalProductDefinition| AdministrableProductDefinition|ManufacturedItemDefinition »A classification of the ingredient identifying its purpose within the product, e.g. active, inactiverole : CodeableConcept [1..1]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 Agentfunction : CodeableConcept [0..*]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 inkgroup : CodeableConcept [0..1]If the ingredient is a known or suspected allergenallergenicIndicator : boolean [0..1]ManufacturerThe 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 rolerole : Coding [0..1] « null (Strength=Required)IngredientManufacturerRole! »An organization that manufactures this ingredientmanufacturer : Reference [1..1] « Organization »SubstanceA code or full resource that represents the ingredient substancecode : DataType [1..1] « SubstanceDefinition »StrengthThe quantity of substance in the unit of presentation, or in the volume (or mass) of the single pharmaceutical product or manufactured itempresentation[x] : DataType [0..1] « Ratio|RatioRange|CodeableConcept| Quantity »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 ratiopresentationText : string [0..1]The strength per unitary volume (or mass)concentration[x] : DataType [0..1] « Ratio|RatioRange| CodeableConcept|Quantity »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 ratioconcentrationText : string [0..1]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)basis : CodeableConcept [0..1]For when strength is measured at a particular point or distancemeasurementPoint : string [0..1]The country or countries for which the strength range appliescountry : CodeableConcept [0..*]ReferenceStrengthRelevant reference substancesubstance : DataType [0..1] « SubstanceDefinition »Strength expressed in terms of a reference substancestrength[x] : DataType [1..1] « Ratio|RatioRange|Quantity »For when strength is measured at a particular point or distancemeasurementPoint : string [0..1]The country or countries for which the strength range appliescountry : CodeableConcept [0..*]An organization that manufactures this ingredientmanufacturer[0..*]Strength expressed in terms of a reference substancereferenceStrength[0..*]The quantity of substance in the unit of presentation, or in the volume (or mass) of the single pharmaceutical product or manufactured itemstrength[0..*]The substance that comprises this ingredientsubstance[1..1]

XML Template

<Ingredient xmlns="http://hl7.org/fhir"> doco
 <!-- 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>
 <group><!-- 0..1 CodeableConcept 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 --></group>
 <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  --></role>
  <manufacturer><!-- 1..1 Reference(Organization) An organization that manufactures this ingredient --></manufacturer>
 </manufacturer>
 <substance>  <!-- 1..1 The substance that comprises this ingredient -->
  <code><!-- 1..1 CodeableReference(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 -->
   <presentation[x]><!-- 0..1 Ratio|RatioRange|CodeableConcept|Quantity 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]>
   <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[x]><!-- 0..1 Ratio|RatioRange|CodeableConcept|Quantity The strength per unitary volume (or mass) --></concentration[x]>
   <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 -->
   <basis><!-- 0..1 CodeableConcept 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) --></basis>
   <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(SubstanceDefinition) Relevant reference substance --></substance>
    <strength[x]><!-- 1..1 Ratio|RatioRange|Quantity Strength expressed in terms of a reference substance --></strength[x]>
    <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>
</Ingredient>

JSON Template

{doco
  "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
  "group" : { CodeableConcept }, // 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
  "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 4:
      "presentationRatio" : { Ratio },
      "presentationRatioRange" : { RatioRange },
      "presentationCodeableConcept" : { CodeableConcept },
      "presentationQuantity" : { Quantity },
      "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 4:
      "concentrationRatio" : { Ratio },
      "concentrationRatioRange" : { RatioRange },
      "concentrationCodeableConcept" : { CodeableConcept },
      "concentrationQuantity" : { Quantity },
      "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
      "basis" : { CodeableConcept }, // 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)
      "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 3:
        "strengthRatio" : { Ratio },
        "strengthRatioRange" : { RatioRange },
        "strengthQuantity" : { Quantity },
        "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/> .doco


[ 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.status [ code ]; # 1..1 draft | active | retired | unknown
  fhir:Ingredient.for [ Reference(AdministrableProductDefinition|ManufacturedItemDefinition|
  MedicinalProductDefinition) ], ... ; # 0..* The product which this ingredient is a constituent part of
  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.group [ CodeableConcept ]; # 0..1 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:Ingredient.allergenicIndicator [ boolean ]; # 0..1 If the ingredient is a known or suspected allergen
  fhir:Ingredient.manufacturer [ # 0..* An organization that manufactures this ingredient
    fhir:Ingredient.manufacturer.role [ Coding ]; # 0..1 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
    fhir:Ingredient.manufacturer.manufacturer [ Reference(Organization) ]; # 1..1 An organization that manufactures this ingredient
  ], ...;
  fhir:Ingredient.substance [ # 1..1 The substance that comprises this ingredient
    fhir:Ingredient.substance.code [ CodeableReference(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
      # Ingredient.substance.strength.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. One of these 4
        fhir:Ingredient.substance.strength.presentationRatio [ Ratio ]
        fhir:Ingredient.substance.strength.presentationRatioRange [ RatioRange ]
        fhir:Ingredient.substance.strength.presentationCodeableConcept [ CodeableConcept ]
        fhir:Ingredient.substance.strength.presentationQuantity [ Quantity ]
      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
      # Ingredient.substance.strength.concentration[x] : 0..1 The strength per unitary volume (or mass). One of these 4
        fhir:Ingredient.substance.strength.concentrationRatio [ Ratio ]
        fhir:Ingredient.substance.strength.concentrationRatioRange [ RatioRange ]
        fhir:Ingredient.substance.strength.concentrationCodeableConcept [ CodeableConcept ]
        fhir:Ingredient.substance.strength.concentrationQuantity [ Quantity ]
      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.basis [ CodeableConcept ]; # 0..1 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: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(SubstanceDefinition) ]; # 0..1 Relevant reference substance
        # Ingredient.substance.strength.referenceStrength.strength[x] : 1..1 Strength expressed in terms of a reference substance. One of these 3
          fhir:Ingredient.substance.strength.referenceStrength.strengthRatio [ Ratio ]
          fhir:Ingredient.substance.strength.referenceStrength.strengthRatioRange [ RatioRange ]
          fhir:Ingredient.substance.strength.referenceStrength.strengthQuantity [ Quantity ]
        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
      ], ...;
    ], ...;
  ];
]

Changes since R3

This resource did not exist in Release 2

This analysis is available as XML or JSON.

Structure

NameFlagsCard.TypeDescription & Constraintsdoco
.. Ingredient TUDomainResourceAn ingredient of a manufactured item or pharmaceutical product
Elements defined in Ancestors: id, meta, implicitRules, language, text, contained, extension, modifierExtension
... identifier Σ0..1IdentifierAn identifier or code by which the ingredient can be referenced
... status ?!Σ1..1codedraft | active | retired | unknown
PublicationStatus (Required)
... for Σ0..*Reference(MedicinalProductDefinition | AdministrableProductDefinition | ManufacturedItemDefinition)The product which this ingredient is a constituent part of
... function Σ0..*CodeableConceptA 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
... group Σ0..1CodeableConceptA 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
... allergenicIndicator Σ0..1booleanIf the ingredient is a known or suspected allergen
... manufacturer Σ0..*BackboneElementAn organization that manufactures this ingredient
.... role Σ0..1CodingThe 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..1Reference(Organization)An organization that manufactures this ingredient
... substance Σ1..1BackboneElementThe substance that comprises this ingredient
.... code Σ1..1CodeableReference(SubstanceDefinition)A code or full resource that represents the ingredient substance
.... strength Σ0..*BackboneElementThe 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..1The quantity of substance in the unit of presentation, or in the volume (or mass) of the single pharmaceutical product or manufactured item
...... presentationRatioRatio
...... presentationRatioRangeRatioRange
...... presentationCodeableConceptCodeableConcept
...... presentationQuantityQuantity
..... presentationText Σ0..1stringA 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..1The strength per unitary volume (or mass)
...... concentrationRatioRatio
...... concentrationRatioRangeRatioRange
...... concentrationCodeableConceptCodeableConcept
...... concentrationQuantityQuantity
..... concentrationText Σ0..1stringA 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
..... basis Σ0..1CodeableConceptA 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)
..... measurementPoint Σ0..1stringFor when strength is measured at a particular point or distance
..... country Σ0..*CodeableConceptThe country or countries for which the strength range applies
..... referenceStrength Σ0..*BackboneElementStrength expressed in terms of a reference substance
...... substance Σ0..1CodeableReference(SubstanceDefinition)Relevant reference substance
...... strength[x] Σ1..1Strength expressed in terms of a reference substance
....... strengthRatioRatio
....... strengthRatioRangeRatioRange
....... strengthQuantityQuantity
...... measurementPoint Σ0..1stringFor when strength is measured at a particular point or distance
...... country Σ0..*CodeableConceptThe country or countries for which the strength range applies

doco Documentation for this format

UML Diagram (Legend)

Ingredient (DomainResource)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 appropriateidentifier : Identifier [0..1]The status of this ingredient. Enables tracking the life-cycle of the content (this element modifies the meaning of other elements)status : code [1..1] « null (Strength=Required)PublicationStatus! »The product which this ingredient is a constituent part offor : Reference [0..*] « MedicinalProductDefinition| AdministrableProductDefinition|ManufacturedItemDefinition »A classification of the ingredient identifying its purpose within the product, e.g. active, inactiverole : CodeableConcept [1..1]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 Agentfunction : CodeableConcept [0..*]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 inkgroup : CodeableConcept [0..1]If the ingredient is a known or suspected allergenallergenicIndicator : boolean [0..1]ManufacturerThe 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 rolerole : Coding [0..1] « null (Strength=Required)IngredientManufacturerRole! »An organization that manufactures this ingredientmanufacturer : Reference [1..1] « Organization »SubstanceA code or full resource that represents the ingredient substancecode : DataType [1..1] « SubstanceDefinition »StrengthThe quantity of substance in the unit of presentation, or in the volume (or mass) of the single pharmaceutical product or manufactured itempresentation[x] : DataType [0..1] « Ratio|RatioRange|CodeableConcept| Quantity »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 ratiopresentationText : string [0..1]The strength per unitary volume (or mass)concentration[x] : DataType [0..1] « Ratio|RatioRange| CodeableConcept|Quantity »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 ratioconcentrationText : string [0..1]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)basis : CodeableConcept [0..1]For when strength is measured at a particular point or distancemeasurementPoint : string [0..1]The country or countries for which the strength range appliescountry : CodeableConcept [0..*]ReferenceStrengthRelevant reference substancesubstance : DataType [0..1] « SubstanceDefinition »Strength expressed in terms of a reference substancestrength[x] : DataType [1..1] « Ratio|RatioRange|Quantity »For when strength is measured at a particular point or distancemeasurementPoint : string [0..1]The country or countries for which the strength range appliescountry : CodeableConcept [0..*]An organization that manufactures this ingredientmanufacturer[0..*]Strength expressed in terms of a reference substancereferenceStrength[0..*]The quantity of substance in the unit of presentation, or in the volume (or mass) of the single pharmaceutical product or manufactured itemstrength[0..*]The substance that comprises this ingredientsubstance[1..1]

XML Template

<Ingredient xmlns="http://hl7.org/fhir"> doco
 <!-- 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>
 <group><!-- 0..1 CodeableConcept 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 --></group>
 <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  --></role>
  <manufacturer><!-- 1..1 Reference(Organization) An organization that manufactures this ingredient --></manufacturer>
 </manufacturer>
 <substance>  <!-- 1..1 The substance that comprises this ingredient -->
  <code><!-- 1..1 CodeableReference(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 -->
   <presentation[x]><!-- 0..1 Ratio|RatioRange|CodeableConcept|Quantity 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]>
   <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[x]><!-- 0..1 Ratio|RatioRange|CodeableConcept|Quantity The strength per unitary volume (or mass) --></concentration[x]>
   <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 -->
   <basis><!-- 0..1 CodeableConcept 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) --></basis>
   <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(SubstanceDefinition) Relevant reference substance --></substance>
    <strength[x]><!-- 1..1 Ratio|RatioRange|Quantity Strength expressed in terms of a reference substance --></strength[x]>
    <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>
</Ingredient>

JSON Template

{doco
  "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
  "group" : { CodeableConcept }, // 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
  "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 4:
      "presentationRatio" : { Ratio },
      "presentationRatioRange" : { RatioRange },
      "presentationCodeableConcept" : { CodeableConcept },
      "presentationQuantity" : { Quantity },
      "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 4:
      "concentrationRatio" : { Ratio },
      "concentrationRatioRange" : { RatioRange },
      "concentrationCodeableConcept" : { CodeableConcept },
      "concentrationQuantity" : { Quantity },
      "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
      "basis" : { CodeableConcept }, // 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)
      "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 3:
        "strengthRatio" : { Ratio },
        "strengthRatioRange" : { RatioRange },
        "strengthQuantity" : { Quantity },
        "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/> .doco


[ 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.status [ code ]; # 1..1 draft | active | retired | unknown
  fhir:Ingredient.for [ Reference(AdministrableProductDefinition|ManufacturedItemDefinition|
  MedicinalProductDefinition) ], ... ; # 0..* The product which this ingredient is a constituent part of
  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.group [ CodeableConcept ]; # 0..1 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:Ingredient.allergenicIndicator [ boolean ]; # 0..1 If the ingredient is a known or suspected allergen
  fhir:Ingredient.manufacturer [ # 0..* An organization that manufactures this ingredient
    fhir:Ingredient.manufacturer.role [ Coding ]; # 0..1 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
    fhir:Ingredient.manufacturer.manufacturer [ Reference(Organization) ]; # 1..1 An organization that manufactures this ingredient
  ], ...;
  fhir:Ingredient.substance [ # 1..1 The substance that comprises this ingredient
    fhir:Ingredient.substance.code [ CodeableReference(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
      # Ingredient.substance.strength.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. One of these 4
        fhir:Ingredient.substance.strength.presentationRatio [ Ratio ]
        fhir:Ingredient.substance.strength.presentationRatioRange [ RatioRange ]
        fhir:Ingredient.substance.strength.presentationCodeableConcept [ CodeableConcept ]
        fhir:Ingredient.substance.strength.presentationQuantity [ Quantity ]
      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
      # Ingredient.substance.strength.concentration[x] : 0..1 The strength per unitary volume (or mass). One of these 4
        fhir:Ingredient.substance.strength.concentrationRatio [ Ratio ]
        fhir:Ingredient.substance.strength.concentrationRatioRange [ RatioRange ]
        fhir:Ingredient.substance.strength.concentrationCodeableConcept [ CodeableConcept ]
        fhir:Ingredient.substance.strength.concentrationQuantity [ Quantity ]
      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.basis [ CodeableConcept ]; # 0..1 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: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(SubstanceDefinition) ]; # 0..1 Relevant reference substance
        # Ingredient.substance.strength.referenceStrength.strength[x] : 1..1 Strength expressed in terms of a reference substance. One of these 3
          fhir:Ingredient.substance.strength.referenceStrength.strengthRatio [ Ratio ]
          fhir:Ingredient.substance.strength.referenceStrength.strengthRatioRange [ RatioRange ]
          fhir:Ingredient.substance.strength.referenceStrength.strengthQuantity [ Quantity ]
        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
      ], ...;
    ], ...;
  ];
]

Changes since Release 3

This resource did not exist in Release 2

This analysis is available as XML or JSON.

 

See the Profiles & Extensions and the alternate definitions: Master Definition XML + JSON, XML Schema/Schematron + JSON Schema, ShEx (for Turtle) + see the extensions, the spreadsheet version & the dependency analysis a

PathDefinitionTypeReference
Ingredient.status RequiredPublicationStatus
Ingredient.manufacturer.role Requiredhttp://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.

NameTypeDescriptionExpressionIn Common
forreferenceThe product which this ingredient is a constituent part ofIngredient.for
(AdministrableProductDefinition, ManufacturedItemDefinition, MedicinalProductDefinition)
functiontokenA 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 AgentIngredient.function
identifiertokenAn identifier or code by which the ingredient can be referencedIngredient.identifier
manufacturerreferenceThe organization that manufactures this ingredientIngredient.manufacturer
roletokenA classification of the ingredient identifying its purpose within the product, e.g. active, inactiveIngredient.role
substance DreferenceReference to a resource (by instance)Ingredient.substance.code.reference
substance-code DtokenReference to a concept (by class)Ingredient.substance.code.concept
substance-definition DreferenceReference to a resource (by instance)Ingredient.substance.code.reference