Kenya ePrescription FHIR Implementation Guide
0.1.0 - ci-build Kenya flag

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

Resource Profile: Kenya eRx MedicationRequest

Official URL: https://nshr-uat.sha.go.ke/StructureDefinition/ke-medication-request Version: 0.1.0
Draft as of 2026-04-24 Computable Name: KEMedicationRequest

Copyright/Legal: Copyright 2025+ Digital Health Agency, Kenya. This content is licensed under Creative Commons Attribution 4.0 International (CC-BY-4.0). Terminology content from the Kenya Pharmacy and Poisons Board (PPB) via Open Concept Lab (OCL) is subject to separate terms.

Profile on MedicationRequest for the Kenya Electronic Prescription (eRx) Implementation Guide.

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
.. MedicationRequest 0..* MedicationRequest Ordering of medication for patient or group
... id Σ 1..1 id Logical id of this artifact
... 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
... identifier S 1..* Identifier Globally unique prescription identifier (UUID / token / QR)
... status ?!SΣ 1..1 code Status of the prescription (active, completed, cancelled, on-hold, entered-in-error)
Binding: medicationrequest Status (required)
... statusReason S 0..1 CodeableConcept ​Reason for prescription status change
Binding: https://nshr-uat.sha.go.ke/ValueSet/medication-request-status-reason (required)
... intent ?!SΣ 1..1 code Must be 'order' for ePrescription
Binding: medicationRequest Intent (required)
... category S 1..* CodeableConcept Prescription type (community, inpatient, discharge)
Binding: medicationRequest Category Codes (required)
... priority SΣ 0..1 code Urgency of prescription
Binding: RequestPriority (required)
... doNotPerform ?!Σ 0..1 boolean True if request is prohibiting action
... medication[x] SΣ 1..1 CodeableConcept ​Medicinal product prescribed — Kenya MOH PPB Generic Products
Binding: https://nshr-uat.sha.go.ke/ValueSet/generic-products-vs (required)
... subject SΣ 1..1 Reference(Patient) Patient receiving the prescription
... authoredOn SΣ 1..1 dateTime Date/time prescription was authored
... requester SΣ 1..1 Reference(Practitioner | PractitionerRole) Prescriber
... recorder 0..1 Reference(Practitioner) User who entered the prescription if different from prescriber
... reasonCode S 0..* CodeableConcept ​Clinical indication for therapy
Binding: https://nshr-uat.sha.go.ke/ValueSet/condition-codes-vs (required)
... reasonReference S 0..* Reference(Condition) Condition or observation that supports why the prescription is being written
... note S 0..* Annotation Free-text instructions to pharmacist or patient
... dosageInstruction S 1..* Dosage At least one dosage instruction is required
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... text SΣ 0..1 string Human-readable patient instructions
.... timing SΣ 1..1 Timing When the medication should be taken
..... 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
...... duration SΣ 0..1 decimal Duration value
...... durationUnit SΣ 0..1 code Duration unit
Binding: UnitsOfTime (required): A unit of time (units from UCUM).
...... frequency SΣ 0..1 positiveInt Event occurs frequency times per period
...... period SΣ 0..1 decimal Event occurs frequency times per period
...... periodUnit SΣ 1..1 code Time unit (day, hour, week)
Binding: UnitsOfTime (required): A unit of time (units from UCUM).
..... code SΣ 0..1 CodeableConcept Coded frequency (e.g. BID, TID)
Binding: medicationrequest-dispenser-instructions (??) (required)
.... route SΣ 1..1 CodeableConcept ​Route of administration
Binding: https://nshr-uat.sha.go.ke/ValueSet/route-of-administration-vs (required)
.... method Σ 0..1 CodeableConcept ​Method of administration
Binding: https://nshr-uat.sha.go.ke/ValueSet/route-of-administration-vs (required)
.... doseAndRate SΣ 1..* Element Amount of medication administered
..... Slices for dose[x] Σ 1..1 SimpleQuantity(4.0.1) Amount of medication per dose
Slice: Unordered, Closed by type:$this
...... dose[x]:doseQuantity SΣ 1..1 SimpleQuantity Dose per administration (e.g. 500 mg, 5 ml)
... dispenseRequest S 1..1 BackboneElement Mandatory for ePrescription
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... initialFill S 0..1 BackboneElement First fill details
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... dispenseInterval S 0..1 Duration Minimum period of time between dispenses
.... validityPeriod S 0..1 Period Time period supply is authorized for
.... numberOfRepeatsAllowed S 0..1 unsignedInt Number of refills authorized
.... quantity S 1..1 SimpleQuantity(4.0.1) Total quantity to be dispensed
.... expectedSupplyDuration S 0..1 Duration Number of days supply per dispense
... substitution S 0..1 BackboneElement Any restrictions on medication substitution
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... Slices for allowed[x] 1..1 Whether substitution is allowed or not
Slice: Unordered, Open by type:$this
Binding: ActSubstanceAdminSubstitutionCode (example): Identifies the type of substitution allowed.
..... allowedBoolean boolean
..... allowedCodeableConcept CodeableConcept
..... allowed[x]:allowedCodeableConcept 0..1 CodeableConcept ​Whether generic substitution is allowed
Binding: SubstanceAdminSubstitution (required)
.... reason S 0..1 CodeableConcept Reason substitution is restricted
Binding: SubstanceAdminSubstitutionReason (required)
... detectedIssue S 0..* Reference(DetectedIssue) Clinical Issue with action
... eventHistory S 0..* Reference(Provenance) A list of events of interest in the lifecycle

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
MedicationRequest.status Base required Medicationrequest status 📦4.0.1 FHIR Std.
MedicationRequest.statusReason Base required ​ https://nshr-uat.sha.go.ke/ValueSet/medication-request-status-reason Not State Unknown
MedicationRequest.intent Base required Medication request intent 📦4.0.1 FHIR Std.
MedicationRequest.category Base required Medication request category codes 📦4.0.1 FHIR Std.
MedicationRequest.priority Base required Request priority 📦4.0.1 FHIR Std.
MedicationRequest.medication[x] Base required ​ https://nshr-uat.sha.go.ke/ValueSet/generic-products-vs Not State Unknown
MedicationRequest.reasonCode Base required ​ https://nshr-uat.sha.go.ke/ValueSet/condition-codes-vs Not State Unknown
MedicationRequest.dosageInstruction.​timing.repeat.durationUnit Base required UnitsOfTime 📍4.0.1 FHIR Std.
MedicationRequest.dosageInstruction.​timing.repeat.periodUnit Base required UnitsOfTime 📍4.0.1 FHIR Std.
MedicationRequest.dosageInstruction.​timing.code Base required http://hl7.org/fhir/ValueSet/medicationrequest-dispenser-instructions Not State Unknown
MedicationRequest.dosageInstruction.​route Base required ​ https://nshr-uat.sha.go.ke/ValueSet/route-of-administration-vs Not State Unknown
MedicationRequest.dosageInstruction.​method Base required ​ https://nshr-uat.sha.go.ke/ValueSet/route-of-administration-vs Not State Unknown
MedicationRequest.substitution.​allowed[x] Base example ActSubstanceAdminSubstitutionCode 📦3.0.0 THO v7.1
MedicationRequest.substitution.​allowed[x]:allowedCodeableConcept Base required http://hl7.org/fhir/ValueSet/v3-SubstanceAdminSubstitution Not State Unknown
MedicationRequest.substitution.​reason Base required SubstanceAdminSubstitutionReason 📦3.0.0 THO v7.1

