UMC IDMP Request and Publish API
0.1.0 - CI Build International flag

UMC IDMP Request and Publish API, published by Uppsala Monitoring Centre. This guide is not an authorized publication; it is the continuous build for version 0.1.0 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/Uppsala-Monitoring-Centre/WHO-UMC-IDMP-Service/ and changes regularly. See the Directory of published versions

Resource Profile: Ingredient (WHO PhP)

Official URL: http://who-umc.org/idmp/StructureDefinition/Ingredient-who-php Version: 0.1.0
Active as of 2025-05-09 Computable Name: IngredientWhoPhP

This profile specified how the Ingredient is used in a PhPID request (as contained resource in a MedicinalProductDefinition) by the WHO-UMC PhP HL7 FHIR Service

Usage:

Formal Views of Profile Content

Description of Profiles, Differentials, Snapshots and how the different presentations work.

NameFlagsCard.TypeDescription & Constraintsdoco
.. Ingredient C 0..* Ingredient An ingredient of a manufactured item or pharmaceutical product
dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources
dom-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource
dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated
dom-5: If a resource is contained in another resource, it SHALL NOT have a security label
dom-6: A resource should have narrative for robust management
ing-1: If an ingredient is noted as an allergen (allergenicIndicator) then its substance should be a code. If the substance is a SubstanceDefinition, then the allegen information should be documented in that resource
presentation-required: Either presentationRatio or presentationQuantity or textPresentation MUST be populated
... id Σ 1..1 id Logical id of this artifact
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
ele-1: All FHIR elements must have a @value or children
... contained 0..* Resource Contained, inline Resources
... status ?!Σ 1..1 code Not used in this profile
Binding: PublicationStatus (required): The lifecycle status of an artifact.


ele-1: All FHIR elements must have a @value or children
... for Σ 0..* Reference(MedicinalProductDefinition for PhPID request) The product which this ingredient is a constituent part of
ele-1: All FHIR elements must have a @value or children
... role Σ 1..1 CodeableConcept Purpose of the ingredient within the product, e.g. active, inactive
Binding: IngredientRole (example)
ele-1: All FHIR elements must have a @value or children
... allergenicIndicator ΣC 0..1 boolean Not used in this profile
ele-1: All FHIR elements must have a @value or children
... manufacturer Σ 0..* BackboneElement Not used in this profile
ele-1: All FHIR elements must have a @value or children
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
.... manufacturer Σ 1..1 Reference(Organization) An organization that manufactures this ingredient
ele-1: All FHIR elements must have a @value or children
... substance ΣC 1..1 BackboneElement The substance that comprises this ingredient
ele-1: All FHIR elements must have a @value or children
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
.... code ΣC 1..1 CodeableReference(SubstanceDefinition) A code or full resource that represents the ingredient substance
Binding: SNOMEDCTSubstanceCodes (example): This value set includes all substance codes from SNOMED CT - provided as an exemplar value set.


ele-1: All FHIR elements must have a @value or children
.... strength Σ 1..1 BackboneElement The quantity of substance, per presentation, or per volume or mass, and type of quantity.
ele-1: All FHIR elements must have a @value or children
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
..... presentation[x] Σ 0..1 The quantity of substance in the unit of presentation
ele-1: All FHIR elements must have a @value or children
...... presentationRatio Ratio
...... presentationQuantity Quantity
..... textPresentation Σ 0..1 string Should only be used if the strength cannot be coded.
ele-1: All FHIR elements must have a @value or children
..... textConcentration Σ 0..1 string Not used in this profile
ele-1: All FHIR elements must have a @value or children

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
Ingredient.statusrequiredPublicationStatus
http://hl7.org/fhir/ValueSet/publication-status|5.0.0
from the FHIR Standard
Ingredient.roleexampleIngredientRole
http://hl7.org/fhir/ValueSet/ingredient-role
from the FHIR Standard
Ingredient.substance.codeexampleSNOMEDCTSubstanceCodes
http://hl7.org/fhir/ValueSet/substance-codes
from the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
presentation-requirederrorIngredientEither presentationRatio or presentationQuantity or textPresentation MUST be populated
: substance.strength.presentation.ofType(Ratio).exists() or substance.strength.presentation.ofType(Quantity).exists() or substance.strength.textPresentation.exists()

