HdBe-MedicationAdministration2

ProfileStatusURL
HdBe-MedicationAdministration2drafthttps://fhir.healthdata.be/StructureDefinition/LogicalModel/HdBe-MedicationAdministration2

administration_product1..1Reference(HdBe PharmaceuticalProduct)
administering_speed0..1HdBe Range
administration_date_time1..1dateTime
agreed_date_time0..1dateTime
administered_amount0..1Quantity
deviating_administration0..1boolean
route_of_administration1..1CodeableConceptBinding
double_check_performed0..1boolean
medication_agreementI0..1Reference(HdBe MedicationAgreement)
administration_agreementI0..1Reference(HdBe AdministrationAgreement)
patientI0..1Reference(HdBe Patient)
health_professionalI0..1Reference(HdBe HealthProfessional)
caregiverI0..1Reference(HdBe ContactPerson)
medication_administration_reason_for_deviation0..1CodeableConceptBinding
medication_administration_status1..1CodeableConceptBinding
comment0..1string

medication_administration0..*
medication_administration.administration_productReference(HdBe PharmaceuticalProduct)1..1
medication_administration.administering_speedHdBe Range0..1
medication_administration.administration_date_timedateTime1..1
medication_administration.agreed_date_timedateTime0..1
medication_administration.administered_amountQuantity0..1
medication_administration.deviating_administrationboolean0..1
medication_administration.route_of_administrationCodeableConcept1..1
medication_administration.double_check_performedboolean0..1
medication_administration.related_agreementBackboneElement0..1
medication_administration.related_agreement.medication_agreementReference(HdBe MedicationAgreement)0..1
medication_administration.related_agreement.administration_agreementReference(HdBe AdministrationAgreement)0..1
medication_administration.administratorBackboneElement0..1
medication_administration.administrator.patientReference(HdBe Patient)0..1
medication_administration.administrator.health_professionalReference(HdBe HealthProfessional)0..1
medication_administration.administrator.caregiverReference(HdBe ContactPerson)0..1
medication_administration.medication_administration_reason_for_deviationCodeableConcept0..1
medication_administration.medication_administration_statusCodeableConcept1..1
medication_administration.commentstring0..1



medication_administration
DefinitionRoot concept of the MedicationAdministration information model. This root concept contains all data elements of the MedicationAdministration information model.
Cardinality0...*
Invariants
  • ele-1:All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim:n/a
medication_administration.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
TypeSystem.String
Mappings
  • rim:n/a
