This page is part of the FHIR Specification (v4.5.0: R5 Preview #3). 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

11.18 Resource Ingredient - Content

Biomedical Research and Regulation

Work Group

Maturity Level: 1

Trial Use

Security Category: Anonymous

Compartments: Not linked to any defined compartments

An ingredient of a manufactured item or pharmaceutical product.

11.18.1 Scope and Usage

A material used in the preparation of a medicinal/pharmaceutical product, within the context of a particular use.

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, which may include whether it is an active or inactive substance and what the stength 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. 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").

11.18.2 References

This resource is referenced by AdministrableProductDefinition, ManufacturedItemDefinition and MedicinalProductDefinition.

This resource does not implement any patterns.

Structure

Name	Flags	Card.	Type	Description & Constraints
Ingredient	Σ TU		DomainResource	An ingredient of a manufactured item or pharmaceutical product Elements defined in Ancestors: id, meta, implicitRules, language, text, contained, extension, modifierExtension
identifier	Σ	0..1	Identifier	An identifier or code by which the ingredient can be referenced
role	Σ	1..1	CodeableConcept	Ingredient role within a drug product e.g. Active ingredient, Excipient
function	Σ	0..*	CodeableConcept	A classification of the ingredient identifying its precise purpose(s) in the drug product. This extends the Ingredient.role to add more detail. Example: Antioxidant, Alkalizing Agent
description	Σ	0..1	markdown	A general description of the ingredient, or any supporting text. May be used for an unstructured list of excipients
allergenicIndicator	Σ	0..1	boolean	If the ingredient is a known or suspected allergen
manufacturer	Σ	0..*	Reference(Organization)	The organization that manufactures this ingredient
substance	Σ	0..1	BackboneElement	The substance that comprises this ingredient
code[x]	Σ	1..1		A code or full resource that represents the ingredient substance
codeCodeableConcept			CodeableConcept
codeReference			Reference(SubstanceDefinition \| Substance)
strength	Σ	0..*	BackboneElement	Quantity of the substance or specified substance present in the manufactured item or pharmaceutical product
presentation	Σ	0..1	Ratio	The quantity of substance in the unit of presentation, or in the volume (or mass) of the single pharmaceutical product or manufactured item
presentationHighLimit	?!Σ	0..1	Ratio	An upper limit for the quantity of substance in the unit of presentation. For use when there is a range of strengths, this is the high limit, with the presentation attribute becoming the lower limit
presentationText	Σ	0..1	string	A textual represention of either the whole of the presentation strength or a part of it - with the rest being in Strength.presentation as a ratio
concentration	Σ	0..1	Ratio	The strength per unitary volume (or mass)
concentrationHighLimit	?!Σ	0..1	Ratio	An upper limit for the strength per unitary volume (or mass), for when there is a range. The concentration attribute then becomes the lower limit
concentrationText	Σ	0..1	string	A textual represention of either the whole of the concentration strength or a part of it - with the rest being in Strength.concentration as a ratio
measurementPoint	Σ	0..1	string	For when strength is measured at a particular point or distance
country	Σ	0..*	CodeableConcept	The country or countries for which the strength range applies
referenceStrength	Σ	0..*	BackboneElement	Strength expressed in terms of a reference substance
substance[x]	Σ	0..1		Relevant reference substance
substanceCodeableConcept			CodeableConcept
substanceReference			Reference(SubstanceDefinition \| Substance)
strength	Σ	1..1	Ratio	Strength expressed in terms of a reference substance
strengthHighLimit	Σ	0..1	Ratio	Strength expressed in terms of a reference substance, upper limit
measurementPoint	Σ	0..1	string	For when strength is measured at a particular point or distance
country	Σ	0..*	CodeableConcept	The country or countries for which the strength range applies
specifiedSubstance	Σ	0..*	BackboneElement	A specified substance that comprises this ingredient
code[x]	Σ	1..1		Substance as a 'specified substance', implying extra substance related characteristics
codeCodeableConcept			CodeableConcept
codeReference			Reference(SubstanceDefinition \| Substance)
group	Σ	1..1	CodeableConcept	The group of specified substance, e.g. group 1 to 4
confidentiality	Σ	0..1	CodeableConcept	Confidentiality level of the specified substance as the ingredient
strength	Σ	0..*	see strength	Quantity of the substance or specified substance present in the manufactured item or pharmaceutical product
Documentation for this format

UML Diagram (Legend)

XML Template

<Ingredient xmlns="http://hl7.org/fhir"> 
 <!-- from Resource: id, meta, implicitRules, and language -->
 <!-- from DomainResource: text, contained, extension, and modifierExtension -->
 <identifier><!-- 0..1 Identifier An identifier or code by which the ingredient can be referenced --></identifier>
 <role><!-- 1..1 CodeableConcept Ingredient role within a drug product e.g. Active ingredient, Excipient --></role>
 <function><!-- 0..* CodeableConcept A classification of the ingredient identifying its precise purpose(s) in the drug product. This extends the Ingredient.role to add more detail. Example: Antioxidant, Alkalizing Agent --></function>
 <description value="[markdown]"/><!-- 0..1 A general description of the ingredient, or any supporting text. May be used for an unstructured list of excipients -->
 <allergenicIndicator value="[boolean]"/><!-- 0..1 If the ingredient is a known or suspected allergen -->
 <manufacturer><!-- 0..* Reference(Organization) The organization that manufactures this ingredient --></manufacturer>
 <substance>  <!-- 0..1 The substance that comprises this ingredient -->
  <code[x]><!-- 1..1 CodeableConcept|Reference(Substance|SubstanceDefinition) A code or full resource that represents the ingredient substance --></code[x]>
  <strength>  <!-- 0..* Quantity of the substance or specified substance present in the manufactured item or pharmaceutical product -->
   <presentation><!-- 0..1 Ratio The quantity of substance in the unit of presentation, or in the volume (or mass) of the single pharmaceutical product or manufactured item --></presentation>
   <presentationHighLimit><!-- 0..1 Ratio An upper limit for the quantity of substance in the unit of presentation. For use when there is a range of strengths, this is the high limit, with the presentation attribute becoming the lower limit --></presentationHighLimit>
   <presentationText value="[string]"/><!-- 0..1 A textual represention of either the whole of the presentation strength or a part of it - with the rest being in Strength.presentation as a ratio -->
   <concentration><!-- 0..1 Ratio The strength per unitary volume (or mass) --></concentration>
   <concentrationHighLimit><!-- 0..1 Ratio An upper limit for the strength per unitary volume (or mass), for when there is a range. The concentration attribute then becomes the lower limit --></concentrationHighLimit>
   <concentrationText value="[string]"/><!-- 0..1 A textual represention of either the whole of the concentration strength or a part of it - with the rest being in Strength.concentration as a ratio -->
   <measurementPoint value="[string]"/><!-- 0..1 For when strength is measured at a particular point or distance -->
   <country><!-- 0..* CodeableConcept The country or countries for which the strength range applies --></country>
   <referenceStrength>  <!-- 0..* Strength expressed in terms of a reference substance -->
    <substance[x]><!-- 0..1 CodeableConcept|Reference(Substance|
      SubstanceDefinition) Relevant reference substance --></substance[x]>
    <strength><!-- 1..1 Ratio Strength expressed in terms of a reference substance --></strength>
    <strengthHighLimit><!-- 0..1 Ratio Strength expressed in terms of a reference substance, upper limit --></strengthHighLimit>
    <measurementPoint value="[string]"/><!-- 0..1 For when strength is measured at a particular point or distance -->
    <country><!-- 0..* CodeableConcept The country or countries for which the strength range applies --></country>
   </referenceStrength>
  </strength>
 </substance>
 <specifiedSubstance>  <!-- 0..* A specified substance that comprises this ingredient -->
  <code[x]><!-- 1..1 CodeableConcept|Reference(Substance|SubstanceDefinition) Substance as a 'specified substance', implying extra substance related characteristics --></code[x]>
  <group><!-- 1..1 CodeableConcept The group of specified substance, e.g. group 1 to 4 --></group>
  <confidentiality><!-- 0..1 CodeableConcept Confidentiality level of the specified substance as the ingredient --></confidentiality>
  <strength><!-- 0..* Content as for Ingredient.substance.strength Quantity of the substance or specified substance present in the manufactured item or pharmaceutical product --></strength>
 </specifiedSubstance>
</Ingredient>

JSON Template

{
  "resourceType" : "Ingredient",
  // from Resource: id, meta, implicitRules, and language
  // from DomainResource: text, contained, extension, and modifierExtension
  "identifier" : { Identifier }, // An identifier or code by which the ingredient can be referenced
  "role" : { CodeableConcept }, // R!  Ingredient role within a drug product e.g. Active ingredient, Excipient
  "function" : [{ CodeableConcept }], // A classification of the ingredient identifying its precise purpose(s) in the drug product. This extends the Ingredient.role to add more detail. Example: Antioxidant, Alkalizing Agent
  "description" : "<markdown>", // A general description of the ingredient, or any supporting text. May be used for an unstructured list of excipients
  "allergenicIndicator" : <boolean>, // If the ingredient is a known or suspected allergen
  "manufacturer" : [{ Reference(Organization) }], // The organization that manufactures this ingredient
  "substance" : { // The substance that comprises this ingredient
    // code[x]: A code or full resource that represents the ingredient substance. One of these 2:
    "codeCodeableConcept" : { CodeableConcept },
    "codeReference" : { Reference(Substance|SubstanceDefinition) },
    "strength" : [{ // Quantity of the substance or specified substance present in the manufactured item or pharmaceutical product
      "presentation" : { Ratio }, // The quantity of substance in the unit of presentation, or in the volume (or mass) of the single pharmaceutical product or manufactured item
      "presentationHighLimit" : { Ratio }, // An upper limit for the quantity of substance in the unit of presentation. For use when there is a range of strengths, this is the high limit, with the presentation attribute becoming the lower limit
      "presentationText" : "<string>", // A textual represention of either the whole of the presentation strength or a part of it - with the rest being in Strength.presentation as a ratio
      "concentration" : { Ratio }, // The strength per unitary volume (or mass)
      "concentrationHighLimit" : { Ratio }, // An upper limit for the strength per unitary volume (or mass), for when there is a range. The concentration attribute then becomes the lower limit
      "concentrationText" : "<string>", // A textual represention of either the whole of the concentration strength or a part of it - with the rest being in Strength.concentration as a ratio
      "measurementPoint" : "<string>", // For when strength is measured at a particular point or distance
      "country" : [{ CodeableConcept }], // The country or countries for which the strength range applies
      "referenceStrength" : [{ // Strength expressed in terms of a reference substance
        // substance[x]: Relevant reference substance. One of these 2:
        "substanceCodeableConcept" : { CodeableConcept },
        "substanceReference" : { Reference(Substance|SubstanceDefinition) },
        "strength" : { Ratio }, // R!  Strength expressed in terms of a reference substance
        "strengthHighLimit" : { Ratio }, // Strength expressed in terms of a reference substance, upper limit
        "measurementPoint" : "<string>", // For when strength is measured at a particular point or distance
        "country" : [{ CodeableConcept }] // The country or countries for which the strength range applies
      }]
    }]
  },
  "specifiedSubstance" : [{ // A specified substance that comprises this ingredient
    // code[x]: Substance as a 'specified substance', implying extra substance related characteristics. One of these 2:
    "codeCodeableConcept" : { CodeableConcept },
    "codeReference" : { Reference(Substance|SubstanceDefinition) },
    "group" : { CodeableConcept }, // R!  The group of specified substance, e.g. group 1 to 4
    "confidentiality" : { CodeableConcept }, // Confidentiality level of the specified substance as the ingredient
    "strength" : [{ Content as for Ingredient.substance.strength }] // Quantity of the substance or specified substance present in the manufactured item or pharmaceutical product
  }]
}

Turtle Template

@prefix fhir: <http://hl7.org/fhir/> .


[ a fhir:Ingredient;
  fhir:nodeRole fhir:treeRoot; # if this is the parser root

  # from Resource: .id, .meta, .implicitRules, and .language
  # from DomainResource: .text, .contained, .extension, and .modifierExtension
  fhir:Ingredient.identifier [ Identifier ]; # 0..1 An identifier or code by which the ingredient can be referenced
  fhir:Ingredient.role [ CodeableConcept ]; # 1..1 Ingredient role within a drug product e.g. Active ingredient, Excipient
  fhir:Ingredient.function [ CodeableConcept ], ... ; # 0..* A classification of the ingredient identifying its precise purpose(s) in the drug product. This extends the Ingredient.role to add more detail. Example: Antioxidant, Alkalizing Agent
  fhir:Ingredient.description [ markdown ]; # 0..1 A general description of the ingredient, or any supporting text. May be used for an unstructured list of excipients
  fhir:Ingredient.allergenicIndicator [ boolean ]; # 0..1 If the ingredient is a known or suspected allergen
  fhir:Ingredient.manufacturer [ Reference(Organization) ], ... ; # 0..* The organization that manufactures this ingredient
  fhir:Ingredient.substance [ # 0..1 The substance that comprises this ingredient
    # Ingredient.substance.code[x] : 1..1 A code or full resource that represents the ingredient substance. One of these 2
      fhir:Ingredient.substance.codeCodeableConcept [ CodeableConcept ]
      fhir:Ingredient.substance.codeReference [ Reference(Substance|SubstanceDefinition) ]
    fhir:Ingredient.substance.strength [ # 0..* Quantity of the substance or specified substance present in the manufactured item or pharmaceutical product
      fhir:Ingredient.substance.strength.presentation [ Ratio ]; # 0..1 The quantity of substance in the unit of presentation, or in the volume (or mass) of the single pharmaceutical product or manufactured item
      fhir:Ingredient.substance.strength.presentationHighLimit [ Ratio ]; # 0..1 An upper limit for the quantity of substance in the unit of presentation. For use when there is a range of strengths, this is the high limit, with the presentation attribute becoming the lower limit
      fhir:Ingredient.substance.strength.presentationText [ string ]; # 0..1 A textual represention of either the whole of the presentation strength or a part of it - with the rest being in Strength.presentation as a ratio
      fhir:Ingredient.substance.strength.concentration [ Ratio ]; # 0..1 The strength per unitary volume (or mass)
      fhir:Ingredient.substance.strength.concentrationHighLimit [ Ratio ]; # 0..1 An upper limit for the strength per unitary volume (or mass), for when there is a range. The concentration attribute then becomes the lower limit
      fhir:Ingredient.substance.strength.concentrationText [ string ]; # 0..1 A textual represention of either the whole of the concentration strength or a part of it - with the rest being in Strength.concentration as a ratio
      fhir:Ingredient.substance.strength.measurementPoint [ string ]; # 0..1 For when strength is measured at a particular point or distance
      fhir:Ingredient.substance.strength.country [ CodeableConcept ], ... ; # 0..* The country or countries for which the strength range applies
      fhir:Ingredient.substance.strength.referenceStrength [ # 0..* Strength expressed in terms of a reference substance
        # Ingredient.substance.strength.referenceStrength.substance[x] : 0..1 Relevant reference substance. One of these 2
          fhir:Ingredient.substance.strength.referenceStrength.substanceCodeableConcept [ CodeableConcept ]
          fhir:Ingredient.substance.strength.referenceStrength.substanceReference [ Reference(Substance|SubstanceDefinition) ]
        fhir:Ingredient.substance.strength.referenceStrength.strength [ Ratio ]; # 1..1 Strength expressed in terms of a reference substance
        fhir:Ingredient.substance.strength.referenceStrength.strengthHighLimit [ Ratio ]; # 0..1 Strength expressed in terms of a reference substance, upper limit
        fhir:Ingredient.substance.strength.referenceStrength.measurementPoint [ string ]; # 0..1 For when strength is measured at a particular point or distance
        fhir:Ingredient.substance.strength.referenceStrength.country [ CodeableConcept ], ... ; # 0..* The country or countries for which the strength range applies
      ], ...;
    ], ...;
  ];
  fhir:Ingredient.specifiedSubstance [ # 0..* A specified substance that comprises this ingredient
    # Ingredient.specifiedSubstance.code[x] : 1..1 Substance as a 'specified substance', implying extra substance related characteristics. One of these 2
      fhir:Ingredient.specifiedSubstance.codeCodeableConcept [ CodeableConcept ]
      fhir:Ingredient.specifiedSubstance.codeReference [ Reference(Substance|SubstanceDefinition) ]
    fhir:Ingredient.specifiedSubstance.group [ CodeableConcept ]; # 1..1 The group of specified substance, e.g. group 1 to 4
    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

Name	Flags	Card.	Type	Description & Constraints
Ingredient	Σ TU		DomainResource	An ingredient of a manufactured item or pharmaceutical product Elements defined in Ancestors: id, meta, implicitRules, language, text, contained, extension, modifierExtension
identifier	Σ	0..1	Identifier	An identifier or code by which the ingredient can be referenced
role	Σ	1..1	CodeableConcept	Ingredient role within a drug product e.g. Active ingredient, Excipient
function	Σ	0..*	CodeableConcept	A classification of the ingredient identifying its precise purpose(s) in the drug product. This extends the Ingredient.role to add more detail. Example: Antioxidant, Alkalizing Agent
description	Σ	0..1	markdown	A general description of the ingredient, or any supporting text. May be used for an unstructured list of excipients
allergenicIndicator	Σ	0..1	boolean	If the ingredient is a known or suspected allergen
manufacturer	Σ	0..*	Reference(Organization)	The organization that manufactures this ingredient
substance	Σ	0..1	BackboneElement	The substance that comprises this ingredient
code[x]	Σ	1..1		A code or full resource that represents the ingredient substance
codeCodeableConcept			CodeableConcept
codeReference			Reference(SubstanceDefinition \| Substance)
strength	Σ	0..*	BackboneElement	Quantity of the substance or specified substance present in the manufactured item or pharmaceutical product
presentation	Σ	0..1	Ratio	The quantity of substance in the unit of presentation, or in the volume (or mass) of the single pharmaceutical product or manufactured item
presentationHighLimit	?!Σ	0..1	Ratio	An upper limit for the quantity of substance in the unit of presentation. For use when there is a range of strengths, this is the high limit, with the presentation attribute becoming the lower limit
presentationText	Σ	0..1	string	A textual represention of either the whole of the presentation strength or a part of it - with the rest being in Strength.presentation as a ratio
concentration	Σ	0..1	Ratio	The strength per unitary volume (or mass)
concentrationHighLimit	?!Σ	0..1	Ratio	An upper limit for the strength per unitary volume (or mass), for when there is a range. The concentration attribute then becomes the lower limit
concentrationText	Σ	0..1	string	A textual represention of either the whole of the concentration strength or a part of it - with the rest being in Strength.concentration as a ratio
measurementPoint	Σ	0..1	string	For when strength is measured at a particular point or distance
country	Σ	0..*	CodeableConcept	The country or countries for which the strength range applies
referenceStrength	Σ	0..*	BackboneElement	Strength expressed in terms of a reference substance
substance[x]	Σ	0..1		Relevant reference substance
substanceCodeableConcept			CodeableConcept
substanceReference			Reference(SubstanceDefinition \| Substance)
strength	Σ	1..1	Ratio	Strength expressed in terms of a reference substance
strengthHighLimit	Σ	0..1	Ratio	Strength expressed in terms of a reference substance, upper limit
measurementPoint	Σ	0..1	string	For when strength is measured at a particular point or distance
country	Σ	0..*	CodeableConcept	The country or countries for which the strength range applies
specifiedSubstance	Σ	0..*	BackboneElement	A specified substance that comprises this ingredient
code[x]	Σ	1..1		Substance as a 'specified substance', implying extra substance related characteristics
codeCodeableConcept			CodeableConcept
codeReference			Reference(SubstanceDefinition \| Substance)
group	Σ	1..1	CodeableConcept	The group of specified substance, e.g. group 1 to 4
confidentiality	Σ	0..1	CodeableConcept	Confidentiality level of the specified substance as the ingredient
strength	Σ	0..*	see strength	Quantity of the substance or specified substance present in the manufactured item or pharmaceutical product
Documentation for this format

UML Diagram (Legend)

XML Template

<Ingredient xmlns="http://hl7.org/fhir"> 
 <!-- from Resource: id, meta, implicitRules, and language -->
 <!-- from DomainResource: text, contained, extension, and modifierExtension -->
 <identifier><!-- 0..1 Identifier An identifier or code by which the ingredient can be referenced --></identifier>
 <role><!-- 1..1 CodeableConcept Ingredient role within a drug product e.g. Active ingredient, Excipient --></role>
 <function><!-- 0..* CodeableConcept A classification of the ingredient identifying its precise purpose(s) in the drug product. This extends the Ingredient.role to add more detail. Example: Antioxidant, Alkalizing Agent --></function>
 <description value="[markdown]"/><!-- 0..1 A general description of the ingredient, or any supporting text. May be used for an unstructured list of excipients -->
 <allergenicIndicator value="[boolean]"/><!-- 0..1 If the ingredient is a known or suspected allergen -->
 <manufacturer><!-- 0..* Reference(Organization) The organization that manufactures this ingredient --></manufacturer>
 <substance>  <!-- 0..1 The substance that comprises this ingredient -->
  <code[x]><!-- 1..1 CodeableConcept|Reference(Substance|SubstanceDefinition) A code or full resource that represents the ingredient substance --></code[x]>
  <strength>  <!-- 0..* Quantity of the substance or specified substance present in the manufactured item or pharmaceutical product -->
   <presentation><!-- 0..1 Ratio The quantity of substance in the unit of presentation, or in the volume (or mass) of the single pharmaceutical product or manufactured item --></presentation>
   <presentationHighLimit><!-- 0..1 Ratio An upper limit for the quantity of substance in the unit of presentation. For use when there is a range of strengths, this is the high limit, with the presentation attribute becoming the lower limit --></presentationHighLimit>
   <presentationText value="[string]"/><!-- 0..1 A textual represention of either the whole of the presentation strength or a part of it - with the rest being in Strength.presentation as a ratio -->
   <concentration><!-- 0..1 Ratio The strength per unitary volume (or mass) --></concentration>
   <concentrationHighLimit><!-- 0..1 Ratio An upper limit for the strength per unitary volume (or mass), for when there is a range. The concentration attribute then becomes the lower limit --></concentrationHighLimit>
   <concentrationText value="[string]"/><!-- 0..1 A textual represention of either the whole of the concentration strength or a part of it - with the rest being in Strength.concentration as a ratio -->
   <measurementPoint value="[string]"/><!-- 0..1 For when strength is measured at a particular point or distance -->
   <country><!-- 0..* CodeableConcept The country or countries for which the strength range applies --></country>
   <referenceStrength>  <!-- 0..* Strength expressed in terms of a reference substance -->
    <substance[x]><!-- 0..1 CodeableConcept|Reference(Substance|
      SubstanceDefinition) Relevant reference substance --></substance[x]>
    <strength><!-- 1..1 Ratio Strength expressed in terms of a reference substance --></strength>
    <strengthHighLimit><!-- 0..1 Ratio Strength expressed in terms of a reference substance, upper limit --></strengthHighLimit>
    <measurementPoint value="[string]"/><!-- 0..1 For when strength is measured at a particular point or distance -->
    <country><!-- 0..* CodeableConcept The country or countries for which the strength range applies --></country>
   </referenceStrength>
  </strength>
 </substance>
 <specifiedSubstance>  <!-- 0..* A specified substance that comprises this ingredient -->
  <code[x]><!-- 1..1 CodeableConcept|Reference(Substance|SubstanceDefinition) Substance as a 'specified substance', implying extra substance related characteristics --></code[x]>
  <group><!-- 1..1 CodeableConcept The group of specified substance, e.g. group 1 to 4 --></group>
  <confidentiality><!-- 0..1 CodeableConcept Confidentiality level of the specified substance as the ingredient --></confidentiality>
  <strength><!-- 0..* Content as for Ingredient.substance.strength Quantity of the substance or specified substance present in the manufactured item or pharmaceutical product --></strength>
 </specifiedSubstance>
</Ingredient>

JSON Template

{
  "resourceType" : "Ingredient",
  // from Resource: id, meta, implicitRules, and language
  // from DomainResource: text, contained, extension, and modifierExtension
  "identifier" : { Identifier }, // An identifier or code by which the ingredient can be referenced
  "role" : { CodeableConcept }, // R!  Ingredient role within a drug product e.g. Active ingredient, Excipient
  "function" : [{ CodeableConcept }], // A classification of the ingredient identifying its precise purpose(s) in the drug product. This extends the Ingredient.role to add more detail. Example: Antioxidant, Alkalizing Agent
  "description" : "<markdown>", // A general description of the ingredient, or any supporting text. May be used for an unstructured list of excipients
  "allergenicIndicator" : <boolean>, // If the ingredient is a known or suspected allergen
  "manufacturer" : [{ Reference(Organization) }], // The organization that manufactures this ingredient
  "substance" : { // The substance that comprises this ingredient
    // code[x]: A code or full resource that represents the ingredient substance. One of these 2:
    "codeCodeableConcept" : { CodeableConcept },
    "codeReference" : { Reference(Substance|SubstanceDefinition) },
    "strength" : [{ // Quantity of the substance or specified substance present in the manufactured item or pharmaceutical product
      "presentation" : { Ratio }, // The quantity of substance in the unit of presentation, or in the volume (or mass) of the single pharmaceutical product or manufactured item
      "presentationHighLimit" : { Ratio }, // An upper limit for the quantity of substance in the unit of presentation. For use when there is a range of strengths, this is the high limit, with the presentation attribute becoming the lower limit
      "presentationText" : "<string>", // A textual represention of either the whole of the presentation strength or a part of it - with the rest being in Strength.presentation as a ratio
      "concentration" : { Ratio }, // The strength per unitary volume (or mass)
      "concentrationHighLimit" : { Ratio }, // An upper limit for the strength per unitary volume (or mass), for when there is a range. The concentration attribute then becomes the lower limit
      "concentrationText" : "<string>", // A textual represention of either the whole of the concentration strength or a part of it - with the rest being in Strength.concentration as a ratio
      "measurementPoint" : "<string>", // For when strength is measured at a particular point or distance
      "country" : [{ CodeableConcept }], // The country or countries for which the strength range applies
      "referenceStrength" : [{ // Strength expressed in terms of a reference substance
        // substance[x]: Relevant reference substance. One of these 2:
        "substanceCodeableConcept" : { CodeableConcept },
        "substanceReference" : { Reference(Substance|SubstanceDefinition) },
        "strength" : { Ratio }, // R!  Strength expressed in terms of a reference substance
        "strengthHighLimit" : { Ratio }, // Strength expressed in terms of a reference substance, upper limit
        "measurementPoint" : "<string>", // For when strength is measured at a particular point or distance
        "country" : [{ CodeableConcept }] // The country or countries for which the strength range applies
      }]
    }]
  },
  "specifiedSubstance" : [{ // A specified substance that comprises this ingredient
    // code[x]: Substance as a 'specified substance', implying extra substance related characteristics. One of these 2:
    "codeCodeableConcept" : { CodeableConcept },
    "codeReference" : { Reference(Substance|SubstanceDefinition) },
    "group" : { CodeableConcept }, // R!  The group of specified substance, e.g. group 1 to 4
    "confidentiality" : { CodeableConcept }, // Confidentiality level of the specified substance as the ingredient
    "strength" : [{ Content as for Ingredient.substance.strength }] // Quantity of the substance or specified substance present in the manufactured item or pharmaceutical product
  }]
}

Turtle Template

@prefix fhir: <http://hl7.org/fhir/> .


[ a fhir:Ingredient;
  fhir:nodeRole fhir:treeRoot; # if this is the parser root

  # from Resource: .id, .meta, .implicitRules, and .language
  # from DomainResource: .text, .contained, .extension, and .modifierExtension
  fhir:Ingredient.identifier [ Identifier ]; # 0..1 An identifier or code by which the ingredient can be referenced
  fhir:Ingredient.role [ CodeableConcept ]; # 1..1 Ingredient role within a drug product e.g. Active ingredient, Excipient
  fhir:Ingredient.function [ CodeableConcept ], ... ; # 0..* A classification of the ingredient identifying its precise purpose(s) in the drug product. This extends the Ingredient.role to add more detail. Example: Antioxidant, Alkalizing Agent
  fhir:Ingredient.description [ markdown ]; # 0..1 A general description of the ingredient, or any supporting text. May be used for an unstructured list of excipients
  fhir:Ingredient.allergenicIndicator [ boolean ]; # 0..1 If the ingredient is a known or suspected allergen
  fhir:Ingredient.manufacturer [ Reference(Organization) ], ... ; # 0..* The organization that manufactures this ingredient
  fhir:Ingredient.substance [ # 0..1 The substance that comprises this ingredient
    # Ingredient.substance.code[x] : 1..1 A code or full resource that represents the ingredient substance. One of these 2
      fhir:Ingredient.substance.codeCodeableConcept [ CodeableConcept ]
      fhir:Ingredient.substance.codeReference [ Reference(Substance|SubstanceDefinition) ]
    fhir:Ingredient.substance.strength [ # 0..* Quantity of the substance or specified substance present in the manufactured item or pharmaceutical product
      fhir:Ingredient.substance.strength.presentation [ Ratio ]; # 0..1 The quantity of substance in the unit of presentation, or in the volume (or mass) of the single pharmaceutical product or manufactured item
      fhir:Ingredient.substance.strength.presentationHighLimit [ Ratio ]; # 0..1 An upper limit for the quantity of substance in the unit of presentation. For use when there is a range of strengths, this is the high limit, with the presentation attribute becoming the lower limit
      fhir:Ingredient.substance.strength.presentationText [ string ]; # 0..1 A textual represention of either the whole of the presentation strength or a part of it - with the rest being in Strength.presentation as a ratio
      fhir:Ingredient.substance.strength.concentration [ Ratio ]; # 0..1 The strength per unitary volume (or mass)
      fhir:Ingredient.substance.strength.concentrationHighLimit [ Ratio ]; # 0..1 An upper limit for the strength per unitary volume (or mass), for when there is a range. The concentration attribute then becomes the lower limit
      fhir:Ingredient.substance.strength.concentrationText [ string ]; # 0..1 A textual represention of either the whole of the concentration strength or a part of it - with the rest being in Strength.concentration as a ratio
      fhir:Ingredient.substance.strength.measurementPoint [ string ]; # 0..1 For when strength is measured at a particular point or distance
      fhir:Ingredient.substance.strength.country [ CodeableConcept ], ... ; # 0..* The country or countries for which the strength range applies
      fhir:Ingredient.substance.strength.referenceStrength [ # 0..* Strength expressed in terms of a reference substance
        # Ingredient.substance.strength.referenceStrength.substance[x] : 0..1 Relevant reference substance. One of these 2
          fhir:Ingredient.substance.strength.referenceStrength.substanceCodeableConcept [ CodeableConcept ]
          fhir:Ingredient.substance.strength.referenceStrength.substanceReference [ Reference(Substance|SubstanceDefinition) ]
        fhir:Ingredient.substance.strength.referenceStrength.strength [ Ratio ]; # 1..1 Strength expressed in terms of a reference substance
        fhir:Ingredient.substance.strength.referenceStrength.strengthHighLimit [ Ratio ]; # 0..1 Strength expressed in terms of a reference substance, upper limit
        fhir:Ingredient.substance.strength.referenceStrength.measurementPoint [ string ]; # 0..1 For when strength is measured at a particular point or distance
        fhir:Ingredient.substance.strength.referenceStrength.country [ CodeableConcept ], ... ; # 0..* The country or countries for which the strength range applies
      ], ...;
    ], ...;
  ];
  fhir:Ingredient.specifiedSubstance [ # 0..* A specified substance that comprises this ingredient
    # Ingredient.specifiedSubstance.code[x] : 1..1 Substance as a 'specified substance', implying extra substance related characteristics. One of these 2
      fhir:Ingredient.specifiedSubstance.codeCodeableConcept [ CodeableConcept ]
      fhir:Ingredient.specifiedSubstance.codeReference [ Reference(Substance|SubstanceDefinition) ]
    fhir:Ingredient.specifiedSubstance.group [ CodeableConcept ]; # 1..1 The group of specified substance, e.g. group 1 to 4
    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

11.18.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
function	token	A classification of the ingredient identifying its precise purpose(s) in the drug product. This extends the Ingredient.role to add more detail. Example: Antioxidant, Alkalizing Agent	Ingredient.function
identifier	token	An identifier or code by which the ingredient can be referenced	Ingredient.identifier
manufacturer	reference	The organization that manufactures this ingredient	Ingredient.manufacturer (Organization)
role	token	Ingredient role within a drug product e.g. Active ingredient, Excipient	Ingredient.role
specified-substance	reference	Substance as a 'specified substance', implying extra substance related characteristics	Ingredient.specifiedSubstance.code.where(resolve() is Substance) (Substance)
specified-substance-code	token	Substance as a 'specified substance', implying extra substance related characteristics	Ingredient.specifiedSubstance.code
specified-substance-definition	reference	Substance as a 'specified substance', implying extra substance related characteristics	Ingredient.specifiedSubstance.code.where(resolve() is SubstanceDefinition) (SubstanceDefinition)
substance	reference	A code or full resource that represents the ingredient substance	Ingredient.substance.code.where(resolve() is Substance) (Substance)
substance-code	token	A code or full resource that represents the ingredient substance	Ingredient.substance.code
substance-definition	reference	A code or full resource that represents the ingredient substance	Ingredient.substance.code.where(resolve() is SubstanceDefinition) (SubstanceDefinition)