UnicomIG
0.1.0 - ci-build
UnicomIG, published by UNICOM. 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/hl7-eu/unicom-ig/tree/master and changes regularly. See the Directory of published versions
Draft as of 2024-10-11 |
Definitions for the PPLIngredient resource profile.
Guidance on how to interpret the contents of this table can be found here
0. Ingredient | |
Invariants | strength-required: If product is active, then strength MUST be populated (role.coding.code='100000072072' implies strength.exists() ) |
2. Ingredient.for | |
Short | Reference to the medicinal product, pharmaceutical product and/or manufactured item where the ingredient is used |
Control | 1..? |
Type | Reference(PPL Medicinal Product profile, PPL Administrable Product profile, PPL Manufactured Item profile) |
4. Ingredient.role | |
Definition | EMA IG 5.1 |
Short | Role of the ingredient. Default is 100000072072|Active as PPL data normally only includes active ingredients. |
6. Ingredient.role.coding | |
8. Ingredient.role.coding.system | |
Pattern Value | https://spor.ema.europa.eu/v1/lists/100000072050 |
10. Ingredient.substance | |
Definition | EMA IG 5.5 |
Short | Substance code from EMA SMS |
12. Ingredient.substance.code | |
Binding | The codes SHALL be taken from EMA SPOR SMS Substances (required to http://unicom-project.eu/fhir/ValueSet/substances-vs ) |
14. Ingredient.substance.strength | |
Definition | EMA IG 5.5.2 |
16. Ingredient.substance.strength.presentation[x] | |
[x] Note | SeeChoice of Data Typesfor further information about how to use [x] |
Slicing | This element introduces a set of slices on Ingredient.substance.strength.presentation[x] . The slices areUnordered and Open, and can be differentiated using the following discriminators: |
18. Ingredient.substance.strength.presentation[x]:presentationRatio | |
Slice Name | presentationRatio |
Definition | EMA IG 5.5.2 |
Short | Strength per unit of presentation (10mg/vial or 10mg/0.5ml where 0.5ml is the size of the vial) |
Control | 0..1 |
Type | Ratio |
[x] Note | SeeChoice of Data Typesfor further information about how to use [x] |
20. Ingredient.substance.strength.presentation[x]:presentationRatio.numerator | |
Binding | The codes SHALL be taken from EMA SPOR Unit of Measurement (required to http://unicom-project.eu/fhir/ValueSet/unit-of-measurement-vs ) |
22. Ingredient.substance.strength.presentation[x]:presentationRatio.denominator | |
Short | Unit of measurement or unit of presentation |
Control | 1..? |
Binding | The codes SHALL be taken from EMA SPOR All Units Combined (required to http://unicom-project.eu/fhir/ValueSet/all-units-vs ) |
24. Ingredient.substance.strength.concentration[x] | |
[x] Note | SeeChoice of Data Typesfor further information about how to use [x] |
Slicing | This element introduces a set of slices on Ingredient.substance.strength.concentration[x] . The slices areUnordered and Open, and can be differentiated using the following discriminators: |
26. Ingredient.substance.strength.concentration[x]:concentrationRatio | |
Slice Name | concentrationRatio |
Definition | EMA IG 5.5.2 |
Short | Strength per unit of measurement (20mg/1ml) |
Control | 0..1 |
Type | Ratio |
[x] Note | SeeChoice of Data Typesfor further information about how to use [x] |
28. Ingredient.substance.strength.concentration[x]:concentrationRatio.numerator | |
Binding | The codes SHALL be taken from EMA SPOR Unit of Measurement (required to http://unicom-project.eu/fhir/ValueSet/unit-of-measurement-vs ) |
30. Ingredient.substance.strength.concentration[x]:concentrationRatio.denominator | |
Control | 1..? |
Binding | The codes SHALL be taken from EMA SPOR Unit of Measurement (required to http://unicom-project.eu/fhir/ValueSet/unit-of-measurement-vs ) |
32. Ingredient.substance.strength.referenceStrength | |
Definition | EMA IG 5.5.3. According to EMA, this is a mandatory element for all products, which is not necessarily accepted by all NCAs, and it is ambivalent in ISO IDMP. |
Short | Strenth expressed in terms of a reference substance; reference strength type not distinguished. According to EMA IG, all products need to have reference strentgh (repeating the strentgh, if needed) |
34. Ingredient.substance.strength.referenceStrength.substance | |
Short | Substance code from EMA SMS |
Binding | The codes SHALL be taken from EMA SPOR SMS Substances (required to http://unicom-project.eu/fhir/ValueSet/substances-vs ) |
36. Ingredient.substance.strength.referenceStrength.strength[x] | |
[x] Note | SeeChoice of Data Typesfor further information about how to use [x] |
Slicing | This element introduces a set of slices on Ingredient.substance.strength.referenceStrength.strength[x] . The slices areUnordered and Open, and can be differentiated using the following discriminators: |
38. Ingredient.substance.strength.referenceStrength.strength[x]:strengthRatio | |
Slice Name | strengthRatio |
Control | 0..1 |
Type | Ratio |
[x] Note | SeeChoice of Data Typesfor further information about how to use [x] |
40. Ingredient.substance.strength.referenceStrength.strength[x]:strengthRatio.numerator | |
Control | 1..? |
Binding | The codes SHALL be taken from EMA SPOR Unit of Measurement (required to http://unicom-project.eu/fhir/ValueSet/unit-of-measurement-vs ) |
42. Ingredient.substance.strength.referenceStrength.strength[x]:strengthRatio.denominator | |
Short | Unit of measurement or unit of presentation |
Control | 1..? |
Binding | The codes SHALL be taken from EMA SPOR All Units Combined (required to http://unicom-project.eu/fhir/ValueSet/all-units-vs ) |
Guidance on how to interpret the contents of this table can be found here
0. Ingredient | |
Definition | An ingredient of a manufactured item or pharmaceutical product. |
Short | An ingredient of a manufactured item or pharmaceutical product |
Control | 0..* |
Is Modifier | false |
Must Support | false |
Summary | false |
Invariants | dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources (contained.contained.empty()) dom-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource (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: 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: If a resource is contained in another resource, it SHALL NOT have a security label (contained.meta.security.empty()) dom-6: A resource should have narrative for robust management (text.`div`.exists()) 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 (Ingredient.where(allergenicIndicator=true).count() + Ingredient.substance.code.reference.count() < 2) strength-required: If product is active, then strength MUST be populated ( role.coding.code='100000072072' implies strength.exists() ) |
2. Ingredient.implicitRules | |
Definition | A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc. |
Short | A set of rules under which this content was created |
Comments | Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of its narrative along with other profiles, value sets, etc. |
Control | 0..1 |
Type | uri |
Is Modifier | true because This element is labeled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies its meaning or interpretation |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Must Support | false |
Summary | true |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
4. Ingredient.contained | |
Definition | These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, nor can they have their own independent transaction scope. This is allowed to be a Parameters resource if and only if it is referenced by a resource that provides context/meaning. |
Short | Contained, inline Resources |
Comments | This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags in their meta elements, but SHALL NOT have security labels. |
Control | 0..* This element is affected by the following invariants: dom-2, dom-4, dom-3, dom-5 |
Type | Resource |
Is Modifier | false |
Must Support | false |
Summary | false |
Alternate Names | inline resources, anonymous resources, contained resources |
6. Ingredient.modifierExtension | |
Definition | May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). |
Short | Extensions that cannot be ignored |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Control | 0..* |
Type | Extension |
Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the resource that contains them |
Must Support | false |
Summary | true |
Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. |
Alternate Names | extensions, user content |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists()) |
8. Ingredient.status | |
Definition | The status of this ingredient. Enables tracking the life-cycle of the content. |
Short | draft | active | retired | unknown |
Comments | Allows filtering of ingredient that are appropriate for use versus not. |
Control | 1..1 |
Binding | The codes SHALL be taken from PublicationStatushttp://hl7.org/fhir/ValueSet/publication-status|5.0.0 (required to http://hl7.org/fhir/ValueSet/publication-status|5.0.0 )The lifecycle status of an artifact. |
Type | code |
Is Modifier | true because This is labeled as "Is Modifier" because applications should not use a retired {{title}} without due consideration |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Must Support | false |
Summary | true |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
10. Ingredient.for | |
Definition | The product which this ingredient is a constituent part of. |
Short | Reference to the medicinal product, pharmaceutical product and/or manufactured item where the ingredient is usedThe product which this ingredient is a constituent part of |
Control | 10..* |
Type | Reference(PPL Medicinal Product profile, PPL Administrable Product profile, PPL Manufactured Item profile, MedicinalProductDefinition, AdministrableProductDefinition, ManufacturedItemDefinition) |
Is Modifier | false |
Must Support | false |
Summary | true |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
12. Ingredient.role | |
Definition | EMA IG 5.1 A classification of the ingredient identifying its purpose within the product, e.g. active, inactive. |
Short | Role of the ingredient. Default is 100000072072|Active as PPL data normally only includes active ingredients.Purpose of the ingredient within the product, e.g. active, inactive |
Control | 1..1 |
Binding | For example codes, see IngredientRolehttp://hl7.org/fhir/ValueSet/ingredient-role (example to http://hl7.org/fhir/ValueSet/ingredient-role )A classification of the ingredient identifying its purpose within the product, e.g. active, inactive. |
Type | CodeableConcept |
Is Modifier | false |
Must Support | false |
Summary | true |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
14. Ingredient.substance | |
Definition | EMA IG 5.5 The substance that comprises this ingredient. |
Short | Substance code from EMA SMSThe substance that comprises this ingredient |
Control | 1..1 This element is affected by the following invariants: ing-1 |
Type | BackboneElement |
Is Modifier | false |
Must Support | false |
Summary | true |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
16. Ingredient.substance.modifierExtension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). |
Short | Extensions that cannot be ignored even if unrecognized |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Control | 0..* |
Type | Extension |
Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them |
Summary | true |
Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. |
Alternate Names | extensions, user content, modifiers |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists()) |
18. Ingredient.substance.code | |
Definition | A code or full resource that represents the ingredient's substance. |
Short | A code or full resource that represents the ingredient substance |
Control | 1..1 This element is affected by the following invariants: ing-1 |
Binding | The codes SHALL be taken from For example codes, see EMA SPOR SMS Substanceshttp://hl7.org/fhir/ValueSet/substance-codes (required to http://unicom-project.eu/fhir/ValueSet/substances-vs ) |
Type | CodeableReference(SubstanceDefinition) |
Is Modifier | false |
Must Support | false |
Summary | true |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
20. Ingredient.substance.strength | |
Definition | EMA IG 5.5.2 The quantity of substance in the unit of presentation, or in the volume (or mass) of the single pharmaceutical product or manufactured item. The allowed repetitions do not represent different strengths, but are different representations - mathematically equivalent - of a single strength. |
Short | The quantity of substance, per presentation, or per volume or mass, and type of quantity |
Control | 0..* |
Type | BackboneElement |
Is Modifier | false |
Must Support | false |
Summary | true |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
22. Ingredient.substance.strength.modifierExtension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). |
Short | Extensions that cannot be ignored even if unrecognized |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Control | 0..* |
Type | Extension |
Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them |
Summary | true |
Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. |
Alternate Names | extensions, user content, modifiers |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists()) |
24. Ingredient.substance.strength.presentation[x] | |
Definition | The quantity of substance in the unit of presentation, or in the volume (or mass) of the single pharmaceutical product or manufactured item. Unit of presentation refers to the quantity that the item occurs in e.g. a strength per tablet size, perhaps 'per 20mg' (the size of the tablet). It is not generally normalized as a unitary unit, which would be 'per mg'). |
Short | The quantity of substance in the unit of presentation |
Control | 0..1 |
Type | Choice of: Ratio, RatioRange, CodeableConcept, Quantity |
[x] Note | SeeChoice of Data Typesfor further information about how to use [x] |
Is Modifier | false |
Must Support | false |
Summary | true |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
Slicing | This element introduces a set of slices on Ingredient.substance.strength.presentation[x] . The slices areUnordered and Open, and can be differentiated using the following discriminators: |
26. Ingredient.substance.strength.presentation[x]:presentationRatio | |
Slice Name | presentationRatio |
Definition | EMA IG 5.5.2 The quantity of substance in the unit of presentation, or in the volume (or mass) of the single pharmaceutical product or manufactured item. Unit of presentation refers to the quantity that the item occurs in e.g. a strength per tablet size, perhaps 'per 20mg' (the size of the tablet). It is not generally normalized as a unitary unit, which would be 'per mg'). |
Short | Strength per unit of presentation (10mg/vial or 10mg/0.5ml where 0.5ml is the size of the vial)The quantity of substance in the unit of presentation |
Control | 0..1 |
Type | Ratio, RatioRange, Quantity, CodeableConcept |
[x] Note | SeeChoice of Data Typesfor further information about how to use [x] |
Is Modifier | false |
Must Support | false |
Summary | true |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
28. Ingredient.substance.strength.presentation[x]:presentationRatio.numerator | |
Definition | The value of the numerator. |
Short | Numerator value |
Control | 0..1 This element is affected by the following invariants: rat-1 |
Binding | The codes SHALL be taken from For codes, see EMA SPOR Unit of Measurement (required to http://unicom-project.eu/fhir/ValueSet/unit-of-measurement-vs ) |
Type | Quantity |
Is Modifier | false |
Summary | true |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
30. Ingredient.substance.strength.presentation[x]:presentationRatio.denominator | |
Definition | The value of the denominator. |
Short | Unit of measurement or unit of presentationDenominator value |
Control | 10..1 This element is affected by the following invariants: rat-1 |
Binding | The codes SHALL be taken from For codes, see EMA SPOR All Units Combined (required to http://unicom-project.eu/fhir/ValueSet/all-units-vs ) |
Type | Quantity(SimpleQuantity) |
Is Modifier | false |
Summary | true |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
32. Ingredient.substance.strength.concentration[x] | |
Definition | The strength per unitary volume (or mass). |
Short | The strength per unitary volume (or mass) |
Control | 0..1 |
Type | Choice of: Ratio, RatioRange, CodeableConcept, Quantity |
[x] Note | SeeChoice of Data Typesfor further information about how to use [x] |
Is Modifier | false |
Must Support | false |
Summary | true |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
Slicing | This element introduces a set of slices on Ingredient.substance.strength.concentration[x] . The slices areUnordered and Open, and can be differentiated using the following discriminators: |
34. Ingredient.substance.strength.concentration[x]:concentrationRatio | |
Slice Name | concentrationRatio |
Definition | EMA IG 5.5.2 The strength per unitary volume (or mass). |
Short | Strength per unit of measurement (20mg/1ml)The strength per unitary volume (or mass) |
Control | 0..1 |
Type | Ratio, RatioRange, Quantity, CodeableConcept |
[x] Note | SeeChoice of Data Typesfor further information about how to use [x] |
Is Modifier | false |
Must Support | false |
Summary | true |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
36. Ingredient.substance.strength.concentration[x]:concentrationRatio.numerator | |
Definition | The value of the numerator. |
Short | Numerator value |
Control | 0..1 This element is affected by the following invariants: rat-1 |
Binding | The codes SHALL be taken from For codes, see EMA SPOR Unit of Measurement (required to http://unicom-project.eu/fhir/ValueSet/unit-of-measurement-vs ) |
Type | Quantity |
Is Modifier | false |
Summary | true |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
38. Ingredient.substance.strength.concentration[x]:concentrationRatio.denominator | |
Definition | The value of the denominator. |
Short | Denominator value |
Control | 10..1 This element is affected by the following invariants: rat-1 |
Binding | The codes SHALL be taken from For codes, see EMA SPOR Unit of Measurement (required to http://unicom-project.eu/fhir/ValueSet/unit-of-measurement-vs ) |
Type | Quantity(SimpleQuantity) |
Is Modifier | false |
Summary | true |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
40. Ingredient.substance.strength.referenceStrength | |
Definition | EMA IG 5.5.3. According to EMA, this is a mandatory element for all products, which is not necessarily accepted by all NCAs, and it is ambivalent in ISO IDMP. Strength expressed in terms of a reference substance. For when the ingredient strength is additionally expressed as equivalent to the strength of some other closely related substance (e.g. salt vs. base). Reference strength represents the strength (quantitative composition) of the active moiety of the active substance. There are situations when the active substance and active moiety are different, therefore both a strength and a reference strength are needed. |
Short | Strenth expressed in terms of a reference substance; reference strength type not distinguished. According to EMA IG, all products need to have reference strentgh (repeating the strentgh, if needed)Strength expressed in terms of a reference substance |
Control | 0..* |
Type | BackboneElement |
Is Modifier | false |
Must Support | false |
Summary | true |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
42. Ingredient.substance.strength.referenceStrength.modifierExtension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). |
Short | Extensions that cannot be ignored even if unrecognized |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Control | 0..* |
Type | Extension |
Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them |
Summary | true |
Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. |
Alternate Names | extensions, user content, modifiers |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists()) |
44. Ingredient.substance.strength.referenceStrength.substance | |
Definition | Relevant reference substance. |
Short | Substance code from EMA SMSRelevant reference substance |
Control | 1..1 |
Binding | The codes SHALL be taken from For example codes, see EMA SPOR SMS Substanceshttp://hl7.org/fhir/ValueSet/substance-codes (required to http://unicom-project.eu/fhir/ValueSet/substances-vs ) |
Type | CodeableReference(SubstanceDefinition) |
Is Modifier | false |
Must Support | false |
Summary | true |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
46. Ingredient.substance.strength.referenceStrength.strength[x] | |
Definition | Strength expressed in terms of a reference substance. |
Short | Strength expressed in terms of a reference substance |
Control | 1..1 |
Type | Choice of: Ratio, RatioRange, Quantity |
[x] Note | SeeChoice of Data Typesfor further information about how to use [x] |
Is Modifier | false |
Must Support | false |
Summary | true |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
Slicing | This element introduces a set of slices on Ingredient.substance.strength.referenceStrength.strength[x] . The slices areUnordered and Open, and can be differentiated using the following discriminators: |
48. Ingredient.substance.strength.referenceStrength.strength[x]:strengthRatio | |
Slice Name | strengthRatio |
Definition | Strength expressed in terms of a reference substance. |
Short | Strength expressed in terms of a reference substance |
Control | 01..1 |
Type | Ratio, RatioRange, Quantity |
[x] Note | SeeChoice of Data Typesfor further information about how to use [x] |
Is Modifier | false |
Must Support | false |
Summary | true |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
50. Ingredient.substance.strength.referenceStrength.strength[x]:strengthRatio.numerator | |
Definition | The value of the numerator. |
Short | Numerator value |
Control | 10..1 This element is affected by the following invariants: rat-1 |
Binding | The codes SHALL be taken from For codes, see EMA SPOR Unit of Measurement (required to http://unicom-project.eu/fhir/ValueSet/unit-of-measurement-vs ) |
Type | Quantity |
Is Modifier | false |
Summary | true |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
52. Ingredient.substance.strength.referenceStrength.strength[x]:strengthRatio.denominator | |
Definition | The value of the denominator. |
Short | Unit of measurement or unit of presentationDenominator value |
Control | 10..1 This element is affected by the following invariants: rat-1 |
Binding | The codes SHALL be taken from For codes, see EMA SPOR All Units Combined (required to http://unicom-project.eu/fhir/ValueSet/all-units-vs ) |
Type | Quantity(SimpleQuantity) |
Is Modifier | false |
Summary | true |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
Guidance on how to interpret the contents of this table can be found here
0. Ingredient | |
Definition | An ingredient of a manufactured item or pharmaceutical product. |
Short | An ingredient of a manufactured item or pharmaceutical product |
Control | 0..* |
Is Modifier | false |
Must Support | false |
Summary | false |
Invariants | dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources (contained.contained.empty() )dom-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource ( 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: 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: If a resource is contained in another resource, it SHALL NOT have a security label ( contained.meta.security.empty() )dom-6: A resource should have narrative for robust management ( text.`div`.exists() )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 ( Ingredient.where(allergenicIndicator=true).count() + Ingredient.substance.code.reference.count() < 2 )strength-required: If product is active, then strength MUST be populated ( role.coding.code='100000072072' implies strength.exists() ) |
2. Ingredient.id | |
Definition | The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. |
Short | Logical id of this artifact |
Comments | Within the context of the FHIR RESTful interactions, the resource has an id except for cases like the create and conditional update. Otherwise, the use of the resouce id depends on the given use case. |
Control | 0..1 |
Type | id |
Is Modifier | false |
Must Support | false |
Summary | true |
4. Ingredient.meta | |
Definition | The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource. |
Short | Metadata about the resource |
Control | 0..1 |
Type | Meta |
Is Modifier | false |
Must Support | false |
Summary | true |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) |
6. Ingredient.implicitRules | |
Definition | A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc. |
Short | A set of rules under which this content was created |
Comments | Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of its narrative along with other profiles, value sets, etc. |
Control | 0..1 |
Type | uri |
Is Modifier | true because This element is labeled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies its meaning or interpretation |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Must Support | false |
Summary | true |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) |
8. Ingredient.language | |
Definition | The base language in which the resource is written. |
Short | Language of the resource content |
Comments | Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute). |
Control | 0..1 |
Binding | The codes SHALL be taken from AllLanguages (required to http://hl7.org/fhir/ValueSet/all-languages|5.0.0 )IETF language tag for a human language |
Type | code |
Is Modifier | false |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Must Support | false |
Summary | false |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) |
10. Ingredient.text | |
Definition | A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety. |
Short | Text summary of the resource, for human interpretation |
Comments | Contained resources do not have a narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a "text blob" or where text is additionally entered raw or narrated and encoded information is added later. |
Control | 0..1 This element is affected by the following invariants: dom-6 |
Type | Narrative |
Is Modifier | false |
Must Support | false |
Summary | false |
Alternate Names | narrative, html, xhtml, display |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) |
12. Ingredient.contained | |
Definition | These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, nor can they have their own independent transaction scope. This is allowed to be a Parameters resource if and only if it is referenced by a resource that provides context/meaning. |
Short | Contained, inline Resources |
Comments | This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags in their meta elements, but SHALL NOT have security labels. |
Control | 0..* This element is affected by the following invariants: dom-2, dom-4, dom-3, dom-5 |
Type | Resource |
Is Modifier | false |
Must Support | false |
Summary | false |
Alternate Names | inline resources, anonymous resources, contained resources |
14. Ingredient.extension | |
Definition | May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
Short | Additional content defined by implementations |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Control | 0..* |
Type | Extension |
Is Modifier | false |
Must Support | false |
Summary | false |
Alternate Names | extensions, user content |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) )ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists() ) |
16. Ingredient.modifierExtension | |
Definition | May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). |
Short | Extensions that cannot be ignored |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Control | 0..* |
Type | Extension |
Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the resource that contains them |
Must Support | false |
Summary | true |
Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. |
Alternate Names | extensions, user content |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) )ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists() ) |
18. Ingredient.identifier | |
Definition | The identifier(s) of this Ingredient that are assigned by business processes and/or used to refer to it when a direct URL reference to the resource itself is not appropriate. |
Short | An identifier or code by which the ingredient can be referenced |
Note | This is a business identifier, not a resource identifier (see discussion) |
Control | 0..1 |
Type | Identifier |
Is Modifier | false |
Must Support | false |
Summary | true |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) |
20. Ingredient.status | |
Definition | The status of this ingredient. Enables tracking the life-cycle of the content. |
Short | draft | active | retired | unknown |
Comments | Allows filtering of ingredient that are appropriate for use versus not. |
Control | 1..1 |
Binding | The codes SHALL be taken from PublicationStatus (required to http://hl7.org/fhir/ValueSet/publication-status|5.0.0 )The lifecycle status of an artifact. |
Type | code |
Is Modifier | true because This is labeled as "Is Modifier" because applications should not use a retired {{title}} without due consideration |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Must Support | false |
Summary | true |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) |
22. Ingredient.for | |
Definition | The product which this ingredient is a constituent part of. |
Short | Reference to the medicinal product, pharmaceutical product and/or manufactured item where the ingredient is used |
Control | 1..* |
Type | Reference(PPL Medicinal Product profile, PPL Administrable Product profile, PPL Manufactured Item profile) |
Is Modifier | false |
Must Support | false |
Summary | true |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) |
24. Ingredient.role | |
Definition | EMA IG 5.1 |
Short | Role of the ingredient. Default is 100000072072|Active as PPL data normally only includes active ingredients. |
Control | 1..1 |
Binding | For example codes, see IngredientRole (example to http://hl7.org/fhir/ValueSet/ingredient-role )A classification of the ingredient identifying its purpose within the product, e.g. active, inactive. |
Type | CodeableConcept |
Is Modifier | false |
Must Support | false |
Summary | true |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) |
26. Ingredient.role.id | |
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Short | Unique id for inter-element referencing |
Control | 0..1 This element is affected by the following invariants: ele-1 |
Type | id |
Is Modifier | false |
XML Format | In the XML format, this property is represented as an attribute. |
Summary | false |
28. Ingredient.role.extension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
Short | Additional content defined by implementations |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Control | 0..* |
Type | Extension |
Is Modifier | false |
Summary | false |
Alternate Names | extensions, user content |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) )ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists() ) |
Slicing | This element introduces a set of slices on Ingredient.role.extension . The slices areUnordered and Open, and can be differentiated using the following discriminators: |
30. Ingredient.role.coding | |
Definition | A reference to a code defined by a terminology system. |
Short | Code defined by a terminology system |
Comments | Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true. |
Control | 0..* |
Type | Coding |
Is Modifier | false |
Summary | true |
Requirements | Allows for alternative encodings within a code system, and translations to other code systems. |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) |
32. Ingredient.role.coding.id | |
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Short | Unique id for inter-element referencing |
Control | 0..1 This element is affected by the following invariants: ele-1 |
Type | id |
Is Modifier | false |
XML Format | In the XML format, this property is represented as an attribute. |
Summary | false |
34. Ingredient.role.coding.extension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
Short | Additional content defined by implementations |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Control | 0..* |
Type | Extension |
Is Modifier | false |
Summary | false |
Alternate Names | extensions, user content |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) )ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists() ) |
Slicing | This element introduces a set of slices on Ingredient.role.coding.extension . The slices areUnordered and Open, and can be differentiated using the following discriminators: |
36. Ingredient.role.coding.system | |
Definition | The identification of the code system that defines the meaning of the symbol in the code. |
Short | Identity of the terminology system |
Comments | The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should be an absolute reference to some definition that establishes the system clearly and unambiguously. |
Control | 0..1 |
Type | uri |
Is Modifier | false |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Summary | true |
Requirements | Need to be unambiguous about the source of the definition of the symbol. |
Pattern Value | https://spor.ema.europa.eu/v1/lists/100000072050 |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) |
38. Ingredient.role.coding.version | |
Definition | The version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured, and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged. |
Short | Version of the system - if relevant |
Comments | Where the terminology does not clearly define what string should be used to identify code system versions, the recommendation is to use the date (expressed in FHIR date format) on which that version was officially published as the version date. |
Note | This is a business version Id, not a resource version Id (see discussion) |
Control | 0..1 |
Type | string |
Is Modifier | false |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Summary | true |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) |
40. Ingredient.role.coding.code | |
Definition | A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination). |
Short | Symbol in syntax defined by the system |
Control | 0..1 This element is affected by the following invariants: cod-1 |
Type | code |
Is Modifier | false |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Summary | true |
Requirements | Need to refer to a particular code in the system. |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) |
42. Ingredient.role.coding.display | |
Definition | A representation of the meaning of the code in the system, following the rules of the system. |
Short | Representation defined by the system |
Control | 0..1 This element is affected by the following invariants: cod-1 |
Type | string |
Is Modifier | false |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Summary | true |
Requirements | Need to be able to carry a human-readable meaning of the code for readers that do not know the system. |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) |
44. Ingredient.role.coding.userSelected | |
Definition | Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays). |
Short | If this coding was chosen directly by the user |
Comments | Amongst a set of alternatives, a directly chosen code is the most appropriate starting point for new translations. There is some ambiguity about what exactly 'directly chosen' implies, and trading partner agreement may be needed to clarify the use of this element and its consequences more completely. |
Control | 0..1 |
Type | boolean |
Is Modifier | false |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Summary | true |
Requirements | This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing. |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) |
46. Ingredient.role.text | |
Definition | A human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user. |
Short | Plain text representation of the concept |
Comments | Very often the text is the same as a displayName of one of the codings. |
Control | 0..1 |
Type | string |
Is Modifier | false |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Summary | true |
Requirements | The codes from the terminologies do not always capture the correct meaning with all the nuances of the human using them, or sometimes there is no appropriate code at all. In these cases, the text is used to capture the full meaning of the source. |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) |
48. Ingredient.function | |
Definition | A classification of the ingredient identifying its precise purpose(s) in the drug product. This extends the Ingredient.role to add more detail. Example: antioxidant, alkalizing agent. |
Short | Precise action within the drug product, e.g. antioxidant, alkalizing agent |
Control | 0..* |
Binding | For example codes, see IngredientFunction (example to http://hl7.org/fhir/ValueSet/ingredient-function )A classification of the ingredient identifying its precise purpose(s) in the drug product (beyond e.g. active/inactive). |
Type | CodeableConcept |
Is Modifier | false |
Must Support | false |
Summary | true |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) |
50. Ingredient.group | |
Definition | 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. |
Short | 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 |
Control | 0..1 |
Type | CodeableConcept |
Is Modifier | false |
Must Support | false |
Summary | true |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) |
52. Ingredient.allergenicIndicator | |
Definition | If the ingredient is a known or suspected allergen. Note that this is a property of the substance, so if a reference to a SubstanceDefinition is used to decribe that (rather than just a code), the allergen information should go there, not here. |
Short | If the ingredient is a known or suspected allergen |
Control | 0..1 This element is affected by the following invariants: ing-1 |
Type | boolean |
Is Modifier | false |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Must Support | false |
Summary | true |
Meaning if Missing | If this value is not present, there is no statement being made about whether this is an allergen or not. No inference can be made |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) |
54. Ingredient.comment | |
Definition | A place for providing any notes that are relevant to the component, e.g. removed during process, adjusted for loss on drying. |
Short | A place for providing any notes that are relevant to the component, e.g. removed during process, adjusted for loss on drying |
Control | 0..1 |
Type | markdown |
Is Modifier | false |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Must Support | false |
Summary | false |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) |
56. Ingredient.manufacturer | |
Definition | The organization(s) that manufacture this ingredient. Can be used to indicate: 1) Organizations we are aware of that manufacture this ingredient 2) Specific Manufacturer(s) currently being used 3) Set of organisations allowed to manufacture this ingredient for this product Users must be clear on the application of context relevant to their use case. |
Short | An organization that manufactures this ingredient |
Control | 0..* |
Type | BackboneElement |
Is Modifier | false |
Must Support | false |
Summary | true |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) |
58. Ingredient.manufacturer.id | |
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Short | Unique id for inter-element referencing |
Control | 0..1 This element is affected by the following invariants: ele-1 |
Type | string |
Is Modifier | false |
XML Format | In the XML format, this property is represented as an attribute. |
Summary | false |
60. Ingredient.manufacturer.extension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
Short | Additional content defined by implementations |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Control | 0..* |
Type | Extension |
Is Modifier | false |
Summary | false |
Alternate Names | extensions, user content |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) )ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists() ) |
62. Ingredient.manufacturer.modifierExtension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). |
Short | Extensions that cannot be ignored even if unrecognized |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Control | 0..* |
Type | Extension |
Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them |
Summary | true |
Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. |
Alternate Names | extensions, user content, modifiers |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) )ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists() ) |
64. Ingredient.manufacturer.role | |
Definition | The way in which this manufacturer is associated with the ingredient. For example whether it is a possible one (others allowed), or an exclusive authorized one for this ingredient. Note that this is not the manufacturing process role. |
Short | allowed | possible | actual |
Control | 0..1 |
Binding | The codes SHALL be taken from IngredientManufacturerRole (required to http://hl7.org/fhir/ValueSet/ingredient-manufacturer-role|5.0.0 )The way in which this manufacturer is associated with the ingredient. |
Type | code |
Is Modifier | false |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Must Support | false |
Summary | true |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) |
66. Ingredient.manufacturer.manufacturer | |
Definition | An organization that manufactures this ingredient. |
Short | An organization that manufactures this ingredient |
Control | 1..1 |
Type | Reference(Organization) |
Is Modifier | false |
Must Support | false |
Summary | true |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) |
68. Ingredient.substance | |
Definition | EMA IG 5.5 |
Short | Substance code from EMA SMS |
Control | 1..1 This element is affected by the following invariants: ing-1 |
Type | BackboneElement |
Is Modifier | false |
Must Support | false |
Summary | true |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) |
70. Ingredient.substance.id | |
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Short | Unique id for inter-element referencing |
Control | 0..1 This element is affected by the following invariants: ele-1 |
Type | string |
Is Modifier | false |
XML Format | In the XML format, this property is represented as an attribute. |
Summary | false |
72. Ingredient.substance.extension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
Short | Additional content defined by implementations |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Control | 0..* |
Type | Extension |
Is Modifier | false |
Summary | false |
Alternate Names | extensions, user content |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) )ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists() ) |
74. Ingredient.substance.modifierExtension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). |
Short | Extensions that cannot be ignored even if unrecognized |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Control | 0..* |
Type | Extension |
Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them |
Summary | true |
Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. |
Alternate Names | extensions, user content, modifiers |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) )ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists() ) |
76. Ingredient.substance.code | |
Definition | A code or full resource that represents the ingredient's substance. |
Short | A code or full resource that represents the ingredient substance |
Control | 1..1 This element is affected by the following invariants: ing-1 |
Binding | The codes SHALL be taken from EMA SPOR SMS Substances (required to http://unicom-project.eu/fhir/ValueSet/substances-vs ) |
Type | CodeableReference(SubstanceDefinition) |
Is Modifier | false |
Must Support | false |
Summary | true |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) |
78. Ingredient.substance.strength | |
Definition | EMA IG 5.5.2 |
Short | The quantity of substance, per presentation, or per volume or mass, and type of quantity |
Control | 0..* |
Type | BackboneElement |
Is Modifier | false |
Must Support | false |
Summary | true |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) |
80. Ingredient.substance.strength.id | |
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Short | Unique id for inter-element referencing |
Control | 0..1 This element is affected by the following invariants: ele-1 |
Type | string |
Is Modifier | false |
XML Format | In the XML format, this property is represented as an attribute. |
Summary | false |
82. Ingredient.substance.strength.extension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
Short | Additional content defined by implementations |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Control | 0..* |
Type | Extension |
Is Modifier | false |
Summary | false |
Alternate Names | extensions, user content |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) )ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists() ) |
84. Ingredient.substance.strength.modifierExtension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). |
Short | Extensions that cannot be ignored even if unrecognized |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Control | 0..* |
Type | Extension |
Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them |
Summary | true |
Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. |
Alternate Names | extensions, user content, modifiers |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) )ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists() ) |
86. Ingredient.substance.strength.presentation[x] | |
Definition | The quantity of substance in the unit of presentation, or in the volume (or mass) of the single pharmaceutical product or manufactured item. Unit of presentation refers to the quantity that the item occurs in e.g. a strength per tablet size, perhaps 'per 20mg' (the size of the tablet). It is not generally normalized as a unitary unit, which would be 'per mg'). |
Short | The quantity of substance in the unit of presentation |
Control | 0..1 |
Type | Choice of: Ratio, RatioRange, CodeableConcept, Quantity |
[x] Note | SeeChoice of Data Typesfor further information about how to use [x] |
Is Modifier | false |
Must Support | false |
Summary | true |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) |
Slicing | This element introduces a set of slices on Ingredient.substance.strength.presentation[x] . The slices areUnordered and Open, and can be differentiated using the following discriminators: |
88. Ingredient.substance.strength.presentation[x]:presentationRatio | |
Slice Name | presentationRatio |
Definition | EMA IG 5.5.2 |
Short | Strength per unit of presentation (10mg/vial or 10mg/0.5ml where 0.5ml is the size of the vial) |
Control | 0..1 |
Type | Ratio |
[x] Note | SeeChoice of Data Typesfor further information about how to use [x] |
Is Modifier | false |
Must Support | false |
Summary | true |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) |
90. Ingredient.substance.strength.presentation[x]:presentationRatio.id | |
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Short | Unique id for inter-element referencing |
Control | 0..1 This element is affected by the following invariants: ele-1 |
Type | id |
Is Modifier | false |
XML Format | In the XML format, this property is represented as an attribute. |
Summary | false |
92. Ingredient.substance.strength.presentation[x]:presentationRatio.extension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
Short | Additional content defined by implementations |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Control | 0..* |
Type | Extension |
Is Modifier | false |
Summary | false |
Alternate Names | extensions, user content |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) )ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists() ) |
Slicing | This element introduces a set of slices on Ingredient.substance.strength.presentation[x].extension . The slices areUnordered and Open, and can be differentiated using the following discriminators: |
94. Ingredient.substance.strength.presentation[x]:presentationRatio.numerator | |
Definition | The value of the numerator. |
Short | Numerator value |
Control | 0..1 This element is affected by the following invariants: rat-1 |
Binding | The codes SHALL be taken from EMA SPOR Unit of Measurement (required to http://unicom-project.eu/fhir/ValueSet/unit-of-measurement-vs ) |
Type | Quantity |
Is Modifier | false |
Summary | true |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) |
96. Ingredient.substance.strength.presentation[x]:presentationRatio.denominator | |
Definition | The value of the denominator. |
Short | Unit of measurement or unit of presentation |
Control | 1..1 This element is affected by the following invariants: rat-1 |
Binding | The codes SHALL be taken from EMA SPOR All Units Combined (required to http://unicom-project.eu/fhir/ValueSet/all-units-vs ) |
Type | Quantity(SimpleQuantity) |
Is Modifier | false |
Summary | true |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) |
98. Ingredient.substance.strength.textPresentation | |
Definition | A textual represention of either the whole of the presentation strength or a part of it - with the rest being in Strength.presentation as a ratio. |
Short | Text of either the whole presentation strength or a part of it (rest being in Strength.presentation as a ratio) |
Control | 0..1 |
Type | string |
Is Modifier | false |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Must Support | false |
Summary | true |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) |
100. Ingredient.substance.strength.concentration[x] | |
Definition | The strength per unitary volume (or mass). |
Short | The strength per unitary volume (or mass) |
Control | 0..1 |
Type | Choice of: Ratio, RatioRange, CodeableConcept, Quantity |
[x] Note | SeeChoice of Data Typesfor further information about how to use [x] |
Is Modifier | false |
Must Support | false |
Summary | true |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) |
Slicing | This element introduces a set of slices on Ingredient.substance.strength.concentration[x] . The slices areUnordered and Open, and can be differentiated using the following discriminators: |
102. Ingredient.substance.strength.concentration[x]:concentrationRatio | |
Slice Name | concentrationRatio |
Definition | EMA IG 5.5.2 |
Short | Strength per unit of measurement (20mg/1ml) |
Control | 0..1 |
Type | Ratio |
[x] Note | SeeChoice of Data Typesfor further information about how to use [x] |
Is Modifier | false |
Must Support | false |
Summary | true |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) |
104. Ingredient.substance.strength.concentration[x]:concentrationRatio.id | |
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Short | Unique id for inter-element referencing |
Control | 0..1 This element is affected by the following invariants: ele-1 |
Type | id |
Is Modifier | false |
XML Format | In the XML format, this property is represented as an attribute. |
Summary | false |
106. Ingredient.substance.strength.concentration[x]:concentrationRatio.extension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
Short | Additional content defined by implementations |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Control | 0..* |
Type | Extension |
Is Modifier | false |
Summary | false |
Alternate Names | extensions, user content |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) )ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists() ) |
Slicing | This element introduces a set of slices on Ingredient.substance.strength.concentration[x].extension . The slices areUnordered and Open, and can be differentiated using the following discriminators: |
108. Ingredient.substance.strength.concentration[x]:concentrationRatio.numerator | |
Definition | The value of the numerator. |
Short | Numerator value |
Control | 0..1 This element is affected by the following invariants: rat-1 |
Binding | The codes SHALL be taken from EMA SPOR Unit of Measurement (required to http://unicom-project.eu/fhir/ValueSet/unit-of-measurement-vs ) |
Type | Quantity |
Is Modifier | false |
Summary | true |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) |
110. Ingredient.substance.strength.concentration[x]:concentrationRatio.denominator | |
Definition | The value of the denominator. |
Short | Denominator value |
Control | 1..1 This element is affected by the following invariants: rat-1 |
Binding | The codes SHALL be taken from EMA SPOR Unit of Measurement (required to http://unicom-project.eu/fhir/ValueSet/unit-of-measurement-vs ) |
Type | Quantity(SimpleQuantity) |
Is Modifier | false |
Summary | true |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) |
112. Ingredient.substance.strength.textConcentration | |
Definition | A textual represention of either the whole of the concentration strength or a part of it - with the rest being in Strength.concentration as a ratio. |
Short | Text of either the whole concentration strength or a part of it (rest being in Strength.concentration as a ratio) |
Control | 0..1 |
Type | string |
Is Modifier | false |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Must Support | false |
Summary | true |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) |
114. Ingredient.substance.strength.basis | |
Definition | 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). |
Short | 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) |
Control | 0..1 |
Type | CodeableConcept |
Is Modifier | false |
Must Support | false |
Summary | true |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) |
116. Ingredient.substance.strength.measurementPoint | |
Definition | For when strength is measured at a particular point or distance. There are products where strength is measured at a particular point. For example, the strength of the ingredient in some inhalers is measured at a particular position relative to the point of aerosolization. |
Short | When strength is measured at a particular point or distance |
Control | 0..1 |
Type | string |
Is Modifier | false |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Must Support | false |
Summary | true |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) |
118. Ingredient.substance.strength.country | |
Definition | The country or countries for which the strength range applies. |
Short | Where the strength range applies |
Control | 0..* |
Binding | For example codes, see CountryValueSet (example to http://hl7.org/fhir/ValueSet/country )Jurisdiction codes |
Type | CodeableConcept |
Is Modifier | false |
Must Support | false |
Summary | true |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) |
120. Ingredient.substance.strength.referenceStrength | |
Definition | EMA IG 5.5.3. According to EMA, this is a mandatory element for all products, which is not necessarily accepted by all NCAs, and it is ambivalent in ISO IDMP. |
Short | Strenth expressed in terms of a reference substance; reference strength type not distinguished. According to EMA IG, all products need to have reference strentgh (repeating the strentgh, if needed) |
Control | 0..* |
Type | BackboneElement |
Is Modifier | false |
Must Support | false |
Summary | true |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) |
122. Ingredient.substance.strength.referenceStrength.id | |
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Short | Unique id for inter-element referencing |
Control | 0..1 This element is affected by the following invariants: ele-1 |
Type | string |
Is Modifier | false |
XML Format | In the XML format, this property is represented as an attribute. |
Summary | false |
124. Ingredient.substance.strength.referenceStrength.extension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
Short | Additional content defined by implementations |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Control | 0..* |
Type | Extension |
Is Modifier | false |
Summary | false |
Alternate Names | extensions, user content |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) )ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists() ) |
126. Ingredient.substance.strength.referenceStrength.modifierExtension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). |
Short | Extensions that cannot be ignored even if unrecognized |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Control | 0..* |
Type | Extension |
Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them |
Summary | true |
Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. |
Alternate Names | extensions, user content, modifiers |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) )ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists() ) |
128. Ingredient.substance.strength.referenceStrength.substance | |
Definition | Relevant reference substance. |
Short | Substance code from EMA SMS |
Control | 1..1 |
Binding | The codes SHALL be taken from EMA SPOR SMS Substances (required to http://unicom-project.eu/fhir/ValueSet/substances-vs ) |
Type | CodeableReference(SubstanceDefinition) |
Is Modifier | false |
Must Support | false |
Summary | true |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) |
130. Ingredient.substance.strength.referenceStrength.strength[x] | |
Definition | Strength expressed in terms of a reference substance. |
Short | Strength expressed in terms of a reference substance |
Control | 1..1 |
Type | Choice of: Ratio, RatioRange, Quantity |
[x] Note | SeeChoice of Data Typesfor further information about how to use [x] |
Is Modifier | false |
Must Support | false |
Summary | true |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) |
Slicing | This element introduces a set of slices on Ingredient.substance.strength.referenceStrength.strength[x] . The slices areUnordered and Open, and can be differentiated using the following discriminators: |
132. Ingredient.substance.strength.referenceStrength.strength[x]:strengthRatio | |
Slice Name | strengthRatio |
Definition | Strength expressed in terms of a reference substance. |
Short | Strength expressed in terms of a reference substance |
Control | 0..1 |
Type | Ratio |
[x] Note | SeeChoice of Data Typesfor further information about how to use [x] |
Is Modifier | false |
Must Support | false |
Summary | true |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) |
134. Ingredient.substance.strength.referenceStrength.strength[x]:strengthRatio.id | |
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Short | Unique id for inter-element referencing |
Control | 0..1 This element is affected by the following invariants: ele-1 |
Type | id |
Is Modifier | false |
XML Format | In the XML format, this property is represented as an attribute. |
Summary | false |
136. Ingredient.substance.strength.referenceStrength.strength[x]:strengthRatio.extension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
Short | Additional content defined by implementations |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Control | 0..* |
Type | Extension |
Is Modifier | false |
Summary | false |
Alternate Names | extensions, user content |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) )ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists() ) |
Slicing | This element introduces a set of slices on Ingredient.substance.strength.referenceStrength.strength[x].extension . The slices areUnordered and Open, and can be differentiated using the following discriminators: |
138. Ingredient.substance.strength.referenceStrength.strength[x]:strengthRatio.numerator | |
Definition | The value of the numerator. |
Short | Numerator value |
Control | 1..1 This element is affected by the following invariants: rat-1 |
Binding | The codes SHALL be taken from EMA SPOR Unit of Measurement (required to http://unicom-project.eu/fhir/ValueSet/unit-of-measurement-vs ) |
Type | Quantity |
Is Modifier | false |
Summary | true |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) |
140. Ingredient.substance.strength.referenceStrength.strength[x]:strengthRatio.denominator | |
Definition | The value of the denominator. |
Short | Unit of measurement or unit of presentation |
Control | 1..1 This element is affected by the following invariants: rat-1 |
Binding | The codes SHALL be taken from EMA SPOR All Units Combined (required to http://unicom-project.eu/fhir/ValueSet/all-units-vs ) |
Type | Quantity(SimpleQuantity) |
Is Modifier | false |
Summary | true |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) |
142. Ingredient.substance.strength.referenceStrength.measurementPoint | |
Definition | For when strength is measured at a particular point or distance. |
Short | When strength is measured at a particular point or distance |
Control | 0..1 |
Type | string |
Is Modifier | false |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Must Support | false |
Summary | true |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) |
144. Ingredient.substance.strength.referenceStrength.country | |
Definition | The country or countries for which the strength range applies. |
Short | Where the strength range applies |
Control | 0..* |
Binding | For example codes, see CountryValueSet (example to http://hl7.org/fhir/ValueSet/country )Jurisdiction codes |
Type | CodeableConcept |
Is Modifier | false |
Must Support | false |
Summary | true |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) |