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

• Content
• Detailed Descriptions
• XML
• JSON

Data Type Profile: IE MPD Dosage

How a medicine is to be taken or given (HIQA EP Section 5 Dosaging). Used by the ePrescription item, the eDispensation and the medication statement. Structured dosage always comes with human-readable text, a frequency always has its period, and doses use SNOMED CT units of presentation or UCUM. See the Dosage guidance page.

Usages:

• Use this DataType Profile: IE MPD MedicationDispense (eDispensation), IE MPD MedicationRequest (ePrescription) and IE MPD MedicationStatement

You can also check for usages in the FHIR IG Statistics

Formal Views of Profile Content

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

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

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
Dosage	C	0..*	DosageEuMpd(1.0.0)	How the medication is/was taken or should be taken Constraints: ie-dos-1, ie-dos-2, ie-dos-3, ie-dos-4
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized Constraints: ext-1
sequence	SΣ	0..1	integer	The order of the dosage instructions
text	SΣ	0..1	string	Free text dosage instructions e.g. SIG
additionalInstruction	SΣ	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	SOΣ	0..1	string	Patient or consumer oriented instructions Obligations Actor Source SHOULD:able-to-populate Producer from Dosage: MPD
timing	SΣ	0..1	Timing	When medication should be administered
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized Constraints: ext-1
repeat	OΣ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 Obligations Actor Source SHALL:able-to-populate Producer from Dosage: MPD
bounds[x]	SOΣ	0..1		Length/Range of lengths, or (Start and/or end) limits Obligations Actor Source SHALL:able-to-populate Producer from Dosage: MPD
boundsDuration			Duration
boundsRange			Range
boundsPeriod			Period
duration	Σ	0..1	decimal	How long when it happens
frequency	SOΣ	0..1	positiveInt	Event occurs frequency times per period Obligations Actor Source SHALL:able-to-populate Producer from Dosage: MPD
period	SOΣ	0..1	decimal	Event occurs frequency times per period Obligations Actor Source SHALL:able-to-populate Producer from Dosage: MPD
periodUnit	SOΣ	0..1	code	s | min | h | d | wk | mo | a - unit of time (UCUM) Binding: UnitsOfTime (required): A unit of time (units from UCUM). Obligations Actor Source SHALL:able-to-populate Producer from Dosage: MPD
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.
Slices for asNeeded[x]	Σ	0..1		Take "as needed" (for x) Slice: Unordered, Closed by type:$this Binding: SNOMEDCTMedicationAsNeededReasonCodes (example): A coded concept identifying the precondition that should be met or evaluated prior to consuming or administering a medication dose. For example "pain", "30 minutes prior to sexual intercourse", "on flare-up" etc.
asNeededBoolean			boolean
asNeededCodeableConcept			CodeableConcept
asNeeded[x]:asNeededBoolean	Σ	0..1	boolean	Take "as needed" (for x)
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	SOΣ	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. Obligations Actor Source SHOULD:able-to-populate Producer from Dosage: MPD
method	Σ	0..1	CodeableConcept	Technique for administering medication Binding: SNOMEDCTAdministrationMethodCodes (example): A coded concept describing the technique by which the medicine is administered.
doseAndRate	SΣ	0..*	Element	Amount of medication administered
dose[x]	SOΣ	0..1		Amount of medication per dose Obligations Actor Source SHALL:able-to-populate Producer from Dosage: MPD
doseRange			Range
doseQuantity			Quantity(SimpleQuantity)
rate[x]	Σ	0..1		Amount of medication per unit of time
rateRatio			Ratio
rateRange			Range
rateQuantity			Quantity(SimpleQuantity)
maxDosePerPeriod	SΣ	0..1	Ratio	Upper limit on medication per unit of time
maxDosePerAdministration	Σ	0..1	SimpleQuantity(4.0.1)	Upper limit on medication per administration
Documentation for this format

Terminology Bindings

Path	Status	Usage	ValueSet	Version	Source
Dosage.additionalInstruction	Base	example	SNOMED CT Additional Dosage Instructions	📍4.0.1	FHIR Std.
Dosage.timing.repeat.​periodUnit	Base	required	UnitsOfTime	📍4.0.1	FHIR Std.
Dosage.timing.repeat.​dayOfWeek	Base	required	DaysOfWeek	📍4.0.1	FHIR Std.
Dosage.timing.repeat.​when	Base	required	EventTiming	📍4.0.1	FHIR Std.
Dosage.asNeeded[x]	Base	example	SNOMED CT Medication As Needed Reason Codes	📍4.0.1	FHIR Std.
Dosage.site	Base	example	SNOMED CT Anatomical Structure for Administration Site Codes	📍4.0.1	FHIR Std.
Dosage.route	Base	example	SNOMED CT Route Codes	📍4.0.1	FHIR Std.
Dosage.method	Base	example	SNOMED CT Administration Method Codes	📍4.0.1	FHIR Std.

