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/ and changes regularly. See the Directory of published versions

Resource Profile: BEMedicationLine

Official URL: https://www.ehealth.fgov.be/standards/fhir/medication/StructureDefinition/BEMedicationLine Version: 1.1.0
Draft as of 2024-11-18 Computable Name: BEMedicationLine

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

Usage:

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

Formal Views of Profile Content

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

This structure is derived from MedicationStatement

NameFlagsCard.TypeDescription & Constraintsdoco
.. MedicationStatement 0..* MedicationStatement Record of medication being taken by a patient
... Slices for extension 2..* Extension Extension
Slice: Unordered, Open by value:url
.... exposure-category S 0..1 CodeableConcept Exposure category
URL: https://www.ehealth.fgov.be/standards/fhir/medication/StructureDefinition/ExposureCategory
Binding: Medication exposure intent (extensible)
.... 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
.... 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
.... 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
.... 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
.... Slices for extension Content/Rules for all slices
..... dosage-override S 0..1 boolean Indicates that the recommended dosage was overridden
URL: https://www.ehealth.fgov.be/standards/fhir/medication/StructureDefinition/DosageOverride
..... dosage-override-reason S 0..1 CodeableConcept The reason why the recommended dosage was overridden
URL: https://www.ehealth.fgov.be/standards/fhir/medication/StructureDefinition/DosageOverrideReason

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. MedicationStatement 0..* MedicationStatement Record of medication being taken by a patient
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... Slices for extension 2..* Extension Extension
Slice: Unordered, Open by value:url
.... exposure-category S 0..1 CodeableConcept Exposure category
URL: https://www.ehealth.fgov.be/standards/fhir/medication/StructureDefinition/ExposureCategory
Binding: Medication exposure intent (extensible)
.... 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
.... 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
.... 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
.... 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
.... identifier:vidis SΣ 0..1 Identifier VIDIS 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-medicationline
..... value SΣ 0..1 string The value that is unique
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.

... 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
... 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
... 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
.... Slices for extension Content/Rules for all slices
..... dosage-override S 0..1 boolean Indicates that the recommended dosage was overridden
URL: https://www.ehealth.fgov.be/standards/fhir/medication/StructureDefinition/DosageOverride
..... dosage-override-reason S 0..1 CodeableConcept The reason why the recommended dosage was overridden
URL: https://www.ehealth.fgov.be/standards/fhir/medication/StructureDefinition/DosageOverrideReason
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized

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()
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
.... exposure-category S 0..1 CodeableConcept Exposure category
URL: https://www.ehealth.fgov.be/standards/fhir/medication/StructureDefinition/ExposureCategory
Binding: Medication exposure intent (extensible)
.... 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
.... 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
.... 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
.... 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
.... id 0..1 string Unique id for inter-element referencing
.... Slices for extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... dosage-override S 0..1 boolean Indicates that the recommended dosage was overridden
URL: https://www.ehealth.fgov.be/standards/fhir/medication/StructureDefinition/DosageOverride
..... dosage-override-reason S 0..1 CodeableConcept The reason why the recommended dosage was overridden
URL: https://www.ehealth.fgov.be/standards/fhir/medication/StructureDefinition/DosageOverrideReason
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... sequence Σ 0..1 integer The order of the dosage instructions
.... text Σ 0..1 string Free text dosage instructions e.g. SIG
.... additionalInstruction Σ 0..* CodeableConcept Supplemental instruction or warnings to the patient - e.g. "with meals", "may cause drowsiness"
Binding: SNOMEDCTAdditionalDosageInstructions (example): A coded concept identifying additional instructions such as "take with water" or "avoid operating heavy machinery".


.... patientInstruction Σ 0..1 string Patient or consumer oriented instructions
.... timing Σ 0..1 Timing When medication should be administered
.... asNeeded[x] Σ 0..1 Take "as needed" (for x)
Binding: SNOMEDCTMedicationAsNeededReasonCodes (example): A coded concept identifying the precondition that should be met or evaluated prior to consuming or administering a medication dose. For example "pain", "30 minutes prior to sexual intercourse", "on flare-up" etc.

..... asNeededBoolean boolean
..... asNeededCodeableConcept CodeableConcept
.... site Σ 0..1 CodeableConcept Body site to administer to
Binding: SNOMEDCTAnatomicalStructureForAdministrationSiteCodes (example): A coded concept describing the site location the medicine enters into or onto the body.

.... route Σ 0..1 CodeableConcept How drug should enter body
Binding: SNOMEDCTRouteCodes (example): A coded concept describing the route or physiological path of administration of a therapeutic agent into or onto the body of a subject.

