Kenya-ePrescription-IG
0.1.0 - ci-build

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

Resource Profile: Kenya Medication Dispense

Official URL: http://example.org/StructureDefinition/kenya-medication-dispense Version: 0.1.0
Draft as of 2026-01-27 Computable Name: KenyaMedicationDispense

Records the actual dispensing of a medication to a patient.

Usages:

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

You can also check for usages in the FHIR IG Statistics

Formal Views of Profile Content

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

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. MedicationDispense C 0..* MedicationDispense Dispensing a medication to a named patient
Constraints: mdd-1
... meta SΣ 1..1 Meta Metadata about the resource
.... profile SΣ 1..* canonical(StructureDefinition) Profiles this resource claims to conform to.
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
.... use ?!SΣ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
.... type SΣ 1..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 SΣ 1..1 uri The namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
.... value SΣ 1..1 string The value that is unique
Example General: 123456
... status ?!SΣ 1..1 code preparation | in-progress | cancelled | on-hold | completed | entered-in-error | stopped | declined | unknown
Binding: MedicationDispense Status Codes (required)
... 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(KenyaCodeableConcept)
.... medicationReference Reference(Medication)
.... medication[x]:medicationCodeableConcept SΣ 0..1 KenyaCodeableConcept What medication was supplied
Binding: https://fhir.sha.go.ke/fhir/ValueSet/medication-codes-vs (extensible)
... subject SΣ 1..1 Reference(Patient) Who the dispense is for
... context S 1..1 Reference(Encounter) Encounter / Episode associated with event
... performer S 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
... authorizingPrescription S 1..* Reference(MedicationRequest - ePrescription) Medication order that authorizes the dispense
... quantity S 1..1 SimpleQuantity(4.0.1) Amount dispensed (e.g., 30 Tablets)
... daysSupply S 1..1 SimpleQuantity(4.0.1) How long this supply lasts
... whenHandedOver S 1..1 dateTime Timestamp of pickup
... receiver S 1..1 Reference(Patient | Practitioner) Who collected the medication
... dosageInstruction S 1..* 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
.... text SΣ 1..1 string Full instructions: 'Take 1 tab orally 3 times a day'
.... timing SΣ 0..1 Timing When medication should be administered
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... repeat SΣC 0..1 Element When the event is to occur
Constraints: tim-1, tim-2, tim-4, tim-5, tim-6, tim-7, tim-8, tim-9, tim-10
...... frequency SΣ 0..1 positiveInt Event occurs frequency times per period
...... period SΣ 0..1 decimal Event occurs frequency times per period
...... periodUnit SΣ 0..1 code s | min | h | d | wk | mo | a - unit of time (UCUM)
Binding: UnitsOfTime (required): A unit of time (units from UCUM).
..... code SΣ 0..1 CodeableConcept BID | TID | QID | AM | PM | QD | QOD | +
Binding: TimingAbbreviation (extensible)
.... Slices for asNeeded[x] SΣ 0..1 Take "as needed" (for x)
Slice: Unordered, Closed by type:$this
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
..... asNeeded[x]:asNeededBoolean Σ 0..1 boolean Take only when needed (true/false)
..... asNeeded[x]:asNeededCodeableConcept Σ 0..1 CodeableConcept Take "as needed" (for x)
Binding: SNOMEDCTMedicationAsNeededReasonCodes (extensible)
.... site SΣ 0..1 CodeableConcept Where to apply (left eye, right arm)
Binding: SNOMEDCTBodyStructures (extensible)
.... route SΣ 1..1 CodeableConcept How to take (oral, iv)
Binding: SNOMEDCTRouteCodes (extensible)
.... method SΣ 0..1 CodeableConcept How to apply (injection, topical)
Binding: method-codes (??) (extensible)
.... doseAndRate SΣ 0..1 Element Amount of medication administered
..... Slices for dose[x] SΣ 0..1 Amount of medication per dose
Slice: Unordered, Open by type:$this
...... doseRange Range
...... doseQuantity Quantity(SimpleQuantity)
...... dose[x]:doseQuantity SΣ 0..1 SimpleQuantity Amount per dose (e.g. 500 mg)
... substitution S 0..1 BackboneElement Whether a substitution was performed on the dispense
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... wasSubstituted S 1..1 boolean True if different from Order
.... type S 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.
..... coding SΣ 1..* Coding Code defined by a terminology system
...... system SΣ 1..1 uri Identity of the terminology system
...... code SΣ 1..1 code Symbol in syntax defined by the system
...... display SΣ 0..1 string Representation defined by the system
..... text SΣ 0..1 string Plain text representation of the concept
.... reason S 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.

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
MedicationDispense.identifier.​use Base required IdentifierUse 📍4.0.1 FHIR Std.
MedicationDispense.identifier.​type Base extensible IdentifierType 📍4.0.1 FHIR Std.
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 extensible https://fhir.sha.go.ke/fhir/ValueSet/medication-codes-vs Not State Unknown
MedicationDispense.dosageInstruction.​timing.repeat.periodUnit Base required UnitsOfTime 📍4.0.1 FHIR Std.
MedicationDispense.dosageInstruction.​timing.code Base extensible TimingAbbreviation 📦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.​asNeeded[x]:asNeededCodeableConcept Base extensible SNOMED CT Medication As Needed Reason Codes 📦4.0.1 FHIR Std.
MedicationDispense.dosageInstruction.​site Base extensible SNOMED CT Body Structures 📦4.0.1 FHIR Std.
MedicationDispense.dosageInstruction.​route Base extensible SNOMED CT Route Codes 📦4.0.1 FHIR Std.
MedicationDispense.dosageInstruction.​method Base extensible http://hl7.org/fhir/ValueSet/method-codes Not State Unknown
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
tim-1 error MedicationDispense.dosageInstruction.timing.repeat if there's a duration, there needs to be duration units duration.empty() or durationUnit.exists()
tim-2 error MedicationDispense.dosageInstruction.timing.repeat if there's a period, there needs to be period units period.empty() or periodUnit.exists()
tim-4 error MedicationDispense.dosageInstruction.timing.repeat duration SHALL be a non-negative value duration.exists() implies duration >= 0
tim-5 error MedicationDispense.dosageInstruction.timing.repeat period SHALL be a non-negative value period.exists() implies period >= 0
tim-6 error MedicationDispense.dosageInstruction.timing.repeat If there's a periodMax, there must be a period periodMax.empty() or period.exists()
tim-7 error MedicationDispense.dosageInstruction.timing.repeat If there's a durationMax, there must be a duration durationMax.empty() or duration.exists()
tim-8 error MedicationDispense.dosageInstruction.timing.repeat If there's a countMax, there must be a count countMax.empty() or count.exists()
tim-9 error MedicationDispense.dosageInstruction.timing.repeat If there's an offset, there must be a when (and not C, CM, CD, CV) offset.empty() or (when.exists() and ((when in ('C' | 'CM' | 'CD' | 'CV')).not()))
tim-10 error MedicationDispense.dosageInstruction.timing.repeat If there's a timeOfDay, there cannot be a when, or vice versa timeOfDay.empty() or when.empty()