Constraints

Id	Grade	Path(s)	Description	Expression
ele-1	error	Dosage, Dosage.modifierExtension, Dosage.sequence, Dosage.text, Dosage.additionalInstruction, Dosage.patientInstruction, Dosage.timing, Dosage.timing.modifierExtension, Dosage.timing.repeat, Dosage.timing.repeat.bounds[x], Dosage.timing.repeat.duration, Dosage.timing.repeat.frequency, Dosage.timing.repeat.period, Dosage.timing.repeat.periodUnit, Dosage.timing.repeat.dayOfWeek, Dosage.timing.repeat.timeOfDay, Dosage.timing.repeat.when, Dosage.asNeeded[x], Dosage.asNeeded[x]:asNeededBoolean, Dosage.site, Dosage.route, Dosage.method, Dosage.doseAndRate, Dosage.doseAndRate.dose[x], Dosage.doseAndRate.rate[x], Dosage.maxDosePerPeriod, Dosage.maxDosePerAdministration	All FHIR elements must have a @value or children	hasValue() or (children().count() > id.count())
ext-1	error	Dosage.modifierExtension, Dosage.timing.modifierExtension	Must have either extensions or value[x], not both	extension.exists() != value.exists()
ie-dos-1	error	Dosage	A structured dosage SHALL be accompanied by a human-readable dosage text (HIQA EP 5.1; safety fallback)	(timing.exists() or doseAndRate.exists() or route.exists() or asNeeded.exists()) implies text.exists()
ie-dos-2	error	Dosage	A frequency SHALL have its period and period unit (HIQA EP 5.2.4.3.1 and 5.2.4.3.2 are both Mandatory in the frequency cluster)	timing.repeat.frequency.exists() implies (timing.repeat.period.exists() and timing.repeat.periodUnit.exists())
ie-dos-3	warning	Dosage	An as-needed dosage SHOULD state a maximum dose per period	asNeeded.ofType(boolean) = true implies maxDosePerPeriod.exists()
ie-dos-4	error	Dosage	A dose range SHALL give both a low and a high value (HIQA EP 5.2.3.1.2)	doseAndRate.dose.ofType(Range).all(low.exists() and high.exists())
tim-1	error	Dosage.timing.repeat	if there's a duration, there needs to be duration units	duration.empty() or durationUnit.exists()
tim-2	error	Dosage.timing.repeat	if there's a period, there needs to be period units	period.empty() or periodUnit.exists()
tim-4	error	Dosage.timing.repeat	duration SHALL be a non-negative value	duration.exists() implies duration >= 0
tim-5	error	Dosage.timing.repeat	period SHALL be a non-negative value	period.exists() implies period >= 0
tim-6	error	Dosage.timing.repeat	If there's a periodMax, there must be a period	periodMax.empty() or period.exists()
tim-7	error	Dosage.timing.repeat	If there's a durationMax, there must be a duration	durationMax.empty() or duration.exists()
tim-8	error	Dosage.timing.repeat	If there's a countMax, there must be a count	countMax.empty() or count.exists()
tim-9	error	Dosage.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	Dosage.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 DosageEuMpd

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
Dosage	C	0..*	DosageEuMpd(1.0.0)	How the medication is/was taken or should be taken
sequence	S	0..1	integer	The order of the dosage instructions
text	S	0..1	string	Free text dosage instructions e.g. SIG
additionalInstruction	S	0..*	CodeableConcept	Supplemental instruction or warnings to the patient - e.g. "with meals", "may cause drowsiness"
patientInstruction	S	0..1	string	Patient or consumer oriented instructions
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
duration		0..1	decimal	How long when it happens
frequency	S	0..1	positiveInt	Event occurs frequency times per period
period	S	0..1	decimal	Event occurs frequency times per period
periodUnit	S	0..1	code	s | min | h | d | wk | mo | a - unit of time (UCUM)
dayOfWeek		0..*	code	mon | tue | wed | thu | fri | sat | sun
timeOfDay		0..*	time	Time of day for action
when		0..*	code	Code for time period of occurrence
asNeeded[x]		0..1	boolean, CodeableConcept	Take "as needed" (for x)
site		0..1	CodeableConcept	Body site to administer to
route	S	0..1	CodeableConcept	How drug should enter body
method		0..1	CodeableConcept	Technique for administering medication
doseAndRate	S	0..*	Element	Amount of medication administered
dose[x]	S	0..1	Range, SimpleQuantity(4.0.1)	Amount of medication per dose
rate[x]		0..1	Ratio, Range, SimpleQuantity(4.0.1)	Amount of medication per unit of time
maxDosePerPeriod	S	0..1	Ratio	Upper limit on medication per unit of time
maxDosePerAdministration		0..1	SimpleQuantity(4.0.1)	Upper limit on medication per administration
Documentation for this format

