Medication
1.1.0 - STU Belgium flag

Medication, published by HL7 Belgium. This guide is not an authorized publication; it is the continuous build for version 1.1.0 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/hl7-be/medication/ and changes regularly. See the Directory of published versions

Logical Model: Medication Line - logical model

Official URL: https://www.ehealth.fgov.be/standards/fhir/medication/StructureDefinition/be-model-medicationline Version: 1.1.0
Draft as of 2024-11-18 Computable Name: MedicationLine

A logical data model of the medication line.

Relationship with other elements:

The Medication Line relates to the other data structures in the following way:

Medication Product Medication Line Prescription Line Dispense      

Usage:

  • This Logical Model Profile is not used by any profiles in this Implementation Guide

Formal Views of Profile Content

Description of Profiles, Differentials, Snapshots and how the different presentations work.

This structure is derived from Base

NameFlagsCard.TypeDescription & Constraintsdoco
.. be-model-medicationline 0..* Base Medication Line - logical model
Instances of this logical model are not marked to be the target of a Reference
... uniqueIdentifier 1..* Identifier Unique identifier
... versionIdentifier 1..1 string Version of the medication line at the time the content was recorded or last updated.
... lastUpdatedDate 1..1 dateTime Timestamp the medication line content was recorded or last updated.
... statusReason 0..1 CodeableConcept Reason for the status
... assertedDate 0..1 dateTime Date the medication line was first asserted or known
... recorder 1..1 Reference(Practitioner) Recorder
... patient 1..1 Reference(Patient) Patient
... category 0..1 BackboneElement Category for the line
.... originType 0..1 CodeableConcept The origin of the line - hospital, ambulatory
... medication 1..1 BackboneElement The product or substance
.... product 1..1 Reference(Medicinal Product) Product reference, identifier or name
.... type 1..1 CodeableConcept Type of medication - magistral, medicinal product, non-medicinal product
Binding: Medication preparation Type value set (required)
... exposure 0..1 CodeableConcept Therapeutic, Prophylactic
Binding: Medication exposure intent (required)
... reason 0..* BackboneElement Reason for the medication treatment
.... reference 0..1 Reference() Reference to existing condition or reason
.... code 0..1 CodeableConcept Code of the condition, or free text
... effectivePeriod 1..1 BackboneElement Period of medication treatment
.... start 1..1 dateTime The begin of the medication line
.... end 0..1 dateTime The end of the medication line
... adherence 0..1 BackboneElement Whether the patient is known to be taking the medication
.... code 1..1 CodeableConcept The status - taking, not taking,...
.... adherenceReason 0..1 CodeableConcept Reason for the adherence status
... dosage 0..1 BackboneElement Dosage
.... dosageDetails 0..1 Dosage Structure Dosage
.... dosageOverride 0..1 boolean Dosage Override
.... dosageOverrideReason 1..1 CodeableConcept Dosage Override reason
... note 0..* Annotation A note captured by a professional
... dispenseRequestNeeded 0..* CodeableConcept Whether the medication needs a prescription or request to be dispensed

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSetURI
be-model-medicationline.medication.typerequiredBEMLMedicationTypeVS (a valid code from Medication preparation Type)
https://www.ehealth.fgov.be/standards/fhir/medication/ValueSet/medication-type-vs
from this IG
be-model-medicationline.exposurerequiredMedicationExposureCategoryVS
https://www.ehealth.fgov.be/standards/fhir/medication/ValueSet/medication-exposure-category-vs
from this IG
NameFlagsCard.TypeDescription & Constraintsdoco
.. be-model-medicationline 0..* Base Medication Line - logical model
Instances of this logical model are not marked to be the target of a Reference
... uniqueIdentifier 1..* Identifier Unique identifier
... versionIdentifier 1..1 string Version of the medication line at the time the content was recorded or last updated.
... lastUpdatedDate 1..1 dateTime Timestamp the medication line content was recorded or last updated.
... statusReason 0..1 CodeableConcept Reason for the status
... assertedDate 0..1 dateTime Date the medication line was first asserted or known
... recorder 1..1 Reference(Practitioner) Recorder
... patient 1..1 Reference(Patient) Patient
... category 0..1 BackboneElement Category for the line
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... originType 0..1 CodeableConcept The origin of the line - hospital, ambulatory
... medication 1..1 BackboneElement The product or substance
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... product 1..1 Reference(Medicinal Product) Product reference, identifier or name
.... type 1..1 CodeableConcept Type of medication - magistral, medicinal product, non-medicinal product
Binding: Medication preparation Type value set (required)
... exposure 0..1 CodeableConcept Therapeutic, Prophylactic
Binding: Medication exposure intent (required)
... reason 0..* BackboneElement Reason for the medication treatment
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... reference 0..1 Reference() Reference to existing condition or reason
.... code 0..1 CodeableConcept Code of the condition, or free text
... effectivePeriod 1..1 BackboneElement Period of medication treatment
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... start 1..1 dateTime The begin of the medication line
.... end 0..1 dateTime The end of the medication line
... adherence 0..1 BackboneElement Whether the patient is known to be taking the medication
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... code 1..1 CodeableConcept The status - taking, not taking,...
.... adherenceReason 0..1 CodeableConcept Reason for the adherence status
... dosage 0..1 BackboneElement Dosage
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... dosageDetails 0..1 Dosage Structure Dosage
.... dosageOverride 0..1 boolean Dosage Override
.... dosageOverrideReason 1..1 CodeableConcept Dosage Override reason
... note 0..* Annotation A note captured by a professional
... dispenseRequestNeeded 0..* CodeableConcept Whether the medication needs a prescription or request to be dispensed

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
be-model-medicationline.medication.typerequiredBEMLMedicationTypeVS (a valid code from Medication preparation Type)
https://www.ehealth.fgov.be/standards/fhir/medication/ValueSet/medication-type-vs
from this IG
be-model-medicationline.exposurerequiredMedicationExposureCategoryVS
https://www.ehealth.fgov.be/standards/fhir/medication/ValueSet/medication-exposure-category-vs
from this IG

