Release 4B Snapshot 3: Connectathon 32 Base

This page is part of the FHIR Specification (v4.3.0: R4B - STU (v5.0.0-snapshot3: R5 Snapshot #3, to support Connectathon 32 ). 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

15.8 Resource Ingredient - Content

Biomedical Research and Regulation icon Work Group Maturity Level : 1 2   Trial Use Security Category : Anonymous Compartments : Not linked to any defined compartments

An ingredient of a manufactured item or pharmaceutical product.

15.8.1 Scope and Usage

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.

15.8.2 References to this Resource

This resource is referenced by

15.8.3 Resource Content

Structure

Name icon Flags icon Card. icon Type icon Description & Constraints icon doco icon
. . Ingredient TU DomainResource An ingredient of a manufactured item or pharmaceutical product
+ Rule: If an ingredient is noted as an allergen (allergenicIndicator) then its substance should be a code. If the substance is a SubstanceDefinition, then the allegen information should be documented in that resource

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

. . . function Σ 0..* CodeableConcept Precise action within the drug product, e.g. antioxidant, alkalizing agent
IngredientFunction ( Example )

. . allergenicIndicator . 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
... 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 code allowed | possible | actual
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
SNOMEDCTSubstanceCodes SNOMED CT Substance Codes ( Example )
. . . . strength Σ 0..* BackboneElement The quantity of substance, per presentation, or per volume or mass, and type of quantity

. . . . . presentation[x] Σ 0..1 The quantity of substance in the unit of presentation
. . . . . . presentationRatio Ratio
. . . . . . presentationRatioRange RatioRange
. . . . . . presentationRatioRange presentationCodeableConcept CodeableConcept RatioRange
. . . . . . presentationQuantity Quantity
. . . . . textPresentation Σ 0..1 string Text of either the whole presentation strength or a part of it (rest being in Strength.presentation as a ratio)
. . . . . concentration[x] Σ 0..1 The strength per unitary volume (or mass)
. . . . . . concentrationRatio Ratio
. . . . . . concentrationRatioRange RatioRange
. . . . . . concentrationRatioRange concentrationCodeableConcept CodeableConcept RatioRange
. . . . . . concentrationQuantity Quantity
. . . . . textConcentration Σ 0..1 string Text of either the whole concentration strength or a part of it (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)
. . . . . measurementPoint Σ 0..1 string When strength is measured at a particular point or distance
. . . . . country Σ 0..* CodeableConcept Where the strength range applies
Country ValueSet ( Example )

. . . . . referenceStrength Σ 0..* BackboneElement Strength expressed in terms of a reference substance

. . . . . . substance Σ 0..1 CodeableReference ( SubstanceDefinition ) Relevant reference substance
SNOMEDCTSubstanceCodes SNOMED CT Substance Codes ( Example )
. . . . . . strength[x] Σ 1..1 Strength expressed in terms of a reference substance
. . . . . . . strengthRatio Ratio
. . . . . . . strengthRatioRange RatioRange
. . . . . . . strengthQuantity Quantity
. . . . . . measurementPoint Σ 0..1 string When strength is measured at a particular point or distance
. . . . . . country Σ 0..* CodeableConcept Where the strength range applies
Country ValueSet ( Example )


doco Documentation for this format icon

See the Extensions for this resource

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 appropriate identifier : 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 of for : Reference [0..*] « MedicinalProductDefinition | AdministrableProductDefinition | ManufacturedItemDefinition » A classification of the ingredient identifying its purpose within the product, e.g. active, inactive role : CodeableConcept [1..1] « null (Strength=Example) IngredientRole ?? » 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 : CodeableConcept [0..*] « null (Strength=Example) IngredientFunction ?? » 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 : CodeableConcept [0..1] If the ingredient is a known or suspected allergen. Note that this is a property of the substance, so if a reference to a SubstanceDefinition is used to decribe that (rather than just a code), the allergen information should go there, not here allergenicIndicator : boolean [0..1] Manufacturer 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 : code [0..1] « null (Strength=Required) IngredientManufacturerRole ! » An organization that manufactures this ingredient manufacturer : Reference [1..1] « Organization » Substance A code or full resource that represents the ingredient's substance code : Element CodeableReference [1..1] « SubstanceDefinition ; null (Strength=Example) SNOMEDCTSubstanceCodes ?? » Strength The quantity of substance in the unit of presentation, or in the volume (or mass) of the single pharmaceutical product or manufactured item. Unit of presentation refers to the quantity that the item occurs in e.g. a strength per tablet size, perhaps 'per 20mg' (the size of the tablet). It is not generally normalized as a unitary unit, which would be 'per mg') presentation[x] : Element 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 ratio textPresentation : string [0..1] The strength per unitary volume (or mass) concentration[x] : Element 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 ratio textConcentration : 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 distance. There are products where strength is measured at a particular point. For example, the strength of the ingredient in some inhalers is measured at a particular position relative to the point of aerosolization measurementPoint : string [0..1] The country or countries for which the strength range applies country : CodeableConcept [0..*] « null (Strength=Example) Country ValueSet CountryValueSet ?? » ReferenceStrength Relevant reference substance substance : Element CodeableReference [0..1] « SubstanceDefinition ; null (Strength=Example) SNOMEDCTSubstanceCodes ?? » Strength expressed in terms of a reference substance strength[x] : Element DataType [1..1] « Ratio | RatioRange | Quantity » For when strength is measured at a particular point or distance measurementPoint : string [0..1] The country or countries for which the strength range applies country : CodeableConcept [0..*] « null (Strength=Example) Country ValueSet CountryValueSet ?? » The organization(s) that manufacture this ingredient. Can be used to indicate: 1) Organizations we are aware of that manufacture this ingredient 2) Specific Manufacturer(s) currently being used 3) Set of organisations allowed to manufacture this ingredient for this product Users must be clear on the application of context relevant to their use case manufacturer [0..*] Strength expressed in terms of a reference substance. For when the ingredient strength is additionally expressed as equivalent to the strength of some other closely related substance (e.g. salt vs. base). Reference strength represents the strength (quantitative composition) of the active moiety of the active substance. There are situations when the active substance and active moiety are different, therefore both a strength and a reference strength are needed referenceStrength [0..*] The quantity of substance in the unit of presentation, or in the volume (or mass) of the single pharmaceutical product or manufactured item. The allowed repetitions do not represent different strengths, but are different representations - mathematically equivalent - of a single strength strength [0..*] The substance that comprises this ingredient substance [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 Purpose of the ingredient within the product, e.g. active, inactive --></role>
 <function><!-- 0..* CodeableConcept Precise action within the drug product, e.g. 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 value="[code]"/><!-- 0..1 allowed | possible | actual -->
  <manufacturer><!-- 1..1 Reference(Organization) An organization that manufactures this ingredient --></manufacturer>
 </manufacturer>
 <substance>  <!-- 1..1 The substance that comprises this ingredient -->
  <</code>

  <code><!-- 1..1 CodeableReference(SubstanceDefinition) A code or full resource that represents the ingredient substance --></code>

  <strength>  <!-- 0..* The quantity of substance, per presentation, or per volume or mass, and type of quantity -->
   <</presentation[x]>

   <presentation[x]><!-- 0..1 Ratio|RatioRange|CodeableConcept|Quantity The quantity of substance in the unit of presentation --></presentation[x]>

   <textPresentation value="[string]"/><!-- 0..1 Text of either the whole presentation strength or a part of it (rest being in Strength.presentation as a ratio) -->
   <</concentration[x]>

   <concentration[x]><!-- 0..1 Ratio|RatioRange|CodeableConcept|Quantity The strength per unitary volume (or mass) --></concentration[x]>

   <textConcentration value="[string]"/><!-- 0..1 Text of either the whole concentration strength or a part of it (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 When strength is measured at a particular point or distance -->
   <country><!-- 0..* CodeableConcept Where the strength range applies --></country>
   <referenceStrength>  <!-- 0..* Strength expressed in terms of a reference substance -->
    <</substance>
    <</strength[x]>

    <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 When strength is measured at a particular point or distance -->
    <country><!-- 0..* CodeableConcept Where 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!  Purpose of the ingredient within the product, e.g. active, inactive
  "function" : [{ CodeableConcept }], // Precise action within the drug product, e.g. 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" : "<code>", // allowed | possible | actual
    "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, per presentation, or per volume or mass, and type of quantity
      

      // presentation[x]: The quantity of substance in the unit of presentation. One of these 4:
      "presentationRatio" : { Ratio },
      "presentationRatioRange" : { RatioRange },
      "presentationCodeableConcept" : { CodeableConcept },
      "presentationQuantity" : { Quantity },

      "textPresentation" : "<string>", // Text of either the whole presentation strength or a part of it (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 },

      "textConcentration" : "<string>", // Text of either the whole concentration strength or a part of it (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>", // When strength is measured at a particular point or distance
      "country" : [{ CodeableConcept }], // Where 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>", // When strength is measured at a particular point or distance
        "country" : [{ CodeableConcept }] // Where 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 Purpose of the ingredient within the product, e.g. active, inactive
  fhir:Ingredient.function [ CodeableConcept ], ... ; # 0..* Precise action within the drug product, e.g. 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 [ code ]; # 0..1 allowed | possible | actual
    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, per presentation, or per volume or mass, and type of quantity
      # . One of these 2

      # Ingredient.substance.strength.presentation[x] : 0..1 The quantity of substance in the unit of presentation. 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.textPresentation [ string ]; # 0..1 Text of either the whole presentation strength or a part of it (rest being in Strength.presentation as a ratio)
      # . One of these 2

      # 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.textConcentration [ string ]; # 0..1 Text of either the whole concentration strength or a part of it (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 When strength is measured at a particular point or distance
      fhir:Ingredient.substance.strength.country [ CodeableConcept ], ... ; # 0..* Where 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
        # . One of these 2

        # 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 When strength is measured at a particular point or distance
        fhir:Ingredient.substance.strength.referenceStrength.country [ CodeableConcept ], ... ; # 0..* Where the strength range applies
      ], ...;
    ], ...;
  ];
]

