Medication
1.1.0 - STU Belgium flag

Medication, published by HL7 Belgium. This guide is not an authorized publication; it is the continuous build for version 1.1.0 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/hl7-be/medication/tree/prescription and changes regularly. See the Directory of published versions

Resource Profile: Medication Line

Official URL: https://www.ehealth.fgov.be/standards/fhir/medication/StructureDefinition/BeMedicationLine Version: 1.1.0
Draft as of 2025-04-09 Computable Name: BeMedicationLine

Medication Line profile - contains the overview information for a single medication item

Usage:

Formal Views of Profile Content

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

NameFlagsCard.TypeDescription & Constraintsdoco
.. MedicationStatement 0..* MedicationStatement Record of medication being taken by a patient
dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources
dom-3: 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
dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated
dom-5: If a resource is contained in another resource, it SHALL NOT have a security label
dom-6: A resource should have narrative for robust management
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
ele-1: All FHIR elements must have a @value or children
... Slices for extension 2..* Extension Extension
Slice: Unordered, Open by value:url
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
.... extension:offLabel SC 0..1 (Complex) MedicationRequest - Off-label use
URL: https://www.ehealth.fgov.be/standards/fhir/medication/StructureDefinition/be-ext-OffLabel
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
offLabel-reason-required: If isOffLabelUse is true, reason must be provided
..... Slices for extension 1..* Extension Extension
Slice: Unordered, Open by value:url
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
...... extension:isOffLabelUse 1..1 Extension Indicates that the recommended dosage was overridden
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
....... extension 0..0
....... url 1..1 uri "isOffLabelUse"
...... extension:reason 0..* Extension The reason why the recommended dosage was overridden
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
....... extension 0..0
....... url 1..1 uri "reason"
..... url 1..1 uri "https://www.ehealth.fgov.be/standards/fhir/medication/StructureDefinition/be-ext-OffLabel"
.... extension:exposure-category S 0..1 CodeableConcept Exposure category
URL: https://www.ehealth.fgov.be/standards/fhir/medication/StructureDefinition/ExposureCategory
Binding: Medication exposure intent (extensible)
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
.... extension:dispense-request-needed S 0..1 boolean Indication of whether a dispense request is needed for delivering the medication
URL: https://www.ehealth.fgov.be/standards/fhir/medication/StructureDefinition/DispenseRequestNeededCategory
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
.... extension:artifact-version S 1..1 string The business version of the medication line - this version changes when the content update is considered clinically relevant
URL: http://hl7.org/fhir/StructureDefinition/artifact-version
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
.... extension:artifact-date S 0..1 dateTime The business-relevant recorded date - the date the medication line was created or changed
URL: http://hl7.org/fhir/StructureDefinition/artifact-date
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
.... extension:adherence S 1..1 (Complex) Indicates whether the medication is or is not being consumed or administered
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-MedicationStatement.adherence
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
.... identifier:vidis SΣ 0..1 Identifier VIDIS identifier
ele-1: All FHIR elements must have a @value or children
..... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .


ele-1: All FHIR elements must have a @value or children
..... system Σ 1..1 uri The namespace for the identifier value
ele-1: All FHIR elements must have a @value or children
Required Pattern: http://ehealth.fgov.be/standards/fhir/medication/NamingSystem/be-ns-medicationline
..... value SΣ 0..1 string The value that is unique
ele-1: All FHIR elements must have a @value or children
Example General: 123456
... status ?!SΣ 1..1 code active | completed | entered-in-error | intended | stopped | on-hold | unknown | not-taken
Binding: Medication Status Codes (required): A coded concept indicating the current status of a MedicationStatement.


ele-1: All FHIR elements must have a @value or children
... statusReason S 0..* CodeableConcept Reason for current status
Binding: SNOMEDCTDrugTherapyStatusCodes (example): A coded concept indicating the reason for the status of the statement.


ele-1: All FHIR elements must have a @value or children
... category SΣ 0..1 CodeableConcept Type of medication usage
Binding: Medication usage category codes (preferred): A coded concept identifying where the medication included in the MedicationStatement is expected to be consumed or administered.


