Medication, published by HL7 Belgium. This guide is not an authorized publication; it is the continuous build for version 1.1.0 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/hl7-be/medication/ and changes regularly. See the Directory of published versions
Draft as of 2024-11-18 |
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 logical data model of the medication line. |
Short | Medication Line - logical model |
Logical Model | Instances 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. |
Short | Unique identifier |
Control | 1..* |
Type | Identifier |
4. be-model-medicationline.versionIdentifier | |
Definition | Version of the medication line at the time the content was recorded or last updated. |
Short | Version of the medication line at the time the content was recorded or last updated. |
Control | 1..1 |
Type | string |
Primitive Value | This 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. |
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 |
8. be-model-medicationline.status | |
Definition | Status of the line entry |
Short | Status of the line entry |
Control | 1..1 |
Type | code |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
10. be-model-medicationline.statusReason | |
Definition | Reason for the status |
Short | Reason for the status |
Comments | We consider this is not necessary - should we add? |
Control | 0..1 |
Type | CodeableConcept |
12. be-model-medicationline.assertedDate | |
Definition | Date the medication line was first asserted or known |
Short | Date the medication line was first asserted or known |
Comments | We consider this is not necessary |
Control | 0..1 |
Type | dateTime |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
14. be-model-medicationline.recorder | |
Definition | Recorder |
Short | Recorder |
Comments | We understand this will be updated as the line changes |
Control | 1..1 |
Type | Reference(Practitioner) |
16. be-model-medicationline.patient | |
Definition | Patient |
Short | Patient |
Control | 1..1 |
Type | Reference(Patient) |
18. be-model-medicationline.category | |
Definition | Category for the line |
Short | Category for the line |
Control | 0..1 |
Type | BackboneElement |
20. be-model-medicationline.category.originType | |
Definition | The origin of the line - hospital, ambulatory |
Short | The origin of the line - hospital, ambulatory |
Control | 0..1 |
Type | CodeableConcept |
22. be-model-medicationline.medication | |
Definition | The product or substance |
Short | The product or substance |
Control | 1..1 |
Type | BackboneElement |
24. be-model-medicationline.medication.product | |
Definition | Product reference, identifier or name |
Short | Product reference, identifier or name |
Control | 1..1 |
Type | Reference(Medicinal Product) |
26. be-model-medicationline.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/medication/ValueSet/medication-type-vs ) |
Type | CodeableConcept |
28. be-model-medicationline.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/medication/ValueSet/medication-exposure-category-vs ) |
Type | CodeableConcept |
30. be-model-medicationline.reason | |
Definition | Reason for the medication treatment |
Short | Reason for the medication treatment |
Control | 0..* |
Type | BackboneElement |
32. be-model-medicationline.reason.reference | |
Definition | Reference to existing condition or reason |
Short | Reference to existing condition or reason |
Control | 0..1 |
Type | Reference |
34. be-model-medicationline.reason.code | |
Definition | Code of the condition, or free text |
Short | Code of the condition, or free text |
Control | 0..1 |
Type | CodeableConcept |
36. be-model-medicationline.effectivePeriod | |
Definition | Period of medication treatment |
Short | Period 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? |
Control | 1..1 |
Type | BackboneElement |
38. be-model-medicationline.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 |
40. be-model-medicationline.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 |
42. be-model-medicationline.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 |
44. be-model-medicationline.adherence.code | |
Definition | The status - taking, not taking,... |
Short | The status - taking, not taking,... |
Control | 1..1 |
Type | CodeableConcept |
46. be-model-medicationline.adherence.adherenceReason | |
Definition | Reason for the adherence status |
Short | Reason for the adherence status |
Control | 0..1 |
Type | CodeableConcept |
48. be-model-medicationline.dosage | |
Definition | Dosage |
Short | Dosage |
Control | 0..1 |
Type | BackboneElement |
50. be-model-medicationline.dosage.dosageDetails | |
Definition | Structure Dosage |
Short | Structure Dosage |
Control | 0..1 |
Type | Dosage |
52. be-model-medicationline.dosage.dosageOverride | |
Definition | Dosage Override |
Short | Dosage Override |
Comments | should these be extensions on dosage or on the line? |
Control | 0..1 |
Type | boolean |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
54. be-model-medicationline.dosage.dosageOverrideReason | |
Definition | Dosage Override reason |
Short | Dosage Override reason |
Comments | should these be extensions on dosage or on the line? |
Control | 1..1 |
Type | CodeableConcept |
56. be-model-medicationline.note | |
Definition | A note captured by a professional |
Short | A note captured by a professional |
Control | 0..* |
Type | Annotation |
58. be-model-medicationline.dispenseRequestNeeded | |
Definition | Whether the medication needs a prescription or request to be dispensed |
Short | Whether the medication needs a prescription or request to be dispensed |
Control | 0..* |
Type | CodeableConcept |
Guidance on how to interpret the contents of this table can be found here
0. be-model-medicationline | |
Definition | A logical data model of the medication line. |
Short | Medication Line - logical model |
Control | 0..* |
Is Modifier | false |
Logical Model | Instances 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. |
Short | Unique identifier |
Control | 1..* |
Type | Identifier |
4. be-model-medicationline.versionIdentifier | |
Definition | Version of the medication line at the time the content was recorded or last updated. |
Short | Version of the medication line at the time the content was recorded or last updated. |
Control | 1..1 |
Type | string |
Primitive Value | This 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. |
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 |
8. be-model-medicationline.status | |
Definition | Status of the line entry |
Short | Status of the line entry |
Control | 1..1 |
Type | code |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
10. be-model-medicationline.statusReason | |
Definition | Reason for the status |
Short | Reason for the status |
Comments | We consider this is not necessary - should we add? |
Control | 0..1 |
Type | CodeableConcept |
12. be-model-medicationline.assertedDate | |
Definition | Date the medication line was first asserted or known |
Short | Date the medication line was first asserted or known |
Comments | We consider this is not necessary |
Control | 0..1 |
Type | dateTime |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
14. be-model-medicationline.recorder | |
Definition | Recorder |
Short | Recorder |
Comments | We understand this will be updated as the line changes |
Control | 1..1 |
Type | Reference(Practitioner) |
16. be-model-medicationline.patient | |
Definition | Patient |
Short | Patient |
Control | 1..1 |
Type | Reference(Patient) |
18. be-model-medicationline.category | |
Definition | Category for the line |
Short | Category for the line |
Control | 0..1 |
Type | BackboneElement |
Invariants | ele-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). |
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()) |
22. be-model-medicationline.category.originType | |
Definition | The origin of the line - hospital, ambulatory |
Short | The origin of the line - hospital, ambulatory |
Control | 0..1 |
Type | CodeableConcept |
24. be-model-medicationline.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. 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). |
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()) |
28. be-model-medicationline.medication.product | |
Definition | Product reference, identifier or name |
Short | Product reference, identifier or name |
Control | 1..1 |
Type | Reference(Medicinal Product) |
30. be-model-medicationline.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/medication/ValueSet/medication-type-vs ) |
Type | CodeableConcept |
32. be-model-medicationline.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/medication/ValueSet/medication-exposure-category-vs ) |
Type | CodeableConcept |
34. be-model-medicationline.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()) ) |
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). |
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()) |
38. be-model-medicationline.reason.reference | |
Definition | Reference to existing condition or reason |
Short | Reference to existing condition or reason |
Control | 0..1 |
Type | Reference |
40. be-model-medicationline.reason.code | |
Definition | Code of the condition, or free text |
Short | Code of the condition, or free text |
Control | 0..1 |
Type | CodeableConcept |
42. be-model-medicationline.effectivePeriod | |
Definition | Period of medication treatment |
Short | Period 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? |
Control | 1..1 |
Type | BackboneElement |
Invariants | ele-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). |
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()) |
46. be-model-medicationline.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 |
48. be-model-medicationline.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 |
50. be-model-medicationline.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()) ) |
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). |
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()) |
54. be-model-medicationline.adherence.code | |
Definition | The status - taking, not taking,... |
Short | The status - taking, not taking,... |
Control | 1..1 |
Type | CodeableConcept |
56. be-model-medicationline.adherence.adherenceReason | |
Definition | Reason for the adherence status |
Short | Reason for the adherence status |
Control | 0..1 |
Type | CodeableConcept |
58. be-model-medicationline.dosage | |
Definition | Dosage |
Short | Dosage |
Control | 0..1 |
Type | BackboneElement |
Invariants | ele-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). |
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()) |
62. be-model-medicationline.dosage.dosageDetails | |
Definition | Structure Dosage |
Short | Structure Dosage |
Control | 0..1 |
Type | Dosage |
64. be-model-medicationline.dosage.dosageOverride | |
Definition | Dosage Override |
Short | Dosage Override |
Comments | should these be extensions on dosage or on the line? |
Control | 0..1 |
Type | boolean |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
66. be-model-medicationline.dosage.dosageOverrideReason | |
Definition | Dosage Override reason |
Short | Dosage Override reason |
Comments | should these be extensions on dosage or on the line? |
Control | 1..1 |
Type | CodeableConcept |
68. be-model-medicationline.note | |
Definition | A note captured by a professional |
Short | A note captured by a professional |
Control | 0..* |
Type | Annotation |
70. be-model-medicationline.dispenseRequestNeeded | |
Definition | Whether the medication needs a prescription or request to be dispensed |
Short | Whether the medication needs a prescription or request to be dispensed |
Control | 0..* |
Type | CodeableConcept |
Guidance on how to interpret the contents of this table can be found here
0. be-model-medicationline | |
Definition | A logical data model of the medication line. |
Short | Medication Line - logical model |
Control | 0..* |
Is Modifier | false |
Logical Model | Instances 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. |
Short | Unique identifier |
Control | 1..* |
Type | Identifier |
4. be-model-medicationline.versionIdentifier | |
Definition | Version of the medication line at the time the content was recorded or last updated. |
Short | Version of the medication line at the time the content was recorded or last updated. |
Control | 1..1 |
Type | string |
Primitive Value | This 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. |
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 |
8. be-model-medicationline.status | |
Definition | Status of the line entry |
Short | Status of the line entry |
Control | 1..1 |
Type | code |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
10. be-model-medicationline.statusReason | |
Definition | Reason for the status |
Short | Reason for the status |
Comments | We consider this is not necessary - should we add? |
Control | 0..1 |
Type | CodeableConcept |
12. be-model-medicationline.assertedDate | |
Definition | Date the medication line was first asserted or known |
Short | Date the medication line was first asserted or known |
Comments | We consider this is not necessary |
Control | 0..1 |
Type | dateTime |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
14. be-model-medicationline.recorder | |
Definition | Recorder |
Short | Recorder |
Comments | We understand this will be updated as the line changes |
Control | 1..1 |
Type | Reference(Practitioner) |
16. be-model-medicationline.patient | |
Definition | Patient |
Short | Patient |
Control | 1..1 |
Type | Reference(Patient) |
18. be-model-medicationline.category | |
Definition | Category for the line |
Short | Category for the line |
Control | 0..1 |
Type | BackboneElement |
Invariants | ele-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. |
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 |
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. |
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 be-model-medicationline.category.extension . The slices areUnordered and Open, and can be differentiated using the following discriminators: |
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). |
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() ) |
26. be-model-medicationline.category.originType | |
Definition | The origin of the line - hospital, ambulatory |
Short | The origin of the line - hospital, ambulatory |
Control | 0..1 |
Type | CodeableConcept |
28. be-model-medicationline.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()) ) |
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. |
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 |
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. |
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 be-model-medicationline.medication.extension . The slices areUnordered and Open, and can be differentiated using the following discriminators: |
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). |
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() ) |
36. be-model-medicationline.medication.product | |
Definition | Product reference, identifier or name |
Short | Product reference, identifier or name |
Control | 1..1 |
Type | Reference(Medicinal Product) |
38. be-model-medicationline.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/medication/ValueSet/medication-type-vs ) |
Type | CodeableConcept |
40. be-model-medicationline.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/medication/ValueSet/medication-exposure-category-vs ) |
Type | CodeableConcept |
42. be-model-medicationline.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()) ) |
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. |
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 |
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. |
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 be-model-medicationline.reason.extension . The slices areUnordered and Open, and can be differentiated using the following discriminators: |
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). |
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() ) |
50. be-model-medicationline.reason.reference | |
Definition | Reference to existing condition or reason |
Short | Reference to existing condition or reason |
Control | 0..1 |
Type | Reference |
52. be-model-medicationline.reason.code | |
Definition | Code of the condition, or free text |
Short | Code of the condition, or free text |
Control | 0..1 |
Type | CodeableConcept |
54. be-model-medicationline.effectivePeriod | |
Definition | Period of medication treatment |
Short | Period 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? |
Control | 1..1 |
Type | BackboneElement |
Invariants | ele-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. |
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 |
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. |
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 be-model-medicationline.effectivePeriod.extension . The slices areUnordered and Open, and can be differentiated using the following discriminators: |
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). |
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() ) |
62. be-model-medicationline.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 |
64. be-model-medicationline.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 |
66. be-model-medicationline.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()) ) |
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. |
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 |
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. |
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 be-model-medicationline.adherence.extension . The slices areUnordered and Open, and can be differentiated using the following discriminators: |
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). |
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() ) |
74. be-model-medicationline.adherence.code | |
Definition | The status - taking, not taking,... |
Short | The status - taking, not taking,... |
Control | 1..1 |
Type | CodeableConcept |
76. be-model-medicationline.adherence.adherenceReason | |
Definition | Reason for the adherence status |
Short | Reason for the adherence status |
Control | 0..1 |
Type | CodeableConcept |
78. be-model-medicationline.dosage | |
Definition | Dosage |
Short | Dosage |
Control | 0..1 |
Type | BackboneElement |
Invariants | ele-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. |
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 |
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. |
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 be-model-medicationline.dosage.extension . The slices areUnordered and Open, and can be differentiated using the following discriminators: |
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). |
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() ) |
86. be-model-medicationline.dosage.dosageDetails | |
Definition | Structure Dosage |
Short | Structure Dosage |
Control | 0..1 |
Type | Dosage |
88. be-model-medicationline.dosage.dosageOverride | |
Definition | Dosage Override |
Short | Dosage Override |
Comments | should these be extensions on dosage or on the line? |
Control | 0..1 |
Type | boolean |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
90. be-model-medicationline.dosage.dosageOverrideReason | |
Definition | Dosage Override reason |
Short | Dosage Override reason |
Comments | should these be extensions on dosage or on the line? |
Control | 1..1 |
Type | CodeableConcept |
92. be-model-medicationline.note | |
Definition | A note captured by a professional |
Short | A note captured by a professional |
Control | 0..* |
Type | Annotation |
94. be-model-medicationline.dispenseRequestNeeded | |
Definition | Whether the medication needs a prescription or request to be dispensed |
Short | Whether the medication needs a prescription or request to be dispensed |
Control | 0..* |
Type | CodeableConcept |