HdBe-MedicationDispense

Profile	Status	URL
HdBe-MedicationDispense	draft	https://fhir.healthdata.be/StructureDefinition/LogicalModel/HdBe-MedicationDispense

medication_dispense		medication_dispense	There are no (further) constraints on this element Element Id medication_dispense Short description MedicationDispense Definition Root concept of the MedicationDispense information model. This root concept contains all data elements of the MedicationDispense information model. Data Type medication_dispense
supplier	0..1	BackboneElement	There are no (further) constraints on this element Element Id medication_dispense.supplier Short description Supplier Definition In almost all cases, the supplier will be a pharmacist. It could also be supplied by a webshop (in case of an online order), a drug store or a foreign pharmacist. Data Type BackboneElement
healthcare_provider	1..1	Reference(HdBe HealthcareProvider)	There are no (further) constraints on this element Element Id medication_dispense.supplier.healthcare_provider Short description HealthcareProvider Definition Root concept of the Healthcare Provider information model. This root concept contains all data elements of the Healthcare Provider information model. Data Type Reference(HdBe HealthcareProvider)
dispense_request	0..1	Reference(HdBe DispenseRequest)	There are no (further) constraints on this element Element Id medication_dispense.dispense_request Short description DispenseRequest Definition Relationship to the dispense request. Data Type Reference(HdBe DispenseRequest)
dispensed_medicine	1..1	BackboneElement	There are no (further) constraints on this element Element Id medication_dispense.dispensed_medicine Short description DispensedMedicine Definition The dispensed medicine. Data Type BackboneElement
pharmaceutical_product	1..1	Reference(HdBe PharmaceuticalProduct)	There are no (further) constraints on this element Element Id medication_dispense.dispensed_medicine.pharmaceutical_product Short description 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. 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. Data Type Reference(HdBe PharmaceuticalProduct)
medication_dispense_date_time	0..1	dateTime	There are no (further) constraints on this element Element Id medication_dispense.medication_dispense_date_time Short description MedicationDispenseDateTime Definition The time at which the medicine was supplied. The date and time at which the medicine is delivered. Note: this is the time at which the medicine was delivered to the patient (or their administrator/representative) and not the request date. Data Type dateTime
request_date	0..1	dateTime	There are no (further) constraints on this element Element Id medication_dispense.request_date Short description RequestDate Definition The request date is the time at which a pharmacist records an intended dispense. Data Type dateTime
distribution_form	0..1	CodeableConceptBinding	There are no (further) constraints on this element Element Id medication_dispense.distribution_form Short description DistributionForm Definition Distribution form Data Type CodeableConcept Binding DistributionForm codes MedicatieverstrekkingDistributievorm (required)
duration_of_use	0..1	Quantity	There are no (further) constraints on this element Element Id medication_dispense.duration_of_use Short description DurationOfUse Definition The period in which the medication is expected to be used. The value depends on the dose and the dispensed amount. Data Type Quantity
medication_dispense_additional_information	0..*	CodeableConceptBinding	There are no (further) constraints on this element Element Id medication_dispense.medication_dispense_additional_information Short description MedicationDispenseAdditionalInformation Definition Additional information includes details on the structure of the medical dispense. This can be e.g. a reason for deviating from the dispense request. For now, this list is used. This list will be replaced by a thesaurus in the G standard at a later stage. Data Type CodeableConcept Binding MedicationDispenseAdditionalInformation codes MedicatieverstrekkingAanvullendeInformatie (required)
dispensed_amount	0..1	Quantity	There are no (further) constraints on this element Element Id medication_dispense.dispensed_amount Short description DispensedAmount Definition Number of units of the product (measured based on the relevant product code) supplied. Optionally a translation to NHG table Gebruiksvoorschriften(Table 25) is also allowed. Data Type Quantity
dispense_location	0..1	string	There are no (further) constraints on this element Element Id medication_dispense.dispense_location Short description DispenseLocation Definition Dispense location Data Type string
comment	0..1	string	There are no (further) constraints on this element Element Id medication_dispense.comment Short description Comment Definition Comments on the dispense. Data Type string

medication_dispense		0..*
medication_dispense.supplier	BackboneElement	0..1
medication_dispense.supplier.healthcare_provider	Reference(HdBe HealthcareProvider)	1..1
medication_dispense.dispense_request	Reference(HdBe DispenseRequest)	0..1
medication_dispense.dispensed_medicine	BackboneElement	1..1
medication_dispense.dispensed_medicine.pharmaceutical_product	Reference(HdBe PharmaceuticalProduct)	1..1
medication_dispense.medication_dispense_date_time	dateTime	0..1
medication_dispense.request_date	dateTime	0..1
medication_dispense.distribution_form	CodeableConcept	0..1
medication_dispense.duration_of_use	Quantity	0..1
medication_dispense.medication_dispense_additional_information	CodeableConcept	0..*
medication_dispense.dispensed_amount	Quantity	0..1
medication_dispense.dispense_location	string	0..1
medication_dispense.comment	string	0..1