This structure is derived from MedicationDispense

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. MedicationDispense 0..* MedicationDispense Dispensing a medication to a named patient
... meta S 1..1 Meta Metadata about the resource
.... profile S 1..* canonical(StructureDefinition) Profiles this resource claims to conform to.
... identifier S 1..* Identifier External identifier
.... use S 0..1 code usual | official | temp | secondary | old (If known)
.... type S 1..1 CodeableConcept Description of identifier
.... system S 1..1 uri The namespace for the identifier value
.... value S 1..1 string The value that is unique
... status S 1..1 code preparation | in-progress | cancelled | on-hold | completed | entered-in-error | stopped | declined | unknown
Binding: MedicationDispense Status Codes (required)
.... medicationCodeableConcept CodeableConcept(KenyaCodeableConcept)
.... medicationReference Reference(Medication)
.... medication[x]:medicationCodeableConcept S 0..1 KenyaCodeableConcept What medication was supplied
Binding: https://fhir.sha.go.ke/fhir/ValueSet/medication-codes-vs (extensible)
... subject S 1..1 Reference(Patient) Who the dispense is for
... context S 1..1 Reference(Encounter) Encounter / Episode associated with event
... performer S 1..* BackboneElement Who performed event
.... actor S 1..1 Reference(Practitioner) Individual who was performing
... authorizingPrescription S 1..* Reference(MedicationRequest - ePrescription) Medication order that authorizes the dispense
... quantity S 1..1 SimpleQuantity(4.0.1) Amount dispensed (e.g., 30 Tablets)
... daysSupply S 1..1 SimpleQuantity(4.0.1) How long this supply lasts
... whenHandedOver S 1..1 dateTime Timestamp of pickup
... receiver S 1..1 Reference(Patient | Practitioner) Who collected the medication
... dosageInstruction S 1..* Dosage How the medication is to be used by the patient or administered by the caregiver
.... text S 1..1 string Full instructions: 'Take 1 tab orally 3 times a day'
.... timing S 0..1 Timing When medication should be administered
..... repeat S 0..1 Element When the event is to occur
...... frequency S 0..1 positiveInt Event occurs frequency times per period
...... period S 0..1 decimal Event occurs frequency times per period
...... periodUnit S 0..1 code s | min | h | d | wk | mo | a - unit of time (UCUM)
..... code S 0..1 CodeableConcept BID | TID | QID | AM | PM | QD | QOD | +
Binding: TimingAbbreviation (extensible)
.... Slices for asNeeded[x] S 0..1 boolean, CodeableConcept Take "as needed" (for x)
Slice: Unordered, Open by type:$this
..... asNeeded[x]:asNeededBoolean 0..1 boolean Take only when needed (true/false)
..... asNeeded[x]:asNeededCodeableConcept 0..1 CodeableConcept Take "as needed" (for x)
Binding: SNOMEDCTMedicationAsNeededReasonCodes (extensible)
.... site S 0..1 CodeableConcept Where to apply (left eye, right arm)
Binding: SNOMEDCTBodyStructures (extensible)
.... route S 1..1 CodeableConcept How to take (oral, iv)
Binding: SNOMEDCTRouteCodes (extensible)
.... method S 0..1 CodeableConcept How to apply (injection, topical)
Binding: method-codes (??) (extensible)
.... doseAndRate S 0..1 Element Amount of medication administered
..... Slices for dose[x] S 0..1 Range, SimpleQuantity(4.0.1) Amount of medication per dose
Slice: Unordered, Open by type:$this
...... dose[x]:doseQuantity S 0..1 SimpleQuantity Amount per dose (e.g. 500 mg)
... substitution S 0..1 BackboneElement Whether a substitution was performed on the dispense
.... wasSubstituted S 1..1 boolean True if different from Order
.... type S 0..1 CodeableConcept Code signifying whether a different drug was dispensed from what was prescribed
..... coding S 1..* Coding Code defined by a terminology system
...... system S 1..1 uri Identity of the terminology system
...... code S 1..1 code Symbol in syntax defined by the system
...... display S 0..1 string Representation defined by the system
..... text S 0..1 string Plain text representation of the concept
.... reason S 0..* CodeableConcept Why was substitution made

