UMC IDMP Request and Publish API
1.0.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 1.0.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 (request)

Official URL: http://umcterminologies.org/StructureDefinition/Ingredient-req Version: 1.0.0
Active as of 2026-11-03 Computable Name: IngredientPhPIdReq

This profile defines how the Ingredient is used for request (as contained resource in a MedicinalProductDefinition) by UMC terminologies

Usages:

You can also check for usages in the FHIR IG Statistics

Formal Views of Profile Content

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

NameFlagsCard.TypeDescription & Constraints    Filter: doco
Ingredient C 0..* Ingredient An ingredient of a manufactured item or pharmaceutical product
Constraints: ing-1, presentation-required
Ingredient.id This element is included in summaries. 1..1 id Logical id of this artifact
Ingredient.implicitRules This element is a modifier element. This element is included in summaries. 0..1 uri A set of rules under which this content was created
Ingredient.contained 0..* Resource Contained, inline Resources
Ingredient.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored
Ingredient.status This element is a modifier element. This element is included in summaries. 1..1 code draft | active | retired | unknown
Binding: PublicationStatus (required): The lifecycle status of an artifact.
Ingredient.for This element is included in summaries. 1..* Reference(MedicinalProductDefinition (request)) The product which this ingredient is a constituent part of
Ingredient.role This element is included in summaries. 1..1 CodeableConcept Purpose of the ingredient within the product, e.g. active, inactive
Binding: IngredientRole (example)
Ingredient.substance This element is included in summaries. C 1..1 BackboneElement The substance that comprises this ingredient
Ingredient.substance.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
Ingredient.substance.code This element is included in summaries. 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.
Ingredient.substance.strength This element is included in summaries. 1..1 BackboneElement The quantity of substance, per presentation, or per volume or mass, and type of quantity.
Ingredient.substance.strength.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
Ingredient.substance.strength.presentation[x] This element is included in summaries. 0..1 The quantity of substance in the unit of presentation
Ingredient.substance.strength.presentation[x].presentationRatio Ratio
Ingredient.substance.strength.presentation[x].presentationQuantity Quantity
Ingredient.substance.strength.textPresentation This element is included in summaries. 0..1 string Should only be used if the strength cannot be coded.
Ingredient.substance.strength.referenceStrength This element is included in summaries. 0..1 BackboneElement Strength expressed in terms of a reference substance
Ingredient.substance.strength.referenceStrength.substance This element is included in summaries. 1..1 CodeableReference(SubstanceDefinition) ​Relevant reference substance.
Binding: http://umcterminologies.org/gsid (required)
Ingredient.substance.strength.referenceStrength.strength[x] This element is included in summaries. 1..1 Quantity Strength of the reference substance.

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Ingredient.status Base required PublicationStatus 📍5.0.0 FHIR Std.
Ingredient.role Base example Ingredient Role 📦5.0.0 FHIR Std.
Ingredient.substance.​code Base example SNOMED CT Substance Codes 📍5.0.0 FHIR Std.
Ingredient.substance.​strength.referenceStrength.​substance Base required ​ http://umcterminologies.org/gsid Not State Unknown

Constraints

