Medication
2.0.0 - STU Belgium flag

Medication, published by HL7 Belgium. This guide is not an authorized publication; it is the continuous build for version 2.0.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: MedicationLine - Detailed Descriptions

Draft as of 2024-04-07

Definitions for the be-model-medicationline logical model.

Guidance on how to interpret the contents of this table can be found here

0. be-model-medicationline
Definition

A model for representing a Treatment Line.

ShortMedication Treatment Line - logical model
Logical ModelInstances of this logical model are not marked to be the target of a Reference
2. be-model-medicationline.uniqueIdentifier
Definition

A unique identifier for the medication line. This identifier alone may be the same for different versions of the medication line.

ShortUnique identifier
Control1..*
TypeIdentifier
4. be-model-medicationline.versionIdentifier
Definition

Version of the medication line at the time the content was recorded or last updated.

ShortVersion of the medication line at the time the content was recorded or last updated.
Control1..1
Typestring
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
6. be-model-medicationline.lastUpdatedDate
Definition

Timestamp the medication line content was recorded or last updated.

ShortTimestamp the medication line content was recorded or last updated.
Comments

We consider this is redundant with the above, given the intended use in Belgium (version is a date). How to ensure the compatibility?

Control1..1
TypedateTime
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
8. be-model-medicationline.status
Definition

Status of the treatment line entry

ShortStatus of the treatment line entry
Control1..1
Typecode
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
10. be-model-medicationline.statusReason
Definition

Reason for the status

ShortReason for the status
Comments

We consider this is not necessary - should we add?

Control0..1
TypeCodeableConcept
12. be-model-medicationline.assertedDate
Definition

Date the medication line was first asserted or known

ShortDate the medication line was first asserted or known
Comments

We consider this is not necessary

Control0..1
TypedateTime
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
14. be-model-medicationline.recorder
Definition

Recorder

ShortRecorder
Comments

We understand this will be updated as the line changes

Control1..1
TypeReference(Practitioner)
16. be-model-medicationline.patient
Definition

Patient

ShortPatient
Control1..1
TypeReference(Patient)
18. be-model-medicationline.category
Definition

Category for the treatment line

ShortCategory for the treatment line
Control0..1
TypeBackboneElement
20. be-model-medicationline.category.originType
Definition

The origin of the line - hospital, ambulatory

ShortThe origin of the line - hospital, ambulatory
Control0..1
TypeCodeableConcept
22. be-model-medicationline.medication
Definition

The product or substance

ShortThe product or substance
Control1..1
TypeBackboneElement
24. be-model-medicationline.medication.product
Definition

Product reference, identifier or name

ShortProduct reference, identifier or name
Control1..1
TypeReference(Medicinal Product)
26. be-model-medicationline.medication.type
Definition

Type of medication - magistral, medicinal product, non-medicinal product

