Kenya eClaims FHIR IG
0.1.0 - ci-build Kenya flag

Kenya eClaims FHIR IG - Local Development build (v0.1.0) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions

Resource Profile: MedicationDispense Profile

Official URL: https://example.com/fhir/StructureDefinition/eclaims-medicationdispense Version: 0.1.0
Draft as of 2025-12-09 Computable Name: eClaimsMedicationDispense

This profile defines constraints on the MedicationDispense resource for use within the Kenya eClaims Implementation Guide. It documents the supply of medication to a patient, including quantity, dosage, and dispensing provider, supporting claim justification and medication traceability.

Usages:

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
.. MedicationDispense C 0..* MedicationDispense Dispensing a medication to a named patient
Constraints: mdd-1
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... status ?!SΣ 1..1 code preparation | in-progress | cancelled | on-hold | completed | entered-in-error | stopped | declined | unknown
Binding: MedicationDispense Status Codes (required): A coded concept specifying the state of the dispense event.
.... medicationCodeableConcept CodeableConcept
.... medicationReference Reference(Medication)
.... medication[x]:medicationCodeableConcept Σ 0..1 CodeableConcept What medication was supplied
Binding: Generic Medicinal Products (required)
..... coding Σ 1..1 Coding Code defined by a terminology system
...... system Σ 1..1 uri Identity of the terminology system
Fixed Value: https://hapi.slade360edi.com/fhir/CodeSystem/product-catalogue
...... code SΣ 1..1 code Symbol in syntax defined by the system
Binding: Generic Medicinal Products (required)
...... display SΣ 1..1 string Representation defined by the system
... subject SΣ 0..1 Reference(Patient | Group) Who the dispense is for
.... reference SΣC 1..1 string Literal reference, Relative, internal or absolute URL
.... display SΣ 1..1 string Text alternative for the resource
... performer S 1..1 BackboneElement Who performed event
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... actor S 1..1 Reference(Practitioner) Individual who was performing
... location S 0..1 Reference(Location) Where the dispense occurred
... authorizingPrescription S 1..1 Reference(MedicationRequest) Medication order that authorizes the dispense
... type S 1..1 CodeableConcept Trial fill, partial fill, emergency fill, etc.
Binding: ActPharmacySupplyType (example): Indicates the type of dispensing event that is performed. For example, Trial Fill, Completion of Trial, Partial Fill, Emergency Fill, Samples, etc.
... quantity S 1..1 SimpleQuantity(4.0.1) Amount dispensed
... whenHandedOver S 1..1 dateTime When product was given out
... dosageInstruction 0..* Dosage How the medication is to be used by the patient or administered by the caregiver
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... sequence SΣ 1..1 integer The order of the dosage instructions
.... text SΣ 1..1 string Free text dosage instructions e.g. SIG
.... additionalInstruction SΣ 1..* 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 SΣ 1..1 string Patient or consumer oriented instructions
.... timing SΣ 1..1 Timing When medication should be administered
.... asNeeded[x] SΣ 1..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 SΣ 1..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 SΣ 1..1 CodeableConcept How drug should enter body
Binding: Route of Administration (required)
.... method SΣ 0..1 CodeableConcept Technique for administering medication
Binding: SNOMEDCTAdministrationMethodCodes (example): A coded concept describing the technique by which the medicine is administered.
.... doseAndRate SΣ 0..* Element Amount of medication administered
..... type SΣ 0..1 CodeableConcept The kind of dose or rate specified
Binding: DoseAndRateType (example): The kind of dose or rate specified.
..... Slices for dose[x] Σ 0..1 Amount of medication per dose
Slice: Unordered, Closed by type:$this
...... doseRange Range
...... doseQuantity Quantity(SimpleQuantity)
...... dose[x]:doseRange SΣ 0..1 Range Amount of medication per dose
...... dose[x]:doseQuantity SΣ 0..1 SimpleQuantity Amount of medication per dose
..... Slices for rate[x] Σ 0..1 Amount of medication per unit of time
Slice: Unordered, Closed by type:$this
...... rateRatio Ratio
...... rateRange Range
...... rateQuantity Quantity(SimpleQuantity)
...... rate[x]:rateRatio SΣ 0..1 Ratio Amount of medication per unit of time
...... rate[x]:rateRange SΣ 0..1 Range Amount of medication per unit of time
...... rate[x]:rateQuantity SΣ 0..1 SimpleQuantity Amount of medication per unit of time
.... maxDosePerPeriod SΣ 0..1 Ratio Upper limit on medication per unit of time
.... maxDosePerAdministration SΣ 0..1 SimpleQuantity(4.0.1) Upper limit on medication per administration
.... maxDosePerLifetime SΣ 0..1 SimpleQuantity(4.0.1) Upper limit on medication per lifetime of the patient

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
MedicationDispense.status Base required Medication dispense status codes 📍4.0.1 FHIR Std.
MedicationDispense.medication[x] Base example SNOMED CT Medication Codes 📍4.0.1 FHIR Std.
MedicationDispense.medication[x]:medicationCodeableConcept Base required Generic Medicinal Products 📦0.1.0 This IG
MedicationDispense.medication[x]:medicationCodeableConcept.​coding.code Base required Generic Medicinal Products 📦0.1.0 This IG
MedicationDispense.type Base example ActPharmacySupplyType 📦3.0.0 THO v7.0
MedicationDispense.dosageInstruction.​additionalInstruction Base example SNOMED CT Additional Dosage Instructions 📍4.0.1 FHIR Std.
MedicationDispense.dosageInstruction.​asNeeded[x] Base example SNOMED CT Medication As Needed Reason Codes 📍4.0.1 FHIR Std.
MedicationDispense.dosageInstruction.​site Base example SNOMED CT Anatomical Structure for Administration Site Codes 📍4.0.1 FHIR Std.
MedicationDispense.dosageInstruction.​route Base required Route of Administration 📦0.1.0 This IG
MedicationDispense.dosageInstruction.​method Base example SNOMED CT Administration Method Codes 📍4.0.1 FHIR Std.
MedicationDispense.dosageInstruction.​doseAndRate.type Base example DoseAndRateType 📍4.0.1 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
dom-2 error MedicationDispense If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error MedicationDispense 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 MedicationDispense 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 MedicationDispense If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice MedicationDispense A resource should have narrative for robust management text.`div`.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()
mdd-1 error MedicationDispense whenHandedOver cannot be before whenPrepared whenHandedOver.empty() or whenPrepared.empty() or whenHandedOver >= whenPrepared