This structure is derived from Ingredient

NameFlagsCard.TypeDescription & Constraintsdoco
.. Ingredient C 0..* Ingredient An ingredient of a manufactured item or pharmaceutical product
presentation-required: Either presentationRatio or presentationQuantity or textPresentation MUST be populated
... id 1..1 id Logical id of this artifact
... status 1..1 code Not used in this profile
... for 0..* Reference(MedicinalProductDefinition for PhPID request) The product which this ingredient is a constituent part of
... allergenicIndicator 0..1 boolean Not used in this profile
... manufacturer 0..* BackboneElement Not used in this profile
... substance
.... code
..... concept
...... coding 0..1 Coding Code defined by a terminology system
....... system 1..1 uri Identity of the terminology system
....... code 1..1 code Symbol in syntax defined by the system
...... text 1..1 string Plain text representation of the concept
.... strength 1..1 BackboneElement The quantity of substance, per presentation, or per volume or mass, and type of quantity.
..... presentation[x] 0..1 The quantity of substance in the unit of presentation
...... presentationRatio Ratio
...... presentationQuantity Quantity
..... textPresentation 0..1 string Should only be used if the strength cannot be coded.
..... textConcentration 0..1 string Not used in this profile

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSetURI
Ingredient.roleexampleIngredientRole
http://hl7.org/fhir/ValueSet/ingredient-role
from the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
presentation-requirederrorIngredientEither presentationRatio or presentationQuantity or textPresentation MUST be populated
: substance.strength.presentation.ofType(Ratio).exists() or substance.strength.presentation.ofType(Quantity).exists() or substance.strength.textPresentation.exists()
NameFlagsCard.TypeDescription & Constraintsdoco
.. Ingredient C 0..* Ingredient An ingredient of a manufactured item or pharmaceutical product
ing-1: If an ingredient is noted as an allergen (allergenicIndicator) then its substance should be a code. If the substance is a SubstanceDefinition, then the allegen information should be documented in that resource
presentation-required: Either presentationRatio or presentationQuantity or textPresentation MUST be populated
... id Σ 1..1 id Logical id of this artifact
... meta Σ 0..1 Meta Metadata about the resource
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... text 0..1 Narrative Text summary of the resource, for human interpretation
... contained 0..* Resource Contained, inline Resources
... extension 0..* Extension Additional content defined by implementations
... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored
... identifier Σ 0..1 Identifier An identifier or code by which the ingredient can be referenced
... status ?!Σ 1..1 code Not used in this profile
Binding: PublicationStatus (required): The lifecycle status of an artifact.

... for Σ 0..* Reference(MedicinalProductDefinition for PhPID request) The product which this ingredient is a constituent part of
... role Σ 1..1 CodeableConcept Purpose of the ingredient within the product, e.g. active, inactive
Binding: IngredientRole (example)
... function Σ 0..* CodeableConcept Precise action within the drug product, e.g. antioxidant, alkalizing agent
Binding: IngredientFunction (example): A classification of the ingredient identifying its precise purpose(s) in the drug product (beyond e.g. active/inactive).


... group Σ 0..1 CodeableConcept A classification of the ingredient according to where in the physical item it tends to be used, such the outer shell of a tablet, inner body or ink
... allergenicIndicator ΣC 0..1 boolean Not used in this profile
... comment 0..1 markdown A place for providing any notes that are relevant to the component, e.g. removed during process, adjusted for loss on drying
... manufacturer Σ 0..* BackboneElement Not used in this profile
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... role Σ 0..1 code allowed | possible | actual
Binding: IngredientManufacturerRole (required): The way in which this manufacturer is associated with the ingredient.