Constraints

Id	Grade	Path(s)	Description	Expression
ie-dos-1	error	Dosage	A structured dosage SHALL be accompanied by a human-readable dosage text (HIQA EP 5.1; safety fallback)	(timing.exists() or doseAndRate.exists() or route.exists() or asNeeded.exists()) implies text.exists()
ie-dos-2	error	Dosage	A frequency SHALL have its period and period unit (HIQA EP 5.2.4.3.1 and 5.2.4.3.2 are both Mandatory in the frequency cluster)	timing.repeat.frequency.exists() implies (timing.repeat.period.exists() and timing.repeat.periodUnit.exists())
ie-dos-3	warning	Dosage	An as-needed dosage SHOULD state a maximum dose per period	asNeeded.ofType(boolean) = true implies maxDosePerPeriod.exists()
ie-dos-4	error	Dosage	A dose range SHALL give both a low and a high value (HIQA EP 5.2.3.1.2)	doseAndRate.dose.ofType(Range).all(low.exists() and high.exists())

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
Dosage	C	0..*	DosageEuMpd(1.0.0)	How the medication is/was taken or should be taken Constraints: ie-dos-1, ie-dos-2, ie-dos-3, ie-dos-4
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url Constraints: ext-1
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized Constraints: ext-1
sequence	SΣ	0..1	integer	The order of the dosage instructions
text	SΣ	0..1	string	Free text dosage instructions e.g. SIG
additionalInstruction	SΣ	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	SOΣ	0..1	string	Patient or consumer oriented instructions Obligations Actor Source SHOULD:able-to-populate Producer from Dosage: MPD
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 Constraints: ext-1
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized Constraints: ext-1
event	Σ	0..*	dateTime	When the event occurs
repeat	OΣ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 Obligations Actor Source SHALL:able-to-populate Producer from Dosage: MPD
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url Constraints: ext-1
bounds[x]	SOΣ	0..1		Length/Range of lengths, or (Start and/or end) limits Obligations Actor Source SHALL:able-to-populate Producer from Dosage: MPD
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	SOΣ	0..1	positiveInt	Event occurs frequency times per period Obligations Actor Source SHALL:able-to-populate Producer from Dosage: MPD
frequencyMax	Σ	0..1	positiveInt	Event occurs up to frequencyMax times per period
period	SOΣ	0..1	decimal	Event occurs frequency times per period Obligations Actor Source SHALL:able-to-populate Producer from Dosage: MPD
periodMax	Σ	0..1	decimal	Upper limit of period (3-4 hours)
periodUnit	SOΣ	0..1	code	s | min | h | d | wk | mo | a - unit of time (UCUM) Binding: UnitsOfTime (required): A unit of time (units from UCUM). Obligations Actor Source SHALL:able-to-populate Producer from Dosage: MPD
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.
Slices for asNeeded[x]	Σ	0..1		Take "as needed" (for x) Slice: Unordered, Closed by type:$this Binding: SNOMEDCTMedicationAsNeededReasonCodes (example): A coded concept identifying the precondition that should be met or evaluated prior to consuming or administering a medication dose. For example "pain", "30 minutes prior to sexual intercourse", "on flare-up" etc.
asNeededBoolean			boolean
asNeededCodeableConcept			CodeableConcept
asNeeded[x]:asNeededBoolean	Σ	0..1	boolean	Take "as needed" (for x)
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	SOΣ	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. Obligations Actor Source SHOULD:able-to-populate Producer from Dosage: MPD
method	Σ	0..1	CodeableConcept	Technique for administering medication Binding: SNOMEDCTAdministrationMethodCodes (example): A coded concept describing the technique by which the medicine is administered.
doseAndRate	SΣ	0..*	Element	Amount of medication administered
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url Constraints: ext-1
type	Σ	0..1	CodeableConcept	The kind of dose or rate specified Binding: DoseAndRateType (example): The kind of dose or rate specified.
dose[x]	SOΣ	0..1		Amount of medication per dose Obligations Actor Source SHALL:able-to-populate Producer from Dosage: MPD
doseRange			Range
doseQuantity			Quantity(SimpleQuantity)
rate[x]	Σ	0..1		Amount of medication per unit of time
rateRatio			Ratio
rateRange			Range
rateQuantity			Quantity(SimpleQuantity)
maxDosePerPeriod	SΣ	0..1	Ratio	Upper limit on medication per unit of time
maxDosePerAdministration	Σ	0..1	SimpleQuantity(4.0.1)	Upper limit on medication per administration
maxDosePerLifetime	Σ	0..1	SimpleQuantity(4.0.1)	Upper limit on medication per lifetime of the patient
Documentation for this format

Terminology Bindings