Constraints

Id Grade Path(s) Description Expression
dom-2 error MedicationRequest If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error MedicationRequest If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4 error MedicationRequest If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5 error MedicationRequest If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice MedicationRequest A resource should have narrative for robust management text.`div`.exists()
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()
tim-1 error MedicationRequest.dosageInstruction.timing.repeat if there's a duration, there needs to be duration units duration.empty() or durationUnit.exists()
tim-2 error MedicationRequest.dosageInstruction.timing.repeat if there's a period, there needs to be period units period.empty() or periodUnit.exists()
tim-4 error MedicationRequest.dosageInstruction.timing.repeat duration SHALL be a non-negative value duration.exists() implies duration >= 0
tim-5 error MedicationRequest.dosageInstruction.timing.repeat period SHALL be a non-negative value period.exists() implies period >= 0
tim-6 error MedicationRequest.dosageInstruction.timing.repeat If there's a periodMax, there must be a period periodMax.empty() or period.exists()
tim-7 error MedicationRequest.dosageInstruction.timing.repeat If there's a durationMax, there must be a duration durationMax.empty() or duration.exists()
tim-8 error MedicationRequest.dosageInstruction.timing.repeat If there's a countMax, there must be a count countMax.empty() or count.exists()
tim-9 error MedicationRequest.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 MedicationRequest.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 MedicationRequest

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. MedicationRequest 0..* MedicationRequest Ordering of medication for patient or group
... id 1..1 id Logical id of this artifact
... 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 Globally unique prescription identifier (UUID / token / QR)
... statusReason S 0..1 CodeableConcept ​Reason for prescription status change
Binding: https://nshr-uat.sha.go.ke/ValueSet/medication-request-status-reason (required)
... intent S 1..1 code Must be 'order' for ePrescription
Binding: medicationRequest Intent (required)
... category S 1..* CodeableConcept Prescription type (community, inpatient, discharge)
Binding: medicationRequest Category Codes (required)
... priority S 0..1 code Urgency of prescription
Binding: RequestPriority (required)
... medication[x] S 1..1 CodeableConcept ​Medicinal product prescribed — Kenya MOH PPB Generic Products
Binding: https://nshr-uat.sha.go.ke/ValueSet/generic-products-vs (required)
... subject S 1..1 Reference(Patient) Patient receiving the prescription
... authoredOn S 1..1 dateTime Date/time prescription was authored
... requester S 1..1 Reference(Practitioner | PractitionerRole) Prescriber
... recorder 0..1 Reference(Practitioner) User who entered the prescription if different from prescriber
... reasonCode S 0..* CodeableConcept ​Clinical indication for therapy
Binding: https://nshr-uat.sha.go.ke/ValueSet/condition-codes-vs (required)
... reasonReference S 0..* Reference(Condition) Condition or observation that supports why the prescription is being written
... note S 0..* Annotation Free-text instructions to pharmacist or patient
... dosageInstruction S 1..* Dosage At least one dosage instruction is required
.... text S 0..1 string Human-readable patient instructions
.... timing S 1..1 Timing When the medication should be taken
..... repeat S 0..1 Element When the event is to occur
...... duration S 0..1 decimal Duration value
...... durationUnit S 0..1 code Duration unit
...... frequency S 0..1 positiveInt Event occurs frequency times per period
...... period S 0..1 decimal Event occurs frequency times per period
...... periodUnit S 1..1 code Time unit (day, hour, week)
..... code S 0..1 CodeableConcept Coded frequency (e.g. BID, TID)
Binding: medicationrequest-dispenser-instructions (??) (required)
.... route S 1..1 CodeableConcept ​Route of administration
Binding: https://nshr-uat.sha.go.ke/ValueSet/route-of-administration-vs (required)
.... method 0..1 CodeableConcept ​Method of administration
Binding: https://nshr-uat.sha.go.ke/ValueSet/route-of-administration-vs (required)
.... doseAndRate S 1..* Element Amount of medication administered
..... Slices for dose[x] 1..1 SimpleQuantity(4.0.1) Amount of medication per dose
Slice: Unordered, Open by type:$this
...... dose[x]:doseQuantity S 1..1 SimpleQuantity Dose per administration (e.g. 500 mg, 5 ml)
... dispenseRequest S 1..1 BackboneElement Mandatory for ePrescription
.... initialFill S 0..1 BackboneElement First fill details
.... dispenseInterval S 0..1 Duration Minimum period of time between dispenses
.... validityPeriod S 0..1 Period Time period supply is authorized for
.... numberOfRepeatsAllowed S 0..1 unsignedInt Number of refills authorized
.... quantity S 1..1 SimpleQuantity(4.0.1) Total quantity to be dispensed
.... expectedSupplyDuration S 0..1 Duration Number of days supply per dispense
... substitution S 0..1 BackboneElement Any restrictions on medication substitution
.... Slices for allowed[x] 1..1 boolean, CodeableConcept Whether substitution is allowed or not
Slice: Unordered, Open by type:$this
..... allowed[x]:allowedCodeableConcept 0..1 CodeableConcept ​Whether generic substitution is allowed
Binding: SubstanceAdminSubstitution (required)
.... reason S 0..1 CodeableConcept Reason substitution is restricted
Binding: SubstanceAdminSubstitutionReason (required)
... detectedIssue S 0..* Reference(DetectedIssue) Clinical Issue with action
... eventHistory S 0..* Reference(Provenance) A list of events of interest in the lifecycle

doco Documentation for this format

Terminology Bindings (Differential)