.... manufacturer Σ 1..1 Reference(Organization) An organization that manufactures this ingredient
... substance ΣC 1..1 BackboneElement The substance that comprises this ingredient
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... code ΣC 1..1 CodeableReference(SubstanceDefinition) A code or full resource that represents the ingredient substance
Binding: SNOMEDCTSubstanceCodes (example): This value set includes all substance codes from SNOMED CT - provided as an exemplar value set.

..... id 0..1 id Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... concept Σ 0..1 CodeableConcept Reference to a concept (by class)
...... id 0..1 id Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
...... coding Σ 0..1 Coding Code defined by a terminology system
....... id 0..1 id Unique id for inter-element referencing
....... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
....... system Σ 1..1 uri Identity of the terminology system
....... version Σ 0..1 string Version of the system - if relevant
....... code ΣC 1..1 code Symbol in syntax defined by the system
....... display ΣC 0..1 string Representation defined by the system
....... userSelected Σ 0..1 boolean If this coding was chosen directly by the user
...... text Σ 1..1 string Plain text representation of the concept
..... reference Σ 0..1 Reference() Reference to a resource (by instance)
.... strength Σ 1..1 BackboneElement The quantity of substance, per presentation, or per volume or mass, and type of quantity.
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... presentation[x] Σ 0..1 The quantity of substance in the unit of presentation
...... presentationRatio Ratio
...... presentationQuantity Quantity
..... textPresentation Σ 0..1 string Should only be used if the strength cannot be coded.
..... concentration[x] Σ 0..1 The strength per unitary volume (or mass)
...... concentrationRatio Ratio
...... concentrationRatioRange RatioRange
...... concentrationCodeableConcept CodeableConcept
...... concentrationQuantity Quantity
..... textConcentration Σ 0..1 string Not used in this profile
..... basis Σ 0..1 CodeableConcept A code that indicates if the strength is, for example, based on the ingredient substance as stated or on the substance base (when the ingredient is a salt)
..... measurementPoint Σ 0..1 string When strength is measured at a particular point or distance
..... country Σ 0..* CodeableConcept Where the strength range applies
Binding: CountryValueSet (example): Jurisdiction codes


..... referenceStrength Σ 0..* BackboneElement Strength expressed in terms of a reference substance
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
...... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
...... substance Σ 1..1 CodeableReference(SubstanceDefinition) Relevant reference substance
Binding: SNOMEDCTSubstanceCodes (example): This value set includes all substance codes from SNOMED CT - provided as an exemplar value set.

...... strength[x] Σ 1..1 Strength expressed in terms of a reference substance
....... strengthRatio Ratio
....... strengthRatioRange RatioRange
....... strengthQuantity Quantity
...... measurementPoint Σ 0..1 string When strength is measured at a particular point or distance
...... country Σ 0..* CodeableConcept Where the strength range applies
Binding: CountryValueSet (example): Jurisdiction codes



doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
Ingredient.languagerequiredAllLanguages
http://hl7.org/fhir/ValueSet/all-languages|5.0.0
from the FHIR Standard
Ingredient.statusrequiredPublicationStatus
http://hl7.org/fhir/ValueSet/publication-status|5.0.0
from the FHIR Standard
Ingredient.roleexampleIngredientRole
http://hl7.org/fhir/ValueSet/ingredient-role
from the FHIR Standard
Ingredient.functionexampleIngredientFunction
http://hl7.org/fhir/ValueSet/ingredient-function
from the FHIR Standard
Ingredient.manufacturer.rolerequiredIngredientManufacturerRole
http://hl7.org/fhir/ValueSet/ingredient-manufacturer-role|5.0.0
from the FHIR Standard
Ingredient.substance.codeexampleSNOMEDCTSubstanceCodes
http://hl7.org/fhir/ValueSet/substance-codes
from the FHIR Standard
Ingredient.substance.strength.countryexampleCountryValueSet
http://hl7.org/fhir/ValueSet/country
from the FHIR Standard
Ingredient.substance.strength.referenceStrength.substanceexampleSNOMEDCTSubstanceCodes
http://hl7.org/fhir/ValueSet/substance-codes
from the FHIR Standard
Ingredient.substance.strength.referenceStrength.countryexampleCountryValueSet
http://hl7.org/fhir/ValueSet/country
from the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
presentation-requirederrorIngredientEither presentationRatio or presentationQuantity or textPresentation MUST be populated
: substance.strength.presentation.ofType(Ratio).exists() or substance.strength.presentation.ofType(Quantity).exists() or substance.strength.textPresentation.exists()

