Personal Health Records
1.0.0-ballot2 - STU 1 ballot International flag

Personal Health Records, published by HL7 International / Patient Empowerment. This guide is not an authorized publication; it is the continuous build for version 1.0.0-ballot2 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/HL7/personal-health-record-format-ig/ and changes regularly. See the Directory of published versions

Resource Profile: PGHD MedicationDispense Profile

Official URL: http://hl7.org/fhir/uv/phr/StructureDefinition/pghd-medicationdispense Version: 1.0.0-ballot2
Standards status: Trial-use Maturity Level: 1 Computable Name: PGHDMedicationDispense

This profile defines the dispensing on the part of a pharmacy.

Usages:

  • This Profile is not used by any profiles in this Specification

You can also check for usages in the FHIR IG Statistics

Formal Views of Profile Content

Description Differentials, Snapshots, and other representations.

NameFlagsCard.TypeDescription & Constraints    Filter: doco
MedicationDispense C 0..* MedicationDispense PGHD MedicationDispense Profile
Constraints: mdd-1
MedicationDispense.implicitRules This element is a modifier element. This element is included in summaries. 0..1 uri A set of rules under which this content was created
MedicationDispense.modifierExtension This element is a modifier element. 0..* Extension Extensions that cannot be ignored
MedicationDispense.status This element is a modifier element. This element must be supported. This element is included in summaries. 1..1 code preparation | in-progress | cancelled | on-hold | completed | entered-in-error | stopped | declined | unknown
Binding: MedicationDispense Status Codes (required): A coded concept specifying the state of the dispense event.
MedicationDispense.medication[x] This element must be supported. This element is included in summaries. 1..1 What medication was supplied
Binding: SNOMEDCTMedicationCodes (example): A coded concept identifying which substance or product can be dispensed.
MedicationDispense.medication[x].medicationCodeableConcept CodeableConcept
MedicationDispense.medication[x].medicationReference Reference(Medication)
MedicationDispense.subject This element must be supported. This element is included in summaries. 0..1 Reference(PGHD Patient Profile) Who the dispense is for
MedicationDispense.quantity This element must be supported. C 0..1 SimpleQuantity(4.0.1) Amount dispensed
Constraints: sqty-1
MedicationDispense.whenHandedOver This element must be supported. 0..1 dateTime When product was given out
MedicationDispense.dosageInstruction This element must be supported. 0..* Dosage How the medication is to be used by the patient or administered by the caregiver
MedicationDispense.dosageInstruction.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
MedicationDispense.dosageInstruction.additionalInstruction This element must be supported. This element is included in summaries. 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".
MedicationDispense.dosageInstruction.timing This element must be supported. This element is included in summaries. 0..1 Timing When medication should be administered
MedicationDispense.dosageInstruction.timing.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
MedicationDispense.dosageInstruction.timing.repeat This element must be supported. This element is included in summaries. 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
MedicationDispense.dosageInstruction.timing.repeat.bounds[x] This element must be supported. This element is included in summaries. 0..1 Length/Range of lengths, or (Start and/or end) limits
MedicationDispense.dosageInstruction.timing.repeat.bounds[x].boundsDuration Duration
MedicationDispense.dosageInstruction.timing.repeat.bounds[x].boundsRange Range
MedicationDispense.dosageInstruction.timing.repeat.bounds[x].boundsPeriod Period
MedicationDispense.dosageInstruction.timing.code This element must be supported. This element is included in summaries. 0..1 CodeableConcept BID | TID | QID | AM | PM | QD | QOD | +
Binding: TimingAbbreviation (preferred): Code for a known / defined timing pattern.
MedicationDispense.dosageInstruction.method This element must be supported. This element is included in summaries. 0..1 CodeableConcept Technique for administering medication
Binding: SNOMEDCTAdministrationMethodCodes (example): A coded concept describing the technique by which the medicine is administered.
MedicationDispense.dosageInstruction.doseAndRate This element must be supported. This element is included in summaries. 0..* Element Amount of medication administered
MedicationDispense.dosageInstruction.doseAndRate.type This element must be supported. This element is included in summaries. 0..1 CodeableConcept The kind of dose or rate specified
Binding: DoseAndRateType (example): The kind of dose or rate specified.
MedicationDispense.dosageInstruction.doseAndRate.dose[x] This element must be supported. This element is included in summaries. 0..1 Amount of medication per dose
MedicationDispense.dosageInstruction.doseAndRate.dose[x].doseRange Range
MedicationDispense.dosageInstruction.doseAndRate.dose[x].doseQuantity Quantity(SimpleQuantity)
MedicationDispense.dosageInstruction.doseAndRate.rate[x] This element must be supported. This element is included in summaries. 0..1 Amount of medication per unit of time
MedicationDispense.dosageInstruction.doseAndRate.rate[x].rateRatio Ratio
MedicationDispense.dosageInstruction.doseAndRate.rate[x].rateRange Range
MedicationDispense.dosageInstruction.doseAndRate.rate[x].rateQuantity Quantity(SimpleQuantity)

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
MedicationDispense.status Base required Medication dispense status codes 📍4.0.1 FHIR Std.
MedicationDispense.medication[x] Base example SNOMED CT Medication Codes 📍4.0.1 FHIR Std.
MedicationDispense.dosageInstruction.​additionalInstruction Base example SNOMED CT Additional Dosage Instructions 📍4.0.1 FHIR Std.
MedicationDispense.dosageInstruction.​timing.code Base preferred TimingAbbreviation 📍4.0.1 FHIR Std.
MedicationDispense.dosageInstruction.​method Base example SNOMED CT Administration Method Codes 📍4.0.1 FHIR Std.
MedicationDispense.dosageInstruction.​doseAndRate.type Base example DoseAndRateType 📍4.0.1 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
dom-2 error MedicationDispense If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error MedicationDispense If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4 error MedicationDispense If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5 error MedicationDispense If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice MedicationDispense A resource should have narrative for robust management text.`div`.exists()
ele-1 error **ALL** elements All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error **ALL** extensions Must have either extensions or value[x], not both extension.exists() != value.exists()
mdd-1 error MedicationDispense whenHandedOver cannot be before whenPrepared whenHandedOver.empty() or whenPrepared.empty() or whenHandedOver >= whenPrepared
sqty-1 error MedicationDispense.quantity The comparator is not used on a SimpleQuantity comparator.empty()
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: doco
MedicationDispense 0..* MedicationDispense PGHD MedicationDispense Profile
MedicationDispense.status This element must be supported. 1..1 code preparation | in-progress | cancelled | on-hold | completed | entered-in-error | stopped | declined | unknown
MedicationDispense.medication[x] This element must be supported. 1..1 CodeableConcept, Reference(Medication) What medication was supplied
MedicationDispense.subject This element must be supported. 0..1 Reference(PGHD Patient Profile) Who the dispense is for
MedicationDispense.whenHandedOver This element must be supported. 0..1 dateTime When product was given out
MedicationDispense.dosageInstruction This element must be supported. 0..* Dosage How the medication is to be used by the patient or administered by the caregiver
MedicationDispense.dosageInstruction.additionalInstruction This element must be supported. 0..* CodeableConcept Supplemental instruction or warnings to the patient - e.g. "with meals", "may cause drowsiness"
MedicationDispense.dosageInstruction.timing This element must be supported. 0..1 Timing When medication should be administered
MedicationDispense.dosageInstruction.timing.repeat This element must be supported. 0..1 Element When the event is to occur
MedicationDispense.dosageInstruction.timing.repeat.bounds[x] This element must be supported. 0..1 Duration, Range, Period Length/Range of lengths, or (Start and/or end) limits
MedicationDispense.dosageInstruction.timing.code This element must be supported. 0..1 CodeableConcept BID | TID | QID | AM | PM | QD | QOD | +
MedicationDispense.dosageInstruction.method This element must be supported. 0..1 CodeableConcept Technique for administering medication
MedicationDispense.dosageInstruction.doseAndRate This element must be supported. 0..* Element Amount of medication administered
MedicationDispense.dosageInstruction.doseAndRate.type This element must be supported. 0..1 CodeableConcept The kind of dose or rate specified
MedicationDispense.dosageInstruction.doseAndRate.dose[x] This element must be supported. 0..1 Range, SimpleQuantity(4.0.1) Amount of medication per dose
MedicationDispense.dosageInstruction.doseAndRate.rate[x] This element must be supported. 0..1 Ratio, Range, SimpleQuantity(4.0.1) Amount of medication per unit of time

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraints    Filter: doco
MedicationDispense C 0..* MedicationDispense PGHD MedicationDispense Profile
Constraints: mdd-1
MedicationDispense.id This element is included in summaries. 0..1 id Logical id of this artifact
MedicationDispense.meta This element is included in summaries. 0..1 Meta Metadata about the resource
MedicationDispense.implicitRules This element is a modifier element. This element is included in summaries. 0..1 uri A set of rules under which this content was created
MedicationDispense.language 0..1 code Language of the resource content
Binding: CommonLanguages (preferred): A human language.
Additional BindingsPurpose
AllLanguages Max Binding
MedicationDispense.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
MedicationDispense.contained 0..* Resource Contained, inline Resources
MedicationDispense.extension 0..* Extension Additional content defined by implementations
MedicationDispense.modifierExtension This element is a modifier element. 0..* Extension Extensions that cannot be ignored
MedicationDispense.identifier 0..* Identifier External identifier
MedicationDispense.partOf 0..* Reference(Procedure) Event that dispense is part of
MedicationDispense.status This element is a modifier element. This element must be supported. This element is included in summaries. 1..1 code preparation | in-progress | cancelled | on-hold | completed | entered-in-error | stopped | declined | unknown
Binding: MedicationDispense Status Codes (required): A coded concept specifying the state of the dispense event.
MedicationDispense.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.
MedicationDispense.statusReason[x].statusReasonCodeableConcept CodeableConcept
MedicationDispense.statusReason[x].statusReasonReference Reference(DetectedIssue)
MedicationDispense.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.
MedicationDispense.medication[x] This element must be supported. This element is included in summaries. 1..1 What medication was supplied
Binding: SNOMEDCTMedicationCodes (example): A coded concept identifying which substance or product can be dispensed.
MedicationDispense.medication[x].medicationCodeableConcept CodeableConcept
MedicationDispense.medication[x].medicationReference Reference(Medication)
MedicationDispense.subject This element must be supported. This element is included in summaries. 0..1 Reference(PGHD Patient Profile) Who the dispense is for
MedicationDispense.context 0..1 Reference(Encounter | EpisodeOfCare) Encounter / Episode associated with event
MedicationDispense.supportingInformation 0..* Reference(Resource) Information that supports the dispensing of the medication
MedicationDispense.performer 0..* BackboneElement Who performed event
MedicationDispense.performer.id 0..1 string Unique id for inter-element referencing
MedicationDispense.performer.extension 0..* Extension Additional content defined by implementations
MedicationDispense.performer.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
MedicationDispense.performer.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.
MedicationDispense.performer.actor 1..1 Reference(Practitioner | PractitionerRole | Organization | Patient | Device | RelatedPerson) Individual who was performing
MedicationDispense.location 0..1 Reference(Location) Where the dispense occurred
MedicationDispense.authorizingPrescription 0..* Reference(MedicationRequest) Medication order that authorizes the dispense
MedicationDispense.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.
MedicationDispense.quantity This element must be supported. C 0..1 SimpleQuantity(4.0.1) Amount dispensed
Constraints: sqty-1
MedicationDispense.daysSupply C 0..1 SimpleQuantity(4.0.1) Amount of medication expressed as a timing amount
Constraints: sqty-1
MedicationDispense.whenPrepared This element is included in summaries. 0..1 dateTime When product was packaged and reviewed
MedicationDispense.whenHandedOver This element must be supported. 0..1 dateTime When product was given out
MedicationDispense.destination 0..1 Reference(Location) Where the medication was sent
MedicationDispense.receiver 0..* Reference(Patient | Practitioner) Who collected the medication
MedicationDispense.note 0..* Annotation Information about the dispense
MedicationDispense.dosageInstruction This element must be supported. 0..* Dosage How the medication is to be used by the patient or administered by the caregiver
MedicationDispense.dosageInstruction.id 0..1 string Unique id for inter-element referencing
MedicationDispense.dosageInstruction.extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
MedicationDispense.dosageInstruction.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
MedicationDispense.dosageInstruction.sequence This element is included in summaries. 0..1 integer The order of the dosage instructions
MedicationDispense.dosageInstruction.text This element is included in summaries. 0..1 string Free text dosage instructions e.g. SIG
MedicationDispense.dosageInstruction.additionalInstruction This element must be supported. This element is included in summaries. 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".
MedicationDispense.dosageInstruction.patientInstruction This element is included in summaries. 0..1 string Patient or consumer oriented instructions
MedicationDispense.dosageInstruction.timing This element must be supported. This element is included in summaries. 0..1 Timing When medication should be administered
MedicationDispense.dosageInstruction.timing.id 0..1 string Unique id for inter-element referencing
MedicationDispense.dosageInstruction.timing.extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
MedicationDispense.dosageInstruction.timing.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
MedicationDispense.dosageInstruction.timing.event This element is included in summaries. 0..* dateTime When the event occurs
MedicationDispense.dosageInstruction.timing.repeat This element must be supported. This element is included in summaries. 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
MedicationDispense.dosageInstruction.timing.repeat.id 0..1 string Unique id for inter-element referencing
MedicationDispense.dosageInstruction.timing.repeat.extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
MedicationDispense.dosageInstruction.timing.repeat.bounds[x] This element must be supported. This element is included in summaries. 0..1 Length/Range of lengths, or (Start and/or end) limits
MedicationDispense.dosageInstruction.timing.repeat.bounds[x].boundsDuration Duration
MedicationDispense.dosageInstruction.timing.repeat.bounds[x].boundsRange Range
MedicationDispense.dosageInstruction.timing.repeat.bounds[x].boundsPeriod Period
MedicationDispense.dosageInstruction.timing.repeat.count This element is included in summaries. 0..1 positiveInt Number of times to repeat
MedicationDispense.dosageInstruction.timing.repeat.countMax This element is included in summaries. 0..1 positiveInt Maximum number of times to repeat
MedicationDispense.dosageInstruction.timing.repeat.duration This element is included in summaries. 0..1 decimal How long when it happens
MedicationDispense.dosageInstruction.timing.repeat.durationMax This element is included in summaries. 0..1 decimal How long when it happens (Max)
MedicationDispense.dosageInstruction.timing.repeat.durationUnit This element is included in summaries. 0..1 code s | min | h | d | wk | mo | a - unit of time (UCUM)
Binding: UnitsOfTime (required): A unit of time (units from UCUM).
MedicationDispense.dosageInstruction.timing.repeat.frequency This element is included in summaries. 0..1 positiveInt Event occurs frequency times per period
MedicationDispense.dosageInstruction.timing.repeat.frequencyMax This element is included in summaries. 0..1 positiveInt Event occurs up to frequencyMax times per period
MedicationDispense.dosageInstruction.timing.repeat.period This element is included in summaries. 0..1 decimal Event occurs frequency times per period
MedicationDispense.dosageInstruction.timing.repeat.periodMax This element is included in summaries. 0..1 decimal Upper limit of period (3-4 hours)
MedicationDispense.dosageInstruction.timing.repeat.periodUnit This element is included in summaries. 0..1 code s | min | h | d | wk | mo | a - unit of time (UCUM)
Binding: UnitsOfTime (required): A unit of time (units from UCUM).
MedicationDispense.dosageInstruction.timing.repeat.dayOfWeek This element is included in summaries. 0..* code mon | tue | wed | thu | fri | sat | sun
Binding: DaysOfWeek (required)
MedicationDispense.dosageInstruction.timing.repeat.timeOfDay This element is included in summaries. 0..* time Time of day for action
MedicationDispense.dosageInstruction.timing.repeat.when This element is included in summaries. 0..* code Code for time period of occurrence
Binding: EventTiming (required): Real world event relating to the schedule.
MedicationDispense.dosageInstruction.timing.repeat.offset This element is included in summaries. 0..1 unsignedInt Minutes from event (before or after)
MedicationDispense.dosageInstruction.timing.code This element must be supported. This element is included in summaries. 0..1 CodeableConcept BID | TID | QID | AM | PM | QD | QOD | +
Binding: TimingAbbreviation (preferred): Code for a known / defined timing pattern.
MedicationDispense.dosageInstruction.asNeeded[x] This element is included in summaries. 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.
MedicationDispense.dosageInstruction.asNeeded[x].asNeededBoolean boolean
MedicationDispense.dosageInstruction.asNeeded[x].asNeededCodeableConcept CodeableConcept
MedicationDispense.dosageInstruction.site This element is included in summaries. 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.
MedicationDispense.dosageInstruction.route This element is included in summaries. 0..1 CodeableConcept How drug should enter body
Binding: SNOMEDCTRouteCodes (example): A coded concept describing the route or physiological path of administration of a therapeutic agent into or onto the body of a subject.
MedicationDispense.dosageInstruction.method This element must be supported. This element is included in summaries. 0..1 CodeableConcept Technique for administering medication
Binding: SNOMEDCTAdministrationMethodCodes (example): A coded concept describing the technique by which the medicine is administered.
MedicationDispense.dosageInstruction.doseAndRate This element must be supported. This element is included in summaries. 0..* Element Amount of medication administered
MedicationDispense.dosageInstruction.doseAndRate.id 0..1 string Unique id for inter-element referencing
MedicationDispense.dosageInstruction.doseAndRate.extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
MedicationDispense.dosageInstruction.doseAndRate.type This element must be supported. This element is included in summaries. 0..1 CodeableConcept The kind of dose or rate specified
Binding: DoseAndRateType (example): The kind of dose or rate specified.
MedicationDispense.dosageInstruction.doseAndRate.dose[x] This element must be supported. This element is included in summaries. 0..1 Amount of medication per dose
MedicationDispense.dosageInstruction.doseAndRate.dose[x].doseRange Range
MedicationDispense.dosageInstruction.doseAndRate.dose[x].doseQuantity Quantity(SimpleQuantity)
MedicationDispense.dosageInstruction.doseAndRate.rate[x] This element must be supported. This element is included in summaries. 0..1 Amount of medication per unit of time
MedicationDispense.dosageInstruction.doseAndRate.rate[x].rateRatio Ratio
MedicationDispense.dosageInstruction.doseAndRate.rate[x].rateRange Range
MedicationDispense.dosageInstruction.doseAndRate.rate[x].rateQuantity Quantity(SimpleQuantity)
MedicationDispense.dosageInstruction.maxDosePerPeriod This element is included in summaries. 0..1 Ratio Upper limit on medication per unit of time
MedicationDispense.dosageInstruction.maxDosePerAdministration This element is included in summaries. C 0..1 SimpleQuantity(4.0.1) Upper limit on medication per administration
Constraints: sqty-1
MedicationDispense.dosageInstruction.maxDosePerLifetime This element is included in summaries. C 0..1 SimpleQuantity(4.0.1) Upper limit on medication per lifetime of the patient
Constraints: sqty-1
MedicationDispense.substitution 0..1 BackboneElement Whether a substitution was performed on the dispense
MedicationDispense.substitution.id 0..1 string Unique id for inter-element referencing
MedicationDispense.substitution.extension 0..* Extension Additional content defined by implementations
MedicationDispense.substitution.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
MedicationDispense.substitution.wasSubstituted 1..1 boolean Whether a substitution was or was not performed on the dispense
MedicationDispense.substitution.type 0..1 CodeableConcept Code signifying whether a different drug was dispensed from what was prescribed
Binding: ActSubstanceAdminSubstitutionCode (example): A coded concept describing whether a different medicinal product may be dispensed other than the product as specified exactly in the prescription.
MedicationDispense.substitution.reason 0..* CodeableConcept Why was substitution made
Binding: SubstanceAdminSubstitutionReason (example): A coded concept describing the reason that a different medication should (or should not) be substituted from what was prescribed.
MedicationDispense.substitution.responsibleParty 0..* Reference(Practitioner | PractitionerRole) Who is responsible for the substitution
MedicationDispense.detectedIssue 0..* Reference(DetectedIssue) Clinical issue with action
MedicationDispense.eventHistory 0..* Reference(Provenance) A list of relevant lifecycle events

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
MedicationDispense.language Base preferred Common Languages 📍4.0.1 FHIR Std.
MedicationDispense.status Base required Medication dispense status codes 📍4.0.1 FHIR Std.
MedicationDispense.statusReason[x] Base example Medication dispense status reason codes 📍4.0.1 FHIR Std.
MedicationDispense.category Base preferred Medication dispense category codes 📍4.0.1 FHIR Std.
MedicationDispense.medication[x] Base example SNOMED CT Medication Codes 📍4.0.1 FHIR Std.
MedicationDispense.performer.​function Base example Medication dispense performer function codes 📍4.0.1 FHIR Std.
MedicationDispense.type Base example ActPharmacySupplyType 📦3.0.0 THO v7.4
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 preferred 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.​site Base example SNOMED CT Anatomical Structure for Administration Site Codes 📍4.0.1 FHIR Std.
MedicationDispense.dosageInstruction.​route Base example SNOMED CT Route Codes 📍4.0.1 FHIR Std.
MedicationDispense.dosageInstruction.​method Base example SNOMED CT Administration Method Codes 📍4.0.1 FHIR Std.
MedicationDispense.dosageInstruction.​doseAndRate.type Base example DoseAndRateType 📍4.0.1 FHIR Std.
MedicationDispense.substitution.​type Base example ActSubstanceAdminSubstitutionCode 📦3.0.0 THO v7.4
MedicationDispense.substitution.​reason Base example SubstanceAdminSubstitutionReason 📦3.0.0 THO v7.4

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
sqty-1 error MedicationDispense.quantity, MedicationDispense.daysSupply, MedicationDispense.dosageInstruction.maxDosePerAdministration, MedicationDispense.dosageInstruction.maxDosePerLifetime The comparator is not used on a SimpleQuantity comparator.empty()
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

