CH EPL (R5)
0.1.0 - ci-build

CH EPL (R5), published by Federal Office of Public Health FOPH. 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/bag-epl/bag-epl-fhir/ and changes regularly. See the Directory of published versions

Resource Profile: IDMP Ingredient

Official URL: http://fhir.ch/ig/ch-epl/StructureDefinition/ch-idmp-ingredient Version: 0.1.0
Active as of 2024-09-16 Computable Name: CHIDMPIngredient

Copyright/Legal: CC0-1.0

Profile of the Ingredient resource for representing the material used in the preparation of a medicinal/pharmaceutical product.

Usage:

Formal Views of Profile Content

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

This structure is derived from Ingredient

NameFlagsCard.TypeDescription & Constraintsdoco
.. Ingredient 0..* Ingredient CH IDMP Ingredient
... for 0..* Reference(IDMP MedicinalProductDefinition | CH IDMP AdministrableProductDefinition | CH IDMP ManufacturedItemDefinition) 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: CH SMC - Ingredient Role (required)
.... Slices for coding 1..* Coding Code defined by a terminology system
Slice: Unordered, Open by value:system
..... coding:SMC 0..1 Coding Code defined by a terminology system
...... system 1..1 uri Identity of the terminology system
Required Pattern: http://fhir.ch/ig/ch-epl/CodeSystem/ch-SMC-ingredient-role
...... code 1..1 code Symbol in syntax defined by the system
... substance
.... code 1..1 CodeableReference(SubstanceDefinition) A code or full resource that represents the ingredient substance
Binding: CH SMC - Substance (required)
..... concept 1..1 CodeableConcept Reference to a concept (by class)
...... Slices for coding 1..* Coding Code defined by a terminology system
Slice: Unordered, Open by value:system
....... coding:UNII 0..1 Coding Code defined by a terminology system
........ system 1..1 uri Identity of the terminology system
Required Pattern: http://fhir.ch/ig/ch-epl/CodeSystem/ch-SMC-substance
........ code 1..1 code Symbol in syntax defined by the system

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSetURI
Ingredient.rolerequiredChSMCIngredientRoleVS (a valid code from CH SMC - Ingredient Role)
http://fhir.ch/ig/ch-epl/ValueSet/ch-SMC-ingredient-role
from this IG
Ingredient.substance.coderequiredChSMCSubstanceVS (a valid code from CH SMC - Substance)
http://fhir.ch/ig/ch-epl/ValueSet/ch-SMC-substance
from this IG
NameFlagsCard.TypeDescription & Constraintsdoco
.. Ingredient C 0..* Ingredient CH IDMP Ingredient
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
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... contained 0..* Resource Contained, inline Resources
... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored
... for Σ 0..* Reference(IDMP MedicinalProductDefinition | CH IDMP AdministrableProductDefinition | CH IDMP ManufacturedItemDefinition) 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: CH SMC - Ingredient Role (required)
.... Slices for coding Σ 1..* Coding Code defined by a terminology system
Slice: Unordered, Open by value:system
..... coding:SMC Σ 0..1 Coding Code defined by a terminology system
...... system Σ 1..1 uri Identity of the terminology system
Required Pattern: http://fhir.ch/ig/ch-epl/CodeSystem/ch-SMC-ingredient-role
...... code ΣC 1..1 code Symbol in syntax defined by the system
... substance ΣC 1..1 BackboneElement The substance that comprises this ingredient
.... 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: CH SMC - Substance (required)
..... concept Σ 1..1 CodeableConcept Reference to a concept (by class)
...... Slices for coding Σ 1..* Coding Code defined by a terminology system
Slice: Unordered, Open by value:system
....... coding:UNII Σ 0..1 Coding Code defined by a terminology system
........ system Σ 1..1 uri Identity of the terminology system
Required Pattern: http://fhir.ch/ig/ch-epl/CodeSystem/ch-SMC-substance
........ code ΣC 1..1 code Symbol in syntax defined by the system

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.rolerequiredChSMCIngredientRoleVS (a valid code from CH SMC - Ingredient Role)
http://fhir.ch/ig/ch-epl/ValueSet/ch-SMC-ingredient-role
from this IG
Ingredient.substance.coderequiredChSMCSubstanceVS (a valid code from CH SMC - Substance)
http://fhir.ch/ig/ch-epl/ValueSet/ch-SMC-substance
from this IG

