| Package | hl7.fhir.be.medication |
| Resource Type | StructureDefinition |
| Id | BeModelMedicationLine |
| FHIR Version | R4 |
| Source | https://www.ehealth.fgov.be/standards/fhir/medication/https://build.fhir.org/ig/hl7-be/medication/StructureDefinition-BeModelMedicationLine.html |
| URL | https://www.ehealth.fgov.be/standards/fhir/medication/StructureDefinition/BeModelMedicationLine |
| Version | 1.1.0 |
| Status | draft |
| Date | 2025-07-25T19:42:33+00:00 |
| Name | MedicationLine |
| Title | Medication Line (model) |
| Realm | be |
| Authority | hl7 |
| Description | Logical data model for medication line. |
| Type | https://www.ehealth.fgov.be/standards/fhir/medication/StructureDefinition/BeModelMedicationLine |
| Kind | logical |
| StructureDefinition | |
| BeModelMedicationDispense | Medication Dispense (model) |
| BeModelMedicationPrescription | Medication prescription (model) |
| StructureDefinition | |
| BeModelDosagingInformation | Dosaging (model) |
| BeModelMedication | Medication (model) |
| be-patient | BePatient |
| be-practitioner | BePractitioner |
| ValueSet | |
| BeMedicationExposureIntentVS | Medication exposure intent |
| BeMedicationLineAdherenceStatusReasonVS | Adherence Status Reason ValueSet |
| BeMedicationLineAdherenceStatusVS | BeExtAdherenceStatus |
| BeMedicationLineOriginTypeVS | Medication origin type value set |
| BeMedicationTypeVS | Medication preparation Type value set |
Note: links and images are rebased to the (stated) source
Generated Narrative: StructureDefinition BeModelMedicationLine
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
  BeModelMedicationLine | 0..* | Base | Medication Line (model) Instances of this logical model can be the target of a Reference | |
  identifier | 1..* | Identifier | Unique identifier | |
 recordedDate | 1..1 | dateTime | Timestamp the medication line content was recorded or last updated. | |
 recorder | 1..1 | Reference(BePractitioner) | Recorder | |
| patient | 1..1 | Reference(BePatient) | Patient | |
| status | 1..1 | code | Status of the line entry Binding Description: (preferred): Draft, Recorded, or Entered in Error | |
| adherence | 0..1 | BackboneElement | Whether the patient is known to be taking the medication | |
 status | 1..1 | CodeableConcept | The status - taking, not taking,... Binding: BeExtAdherenceStatus (required) | |
 adherenceStatusReason | 0..1 | CodeableConcept | Reason for the adherence status Binding: Adherence Status Reason ValueSet (example) | |
| medication | 1..1 | BackboneElement | The product or substance | |
| product | 1..1 | Reference(Medication (model)) | Product reference, identifier or name | |
| type | 1..1 | CodeableConcept | Type of medication - magistral, medicinal product, non-medicinal product Binding: Medication preparation Type value set (required) | |
| reason | 0..* | BackboneElement | Reason for the medication treatment | |
| reference | 0..1 | Reference() | Reference to existing condition or reason | |
| code | 0..1 | CodeableConcept | Code of the condition, or free text | |
| effectivePeriod | 1..1 | BackboneElement | Period of medication treatment | |
| start | 1..1 | dateTime | The begin of the medication line | |
| end | 0..1 | dateTime | The end of the medication line | |
 dosage | 0..* | BeModelDosagingInformation | Structured Dosage | |
