Medication
1.0.1 - STU1 Belgium flag

Medication, published by HL7 Belgium. This is not an authorized publication; it is the continuous build for version 1.0.1. 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 Treatment Line - logical model

Official URL: https://www.ehealth.fgov.be/standards/fhir/medication/StructureDefinition/be-lm-medicationline Version: 1.0.1
Draft as of 2023-11-02 Computable Name: MedicationLine

A model for representing a Treatment 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-lm-medicationline 0..*BaseMedication Treatment Line - logical model
Instances of this logical model can be the target of a Reference
... uniqueIdentifier 1..1IdentifierUnique identifier
... versionIdentifier 1..1stringTimestamp the medication line content was recorded or last updated.
... lastUpdatedDate 1..1stringTimestamp the medication line content was recorded or last updated.
... statusReason 0..1CodeableConceptReason for the status
... recordedDate 0..1dateTimeDate the medication line was first recorded
... assertedDate 0..1dateTimeDate the medication line was first asserted or known
... recorder 1..1Reference(Practitioner)Recorder
... patient 1..1Reference(Patient)Patient
... category 0..1BackboneElementCategory for the treatment line
.... originType 0..1CodeableConceptThe origin...
... medication 1..1BackboneElementThe product or substance
.... product 1..1Reference(Medicinal Product)Product reference, identifier or name
.... type 1..1CodeableConceptType of medication - magistral, medicinal product, non-medicinal product
Binding: BEMLMedicationTypeVS (required)
... exposure 0..1CodeableConceptTherapeutic, Prophylactic
Binding: Medication exposure purpose (required)
... reason 0..*BackboneElementReason for the medication treatment
.... reference 0..1Reference()Reference to existing condition or reason
.... code 0..1CodeableConceptCode of the condition, or free text
... effectivePeriod 1..1BackboneElementPeriod of medication treatment
.... start 1..1dateTimeThe begin of the medication line
.... end 0..1dateTimeThe end of the medication line
... adherence 0..1BackboneElementWhether the patient is known to be taking the medication
.... code 1..1CodeableConceptThe status - taking, not taking,...
.... adherenceReason 0..1CodeableConceptReason for the adherence status
... dosage 0..1BackboneElementDosage
.... dosageDetails 0..1DosageStructure Dosage
.... dosageOverride 0..1booleanDosage Override
.... dosageOverrideReason 1..1CodeableConceptDosage Override reason
... note 0..*AnnotationA note captured by a professional
... dispenseRequestNeeded 0..*CodeableConceptWhether the medication needs a prescription or request to be dispensed
... visibility 0..*CodeableConceptWhether the patient has explicitly requested the medication line not to be seen - when other rules don't prevail

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSet
be-lm-medicationline.medication.typerequiredBEMLMedicationTypeVS (a valid code from Medication preparation Type)
be-lm-medicationline.exposurerequiredBEMLMExposureTypeVS (a valid code from Medication exposure purpose)
NameFlagsCard.TypeDescription & Constraintsdoco
.. be-lm-medicationline 0..*BaseMedication Treatment Line - logical model
Instances of this logical model can be the target of a Reference
... uniqueIdentifier 1..1IdentifierUnique identifier
... versionIdentifier 1..1stringTimestamp the medication line content was recorded or last updated.
... lastUpdatedDate 1..1stringTimestamp the medication line content was recorded or last updated.
... statusReason 0..1CodeableConceptReason for the status
... recordedDate 0..1dateTimeDate the medication line was first recorded
... assertedDate 0..1dateTimeDate the medication line was first asserted or known
... recorder 1..1Reference(Practitioner)Recorder
... patient 1..1Reference(Patient)Patient
... category 0..1BackboneElementCategory for the treatment line
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... originType 0..1CodeableConceptThe origin...
... medication 1..1BackboneElementThe product or substance
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... product 1..1Reference(Medicinal Product)Product reference, identifier or name
.... type 1..1CodeableConceptType of medication - magistral, medicinal product, non-medicinal product
Binding: BEMLMedicationTypeVS (required)
... exposure 0..1CodeableConceptTherapeutic, Prophylactic
Binding: Medication exposure purpose (required)
... reason 0..*BackboneElementReason for the medication treatment
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... reference 0..1Reference()Reference to existing condition or reason
.... code 0..1CodeableConceptCode of the condition, or free text
... effectivePeriod 1..1BackboneElementPeriod of medication treatment
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... start 1..1dateTimeThe begin of the medication line
.... end 0..1dateTimeThe end of the medication line
... adherence 0..1BackboneElementWhether the patient is known to be taking the medication
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... code 1..1CodeableConceptThe status - taking, not taking,...
.... adherenceReason 0..1CodeableConceptReason for the adherence status
... dosage 0..1BackboneElementDosage
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... dosageDetails 0..1DosageStructure Dosage
.... dosageOverride 0..1booleanDosage Override
.... dosageOverrideReason 1..1CodeableConceptDosage Override reason
... note 0..*AnnotationA note captured by a professional
... dispenseRequestNeeded 0..*CodeableConceptWhether the medication needs a prescription or request to be dispensed
... visibility 0..*CodeableConceptWhether the patient has explicitly requested the medication line not to be seen - when other rules don't prevail

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet
be-lm-medicationline.medication.typerequiredBEMLMedicationTypeVS (a valid code from Medication preparation Type)
be-lm-medicationline.exposurerequiredBEMLMExposureTypeVS (a valid code from Medication exposure purpose)

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-lm-medicationline 0..*BaseMedication Treatment Line - logical model
Instances of this logical model can be the target of a Reference
... uniqueIdentifier 1..1IdentifierUnique identifier
... versionIdentifier 1..1stringTimestamp the medication line content was recorded or last updated.
... lastUpdatedDate 1..1stringTimestamp the medication line content was recorded or last updated.
... statusReason 0..1CodeableConceptReason for the status
... recordedDate 0..1dateTimeDate the medication line was first recorded
... assertedDate 0..1dateTimeDate the medication line was first asserted or known
... recorder 1..1Reference(Practitioner)Recorder
... patient 1..1Reference(Patient)Patient
... category 0..1BackboneElementCategory for the treatment line
.... @id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... originType 0..1CodeableConceptThe origin...
... medication 1..1BackboneElementThe product or substance
.... @id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... product 1..1Reference(Medicinal Product)Product reference, identifier or name
.... type 1..1CodeableConceptType of medication - magistral, medicinal product, non-medicinal product
Binding: BEMLMedicationTypeVS (required)
... exposure 0..1CodeableConceptTherapeutic, Prophylactic
Binding: Medication exposure purpose (required)
... reason 0..*BackboneElementReason for the medication treatment
.... @id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... reference 0..1Reference()Reference to existing condition or reason
.... code 0..1CodeableConceptCode of the condition, or free text
... effectivePeriod 1..1BackboneElementPeriod of medication treatment
.... @id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... start 1..1dateTimeThe begin of the medication line
.... end 0..1dateTimeThe end of the medication line
... adherence 0..1BackboneElementWhether the patient is known to be taking the medication
.... @id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... code 1..1CodeableConceptThe status - taking, not taking,...
.... adherenceReason 0..1CodeableConceptReason for the adherence status
... dosage 0..1BackboneElementDosage
.... @id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... dosageDetails 0..1DosageStructure Dosage
.... dosageOverride 0..1booleanDosage Override
.... dosageOverrideReason 1..1CodeableConceptDosage Override reason
... note 0..*AnnotationA note captured by a professional
... dispenseRequestNeeded 0..*CodeableConceptWhether the medication needs a prescription or request to be dispensed
... visibility 0..*CodeableConceptWhether the patient has explicitly requested the medication line not to be seen - when other rules don't prevail

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet
be-lm-medicationline.medication.typerequiredBEMLMedicationTypeVS (a valid code from Medication preparation Type)
be-lm-medicationline.exposurerequiredBEMLMExposureTypeVS (a valid code from Medication exposure purpose)

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-lm-medicationline 0..*BaseMedication Treatment Line - logical model
Instances of this logical model can be the target of a Reference
... uniqueIdentifier 1..1IdentifierUnique identifier
... versionIdentifier 1..1stringTimestamp the medication line content was recorded or last updated.
... lastUpdatedDate 1..1stringTimestamp the medication line content was recorded or last updated.
... statusReason 0..1CodeableConceptReason for the status
... recordedDate 0..1dateTimeDate the medication line was first recorded
... assertedDate 0..1dateTimeDate the medication line was first asserted or known
... recorder 1..1Reference(Practitioner)Recorder
... patient 1..1Reference(Patient)Patient
... category 0..1BackboneElementCategory for the treatment line
.... originType 0..1CodeableConceptThe origin...
... medication 1..1BackboneElementThe product or substance
.... product 1..1Reference(Medicinal Product)Product reference, identifier or name
.... type 1..1CodeableConceptType of medication - magistral, medicinal product, non-medicinal product
Binding: BEMLMedicationTypeVS (required)
... exposure 0..1CodeableConceptTherapeutic, Prophylactic
Binding: Medication exposure purpose (required)
... reason 0..*BackboneElementReason for the medication treatment
.... reference 0..1Reference()Reference to existing condition or reason
.... code 0..1CodeableConceptCode of the condition, or free text
... effectivePeriod 1..1BackboneElementPeriod of medication treatment
.... start 1..1dateTimeThe begin of the medication line
.... end 0..1dateTimeThe end of the medication line
... adherence 0..1BackboneElementWhether the patient is known to be taking the medication
.... code 1..1CodeableConceptThe status - taking, not taking,...
.... adherenceReason 0..1CodeableConceptReason for the adherence status
... dosage 0..1BackboneElementDosage
.... dosageDetails 0..1DosageStructure Dosage
.... dosageOverride 0..1booleanDosage Override
.... dosageOverrideReason 1..1CodeableConceptDosage Override reason
... note 0..*AnnotationA note captured by a professional
... dispenseRequestNeeded 0..*CodeableConceptWhether the medication needs a prescription or request to be dispensed
... visibility 0..*CodeableConceptWhether the patient has explicitly requested the medication line not to be seen - when other rules don't prevail

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSet
be-lm-medicationline.medication.typerequiredBEMLMedicationTypeVS (a valid code from Medication preparation Type)
be-lm-medicationline.exposurerequiredBEMLMExposureTypeVS (a valid code from Medication exposure purpose)