ele-1: All FHIR elements must have a @value or children
... medication[x] SΣ 1..1 What medication was taken
Binding: SNOMEDCTMedicationCodes (example): A coded concept identifying the substance or product being taken.


ele-1: All FHIR elements must have a @value or children
.... medicationCodeableConcept CodeableConcept
.... medicationReference Reference(Medication)
... subject SΣ 1..1 Reference(BePatient) Who is/was taking the medication
ele-1: All FHIR elements must have a @value or children
... effective[x] SΣ 1..1 The date/time or interval when the medication is/was/will be taken
ele-1: All FHIR elements must have a @value or children
.... effectiveDateTime dateTime
.... effectivePeriod Period
... dateAsserted SΣ 0..1 dateTime When the statement was asserted?
ele-1: All FHIR elements must have a @value or children
... informationSource S 1..1 Reference(BePatient | BePractitioner | BePractitionerRole | RelatedPerson | BeOrganization) Person or organization that provided the information about the taking of this medication
ele-1: All FHIR elements must have a @value or children
... reasonCode S 0..* CodeableConcept Reason for why the medication is being/was taken
Binding: Condition/Problem/DiagnosisCodes (example): A coded concept identifying why the medication is being taken.


ele-1: All FHIR elements must have a @value or children
... reasonReference S 0..* Reference(Condition | Observation | DiagnosticReport) Condition or observation that supports why the medication is being/was taken
ele-1: All FHIR elements must have a @value or children
... note S 0..* Annotation Further information about the statement
ele-1: All FHIR elements must have a @value or children
... dosage S 0..* Dosage Details of how medication is/was taken or should be taken
ele-1: All FHIR elements must have a @value or children

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
MedicationStatement.identifier:vidis.userequiredIdentifierUse
http://hl7.org/fhir/ValueSet/identifier-use|4.0.1
from the FHIR Standard
MedicationStatement.statusrequiredMedication Status Codes
http://hl7.org/fhir/ValueSet/medication-statement-status|4.0.1
from the FHIR Standard
MedicationStatement.statusReasonexampleSNOMEDCTDrugTherapyStatusCodes
http://hl7.org/fhir/ValueSet/reason-medication-status-codes
from the FHIR Standard
MedicationStatement.categorypreferredMedication usage category codes
http://hl7.org/fhir/ValueSet/medication-statement-category
from the FHIR Standard
MedicationStatement.medication[x]exampleSNOMEDCTMedicationCodes
http://hl7.org/fhir/ValueSet/medication-codes
from the FHIR Standard
MedicationStatement.reasonCodeexampleCondition/Problem/DiagnosisCodes
http://hl7.org/fhir/ValueSet/condition-code
from the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
dom-2errorMedicationStatementIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorMedicationStatementIf 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-4errorMedicationStatementIf 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-5errorMedicationStatementIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceMedicationStatementA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()
offLabel-reason-requirederrorMedicationStatement.extension:offLabelIf 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 MedicationStatement