Constraints

IdGradePath(s)DetailsRequirements
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()
NameFlagsCard.TypeDescription & Constraintsdoco
.. be-model-medicationline 0..* Base Medication Line - logical model
Instances of this logical model are not marked to be the target of a Reference
... uniqueIdentifier 1..* Identifier Unique identifier
... versionIdentifier 1..1 string Version of the medication line at the time the content was recorded or last updated.
... lastUpdatedDate 1..1 dateTime Timestamp the medication line content was recorded or last updated.
... statusReason 0..1 CodeableConcept Reason for the status
... assertedDate 0..1 dateTime Date the medication line was first asserted or known
... recorder 1..1 Reference(Practitioner) Recorder
... patient 1..1 Reference(Patient) Patient
... category 0..1 BackboneElement Category for the line
.... @id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... originType 0..1 CodeableConcept The origin of the line - hospital, ambulatory
... medication 1..1 BackboneElement The product or substance
.... @id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... product 1..1 Reference(Medicinal Product) Product reference, identifier or name
.... type 1..1 CodeableConcept Type of medication - magistral, medicinal product, non-medicinal product
Binding: Medication preparation Type value set (required)
... exposure 0..1 CodeableConcept Therapeutic, Prophylactic
Binding: Medication exposure intent (required)
... reason 0..* BackboneElement Reason for the medication treatment
.... @id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... reference 0..1 Reference() Reference to existing condition or reason
.... code 0..1 CodeableConcept Code of the condition, or free text
... effectivePeriod 1..1 BackboneElement Period of medication treatment
.... @id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... start 1..1 dateTime The begin of the medication line
.... end 0..1 dateTime The end of the medication line
... adherence 0..1 BackboneElement Whether the patient is known to be taking the medication
.... @id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... code 1..1 CodeableConcept The status - taking, not taking,...
.... adherenceReason 0..1 CodeableConcept Reason for the adherence status
... dosage 0..1 BackboneElement Dosage
.... @id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... dosageDetails 0..1 Dosage Structure Dosage
.... dosageOverride 0..1 boolean Dosage Override
.... dosageOverrideReason 1..1 CodeableConcept Dosage Override reason
... note 0..* Annotation A note captured by a professional
... dispenseRequestNeeded 0..* CodeableConcept Whether the medication needs a prescription or request to be dispensed

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
be-model-medicationline.medication.typerequiredBEMLMedicationTypeVS (a valid code from Medication preparation Type)
https://www.ehealth.fgov.be/standards/fhir/medication/ValueSet/medication-type-vs
from this IG
be-model-medicationline.exposurerequiredMedicationExposureCategoryVS
https://www.ehealth.fgov.be/standards/fhir/medication/ValueSet/medication-exposure-category-vs
from this IG

Constraints

IdGradePath(s)DetailsRequirements
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()

This structure is derived from Base

Summary

