Current Build

11.10 Resource MedicinalProductIngredient - Content

Biomedical Research and Regulation Work GroupMaturity Level: 0 Draft Compartments: Not linked to any defined compartments

An ingredient of a manufactured item or pharmaceutical product.

Material used in the preparation of a medicinal/pharmaceutical product

The ingredient is part of a Medicinal Product, either alone or in combination with other ingredients. The ingredient is also a component of a pharmaceutical product. Ingredient is equal to a substance with the indication of the specific role it is playing in the product.

This resource is referenced by MedicinalProductPackaged and MedicinalProductPharmaceutical

Structure

NameFlagsCard.TypeDescription & Constraintsdoco
.. MedicinalProductIngredient ΣDDomainResourceAn ingredient of a manufactured item or pharmaceutical product
Elements defined in Ancestors: id, meta, implicitRules, language, text, contained, extension, modifierExtension
... identifier Σ0..1IdentifierIdentifier for the ingredient
... role Σ1..1CodeableConceptIngredient role e.g. Active ingredient, excipient
... allergenicIndicator Σ0..1booleanIf the ingredient is a known or suspected allergen
... manufacturer Σ0..*Reference(Organization)Manufacturer of this Ingredient
... specifiedSubstance Σ0..*BackboneElementA specified substance that comprises this ingredient
.... code Σ1..1CodeableConceptThe specified 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 Σ1..1RatioThe quantity of substance in the unit of presentation, or in the volume (or mass) of the single pharmaceutical product or manufactured item
..... concentration Σ0..1RatioThe strength per unitary volume (or mass)
..... 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..1CodeableConceptRelevent refrerence substance
... substance Σ0..1BackboneElementThe ingredient substance
.... code Σ1..1CodeableConceptThe ingredient substance
.... strength Σ1..*see strengthQuantity of the substance or specified substance present in the manufactured item or pharmaceutical product

doco Documentation for this format

UML Diagram (Legend)

MedicinalProductIngredient (DomainResource)The identifier(s) of this Ingredient t 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 e.g. Active ingredient, excipientrole : CodeableConcept [1..1]If the ingredient is a known or suspected allergenallergenicIndicator : boolean [0..1]Manufacturer of this Ingredientmanufacturer : Reference [0..*] « Organization »SpecifiedSubstanceThe specified substancecode : CodeableConcept [1..1]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 [1..1]The strength per unitary volume (or mass)concentration : 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..*]ReferenceStrengthRelevent refrerence substancesubstance : CodeableConcept [0..1]SubstanceThe ingredient substancecode : CodeableConcept [1..1]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[1..*]The ingredient substancesubstance[0..1]

XML Template

<MedicinalProductIngredient xmlns="http://hl7.org/fhir"> doco
 <!-- from Resource: id, meta, implicitRules, and language -->
 <!-- from DomainResource: text, contained, extension, and modifierExtension -->
 <identifier><!-- 0..1 Identifier Identifier for the ingredient --></identifier>
 <role><!-- 1..1 CodeableConcept Ingredient role e.g. Active ingredient, excipient --></role>
 <allergenicIndicator value="[boolean]"/><!-- 0..1 If the ingredient is a known or suspected allergen -->
 <manufacturer><!-- 0..* Reference(Organization) Manufacturer of this Ingredient --></manufacturer>
 <specifiedSubstance>  <!-- 0..* A specified substance that comprises this ingredient -->
  <code><!-- 1..1 CodeableConcept The specified substance --></code>
  <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><!-- 1..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>
   <concentration><!-- 0..1 Ratio The strength per unitary volume (or mass) --></concentration>
   <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 CodeableConcept Relevent refrerence substance --></substance>
   </referenceStrength>
  </strength>
 </specifiedSubstance>
 <substance>  <!-- 0..1 The ingredient substance -->
  <code><!-- 1..1 CodeableConcept The ingredient substance --></code>
  <strength><!-- 1..* Content as for MedicinalProductIngredient.specifiedSubstance.strength Quantity of the substance or specified substance present in the manufactured item or pharmaceutical product --></strength>
 </substance>