.... method Σ 0..1 CodeableConcept Technique for administering medication
Binding: SNOMEDCTAdministrationMethodCodes (example): A coded concept describing the technique by which the medicine is administered.

.... doseAndRate Σ 0..* Element Amount of medication administered
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... type Σ 0..1 CodeableConcept The kind of dose or rate specified
Binding: DoseAndRateType (example): The kind of dose or rate specified.

..... dose[x] Σ 0..1 Amount of medication per dose
...... doseRange Range
...... doseQuantity Quantity(SimpleQuantity)
..... rate[x] Σ 0..1 Amount of medication per unit of time
...... rateRatio Ratio
...... rateRange Range
...... rateQuantity Quantity(SimpleQuantity)
.... maxDosePerPeriod Σ 0..1 Ratio Upper limit on medication per unit of time
.... maxDosePerAdministration Σ 0..1 SimpleQuantity Upper limit on medication per administration
.... maxDosePerLifetime Σ 0..1 SimpleQuantity Upper limit on medication per lifetime of the patient

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
MedicationStatement.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
http://hl7.org/fhir/ValueSet/languages
from the FHIR Standard
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
MedicationStatement.dosage.additionalInstructionexampleSNOMEDCTAdditionalDosageInstructions
http://hl7.org/fhir/ValueSet/additional-instruction-codes
from the FHIR Standard
MedicationStatement.dosage.asNeeded[x]exampleSNOMEDCTMedicationAsNeededReasonCodes
http://hl7.org/fhir/ValueSet/medication-as-needed-reason
from the FHIR Standard
MedicationStatement.dosage.siteexampleSNOMEDCTAnatomicalStructureForAdministrationSiteCodes
http://hl7.org/fhir/ValueSet/approach-site-codes
from the FHIR Standard
MedicationStatement.dosage.routeexampleSNOMEDCTRouteCodes
http://hl7.org/fhir/ValueSet/route-codes
from the FHIR Standard
MedicationStatement.dosage.methodexampleSNOMEDCTAdministrationMethodCodes
http://hl7.org/fhir/ValueSet/administration-method-codes
from the FHIR Standard
MedicationStatement.dosage.doseAndRate.typeexampleDoseAndRateType
http://hl7.org/fhir/ValueSet/dose-rate-type
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()

Differential View

This structure is derived from MedicationStatement

NameFlagsCard.TypeDescription & Constraintsdoco
.. MedicationStatement 0..* MedicationStatement Record of medication being taken by a patient
... Slices for extension 2..* Extension Extension
Slice: Unordered, Open by value:url
.... exposure-category S 0..1 CodeableConcept Exposure category
URL: https://www.ehealth.fgov.be/standards/fhir/medication/StructureDefinition/ExposureCategory
Binding: Medication exposure intent (extensible)
.... 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
.... 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
.... 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
.... 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
.... Slices for extension Content/Rules for all slices
..... dosage-override S 0..1 boolean Indicates that the recommended dosage was overridden
URL: https://www.ehealth.fgov.be/standards/fhir/medication/StructureDefinition/DosageOverride
..... dosage-override-reason S 0..1 CodeableConcept The reason why the recommended dosage was overridden
URL: https://www.ehealth.fgov.be/standards/fhir/medication/StructureDefinition/DosageOverrideReason

doco Documentation for this format

Key Elements View

NameFlagsCard.TypeDescription & Constraintsdoco
.. MedicationStatement 0..* MedicationStatement Record of medication being taken by a patient
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... Slices for extension 2..* Extension Extension
Slice: Unordered, Open by value:url
.... exposure-category S 0..1 CodeableConcept Exposure category
URL: https://www.ehealth.fgov.be/standards/fhir/medication/StructureDefinition/ExposureCategory
Binding: Medication exposure intent (extensible)
.... 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
.... 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
.... 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
.... 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
.... identifier:vidis SΣ 0..1 Identifier VIDIS 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-medicationline
..... value SΣ 0..1 string The value that is unique
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.