Id Grade Path(s) Description Expression
presentation-required error Ingredient Either 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 & Constraints    Filter: doco
Ingredient C 0..* Ingredient An ingredient of a manufactured item or pharmaceutical product
Constraints: presentation-required
Ingredient.id 1..1 id Logical id of this artifact
Ingredient.for 1..* Reference(MedicinalProductDefinition (request)) The product which this ingredient is a constituent part of
Ingredient.role 1..1 CodeableConcept Purpose of the ingredient within the product, e.g. active, inactive
Binding: IngredientRole (example)
Ingredient.manufacturer 0..0 An organization that manufactures this ingredient
Ingredient.substance
Ingredient.substance.code
Ingredient.substance.code.concept
Ingredient.substance.code.concept.coding 0..1 Coding Code defined by a terminology system
Ingredient.substance.code.concept.coding.system 1..1 uri Identity of the terminology system
Ingredient.substance.code.concept.coding.code 1..1 code Symbol in syntax defined by the system
Ingredient.substance.code.concept.text 1..1 string Plain text representation of the concept
Ingredient.substance.strength 1..1 BackboneElement The quantity of substance, per presentation, or per volume or mass, and type of quantity.
Ingredient.substance.strength.presentation[x] 0..1 The quantity of substance in the unit of presentation
Ingredient.substance.strength.presentation[x].presentationRatio Ratio
Ingredient.substance.strength.presentation[x].presentationQuantity Quantity
Ingredient.substance.strength.textPresentation 0..1 string Should only be used if the strength cannot be coded.
Ingredient.substance.strength.textConcentration 0..0 Text of either the whole concentration strength or a part of it (rest being in Strength.concentration as a ratio)
Ingredient.substance.strength.referenceStrength 0..1 BackboneElement Strength expressed in terms of a reference substance
Ingredient.substance.strength.referenceStrength.modifierExtension 0..0 Extension
Ingredient.substance.strength.referenceStrength.substance 1..1 CodeableReference(SubstanceDefinition) ​Relevant reference substance.
Binding: http://umcterminologies.org/gsid (required)
Ingredient.substance.strength.referenceStrength.substance.concept
Ingredient.substance.strength.referenceStrength.substance.concept.coding 0..1 Coding Code defined by a terminology system
Ingredient.substance.strength.referenceStrength.substance.concept.coding.system 1..1 uri Identity of the terminology system
Required Pattern: http://umcterminologies.org/gsid (extensions allowed)
Ingredient.substance.strength.referenceStrength.substance.concept.coding.code 1..1 code Symbol in syntax defined by the system
Ingredient.substance.strength.referenceStrength.strength[x] 1..1 Quantity Strength of the reference substance.

doco Documentation for this format

Terminology Bindings (Differential)

Path Status Usage ValueSet Version Source
Ingredient.role Base example Ingredient Role 📦5.0.0 FHIR Std.
Ingredient.substance.​strength.referenceStrength.​substance Base required ​ http://umcterminologies.org/gsid Not State Unknown

Constraints

