HdBe-PharmaceuticalProduct
Profile | Status | URL |
---|---|---|
HdBe-PharmaceuticalProduct | draft | https://fhir.healthdata.be/StructureDefinition/LogicalModel/HdBe-PharmaceuticalProduct |
pharmaceutical_product | pharmaceutical_product | ||
medication_code | 0..1 | CodeableConcept | |
product_specifications | 0..1 | BackboneElement | |
pharmaceutical_form | 0..1 | CodeableConceptBinding | |
medication | 0..1 | string | |
description | 0..1 | string | |
ingredient | 0..* | BackboneElement | |
substance_code | 0..1 | CodeableConcept | |
concentration | 0..1 | BackboneElement | |
ingredient_amount | 0..1 | Quantity | |
product_amount | 0..1 | Quantity |
pharmaceutical_product | 0..* | |
pharmaceutical_product.medication_code | CodeableConcept | 0..1 |
pharmaceutical_product.product_specifications | BackboneElement | 0..1 |
pharmaceutical_product.product_specifications.pharmaceutical_form | CodeableConcept | 0..1 |
pharmaceutical_product.product_specifications.medication | string | 0..1 |
pharmaceutical_product.product_specifications.description | string | 0..1 |
pharmaceutical_product.product_specifications.ingredient | BackboneElement | 0..* |
pharmaceutical_product.product_specifications.ingredient.substance_code | CodeableConcept | 0..1 |
pharmaceutical_product.product_specifications.ingredient.concentration | BackboneElement | 0..1 |
pharmaceutical_product.product_specifications.ingredient.concentration.ingredient_amount | Quantity | 0..1 |
pharmaceutical_product.product_specifications.ingredient.concentration.product_amount | Quantity | 0..1 |
pharmaceutical_product | |
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. A type of medication can be indicated with **a single code**. That code can be chosen from several possible coding systems (concretely: GPK, PRK, HPK or article numbers). Correct use of these codes in the software systems will sufficiently record the composition of the product used, making a complete product specification unnecessary. In addition to a primary code, **alternative codes **from other coding systems can also be entered (so that the GPK can be sent along in the event that the patient was registered based on PRK, for example). Entering multiple ingredients will enable you to display a compound product. 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) substance(s) of the medication. **Prescriptions to be prepared by the pharmacy** 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. |
Cardinality | 0...* |
Invariants |
|
Mappings |
|
pharmaceutical_product.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 | System.String |
Mappings |
|
pharmaceutical_product.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 |
|
pharmaceutical_product.medication_code | |
Definition | Coding medication in the Netherlands is done on the basis of the G standard (issued by Z-index), which is filled under the direction of KNMP. The coded medication can be expressed as: * GTIN International Article Number * ZI-nummer (2.16.840.1.113883.2.4.4.8) * Trade product code (HPK) * Prescription code (PRK) * Generic product code (GPK) * Anatomic Therapeutic Classification code (ATC) * Substance Name Code (SNK) * Substance Name Code, in combination with Route of Administration (SSK) * SNOMED CT code The GTIN enables identification of the product including its origin with a barcode. The ZI number represents the tradeproduct and the package size. The HPK is the code for the trade product (with the brand name) as used per dose/per time the medication is taken (1 pill, 1 puff, 1ml) The PRK contains als GPK information supplemented with information needed to prescribe the right product. this level is intended to facilitate generic prescription of drugs. The GPK defines the pharmaceutical characteristics of a product: ingredients, strengths, units, pharmaceutical form and route of administration. The Substance Name Code (SNK) is the (active) compound. Further information about the G-Standaard levels see https://www.z-index.nl So called 90.000.000 numbers are used in local IT systems. These numbers shall not be used for external communication. In the this is necessary only the description (not the code) may be included. This is in accordance with national agreements (Nictiz Standard). |
Cardinality | 0...1 |
Type | CodeableConcept |
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 |
|
pharmaceutical_product.product_specifications | |
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 |
|
pharmaceutical_product.product_specifications.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 | System.String |
Mappings |
|
pharmaceutical_product.product_specifications.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 |
|
pharmaceutical_product.product_specifications.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 |
|
pharmaceutical_product.product_specifications.pharmaceutical_form | |
Definition | The pharmaceutical form indicates the form of the medication. Examples include: tablet, suppository, infusion liquid, ointment. If the product has a GPK code in the G standard, the form will be known in the G standard. For products without a code (free text, preparation by the pharmacy), the means of administration can be entered. |
Cardinality | 0...1 |
Type | CodeableConcept |
Binding | PharmaceuticalForm codes FarmaceutischeVorm (required) |
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 |
|
pharmaceutical_product.product_specifications.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 |
|
pharmaceutical_product.product_specifications.description | |
Definition | A textual description of the type of medication (including relevant properties of the composition and preparation method if possible), which is only used if no coded indication from the G Standard is available (magistral preparation). |
Cardinality | 0...1 |
Type | string |
Comments | Note that FHIR strings SHALL NOT exceed 1MB in size |
Invariants |
|
Mappings |
|
pharmaceutical_product.product_specifications.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 |
|
pharmaceutical_product.product_specifications.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 | System.String |
Mappings |
|
pharmaceutical_product.product_specifications.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 |
|
pharmaceutical_product.product_specifications.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 |
|
pharmaceutical_product.product_specifications.ingredient.substance_code | |
Definition | Active substance or excipient. Here, the same codes can be used as for the ProductCode (for dilutions and compounds in particular), but now, the ATC, SSK and SNK codes can also be used to indicate a substance (to list ingredients of local products prepared by the pharmacy). * GTIN International Article Number * KNMP article number * Trade product code (HPK) * Prescription code (PRK) * Generic product code (GPK) * ATC (anatomic therapeutic classification) * SSK (substance name code with route of administration) * SNK (substance name code) For further explanation about ATC see https://www.whocc.no/atc/structure_and_principles/ |
Cardinality | 0...1 |
Type | CodeableConcept |
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 |
|
pharmaceutical_product.product_specifications.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 |
|
pharmaceutical_product.product_specifications.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 | System.String |
Mappings |
|
pharmaceutical_product.product_specifications.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 |
|
pharmaceutical_product.product_specifications.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 |
|
pharmaceutical_product.product_specifications.ingredient.concentration.ingredient_amount | |
Definition | The amount and unit of this ingredient. This is the numerator for the calculation of the concentration. The unit should be selected from the G-Standard (Table 902). |
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 |
|
pharmaceutical_product.product_specifications.ingredient.concentration.product_amount | |
Definition | Amount of the product. This is the denominator for the calculation of the concentration. Optionally a translation to NHG table Gebruiksvoorschriften(Table 25) is also allowed. |
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
[CBB name] | |
---|---|
[Concept name ] | [example value] |
// example of NameInformation
## Example instances
| name_information | |
|----------------------|-------------------|
| first_names | Johanna Petronella Maria
| initials | J.P.M.
| given_name | Jo
| name_usage | Geslachtsnaam partner gevolgd door eigen geslachtsnaam
| last_name.prefix | van
| last_name.last_name | Putten
| last_name_partner.partner_prefix | van der
| last_name_partner.partner_last_name | Giessen
| titles |
zib [zib name + version](https://zibs.nl/wiki/[zib name + version(release)]) difference
Concept | Category | Description |
---|---|---|
[element.path] |
[category of change] | [Description of change]([Reference to ticket/issue/zulip chat using MarkDown link]) |
Terminology Bindings
Path | Name | Strength | URL |
---|---|---|---|
product_specifications.pharmaceutical_form | FarmaceutischeVorm | required | https://fhir.healthdata.be/ValueSet/FarmaceutischeVorm |