... 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
... 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
... 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
.... Slices for extension Content/Rules for all slices
..... dosage-override S 0..1 boolean Indicates that the recommended dosage was overridden
URL: https://www.ehealth.fgov.be/standards/fhir/medication/StructureDefinition/DosageOverride
..... dosage-override-reason S 0..1 CodeableConcept The reason why the recommended dosage was overridden
URL: https://www.ehealth.fgov.be/standards/fhir/medication/StructureDefinition/DosageOverrideReason
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized

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()

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
.... exposure-category S 0..1 CodeableConcept Exposure category
URL: https://www.ehealth.fgov.be/standards/fhir/medication/StructureDefinition/ExposureCategory
Binding: Medication exposure intent (extensible)
.... 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
.... 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
.... 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
.... 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
.... id 0..1 string Unique id for inter-element referencing
.... Slices for extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... dosage-override S 0..1 boolean Indicates that the recommended dosage was overridden
URL: https://www.ehealth.fgov.be/standards/fhir/medication/StructureDefinition/DosageOverride
..... dosage-override-reason S 0..1 CodeableConcept The reason why the recommended dosage was overridden
URL: https://www.ehealth.fgov.be/standards/fhir/medication/StructureDefinition/DosageOverrideReason
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... sequence Σ 0..1 integer The order of the dosage instructions
.... text Σ 0..1 string Free text dosage instructions e.g. SIG
.... additionalInstruction Σ 0..* CodeableConcept Supplemental instruction or warnings to the patient - e.g. "with meals", "may cause drowsiness"
Binding: SNOMEDCTAdditionalDosageInstructions (example): A coded concept identifying additional instructions such as "take with water" or "avoid operating heavy machinery".


.... patientInstruction Σ 0..1 string Patient or consumer oriented instructions
.... timing Σ 0..1 Timing When medication should be administered
.... asNeeded[x] Σ 0..1 Take "as needed" (for x)
Binding: SNOMEDCTMedicationAsNeededReasonCodes (example): A coded concept identifying the precondition that should be met or evaluated prior to consuming or administering a medication dose. For example "pain", "30 minutes prior to sexual intercourse", "on flare-up" etc.

..... asNeededBoolean boolean
..... asNeededCodeableConcept CodeableConcept
.... site Σ 0..1 CodeableConcept Body site to administer to
Binding: SNOMEDCTAnatomicalStructureForAdministrationSiteCodes (example): A coded concept describing the site location the medicine enters into or onto the body.

.... route Σ 0..1 CodeableConcept How drug should enter body
Binding: SNOMEDCTRouteCodes (example): A coded concept describing the route or physiological path of administration of a therapeutic agent into or onto the body of a subject.

.... method Σ 0..1 CodeableConcept Technique for administering medication
Binding: SNOMEDCTAdministrationMethodCodes (example): A coded concept describing the technique by which the medicine is administered.

.... doseAndRate Σ 0..* Element Amount of medication administered
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... type Σ 0..1 CodeableConcept The kind of dose or rate specified
Binding: DoseAndRateType (example): The kind of dose or rate specified.

..... dose[x] Σ 0..1 Amount of medication per dose
...... doseRange Range
...... doseQuantity Quantity(SimpleQuantity)
..... rate[x] Σ 0..1 Amount of medication per unit of time
...... rateRatio Ratio
...... rateRange Range
...... rateQuantity Quantity(SimpleQuantity)
.... maxDosePerPeriod Σ 0..1 Ratio Upper limit on medication per unit of time
.... maxDosePerAdministration Σ 0..1 SimpleQuantity Upper limit on medication per administration
.... maxDosePerLifetime Σ 0..1 SimpleQuantity Upper limit on medication per lifetime of the patient

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
MedicationStatement.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
http://hl7.org/fhir/ValueSet/languages
from the FHIR Standard
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
MedicationStatement.dosage.additionalInstructionexampleSNOMEDCTAdditionalDosageInstructions
http://hl7.org/fhir/ValueSet/additional-instruction-codes
from the FHIR Standard
MedicationStatement.dosage.asNeeded[x]exampleSNOMEDCTMedicationAsNeededReasonCodes
http://hl7.org/fhir/ValueSet/medication-as-needed-reason
from the FHIR Standard
MedicationStatement.dosage.siteexampleSNOMEDCTAnatomicalStructureForAdministrationSiteCodes
http://hl7.org/fhir/ValueSet/approach-site-codes
from the FHIR Standard
MedicationStatement.dosage.routeexampleSNOMEDCTRouteCodes
http://hl7.org/fhir/ValueSet/route-codes
from the FHIR Standard
MedicationStatement.dosage.methodexampleSNOMEDCTAdministrationMethodCodes
http://hl7.org/fhir/ValueSet/administration-method-codes
from the FHIR Standard
MedicationStatement.dosage.doseAndRate.typeexampleDoseAndRateType
http://hl7.org/fhir/ValueSet/dose-rate-type
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()

 

Other representations of profile: CSV, Excel, Schematron