Important: This is a draft IG for trial use. Click here to give feedback.

EN NL FR

HdBe-ProduitPharmaceutique

CBBConceptStatus
HdBe-PharmaceuticalProduct

La substance prescrite est habituellement un médicament. Cependant, des aides médicales et des bandages peuvent également être prescrits et livrés par la pharmacie. Les aliments et les produits sanguins ne relèvent pas strictement de la catégorie des médicaments, mais peuvent également être prescrits et livrés par une pharmacie.

Un type de médicament peut être indiqué par un code unique. La saisie d'ingrédients multiples vous permet d'afficher un produit composé. Si l'une des parties composites est liquide, le dosage en sera donné en millilitres ; sinon, il sera donné en ‘unités’.

Dans ce cas, la composition du médicament peut être spécifiée implicitement (en utilisant un code de médicament) ou explicitement, par exemple en énumérant le(s) ingrédient(s) (actif(s)) du médicament.

Des ordonnances magistrales peuvent également être saisies. Pour ce faire, utilisez l'option indiquée ci-dessus pour saisir les ingrédients codés et/ou saisissez la composition et la méthode de préparation sous forme de texte libre. Il s'agit d'un modèle d'information partiel

Purpose

L'objectif de Produit est de décrire sans ambiguïté le médicament à utiliser.

active

id0..1string
extensionI0..*Extension
MedicationCode0..1CodeableConceptBinding
id0..1string
extensionI0..*Extension
modifierExtensionΣ ?! I0..*Extension
PharmaceuticalForm0..1CodeableConceptBinding
Medication0..1string
Description0..1string
id0..1string
extensionI0..*Extension
modifierExtensionΣ ?! I0..*Extension
SubstanceCode0..1CodeableConceptBinding
id0..1string
extensionI0..*Extension
modifierExtensionΣ ?! I0..*Extension
IngredientAmountI0..1Quantity
ProductAmountI0..1Quantity

PharmaceuticalProduct0..*
PharmaceuticalProduct.MedicationCodeCodeableConcept0..1
PharmaceuticalProduct.ProductSpecificationsBackboneElement0..1
PharmaceuticalProduct.ProductSpecifications.PharmaceuticalFormCodeableConcept0..1
PharmaceuticalProduct.ProductSpecifications.Medicationstring0..1
PharmaceuticalProduct.ProductSpecifications.Descriptionstring0..1
PharmaceuticalProduct.ProductSpecifications.IngredientBackboneElement0..*
PharmaceuticalProduct.ProductSpecifications.Ingredient.SubstanceCodeCodeableConcept0..1
PharmaceuticalProduct.ProductSpecifications.Ingredient.ConcentrationBackboneElement0..1
PharmaceuticalProduct.ProductSpecifications.Ingredient.Concentration.IngredientAmountQuantity0..1
PharmaceuticalProduct.ProductSpecifications.Ingredient.Concentration.ProductAmountQuantity0..1


PharmaceuticalProduct
DefinitionRoot 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.
Cardinality0...*
Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
PharmaceuticalProduct.id
DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Cardinality0...1
Typestring
Mappings
  • rim: n/a
PharmaceuticalProduct.extension
DefinitionMay 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.
Cardinality0...*
TypeExtension
Aliasextensions, 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.

SlicingUnordered, Open, by url(Value)
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()
Mappings
  • rim: n/a
  • rim: N/A
PharmaceuticalProduct.MedicationCode
DefinitionCode of the Medication.
Cardinality0...1
TypeCodeableConcept
BindingProductCode (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
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • v2: CE/CNE/CWE
  • rim: CD
  • orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
PharmaceuticalProduct.ProductSpecifications
DefinitionContainer 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.
Cardinality0...1
TypeBackboneElement
Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
PharmaceuticalProduct.ProductSpecifications.id
DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Cardinality0...1
Typestring
Mappings
  • rim: n/a
PharmaceuticalProduct.ProductSpecifications.extension
DefinitionMay 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.
Cardinality0...*
TypeExtension
Aliasextensions, 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.

SlicingUnordered, Open, by url(Value)
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()
Mappings
  • rim: n/a
  • rim: N/A
PharmaceuticalProduct.ProductSpecifications.modifierExtension
DefinitionMay 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).
Cardinality0...*
TypeExtension
ModifierTrue
SummaryTrue
Aliasextensions, 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
  • 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()
Mappings
  • rim: n/a
  • rim: N/A