Changes since R4

Ingredient Name Changed from MedicinalProductIngredient to Ingredient Ingredient Moved from MedicinalProductIngredient to Ingredient Ingredient.status Added Mandatory Element Ingredient.for Added Element Ingredient.function Added Element Ingredient.manufacturer Type changed from Reference(Organization) to BackboneElement Ingredient.manufacturer.role Added Element Ingredient.manufacturer.manufacturer Added Mandatory Element Ingredient.substance Min Cardinality changed from 0 to 1 Ingredient.substance.code Type changed from CodeableConcept to CodeableReference Ingredient.substance.strength.presentation[x] Added Element Ingredient.substance.strength.textPresentation Added Element Ingredient.substance.strength.concentration[x] Added Element Ingredient.substance.strength.textConcentration Added Element Ingredient.substance.strength.measurementPoint Added Element Ingredient.substance.strength.country Added Element Ingredient.substance.strength.referenceStrength Added Element Ingredient.substance.strength.referenceStrength.substance Added Element Ingredient.substance.strength.referenceStrength.strength[x] Added Mandatory Element Ingredient.substance.strength.referenceStrength.measurementPoint Added Element Ingredient.substance.strength.referenceStrength.country Added Element MedicinalProductIngredient.specifiedSubstance deleted

See the Full Difference for further information This resource did not exist in Release 3

