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/tree/master and changes regularly. See the Directory of published versions
Draft as of 2025-07-25 |
Definitions for the BeModelMedicationLine logical model.
Guidance on how to interpret the contents of this table can be foundhere
0. BeModelMedicationLine | |
Definition | Logical data model for medication line. |
Short | Medication Line (model) |
Control | 0..* |
Is Modifier | false |
Logical Model | Instances of this logical model are not marked to be the target of a Reference |
2. BeModelMedicationLine.identifier | |
Definition | A unique identifier for the medication line. This identifier alone may be the same for different versions of the medication line. |
Short | Unique identifier |
Note | This is a business identifier, not a resource identifier (see discussion) |
Control | 1..* |
Type | Identifier |
4. BeModelMedicationLine.recordedDate | |
Definition | Timestamp the medication line content was recorded or last updated. |
Short | Timestamp 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? |
Control | 1..1 |
Type | dateTime |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
6. BeModelMedicationLine.recorder | |
Definition | Recorder |
Short | Recorder |
Comments | We understand this will be updated as the line changes |
Control | 1..1 |
Type | Reference(BePractitioner) |
8. BeModelMedicationLine.patient | |
Definition | Patient |
Short | Patient |
Control | 1..1 |
Type | Reference(BePatient) |
10. BeModelMedicationLine.status | |
Definition | Status of the line entry |
Short | Status of the line entry |
Control | 1..1 |
Binding |
|
Type | code |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
12. BeModelMedicationLine.adherence | |
Definition | Whether the patient is known to be taking the medication |
Short | Whether the patient is known to be taking the medication |
Control | 0..1 |
Type | BackboneElement |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) |
14. BeModelMedicationLine.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. |
Short | Unique id for inter-element referencing |
Control | 0..1 |
Type | string |
Is Modifier | false |
XML Format | In the XML format, this property is represented as an attribute. |
Summary | false |
16. BeModelMedicationLine.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. |
Short | Additional 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. |
Control | 0..* |
Type | Extension |
Is Modifier | false |
Summary | false |
Alternate Names | extensions, user content |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists()) |
Slicing | This element introduces a set of slices on BeModelMedicationLine.adherence.extension . The slices areUnordered and Open, and can be differentiated using the following discriminators: |
18. BeModelMedicationLine.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). |
Short | Extensions 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. |
Control | 0..* |
Type | Extension |
Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them |
Summary | true |
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 Names | extensions, user content, modifiers |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists()) |
20. BeModelMedicationLine.adherence.status | |
Definition | The status - taking, not taking,... |
Short | The status - taking, not taking,... |
Control | 1..1 |
Binding | The codes SHALL be taken from BeExtAdherenceStatus (required to https://www.ehealth.fgov.be/standards/fhir/terminology/ValueSet/BeMedicationLineAdherenceStatusVS ) |
Type | CodeableConcept |
22. BeModelMedicationLine.adherence.adherenceStatusReason | |
Definition | Reason for the adherence status |
Short | Reason for the adherence status |
Comments | The value set provided is an indicative example |
Control | 0..1 |
Binding | For example codes, see Adherence Status Reason ValueSet (example to https://www.ehealth.fgov.be/standards/fhir/terminology/ValueSet/BeMedicationLineAdherenceStatusReasonVS ) |
Type | CodeableConcept |
24. BeModelMedicationLine.medication | |
Definition | The product or substance |
Short | The product or substance |
Control | 1..1 |
Type | BackboneElement |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) |
26. BeModelMedicationLine.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. |
Short | Unique id for inter-element referencing |
Control | 0..1 |
Type | string |
Is Modifier | false |
XML Format | In the XML format, this property is represented as an attribute. |
Summary | false |
28. BeModelMedicationLine.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. |
Short | Additional 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. |
Control | 0..* |
Type | Extension |
Is Modifier | false |
Summary | false |
Alternate Names | extensions, user content |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists()) |
Slicing | This element introduces a set of slices on BeModelMedicationLine.medication.extension . The slices areUnordered and Open, and can be differentiated using the following discriminators: |
30. BeModelMedicationLine.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). |
Short | Extensions 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. |
Control | 0..* |
Type | Extension |
Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them |
Summary | true |
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 Names | extensions, user content, modifiers |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists()) |
32. BeModelMedicationLine.medication.product | |
Definition | Product reference, identifier or name |
Short | Product reference, identifier or name |
Control | 1..1 |
Type | Reference(Medication (model)) |
34. BeModelMedicationLine.medication.type | |
Definition | Type of medication - magistral, medicinal product, non-medicinal product |
Short | Type of medication - magistral, medicinal product, non-medicinal product |
Control | 1..1 |
Binding | The codes SHALL be taken from Medication preparation Type value set (required to https://www.ehealth.fgov.be/standards/fhir/terminology/ValueSet/BeMedicationTypeVS ) |
Type | CodeableConcept |
36. BeModelMedicationLine.reason | |
Definition | Reason for the medication treatment |
Short | Reason for the medication treatment |
Control | 0..* |
Type | BackboneElement |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) |
38. BeModelMedicationLine.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. |
Short | Unique id for inter-element referencing |
Control | 0..1 |
Type | string |
Is Modifier | false |
XML Format | In the XML format, this property is represented as an attribute. |
Summary | false |
40. BeModelMedicationLine.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. |
Short | Additional 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. |
Control | 0..* |
Type | Extension |
Is Modifier | false |
Summary | false |
Alternate Names | extensions, user content |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists()) |
Slicing | This element introduces a set of slices on BeModelMedicationLine.reason.extension . The slices areUnordered and Open, and can be differentiated using the following discriminators: |
42. BeModelMedicationLine.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). |
Short | Extensions 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. |
Control | 0..* |
Type | Extension |
Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them |
Summary | true |
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 Names | extensions, user content, modifiers |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists()) |
44. BeModelMedicationLine.reason.reference | |
Definition | Reference to existing condition or reason |
Short | Reference to existing condition or reason |
Control | 0..1 |
Type | Reference |
46. BeModelMedicationLine.reason.code | |
Definition | Code of the condition, or free text |
Short | Code of the condition, or free text |
Control | 0..1 |
Type | CodeableConcept |
48. BeModelMedicationLine.effectivePeriod | |
Definition | Period of medication treatment |
Short | Period of medication treatment |
Control | 1..1 |
Type | BackboneElement |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) |
50. BeModelMedicationLine.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. |
Short | Unique id for inter-element referencing |
Control | 0..1 |
Type | string |
Is Modifier | false |
XML Format | In the XML format, this property is represented as an attribute. |
Summary | false |
52. BeModelMedicationLine.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. |
Short | Additional 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. |
Control | 0..* |
Type | Extension |
Is Modifier | false |
Summary | false |
Alternate Names | extensions, user content |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists()) |
Slicing | This element introduces a set of slices on BeModelMedicationLine.effectivePeriod.extension . The slices areUnordered and Open, and can be differentiated using the following discriminators: |
54. BeModelMedicationLine.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). |
Short | Extensions 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. |
Control | 0..* |
Type | Extension |
Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them |
Summary | true |
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 Names | extensions, user content, modifiers |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists()) |
56. BeModelMedicationLine.effectivePeriod.start | |
Definition | The begin of the medication line |
Short | The begin of the medication line |
Control | 1..1 |
Type | dateTime |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
58. BeModelMedicationLine.effectivePeriod.end | |
Definition | The end of the medication line |
Short | The end of the medication line |
Control | 0..1 |
Type | dateTime |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
60. BeModelMedicationLine.dosage | |
Definition | Structured Dosage |
Short | Structured Dosage |
Control | 0..* |
Type | https://www.ehealth.fgov.be/standards/fhir/medication/StructureDefinition/BeModelDosagingInformation |
62. BeModelMedicationLine.offLabel | |
Definition | Reason for Off-label use or dosage override |
Short | Reason for Off-label use or dosage override |
Comments | isOffLabelUse and reason are expected to be manually filled by the prescriber, indicating that this dosage is not entered in error. This information is an indication (for example) for the pharmacist to see that there is a justification of the dosage difference. |
Control | 0..1 |
Type | string |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
64. BeModelMedicationLine.exposure | |
Definition | Therapeutic, Prophylactic |
Short | Therapeutic, Prophylactic |
Control | 0..1 |
Binding | The codes SHALL be taken from Medication exposure intent (required to https://www.ehealth.fgov.be/standards/fhir/terminology/ValueSet/BeMedicationExposureIntentVS ) |
Type | CodeableConcept |
66. BeModelMedicationLine.originType | |
Definition | The origin of the line - hospital, ambulatory |
Short | The origin of the line - hospital, ambulatory |
Control | 0..1 |
Binding | The codes SHALL be taken from Medication origin type value set (required to https://www.ehealth.fgov.be/standards/fhir/terminology/ValueSet/BeMedicationLineOriginTypeVS ) |
Type | CodeableConcept |
68. BeModelMedicationLine.note | |
Definition | A note captured by a professional |
Short | A note captured by a professional |
Control | 0..* |
Type | Annotation |
Guidance on how to interpret the contents of this table can be foundhere
0. BeModelMedicationLine | |
Definition | Logical data model for medication line. |
Short | Medication Line (model) |
Logical Model | Instances of this logical model are not marked to be the target of a Reference |
2. BeModelMedicationLine.identifier | |
Definition | A unique identifier for the medication line. This identifier alone may be the same for different versions of the medication line. |
Short | Unique identifier |
Note | This is a business identifier, not a resource identifier (see discussion) |
Control | 1..* |
Type | Identifier |
4. BeModelMedicationLine.recordedDate | |
Definition | Timestamp the medication line content was recorded or last updated. |
Short | Timestamp 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? |
Control | 1..1 |
Type | dateTime |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
6. BeModelMedicationLine.recorder | |
Definition | Recorder |
Short | Recorder |
Comments | We understand this will be updated as the line changes |
Control | 1..1 |
Type | Reference(BePractitioner) |
8. BeModelMedicationLine.patient | |
Definition | Patient |
Short | Patient |
Control | 1..1 |
Type | Reference(BePatient) |
10. BeModelMedicationLine.status | |
Definition | Status of the line entry |
Short | Status of the line entry |
Control | 1..1 |
Binding |
|
Type | code |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
12. BeModelMedicationLine.adherence | |
Definition | Whether the patient is known to be taking the medication |
Short | Whether the patient is known to be taking the medication |
Control | 0..1 |
Type | BackboneElement |
14. BeModelMedicationLine.adherence.status | |
Definition | The status - taking, not taking,... |
Short | The status - taking, not taking,... |
Control | 1..1 |
Binding | The codes SHALL be taken from BeExtAdherenceStatus (required to https://www.ehealth.fgov.be/standards/fhir/terminology/ValueSet/BeMedicationLineAdherenceStatusVS ) |
Type | CodeableConcept |
16. BeModelMedicationLine.adherence.adherenceStatusReason | |
Definition | Reason for the adherence status |
Short | Reason for the adherence status |
Comments | The value set provided is an indicative example |
Control | 0..1 |
Binding | For example codes, see Adherence Status Reason ValueSet (example to https://www.ehealth.fgov.be/standards/fhir/terminology/ValueSet/BeMedicationLineAdherenceStatusReasonVS ) |
Type | CodeableConcept |
18. BeModelMedicationLine.medication | |
Definition | The product or substance |
Short | The product or substance |
Control | 1..1 |
Type | BackboneElement |
20. BeModelMedicationLine.medication.product | |
Definition | Product reference, identifier or name |
Short | Product reference, identifier or name |
Control | 1..1 |
Type | Reference(Medication (model)) |
22. BeModelMedicationLine.medication.type | |
Definition | Type of medication - magistral, medicinal product, non-medicinal product |
Short | Type of medication - magistral, medicinal product, non-medicinal product |
Control | 1..1 |
Binding | The codes SHALL be taken from Medication preparation Type value set (required to https://www.ehealth.fgov.be/standards/fhir/terminology/ValueSet/BeMedicationTypeVS ) |
Type | CodeableConcept |
24. BeModelMedicationLine.reason | |
Definition | Reason for the medication treatment |
Short | Reason for the medication treatment |
Control | 0..* |
Type | BackboneElement |
26. BeModelMedicationLine.reason.reference | |
Definition | Reference to existing condition or reason |
Short | Reference to existing condition or reason |
Control | 0..1 |
Type | Reference |
28. BeModelMedicationLine.reason.code | |
Definition | Code of the condition, or free text |
Short | Code of the condition, or free text |
Control | 0..1 |
Type | CodeableConcept |
30. BeModelMedicationLine.effectivePeriod | |
Definition | Period of medication treatment |
Short | Period of medication treatment |
Control | 1..1 |
Type | BackboneElement |
32. BeModelMedicationLine.effectivePeriod.start | |
Definition | The begin of the medication line |
Short | The begin of the medication line |
Control | 1..1 |
Type | dateTime |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
34. BeModelMedicationLine.effectivePeriod.end | |
Definition | The end of the medication line |
Short | The end of the medication line |
Control | 0..1 |
Type | dateTime |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
36. BeModelMedicationLine.dosage | |
Definition | Structured Dosage |
Short | Structured Dosage |
Control | 0..* |
Type | https://www.ehealth.fgov.be/standards/fhir/medication/StructureDefinition/BeModelDosagingInformation |
38. BeModelMedicationLine.offLabel | |
Definition | Reason for Off-label use or dosage override |
Short | Reason for Off-label use or dosage override |
Comments | isOffLabelUse and reason are expected to be manually filled by the prescriber, indicating that this dosage is not entered in error. This information is an indication (for example) for the pharmacist to see that there is a justification of the dosage difference. |
Control | 0..1 |
Type | string |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
40. BeModelMedicationLine.exposure | |
Definition | Therapeutic, Prophylactic |
Short | Therapeutic, Prophylactic |
Control | 0..1 |
Binding | The codes SHALL be taken from Medication exposure intent (required to https://www.ehealth.fgov.be/standards/fhir/terminology/ValueSet/BeMedicationExposureIntentVS ) |
Type | CodeableConcept |
42. BeModelMedicationLine.originType | |
Definition | The origin of the line - hospital, ambulatory |
Short | The origin of the line - hospital, ambulatory |
Control | 0..1 |
Binding | The codes SHALL be taken from Medication origin type value set (required to https://www.ehealth.fgov.be/standards/fhir/terminology/ValueSet/BeMedicationLineOriginTypeVS ) |
Type | CodeableConcept |
44. BeModelMedicationLine.note | |
Definition | A note captured by a professional |
Short | A note captured by a professional |
Control | 0..* |
Type | Annotation |
Guidance on how to interpret the contents of this table can be foundhere
0. BeModelMedicationLine | |
Definition | Logical data model for medication line. |
Short | Medication Line (model) |
Control | 0..* |
Is Modifier | false |
Logical Model | Instances of this logical model are not marked to be the target of a Reference |
2. BeModelMedicationLine.identifier | |
Definition | A unique identifier for the medication line. This identifier alone may be the same for different versions of the medication line. |
Short | Unique identifier |
Note | This is a business identifier, not a resource identifier (see discussion) |
Control | 1..* |
Type | Identifier |
4. BeModelMedicationLine.recordedDate | |
Definition | Timestamp the medication line content was recorded or last updated. |
Short | Timestamp 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? |
Control | 1..1 |
Type | dateTime |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
6. BeModelMedicationLine.recorder | |
Definition | Recorder |
Short | Recorder |
Comments | We understand this will be updated as the line changes |
Control | 1..1 |
Type | Reference(BePractitioner) |
8. BeModelMedicationLine.patient | |
Definition | Patient |
Short | Patient |
Control | 1..1 |
Type | Reference(BePatient) |
10. BeModelMedicationLine.status | |
Definition | Status of the line entry |
Short | Status of the line entry |
Control | 1..1 |
Binding |
|
Type | code |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
12. BeModelMedicationLine.adherence | |
Definition | Whether the patient is known to be taking the medication |
Short | Whether the patient is known to be taking the medication |
Control | 0..1 |
Type | BackboneElement |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) |
14. BeModelMedicationLine.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. |
Short | Unique id for inter-element referencing |
Control | 0..1 |
Type | string |
Is Modifier | false |
XML Format | In the XML format, this property is represented as an attribute. |
Summary | false |
16. BeModelMedicationLine.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. |
Short | Additional 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. |
Control | 0..* |
Type | Extension |
Is Modifier | false |
Summary | false |
Alternate Names | extensions, user content |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) )ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists() ) |
Slicing | This element introduces a set of slices on BeModelMedicationLine.adherence.extension . The slices areUnordered and Open, and can be differentiated using the following discriminators: |
18. BeModelMedicationLine.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). |
Short | Extensions 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. |
Control | 0..* |
Type | Extension |
Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them |
Summary | true |
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 Names | extensions, user content, modifiers |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) )ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists() ) |
20. BeModelMedicationLine.adherence.status | |
Definition | The status - taking, not taking,... |
Short | The status - taking, not taking,... |
Control | 1..1 |
Binding | The codes SHALL be taken from BeExtAdherenceStatus (required to https://www.ehealth.fgov.be/standards/fhir/terminology/ValueSet/BeMedicationLineAdherenceStatusVS ) |
Type | CodeableConcept |
22. BeModelMedicationLine.adherence.adherenceStatusReason | |
Definition | Reason for the adherence status |
Short | Reason for the adherence status |
Comments | The value set provided is an indicative example |
Control | 0..1 |
Binding | For example codes, see Adherence Status Reason ValueSet (example to https://www.ehealth.fgov.be/standards/fhir/terminology/ValueSet/BeMedicationLineAdherenceStatusReasonVS ) |
Type | CodeableConcept |
24. BeModelMedicationLine.medication | |
Definition | The product or substance |
Short | The product or substance |
Control | 1..1 |
Type | BackboneElement |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) |
26. BeModelMedicationLine.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. |
Short | Unique id for inter-element referencing |
Control | 0..1 |
Type | string |
Is Modifier | false |
XML Format | In the XML format, this property is represented as an attribute. |
Summary | false |
28. BeModelMedicationLine.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. |
Short | Additional 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. |
Control | 0..* |
Type | Extension |
Is Modifier | false |
Summary | false |
Alternate Names | extensions, user content |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) )ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists() ) |
Slicing | This element introduces a set of slices on BeModelMedicationLine.medication.extension . The slices areUnordered and Open, and can be differentiated using the following discriminators: |
30. BeModelMedicationLine.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). |
Short | Extensions 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. |
Control | 0..* |
Type | Extension |
Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them |
Summary | true |
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 Names | extensions, user content, modifiers |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) )ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists() ) |
32. BeModelMedicationLine.medication.product | |
Definition | Product reference, identifier or name |
Short | Product reference, identifier or name |
Control | 1..1 |
Type | Reference(Medication (model)) |
34. BeModelMedicationLine.medication.type | |
Definition | Type of medication - magistral, medicinal product, non-medicinal product |
Short | Type of medication - magistral, medicinal product, non-medicinal product |
Control | 1..1 |
Binding | The codes SHALL be taken from Medication preparation Type value set (required to https://www.ehealth.fgov.be/standards/fhir/terminology/ValueSet/BeMedicationTypeVS ) |
Type | CodeableConcept |
36. BeModelMedicationLine.reason | |
Definition | Reason for the medication treatment |
Short | Reason for the medication treatment |
Control | 0..* |
Type | BackboneElement |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) |
38. BeModelMedicationLine.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. |
Short | Unique id for inter-element referencing |
Control | 0..1 |
Type | string |
Is Modifier | false |
XML Format | In the XML format, this property is represented as an attribute. |
Summary | false |
40. BeModelMedicationLine.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. |
Short | Additional 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. |
Control | 0..* |
Type | Extension |
Is Modifier | false |
Summary | false |
Alternate Names | extensions, user content |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) )ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists() ) |
Slicing | This element introduces a set of slices on BeModelMedicationLine.reason.extension . The slices areUnordered and Open, and can be differentiated using the following discriminators: |
42. BeModelMedicationLine.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). |
Short | Extensions 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. |
Control | 0..* |
Type | Extension |
Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them |
Summary | true |
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 Names | extensions, user content, modifiers |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) )ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists() ) |
44. BeModelMedicationLine.reason.reference | |
Definition | Reference to existing condition or reason |
Short | Reference to existing condition or reason |
Control | 0..1 |
Type | Reference |
46. BeModelMedicationLine.reason.code | |
Definition | Code of the condition, or free text |
Short | Code of the condition, or free text |
Control | 0..1 |
Type | CodeableConcept |
48. BeModelMedicationLine.effectivePeriod | |
Definition | Period of medication treatment |
Short | Period of medication treatment |
Control | 1..1 |
Type | BackboneElement |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) |
50. BeModelMedicationLine.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. |
Short | Unique id for inter-element referencing |
Control | 0..1 |
Type | string |
Is Modifier | false |
XML Format | In the XML format, this property is represented as an attribute. |
Summary | false |
52. BeModelMedicationLine.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. |
Short | Additional 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. |
Control | 0..* |
Type | Extension |
Is Modifier | false |
Summary | false |
Alternate Names | extensions, user content |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) )ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists() ) |
Slicing | This element introduces a set of slices on BeModelMedicationLine.effectivePeriod.extension . The slices areUnordered and Open, and can be differentiated using the following discriminators: |
54. BeModelMedicationLine.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). |
Short | Extensions 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. |
Control | 0..* |
Type | Extension |
Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them |
Summary | true |
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 Names | extensions, user content, modifiers |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) )ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists() ) |
56. BeModelMedicationLine.effectivePeriod.start | |
Definition | The begin of the medication line |
Short | The begin of the medication line |
Control | 1..1 |
Type | dateTime |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
58. BeModelMedicationLine.effectivePeriod.end | |
Definition | The end of the medication line |
Short | The end of the medication line |
Control | 0..1 |
Type | dateTime |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
60. BeModelMedicationLine.dosage | |
Definition | Structured Dosage |
Short | Structured Dosage |
Control | 0..* |
Type | https://www.ehealth.fgov.be/standards/fhir/medication/StructureDefinition/BeModelDosagingInformation |
62. BeModelMedicationLine.offLabel | |
Definition | Reason for Off-label use or dosage override |
Short | Reason for Off-label use or dosage override |
Comments | isOffLabelUse and reason are expected to be manually filled by the prescriber, indicating that this dosage is not entered in error. This information is an indication (for example) for the pharmacist to see that there is a justification of the dosage difference. |
Control | 0..1 |
Type | string |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
64. BeModelMedicationLine.exposure | |
Definition | Therapeutic, Prophylactic |
Short | Therapeutic, Prophylactic |
Control | 0..1 |
Binding | The codes SHALL be taken from Medication exposure intent (required to https://www.ehealth.fgov.be/standards/fhir/terminology/ValueSet/BeMedicationExposureIntentVS ) |
Type | CodeableConcept |
66. BeModelMedicationLine.originType | |
Definition | The origin of the line - hospital, ambulatory |
Short | The origin of the line - hospital, ambulatory |
Control | 0..1 |
Binding | The codes SHALL be taken from Medication origin type value set (required to https://www.ehealth.fgov.be/standards/fhir/terminology/ValueSet/BeMedicationLineOriginTypeVS ) |
Type | CodeableConcept |
68. BeModelMedicationLine.note | |
Definition | A note captured by a professional |
Short | A note captured by a professional |
Control | 0..* |
Type | Annotation |