Id Grade Path(s) Description Expression
presentation-required error Ingredient Either 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 & Constraints    Filter: doco
Ingredient C 0..* Ingredient An ingredient of a manufactured item or pharmaceutical product
Constraints: ing-1, presentation-required
Ingredient.id This element is included in summaries. 1..1 id Logical id of this artifact
Ingredient.meta This element is included in summaries. 0..1 Meta Metadata about the resource
Ingredient.implicitRules This element is a modifier element. This element is included in summaries. 0..1 uri A set of rules under which this content was created
Ingredient.language 0..1 code Language of the resource content
Binding: AllLanguages (required): IETF language tag for a human language
Additional BindingsPurpose
CommonLanguages Starter
Ingredient.text 0..1 Narrative Text summary of the resource, for human interpretation
This profile does not constrain the narrative in regard to content, language, or traceability to data elements
Ingredient.contained 0..* Resource Contained, inline Resources
Ingredient.extension 0..* Extension Additional content defined by implementations
Ingredient.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored
Ingredient.identifier This element is included in summaries. 0..1 Identifier An identifier or code by which the ingredient can be referenced
Ingredient.status This element is a modifier element. This element is included in summaries. 1..1 code draft | active | retired | unknown
Binding: PublicationStatus (required): The lifecycle status of an artifact.
Ingredient.for This element is included in summaries. 1..* Reference(MedicinalProductDefinition (request)) The product which this ingredient is a constituent part of
Ingredient.role This element is included in summaries. 1..1 CodeableConcept Purpose of the ingredient within the product, e.g. active, inactive
Binding: IngredientRole (example)
Ingredient.function This element is included in summaries. 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).
Ingredient.group This element is included in summaries. 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
Ingredient.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
Ingredient.substance This element is included in summaries. C 1..1 BackboneElement The substance that comprises this ingredient
Ingredient.substance.id 0..1 string Unique id for inter-element referencing
Ingredient.substance.extension 0..* Extension Additional content defined by implementations
Ingredient.substance.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
Ingredient.substance.code This element is included in summaries. 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.
Ingredient.substance.code.id 0..1 id Unique id for inter-element referencing
Ingredient.substance.code.extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
Ingredient.substance.code.concept This element is included in summaries. 0..1 CodeableConcept Reference to a concept (by class)
Ingredient.substance.code.concept.id 0..1 id Unique id for inter-element referencing
Ingredient.substance.code.concept.extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
Ingredient.substance.code.concept.coding This element is included in summaries. 0..1 Coding Code defined by a terminology system
Ingredient.substance.code.concept.coding.id 0..1 id Unique id for inter-element referencing
Ingredient.substance.code.concept.coding.extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
Ingredient.substance.code.concept.coding.system This element is included in summaries. 1..1 uri Identity of the terminology system
Ingredient.substance.code.concept.coding.version This element is included in summaries. 0..1 string Version of the system - if relevant
Ingredient.substance.code.concept.coding.code This element is included in summaries. C 1..1 code Symbol in syntax defined by the system
Ingredient.substance.code.concept.coding.display This element is included in summaries. C 0..1 string Representation defined by the system
Ingredient.substance.code.concept.coding.userSelected This element is included in summaries. 0..1 boolean If this coding was chosen directly by the user
Ingredient.substance.code.concept.text This element is included in summaries. 1..1 string Plain text representation of the concept
Ingredient.substance.code.reference This element is included in summaries. 0..1 Reference() Reference to a resource (by instance)
Ingredient.substance.strength This element is included in summaries. 1..1 BackboneElement The quantity of substance, per presentation, or per volume or mass, and type of quantity.
Ingredient.substance.strength.id 0..1 string Unique id for inter-element referencing
Ingredient.substance.strength.extension 0..* Extension Additional content defined by implementations
Ingredient.substance.strength.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
Ingredient.substance.strength.presentation[x] This element is included in summaries. 0..1 The quantity of substance in the unit of presentation
Ingredient.substance.strength.presentation[x].presentationRatio Ratio
Ingredient.substance.strength.presentation[x].presentationQuantity Quantity
Ingredient.substance.strength.textPresentation This element is included in summaries. 0..1 string Should only be used if the strength cannot be coded.
Ingredient.substance.strength.concentration[x] This element is included in summaries. 0..1 The strength per unitary volume (or mass)
Ingredient.substance.strength.concentration[x].concentrationRatio Ratio
Ingredient.substance.strength.concentration[x].concentrationRatioRange RatioRange
Ingredient.substance.strength.concentration[x].concentrationCodeableConcept CodeableConcept
Ingredient.substance.strength.concentration[x].concentrationQuantity Quantity
Ingredient.substance.strength.basis This element is included in summaries. 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)
Ingredient.substance.strength.measurementPoint This element is included in summaries. 0..1 string When strength is measured at a particular point or distance
Ingredient.substance.strength.country This element is included in summaries. 0..* CodeableConcept Where the strength range applies
Binding: CountryValueSet (example): Jurisdiction codes
Ingredient.substance.strength.referenceStrength This element is included in summaries. 0..1 BackboneElement Strength expressed in terms of a reference substance
Ingredient.substance.strength.referenceStrength.id 0..1 string Unique id for inter-element referencing
Ingredient.substance.strength.referenceStrength.extension 0..* Extension Additional content defined by implementations
Ingredient.substance.strength.referenceStrength.substance This element is included in summaries. 1..1 CodeableReference(SubstanceDefinition) ​Relevant reference substance.
Binding: http://umcterminologies.org/gsid (required)
Ingredient.substance.strength.referenceStrength.substance.id 0..1 id Unique id for inter-element referencing
Ingredient.substance.strength.referenceStrength.substance.extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
Ingredient.substance.strength.referenceStrength.substance.concept This element is included in summaries. 0..1 CodeableConcept Reference to a concept (by class)
Ingredient.substance.strength.referenceStrength.substance.concept.id 0..1 id Unique id for inter-element referencing
Ingredient.substance.strength.referenceStrength.substance.concept.extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
Ingredient.substance.strength.referenceStrength.substance.concept.coding This element is included in summaries. 0..1 Coding Code defined by a terminology system
Ingredient.substance.strength.referenceStrength.substance.concept.coding.id 0..1 id Unique id for inter-element referencing
Ingredient.substance.strength.referenceStrength.substance.concept.coding.extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
Ingredient.substance.strength.referenceStrength.substance.concept.coding.system This element is included in summaries. 1..1 uri Identity of the terminology system
Required Pattern: http://umcterminologies.org/gsid (extensions allowed)
Ingredient.substance.strength.referenceStrength.substance.concept.coding.version This element is included in summaries. 0..1 string Version of the system - if relevant
Ingredient.substance.strength.referenceStrength.substance.concept.coding.code This element is included in summaries. C 1..1 code Symbol in syntax defined by the system
Ingredient.substance.strength.referenceStrength.substance.concept.coding.display This element is included in summaries. C 0..1 string Representation defined by the system
Ingredient.substance.strength.referenceStrength.substance.concept.coding.userSelected This element is included in summaries. 0..1 boolean If this coding was chosen directly by the user
Ingredient.substance.strength.referenceStrength.substance.concept.text This element is included in summaries. 0..1 string Plain text representation of the concept
Ingredient.substance.strength.referenceStrength.substance.reference This element is included in summaries. 0..1 Reference() Reference to a resource (by instance)
Ingredient.substance.strength.referenceStrength.strength[x] This element is included in summaries. 1..1 Quantity Strength of the reference substance.
Ingredient.substance.strength.referenceStrength.measurementPoint This element is included in summaries. 0..1 string When strength is measured at a particular point or distance
Ingredient.substance.strength.referenceStrength.country This element is included in summaries. 0..* CodeableConcept Where the strength range applies
Binding: CountryValueSet (example): Jurisdiction codes

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Ingredient.language Base required All Languages 📍5.0.0 FHIR Std.
Ingredient.status Base required PublicationStatus 📍5.0.0 FHIR Std.
Ingredient.role Base example Ingredient Role 📦5.0.0 FHIR Std.
Ingredient.function Base example Ingredient Function 📍5.0.0 FHIR Std.
Ingredient.manufacturer.​role Base required Ingredient Manufacturer Role 📍5.0.0 FHIR Std.
Ingredient.substance.​code Base example SNOMED CT Substance Codes 📍5.0.0 FHIR Std.
Ingredient.substance.​strength.country Base example Country ValueSet 📍5.0.0 FHIR Std.
Ingredient.substance.​strength.referenceStrength.​substance Base required ​ http://umcterminologies.org/gsid Not State Unknown
Ingredient.substance.​strength.referenceStrength.​country Base example Country ValueSet 📍5.0.0 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
presentation-required error Ingredient Either 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: 3 elements(5 nested mandatory elements)
Prohibited: 4 elements