Path Status Usage ValueSet Version Source
MedicationRequest.status Base required Medicationrequest status 📦4.0.1 FHIR Std.
MedicationRequest.statusReason Base required ​ https://nshr-uat.sha.go.ke/ValueSet/medication-request-status-reason Not State Unknown
MedicationRequest.intent Base required Medication request intent 📦4.0.1 FHIR Std.
MedicationRequest.category Base required Medication request category codes 📦4.0.1 FHIR Std.
MedicationRequest.priority Base required Request priority 📦4.0.1 FHIR Std.
MedicationRequest.medication[x] Base required ​ https://nshr-uat.sha.go.ke/ValueSet/generic-products-vs Not State Unknown
MedicationRequest.reasonCode Base required ​ https://nshr-uat.sha.go.ke/ValueSet/condition-codes-vs Not State Unknown
MedicationRequest.dosageInstruction.​timing.code Base required http://hl7.org/fhir/ValueSet/medicationrequest-dispenser-instructions Not State Unknown
MedicationRequest.dosageInstruction.​route Base required ​ https://nshr-uat.sha.go.ke/ValueSet/route-of-administration-vs Not State Unknown
MedicationRequest.dosageInstruction.​method Base required ​ https://nshr-uat.sha.go.ke/ValueSet/route-of-administration-vs Not State Unknown
MedicationRequest.substitution.​allowed[x]:allowedCodeableConcept Base required http://hl7.org/fhir/ValueSet/v3-SubstanceAdminSubstitution Not State Unknown
MedicationRequest.substitution.​reason Base required SubstanceAdminSubstitutionReason 📦3.0.0 THO v7.1
NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. MedicationRequest 0..* MedicationRequest Ordering of medication for patient or group
... id Σ 1..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 Globally unique prescription identifier (UUID / token / QR)
... status ?!SΣ 1..1 code Status of the prescription (active, completed, cancelled, on-hold, entered-in-error)
Binding: medicationrequest Status (required)
... statusReason S 0..1 CodeableConcept ​Reason for prescription status change
Binding: https://nshr-uat.sha.go.ke/ValueSet/medication-request-status-reason (required)
... intent ?!SΣ 1..1 code Must be 'order' for ePrescription
Binding: medicationRequest Intent (required)
... category S 1..* CodeableConcept Prescription type (community, inpatient, discharge)
Binding: medicationRequest Category Codes (required)
... priority SΣ 0..1 code Urgency of prescription
Binding: RequestPriority (required)
... doNotPerform ?!Σ 0..1 boolean True if request is prohibiting action
... reported[x] Σ 0..1 Reported rather than primary record
.... reportedBoolean boolean
.... reportedReference Reference(Patient | Practitioner | PractitionerRole | RelatedPerson | Organization)
... medication[x] SΣ 1..1 CodeableConcept ​Medicinal product prescribed — Kenya MOH PPB Generic Products
Binding: https://nshr-uat.sha.go.ke/ValueSet/generic-products-vs (required)
... subject SΣ 1..1 Reference(Patient) Patient receiving the prescription
... encounter 0..1 Reference(Encounter) Encounter created as part of encounter/admission/stay
... supportingInformation 0..* Reference(Resource) Information to support ordering of the medication
... authoredOn SΣ 1..1 dateTime Date/time prescription was authored
... requester SΣ 1..1 Reference(Practitioner | PractitionerRole) Prescriber
... performer 0..1 Reference(Practitioner | PractitionerRole | Organization | Patient | Device | RelatedPerson | CareTeam) Intended performer of administration
... performerType Σ 0..1 CodeableConcept Desired kind of performer of the medication administration
Binding: ProcedurePerformerRoleCodes (example): Identifies the type of individual that is desired to administer the medication.
... recorder 0..1 Reference(Practitioner) User who entered the prescription if different from prescriber
... reasonCode S 0..* CodeableConcept ​Clinical indication for therapy
Binding: https://nshr-uat.sha.go.ke/ValueSet/condition-codes-vs (required)
... reasonReference S 0..* Reference(Condition) Condition or observation that supports why the prescription is being written
... instantiatesCanonical Σ 0..* canonical() Instantiates FHIR protocol or definition
... instantiatesUri Σ 0..* uri Instantiates external protocol or definition
... basedOn Σ 0..* Reference(CarePlan | MedicationRequest | ServiceRequest | ImmunizationRecommendation) What request fulfills
... groupIdentifier Σ 0..1 Identifier Composite request this is part of
... courseOfTherapyType 0..1 CodeableConcept Overall pattern of medication administration
Binding: medicationRequest Course of Therapy Codes (example): Identifies the overall pattern of medication administratio.
... insurance 0..* Reference(Coverage | ClaimResponse) Associated insurance coverage
... note S 0..* Annotation Free-text instructions to pharmacist or patient
... dosageInstruction S 1..* Dosage At least one dosage instruction is 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
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... sequence Σ 0..1 integer The order of the dosage instructions
.... text SΣ 0..1 string Human-readable patient instructions
.... 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Σ 1..1 Timing When the medication should be taken
..... 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 SΣ 0..1 decimal Duration value
...... durationMax Σ 0..1 decimal How long when it happens (Max)
...... durationUnit SΣ 0..1 code Duration unit
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Σ 1..1 code Time unit (day, hour, week)
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 Coded frequency (e.g. BID, TID)
Binding: medicationrequest-dispenser-instructions (??) (required)
.... asNeeded[x] Σ 0..1 Take "as needed" (for x)
Binding: SNOMEDCTMedicationAsNeededReasonCodes (example): A coded concept identifying the precondition that should be met or evaluated prior to consuming or administering a medication dose. For example "pain", "30 minutes prior to sexual intercourse", "on flare-up" etc.
..... asNeededBoolean boolean
..... asNeededCodeableConcept CodeableConcept
.... site Σ 0..1 CodeableConcept Body site to administer to
Binding: SNOMEDCTAnatomicalStructureForAdministrationSiteCodes (example): A coded concept describing the site location the medicine enters into or onto the body.
.... route SΣ 1..1 CodeableConcept ​Route of administration
Binding: https://nshr-uat.sha.go.ke/ValueSet/route-of-administration-vs (required)
.... method Σ 0..1 CodeableConcept ​Method of administration
Binding: https://nshr-uat.sha.go.ke/ValueSet/route-of-administration-vs (required)
.... doseAndRate SΣ 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] Σ 1..1 SimpleQuantity(4.0.1) Amount of medication per dose
Slice: Unordered, Closed by type:$this
...... dose[x]:doseQuantity SΣ 1..1 SimpleQuantity Dose per administration (e.g. 500 mg, 5 ml)
..... 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
... dispenseRequest S 1..1 BackboneElement Mandatory for ePrescription
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... initialFill S 0..1 BackboneElement First fill details
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... quantity 0..1 SimpleQuantity(4.0.1) First fill quantity
..... duration 0..1 Duration First fill duration
.... dispenseInterval S 0..1 Duration Minimum period of time between dispenses
.... validityPeriod S 0..1 Period Time period supply is authorized for
.... numberOfRepeatsAllowed S 0..1 unsignedInt Number of refills authorized
.... quantity S 1..1 SimpleQuantity(4.0.1) Total quantity to be dispensed
.... expectedSupplyDuration S 0..1 Duration Number of days supply per dispense
.... performer 0..1 Reference(Organization) Intended dispenser
... substitution S 0..1 BackboneElement Any restrictions on medication substitution
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... Slices for allowed[x] 1..1 Whether substitution is allowed or not
Slice: Unordered, Open by type:$this
Binding: ActSubstanceAdminSubstitutionCode (example): Identifies the type of substitution allowed.
..... allowedBoolean boolean
..... allowedCodeableConcept CodeableConcept
..... allowed[x]:allowedCodeableConcept 0..1 CodeableConcept ​Whether generic substitution is allowed
Binding: SubstanceAdminSubstitution (required)
.... reason S 0..1 CodeableConcept Reason substitution is restricted
Binding: SubstanceAdminSubstitutionReason (required)
... priorPrescription 0..1 Reference(MedicationRequest) An order/prescription that is being replaced
... detectedIssue S 0..* Reference(DetectedIssue) Clinical Issue with action
... eventHistory S 0..* Reference(Provenance) A list of events of interest in the lifecycle

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
MedicationRequest.meta.​security Base extensible SecurityLabels 📍4.0.1 FHIR Std.
MedicationRequest.meta.​tag Base example Common Tags 📍4.0.1 FHIR Std.
MedicationRequest.language Base preferred Common Languages 📍4.0.1 FHIR Std.
MedicationRequest.status Base required Medicationrequest status 📦4.0.1 FHIR Std.
MedicationRequest.statusReason Base required ​ https://nshr-uat.sha.go.ke/ValueSet/medication-request-status-reason Not State Unknown
MedicationRequest.intent Base required Medication request intent 📦4.0.1 FHIR Std.
MedicationRequest.category Base required Medication request category codes 📦4.0.1 FHIR Std.
MedicationRequest.priority Base required Request priority 📦4.0.1 FHIR Std.
MedicationRequest.medication[x] Base required ​ https://nshr-uat.sha.go.ke/ValueSet/generic-products-vs Not State Unknown
MedicationRequest.performerType Base example Procedure Performer Role Codes 📍4.0.1 FHIR Std.
MedicationRequest.reasonCode Base required ​ https://nshr-uat.sha.go.ke/ValueSet/condition-codes-vs Not State Unknown
MedicationRequest.courseOfTherapyType Base example Medication request course of therapy codes 📍4.0.1 FHIR Std.
MedicationRequest.dosageInstruction.​additionalInstruction Base example SNOMED CT Additional Dosage Instructions 📍4.0.1 FHIR Std.
MedicationRequest.dosageInstruction.​timing.repeat.durationUnit Base required UnitsOfTime 📍4.0.1 FHIR Std.
MedicationRequest.dosageInstruction.​timing.repeat.periodUnit Base required UnitsOfTime 📍4.0.1 FHIR Std.
MedicationRequest.dosageInstruction.​timing.repeat.dayOfWeek Base required DaysOfWeek 📍4.0.1 FHIR Std.
MedicationRequest.dosageInstruction.​timing.repeat.when Base required EventTiming 📍4.0.1 FHIR Std.
MedicationRequest.dosageInstruction.​timing.code Base required http://hl7.org/fhir/ValueSet/medicationrequest-dispenser-instructions Not State Unknown
MedicationRequest.dosageInstruction.​asNeeded[x] Base example SNOMED CT Medication As Needed Reason Codes 📍4.0.1 FHIR Std.
MedicationRequest.dosageInstruction.​site Base example SNOMED CT Anatomical Structure for Administration Site Codes 📍4.0.1 FHIR Std.
MedicationRequest.dosageInstruction.​route Base required ​ https://nshr-uat.sha.go.ke/ValueSet/route-of-administration-vs Not State Unknown
MedicationRequest.dosageInstruction.​method Base required ​ https://nshr-uat.sha.go.ke/ValueSet/route-of-administration-vs Not State Unknown
MedicationRequest.dosageInstruction.​doseAndRate.type Base example DoseAndRateType 📍4.0.1 FHIR Std.
MedicationRequest.substitution.​allowed[x] Base example ActSubstanceAdminSubstitutionCode 📦3.0.0 THO v7.1
MedicationRequest.substitution.​allowed[x]:allowedCodeableConcept Base required http://hl7.org/fhir/ValueSet/v3-SubstanceAdminSubstitution Not State Unknown
MedicationRequest.substitution.​reason Base required SubstanceAdminSubstitutionReason 📦3.0.0 THO v7.1