medication_administration.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
medication_administration.administration_product
DefinitionThe product taken or administered. This is usually medication. Food, blood products, aids and bandages do not strictly fall under the category of medication, but can be reported as well. In principle, this will be the prescribed product, but the administrator may substitute it by replacing the product with an equivalent product. For example: two 50mg tablets can be administered instead of one 100mg tablet.
Cardinality1...1
TypeReference(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_administration.administering_speed
DefinitionThe administering speed is used in slow administration of liquid. In practice, the measuring unit is almost always ml/hour. Entering an interval (such as 0-10 ml/hour) is also a commonly used option. For example, with an administering speed of 10ml/hour: * amount = 10, * dose unit = ml * time unit = hour
Cardinality0...1
TypeHdBe Range
Invariants
  • ele-1:All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim:n/a
medication_administration.administration_date_time
DefinitionThe date and time at which the medication was administered.
Cardinality1...1
TypedateTime
Invariants
  • ele-1:All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim:n/a
medication_administration.agreed_date_time
DefinitionDate and time in the medication or administration agreement to which this administration pertains. Since multiple times can be indicated in one medication/administration agreement, this can be used to identify the agreed time in the event of e.g. early administration or a late administration.
Cardinality0...1
TypedateTime
Invariants
  • ele-1:All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim:n/a
medication_administration.administered_amount
DefinitionAmount of the administered product.
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
medication_administration.deviating_administration
DefinitionIn the administration, was there a deviation from the medication or administration agreement? This can be a deviation in product, time, amount, route of administration or administering speed or foregoing administration altogether.
Cardinality0...1
Typeboolean
Invariants
  • ele-1:All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim:n/a
medication_administration.route_of_administration
DefinitionThe route through which the medication is administered (oral, nasal, intravenous,...).
Cardinality1...1
TypeCodeableConcept
Binding

RouteOfAdministration codes

RouteOfMedicationAdministration (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_administration.double_check_performed
DefinitionWas a double check performed prior to the administration? This is only legally required for certain medication.
Cardinality0...1
Typeboolean
Invariants
  • ele-1:All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim:n/a
medication_administration.related_agreement
DefinitionMedication or administration agreement on which this administration.is based.
Cardinality0...1
TypeBackboneElement
Invariants
  • ele-1:All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • HdBe-MedicationAdministration2-1:Either medication_agreement or administration_agreement may exists.
    medication_agreement.exists() xor administration_agreement.exists()
Mappings
  • rim:n/a
medication_administration.related_agreement.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
TypeSystem.String
Mappings
  • rim:n/a
medication_administration.related_agreement.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
medication_administration.related_agreement.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
medication_administration.related_agreement.medication_agreement
DefinitionMedication agreement on which this administration is based.
Cardinality0...1
TypeReference(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
  • 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_administration.related_agreement.administration_agreement
DefinitionAdministration agreement on which this administration is based.
Cardinality0...1
TypeReference(HdBe AdministrationAgreement)
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_administration.administrator
DefinitionContainer of the Administrator concept. This container contains all data elements of the Administrator concept. The concept describes the person who administered the product. This is a professional authorised administrator, the patient themselves or the caregiver, for example.
Cardinality0...1
TypeBackboneElement
Invariants
  • ele-1:All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • HdBe-MedicationAdministration2-2:Either patient, health_professional or caregiver may exists.
    patient.exists() xor health_professional.exists() xor caregiver.exists()
Mappings
  • rim:n/a
medication_administration.administrator.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
TypeSystem.String
Mappings
  • rim:n/a
medication_administration.administrator.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
medication_administration.administrator.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
medication_administration.administrator.patient
DefinitionIf the patient administered the medication themselves, indicate that here. If the medication is administered by a health professional or caregiver/family member/etc., the health professional is entered in the ‘Healthcare provider’ element or the caregiver/family member/etc. is entered in the ‘Contact’ element respectively.
Cardinality0...1
TypeReference(HdBe Patient)
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_administration.administrator.health_professional
DefinitionThe concept describes the person who administered the product. This is a professional authorised administrator.
Cardinality0...1
TypeReference(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
  • 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_administration.administrator.caregiver
DefinitionInformation on the patient’s personal relative or contact that administered the medication.
Cardinality0...1
TypeReference(HdBe ContactPerson)
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_administration.medication_administration_reason_for_deviation
DefinitionReason why the medication was not taken or administered or was taken or administered differently. Here, you can choose to enter text or one of the codes.
Cardinality0...1
TypeCodeableConcept
Binding

MedicationAdministrationReasonForDeviation codes

MedicationAdministrationReasonForDeviation (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_administration.medication_administration_status
DefinitionThe status of the administration, as a description of the stage within the administering process. Only the status codes ‘completed’ and ‘cancelled’ apply to indivisible products (such as tablets or suppositories). For divisible products (such as infusions), doses can also be ‘suspended’ or ‘aborted’. When documenting this, the following interpretations are used: * Active: The product is administered. * Suspended: Use has (temporarily) been interrupted, because of a side effect, for example. Later, the patient and/or doctor can decide whether or not to resume or discontinue use. * Aborted: Administration has stopped. * Completed: Administration has been completed. * Canceled: The product was never administered.
Cardinality1...1
TypeCodeableConcept
Binding

MedicationAdministrationStatus codes

MedicationAdministrationStatus (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_administration.comment
DefinitionComments on administering the medication.
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

Example instances

medication_administration
administration_product Reference to PharmaceuticalProduct (Acetaminophen 500 mg oral tablet)
administering_speed
administration_date_time 2022-06-03 16:19:07
agreed_date_time
administered_amount 1 tablet
deviating_administration false
route_of_administration 26643006 - Oral route (code by SNOMED CT)
double_check_performed false
related_agreement --
related_agreement.medication_agreement
related_agreement.administration_agreement
administrator --
administrator.patient Reference to Patient (Belle Ulijn)
administrator.health_professional
administrator.caregiver
medication_administration_reason_for_deviation
medication_administration_status MS0002 - Completed (code by Healthdate.be (Sciensano))
comment

zib MedicationAdministration2-v1.1.1 difference

Concept Category Description
administering_speed type Replaced type BackboneElement with Range type and added HdBe-Range partial CBB.
administering_speed element Removed elements minimum_value, maximum_value and nominal_value as they are defined within the CBB HdBe-Range.
administering_speed textual Removed context regarding the Dutch NHG table.
route_of_administration terminology Replaced Gstandaard codes with SNOMED hierarchy containing descendents of 284009009 (Route of administration value) (zib ticket #1781) and renamed it to RouteOfMedicationAdministration to reuse the ValueSet both here and in InstructionsForUse.
medication_administration_reason_for_deviation terminology Replaced NL-CM-CS or ActReason codes with SNOMED codes as found in the 2022 CodeList. Also added SNOMED codes for Unknown and Other. SNOMED NL codes are replaced with custom codes as defined the CodeSystem MedicationAdministrationReasonForDeviation.
medication_administration_status terminology Replaced ActStatus codes of the MedicationAdministrationStatus ValueSet with SNOMED codes where applicable and added custom codes for codes not found in SNOMED, such as: Aborted and Completed.
medication_administration_status textual Aligned description of the values with the used valueSet.
related_agreement constraint Added an invariant (id = HdBe-MedicationAdministration2-1 ) to indicate only one related_greement is expected.
administrator constraint Added an invariant (HdBe-MedicationAdministration2-2) to indicate only one administrator is expected.



Terminology Bindings

PathNameStrengthURL
route_of_administrationRouteOfMedicationAdministrationrequiredhttps://fhir.healthdata.be/ValueSet/RouteOfMedicationAdministration
medication_administration_reason_for_deviationMedicationAdministrationReasonForDeviationrequiredhttps://fhir.healthdata.be/ValueSet/MedicationAdministrationReasonForDeviation
medication_administration_statusMedicationAdministrationStatusrequiredhttps://fhir.healthdata.be/ValueSet/MedicationAdministrationStatus