This structure is derived from Ingredient

Summary

Mandatory: 2 elements(3 nested mandatory elements)

Structures

This structure refers to these other structures:

Key Elements View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Ingredient C 0..* Ingredient An ingredient of a manufactured item or pharmaceutical product
dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources
dom-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource
dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated
dom-5: If a resource is contained in another resource, it SHALL NOT have a security label
dom-6: A resource should have narrative for robust management
ing-1: If an ingredient is noted as an allergen (allergenicIndicator) then its substance should be a code. If the substance is a SubstanceDefinition, then the allegen information should be documented in that resource
presentation-required: Either presentationRatio or presentationQuantity or textPresentation MUST be populated
... id Σ 1..1 id Logical id of this artifact
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
ele-1: All FHIR elements must have a @value or children
... contained 0..* Resource Contained, inline Resources
... status ?!Σ 1..1 code Not used in this profile
Binding: PublicationStatus (required): The lifecycle status of an artifact.


ele-1: All FHIR elements must have a @value or children
... for Σ 0..* Reference(MedicinalProductDefinition for PhPID request) The product which this ingredient is a constituent part of
ele-1: All FHIR elements must have a @value or children
... role Σ 1..1 CodeableConcept Purpose of the ingredient within the product, e.g. active, inactive
Binding: IngredientRole (example)
ele-1: All FHIR elements must have a @value or children
... allergenicIndicator ΣC 0..1 boolean Not used in this profile
ele-1: All FHIR elements must have a @value or children
... manufacturer Σ 0..* BackboneElement Not used in this profile
ele-1: All FHIR elements must have a @value or children
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
.... manufacturer Σ 1..1 Reference(Organization) An organization that manufactures this ingredient
ele-1: All FHIR elements must have a @value or children
... substance ΣC 1..1 BackboneElement The substance that comprises this ingredient
ele-1: All FHIR elements must have a @value or children
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
.... code ΣC 1..1 CodeableReference(SubstanceDefinition) A code or full resource that represents the ingredient substance
Binding: SNOMEDCTSubstanceCodes (example): This value set includes all substance codes from SNOMED CT - provided as an exemplar value set.


ele-1: All FHIR elements must have a @value or children
.... strength Σ 1..1 BackboneElement The quantity of substance, per presentation, or per volume or mass, and type of quantity.
ele-1: All FHIR elements must have a @value or children
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
..... presentation[x] Σ 0..1 The quantity of substance in the unit of presentation
ele-1: All FHIR elements must have a @value or children
...... presentationRatio Ratio
...... presentationQuantity Quantity
..... textPresentation Σ 0..1 string Should only be used if the strength cannot be coded.
ele-1: All FHIR elements must have a @value or children
..... textConcentration Σ 0..1 string Not used in this profile
ele-1: All FHIR elements must have a @value or children

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
Ingredient.statusrequiredPublicationStatus
http://hl7.org/fhir/ValueSet/publication-status|5.0.0
from the FHIR Standard
Ingredient.roleexampleIngredientRole
http://hl7.org/fhir/ValueSet/ingredient-role
from the FHIR Standard
Ingredient.substance.codeexampleSNOMEDCTSubstanceCodes
http://hl7.org/fhir/ValueSet/substance-codes
from the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
presentation-requirederrorIngredientEither presentationRatio or presentationQuantity or textPresentation MUST be populated
: substance.strength.presentation.ofType(Ratio).exists() or substance.strength.presentation.ofType(Quantity).exists() or substance.strength.textPresentation.exists()

Differential View

This structure is derived from Ingredient