Path	Status	Usage	ValueSet	Version	Source
Dosage.additionalInstruction	Base	example	SNOMED CT Additional Dosage Instructions	📍4.0.1	FHIR Std.
Dosage.timing.repeat.​durationUnit	Base	required	UnitsOfTime	📍4.0.1	FHIR Std.
Dosage.timing.repeat.​periodUnit	Base	required	UnitsOfTime	📍4.0.1	FHIR Std.
Dosage.timing.repeat.​dayOfWeek	Base	required	DaysOfWeek	📍4.0.1	FHIR Std.
Dosage.timing.repeat.​when	Base	required	EventTiming	📍4.0.1	FHIR Std.
Dosage.timing.code	Base	preferred	TimingAbbreviation	📍4.0.1	FHIR Std.
Dosage.asNeeded[x]	Base	example	SNOMED CT Medication As Needed Reason Codes	📍4.0.1	FHIR Std.
Dosage.site	Base	example	SNOMED CT Anatomical Structure for Administration Site Codes	📍4.0.1	FHIR Std.
Dosage.route	Base	example	SNOMED CT Route Codes	📍4.0.1	FHIR Std.
Dosage.method	Base	example	SNOMED CT Administration Method Codes	📍4.0.1	FHIR Std.
Dosage.doseAndRate.type	Base	example	DoseAndRateType	📍4.0.1	FHIR Std.

Constraints

Id	Grade	Path(s)	Description	Expression
ele-1	error	Dosage, Dosage.extension, Dosage.modifierExtension, Dosage.sequence, Dosage.text, Dosage.additionalInstruction, Dosage.patientInstruction, Dosage.timing, Dosage.timing.extension, Dosage.timing.modifierExtension, Dosage.timing.event, Dosage.timing.repeat, Dosage.timing.repeat.extension, Dosage.timing.repeat.bounds[x], Dosage.timing.repeat.count, Dosage.timing.repeat.countMax, Dosage.timing.repeat.duration, Dosage.timing.repeat.durationMax, Dosage.timing.repeat.durationUnit, Dosage.timing.repeat.frequency, Dosage.timing.repeat.frequencyMax, Dosage.timing.repeat.period, Dosage.timing.repeat.periodMax, Dosage.timing.repeat.periodUnit, Dosage.timing.repeat.dayOfWeek, Dosage.timing.repeat.timeOfDay, Dosage.timing.repeat.when, Dosage.timing.repeat.offset, Dosage.timing.code, Dosage.asNeeded[x], Dosage.asNeeded[x]:asNeededBoolean, Dosage.site, Dosage.route, Dosage.method, Dosage.doseAndRate, Dosage.doseAndRate.extension, Dosage.doseAndRate.type, Dosage.doseAndRate.dose[x], Dosage.doseAndRate.rate[x], Dosage.maxDosePerPeriod, Dosage.maxDosePerAdministration, Dosage.maxDosePerLifetime	All FHIR elements must have a @value or children	hasValue() or (children().count() > id.count())
ext-1	error	Dosage.extension, Dosage.modifierExtension, Dosage.timing.extension, Dosage.timing.modifierExtension, Dosage.timing.repeat.extension, Dosage.doseAndRate.extension	Must have either extensions or value[x], not both	extension.exists() != value.exists()
ie-dos-1	error	Dosage	A structured dosage SHALL be accompanied by a human-readable dosage text (HIQA EP 5.1; safety fallback)	(timing.exists() or doseAndRate.exists() or route.exists() or asNeeded.exists()) implies text.exists()
ie-dos-2	error	Dosage	A frequency SHALL have its period and period unit (HIQA EP 5.2.4.3.1 and 5.2.4.3.2 are both Mandatory in the frequency cluster)	timing.repeat.frequency.exists() implies (timing.repeat.period.exists() and timing.repeat.periodUnit.exists())
ie-dos-3	warning	Dosage	An as-needed dosage SHOULD state a maximum dose per period	asNeeded.ofType(boolean) = true implies maxDosePerPeriod.exists()
ie-dos-4	error	Dosage	A dose range SHALL give both a low and a high value (HIQA EP 5.2.3.1.2)	doseAndRate.dose.ofType(Range).all(low.exists() and high.exists())
tim-1	error	Dosage.timing.repeat	if there's a duration, there needs to be duration units	duration.empty() or durationUnit.exists()
tim-2	error	Dosage.timing.repeat	if there's a period, there needs to be period units	period.empty() or periodUnit.exists()
tim-4	error	Dosage.timing.repeat	duration SHALL be a non-negative value	duration.exists() implies duration >= 0
tim-5	error	Dosage.timing.repeat	period SHALL be a non-negative value	period.exists() implies period >= 0
tim-6	error	Dosage.timing.repeat	If there's a periodMax, there must be a period	periodMax.empty() or period.exists()
tim-7	error	Dosage.timing.repeat	If there's a durationMax, there must be a duration	durationMax.empty() or duration.exists()
tim-8	error	Dosage.timing.repeat	If there's a countMax, there must be a count	countMax.empty() or count.exists()
tim-9	error	Dosage.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	Dosage.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 DosageEuMpd