NameFlagsCard.TypeDescription & Constraintsdoco
.. MedicationStatement MedicationStatement
... Slices for extension 2..* 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/be-ext-OffLabel
..... 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:exposure-category S 0..1 CodeableConcept Exposure category
URL: https://www.ehealth.fgov.be/standards/fhir/medication/StructureDefinition/ExposureCategory
Binding: Medication exposure intent (extensible)
.... extension:dispense-request-needed S 0..1 boolean Indication of whether a dispense request is needed for delivering the medication
URL: https://www.ehealth.fgov.be/standards/fhir/medication/StructureDefinition/DispenseRequestNeededCategory
.... extension:artifact-version S 1..1 string The business version of the medication line - this version changes when the content update is considered clinically relevant
URL: http://hl7.org/fhir/StructureDefinition/artifact-version
.... extension:artifact-date S 0..1 dateTime The business-relevant recorded date - the date the medication line was created or changed
URL: http://hl7.org/fhir/StructureDefinition/artifact-date
.... extension:adherence S 1..1 (Complex) Indicates whether the medication is or is not being consumed or administered
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-MedicationStatement.adherence
... Slices for identifier S 1..* Identifier External identifier
Slice: Unordered, Open by pattern:system
.... identifier:vidis S 0..1 Identifier VIDIS identifier
..... system 1..1 uri The namespace for the identifier value
Required Pattern: http://ehealth.fgov.be/standards/fhir/medication/NamingSystem/be-ns-medicationline
..... value S 0..1 string The value that is unique
... status S 1..1 code active | completed | entered-in-error | intended | stopped | on-hold | unknown | not-taken
... category S 0..1 CodeableConcept Type of medication usage
... medication[x] S 1..1 CodeableConcept, Reference(Medication) What medication was taken
... subject S 1..1 Reference(BePatient) Who is/was taking the medication
... effective[x] S 1..1 dateTime, Period The date/time or interval when the medication is/was/will be taken
... dateAsserted S 0..1 dateTime When the statement was asserted?
... informationSource S 1..1 Reference(BePatient | BePractitioner | BePractitionerRole | RelatedPerson | BeOrganization) Person or organization that provided the information about the taking of this medication
... reasonCode S 0..* CodeableConcept Reason for why the medication is being/was taken
... reasonReference S 0..* Reference(Condition | Observation | DiagnosticReport) Condition or observation that supports why the medication is being/was taken
... note S 0..* Annotation Further information about the statement
... dosage S 0..* Dosage Details of how medication is/was taken or should be taken

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. MedicationStatement 0..* MedicationStatement Record of medication being taken by a patient
... 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
... text 0..1 Narrative Text summary of the resource, for human interpretation
... contained 0..* Resource Contained, inline Resources
... Slices for extension 2..* 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/be-ext-OffLabel
offLabel-reason-required: If isOffLabelUse is true, reason must be provided
..... 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/be-ext-OffLabel"
.... extension:exposure-category S 0..1 CodeableConcept Exposure category
URL: https://www.ehealth.fgov.be/standards/fhir/medication/StructureDefinition/ExposureCategory
Binding: Medication exposure intent (extensible)
.... extension:dispense-request-needed S 0..1 boolean Indication of whether a dispense request is needed for delivering the medication
URL: https://www.ehealth.fgov.be/standards/fhir/medication/StructureDefinition/DispenseRequestNeededCategory
.... extension:artifact-version S 1..1 string The business version of the medication line - this version changes when the content update is considered clinically relevant
URL: http://hl7.org/fhir/StructureDefinition/artifact-version
.... extension:artifact-date S 0..1 dateTime The business-relevant recorded date - the date the medication line was created or changed
URL: http://hl7.org/fhir/StructureDefinition/artifact-date
.... extension:adherence S 1..1 (Complex) Indicates whether the medication is or is not being consumed or administered
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-MedicationStatement.adherence
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... Slices for identifier SΣ 1..* Identifier External identifier
Slice: Unordered, Open by pattern:system
.... identifier:vidis SΣ 0..1 Identifier VIDIS 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-medicationline
..... 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)
... basedOn Σ 0..* Reference(MedicationRequest | CarePlan | ServiceRequest) Fulfils plan, proposal or order
... partOf Σ 0..* Reference(MedicationAdministration | MedicationDispense | MedicationStatement | Procedure | Observation) Part of referenced event
... status ?!SΣ 1..1 code active | completed | entered-in-error | intended | stopped | on-hold | unknown | not-taken
Binding: Medication Status Codes (required): A coded concept indicating the current status of a MedicationStatement.

... statusReason S 0..* CodeableConcept Reason for current status
Binding: SNOMEDCTDrugTherapyStatusCodes (example): A coded concept indicating the reason for the status of the statement.


... category SΣ 0..1 CodeableConcept Type of medication usage
Binding: Medication usage category codes (preferred): A coded concept identifying where the medication included in the MedicationStatement is expected to be consumed or administered.

... medication[x] SΣ 1..1 What medication was taken
Binding: SNOMEDCTMedicationCodes (example): A coded concept identifying the substance or product being taken.