Key Elements View

NameFlagsCard.TypeDescription & Constraintsdoco
.. be-lm-medicationline 0..*BaseMedication Treatment Line - logical model
Instances of this logical model can be the target of a Reference
... uniqueIdentifier 1..1IdentifierUnique identifier
... versionIdentifier 1..1stringTimestamp the medication line content was recorded or last updated.
... lastUpdatedDate 1..1stringTimestamp the medication line content was recorded or last updated.
... statusReason 0..1CodeableConceptReason for the status
... recordedDate 0..1dateTimeDate the medication line was first recorded
... assertedDate 0..1dateTimeDate the medication line was first asserted or known
... recorder 1..1Reference(Practitioner)Recorder
... patient 1..1Reference(Patient)Patient
... category 0..1BackboneElementCategory for the treatment line
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... originType 0..1CodeableConceptThe origin...
... medication 1..1BackboneElementThe product or substance
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... product 1..1Reference(Medicinal Product)Product reference, identifier or name
.... type 1..1CodeableConceptType of medication - magistral, medicinal product, non-medicinal product
Binding: BEMLMedicationTypeVS (required)
... exposure 0..1CodeableConceptTherapeutic, Prophylactic
Binding: Medication exposure purpose (required)
... reason 0..*BackboneElementReason for the medication treatment
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... reference 0..1Reference()Reference to existing condition or reason
.... code 0..1CodeableConceptCode of the condition, or free text
... effectivePeriod 1..1BackboneElementPeriod of medication treatment
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... start 1..1dateTimeThe begin of the medication line
.... end 0..1dateTimeThe end of the medication line
... adherence 0..1BackboneElementWhether the patient is known to be taking the medication
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... code 1..1CodeableConceptThe status - taking, not taking,...
.... adherenceReason 0..1CodeableConceptReason for the adherence status
... dosage 0..1BackboneElementDosage
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... dosageDetails 0..1DosageStructure Dosage
.... dosageOverride 0..1booleanDosage Override
.... dosageOverrideReason 1..1CodeableConceptDosage Override reason
... note 0..*AnnotationA note captured by a professional
... dispenseRequestNeeded 0..*CodeableConceptWhether the medication needs a prescription or request to be dispensed
... visibility 0..*CodeableConceptWhether the patient has explicitly requested the medication line not to be seen - when other rules don't prevail

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet
be-lm-medicationline.medication.typerequiredBEMLMedicationTypeVS (a valid code from Medication preparation Type)
be-lm-medicationline.exposurerequiredBEMLMExposureTypeVS (a valid code from Medication exposure purpose)

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-lm-medicationline 0..*BaseMedication Treatment Line - logical model
Instances of this logical model can be the target of a Reference
... uniqueIdentifier 1..1IdentifierUnique identifier
... versionIdentifier 1..1stringTimestamp the medication line content was recorded or last updated.
... lastUpdatedDate 1..1stringTimestamp the medication line content was recorded or last updated.
... statusReason 0..1CodeableConceptReason for the status
... recordedDate 0..1dateTimeDate the medication line was first recorded
... assertedDate 0..1dateTimeDate the medication line was first asserted or known
... recorder 1..1Reference(Practitioner)Recorder
... patient 1..1Reference(Patient)Patient
... category 0..1BackboneElementCategory for the treatment line
.... @id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... originType 0..1CodeableConceptThe origin...
... medication 1..1BackboneElementThe product or substance
.... @id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... product 1..1Reference(Medicinal Product)Product reference, identifier or name
.... type 1..1CodeableConceptType of medication - magistral, medicinal product, non-medicinal product
Binding: BEMLMedicationTypeVS (required)
... exposure 0..1CodeableConceptTherapeutic, Prophylactic
Binding: Medication exposure purpose (required)
... reason 0..*BackboneElementReason for the medication treatment
.... @id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... reference 0..1Reference()Reference to existing condition or reason
.... code 0..1CodeableConceptCode of the condition, or free text
... effectivePeriod 1..1BackboneElementPeriod of medication treatment
.... @id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... start 1..1dateTimeThe begin of the medication line
.... end 0..1dateTimeThe end of the medication line
... adherence 0..1BackboneElementWhether the patient is known to be taking the medication
.... @id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... code 1..1CodeableConceptThe status - taking, not taking,...
.... adherenceReason 0..1CodeableConceptReason for the adherence status
... dosage 0..1BackboneElementDosage
.... @id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... dosageDetails 0..1DosageStructure Dosage
.... dosageOverride 0..1booleanDosage Override
.... dosageOverrideReason 1..1CodeableConceptDosage Override reason
... note 0..*AnnotationA note captured by a professional
... dispenseRequestNeeded 0..*CodeableConceptWhether the medication needs a prescription or request to be dispensed
... visibility 0..*CodeableConceptWhether the patient has explicitly requested the medication line not to be seen - when other rules don't prevail

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet
be-lm-medicationline.medication.typerequiredBEMLMedicationTypeVS (a valid code from Medication preparation Type)
be-lm-medicationline.exposurerequiredBEMLMExposureTypeVS (a valid code from Medication exposure purpose)

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..*