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

HdBe-Medicatieverstrekking

WARNING This page contains a draft CBB, as raw output from the zib export and automatic conversion to CBB. It requires thorough review and adaption to the Belgian realm. This CBB is merely added for informative use.

CBB	Concept	Status
HdBe-MedicationDispense	Een verstrekking is de terhandstelling van een hoeveelheid van een geneesmiddel aan de patiënt, zijn toediener of zijn vertegenwoordiger. Purpose Het doel van de verstrekking is inzicht te geven in welke producten ter hand gesteld zijn door de apotheker aan de patiënt (of zijn vertegenwoordiger).	draft

CBB

Concept

Status

HdBe-MedicationDispense

Een verstrekking is de terhandstelling van een hoeveelheid van een geneesmiddel aan de patiënt, zijn toediener of zijn vertegenwoordiger.

Purpose

Het doel van de verstrekking is inzicht te geven in welke producten ter hand gesteld zijn door de apotheker aan de patiënt (of zijn vertegenwoordiger).

draft

MedicationDispense			MedicationDispense	Element id MedicationDispense 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 MedicationDispense Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim: n/a
id		0..1	string	There are no (further) constraints on this element Element id MedicationDispense.id Short description Unique id for inter-element referencing Definition Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. Data type string Mappings rim: n/a
extension	I	0..*	Extension	There are no (further) constraints on this element Element id MedicationDispense.extension Short description Additional content defined by implementations Alternate names extensions, user content 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. 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. Data type Extension Sliced: Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints 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
Supplier	I	0..1	Reference(HdBe-HealthcareOrganization)	Element id MedicationDispense.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. 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. Data type Reference(HdBe-HealthcareOrganization) Constraints 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)
DispenseRequest	I	0..1	Reference(HdBe-DispenseRequest)	Element id MedicationDispense.DispenseRequest Short description DispenseRequest Definition Relationship to the dispense request. 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. Data type Reference(HdBe-DispenseRequest) Constraints 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)
DispensedMedicine	I	1..1	Reference(HdBe-PharmaceuticalProduct)	Element id MedicationDispense.DispensedMedicine Short description DispensedMedicine Definition The dispensed medicine. 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. Data type Reference(HdBe-PharmaceuticalProduct) Constraints 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)
MedicationDispenseDateTime		0..1	dateTime	Element id MedicationDispense.MedicationDispenseDateTime 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 Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim: n/a
RequestDate		0..1	dateTime	Element id MedicationDispense.RequestDate Short description RequestDate Definition The request date is the time at which a pharmacist records an intended dispense. Data type dateTime Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim: n/a
DistributionForm		0..1	CodeableConceptBinding	Element id MedicationDispense.DistributionForm Short description DistributionForm Definition Distribution form 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. Data type CodeableConcept Binding DistributionForm codes DistributionForm (required) Constraints 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
DurationOfUse	I	0..1	Quantity	Element id MedicationDispense.DurationOfUse 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. 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. Data type Quantity Constraints 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
MedicationDispenseAdditionalInformation		0..*	CodeableConceptBinding	Element id MedicationDispense.MedicationDispenseAdditionalInformation 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. 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. Data type CodeableConcept Binding MedicationDispenseAdditionalInformation codes MedicationDispenseAdditionalInformation (required) Constraints 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
DispensedAmount	I	0..1	Quantity	Element id MedicationDispense.DispensedAmount 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. 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. Data type Quantity Constraints 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
DispenseLocation		0..1	string	Element id MedicationDispense.DispenseLocation Short description DispenseLocation Definition Dispense location Comments Note that FHIR strings SHALL NOT exceed 1MB in size Data type string Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim: n/a
Comment		0..1	string	Element id MedicationDispense.Comment Short description Comment Definition Comments on the dispense. Comments Note that FHIR strings SHALL NOT exceed 1MB in size Data type string Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim: n/a

MedicationDispense		0..*
MedicationDispense.Supplier	Reference(HdBe-HealthcareOrganization)	0..1
MedicationDispense.DispenseRequest	Reference(HdBe-DispenseRequest)	0..1
MedicationDispense.DispensedMedicine	Reference(HdBe-PharmaceuticalProduct)	1..1
MedicationDispense.MedicationDispenseDateTime	dateTime	0..1
MedicationDispense.RequestDate	dateTime	0..1
MedicationDispense.DistributionForm	CodeableConcept	0..1
MedicationDispense.DurationOfUse	Quantity	0..1
MedicationDispense.MedicationDispenseAdditionalInformation	CodeableConcept	0..*
MedicationDispense.DispensedAmount	Quantity	0..1
MedicationDispense.DispenseLocation	string	0..1
MedicationDispense.Comment	string	0..1

MedicationDispense
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
MedicationDispense.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	rim: n/a
MedicationDispense.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
MedicationDispense.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	Reference(HdBe-HealthcareOrganization)
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)
MedicationDispense.DispenseRequest
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)
MedicationDispense.DispensedMedicine
Definition	The dispensed medicine.
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)
MedicationDispense.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.
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
MedicationDispense.RequestDate
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
MedicationDispense.DistributionForm
Definition	Distribution form
Cardinality	0...1
Type	CodeableConcept
Binding	DistributionForm codes DistributionForm (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
MedicationDispense.DurationOfUse
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
MedicationDispense.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.
Cardinality	0...*
Type	CodeableConcept
Binding	MedicationDispenseAdditionalInformation codes MedicationDispenseAdditionalInformation (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
MedicationDispense.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.
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
MedicationDispense.DispenseLocation
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
MedicationDispense.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

| NameInformation      |                   |
|----------------------|-------------------|
| FirstNames | Johanna Petronella Maria   
| Initials | J.P.M. 
| GivenName | Jo 
| NameUsage | Geslachtsnaam partner gevolgd door eigen geslachtsnaam
| LastName.Prefix | van
| LastName.LastName | Putten
| LastNamePartner.PartnerPrefix | van der
| LastNamePartner.PartnerLastName | 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
DistributionForm	DistributionForm	required	https://fhir.healthdata.be/ValueSet/DistributionForm
MedicationDispenseAdditionalInformation	MedicationDispenseAdditionalInformation	required	https://fhir.healthdata.be/ValueSet/MedicationDispenseAdditionalInformation