medication_dispense
Definition	Root concept of the MedicationDispense information model. This root concept contains all data elements of the MedicationDispense information model.
Cardinality	0...*
Invariants	ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
Mappings	rim:n/a
medication_dispense.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	rim:n/a
medication_dispense.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	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
medication_dispense.supplier
Definition	In almost all cases, the supplier will be a pharmacist. It could also be supplied by a webshop (in case of an online order), a drug store or a foreign pharmacist.
Cardinality	0...1
Type	BackboneElement
Invariants	ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
Mappings	rim:n/a
medication_dispense.supplier.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	rim:n/a
medication_dispense.supplier.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	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
medication_dispense.supplier.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	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
medication_dispense.supplier.healthcare_provider
Definition	Root concept of the Healthcare Provider information model. This root concept contains all data elements of the Healthcare Provider information model.
Cardinality	1...1
Type	Reference(HdBe HealthcareProvider)
Comments	References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository.
Invariants	ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` ref-1:SHALL have a contained resource if a local reference is provided `reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids'))`
Mappings	rim:n/a rim:The target of a resource reference is a RIM entry point (Act, Role, or Entity)
medication_dispense.dispense_request
Definition	Relationship to the dispense request.
Cardinality	0...1
Type	Reference(HdBe DispenseRequest)
Comments	References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository.
Invariants	ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` ref-1:SHALL have a contained resource if a local reference is provided `reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids'))`
Mappings	rim:n/a rim:The target of a resource reference is a RIM entry point (Act, Role, or Entity)
medication_dispense.dispensed_medicine
Definition	The dispensed medicine.
Cardinality	1...1
Type	BackboneElement
Invariants	ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
Mappings	rim:n/a
medication_dispense.dispensed_medicine.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	rim:n/a
medication_dispense.dispensed_medicine.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	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
medication_dispense.dispensed_medicine.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	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
medication_dispense.dispensed_medicine.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	1...1
Type	Reference(HdBe PharmaceuticalProduct)
Comments	References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository.
Invariants	ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` ref-1:SHALL have a contained resource if a local reference is provided `reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids'))`
Mappings	rim:n/a rim:The target of a resource reference is a RIM entry point (Act, Role, or Entity)
medication_dispense.medication_dispense_date_time
Definition	The time at which the medicine was supplied. The date and time at which the medicine is delivered. Note: this is the time at which the medicine was delivered to the patient (or their administrator/representative) and not the request date.
Cardinality	0...1
Type	dateTime
Invariants	ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
Mappings	rim:n/a
medication_dispense.request_date
Definition	The request date is the time at which a pharmacist records an intended dispense.
Cardinality	0...1
Type	dateTime
Invariants	ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
Mappings	rim:n/a
medication_dispense.distribution_form
Definition	Distribution form
Cardinality	0...1
Type	CodeableConcept
Binding	DistributionForm codes MedicatieverstrekkingDistributievorm (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	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
medication_dispense.duration_of_use
Definition	The period in which the medication is expected to be used. The value depends on the dose and the dispensed amount.
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	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
medication_dispense.medication_dispense_additional_information
Definition	Additional information includes details on the structure of the medical dispense. This can be e.g. a reason for deviating from the dispense request. For now, this list is used. This list will be replaced by a thesaurus in the G standard at a later stage.
Cardinality	0...*
Type	CodeableConcept
Binding	MedicationDispenseAdditionalInformation codes MedicatieverstrekkingAanvullendeInformatie (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	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
medication_dispense.dispensed_amount
Definition	Number of units of the product (measured based on the relevant product code) supplied. 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	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
medication_dispense.dispense_location
Definition	Dispense location
Cardinality	0...1
Type	string
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
medication_dispense.comment
Definition	Comments on the dispense.
Cardinality	0...1
Type	string
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

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
distribution_form	MedicatieverstrekkingDistributievorm	required	https://fhir.healthdata.be/ValueSet/MedicatieverstrekkingDistributievorm
medication_dispense_additional_information	MedicatieverstrekkingAanvullendeInformatie	required	https://fhir.healthdata.be/ValueSet/MedicatieverstrekkingAanvullendeInformatie