ShortType of medication - magistral, medicinal product, non-medicinal product
Control1..1
BindingThe codes SHALL be taken from Medication preparation Type value set
(required to https://www.ehealth.fgov.be/standards/fhir/medication/ValueSet/medication-type-vs)
TypeCodeableConcept
28. be-model-medicationline.exposure
Definition

Therapeutic, Prophylactic

ShortTherapeutic, Prophylactic
Control0..1
BindingThe codes SHALL be taken from Medication exposure intent
(required to https://www.ehealth.fgov.be/standards/fhir/medication/ValueSet/medication-exposure-category-vs)
TypeCodeableConcept
30. be-model-medicationline.reason
Definition

Reason for the medication treatment

ShortReason for the medication treatment
Control0..*
TypeBackboneElement
32. be-model-medicationline.reason.reference
Definition

Reference to existing condition or reason

ShortReference to existing condition or reason
Control0..1
TypeReference
34. be-model-medicationline.reason.code
Definition

Code of the condition, or free text

ShortCode of the condition, or free text
Control0..1
TypeCodeableConcept
36. be-model-medicationline.effectivePeriod
Definition

Period of medication treatment

ShortPeriod of medication treatment
Comments

.effectiveDateTime OR .effectivePeriod.start. Do we need to support both? Can we use effectivePeriod when .end is known? And when only .start is known, we use dateTime?

Control1..1
TypeBackboneElement
38. be-model-medicationline.effectivePeriod.start
Definition

The begin of the medication line

ShortThe begin of the medication line
Control1..1
TypedateTime
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
40. be-model-medicationline.effectivePeriod.end
Definition

The end of the medication line

ShortThe end of the medication line
Control0..1
TypedateTime
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
42. be-model-medicationline.adherence
Definition

Whether the patient is known to be taking the medication

ShortWhether the patient is known to be taking the medication
Control0..1
TypeBackboneElement
44. be-model-medicationline.adherence.code
Definition

The status - taking, not taking,...

ShortThe status - taking, not taking,...
Control1..1
TypeCodeableConcept
46. be-model-medicationline.adherence.adherenceReason
Definition

Reason for the adherence status

ShortReason for the adherence status
Control0..1
TypeCodeableConcept
48. be-model-medicationline.dosage
Definition

Dosage

ShortDosage
Control0..1
TypeBackboneElement
50. be-model-medicationline.dosage.dosageDetails
Definition

Structure Dosage

ShortStructure Dosage
Control0..1
TypeDosage
52. be-model-medicationline.dosage.dosageOverride
Definition

Dosage Override

ShortDosage Override
Comments

should these be extensions on dosage or on the line?

Control0..1
Typeboolean
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
54. be-model-medicationline.dosage.dosageOverrideReason
Definition

Dosage Override reason

ShortDosage Override reason
Comments

should these be extensions on dosage or on the line?

Control1..1
TypeCodeableConcept
56. be-model-medicationline.note
Definition

A note captured by a professional

ShortA note captured by a professional
Control0..*
TypeAnnotation
58. be-model-medicationline.dispenseRequestNeeded
Definition

Whether the medication needs a prescription or request to be dispensed

ShortWhether the medication needs a prescription or request to be dispensed
Control0..*
TypeCodeableConcept
60. be-model-medicationline.visibility
Definition

Whether the patient has explicitly requested the medication line not to be seen - when other rules don't prevail

ShortWhether the patient has explicitly requested the medication line not to be seen - when other rules don't prevail
Control0..*
TypeCodeableConcept

Guidance on how to interpret the contents of this table can be found here

0. be-model-medicationline
Definition

A model for representing a Treatment Line.

ShortMedication Treatment Line - logical model
Control0..*
Is Modifierfalse
Logical ModelInstances of this logical model are not marked to be the target of a Reference
2. be-model-medicationline.uniqueIdentifier
Definition

A unique identifier for the medication line. This identifier alone may be the same for different versions of the medication line.

ShortUnique identifier
Control1..*
TypeIdentifier
4. be-model-medicationline.versionIdentifier
Definition

Version of the medication line at the time the content was recorded or last updated.

ShortVersion of the medication line at the time the content was recorded or last updated.
Control1..1
Typestring
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
6. be-model-medicationline.lastUpdatedDate
Definition

Timestamp the medication line content was recorded or last updated.

ShortTimestamp the medication line content was recorded or last updated.
Comments

We consider this is redundant with the above, given the intended use in Belgium (version is a date). How to ensure the compatibility?

Control1..1
TypedateTime
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
8. be-model-medicationline.status
Definition

Status of the treatment line entry

ShortStatus of the treatment line entry
Control1..1
Typecode
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
10. be-model-medicationline.statusReason
Definition

Reason for the status

ShortReason for the status
Comments

We consider this is not necessary - should we add?

Control0..1
TypeCodeableConcept
12. be-model-medicationline.assertedDate
Definition

Date the medication line was first asserted or known

ShortDate the medication line was first asserted or known
Comments

We consider this is not necessary

Control0..1
TypedateTime
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
14. be-model-medicationline.recorder
Definition

Recorder

ShortRecorder
Comments

We understand this will be updated as the line changes

Control1..1
TypeReference(Practitioner)
16. be-model-medicationline.patient
Definition

Patient

ShortPatient
Control1..1
TypeReference(Patient)
18. be-model-medicationline.category
Definition

Category for the treatment line

ShortCategory for the treatment line
Control0..1
TypeBackboneElement
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
20. be-model-medicationline.category.modifierExtension
Definition

May 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).

ShortExtensions that cannot be ignored even if unrecognized
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.

Control0..*
TypeExtension
Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
Summarytrue
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.

Alternate Namesextensions, user content, modifiers
Invariantsele-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())
22. be-model-medicationline.category.originType
Definition

The origin of the line - hospital, ambulatory