Mandatory: 0 element(13 nested mandatory elements)

Structures

This structure refers to these other structures:

Differential View

This structure is derived from Base

NameFlagsCard.TypeDescription & Constraintsdoco
.. be-model-medicationline 0..* Base Medication Line - logical model
Instances of this logical model are not marked to be the target of a Reference
... uniqueIdentifier 1..* Identifier Unique identifier
... versionIdentifier 1..1 string Version of the medication line at the time the content was recorded or last updated.
... lastUpdatedDate 1..1 dateTime Timestamp the medication line content was recorded or last updated.
... statusReason 0..1 CodeableConcept Reason for the status
... assertedDate 0..1 dateTime Date the medication line was first asserted or known
... recorder 1..1 Reference(Practitioner) Recorder
... patient 1..1 Reference(Patient) Patient
... category 0..1 BackboneElement Category for the line
.... originType 0..1 CodeableConcept The origin of the line - hospital, ambulatory
... medication 1..1 BackboneElement The product or substance
.... product 1..1 Reference(Medicinal Product) Product reference, identifier or name
.... type 1..1 CodeableConcept Type of medication - magistral, medicinal product, non-medicinal product
Binding: Medication preparation Type value set (required)
... exposure 0..1 CodeableConcept Therapeutic, Prophylactic
Binding: Medication exposure intent (required)
... reason 0..* BackboneElement Reason for the medication treatment
.... reference 0..1 Reference() Reference to existing condition or reason
.... code 0..1 CodeableConcept Code of the condition, or free text
... effectivePeriod 1..1 BackboneElement Period of medication treatment
.... start 1..1 dateTime The begin of the medication line
.... end 0..1 dateTime The end of the medication line
... adherence 0..1 BackboneElement Whether the patient is known to be taking the medication
.... code 1..1 CodeableConcept The status - taking, not taking,...
.... adherenceReason 0..1 CodeableConcept Reason for the adherence status
... dosage 0..1 BackboneElement Dosage
.... dosageDetails 0..1 Dosage Structure Dosage
.... dosageOverride 0..1 boolean Dosage Override
.... dosageOverrideReason 1..1 CodeableConcept Dosage Override reason
... note 0..* Annotation A note captured by a professional
... dispenseRequestNeeded 0..* CodeableConcept Whether the medication needs a prescription or request to be dispensed

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSetURI
be-model-medicationline.medication.typerequiredBEMLMedicationTypeVS (a valid code from Medication preparation Type)
https://www.ehealth.fgov.be/standards/fhir/medication/ValueSet/medication-type-vs
from this IG
be-model-medicationline.exposurerequiredMedicationExposureCategoryVS
https://www.ehealth.fgov.be/standards/fhir/medication/ValueSet/medication-exposure-category-vs
from this IG

Key Elements View

NameFlagsCard.TypeDescription & Constraintsdoco
.. be-model-medicationline 0..* Base Medication Line - logical model
Instances of this logical model are not marked to be the target of a Reference
... uniqueIdentifier 1..* Identifier Unique identifier
... versionIdentifier 1..1 string Version of the medication line at the time the content was recorded or last updated.
... lastUpdatedDate 1..1 dateTime Timestamp the medication line content was recorded or last updated.
... statusReason 0..1 CodeableConcept Reason for the status
... assertedDate 0..1 dateTime Date the medication line was first asserted or known
... recorder 1..1 Reference(Practitioner) Recorder
... patient 1..1 Reference(Patient) Patient
... category 0..1 BackboneElement Category for the line
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... originType 0..1 CodeableConcept The origin of the line - hospital, ambulatory
... medication 1..1 BackboneElement The product or substance
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... product 1..1 Reference(Medicinal Product) Product reference, identifier or name
.... type 1..1 CodeableConcept Type of medication - magistral, medicinal product, non-medicinal product
Binding: Medication preparation Type value set (required)
... exposure 0..1 CodeableConcept Therapeutic, Prophylactic
Binding: Medication exposure intent (required)
... reason 0..* BackboneElement Reason for the medication treatment
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... reference 0..1 Reference() Reference to existing condition or reason
.... code 0..1 CodeableConcept Code of the condition, or free text
... effectivePeriod 1..1 BackboneElement Period of medication treatment
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... start 1..1 dateTime The begin of the medication line
.... end 0..1 dateTime The end of the medication line
... adherence 0..1 BackboneElement Whether the patient is known to be taking the medication
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... code 1..1 CodeableConcept The status - taking, not taking,...
.... adherenceReason 0..1 CodeableConcept Reason for the adherence status
... dosage 0..1 BackboneElement Dosage
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... dosageDetails 0..1 Dosage Structure Dosage
.... dosageOverride 0..1 boolean Dosage Override
.... dosageOverrideReason 1..1 CodeableConcept Dosage Override reason
... note 0..* Annotation A note captured by a professional
... dispenseRequestNeeded 0..* CodeableConcept Whether the medication needs a prescription or request to be dispensed

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
be-model-medicationline.medication.typerequiredBEMLMedicationTypeVS (a valid code from Medication preparation Type)
https://www.ehealth.fgov.be/standards/fhir/medication/ValueSet/medication-type-vs
from this IG
be-model-medicationline.exposurerequiredMedicationExposureCategoryVS
https://www.ehealth.fgov.be/standards/fhir/medication/ValueSet/medication-exposure-category-vs
from this IG