Summary

Must-Support: 13 elements

Key Elements View

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
Dosage	C	0..*	DosageEuMpd(1.0.0)	How the medication is/was taken or should be taken Constraints: ie-dos-1, ie-dos-2, ie-dos-3, ie-dos-4
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized Constraints: ext-1
sequence	SΣ	0..1	integer	The order of the dosage instructions
text	SΣ	0..1	string	Free text dosage instructions e.g. SIG
additionalInstruction	SΣ	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	SOΣ	0..1	string	Patient or consumer oriented instructions Obligations Actor Source SHOULD:able-to-populate Producer from Dosage: MPD
timing	SΣ	0..1	Timing	When medication should be administered
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized Constraints: ext-1
repeat	OΣ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 Obligations Actor Source SHALL:able-to-populate Producer from Dosage: MPD
bounds[x]	SOΣ	0..1		Length/Range of lengths, or (Start and/or end) limits Obligations Actor Source SHALL:able-to-populate Producer from Dosage: MPD
boundsDuration			Duration
boundsRange			Range
boundsPeriod			Period
duration	Σ	0..1	decimal	How long when it happens
frequency	SOΣ	0..1	positiveInt	Event occurs frequency times per period Obligations Actor Source SHALL:able-to-populate Producer from Dosage: MPD
period	SOΣ	0..1	decimal	Event occurs frequency times per period Obligations Actor Source SHALL:able-to-populate Producer from Dosage: MPD
periodUnit	SOΣ	0..1	code	s | min | h | d | wk | mo | a - unit of time (UCUM) Binding: UnitsOfTime (required): A unit of time (units from UCUM). Obligations Actor Source SHALL:able-to-populate Producer from Dosage: MPD
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.
Slices for asNeeded[x]	Σ	0..1		Take "as needed" (for x) Slice: Unordered, Closed by type:$this Binding: SNOMEDCTMedicationAsNeededReasonCodes (example): A coded concept identifying the precondition that should be met or evaluated prior to consuming or administering a medication dose. For example "pain", "30 minutes prior to sexual intercourse", "on flare-up" etc.
asNeededBoolean			boolean
asNeededCodeableConcept			CodeableConcept
asNeeded[x]:asNeededBoolean	Σ	0..1	boolean	Take "as needed" (for x)
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	SOΣ	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. Obligations Actor Source SHOULD:able-to-populate Producer from Dosage: MPD
method	Σ	0..1	CodeableConcept	Technique for administering medication Binding: SNOMEDCTAdministrationMethodCodes (example): A coded concept describing the technique by which the medicine is administered.
doseAndRate	SΣ	0..*	Element	Amount of medication administered
dose[x]	SOΣ	0..1		Amount of medication per dose Obligations Actor Source SHALL:able-to-populate Producer from Dosage: MPD
doseRange			Range
doseQuantity			Quantity(SimpleQuantity)
rate[x]	Σ	0..1		Amount of medication per unit of time
rateRatio			Ratio
rateRange			Range
rateQuantity			Quantity(SimpleQuantity)
maxDosePerPeriod	SΣ	0..1	Ratio	Upper limit on medication per unit of time
maxDosePerAdministration	Σ	0..1	SimpleQuantity(4.0.1)	Upper limit on medication per administration
Documentation for this format

Terminology Bindings

Path	Status	Usage	ValueSet	Version	Source
Dosage.additionalInstruction	Base	example	SNOMED CT Additional Dosage Instructions	📍4.0.1	FHIR Std.
Dosage.timing.repeat.​periodUnit	Base	required	UnitsOfTime	📍4.0.1	FHIR Std.
Dosage.timing.repeat.​dayOfWeek	Base	required	DaysOfWeek	📍4.0.1	FHIR Std.
Dosage.timing.repeat.​when	Base	required	EventTiming	📍4.0.1	FHIR Std.
Dosage.asNeeded[x]	Base	example	SNOMED CT Medication As Needed Reason Codes	📍4.0.1	FHIR Std.
Dosage.site	Base	example	SNOMED CT Anatomical Structure for Administration Site Codes	📍4.0.1	FHIR Std.
Dosage.route	Base	example	SNOMED CT Route Codes	📍4.0.1	FHIR Std.
Dosage.method	Base	example	SNOMED CT Administration Method Codes	📍4.0.1	FHIR Std.

Constraints

