HdBe-AdministrationAgreement
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 | Description | Status |
---|---|---|
HdBe-AdministrationAgreement | An administration agreement is the use (or administering) instructions from the pharmacist to the patient (or their representative or administrator), whereby a medication agreement is structured at a concrete level. PurposeThe goal of the administration agreement is to provide insight into the concrete instructions for administration/use of medication. | draft |
AdministrationAgreement | AdministrationAgreement | ||
id | 0..1 | string | |
extension | I | 0..* | Extension |
Supplier | I | 0..1 | Reference(HdBe-HealthcareOrganization) |
MedicineForAdministrationAgreement | I | 1..1 | Reference(HdBe-PharmaceuticalProduct) |
InstructionsForUse | 0..1 | HdBe-InstructionsForUse | |
AdministrationAgreementDateTime | 0..1 | dateTime | |
AgreementReason | 0..1 | string | |
PeriodOfUse | 1..1 | BackboneElement | |
id | 0..1 | string | |
extension | I | 0..* | Extension |
modifierExtension | Σ ?! I | 0..* | Extension |
StartDateTime | 0..1 | dateTime | |
EndDateTime | 0..1 | dateTime | |
Duration | I | 0..1 | Quantity |
MedicationAgreement | I | 0..1 | Reference(HdBe-MedicationAgreement) |
AdministrationAgreementStopType | 0..1 | CodeableConceptBinding | |
CanceledIndicator | 0..1 | boolean | |
AdministrationAgreementAdditionalInformation | 0..* | CodeableConceptBinding | |
Comment | 0..1 | string |
AdministrationAgreement | 0..* | |
AdministrationAgreement.Supplier | Reference(HdBe-HealthcareOrganization) | 0..1 |
AdministrationAgreement.MedicineForAdministrationAgreement | Reference(HdBe-PharmaceuticalProduct) | 1..1 |
AdministrationAgreement.InstructionsForUse | HdBe-InstructionsForUse | 0..1 |
AdministrationAgreement.AdministrationAgreementDateTime | dateTime | 0..1 |
AdministrationAgreement.AgreementReason | string | 0..1 |
AdministrationAgreement.PeriodOfUse | BackboneElement | 1..1 |
AdministrationAgreement.PeriodOfUse.StartDateTime | dateTime | 0..1 |
AdministrationAgreement.PeriodOfUse.EndDateTime | dateTime | 0..1 |
AdministrationAgreement.PeriodOfUse.Duration | Quantity | 0..1 |
AdministrationAgreement.MedicationAgreement | Reference(HdBe-MedicationAgreement) | 0..1 |
AdministrationAgreement.AdministrationAgreementStopType | CodeableConcept | 0..1 |
AdministrationAgreement.CanceledIndicator | boolean | 0..1 |
AdministrationAgreement.AdministrationAgreementAdditionalInformation | CodeableConcept | 0..* |
AdministrationAgreement.Comment | string | 0..1 |
AdministrationAgreement | |
Definition | Root concept of the AdministrationAgreement information model. This root concept contains all data elements of the AdministrationAgreement information model. |
Cardinality | 0...* |
Invariants |
|
Mappings |
|
AdministrationAgreement.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 |
|
AdministrationAgreement.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 |
|
AdministrationAgreement.Supplier | |
Definition | The supplier (pharmacist) that entered the administration agreement. |
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 |
|
Mappings |
|
AdministrationAgreement.MedicineForAdministrationAgreement | |
Definition | Medicine in the AdministrationAgreement. |
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 |
|
AdministrationAgreement.InstructionsForUse | |
Definition | Instructions for administering the medication, e.g. dose and route of administration. |
Cardinality | 0...1 |
Type | HdBe-InstructionsForUse |
Invariants |
|
Mappings |
|
AdministrationAgreement.AdministrationAgreementDateTime | |
Definition | The time at which the agreement was made. |
Cardinality | 0...1 |
Type | dateTime |
Invariants |
|
Mappings |
|
AdministrationAgreement.AgreementReason | |
Definition | Reason for this agreement. This will often be the same reason as the one for the medication agreement. This field has the option to - if applicable - enter a specific reason for the administration agreement. Examples include: substitution, transfer to GDS, patient request for different product, etc. |
Cardinality | 0...1 |
Type | string |
Comments | Note that FHIR strings SHALL NOT exceed 1MB in size |
Invariants |
|
Mappings |
|
AdministrationAgreement.PeriodOfUse | |
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 administration 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 | 1...1 |
Type | BackboneElement |
Invariants |
|
Mappings |
|
AdministrationAgreement.PeriodOfUse.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 |
|
AdministrationAgreement.PeriodOfUse.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 |
|
AdministrationAgreement.PeriodOfUse.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 |
|
AdministrationAgreement.PeriodOfUse.StartDateTime | |
Definition | The start date and time of the interval |
Cardinality | 0...1 |
Type | dateTime |
Invariants |
|
Mappings |
|
AdministrationAgreement.PeriodOfUse.EndDateTime | |
Definition | The end date and time of the interval |
Cardinality | 0...1 |
Type | dateTime |
Invariants |
|
Mappings |
|
AdministrationAgreement.PeriodOfUse.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 |
|
AdministrationAgreement.MedicationAgreement | |
Definition | Relationship to the medication agreement on which the administration agreement is based. |
Cardinality | 0...1 |
Type | Reference(HdBe-MedicationAgreement) |
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 |
|
AdministrationAgreement.AdministrationAgreementStopType | |
Definition | Stop type, the manner in which this medication is discontinued (temporary or definitive). |
Cardinality | 0...1 |
Type | CodeableConcept |
Binding | AdministrationAgreementStopType codes |
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 |
|
AdministrationAgreement.CanceledIndicator | |
Definition | In the event of an error correction, this indicator is to be put on for the incorrect agreement. |
Cardinality | 0...1 |
Type | boolean |
Invariants |
|
Mappings |
|
AdministrationAgreement.AdministrationAgreementAdditionalInformation | |
Definition | Additional information includes details on the structure of the agreement made. This element mainly contains information that until now has been structured with ZZ rules. The medication-related topics that are now supported by the ZZ rules are best supported with a system functionality. A process has been started for this by Z-index/KNMP. For now, the following list will be used. This list will be replaced by a thesaurus in the G standard at a later stage. |
Cardinality | 0...* |
Type | CodeableConcept |
Binding | AdministrationAgreementAdditionalInformation codes |
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 |
|
AdministrationAgreement.Comment | |
Definition | Comments on the administration agreement. |
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
| 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 |
---|---|---|---|
AdministrationAgreementStopType | AdministrationAgreementStopType | required | https://fhir.healthdata.be/ValueSet/AdministrationAgreementStopType |
AdministrationAgreementAdditionalInformation | AdministrationAgreementAdditionalInformation | required | https://fhir.healthdata.be/ValueSet/AdministrationAgreementAdditionalInformation |