This structure is derived from MedicationDispense

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. MedicationDispense 0..* MedicationDispense Dispensing a medication to a named patient
... status S 1..1 code preparation | in-progress | cancelled | on-hold | completed | entered-in-error | stopped | declined | unknown
... Slices for medication[x] S 1..1 CodeableConcept, Reference(Medication) What medication was supplied
Slice: Unordered, Open by type:$this
.... medication[x]:medicationCodeableConcept 0..1 CodeableConcept What medication was supplied
Binding: Generic Medicinal Products (required)
..... coding 1..1 Coding Code defined by a terminology system
...... system 1..1 uri Identity of the terminology system
Fixed Value: https://hapi.slade360edi.com/fhir/CodeSystem/product-catalogue
...... code S 1..1 code Symbol in syntax defined by the system
Binding: Generic Medicinal Products (required)
...... display S 1..1 string Representation defined by the system
... subject S 0..1 Reference(Patient | Group) Who the dispense is for
.... reference S 1..1 string Literal reference, Relative, internal or absolute URL
.... display S 1..1 string Text alternative for the resource
.... actor S 1..1 Reference(Practitioner) Individual who was performing
... location S 0..1 Reference(Location) Where the dispense occurred
... authorizingPrescription S 1..1 Reference(MedicationRequest) Medication order that authorizes the dispense
... type S 1..1 CodeableConcept Trial fill, partial fill, emergency fill, etc.
... quantity S 1..1 SimpleQuantity(4.0.1) Amount dispensed
... whenHandedOver S 1..1 dateTime When product was given out
... dosageInstruction
.... sequence S 1..1 integer The order of the dosage instructions
.... text S 1..1 string Free text dosage instructions e.g. SIG
.... additionalInstruction S 1..* CodeableConcept Supplemental instruction or warnings to the patient - e.g. "with meals", "may cause drowsiness"
.... patientInstruction S 1..1 string Patient or consumer oriented instructions
.... timing S 1..1 Timing When medication should be administered
.... asNeeded[x] S 1..1 boolean, CodeableConcept Take "as needed" (for x)
.... site S 1..1 CodeableConcept Body site to administer to
.... route S 1..1 CodeableConcept How drug should enter body
Binding: Route of Administration (required)
..... coding
...... system 0..1 uri Identity of the terminology system
Fixed Value: https://hapi.slade360edi.com/fhir/CodeSystem/product-catalogue
.... method S 0..1 CodeableConcept Technique for administering medication
.... doseAndRate S 0..* Element Amount of medication administered
..... type S 0..1 CodeableConcept The kind of dose or rate specified
..... Slices for dose[x] 0..1 Range, SimpleQuantity(4.0.1) Amount of medication per dose
Slice: Unordered, Open by type:$this
...... dose[x]:doseRange S 0..1 Range Amount of medication per dose
...... dose[x]:doseQuantity S 0..1 SimpleQuantity Amount of medication per dose
..... Slices for rate[x] 0..1 Ratio, Range, SimpleQuantity(4.0.1) Amount of medication per unit of time
Slice: Unordered, Open by type:$this
...... rate[x]:rateRatio S 0..1 Ratio Amount of medication per unit of time
...... rate[x]:rateRange S 0..1 Range Amount of medication per unit of time
...... rate[x]:rateQuantity S 0..1 SimpleQuantity Amount of medication per unit of time
.... maxDosePerPeriod S 0..1 Ratio Upper limit on medication per unit of time
.... maxDosePerAdministration S 0..1 SimpleQuantity(4.0.1) Upper limit on medication per administration
.... maxDosePerLifetime S 0..1 SimpleQuantity(4.0.1) Upper limit on medication per lifetime of the patient

doco Documentation for this format

Terminology Bindings (Differential)