Constraints

Id Grade Path(s) Description Expression
dom-2 error MedicationRequest If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error MedicationRequest If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4 error MedicationRequest If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5 error MedicationRequest If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice MedicationRequest A resource should have narrative for robust management text.`div`.exists()
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()
tim-1 error MedicationRequest.dosageInstruction.timing.repeat if there's a duration, there needs to be duration units duration.empty() or durationUnit.exists()
tim-2 error MedicationRequest.dosageInstruction.timing.repeat if there's a period, there needs to be period units period.empty() or periodUnit.exists()
tim-4 error MedicationRequest.dosageInstruction.timing.repeat duration SHALL be a non-negative value duration.exists() implies duration >= 0
tim-5 error MedicationRequest.dosageInstruction.timing.repeat period SHALL be a non-negative value period.exists() implies period >= 0
tim-6 error MedicationRequest.dosageInstruction.timing.repeat If there's a periodMax, there must be a period periodMax.empty() or period.exists()
tim-7 error MedicationRequest.dosageInstruction.timing.repeat If there's a durationMax, there must be a duration durationMax.empty() or duration.exists()
tim-8 error MedicationRequest.dosageInstruction.timing.repeat If there's a countMax, there must be a count countMax.empty() or count.exists()
tim-9 error MedicationRequest.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 MedicationRequest.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 MedicationRequest

