Medication
1.1.0 - STU Belgium flag

This page is part of the HL7 BE Medication IG (v1.1.0: Release) based on FHIR (HL7® FHIR® Standard) R4. This is the current published version. For a full list of available versions, see the Directory of published versions

Resource Profile: BeMedicationPrescription

Official URL: https://www.ehealth.fgov.be/standards/fhir/medication/StructureDefinition/BeMedicationPrescription Version: 1.1.0
Active as of 2025-10-10 Computable Name: BeMedicationPrescription

Medication Request profile - The common structure for medication request

Usages:

  • This Profile is not used by any profiles in this Implementation Guide

You can also check for usages in the FHIR IG Statistics

Formal Views of Profile Content

Description of Profiles, Differentials, Snapshots and how the different presentations work.

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. MedicationRequest C 0..* MedicationRequest Ordering of medication for patient or group
Constraints: dosage-override-reason-required
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:offLabel SC 0..1 (Complex) MedicationRequest - Off-label use
URL: https://www.ehealth.fgov.be/standards/fhir/medication/StructureDefinition/BeExtOffLabel
Constraints: offLabel-reason-required
..... Slices for extension 1..* Extension Extension
Slice: Unordered, Open by value:url
...... extension:isOffLabelUse 1..1 Extension Indicates that the recommended dosage was overridden
....... extension 0..0
....... url 1..1 uri "isOffLabelUse"
...... extension:reason 0..* Extension The reason why the recommended dosage was overridden
....... extension 0..0
....... url 1..1 uri "reason"
..... url 1..1 uri "https://www.ehealth.fgov.be/standards/fhir/medication/StructureDefinition/BeExtOffLabel"
.... extension:basedOnMedicationLine S 0..1 Reference(BeMedicationLine) Medication Line where this prescription is based upon
URL: https://www.ehealth.fgov.be/standards/fhir/medication/StructureDefinition/BasedOnMedicationLine
.... extension:instructionsForReimbursement S 0..1 CodeableConcept Instructions for reimbursement
URL: https://www.ehealth.fgov.be/standards/fhir/medication/StructureDefinition/BeExtInstructionsForReimbursement
Binding: Medication request reimbursement type ValueSet (required)
.... extension:statusChanged S 0..1 dateTime Indicates when the status of the medication request was last changed.
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-MedicationRequest.statusChanged
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
.... identifier:recip-e S 0..1 Identifier Recip-E identifier
..... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
..... system Σ 1..1 uri The namespace for the identifier value
Required Pattern: http://ehealth.fgov.be/standards/fhir/medication/NamingSystem/be-ns-prescription
..... value SΣ 0..1 string The value that is unique
Example General: 123456
... status ?!SΣ 1..1 code active | on-hold | cancelled | completed | entered-in-error | stopped | draft | unknown
Binding: Medication Prescription Status (required)
... statusReason S 0..1 CodeableConcept Reason for current status
Binding: medicationRequest Status Reason Codes (example): Identifies the reasons for a given status.
... intent ?!SΣ 1..1 code proposal | plan | order | original-order | reflex-order | filler-order | instance-order | option
Binding: medicationRequest Intent (required): The kind of medication order.
... priority SΣ 0..1 code routine | urgent | asap | stat
Binding: RequestPriority (required): Identifies the level of importance to be assigned to actioning the request.
... doNotPerform ?!Σ 0..1 boolean True if request is prohibiting action
... medication[x] SΣ 1..1 Medication to be taken
Binding: SNOMEDCTMedicationCodes (example): A coded concept identifying substance or product that can be ordered.
.... medicationCodeableConcept CodeableConcept
.... medicationReference Reference(Medication)
... subject SΣ 1..1 Reference(BePatient) Who or group medication request is for
... supportingInformation S 0..* Reference(Resource) Information to support ordering of the medication
... authoredOn SΣ 1..1 dateTime When request was initially authored
... requester SΣ 1..1 Reference(BePractitioner | BePractitionerRole) Who/What requested the Request
... reasonCode S 0..* CodeableConcept Reason or indication for ordering or not ordering the medication
Binding: Condition/Problem/DiagnosisCodes (example): A coded concept indicating why the medication was ordered.
... reasonReference S 0..* Reference(Condition | Observation) Condition or observation that supports why the prescription is being written
... groupIdentifier SΣ 0..1 Identifier Composite request this is part of
... note S 0..* Annotation Information about the prescription
... dosageInstruction S 1..* BeDosage How the medication should be taken
... dispenseRequest S 0..1 BackboneElement Medication supply authorization
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... validityPeriod S 0..1 Period Time period supply is authorized for
..... start SΣC 1..1 dateTime Starting time with inclusive boundary
..... end SΣC 0..1 dateTime End time with inclusive boundary, if not ongoing
.... numberOfRepeatsAllowed S 0..1 unsignedInt Number of refills authorized
.... quantity S 0..1 SimpleQuantity(4.0.1) Amount of medication to supply per dispense
... substitution S 0..1 BackboneElement Any restrictions on medication substitution
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... allowed[x] S 1..1 boolean Whether substitution is allowed or not

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
MedicationRequest.identifier:recip-e.​use Base required IdentifierUse 📍4.0.1 FHIR Std.
MedicationRequest.status Base required Medication Prescription Status 📦1.1.0 This IG
MedicationRequest.statusReason Base example Medication request status reason codes 📍4.0.1 FHIR Std.
MedicationRequest.intent Base required Medication request intent 📍4.0.1 FHIR Std.
MedicationRequest.priority Base required Request priority 📍4.0.1 FHIR Std.
MedicationRequest.medication[x] Base example SNOMED CT Medication Codes 📍4.0.1 FHIR Std.
MedicationRequest.reasonCode Base example Condition/Problem/Diagnosis Codes 📍4.0.1 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
dom-2 error MedicationRequest If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error MedicationRequest If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4 error MedicationRequest If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5 error MedicationRequest If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice MedicationRequest A resource should have narrative for robust management text.`div`.exists()
dosage-override-reason-required error MedicationRequest If isOffLabelUse is true, reason must be provided extension.where(url = 'https://www.ehealth.fgov.be/standards/fhir/medication/StructureDefinition/offLabel').hasValue() implies extension.where(url = 'https://www.ehealth.fgov.be/standards/fhir/medication/StructureDefinition/offlabel').exists()
ele-1 error **ALL** elements All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error **ALL** extensions Must have either extensions or value[x], not both extension.exists() != value.exists()
offLabel-reason-required error MedicationRequest.extension:offLabel If isOffLabelUse is true, reason must be provided extension.where(url = 'isOffLabelUse').value.ofType(boolean).where($this = true).exists() implies extension.where(url = 'reason').exists()