Path Status Usage ValueSet Version Source
MedicationDispense.medication[x]:medicationCodeableConcept Base required Generic Medicinal Products 📦0.1.0 This IG
MedicationDispense.medication[x]:medicationCodeableConcept.​coding.code Base required Generic Medicinal Products 📦0.1.0 This IG
MedicationDispense.dosageInstruction.​route Base required Route of Administration 📦0.1.0 This IG
NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. MedicationDispense C 0..* MedicationDispense Dispensing a medication to a named patient
Constraints: mdd-1
... 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
... extension 0..* Extension Additional content defined by implementations
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... identifier 0..* Identifier External identifier
... partOf 0..* Reference(Procedure) Event that dispense is part of
... status ?!SΣ 1..1 code preparation | in-progress | cancelled | on-hold | completed | entered-in-error | stopped | declined | unknown
Binding: MedicationDispense Status Codes (required): A coded concept specifying the state of the dispense event.
... statusReason[x] 0..1 Why a dispense was not performed
Binding: MedicationDispense Status Reason Codes (example): A code describing why a dispense was not performed.
.... statusReasonCodeableConcept CodeableConcept
.... statusReasonReference Reference(DetectedIssue)
... category 0..1 CodeableConcept Type of medication dispense
Binding: MedicationDispense Category Codes (preferred): A code describing where the dispensed medication is expected to be consumed or administered.
... Slices for medication[x] SΣ 1..1 What medication was supplied
Slice: Unordered, Open by type:$this
Binding: SNOMEDCTMedicationCodes (example): A coded concept identifying which substance or product can be dispensed.
.... medicationCodeableConcept CodeableConcept
.... medicationReference Reference(Medication)
.... medication[x]:medicationCodeableConcept Σ 0..1 CodeableConcept What medication was supplied
Binding: Generic Medicinal Products (required)
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... coding Σ 1..1 Coding Code defined by a terminology system
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
...... system Σ 1..1 uri Identity of the terminology system
Fixed Value: https://hapi.slade360edi.com/fhir/CodeSystem/product-catalogue
...... version Σ 0..1 string Version of the system - if relevant
...... code SΣ 1..1 code Symbol in syntax defined by the system
Binding: Generic Medicinal Products (required)
...... display SΣ 1..1 string Representation defined by the system
...... userSelected Σ 0..1 boolean If this coding was chosen directly by the user
..... text Σ 0..1 string Plain text representation of the concept
... subject SΣ 0..1 Reference(Patient | Group) Who the dispense is 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
.... reference SΣC 1..1 string Literal reference, Relative, internal or absolute URL
.... type Σ 0..1 uri Type the reference refers to (e.g. "Patient")
Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model).
.... identifier Σ 0..1 Identifier Logical reference, when literal reference is not known
.... display SΣ 1..1 string Text alternative for the resource
... context 0..1 Reference(Encounter | EpisodeOfCare) Encounter / Episode associated with event
... supportingInformation 0..* Reference(Resource) Information that supports the dispensing of the medication
... performer S 1..1 BackboneElement Who performed event
.... 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
.... function 0..1 CodeableConcept Who performed the dispense and what they did
Binding: MedicationDispense Performer Function Codes (example): A code describing the role an individual played in dispensing a medication.
.... actor S 1..1 Reference(Practitioner) Individual who was performing
... location S 0..1 Reference(Location) Where the dispense occurred
... authorizingPrescription S 1..1 Reference(MedicationRequest) Medication order that authorizes the dispense
... type S 1..1 CodeableConcept Trial fill, partial fill, emergency fill, etc.
Binding: ActPharmacySupplyType (example): Indicates the type of dispensing event that is performed. For example, Trial Fill, Completion of Trial, Partial Fill, Emergency Fill, Samples, etc.
... quantity S 1..1 SimpleQuantity(4.0.1) Amount dispensed
... daysSupply 0..1 SimpleQuantity(4.0.1) Amount of medication expressed as a timing amount
... whenPrepared Σ 0..1 dateTime When product was packaged and reviewed
... whenHandedOver S 1..1 dateTime When product was given out
... destination 0..1 Reference(Location) Where the medication was sent
... receiver 0..* Reference(Patient | Practitioner) Who collected the medication
... note 0..* Annotation Information about the dispense
... dosageInstruction 0..* Dosage How the medication is to be used by the patient or administered by the caregiver
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... sequence SΣ 1..1 integer The order of the dosage instructions
.... text SΣ 1..1 string Free text dosage instructions e.g. SIG
.... additionalInstruction SΣ 1..* 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 SΣ 1..1 string Patient or consumer oriented instructions
.... timing SΣ 1..1 Timing When medication should be administered
.... asNeeded[x] SΣ 1..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 SΣ 1..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 SΣ 1..1 CodeableConcept How drug should enter body
Binding: Route of Administration (required)
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... coding Σ 0..* Coding Code defined by a terminology system
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
...... system Σ 0..1 uri Identity of the terminology system
Fixed Value: https://hapi.slade360edi.com/fhir/CodeSystem/product-catalogue
...... version Σ 0..1 string Version of the system - if relevant
...... code Σ 0..1 code Symbol in syntax defined by the system
...... display Σ 0..1 string Representation defined by the system
...... userSelected Σ 0..1 boolean If this coding was chosen directly by the user
..... text Σ 0..1 string Plain text representation of the concept
.... method SΣ 0..1 CodeableConcept Technique for administering medication
Binding: SNOMEDCTAdministrationMethodCodes (example): A coded concept describing the technique by which the medicine is administered.
.... doseAndRate SΣ 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 SΣ 0..1 CodeableConcept The kind of dose or rate specified
Binding: DoseAndRateType (example): The kind of dose or rate specified.
..... Slices for dose[x] Σ 0..1 Amount of medication per dose
Slice: Unordered, Closed by type:$this
...... doseRange Range
...... doseQuantity Quantity(SimpleQuantity)
...... dose[x]:doseRange SΣ 0..1 Range Amount of medication per dose
...... dose[x]:doseQuantity SΣ 0..1 SimpleQuantity Amount of medication per dose
..... Slices for rate[x] Σ 0..1 Amount of medication per unit of time
Slice: Unordered, Closed by type:$this
...... rateRatio Ratio
...... rateRange Range
...... rateQuantity Quantity(SimpleQuantity)
...... rate[x]:rateRatio SΣ 0..1 Ratio Amount of medication per unit of time
...... rate[x]:rateRange SΣ 0..1 Range Amount of medication per unit of time
...... rate[x]:rateQuantity SΣ 0..1 SimpleQuantity Amount of medication per unit of time
.... maxDosePerPeriod SΣ 0..1 Ratio Upper limit on medication per unit of time
.... maxDosePerAdministration SΣ 0..1 SimpleQuantity(4.0.1) Upper limit on medication per administration
.... maxDosePerLifetime SΣ 0..1 SimpleQuantity(4.0.1) Upper limit on medication per lifetime of the patient
... substitution 0..1 BackboneElement Whether a substitution was performed on the dispense
.... 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
.... wasSubstituted 1..1 boolean Whether a substitution was or was not performed on the dispense
.... type 0..1 CodeableConcept Code signifying whether a different drug was dispensed from what was prescribed
Binding: ActSubstanceAdminSubstitutionCode (example): A coded concept describing whether a different medicinal product may be dispensed other than the product as specified exactly in the prescription.
.... reason 0..* CodeableConcept Why was substitution made
Binding: SubstanceAdminSubstitutionReason (example): A coded concept describing the reason that a different medication should (or should not) be substituted from what was prescribed.
.... responsibleParty 0..* Reference(Practitioner | PractitionerRole) Who is responsible for the substitution
... detectedIssue 0..* Reference(DetectedIssue) Clinical issue with action
... eventHistory 0..* Reference(Provenance) A list of relevant lifecycle events

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
MedicationDispense.language Base preferred Common Languages 📍4.0.1 FHIR Std.
MedicationDispense.status Base required Medication dispense status codes 📍4.0.1 FHIR Std.
MedicationDispense.statusReason[x] Base example Medication dispense status reason codes 📍4.0.1 FHIR Std.
MedicationDispense.category Base preferred Medication dispense category codes 📍4.0.1 FHIR Std.
MedicationDispense.medication[x] Base example SNOMED CT Medication Codes 📍4.0.1 FHIR Std.
MedicationDispense.medication[x]:medicationCodeableConcept Base required Generic Medicinal Products 📦0.1.0 This IG
MedicationDispense.medication[x]:medicationCodeableConcept.​coding.code Base required Generic Medicinal Products 📦0.1.0 This IG
MedicationDispense.subject.​type Base extensible ResourceType 📍4.0.1 FHIR Std.
MedicationDispense.performer.​function Base example Medication dispense performer function codes 📍4.0.1 FHIR Std.
MedicationDispense.type Base example ActPharmacySupplyType 📦3.0.0 THO v7.0
MedicationDispense.dosageInstruction.​additionalInstruction Base example SNOMED CT Additional Dosage Instructions 📍4.0.1 FHIR Std.
MedicationDispense.dosageInstruction.​asNeeded[x] Base example SNOMED CT Medication As Needed Reason Codes 📍4.0.1 FHIR Std.
MedicationDispense.dosageInstruction.​site Base example SNOMED CT Anatomical Structure for Administration Site Codes 📍4.0.1 FHIR Std.
MedicationDispense.dosageInstruction.​route Base required Route of Administration 📦0.1.0 This IG
MedicationDispense.dosageInstruction.​method Base example SNOMED CT Administration Method Codes 📍4.0.1 FHIR Std.
MedicationDispense.dosageInstruction.​doseAndRate.type Base example DoseAndRateType 📍4.0.1 FHIR Std.
MedicationDispense.substitution.​type Base example ActSubstanceAdminSubstitutionCode 📦3.0.0 THO v7.0
MedicationDispense.substitution.​reason Base example SubstanceAdminSubstitutionReason 📦3.0.0 THO v7.0