Summary

Mandatory: 15 elements(1 nested mandatory element)
Must-Support: 39 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 MedicationRequest.dosageInstruction.doseAndRate.dose[x]
  • The element 1 is sliced based on the value of MedicationRequest.substitution.allowed[x]

Key Elements View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. MedicationRequest 0..* MedicationRequest Ordering of medication for patient or group
... id Σ 1..1 id Logical id of this artifact
... 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
... identifier S 1..* Identifier Globally unique prescription identifier (UUID / token / QR)
... status ?!SΣ 1..1 code Status of the prescription (active, completed, cancelled, on-hold, entered-in-error)
Binding: medicationrequest Status (required)
... statusReason S 0..1 CodeableConcept ​Reason for prescription status change
Binding: https://nshr-uat.sha.go.ke/ValueSet/medication-request-status-reason (required)
... intent ?!SΣ 1..1 code Must be 'order' for ePrescription
Binding: medicationRequest Intent (required)
... category S 1..* CodeableConcept Prescription type (community, inpatient, discharge)
Binding: medicationRequest Category Codes (required)
... priority SΣ 0..1 code Urgency of prescription
Binding: RequestPriority (required)
... doNotPerform ?!Σ 0..1 boolean True if request is prohibiting action
... medication[x] SΣ 1..1 CodeableConcept ​Medicinal product prescribed — Kenya MOH PPB Generic Products
Binding: https://nshr-uat.sha.go.ke/ValueSet/generic-products-vs (required)
... subject SΣ 1..1 Reference(Patient) Patient receiving the prescription
... authoredOn SΣ 1..1 dateTime Date/time prescription was authored
... requester SΣ 1..1 Reference(Practitioner | PractitionerRole) Prescriber
... recorder 0..1 Reference(Practitioner) User who entered the prescription if different from prescriber
... reasonCode S 0..* CodeableConcept ​Clinical indication for therapy
Binding: https://nshr-uat.sha.go.ke/ValueSet/condition-codes-vs (required)
... reasonReference S 0..* Reference(Condition) Condition or observation that supports why the prescription is being written
... note S 0..* Annotation Free-text instructions to pharmacist or patient
... dosageInstruction S 1..* Dosage At least one dosage instruction is required
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... text SΣ 0..1 string Human-readable patient instructions
.... timing SΣ 1..1 Timing When the medication should be taken
..... 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
...... duration SΣ 0..1 decimal Duration value
...... durationUnit SΣ 0..1 code Duration unit
Binding: UnitsOfTime (required): A unit of time (units from UCUM).
...... frequency SΣ 0..1 positiveInt Event occurs frequency times per period
...... period SΣ 0..1 decimal Event occurs frequency times per period
...... periodUnit SΣ 1..1 code Time unit (day, hour, week)
Binding: UnitsOfTime (required): A unit of time (units from UCUM).
..... code SΣ 0..1 CodeableConcept Coded frequency (e.g. BID, TID)
Binding: medicationrequest-dispenser-instructions (??) (required)
.... route SΣ 1..1 CodeableConcept ​Route of administration
Binding: https://nshr-uat.sha.go.ke/ValueSet/route-of-administration-vs (required)
.... method Σ 0..1 CodeableConcept ​Method of administration
Binding: https://nshr-uat.sha.go.ke/ValueSet/route-of-administration-vs (required)
.... doseAndRate SΣ 1..* Element Amount of medication administered
..... Slices for dose[x] Σ 1..1 SimpleQuantity(4.0.1) Amount of medication per dose
Slice: Unordered, Closed by type:$this
...... dose[x]:doseQuantity SΣ 1..1 SimpleQuantity Dose per administration (e.g. 500 mg, 5 ml)
... dispenseRequest S 1..1 BackboneElement Mandatory for ePrescription
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... initialFill S 0..1 BackboneElement First fill details
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... dispenseInterval S 0..1 Duration Minimum period of time between dispenses
.... validityPeriod S 0..1 Period Time period supply is authorized for
.... numberOfRepeatsAllowed S 0..1 unsignedInt Number of refills authorized
.... quantity S 1..1 SimpleQuantity(4.0.1) Total quantity to be dispensed
.... expectedSupplyDuration S 0..1 Duration Number of days supply per dispense
... substitution S 0..1 BackboneElement Any restrictions on medication substitution
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... Slices for allowed[x] 1..1 Whether substitution is allowed or not
Slice: Unordered, Open by type:$this
Binding: ActSubstanceAdminSubstitutionCode (example): Identifies the type of substitution allowed.
..... allowedBoolean boolean
..... allowedCodeableConcept CodeableConcept
..... allowed[x]:allowedCodeableConcept 0..1 CodeableConcept ​Whether generic substitution is allowed
Binding: SubstanceAdminSubstitution (required)
.... reason S 0..1 CodeableConcept Reason substitution is restricted
Binding: SubstanceAdminSubstitutionReason (required)
... detectedIssue S 0..* Reference(DetectedIssue) Clinical Issue with action
... eventHistory S 0..* Reference(Provenance) A list of events of interest in the lifecycle

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
MedicationRequest.status Base required Medicationrequest status 📦4.0.1 FHIR Std.
MedicationRequest.statusReason Base required ​ https://nshr-uat.sha.go.ke/ValueSet/medication-request-status-reason Not State Unknown
MedicationRequest.intent Base required Medication request intent 📦4.0.1 FHIR Std.
MedicationRequest.category Base required Medication request category codes 📦4.0.1 FHIR Std.
MedicationRequest.priority Base required Request priority 📦4.0.1 FHIR Std.
MedicationRequest.medication[x] Base required ​ https://nshr-uat.sha.go.ke/ValueSet/generic-products-vs Not State Unknown
MedicationRequest.reasonCode Base required ​ https://nshr-uat.sha.go.ke/ValueSet/condition-codes-vs Not State Unknown
MedicationRequest.dosageInstruction.​timing.repeat.durationUnit Base required UnitsOfTime 📍4.0.1 FHIR Std.
MedicationRequest.dosageInstruction.​timing.repeat.periodUnit Base required UnitsOfTime 📍4.0.1 FHIR Std.
MedicationRequest.dosageInstruction.​timing.code Base required http://hl7.org/fhir/ValueSet/medicationrequest-dispenser-instructions Not State Unknown
MedicationRequest.dosageInstruction.​route Base required ​ https://nshr-uat.sha.go.ke/ValueSet/route-of-administration-vs Not State Unknown
MedicationRequest.dosageInstruction.​method Base required ​ https://nshr-uat.sha.go.ke/ValueSet/route-of-administration-vs Not State Unknown
MedicationRequest.substitution.​allowed[x] Base example ActSubstanceAdminSubstitutionCode 📦3.0.0 THO v7.1
MedicationRequest.substitution.​allowed[x]:allowedCodeableConcept Base required http://hl7.org/fhir/ValueSet/v3-SubstanceAdminSubstitution Not State Unknown
MedicationRequest.substitution.​reason Base required SubstanceAdminSubstitutionReason 📦3.0.0 THO v7.1