This analysis is available as XML or JSON .

Conversions between R3 and R4

Structure

Name icon Flags icon Card. icon Type icon Description & Constraints icon doco icon
. . Ingredient TU DomainResource An ingredient of a manufactured item or pharmaceutical product
+ Rule: If an ingredient is noted as an allergen (allergenicIndicator) then its substance should be a code. If the substance is a SubstanceDefinition, then the allegen information should be documented in that resource

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

. . . function Σ 0..* CodeableConcept Precise action within the drug product, e.g. antioxidant, alkalizing agent
IngredientFunction ( Example )

. . allergenicIndicator . 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
... 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 code allowed | possible | actual
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
SNOMEDCTSubstanceCodes SNOMED CT Substance Codes ( Example )
. . . . strength Σ 0..* BackboneElement The quantity of substance, per presentation, or per volume or mass, and type of quantity

. . . . . presentation[x] Σ 0..1 The quantity of substance in the unit of presentation
. . . . . . presentationRatio Ratio
. . . . . . presentationRatioRange RatioRange
. . . . . . presentationRatioRange presentationCodeableConcept CodeableConcept RatioRange
. . . . . . presentationQuantity Quantity
. . . . . textPresentation Σ 0..1 string Text of either the whole presentation strength or a part of it (rest being in Strength.presentation as a ratio)
. . . . . concentration[x] Σ 0..1 The strength per unitary volume (or mass)
. . . . . . concentrationRatio Ratio
. . . . . . concentrationRatioRange RatioRange
. . . . . . concentrationRatioRange concentrationCodeableConcept CodeableConcept RatioRange
. . . . . . concentrationQuantity Quantity
. . . . . textConcentration Σ 0..1 string Text of either the whole concentration strength or a part of it (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)
. . . . . measurementPoint Σ 0..1 string When strength is measured at a particular point or distance
. . . . . country Σ 0..* CodeableConcept Where the strength range applies
Country ValueSet ( Example )

