MedNet interface implementation guide - Downloaded Version 0.20.0 See the Directory of published versions

• Content
• Detailed Descriptions

Data Type Profile: MedNet Interface (MNI) - Medication Statement Dosage

MedNet Interface (MNI) - Medication Statement Dosage

Usages:

• Use this DataType Profile: MedNet Interface (MNI) - Medication Statement

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..*	CHEMEDDosage	MedNet Interface (MNI) - Medication Statement Dosage Constraints: ch-dosage-4
id	S	0..1	string	The id is unique within the space of all resources of the same type on the same server It can be any combination of upper- or lower-case ASCII letters 'A'..'Z', and 'a'..'z', numerals ('0'..'9'), '-' and '.' with a length limit of 64 characters. (This might be an integer, an un-prefixed OID, UUID or any other identifier pattern that meets these constraints.)
patientInstruction	SΣ	0..1	string	Patient instructions (e.g. 'take with food'), incl. free text dosage instructions (e.g. for complex dosage)
timing	SΣ	1..1	Timing	When medication should be administered
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
repeat	SΣC	1..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
Slices for bounds[x]	Σ	0..1		Length/Range of lengths, or (Start and/or end) limits Slice: Unordered, Open by type:$this
boundsDuration			Duration
boundsRange			Range
boundsPeriod			Period
bounds[x]:boundsPeriod	SΣ	0..1	Period	Start and/or end of treatment
when	SΣC	1..*	code	MORN (Morning) | NOON (Noon) | EVE (Evening) | NIGHT (Night) Binding: MedNet Interface (MNI) - Taking Time For Posology ValueSet (required) Constraints: ch-emed-event-timing
Slices for asNeeded[x]	Σ	0..1		Take "as needed" (for x) Slice: Unordered, Open 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	In reserve (to be taken by the patient only if the need arises - e.g. pains)
route	Σ	0..1	CodeableConcept	Route of administration Binding: EDQM - RouteOfAdministration (required)
coding	SΣ	1..*	Coding	Code defined by a terminology system
system	Σ	1..1	uri	Identity of the terminology system
code	Σ	1..1	code	Symbol in syntax defined by the system
doseAndRate	SΣ	1..1	Element	Amount of medication administered
Slices for dose[x]	SΣ	1..1	Quantity	Amount of medication per dose Slice: Unordered, Closed by type:$this
dose[x]:doseQuantity	SΣ	1..1	Quantity	Amount of medication per dose
value	SΣ	1..1	decimal	Numerical value (with implicit precision)
comparator	?!Σ	0..1	code	< | <= | >= | > - how to understand the value Binding: QuantityComparator (required): How the Quantity should be understood and represented.
unit	SΣ	1..1	string	Unit representation
system	SΣC	1..1	uri	System that defines coded unit form
Documentation for this format

Terminology Bindings

Path	Status	Usage	ValueSet	Version	Source
Dosage.timing.repeat.​when	Base	required	MedNet Interface (MNI) - Taking Time For Posology ValueSet	📦0.20.0	This IG
Dosage.asNeeded[x]	Base	example	SNOMED CT Medication As Needed Reason Codes	📍4.0.1	FHIR Std.
Dosage.route	Base	required	EDQM - RouteOfAdministration	📦3.3.0	CH Term v3.3
Dosage.doseAndRate.dose[x]:doseQuantity.​comparator	Base	required	QuantityComparator	📍4.0.1	FHIR Std.

Constraints

Id	Grade	Path(s)	Description	Expression
ch-dosage-4	error	Dosage	For split dosage timing event and dose/rate are REQUIRED	sequence.exists() implies (timing.repeat.when.exists() and doseAndRate.dose.exists())
ch-emed-event-timing	warning	Dosage.timing.repeat.when	For the representation of the time of administration according to the 1-1-1-1 scheme, the values MORN-NOON-EVE-NIGHT SHOULD be used.	$this='MORN' or $this='NOON' or $this='EVE' or $this='NIGHT'
ele-1	error	**ALL** elements	All FHIR elements must have a @value or children	hasValue() or (children().count() > id.count())
ext-1	error	**ALL** extensions	Must have either extensions or value[x], not both	extension.exists() != value.exists()
tim-1	error	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 CHEMEDDosage

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
Dosage		0..*	CHEMEDDosage	MedNet Interface (MNI) - Medication Statement Dosage
id	S	0..1	string	The id is unique within the space of all resources of the same type on the same server It can be any combination of upper- or lower-case ASCII letters 'A'..'Z', and 'a'..'z', numerals ('0'..'9'), '-' and '.' with a length limit of 64 characters. (This might be an integer, an un-prefixed OID, UUID or any other identifier pattern that meets these constraints.)
modifierExtension		0..0		Extension
timing	S	1..1	Timing	When medication should be administered
repeat	S	1..1	Element	When the event is to occur
when	S	1..*	code	MORN (Morning) | NOON (Noon) | EVE (Evening) | NIGHT (Night) Binding: MedNet Interface (MNI) - Taking Time For Posology ValueSet (required)
doseAndRate	S	1..1	Element	Amount of medication administered
doseQuantity	S	1..1	Quantity	Amount of medication per dose
value	S	1..1	decimal	Numerical value (with implicit precision)
unit	S	1..1	string	Unit representation
system	S	1..1	uri	System that defines coded unit form
Documentation for this format