Constraints

Id Grade Path(s) Description Expression
dom-2 error MedicationDispense If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error MedicationDispense 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 MedicationDispense 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 MedicationDispense If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice MedicationDispense A resource should have narrative for robust management text.`div`.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()
mdd-1 error MedicationDispense whenHandedOver cannot be before whenPrepared whenHandedOver.empty() or whenPrepared.empty() or whenHandedOver >= whenPrepared

This structure is derived from MedicationDispense

Summary

Mandatory: 5 elements(14 nested mandatory elements)
Must-Support: 33 elements
Fixed: 2 elements

Structures

This structure refers to these other structures:

Slices

This structure defines the following Slices:

  • The element 1 is sliced based on the value of MedicationDispense.medication[x]
  • The element 1 is sliced based on the value of MedicationDispense.dosageInstruction.doseAndRate.dose[x]
  • The element 1 is sliced based on the value of MedicationDispense.dosageInstruction.doseAndRate.rate[x]

Key Elements View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. MedicationDispense C 0..* MedicationDispense Dispensing a medication to a named patient
Constraints: mdd-1
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... status ?!SΣ 1..1 code preparation | in-progress | cancelled | on-hold | completed | entered-in-error | stopped | declined | unknown
Binding: MedicationDispense Status Codes (required): A coded concept specifying the state of the dispense event.
.... medicationCodeableConcept CodeableConcept
.... medicationReference Reference(Medication)
.... medication[x]:medicationCodeableConcept Σ 0..1 CodeableConcept What medication was supplied
Binding: Generic Medicinal Products (required)
..... coding Σ 1..1 Coding Code defined by a terminology system
...... system Σ 1..1 uri Identity of the terminology system
Fixed Value: https://hapi.slade360edi.com/fhir/CodeSystem/product-catalogue
...... code SΣ 1..1 code Symbol in syntax defined by the system
Binding: Generic Medicinal Products (required)
...... display SΣ 1..1 string Representation defined by the system
... subject SΣ 0..1 Reference(Patient | Group) Who the dispense is for
.... reference SΣC 1..1 string Literal reference, Relative, internal or absolute URL
.... display SΣ 1..1 string Text alternative for the resource
... performer S 1..1 BackboneElement Who performed event
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... actor S 1..1 Reference(Practitioner) Individual who was performing
... location S 0..1 Reference(Location) Where the dispense occurred
... authorizingPrescription S 1..1 Reference(MedicationRequest) Medication order that authorizes the dispense
... type S 1..1 CodeableConcept Trial fill, partial fill, emergency fill, etc.
Binding: ActPharmacySupplyType (example): Indicates the type of dispensing event that is performed. For example, Trial Fill, Completion of Trial, Partial Fill, Emergency Fill, Samples, etc.
... quantity S 1..1 SimpleQuantity(4.0.1) Amount dispensed
... whenHandedOver S 1..1 dateTime When product was given out
... dosageInstruction 0..* Dosage How the medication is to be used by the patient or administered by the caregiver
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... sequence SΣ 1..1 integer The order of the dosage instructions
.... text SΣ 1..1 string Free text dosage instructions e.g. SIG
.... additionalInstruction SΣ 1..* 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 SΣ 1..1 string Patient or consumer oriented instructions
.... timing SΣ 1..1 Timing When medication should be administered
.... asNeeded[x] SΣ 1..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 SΣ 1..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 SΣ 1..1 CodeableConcept How drug should enter body
Binding: Route of Administration (required)
.... method SΣ 0..1 CodeableConcept Technique for administering medication
Binding: SNOMEDCTAdministrationMethodCodes (example): A coded concept describing the technique by which the medicine is administered.
.... doseAndRate SΣ 0..* Element Amount of medication administered
..... type SΣ 0..1 CodeableConcept The kind of dose or rate specified
Binding: DoseAndRateType (example): The kind of dose or rate specified.
..... Slices for dose[x] Σ 0..1 Amount of medication per dose
Slice: Unordered, Closed by type:$this
...... doseRange Range
...... doseQuantity Quantity(SimpleQuantity)
...... dose[x]:doseRange SΣ 0..1 Range Amount of medication per dose
...... dose[x]:doseQuantity SΣ 0..1 SimpleQuantity Amount of medication per dose
..... Slices for rate[x] Σ 0..1 Amount of medication per unit of time
Slice: Unordered, Closed by type:$this
...... rateRatio Ratio
...... rateRange Range
...... rateQuantity Quantity(SimpleQuantity)
...... rate[x]:rateRatio SΣ 0..1 Ratio Amount of medication per unit of time
...... rate[x]:rateRange SΣ 0..1 Range Amount of medication per unit of time
...... rate[x]:rateQuantity SΣ 0..1 SimpleQuantity Amount of medication per unit of time
.... maxDosePerPeriod SΣ 0..1 Ratio Upper limit on medication per unit of time
.... maxDosePerAdministration SΣ 0..1 SimpleQuantity(4.0.1) Upper limit on medication per administration
.... maxDosePerLifetime SΣ 0..1 SimpleQuantity(4.0.1) Upper limit on medication per lifetime of the patient

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
MedicationDispense.status Base required Medication dispense status codes 📍4.0.1 FHIR Std.
MedicationDispense.medication[x] Base example SNOMED CT Medication Codes 📍4.0.1 FHIR Std.
MedicationDispense.medication[x]:medicationCodeableConcept Base required Generic Medicinal Products 📦0.1.0 This IG
MedicationDispense.medication[x]:medicationCodeableConcept.​coding.code Base required Generic Medicinal Products 📦0.1.0 This IG
MedicationDispense.type Base example ActPharmacySupplyType 📦3.0.0 THO v7.0
MedicationDispense.dosageInstruction.​additionalInstruction Base example SNOMED CT Additional Dosage Instructions 📍4.0.1 FHIR Std.
MedicationDispense.dosageInstruction.​asNeeded[x] Base example SNOMED CT Medication As Needed Reason Codes 📍4.0.1 FHIR Std.
MedicationDispense.dosageInstruction.​site Base example SNOMED CT Anatomical Structure for Administration Site Codes 📍4.0.1 FHIR Std.
MedicationDispense.dosageInstruction.​route Base required Route of Administration 📦0.1.0 This IG
MedicationDispense.dosageInstruction.​method Base example SNOMED CT Administration Method Codes 📍4.0.1 FHIR Std.
MedicationDispense.dosageInstruction.​doseAndRate.type Base example DoseAndRateType 📍4.0.1 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
dom-2 error MedicationDispense If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error MedicationDispense 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 MedicationDispense 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 MedicationDispense If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice MedicationDispense A resource should have narrative for robust management text.`div`.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()
mdd-1 error MedicationDispense whenHandedOver cannot be before whenPrepared whenHandedOver.empty() or whenPrepared.empty() or whenHandedOver >= whenPrepared