NameFlagsCard.TypeDescription & Constraintsdoco
.. Ingredient C 0..* Ingredient An ingredient of a manufactured item or pharmaceutical product
presentation-required: Either presentationRatio or presentationQuantity or textPresentation MUST be populated
... id 1..1 id Logical id of this artifact
... status 1..1 code Not used in this profile
... for 0..* Reference(MedicinalProductDefinition for PhPID request) The product which this ingredient is a constituent part of
... allergenicIndicator 0..1 boolean Not used in this profile
... manufacturer 0..* BackboneElement Not used in this profile
... substance
.... code
..... concept
...... coding 0..1 Coding Code defined by a terminology system
....... system 1..1 uri Identity of the terminology system
....... code 1..1 code Symbol in syntax defined by the system
...... text 1..1 string Plain text representation of the concept
.... strength 1..1 BackboneElement The quantity of substance, per presentation, or per volume or mass, and type of quantity.
..... presentation[x] 0..1 The quantity of substance in the unit of presentation
...... presentationRatio Ratio
...... presentationQuantity Quantity
..... textPresentation 0..1 string Should only be used if the strength cannot be coded.
..... textConcentration 0..1 string Not used in this profile

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSetURI
Ingredient.roleexampleIngredientRole
http://hl7.org/fhir/ValueSet/ingredient-role
from the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
presentation-requirederrorIngredientEither presentationRatio or presentationQuantity or textPresentation MUST be populated
: substance.strength.presentation.ofType(Ratio).exists() or substance.strength.presentation.ofType(Quantity).exists() or substance.strength.textPresentation.exists()

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Ingredient C 0..* Ingredient An ingredient of a manufactured item or pharmaceutical product
ing-1: If an ingredient is noted as an allergen (allergenicIndicator) then its substance should be a code. If the substance is a SubstanceDefinition, then the allegen information should be documented in that resource
presentation-required: Either presentationRatio or presentationQuantity or textPresentation MUST be populated
... id Σ 1..1 id Logical id of this artifact
... meta Σ 0..1 Meta Metadata about the resource
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... text 0..1 Narrative Text summary of the resource, for human interpretation
... contained 0..* Resource Contained, inline Resources
... extension 0..* Extension Additional content defined by implementations
... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored
... identifier Σ 0..1 Identifier An identifier or code by which the ingredient can be referenced
... status ?!Σ 1..1 code Not used in this profile
Binding: PublicationStatus (required): The lifecycle status of an artifact.

... for Σ 0..* Reference(MedicinalProductDefinition for PhPID request) The product which this ingredient is a constituent part of
... role Σ 1..1 CodeableConcept Purpose of the ingredient within the product, e.g. active, inactive
Binding: IngredientRole (example)
... function Σ 0..* CodeableConcept Precise action within the drug product, e.g. antioxidant, alkalizing agent
Binding: IngredientFunction (example): A classification of the ingredient identifying its precise purpose(s) in the drug product (beyond e.g. active/inactive).


... group Σ 0..1 CodeableConcept A classification of the ingredient according to where in the physical item it tends to be used, such the outer shell of a tablet, inner body or ink
... allergenicIndicator ΣC 0..1 boolean Not used in this profile
... comment 0..1 markdown A place for providing any notes that are relevant to the component, e.g. removed during process, adjusted for loss on drying
... manufacturer Σ 0..* BackboneElement Not used in this profile
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... role Σ 0..1 code allowed | possible | actual
Binding: IngredientManufacturerRole (required): The way in which this manufacturer is associated with the ingredient.

.... manufacturer Σ 1..1 Reference(Organization) An organization that manufactures this ingredient
... substance ΣC 1..1 BackboneElement The substance that comprises this ingredient
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... code ΣC 1..1 CodeableReference(SubstanceDefinition) A code or full resource that represents the ingredient substance
Binding: SNOMEDCTSubstanceCodes (example): This value set includes all substance codes from SNOMED CT - provided as an exemplar value set.

