This page is part of the Retrieval of Real World Data for Clinical Research (v1.0.0-ballot: STU1 Ballot 1) based on FHIR R4. . For a full list of available versions, see the Directory of published versions

• Content
• Detailed Descriptions
• Mappings
• Examples
• XML
• JSON
• TTL

Resource Profile: MedicationDispenseRwd

A profile on MedicationDispense that indicates the minimum set of attributes required for finding patients who may be taking certain medications.

Usage:

• Refer to this Resource Profile:
• Examples for this Resource Profile: MedicationDispense/RWDMedicationDispense

Formal Views of Profile Content

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

• Differential Table
• Key Elements Table
• Snapshot Table
• Statistics/References
• All

This structure is derived from MedicationDispense

Name	Flags	Card.	Type	Description & Constraints
MedicationDispense		0..*	MedicationDispense	Dispensing a medication to a named patient
status	S	1..1	code	preparation | in-progress | cancelled | on-hold | completed | entered-in-error | stopped | declined | unknown
medication[x]	S	1..1	CodeableConcept, Reference(Medication)	What medication was supplied
subject	S	0..1	Reference(Patient (IPS))	Who the dispense is for
quantity	S	0..1	SimpleQuantity	Amount dispensed
daysSupply	S	0..1	SimpleQuantity	Amount of medication expressed as a timing amount
whenHandedOver	S	0..1	dateTime	When product was given out
dosageInstruction	S	0..*	Dosage	How the medication is to be used by the patient or administered by the caregiver
timing	S	0..1	Timing	When medication should be administered
repeat
bounds[x]	S	0..1	Duration, Range, Period	Length/Range of lengths, or (Start and/or end) limits
Documentation for this format

Name	Flags	Card.	Type	Description & Constraints
MedicationDispense	C	0..*	MedicationDispense	Dispensing a medication to a named patient
implicitRules	?!Σ	0..1	uri	A set of rules under which this content was created
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored
status	?!SΣ	1..1	code	preparation | in-progress | cancelled | on-hold | completed | entered-in-error | stopped | declined | unknown Binding: MedicationDispense Status Codes (required): A coded concept specifying the state of the dispense event.
medication[x]	SΣ	1..1		What medication was supplied Binding: SNOMEDCTMedicationCodes (example): A coded concept identifying which substance or product can be dispensed.
medicationCodeableConcept			CodeableConcept
medicationReference			Reference(Medication)
subject	SΣ	0..1	Reference(Patient (IPS))	Who the dispense is for
quantity	S	0..1	SimpleQuantity	Amount dispensed
daysSupply	S	0..1	SimpleQuantity	Amount of medication expressed as a timing amount
whenHandedOver	S	0..1	dateTime	When product was given out
dosageInstruction	S	0..*	Dosage	How the medication is to be used by the patient or administered by the caregiver
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
timing	SΣ	0..1	Timing	When medication should be administered
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
repeat	ΣC	0..1	Element	When the event is to occur
bounds[x]	SΣ	0..1		Length/Range of lengths, or (Start and/or end) limits
boundsDuration			Duration
boundsRange			Range
boundsPeriod			Period
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet
MedicationDispense.status	required	MedicationDispense Status Codes
MedicationDispense.medication[x]	example	SNOMEDCTMedicationCodes

Constraints