.... medicationCodeableConcept CodeableConcept
.... medicationReference Reference(Medication)
... subject SΣ 1..1 Reference(BePatient) Who is/was taking the medication
... context Σ 0..1 Reference(Encounter | EpisodeOfCare) Encounter / Episode associated with MedicationStatement
... effective[x] SΣ 1..1 The date/time or interval when the medication is/was/will be taken
.... effectiveDateTime dateTime
.... effectivePeriod Period
... dateAsserted SΣ 0..1 dateTime When the statement was asserted?
... informationSource S 1..1 Reference(BePatient | BePractitioner | BePractitionerRole | RelatedPerson | BeOrganization) Person or organization that provided the information about the taking of this medication
... derivedFrom 0..* Reference(Resource) Additional supporting information
... reasonCode S 0..* CodeableConcept Reason for why the medication is being/was taken
Binding: Condition/Problem/DiagnosisCodes (example): A coded concept identifying why the medication is being taken.


... reasonReference S 0..* Reference(Condition | Observation | DiagnosticReport) Condition or observation that supports why the medication is being/was taken
... note S 0..* Annotation Further information about the statement
... dosage S 0..* Dosage Details of how medication is/was taken or should be taken

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
MedicationStatement.languagepreferredCommonLanguages
http://hl7.org/fhir/ValueSet/languages
from the FHIR Standard
Additional Bindings Purpose
AllLanguages Max Binding
MedicationStatement.identifier:vidis.userequiredIdentifierUse
http://hl7.org/fhir/ValueSet/identifier-use|4.0.1
from the FHIR Standard
MedicationStatement.identifier:vidis.typeextensibleIdentifier Type Codes
http://hl7.org/fhir/ValueSet/identifier-type
from the FHIR Standard
MedicationStatement.statusrequiredMedication Status Codes
http://hl7.org/fhir/ValueSet/medication-statement-status|4.0.1
from the FHIR Standard
MedicationStatement.statusReasonexampleSNOMEDCTDrugTherapyStatusCodes
http://hl7.org/fhir/ValueSet/reason-medication-status-codes
from the FHIR Standard
MedicationStatement.categorypreferredMedication usage category codes
http://hl7.org/fhir/ValueSet/medication-statement-category
from the FHIR Standard
MedicationStatement.medication[x]exampleSNOMEDCTMedicationCodes
http://hl7.org/fhir/ValueSet/medication-codes
from the FHIR Standard
MedicationStatement.reasonCodeexampleCondition/Problem/DiagnosisCodes
http://hl7.org/fhir/ValueSet/condition-code
from the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
dom-2errorMedicationStatementIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorMedicationStatementIf 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-4errorMedicationStatementIf 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-5errorMedicationStatementIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceMedicationStatementA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()
offLabel-reason-requirederrorMedicationStatement.extension:offLabelIf 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 & Constraintsdoco
.. MedicationStatement 0..* MedicationStatement Record of medication being taken by a patient
dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources
dom-3: 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
dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated
dom-5: If a resource is contained in another resource, it SHALL NOT have a security label
dom-6: A resource should have narrative for robust management
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
ele-1: All FHIR elements must have a @value or children
... Slices for extension 2..* Extension Extension
Slice: Unordered, Open by value:url
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
.... extension:offLabel SC 0..1 (Complex) MedicationRequest - Off-label use
URL: https://www.ehealth.fgov.be/standards/fhir/medication/StructureDefinition/be-ext-OffLabel
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
offLabel-reason-required: If isOffLabelUse is true, reason must be provided
..... Slices for extension 1..* Extension Extension
Slice: Unordered, Open by value:url
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
...... extension:isOffLabelUse 1..1 Extension Indicates that the recommended dosage was overridden
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
....... extension 0..0
....... url 1..1 uri "isOffLabelUse"
...... extension:reason 0..* Extension The reason why the recommended dosage was overridden
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
....... extension 0..0
....... url 1..1 uri "reason"
..... url 1..1 uri "https://www.ehealth.fgov.be/standards/fhir/medication/StructureDefinition/be-ext-OffLabel"
.... extension:exposure-category S 0..1 CodeableConcept Exposure category
URL: https://www.ehealth.fgov.be/standards/fhir/medication/StructureDefinition/ExposureCategory
Binding: Medication exposure intent (extensible)
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
.... extension:dispense-request-needed S 0..1 boolean Indication of whether a dispense request is needed for delivering the medication
URL: https://www.ehealth.fgov.be/standards/fhir/medication/StructureDefinition/DispenseRequestNeededCategory
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
.... extension:artifact-version S 1..1 string The business version of the medication line - this version changes when the content update is considered clinically relevant
URL: http://hl7.org/fhir/StructureDefinition/artifact-version
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
.... extension:artifact-date S 0..1 dateTime The business-relevant recorded date - the date the medication line was created or changed
URL: http://hl7.org/fhir/StructureDefinition/artifact-date
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
.... extension:adherence S 1..1 (Complex) Indicates whether the medication is or is not being consumed or administered
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-MedicationStatement.adherence
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
.... identifier:vidis SΣ 0..1 Identifier VIDIS identifier
ele-1: All FHIR elements must have a @value or children
..... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .


ele-1: All FHIR elements must have a @value or children
..... system Σ 1..1 uri The namespace for the identifier value
ele-1: All FHIR elements must have a @value or children
Required Pattern: http://ehealth.fgov.be/standards/fhir/medication/NamingSystem/be-ns-medicationline
..... value SΣ 0..1 string The value that is unique
ele-1: All FHIR elements must have a @value or children
Example General: 123456
... status ?!SΣ 1..1 code active | completed | entered-in-error | intended | stopped | on-hold | unknown | not-taken
Binding: Medication Status Codes (required): A coded concept indicating the current status of a MedicationStatement.


ele-1: All FHIR elements must have a @value or children
... statusReason S 0..* CodeableConcept Reason for current status
Binding: SNOMEDCTDrugTherapyStatusCodes (example): A coded concept indicating the reason for the status of the statement.


ele-1: All FHIR elements must have a @value or children
... category SΣ 0..1 CodeableConcept Type of medication usage
Binding: Medication usage category codes (preferred): A coded concept identifying where the medication included in the MedicationStatement is expected to be consumed or administered.


ele-1: All FHIR elements must have a @value or children
... medication[x] SΣ 1..1 What medication was taken
Binding: SNOMEDCTMedicationCodes (example): A coded concept identifying the substance or product being taken.


ele-1: All FHIR elements must have a @value or children
.... medicationCodeableConcept CodeableConcept
.... medicationReference Reference(Medication)
... subject SΣ 1..1 Reference(BePatient) Who is/was taking the medication
ele-1: All FHIR elements must have a @value or children
... effective[x] SΣ 1..1 The date/time or interval when the medication is/was/will be taken
ele-1: All FHIR elements must have a @value or children
.... effectiveDateTime dateTime
.... effectivePeriod Period
... dateAsserted SΣ 0..1 dateTime When the statement was asserted?
ele-1: All FHIR elements must have a @value or children
... informationSource S 1..1 Reference(BePatient | BePractitioner | BePractitionerRole | RelatedPerson | BeOrganization) Person or organization that provided the information about the taking of this medication
ele-1: All FHIR elements must have a @value or children
... reasonCode S 0..* CodeableConcept Reason for why the medication is being/was taken
Binding: Condition/Problem/DiagnosisCodes (example): A coded concept identifying why the medication is being taken.


ele-1: All FHIR elements must have a @value or children
... reasonReference S 0..* Reference(Condition | Observation | DiagnosticReport) Condition or observation that supports why the medication is being/was taken
ele-1: All FHIR elements must have a @value or children
... note S 0..* Annotation Further information about the statement
ele-1: All FHIR elements must have a @value or children
... dosage S 0..* Dosage Details of how medication is/was taken or should be taken
ele-1: All FHIR elements must have a @value or children

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
MedicationStatement.identifier:vidis.userequiredIdentifierUse
http://hl7.org/fhir/ValueSet/identifier-use|4.0.1
from the FHIR Standard
MedicationStatement.statusrequiredMedication Status Codes
http://hl7.org/fhir/ValueSet/medication-statement-status|4.0.1
from the FHIR Standard
MedicationStatement.statusReasonexampleSNOMEDCTDrugTherapyStatusCodes
http://hl7.org/fhir/ValueSet/reason-medication-status-codes
from the FHIR Standard
MedicationStatement.categorypreferredMedication usage category codes
http://hl7.org/fhir/ValueSet/medication-statement-category
from the FHIR Standard
MedicationStatement.medication[x]exampleSNOMEDCTMedicationCodes
http://hl7.org/fhir/ValueSet/medication-codes
from the FHIR Standard
MedicationStatement.reasonCodeexampleCondition/Problem/DiagnosisCodes
http://hl7.org/fhir/ValueSet/condition-code
from the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
dom-2errorMedicationStatementIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorMedicationStatementIf 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-4errorMedicationStatementIf 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-5errorMedicationStatementIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceMedicationStatementA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()
offLabel-reason-requirederrorMedicationStatement.extension:offLabelIf 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 MedicationStatement