. . . . . referenceStrength Σ 0..* BackboneElement Strength expressed in terms of a reference substance

. . . . . . substance Σ 0..1 CodeableReference ( SubstanceDefinition ) Relevant reference substance
SNOMEDCTSubstanceCodes SNOMED CT Substance Codes ( Example )
. . . . . . strength[x] Σ 1..1 Strength expressed in terms of a reference substance
. . . . . . . strengthRatio Ratio
. . . . . . . strengthRatioRange RatioRange
. . . . . . . strengthQuantity Quantity
. . . . . . measurementPoint Σ 0..1 string When strength is measured at a particular point or distance
. . . . . . country Σ 0..* CodeableConcept Where the strength range applies
Country ValueSet ( Example )


doco Documentation for this format icon

See the Extensions for this resource

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 appropriate identifier : 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 of for : Reference [0..*] « MedicinalProductDefinition | AdministrableProductDefinition | ManufacturedItemDefinition » A classification of the ingredient identifying its purpose within the product, e.g. active, inactive role : CodeableConcept [1..1] « null (Strength=Example) IngredientRole ?? » 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 : CodeableConcept [0..*] « null (Strength=Example) IngredientFunction ?? » 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 : CodeableConcept [0..1] If the ingredient is a known or suspected allergen. Note that this is a property of the substance, so if a reference to a SubstanceDefinition is used to decribe that (rather than just a code), the allergen information should go there, not here allergenicIndicator : boolean [0..1] Manufacturer 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 : code [0..1] « null (Strength=Required) IngredientManufacturerRole ! » An organization that manufactures this ingredient manufacturer : Reference [1..1] « Organization » Substance A code or full resource that represents the ingredient's substance code : Element CodeableReference [1..1] « SubstanceDefinition ; null (Strength=Example) SNOMEDCTSubstanceCodes ?? » Strength The quantity of substance in the unit of presentation, or in the volume (or mass) of the single pharmaceutical product or manufactured item. Unit of presentation refers to the quantity that the item occurs in e.g. a strength per tablet size, perhaps 'per 20mg' (the size of the tablet). It is not generally normalized as a unitary unit, which would be 'per mg') presentation[x] : Element 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 ratio textPresentation : string [0..1] The strength per unitary volume (or mass) concentration[x] : Element 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 ratio textConcentration : 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 distance. There are products where strength is measured at a particular point. For example, the strength of the ingredient in some inhalers is measured at a particular position relative to the point of aerosolization measurementPoint : string [0..1] The country or countries for which the strength range applies country : CodeableConcept [0..*] « null (Strength=Example) Country ValueSet CountryValueSet ?? » ReferenceStrength Relevant reference substance substance : Element CodeableReference [0..1] « SubstanceDefinition ; null (Strength=Example) SNOMEDCTSubstanceCodes ?? » Strength expressed in terms of a reference substance strength[x] : Element DataType [1..1] « Ratio | RatioRange | Quantity » For when strength is measured at a particular point or distance measurementPoint : string [0..1] The country or countries for which the strength range applies country : CodeableConcept [0..*] « null (Strength=Example) Country ValueSet CountryValueSet ?? » The organization(s) that manufacture this ingredient. Can be used to indicate: 1) Organizations we are aware of that manufacture this ingredient 2) Specific Manufacturer(s) currently being used 3) Set of organisations allowed to manufacture this ingredient for this product Users must be clear on the application of context relevant to their use case manufacturer [0..*] Strength expressed in terms of a reference substance. For when the ingredient strength is additionally expressed as equivalent to the strength of some other closely related substance (e.g. salt vs. base). Reference strength represents the strength (quantitative composition) of the active moiety of the active substance. There are situations when the active substance and active moiety are different, therefore both a strength and a reference strength are needed referenceStrength [0..*] The quantity of substance in the unit of presentation, or in the volume (or mass) of the single pharmaceutical product or manufactured item. The allowed repetitions do not represent different strengths, but are different representations - mathematically equivalent - of a single strength strength [0..*] The substance that comprises this ingredient substance [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 Purpose of the ingredient within the product, e.g. active, inactive --></role>
 <function><!-- 0..* CodeableConcept Precise action within the drug product, e.g. 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 value="[code]"/><!-- 0..1 allowed | possible | actual -->
  <manufacturer><!-- 1..1 Reference(Organization) An organization that manufactures this ingredient --></manufacturer>
 </manufacturer>
 <substance>  <!-- 1..1 The substance that comprises this ingredient -->
  <</code>

  <code><!-- 1..1 CodeableReference(SubstanceDefinition) A code or full resource that represents the ingredient substance --></code>

  <strength>  <!-- 0..* The quantity of substance, per presentation, or per volume or mass, and type of quantity -->
   <</presentation[x]>

   <presentation[x]><!-- 0..1 Ratio|RatioRange|CodeableConcept|Quantity The quantity of substance in the unit of presentation --></presentation[x]>

   <textPresentation value="[string]"/><!-- 0..1 Text of either the whole presentation strength or a part of it (rest being in Strength.presentation as a ratio) -->
   <</concentration[x]>

   <concentration[x]><!-- 0..1 Ratio|RatioRange|CodeableConcept|Quantity The strength per unitary volume (or mass) --></concentration[x]>

   <textConcentration value="[string]"/><!-- 0..1 Text of either the whole concentration strength or a part of it (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 When strength is measured at a particular point or distance -->
   <country><!-- 0..* CodeableConcept Where the strength range applies --></country>
   <referenceStrength>  <!-- 0..* Strength expressed in terms of a reference substance -->
    <</substance>
    <</strength[x]>

    <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 When strength is measured at a particular point or distance -->
    <country><!-- 0..* CodeableConcept Where 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!  Purpose of the ingredient within the product, e.g. active, inactive
  "function" : [{ CodeableConcept }], // Precise action within the drug product, e.g. 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" : "<code>", // allowed | possible | actual
    "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, per presentation, or per volume or mass, and type of quantity
      

      // presentation[x]: The quantity of substance in the unit of presentation. One of these 4:
      "presentationRatio" : { Ratio },
      "presentationRatioRange" : { RatioRange },
      "presentationCodeableConcept" : { CodeableConcept },
      "presentationQuantity" : { Quantity },

      "textPresentation" : "<string>", // Text of either the whole presentation strength or a part of it (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 },

      "textConcentration" : "<string>", // Text of either the whole concentration strength or a part of it (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>", // When strength is measured at a particular point or distance
      "country" : [{ CodeableConcept }], // Where 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>", // When strength is measured at a particular point or distance
        "country" : [{ CodeableConcept }] // Where 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 Purpose of the ingredient within the product, e.g. active, inactive
  fhir:Ingredient.function [ CodeableConcept ], ... ; # 0..* Precise action within the drug product, e.g. 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 [ code ]; # 0..1 allowed | possible | actual
    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, per presentation, or per volume or mass, and type of quantity
      # . One of these 2

      # Ingredient.substance.strength.presentation[x] : 0..1 The quantity of substance in the unit of presentation. 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.textPresentation [ string ]; # 0..1 Text of either the whole presentation strength or a part of it (rest being in Strength.presentation as a ratio)
      # . One of these 2

      # 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.textConcentration [ string ]; # 0..1 Text of either the whole concentration strength or a part of it (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 When strength is measured at a particular point or distance
      fhir:Ingredient.substance.strength.country [ CodeableConcept ], ... ; # 0..* Where 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
        # . One of these 2

        # 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 When strength is measured at a particular point or distance
        fhir:Ingredient.substance.strength.referenceStrength.country [ CodeableConcept ], ... ; # 0..* Where the strength range applies
      ], ...;
    ], ...;
  ];
]