This structure is derived from MedicationRequest

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. MedicationRequest C 0..* MedicationRequest Ordering of medication for patient or group
Constraints: dosage-override-reason-required
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:offLabel S 0..1 (Complex) MedicationRequest - Off-label use
URL: https://www.ehealth.fgov.be/standards/fhir/medication/StructureDefinition/BeExtOffLabel
..... Slices for extension Content/Rules for all slices
...... extension:isOffLabelUse 1..1 Extension Indicates that the recommended dosage was overridden
...... extension:reason 0..* Extension The reason why the recommended dosage was overridden
.... extension:basedOnMedicationLine S 0..1 Reference(BeMedicationLine) Medication Line where this prescription is based upon
URL: https://www.ehealth.fgov.be/standards/fhir/medication/StructureDefinition/BasedOnMedicationLine
.... extension:instructionsForReimbursement S 0..1 CodeableConcept Instructions for reimbursement
URL: https://www.ehealth.fgov.be/standards/fhir/medication/StructureDefinition/BeExtInstructionsForReimbursement
Binding: Medication request reimbursement type ValueSet (required)
.... extension:statusChanged S 0..1 dateTime Indicates when the status of the medication request was last changed.
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-MedicationRequest.statusChanged
... Slices for identifier S 1..* Identifier External ids for this request
Slice: Unordered, Open by pattern:system
.... identifier:recip-e S 0..1 Identifier Recip-E identifier
..... system 1..1 uri The namespace for the identifier value
Required Pattern: http://ehealth.fgov.be/standards/fhir/medication/NamingSystem/be-ns-prescription
..... value S 0..1 string The value that is unique
... status S 1..1 code active | on-hold | cancelled | completed | entered-in-error | stopped | draft | unknown
Binding: Medication Prescription Status (required)
... intent S 1..1 code proposal | plan | order | original-order | reflex-order | filler-order | instance-order | option
... priority S 0..1 code routine | urgent | asap | stat
... medication[x] S 1..1 CodeableConcept, Reference(Medication) Medication to be taken
... subject S 1..1 Reference(BePatient) Who or group medication request is for
... supportingInformation S 0..* Reference(Resource) Information to support ordering of the medication
... authoredOn S 1..1 dateTime When request was initially authored
... requester S 1..1 Reference(BePractitioner | BePractitionerRole) Who/What requested the Request
... reasonCode S 0..* CodeableConcept Reason or indication for ordering or not ordering the medication
... reasonReference S 0..* Reference(Condition | Observation) Condition or observation that supports why the prescription is being written
... groupIdentifier S 0..1 Identifier Composite request this is part of
... note S 0..* Annotation Information about the prescription
... dosageInstruction S 1..* BeDosage How the medication should be taken
... dispenseRequest S 0..1 BackboneElement Medication supply authorization
.... validityPeriod S 0..1 Period Time period supply is authorized for
..... start S 1..1 dateTime Starting time with inclusive boundary
..... end S 0..1 dateTime End time with inclusive boundary, if not ongoing
.... numberOfRepeatsAllowed S 0..1 unsignedInt Number of refills authorized
.... quantity S 0..1 SimpleQuantity(4.0.1) Amount of medication to supply per dispense
... substitution S 0..1 BackboneElement Any restrictions on medication substitution
.... allowed[x] S 1..1 boolean Whether substitution is allowed or not

doco Documentation for this format

Terminology Bindings (Differential)