Id	Grade	Path(s)	Description	Expression
ele-1	error	Dosage, Dosage.modifierExtension, Dosage.sequence, Dosage.text, Dosage.additionalInstruction, Dosage.patientInstruction, Dosage.timing, Dosage.timing.modifierExtension, Dosage.timing.repeat, Dosage.timing.repeat.bounds[x], Dosage.timing.repeat.duration, Dosage.timing.repeat.frequency, Dosage.timing.repeat.period, Dosage.timing.repeat.periodUnit, Dosage.timing.repeat.dayOfWeek, Dosage.timing.repeat.timeOfDay, Dosage.timing.repeat.when, Dosage.asNeeded[x], Dosage.asNeeded[x]:asNeededBoolean, Dosage.site, Dosage.route, Dosage.method, Dosage.doseAndRate, Dosage.doseAndRate.dose[x], Dosage.doseAndRate.rate[x], Dosage.maxDosePerPeriod, Dosage.maxDosePerAdministration	All FHIR elements must have a @value or children	hasValue() or (children().count() > id.count())
ext-1	error	Dosage.modifierExtension, Dosage.timing.modifierExtension	Must have either extensions or value[x], not both	extension.exists() != value.exists()
ie-dos-1	error	Dosage	A structured dosage SHALL be accompanied by a human-readable dosage text (HIQA EP 5.1; safety fallback)	(timing.exists() or doseAndRate.exists() or route.exists() or asNeeded.exists()) implies text.exists()
ie-dos-2	error	Dosage	A frequency SHALL have its period and period unit (HIQA EP 5.2.4.3.1 and 5.2.4.3.2 are both Mandatory in the frequency cluster)	timing.repeat.frequency.exists() implies (timing.repeat.period.exists() and timing.repeat.periodUnit.exists())
ie-dos-3	warning	Dosage	An as-needed dosage SHOULD state a maximum dose per period	asNeeded.ofType(boolean) = true implies maxDosePerPeriod.exists()
ie-dos-4	error	Dosage	A dose range SHALL give both a low and a high value (HIQA EP 5.2.3.1.2)	doseAndRate.dose.ofType(Range).all(low.exists() and high.exists())
tim-1	error	Dosage.timing.repeat	if there's a duration, there needs to be duration units	duration.empty() or durationUnit.exists()
tim-2	error	Dosage.timing.repeat	if there's a period, there needs to be period units	period.empty() or periodUnit.exists()
tim-4	error	Dosage.timing.repeat	duration SHALL be a non-negative value	duration.exists() implies duration >= 0
tim-5	error	Dosage.timing.repeat	period SHALL be a non-negative value	period.exists() implies period >= 0
tim-6	error	Dosage.timing.repeat	If there's a periodMax, there must be a period	periodMax.empty() or period.exists()
tim-7	error	Dosage.timing.repeat	If there's a durationMax, there must be a duration	durationMax.empty() or duration.exists()
tim-8	error	Dosage.timing.repeat	If there's a countMax, there must be a count	countMax.empty() or count.exists()
tim-9	error	Dosage.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	Dosage.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 DosageEuMpd

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
Dosage	C	0..*	DosageEuMpd(1.0.0)	How the medication is/was taken or should be taken
sequence	S	0..1	integer	The order of the dosage instructions
text	S	0..1	string	Free text dosage instructions e.g. SIG
additionalInstruction	S	0..*	CodeableConcept	Supplemental instruction or warnings to the patient - e.g. "with meals", "may cause drowsiness"
patientInstruction	S	0..1	string	Patient or consumer oriented instructions
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
duration		0..1	decimal	How long when it happens
frequency	S	0..1	positiveInt	Event occurs frequency times per period
period	S	0..1	decimal	Event occurs frequency times per period
periodUnit	S	0..1	code	s | min | h | d | wk | mo | a - unit of time (UCUM)
dayOfWeek		0..*	code	mon | tue | wed | thu | fri | sat | sun
timeOfDay		0..*	time	Time of day for action
when		0..*	code	Code for time period of occurrence
asNeeded[x]		0..1	boolean, CodeableConcept	Take "as needed" (for x)
site		0..1	CodeableConcept	Body site to administer to
route	S	0..1	CodeableConcept	How drug should enter body
method		0..1	CodeableConcept	Technique for administering medication
doseAndRate	S	0..*	Element	Amount of medication administered
dose[x]	S	0..1	Range, SimpleQuantity(4.0.1)	Amount of medication per dose
rate[x]		0..1	Ratio, Range, SimpleQuantity(4.0.1)	Amount of medication per unit of time
maxDosePerPeriod	S	0..1	Ratio	Upper limit on medication per unit of time
maxDosePerAdministration		0..1	SimpleQuantity(4.0.1)	Upper limit on medication per administration
Documentation for this format

Constraints

