HdBe-MedicationUse2

ProfileStatusURL
HdBe-MedicationUse2drafthttps://fhir.healthdata.be/StructureDefinition/LogicalModel/HdBe-MedicationUse2

prescriber0..1Reference(HdBe HealthProfessional)
product_used1..1Reference(HdBe PharmaceuticalProduct)
instructions_for_use0..1HdBe InstructionsForUse
medication_use_date_time1..1dateTime
period_of_use0..1HdBe TimeInterval
as_agreed_indicator0..1boolean
use_indicator1..1boolean
reason_for_use0..1string
medication_use_stop_type0..1CodeableConceptBinding
reason_for_change_or_discontinuation_of_use0..*CodeableConceptBinding
comment0..1string

medication_use0..*
medication_use.prescriberReference(HdBe HealthProfessional)0..1
medication_use.product_usedReference(HdBe PharmaceuticalProduct)1..1
medication_use.instructions_for_useHdBe InstructionsForUse0..1
medication_use.medication_use_date_timedateTime1..1
medication_use.period_of_useHdBe TimeInterval0..1
medication_use.as_agreed_indicatorboolean0..1
medication_use.use_indicatorboolean1..1
medication_use.reason_for_usestring0..1
medication_use.medication_use_stop_typeCodeableConcept0..1
medication_use.reason_for_change_or_discontinuation_of_useCodeableConcept0..*
medication_use.commentstring0..1



medication_use
DefinitionRoot concept of the MedicationUse information model. This root concept contains all data elements of the MedicationUse 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_use.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_use.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_use.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)
medication_use.product_used
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)
medication_use.instructions_for_use
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 which 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
medication_use.medication_use_date_time
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
medication_use.period_of_use
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
medication_use.as_agreed_indicator
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
medication_use.use_indicator
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
medication_use.reason_for_use
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
medication_use.medication_use_stop_type
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
medication_use.reason_for_change_or_discontinuation_of_use
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
medication_use.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

medication_use
prescriber Reference to HealthProfessional (E. Penninx)
product_used Reference to PharmaceuticalProduct (Acetaminophen 500 mg)
instructions_for_use 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.)
medication_use_date_time 2020-07-21
period_of_use Reference to TimeInterval (duration: 4 days)
as_agreed_indicator true
use_indicator
reason_for_use Taken for side effects of vaccination
medication_use_stop_type
reason_for_change_or_discontinuation_of_use
comment

zib MedicationUse2-v1.1.1 difference

Concept Category Description
reason_for_change_or_discontinuation_of_use 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.
medication_use_stop_type 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.



Terminology Bindings

PathNameStrengthURL
medication_use_stop_typeMedicationStopTyperequiredhttps://fhir.healthdata.be/ValueSet/MedicationStopType
reason_for_change_or_discontinuation_of_useMedicationReasonrequiredhttps://fhir.healthdata.be/ValueSet/MedicationReason