Differential View

This structure is derived from MedicationDispense

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. MedicationDispense 0..* MedicationDispense Dispensing a medication to a named patient
... status S 1..1 code preparation | in-progress | cancelled | on-hold | completed | entered-in-error | stopped | declined | unknown
... Slices for medication[x] S 1..1 CodeableConcept, Reference(Medication) What medication was supplied
Slice: Unordered, Open by type:$this
.... medication[x]:medicationCodeableConcept 0..1 CodeableConcept What medication was supplied
Binding: Generic Medicinal Products (required)
..... coding 1..1 Coding Code defined by a terminology system
...... system 1..1 uri Identity of the terminology system
Fixed Value: https://hapi.slade360edi.com/fhir/CodeSystem/product-catalogue
...... code S 1..1 code Symbol in syntax defined by the system
Binding: Generic Medicinal Products (required)
...... display S 1..1 string Representation defined by the system
... subject S 0..1 Reference(Patient | Group) Who the dispense is for
.... reference S 1..1 string Literal reference, Relative, internal or absolute URL
.... display S 1..1 string Text alternative for the resource
.... actor S 1..1 Reference(Practitioner) Individual who was performing
... location S 0..1 Reference(Location) Where the dispense occurred
... authorizingPrescription S 1..1 Reference(MedicationRequest) Medication order that authorizes the dispense
... type S 1..1 CodeableConcept Trial fill, partial fill, emergency fill, etc.
... quantity S 1..1 SimpleQuantity(4.0.1) Amount dispensed
... whenHandedOver S 1..1 dateTime When product was given out
... dosageInstruction
.... sequence S 1..1 integer The order of the dosage instructions
.... text S 1..1 string Free text dosage instructions e.g. SIG
.... additionalInstruction S 1..* CodeableConcept Supplemental instruction or warnings to the patient - e.g. "with meals", "may cause drowsiness"
.... patientInstruction S 1..1 string Patient or consumer oriented instructions
.... timing S 1..1 Timing When medication should be administered
.... asNeeded[x] S 1..1 boolean, CodeableConcept Take "as needed" (for x)
.... site S 1..1 CodeableConcept Body site to administer to
.... route S 1..1 CodeableConcept How drug should enter body
Binding: Route of Administration (required)
..... coding
...... system 0..1 uri Identity of the terminology system
Fixed Value: https://hapi.slade360edi.com/fhir/CodeSystem/product-catalogue
.... method S 0..1 CodeableConcept Technique for administering medication
.... doseAndRate S 0..* Element Amount of medication administered
..... type S 0..1 CodeableConcept The kind of dose or rate specified
..... Slices for dose[x] 0..1 Range, SimpleQuantity(4.0.1) Amount of medication per dose
Slice: Unordered, Open by type:$this
...... dose[x]:doseRange S 0..1 Range Amount of medication per dose
...... dose[x]:doseQuantity S 0..1 SimpleQuantity Amount of medication per dose
..... Slices for rate[x] 0..1 Ratio, Range, SimpleQuantity(4.0.1) Amount of medication per unit of time
Slice: Unordered, Open by type:$this
...... rate[x]:rateRatio S 0..1 Ratio Amount of medication per unit of time
...... rate[x]:rateRange S 0..1 Range Amount of medication per unit of time
...... rate[x]:rateQuantity S 0..1 SimpleQuantity Amount of medication per unit of time
.... maxDosePerPeriod S 0..1 Ratio Upper limit on medication per unit of time
.... maxDosePerAdministration S 0..1 SimpleQuantity(4.0.1) Upper limit on medication per administration
.... maxDosePerLifetime S 0..1 SimpleQuantity(4.0.1) Upper limit on medication per lifetime of the patient

