Release 5 Draft Ballot

15.8 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 and AdministrableProductDefinition.

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
... role Σ1..1CodeableConceptA classification of the ingredient identifying its purpose within the product, e.g. active, inactive
... 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
... description Σ0..1markdownA general description of the ingredient, or any supporting text. May be used for an unstructured list of excipients
... allergenicIndicator Σ0..1booleanIf the ingredient is a known or suspected allergen
... manufacturer Σ0..*Reference(Organization)The organization that manufactures this ingredient
... substance Σ0..1BackboneElementThe substance that comprises this ingredient
.... code Σ1..1CodeableReference(SubstanceDefinition | Substance)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. When there is a range of strengths, this represents the lower limit
..... 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
...... presentationCodeableConceptCodeableConcept
...... presentationQuantityQuantity
..... presentationHighLimit[x] ?!Σ0..1An upper limit for the quantity of substance in the unit of presentation. When there is a range of strengths, this represents the upper limit
...... presentationHighLimitRatioRatio
...... presentationHighLimitQuantityQuantity
..... 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
...... concentrationCodeableConceptCodeableConcept
...... concentrationQuantityQuantity
..... concentrationHighLimit[x] ?!Σ0..1An upper limit for the strength per unitary volume (or mass), for when there is a range. The concentration attribute then becomes the lower limit
...... concentrationHighLimitRatioRatio
...... concentrationHighLimitQuantityQuantity
..... 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 | Substance)Relevant reference substance
...... strength[x] Σ1..1Strength expressed in terms of a reference substance. When there is a range of strengths, this represents the lower limit
....... strengthRatioRatio
....... strengthQuantityQuantity
...... strengthHighLimit[x] Σ0..1Strength expressed in terms of a reference substance. When there is a range of strengths, this represents the upper limit
....... strengthHighLimitRatioRatio
....... strengthHighLimitQuantityQuantity
...... 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
... specifiedSubstance Σ0..*BackboneElementA specified substance that comprises this ingredient
.... code Σ1..1CodeableReference(SubstanceDefinition | Substance)Substance as a 'specified substance', implying extra substance related characteristics
.... group Σ1..1CodeableConceptThe group of specified substance, e.g. group 1 to 4, where the group categorises the level of description of the substance according to standardised sets of properties
.... confidentiality Σ0..1CodeableConceptConfidentiality level of the specified substance as the ingredient
.... strength Σ0..*see strengthQuantity of the substance or specified substance present in the manufactured item or pharmaceutical product

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]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]A general description of the ingredient, or any supporting text. May be used for an unstructured list of excipientsdescription : markdown [0..1]If the ingredient is a known or suspected allergenallergenicIndicator : boolean [0..1]The organization that manufactures this ingredientmanufacturer : Reference [0..*] « Organization »SubstanceA code or full resource that represents the ingredient substancecode : DataType [1..1] « SubstanceDefinition|Substance »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|CodeableConcept|Quantity »An upper limit for the quantity of substance in the unit of presentation. When there is a range of strengths, this represents the upper limit (this element modifies the meaning of other elements)presentationHighLimit[x] : DataType [0..1] « Ratio|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|CodeableConcept|Quantity »An upper limit for the strength per unitary volume (or mass), for when there is a range. The concentration attribute then becomes the lower limit (this element modifies the meaning of other elements)concentrationHighLimit[x] : DataType [0..1] « Ratio|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|Substance »Strength expressed in terms of a reference substance. When there is a range of strengths, this represents the lower limitstrength[x] : DataType [1..1] « Ratio|Quantity »Strength expressed in terms of a reference substance. When there is a range of strengths, this represents the upper limitstrengthHighLimit[x] : DataType [0..1] « Ratio|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..*]SpecifiedSubstanceSubstance as a 'specified substance', implying extra substance related characteristicscode : DataType [1..1] « SubstanceDefinition|Substance »The group of specified substance, e.g. group 1 to 4, where the group categorises the level of description of the substance according to standardised sets of propertiesgroup : CodeableConcept [1..1]Confidentiality level of the specified substance as the ingredientconfidentiality : CodeableConcept [0..1]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 item. When there is a range of strengths, this represents the lower limitstrength[0..*]The substance that comprises this ingredientsubstance[0..1]Quantity of the substance or specified substance present in the manufactured item or pharmaceutical productstrength[0..*]A specified substance that comprises this ingredientspecifiedSubstance[0..*]

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>
 <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>
 <description value="[markdown]"/><!-- 0..1 A general description of the ingredient, or any supporting text. May be used for an unstructured list of excipients -->
 <allergenicIndicator value="[boolean]"/><!-- 0..1 If the ingredient is a known or suspected allergen -->
 <manufacturer><!-- 0..* Reference(Organization) The organization that manufactures this ingredient --></manufacturer>
 <substance>  <!-- 0..1 The substance that comprises this ingredient -->
  <code><!-- 1..1 CodeableReference(Substance|SubstanceDefinition) A code or full resource that represents the ingredient substance --></code>
  <strength>  <!-- 0..* The quantity of substance in the unit of presentation, or in the volume (or mass) of the single pharmaceutical product or manufactured item. When there is a range of strengths, this represents the lower limit -->
   <presentation[x]><!-- 0..1 Ratio|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]>
   <presentationHighLimit[x]><!-- 0..1 Ratio|Quantity An upper limit for the quantity of substance in the unit of presentation. When there is a range of strengths, this represents the upper limit --></presentationHighLimit[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|CodeableConcept|Quantity The strength per unitary volume (or mass) --></concentration[x]>
   <concentrationHighLimit[x]><!-- 0..1 Ratio|Quantity An upper limit for the strength per unitary volume (or mass), for when there is a range. The concentration attribute then becomes the lower limit --></concentrationHighLimit[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(Substance|SubstanceDefinition) Relevant reference substance --></substance>
    <strength[x]><!-- 1..1 Ratio|Quantity Strength expressed in terms of a reference substance. When there is a range of strengths, this represents the lower limit --></strength[x]>
    <strengthHighLimit[x]><!-- 0..1 Ratio|Quantity Strength expressed in terms of a reference substance. When there is a range of strengths, this represents the upper limit --></strengthHighLimit[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>
 <specifiedSubstance>  <!-- 0..* A specified substance that comprises this ingredient -->
  <code><!-- 1..1 CodeableReference(Substance|SubstanceDefinition) Substance as a 'specified substance', implying extra substance related characteristics --></code>
  <group><!-- 1..1 CodeableConcept The group of specified substance, e.g. group 1 to 4, where the group categorises the level of 
description of the substance according to standardised sets of properties --></group>
  <confidentiality><!-- 0..1 CodeableConcept Confidentiality level of the specified substance as the ingredient --></confidentiality>
  <strength><!-- 0..* Content as for Ingredient.substance.strength Quantity of the substance or specified substance present in the manufactured item or pharmaceutical product --></strength>
 </specifiedSubstance>
</Ingredient>

JSON Template

{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
  "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
  "description" : "<markdown>", // A general description of the ingredient, or any supporting text. May be used for an unstructured list of excipients
  "allergenicIndicator" : <boolean>, // If the ingredient is a known or suspected allergen
  "manufacturer" : [{ Reference(Organization) }], // The organization that manufactures this ingredient
  "substance" : { // The substance that comprises this ingredient
    "code" : { CodeableReference(Substance|SubstanceDefinition) }, // R!  A code or full resource that represents the ingredient substance
    "strength" : [{ // The quantity of substance in the unit of presentation, or in the volume (or mass) of the single pharmaceutical product or manufactured item. When there is a range of strengths, this represents the lower limit
      // presentation[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 3:
      "presentationRatio" : { Ratio },
      "presentationCodeableConcept" : { CodeableConcept },
      "presentationQuantity" : { Quantity },
      // presentationHighLimit[x]: 
       An upper limit for the quantity of substance in the unit of presentation. When there is a range of strengths, this represents the upper limit. One of these 2:
      "presentationHighLimitRatio" : { Ratio },
      "presentationHighLimitQuantity" : { 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 3:
      "concentrationRatio" : { Ratio },
      "concentrationCodeableConcept" : { CodeableConcept },
      "concentrationQuantity" : { Quantity },
      // concentrationHighLimit[x]: 
       An upper limit for the strength per unitary volume (or mass), for when there is a range. The concentration attribute then becomes the lower limit. One of these 2:
      "concentrationHighLimitRatio" : { Ratio },
      "concentrationHighLimitQuantity" : { 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(Substance|SubstanceDefinition) }, // Relevant reference substance
        // strength[x]: 
        Strength expressed in terms of a reference substance. When there is a range of strengths, this represents the lower limit. One of these 2:
        "strengthRatio" : { Ratio },
        "strengthQuantity" : { Quantity },
        // strengthHighLimit[x]: 
        Strength expressed in terms of a reference substance. When there is a range of strengths, this represents the upper limit. One of these 2:
        "strengthHighLimitRatio" : { Ratio },
        "strengthHighLimitQuantity" : { 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
      }]
    }]
  },
  "specifiedSubstance" : [{ // A specified substance that comprises this ingredient
    "code" : { CodeableReference(Substance|SubstanceDefinition) }, // R!  Substance as a 'specified substance', implying extra substance related characteristics
    "group" : { CodeableConcept }, // R!  The group of specified substance, e.g. group 1 to 4, where the group categorises the level of 
description of the substance according to standardised sets of properties
    "confidentiality" : { CodeableConcept }, // Confidentiality level of the specified substance as the ingredient
    "strength" : [{ Content as for Ingredient.substance.strength }] // Quantity of the substance or specified substance present in the manufactured item or pharmaceutical product
  }]
}

Turtle Template

@prefix fhir: <http://hl7.org/fhir/> .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.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.description [ markdown ]; # 0..1 A general description of the ingredient, or any supporting text. May be used for an unstructured list of excipients
  fhir:Ingredient.allergenicIndicator [ boolean ]; # 0..1 If the ingredient is a known or suspected allergen
  fhir:Ingredient.manufacturer [ Reference(Organization) ], ... ; # 0..* The organization that manufactures this ingredient
  fhir:Ingredient.substance [ # 0..1 The substance that comprises this ingredient
    fhir:Ingredient.substance.code [ CodeableReference(Substance|SubstanceDefinition) ]; # 1..1 A code or full resource that represents the ingredient substance
    fhir:Ingredient.substance.strength [ # 0..* The quantity of substance in the unit of presentation, or in the volume (or mass) of the single pharmaceutical product or manufactured item. When there is a range of strengths, this represents the lower limit
      # 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 3
        fhir:Ingredient.substance.strength.presentationRatio [ Ratio ]
        fhir:Ingredient.substance.strength.presentationCodeableConcept [ CodeableConcept ]
        fhir:Ingredient.substance.strength.presentationQuantity [ Quantity ]
      # Ingredient.substance.strength.presentationHighLimit[x] : 0..1 An upper limit for the quantity of substance in the unit of presentation. When there is a range of strengths, this represents the upper limit. One of these 2
        fhir:Ingredient.substance.strength.presentationHighLimitRatio [ Ratio ]
        fhir:Ingredient.substance.strength.presentationHighLimitQuantity [ 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 3
        fhir:Ingredient.substance.strength.concentrationRatio [ Ratio ]
        fhir:Ingredient.substance.strength.concentrationCodeableConcept [ CodeableConcept ]
        fhir:Ingredient.substance.strength.concentrationQuantity [ Quantity ]
      # Ingredient.substance.strength.concentrationHighLimit[x] : 0..1 An upper limit for the strength per unitary volume (or mass), for when there is a range. The concentration attribute then becomes the lower limit. One of these 2
        fhir:Ingredient.substance.strength.concentrationHighLimitRatio [ Ratio ]
        fhir:Ingredient.substance.strength.concentrationHighLimitQuantity [ 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(Substance|SubstanceDefinition) ]; # 0..1 Relevant reference substance
        # Ingredient.substance.strength.referenceStrength.strength[x] : 1..1 Strength expressed in terms of a reference substance. When there is a range of strengths, this represents the lower limit. One of these 2
          fhir:Ingredient.substance.strength.referenceStrength.strengthRatio [ Ratio ]
          fhir:Ingredient.substance.strength.referenceStrength.strengthQuantity [ Quantity ]
        # Ingredient.substance.strength.referenceStrength.strengthHighLimit[x] : 0..1 Strength expressed in terms of a reference substance. When there is a range of strengths, this represents the upper limit. One of these 2
          fhir:Ingredient.substance.strength.referenceStrength.strengthHighLimitRatio [ Ratio ]
          fhir:Ingredient.substance.strength.referenceStrength.strengthHighLimitQuantity [ 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
      ], ...;
    ], ...;
  ];
  fhir:Ingredient.specifiedSubstance [ # 0..* A specified substance that comprises this ingredient
    fhir:Ingredient.specifiedSubstance.code [ CodeableReference(Substance|SubstanceDefinition) ]; # 1..1 Substance as a 'specified substance', implying extra substance related characteristics
    fhir:Ingredient.specifiedSubstance.group [ CodeableConcept ]; # 1..1 The group of specified substance, e.g. group 1 to 4, where the group categorises the level of 
description of the substance according to standardised sets of properties
    fhir:Ingredient.specifiedSubstance.confidentiality [ CodeableConcept ]; # 0..1 Confidentiality level of the specified substance as the ingredient
    fhir:Ingredient.specifiedSubstance.strength [ See Ingredient.substance.strength ], ... ; # 0..* Quantity of the substance or specified substance present in the manufactured item or pharmaceutical product
  ], ...;
]

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
... role Σ1..1CodeableConceptA classification of the ingredient identifying its purpose within the product, e.g. active, inactive
... 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
... description Σ0..1markdownA general description of the ingredient, or any supporting text. May be used for an unstructured list of excipients
... allergenicIndicator Σ0..1booleanIf the ingredient is a known or suspected allergen
... manufacturer Σ0..*Reference(Organization)The organization that manufactures this ingredient
... substance Σ0..1BackboneElementThe substance that comprises this ingredient
.... code Σ1..1CodeableReference(SubstanceDefinition | Substance)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. When there is a range of strengths, this represents the lower limit
..... 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
...... presentationCodeableConceptCodeableConcept
...... presentationQuantityQuantity
..... presentationHighLimit[x] ?!Σ0..1An upper limit for the quantity of substance in the unit of presentation. When there is a range of strengths, this represents the upper limit
...... presentationHighLimitRatioRatio
...... presentationHighLimitQuantityQuantity
..... 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
...... concentrationCodeableConceptCodeableConcept
...... concentrationQuantityQuantity
..... concentrationHighLimit[x] ?!Σ0..1An upper limit for the strength per unitary volume (or mass), for when there is a range. The concentration attribute then becomes the lower limit
...... concentrationHighLimitRatioRatio
...... concentrationHighLimitQuantityQuantity
..... 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 | Substance)Relevant reference substance
...... strength[x] Σ1..1Strength expressed in terms of a reference substance. When there is a range of strengths, this represents the lower limit
....... strengthRatioRatio
....... strengthQuantityQuantity
...... strengthHighLimit[x] Σ0..1Strength expressed in terms of a reference substance. When there is a range of strengths, this represents the upper limit
....... strengthHighLimitRatioRatio
....... strengthHighLimitQuantityQuantity
...... 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
... specifiedSubstance Σ0..*BackboneElementA specified substance that comprises this ingredient
.... code Σ1..1CodeableReference(SubstanceDefinition | Substance)Substance as a 'specified substance', implying extra substance related characteristics
.... group Σ1..1CodeableConceptThe group of specified substance, e.g. group 1 to 4, where the group categorises the level of description of the substance according to standardised sets of properties
.... confidentiality Σ0..1CodeableConceptConfidentiality level of the specified substance as the ingredient
.... strength Σ0..*see strengthQuantity of the substance or specified substance present in the manufactured item or pharmaceutical product

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]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]A general description of the ingredient, or any supporting text. May be used for an unstructured list of excipientsdescription : markdown [0..1]If the ingredient is a known or suspected allergenallergenicIndicator : boolean [0..1]The organization that manufactures this ingredientmanufacturer : Reference [0..*] « Organization »SubstanceA code or full resource that represents the ingredient substancecode : DataType [1..1] « SubstanceDefinition|Substance »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|CodeableConcept|Quantity »An upper limit for the quantity of substance in the unit of presentation. When there is a range of strengths, this represents the upper limit (this element modifies the meaning of other elements)presentationHighLimit[x] : DataType [0..1] « Ratio|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|CodeableConcept|Quantity »An upper limit for the strength per unitary volume (or mass), for when there is a range. The concentration attribute then becomes the lower limit (this element modifies the meaning of other elements)concentrationHighLimit[x] : DataType [0..1] « Ratio|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|Substance »Strength expressed in terms of a reference substance. When there is a range of strengths, this represents the lower limitstrength[x] : DataType [1..1] « Ratio|Quantity »Strength expressed in terms of a reference substance. When there is a range of strengths, this represents the upper limitstrengthHighLimit[x] : DataType [0..1] « Ratio|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..*]SpecifiedSubstanceSubstance as a 'specified substance', implying extra substance related characteristicscode : DataType [1..1] « SubstanceDefinition|Substance »The group of specified substance, e.g. group 1 to 4, where the group categorises the level of description of the substance according to standardised sets of propertiesgroup : CodeableConcept [1..1]Confidentiality level of the specified substance as the ingredientconfidentiality : CodeableConcept [0..1]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 item. When there is a range of strengths, this represents the lower limitstrength[0..*]The substance that comprises this ingredientsubstance[0..1]Quantity of the substance or specified substance present in the manufactured item or pharmaceutical productstrength[0..*]A specified substance that comprises this ingredientspecifiedSubstance[0..*]

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>
 <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>
 <description value="[markdown]"/><!-- 0..1 A general description of the ingredient, or any supporting text. May be used for an unstructured list of excipients -->
 <allergenicIndicator value="[boolean]"/><!-- 0..1 If the ingredient is a known or suspected allergen -->
 <manufacturer><!-- 0..* Reference(Organization) The organization that manufactures this ingredient --></manufacturer>
 <substance>  <!-- 0..1 The substance that comprises this ingredient -->
  <code><!-- 1..1 CodeableReference(Substance|SubstanceDefinition) A code or full resource that represents the ingredient substance --></code>
  <strength>  <!-- 0..* The quantity of substance in the unit of presentation, or in the volume (or mass) of the single pharmaceutical product or manufactured item. When there is a range of strengths, this represents the lower limit -->
   <presentation[x]><!-- 0..1 Ratio|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]>
   <presentationHighLimit[x]><!-- 0..1 Ratio|Quantity An upper limit for the quantity of substance in the unit of presentation. When there is a range of strengths, this represents the upper limit --></presentationHighLimit[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|CodeableConcept|Quantity The strength per unitary volume (or mass) --></concentration[x]>
   <concentrationHighLimit[x]><!-- 0..1 Ratio|Quantity An upper limit for the strength per unitary volume (or mass), for when there is a range. The concentration attribute then becomes the lower limit --></concentrationHighLimit[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(Substance|SubstanceDefinition) Relevant reference substance --></substance>
    <strength[x]><!-- 1..1 Ratio|Quantity Strength expressed in terms of a reference substance. When there is a range of strengths, this represents the lower limit --></strength[x]>
    <strengthHighLimit[x]><!-- 0..1 Ratio|Quantity Strength expressed in terms of a reference substance. When there is a range of strengths, this represents the upper limit --></strengthHighLimit[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>
 <specifiedSubstance>  <!-- 0..* A specified substance that comprises this ingredient -->
  <code><!-- 1..1 CodeableReference(Substance|SubstanceDefinition) Substance as a 'specified substance', implying extra substance related characteristics --></code>
  <group><!-- 1..1 CodeableConcept The group of specified substance, e.g. group 1 to 4, where the group categorises the level of 
description of the substance according to standardised sets of properties --></group>
  <confidentiality><!-- 0..1 CodeableConcept Confidentiality level of the specified substance as the ingredient --></confidentiality>
  <strength><!-- 0..* Content as for Ingredient.substance.strength Quantity of the substance or specified substance present in the manufactured item or pharmaceutical product --></strength>
 </specifiedSubstance>
</Ingredient>

JSON Template

{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
  "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
  "description" : "<markdown>", // A general description of the ingredient, or any supporting text. May be used for an unstructured list of excipients
  "allergenicIndicator" : <boolean>, // If the ingredient is a known or suspected allergen
  "manufacturer" : [{ Reference(Organization) }], // The organization that manufactures this ingredient
  "substance" : { // The substance that comprises this ingredient
    "code" : { CodeableReference(Substance|SubstanceDefinition) }, // R!  A code or full resource that represents the ingredient substance
    "strength" : [{ // The quantity of substance in the unit of presentation, or in the volume (or mass) of the single pharmaceutical product or manufactured item. When there is a range of strengths, this represents the lower limit
      // presentation[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 3:
      "presentationRatio" : { Ratio },
      "presentationCodeableConcept" : { CodeableConcept },
      "presentationQuantity" : { Quantity },
      // presentationHighLimit[x]: 
       An upper limit for the quantity of substance in the unit of presentation. When there is a range of strengths, this represents the upper limit. One of these 2:
      "presentationHighLimitRatio" : { Ratio },
      "presentationHighLimitQuantity" : { 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 3:
      "concentrationRatio" : { Ratio },
      "concentrationCodeableConcept" : { CodeableConcept },
      "concentrationQuantity" : { Quantity },
      // concentrationHighLimit[x]: 
       An upper limit for the strength per unitary volume (or mass), for when there is a range. The concentration attribute then becomes the lower limit. One of these 2:
      "concentrationHighLimitRatio" : { Ratio },
      "concentrationHighLimitQuantity" : { 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(Substance|SubstanceDefinition) }, // Relevant reference substance
        // strength[x]: 
        Strength expressed in terms of a reference substance. When there is a range of strengths, this represents the lower limit. One of these 2:
        "strengthRatio" : { Ratio },
        "strengthQuantity" : { Quantity },
        // strengthHighLimit[x]: 
        Strength expressed in terms of a reference substance. When there is a range of strengths, this represents the upper limit. One of these 2:
        "strengthHighLimitRatio" : { Ratio },
        "strengthHighLimitQuantity" : { 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
      }]
    }]
  },
  "specifiedSubstance" : [{ // A specified substance that comprises this ingredient
    "code" : { CodeableReference(Substance|SubstanceDefinition) }, // R!  Substance as a 'specified substance', implying extra substance related characteristics
    "group" : { CodeableConcept }, // R!  The group of specified substance, e.g. group 1 to 4, where the group categorises the level of 
description of the substance according to standardised sets of properties
    "confidentiality" : { CodeableConcept }, // Confidentiality level of the specified substance as the ingredient
    "strength" : [{ Content as for Ingredient.substance.strength }] // Quantity of the substance or specified substance present in the manufactured item or pharmaceutical product
  }]
}

Turtle Template

@prefix fhir: <http://hl7.org/fhir/> .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.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.description [ markdown ]; # 0..1 A general description of the ingredient, or any supporting text. May be used for an unstructured list of excipients
  fhir:Ingredient.allergenicIndicator [ boolean ]; # 0..1 If the ingredient is a known or suspected allergen
  fhir:Ingredient.manufacturer [ Reference(Organization) ], ... ; # 0..* The organization that manufactures this ingredient
  fhir:Ingredient.substance [ # 0..1 The substance that comprises this ingredient
    fhir:Ingredient.substance.code [ CodeableReference(Substance|SubstanceDefinition) ]; # 1..1 A code or full resource that represents the ingredient substance
    fhir:Ingredient.substance.strength [ # 0..* The quantity of substance in the unit of presentation, or in the volume (or mass) of the single pharmaceutical product or manufactured item. When there is a range of strengths, this represents the lower limit
      # 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 3
        fhir:Ingredient.substance.strength.presentationRatio [ Ratio ]
        fhir:Ingredient.substance.strength.presentationCodeableConcept [ CodeableConcept ]
        fhir:Ingredient.substance.strength.presentationQuantity [ Quantity ]
      # Ingredient.substance.strength.presentationHighLimit[x] : 0..1 An upper limit for the quantity of substance in the unit of presentation. When there is a range of strengths, this represents the upper limit. One of these 2
        fhir:Ingredient.substance.strength.presentationHighLimitRatio [ Ratio ]
        fhir:Ingredient.substance.strength.presentationHighLimitQuantity [ 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 3
        fhir:Ingredient.substance.strength.concentrationRatio [ Ratio ]
        fhir:Ingredient.substance.strength.concentrationCodeableConcept [ CodeableConcept ]
        fhir:Ingredient.substance.strength.concentrationQuantity [ Quantity ]
      # Ingredient.substance.strength.concentrationHighLimit[x] : 0..1 An upper limit for the strength per unitary volume (or mass), for when there is a range. The concentration attribute then becomes the lower limit. One of these 2
        fhir:Ingredient.substance.strength.concentrationHighLimitRatio [ Ratio ]
        fhir:Ingredient.substance.strength.concentrationHighLimitQuantity [ 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(Substance|SubstanceDefinition) ]; # 0..1 Relevant reference substance
        # Ingredient.substance.strength.referenceStrength.strength[x] : 1..1 Strength expressed in terms of a reference substance. When there is a range of strengths, this represents the lower limit. One of these 2
          fhir:Ingredient.substance.strength.referenceStrength.strengthRatio [ Ratio ]
          fhir:Ingredient.substance.strength.referenceStrength.strengthQuantity [ Quantity ]
        # Ingredient.substance.strength.referenceStrength.strengthHighLimit[x] : 0..1 Strength expressed in terms of a reference substance. When there is a range of strengths, this represents the upper limit. One of these 2
          fhir:Ingredient.substance.strength.referenceStrength.strengthHighLimitRatio [ Ratio ]
          fhir:Ingredient.substance.strength.referenceStrength.strengthHighLimitQuantity [ 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
      ], ...;
    ], ...;
  ];
  fhir:Ingredient.specifiedSubstance [ # 0..* A specified substance that comprises this ingredient
    fhir:Ingredient.specifiedSubstance.code [ CodeableReference(Substance|SubstanceDefinition) ]; # 1..1 Substance as a 'specified substance', implying extra substance related characteristics
    fhir:Ingredient.specifiedSubstance.group [ CodeableConcept ]; # 1..1 The group of specified substance, e.g. group 1 to 4, where the group categorises the level of 
description of the substance according to standardised sets of properties
    fhir:Ingredient.specifiedSubstance.confidentiality [ CodeableConcept ]; # 0..1 Confidentiality level of the specified substance as the ingredient
    fhir:Ingredient.specifiedSubstance.strength [ See Ingredient.substance.strength ], ... ; # 0..* Quantity of the substance or specified substance present in the manufactured item or pharmaceutical product
  ], ...;
]

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

Search parameters for this resource. The common parameters also apply. See Searching for more information about searching in REST, messaging, and services.

NameTypeDescriptionExpressionIn Common
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
(Organization)
roletokenA classification of the ingredient identifying its purpose within the product, e.g. active, inactiveIngredient.role
specified-substance DreferenceReference to a resource (by instance)Ingredient.specifiedSubstance.code.reference
specified-substance-code DtokenReference to a concept (by class)Ingredient.specifiedSubstance.code.concept
specified-substance-definition DreferenceReference to a resource (by instance)Ingredient.specifiedSubstance.code.reference
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