</MedicinalProductIngredient>

JSON Template

{doco
  "resourceType" : "MedicinalProductIngredient",
  // from Resource: id, meta, implicitRules, and language
  // from DomainResource: text, contained, extension, and modifierExtension
  "identifier" : { Identifier }, // Identifier for the ingredient
  "role" : { CodeableConcept }, // R!  Ingredient role e.g. Active ingredient, excipient
  "allergenicIndicator" : <boolean>, // If the ingredient is a known or suspected allergen
  "manufacturer" : [{ Reference(Organization) }], // Manufacturer of this Ingredient
  "specifiedSubstance" : [{ // A specified substance that comprises this ingredient
    "code" : { CodeableConcept }, // R!  The specified substance
    "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 }, // R!  The quantity of substance in the unit of presentation, or in the volume (or mass) of the single pharmaceutical product or manufactured item
      "concentration" : { Ratio }, // The strength per unitary volume (or mass)
      "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" : { CodeableConcept } // Relevent refrerence substance
      }]
    }]
  }],
  "substance" : { // The ingredient substance
    "code" : { CodeableConcept }, // R!  The ingredient substance
    "strength" : [{ Content as for MedicinalProductIngredient.specifiedSubstance.strength }] // R!  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:MedicinalProductIngredient;
  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:MedicinalProductIngredient.identifier [ Identifier ]; # 0..1 Identifier for the ingredient
  fhir:MedicinalProductIngredient.role [ CodeableConcept ]; # 1..1 Ingredient role e.g. Active ingredient, excipient
  fhir:MedicinalProductIngredient.allergenicIndicator [ boolean ]; # 0..1 If the ingredient is a known or suspected allergen
  fhir:MedicinalProductIngredient.manufacturer [ Reference(Organization) ], ... ; # 0..* Manufacturer of this Ingredient
  fhir:MedicinalProductIngredient.specifiedSubstance [ # 0..* A specified substance that comprises this ingredient
    fhir:MedicinalProductIngredient.specifiedSubstance.code [ CodeableConcept ]; # 1..1 The specified substance
    fhir:MedicinalProductIngredient.specifiedSubstance.group [ CodeableConcept ]; # 1..1 The group of specified substance, e.g. group 1 to 4
    fhir:MedicinalProductIngredient.specifiedSubstance.confidentiality [ CodeableConcept ]; # 0..1 Confidentiality level of the specified substance as the ingredient
    fhir:MedicinalProductIngredient.specifiedSubstance.strength [ # 0..* Quantity of the substance or specified substance present in the manufactured item or pharmaceutical product
      fhir:MedicinalProductIngredient.specifiedSubstance.strength.presentation [ Ratio ]; # 1..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:MedicinalProductIngredient.specifiedSubstance.strength.concentration [ Ratio ]; # 0..1 The strength per unitary volume (or mass)
      fhir:MedicinalProductIngredient.specifiedSubstance.strength.measurementPoint [ string ]; # 0..1 For when strength is measured at a particular point or distance
      fhir:MedicinalProductIngredient.specifiedSubstance.strength.country [ CodeableConcept ], ... ; # 0..* The country or countries for which the strength range applies
      fhir:MedicinalProductIngredient.specifiedSubstance.strength.referenceStrength [ # 0..* Strength expressed in terms of a reference substance
        fhir:MedicinalProductIngredient.specifiedSubstance.strength.referenceStrength.substance [ CodeableConcept ]; # 0..1 Relevent refrerence substance
      ], ...;
    ], ...;
  ], ...;
  fhir:MedicinalProductIngredient.substance [ # 0..1 The ingredient substance
    fhir:MedicinalProductIngredient.substance.code [ CodeableConcept ]; # 1..1 The ingredient substance
    fhir:MedicinalProductIngredient.substance.strength [ See MedicinalProductIngredient.specifiedSubstance.strength ], ... ; # 1..* 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
.. MedicinalProductIngredient ΣDDomainResourceAn ingredient of a manufactured item or pharmaceutical product
Elements defined in Ancestors: id, meta, implicitRules, language, text, contained, extension, modifierExtension
... identifier Σ0..1IdentifierIdentifier for the ingredient
... role Σ1..1CodeableConceptIngredient role e.g. Active ingredient, excipient
... allergenicIndicator Σ0..1booleanIf the ingredient is a known or suspected allergen
... manufacturer Σ0..*Reference(Organization)Manufacturer of this Ingredient
... specifiedSubstance Σ0..*BackboneElementA specified substance that comprises this ingredient
.... code Σ1..1CodeableConceptThe specified 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 Σ1..1RatioThe quantity of substance in the unit of presentation, or in the volume (or mass) of the single pharmaceutical product or manufactured item
..... concentration Σ0..1RatioThe strength per unitary volume (or mass)
..... 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..1CodeableConceptRelevent refrerence substance
... substance Σ0..1BackboneElementThe ingredient substance
.... code Σ1..1CodeableConceptThe ingredient substance
.... strength Σ1..*see strengthQuantity of the substance or specified substance present in the manufactured item or pharmaceutical product

doco Documentation for this format

UML Diagram (Legend)

MedicinalProductIngredient (DomainResource)The identifier(s) of this Ingredient t 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 e.g. Active ingredient, excipientrole : CodeableConcept [1..1]If the ingredient is a known or suspected allergenallergenicIndicator : boolean [0..1]Manufacturer of this Ingredientmanufacturer : Reference [0..*] « Organization »SpecifiedSubstanceThe specified substancecode : CodeableConcept [1..1]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 [1..1]The strength per unitary volume (or mass)concentration : 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..*]ReferenceStrengthRelevent refrerence substancesubstance : CodeableConcept [0..1]SubstanceThe ingredient substancecode : CodeableConcept [1..1]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[1..*]The ingredient substancesubstance[0..1]

XML Template

<MedicinalProductIngredient xmlns="http://hl7.org/fhir"> doco
 <!-- from Resource: id, meta, implicitRules, and language -->
 <!-- from DomainResource: text, contained, extension, and modifierExtension -->
 <identifier><!-- 0..1 Identifier Identifier for the ingredient --></identifier>
 <role><!-- 1..1 CodeableConcept Ingredient role e.g. Active ingredient, excipient --></role>
 <allergenicIndicator value="[boolean]"/><!-- 0..1 If the ingredient is a known or suspected allergen -->
 <manufacturer><!-- 0..* Reference(Organization) Manufacturer of this Ingredient --></manufacturer>
 <specifiedSubstance>  <!-- 0..* A specified substance that comprises this ingredient -->
  <code><!-- 1..1 CodeableConcept The specified substance --></code>
  <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><!-- 1..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>
   <concentration><!-- 0..1 Ratio The strength per unitary volume (or mass) --></concentration>
   <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 CodeableConcept Relevent refrerence substance --></substance>
   </referenceStrength>
  </strength>
 </specifiedSubstance>
 <substance>  <!-- 0..1 The ingredient substance -->
  <code><!-- 1..1 CodeableConcept The ingredient substance --></code>
  <strength><!-- 1..* Content as for MedicinalProductIngredient.specifiedSubstance.strength Quantity of the substance or specified substance present in the manufactured item or pharmaceutical product --></strength>
 </substance>
</MedicinalProductIngredient>

JSON Template

{doco
  "resourceType" : "MedicinalProductIngredient",
  // from Resource: id, meta, implicitRules, and language
  // from DomainResource: text, contained, extension, and modifierExtension
  "identifier" : { Identifier }, // Identifier for the ingredient
  "role" : { CodeableConcept }, // R!  Ingredient role e.g. Active ingredient, excipient
  "allergenicIndicator" : <boolean>, // If the ingredient is a known or suspected allergen
  "manufacturer" : [{ Reference(Organization) }], // Manufacturer of this Ingredient
  "specifiedSubstance" : [{ // A specified substance that comprises this ingredient
    "code" : { CodeableConcept }, // R!  The specified substance
    "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 }, // R!  The quantity of substance in the unit of presentation, or in the volume (or mass) of the single pharmaceutical product or manufactured item
      "concentration" : { Ratio }, // The strength per unitary volume (or mass)
      "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" : { CodeableConcept } // Relevent refrerence substance
      }]
    }]
  }],
  "substance" : { // The ingredient substance
    "code" : { CodeableConcept }, // R!  The ingredient substance
    "strength" : [{ Content as for MedicinalProductIngredient.specifiedSubstance.strength }] // R!  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:MedicinalProductIngredient;
  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:MedicinalProductIngredient.identifier [ Identifier ]; # 0..1 Identifier for the ingredient
  fhir:MedicinalProductIngredient.role [ CodeableConcept ]; # 1..1 Ingredient role e.g. Active ingredient, excipient
  fhir:MedicinalProductIngredient.allergenicIndicator [ boolean ]; # 0..1 If the ingredient is a known or suspected allergen
  fhir:MedicinalProductIngredient.manufacturer [ Reference(Organization) ], ... ; # 0..* Manufacturer of this Ingredient
  fhir:MedicinalProductIngredient.specifiedSubstance [ # 0..* A specified substance that comprises this ingredient
    fhir:MedicinalProductIngredient.specifiedSubstance.code [ CodeableConcept ]; # 1..1 The specified substance
    fhir:MedicinalProductIngredient.specifiedSubstance.group [ CodeableConcept ]; # 1..1 The group of specified substance, e.g. group 1 to 4
    fhir:MedicinalProductIngredient.specifiedSubstance.confidentiality [ CodeableConcept ]; # 0..1 Confidentiality level of the specified substance as the ingredient
    fhir:MedicinalProductIngredient.specifiedSubstance.strength [ # 0..* Quantity of the substance or specified substance present in the manufactured item or pharmaceutical product
      fhir:MedicinalProductIngredient.specifiedSubstance.strength.presentation [ Ratio ]; # 1..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:MedicinalProductIngredient.specifiedSubstance.strength.concentration [ Ratio ]; # 0..1 The strength per unitary volume (or mass)
      fhir:MedicinalProductIngredient.specifiedSubstance.strength.measurementPoint [ string ]; # 0..1 For when strength is measured at a particular point or distance
      fhir:MedicinalProductIngredient.specifiedSubstance.strength.country [ CodeableConcept ], ... ; # 0..* The country or countries for which the strength range applies
      fhir:MedicinalProductIngredient.specifiedSubstance.strength.referenceStrength [ # 0..* Strength expressed in terms of a reference substance
        fhir:MedicinalProductIngredient.specifiedSubstance.strength.referenceStrength.substance [ CodeableConcept ]; # 0..1 Relevent refrerence substance
      ], ...;
    ], ...;
  ], ...;
  fhir:MedicinalProductIngredient.substance [ # 0..1 The ingredient substance
    fhir:MedicinalProductIngredient.substance.code [ CodeableConcept ]; # 1..1 The ingredient substance
    fhir:MedicinalProductIngredient.substance.strength [ See MedicinalProductIngredient.specifiedSubstance.strength ], ... ; # 1..* Quantity of the substance or specified substance present in the manufactured item or pharmaceutical product
  ];
]

Changes since DSTU2

This resource did not exist in Release 2

This analysis is available as XML or JSON.

 

Alternate definitions: Master Definition XML + JSON, XML Schema/Schematron + JSON Schema, ShEx (for Turtle) + see the extensions & the dependency analysis