ShortThe origin of the line - hospital, ambulatory
Control0..1
TypeCodeableConcept
24. be-model-medicationline.medication
Definition

The product or substance

ShortThe product or substance
Control1..1
TypeBackboneElement
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
26. be-model-medicationline.medication.modifierExtension
Definition

May 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).

ShortExtensions that cannot be ignored even if unrecognized
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.

Control0..*
TypeExtension
Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
Summarytrue
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.

Alternate Namesextensions, user content, modifiers
Invariantsele-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())
28. be-model-medicationline.medication.product
Definition

Product reference, identifier or name

ShortProduct reference, identifier or name
Control1..1
TypeReference(Medicinal Product)
30. be-model-medicationline.medication.type
Definition

Type of medication - magistral, medicinal product, non-medicinal product

ShortType of medication - magistral, medicinal product, non-medicinal product
Control1..1
BindingThe codes SHALL be taken from Medication preparation Type value set
(required to https://www.ehealth.fgov.be/standards/fhir/medication/ValueSet/medication-type-vs)
TypeCodeableConcept
32. be-model-medicationline.exposure
Definition

Therapeutic, Prophylactic

ShortTherapeutic, Prophylactic
Control0..1
BindingThe codes SHALL be taken from Medication exposure intent
(required to https://www.ehealth.fgov.be/standards/fhir/medication/ValueSet/medication-exposure-category-vs)
TypeCodeableConcept
34. be-model-medicationline.reason
Definition

Reason for the medication treatment

ShortReason for the medication treatment
Control0..*
TypeBackboneElement
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
36. be-model-medicationline.reason.modifierExtension
Definition

May 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).

ShortExtensions that cannot be ignored even if unrecognized
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.

Control0..*
TypeExtension
Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
Summarytrue
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.

Alternate Namesextensions, user content, modifiers
Invariantsele-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())
38. be-model-medicationline.reason.reference
Definition

Reference to existing condition or reason

ShortReference to existing condition or reason
Control0..1
TypeReference
40. be-model-medicationline.reason.code
Definition

Code of the condition, or free text

ShortCode of the condition, or free text
Control0..1
TypeCodeableConcept
42. be-model-medicationline.effectivePeriod
Definition

Period of medication treatment

ShortPeriod of medication treatment
Comments

.effectiveDateTime OR .effectivePeriod.start. Do we need to support both? Can we use effectivePeriod when .end is known? And when only .start is known, we use dateTime?

Control1..1
TypeBackboneElement
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
44. be-model-medicationline.effectivePeriod.modifierExtension
Definition

May 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).

ShortExtensions that cannot be ignored even if unrecognized
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.

Control0..*
TypeExtension
Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
Summarytrue
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.

Alternate Namesextensions, user content, modifiers
Invariantsele-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())
46. be-model-medicationline.effectivePeriod.start
Definition

The begin of the medication line

ShortThe begin of the medication line
Control1..1
TypedateTime
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
48. be-model-medicationline.effectivePeriod.end
Definition

The end of the medication line

ShortThe end of the medication line
Control0..1
TypedateTime
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
50. be-model-medicationline.adherence
Definition

Whether the patient is known to be taking the medication

ShortWhether the patient is known to be taking the medication
Control0..1
TypeBackboneElement
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
52. be-model-medicationline.adherence.modifierExtension
Definition

May 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).

ShortExtensions that cannot be ignored even if unrecognized
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.

Control0..*
TypeExtension
Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
Summarytrue
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.

Alternate Namesextensions, user content, modifiers
Invariantsele-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())
54. be-model-medicationline.adherence.code
Definition

The status - taking, not taking,...

ShortThe status - taking, not taking,...
Control1..1
TypeCodeableConcept
56. be-model-medicationline.adherence.adherenceReason
Definition

Reason for the adherence status

ShortReason for the adherence status
Control0..1
TypeCodeableConcept
58. be-model-medicationline.dosage
Definition

Dosage

ShortDosage
Control0..1
TypeBackboneElement
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
60. be-model-medicationline.dosage.modifierExtension
Definition

May 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).

ShortExtensions that cannot be ignored even if unrecognized
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.

Control0..*
TypeExtension
Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
Summarytrue
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.

Alternate Namesextensions, user content, modifiers
Invariantsele-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())
62. be-model-medicationline.dosage.dosageDetails
Definition

Structure Dosage