Changes since Release 4

Ingredient Name Changed from MedicinalProductIngredient to Ingredient Ingredient Moved from MedicinalProductIngredient to Ingredient Ingredient.status Added Mandatory Element Ingredient.for Added Element Ingredient.function Added Element Ingredient.manufacturer Type changed from Reference(Organization) to BackboneElement Ingredient.manufacturer.role Added Element Ingredient.manufacturer.manufacturer Added Mandatory Element Ingredient.substance Min Cardinality changed from 0 to 1 Ingredient.substance.code Type changed from CodeableConcept to CodeableReference Ingredient.substance.strength.presentation[x] Added Element Ingredient.substance.strength.textPresentation Added Element Ingredient.substance.strength.concentration[x] Added Element Ingredient.substance.strength.textConcentration Added Element Ingredient.substance.strength.measurementPoint Added Element Ingredient.substance.strength.country Added Element Ingredient.substance.strength.referenceStrength Added Element Ingredient.substance.strength.referenceStrength.substance Added Element Ingredient.substance.strength.referenceStrength.strength[x] Added Mandatory Element Ingredient.substance.strength.referenceStrength.measurementPoint Added Element Ingredient.substance.strength.referenceStrength.country Added Element MedicinalProductIngredient.specifiedSubstance deleted

See the Full Difference for further information This resource did not exist in Release 3