Must-Support: 16 elements

Structures

This structure refers to these other structures:

Maturity: 1

Key Elements View

NameFlagsCard.TypeDescription & Constraints    Filter: doco
MedicationDispense C 0..* MedicationDispense PGHD MedicationDispense Profile
Constraints: mdd-1
MedicationDispense.implicitRules This element is a modifier element. This element is included in summaries. 0..1 uri A set of rules under which this content was created
MedicationDispense.modifierExtension This element is a modifier element. 0..* Extension Extensions that cannot be ignored
MedicationDispense.status This element is a modifier element. This element must be supported. This element is included in summaries. 1..1 code preparation | in-progress | cancelled | on-hold | completed | entered-in-error | stopped | declined | unknown
Binding: MedicationDispense Status Codes (required): A coded concept specifying the state of the dispense event.
MedicationDispense.medication[x] This element must be supported. This element is included in summaries. 1..1 What medication was supplied
Binding: SNOMEDCTMedicationCodes (example): A coded concept identifying which substance or product can be dispensed.
MedicationDispense.medication[x].medicationCodeableConcept CodeableConcept
MedicationDispense.medication[x].medicationReference Reference(Medication)
MedicationDispense.subject This element must be supported. This element is included in summaries. 0..1 Reference(PGHD Patient Profile) Who the dispense is for
MedicationDispense.quantity This element must be supported. C 0..1 SimpleQuantity(4.0.1) Amount dispensed
Constraints: sqty-1
MedicationDispense.whenHandedOver This element must be supported. 0..1 dateTime When product was given out
MedicationDispense.dosageInstruction This element must be supported. 0..* Dosage How the medication is to be used by the patient or administered by the caregiver
MedicationDispense.dosageInstruction.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
MedicationDispense.dosageInstruction.additionalInstruction This element must be supported. This element is included in summaries. 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".
MedicationDispense.dosageInstruction.timing This element must be supported. This element is included in summaries. 0..1 Timing When medication should be administered
MedicationDispense.dosageInstruction.timing.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
MedicationDispense.dosageInstruction.timing.repeat This element must be supported. This element is included in summaries. 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
MedicationDispense.dosageInstruction.timing.repeat.bounds[x] This element must be supported. This element is included in summaries. 0..1 Length/Range of lengths, or (Start and/or end) limits
MedicationDispense.dosageInstruction.timing.repeat.bounds[x].boundsDuration Duration
MedicationDispense.dosageInstruction.timing.repeat.bounds[x].boundsRange Range
MedicationDispense.dosageInstruction.timing.repeat.bounds[x].boundsPeriod Period
MedicationDispense.dosageInstruction.timing.code This element must be supported. This element is included in summaries. 0..1 CodeableConcept BID | TID | QID | AM | PM | QD | QOD | +
Binding: TimingAbbreviation (preferred): Code for a known / defined timing pattern.
MedicationDispense.dosageInstruction.method This element must be supported. This element is included in summaries. 0..1 CodeableConcept Technique for administering medication
Binding: SNOMEDCTAdministrationMethodCodes (example): A coded concept describing the technique by which the medicine is administered.
MedicationDispense.dosageInstruction.doseAndRate This element must be supported. This element is included in summaries. 0..* Element Amount of medication administered
MedicationDispense.dosageInstruction.doseAndRate.type This element must be supported. This element is included in summaries. 0..1 CodeableConcept The kind of dose or rate specified
Binding: DoseAndRateType (example): The kind of dose or rate specified.
MedicationDispense.dosageInstruction.doseAndRate.dose[x] This element must be supported. This element is included in summaries. 0..1 Amount of medication per dose
MedicationDispense.dosageInstruction.doseAndRate.dose[x].doseRange Range
MedicationDispense.dosageInstruction.doseAndRate.dose[x].doseQuantity Quantity(SimpleQuantity)
MedicationDispense.dosageInstruction.doseAndRate.rate[x] This element must be supported. This element is included in summaries. 0..1 Amount of medication per unit of time
MedicationDispense.dosageInstruction.doseAndRate.rate[x].rateRatio Ratio
MedicationDispense.dosageInstruction.doseAndRate.rate[x].rateRange Range
MedicationDispense.dosageInstruction.doseAndRate.rate[x].rateQuantity Quantity(SimpleQuantity)

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
MedicationDispense.status Base required Medication dispense status codes 📍4.0.1 FHIR Std.
MedicationDispense.medication[x] Base example SNOMED CT Medication Codes 📍4.0.1 FHIR Std.
MedicationDispense.dosageInstruction.​additionalInstruction Base example SNOMED CT Additional Dosage Instructions 📍4.0.1 FHIR Std.
MedicationDispense.dosageInstruction.​timing.code Base preferred TimingAbbreviation 📍4.0.1 FHIR Std.
MedicationDispense.dosageInstruction.​method Base example SNOMED CT Administration Method Codes 📍4.0.1 FHIR Std.
MedicationDispense.dosageInstruction.​doseAndRate.type Base example DoseAndRateType 📍4.0.1 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
dom-2 error MedicationDispense If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error MedicationDispense If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4 error MedicationDispense If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5 error MedicationDispense If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice MedicationDispense A resource should have narrative for robust management text.`div`.exists()
ele-1 error **ALL** elements All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error **ALL** extensions Must have either extensions or value[x], not both extension.exists() != value.exists()
mdd-1 error MedicationDispense whenHandedOver cannot be before whenPrepared whenHandedOver.empty() or whenPrepared.empty() or whenHandedOver >= whenPrepared
sqty-1 error MedicationDispense.quantity The comparator is not used on a SimpleQuantity comparator.empty()
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: doco
MedicationDispense 0..* MedicationDispense PGHD MedicationDispense Profile
MedicationDispense.status This element must be supported. 1..1 code preparation | in-progress | cancelled | on-hold | completed | entered-in-error | stopped | declined | unknown
MedicationDispense.medication[x] This element must be supported. 1..1 CodeableConcept, Reference(Medication) What medication was supplied
MedicationDispense.subject This element must be supported. 0..1 Reference(PGHD Patient Profile) Who the dispense is for
MedicationDispense.quantity This element must be supported. 0..1 SimpleQuantity(4.0.1) Amount dispensed
MedicationDispense.whenHandedOver This element must be supported. 0..1 dateTime When product was given out
MedicationDispense.dosageInstruction This element must be supported. 0..* Dosage How the medication is to be used by the patient or administered by the caregiver
MedicationDispense.dosageInstruction.additionalInstruction This element must be supported. 0..* CodeableConcept Supplemental instruction or warnings to the patient - e.g. "with meals", "may cause drowsiness"
MedicationDispense.dosageInstruction.timing This element must be supported. 0..1 Timing When medication should be administered
MedicationDispense.dosageInstruction.timing.repeat This element must be supported. 0..1 Element When the event is to occur
MedicationDispense.dosageInstruction.timing.repeat.bounds[x] This element must be supported. 0..1 Duration, Range, Period Length/Range of lengths, or (Start and/or end) limits
MedicationDispense.dosageInstruction.timing.code This element must be supported. 0..1 CodeableConcept BID | TID | QID | AM | PM | QD | QOD | +
MedicationDispense.dosageInstruction.method This element must be supported. 0..1 CodeableConcept Technique for administering medication
MedicationDispense.dosageInstruction.doseAndRate This element must be supported. 0..* Element Amount of medication administered
MedicationDispense.dosageInstruction.doseAndRate.type This element must be supported. 0..1 CodeableConcept The kind of dose or rate specified
MedicationDispense.dosageInstruction.doseAndRate.dose[x] This element must be supported. 0..1 Range, SimpleQuantity(4.0.1) Amount of medication per dose
MedicationDispense.dosageInstruction.doseAndRate.rate[x] This element must be supported. 0..1 Ratio, Range, SimpleQuantity(4.0.1) Amount of medication per unit of time