ShortStructure Dosage
Control0..1
TypeDosage
64. be-model-medicationline.dosage.dosageOverride
Definition

Dosage Override

ShortDosage Override
Comments

should these be extensions on dosage or on the line?

Control0..1
Typeboolean
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
66. be-model-medicationline.dosage.dosageOverrideReason
Definition

Dosage Override reason

ShortDosage Override reason
Comments

should these be extensions on dosage or on the line?

Control1..1
TypeCodeableConcept
68. be-model-medicationline.note
Definition

A note captured by a professional

ShortA note captured by a professional
Control0..*
TypeAnnotation
70. be-model-medicationline.dispenseRequestNeeded
Definition

Whether the medication needs a prescription or request to be dispensed

ShortWhether the medication needs a prescription or request to be dispensed
Control0..*
TypeCodeableConcept
72. be-model-medicationline.visibility
Definition

Whether the patient has explicitly requested the medication line not to be seen - when other rules don't prevail

ShortWhether the patient has explicitly requested the medication line not to be seen - when other rules don't prevail
Control0..*
TypeCodeableConcept

Guidance on how to interpret the contents of this table can be found here

0. be-model-medicationline
Definition

A model for representing a Treatment Line.

ShortMedication Treatment Line - logical model
Control0..*
Is Modifierfalse
Logical ModelInstances of this logical model are not marked to be the target of a Reference
2. be-model-medicationline.uniqueIdentifier
Definition

A unique identifier for the medication line. This identifier alone may be the same for different versions of the medication line.

ShortUnique identifier
Control1..*
TypeIdentifier
4. be-model-medicationline.versionIdentifier
Definition

Version of the medication line at the time the content was recorded or last updated.

ShortVersion of the medication line at the time the content was recorded or last updated.
Control1..1
Typestring
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
6. be-model-medicationline.lastUpdatedDate
Definition

Timestamp the medication line content was recorded or last updated.

ShortTimestamp the medication line content was recorded or last updated.
Comments

We consider this is redundant with the above, given the intended use in Belgium (version is a date). How to ensure the compatibility?

Control1..1
TypedateTime
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
8. be-model-medicationline.status
Definition

Status of the treatment line entry

ShortStatus of the treatment line entry
Control1..1
Typecode
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
10. be-model-medicationline.statusReason
Definition

Reason for the status

ShortReason for the status
Comments

We consider this is not necessary - should we add?

Control0..1
TypeCodeableConcept
12. be-model-medicationline.assertedDate
Definition

Date the medication line was first asserted or known

ShortDate the medication line was first asserted or known
Comments

We consider this is not necessary

Control0..1
TypedateTime
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
14. be-model-medicationline.recorder
Definition

Recorder

ShortRecorder
Comments

We understand this will be updated as the line changes

Control1..1
TypeReference(Practitioner)
16. be-model-medicationline.patient
Definition

Patient

ShortPatient
Control1..1
TypeReference(Patient)
18. be-model-medicationline.category
Definition

Category for the treatment line

ShortCategory for the treatment line
Control0..1
TypeBackboneElement
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
20. be-model-medicationline.category.id
Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

ShortUnique id for inter-element referencing
Control0..1
Typestring
Is Modifierfalse
XML FormatIn the XML format, this property is represented as an attribute.
Summaryfalse
22. be-model-medicationline.category.extension
Definition

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

ShortAdditional content defined by implementations
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.