Id	Grade	Path(s)	Description	Expression
ie-dos-1	error	Dosage	A structured dosage SHALL be accompanied by a human-readable dosage text (HIQA EP 5.1; safety fallback)	(timing.exists() or doseAndRate.exists() or route.exists() or asNeeded.exists()) implies text.exists()
ie-dos-2	error	Dosage	A frequency SHALL have its period and period unit (HIQA EP 5.2.4.3.1 and 5.2.4.3.2 are both Mandatory in the frequency cluster)	timing.repeat.frequency.exists() implies (timing.repeat.period.exists() and timing.repeat.periodUnit.exists())
ie-dos-3	warning	Dosage	An as-needed dosage SHOULD state a maximum dose per period	asNeeded.ofType(boolean) = true implies maxDosePerPeriod.exists()
ie-dos-4	error	Dosage	A dose range SHALL give both a low and a high value (HIQA EP 5.2.3.1.2)	doseAndRate.dose.ofType(Range).all(low.exists() and high.exists())

Snapshot View

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
Dosage	C	0..*	DosageEuMpd(1.0.0)	How the medication is/was taken or should be taken Constraints: ie-dos-1, ie-dos-2, ie-dos-3, ie-dos-4
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url Constraints: ext-1
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized Constraints: ext-1
sequence	SΣ	0..1	integer	The order of the dosage instructions
text	SΣ	0..1	string	Free text dosage instructions e.g. SIG
additionalInstruction	SΣ	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	SOΣ	0..1	string	Patient or consumer oriented instructions Obligations Actor Source SHOULD:able-to-populate Producer from Dosage: MPD
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 Constraints: ext-1
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized Constraints: ext-1
event	Σ	0..*	dateTime	When the event occurs
repeat	OΣ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 Obligations Actor Source SHALL:able-to-populate Producer from Dosage: MPD
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url Constraints: ext-1
bounds[x]	SOΣ	0..1		Length/Range of lengths, or (Start and/or end) limits Obligations Actor Source SHALL:able-to-populate Producer from Dosage: MPD
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	SOΣ	0..1	positiveInt	Event occurs frequency times per period Obligations Actor Source SHALL:able-to-populate Producer from Dosage: MPD
frequencyMax	Σ	0..1	positiveInt	Event occurs up to frequencyMax times per period
period	SOΣ	0..1	decimal	Event occurs frequency times per period Obligations Actor Source SHALL:able-to-populate Producer from Dosage: MPD
periodMax	Σ	0..1	decimal	Upper limit of period (3-4 hours)
periodUnit	SOΣ	0..1	code	s | min | h | d | wk | mo | a - unit of time (UCUM) Binding: UnitsOfTime (required): A unit of time (units from UCUM). Obligations Actor Source SHALL:able-to-populate Producer from Dosage: MPD
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.
Slices for asNeeded[x]	Σ	0..1		Take "as needed" (for x) Slice: Unordered, Closed by type:$this Binding: SNOMEDCTMedicationAsNeededReasonCodes (example): A coded concept identifying the precondition that should be met or evaluated prior to consuming or administering a medication dose. For example "pain", "30 minutes prior to sexual intercourse", "on flare-up" etc.
asNeededBoolean			boolean
asNeededCodeableConcept			CodeableConcept
asNeeded[x]:asNeededBoolean	Σ	0..1	boolean	Take "as needed" (for x)
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	SOΣ	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. Obligations Actor Source SHOULD:able-to-populate Producer from Dosage: MPD
method	Σ	0..1	CodeableConcept	Technique for administering medication Binding: SNOMEDCTAdministrationMethodCodes (example): A coded concept describing the technique by which the medicine is administered.
doseAndRate	SΣ	0..*	Element	Amount of medication administered
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url Constraints: ext-1
type	Σ	0..1	CodeableConcept	The kind of dose or rate specified Binding: DoseAndRateType (example): The kind of dose or rate specified.
dose[x]	SOΣ	0..1		Amount of medication per dose Obligations Actor Source SHALL:able-to-populate Producer from Dosage: MPD
doseRange			Range
doseQuantity			Quantity(SimpleQuantity)
rate[x]	Σ	0..1		Amount of medication per unit of time
rateRatio			Ratio
rateRange			Range
rateQuantity			Quantity(SimpleQuantity)
maxDosePerPeriod	SΣ	0..1	Ratio	Upper limit on medication per unit of time
maxDosePerAdministration	Σ	0..1	SimpleQuantity(4.0.1)	Upper limit on medication per administration
maxDosePerLifetime	Σ	0..1	SimpleQuantity(4.0.1)	Upper limit on medication per lifetime of the patient
Documentation for this format

Terminology Bindings