doco Documentation for this format

Snapshot ViewView

NameFlagsCard.TypeDescription & Constraints    Filter: doco
MedicationDispense C 0..* MedicationDispense PGHD MedicationDispense Profile
Constraints: mdd-1
MedicationDispense.id This element is included in summaries. 0..1 id Logical id of this artifact
MedicationDispense.meta This element is included in summaries. 0..1 Meta Metadata about the resource
MedicationDispense.implicitRules This element is a modifier element. This element is included in summaries. 0..1 uri A set of rules under which this content was created
MedicationDispense.language 0..1 code Language of the resource content
Binding: CommonLanguages (preferred): A human language.
Additional BindingsPurpose
AllLanguages Max Binding
MedicationDispense.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
MedicationDispense.contained 0..* Resource Contained, inline Resources
MedicationDispense.extension 0..* Extension Additional content defined by implementations
MedicationDispense.modifierExtension This element is a modifier element. 0..* Extension Extensions that cannot be ignored
MedicationDispense.identifier 0..* Identifier External identifier
MedicationDispense.partOf 0..* Reference(Procedure) Event that dispense is part of
MedicationDispense.status This element is a modifier element. This element must be supported. This element is included in summaries. 1..1 code preparation | in-progress | cancelled | on-hold | completed | entered-in-error | stopped | declined | unknown
Binding: MedicationDispense Status Codes (required): A coded concept specifying the state of the dispense event.
MedicationDispense.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.
MedicationDispense.statusReason[x].statusReasonCodeableConcept CodeableConcept
MedicationDispense.statusReason[x].statusReasonReference Reference(DetectedIssue)
MedicationDispense.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.
MedicationDispense.medication[x] This element must be supported. This element is included in summaries. 1..1 What medication was supplied
Binding: SNOMEDCTMedicationCodes (example): A coded concept identifying which substance or product can be dispensed.
MedicationDispense.medication[x].medicationCodeableConcept CodeableConcept
MedicationDispense.medication[x].medicationReference Reference(Medication)
MedicationDispense.subject This element must be supported. This element is included in summaries. 0..1 Reference(PGHD Patient Profile) Who the dispense is for
MedicationDispense.context 0..1 Reference(Encounter | EpisodeOfCare) Encounter / Episode associated with event
MedicationDispense.supportingInformation 0..* Reference(Resource) Information that supports the dispensing of the medication
MedicationDispense.performer 0..* BackboneElement Who performed event
MedicationDispense.performer.id 0..1 string Unique id for inter-element referencing
MedicationDispense.performer.extension 0..* Extension Additional content defined by implementations
MedicationDispense.performer.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
MedicationDispense.performer.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.
MedicationDispense.performer.actor 1..1 Reference(Practitioner | PractitionerRole | Organization | Patient | Device | RelatedPerson) Individual who was performing
MedicationDispense.location 0..1 Reference(Location) Where the dispense occurred
MedicationDispense.authorizingPrescription 0..* Reference(MedicationRequest) Medication order that authorizes the dispense
MedicationDispense.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.
MedicationDispense.quantity This element must be supported. C 0..1 SimpleQuantity(4.0.1) Amount dispensed
Constraints: sqty-1
MedicationDispense.daysSupply C 0..1 SimpleQuantity(4.0.1) Amount of medication expressed as a timing amount
Constraints: sqty-1
MedicationDispense.whenPrepared This element is included in summaries. 0..1 dateTime When product was packaged and reviewed
MedicationDispense.whenHandedOver This element must be supported. 0..1 dateTime When product was given out
MedicationDispense.destination 0..1 Reference(Location) Where the medication was sent
MedicationDispense.receiver 0..* Reference(Patient | Practitioner) Who collected the medication
MedicationDispense.note 0..* Annotation Information about the dispense
MedicationDispense.dosageInstruction This element must be supported. 0..* Dosage How the medication is to be used by the patient or administered by the caregiver
MedicationDispense.dosageInstruction.id 0..1 string Unique id for inter-element referencing
MedicationDispense.dosageInstruction.extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
MedicationDispense.dosageInstruction.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
MedicationDispense.dosageInstruction.sequence This element is included in summaries. 0..1 integer The order of the dosage instructions
MedicationDispense.dosageInstruction.text This element is included in summaries. 0..1 string Free text dosage instructions e.g. SIG
MedicationDispense.dosageInstruction.additionalInstruction This element must be supported. This element is included in summaries. 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".
MedicationDispense.dosageInstruction.patientInstruction This element is included in summaries. 0..1 string Patient or consumer oriented instructions
MedicationDispense.dosageInstruction.timing This element must be supported. This element is included in summaries. 0..1 Timing When medication should be administered
MedicationDispense.dosageInstruction.timing.id 0..1 string Unique id for inter-element referencing
MedicationDispense.dosageInstruction.timing.extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
MedicationDispense.dosageInstruction.timing.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
MedicationDispense.dosageInstruction.timing.event This element is included in summaries. 0..* dateTime When the event occurs
MedicationDispense.dosageInstruction.timing.repeat This element must be supported. This element is included in summaries. 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
MedicationDispense.dosageInstruction.timing.repeat.id 0..1 string Unique id for inter-element referencing
MedicationDispense.dosageInstruction.timing.repeat.extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
MedicationDispense.dosageInstruction.timing.repeat.bounds[x] This element must be supported. This element is included in summaries. 0..1 Length/Range of lengths, or (Start and/or end) limits
MedicationDispense.dosageInstruction.timing.repeat.bounds[x].boundsDuration Duration
MedicationDispense.dosageInstruction.timing.repeat.bounds[x].boundsRange Range
MedicationDispense.dosageInstruction.timing.repeat.bounds[x].boundsPeriod Period
MedicationDispense.dosageInstruction.timing.repeat.count This element is included in summaries. 0..1 positiveInt Number of times to repeat
MedicationDispense.dosageInstruction.timing.repeat.countMax This element is included in summaries. 0..1 positiveInt Maximum number of times to repeat
MedicationDispense.dosageInstruction.timing.repeat.duration This element is included in summaries. 0..1 decimal How long when it happens
MedicationDispense.dosageInstruction.timing.repeat.durationMax This element is included in summaries. 0..1 decimal How long when it happens (Max)
MedicationDispense.dosageInstruction.timing.repeat.durationUnit This element is included in summaries. 0..1 code s | min | h | d | wk | mo | a - unit of time (UCUM)
Binding: UnitsOfTime (required): A unit of time (units from UCUM).
MedicationDispense.dosageInstruction.timing.repeat.frequency This element is included in summaries. 0..1 positiveInt Event occurs frequency times per period
MedicationDispense.dosageInstruction.timing.repeat.frequencyMax This element is included in summaries. 0..1 positiveInt Event occurs up to frequencyMax times per period
MedicationDispense.dosageInstruction.timing.repeat.period This element is included in summaries. 0..1 decimal Event occurs frequency times per period
MedicationDispense.dosageInstruction.timing.repeat.periodMax This element is included in summaries. 0..1 decimal Upper limit of period (3-4 hours)
MedicationDispense.dosageInstruction.timing.repeat.periodUnit This element is included in summaries. 0..1 code s | min | h | d | wk | mo | a - unit of time (UCUM)
Binding: UnitsOfTime (required): A unit of time (units from UCUM).
MedicationDispense.dosageInstruction.timing.repeat.dayOfWeek This element is included in summaries. 0..* code mon | tue | wed | thu | fri | sat | sun
Binding: DaysOfWeek (required)
MedicationDispense.dosageInstruction.timing.repeat.timeOfDay This element is included in summaries. 0..* time Time of day for action
MedicationDispense.dosageInstruction.timing.repeat.when This element is included in summaries. 0..* code Code for time period of occurrence
Binding: EventTiming (required): Real world event relating to the schedule.
MedicationDispense.dosageInstruction.timing.repeat.offset This element is included in summaries. 0..1 unsignedInt Minutes from event (before or after)
MedicationDispense.dosageInstruction.timing.code This element must be supported. This element is included in summaries. 0..1 CodeableConcept BID | TID | QID | AM | PM | QD | QOD | +
Binding: TimingAbbreviation (preferred): Code for a known / defined timing pattern.
MedicationDispense.dosageInstruction.asNeeded[x] This element is included in summaries. 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.
MedicationDispense.dosageInstruction.asNeeded[x].asNeededBoolean boolean
MedicationDispense.dosageInstruction.asNeeded[x].asNeededCodeableConcept CodeableConcept
MedicationDispense.dosageInstruction.site This element is included in summaries. 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.
MedicationDispense.dosageInstruction.route This element is included in summaries. 0..1 CodeableConcept How drug should enter body
Binding: SNOMEDCTRouteCodes (example): A coded concept describing the route or physiological path of administration of a therapeutic agent into or onto the body of a subject.
MedicationDispense.dosageInstruction.method This element must be supported. This element is included in summaries. 0..1 CodeableConcept Technique for administering medication
Binding: SNOMEDCTAdministrationMethodCodes (example): A coded concept describing the technique by which the medicine is administered.
MedicationDispense.dosageInstruction.doseAndRate This element must be supported. This element is included in summaries. 0..* Element Amount of medication administered
MedicationDispense.dosageInstruction.doseAndRate.id 0..1 string Unique id for inter-element referencing
MedicationDispense.dosageInstruction.doseAndRate.extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
MedicationDispense.dosageInstruction.doseAndRate.type This element must be supported. This element is included in summaries. 0..1 CodeableConcept The kind of dose or rate specified
Binding: DoseAndRateType (example): The kind of dose or rate specified.
MedicationDispense.dosageInstruction.doseAndRate.dose[x] This element must be supported. This element is included in summaries. 0..1 Amount of medication per dose
MedicationDispense.dosageInstruction.doseAndRate.dose[x].doseRange Range
MedicationDispense.dosageInstruction.doseAndRate.dose[x].doseQuantity Quantity(SimpleQuantity)
MedicationDispense.dosageInstruction.doseAndRate.rate[x] This element must be supported. This element is included in summaries. 0..1 Amount of medication per unit of time
MedicationDispense.dosageInstruction.doseAndRate.rate[x].rateRatio Ratio
MedicationDispense.dosageInstruction.doseAndRate.rate[x].rateRange Range
MedicationDispense.dosageInstruction.doseAndRate.rate[x].rateQuantity Quantity(SimpleQuantity)
MedicationDispense.dosageInstruction.maxDosePerPeriod This element is included in summaries. 0..1 Ratio Upper limit on medication per unit of time
MedicationDispense.dosageInstruction.maxDosePerAdministration This element is included in summaries. C 0..1 SimpleQuantity(4.0.1) Upper limit on medication per administration
Constraints: sqty-1
MedicationDispense.dosageInstruction.maxDosePerLifetime This element is included in summaries. C 0..1 SimpleQuantity(4.0.1) Upper limit on medication per lifetime of the patient
Constraints: sqty-1
MedicationDispense.substitution 0..1 BackboneElement Whether a substitution was performed on the dispense
MedicationDispense.substitution.id 0..1 string Unique id for inter-element referencing
MedicationDispense.substitution.extension 0..* Extension Additional content defined by implementations
MedicationDispense.substitution.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
MedicationDispense.substitution.wasSubstituted 1..1 boolean Whether a substitution was or was not performed on the dispense
MedicationDispense.substitution.type 0..1 CodeableConcept Code signifying whether a different drug was dispensed from what was prescribed
Binding: ActSubstanceAdminSubstitutionCode (example): A coded concept describing whether a different medicinal product may be dispensed other than the product as specified exactly in the prescription.
MedicationDispense.substitution.reason 0..* CodeableConcept Why was substitution made
Binding: SubstanceAdminSubstitutionReason (example): A coded concept describing the reason that a different medication should (or should not) be substituted from what was prescribed.
MedicationDispense.substitution.responsibleParty 0..* Reference(Practitioner | PractitionerRole) Who is responsible for the substitution
MedicationDispense.detectedIssue 0..* Reference(DetectedIssue) Clinical issue with action
MedicationDispense.eventHistory 0..* Reference(Provenance) A list of relevant lifecycle events

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
MedicationDispense.language Base preferred Common Languages 📍4.0.1 FHIR Std.
MedicationDispense.status Base required Medication dispense status codes 📍4.0.1 FHIR Std.
MedicationDispense.statusReason[x] Base example Medication dispense status reason codes 📍4.0.1 FHIR Std.
MedicationDispense.category Base preferred Medication dispense category codes 📍4.0.1 FHIR Std.
MedicationDispense.medication[x] Base example SNOMED CT Medication Codes 📍4.0.1 FHIR Std.
MedicationDispense.performer.​function Base example Medication dispense performer function codes 📍4.0.1 FHIR Std.
MedicationDispense.type Base example ActPharmacySupplyType 📦3.0.0 THO v7.4
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 preferred 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.​site Base example SNOMED CT Anatomical Structure for Administration Site Codes 📍4.0.1 FHIR Std.
MedicationDispense.dosageInstruction.​route Base example SNOMED CT Route Codes 📍4.0.1 FHIR Std.
MedicationDispense.dosageInstruction.​method Base example SNOMED CT Administration Method Codes 📍4.0.1 FHIR Std.
MedicationDispense.dosageInstruction.​doseAndRate.type Base example DoseAndRateType 📍4.0.1 FHIR Std.
MedicationDispense.substitution.​type Base example ActSubstanceAdminSubstitutionCode 📦3.0.0 THO v7.4
MedicationDispense.substitution.​reason Base example SubstanceAdminSubstitutionReason 📦3.0.0 THO v7.4

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
sqty-1 error MedicationDispense.quantity, MedicationDispense.daysSupply, MedicationDispense.dosageInstruction.maxDosePerAdministration, MedicationDispense.dosageInstruction.maxDosePerLifetime The comparator is not used on a SimpleQuantity comparator.empty()
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

Must-Support: 16 elements

Structures

This structure refers to these other structures:

Maturity: 1

 

Other representations of profile: CSV, Excel, Schematron