Path Status Usage ValueSet Version Source
MedicationRequest.status Base required Medication Prescription Status 📦1.1.0 This IG

Constraints

Id Grade Path(s) Description Expression
dosage-override-reason-required error MedicationRequest If isOffLabelUse is true, reason must be provided extension.where(url = 'https://www.ehealth.fgov.be/standards/fhir/medication/StructureDefinition/offLabel').hasValue() implies extension.where(url = 'https://www.ehealth.fgov.be/standards/fhir/medication/StructureDefinition/offlabel').exists()
NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. MedicationRequest C 0..* MedicationRequest Ordering of medication for patient or group
Constraints: dosage-override-reason-required
... id Σ 0..1 id Logical id of this artifact
... meta Σ 0..1 Meta Metadata about the resource
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... language 0..1 code Language of the resource content
Binding: CommonLanguages (preferred): A human language.
Additional BindingsPurpose
AllLanguages Max Binding
... text 0..1 Narrative Text summary of the resource, for human interpretation
This profile does not constrain the narrative in regard to content, language, or traceability to data elements
... contained 0..* Resource Contained, inline Resources
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:offLabel SC 0..1 (Complex) MedicationRequest - Off-label use
URL: https://www.ehealth.fgov.be/standards/fhir/medication/StructureDefinition/BeExtOffLabel
Constraints: offLabel-reason-required
..... id 0..1 string Unique id for inter-element referencing
..... Slices for extension 1..* Extension Extension
Slice: Unordered, Open by value:url
...... extension:isOffLabelUse 1..1 Extension Indicates that the recommended dosage was overridden
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..0
....... url 1..1 uri "isOffLabelUse"
....... value[x] 0..1 boolean Value of extension
...... extension:reason 0..* Extension The reason why the recommended dosage was overridden
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..0
....... url 1..1 uri "reason"
....... value[x] 0..1 CodeableConcept Value of extension
..... url 1..1 uri "https://www.ehealth.fgov.be/standards/fhir/medication/StructureDefinition/BeExtOffLabel"
.... extension:basedOnMedicationLine S 0..1 Reference(BeMedicationLine) Medication Line where this prescription is based upon
URL: https://www.ehealth.fgov.be/standards/fhir/medication/StructureDefinition/BasedOnMedicationLine
.... extension:instructionsForReimbursement S 0..1 CodeableConcept Instructions for reimbursement
URL: https://www.ehealth.fgov.be/standards/fhir/medication/StructureDefinition/BeExtInstructionsForReimbursement
Binding: Medication request reimbursement type ValueSet (required)
.... extension:statusChanged S 0..1 dateTime Indicates when the status of the medication request was last changed.
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-MedicationRequest.statusChanged
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... Slices for identifier S 1..* Identifier External ids for this request
Slice: Unordered, Open by pattern:system
.... identifier:recip-e S 0..1 Identifier Recip-E identifier
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
..... type Σ 0..1 CodeableConcept Description of identifier
Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
..... system Σ 1..1 uri The namespace for the identifier value
Required Pattern: http://ehealth.fgov.be/standards/fhir/medication/NamingSystem/be-ns-prescription
..... value SΣ 0..1 string The value that is unique
Example General: 123456
..... period Σ 0..1 Period Time period when id is/was valid for use
..... assigner Σ 0..1 Reference(Organization) Organization that issued id (may be just text)
... status ?!SΣ 1..1 code active | on-hold | cancelled | completed | entered-in-error | stopped | draft | unknown
Binding: Medication Prescription Status (required)
... statusReason S 0..1 CodeableConcept Reason for current status
Binding: medicationRequest Status Reason Codes (example): Identifies the reasons for a given status.
... intent ?!SΣ 1..1 code proposal | plan | order | original-order | reflex-order | filler-order | instance-order | option
Binding: medicationRequest Intent (required): The kind of medication order.
... category 0..* CodeableConcept Type of medication usage
Binding: medicationRequest Category Codes (example): A coded concept identifying the category of medication request. For example, where the medication is to be consumed or administered, or the type of medication treatment.
... priority SΣ 0..1 code routine | urgent | asap | stat
Binding: RequestPriority (required): Identifies the level of importance to be assigned to actioning the request.
... doNotPerform ?!Σ 0..1 boolean True if request is prohibiting action
... reported[x] Σ 0..1 Reported rather than primary record
.... reportedBoolean boolean
.... reportedReference Reference(Patient | Practitioner | PractitionerRole | RelatedPerson | Organization)
... medication[x] SΣ 1..1 Medication to be taken
Binding: SNOMEDCTMedicationCodes (example): A coded concept identifying substance or product that can be ordered.
.... medicationCodeableConcept CodeableConcept
.... medicationReference Reference(Medication)
... subject SΣ 1..1 Reference(BePatient) Who or group medication request is for
... encounter 0..1 Reference(Encounter) Encounter created as part of encounter/admission/stay
... supportingInformation S 0..* Reference(Resource) Information to support ordering of the medication
... authoredOn SΣ 1..1 dateTime When request was initially authored
... requester SΣ 1..1 Reference(BePractitioner | BePractitionerRole) Who/What requested the Request
... performer 0..1 Reference(Practitioner | PractitionerRole | Organization | Patient | Device | RelatedPerson | CareTeam) Intended performer of administration
... performerType Σ 0..1 CodeableConcept Desired kind of performer of the medication administration
Binding: ProcedurePerformerRoleCodes (example): Identifies the type of individual that is desired to administer the medication.
... recorder 0..1 Reference(Practitioner | PractitionerRole) Person who entered the request
... reasonCode S 0..* CodeableConcept Reason or indication for ordering or not ordering the medication
Binding: Condition/Problem/DiagnosisCodes (example): A coded concept indicating why the medication was ordered.
... reasonReference S 0..* Reference(Condition | Observation) Condition or observation that supports why the prescription is being written
... instantiatesCanonical Σ 0..* canonical() Instantiates FHIR protocol or definition
... instantiatesUri Σ 0..* uri Instantiates external protocol or definition
... basedOn Σ 0..* Reference(CarePlan | MedicationRequest | ServiceRequest | ImmunizationRecommendation) What request fulfills
... groupIdentifier SΣ 0..1 Identifier Composite request this is part of
... courseOfTherapyType 0..1 CodeableConcept Overall pattern of medication administration
Binding: medicationRequest Course of Therapy Codes (example): Identifies the overall pattern of medication administratio.
... insurance 0..* Reference(Coverage | ClaimResponse) Associated insurance coverage
... note S 0..* Annotation Information about the prescription
... dosageInstruction S 1..* BeDosage How the medication should be taken
... dispenseRequest S 0..1 BackboneElement Medication supply authorization
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... initialFill 0..1 BackboneElement First fill details
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... quantity 0..1 SimpleQuantity(4.0.1) First fill quantity
..... duration 0..1 Duration First fill duration
.... dispenseInterval 0..1 Duration Minimum period of time between dispenses
.... validityPeriod S 0..1 Period Time period supply is authorized for
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... start SΣC 1..1 dateTime Starting time with inclusive boundary
..... end SΣC 0..1 dateTime End time with inclusive boundary, if not ongoing
.... numberOfRepeatsAllowed S 0..1 unsignedInt Number of refills authorized
.... quantity S 0..1 SimpleQuantity(4.0.1) Amount of medication to supply per dispense
.... expectedSupplyDuration 0..1 Duration Number of days supply per dispense
.... performer 0..1 Reference(Organization) Intended dispenser
... substitution S 0..1 BackboneElement Any restrictions on medication substitution
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... allowed[x] S 1..1 boolean Whether substitution is allowed or not
.... reason 0..1 CodeableConcept Why should (not) substitution be made
Binding: SubstanceAdminSubstitutionReason (example): A coded concept describing the reason that a different medication should (or should not) be substituted from what was prescribed.
... priorPrescription 0..1 Reference(MedicationRequest) An order/prescription that is being replaced
... detectedIssue 0..* Reference(DetectedIssue) Clinical Issue with action
... eventHistory 0..* Reference(Provenance) A list of events of interest in the lifecycle

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
MedicationRequest.language Base preferred Common Languages 📍4.0.1 FHIR Std.
MedicationRequest.identifier:recip-e.​use Base required IdentifierUse 📍4.0.1 FHIR Std.
MedicationRequest.identifier:recip-e.​type Base extensible IdentifierType 📍4.0.1 FHIR Std.
MedicationRequest.status Base required Medication Prescription Status 📦1.1.0 This IG
MedicationRequest.statusReason Base example Medication request status reason codes 📍4.0.1 FHIR Std.
MedicationRequest.intent Base required Medication request intent 📍4.0.1 FHIR Std.
MedicationRequest.category Base example Medication request category codes 📍4.0.1 FHIR Std.
MedicationRequest.priority Base required Request priority 📍4.0.1 FHIR Std.
MedicationRequest.medication[x] Base example SNOMED CT Medication Codes 📍4.0.1 FHIR Std.
MedicationRequest.performerType Base example Procedure Performer Role Codes 📍4.0.1 FHIR Std.
MedicationRequest.reasonCode Base example Condition/Problem/Diagnosis Codes 📍4.0.1 FHIR Std.
MedicationRequest.courseOfTherapyType Base example Medication request course of therapy codes 📍4.0.1 FHIR Std.
MedicationRequest.substitution.​reason Base example SubstanceAdminSubstitutionReason 📦3.0.0 THO v6.5

