Release 5 Preview #2

11.18 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.

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").

This resource is referenced by AdministrableProductDefinition, ManufacturedItemDefinition and MedicinalProductDefinition.

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..1CodeableConceptIngredient role within a drug product e.g. Active ingredient, Excipient
... 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
... allergenicIndicator Σ0..1booleanIf the ingredient is a known or suspected allergen
... manufacturer Σ0..*Reference(Organization)The organization that manufactures this ingredient
... specifiedSubstance Σ0..*BackboneElementA specified substance that comprises this ingredient
.... code[x] Σ1..1Substance as a 'specified substance', implying extra substance related characteristics
..... codeCodeableConceptCodeableConcept
..... codeReferenceReference(SubstanceDefinition | Substance)
.... group Σ1..1CodeableConceptThe group of specified substance, e.g. group 1 to 4
.... confidentiality Σ0..1CodeableConceptConfidentiality level of the specified substance as the ingredient
.... strength Σ0..*BackboneElementQuantity of the substance or specified substance present in the manufactured item or pharmaceutical product
..... presentation Σ0..1RatioThe quantity of substance in the unit of presentation, or in the volume (or mass) of the single pharmaceutical product or manufactured item
..... presentationHighLimit ?!Σ0..1RatioAn 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..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 Σ0..1RatioThe strength per unitary volume (or mass)
..... concentrationHighLimit ?!Σ0..1RatioAn 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..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
..... 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[x] Σ0..1Relevant reference substance
....... substanceCodeableConceptCodeableConcept
....... substanceReferenceReference(SubstanceDefinition | Substance)
...... strength Σ1..1RatioStrength expressed in terms of a reference substance
...... strengthHighLimit Σ0..1RatioStrength expressed in terms of a reference substance, upper limit
...... 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
... substance Σ0..1BackboneElementThe substance that comprises this ingredient
.... code[x] Σ1..1A code that represents the ingredient substance
..... codeCodeableConceptCodeableConcept
..... codeReferenceReference(SubstanceDefinition | Substance)
.... 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]Ingredient role within a drug product e.g. Active ingredient, Excipientrole : 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 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 »SpecifiedSubstanceSubstance as a 'specified substance', implying extra substance related characteristicscode[x] : DataType [1..1] « CodeableConcept|Reference( SubstanceDefinition|Substance) »The group of specified substance, e.g. group 1 to 4group : CodeableConcept [1..1]Confidentiality level of the specified substance as the ingredientconfidentiality : CodeableConcept [0..1]StrengthThe quantity of substance in the unit of presentation, or in the volume (or mass) of the single pharmaceutical product or manufactured itempresentation : 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 (this element modifies the meaning of other elements)presentationHighLimit : Ratio [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 ratiopresentationText : string [0..1]The strength per unitary volume (or mass)concentration : 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 (this element modifies the meaning of other elements)concentrationHighLimit : Ratio [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 ratioconcentrationText : string [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[x] : DataType [0..1] « CodeableConcept|Reference( SubstanceDefinition|Substance) »Strength expressed in terms of a reference substancestrength : Ratio [1..1]Strength expressed in terms of a reference substance, upper limitstrengthHighLimit : Ratio [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..*]SubstanceA code that represents the ingredient substancecode[x] : DataType [1..1] « CodeableConcept|Reference( SubstanceDefinition|Substance) »Strength expressed in terms of a reference substancereferenceStrength[0..*]Quantity of the substance or specified substance present in the manufactured item or pharmaceutical productstrength[0..*]A specified substance that comprises this ingredientspecifiedSubstance[0..*]Quantity of the substance or specified substance present in the manufactured item or pharmaceutical productstrength[0..*]The substance that comprises this ingredientsubstance[0..1]

XML Template

<Ingredient xmlns="http://hl7.org/fhir"> doco
 <!-- from Resource: id, meta, implicitRules, and language -->
 <!-- from DomainResource: text, contained, extension, and modifierExtension -->
 <identifier><!-- 0..1 Identifier An identifier or code by which the ingredient can be referenced --></identifier>
 <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>
 <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..* 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>
 </specifiedSubstance>
 <substance>  <!-- 0..1 The substance that comprises this ingredient -->
  <code[x]><!-- 1..1 CodeableConcept|Reference(Substance|SubstanceDefinition) A code that represents the ingredient substance --></code[x]>
  <strength><!-- 0..* Content as for Ingredient.specifiedSubstance.strength Quantity of the substance or specified substance present in the manufactured item or pharmaceutical product --></strength>
 </substance>
</Ingredient>

JSON Template

{doco
  "resourceType" : "Ingredient",
  // from Resource: id, meta, implicitRules, and language
  // from DomainResource: text, contained, extension, and modifierExtension
  "identifier" : { Identifier }, // An identifier or code by which the ingredient can be referenced
  "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
  "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" : [{ // 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
      }]
    }]
  }],
  "substance" : { // The substance that comprises this ingredient
    // code[x]: A code that represents the ingredient substance. One of these 2:
    "codeCodeableConcept" : { CodeableConcept },
    "codeReference" : { Reference(Substance|SubstanceDefinition) },
    "strength" : [{ Content as for Ingredient.specifiedSubstance.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 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.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 [ # 0..* Quantity of the substance or specified substance present in the manufactured item or pharmaceutical product
      fhir:Ingredient.specifiedSubstance.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.specifiedSubstance.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.specifiedSubstance.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.specifiedSubstance.strength.concentration [ Ratio ]; # 0..1 The strength per unitary volume (or mass)
      fhir:Ingredient.specifiedSubstance.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.specifiedSubstance.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.specifiedSubstance.strength.measurementPoint [ string ]; # 0..1 For when strength is measured at a particular point or distance
      fhir:Ingredient.specifiedSubstance.strength.country [ CodeableConcept ], ... ; # 0..* The country or countries for which the strength range applies
      fhir:Ingredient.specifiedSubstance.strength.referenceStrength [ # 0..* Strength expressed in terms of a reference substance
        # Ingredient.specifiedSubstance.strength.referenceStrength.substance[x] : 0..1 Relevant reference substance. One of these 2
          fhir:Ingredient.specifiedSubstance.strength.referenceStrength.substanceCodeableConcept [ CodeableConcept ]
          fhir:Ingredient.specifiedSubstance.strength.referenceStrength.substanceReference [ Reference(Substance|SubstanceDefinition) ]
        fhir:Ingredient.specifiedSubstance.strength.referenceStrength.strength [ Ratio ]; # 1..1 Strength expressed in terms of a reference substance
        fhir:Ingredient.specifiedSubstance.strength.referenceStrength.strengthHighLimit [ Ratio ]; # 0..1 Strength expressed in terms of a reference substance, upper limit
        fhir:Ingredient.specifiedSubstance.strength.referenceStrength.measurementPoint [ string ]; # 0..1 For when strength is measured at a particular point or distance
        fhir:Ingredient.specifiedSubstance.strength.referenceStrength.country [ CodeableConcept ], ... ; # 0..* The country or countries for which the strength range applies
      ], ...;
    ], ...;
  ], ...;
  fhir:Ingredient.substance [ # 0..1 The substance that comprises this ingredient
    # Ingredient.substance.code[x] : 1..1 A code 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 [ See Ingredient.specifiedSubstance.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..1CodeableConceptIngredient role within a drug product e.g. Active ingredient, Excipient
... 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
... allergenicIndicator Σ0..1booleanIf the ingredient is a known or suspected allergen
... manufacturer Σ0..*Reference(Organization)The organization that manufactures this ingredient
... specifiedSubstance Σ0..*BackboneElementA specified substance that comprises this ingredient
.... code[x] Σ1..1Substance as a 'specified substance', implying extra substance related characteristics
..... codeCodeableConceptCodeableConcept
..... codeReferenceReference(SubstanceDefinition | Substance)
.... group Σ1..1CodeableConceptThe group of specified substance, e.g. group 1 to 4
.... confidentiality Σ0..1CodeableConceptConfidentiality level of the specified substance as the ingredient
.... strength Σ0..*BackboneElementQuantity of the substance or specified substance present in the manufactured item or pharmaceutical product
..... presentation Σ0..1RatioThe quantity of substance in the unit of presentation, or in the volume (or mass) of the single pharmaceutical product or manufactured item
..... presentationHighLimit ?!Σ0..1RatioAn 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..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 Σ0..1RatioThe strength per unitary volume (or mass)
..... concentrationHighLimit ?!Σ0..1RatioAn 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..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
..... 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[x] Σ0..1Relevant reference substance
....... substanceCodeableConceptCodeableConcept
....... substanceReferenceReference(SubstanceDefinition | Substance)
...... strength Σ1..1RatioStrength expressed in terms of a reference substance
...... strengthHighLimit Σ0..1RatioStrength expressed in terms of a reference substance, upper limit
...... 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
... substance Σ0..1BackboneElementThe substance that comprises this ingredient
.... code[x] Σ1..1A code that represents the ingredient substance
..... codeCodeableConceptCodeableConcept
..... codeReferenceReference(SubstanceDefinition | Substance)
.... 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]Ingredient role within a drug product e.g. Active ingredient, Excipientrole : 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 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 »SpecifiedSubstanceSubstance as a 'specified substance', implying extra substance related characteristicscode[x] : DataType [1..1] « CodeableConcept|Reference( SubstanceDefinition|Substance) »The group of specified substance, e.g. group 1 to 4group : CodeableConcept [1..1]Confidentiality level of the specified substance as the ingredientconfidentiality : CodeableConcept [0..1]StrengthThe quantity of substance in the unit of presentation, or in the volume (or mass) of the single pharmaceutical product or manufactured itempresentation : 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 (this element modifies the meaning of other elements)presentationHighLimit : Ratio [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 ratiopresentationText : string [0..1]The strength per unitary volume (or mass)concentration : 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 (this element modifies the meaning of other elements)concentrationHighLimit : Ratio [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 ratioconcentrationText : string [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[x] : DataType [0..1] « CodeableConcept|Reference( SubstanceDefinition|Substance) »Strength expressed in terms of a reference substancestrength : Ratio [1..1]Strength expressed in terms of a reference substance, upper limitstrengthHighLimit : Ratio [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..*]SubstanceA code that represents the ingredient substancecode[x] : DataType [1..1] « CodeableConcept|Reference( SubstanceDefinition|Substance) »Strength expressed in terms of a reference substancereferenceStrength[0..*]Quantity of the substance or specified substance present in the manufactured item or pharmaceutical productstrength[0..*]A specified substance that comprises this ingredientspecifiedSubstance[0..*]Quantity of the substance or specified substance present in the manufactured item or pharmaceutical productstrength[0..*]The substance that comprises this ingredientsubstance[0..1]

XML Template

<Ingredient xmlns="http://hl7.org/fhir"> doco
 <!-- from Resource: id, meta, implicitRules, and language -->
 <!-- from DomainResource: text, contained, extension, and modifierExtension -->
 <identifier><!-- 0..1 Identifier An identifier or code by which the ingredient can be referenced --></identifier>
 <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>
 <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..* 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>
 </specifiedSubstance>
 <substance>  <!-- 0..1 The substance that comprises this ingredient -->
  <code[x]><!-- 1..1 CodeableConcept|Reference(Substance|SubstanceDefinition) A code that represents the ingredient substance --></code[x]>
  <strength><!-- 0..* Content as for Ingredient.specifiedSubstance.strength Quantity of the substance or specified substance present in the manufactured item or pharmaceutical product --></strength>
 </substance>
</Ingredient>

JSON Template

{doco
  "resourceType" : "Ingredient",
  // from Resource: id, meta, implicitRules, and language
  // from DomainResource: text, contained, extension, and modifierExtension
  "identifier" : { Identifier }, // An identifier or code by which the ingredient can be referenced
  "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
  "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" : [{ // 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
      }]
    }]
  }],
  "substance" : { // The substance that comprises this ingredient
    // code[x]: A code that represents the ingredient substance. One of these 2:
    "codeCodeableConcept" : { CodeableConcept },
    "codeReference" : { Reference(Substance|SubstanceDefinition) },
    "strength" : [{ Content as for Ingredient.specifiedSubstance.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 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.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 [ # 0..* Quantity of the substance or specified substance present in the manufactured item or pharmaceutical product
      fhir:Ingredient.specifiedSubstance.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.specifiedSubstance.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.specifiedSubstance.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.specifiedSubstance.strength.concentration [ Ratio ]; # 0..1 The strength per unitary volume (or mass)
      fhir:Ingredient.specifiedSubstance.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.specifiedSubstance.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.specifiedSubstance.strength.measurementPoint [ string ]; # 0..1 For when strength is measured at a particular point or distance
      fhir:Ingredient.specifiedSubstance.strength.country [ CodeableConcept ], ... ; # 0..* The country or countries for which the strength range applies
      fhir:Ingredient.specifiedSubstance.strength.referenceStrength [ # 0..* Strength expressed in terms of a reference substance
        # Ingredient.specifiedSubstance.strength.referenceStrength.substance[x] : 0..1 Relevant reference substance. One of these 2
          fhir:Ingredient.specifiedSubstance.strength.referenceStrength.substanceCodeableConcept [ CodeableConcept ]
          fhir:Ingredient.specifiedSubstance.strength.referenceStrength.substanceReference [ Reference(Substance|SubstanceDefinition) ]
        fhir:Ingredient.specifiedSubstance.strength.referenceStrength.strength [ Ratio ]; # 1..1 Strength expressed in terms of a reference substance
        fhir:Ingredient.specifiedSubstance.strength.referenceStrength.strengthHighLimit [ Ratio ]; # 0..1 Strength expressed in terms of a reference substance, upper limit
        fhir:Ingredient.specifiedSubstance.strength.referenceStrength.measurementPoint [ string ]; # 0..1 For when strength is measured at a particular point or distance
        fhir:Ingredient.specifiedSubstance.strength.referenceStrength.country [ CodeableConcept ], ... ; # 0..* The country or countries for which the strength range applies
      ], ...;
    ], ...;
  ], ...;
  fhir:Ingredient.substance [ # 0..1 The substance that comprises this ingredient
    # Ingredient.substance.code[x] : 1..1 A code 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 [ See Ingredient.specifiedSubstance.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
identifiertokenAn identifier or code by which the ingredient can be referencedIngredient.identifier
specified-substancetokenSubstance as a 'specified substance', implying extra substance related characteristics(Ingredient.specifiedSubstance.code as CodeableConcept)
substancetokenA code that represents the ingredient substance(Ingredient.substance.code as CodeableConcept)