This analysis is available as XML or JSON .

Conversions between R3 and R4

 

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

15.8.3.1 Terminology Bindings

Path Definition Type Reference
Ingredient.status

The lifecycle status of an artifact.

Required PublicationStatus
Ingredient.role

A classification of the ingredient identifying its purpose within the product.

Example IngredientRole
Ingredient.function

A classification of the ingredient identifying its precise purpose(s) in the drug product (beyond e.g. active/inactive).

Example IngredientFunction
Ingredient.manufacturer.role

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.

Required IngredientManufacturerRole
Ingredient.substance.code

This value set includes all substance codes from SNOMED CT - provided as an exemplar value set.

Example http://hl7.org/fhir/ValueSet/substance-codes SNOMEDCTSubstanceCodes
Ingredient.substance.strength.country

This value set defines a base set of codes for countries.

Note: The codes for countries are taken from ISO 3166 icon.

 Example CountryValueSet (a valid code from ISO 3166-1 Codes for the representation of names of countries and their subdivisions — Part 1: Country ValueSet code icon )
Ingredient.substance.strength.referenceStrength.substance

This value set includes all substance codes from SNOMED CT - provided as an exemplar value set.

Example http://hl7.org/fhir/ValueSet/substance-codes SNOMEDCTSubstanceCodes
Ingredient.substance.strength.referenceStrength.country

This value set defines a base set of codes for countries.

Note: The codes for countries are taken from ISO 3166 icon.

 Example CountryValueSet (a valid code from ISO 3166-1 Codes for the representation of names of countries and their subdivisions — Part 1: Country ValueSet code icon )

15.8.3.2 Constraints

id UniqueKey Level Location Description Expression
ing-1 img  ing-1 Rule (base) If an ingredient is noted as an allergen (allergenicIndicator) then its substance should be a code. If the substance is a SubstanceDefinition, then the allegen information should be documented in that resource (Ingredient.allergenicIndicator.where(value='true').count() + Ingredient.substance.code.reference.count()) < 2

15.8.4 Search Parameters

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 status token The status of this ingredient. Enables tracking the life-cycle of the content Ingredient.status
substance 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