Terminology Bindings (Differential)

Path	Status	Usage	ValueSet	Version	Source
Dosage.timing.repeat.​when	Base	required	MedNet Interface (MNI) - Taking Time For Posology ValueSet	📦0.20.0	This IG

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
Dosage	C	0..*	CHEMEDDosage	MedNet Interface (MNI) - Medication Statement Dosage Constraints: ch-dosage-4
id	S	0..1	string	The id is unique within the space of all resources of the same type on the same server It can be any combination of upper- or lower-case ASCII letters 'A'..'Z', and 'a'..'z', numerals ('0'..'9'), '-' and '.' with a length limit of 64 characters. (This might be an integer, an un-prefixed OID, UUID or any other identifier pattern that meets these constraints.)
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
sequence	ΣC	0..1	integer	The order of the dosage instructions Constraints: ch-dosage-1
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	SΣ	0..1	string	Patient instructions (e.g. 'take with food'), incl. free text dosage instructions (e.g. for complex dosage)
timing	SΣ	1..1	Timing	When medication should be administered
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
event	Σ	0..*	dateTime	When the event occurs
repeat	SΣC	1..1	Element	When the event is to occur Constraints: tim-1, tim-2, tim-4, tim-5, tim-6, tim-7, tim-8, tim-9, tim-10
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
Slices for bounds[x]	Σ	0..1		Length/Range of lengths, or (Start and/or end) limits Slice: Unordered, Open by type:$this
boundsDuration			Duration
boundsRange			Range
boundsPeriod			Period
bounds[x]:boundsPeriod	SΣ	0..1	Period	Start and/or end of treatment
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	SΣC	1..*	code	MORN (Morning) | NOON (Noon) | EVE (Evening) | NIGHT (Night) Binding: MedNet Interface (MNI) - Taking Time For Posology ValueSet (required) Constraints: ch-emed-event-timing
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, Open 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	In reserve (to be taken by the patient only if the need arises - e.g. pains)
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	Route of administration Binding: EDQM - RouteOfAdministration (required)
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
coding	SΣ	1..*	Coding	Code defined by a terminology system
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
system	Σ	1..1	uri	Identity of the terminology system
version	Σ	0..1	string	Version of the system - if relevant
code	Σ	1..1	code	Symbol in syntax defined by the system
display	Σ	0..1	string	Representation defined by the system
userSelected	Σ	0..1	boolean	If this coding was chosen directly by the user
text	Σ	0..1	string	Plain text representation of the concept
method	Σ	0..1	CodeableConcept	Administration method Binding: EDQM - Administration Method (required)
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
coding	Σ	1..*	Coding	Code defined by a terminology system
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
system	Σ	1..1	uri	Identity of the terminology system
version	Σ	0..1	string	Version of the system - if relevant
code	Σ	1..1	code	Symbol in syntax defined by the system
display	Σ	0..1	string	Representation defined by the system
userSelected	Σ	0..1	boolean	If this coding was chosen directly by the user
text	Σ	0..1	string	Plain text representation of the concept
doseAndRate	SΣ	1..1	Element	Amount of medication administered
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
type	Σ	0..1	CodeableConcept	The kind of dose or rate specified Binding: DoseAndRateType (example): The kind of dose or rate specified.
Slices for dose[x]	SΣ	1..1	Quantity	Amount of medication per dose Slice: Unordered, Closed by type:$this
dose[x]:doseQuantity	SΣ	1..1	Quantity	Amount of medication per dose
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
value	SΣ	1..1	decimal	Numerical value (with implicit precision)
comparator	?!Σ	0..1	code	< | <= | >= | > - how to understand the value Binding: QuantityComparator (required): How the Quantity should be understood and represented.
unit	SΣ	1..1	string	Unit representation
system	SΣC	1..1	uri	System that defines coded unit form
code	Σ	0..1	code	Coded form of the unit
rate[x]	Σ	0..1		Amount of medication per unit of time
rateRatio			Ratio
rateRange			Range
rateQuantity			Quantity(SimpleQuantity)
maxDosePerPeriod	Σ	0..1	Ratio	Upper limit on medication per unit of time
maxDosePerAdministration	Σ	0..1	SimpleQuantity(4.0.1)	Upper limit on medication per administration
maxDosePerLifetime	Σ	0..1	SimpleQuantity(4.0.1)	Upper limit on medication per lifetime of the patient
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	MedNet Interface (MNI) - Taking Time For Posology ValueSet	📦0.20.0	This IG
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	required	EDQM - RouteOfAdministration	📦3.3.0	CH Term v3.3
Dosage.method	Base	required	EDQM - Administration Method	📦3.3.0	CH Term v3.3
Dosage.doseAndRate.type	Base	example	DoseAndRateType	📍4.0.1	FHIR Std.
Dosage.doseAndRate.dose[x]:doseQuantity.​comparator	Base	required	QuantityComparator	📍4.0.1	FHIR Std.