Constraints

Id Grade Path(s) Description Expression
dom-2 error MedicationRequest If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error MedicationRequest If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4 error MedicationRequest If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5 error MedicationRequest If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice MedicationRequest A resource should have narrative for robust management text.`div`.exists()
dosage-override-reason-required error MedicationRequest If isOffLabelUse is true, reason must be provided extension.where(url = 'https://www.ehealth.fgov.be/standards/fhir/medication/StructureDefinition/offLabel').hasValue() implies extension.where(url = 'https://www.ehealth.fgov.be/standards/fhir/medication/StructureDefinition/offlabel').exists()
ele-1 error **ALL** elements All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error **ALL** extensions Must have either extensions or value[x], not both extension.exists() != value.exists()
offLabel-reason-required error MedicationRequest.extension:offLabel If isOffLabelUse is true, reason must be provided extension.where(url = 'isOffLabelUse').value.ofType(boolean).where($this = true).exists() implies extension.where(url = 'reason').exists()

Key Elements View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. MedicationRequest C 0..* MedicationRequest Ordering of medication for patient or group
Constraints: dosage-override-reason-required
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:offLabel SC 0..1 (Complex) MedicationRequest - Off-label use
URL: https://www.ehealth.fgov.be/standards/fhir/medication/StructureDefinition/BeExtOffLabel
Constraints: offLabel-reason-required
..... Slices for extension 1..* Extension Extension
Slice: Unordered, Open by value:url
...... extension:isOffLabelUse 1..1 Extension Indicates that the recommended dosage was overridden
....... extension 0..0
....... url 1..1 uri "isOffLabelUse"
...... extension:reason 0..* Extension The reason why the recommended dosage was overridden
....... extension 0..0
....... url 1..1 uri "reason"
..... url 1..1 uri "https://www.ehealth.fgov.be/standards/fhir/medication/StructureDefinition/BeExtOffLabel"
.... extension:basedOnMedicationLine S 0..1 Reference(BeMedicationLine) Medication Line where this prescription is based upon
URL: https://www.ehealth.fgov.be/standards/fhir/medication/StructureDefinition/BasedOnMedicationLine
.... extension:instructionsForReimbursement S 0..1 CodeableConcept Instructions for reimbursement
URL: https://www.ehealth.fgov.be/standards/fhir/medication/StructureDefinition/BeExtInstructionsForReimbursement
Binding: Medication request reimbursement type ValueSet (required)
.... extension:statusChanged S 0..1 dateTime Indicates when the status of the medication request was last changed.
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-MedicationRequest.statusChanged
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
.... identifier:recip-e S 0..1 Identifier Recip-E identifier
..... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
..... system Σ 1..1 uri The namespace for the identifier value
Required Pattern: http://ehealth.fgov.be/standards/fhir/medication/NamingSystem/be-ns-prescription
..... value SΣ 0..1 string The value that is unique
Example General: 123456
... status ?!SΣ 1..1 code active | on-hold | cancelled | completed | entered-in-error | stopped | draft | unknown
Binding: Medication Prescription Status (required)
... statusReason S 0..1 CodeableConcept Reason for current status
Binding: medicationRequest Status Reason Codes (example): Identifies the reasons for a given status.
... intent ?!SΣ 1..1 code proposal | plan | order | original-order | reflex-order | filler-order | instance-order | option
Binding: medicationRequest Intent (required): The kind of medication order.
... priority SΣ 0..1 code routine | urgent | asap | stat
Binding: RequestPriority (required): Identifies the level of importance to be assigned to actioning the request.
... doNotPerform ?!Σ 0..1 boolean True if request is prohibiting action
... medication[x] SΣ 1..1 Medication to be taken
Binding: SNOMEDCTMedicationCodes (example): A coded concept identifying substance or product that can be ordered.
.... medicationCodeableConcept CodeableConcept
.... medicationReference Reference(Medication)
... subject SΣ 1..1 Reference(BePatient) Who or group medication request is for
... supportingInformation S 0..* Reference(Resource) Information to support ordering of the medication
... authoredOn SΣ 1..1 dateTime When request was initially authored
... requester SΣ 1..1 Reference(BePractitioner | BePractitionerRole) Who/What requested the Request
... reasonCode S 0..* CodeableConcept Reason or indication for ordering or not ordering the medication
Binding: Condition/Problem/DiagnosisCodes (example): A coded concept indicating why the medication was ordered.
... reasonReference S 0..* Reference(Condition | Observation) Condition or observation that supports why the prescription is being written
... groupIdentifier SΣ 0..1 Identifier Composite request this is part of
... note S 0..* Annotation Information about the prescription
... dosageInstruction S 1..* BeDosage How the medication should be taken
... dispenseRequest S 0..1 BackboneElement Medication supply authorization
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... validityPeriod S 0..1 Period Time period supply is authorized for
..... start SΣC 1..1 dateTime Starting time with inclusive boundary
..... end SΣC 0..1 dateTime End time with inclusive boundary, if not ongoing
.... numberOfRepeatsAllowed S 0..1 unsignedInt Number of refills authorized
.... quantity S 0..1 SimpleQuantity(4.0.1) Amount of medication to supply per dispense
... substitution S 0..1 BackboneElement Any restrictions on medication substitution
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... allowed[x] S 1..1 boolean Whether substitution is allowed or not

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
MedicationRequest.identifier:recip-e.​use Base required IdentifierUse 📍4.0.1 FHIR Std.
MedicationRequest.status Base required Medication Prescription Status 📦1.1.0 This IG
MedicationRequest.statusReason Base example Medication request status reason codes 📍4.0.1 FHIR Std.
MedicationRequest.intent Base required Medication request intent 📍4.0.1 FHIR Std.
MedicationRequest.priority Base required Request priority 📍4.0.1 FHIR Std.
MedicationRequest.medication[x] Base example SNOMED CT Medication Codes 📍4.0.1 FHIR Std.
MedicationRequest.reasonCode Base example Condition/Problem/Diagnosis Codes 📍4.0.1 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
dom-2 error MedicationRequest If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error MedicationRequest If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4 error MedicationRequest If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5 error MedicationRequest If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice MedicationRequest A resource should have narrative for robust management text.`div`.exists()
dosage-override-reason-required error MedicationRequest If isOffLabelUse is true, reason must be provided extension.where(url = 'https://www.ehealth.fgov.be/standards/fhir/medication/StructureDefinition/offLabel').hasValue() implies extension.where(url = 'https://www.ehealth.fgov.be/standards/fhir/medication/StructureDefinition/offlabel').exists()
ele-1 error **ALL** elements All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error **ALL** extensions Must have either extensions or value[x], not both extension.exists() != value.exists()
offLabel-reason-required error MedicationRequest.extension:offLabel If isOffLabelUse is true, reason must be provided extension.where(url = 'isOffLabelUse').value.ofType(boolean).where($this = true).exists() implies extension.where(url = 'reason').exists()