doco Documentation for this format

Terminology Bindings (Differential)

Path Status Usage ValueSet Version Source
MedicationDispense.status Base required Medication dispense status codes 📦4.0.1 FHIR Std.
MedicationDispense.medication[x]:medicationCodeableConcept Base extensible https://fhir.sha.go.ke/fhir/ValueSet/medication-codes-vs Not State Unknown
MedicationDispense.dosageInstruction.​timing.code Base extensible TimingAbbreviation 📦4.0.1 FHIR Std.
MedicationDispense.dosageInstruction.​asNeeded[x]:asNeededCodeableConcept Base extensible SNOMED CT Medication As Needed Reason Codes 📦4.0.1 FHIR Std.
MedicationDispense.dosageInstruction.​site Base extensible SNOMED CT Body Structures 📦4.0.1 FHIR Std.
MedicationDispense.dosageInstruction.​route Base extensible SNOMED CT Route Codes 📦4.0.1 FHIR Std.
MedicationDispense.dosageInstruction.​method Base extensible http://hl7.org/fhir/ValueSet/method-codes Not State Unknown
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 SΣ 1..1 Meta Metadata about the resource
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... versionId Σ 0..1 id Version specific identifier
.... lastUpdated Σ 0..1 instant When the resource version last changed
.... source Σ 0..1 uri Identifies where the resource comes from
.... profile SΣ 1..* canonical(StructureDefinition) Profiles this resource claims to conform to.
.... security Σ 0..* Coding Security Labels applied to this resource
Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System.
.... tag Σ 0..* Coding Tags applied to this resource
Binding: CommonTags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones".
... 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 S 1..* Identifier External 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 ?!SΣ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
.... type SΣ 1..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 SΣ 1..1 uri The namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
.... value SΣ 1..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)
... 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)
... 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(KenyaCodeableConcept)
.... medicationReference Reference(Medication)
.... medication[x]:medicationCodeableConcept SΣ 0..1 KenyaCodeableConcept What medication was supplied
Binding: https://fhir.sha.go.ke/fhir/ValueSet/medication-codes-vs (extensible)
... subject SΣ 1..1 Reference(Patient) Who the dispense is for
... context S 1..1 Reference(Encounter) Encounter / Episode associated with event
... supportingInformation 0..* Reference(Resource) Information that supports the dispensing of the medication
... performer S 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 0..1 Reference(Location) Where the dispense occurred
... authorizingPrescription S 1..* Reference(MedicationRequest - ePrescription) Medication order that authorizes the dispense
... type 0..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 (e.g., 30 Tablets)
... daysSupply S 1..1 SimpleQuantity(4.0.1) How long this supply lasts
... whenPrepared Σ 0..1 dateTime When product was packaged and reviewed
... whenHandedOver S 1..1 dateTime Timestamp of pickup
... destination 0..1 Reference(Location) Where the medication was sent
... receiver S 1..1 Reference(Patient | Practitioner) Who collected the medication
... note 0..* Annotation Information about the dispense
... dosageInstruction S 1..* 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 Σ 0..1 integer The order of the dosage instructions
.... text SΣ 1..1 string Full instructions: 'Take 1 tab orally 3 times a day'
.... 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 SΣ 0..1 Timing When medication should be 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
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... event Σ 0..* dateTime When the event occurs
..... repeat SΣC 0..1 Element When the event is to occur
Constraints: tim-1, tim-2, tim-4, tim-5, tim-6, tim-7, tim-8, tim-9, tim-10
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
...... bounds[x] Σ 0..1 Length/Range of lengths, or (Start and/or end) limits
....... boundsDuration Duration
....... boundsRange Range
....... boundsPeriod Period
...... count Σ 0..1 positiveInt Number of times to repeat
...... countMax Σ 0..1 positiveInt Maximum number of times to repeat
...... duration Σ 0..1 decimal How long when it happens
...... durationMax Σ 0..1 decimal How long when it happens (Max)
...... durationUnit Σ 0..1 code s | min | h | d | wk | mo | a - unit of time (UCUM)
Binding: UnitsOfTime (required): A unit of time (units from UCUM).
...... frequency SΣ 0..1 positiveInt Event occurs frequency times per period
...... frequencyMax Σ 0..1 positiveInt Event occurs up to frequencyMax times per period
...... period SΣ 0..1 decimal Event occurs frequency times per period
...... periodMax Σ 0..1 decimal Upper limit of period (3-4 hours)
...... periodUnit SΣ 0..1 code s | min | h | d | wk | mo | a - unit of time (UCUM)
Binding: UnitsOfTime (required): A unit of time (units from UCUM).
...... dayOfWeek Σ 0..* code mon | tue | wed | thu | fri | sat | sun
Binding: DaysOfWeek (required)
...... timeOfDay Σ 0..* time Time of day for action
...... when Σ 0..* code Code for time period of occurrence
Binding: EventTiming (required): Real world event relating to the schedule.
...... offset Σ 0..1 unsignedInt Minutes from event (before or after)
..... code SΣ 0..1 CodeableConcept BID | TID | QID | AM | PM | QD | QOD | +
Binding: TimingAbbreviation (extensible)
.... Slices for asNeeded[x] SΣ 0..1 Take "as needed" (for x)
Slice: Unordered, Closed by type:$this
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
..... asNeeded[x]:asNeededBoolean Σ 0..1 boolean Take only when needed (true/false)
..... asNeeded[x]:asNeededCodeableConcept Σ 0..1 CodeableConcept Take "as needed" (for x)
Binding: SNOMEDCTMedicationAsNeededReasonCodes (extensible)
.... site SΣ 0..1 CodeableConcept Where to apply (left eye, right arm)
Binding: SNOMEDCTBodyStructures (extensible)
.... route SΣ 1..1 CodeableConcept How to take (oral, iv)
Binding: SNOMEDCTRouteCodes (extensible)
.... method SΣ 0..1 CodeableConcept How to apply (injection, topical)
Binding: method-codes (??) (extensible)
.... doseAndRate SΣ 0..1 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.
..... Slices for dose[x] SΣ 0..1 Amount of medication per dose
Slice: Unordered, Open by type:$this
...... doseRange Range
...... doseQuantity Quantity(SimpleQuantity)
...... dose[x]:doseQuantity SΣ 0..1 SimpleQuantity Amount per dose (e.g. 500 mg)
..... 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(4.0.1) Upper limit on medication per administration
.... maxDosePerLifetime Σ 0..1 SimpleQuantity(4.0.1) Upper limit on medication per lifetime of the patient
... substitution S 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 S 1..1 boolean True if different from Order
.... type S 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.
..... 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 SΣ 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 SΣ 1..1 uri Identity of the terminology system
...... version Σ 0..1 string Version of the system - if relevant
...... code SΣ 1..1 code Symbol in syntax defined by the system
...... display SΣ 0..1 string Representation defined by the system
...... userSelected Σ 0..1 boolean If this coding was chosen directly by the user
..... text SΣ 0..1 string Plain text representation of the concept
.... reason S 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.meta.​security Base extensible SecurityLabels 📍4.0.1 FHIR Std.
MedicationDispense.meta.​tag Base example Common Tags 📍4.0.1 FHIR Std.
MedicationDispense.language Base preferred Common Languages 📍4.0.1 FHIR Std.
MedicationDispense.identifier.​use Base required IdentifierUse 📍4.0.1 FHIR Std.
MedicationDispense.identifier.​type Base extensible IdentifierType 📍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 extensible https://fhir.sha.go.ke/fhir/ValueSet/medication-codes-vs Not State Unknown
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.​timing.repeat.durationUnit Base required UnitsOfTime 📍4.0.1 FHIR Std.
MedicationDispense.dosageInstruction.​timing.repeat.periodUnit Base required UnitsOfTime 📍4.0.1 FHIR Std.
MedicationDispense.dosageInstruction.​timing.repeat.dayOfWeek Base required DaysOfWeek 📍4.0.1 FHIR Std.
MedicationDispense.dosageInstruction.​timing.repeat.when Base required EventTiming 📍4.0.1 FHIR Std.
MedicationDispense.dosageInstruction.​timing.code Base extensible TimingAbbreviation 📦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.​asNeeded[x]:asNeededCodeableConcept Base extensible SNOMED CT Medication As Needed Reason Codes 📦4.0.1 FHIR Std.
MedicationDispense.dosageInstruction.​site Base extensible SNOMED CT Body Structures 📦4.0.1 FHIR Std.
MedicationDispense.dosageInstruction.​route Base extensible SNOMED CT Route Codes 📦4.0.1 FHIR Std.
MedicationDispense.dosageInstruction.​method Base extensible http://hl7.org/fhir/ValueSet/method-codes Not State Unknown
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
tim-1 error MedicationDispense.dosageInstruction.timing.repeat if there's a duration, there needs to be duration units duration.empty() or durationUnit.exists()
tim-2 error MedicationDispense.dosageInstruction.timing.repeat if there's a period, there needs to be period units period.empty() or periodUnit.exists()
tim-4 error MedicationDispense.dosageInstruction.timing.repeat duration SHALL be a non-negative value duration.exists() implies duration >= 0
tim-5 error MedicationDispense.dosageInstruction.timing.repeat period SHALL be a non-negative value period.exists() implies period >= 0
tim-6 error MedicationDispense.dosageInstruction.timing.repeat If there's a periodMax, there must be a period periodMax.empty() or period.exists()
tim-7 error MedicationDispense.dosageInstruction.timing.repeat If there's a durationMax, there must be a duration durationMax.empty() or duration.exists()
tim-8 error MedicationDispense.dosageInstruction.timing.repeat If there's a countMax, there must be a count countMax.empty() or count.exists()
tim-9 error MedicationDispense.dosageInstruction.timing.repeat If there's an offset, there must be a when (and not C, CM, CD, CV) offset.empty() or (when.exists() and ((when in ('C' | 'CM' | 'CD' | 'CV')).not()))
tim-10 error MedicationDispense.dosageInstruction.timing.repeat If there's a timeOfDay, there cannot be a when, or vice versa timeOfDay.empty() or when.empty()