Constraints

Id	Grade	Path(s)	Description	Expression
ch-dosage-1	error	Dosage.sequence	No sequence number (for one dosage element) or sequence number = 1 (for more than one dosage element)	$this.count() = 0 or $this = 1
ch-dosage-4	error	Dosage	For split dosage timing event and dose/rate are REQUIRED	sequence.exists() implies (timing.repeat.when.exists() and doseAndRate.dose.exists())
ch-emed-event-timing	warning	Dosage.timing.repeat.when	For the representation of the time of administration according to the 1-1-1-1 scheme, the values MORN-NOON-EVE-NIGHT SHOULD be used.	$this='MORN' or $this='NOON' or $this='EVE' or $this='NIGHT'
ele-1	error	**ALL** elements	All FHIR elements must have a @value or children	hasValue() or (children().count() > id.count())
ext-1	error	**ALL** extensions	Must have either extensions or value[x], not both	extension.exists() != value.exists()
tim-1	error	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 CHEMEDDosage

Summary

Mandatory: 8 elements
Must-Support: 9 elements
Prohibited: 1 element

Key Elements View

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
Dosage	C	0..*	CHEMEDDosage	MedNet Interface (MNI) - Medication Statement Dosage Constraints: ch-dosage-4
id	S	0..1	string	The id is unique within the space of all resources of the same type on the same server It can be any combination of upper- or lower-case ASCII letters 'A'..'Z', and 'a'..'z', numerals ('0'..'9'), '-' and '.' with a length limit of 64 characters. (This might be an integer, an un-prefixed OID, UUID or any other identifier pattern that meets these constraints.)
patientInstruction	SΣ	0..1	string	Patient instructions (e.g. 'take with food'), incl. free text dosage instructions (e.g. for complex dosage)
timing	SΣ	1..1	Timing	When medication should be administered
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
repeat	SΣC	1..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
Slices for bounds[x]	Σ	0..1		Length/Range of lengths, or (Start and/or end) limits Slice: Unordered, Open by type:$this
boundsDuration			Duration
boundsRange			Range
boundsPeriod			Period
bounds[x]:boundsPeriod	SΣ	0..1	Period	Start and/or end of treatment
when	SΣC	1..*	code	MORN (Morning) | NOON (Noon) | EVE (Evening) | NIGHT (Night) Binding: MedNet Interface (MNI) - Taking Time For Posology ValueSet (required) Constraints: ch-emed-event-timing
Slices for asNeeded[x]	Σ	0..1		Take "as needed" (for x) Slice: Unordered, Open 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	In reserve (to be taken by the patient only if the need arises - e.g. pains)
route	Σ	0..1	CodeableConcept	Route of administration Binding: EDQM - RouteOfAdministration (required)
coding	SΣ	1..*	Coding	Code defined by a terminology system
system	Σ	1..1	uri	Identity of the terminology system
code	Σ	1..1	code	Symbol in syntax defined by the system
doseAndRate	SΣ	1..1	Element	Amount of medication administered
Slices for dose[x]	SΣ	1..1	Quantity	Amount of medication per dose Slice: Unordered, Closed by type:$this
dose[x]:doseQuantity	SΣ	1..1	Quantity	Amount of medication per dose
value	SΣ	1..1	decimal	Numerical value (with implicit precision)
comparator	?!Σ	0..1	code	< | <= | >= | > - how to understand the value Binding: QuantityComparator (required): How the Quantity should be understood and represented.
unit	SΣ	1..1	string	Unit representation
system	SΣC	1..1	uri	System that defines coded unit form
Documentation for this format