Constraints

IdGradePath(s)DetailsRequirements
dom-2errorIngredientIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorIngredientIf the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource
: contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().ofType(canonical) | %resource.descendants().ofType(uri) | %resource.descendants().ofType(url))) or descendants().where(reference = '#').exists() or descendants().where(ofType(canonical) = '#').exists() or descendants().where(ofType(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4errorIngredientIf a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated
: contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5errorIngredientIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceIngredientA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ing-1errorIngredientIf 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
: Ingredient.where(allergenicIndicator=true).count() + Ingredient.substance.code.reference.count() < 2
NameFlagsCard.TypeDescription & Constraintsdoco
.. Ingredient C 0..* Ingredient CH IDMP Ingredient
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
... id Σ 0..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 draft | active | retired | unknown
Binding: PublicationStatus (required): The lifecycle status of an artifact.

... for Σ 0..* Reference(IDMP MedicinalProductDefinition | CH IDMP AdministrableProductDefinition | CH IDMP ManufacturedItemDefinition) 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: CH SMC - Ingredient Role (required)
.... id 0..1 id Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... Slices for coding Σ 1..* Coding Code defined by a terminology system
Slice: Unordered, Open by value:system
..... coding:SMC Σ 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
Required Pattern: http://fhir.ch/ig/ch-epl/CodeSystem/ch-SMC-ingredient-role
...... 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 Σ 0..1 string Plain text representation of the concept
... 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 If the ingredient is a known or suspected allergen
... 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 An organization that manufactures 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
.... 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: CH SMC - Substance (required)
..... 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 Σ 1..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
...... Slices for coding Σ 1..* Coding Code defined by a terminology system
Slice: Unordered, Open by value:system
....... coding:UNII Σ 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
Required Pattern: http://fhir.ch/ig/ch-epl/CodeSystem/ch-SMC-substance
........ 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 Σ 0..1 string Plain text representation of the concept
..... reference Σ 0..1 Reference() Reference to a resource (by instance)
.... strength Σ 0..* 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
...... presentationRatioRange RatioRange
...... presentationCodeableConcept CodeableConcept
...... presentationQuantity Quantity
..... textPresentation Σ 0..1 string Text of either the whole presentation strength or a part of it (rest being in Strength.presentation as a ratio)
..... concentration[x] Σ 0..1 The strength per unitary volume (or mass)
...... concentrationRatio Ratio
...... concentrationRatioRange RatioRange
...... concentrationCodeableConcept CodeableConcept
...... concentrationQuantity Quantity
..... textConcentration Σ 0..1 string Text of either the whole concentration strength or a part of it (rest being in Strength.concentration as a ratio)
..... 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.rolerequiredChSMCIngredientRoleVS (a valid code from CH SMC - Ingredient Role)
http://fhir.ch/ig/ch-epl/ValueSet/ch-SMC-ingredient-role
from this IG
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.coderequiredChSMCSubstanceVS (a valid code from CH SMC - Substance)
http://fhir.ch/ig/ch-epl/ValueSet/ch-SMC-substance
from this IG
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
dom-2errorIngredientIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorIngredientIf the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource
: contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().ofType(canonical) | %resource.descendants().ofType(uri) | %resource.descendants().ofType(url))) or descendants().where(reference = '#').exists() or descendants().where(ofType(canonical) = '#').exists() or descendants().where(ofType(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4errorIngredientIf a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated
: contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5errorIngredientIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceIngredientA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ing-1errorIngredientIf 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
: Ingredient.where(allergenicIndicator=true).count() + Ingredient.substance.code.reference.count() < 2

This structure is derived from Ingredient

Summary

Mandatory: 3 elements(4 nested mandatory elements)

Structures

This structure refers to these other structures:

Slices

This structure defines the following Slices:

  • The element 1 is sliced based on the value of Ingredient.role.coding
  • The element 1 is sliced based on the value of Ingredient.substance.code.concept.coding

Differential View

This structure is derived from Ingredient

NameFlagsCard.TypeDescription & Constraintsdoco
.. Ingredient 0..* Ingredient CH IDMP Ingredient
... for 0..* Reference(IDMP MedicinalProductDefinition | CH IDMP AdministrableProductDefinition | CH IDMP ManufacturedItemDefinition) 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: CH SMC - Ingredient Role (required)
.... Slices for coding 1..* Coding Code defined by a terminology system
Slice: Unordered, Open by value:system
..... coding:SMC 0..1 Coding Code defined by a terminology system
...... system 1..1 uri Identity of the terminology system
Required Pattern: http://fhir.ch/ig/ch-epl/CodeSystem/ch-SMC-ingredient-role
...... code 1..1 code Symbol in syntax defined by the system
... substance
.... code 1..1 CodeableReference(SubstanceDefinition) A code or full resource that represents the ingredient substance
Binding: CH SMC - Substance (required)
..... concept 1..1 CodeableConcept Reference to a concept (by class)
...... Slices for coding 1..* Coding Code defined by a terminology system
Slice: Unordered, Open by value:system
....... coding:UNII 0..1 Coding Code defined by a terminology system
........ system 1..1 uri Identity of the terminology system
Required Pattern: http://fhir.ch/ig/ch-epl/CodeSystem/ch-SMC-substance
........ code 1..1 code Symbol in syntax defined by the system

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSetURI
Ingredient.rolerequiredChSMCIngredientRoleVS (a valid code from CH SMC - Ingredient Role)
http://fhir.ch/ig/ch-epl/ValueSet/ch-SMC-ingredient-role
from this IG
Ingredient.substance.coderequiredChSMCSubstanceVS (a valid code from CH SMC - Substance)
http://fhir.ch/ig/ch-epl/ValueSet/ch-SMC-substance
from this IG

Key Elements View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Ingredient C 0..* Ingredient CH IDMP Ingredient
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
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... contained 0..* Resource Contained, inline Resources
... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored
... for Σ 0..* Reference(IDMP MedicinalProductDefinition | CH IDMP AdministrableProductDefinition | CH IDMP ManufacturedItemDefinition) 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: CH SMC - Ingredient Role (required)
.... Slices for coding Σ 1..* Coding Code defined by a terminology system
Slice: Unordered, Open by value:system
..... coding:SMC Σ 0..1 Coding Code defined by a terminology system
...... system Σ 1..1 uri Identity of the terminology system
Required Pattern: http://fhir.ch/ig/ch-epl/CodeSystem/ch-SMC-ingredient-role
...... code ΣC 1..1 code Symbol in syntax defined by the system
... substance ΣC 1..1 BackboneElement The substance that comprises this ingredient
.... 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: CH SMC - Substance (required)
..... concept Σ 1..1 CodeableConcept Reference to a concept (by class)
...... Slices for coding Σ 1..* Coding Code defined by a terminology system
Slice: Unordered, Open by value:system
....... coding:UNII Σ 0..1 Coding Code defined by a terminology system
........ system Σ 1..1 uri Identity of the terminology system
Required Pattern: http://fhir.ch/ig/ch-epl/CodeSystem/ch-SMC-substance
........ code ΣC 1..1 code Symbol in syntax defined by the system

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.rolerequiredChSMCIngredientRoleVS (a valid code from CH SMC - Ingredient Role)
http://fhir.ch/ig/ch-epl/ValueSet/ch-SMC-ingredient-role
from this IG
Ingredient.substance.coderequiredChSMCSubstanceVS (a valid code from CH SMC - Substance)
http://fhir.ch/ig/ch-epl/ValueSet/ch-SMC-substance
from this IG

Constraints

IdGradePath(s)DetailsRequirements
dom-2errorIngredientIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorIngredientIf the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource
: contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().ofType(canonical) | %resource.descendants().ofType(uri) | %resource.descendants().ofType(url))) or descendants().where(reference = '#').exists() or descendants().where(ofType(canonical) = '#').exists() or descendants().where(ofType(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4errorIngredientIf a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated
: contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5errorIngredientIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceIngredientA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ing-1errorIngredientIf 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
: Ingredient.where(allergenicIndicator=true).count() + Ingredient.substance.code.reference.count() < 2

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Ingredient C 0..* Ingredient CH IDMP Ingredient
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
... id Σ 0..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 draft | active | retired | unknown
Binding: PublicationStatus (required): The lifecycle status of an artifact.

... for Σ 0..* Reference(IDMP MedicinalProductDefinition | CH IDMP AdministrableProductDefinition | CH IDMP ManufacturedItemDefinition) 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: CH SMC - Ingredient Role (required)
.... id 0..1 id Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... Slices for coding Σ 1..* Coding Code defined by a terminology system
Slice: Unordered, Open by value:system
..... coding:SMC Σ 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
Required Pattern: http://fhir.ch/ig/ch-epl/CodeSystem/ch-SMC-ingredient-role
...... 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 Σ 0..1 string Plain text representation of the concept
... 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 If the ingredient is a known or suspected allergen
... 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 An organization that manufactures 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
.... 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: CH SMC - Substance (required)
..... 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 Σ 1..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
...... Slices for coding Σ 1..* Coding Code defined by a terminology system
Slice: Unordered, Open by value:system
....... coding:UNII Σ 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
Required Pattern: http://fhir.ch/ig/ch-epl/CodeSystem/ch-SMC-substance
........ 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 Σ 0..1 string Plain text representation of the concept
..... reference Σ 0..1 Reference() Reference to a resource (by instance)
.... strength Σ 0..* 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
...... presentationRatioRange RatioRange
...... presentationCodeableConcept CodeableConcept
...... presentationQuantity Quantity
..... textPresentation Σ 0..1 string Text of either the whole presentation strength or a part of it (rest being in Strength.presentation as a ratio)
..... concentration[x] Σ 0..1 The strength per unitary volume (or mass)
...... concentrationRatio Ratio
...... concentrationRatioRange RatioRange
...... concentrationCodeableConcept CodeableConcept
...... concentrationQuantity Quantity
..... textConcentration Σ 0..1 string Text of either the whole concentration strength or a part of it (rest being in Strength.concentration as a ratio)
..... 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.rolerequiredChSMCIngredientRoleVS (a valid code from CH SMC - Ingredient Role)
http://fhir.ch/ig/ch-epl/ValueSet/ch-SMC-ingredient-role
from this IG
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.coderequiredChSMCSubstanceVS (a valid code from CH SMC - Substance)
http://fhir.ch/ig/ch-epl/ValueSet/ch-SMC-substance
from this IG
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
dom-2errorIngredientIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorIngredientIf the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource
: contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().ofType(canonical) | %resource.descendants().ofType(uri) | %resource.descendants().ofType(url))) or descendants().where(reference = '#').exists() or descendants().where(ofType(canonical) = '#').exists() or descendants().where(ofType(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4errorIngredientIf a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated
: contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5errorIngredientIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceIngredientA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ing-1errorIngredientIf 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
: Ingredient.where(allergenicIndicator=true).count() + Ingredient.substance.code.reference.count() < 2

This structure is derived from Ingredient

Summary

Mandatory: 3 elements(4 nested mandatory elements)

Structures

This structure refers to these other structures:

Slices

This structure defines the following Slices:

  • The element 1 is sliced based on the value of Ingredient.role.coding
  • The element 1 is sliced based on the value of Ingredient.substance.code.concept.coding

 

Other representations of profile: CSV, Excel, Schematron