Path	Status	Usage	ValueSet	Version	Source
Dosage.additionalInstruction	Base	example	SNOMED CT Additional Dosage Instructions	📍4.0.1	FHIR Std.
Dosage.timing.repeat.​durationUnit	Base	required	UnitsOfTime	📍4.0.1	FHIR Std.
Dosage.timing.repeat.​periodUnit	Base	required	UnitsOfTime	📍4.0.1	FHIR Std.
Dosage.timing.repeat.​dayOfWeek	Base	required	DaysOfWeek	📍4.0.1	FHIR Std.
Dosage.timing.repeat.​when	Base	required	EventTiming	📍4.0.1	FHIR Std.
Dosage.timing.code	Base	preferred	TimingAbbreviation	📍4.0.1	FHIR Std.
Dosage.asNeeded[x]	Base	example	SNOMED CT Medication As Needed Reason Codes	📍4.0.1	FHIR Std.
Dosage.site	Base	example	SNOMED CT Anatomical Structure for Administration Site Codes	📍4.0.1	FHIR Std.
Dosage.route	Base	example	SNOMED CT Route Codes	📍4.0.1	FHIR Std.
Dosage.method	Base	example	SNOMED CT Administration Method Codes	📍4.0.1	FHIR Std.
Dosage.doseAndRate.type	Base	example	DoseAndRateType	📍4.0.1	FHIR Std.

Constraints

Id	Grade	Path(s)	Description	Expression
ele-1	error	Dosage, Dosage.extension, Dosage.modifierExtension, Dosage.sequence, Dosage.text, Dosage.additionalInstruction, Dosage.patientInstruction, Dosage.timing, Dosage.timing.extension, Dosage.timing.modifierExtension, Dosage.timing.event, Dosage.timing.repeat, Dosage.timing.repeat.extension, Dosage.timing.repeat.bounds[x], Dosage.timing.repeat.count, Dosage.timing.repeat.countMax, Dosage.timing.repeat.duration, Dosage.timing.repeat.durationMax, Dosage.timing.repeat.durationUnit, Dosage.timing.repeat.frequency, Dosage.timing.repeat.frequencyMax, Dosage.timing.repeat.period, Dosage.timing.repeat.periodMax, Dosage.timing.repeat.periodUnit, Dosage.timing.repeat.dayOfWeek, Dosage.timing.repeat.timeOfDay, Dosage.timing.repeat.when, Dosage.timing.repeat.offset, Dosage.timing.code, Dosage.asNeeded[x], Dosage.asNeeded[x]:asNeededBoolean, Dosage.site, Dosage.route, Dosage.method, Dosage.doseAndRate, Dosage.doseAndRate.extension, Dosage.doseAndRate.type, Dosage.doseAndRate.dose[x], Dosage.doseAndRate.rate[x], Dosage.maxDosePerPeriod, Dosage.maxDosePerAdministration, Dosage.maxDosePerLifetime	All FHIR elements must have a @value or children	hasValue() or (children().count() > id.count())
ext-1	error	Dosage.extension, Dosage.modifierExtension, Dosage.timing.extension, Dosage.timing.modifierExtension, Dosage.timing.repeat.extension, Dosage.doseAndRate.extension	Must have either extensions or value[x], not both	extension.exists() != value.exists()
ie-dos-1	error	Dosage	A structured dosage SHALL be accompanied by a human-readable dosage text (HIQA EP 5.1; safety fallback)	(timing.exists() or doseAndRate.exists() or route.exists() or asNeeded.exists()) implies text.exists()
ie-dos-2	error	Dosage	A frequency SHALL have its period and period unit (HIQA EP 5.2.4.3.1 and 5.2.4.3.2 are both Mandatory in the frequency cluster)	timing.repeat.frequency.exists() implies (timing.repeat.period.exists() and timing.repeat.periodUnit.exists())
ie-dos-3	warning	Dosage	An as-needed dosage SHOULD state a maximum dose per period	asNeeded.ofType(boolean) = true implies maxDosePerPeriod.exists()
ie-dos-4	error	Dosage	A dose range SHALL give both a low and a high value (HIQA EP 5.2.3.1.2)	doseAndRate.dose.ofType(Range).all(low.exists() and high.exists())
tim-1	error	Dosage.timing.repeat	if there's a duration, there needs to be duration units	duration.empty() or durationUnit.exists()
tim-2	error	Dosage.timing.repeat	if there's a period, there needs to be period units	period.empty() or periodUnit.exists()
tim-4	error	Dosage.timing.repeat	duration SHALL be a non-negative value	duration.exists() implies duration >= 0
tim-5	error	Dosage.timing.repeat	period SHALL be a non-negative value	period.exists() implies period >= 0
tim-6	error	Dosage.timing.repeat	If there's a periodMax, there must be a period	periodMax.empty() or period.exists()
tim-7	error	Dosage.timing.repeat	If there's a durationMax, there must be a duration	durationMax.empty() or duration.exists()
tim-8	error	Dosage.timing.repeat	If there's a countMax, there must be a count	countMax.empty() or count.exists()
tim-9	error	Dosage.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	Dosage.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 DosageEuMpd

Summary

Must-Support: 13 elements

Other representations of profile: CSV, Excel, Schematron