Structures

This structure refers to these other structures:

Key Elements View

NameFlagsCard.TypeDescription & Constraints    Filter: doco
Ingredient C 0..* Ingredient An ingredient of a manufactured item or pharmaceutical product
Constraints: ing-1, presentation-required
Ingredient.id This element is included in summaries. 1..1 id Logical id of this artifact
Ingredient.implicitRules This element is a modifier element. This element is included in summaries. 0..1 uri A set of rules under which this content was created
Ingredient.contained 0..* Resource Contained, inline Resources
Ingredient.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored
Ingredient.status This element is a modifier element. This element is included in summaries. 1..1 code draft | active | retired | unknown
Binding: PublicationStatus (required): The lifecycle status of an artifact.
Ingredient.for This element is included in summaries. 1..* Reference(MedicinalProductDefinition (request)) The product which this ingredient is a constituent part of
Ingredient.role This element is included in summaries. 1..1 CodeableConcept Purpose of the ingredient within the product, e.g. active, inactive
Binding: IngredientRole (example)
Ingredient.substance This element is included in summaries. C 1..1 BackboneElement The substance that comprises this ingredient
Ingredient.substance.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
Ingredient.substance.code This element is included in summaries. 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.
Ingredient.substance.strength This element is included in summaries. 1..1 BackboneElement The quantity of substance, per presentation, or per volume or mass, and type of quantity.
Ingredient.substance.strength.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
Ingredient.substance.strength.presentation[x] This element is included in summaries. 0..1 The quantity of substance in the unit of presentation
Ingredient.substance.strength.presentation[x].presentationRatio Ratio
Ingredient.substance.strength.presentation[x].presentationQuantity Quantity
Ingredient.substance.strength.textPresentation This element is included in summaries. 0..1 string Should only be used if the strength cannot be coded.
Ingredient.substance.strength.referenceStrength This element is included in summaries. 0..1 BackboneElement Strength expressed in terms of a reference substance
Ingredient.substance.strength.referenceStrength.substance This element is included in summaries. 1..1 CodeableReference(SubstanceDefinition) ​Relevant reference substance.
Binding: http://umcterminologies.org/gsid (required)
Ingredient.substance.strength.referenceStrength.strength[x] This element is included in summaries. 1..1 Quantity Strength of the reference substance.

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Ingredient.status Base required PublicationStatus 📍5.0.0 FHIR Std.
Ingredient.role Base example Ingredient Role 📦5.0.0 FHIR Std.
Ingredient.substance.​code Base example SNOMED CT Substance Codes 📍5.0.0 FHIR Std.
Ingredient.substance.​strength.referenceStrength.​substance Base required ​ http://umcterminologies.org/gsid Not State Unknown