Terminology Bindings

Path	Status	Usage	ValueSet	Version	Source
Dosage.timing.repeat.​when	Base	required	MedNet Interface (MNI) - Taking Time For Posology ValueSet	📦0.20.0	This IG
Dosage.asNeeded[x]	Base	example	SNOMED CT Medication As Needed Reason Codes	📍4.0.1	FHIR Std.
Dosage.route	Base	required	EDQM - RouteOfAdministration	📦3.3.0	CH Term v3.3
Dosage.doseAndRate.dose[x]:doseQuantity.​comparator	Base	required	QuantityComparator	📍4.0.1	FHIR Std.

Constraints

Id	Grade	Path(s)	Description	Expression
ch-dosage-4	error	Dosage	For split dosage timing event and dose/rate are REQUIRED	sequence.exists() implies (timing.repeat.when.exists() and doseAndRate.dose.exists())
ch-emed-event-timing	warning	Dosage.timing.repeat.when	For the representation of the time of administration according to the 1-1-1-1 scheme, the values MORN-NOON-EVE-NIGHT SHOULD be used.	$this='MORN' or $this='NOON' or $this='EVE' or $this='NIGHT'
ele-1	error	**ALL** elements	All FHIR elements must have a @value or children	hasValue() or (children().count() > id.count())
ext-1	error	**ALL** extensions	Must have either extensions or value[x], not both	extension.exists() != value.exists()
tim-1	error	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 CHEMEDDosage

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
Dosage		0..*	CHEMEDDosage	MedNet Interface (MNI) - Medication Statement Dosage
id	S	0..1	string	The id is unique within the space of all resources of the same type on the same server It can be any combination of upper- or lower-case ASCII letters 'A'..'Z', and 'a'..'z', numerals ('0'..'9'), '-' and '.' with a length limit of 64 characters. (This might be an integer, an un-prefixed OID, UUID or any other identifier pattern that meets these constraints.)
modifierExtension		0..0		Extension
timing	S	1..1	Timing	When medication should be administered
repeat	S	1..1	Element	When the event is to occur
when	S	1..*	code	MORN (Morning) | NOON (Noon) | EVE (Evening) | NIGHT (Night) Binding: MedNet Interface (MNI) - Taking Time For Posology ValueSet (required)
doseAndRate	S	1..1	Element	Amount of medication administered
doseQuantity	S	1..1	Quantity	Amount of medication per dose
value	S	1..1	decimal	Numerical value (with implicit precision)
unit	S	1..1	string	Unit representation
system	S	1..1	uri	System that defines coded unit form
Documentation for this format

Terminology Bindings (Differential)

Path	Status	Usage	ValueSet	Version	Source
Dosage.timing.repeat.​when	Base	required	MedNet Interface (MNI) - Taking Time For Posology ValueSet	📦0.20.0	This IG