PharmaceuticalProduct.ProductSpecifications.PharmaceuticalForm
DefinitionThe pharmaceutical form indicates the form of the medication. Examples include: tablet, suppository, infusion liquid, ointment.
Cardinality0...1
TypeCodeableConcept
Binding

PharmaceuticalForm codes

PharmaceuticalForm (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
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • v2: CE/CNE/CWE
  • rim: CD
  • orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
PharmaceuticalProduct.ProductSpecifications.Medication
DefinitionThere is no code for medication entered in free text. In these cases, enter the complete description.
Cardinality0...1
Typestring
Comments

Note that FHIR strings SHALL NOT exceed 1MB in size

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
PharmaceuticalProduct.ProductSpecifications.Description
DefinitionA textual description of the type of medication (including relevant properties of the composition and preparation method if possible).
Cardinality0...1
Typestring
Comments

Note that FHIR strings SHALL NOT exceed 1MB in size

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
PharmaceuticalProduct.ProductSpecifications.Ingredient
DefinitionContainer 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).
Cardinality0...*
TypeBackboneElement
Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
PharmaceuticalProduct.ProductSpecifications.Ingredient.id
DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Cardinality0...1
Typestring
Mappings
  • rim: n/a
PharmaceuticalProduct.ProductSpecifications.Ingredient.extension
DefinitionMay 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.
Cardinality0...*
TypeExtension
Aliasextensions, 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.

SlicingUnordered, Open, by url(Value)
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()
Mappings
  • rim: n/a
  • rim: N/A
PharmaceuticalProduct.ProductSpecifications.Ingredient.modifierExtension
DefinitionMay 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).
Cardinality0...*
TypeExtension
ModifierTrue
SummaryTrue
Aliasextensions, 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
  • 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()
Mappings
  • rim: n/a
  • rim: N/A
PharmaceuticalProduct.ProductSpecifications.Ingredient.SubstanceCode
DefinitionActive substance or excipient.
Cardinality0...1
TypeCodeableConcept
BindingSubstanceCode (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
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • v2: CE/CNE/CWE
  • rim: CD
  • orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
PharmaceuticalProduct.ProductSpecifications.Ingredient.Concentration
DefinitionThe 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.
Cardinality0...1
TypeBackboneElement
Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
PharmaceuticalProduct.ProductSpecifications.Ingredient.Concentration.id
DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Cardinality0...1
Typestring
Mappings
  • rim: n/a
PharmaceuticalProduct.ProductSpecifications.Ingredient.Concentration.extension
DefinitionMay 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.
Cardinality0...*
TypeExtension
Aliasextensions, 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.

SlicingUnordered, Open, by url(Value)
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()
Mappings
  • rim: n/a
  • rim: N/A
PharmaceuticalProduct.ProductSpecifications.Ingredient.Concentration.modifierExtension
DefinitionMay 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).
Cardinality0...*
TypeExtension
ModifierTrue
SummaryTrue
Aliasextensions, 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
  • 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()
Mappings
  • rim: n/a
  • rim: N/A
PharmaceuticalProduct.ProductSpecifications.Ingredient.Concentration.IngredientAmount
DefinitionThe amount and unit of this ingredient. This is the numerator for the calculation of the concentration.
Cardinality0...1
TypeQuantity
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
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • qty-3: If a code for the unit is present, the system SHALL also be present
    code.empty() or system.exists()
Mappings
  • rim: n/a
  • v2: SN (see also Range) or CQ
  • rim: PQ, IVL<PQ>, MO, CO, depending on the values
PharmaceuticalProduct.ProductSpecifications.Ingredient.Concentration.ProductAmount
DefinitionAmount of the product. This is the denominator for the calculation of the concentration.
Cardinality0...1
TypeQuantity
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
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • qty-3: If a code for the unit is present, the system SHALL also be present
    code.empty() or system.exists()
Mappings
  • rim: n/a
  • v2: SN (see also Range) or CQ
  • rim: PQ, IVL<PQ>, MO, CO, depending on the values

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

PathNameStrengthURL
MedicationCodeProductCodeextensiblehttps://fhir.healthdata.be/ValueSet/ProductCode
ProductSpecifications.PharmaceuticalFormPharmaceuticalFormextensiblehttps://fhir.healthdata.be/ValueSet/PharmaceuticalForm
ProductSpecifications.Ingredient.SubstanceCodeSubstanceCodeextensiblehttps://fhir.healthdata.be/ValueSet/SubstanceCode