Constraints

Id Grade Path(s) Description Expression
presentation-required error Ingredient Either 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 & Constraints    Filter: doco
Ingredient C 0..* Ingredient An ingredient of a manufactured item or pharmaceutical product
Constraints: presentation-required
Ingredient.id 1..1 id Logical id of this artifact
Ingredient.for 1..* Reference(MedicinalProductDefinition (request)) The product which this ingredient is a constituent part of
Ingredient.role 1..1 CodeableConcept Purpose of the ingredient within the product, e.g. active, inactive
Binding: IngredientRole (example)
Ingredient.allergenicIndicator 0..0 If the ingredient is a known or suspected allergen
Ingredient.manufacturer 0..0 An organization that manufactures this ingredient
Ingredient.substance
Ingredient.substance.code
Ingredient.substance.code.concept
Ingredient.substance.code.concept.coding 0..1 Coding Code defined by a terminology system
Ingredient.substance.code.concept.coding.system 1..1 uri Identity of the terminology system
Ingredient.substance.code.concept.coding.code 1..1 code Symbol in syntax defined by the system
Ingredient.substance.code.concept.text 1..1 string Plain text representation of the concept
Ingredient.substance.strength 1..1 BackboneElement The quantity of substance, per presentation, or per volume or mass, and type of quantity.
Ingredient.substance.strength.presentation[x] 0..1 The quantity of substance in the unit of presentation
Ingredient.substance.strength.presentation[x].presentationRatio Ratio
Ingredient.substance.strength.presentation[x].presentationQuantity Quantity
Ingredient.substance.strength.textPresentation 0..1 string Should only be used if the strength cannot be coded.
Ingredient.substance.strength.textConcentration 0..0 Text of either the whole concentration strength or a part of it (rest being in Strength.concentration as a ratio)
Ingredient.substance.strength.referenceStrength 0..1 BackboneElement Strength expressed in terms of a reference substance
Ingredient.substance.strength.referenceStrength.modifierExtension 0..0 Extension
Ingredient.substance.strength.referenceStrength.substance 1..1 CodeableReference(SubstanceDefinition) ​Relevant reference substance.
Binding: http://umcterminologies.org/gsid (required)
Ingredient.substance.strength.referenceStrength.substance.concept
Ingredient.substance.strength.referenceStrength.substance.concept.coding 0..1 Coding Code defined by a terminology system
Ingredient.substance.strength.referenceStrength.substance.concept.coding.system 1..1 uri Identity of the terminology system
Required Pattern: http://umcterminologies.org/gsid (extensions allowed)
Ingredient.substance.strength.referenceStrength.substance.concept.coding.code 1..1 code Symbol in syntax defined by the system
Ingredient.substance.strength.referenceStrength.strength[x] 1..1 Quantity Strength of the reference substance.

doco Documentation for this format

Terminology Bindings (Differential)

Path Status Usage ValueSet Version Source
Ingredient.role Base example Ingredient Role 📦5.0.0 FHIR Std.
Ingredient.substance.​strength.referenceStrength.​substance Base required ​ http://umcterminologies.org/gsid Not State Unknown

Constraints