Id	Grade	Path(s)	Details	Requirements
dom-2	error	MedicationDispense	If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty()
dom-3	error	MedicationDispense	If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource : contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4	error	MedicationDispense	If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5	error	MedicationDispense	If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty()
dom-6	best practice	MedicationDispense	A resource should have narrative for robust management : text.`div`.exists()
ele-1	error	**ALL** elements	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ext-1	error	**ALL** extensions	Must have either extensions or value[x], not both : extension.exists() != value.exists()
mdd-1	error	MedicationDispense	whenHandedOver cannot be before whenPrepared : whenHandedOver.empty() or whenPrepared.empty() or whenHandedOver >= whenPrepared
tim-1	error	MedicationDispense.dosageInstruction.timing.repeat	if there's a duration, there needs to be duration units : duration.empty() or durationUnit.exists()
tim-2	error	MedicationDispense.dosageInstruction.timing.repeat	if there's a period, there needs to be period units : period.empty() or periodUnit.exists()
tim-4	error	MedicationDispense.dosageInstruction.timing.repeat	duration SHALL be a non-negative value : duration.exists() implies duration >= 0
tim-5	error	MedicationDispense.dosageInstruction.timing.repeat	period SHALL be a non-negative value : period.exists() implies period >= 0
tim-6	error	MedicationDispense.dosageInstruction.timing.repeat	If there's a periodMax, there must be a period : periodMax.empty() or period.exists()
tim-7	error	MedicationDispense.dosageInstruction.timing.repeat	If there's a durationMax, there must be a duration : durationMax.empty() or duration.exists()
tim-8	error	MedicationDispense.dosageInstruction.timing.repeat	If there's a countMax, there must be a count : countMax.empty() or count.exists()
tim-9	error	MedicationDispense.dosageInstruction.timing.repeat	If there's an offset, there must be a when (and not C, CM, CD, CV) : offset.empty() or (when.exists() and ((when in ('C' | 'CM' | 'CD' | 'CV')).not()))
tim-10	error	MedicationDispense.dosageInstruction.timing.repeat	If there's a timeOfDay, there cannot be a when, or vice versa : timeOfDay.empty() or when.empty()