This structure is derived from MedicationDispense

Summary

Mandatory: 17 elements(3 nested mandatory elements)
Must-Support: 43 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.asNeeded[x]
  • The element 1 is sliced based on the value of MedicationDispense.dosageInstruction.doseAndRate.dose[x]

Key Elements View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. MedicationDispense C 0..* MedicationDispense Dispensing a medication to a named patient
Constraints: mdd-1
... meta SΣ 1..1 Meta Metadata about the resource
.... profile SΣ 1..* canonical(StructureDefinition) Profiles this resource claims to conform to.
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
.... use ?!SΣ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
.... type SΣ 1..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 SΣ 1..1 uri The namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
.... value SΣ 1..1 string The value that is unique
Example General: 123456
... status ?!SΣ 1..1 code preparation | in-progress | cancelled | on-hold | completed | entered-in-error | stopped | declined | unknown
Binding: MedicationDispense Status Codes (required)
... 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(KenyaCodeableConcept)
.... medicationReference Reference(Medication)
.... medication[x]:medicationCodeableConcept SΣ 0..1 KenyaCodeableConcept What medication was supplied
Binding: https://fhir.sha.go.ke/fhir/ValueSet/medication-codes-vs (extensible)
... subject SΣ 1..1 Reference(Patient) Who the dispense is for
... context S 1..1 Reference(Encounter) Encounter / Episode associated with event
... performer S 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
... authorizingPrescription S 1..* Reference(MedicationRequest - ePrescription) Medication order that authorizes the dispense
... quantity S 1..1 SimpleQuantity(4.0.1) Amount dispensed (e.g., 30 Tablets)
... daysSupply S 1..1 SimpleQuantity(4.0.1) How long this supply lasts
... whenHandedOver S 1..1 dateTime Timestamp of pickup
... receiver S 1..1 Reference(Patient | Practitioner) Who collected the medication
... dosageInstruction S 1..* 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
.... text SΣ 1..1 string Full instructions: 'Take 1 tab orally 3 times a day'
.... timing SΣ 0..1 Timing When medication should be administered
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... repeat SΣC 0..1 Element When the event is to occur
Constraints: tim-1, tim-2, tim-4, tim-5, tim-6, tim-7, tim-8, tim-9, tim-10
...... frequency SΣ 0..1 positiveInt Event occurs frequency times per period
...... period SΣ 0..1 decimal Event occurs frequency times per period
...... periodUnit SΣ 0..1 code s | min | h | d | wk | mo | a - unit of time (UCUM)
Binding: UnitsOfTime (required): A unit of time (units from UCUM).
..... code SΣ 0..1 CodeableConcept BID | TID | QID | AM | PM | QD | QOD | +
Binding: TimingAbbreviation (extensible)
.... Slices for asNeeded[x] SΣ 0..1 Take "as needed" (for x)
Slice: Unordered, Closed by type:$this
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
..... asNeeded[x]:asNeededBoolean Σ 0..1 boolean Take only when needed (true/false)
..... asNeeded[x]:asNeededCodeableConcept Σ 0..1 CodeableConcept Take "as needed" (for x)
Binding: SNOMEDCTMedicationAsNeededReasonCodes (extensible)
.... site SΣ 0..1 CodeableConcept Where to apply (left eye, right arm)
Binding: SNOMEDCTBodyStructures (extensible)
.... route SΣ 1..1 CodeableConcept How to take (oral, iv)
Binding: SNOMEDCTRouteCodes (extensible)
.... method SΣ 0..1 CodeableConcept How to apply (injection, topical)
Binding: method-codes (??) (extensible)
.... doseAndRate SΣ 0..1 Element Amount of medication administered
..... Slices for dose[x] SΣ 0..1 Amount of medication per dose
Slice: Unordered, Open by type:$this
...... doseRange Range
...... doseQuantity Quantity(SimpleQuantity)
...... dose[x]:doseQuantity SΣ 0..1 SimpleQuantity Amount per dose (e.g. 500 mg)
... substitution S 0..1 BackboneElement Whether a substitution was performed on the dispense
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... wasSubstituted S 1..1 boolean True if different from Order
.... type S 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.
..... coding SΣ 1..* Coding Code defined by a terminology system
...... system SΣ 1..1 uri Identity of the terminology system
...... code SΣ 1..1 code Symbol in syntax defined by the system
...... display SΣ 0..1 string Representation defined by the system
..... text SΣ 0..1 string Plain text representation of the concept
.... reason S 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.

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
MedicationDispense.identifier.​use Base required IdentifierUse 📍4.0.1 FHIR Std.
MedicationDispense.identifier.​type Base extensible IdentifierType 📍4.0.1 FHIR Std.
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 extensible https://fhir.sha.go.ke/fhir/ValueSet/medication-codes-vs Not State Unknown
MedicationDispense.dosageInstruction.​timing.repeat.periodUnit Base required UnitsOfTime 📍4.0.1 FHIR Std.
MedicationDispense.dosageInstruction.​timing.code Base extensible TimingAbbreviation 📦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.​asNeeded[x]:asNeededCodeableConcept Base extensible SNOMED CT Medication As Needed Reason Codes 📦4.0.1 FHIR Std.
MedicationDispense.dosageInstruction.​site Base extensible SNOMED CT Body Structures 📦4.0.1 FHIR Std.
MedicationDispense.dosageInstruction.​route Base extensible SNOMED CT Route Codes 📦4.0.1 FHIR Std.
MedicationDispense.dosageInstruction.​method Base extensible http://hl7.org/fhir/ValueSet/method-codes Not State Unknown
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
tim-1 error MedicationDispense.dosageInstruction.timing.repeat if there's a duration, there needs to be duration units duration.empty() or durationUnit.exists()
tim-2 error MedicationDispense.dosageInstruction.timing.repeat if there's a period, there needs to be period units period.empty() or periodUnit.exists()
tim-4 error MedicationDispense.dosageInstruction.timing.repeat duration SHALL be a non-negative value duration.exists() implies duration >= 0
tim-5 error MedicationDispense.dosageInstruction.timing.repeat period SHALL be a non-negative value period.exists() implies period >= 0
tim-6 error MedicationDispense.dosageInstruction.timing.repeat If there's a periodMax, there must be a period periodMax.empty() or period.exists()
tim-7 error MedicationDispense.dosageInstruction.timing.repeat If there's a durationMax, there must be a duration durationMax.empty() or duration.exists()
tim-8 error MedicationDispense.dosageInstruction.timing.repeat If there's a countMax, there must be a count countMax.empty() or count.exists()
tim-9 error MedicationDispense.dosageInstruction.timing.repeat If there's an offset, there must be a when (and not C, CM, CD, CV) offset.empty() or (when.exists() and ((when in ('C' | 'CM' | 'CD' | 'CV')).not()))
tim-10 error MedicationDispense.dosageInstruction.timing.repeat If there's a timeOfDay, there cannot be a when, or vice versa timeOfDay.empty() or when.empty()

