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

EN NL FR

HdBe-UtilisationMédication2

CBBConceptStatus
HdBe-MedicationUse2

UtilisationMédication est une déclaration sur l'utilisation historique, actuelle ou prévue d'un certain médicament.

Purpose

L'objectif de l'utilisation de la médication est de fournir des informations sur le modèle d'utilisation du patient.

active

id0..1string
extensionI0..*Extension
PrescriberI0..1Reference(HdBe-HealthProfessional)
ProductUsedI1..1Reference(HdBe-PharmaceuticalProduct)
InstructionsForUse0..1HdBe-InstructionsForUse
MedicationUseDateTime1..1dateTime
PeriodOfUse0..1HdBe-TimeInterval
AsAgreedIndicator0..1boolean
UseIndicator1..1boolean
ReasonForUse0..1string
MedicationUseStopType0..1CodeableConceptBinding
ReasonForChangeOrDiscontinuationOfUse0..*CodeableConceptBinding
Comment0..1string

MedicationUse20..*
MedicationUse2.PrescriberReference(HdBe-HealthProfessional)0..1
MedicationUse2.ProductUsedReference(HdBe-PharmaceuticalProduct)1..1
MedicationUse2.InstructionsForUseHdBe-InstructionsForUse0..1
MedicationUse2.MedicationUseDateTimedateTime1..1
MedicationUse2.PeriodOfUseHdBe-TimeInterval0..1
MedicationUse2.AsAgreedIndicatorboolean0..1
MedicationUse2.UseIndicatorboolean1..1
MedicationUse2.ReasonForUsestring0..1
MedicationUse2.MedicationUseStopTypeCodeableConcept0..1
MedicationUse2.ReasonForChangeOrDiscontinuationOfUseCodeableConcept0..*
MedicationUse2.Commentstring0..1


MedicationUse2
DefinitionRoot concept of the MedicationUse2 information model. This root concept contains all data elements of the MedicationUse2 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
MedicationUse2.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
Typestring
Mappings
  • rim: n/a
MedicationUse2.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
MedicationUse2.Prescriber
DefinitionThe health professional that entered the medication agreement with the patient.
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)
MedicationUse2.ProductUsed
DefinitionThe product used. This is usually medication. Food, blood products, aids and bandages do not strictly fall under the category of medication, but can be recorded as well. In principle, this will be the prescribed product, but the product used may differ from the prescribed product.
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)
MedicationUse2.InstructionsForUse
DefinitionInstructions for the use of the medication, e.g. dose and route of administration. In the event of medication use, this is the pattern of use established by the patient or that the patient followed.
Cardinality0...1
TypeHdBe-InstructionsForUse
Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
MedicationUse2.MedicationUseDateTime
DefinitionDate on which this use is entered.
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
MedicationUse2.PeriodOfUse
DefinitionMedication use can be recorded for a certain moment or over a certain period. Thus, medication use can be recorded multiple times during the use of medication. The usage period is the period or moment over which the data is recorded. **Start date**: This is the time at which the agreement was to take effect (or took effect or will take effect). **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). To avoid confusion between 'to' and 'up to', the submission of time is always mandatory for the end date.
Cardinality0...1
TypeHdBe-TimeInterval
Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
MedicationUse2.AsAgreedIndicator
DefinitionIs the medicine used as outlined in the medication agreement?
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
MedicationUse2.UseIndicator
DefinitionIs this medicine used or not?
Cardinality1...1
Typeboolean
Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
MedicationUse2.ReasonForUse
DefinitionThe reason for using the medication, particularly in self-care medicine purchased by the patient themselves.
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
MedicationUse2.MedicationUseStopType
DefinitionStop type, the manner in which this medication is discontinued (temporary or definitive).
Cardinality0...1
TypeCodeableConcept
Binding

MedicationUseStopType codes

MedicationStopType (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
MedicationUse2.ReasonForChangeOrDiscontinuationOfUse
DefinitionReason for changing or discontinuing use of medication.
Cardinality0...*
TypeCodeableConcept
Binding

ReasonForChangeOrDiscontinuationOfUse codes

MedicationReason (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
MedicationUse2.Comment
DefinitionComments on the medication use.
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

MedicationUse2
Prescriber Reference to HealthProfessional (E. Penninx)
ProductUsed Reference to PharmaceuticalProduct (Acetaminophen 500 mg)
InstructionsForUse Reference to InstructionsForUse (From 24 Oct 2016, for 4 days, 4 times per day 1 unit, if needed 2 times a day 1 unit, oral.)
MedicationUseDateTime 2020-07-21
PeriodOfUse Reference to TimeInterval (duration: 4 days)
AsAgreedIndicator true
UseIndicator
ReasonForUse Taken for side effects of vaccination
MedicationUseStopType
ReasonForChangeOrDiscontinuationOfUse
Comment

zib MedicationUse2-v1.1.1 difference

Concept Category Description
MedicationUse2 (root) naming Renamed the root concept name MedicationUse to MedicationUse2 to align with the sdf-8 constraint. (zib ticket #1875)
ReasonForChangeOrDiscontinuationOf terminology Renamed the ValueSet from ReasonForChangeOrDiscontinuationOfUse to MedicationReason, to be able to reuse it at MedicationAgreement. Replaced several values in MedicationReason valueSet
: 1. Replaced OTH with SNOMED-CT code for Other. 2. Added SNOMED-CT code for Unknown. 3. Added CodeSystem MedicationReason which replaces all Dutch SNOMED-CT codes. 4. Removed all Dutch SNOMED-CT codes from valueset.
MedicationUseStopType terminology Renamed the ValueSet from MedicationUseStopType to MedicationStopType, to be able to reuse it in MedicationAgreement and AdministrationAgreement. Replaced Dutch SNOMED-CT codes with international codes.
InstructionsForUse textual Replaced 'which the patient followed' by 'that the patient followed'.



Terminology Bindings

PathNameStrengthURL
MedicationUseStopTypeMedicationStopTyperequiredhttps://fhir.healthdata.be/ValueSet/MedicationStopType
ReasonForChangeOrDiscontinuationOfUseMedicationReasonrequiredhttps://fhir.healthdata.be/ValueSet/MedicationReason