Differential View

This structure is derived from MedicationRequest

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. MedicationRequest C 0..* MedicationRequest Ordering of medication for patient or group
Constraints: dosage-override-reason-required
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:offLabel S 0..1 (Complex) MedicationRequest - Off-label use
URL: https://www.ehealth.fgov.be/standards/fhir/medication/StructureDefinition/BeExtOffLabel
..... Slices for extension Content/Rules for all slices
...... extension:isOffLabelUse 1..1 Extension Indicates that the recommended dosage was overridden
...... extension:reason 0..* Extension The reason why the recommended dosage was overridden
.... extension:basedOnMedicationLine S 0..1 Reference(BeMedicationLine) Medication Line where this prescription is based upon
URL: https://www.ehealth.fgov.be/standards/fhir/medication/StructureDefinition/BasedOnMedicationLine
.... extension:instructionsForReimbursement S 0..1 CodeableConcept Instructions for reimbursement
URL: https://www.ehealth.fgov.be/standards/fhir/medication/StructureDefinition/BeExtInstructionsForReimbursement
Binding: Medication request reimbursement type ValueSet (required)
.... extension:statusChanged S 0..1 dateTime Indicates when the status of the medication request was last changed.
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-MedicationRequest.statusChanged
... Slices for identifier S 1..* Identifier External ids for this request
Slice: Unordered, Open by pattern:system
.... identifier:recip-e S 0..1 Identifier Recip-E identifier
..... system 1..1 uri The namespace for the identifier value
Required Pattern: http://ehealth.fgov.be/standards/fhir/medication/NamingSystem/be-ns-prescription
..... value S 0..1 string The value that is unique
... status S 1..1 code active | on-hold | cancelled | completed | entered-in-error | stopped | draft | unknown
Binding: Medication Prescription Status (required)
... intent S 1..1 code proposal | plan | order | original-order | reflex-order | filler-order | instance-order | option
... priority S 0..1 code routine | urgent | asap | stat
... medication[x] S 1..1 CodeableConcept, Reference(Medication) Medication to be taken
... subject S 1..1 Reference(BePatient) Who or group medication request is for
... supportingInformation S 0..* Reference(Resource) Information to support ordering of the medication
... authoredOn S 1..1 dateTime When request was initially authored
... requester S 1..1 Reference(BePractitioner | BePractitionerRole) Who/What requested the Request
... reasonCode S 0..* CodeableConcept Reason or indication for ordering or not ordering the medication
... reasonReference S 0..* Reference(Condition | Observation) Condition or observation that supports why the prescription is being written
... groupIdentifier S 0..1 Identifier Composite request this is part of
... note S 0..* Annotation Information about the prescription
... dosageInstruction S 1..* BeDosage How the medication should be taken
... dispenseRequest S 0..1 BackboneElement Medication supply authorization
.... validityPeriod S 0..1 Period Time period supply is authorized for
..... start S 1..1 dateTime Starting time with inclusive boundary
..... end S 0..1 dateTime End time with inclusive boundary, if not ongoing
.... numberOfRepeatsAllowed S 0..1 unsignedInt Number of refills authorized
.... quantity S 0..1 SimpleQuantity(4.0.1) Amount of medication to supply per dispense
... substitution S 0..1 BackboneElement Any restrictions on medication substitution
.... allowed[x] S 1..1 boolean Whether substitution is allowed or not