..... id 0..1 id Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... concept Σ 0..1 CodeableConcept Reference to a concept (by class)
...... id 0..1 id Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
...... coding Σ 0..1 Coding Code defined by a terminology system
....... id 0..1 id Unique id for inter-element referencing
....... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
....... system Σ 1..1 uri Identity of the terminology system
....... version Σ 0..1 string Version of the system - if relevant
....... code ΣC 1..1 code Symbol in syntax defined by the system
....... display ΣC 0..1 string Representation defined by the system
....... userSelected Σ 0..1 boolean If this coding was chosen directly by the user
...... text Σ 1..1 string Plain text representation of the concept
..... reference Σ 0..1 Reference() Reference to a resource (by instance)
.... strength Σ 1..1 BackboneElement The quantity of substance, per presentation, or per volume or mass, and type of quantity.
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... presentation[x] Σ 0..1 The quantity of substance in the unit of presentation
...... presentationRatio Ratio
...... presentationQuantity Quantity
..... textPresentation Σ 0..1 string Should only be used if the strength cannot be coded.
..... concentration[x] Σ 0..1 The strength per unitary volume (or mass)
...... concentrationRatio Ratio
...... concentrationRatioRange RatioRange
...... concentrationCodeableConcept CodeableConcept
...... concentrationQuantity Quantity
..... textConcentration Σ 0..1 string Not used in this profile
..... basis Σ 0..1 CodeableConcept A code that indicates if the strength is, for example, based on the ingredient substance as stated or on the substance base (when the ingredient is a salt)
..... measurementPoint Σ 0..1 string When strength is measured at a particular point or distance
..... country Σ 0..* CodeableConcept Where the strength range applies
Binding: CountryValueSet (example): Jurisdiction codes


..... referenceStrength Σ 0..* BackboneElement Strength expressed in terms of a reference substance
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
...... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
...... substance Σ 1..1 CodeableReference(SubstanceDefinition) Relevant reference substance
Binding: SNOMEDCTSubstanceCodes (example): This value set includes all substance codes from SNOMED CT - provided as an exemplar value set.

...... strength[x] Σ 1..1 Strength expressed in terms of a reference substance
....... strengthRatio Ratio
....... strengthRatioRange RatioRange
....... strengthQuantity Quantity
...... measurementPoint Σ 0..1 string When strength is measured at a particular point or distance
...... country Σ 0..* CodeableConcept Where the strength range applies
Binding: CountryValueSet (example): Jurisdiction codes



doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
Ingredient.languagerequiredAllLanguages
http://hl7.org/fhir/ValueSet/all-languages|5.0.0
from the FHIR Standard
Ingredient.statusrequiredPublicationStatus
http://hl7.org/fhir/ValueSet/publication-status|5.0.0
from the FHIR Standard
Ingredient.roleexampleIngredientRole
http://hl7.org/fhir/ValueSet/ingredient-role
from the FHIR Standard
Ingredient.functionexampleIngredientFunction
http://hl7.org/fhir/ValueSet/ingredient-function
from the FHIR Standard
Ingredient.manufacturer.rolerequiredIngredientManufacturerRole
http://hl7.org/fhir/ValueSet/ingredient-manufacturer-role|5.0.0
from the FHIR Standard
Ingredient.substance.codeexampleSNOMEDCTSubstanceCodes
http://hl7.org/fhir/ValueSet/substance-codes
from the FHIR Standard
Ingredient.substance.strength.countryexampleCountryValueSet
http://hl7.org/fhir/ValueSet/country
from the FHIR Standard
Ingredient.substance.strength.referenceStrength.substanceexampleSNOMEDCTSubstanceCodes
http://hl7.org/fhir/ValueSet/substance-codes
from the FHIR Standard
Ingredient.substance.strength.referenceStrength.countryexampleCountryValueSet
http://hl7.org/fhir/ValueSet/country
from the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
presentation-requirederrorIngredientEither presentationRatio or presentationQuantity or textPresentation MUST be populated
: substance.strength.presentation.ofType(Ratio).exists() or substance.strength.presentation.ofType(Quantity).exists() or substance.strength.textPresentation.exists()

This structure is derived from Ingredient

Summary

Mandatory: 2 elements(3 nested mandatory elements)

Structures

This structure refers to these other structures:

 

Other representations of profile: CSV, Excel, Schematron