NameFlagsCard.TypeDescription & Constraintsdoco
.. MedicationStatement MedicationStatement
... Slices for extension 2..* 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/be-ext-OffLabel
..... 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:exposure-category S 0..1 CodeableConcept Exposure category
URL: https://www.ehealth.fgov.be/standards/fhir/medication/StructureDefinition/ExposureCategory
Binding: Medication exposure intent (extensible)
.... extension:dispense-request-needed S 0..1 boolean Indication of whether a dispense request is needed for delivering the medication
URL: https://www.ehealth.fgov.be/standards/fhir/medication/StructureDefinition/DispenseRequestNeededCategory
.... extension:artifact-version S 1..1 string The business version of the medication line - this version changes when the content update is considered clinically relevant
URL: http://hl7.org/fhir/StructureDefinition/artifact-version
.... extension:artifact-date S 0..1 dateTime The business-relevant recorded date - the date the medication line was created or changed
URL: http://hl7.org/fhir/StructureDefinition/artifact-date
.... extension:adherence S 1..1 (Complex) Indicates whether the medication is or is not being consumed or administered
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-MedicationStatement.adherence
... Slices for identifier S 1..* Identifier External identifier
Slice: Unordered, Open by pattern:system
.... identifier:vidis S 0..1 Identifier VIDIS identifier
..... system 1..1 uri The namespace for the identifier value
Required Pattern: http://ehealth.fgov.be/standards/fhir/medication/NamingSystem/be-ns-medicationline
..... value S 0..1 string The value that is unique
... status S 1..1 code active | completed | entered-in-error | intended | stopped | on-hold | unknown | not-taken
... category S 0..1 CodeableConcept Type of medication usage
... medication[x] S 1..1 CodeableConcept, Reference(Medication) What medication was taken
... subject S 1..1 Reference(BePatient) Who is/was taking the medication
... effective[x] S 1..1 dateTime, Period The date/time or interval when the medication is/was/will be taken
... dateAsserted S 0..1 dateTime When the statement was asserted?
... informationSource S 1..1 Reference(BePatient | BePractitioner | BePractitionerRole | RelatedPerson | BeOrganization) Person or organization that provided the information about the taking of this medication
... reasonCode S 0..* CodeableConcept Reason for why the medication is being/was taken
... reasonReference S 0..* Reference(Condition | Observation | DiagnosticReport) Condition or observation that supports why the medication is being/was taken
... note S 0..* Annotation Further information about the statement
... dosage S 0..* Dosage Details of how medication is/was taken or should be taken

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. MedicationStatement 0..* MedicationStatement Record of medication being taken by a patient
... 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
... text 0..1 Narrative Text summary of the resource, for human interpretation
... contained 0..* Resource Contained, inline Resources
... Slices for extension 2..* 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/be-ext-OffLabel
offLabel-reason-required: If isOffLabelUse is true, reason must be provided
..... 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/be-ext-OffLabel"
.... extension:exposure-category S 0..1 CodeableConcept Exposure category
URL: https://www.ehealth.fgov.be/standards/fhir/medication/StructureDefinition/ExposureCategory
Binding: Medication exposure intent (extensible)
.... extension:dispense-request-needed S 0..1 boolean Indication of whether a dispense request is needed for delivering the medication
URL: https://www.ehealth.fgov.be/standards/fhir/medication/StructureDefinition/DispenseRequestNeededCategory
.... extension:artifact-version S 1..1 string The business version of the medication line - this version changes when the content update is considered clinically relevant
URL: http://hl7.org/fhir/StructureDefinition/artifact-version
.... extension:artifact-date S 0..1 dateTime The business-relevant recorded date - the date the medication line was created or changed
URL: http://hl7.org/fhir/StructureDefinition/artifact-date
.... extension:adherence S 1..1 (Complex) Indicates whether the medication is or is not being consumed or administered
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-MedicationStatement.adherence
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... Slices for identifier SΣ 1..* Identifier External identifier
Slice: Unordered, Open by pattern:system
.... identifier:vidis SΣ 0..1 Identifier VIDIS 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-medicationline
..... 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)
... basedOn Σ 0..* Reference(MedicationRequest | CarePlan | ServiceRequest) Fulfils plan, proposal or order
... partOf Σ 0..* Reference(MedicationAdministration | MedicationDispense | MedicationStatement | Procedure | Observation) Part of referenced event
... status ?!SΣ 1..1 code active | completed | entered-in-error | intended | stopped | on-hold | unknown | not-taken
Binding: Medication Status Codes (required): A coded concept indicating the current status of a MedicationStatement.