Constraints

Id Grade Path(s) Description Expression
dom-2 error MedicationRequest If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error MedicationRequest If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4 error MedicationRequest If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5 error MedicationRequest If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice MedicationRequest A resource should have narrative for robust management text.`div`.exists()
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()
tim-1 error MedicationRequest.dosageInstruction.timing.repeat if there's a duration, there needs to be duration units duration.empty() or durationUnit.exists()
tim-2 error MedicationRequest.dosageInstruction.timing.repeat if there's a period, there needs to be period units period.empty() or periodUnit.exists()
tim-4 error MedicationRequest.dosageInstruction.timing.repeat duration SHALL be a non-negative value duration.exists() implies duration >= 0
tim-5 error MedicationRequest.dosageInstruction.timing.repeat period SHALL be a non-negative value period.exists() implies period >= 0
tim-6 error MedicationRequest.dosageInstruction.timing.repeat If there's a periodMax, there must be a period periodMax.empty() or period.exists()
tim-7 error MedicationRequest.dosageInstruction.timing.repeat If there's a durationMax, there must be a duration durationMax.empty() or duration.exists()
tim-8 error MedicationRequest.dosageInstruction.timing.repeat If there's a countMax, there must be a count countMax.empty() or count.exists()
tim-9 error MedicationRequest.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 MedicationRequest.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 MedicationRequest

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. MedicationRequest 0..* MedicationRequest Ordering of medication for patient or group
... id 1..1 id Logical id of this artifact
... 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 Globally unique prescription identifier (UUID / token / QR)
... statusReason S 0..1 CodeableConcept ​Reason for prescription status change
Binding: https://nshr-uat.sha.go.ke/ValueSet/medication-request-status-reason (required)
... intent S 1..1 code Must be 'order' for ePrescription
Binding: medicationRequest Intent (required)
... category S 1..* CodeableConcept Prescription type (community, inpatient, discharge)
Binding: medicationRequest Category Codes (required)
... priority S 0..1 code Urgency of prescription
Binding: RequestPriority (required)
... medication[x] S 1..1 CodeableConcept ​Medicinal product prescribed — Kenya MOH PPB Generic Products
Binding: https://nshr-uat.sha.go.ke/ValueSet/generic-products-vs (required)
... subject S 1..1 Reference(Patient) Patient receiving the prescription
... authoredOn S 1..1 dateTime Date/time prescription was authored
... requester S 1..1 Reference(Practitioner | PractitionerRole) Prescriber
... recorder 0..1 Reference(Practitioner) User who entered the prescription if different from prescriber
... reasonCode S 0..* CodeableConcept ​Clinical indication for therapy
Binding: https://nshr-uat.sha.go.ke/ValueSet/condition-codes-vs (required)
... reasonReference S 0..* Reference(Condition) Condition or observation that supports why the prescription is being written
... note S 0..* Annotation Free-text instructions to pharmacist or patient
... dosageInstruction S 1..* Dosage At least one dosage instruction is required
.... text S 0..1 string Human-readable patient instructions
.... timing S 1..1 Timing When the medication should be taken
..... repeat S 0..1 Element When the event is to occur
...... duration S 0..1 decimal Duration value
...... durationUnit S 0..1 code Duration unit
...... frequency S 0..1 positiveInt Event occurs frequency times per period
...... period S 0..1 decimal Event occurs frequency times per period
...... periodUnit S 1..1 code Time unit (day, hour, week)
..... code S 0..1 CodeableConcept Coded frequency (e.g. BID, TID)
Binding: medicationrequest-dispenser-instructions (??) (required)
.... route S 1..1 CodeableConcept ​Route of administration
Binding: https://nshr-uat.sha.go.ke/ValueSet/route-of-administration-vs (required)
.... method 0..1 CodeableConcept ​Method of administration
Binding: https://nshr-uat.sha.go.ke/ValueSet/route-of-administration-vs (required)
.... doseAndRate S 1..* Element Amount of medication administered
..... Slices for dose[x] 1..1 SimpleQuantity(4.0.1) Amount of medication per dose
Slice: Unordered, Open by type:$this
...... dose[x]:doseQuantity S 1..1 SimpleQuantity Dose per administration (e.g. 500 mg, 5 ml)
... dispenseRequest S 1..1 BackboneElement Mandatory for ePrescription
.... initialFill S 0..1 BackboneElement First fill details
.... dispenseInterval S 0..1 Duration Minimum period of time between dispenses
.... validityPeriod S 0..1 Period Time period supply is authorized for
.... numberOfRepeatsAllowed S 0..1 unsignedInt Number of refills authorized
.... quantity S 1..1 SimpleQuantity(4.0.1) Total quantity to be dispensed
.... expectedSupplyDuration S 0..1 Duration Number of days supply per dispense
... substitution S 0..1 BackboneElement Any restrictions on medication substitution
.... Slices for allowed[x] 1..1 boolean, CodeableConcept Whether substitution is allowed or not
Slice: Unordered, Open by type:$this
..... allowed[x]:allowedCodeableConcept 0..1 CodeableConcept ​Whether generic substitution is allowed
Binding: SubstanceAdminSubstitution (required)
.... reason S 0..1 CodeableConcept Reason substitution is restricted
Binding: SubstanceAdminSubstitutionReason (required)
... detectedIssue S 0..* Reference(DetectedIssue) Clinical Issue with action
... eventHistory S 0..* Reference(Provenance) A list of events of interest in the lifecycle

doco Documentation for this format

Terminology Bindings (Differential)