Differential View

This structure is derived from MedicationDispense

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. MedicationDispense 0..* MedicationDispense Dispensing a medication to a named patient
... meta S 1..1 Meta Metadata about the resource
.... profile S 1..* canonical(StructureDefinition) Profiles this resource claims to conform to.
... identifier S 1..* Identifier External identifier
.... use S 0..1 code usual | official | temp | secondary | old (If known)
.... type S 1..1 CodeableConcept Description of identifier
.... system S 1..1 uri The namespace for the identifier value
.... value S 1..1 string The value that is unique
... status S 1..1 code preparation | in-progress | cancelled | on-hold | completed | entered-in-error | stopped | declined | unknown
Binding: MedicationDispense Status Codes (required)
.... medicationCodeableConcept CodeableConcept(KenyaCodeableConcept)
.... medicationReference Reference(Medication)
.... medication[x]:medicationCodeableConcept S 0..1 KenyaCodeableConcept What medication was supplied
Binding: https://fhir.sha.go.ke/fhir/ValueSet/medication-codes-vs (extensible)
... subject S 1..1 Reference(Patient) Who the dispense is for
... context S 1..1 Reference(Encounter) Encounter / Episode associated with event
... performer S 1..* BackboneElement Who performed event
.... actor S 1..1 Reference(Practitioner) Individual who was performing
... authorizingPrescription S 1..* Reference(MedicationRequest - ePrescription) Medication order that authorizes the dispense
... quantity S 1..1 SimpleQuantity(4.0.1) Amount dispensed (e.g., 30 Tablets)
... daysSupply S 1..1 SimpleQuantity(4.0.1) How long this supply lasts
... whenHandedOver S 1..1 dateTime Timestamp of pickup
... receiver S 1..1 Reference(Patient | Practitioner) Who collected the medication
... dosageInstruction S 1..* Dosage How the medication is to be used by the patient or administered by the caregiver
.... text S 1..1 string Full instructions: 'Take 1 tab orally 3 times a day'
.... timing S 0..1 Timing When medication should be administered
..... repeat S 0..1 Element When the event is to occur
...... frequency S 0..1 positiveInt Event occurs frequency times per period
...... period S 0..1 decimal Event occurs frequency times per period
...... periodUnit S 0..1 code s | min | h | d | wk | mo | a - unit of time (UCUM)
..... code S 0..1 CodeableConcept BID | TID | QID | AM | PM | QD | QOD | +
Binding: TimingAbbreviation (extensible)
.... Slices for asNeeded[x] S 0..1 boolean, CodeableConcept Take "as needed" (for x)
Slice: Unordered, Open by type:$this
..... asNeeded[x]:asNeededBoolean 0..1 boolean Take only when needed (true/false)
..... asNeeded[x]:asNeededCodeableConcept 0..1 CodeableConcept Take "as needed" (for x)
Binding: SNOMEDCTMedicationAsNeededReasonCodes (extensible)
.... site S 0..1 CodeableConcept Where to apply (left eye, right arm)
Binding: SNOMEDCTBodyStructures (extensible)
.... route S 1..1 CodeableConcept How to take (oral, iv)
Binding: SNOMEDCTRouteCodes (extensible)
.... method S 0..1 CodeableConcept How to apply (injection, topical)
Binding: method-codes (??) (extensible)
.... doseAndRate S 0..1 Element Amount of medication administered
..... Slices for dose[x] S 0..1 Range, SimpleQuantity(4.0.1) Amount of medication per dose
Slice: Unordered, Open by type:$this
...... dose[x]:doseQuantity S 0..1 SimpleQuantity Amount per dose (e.g. 500 mg)
... substitution S 0..1 BackboneElement Whether a substitution was performed on the dispense
.... wasSubstituted S 1..1 boolean True if different from Order
.... type S 0..1 CodeableConcept Code signifying whether a different drug was dispensed from what was prescribed
..... coding S 1..* Coding Code defined by a terminology system
...... system S 1..1 uri Identity of the terminology system
...... code S 1..1 code Symbol in syntax defined by the system
...... display S 0..1 string Representation defined by the system
..... text S 0..1 string Plain text representation of the concept
.... reason S 0..* CodeableConcept Why was substitution made