... statusReason S 0..* CodeableConcept Reason for current status
Binding: SNOMEDCTDrugTherapyStatusCodes (example): A coded concept indicating the reason for the status of the statement.


... category SΣ 0..1 CodeableConcept Type of medication usage
Binding: Medication usage category codes (preferred): A coded concept identifying where the medication included in the MedicationStatement is expected to be consumed or administered.

... medication[x] SΣ 1..1 What medication was taken
Binding: SNOMEDCTMedicationCodes (example): A coded concept identifying the substance or product being taken.

.... medicationCodeableConcept CodeableConcept
.... medicationReference Reference(Medication)
... subject SΣ 1..1 Reference(BePatient) Who is/was taking the medication
... context Σ 0..1 Reference(Encounter | EpisodeOfCare) Encounter / Episode associated with MedicationStatement
... effective[x] SΣ 1..1 The date/time or interval when the medication is/was/will be taken
.... effectiveDateTime dateTime
.... effectivePeriod Period
... dateAsserted SΣ 0..1 dateTime When the statement was asserted?
... informationSource S 1..1 Reference(BePatient | BePractitioner | BePractitionerRole | RelatedPerson | BeOrganization) Person or organization that provided the information about the taking of this medication
... derivedFrom 0..* Reference(Resource) Additional supporting information
... reasonCode S 0..* CodeableConcept Reason for why the medication is being/was taken
Binding: Condition/Problem/DiagnosisCodes (example): A coded concept identifying why the medication is being taken.


... reasonReference S 0..* Reference(Condition | Observation | DiagnosticReport) Condition or observation that supports why the medication is being/was taken
... note S 0..* Annotation Further information about the statement
... dosage S 0..* Dosage Details of how medication is/was taken or should be taken

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
MedicationStatement.languagepreferredCommonLanguages
http://hl7.org/fhir/ValueSet/languages
from the FHIR Standard
Additional Bindings Purpose
AllLanguages Max Binding
MedicationStatement.identifier:vidis.userequiredIdentifierUse
http://hl7.org/fhir/ValueSet/identifier-use|4.0.1
from the FHIR Standard
MedicationStatement.identifier:vidis.typeextensibleIdentifier Type Codes
http://hl7.org/fhir/ValueSet/identifier-type
from the FHIR Standard
MedicationStatement.statusrequiredMedication Status Codes
http://hl7.org/fhir/ValueSet/medication-statement-status|4.0.1
from the FHIR Standard
MedicationStatement.statusReasonexampleSNOMEDCTDrugTherapyStatusCodes
http://hl7.org/fhir/ValueSet/reason-medication-status-codes
from the FHIR Standard
MedicationStatement.categorypreferredMedication usage category codes
http://hl7.org/fhir/ValueSet/medication-statement-category
from the FHIR Standard
MedicationStatement.medication[x]exampleSNOMEDCTMedicationCodes
http://hl7.org/fhir/ValueSet/medication-codes
from the FHIR Standard
MedicationStatement.reasonCodeexampleCondition/Problem/DiagnosisCodes
http://hl7.org/fhir/ValueSet/condition-code
from the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
dom-2errorMedicationStatementIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorMedicationStatementIf 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-4errorMedicationStatementIf 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-5errorMedicationStatementIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceMedicationStatementA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()
offLabel-reason-requirederrorMedicationStatement.extension:offLabelIf 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