Path Status Usage ValueSet Version Source
MedicationRequest.status Base required Medicationrequest status 📦4.0.1 FHIR Std.
MedicationRequest.statusReason Base required ​ https://nshr-uat.sha.go.ke/ValueSet/medication-request-status-reason Not State Unknown
MedicationRequest.intent Base required Medication request intent 📦4.0.1 FHIR Std.
MedicationRequest.category Base required Medication request category codes 📦4.0.1 FHIR Std.
MedicationRequest.priority Base required Request priority 📦4.0.1 FHIR Std.
MedicationRequest.medication[x] Base required ​ https://nshr-uat.sha.go.ke/ValueSet/generic-products-vs Not State Unknown
MedicationRequest.reasonCode Base required ​ https://nshr-uat.sha.go.ke/ValueSet/condition-codes-vs Not State Unknown
MedicationRequest.dosageInstruction.​timing.code Base required http://hl7.org/fhir/ValueSet/medicationrequest-dispenser-instructions Not State Unknown
MedicationRequest.dosageInstruction.​route Base required ​ https://nshr-uat.sha.go.ke/ValueSet/route-of-administration-vs Not State Unknown
MedicationRequest.dosageInstruction.​method Base required ​ https://nshr-uat.sha.go.ke/ValueSet/route-of-administration-vs Not State Unknown
MedicationRequest.substitution.​allowed[x]:allowedCodeableConcept Base required http://hl7.org/fhir/ValueSet/v3-SubstanceAdminSubstitution Not State Unknown
MedicationRequest.substitution.​reason Base required SubstanceAdminSubstitutionReason 📦3.0.0 THO v7.1

Snapshot View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. MedicationRequest 0..* MedicationRequest Ordering of medication for patient or group
... id Σ 1..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 Globally unique prescription identifier (UUID / token / QR)
... status ?!SΣ 1..1 code Status of the prescription (active, completed, cancelled, on-hold, entered-in-error)
Binding: medicationrequest Status (required)
... statusReason S 0..1 CodeableConcept ​Reason for prescription status change
Binding: https://nshr-uat.sha.go.ke/ValueSet/medication-request-status-reason (required)
... intent ?!SΣ 1..1 code Must be 'order' for ePrescription
Binding: medicationRequest Intent (required)
... category S 1..* CodeableConcept Prescription type (community, inpatient, discharge)
Binding: medicationRequest Category Codes (required)
... priority SΣ 0..1 code Urgency of prescription
Binding: RequestPriority (required)
... doNotPerform ?!Σ 0..1 boolean True if request is prohibiting action
... reported[x] Σ 0..1 Reported rather than primary record
.... reportedBoolean boolean
.... reportedReference Reference(Patient | Practitioner | PractitionerRole | RelatedPerson | Organization)
... medication[x] SΣ 1..1 CodeableConcept ​Medicinal product prescribed — Kenya MOH PPB Generic Products
Binding: https://nshr-uat.sha.go.ke/ValueSet/generic-products-vs (required)
... subject SΣ 1..1 Reference(Patient) Patient receiving the prescription
... encounter 0..1 Reference(Encounter) Encounter created as part of encounter/admission/stay
... supportingInformation 0..* Reference(Resource) Information to support ordering of the medication
... authoredOn SΣ 1..1 dateTime Date/time prescription was authored
... requester SΣ 1..1 Reference(Practitioner | PractitionerRole) Prescriber
... performer 0..1 Reference(Practitioner | PractitionerRole | Organization | Patient | Device | RelatedPerson | CareTeam) Intended performer of administration
... performerType Σ 0..1 CodeableConcept Desired kind of performer of the medication administration
Binding: ProcedurePerformerRoleCodes (example): Identifies the type of individual that is desired to administer the medication.
... recorder 0..1 Reference(Practitioner) User who entered the prescription if different from prescriber
... reasonCode S 0..* CodeableConcept ​Clinical indication for therapy
Binding: https://nshr-uat.sha.go.ke/ValueSet/condition-codes-vs (required)
... reasonReference S 0..* Reference(Condition) Condition or observation that supports why the prescription is being written
... instantiatesCanonical Σ 0..* canonical() Instantiates FHIR protocol or definition
... instantiatesUri Σ 0..* uri Instantiates external protocol or definition
... basedOn Σ 0..* Reference(CarePlan | MedicationRequest | ServiceRequest | ImmunizationRecommendation) What request fulfills
... groupIdentifier Σ 0..1 Identifier Composite request this is part of
... courseOfTherapyType 0..1 CodeableConcept Overall pattern of medication administration
Binding: medicationRequest Course of Therapy Codes (example): Identifies the overall pattern of medication administratio.
... insurance 0..* Reference(Coverage | ClaimResponse) Associated insurance coverage
... note S 0..* Annotation Free-text instructions to pharmacist or patient
... dosageInstruction S 1..* Dosage At least one dosage instruction is 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
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... sequence Σ 0..1 integer The order of the dosage instructions
.... text SΣ 0..1 string Human-readable patient instructions
.... 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Σ 1..1 Timing When the medication should be taken
..... 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 SΣ 0..1 decimal Duration value
...... durationMax Σ 0..1 decimal How long when it happens (Max)
...... durationUnit SΣ 0..1 code Duration unit
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Σ 1..1 code Time unit (day, hour, week)
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 Coded frequency (e.g. BID, TID)
Binding: medicationrequest-dispenser-instructions (??) (required)
.... asNeeded[x] Σ 0..1 Take "as needed" (for x)
Binding: SNOMEDCTMedicationAsNeededReasonCodes (example): A coded concept identifying the precondition that should be met or evaluated prior to consuming or administering a medication dose. For example "pain", "30 minutes prior to sexual intercourse", "on flare-up" etc.
..... asNeededBoolean boolean
..... asNeededCodeableConcept CodeableConcept
.... site Σ 0..1 CodeableConcept Body site to administer to
Binding: SNOMEDCTAnatomicalStructureForAdministrationSiteCodes (example): A coded concept describing the site location the medicine enters into or onto the body.
.... route SΣ 1..1 CodeableConcept ​Route of administration
Binding: https://nshr-uat.sha.go.ke/ValueSet/route-of-administration-vs (required)
.... method Σ 0..1 CodeableConcept ​Method of administration
Binding: https://nshr-uat.sha.go.ke/ValueSet/route-of-administration-vs (required)
.... doseAndRate SΣ 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] Σ 1..1 SimpleQuantity(4.0.1) Amount of medication per dose
Slice: Unordered, Closed by type:$this
...... dose[x]:doseQuantity SΣ 1..1 SimpleQuantity Dose per administration (e.g. 500 mg, 5 ml)
..... 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
... dispenseRequest S 1..1 BackboneElement Mandatory for ePrescription
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... initialFill S 0..1 BackboneElement First fill details
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... quantity 0..1 SimpleQuantity(4.0.1) First fill quantity
..... duration 0..1 Duration First fill duration
.... dispenseInterval S 0..1 Duration Minimum period of time between dispenses
.... validityPeriod S 0..1 Period Time period supply is authorized for
.... numberOfRepeatsAllowed S 0..1 unsignedInt Number of refills authorized
.... quantity S 1..1 SimpleQuantity(4.0.1) Total quantity to be dispensed
.... expectedSupplyDuration S 0..1 Duration Number of days supply per dispense
.... performer 0..1 Reference(Organization) Intended dispenser
... substitution S 0..1 BackboneElement Any restrictions on medication substitution
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... Slices for allowed[x] 1..1 Whether substitution is allowed or not
Slice: Unordered, Open by type:$this
Binding: ActSubstanceAdminSubstitutionCode (example): Identifies the type of substitution allowed.
..... allowedBoolean boolean
..... allowedCodeableConcept CodeableConcept
..... allowed[x]:allowedCodeableConcept 0..1 CodeableConcept ​Whether generic substitution is allowed
Binding: SubstanceAdminSubstitution (required)
.... reason S 0..1 CodeableConcept Reason substitution is restricted
Binding: SubstanceAdminSubstitutionReason (required)
... priorPrescription 0..1 Reference(MedicationRequest) An order/prescription that is being replaced
... detectedIssue S 0..* Reference(DetectedIssue) Clinical Issue with action
... eventHistory S 0..* Reference(Provenance) A list of events of interest in the lifecycle

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
MedicationRequest.meta.​security Base extensible SecurityLabels 📍4.0.1 FHIR Std.
MedicationRequest.meta.​tag Base example Common Tags 📍4.0.1 FHIR Std.
MedicationRequest.language Base preferred Common Languages 📍4.0.1 FHIR Std.
MedicationRequest.status Base required Medicationrequest status 📦4.0.1 FHIR Std.
MedicationRequest.statusReason Base required ​ https://nshr-uat.sha.go.ke/ValueSet/medication-request-status-reason Not State Unknown
MedicationRequest.intent Base required Medication request intent 📦4.0.1 FHIR Std.
MedicationRequest.category Base required Medication request category codes 📦4.0.1 FHIR Std.
MedicationRequest.priority Base required Request priority 📦4.0.1 FHIR Std.
MedicationRequest.medication[x] Base required ​ https://nshr-uat.sha.go.ke/ValueSet/generic-products-vs Not State Unknown
MedicationRequest.performerType Base example Procedure Performer Role Codes 📍4.0.1 FHIR Std.
MedicationRequest.reasonCode Base required ​ https://nshr-uat.sha.go.ke/ValueSet/condition-codes-vs Not State Unknown
MedicationRequest.courseOfTherapyType Base example Medication request course of therapy codes 📍4.0.1 FHIR Std.
MedicationRequest.dosageInstruction.​additionalInstruction Base example SNOMED CT Additional Dosage Instructions 📍4.0.1 FHIR Std.
MedicationRequest.dosageInstruction.​timing.repeat.durationUnit Base required UnitsOfTime 📍4.0.1 FHIR Std.
MedicationRequest.dosageInstruction.​timing.repeat.periodUnit Base required UnitsOfTime 📍4.0.1 FHIR Std.
MedicationRequest.dosageInstruction.​timing.repeat.dayOfWeek Base required DaysOfWeek 📍4.0.1 FHIR Std.
MedicationRequest.dosageInstruction.​timing.repeat.when Base required EventTiming 📍4.0.1 FHIR Std.
MedicationRequest.dosageInstruction.​timing.code Base required http://hl7.org/fhir/ValueSet/medicationrequest-dispenser-instructions Not State Unknown
MedicationRequest.dosageInstruction.​asNeeded[x] Base example SNOMED CT Medication As Needed Reason Codes 📍4.0.1 FHIR Std.
MedicationRequest.dosageInstruction.​site Base example SNOMED CT Anatomical Structure for Administration Site Codes 📍4.0.1 FHIR Std.
MedicationRequest.dosageInstruction.​route Base required ​ https://nshr-uat.sha.go.ke/ValueSet/route-of-administration-vs Not State Unknown
MedicationRequest.dosageInstruction.​method Base required ​ https://nshr-uat.sha.go.ke/ValueSet/route-of-administration-vs Not State Unknown
MedicationRequest.dosageInstruction.​doseAndRate.type Base example DoseAndRateType 📍4.0.1 FHIR Std.
MedicationRequest.substitution.​allowed[x] Base example ActSubstanceAdminSubstitutionCode 📦3.0.0 THO v7.1
MedicationRequest.substitution.​allowed[x]:allowedCodeableConcept Base required http://hl7.org/fhir/ValueSet/v3-SubstanceAdminSubstitution Not State Unknown
MedicationRequest.substitution.​reason Base required SubstanceAdminSubstitutionReason 📦3.0.0 THO v7.1