Snapshot View

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
Dosage	C	0..*	CHEMEDDosage	MedNet Interface (MNI) - Medication Statement Dosage Constraints: ch-dosage-4
id	S	0..1	string	The id is unique within the space of all resources of the same type on the same server It can be any combination of upper- or lower-case ASCII letters 'A'..'Z', and 'a'..'z', numerals ('0'..'9'), '-' and '.' with a length limit of 64 characters. (This might be an integer, an un-prefixed OID, UUID or any other identifier pattern that meets these constraints.)
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
sequence	ΣC	0..1	integer	The order of the dosage instructions Constraints: ch-dosage-1
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	SΣ	0..1	string	Patient instructions (e.g. 'take with food'), incl. free text dosage instructions (e.g. for complex dosage)
timing	SΣ	1..1	Timing	When medication should be administered
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
event	Σ	0..*	dateTime	When the event occurs
repeat	SΣC	1..1	Element	When the event is to occur Constraints: tim-1, tim-2, tim-4, tim-5, tim-6, tim-7, tim-8, tim-9, tim-10
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
Slices for bounds[x]	Σ	0..1		Length/Range of lengths, or (Start and/or end) limits Slice: Unordered, Open by type:$this
boundsDuration			Duration
boundsRange			Range
boundsPeriod			Period
bounds[x]:boundsPeriod	SΣ	0..1	Period	Start and/or end of treatment
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	SΣC	1..*	code	MORN (Morning) | NOON (Noon) | EVE (Evening) | NIGHT (Night) Binding: MedNet Interface (MNI) - Taking Time For Posology ValueSet (required) Constraints: ch-emed-event-timing
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, Open 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	In reserve (to be taken by the patient only if the need arises - e.g. pains)
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	Route of administration Binding: EDQM - RouteOfAdministration (required)
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
coding	SΣ	1..*	Coding	Code defined by a terminology system
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
system	Σ	1..1	uri	Identity of the terminology system
version	Σ	0..1	string	Version of the system - if relevant
code	Σ	1..1	code	Symbol in syntax defined by the system
display	Σ	0..1	string	Representation defined by the system
userSelected	Σ	0..1	boolean	If this coding was chosen directly by the user
text	Σ	0..1	string	Plain text representation of the concept
method	Σ	0..1	CodeableConcept	Administration method Binding: EDQM - Administration Method (required)
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
coding	Σ	1..*	Coding	Code defined by a terminology system
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
system	Σ	1..1	uri	Identity of the terminology system
version	Σ	0..1	string	Version of the system - if relevant
code	Σ	1..1	code	Symbol in syntax defined by the system
display	Σ	0..1	string	Representation defined by the system
userSelected	Σ	0..1	boolean	If this coding was chosen directly by the user
text	Σ	0..1	string	Plain text representation of the concept
doseAndRate	SΣ	1..1	Element	Amount of medication administered
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
type	Σ	0..1	CodeableConcept	The kind of dose or rate specified Binding: DoseAndRateType (example): The kind of dose or rate specified.
Slices for dose[x]	SΣ	1..1	Quantity	Amount of medication per dose Slice: Unordered, Closed by type:$this
dose[x]:doseQuantity	SΣ	1..1	Quantity	Amount of medication per dose
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
value	SΣ	1..1	decimal	Numerical value (with implicit precision)
comparator	?!Σ	0..1	code	< | <= | >= | > - how to understand the value Binding: QuantityComparator (required): How the Quantity should be understood and represented.
unit	SΣ	1..1	string	Unit representation
system	SΣC	1..1	uri	System that defines coded unit form
code	Σ	0..1	code	Coded form of the unit
rate[x]	Σ	0..1		Amount of medication per unit of time
rateRatio			Ratio
rateRange			Range
rateQuantity			Quantity(SimpleQuantity)
maxDosePerPeriod	Σ	0..1	Ratio	Upper limit on medication per unit of time
maxDosePerAdministration	Σ	0..1	SimpleQuantity(4.0.1)	Upper limit on medication per administration
maxDosePerLifetime	Σ	0..1	SimpleQuantity(4.0.1)	Upper limit on medication per lifetime of the patient
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	MedNet Interface (MNI) - Taking Time For Posology ValueSet	📦0.20.0	This IG
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	required	EDQM - RouteOfAdministration	📦3.3.0	CH Term v3.3
Dosage.method	Base	required	EDQM - Administration Method	📦3.3.0	CH Term v3.3
Dosage.doseAndRate.type	Base	example	DoseAndRateType	📍4.0.1	FHIR Std.
Dosage.doseAndRate.dose[x]:doseQuantity.​comparator	Base	required	QuantityComparator	📍4.0.1	FHIR Std.

Constraints

Id	Grade	Path(s)	Description	Expression
ch-dosage-1	error	Dosage.sequence	No sequence number (for one dosage element) or sequence number = 1 (for more than one dosage element)	$this.count() = 0 or $this = 1
ch-dosage-4	error	Dosage	For split dosage timing event and dose/rate are REQUIRED	sequence.exists() implies (timing.repeat.when.exists() and doseAndRate.dose.exists())
ch-emed-event-timing	warning	Dosage.timing.repeat.when	For the representation of the time of administration according to the 1-1-1-1 scheme, the values MORN-NOON-EVE-NIGHT SHOULD be used.	$this='MORN' or $this='NOON' or $this='EVE' or $this='NIGHT'
ele-1	error	**ALL** elements	All FHIR elements must have a @value or children	hasValue() or (children().count() > id.count())
ext-1	error	**ALL** extensions	Must have either extensions or value[x], not both	extension.exists() != value.exists()
tim-1	error	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 CHEMEDDosage

Summary

Mandatory: 8 elements
Must-Support: 9 elements
Prohibited: 1 element

Other representations of profile: CSV, Excel, Schematron