HdBe-MedicationAgreement
Profile | Status | URL |
---|---|---|
HdBe-MedicationAgreement | draft | https://fhir.healthdata.be/StructureDefinition/LogicalModel/HdBe-MedicationAgreement |
medication_agreement | medication_agreement | ||
prescriber | 0..1 | BackboneElement | |
health_professional | 1..1 | Reference(HdBe HealthProfessional) | |
prescription_reason | 0..1 | BackboneElement | |
problem | 1..1 | Reference(HdBe Problem) | |
agreed_medicine | 1..1 | BackboneElement | |
pharmaceutical_product | 1..1 | Reference(HdBe PharmaceuticalProduct) | |
instructions_for_use | 0..1 | HdBe InstructionsForUse | |
medication_agreement_date_time | 1..1 | dateTime | |
period_of_use | 0..1 | BackboneElement | |
start_date_time | 0..1 | dateTime | |
end_date_time | 0..1 | dateTime | |
duration | 0..1 | Quantity | |
medication_agreement_stop_type | 0..1 | CodeableConceptBinding | |
reason_medication_agreement | 0..1 | CodeableConceptBinding | |
medication_agreement_additional_information | 0..* | CodeableConceptBinding | |
comment | 0..1 | string |
medication_agreement | 0..* | |
medication_agreement.prescriber | BackboneElement | 0..1 |
medication_agreement.prescriber.health_professional | Reference(HdBe HealthProfessional) | 1..1 |
medication_agreement.prescription_reason | BackboneElement | 0..1 |
medication_agreement.prescription_reason.problem | Reference(HdBe Problem) | 1..1 |
medication_agreement.agreed_medicine | BackboneElement | 1..1 |
medication_agreement.agreed_medicine.pharmaceutical_product | Reference(HdBe PharmaceuticalProduct) | 1..1 |
medication_agreement.instructions_for_use | HdBe InstructionsForUse | 0..1 |
medication_agreement.medication_agreement_date_time | dateTime | 1..1 |
medication_agreement.period_of_use | BackboneElement | 0..1 |
medication_agreement.period_of_use.start_date_time | dateTime | 0..1 |
medication_agreement.period_of_use.end_date_time | dateTime | 0..1 |
medication_agreement.period_of_use.duration | Quantity | 0..1 |
medication_agreement.medication_agreement_stop_type | CodeableConcept | 0..1 |
medication_agreement.reason_medication_agreement | CodeableConcept | 0..1 |
medication_agreement.medication_agreement_additional_information | CodeableConcept | 0..* |
medication_agreement.comment | string | 0..1 |
medication_agreement | |
Definition | Root concept of the MedicationAgreement information model. This root concept contains all data elements of the MedicationAgreement information model. |
Cardinality | 0...* |
Invariants |
|
Mappings |
|
medication_agreement.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 |
|
medication_agreement.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 |
|
medication_agreement.prescriber | |
Definition | The health professional that entered the medication agreement with the patient. |
Cardinality | 0...1 |
Type | BackboneElement |
Invariants |
|
Mappings |
|
medication_agreement.prescriber.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 |
|
medication_agreement.prescriber.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 |
|
medication_agreement.prescriber.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 |
|
medication_agreement.prescriber.health_professional | |
Definition | Root concept of the HealthProfessional information model. This root concept contains all data elements of the HealthProfessional information model. When referring to this information model the role the health professional fulfils in the healthcare process can be addressed additionally. For health professionals, this could be for example main practitioner or referrer. |
Cardinality | 1...1 |
Type | Reference(HdBe HealthProfessional) |
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 |
|
Mappings |
|
medication_agreement.prescription_reason | |
Definition | The medical reason for the prescription or for use of the medication. This can be used to enter a medical indication which was the direct cause for prescription or for use of the medication in question. It can concern every type of problem (or condition) of the patient, almost all diagnoses, complaints or symptoms. Please note: The BST401T file of the G standard contains a “special reference” to indicate that “exchange of the reason for prescription is essential”. |
Cardinality | 0...1 |
Type | BackboneElement |
Invariants |
|
Mappings |
|
medication_agreement.prescription_reason.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 |
|
medication_agreement.prescription_reason.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 |
|
medication_agreement.prescription_reason.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 |
|
medication_agreement.prescription_reason.problem | |
Definition | Root concept of the Problem information model. A problem describes a situation with regard to an individual’s health and/or welfare. This situation can be described by the patient himselve (in the form of a complaint) or by their healthprofessional (in the form of a diagnosis, for example). |
Cardinality | 1...1 |
Type | Reference(HdBe Problem) |
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 |
|
Mappings |
|
medication_agreement.agreed_medicine | |
Definition | The medicine agreed upon to be used. |
Cardinality | 1...1 |
Type | BackboneElement |
Invariants |
|
Mappings |
|
medication_agreement.agreed_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 |
|
medication_agreement.agreed_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 |
|
Mappings |
|
medication_agreement.agreed_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 |
|
Mappings |
|
medication_agreement.agreed_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 |
|
Mappings |
|
medication_agreement.instructions_for_use | |
Definition | Instructions for the use of the medication, e.g. dose and route of administration. |
Cardinality | 0...1 |
Type | HdBe InstructionsForUse |
Invariants |
|
Mappings |
|
medication_agreement.medication_agreement_date_time | |
Definition | The time at which the agreement was made. Appointment date + time are required (order of the appointments must be clear in cases with multiple appointments on one day) |
Cardinality | 1...1 |
Type | dateTime |
Invariants |
|
Mappings |
|
medication_agreement.period_of_use | |
Definition | Start date: This is the time at which the agreement was to take effect (or took effect or will take effect). This is the time at which the instructions for use in this agreement start. In the case of an agreement to discontinue use, this is the start date of the original medication agreement. The end date indicates from when the medication is to be discontinued. **Duration:** The intended duration of use. E.g. 5 days or 8 weeks. It is not allowed to indicate the duration in months, because different months have a variable duration in days. **End date:** The time at which the period of use ends (or ended or will end). In the case of an agreement to discontinue use, this is the time at which the medication is to be discontinued. To avoid confusion between 'to' and 'up to', the submission of time is always mandatory for the end date. With medication for an indefinite period only a start date is indicated. |
Cardinality | 0...1 |
Type | BackboneElement |
Invariants |
|
Mappings |
|
medication_agreement.period_of_use.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 |
|
medication_agreement.period_of_use.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 |
|
medication_agreement.period_of_use.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 |
|
medication_agreement.period_of_use.start_date_time | |
Definition | The start date and time of the interval |
Cardinality | 0...1 |
Type | dateTime |
Invariants |
|
Mappings |
|
medication_agreement.period_of_use.end_date_time | |
Definition | The end date and time of the interval |
Cardinality | 0...1 |
Type | dateTime |
Invariants |
|
Mappings |
|
medication_agreement.period_of_use.duration | |
Definition | The duration of the interval in appropriate units of time (*e.g.* days or hours, etc. |
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 |
|
medication_agreement.medication_agreement_stop_type | |
Definition | Stop type, the manner in which this medication is discontinued (temporary or definitive). |
Cardinality | 0...1 |
Type | CodeableConcept |
Binding | MedicationAgreementStopType codes MedicatieafspraakStopType (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 |
|
medication_agreement.reason_medication_agreement | |
Definition | Reason for this agreement. This can be the reason to start, change or stop the medication treatment. |
Cardinality | 0...1 |
Type | CodeableConcept |
Binding | ReasonMedicationAgreement codes RedenMedicatieafspraak (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 |
|
medication_agreement.medication_agreement_additional_information | |
Definition | Additional information includes details on the structure of the agreement made that are relevant for pharmacovigilance and fulfillment by the pharmacist. This can be used e.g. to indicate that there was a conscious decision to deviate from the norm or that the agreement is to be structured in a certain way. See also the Instructions section for more information about use of the element. |
Cardinality | 0...* |
Type | CodeableConcept |
Binding | MedicationAgreementAdditionalInformation codes MedicatieafspraakAanvullendeInformatie (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 |
|
medication_agreement.comment | |
Definition | Comments regarding to the medication agreement. For example: in consultation with the medical specialist. |
Cardinality | 0...1 |
Type | string |
Comments | Note that FHIR strings SHALL NOT exceed 1MB in size |
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 |
---|---|---|---|
medication_agreement_stop_type | MedicatieafspraakStopType | required | https://fhir.healthdata.be/ValueSet/MedicatieafspraakStopType |
reason_medication_agreement | RedenMedicatieafspraak | required | https://fhir.healthdata.be/ValueSet/RedenMedicatieafspraak |
medication_agreement_additional_information | MedicatieafspraakAanvullendeInformatie | required | https://fhir.healthdata.be/ValueSet/MedicatieafspraakAanvullendeInformatie |