Constraints

Id Grade Path(s) Description Expression
dom-2 error MedicationRequest If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error MedicationRequest If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4 error MedicationRequest If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5 error MedicationRequest If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice MedicationRequest A resource should have narrative for robust management text.`div`.exists()
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()
tim-1 error MedicationRequest.dosageInstruction.timing.repeat if there's a duration, there needs to be duration units duration.empty() or durationUnit.exists()
tim-2 error MedicationRequest.dosageInstruction.timing.repeat if there's a period, there needs to be period units period.empty() or periodUnit.exists()
tim-4 error MedicationRequest.dosageInstruction.timing.repeat duration SHALL be a non-negative value duration.exists() implies duration >= 0
tim-5 error MedicationRequest.dosageInstruction.timing.repeat period SHALL be a non-negative value period.exists() implies period >= 0
tim-6 error MedicationRequest.dosageInstruction.timing.repeat If there's a periodMax, there must be a period periodMax.empty() or period.exists()
tim-7 error MedicationRequest.dosageInstruction.timing.repeat If there's a durationMax, there must be a duration durationMax.empty() or duration.exists()
tim-8 error MedicationRequest.dosageInstruction.timing.repeat If there's a countMax, there must be a count countMax.empty() or count.exists()
tim-9 error MedicationRequest.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 MedicationRequest.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 MedicationRequest

Summary

Mandatory: 15 elements(1 nested mandatory element)
Must-Support: 39 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 MedicationRequest.dosageInstruction.doseAndRate.dose[x]
  • The element 1 is sliced based on the value of MedicationRequest.substitution.allowed[x]

 

Other representations of profile: CSV, Excel, Schematron