HdBe-PharmaceuticalProduct
CBB | Description | Status |
---|---|---|
HdBe-PharmaceuticalProduct | The prescribed substance is usually medication. However, medical aids and bandages can also be prescribed and supplied via the pharmacy. Food and blood products do not strictly belong in the medication category, but can be prescribed and supplied by a pharmacy as well. A type of medication can be indicated with a single code. Entering multiple ingredients will enable you to display a compound product. If one of the composite parts is liquid, the dosage will be given in milliliters; otherwise it will be given in ‘units’. In that case, the composition of the medication can be specified implicitly (with the use of a medication code) or explicitly, for example by listing the (active) ingredient(s) of the medication. Magistral prescriptions can be entered as well. This can be done by means of the option listed above to enter coded ingredients and/or by entering the composition and preparation method as free text. This is a partial information model PurposeThe purpose of Product is to unambiguously describe the medication to be used. | active |
PharmaceuticalProduct | PharmaceuticalProduct | ||
id | 0..1 | string | |
extension | I | 0..* | Extension |
MedicationCode | 0..1 | CodeableConceptBinding | |
ProductSpecifications | 0..1 | BackboneElement | |
id | 0..1 | string | |
extension | I | 0..* | Extension |
modifierExtension | Σ ?! I | 0..* | Extension |
PharmaceuticalForm | 0..1 | CodeableConceptBinding | |
Medication | 0..1 | string | |
Description | 0..1 | string | |
Ingredient | 0..* | BackboneElement | |
id | 0..1 | string | |
extension | I | 0..* | Extension |
modifierExtension | Σ ?! I | 0..* | Extension |
SubstanceCode | 0..1 | CodeableConceptBinding | |
Concentration | 0..1 | BackboneElement | |
id | 0..1 | string | |
extension | I | 0..* | Extension |
modifierExtension | Σ ?! I | 0..* | Extension |
IngredientAmount | I | 0..1 | Quantity |
ProductAmount | I | 0..1 | Quantity |
PharmaceuticalProduct | 0..* | |
PharmaceuticalProduct.MedicationCode | CodeableConcept | 0..1 |
PharmaceuticalProduct.ProductSpecifications | BackboneElement | 0..1 |
PharmaceuticalProduct.ProductSpecifications.PharmaceuticalForm | CodeableConcept | 0..1 |
PharmaceuticalProduct.ProductSpecifications.Medication | string | 0..1 |
PharmaceuticalProduct.ProductSpecifications.Description | string | 0..1 |
PharmaceuticalProduct.ProductSpecifications.Ingredient | BackboneElement | 0..* |
PharmaceuticalProduct.ProductSpecifications.Ingredient.SubstanceCode | CodeableConcept | 0..1 |
PharmaceuticalProduct.ProductSpecifications.Ingredient.Concentration | BackboneElement | 0..1 |
PharmaceuticalProduct.ProductSpecifications.Ingredient.Concentration.IngredientAmount | Quantity | 0..1 |
PharmaceuticalProduct.ProductSpecifications.Ingredient.Concentration.ProductAmount | Quantity | 0..1 |
PharmaceuticalProduct | |
Definition | Root concept of the PharmaceuticalProduct partial information model.This root concept contains all data elements of the PharmaceuticalProduct partial information model. The prescribed product is usually a medicine. However, medical aids and bandages can also be prescribed and supplied via the pharmacy. Strictly speaking, food and blood products do not belong in the medication category, but can be prescribed and supplied by a pharmacy as well. |
Cardinality | 0...* |
Invariants |
|
Mappings |
|
PharmaceuticalProduct.id | |
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Cardinality | 0...1 |
Type | string |
Mappings |
|
PharmaceuticalProduct.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 manageable, 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. |
Cardinality | 0...* |
Type | Extension |
Alias | extensions, user content |
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. |
Slicing | Unordered, Open, by url(Value) |
Invariants |
|
Mappings |
|
PharmaceuticalProduct.MedicationCode | |
Definition | Code of the Medication. |
Cardinality | 0...1 |
Type | CodeableConcept |
Binding | ProductCode (extensible) |
Comments | Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination. |
Invariants |
|
Mappings |
|
PharmaceuticalProduct.ProductSpecifications | |
Definition | Container of the ProductSpecifications concept. This container contains all data elements of the ProductSpecifications concept. Product specifications are required if the product code is not sufficient to ascertain the active substances and strength. |
Cardinality | 0...1 |
Type | BackboneElement |
Invariants |
|
Mappings |
|
PharmaceuticalProduct.ProductSpecifications.id | |
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Cardinality | 0...1 |
Type | string |
Mappings |
|
PharmaceuticalProduct.ProductSpecifications.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 manageable, 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. |
Cardinality | 0...* |
Type | Extension |
Alias | extensions, user content |
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. |
Slicing | Unordered, Open, by url(Value) |
Invariants |
|
Mappings |
|
PharmaceuticalProduct.ProductSpecifications.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 manageable, 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). |
Cardinality | 0...* |
Type | Extension |
Modifier | True |
Summary | True |
Alias | extensions, user content, modifiers |
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. |
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. |
Invariants |
|
Mappings |
|
PharmaceuticalProduct.ProductSpecifications.PharmaceuticalForm | |
Definition | The pharmaceutical form indicates the form of the medication. Examples include: tablet, suppository, infusion liquid, ointment. |
Cardinality | 0...1 |
Type | CodeableConcept |
Binding | PharmaceuticalForm codes |
Comments | Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination. |
Invariants |
|
Mappings |
|
PharmaceuticalProduct.ProductSpecifications.Medication | |
Definition | There is no code for medication entered in free text. In these cases, enter the complete description. |
Cardinality | 0...1 |
Type | string |
Comments | Note that FHIR strings SHALL NOT exceed 1MB in size |
Invariants |
|
Mappings |
|
PharmaceuticalProduct.ProductSpecifications.Description | |
Definition | A textual description of the type of medication (including relevant properties of the composition and preparation method if possible). |
Cardinality | 0...1 |
Type | string |
Comments | Note that FHIR strings SHALL NOT exceed 1MB in size |
Invariants |
|
Mappings |
|
PharmaceuticalProduct.ProductSpecifications.Ingredient | |
Definition | Container of the Ingredient concept. This container contains all data elements of the Ingredient concept. A product contains one or more active substances and excipients. These are usually determined by the product code. For medication prepared or compounded by the local pharmacy, each ingredient must be entered separately. The active substances play an important role, as they: a) determine the pharmacotherapeutic effect of the medication and b) serve as the basis for the indication of the strength of the medication (e.g. 200mg). |
Cardinality | 0...* |
Type | BackboneElement |
Invariants |
|
Mappings |
|
PharmaceuticalProduct.ProductSpecifications.Ingredient.id | |
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Cardinality | 0...1 |
Type | string |
Mappings |
|
PharmaceuticalProduct.ProductSpecifications.Ingredient.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 manageable, 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. |
Cardinality | 0...* |
Type | Extension |
Alias | extensions, user content |
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. |
Slicing | Unordered, Open, by url(Value) |
Invariants |
|
Mappings |
|
PharmaceuticalProduct.ProductSpecifications.Ingredient.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 manageable, 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). |
Cardinality | 0...* |
Type | Extension |
Modifier | True |
Summary | True |
Alias | extensions, user content, modifiers |
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. |
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. |
Invariants |
|
Mappings |
|
PharmaceuticalProduct.ProductSpecifications.Ingredient.SubstanceCode | |
Definition | Active substance or excipient. |
Cardinality | 0...1 |
Type | CodeableConcept |
Binding | SubstanceCode (extensible) |
Comments | Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination. |
Invariants |
|
Mappings |
|
PharmaceuticalProduct.ProductSpecifications.Ingredient.Concentration | |
Definition | The relative amount of this ingredient in this product. Calculation of Concentration = Ingredient Amount ÷ Product Amount. This could be a concentration if the medication is dissolved in liquid, for example. |
Cardinality | 0...1 |
Type | BackboneElement |
Invariants |
|
Mappings |
|
PharmaceuticalProduct.ProductSpecifications.Ingredient.Concentration.id | |
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Cardinality | 0...1 |
Type | string |
Mappings |
|
PharmaceuticalProduct.ProductSpecifications.Ingredient.Concentration.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 manageable, 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. |
Cardinality | 0...* |
Type | Extension |
Alias | extensions, user content |
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. |
Slicing | Unordered, Open, by url(Value) |
Invariants |
|
Mappings |
|
PharmaceuticalProduct.ProductSpecifications.Ingredient.Concentration.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 manageable, 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). |
Cardinality | 0...* |
Type | Extension |
Modifier | True |
Summary | True |
Alias | extensions, user content, modifiers |
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. |
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. |
Invariants |
|
Mappings |
|
PharmaceuticalProduct.ProductSpecifications.Ingredient.Concentration.IngredientAmount | |
Definition | The amount and unit of this ingredient. This is the numerator for the calculation of the concentration. |
Cardinality | 0...1 |
Type | Quantity |
Comments | The context of use may frequently define what kind of quantity this is and therefore what kind of units can be used. The context of use may also restrict the values for the comparator. |
Invariants |
|
Mappings |
|
PharmaceuticalProduct.ProductSpecifications.Ingredient.Concentration.ProductAmount | |
Definition | Amount of the product. This is the denominator for the calculation of the concentration. |
Cardinality | 0...1 |
Type | Quantity |
Comments | The context of use may frequently define what kind of quantity this is and therefore what kind of units can be used. The context of use may also restrict the values for the comparator. |
Invariants |
|
Mappings |
|
Example instances
PharmaceuticalProduct | |
---|---|
MedicationCode | 322236009 - Acetaminophen 500 mg oral tablet (code by SNOMED CT) |
ProductSpecifications | --- |
ProductSpecifications.PharmaceuticalForm | 385055001 - Tablet (code by SNOMED CT) |
ProductSpecifications.Medication | |
ProductSpecifications.Description | |
ProductSpecifications.Ingredient | --- |
ProductSpecifications.Ingredient.SubstanceCode | |
ProductSpecifications.Ingredient.Concentration | |
ProductSpecifications.Ingredient.Concentration.IngredientAmount | |
ProductSpecifications.Ingredient.Concentration.ProductAmount |
zib PharmaceuticalProduct-v2.1.2 difference
Concept | Category | Description |
---|---|---|
Concept | textual | Removed context on Dutch coding system specific codes from the Concept section in the StructureDefinition.Description . |
PharmaceuticalProduct (root) |
textual | Removed Dutch specific context. |
MedicationCode |
terminology | Removed all defined valueSets and replaced them with one ProductCode valueSet with the SNOMED descendent-of 763158003 (Medicinal product). Also set binding strength to extensible. |
MedicationCode |
textual | Removed G-standard specific context. |
ProductSpecification.PharmaceuticalForm |
terminology | Replaced values in PharmaceuticalForm valueSet them with the ProductCode valueSet with the SNOMED descendent-of 736478001 (Basic dose form) and loosened the binding from required to extensible. |
ProductSpecification.PharmaceuticalForm |
textual | Removed G-standard specific context. |
ProductSpecification.Description |
textual | Removed G-standard specific context. |
ProductSpecification.Ingredient.SubstanceCode |
textual | Removed context about removed ValueSets in medicationCode. |
ProductSpecification.Ingredient.SubstanceCode |
terminology | Replaced all defined valueSets and replaced them with the SubstanceCode valueSet with the SNOMED descendent-of 105590001 (Substance). Also set binding strength to extensible. |
ProductSpecification.Ingredient.Concentration.IngredientAmount |
textual | Removed G-standard specific context. |
ProductSpecification.Ingredient.Concentration.ProductAmount |
textual | Removed Dutch specific context. |
Terminology Bindings
Path | Name | Strength | URL |
---|---|---|---|
MedicationCode | ProductCode | extensible | https://fhir.healthdata.be/ValueSet/ProductCode |
ProductSpecifications.PharmaceuticalForm | PharmaceuticalForm | extensible | https://fhir.healthdata.be/ValueSet/PharmaceuticalForm |
ProductSpecifications.Ingredient.SubstanceCode | SubstanceCode | extensible | https://fhir.healthdata.be/ValueSet/SubstanceCode |