Id Grade Path(s) Description Expression
presentation-required error Ingredient Either 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 & Constraints    Filter: doco
Ingredient C 0..* Ingredient An ingredient of a manufactured item or pharmaceutical product
Constraints: ing-1, presentation-required
Ingredient.id This element is included in summaries. 1..1 id Logical id of this artifact
Ingredient.meta This element is included in summaries. 0..1 Meta Metadata about the resource
Ingredient.implicitRules This element is a modifier element. This element is included in summaries. 0..1 uri A set of rules under which this content was created
Ingredient.language 0..1 code Language of the resource content
Binding: AllLanguages (required): IETF language tag for a human language
Additional BindingsPurpose
CommonLanguages Starter
Ingredient.text 0..1 Narrative Text summary of the resource, for human interpretation
This profile does not constrain the narrative in regard to content, language, or traceability to data elements
Ingredient.contained 0..* Resource Contained, inline Resources
Ingredient.extension 0..* Extension Additional content defined by implementations
Ingredient.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored
Ingredient.identifier This element is included in summaries. 0..1 Identifier An identifier or code by which the ingredient can be referenced
Ingredient.status This element is a modifier element. This element is included in summaries. 1..1 code draft | active | retired | unknown
Binding: PublicationStatus (required): The lifecycle status of an artifact.
Ingredient.for This element is included in summaries. 1..* Reference(MedicinalProductDefinition (request)) The product which this ingredient is a constituent part of
Ingredient.role This element is included in summaries. 1..1 CodeableConcept Purpose of the ingredient within the product, e.g. active, inactive
Binding: IngredientRole (example)
Ingredient.function This element is included in summaries. 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).
Ingredient.group This element is included in summaries. 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
Ingredient.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
Ingredient.substance This element is included in summaries. C 1..1 BackboneElement The substance that comprises this ingredient
Ingredient.substance.id 0..1 string Unique id for inter-element referencing
Ingredient.substance.extension 0..* Extension Additional content defined by implementations
Ingredient.substance.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
Ingredient.substance.code This element is included in summaries. 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.
Ingredient.substance.code.id 0..1 id Unique id for inter-element referencing
Ingredient.substance.code.extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
Ingredient.substance.code.concept This element is included in summaries. 0..1 CodeableConcept Reference to a concept (by class)
Ingredient.substance.code.concept.id 0..1 id Unique id for inter-element referencing
Ingredient.substance.code.concept.extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
Ingredient.substance.code.concept.coding This element is included in summaries. 0..1 Coding Code defined by a terminology system
Ingredient.substance.code.concept.coding.id 0..1 id Unique id for inter-element referencing
Ingredient.substance.code.concept.coding.extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
Ingredient.substance.code.concept.coding.system This element is included in summaries. 1..1 uri Identity of the terminology system
Ingredient.substance.code.concept.coding.version This element is included in summaries. 0..1 string Version of the system - if relevant
Ingredient.substance.code.concept.coding.code This element is included in summaries. C 1..1 code Symbol in syntax defined by the system
Ingredient.substance.code.concept.coding.display This element is included in summaries. C 0..1 string Representation defined by the system
Ingredient.substance.code.concept.coding.userSelected This element is included in summaries. 0..1 boolean If this coding was chosen directly by the user
Ingredient.substance.code.concept.text This element is included in summaries. 1..1 string Plain text representation of the concept
Ingredient.substance.code.reference This element is included in summaries. 0..1 Reference() Reference to a resource (by instance)
Ingredient.substance.strength This element is included in summaries. 1..1 BackboneElement The quantity of substance, per presentation, or per volume or mass, and type of quantity.
Ingredient.substance.strength.id 0..1 string Unique id for inter-element referencing
Ingredient.substance.strength.extension 0..* Extension Additional content defined by implementations
Ingredient.substance.strength.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
Ingredient.substance.strength.presentation[x] This element is included in summaries. 0..1 The quantity of substance in the unit of presentation
Ingredient.substance.strength.presentation[x].presentationRatio Ratio
Ingredient.substance.strength.presentation[x].presentationQuantity Quantity
Ingredient.substance.strength.textPresentation This element is included in summaries. 0..1 string Should only be used if the strength cannot be coded.
Ingredient.substance.strength.concentration[x] This element is included in summaries. 0..1 The strength per unitary volume (or mass)
Ingredient.substance.strength.concentration[x].concentrationRatio Ratio
Ingredient.substance.strength.concentration[x].concentrationRatioRange RatioRange
Ingredient.substance.strength.concentration[x].concentrationCodeableConcept CodeableConcept
Ingredient.substance.strength.concentration[x].concentrationQuantity Quantity
Ingredient.substance.strength.basis This element is included in summaries. 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)
Ingredient.substance.strength.measurementPoint This element is included in summaries. 0..1 string When strength is measured at a particular point or distance
Ingredient.substance.strength.country This element is included in summaries. 0..* CodeableConcept Where the strength range applies
Binding: CountryValueSet (example): Jurisdiction codes
Ingredient.substance.strength.referenceStrength This element is included in summaries. 0..1 BackboneElement Strength expressed in terms of a reference substance
Ingredient.substance.strength.referenceStrength.id 0..1 string Unique id for inter-element referencing
Ingredient.substance.strength.referenceStrength.extension 0..* Extension Additional content defined by implementations
Ingredient.substance.strength.referenceStrength.substance This element is included in summaries. 1..1 CodeableReference(SubstanceDefinition) ​Relevant reference substance.
Binding: http://umcterminologies.org/gsid (required)
Ingredient.substance.strength.referenceStrength.substance.id 0..1 id Unique id for inter-element referencing
Ingredient.substance.strength.referenceStrength.substance.extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
Ingredient.substance.strength.referenceStrength.substance.concept This element is included in summaries. 0..1 CodeableConcept Reference to a concept (by class)
Ingredient.substance.strength.referenceStrength.substance.concept.id 0..1 id Unique id for inter-element referencing
Ingredient.substance.strength.referenceStrength.substance.concept.extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
Ingredient.substance.strength.referenceStrength.substance.concept.coding This element is included in summaries. 0..1 Coding Code defined by a terminology system
Ingredient.substance.strength.referenceStrength.substance.concept.coding.id 0..1 id Unique id for inter-element referencing
Ingredient.substance.strength.referenceStrength.substance.concept.coding.extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
Ingredient.substance.strength.referenceStrength.substance.concept.coding.system This element is included in summaries. 1..1 uri Identity of the terminology system
Required Pattern: http://umcterminologies.org/gsid (extensions allowed)
Ingredient.substance.strength.referenceStrength.substance.concept.coding.version This element is included in summaries. 0..1 string Version of the system - if relevant
Ingredient.substance.strength.referenceStrength.substance.concept.coding.code This element is included in summaries. C 1..1 code Symbol in syntax defined by the system
Ingredient.substance.strength.referenceStrength.substance.concept.coding.display This element is included in summaries. C 0..1 string Representation defined by the system
Ingredient.substance.strength.referenceStrength.substance.concept.coding.userSelected This element is included in summaries. 0..1 boolean If this coding was chosen directly by the user
Ingredient.substance.strength.referenceStrength.substance.concept.text This element is included in summaries. 0..1 string Plain text representation of the concept
Ingredient.substance.strength.referenceStrength.substance.reference This element is included in summaries. 0..1 Reference() Reference to a resource (by instance)
Ingredient.substance.strength.referenceStrength.strength[x] This element is included in summaries. 1..1 Quantity Strength of the reference substance.
Ingredient.substance.strength.referenceStrength.measurementPoint This element is included in summaries. 0..1 string When strength is measured at a particular point or distance
Ingredient.substance.strength.referenceStrength.country This element is included in summaries. 0..* CodeableConcept Where the strength range applies
Binding: CountryValueSet (example): Jurisdiction codes

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Ingredient.language Base required All Languages 📍5.0.0 FHIR Std.
Ingredient.status Base required PublicationStatus 📍5.0.0 FHIR Std.
Ingredient.role Base example Ingredient Role 📦5.0.0 FHIR Std.
Ingredient.function Base example Ingredient Function 📍5.0.0 FHIR Std.
Ingredient.manufacturer.​role Base required Ingredient Manufacturer Role 📍5.0.0 FHIR Std.
Ingredient.substance.​code Base example SNOMED CT Substance Codes 📍5.0.0 FHIR Std.
Ingredient.substance.​strength.country Base example Country ValueSet 📍5.0.0 FHIR Std.
Ingredient.substance.​strength.referenceStrength.​substance Base required ​ http://umcterminologies.org/gsid Not State Unknown
Ingredient.substance.​strength.referenceStrength.​country Base example Country ValueSet 📍5.0.0 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
presentation-required error Ingredient Either 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: 3 elements(5 nested mandatory elements)
Prohibited: 4 elements

Structures

This structure refers to these other structures:

 

Other representations of profile: CSV, Excel, Schematron