CH EPL (R5)
1.0.0-ci-build - 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 1.0.0-ci-build 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
| Official URL: http://fhir.ch/ig/ch-epl/StructureDefinition/ch-idmp-ingredient | Version: 1.0.0-ci-build | |||
| Active as of 2025-11-11 | 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.
Usages:
You can also check for usages in the FHIR IG Statistics
Description of Profiles, Differentials, Snapshots and how the different presentations work.
| Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() |
|---|---|---|---|---|
![]() |
C | 0..* | Ingredient | CH IDMP Ingredient Constraints: ing-1 |
![]() ![]() |
?!Σ | 0..1 | uri | A set of rules under which this content was created |
![]() ![]() |
0..* | Resource | Contained, inline Resources | |
![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored |
![]() ![]() |
?!Σ | 1..1 | code | draft | active | retired | unknown Binding: PublicationStatus (required): The lifecycle status of an artifact. |
![]() ![]() |
Σ | 0..* | Reference(IDMP MedicinalProductDefinition | CH IDMP AdministrableProductDefinition | CH IDMP ManufacturedItemDefinition) | The product which this ingredient is a constituent part of |
![]() ![]() |
Σ | 1..1 | CodeableConcept | Purpose of the ingredient within the product, e.g. active, inactive Binding: CH SMC - Ingredient Role (required) |
![]() ![]() ![]() |
Σ | 1..* | Coding | Code defined by a terminology system Slice: Unordered, Open by value:system |
![]() ![]() ![]() ![]() |
Σ | 0..1 | Coding | Code defined by a terminology system |
![]() ![]() ![]() ![]() ![]() |
Σ | 1..1 | uri | Identity of the terminology system Required Pattern: http://fhir.ch/ig/ch-epl/CodeSystem/ch-SMC-ingredient-role |
![]() ![]() ![]() ![]() ![]() |
ΣC | 1..1 | code | Symbol in syntax defined by the system |
![]() ![]() |
ΣC | 1..1 | BackboneElement | The substance that comprises this ingredient |
![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
![]() ![]() ![]() |
ΣC | 1..1 | CodeableReference(SubstanceDefinition) | A code or full resource that represents the ingredient substance Binding: CH SMC - Substance (required) |
![]() ![]() ![]() ![]() |
Σ | 1..1 | CodeableConcept | Reference to a concept (by class) |
![]() ![]() ![]() ![]() ![]() |
Σ | 1..* | Coding | Code defined by a terminology system Slice: Unordered, Open by value:system |
![]() ![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | Coding | Code defined by a terminology system |
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
Σ | 1..1 | uri | Identity of the terminology system Required Pattern: http://fhir.ch/ig/ch-epl/CodeSystem/ch-SMC-substance |
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
ΣC | 1..1 | code | Symbol in syntax defined by the system |
Documentation for this format | ||||
| Path | Status | Usage | ValueSet | Version | Source |
| Ingredient.status | Base | required | PublicationStatus | 📍5.0.0 | FHIR Std. |
| Ingredient.role | Base | required | CH SMC - Ingredient Role | 📦1.0.0-ci-build | This IG |
| Ingredient.substance.code | Base | required | CH SMC - Substance | 📦1.0.0-ci-build | This IG |
| Id | Grade | Path(s) | Description | Expression |
| dom-2 | error | Ingredient | If the resource is contained in another resource, it SHALL NOT contain nested Resources |
contained.contained.empty()
|
| dom-3 | error | Ingredient | 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 |
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-4 | error | Ingredient | If 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-5 | error | Ingredient | If a resource is contained in another resource, it SHALL NOT have a security label |
contained.meta.security.empty()
|
| dom-6 | best practice | Ingredient | A resource should have narrative for robust management |
text.`div`.exists()
|
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children |
hasValue() or (children().count() > id.count())
|
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both |
extension.exists() != value.exists()
|
| ing-1 | error | Ingredient | 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 |
Ingredient.where(allergenicIndicator=true).count() + Ingredient.substance.code.reference.count() < 2
|
This structure is derived from Ingredient
| Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() |
|---|---|---|---|---|
![]() |
0..* | Ingredient | CH IDMP Ingredient | |
![]() ![]() |
0..* | Reference(IDMP MedicinalProductDefinition | CH IDMP AdministrableProductDefinition | CH IDMP ManufacturedItemDefinition) | The product which this ingredient is a constituent part of | |
![]() ![]() |
1..1 | CodeableConcept | Purpose of the ingredient within the product, e.g. active, inactive Binding: CH SMC - Ingredient Role (required) | |
![]() ![]() ![]() |
1..* | Coding | Code defined by a terminology system Slice: Unordered, Open by value:system | |
![]() ![]() ![]() ![]() |
0..1 | Coding | Code defined by a terminology system | |
![]() ![]() ![]() ![]() ![]() |
1..1 | uri | Identity of the terminology system Required Pattern: http://fhir.ch/ig/ch-epl/CodeSystem/ch-SMC-ingredient-role | |
![]() ![]() ![]() ![]() ![]() |
1..1 | code | Symbol in syntax defined by the system | |
![]() ![]() |
||||
![]() ![]() ![]() |
1..1 | CodeableReference(SubstanceDefinition) | A code or full resource that represents the ingredient substance Binding: CH SMC - Substance (required) | |
![]() ![]() ![]() ![]() |
1..1 | CodeableConcept | Reference to a concept (by class) | |
![]() ![]() ![]() ![]() ![]() |
1..* | Coding | Code defined by a terminology system Slice: Unordered, Open by value:system | |
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | Coding | Code defined by a terminology system | |
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | uri | Identity of the terminology system Required Pattern: http://fhir.ch/ig/ch-epl/CodeSystem/ch-SMC-substance | |
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | code | Symbol in syntax defined by the system | |
Documentation for this format | ||||
| Path | Status | Usage | ValueSet | Version | Source |
| Ingredient.role | Base | required | CH SMC - Ingredient Role | 📦1.0.0-ci-build | This IG |
| Ingredient.substance.code | Base | required | CH SMC - Substance | 📦1.0.0-ci-build | This IG |
| Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() | ||||
|---|---|---|---|---|---|---|---|---|
![]() |
C | 0..* | Ingredient | CH IDMP Ingredient Constraints: ing-1 | ||||
![]() ![]() |
Σ | 0..1 | id | Logical id of this artifact | ||||
![]() ![]() |
Σ | 0..1 | Meta | Metadata about the resource | ||||
![]() ![]() |
?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
![]() ![]() |
0..1 | code | Language of the resource content Binding: AllLanguages (required): IETF language tag for a human language
| |||||
![]() ![]() |
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 | |||||
![]() ![]() |
0..* | Resource | Contained, inline Resources | |||||
![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored | ||||
![]() ![]() |
Σ | 0..1 | Identifier | An identifier or code by which the ingredient can be referenced | ||||
![]() ![]() |
?!Σ | 1..1 | code | draft | active | retired | unknown Binding: PublicationStatus (required): The lifecycle status of an artifact. | ||||
![]() ![]() |
Σ | 0..* | Reference(IDMP MedicinalProductDefinition | CH IDMP AdministrableProductDefinition | CH IDMP ManufacturedItemDefinition) | The product which this ingredient is a constituent part of | ||||
![]() ![]() |
Σ | 1..1 | CodeableConcept | Purpose of the ingredient within the product, e.g. active, inactive Binding: CH SMC - Ingredient Role (required) | ||||
![]() ![]() ![]() |
0..1 | id | Unique id for inter-element referencing | |||||
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() |
Σ | 1..* | Coding | Code defined by a terminology system Slice: Unordered, Open by value:system | ||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | Coding | Code defined by a terminology system | ||||
![]() ![]() ![]() ![]() ![]() |
0..1 | id | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() ![]() |
Σ | 1..1 | uri | Identity of the terminology system Required Pattern: http://fhir.ch/ig/ch-epl/CodeSystem/ch-SMC-ingredient-role | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | string | Version of the system - if relevant | ||||
![]() ![]() ![]() ![]() ![]() |
ΣC | 1..1 | code | Symbol in syntax defined by the system | ||||
![]() ![]() ![]() ![]() ![]() |
ΣC | 0..1 | string | Representation defined by the system | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | boolean | If this coding was chosen directly by the user | ||||
![]() ![]() ![]() |
Σ | 0..1 | string | Plain text representation of the concept | ||||
![]() ![]() |
Σ | 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). | ||||
![]() ![]() |
Σ | 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 | ||||
![]() ![]() |
ΣC | 0..1 | boolean | If the ingredient is a known or suspected allergen | ||||
![]() ![]() |
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 | |||||
![]() ![]() |
Σ | 0..* | BackboneElement | An organization that manufactures this ingredient | ||||
![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() |
Σ | 0..1 | code | allowed | possible | actual Binding: IngredientManufacturerRole (required): The way in which this manufacturer is associated with the ingredient. | ||||
![]() ![]() ![]() |
Σ | 1..1 | Reference(Organization) | An organization that manufactures this ingredient | ||||
![]() ![]() |
ΣC | 1..1 | BackboneElement | The substance that comprises this ingredient | ||||
![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() |
ΣC | 1..1 | CodeableReference(SubstanceDefinition) | A code or full resource that represents the ingredient substance Binding: CH SMC - Substance (required) | ||||
![]() ![]() ![]() ![]() |
0..1 | id | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() |
Σ | 1..1 | CodeableConcept | Reference to a concept (by class) | ||||
![]() ![]() ![]() ![]() ![]() |
0..1 | id | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() ![]() |
Σ | 1..* | Coding | Code defined by a terminology system Slice: Unordered, Open by value:system | ||||
![]() ![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | Coding | Code defined by a terminology system | ||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | id | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
Σ | 1..1 | uri | Identity of the terminology system Required Pattern: http://fhir.ch/ig/ch-epl/CodeSystem/ch-SMC-substance | ||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | string | Version of the system - if relevant | ||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
ΣC | 1..1 | code | Symbol in syntax defined by the system | ||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
ΣC | 0..1 | string | Representation defined by the system | ||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | boolean | If this coding was chosen directly by the user | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | string | Plain text representation of the concept | ||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | Reference() | Reference to a resource (by instance) | ||||
![]() ![]() ![]() |
Σ | 0..* | BackboneElement | The quantity of substance, per presentation, or per volume or mass, and type of quantity | ||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | The quantity of substance in the unit of presentation | |||||
![]() ![]() ![]() ![]() ![]() |
Ratio | |||||||
![]() ![]() ![]() ![]() ![]() |
RatioRange | |||||||
![]() ![]() ![]() ![]() ![]() |
CodeableConcept | |||||||
![]() ![]() ![]() ![]() ![]() |
Quantity | |||||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | string | Text of either the whole presentation strength or a part of it (rest being in Strength.presentation as a ratio) | ||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | The strength per unitary volume (or mass) | |||||
![]() ![]() ![]() ![]() ![]() |
Ratio | |||||||
![]() ![]() ![]() ![]() ![]() |
RatioRange | |||||||
![]() ![]() ![]() ![]() ![]() |
CodeableConcept | |||||||
![]() ![]() ![]() ![]() ![]() |
Quantity | |||||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | string | Text of either the whole concentration strength or a part of it (rest being in Strength.concentration as a ratio) | ||||
![]() ![]() ![]() ![]() |
Σ | 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) | ||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | string | When strength is measured at a particular point or distance | ||||
![]() ![]() ![]() ![]() |
Σ | 0..* | CodeableConcept | Where the strength range applies Binding: CountryValueSet (example): Jurisdiction codes | ||||
![]() ![]() ![]() ![]() |
Σ | 0..* | BackboneElement | Strength expressed in terms of a reference substance | ||||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 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. | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 1..1 | Strength expressed in terms of a reference substance | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
Ratio | |||||||
![]() ![]() ![]() ![]() ![]() ![]() |
RatioRange | |||||||
![]() ![]() ![]() ![]() ![]() ![]() |
Quantity | |||||||
![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | string | When strength is measured at a particular point or distance | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 0..* | CodeableConcept | Where the strength range applies Binding: CountryValueSet (example): Jurisdiction codes | ||||
Documentation for this format | ||||||||
| 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 | required | CH SMC - Ingredient Role | 📦1.0.0-ci-build | This IG |
| 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 | required | CH SMC - Substance | 📦1.0.0-ci-build | This IG |
| Ingredient.substance.strength.country | Base | example | Country ValueSet | 📍5.0.0 | FHIR Std. |
| Ingredient.substance.strength.referenceStrength.substance | Base | example | SNOMED CT Substance Codes | 📍5.0.0 | FHIR Std. |
| Ingredient.substance.strength.referenceStrength.country | Base | example | Country ValueSet | 📍5.0.0 | FHIR Std. |
| Id | Grade | Path(s) | Description | Expression |
| dom-2 | error | Ingredient | If the resource is contained in another resource, it SHALL NOT contain nested Resources |
contained.contained.empty()
|
| dom-3 | error | Ingredient | 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 |
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-4 | error | Ingredient | If 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-5 | error | Ingredient | If a resource is contained in another resource, it SHALL NOT have a security label |
contained.meta.security.empty()
|
| dom-6 | best practice | Ingredient | A resource should have narrative for robust management |
text.`div`.exists()
|
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children |
hasValue() or (children().count() > id.count())
|
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both |
extension.exists() != value.exists()
|
| ing-1 | error | Ingredient | 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 |
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:
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() |
|---|---|---|---|---|
![]() |
C | 0..* | Ingredient | CH IDMP Ingredient Constraints: ing-1 |
![]() ![]() |
?!Σ | 0..1 | uri | A set of rules under which this content was created |
![]() ![]() |
0..* | Resource | Contained, inline Resources | |
![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored |
![]() ![]() |
?!Σ | 1..1 | code | draft | active | retired | unknown Binding: PublicationStatus (required): The lifecycle status of an artifact. |
![]() ![]() |
Σ | 0..* | Reference(IDMP MedicinalProductDefinition | CH IDMP AdministrableProductDefinition | CH IDMP ManufacturedItemDefinition) | The product which this ingredient is a constituent part of |
![]() ![]() |
Σ | 1..1 | CodeableConcept | Purpose of the ingredient within the product, e.g. active, inactive Binding: CH SMC - Ingredient Role (required) |
![]() ![]() ![]() |
Σ | 1..* | Coding | Code defined by a terminology system Slice: Unordered, Open by value:system |
![]() ![]() ![]() ![]() |
Σ | 0..1 | Coding | Code defined by a terminology system |
![]() ![]() ![]() ![]() ![]() |
Σ | 1..1 | uri | Identity of the terminology system Required Pattern: http://fhir.ch/ig/ch-epl/CodeSystem/ch-SMC-ingredient-role |
![]() ![]() ![]() ![]() ![]() |
ΣC | 1..1 | code | Symbol in syntax defined by the system |
![]() ![]() |
ΣC | 1..1 | BackboneElement | The substance that comprises this ingredient |
![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
![]() ![]() ![]() |
ΣC | 1..1 | CodeableReference(SubstanceDefinition) | A code or full resource that represents the ingredient substance Binding: CH SMC - Substance (required) |
![]() ![]() ![]() ![]() |
Σ | 1..1 | CodeableConcept | Reference to a concept (by class) |
![]() ![]() ![]() ![]() ![]() |
Σ | 1..* | Coding | Code defined by a terminology system Slice: Unordered, Open by value:system |
![]() ![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | Coding | Code defined by a terminology system |
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
Σ | 1..1 | uri | Identity of the terminology system Required Pattern: http://fhir.ch/ig/ch-epl/CodeSystem/ch-SMC-substance |
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
ΣC | 1..1 | code | Symbol in syntax defined by the system |
Documentation for this format | ||||
| Path | Status | Usage | ValueSet | Version | Source |
| Ingredient.status | Base | required | PublicationStatus | 📍5.0.0 | FHIR Std. |
| Ingredient.role | Base | required | CH SMC - Ingredient Role | 📦1.0.0-ci-build | This IG |
| Ingredient.substance.code | Base | required | CH SMC - Substance | 📦1.0.0-ci-build | This IG |
| Id | Grade | Path(s) | Description | Expression |
| dom-2 | error | Ingredient | If the resource is contained in another resource, it SHALL NOT contain nested Resources |
contained.contained.empty()
|
| dom-3 | error | Ingredient | 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 |
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-4 | error | Ingredient | If 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-5 | error | Ingredient | If a resource is contained in another resource, it SHALL NOT have a security label |
contained.meta.security.empty()
|
| dom-6 | best practice | Ingredient | A resource should have narrative for robust management |
text.`div`.exists()
|
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children |
hasValue() or (children().count() > id.count())
|
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both |
extension.exists() != value.exists()
|
| ing-1 | error | Ingredient | 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 |
Ingredient.where(allergenicIndicator=true).count() + Ingredient.substance.code.reference.count() < 2
|
Differential View
This structure is derived from Ingredient
| Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() |
|---|---|---|---|---|
![]() |
0..* | Ingredient | CH IDMP Ingredient | |
![]() ![]() |
0..* | Reference(IDMP MedicinalProductDefinition | CH IDMP AdministrableProductDefinition | CH IDMP ManufacturedItemDefinition) | The product which this ingredient is a constituent part of | |
![]() ![]() |
1..1 | CodeableConcept | Purpose of the ingredient within the product, e.g. active, inactive Binding: CH SMC - Ingredient Role (required) | |
![]() ![]() ![]() |
1..* | Coding | Code defined by a terminology system Slice: Unordered, Open by value:system | |
![]() ![]() ![]() ![]() |
0..1 | Coding | Code defined by a terminology system | |
![]() ![]() ![]() ![]() ![]() |
1..1 | uri | Identity of the terminology system Required Pattern: http://fhir.ch/ig/ch-epl/CodeSystem/ch-SMC-ingredient-role | |
![]() ![]() ![]() ![]() ![]() |
1..1 | code | Symbol in syntax defined by the system | |
![]() ![]() |
||||
![]() ![]() ![]() |
1..1 | CodeableReference(SubstanceDefinition) | A code or full resource that represents the ingredient substance Binding: CH SMC - Substance (required) | |
![]() ![]() ![]() ![]() |
1..1 | CodeableConcept | Reference to a concept (by class) | |
![]() ![]() ![]() ![]() ![]() |
1..* | Coding | Code defined by a terminology system Slice: Unordered, Open by value:system | |
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | Coding | Code defined by a terminology system | |
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | uri | Identity of the terminology system Required Pattern: http://fhir.ch/ig/ch-epl/CodeSystem/ch-SMC-substance | |
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | code | Symbol in syntax defined by the system | |
Documentation for this format | ||||
| Path | Status | Usage | ValueSet | Version | Source |
| Ingredient.role | Base | required | CH SMC - Ingredient Role | 📦1.0.0-ci-build | This IG |
| Ingredient.substance.code | Base | required | CH SMC - Substance | 📦1.0.0-ci-build | This IG |
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() | ||||
|---|---|---|---|---|---|---|---|---|
![]() |
C | 0..* | Ingredient | CH IDMP Ingredient Constraints: ing-1 | ||||
![]() ![]() |
Σ | 0..1 | id | Logical id of this artifact | ||||
![]() ![]() |
Σ | 0..1 | Meta | Metadata about the resource | ||||
![]() ![]() |
?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
![]() ![]() |
0..1 | code | Language of the resource content Binding: AllLanguages (required): IETF language tag for a human language
| |||||
![]() ![]() |
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 | |||||
![]() ![]() |
0..* | Resource | Contained, inline Resources | |||||
![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored | ||||
![]() ![]() |
Σ | 0..1 | Identifier | An identifier or code by which the ingredient can be referenced | ||||
![]() ![]() |
?!Σ | 1..1 | code | draft | active | retired | unknown Binding: PublicationStatus (required): The lifecycle status of an artifact. | ||||
![]() ![]() |
Σ | 0..* | Reference(IDMP MedicinalProductDefinition | CH IDMP AdministrableProductDefinition | CH IDMP ManufacturedItemDefinition) | The product which this ingredient is a constituent part of | ||||
![]() ![]() |
Σ | 1..1 | CodeableConcept | Purpose of the ingredient within the product, e.g. active, inactive Binding: CH SMC - Ingredient Role (required) | ||||
![]() ![]() ![]() |
0..1 | id | Unique id for inter-element referencing | |||||
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() |
Σ | 1..* | Coding | Code defined by a terminology system Slice: Unordered, Open by value:system | ||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | Coding | Code defined by a terminology system | ||||
![]() ![]() ![]() ![]() ![]() |
0..1 | id | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() ![]() |
Σ | 1..1 | uri | Identity of the terminology system Required Pattern: http://fhir.ch/ig/ch-epl/CodeSystem/ch-SMC-ingredient-role | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | string | Version of the system - if relevant | ||||
![]() ![]() ![]() ![]() ![]() |
ΣC | 1..1 | code | Symbol in syntax defined by the system | ||||
![]() ![]() ![]() ![]() ![]() |
ΣC | 0..1 | string | Representation defined by the system | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | boolean | If this coding was chosen directly by the user | ||||
![]() ![]() ![]() |
Σ | 0..1 | string | Plain text representation of the concept | ||||
![]() ![]() |
Σ | 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). | ||||
![]() ![]() |
Σ | 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 | ||||
![]() ![]() |
ΣC | 0..1 | boolean | If the ingredient is a known or suspected allergen | ||||
![]() ![]() |
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 | |||||
![]() ![]() |
Σ | 0..* | BackboneElement | An organization that manufactures this ingredient | ||||
![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() |
Σ | 0..1 | code | allowed | possible | actual Binding: IngredientManufacturerRole (required): The way in which this manufacturer is associated with the ingredient. | ||||
![]() ![]() ![]() |
Σ | 1..1 | Reference(Organization) | An organization that manufactures this ingredient | ||||
![]() ![]() |
ΣC | 1..1 | BackboneElement | The substance that comprises this ingredient | ||||
![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() |
ΣC | 1..1 | CodeableReference(SubstanceDefinition) | A code or full resource that represents the ingredient substance Binding: CH SMC - Substance (required) | ||||
![]() ![]() ![]() ![]() |
0..1 | id | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() |
Σ | 1..1 | CodeableConcept | Reference to a concept (by class) | ||||
![]() ![]() ![]() ![]() ![]() |
0..1 | id | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() ![]() |
Σ | 1..* | Coding | Code defined by a terminology system Slice: Unordered, Open by value:system | ||||
![]() ![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | Coding | Code defined by a terminology system | ||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | id | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
Σ | 1..1 | uri | Identity of the terminology system Required Pattern: http://fhir.ch/ig/ch-epl/CodeSystem/ch-SMC-substance | ||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | string | Version of the system - if relevant | ||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
ΣC | 1..1 | code | Symbol in syntax defined by the system | ||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
ΣC | 0..1 | string | Representation defined by the system | ||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | boolean | If this coding was chosen directly by the user | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | string | Plain text representation of the concept | ||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | Reference() | Reference to a resource (by instance) | ||||
![]() ![]() ![]() |
Σ | 0..* | BackboneElement | The quantity of substance, per presentation, or per volume or mass, and type of quantity | ||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | The quantity of substance in the unit of presentation | |||||
![]() ![]() ![]() ![]() ![]() |
Ratio | |||||||
![]() ![]() ![]() ![]() ![]() |
RatioRange | |||||||
![]() ![]() ![]() ![]() ![]() |
CodeableConcept | |||||||
![]() ![]() ![]() ![]() ![]() |
Quantity | |||||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | string | Text of either the whole presentation strength or a part of it (rest being in Strength.presentation as a ratio) | ||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | The strength per unitary volume (or mass) | |||||
![]() ![]() ![]() ![]() ![]() |
Ratio | |||||||
![]() ![]() ![]() ![]() ![]() |
RatioRange | |||||||
![]() ![]() ![]() ![]() ![]() |
CodeableConcept | |||||||
![]() ![]() ![]() ![]() ![]() |
Quantity | |||||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | string | Text of either the whole concentration strength or a part of it (rest being in Strength.concentration as a ratio) | ||||
![]() ![]() ![]() ![]() |
Σ | 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) | ||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | string | When strength is measured at a particular point or distance | ||||
![]() ![]() ![]() ![]() |
Σ | 0..* | CodeableConcept | Where the strength range applies Binding: CountryValueSet (example): Jurisdiction codes | ||||
![]() ![]() ![]() ![]() |
Σ | 0..* | BackboneElement | Strength expressed in terms of a reference substance | ||||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 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. | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 1..1 | Strength expressed in terms of a reference substance | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
Ratio | |||||||
![]() ![]() ![]() ![]() ![]() ![]() |
RatioRange | |||||||
![]() ![]() ![]() ![]() ![]() ![]() |
Quantity | |||||||
![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | string | When strength is measured at a particular point or distance | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 0..* | CodeableConcept | Where the strength range applies Binding: CountryValueSet (example): Jurisdiction codes | ||||
Documentation for this format | ||||||||
| 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 | required | CH SMC - Ingredient Role | 📦1.0.0-ci-build | This IG |
| 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 | required | CH SMC - Substance | 📦1.0.0-ci-build | This IG |
| Ingredient.substance.strength.country | Base | example | Country ValueSet | 📍5.0.0 | FHIR Std. |
| Ingredient.substance.strength.referenceStrength.substance | Base | example | SNOMED CT Substance Codes | 📍5.0.0 | FHIR Std. |
| Ingredient.substance.strength.referenceStrength.country | Base | example | Country ValueSet | 📍5.0.0 | FHIR Std. |
| Id | Grade | Path(s) | Description | Expression |
| dom-2 | error | Ingredient | If the resource is contained in another resource, it SHALL NOT contain nested Resources |
contained.contained.empty()
|
| dom-3 | error | Ingredient | 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 |
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-4 | error | Ingredient | If 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-5 | error | Ingredient | If a resource is contained in another resource, it SHALL NOT have a security label |
contained.meta.security.empty()
|
| dom-6 | best practice | Ingredient | A resource should have narrative for robust management |
text.`div`.exists()
|
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children |
hasValue() or (children().count() > id.count())
|
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both |
extension.exists() != value.exists()
|
| ing-1 | error | Ingredient | 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 |
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:
Other representations of profile: CSV, Excel, Schematron