Name	Flags	Card.	Type	Description & Constraints
MedicationDispense	C	0..*	MedicationDispense	Dispensing a medication to a named patient
id	Σ	0..1	id	Logical id of this artifact
meta	Σ	0..1	Meta	Metadata about the resource
implicitRules	?!Σ	0..1	uri	A set of rules under which this content was created
language		0..1	code	Language of the resource content Binding: CommonLanguages (preferred): A human language. Additional Bindings Purpose AllLanguages Max Binding
text		0..1	Narrative	Text summary of the resource, for human interpretation
contained		0..*	Resource	Contained, inline Resources
extension		0..*	Extension	Additional content defined by implementations
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored
identifier		0..*	Identifier	External identifier
partOf		0..*	Reference(Procedure)	Event that dispense is part of
status	?!SΣ	1..1	code	preparation | in-progress | cancelled | on-hold | completed | entered-in-error | stopped | declined | unknown Binding: MedicationDispense Status Codes (required): A coded concept specifying the state of the dispense event.
statusReason[x]		0..1		Why a dispense was not performed Binding: MedicationDispense Status Reason Codes (example): A code describing why a dispense was not performed.
statusReasonCodeableConcept			CodeableConcept
statusReasonReference			Reference(DetectedIssue)
category		0..1	CodeableConcept	Type of medication dispense Binding: MedicationDispense Category Codes (preferred): A code describing where the dispensed medication is expected to be consumed or administered.
medication[x]	SΣ	1..1		What medication was supplied Binding: SNOMEDCTMedicationCodes (example): A coded concept identifying which substance or product can be dispensed.
medicationCodeableConcept			CodeableConcept
medicationReference			Reference(Medication)
subject	SΣ	0..1	Reference(Patient (IPS))	Who the dispense is for
context		0..1	Reference(Encounter | EpisodeOfCare)	Encounter / Episode associated with event
supportingInformation		0..*	Reference(Resource)	Information that supports the dispensing of the medication
performer		0..*	BackboneElement	Who performed event
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
function		0..1	CodeableConcept	Who performed the dispense and what they did Binding: MedicationDispense Performer Function Codes (example): A code describing the role an individual played in dispensing a medication.
actor		1..1	Reference(Practitioner | PractitionerRole | Organization | Patient | Device | RelatedPerson)	Individual who was performing
location		0..1	Reference(Location)	Where the dispense occurred
authorizingPrescription		0..*	Reference(MedicationRequest)	Medication order that authorizes the dispense
type		0..1	CodeableConcept	Trial fill, partial fill, emergency fill, etc. Binding: ActPharmacySupplyType (example): Indicates the type of dispensing event that is performed. For example, Trial Fill, Completion of Trial, Partial Fill, Emergency Fill, Samples, etc.
quantity	S	0..1	SimpleQuantity	Amount dispensed
daysSupply	S	0..1	SimpleQuantity	Amount of medication expressed as a timing amount
whenPrepared	Σ	0..1	dateTime	When product was packaged and reviewed
whenHandedOver	S	0..1	dateTime	When product was given out
destination		0..1	Reference(Location)	Where the medication was sent
receiver		0..*	Reference(Patient | Practitioner)	Who collected the medication
note		0..*	Annotation	Information about the dispense
dosageInstruction	S	0..*	Dosage	How the medication is to be used by the patient or administered by the caregiver
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
sequence	Σ	0..1	integer	The order of the dosage instructions
text	Σ	0..1	string	Free text dosage instructions e.g. SIG
additionalInstruction	Σ	0..*	CodeableConcept	Supplemental instruction or warnings to the patient - e.g. "with meals", "may cause drowsiness" Binding: SNOMEDCTAdditionalDosageInstructions (example): A coded concept identifying additional instructions such as "take with water" or "avoid operating heavy machinery".
patientInstruction	Σ	0..1	string	Patient or consumer oriented instructions
timing	SΣ	0..1	Timing	When medication should be administered
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
event	Σ	0..*	dateTime	When the event occurs
repeat	ΣC	0..1	Element	When the event is to occur
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]	SΣ	0..1		Length/Range of lengths, or (Start and/or end) limits
boundsDuration			Duration
boundsRange			Range
boundsPeriod			Period
count	Σ	0..1	positiveInt	Number of times to repeat
countMax	Σ	0..1	positiveInt	Maximum number of times to repeat
duration	Σ	0..1	decimal	How long when it happens
durationMax	Σ	0..1	decimal	How long when it happens (Max)
durationUnit	Σ	0..1	code	s | min | h | d | wk | mo | a - unit of time (UCUM) Binding: UnitsOfTime (required): A unit of time (units from UCUM).
frequency	Σ	0..1	positiveInt	Event occurs frequency times per period
frequencyMax	Σ	0..1	positiveInt	Event occurs up to frequencyMax times per period
period	Σ	0..1	decimal	Event occurs frequency times per period
periodMax	Σ	0..1	decimal	Upper limit of period (3-4 hours)
periodUnit	Σ	0..1	code	s | min | h | d | wk | mo | a - unit of time (UCUM) Binding: UnitsOfTime (required): A unit of time (units from UCUM).
dayOfWeek	Σ	0..*	code	mon | tue | wed | thu | fri | sat | sun Binding: DaysOfWeek (required)
timeOfDay	Σ	0..*	time	Time of day for action
when	Σ	0..*	code	Code for time period of occurrence Binding: EventTiming (required): Real world event relating to the schedule.
offset	Σ	0..1	unsignedInt	Minutes from event (before or after)
code	Σ	0..1	CodeableConcept	BID | TID | QID | AM | PM | QD | QOD | + Binding: TimingAbbreviation (preferred): Code for a known / defined timing pattern.
asNeeded[x]	Σ	0..1		Take "as needed" (for x) Binding: SNOMEDCTMedicationAsNeededReasonCodes (example): A coded concept identifying the precondition that should be met or evaluated prior to consuming or administering a medication dose. For example "pain", "30 minutes prior to sexual intercourse", "on flare-up" etc.
asNeededBoolean			boolean
asNeededCodeableConcept			CodeableConcept
site	Σ	0..1	CodeableConcept	Body site to administer to Binding: SNOMEDCTAnatomicalStructureForAdministrationSiteCodes (example): A coded concept describing the site location the medicine enters into or onto the body.
route	Σ	0..1	CodeableConcept	How drug should enter body Binding: SNOMEDCTRouteCodes (example): A coded concept describing the route or physiological path of administration of a therapeutic agent into or onto the body of a subject.
method	Σ	0..1	CodeableConcept	Technique for administering medication Binding: SNOMEDCTAdministrationMethodCodes (example): A coded concept describing the technique by which the medicine is administered.
doseAndRate	Σ	0..*	Element	Amount of medication administered
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
type	Σ	0..1	CodeableConcept	The kind of dose or rate specified Binding: DoseAndRateType (example): The kind of dose or rate specified.
dose[x]	Σ	0..1		Amount of medication per dose
doseRange			Range
doseQuantity			Quantity(SimpleQuantity)
rate[x]	Σ	0..1		Amount of medication per unit of time
rateRatio			Ratio
rateRange			Range
rateQuantity			Quantity(SimpleQuantity)
maxDosePerPeriod	Σ	0..1	Ratio	Upper limit on medication per unit of time
maxDosePerAdministration	Σ	0..1	SimpleQuantity	Upper limit on medication per administration
maxDosePerLifetime	Σ	0..1	SimpleQuantity	Upper limit on medication per lifetime of the patient
substitution		0..1	BackboneElement	Whether a substitution was performed on the dispense
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
wasSubstituted		1..1	boolean	Whether a substitution was or was not performed on the dispense
type		0..1	CodeableConcept	Code signifying whether a different drug was dispensed from what was prescribed Binding: ActSubstanceAdminSubstitutionCode (example): A coded concept describing whether a different medicinal product may be dispensed other than the product as specified exactly in the prescription.
reason		0..*	CodeableConcept	Why was substitution made Binding: SubstanceAdminSubstitutionReason (example): A coded concept describing the reason that a different medication should (or should not) be substituted from what was prescribed.
responsibleParty		0..*	Reference(Practitioner | PractitionerRole)	Who is responsible for the substitution
detectedIssue		0..*	Reference(DetectedIssue)	Clinical issue with action
eventHistory		0..*	Reference(Provenance)	A list of relevant lifecycle events
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet
MedicationDispense.language	preferred	CommonLanguages Additional Bindings Purpose AllLanguages Max Binding
MedicationDispense.status	required	MedicationDispense Status Codes
MedicationDispense.statusReason[x]	example	MedicationDispense Status Reason Codes
MedicationDispense.category	preferred	MedicationDispense Category Codes
MedicationDispense.medication[x]	example	SNOMEDCTMedicationCodes
MedicationDispense.performer.function	example	MedicationDispense Performer Function Codes
MedicationDispense.type	example	ActPharmacySupplyType
MedicationDispense.dosageInstruction.additionalInstruction	example	SNOMEDCTAdditionalDosageInstructions
MedicationDispense.dosageInstruction.timing.repeat.durationUnit	required	UnitsOfTime
MedicationDispense.dosageInstruction.timing.repeat.periodUnit	required	UnitsOfTime
MedicationDispense.dosageInstruction.timing.repeat.dayOfWeek	required	DaysOfWeek
MedicationDispense.dosageInstruction.timing.repeat.when	required	EventTiming
MedicationDispense.dosageInstruction.timing.code	preferred	TimingAbbreviation
MedicationDispense.dosageInstruction.asNeeded[x]	example	SNOMEDCTMedicationAsNeededReasonCodes
MedicationDispense.dosageInstruction.site	example	SNOMEDCTAnatomicalStructureForAdministrationSiteCodes
MedicationDispense.dosageInstruction.route	example	SNOMEDCTRouteCodes
MedicationDispense.dosageInstruction.method	example	SNOMEDCTAdministrationMethodCodes
MedicationDispense.dosageInstruction.doseAndRate.type	example	DoseAndRateType
MedicationDispense.substitution.type	example	ActSubstanceAdminSubstitutionCode
MedicationDispense.substitution.reason	example	SubstanceAdminSubstitutionReason