doco Documentation for this format

Terminology Bindings (Differential)

Path Status Usage ValueSet Version Source
MedicationRequest.status Base required Medication Prescription Status 📦1.1.0 This IG

Constraints

Id Grade Path(s) Description Expression
dosage-override-reason-required error MedicationRequest If isOffLabelUse is true, reason must be provided extension.where(url = 'https://www.ehealth.fgov.be/standards/fhir/medication/StructureDefinition/offLabel').hasValue() implies extension.where(url = 'https://www.ehealth.fgov.be/standards/fhir/medication/StructureDefinition/offlabel').exists()

Snapshot View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. MedicationRequest C 0..* MedicationRequest Ordering of medication for patient or group
Constraints: dosage-override-reason-required
... id Σ 0..1 id Logical id of this artifact
... meta Σ 0..1 Meta Metadata about the resource
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... language 0..1 code Language of the resource content
Binding: CommonLanguages (preferred): A human language.
Additional BindingsPurpose
AllLanguages Max Binding
... text 0..1 Narrative Text summary of the resource, for human interpretation
This profile does not constrain the narrative in regard to content, language, or traceability to data elements
... contained 0..* Resource Contained, inline Resources
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:offLabel SC 0..1 (Complex) MedicationRequest - Off-label use
URL: https://www.ehealth.fgov.be/standards/fhir/medication/StructureDefinition/BeExtOffLabel
Constraints: offLabel-reason-required
..... id 0..1 string Unique id for inter-element referencing
..... Slices for extension 1..* Extension Extension
Slice: Unordered, Open by value:url
...... extension:isOffLabelUse 1..1 Extension Indicates that the recommended dosage was overridden
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..0
....... url 1..1 uri "isOffLabelUse"
....... value[x] 0..1 boolean Value of extension
...... extension:reason 0..* Extension The reason why the recommended dosage was overridden
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..0
....... url 1..1 uri "reason"
....... value[x] 0..1 CodeableConcept Value of extension
..... url 1..1 uri "https://www.ehealth.fgov.be/standards/fhir/medication/StructureDefinition/BeExtOffLabel"
.... extension:basedOnMedicationLine S 0..1 Reference(BeMedicationLine) Medication Line where this prescription is based upon
URL: https://www.ehealth.fgov.be/standards/fhir/medication/StructureDefinition/BasedOnMedicationLine
.... extension:instructionsForReimbursement S 0..1 CodeableConcept Instructions for reimbursement
URL: https://www.ehealth.fgov.be/standards/fhir/medication/StructureDefinition/BeExtInstructionsForReimbursement
Binding: Medication request reimbursement type ValueSet (required)
.... extension:statusChanged S 0..1 dateTime Indicates when the status of the medication request was last changed.
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-MedicationRequest.statusChanged
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... Slices for identifier S 1..* Identifier External ids for this request
Slice: Unordered, Open by pattern:system
.... identifier:recip-e S 0..1 Identifier Recip-E identifier
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
..... type Σ 0..1 CodeableConcept Description of identifier
Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
..... system Σ 1..1 uri The namespace for the identifier value
Required Pattern: http://ehealth.fgov.be/standards/fhir/medication/NamingSystem/be-ns-prescription
..... value SΣ 0..1 string The value that is unique
Example General: 123456
..... period Σ 0..1 Period Time period when id is/was valid for use
..... assigner Σ 0..1 Reference(Organization) Organization that issued id (may be just text)
... status ?!SΣ 1..1 code active | on-hold | cancelled | completed | entered-in-error | stopped | draft | unknown
Binding: Medication Prescription Status (required)
... statusReason S 0..1 CodeableConcept Reason for current status
Binding: medicationRequest Status Reason Codes (example): Identifies the reasons for a given status.
... intent ?!SΣ 1..1 code proposal | plan | order | original-order | reflex-order | filler-order | instance-order | option
Binding: medicationRequest Intent (required): The kind of medication order.
... category 0..* CodeableConcept Type of medication usage
Binding: medicationRequest Category Codes (example): A coded concept identifying the category of medication request. For example, where the medication is to be consumed or administered, or the type of medication treatment.
... priority SΣ 0..1 code routine | urgent | asap | stat
Binding: RequestPriority (required): Identifies the level of importance to be assigned to actioning the request.
... doNotPerform ?!Σ 0..1 boolean True if request is prohibiting action
... reported[x] Σ 0..1 Reported rather than primary record
.... reportedBoolean boolean
.... reportedReference Reference(Patient | Practitioner | PractitionerRole | RelatedPerson | Organization)
... medication[x] SΣ 1..1 Medication to be taken
Binding: SNOMEDCTMedicationCodes (example): A coded concept identifying substance or product that can be ordered.
.... medicationCodeableConcept CodeableConcept
.... medicationReference Reference(Medication)
... subject SΣ 1..1 Reference(BePatient) Who or group medication request is for
... encounter 0..1 Reference(Encounter) Encounter created as part of encounter/admission/stay
... supportingInformation S 0..* Reference(Resource) Information to support ordering of the medication
... authoredOn SΣ 1..1 dateTime When request was initially authored
... requester SΣ 1..1 Reference(BePractitioner | BePractitionerRole) Who/What requested the Request
... performer 0..1 Reference(Practitioner | PractitionerRole | Organization | Patient | Device | RelatedPerson | CareTeam) Intended performer of administration
... performerType Σ 0..1 CodeableConcept Desired kind of performer of the medication administration
Binding: ProcedurePerformerRoleCodes (example): Identifies the type of individual that is desired to administer the medication.
... recorder 0..1 Reference(Practitioner | PractitionerRole) Person who entered the request
... reasonCode S 0..* CodeableConcept Reason or indication for ordering or not ordering the medication
Binding: Condition/Problem/DiagnosisCodes (example): A coded concept indicating why the medication was ordered.
... reasonReference S 0..* Reference(Condition | Observation) Condition or observation that supports why the prescription is being written
... instantiatesCanonical Σ 0..* canonical() Instantiates FHIR protocol or definition
... instantiatesUri Σ 0..* uri Instantiates external protocol or definition
... basedOn Σ 0..* Reference(CarePlan | MedicationRequest | ServiceRequest | ImmunizationRecommendation) What request fulfills
... groupIdentifier SΣ 0..1 Identifier Composite request this is part of
... courseOfTherapyType 0..1 CodeableConcept Overall pattern of medication administration
Binding: medicationRequest Course of Therapy Codes (example): Identifies the overall pattern of medication administratio.
... insurance 0..* Reference(Coverage | ClaimResponse) Associated insurance coverage
... note S 0..* Annotation Information about the prescription
... dosageInstruction S 1..* BeDosage How the medication should be taken
... dispenseRequest S 0..1 BackboneElement Medication supply authorization
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... initialFill 0..1 BackboneElement First fill details
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... quantity 0..1 SimpleQuantity(4.0.1) First fill quantity
..... duration 0..1 Duration First fill duration
.... dispenseInterval 0..1 Duration Minimum period of time between dispenses
.... validityPeriod S 0..1 Period Time period supply is authorized for
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... start SΣC 1..1 dateTime Starting time with inclusive boundary
..... end SΣC 0..1 dateTime End time with inclusive boundary, if not ongoing
.... numberOfRepeatsAllowed S 0..1 unsignedInt Number of refills authorized
.... quantity S 0..1 SimpleQuantity(4.0.1) Amount of medication to supply per dispense
.... expectedSupplyDuration 0..1 Duration Number of days supply per dispense
.... performer 0..1 Reference(Organization) Intended dispenser
... substitution S 0..1 BackboneElement Any restrictions on medication substitution
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... allowed[x] S 1..1 boolean Whether substitution is allowed or not
.... reason 0..1 CodeableConcept Why should (not) substitution be made
Binding: SubstanceAdminSubstitutionReason (example): A coded concept describing the reason that a different medication should (or should not) be substituted from what was prescribed.
... priorPrescription 0..1 Reference(MedicationRequest) An order/prescription that is being replaced
... detectedIssue 0..* Reference(DetectedIssue) Clinical Issue with action
... eventHistory 0..* Reference(Provenance) A list of events of interest in the lifecycle

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
MedicationRequest.language Base preferred Common Languages 📍4.0.1 FHIR Std.
MedicationRequest.identifier:recip-e.​use Base required IdentifierUse 📍4.0.1 FHIR Std.
MedicationRequest.identifier:recip-e.​type Base extensible IdentifierType 📍4.0.1 FHIR Std.
MedicationRequest.status Base required Medication Prescription Status 📦1.1.0 This IG
MedicationRequest.statusReason Base example Medication request status reason codes 📍4.0.1 FHIR Std.
MedicationRequest.intent Base required Medication request intent 📍4.0.1 FHIR Std.
MedicationRequest.category Base example Medication request category codes 📍4.0.1 FHIR Std.
MedicationRequest.priority Base required Request priority 📍4.0.1 FHIR Std.
MedicationRequest.medication[x] Base example SNOMED CT Medication Codes 📍4.0.1 FHIR Std.
MedicationRequest.performerType Base example Procedure Performer Role Codes 📍4.0.1 FHIR Std.
MedicationRequest.reasonCode Base example Condition/Problem/Diagnosis Codes 📍4.0.1 FHIR Std.
MedicationRequest.courseOfTherapyType Base example Medication request course of therapy codes 📍4.0.1 FHIR Std.
MedicationRequest.substitution.​reason Base example SubstanceAdminSubstitutionReason 📦3.0.0 THO v6.5

Constraints

Id Grade Path(s) Description Expression
dom-2 error MedicationRequest If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error MedicationRequest If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4 error MedicationRequest If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5 error MedicationRequest If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice MedicationRequest A resource should have narrative for robust management text.`div`.exists()
dosage-override-reason-required error MedicationRequest If isOffLabelUse is true, reason must be provided extension.where(url = 'https://www.ehealth.fgov.be/standards/fhir/medication/StructureDefinition/offLabel').hasValue() implies extension.where(url = 'https://www.ehealth.fgov.be/standards/fhir/medication/StructureDefinition/offlabel').exists()
ele-1 error **ALL** elements All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error **ALL** extensions Must have either extensions or value[x], not both extension.exists() != value.exists()
offLabel-reason-required error MedicationRequest.extension:offLabel If isOffLabelUse is true, reason must be provided extension.where(url = 'isOffLabelUse').value.ofType(boolean).where($this = true).exists() implies extension.where(url = 'reason').exists()

 

Other representations of profile: CSV, Excel, Schematron