doco Documentation for this format

Terminology Bindings (Differential)

Path Status Usage ValueSet Version Source
MedicationDispense.medication[x]:medicationCodeableConcept Base required Generic Medicinal Products 📦0.1.0 This IG
MedicationDispense.medication[x]:medicationCodeableConcept.​coding.code Base required Generic Medicinal Products 📦0.1.0 This IG
MedicationDispense.dosageInstruction.​route Base required Route of Administration 📦0.1.0 This IG

Snapshot View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. MedicationDispense C 0..* MedicationDispense Dispensing a medication to a named patient
Constraints: mdd-1
... 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
... extension 0..* Extension Additional content defined by implementations
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... identifier 0..* Identifier External identifier
... partOf 0..* Reference(Procedure) Event that dispense is part of
... status ?!SΣ 1..1 code preparation | in-progress | cancelled | on-hold | completed | entered-in-error | stopped | declined | unknown
Binding: MedicationDispense Status Codes (required): A coded concept specifying the state of the dispense event.
... statusReason[x] 0..1 Why a dispense was not performed
Binding: MedicationDispense Status Reason Codes (example): A code describing why a dispense was not performed.
.... statusReasonCodeableConcept CodeableConcept
.... statusReasonReference Reference(DetectedIssue)
... category 0..1 CodeableConcept Type of medication dispense
Binding: MedicationDispense Category Codes (preferred): A code describing where the dispensed medication is expected to be consumed or administered.
... Slices for medication[x] SΣ 1..1 What medication was supplied
Slice: Unordered, Open by type:$this
Binding: SNOMEDCTMedicationCodes (example): A coded concept identifying which substance or product can be dispensed.
.... medicationCodeableConcept CodeableConcept
.... medicationReference Reference(Medication)
.... medication[x]:medicationCodeableConcept Σ 0..1 CodeableConcept What medication was supplied
Binding: Generic Medicinal Products (required)
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... coding Σ 1..1 Coding Code defined by a terminology system
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
...... system Σ 1..1 uri Identity of the terminology system
Fixed Value: https://hapi.slade360edi.com/fhir/CodeSystem/product-catalogue
...... version Σ 0..1 string Version of the system - if relevant
...... code SΣ 1..1 code Symbol in syntax defined by the system
Binding: Generic Medicinal Products (required)
...... display SΣ 1..1 string Representation defined by the system
...... userSelected Σ 0..1 boolean If this coding was chosen directly by the user
..... text Σ 0..1 string Plain text representation of the concept
... subject SΣ 0..1 Reference(Patient | Group) Who the dispense is 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
.... reference SΣC 1..1 string Literal reference, Relative, internal or absolute URL
.... type Σ 0..1 uri Type the reference refers to (e.g. "Patient")
Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model).
.... identifier Σ 0..1 Identifier Logical reference, when literal reference is not known
.... display SΣ 1..1 string Text alternative for the resource
... context 0..1 Reference(Encounter | EpisodeOfCare) Encounter / Episode associated with event
... supportingInformation 0..* Reference(Resource) Information that supports the dispensing of the medication
... performer S 1..1 BackboneElement Who performed event
.... 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
.... function 0..1 CodeableConcept Who performed the dispense and what they did
Binding: MedicationDispense Performer Function Codes (example): A code describing the role an individual played in dispensing a medication.
.... actor S 1..1 Reference(Practitioner) Individual who was performing
... location S 0..1 Reference(Location) Where the dispense occurred
... authorizingPrescription S 1..1 Reference(MedicationRequest) Medication order that authorizes the dispense
... type S 1..1 CodeableConcept Trial fill, partial fill, emergency fill, etc.
Binding: ActPharmacySupplyType (example): Indicates the type of dispensing event that is performed. For example, Trial Fill, Completion of Trial, Partial Fill, Emergency Fill, Samples, etc.
... quantity S 1..1 SimpleQuantity(4.0.1) Amount dispensed
... daysSupply 0..1 SimpleQuantity(4.0.1) Amount of medication expressed as a timing amount
... whenPrepared Σ 0..1 dateTime When product was packaged and reviewed
... whenHandedOver S 1..1 dateTime When product was given out
... destination 0..1 Reference(Location) Where the medication was sent
... receiver 0..* Reference(Patient | Practitioner) Who collected the medication
... note 0..* Annotation Information about the dispense
... dosageInstruction 0..* Dosage How the medication is to be used by the patient or administered by the caregiver
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... sequence SΣ 1..1 integer The order of the dosage instructions
.... text SΣ 1..1 string Free text dosage instructions e.g. SIG
.... additionalInstruction SΣ 1..* 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 SΣ 1..1 string Patient or consumer oriented instructions
.... timing SΣ 1..1 Timing When medication should be administered
.... asNeeded[x] SΣ 1..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 SΣ 1..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 SΣ 1..1 CodeableConcept How drug should enter body
Binding: Route of Administration (required)
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... coding Σ 0..* Coding Code defined by a terminology system
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
...... system Σ 0..1 uri Identity of the terminology system
Fixed Value: https://hapi.slade360edi.com/fhir/CodeSystem/product-catalogue
...... version Σ 0..1 string Version of the system - if relevant
...... code Σ 0..1 code Symbol in syntax defined by the system
...... display Σ 0..1 string Representation defined by the system
...... userSelected Σ 0..1 boolean If this coding was chosen directly by the user
..... text Σ 0..1 string Plain text representation of the concept
.... method SΣ 0..1 CodeableConcept Technique for administering medication
Binding: SNOMEDCTAdministrationMethodCodes (example): A coded concept describing the technique by which the medicine is administered.
.... doseAndRate SΣ 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 SΣ 0..1 CodeableConcept The kind of dose or rate specified
Binding: DoseAndRateType (example): The kind of dose or rate specified.
..... Slices for dose[x] Σ 0..1 Amount of medication per dose
Slice: Unordered, Closed by type:$this
...... doseRange Range
...... doseQuantity Quantity(SimpleQuantity)
...... dose[x]:doseRange SΣ 0..1 Range Amount of medication per dose
...... dose[x]:doseQuantity SΣ 0..1 SimpleQuantity Amount of medication per dose
..... Slices for rate[x] Σ 0..1 Amount of medication per unit of time
Slice: Unordered, Closed by type:$this
...... rateRatio Ratio
...... rateRange Range
...... rateQuantity Quantity(SimpleQuantity)
...... rate[x]:rateRatio SΣ 0..1 Ratio Amount of medication per unit of time
...... rate[x]:rateRange SΣ 0..1 Range Amount of medication per unit of time
...... rate[x]:rateQuantity SΣ 0..1 SimpleQuantity Amount of medication per unit of time
.... maxDosePerPeriod SΣ 0..1 Ratio Upper limit on medication per unit of time
.... maxDosePerAdministration SΣ 0..1 SimpleQuantity(4.0.1) Upper limit on medication per administration
.... maxDosePerLifetime SΣ 0..1 SimpleQuantity(4.0.1) Upper limit on medication per lifetime of the patient
... substitution 0..1 BackboneElement Whether a substitution was performed on the dispense
.... 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
.... wasSubstituted 1..1 boolean Whether a substitution was or was not performed on the dispense
.... type 0..1 CodeableConcept Code signifying whether a different drug was dispensed from what was prescribed
Binding: ActSubstanceAdminSubstitutionCode (example): A coded concept describing whether a different medicinal product may be dispensed other than the product as specified exactly in the prescription.
.... reason 0..* CodeableConcept Why was substitution made
Binding: SubstanceAdminSubstitutionReason (example): A coded concept describing the reason that a different medication should (or should not) be substituted from what was prescribed.
.... responsibleParty 0..* Reference(Practitioner | PractitionerRole) Who is responsible for the substitution
... detectedIssue 0..* Reference(DetectedIssue) Clinical issue with action
... eventHistory 0..* Reference(Provenance) A list of relevant lifecycle events

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
MedicationDispense.language Base preferred Common Languages 📍4.0.1 FHIR Std.
MedicationDispense.status Base required Medication dispense status codes 📍4.0.1 FHIR Std.
MedicationDispense.statusReason[x] Base example Medication dispense status reason codes 📍4.0.1 FHIR Std.
MedicationDispense.category Base preferred Medication dispense category codes 📍4.0.1 FHIR Std.
MedicationDispense.medication[x] Base example SNOMED CT Medication Codes 📍4.0.1 FHIR Std.
MedicationDispense.medication[x]:medicationCodeableConcept Base required Generic Medicinal Products 📦0.1.0 This IG
MedicationDispense.medication[x]:medicationCodeableConcept.​coding.code Base required Generic Medicinal Products 📦0.1.0 This IG
MedicationDispense.subject.​type Base extensible ResourceType 📍4.0.1 FHIR Std.
MedicationDispense.performer.​function Base example Medication dispense performer function codes 📍4.0.1 FHIR Std.
MedicationDispense.type Base example ActPharmacySupplyType 📦3.0.0 THO v7.0
MedicationDispense.dosageInstruction.​additionalInstruction Base example SNOMED CT Additional Dosage Instructions 📍4.0.1 FHIR Std.
MedicationDispense.dosageInstruction.​asNeeded[x] Base example SNOMED CT Medication As Needed Reason Codes 📍4.0.1 FHIR Std.
MedicationDispense.dosageInstruction.​site Base example SNOMED CT Anatomical Structure for Administration Site Codes 📍4.0.1 FHIR Std.
MedicationDispense.dosageInstruction.​route Base required Route of Administration 📦0.1.0 This IG
MedicationDispense.dosageInstruction.​method Base example SNOMED CT Administration Method Codes 📍4.0.1 FHIR Std.
MedicationDispense.dosageInstruction.​doseAndRate.type Base example DoseAndRateType 📍4.0.1 FHIR Std.
MedicationDispense.substitution.​type Base example ActSubstanceAdminSubstitutionCode 📦3.0.0 THO v7.0
MedicationDispense.substitution.​reason Base example SubstanceAdminSubstitutionReason 📦3.0.0 THO v7.0

Constraints

Id Grade Path(s) Description Expression
dom-2 error MedicationDispense If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error MedicationDispense 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 MedicationDispense 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 MedicationDispense If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice MedicationDispense A resource should have narrative for robust management text.`div`.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()
mdd-1 error MedicationDispense whenHandedOver cannot be before whenPrepared whenHandedOver.empty() or whenPrepared.empty() or whenHandedOver >= whenPrepared

This structure is derived from MedicationDispense

Summary

Mandatory: 5 elements(14 nested mandatory elements)
Must-Support: 33 elements
Fixed: 2 elements

Structures

This structure refers to these other structures:

Slices

This structure defines the following Slices:

  • The element 1 is sliced based on the value of MedicationDispense.medication[x]
  • The element 1 is sliced based on the value of MedicationDispense.dosageInstruction.doseAndRate.dose[x]
  • The element 1 is sliced based on the value of MedicationDispense.dosageInstruction.doseAndRate.rate[x]

 

Other representations of profile: CSV, Excel, Schematron