Constraints

IdGradePath(s)DetailsRequirements
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. be-model-medicationline 0..* Base Medication Line - logical model
Instances of this logical model are not marked to be the target of a Reference
... uniqueIdentifier 1..* Identifier Unique identifier
... versionIdentifier 1..1 string Version of the medication line at the time the content was recorded or last updated.
... lastUpdatedDate 1..1 dateTime Timestamp the medication line content was recorded or last updated.
... statusReason 0..1 CodeableConcept Reason for the status
... assertedDate 0..1 dateTime Date the medication line was first asserted or known
... recorder 1..1 Reference(Practitioner) Recorder
... patient 1..1 Reference(Patient) Patient
... category 0..1 BackboneElement Category for the line
.... @id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... originType 0..1 CodeableConcept The origin of the line - hospital, ambulatory
... medication 1..1 BackboneElement The product or substance
.... @id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... product 1..1 Reference(Medicinal Product) Product reference, identifier or name
.... type 1..1 CodeableConcept Type of medication - magistral, medicinal product, non-medicinal product
Binding: Medication preparation Type value set (required)
... exposure 0..1 CodeableConcept Therapeutic, Prophylactic
Binding: Medication exposure intent (required)
... reason 0..* BackboneElement Reason for the medication treatment
.... @id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... reference 0..1 Reference() Reference to existing condition or reason
.... code 0..1 CodeableConcept Code of the condition, or free text
... effectivePeriod 1..1 BackboneElement Period of medication treatment
.... @id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... start 1..1 dateTime The begin of the medication line
.... end 0..1 dateTime The end of the medication line
... adherence 0..1 BackboneElement Whether the patient is known to be taking the medication
.... @id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... code 1..1 CodeableConcept The status - taking, not taking,...
.... adherenceReason 0..1 CodeableConcept Reason for the adherence status
... dosage 0..1 BackboneElement Dosage
.... @id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... dosageDetails 0..1 Dosage Structure Dosage
.... dosageOverride 0..1 boolean Dosage Override
.... dosageOverrideReason 1..1 CodeableConcept Dosage Override reason
... note 0..* Annotation A note captured by a professional
... dispenseRequestNeeded 0..* CodeableConcept Whether the medication needs a prescription or request to be dispensed

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
be-model-medicationline.medication.typerequiredBEMLMedicationTypeVS (a valid code from Medication preparation Type)
https://www.ehealth.fgov.be/standards/fhir/medication/ValueSet/medication-type-vs
from this IG
be-model-medicationline.exposurerequiredMedicationExposureCategoryVS
https://www.ehealth.fgov.be/standards/fhir/medication/ValueSet/medication-exposure-category-vs
from this IG

Constraints

IdGradePath(s)DetailsRequirements
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()

This structure is derived from Base

Summary

Mandatory: 0 element(13 nested mandatory elements)

Structures

This structure refers to these other structures:

 

Other representations of profile: CSV, Excel

Notes:

Detailed diagram:

MedicationLineuniqueIdentifier 1..1versionIdentifier 1..1lastUpdatedDate 1..1status 1..1statusReason 0..1recordedDate 0..1assertedDate 0..1recorder 1..1patient 1..1category 0..1originType 0..1medication 1..1product 1..1type 1..1exposure 0..1reason 0..*reference 0..1code 0..1effectivePeriod 1..1start 1..1end 0..1adherence 0..1code 1..1adherenceReason 0..1dosage 0..1dosageDetails 0..1dosageOverride 0..1dosageOverrideReason 1..1note 0..*dispenseRequestNeeded 0..*visibility 0..*