Constraints

Id	Grade	Path(s)	Details	Requirements
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()

This structure is derived from MedicationDispense

Summary

Must-Support: 9 elements

Structures

This structure refers to these other structures:

• Patient (IPS) (http://hl7.org/fhir/uv/ips/StructureDefinition/Patient-uv-ips)

Differential View

This structure is derived from MedicationDispense

Name	Flags	Card.	Type	Description & Constraints
MedicationDispense		0..*	MedicationDispense	Dispensing a medication to a named patient
status	S	1..1	code	preparation | in-progress | cancelled | on-hold | completed | entered-in-error | stopped | declined | unknown
medication[x]	S	1..1	CodeableConcept, Reference(Medication)	What medication was supplied
subject	S	0..1	Reference(Patient (IPS))	Who the dispense is for
quantity	S	0..1	SimpleQuantity	Amount dispensed
daysSupply	S	0..1	SimpleQuantity	Amount of medication expressed as a timing amount
whenHandedOver	S	0..1	dateTime	When product was given out
dosageInstruction	S	0..*	Dosage	How the medication is to be used by the patient or administered by the caregiver
timing	S	0..1	Timing	When medication should be administered
repeat
bounds[x]	S	0..1	Duration, Range, Period	Length/Range of lengths, or (Start and/or end) limits
Documentation for this format

Key Elements View

Name	Flags	Card.	Type	Description & Constraints
MedicationDispense	C	0..*	MedicationDispense	Dispensing a medication to a named patient
implicitRules	?!Σ	0..1	uri	A set of rules under which this content was created
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored
status	?!SΣ	1..1	code	preparation | in-progress | cancelled | on-hold | completed | entered-in-error | stopped | declined | unknown Binding: MedicationDispense Status Codes (required): A coded concept specifying the state of the dispense event.
medication[x]	SΣ	1..1		What medication was supplied Binding: SNOMEDCTMedicationCodes (example): A coded concept identifying which substance or product can be dispensed.
medicationCodeableConcept			CodeableConcept
medicationReference			Reference(Medication)
subject	SΣ	0..1	Reference(Patient (IPS))	Who the dispense is for
quantity	S	0..1	SimpleQuantity	Amount dispensed
daysSupply	S	0..1	SimpleQuantity	Amount of medication expressed as a timing amount
whenHandedOver	S	0..1	dateTime	When product was given out
dosageInstruction	S	0..*	Dosage	How the medication is to be used by the patient or administered by the caregiver
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
timing	SΣ	0..1	Timing	When medication should be administered
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
repeat	ΣC	0..1	Element	When the event is to occur
bounds[x]	SΣ	0..1		Length/Range of lengths, or (Start and/or end) limits
boundsDuration			Duration
boundsRange			Range
boundsPeriod			Period
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet
MedicationDispense.status	required	MedicationDispense Status Codes
MedicationDispense.medication[x]	example	SNOMEDCTMedicationCodes

Constraints

Id	Grade	Path(s)	Details	Requirements
dom-2	error	MedicationDispense	If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty()
dom-3	error	MedicationDispense	If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource : contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4	error	MedicationDispense	If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5	error	MedicationDispense	If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty()
dom-6	best practice	MedicationDispense	A resource should have narrative for robust management : text.`div`.exists()
ele-1	error	**ALL** elements	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ext-1	error	**ALL** extensions	Must have either extensions or value[x], not both : extension.exists() != value.exists()
mdd-1	error	MedicationDispense	whenHandedOver cannot be before whenPrepared : whenHandedOver.empty() or whenPrepared.empty() or whenHandedOver >= whenPrepared
tim-1	error	MedicationDispense.dosageInstruction.timing.repeat	if there's a duration, there needs to be duration units : duration.empty() or durationUnit.exists()
tim-2	error	MedicationDispense.dosageInstruction.timing.repeat	if there's a period, there needs to be period units : period.empty() or periodUnit.exists()
tim-4	error	MedicationDispense.dosageInstruction.timing.repeat	duration SHALL be a non-negative value : duration.exists() implies duration >= 0
tim-5	error	MedicationDispense.dosageInstruction.timing.repeat	period SHALL be a non-negative value : period.exists() implies period >= 0
tim-6	error	MedicationDispense.dosageInstruction.timing.repeat	If there's a periodMax, there must be a period : periodMax.empty() or period.exists()
tim-7	error	MedicationDispense.dosageInstruction.timing.repeat	If there's a durationMax, there must be a duration : durationMax.empty() or duration.exists()
tim-8	error	MedicationDispense.dosageInstruction.timing.repeat	If there's a countMax, there must be a count : countMax.empty() or count.exists()
tim-9	error	MedicationDispense.dosageInstruction.timing.repeat	If there's an offset, there must be a when (and not C, CM, CD, CV) : offset.empty() or (when.exists() and ((when in ('C' | 'CM' | 'CD' | 'CV')).not()))
tim-10	error	MedicationDispense.dosageInstruction.timing.repeat	If there's a timeOfDay, there cannot be a when, or vice versa : timeOfDay.empty() or when.empty()

Snapshot View

Name	Flags	Card.	Type	Description & Constraints
MedicationDispense	C	0..*	MedicationDispense	Dispensing a medication to a named patient
id	Σ	0..1	id	Logical id of this artifact
meta	Σ	0..1	Meta	Metadata about the resource
implicitRules	?!Σ	0..1	uri	A set of rules under which this content was created
language		0..1	code	Language of the resource content Binding: CommonLanguages (preferred): A human language. Additional Bindings Purpose AllLanguages Max Binding
text		0..1	Narrative	Text summary of the resource, for human interpretation
contained		0..*	Resource	Contained, inline Resources
extension		0..*	Extension	Additional content defined by implementations
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored
identifier		0..*	Identifier	External identifier
partOf		0..*	Reference(Procedure)	Event that dispense is part of
status	?!SΣ	1..1	code	preparation | in-progress | cancelled | on-hold | completed | entered-in-error | stopped | declined | unknown Binding: MedicationDispense Status Codes (required): A coded concept specifying the state of the dispense event.
statusReason[x]		0..1		Why a dispense was not performed Binding: MedicationDispense Status Reason Codes (example): A code describing why a dispense was not performed.
statusReasonCodeableConcept			CodeableConcept
statusReasonReference			Reference(DetectedIssue)
category		0..1	CodeableConcept	Type of medication dispense Binding: MedicationDispense Category Codes (preferred): A code describing where the dispensed medication is expected to be consumed or administered.
medication[x]	SΣ	1..1		What medication was supplied Binding: SNOMEDCTMedicationCodes (example): A coded concept identifying which substance or product can be dispensed.
medicationCodeableConcept			CodeableConcept
medicationReference			Reference(Medication)
subject	SΣ	0..1	Reference(Patient (IPS))	Who the dispense is for
context		0..1	Reference(Encounter | EpisodeOfCare)	Encounter / Episode associated with event
supportingInformation		0..*	Reference(Resource)	Information that supports the dispensing of the medication
performer		0..*	BackboneElement	Who performed event
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
function		0..1	CodeableConcept	Who performed the dispense and what they did Binding: MedicationDispense Performer Function Codes (example): A code describing the role an individual played in dispensing a medication.
actor		1..1	Reference(Practitioner | PractitionerRole | Organization | Patient | Device | RelatedPerson)	Individual who was performing
location		0..1	Reference(Location)	Where the dispense occurred
authorizingPrescription		0..*	Reference(MedicationRequest)	Medication order that authorizes the dispense
type		0..1	CodeableConcept	Trial fill, partial fill, emergency fill, etc. Binding: ActPharmacySupplyType (example): Indicates the type of dispensing event that is performed. For example, Trial Fill, Completion of Trial, Partial Fill, Emergency Fill, Samples, etc.
quantity	S	0..1	SimpleQuantity	Amount dispensed
daysSupply	S	0..1	SimpleQuantity	Amount of medication expressed as a timing amount
whenPrepared	Σ	0..1	dateTime	When product was packaged and reviewed
whenHandedOver	S	0..1	dateTime	When product was given out
destination		0..1	Reference(Location)	Where the medication was sent
receiver		0..*	Reference(Patient | Practitioner)	Who collected the medication
note		0..*	Annotation	Information about the dispense
dosageInstruction	S	0..*	Dosage	How the medication is to be used by the patient or administered by the caregiver
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
sequence	Σ	0..1	integer	The order of the dosage instructions
text	Σ	0..1	string	Free text dosage instructions e.g. SIG
additionalInstruction	Σ	0..*	CodeableConcept	Supplemental instruction or warnings to the patient - e.g. "with meals", "may cause drowsiness" Binding: SNOMEDCTAdditionalDosageInstructions (example): A coded concept identifying additional instructions such as "take with water" or "avoid operating heavy machinery".
patientInstruction	Σ	0..1	string	Patient or consumer oriented instructions
timing	SΣ	0..1	Timing	When medication should be administered
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
event	Σ	0..*	dateTime	When the event occurs
repeat	ΣC	0..1	Element	When the event is to occur
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]	SΣ	0..1		Length/Range of lengths, or (Start and/or end) limits
boundsDuration			Duration
boundsRange			Range
boundsPeriod			Period
count	Σ	0..1	positiveInt	Number of times to repeat
countMax	Σ	0..1	positiveInt	Maximum number of times to repeat
duration	Σ	0..1	decimal	How long when it happens
durationMax	Σ	0..1	decimal	How long when it happens (Max)
durationUnit	Σ	0..1	code	s | min | h | d | wk | mo | a - unit of time (UCUM) Binding: UnitsOfTime (required): A unit of time (units from UCUM).
frequency	Σ	0..1	positiveInt	Event occurs frequency times per period
frequencyMax	Σ	0..1	positiveInt	Event occurs up to frequencyMax times per period
period	Σ	0..1	decimal	Event occurs frequency times per period
periodMax	Σ	0..1	decimal	Upper limit of period (3-4 hours)
periodUnit	Σ	0..1	code	s | min | h | d | wk | mo | a - unit of time (UCUM) Binding: UnitsOfTime (required): A unit of time (units from UCUM).
dayOfWeek	Σ	0..*	code	mon | tue | wed | thu | fri | sat | sun Binding: DaysOfWeek (required)
timeOfDay	Σ	0..*	time	Time of day for action
when	Σ	0..*	code	Code for time period of occurrence Binding: EventTiming (required): Real world event relating to the schedule.
offset	Σ	0..1	unsignedInt	Minutes from event (before or after)
code	Σ	0..1	CodeableConcept	BID | TID | QID | AM | PM | QD | QOD | + Binding: TimingAbbreviation (preferred): Code for a known / defined timing pattern.
asNeeded[x]	Σ	0..1		Take "as needed" (for x) Binding: SNOMEDCTMedicationAsNeededReasonCodes (example): A coded concept identifying the precondition that should be met or evaluated prior to consuming or administering a medication dose. For example "pain", "30 minutes prior to sexual intercourse", "on flare-up" etc.
asNeededBoolean			boolean
asNeededCodeableConcept			CodeableConcept
site	Σ	0..1	CodeableConcept	Body site to administer to Binding: SNOMEDCTAnatomicalStructureForAdministrationSiteCodes (example): A coded concept describing the site location the medicine enters into or onto the body.
route	Σ	0..1	CodeableConcept	How drug should enter body Binding: SNOMEDCTRouteCodes (example): A coded concept describing the route or physiological path of administration of a therapeutic agent into or onto the body of a subject.
method	Σ	0..1	CodeableConcept	Technique for administering medication Binding: SNOMEDCTAdministrationMethodCodes (example): A coded concept describing the technique by which the medicine is administered.
doseAndRate	Σ	0..*	Element	Amount of medication administered
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
type	Σ	0..1	CodeableConcept	The kind of dose or rate specified Binding: DoseAndRateType (example): The kind of dose or rate specified.
dose[x]	Σ	0..1		Amount of medication per dose
doseRange			Range
doseQuantity			Quantity(SimpleQuantity)
rate[x]	Σ	0..1		Amount of medication per unit of time
rateRatio			Ratio
rateRange			Range
rateQuantity			Quantity(SimpleQuantity)
maxDosePerPeriod	Σ	0..1	Ratio	Upper limit on medication per unit of time
maxDosePerAdministration	Σ	0..1	SimpleQuantity	Upper limit on medication per administration
maxDosePerLifetime	Σ	0..1	SimpleQuantity	Upper limit on medication per lifetime of the patient
substitution		0..1	BackboneElement	Whether a substitution was performed on the dispense
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
wasSubstituted		1..1	boolean	Whether a substitution was or was not performed on the dispense
type		0..1	CodeableConcept	Code signifying whether a different drug was dispensed from what was prescribed Binding: ActSubstanceAdminSubstitutionCode (example): A coded concept describing whether a different medicinal product may be dispensed other than the product as specified exactly in the prescription.
reason		0..*	CodeableConcept	Why was substitution made Binding: SubstanceAdminSubstitutionReason (example): A coded concept describing the reason that a different medication should (or should not) be substituted from what was prescribed.
responsibleParty		0..*	Reference(Practitioner | PractitionerRole)	Who is responsible for the substitution
detectedIssue		0..*	Reference(DetectedIssue)	Clinical issue with action
eventHistory		0..*	Reference(Provenance)	A list of relevant lifecycle events
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet
MedicationDispense.language	preferred	CommonLanguages Additional Bindings Purpose AllLanguages Max Binding
MedicationDispense.status	required	MedicationDispense Status Codes
MedicationDispense.statusReason[x]	example	MedicationDispense Status Reason Codes
MedicationDispense.category	preferred	MedicationDispense Category Codes
MedicationDispense.medication[x]	example	SNOMEDCTMedicationCodes
MedicationDispense.performer.function	example	MedicationDispense Performer Function Codes
MedicationDispense.type	example	ActPharmacySupplyType
MedicationDispense.dosageInstruction.additionalInstruction	example	SNOMEDCTAdditionalDosageInstructions
MedicationDispense.dosageInstruction.timing.repeat.durationUnit	required	UnitsOfTime
MedicationDispense.dosageInstruction.timing.repeat.periodUnit	required	UnitsOfTime
MedicationDispense.dosageInstruction.timing.repeat.dayOfWeek	required	DaysOfWeek
MedicationDispense.dosageInstruction.timing.repeat.when	required	EventTiming
MedicationDispense.dosageInstruction.timing.code	preferred	TimingAbbreviation
MedicationDispense.dosageInstruction.asNeeded[x]	example	SNOMEDCTMedicationAsNeededReasonCodes
MedicationDispense.dosageInstruction.site	example	SNOMEDCTAnatomicalStructureForAdministrationSiteCodes
MedicationDispense.dosageInstruction.route	example	SNOMEDCTRouteCodes
MedicationDispense.dosageInstruction.method	example	SNOMEDCTAdministrationMethodCodes
MedicationDispense.dosageInstruction.doseAndRate.type	example	DoseAndRateType
MedicationDispense.substitution.type	example	ActSubstanceAdminSubstitutionCode
MedicationDispense.substitution.reason	example	SubstanceAdminSubstitutionReason

Constraints

Id	Grade	Path(s)	Details	Requirements
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()

This structure is derived from MedicationDispense

Summary

Must-Support: 9 elements

Structures

This structure refers to these other structures:

• Patient (IPS) (http://hl7.org/fhir/uv/ips/StructureDefinition/Patient-uv-ips)

Other representations of profile: CSV, Excel, Schematron