Control0..*
TypeExtension
Is Modifierfalse
Summaryfalse
Alternate Namesextensions, user content
Invariantsele-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())
SlicingThis element introduces a set of slices on be-model-medicationline.category.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
  • 24. be-model-medicationline.category.modifierExtension
    Definition

    May 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).

    ShortExtensions that cannot be ignored even if unrecognized
    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.

    Control0..*
    TypeExtension
    Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
    Summarytrue
    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.

    Alternate Namesextensions, user content, modifiers
    Invariantsele-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())
    26. be-model-medicationline.category.originType
    Definition

    The origin of the line - hospital, ambulatory

    ShortThe origin of the line - hospital, ambulatory
    Control0..1
    TypeCodeableConcept
    28. be-model-medicationline.medication
    Definition

    The product or substance

    ShortThe product or substance
    Control1..1
    TypeBackboneElement
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    30. be-model-medicationline.medication.id
    Definition

    Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

    ShortUnique id for inter-element referencing
    Control0..1
    Typestring
    Is Modifierfalse
    XML FormatIn the XML format, this property is represented as an attribute.
    Summaryfalse
    32. be-model-medicationline.medication.extension
    Definition

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

    ShortAdditional content defined by implementations
    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.

    Control0..*
    TypeExtension
    Is Modifierfalse
    Summaryfalse
    Alternate Namesextensions, user content
    Invariantsele-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())
    SlicingThis element introduces a set of slices on be-model-medicationline.medication.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
    • value @ url
    • 34. be-model-medicationline.medication.modifierExtension
      Definition

      May 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).

      ShortExtensions that cannot be ignored even if unrecognized
      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.

      Control0..*
      TypeExtension
      Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
      Summarytrue
      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.

      Alternate Namesextensions, user content, modifiers
      Invariantsele-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())
      36. be-model-medicationline.medication.product
      Definition

      Product reference, identifier or name

      ShortProduct reference, identifier or name
      Control1..1
      TypeReference(Medicinal Product)
      38. be-model-medicationline.medication.type
      Definition

      Type of medication - magistral, medicinal product, non-medicinal product

      ShortType of medication - magistral, medicinal product, non-medicinal product
      Control1..1
      BindingThe codes SHALL be taken from Medication preparation Type value set
      (required to https://www.ehealth.fgov.be/standards/fhir/medication/ValueSet/medication-type-vs)
      TypeCodeableConcept
      40. be-model-medicationline.exposure
      Definition

      Therapeutic, Prophylactic

      ShortTherapeutic, Prophylactic
      Control0..1
      BindingThe codes SHALL be taken from Medication exposure intent
      (required to https://www.ehealth.fgov.be/standards/fhir/medication/ValueSet/medication-exposure-category-vs)
      TypeCodeableConcept
      42. be-model-medicationline.reason
      Definition

      Reason for the medication treatment

      ShortReason for the medication treatment
      Control0..*
      TypeBackboneElement
      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
      44. be-model-medicationline.reason.id
      Definition

      Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

      ShortUnique id for inter-element referencing
      Control0..1
      Typestring
      Is Modifierfalse
      XML FormatIn the XML format, this property is represented as an attribute.
      Summaryfalse
      46. be-model-medicationline.reason.extension
      Definition

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

      ShortAdditional content defined by implementations
      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.

      Control0..*
      TypeExtension
      Is Modifierfalse
      Summaryfalse
      Alternate Namesextensions, user content
      Invariantsele-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())
      SlicingThis element introduces a set of slices on be-model-medicationline.reason.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
      • value @ url
      • 48. be-model-medicationline.reason.modifierExtension
        Definition

        May 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).

        ShortExtensions that cannot be ignored even if unrecognized
        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.

        Control0..*
        TypeExtension
        Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
        Summarytrue
        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.

        Alternate Namesextensions, user content, modifiers
        Invariantsele-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())
        50. be-model-medicationline.reason.reference
        Definition

        Reference to existing condition or reason

        ShortReference to existing condition or reason
        Control0..1
        TypeReference
        52. be-model-medicationline.reason.code
        Definition

        Code of the condition, or free text

        ShortCode of the condition, or free text
        Control0..1
        TypeCodeableConcept
        54. be-model-medicationline.effectivePeriod
        Definition

        Period of medication treatment

        ShortPeriod of medication treatment
        Comments

        .effectiveDateTime OR .effectivePeriod.start. Do we need to support both? Can we use effectivePeriod when .end is known? And when only .start is known, we use dateTime?

        Control1..1
        TypeBackboneElement
        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
        56. be-model-medicationline.effectivePeriod.id
        Definition

        Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

        ShortUnique id for inter-element referencing
        Control0..1
        Typestring
        Is Modifierfalse
        XML FormatIn the XML format, this property is represented as an attribute.
        Summaryfalse
        58. be-model-medicationline.effectivePeriod.extension
        Definition

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

        ShortAdditional content defined by implementations
        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.

        Control0..*
        TypeExtension
        Is Modifierfalse
        Summaryfalse
        Alternate Namesextensions, user content
        Invariantsele-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())
        SlicingThis element introduces a set of slices on be-model-medicationline.effectivePeriod.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
        • value @ url
        • 60. be-model-medicationline.effectivePeriod.modifierExtension
          Definition

          May 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).

          ShortExtensions that cannot be ignored even if unrecognized
          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.

          Control0..*
          TypeExtension
          Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
          Summarytrue
          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.

          Alternate Namesextensions, user content, modifiers
          Invariantsele-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())
          62. be-model-medicationline.effectivePeriod.start
          Definition

          The begin of the medication line

          ShortThe begin of the medication line
          Control1..1
          TypedateTime
          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
          64. be-model-medicationline.effectivePeriod.end
          Definition

          The end of the medication line

          ShortThe end of the medication line
          Control0..1
          TypedateTime
          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
          66. be-model-medicationline.adherence
          Definition

          Whether the patient is known to be taking the medication

          ShortWhether the patient is known to be taking the medication
          Control0..1
          TypeBackboneElement
          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
          68. be-model-medicationline.adherence.id
          Definition

          Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

          ShortUnique id for inter-element referencing
          Control0..1
          Typestring
          Is Modifierfalse
          XML FormatIn the XML format, this property is represented as an attribute.
          Summaryfalse
          70. be-model-medicationline.adherence.extension
          Definition

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

          ShortAdditional content defined by implementations
          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.

          Control0..*
          TypeExtension
          Is Modifierfalse
          Summaryfalse
          Alternate Namesextensions, user content
          Invariantsele-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())
          SlicingThis element introduces a set of slices on be-model-medicationline.adherence.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
          • value @ url
          • 72. be-model-medicationline.adherence.modifierExtension
            Definition

            May 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).

            ShortExtensions that cannot be ignored even if unrecognized
            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.

            Control0..*
            TypeExtension
            Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
            Summarytrue
            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.

            Alternate Namesextensions, user content, modifiers
            Invariantsele-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())
            74. be-model-medicationline.adherence.code
            Definition

            The status - taking, not taking,...

            ShortThe status - taking, not taking,...
            Control1..1
            TypeCodeableConcept
            76. be-model-medicationline.adherence.adherenceReason
            Definition

            Reason for the adherence status

            ShortReason for the adherence status
            Control0..1
            TypeCodeableConcept
            78. be-model-medicationline.dosage
            Definition

            Dosage

            ShortDosage
            Control0..1
            TypeBackboneElement
            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
            80. be-model-medicationline.dosage.id
            Definition

            Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

            ShortUnique id for inter-element referencing
            Control0..1
            Typestring
            Is Modifierfalse
            XML FormatIn the XML format, this property is represented as an attribute.
            Summaryfalse
            82. be-model-medicationline.dosage.extension
            Definition

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

            ShortAdditional content defined by implementations
            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.

            Control0..*
            TypeExtension
            Is Modifierfalse
            Summaryfalse
            Alternate Namesextensions, user content
            Invariantsele-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())
            SlicingThis element introduces a set of slices on be-model-medicationline.dosage.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
            • value @ url
            • 84. be-model-medicationline.dosage.modifierExtension
              Definition

              May 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).

              ShortExtensions that cannot be ignored even if unrecognized
              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.

              Control0..*
              TypeExtension
              Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
              Summarytrue
              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.

              Alternate Namesextensions, user content, modifiers
              Invariantsele-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())
              86. be-model-medicationline.dosage.dosageDetails
              Definition

              Structure Dosage

              ShortStructure Dosage
              Control0..1
              TypeDosage
              88. be-model-medicationline.dosage.dosageOverride
              Definition

              Dosage Override

              ShortDosage Override
              Comments

              should these be extensions on dosage or on the line?

              Control0..1
              Typeboolean
              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
              90. be-model-medicationline.dosage.dosageOverrideReason
              Definition

              Dosage Override reason

              ShortDosage Override reason
              Comments

              should these be extensions on dosage or on the line?

              Control1..1
              TypeCodeableConcept
              92. be-model-medicationline.note
              Definition

              A note captured by a professional

              ShortA note captured by a professional
              Control0..*
              TypeAnnotation
              94. be-model-medicationline.dispenseRequestNeeded
              Definition

              Whether the medication needs a prescription or request to be dispensed

              ShortWhether the medication needs a prescription or request to be dispensed
              Control0..*
              TypeCodeableConcept
              96. be-model-medicationline.visibility
              Definition

              Whether the patient has explicitly requested the medication line not to be seen - when other rules don't prevail

              ShortWhether the patient has explicitly requested the medication line not to be seen - when other rules don't prevail
              Control0..*
              TypeCodeableConcept