doco Documentation for this format

Terminology Bindings (Differential)

Path Status Usage ValueSet Version Source
MedicationDispense.status Base required Medication dispense status codes 📦4.0.1 FHIR Std.
MedicationDispense.medication[x]:medicationCodeableConcept Base extensible https://fhir.sha.go.ke/fhir/ValueSet/medication-codes-vs Not State Unknown
MedicationDispense.dosageInstruction.​timing.code Base extensible TimingAbbreviation 📦4.0.1 FHIR Std.
MedicationDispense.dosageInstruction.​asNeeded[x]:asNeededCodeableConcept Base extensible SNOMED CT Medication As Needed Reason Codes 📦4.0.1 FHIR Std.
MedicationDispense.dosageInstruction.​site Base extensible SNOMED CT Body Structures 📦4.0.1 FHIR Std.
MedicationDispense.dosageInstruction.​route Base extensible SNOMED CT Route Codes 📦4.0.1 FHIR Std.
MedicationDispense.dosageInstruction.​method Base extensible http://hl7.org/fhir/ValueSet/method-codes Not State Unknown

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 SΣ 1..1 Meta Metadata about the resource
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... versionId Σ 0..1 id Version specific identifier
.... lastUpdated Σ 0..1 instant When the resource version last changed
.... source Σ 0..1 uri Identifies where the resource comes from
.... profile SΣ 1..* canonical(StructureDefinition) Profiles this resource claims to conform to.
.... security Σ 0..* Coding Security Labels applied to this resource
Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System.
.... tag Σ 0..* Coding Tags applied to this resource
Binding: CommonTags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones".
... 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 S 1..* Identifier External 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 ?!SΣ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
.... type SΣ 1..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 SΣ 1..1 uri The namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
.... value SΣ 1..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)
... 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)
... 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(KenyaCodeableConcept)
.... medicationReference Reference(Medication)
.... medication[x]:medicationCodeableConcept SΣ 0..1 KenyaCodeableConcept What medication was supplied
Binding: https://fhir.sha.go.ke/fhir/ValueSet/medication-codes-vs (extensible)
... subject SΣ 1..1 Reference(Patient) Who the dispense is for
... context S 1..1 Reference(Encounter) Encounter / Episode associated with event
... supportingInformation 0..* Reference(Resource) Information that supports the dispensing of the medication
... performer S 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 0..1 Reference(Location) Where the dispense occurred
... authorizingPrescription S 1..* Reference(MedicationRequest - ePrescription) Medication order that authorizes the dispense
... type 0..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 (e.g., 30 Tablets)
... daysSupply S 1..1 SimpleQuantity(4.0.1) How long this supply lasts
... whenPrepared Σ 0..1 dateTime When product was packaged and reviewed
... whenHandedOver S 1..1 dateTime Timestamp of pickup
... destination 0..1 Reference(Location) Where the medication was sent
... receiver S 1..1 Reference(Patient | Practitioner) Who collected the medication
... note 0..* Annotation Information about the dispense
... dosageInstruction S 1..* 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 Σ 0..1 integer The order of the dosage instructions
.... text SΣ 1..1 string Full instructions: 'Take 1 tab orally 3 times a day'
.... 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 SΣ 0..1 Timing When medication should be 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
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... event Σ 0..* dateTime When the event occurs
..... repeat SΣC 0..1 Element When the event is to occur
Constraints: tim-1, tim-2, tim-4, tim-5, tim-6, tim-7, tim-8, tim-9, tim-10
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
...... bounds[x] Σ 0..1 Length/Range of lengths, or (Start and/or end) limits
....... boundsDuration Duration
....... boundsRange Range
....... boundsPeriod Period
...... count Σ 0..1 positiveInt Number of times to repeat
...... countMax Σ 0..1 positiveInt Maximum number of times to repeat
...... duration Σ 0..1 decimal How long when it happens
...... durationMax Σ 0..1 decimal How long when it happens (Max)
...... durationUnit Σ 0..1 code s | min | h | d | wk | mo | a - unit of time (UCUM)
Binding: UnitsOfTime (required): A unit of time (units from UCUM).
...... frequency SΣ 0..1 positiveInt Event occurs frequency times per period
...... frequencyMax Σ 0..1 positiveInt Event occurs up to frequencyMax times per period
...... period SΣ 0..1 decimal Event occurs frequency times per period
...... periodMax Σ 0..1 decimal Upper limit of period (3-4 hours)
...... periodUnit SΣ 0..1 code s | min | h | d | wk | mo | a - unit of time (UCUM)
Binding: UnitsOfTime (required): A unit of time (units from UCUM).
...... dayOfWeek Σ 0..* code mon | tue | wed | thu | fri | sat | sun
Binding: DaysOfWeek (required)
...... timeOfDay Σ 0..* time Time of day for action
...... when Σ 0..* code Code for time period of occurrence
Binding: EventTiming (required): Real world event relating to the schedule.
...... offset Σ 0..1 unsignedInt Minutes from event (before or after)
..... code SΣ 0..1 CodeableConcept BID | TID | QID | AM | PM | QD | QOD | +
Binding: TimingAbbreviation (extensible)
.... Slices for asNeeded[x] SΣ 0..1 Take "as needed" (for x)
Slice: Unordered, Closed by type:$this
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
..... asNeeded[x]:asNeededBoolean Σ 0..1 boolean Take only when needed (true/false)
..... asNeeded[x]:asNeededCodeableConcept Σ 0..1 CodeableConcept Take "as needed" (for x)
Binding: SNOMEDCTMedicationAsNeededReasonCodes (extensible)
.... site SΣ 0..1 CodeableConcept Where to apply (left eye, right arm)
Binding: SNOMEDCTBodyStructures (extensible)
.... route SΣ 1..1 CodeableConcept How to take (oral, iv)
Binding: SNOMEDCTRouteCodes (extensible)
.... method SΣ 0..1 CodeableConcept How to apply (injection, topical)
Binding: method-codes (??) (extensible)
.... doseAndRate SΣ 0..1 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.
..... Slices for dose[x] SΣ 0..1 Amount of medication per dose
Slice: Unordered, Open by type:$this
...... doseRange Range
...... doseQuantity Quantity(SimpleQuantity)
...... dose[x]:doseQuantity SΣ 0..1 SimpleQuantity Amount per dose (e.g. 500 mg)
..... 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(4.0.1) Upper limit on medication per administration
.... maxDosePerLifetime Σ 0..1 SimpleQuantity(4.0.1) Upper limit on medication per lifetime of the patient
... substitution S 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 S 1..1 boolean True if different from Order
.... type S 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.
..... 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 SΣ 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 SΣ 1..1 uri Identity of the terminology system
...... version Σ 0..1 string Version of the system - if relevant
...... code SΣ 1..1 code Symbol in syntax defined by the system
...... display SΣ 0..1 string Representation defined by the system
...... userSelected Σ 0..1 boolean If this coding was chosen directly by the user
..... text SΣ 0..1 string Plain text representation of the concept
.... reason S 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.meta.​security Base extensible SecurityLabels 📍4.0.1 FHIR Std.
MedicationDispense.meta.​tag Base example Common Tags 📍4.0.1 FHIR Std.
MedicationDispense.language Base preferred Common Languages 📍4.0.1 FHIR Std.
MedicationDispense.identifier.​use Base required IdentifierUse 📍4.0.1 FHIR Std.
MedicationDispense.identifier.​type Base extensible IdentifierType 📍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 extensible https://fhir.sha.go.ke/fhir/ValueSet/medication-codes-vs Not State Unknown
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.​timing.repeat.durationUnit Base required UnitsOfTime 📍4.0.1 FHIR Std.
MedicationDispense.dosageInstruction.​timing.repeat.periodUnit Base required UnitsOfTime 📍4.0.1 FHIR Std.
MedicationDispense.dosageInstruction.​timing.repeat.dayOfWeek Base required DaysOfWeek 📍4.0.1 FHIR Std.
MedicationDispense.dosageInstruction.​timing.repeat.when Base required EventTiming 📍4.0.1 FHIR Std.
MedicationDispense.dosageInstruction.​timing.code Base extensible TimingAbbreviation 📦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.​asNeeded[x]:asNeededCodeableConcept Base extensible SNOMED CT Medication As Needed Reason Codes 📦4.0.1 FHIR Std.
MedicationDispense.dosageInstruction.​site Base extensible SNOMED CT Body Structures 📦4.0.1 FHIR Std.
MedicationDispense.dosageInstruction.​route Base extensible SNOMED CT Route Codes 📦4.0.1 FHIR Std.
MedicationDispense.dosageInstruction.​method Base extensible http://hl7.org/fhir/ValueSet/method-codes Not State Unknown
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
tim-1 error MedicationDispense.dosageInstruction.timing.repeat if there's a duration, there needs to be duration units duration.empty() or durationUnit.exists()
tim-2 error MedicationDispense.dosageInstruction.timing.repeat if there's a period, there needs to be period units period.empty() or periodUnit.exists()
tim-4 error MedicationDispense.dosageInstruction.timing.repeat duration SHALL be a non-negative value duration.exists() implies duration >= 0
tim-5 error MedicationDispense.dosageInstruction.timing.repeat period SHALL be a non-negative value period.exists() implies period >= 0
tim-6 error MedicationDispense.dosageInstruction.timing.repeat If there's a periodMax, there must be a period periodMax.empty() or period.exists()
tim-7 error MedicationDispense.dosageInstruction.timing.repeat If there's a durationMax, there must be a duration durationMax.empty() or duration.exists()
tim-8 error MedicationDispense.dosageInstruction.timing.repeat If there's a countMax, there must be a count countMax.empty() or count.exists()
tim-9 error MedicationDispense.dosageInstruction.timing.repeat If there's an offset, there must be a when (and not C, CM, CD, CV) offset.empty() or (when.exists() and ((when in ('C' | 'CM' | 'CD' | 'CV')).not()))
tim-10 error MedicationDispense.dosageInstruction.timing.repeat If there's a timeOfDay, there cannot be a when, or vice versa timeOfDay.empty() or when.empty()

This structure is derived from MedicationDispense

Summary

Mandatory: 17 elements(3 nested mandatory elements)
Must-Support: 43 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.asNeeded[x]
  • The element 1 is sliced based on the value of MedicationDispense.dosageInstruction.doseAndRate.dose[x]

 

Other representations of profile: CSV, Excel, Schematron