| offLabel | 0..1 | string | Reason for Off-label use or dosage override | |
| exposure | 0..1 | CodeableConcept | Therapeutic, Prophylactic Binding: Medication exposure intent (required) | |
| originType | 0..1 | CodeableConcept | The origin of the line - hospital, ambulatory Binding: Medication origin type value set (required) | |
| note | 0..* | Annotation | A note captured by a professional | |
| Documentation for this format | ||||
FHIR{
"resourceType": "StructureDefinition",
"id": "BeModelMedicationLine",
"text": {
"status": "extensions",
"div": "<!-- snip (see above) -->"
},
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-type-characteristics",
"valueCode": "can-be-target"
}
],
"url": "https://www.ehealth.fgov.be/standards/fhir/medication/StructureDefinition/BeModelMedicationLine",
"version": "1.1.0",
"name": "MedicationLine",
"title": "Medication Line (model)",
"status": "draft",
"date": "2025-07-25T19:42:33+00:00",
"publisher": "HL7 Belgium",
"contact": [
{
"name": "HL7 Belgium",
"telecom": [
{
"system": "url",
"value": "https://www.hl7belgium.org"
},
{
"system": "email",
"value": "hl7belgium@hl7belgium.org"
}
]
},
{
"name": "Message Structure eHealth",
"telecom": [
{
"system": "email",
"value": "message-structure@ehealth.fgov.be",
"use": "work"
}
]
}
],
"description": "Logical data model for medication line.",
"jurisdiction": [
{
"coding": [
{
"system": "urn:iso:std:iso:3166",
"code": "BE",
"display": "Belgium"
}
]
}
],
"fhirVersion": "4.0.1",
"kind": "logical",
"abstract": false,
"type": "https://www.ehealth.fgov.be/standards/fhir/medication/StructureDefinition/BeModelMedicationLine",
"baseDefinition": "http://hl7.org/fhir/StructureDefinition/Base",
"derivation": "specialization",
"snapshot": {
"extension": [
{
"url": "http://hl7.org/fhir/tools/StructureDefinition/snapshot-base-version",
"valueString": "4.0.1"
}
],
"element": [
{
"id": "BeModelMedicationLine",
"path": "BeModelMedicationLine",
"short": "Medication Line (model)",
"definition": "Logical data model for medication line.",
"min": 0,
"max": "*",
"base": {
"path": "Base",
"min": 0,
"max": "*"
},
"isModifier": false
},
{
"id": "BeModelMedicationLine.identifier",
"path": "BeModelMedicationLine.identifier",
"short": "Unique identifier",
"definition": "A unique identifier for the medication line. This identifier alone may be the same for different versions of the medication line.",
"min": 1,
"max": "*",
"base": {
"path": "BeModelMedicationLine.identifier",
"min": 1,
"max": "*"
},
"type": [
{
"code": "Identifier"
}
]
},
{
"id": "BeModelMedicationLine.recordedDate",
"path": "BeModelMedicationLine.recordedDate",
"short": "Timestamp the medication line content was recorded or last updated.",
"definition": "Timestamp the medication line content was recorded or last updated.",
"comment": " We consider this is redundant with the above, given the intended use in Belgium (version is a date). How to ensure the compatibility?",
"min": 1,
"max": "1",
"base": {
"path": "BeModelMedicationLine.recordedDate",
"min": 1,
"max": "1"
},
"type": [
{
"code": "dateTime"
}
]
},
{
"id": "BeModelMedicationLine.recorder",
"path": "BeModelMedicationLine.recorder",
"short": "Recorder",
"definition": "Recorder",
"comment": "We understand this will be updated as the line changes",
"min": 1,
"max": "1",
"base": {
"path": "BeModelMedicationLine.recorder",
"min": 1,
"max": "1"
},
"type": [
{
"code": "Reference",
"targetProfile": [
"https://www.ehealth.fgov.be/standards/fhir/core/StructureDefinition/be-practitioner"
]
}
]
},
{
"id": "BeModelMedicationLine.patient",
"path": "BeModelMedicationLine.patient",
"short": "Patient",
"definition": "Patient",
"min": 1,
"max": "1",
"base": {
"path": "BeModelMedicationLine.patient",
"min": 1,
"max": "1"
},
"type": [
{
"code": "Reference",
"targetProfile": [
"https://www.ehealth.fgov.be/standards/fhir/core/StructureDefinition/be-patient"
]
}
]
},
{
"id": "BeModelMedicationLine.status",
"path": "BeModelMedicationLine.status",
"short": "Status of the line entry",
"definition": "Status of the line entry",
"min": 1,
"max": "1",
"base": {
"path": "BeModelMedicationLine.status",
"min": 1,
"max": "1"
},
"type": [
{
"code": "code"
}
],
"binding": {
"strength": "preferred",
"description": "`Draft`, `Recorded`, or `Entered in Error`"
}
},
{
"id": "BeModelMedicationLine.adherence",
"path": "BeModelMedicationLine.adherence",
"short": "Whether the patient is known to be taking the medication",
"definition": "Whether the patient is known to be taking the medication",
"min": 0,
"max": "1",
"base": {
"path": "BeModelMedicationLine.adherence",
"min": 0,
"max": "1"
},
"type": [
{
"code": "BackboneElement"
}
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
}
]
},
{
"id": "BeModelMedicationLine.adherence.id",
"path": "BeModelMedicationLine.adherence.id",
"representation": [
"xmlAttr"
],
"short": "Unique id for inter-element referencing",
"definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"min": 0,
"max": "1",
"base": {
"path": "Element.id",
"min": 0,
"max": "1"
},
"type": [
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
"valueUrl": "string"
}
],
"code": "http://hl7.org/fhirpath/System.String"
}
],
"isModifier": false,
"isSummary": false,
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"id": "BeModelMedicationLine.adherence.extension",
"path": "BeModelMedicationLine.adherence.extension",
"slicing": {
"discriminator": [
{
"type": "value",
"path": "url"
}
],
"description": "Extensions are always sliced by (at least) url",
"rules": "open"
},
"short": "Additional content defined by implementations",
"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.",
"comment": "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.",
"alias": [
"extensions",
"user content"
],
"min": 0,
"max": "*",
"base": {
"path": "Element.extension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension"
}
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key": "ext-1",
"severity": "error",
"human": "Must have either extensions or value[x], not both",
"expression": "extension.exists() != value.exists()",
"xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source": "http://hl7.org/fhir/StructureDefinition/Extension"
}
],
"isModifier": false,
"isSummary": false,
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"id": "BeModelMedicationLine.adherence.modifierExtension",
"path": "BeModelMedicationLine.adherence.modifierExtension",
"short": "Extensions that cannot be ignored even if unrecognized",
"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.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"comment": "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.",
"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](http://hl7.org/fhir/R4/extensibility.html#modifierExtension).",
"alias": [
"extensions",
"user content",
"modifiers"
],
"min": 0,
"max": "*",
"base": {
"path": "BackboneElement.modifierExtension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension"
}
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key": "ext-1",
"severity": "error",
"human": "Must have either extensions or value[x], not both",
"expression": "extension.exists() != value.exists()",
"xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source": "http://hl7.org/fhir/StructureDefinition/Extension"
}
],
"isModifier": true,
"isModifierReason": "Modifier extensions are expected to modify the meaning or interpretation of the element that contains them",
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"id": "BeModelMedicationLine.adherence.status",
"path": "BeModelMedicationLine.adherence.status",
"short": "The status - taking, not taking,...",
"definition": "The status - taking, not taking,...",
"min": 1,
"max": "1",
"base": {
"path": "BeModelMedicationLine.adherence.status",
"min": 1,
"max": "1"
},
"type": [
{
"code": "CodeableConcept"
}
],
"binding": {
"strength": "required",
"valueSet": "https://www.ehealth.fgov.be/standards/fhir/terminology/ValueSet/BeMedicationLineAdherenceStatusVS"
}
},
{
"id": "BeModelMedicationLine.adherence.adherenceStatusReason",
"path": "BeModelMedicationLine.adherence.adherenceStatusReason",
"short": "Reason for the adherence status",
"definition": "Reason for the adherence status",
"comment": "The value set provided is an indicative example",
"min": 0,
"max": "1",
"base": {
"path": "BeModelMedicationLine.adherence.adherenceStatusReason",
"min": 0,
"max": "1"
},
"type": [
{
"code": "CodeableConcept"
}
],
"binding": {
"strength": "example",
"valueSet": "https://www.ehealth.fgov.be/standards/fhir/terminology/ValueSet/BeMedicationLineAdherenceStatusReasonVS"
}
},
{
"id": "BeModelMedicationLine.medication",
"path": "BeModelMedicationLine.medication",
"short": "The product or substance",
"definition": "The product or substance",
"min": 1,
"max": "1",
"base": {
"path": "BeModelMedicationLine.medication",
"min": 1,
"max": "1"
},
"type": [
{
"code": "BackboneElement"
}
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
}
]
},
{
"id": "BeModelMedicationLine.medication.id",
"path": "BeModelMedicationLine.medication.id",
"representation": [
"xmlAttr"
],
"short": "Unique id for inter-element referencing",
"definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"min": 0,
"max": "1",
"base": {
"path": "Element.id",
"min": 0,
"max": "1"
},
"type": [
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
"valueUrl": "string"
}
],
"code": "http://hl7.org/fhirpath/System.String"
}
],
"isModifier": false,
"isSummary": false,
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"id": "BeModelMedicationLine.medication.extension",
"path": "BeModelMedicationLine.medication.extension",
"slicing": {
"discriminator": [
{
"type": "value",
"path": "url"
}
],
"description": "Extensions are always sliced by (at least) url",
"rules": "open"
},
"short": "Additional content defined by implementations",
"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.",
"comment": "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.",
"alias": [
"extensions",
"user content"
],
"min": 0,
"max": "*",
"base": {
"path": "Element.extension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension"
}
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key": "ext-1",
"severity": "error",
"human": "Must have either extensions or value[x], not both",
"expression": "extension.exists() != value.exists()",
"xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source": "http://hl7.org/fhir/StructureDefinition/Extension"
}
],
"isModifier": false,
"isSummary": false,
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"id": "BeModelMedicationLine.medication.modifierExtension",
"path": "BeModelMedicationLine.medication.modifierExtension",
"short": "Extensions that cannot be ignored even if unrecognized",
"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.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"comment": "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.",
"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](http://hl7.org/fhir/R4/extensibility.html#modifierExtension).",
"alias": [
"extensions",
"user content",
"modifiers"
],
"min": 0,
"max": "*",
"base": {
"path": "BackboneElement.modifierExtension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension"
}
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key": "ext-1",
"severity": "error",
"human": "Must have either extensions or value[x], not both",
"expression": "extension.exists() != value.exists()",
"xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source": "http://hl7.org/fhir/StructureDefinition/Extension"
}
],
"isModifier": true,
"isModifierReason": "Modifier extensions are expected to modify the meaning or interpretation of the element that contains them",
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"id": "BeModelMedicationLine.medication.product",
"path": "BeModelMedicationLine.medication.product",
"short": "Product reference, identifier or name",
"definition": "Product reference, identifier or name",
"min": 1,
"max": "1",
"base": {
"path": "BeModelMedicationLine.medication.product",
"min": 1,
"max": "1"
},
"type": [
{
"code": "Reference",
"targetProfile": [
"https://www.ehealth.fgov.be/standards/fhir/medication/StructureDefinition/BeModelMedication"
]
}
]
},
{
"id": "BeModelMedicationLine.medication.type",
"path": "BeModelMedicationLine.medication.type",
"short": "Type of medication - magistral, medicinal product, non-medicinal product",
"definition": "Type of medication - magistral, medicinal product, non-medicinal product",
"min": 1,
"max": "1",
"base": {
"path": "BeModelMedicationLine.medication.type",
"min": 1,
"max": "1"
},
"type": [
{
"code": "CodeableConcept"
}
],
"binding": {
"strength": "required",
"valueSet": "https://www.ehealth.fgov.be/standards/fhir/terminology/ValueSet/BeMedicationTypeVS"
}
},
{
"id": "BeModelMedicationLine.reason",
"path": "BeModelMedicationLine.reason",
"short": "Reason for the medication treatment",
"definition": "Reason for the medication treatment",
"min": 0,
"max": "*",
"base": {
"path": "BeModelMedicationLine.reason",
"min": 0,
"max": "*"
},
"type": [
{
"code": "BackboneElement"
}
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
}
]
},
{
"id": "BeModelMedicationLine.reason.id",
"path": "BeModelMedicationLine.reason.id",
"representation": [
"xmlAttr"
],
"short": "Unique id for inter-element referencing",
"definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"min": 0,
"max": "1",
"base": {
"path": "Element.id",
"min": 0,
"max": "1"
},
"type": [
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
"valueUrl": "string"
}
],
"code": "http://hl7.org/fhirpath/System.String"
}
],
"isModifier": false,
"isSummary": false,
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"id": "BeModelMedicationLine.reason.extension",
"path": "BeModelMedicationLine.reason.extension",
"slicing": {
"discriminator": [
{
"type": "value",
"path": "url"
}
],
"description": "Extensions are always sliced by (at least) url",
"rules": "open"
},
"short": "Additional content defined by implementations",
"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.",
"comment": "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.",
"alias": [
"extensions",
"user content"
],
"min": 0,
"max": "*",
"base": {
"path": "Element.extension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension"
}
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key": "ext-1",
"severity": "error",
"human": "Must have either extensions or value[x], not both",
"expression": "extension.exists() != value.exists()",
"xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source": "http://hl7.org/fhir/StructureDefinition/Extension"
}
],
"isModifier": false,
"isSummary": false,
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"id": "BeModelMedicationLine.reason.modifierExtension",
"path": "BeModelMedicationLine.reason.modifierExtension",
"short": "Extensions that cannot be ignored even if unrecognized",
"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.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"comment": "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.",
"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](http://hl7.org/fhir/R4/extensibility.html#modifierExtension).",
"alias": [
"extensions",
"user content",
"modifiers"
],
"min": 0,
"max": "*",
"base": {
"path": "BackboneElement.modifierExtension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension"
}
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key": "ext-1",
"severity": "error",
"human": "Must have either extensions or value[x], not both",
"expression": "extension.exists() != value.exists()",
"xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source": "http://hl7.org/fhir/StructureDefinition/Extension"
}
],
"isModifier": true,
"isModifierReason": "Modifier extensions are expected to modify the meaning or interpretation of the element that contains them",
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"id": "BeModelMedicationLine.reason.reference",
"path": "BeModelMedicationLine.reason.reference",
"short": "Reference to existing condition or reason",
"definition": "Reference to existing condition or reason",
"min": 0,
"max": "1",
"base": {
"path": "BeModelMedicationLine.reason.reference",
"min": 0,
"max": "1"
},
"type": [
{
"code": "Reference"
}
]
},
{
"id": "BeModelMedicationLine.reason.code",
"path": "BeModelMedicationLine.reason.code",
"short": "Code of the condition, or free text",
"definition": "Code of the condition, or free text",
"min": 0,
"max": "1",
"base": {
"path": "BeModelMedicationLine.reason.code",
"min": 0,
"max": "1"
},
"type": [
{
"code": "CodeableConcept"
}
]
},
{
"id": "BeModelMedicationLine.effectivePeriod",
"path": "BeModelMedicationLine.effectivePeriod",
"short": "Period of medication treatment",
"definition": "Period of medication treatment",
"min": 1,
"max": "1",
"base": {
"path": "BeModelMedicationLine.effectivePeriod",
"min": 1,
"max": "1"
},
"type": [
{
"code": "BackboneElement"
}
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
}
]
},
{
"id": "BeModelMedicationLine.effectivePeriod.id",
"path": "BeModelMedicationLine.effectivePeriod.id",
"representation": [
"xmlAttr"
],
"short": "Unique id for inter-element referencing",
"definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"min": 0,
"max": "1",
"base": {
"path": "Element.id",
"min": 0,
"max": "1"
},
"type": [
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
"valueUrl": "string"
}
],
"code": "http://hl7.org/fhirpath/System.String"
}
],
"isModifier": false,
"isSummary": false,
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"id": "BeModelMedicationLine.effectivePeriod.extension",
"path": "BeModelMedicationLine.effectivePeriod.extension",
"slicing": {
"discriminator": [
{
"type": "value",
"path": "url"
}
],
"description": "Extensions are always sliced by (at least) url",
"rules": "open"
},
"short": "Additional content defined by implementations",
"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.",
"comment": "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.",
"alias": [
"extensions",
"user content"
],
"min": 0,
"max": "*",
"base": {
"path": "Element.extension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension"
}
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key": "ext-1",
"severity": "error",
"human": "Must have either extensions or value[x], not both",
"expression": "extension.exists() != value.exists()",
"xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source": "http://hl7.org/fhir/StructureDefinition/Extension"
}
],
"isModifier": false,
"isSummary": false,
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"id": "BeModelMedicationLine.effectivePeriod.modifierExtension",
"path": "BeModelMedicationLine.effectivePeriod.modifierExtension",
"short": "Extensions that cannot be ignored even if unrecognized",
"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.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"comment": "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.",
"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](http://hl7.org/fhir/R4/extensibility.html#modifierExtension).",
"alias": [
"extensions",
"user content",
"modifiers"
],
"min": 0,
"max": "*",
"base": {
"path": "BackboneElement.modifierExtension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension"
}
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key": "ext-1",
"severity": "error",
"human": "Must have either extensions or value[x], not both",
"expression": "extension.exists() != value.exists()",
"xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source": "http://hl7.org/fhir/StructureDefinition/Extension"
}
],
"isModifier": true,
"isModifierReason": "Modifier extensions are expected to modify the meaning or interpretation of the element that contains them",
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"id": "BeModelMedicationLine.effectivePeriod.start",
"path": "BeModelMedicationLine.effectivePeriod.start",
"short": "The begin of the medication line",
"definition": "The begin of the medication line",
"min": 1,
"max": "1",
"base": {
"path": "BeModelMedicationLine.effectivePeriod.start",
"min": 1,
"max": "1"
},
"type": [
{
"code": "dateTime"
}
]
},
{
"id": "BeModelMedicationLine.effectivePeriod.end",
"path": "BeModelMedicationLine.effectivePeriod.end",
"short": "The end of the medication line",
"definition": "The end of the medication line",
"min": 0,
"max": "1",
"base": {
"path": "BeModelMedicationLine.effectivePeriod.end",
"min": 0,
"max": "1"
},
"type": [
{
"code": "dateTime"
}
]
},
{
"id": "BeModelMedicationLine.dosage",
"path": "BeModelMedicationLine.dosage",
"short": "Structured Dosage",
"definition": "Structured Dosage",
"min": 0,
"max": "*",
"base": {
"path": "BeModelMedicationLine.dosage",
"min": 0,
"max": "*"
},
"type": [
{
"code": "https://www.ehealth.fgov.be/standards/fhir/medication/StructureDefinition/BeModelDosagingInformation"
}
]
},
{
"id": "BeModelMedicationLine.offLabel",
"path": "BeModelMedicationLine.offLabel",
"short": "Reason for Off-label use or dosage override",
"definition": "Reason for Off-label use or dosage override",
"comment": "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.",
"min": 0,
"max": "1",
"base": {
"path": "BeModelMedicationLine.offLabel",
"min": 0,
"max": "1"
},
"type": [
{
"code": "string"
}
]
},
{
"id": "BeModelMedicationLine.exposure",
"path": "BeModelMedicationLine.exposure",
"short": "Therapeutic, Prophylactic",
"definition": "Therapeutic, Prophylactic",
"min": 0,
"max": "1",
"base": {
"path": "BeModelMedicationLine.exposure",
"min": 0,
"max": "1"
},
"type": [
{
"code": "CodeableConcept"
}
],
"binding": {
"strength": "required",
"valueSet": "https://www.ehealth.fgov.be/standards/fhir/terminology/ValueSet/BeMedicationExposureIntentVS"
}
},
{
"id": "BeModelMedicationLine.originType",
"path": "BeModelMedicationLine.originType",
"short": "The origin of the line - hospital, ambulatory",
"definition": "The origin of the line - hospital, ambulatory",
"min": 0,
"max": "1",
"base": {
"path": "BeModelMedicationLine.originType",
"min": 0,
"max": "1"
},
"type": [
{
"code": "CodeableConcept"
}
],
"binding": {
"strength": "required",
"valueSet": "https://www.ehealth.fgov.be/standards/fhir/terminology/ValueSet/BeMedicationLineOriginTypeVS"
}
},
{
"id": "BeModelMedicationLine.note",
"path": "BeModelMedicationLine.note",
"short": "A note captured by a professional",
"definition": "A note captured by a professional",
"min": 0,
"max": "*",
"base": {
"path": "BeModelMedicationLine.note",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Annotation"
}
]
}
]
},
"differential": {
"element": [
{
"id": "BeModelMedicationLine",
"path": "BeModelMedicationLine",
"short": "Medication Line (model)",
"definition": "Logical data model for medication line."
},
{
"id": "BeModelMedicationLine.identifier",
"path": "BeModelMedicationLine.identifier",
"short": "Unique identifier",
"definition": "A unique identifier for the medication line. This identifier alone may be the same for different versions of the medication line.",
"min": 1,
"max": "*",
"type": [
{
"code": "Identifier"
}
]
},
{
"id": "BeModelMedicationLine.recordedDate",
"path": "BeModelMedicationLine.recordedDate",
"short": "Timestamp the medication line content was recorded or last updated.",
"definition": "Timestamp the medication line content was recorded or last updated.",
"comment": " We consider this is redundant with the above, given the intended use in Belgium (version is a date). How to ensure the compatibility?",
"min": 1,
"max": "1",
"type": [
{
"code": "dateTime"
}
]
},
{
"id": "BeModelMedicationLine.recorder",
"path": "BeModelMedicationLine.recorder",
"short": "Recorder",
"definition": "Recorder",
"comment": "We understand this will be updated as the line changes",
"min": 1,
"max": "1",
"type": [
{
"code": "Reference",
"targetProfile": [
"https://www.ehealth.fgov.be/standards/fhir/core/StructureDefinition/be-practitioner"
]
}
]
},
{
"id": "BeModelMedicationLine.patient",
"path": "BeModelMedicationLine.patient",
"short": "Patient",
"definition": "Patient",
"min": 1,
"max": "1",
"type": [
{
"code": "Reference",
"targetProfile": [
"https://www.ehealth.fgov.be/standards/fhir/core/StructureDefinition/be-patient"
]
}
]
},
{
"id": "BeModelMedicationLine.status",
"path": "BeModelMedicationLine.status",
"short": "Status of the line entry",
"definition": "Status of the line entry",
"min": 1,
"max": "1",
"type": [
{
"code": "code"
}
],
"binding": {
"strength": "preferred",
"description": "`Draft`, `Recorded`, or `Entered in Error`"
}
},
{
"id": "BeModelMedicationLine.adherence",
"path": "BeModelMedicationLine.adherence",
"short": "Whether the patient is known to be taking the medication",
"definition": "Whether the patient is known to be taking the medication",
"min": 0,
"max": "1",
"type": [
{
"code": "BackboneElement"
}
]
},
{
"id": "BeModelMedicationLine.adherence.status",
"path": "BeModelMedicationLine.adherence.status",
"short": "The status - taking, not taking,...",
"definition": "The status - taking, not taking,...",
"min": 1,
"max": "1",
"type": [
{
"code": "CodeableConcept"
}
],
"binding": {
"strength": "required",
"valueSet": "https://www.ehealth.fgov.be/standards/fhir/terminology/ValueSet/BeMedicationLineAdherenceStatusVS"
}
},
{
"id": "BeModelMedicationLine.adherence.adherenceStatusReason",
"path": "BeModelMedicationLine.adherence.adherenceStatusReason",
"short": "Reason for the adherence status",
"definition": "Reason for the adherence status",
"comment": "The value set provided is an indicative example",
"min": 0,
"max": "1",
"type": [
{
"code": "CodeableConcept"
}
],
"binding": {
"strength": "example",
"valueSet": "https://www.ehealth.fgov.be/standards/fhir/terminology/ValueSet/BeMedicationLineAdherenceStatusReasonVS"
}
},
{
"id": "BeModelMedicationLine.medication",
"path": "BeModelMedicationLine.medication",
"short": "The product or substance",
"definition": "The product or substance",
"min": 1,
"max": "1",
"type": [
{
"code": "BackboneElement"
}
]
},
{
"id": "BeModelMedicationLine.medication.product",
"path": "BeModelMedicationLine.medication.product",
"short": "Product reference, identifier or name",
"definition": "Product reference, identifier or name",
"min": 1,
"max": "1",
"type": [
{
"code": "Reference",
"targetProfile": [
"https://www.ehealth.fgov.be/standards/fhir/medication/StructureDefinition/BeModelMedication"
]
}
]
},
{
"id": "BeModelMedicationLine.medication.type",
"path": "BeModelMedicationLine.medication.type",
"short": "Type of medication - magistral, medicinal product, non-medicinal product",
"definition": "Type of medication - magistral, medicinal product, non-medicinal product",
"min": 1,
"max": "1",
"type": [
{
"code": "CodeableConcept"
}
],
"binding": {
"strength": "required",
"valueSet": "https://www.ehealth.fgov.be/standards/fhir/terminology/ValueSet/BeMedicationTypeVS"
}
},
{
"id": "BeModelMedicationLine.reason",
"path": "BeModelMedicationLine.reason",
"short": "Reason for the medication treatment",
"definition": "Reason for the medication treatment",
"min": 0,
"max": "*",
"type": [
{
"code": "BackboneElement"
}
]
},
{
"id": "BeModelMedicationLine.reason.reference",
"path": "BeModelMedicationLine.reason.reference",
"short": "Reference to existing condition or reason",
"definition": "Reference to existing condition or reason",
"min": 0,
"max": "1",
"type": [
{
"code": "Reference"
}
]
},
{
"id": "BeModelMedicationLine.reason.code",
"path": "BeModelMedicationLine.reason.code",
"short": "Code of the condition, or free text",
"definition": "Code of the condition, or free text",
"min": 0,
"max": "1",
"type": [
{
"code": "CodeableConcept"
}
]
},
{
"id": "BeModelMedicationLine.effectivePeriod",
"path": "BeModelMedicationLine.effectivePeriod",
"short": "Period of medication treatment",
"definition": "Period of medication treatment",
"min": 1,
"max": "1",
"type": [
{
"code": "BackboneElement"
}
]
},
{
"id": "BeModelMedicationLine.effectivePeriod.start",
"path": "BeModelMedicationLine.effectivePeriod.start",
"short": "The begin of the medication line",
"definition": "The begin of the medication line",
"min": 1,
"max": "1",
"type": [
{
"code": "dateTime"
}
]
},
{
"id": "BeModelMedicationLine.effectivePeriod.end",
"path": "BeModelMedicationLine.effectivePeriod.end",
"short": "The end of the medication line",
"definition": "The end of the medication line",
"min": 0,
"max": "1",
"type": [
{
"code": "dateTime"
}
]
},
{
"id": "BeModelMedicationLine.dosage",
"path": "BeModelMedicationLine.dosage",
"short": "Structured Dosage",
"definition": "Structured Dosage",
"min": 0,
"max": "*",
"type": [
{
"code": "https://www.ehealth.fgov.be/standards/fhir/medication/StructureDefinition/BeModelDosagingInformation"
}
]
},
{
"id": "BeModelMedicationLine.offLabel",
"path": "BeModelMedicationLine.offLabel",
"short": "Reason for Off-label use or dosage override",
"definition": "Reason for Off-label use or dosage override",
"comment": "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.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
]
},
{
"id": "BeModelMedicationLine.exposure",
"path": "BeModelMedicationLine.exposure",
"short": "Therapeutic, Prophylactic",
"definition": "Therapeutic, Prophylactic",
"min": 0,
"max": "1",
"type": [
{
"code": "CodeableConcept"
}
],
"binding": {
"strength": "required",
"valueSet": "https://www.ehealth.fgov.be/standards/fhir/terminology/ValueSet/BeMedicationExposureIntentVS"
}
},
{
"id": "BeModelMedicationLine.originType",
"path": "BeModelMedicationLine.originType",
"short": "The origin of the line - hospital, ambulatory",
"definition": "The origin of the line - hospital, ambulatory",
"min": 0,
"max": "1",
"type": [
{
"code": "CodeableConcept"
}
],
"binding": {
"strength": "required",
"valueSet": "https://www.ehealth.fgov.be/standards/fhir/terminology/ValueSet/BeMedicationLineOriginTypeVS"
}
},
{
"id": "BeModelMedicationLine.note",
"path": "BeModelMedicationLine.note",
"short": "A note captured by a professional",
"definition": "A note captured by a professional",
"min": 0,
"max": "*",
"type": [
{
"code": "Annotation"
}
]
}
]
}
}