Nictiz FHIR NL STU3 Zib2017 - Local Development build (v1.3.15) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions

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

Data Type Profile: HCIM AdministrationSchedule

This profile is based on the Dutch Health and Care Information (HCIM) models (Dutch: Zorginformatiebouwsteen or ZIB) InstructionsForUse-AdministeringSchedule version 1.1, year 2017.

InstructionsForUse-AdministeringSchedule gives an insight into the manner a drug is to be used.

Usages:

• Use this DataType Profile: HCIM InstructionsForUse

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.

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

This structure is derived from Timing

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
Timing		0..*	Timing	AdministeringSchedule
repeat
bounds[x]		0..1	Duration, Range, Period	DoseDuration
duration		0..1	decimal	Duration of administration
durationUnit		0..1	code	Duration unit of administration
frequency		0..1	integer	Frequency
frequencyMax		0..1	integer	maximumValue
period		0..1	decimal	Interval
periodUnit		0..1	code	s | min | h | d | wk | mo | a - unit of time (UCUM)
dayOfWeek		0..*	code	WeekDay Binding: DaysOfWeek (required)
timeOfDay		0..*	time	AdministrationTime
when		0..*	code	TimeOfDay Binding: EventTiming (required)
Documentation for this format

Terminology Bindings (Differential)

Path	Conformance	ValueSet	URI
Timing.repeat.dayOfWeek	required	DaysOfWeek
Timing.repeat.when	required	EventTiming

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
Timing		0..*	Timing	AdministeringSchedule
Documentation for this format

Constraints

Id	Grade	Path(s)	Details	Requirements
ele-1	error	**ALL** elements	All FHIR elements must have a @value or children : hasValue() | (children().count() > id.count())

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
Timing		0..*	Timing	AdministeringSchedule
id		0..1	string	xml:id (or equivalent in JSON)
extension		0..*	Extension	Additional Content defined by implementations Slice: Unordered, Open by value:url
event	Σ	0..*	dateTime	When the event occurs
repeat	ΣC	0..1	Element	When the event is to occur Constraints: tim-9, tim-5, tim-6, tim-7, tim-8, tim-1, tim-10, tim-2, tim-4
id		0..1	string	xml:id (or equivalent in JSON)
extension		0..*	Extension	Additional Content defined by implementations Slice: Unordered, Open by value:url
bounds[x]	Σ	0..1		DoseDuration
boundsDuration			Duration
boundsRange			Range
boundsPeriod			Period
count	Σ	0..1	integer	Number of times to repeat
countMax	Σ	0..1	integer	Maximum number of times to repeat
duration	Σ	0..1	decimal	Duration of administration
durationMax	Σ	0..1	decimal	How long when it happens (Max)
durationUnit	Σ	0..1	code	Duration unit of administration Binding: UnitsOfTime (required): A unit of time (units from UCUM).
frequency	Σ	0..1	integer	Frequency
frequencyMax	Σ	0..1	integer	maximumValue
period	Σ	0..1	decimal	Interval
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	WeekDay Binding: DaysOfWeek (required)
timeOfDay	Σ	0..*	time	AdministrationTime
when	Σ	0..*	code	TimeOfDay Binding: EventTiming (required)
offset	Σ	0..1	unsignedInt	Minutes from event (before or after)
code	Σ	0..1	CodeableConcept	BID | TID | QID | AM | PM | QD | QOD | Q4H | Q6H + Binding: TimingAbbreviation (preferred): Code for a known / defined timing pattern.
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet	URI
Timing.repeat.durationUnit	required	UnitsOfTime http://hl7.org/fhir/ValueSet/units-of-time|3.0.2 From the FHIR Standard
Timing.repeat.periodUnit	required	UnitsOfTime http://hl7.org/fhir/ValueSet/units-of-time|3.0.2 From the FHIR Standard
Timing.repeat.dayOfWeek	required	DaysOfWeek http://hl7.org/fhir/ValueSet/days-of-week|3.0.2 From the FHIR Standard
Timing.repeat.when	required	EventTiming http://hl7.org/fhir/ValueSet/event-timing|3.0.2 From the FHIR Standard
Timing.code	preferred	TimingAbbreviation http://hl7.org/fhir/ValueSet/timing-abbreviation|3.0.2 From the FHIR Standard

Constraints

Id	Grade	Path(s)	Details	Requirements
ele-1	error	**ALL** elements	All FHIR elements must have a @value or children : hasValue() | (children().count() > id.count())
tim-1	error	Timing.repeat	if there's a duration, there needs to be duration units : duration.empty() or durationUnit.exists()
tim-2	error	Timing.repeat	if there's a period, there needs to be period units : period.empty() or periodUnit.exists()
tim-4	error	Timing.repeat	duration SHALL be a non-negative value : duration.exists() implies duration >= 0
tim-5	error	Timing.repeat	period SHALL be a non-negative value : period.exists() implies period >= 0
tim-6	error	Timing.repeat	If there's a periodMax, there must be a period : periodMax.empty() or period.exists()
tim-7	error	Timing.repeat	If there's a durationMax, there must be a duration : durationMax.empty() or duration.exists()
tim-8	error	Timing.repeat	If there's a countMax, there must be a count : countMax.empty() or count.exists()
tim-9	error	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	Timing.repeat	If there's a timeOfDay, there cannot be be a when, or vice versa : timeOfDay.empty() or when.empty()

This structure is derived from Timing

Summary

Differential View

This structure is derived from Timing

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
Timing		0..*	Timing	AdministeringSchedule
repeat
bounds[x]		0..1	Duration, Range, Period	DoseDuration
duration		0..1	decimal	Duration of administration
durationUnit		0..1	code	Duration unit of administration
frequency		0..1	integer	Frequency
frequencyMax		0..1	integer	maximumValue
period		0..1	decimal	Interval
periodUnit		0..1	code	s | min | h | d | wk | mo | a - unit of time (UCUM)
dayOfWeek		0..*	code	WeekDay Binding: DaysOfWeek (required)
timeOfDay		0..*	time	AdministrationTime
when		0..*	code	TimeOfDay Binding: EventTiming (required)
Documentation for this format

Terminology Bindings (Differential)

Path	Conformance	ValueSet	URI
Timing.repeat.dayOfWeek	required	DaysOfWeek
Timing.repeat.when	required	EventTiming

Key Elements View

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
Timing		0..*	Timing	AdministeringSchedule
Documentation for this format

Constraints

Id	Grade	Path(s)	Details	Requirements
ele-1	error	**ALL** elements	All FHIR elements must have a @value or children : hasValue() | (children().count() > id.count())

Snapshot View

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
Timing		0..*	Timing	AdministeringSchedule
id		0..1	string	xml:id (or equivalent in JSON)
extension		0..*	Extension	Additional Content defined by implementations Slice: Unordered, Open by value:url
event	Σ	0..*	dateTime	When the event occurs
repeat	ΣC	0..1	Element	When the event is to occur Constraints: tim-9, tim-5, tim-6, tim-7, tim-8, tim-1, tim-10, tim-2, tim-4
id		0..1	string	xml:id (or equivalent in JSON)
extension		0..*	Extension	Additional Content defined by implementations Slice: Unordered, Open by value:url
bounds[x]	Σ	0..1		DoseDuration
boundsDuration			Duration
boundsRange			Range
boundsPeriod			Period
count	Σ	0..1	integer	Number of times to repeat
countMax	Σ	0..1	integer	Maximum number of times to repeat
duration	Σ	0..1	decimal	Duration of administration
durationMax	Σ	0..1	decimal	How long when it happens (Max)
durationUnit	Σ	0..1	code	Duration unit of administration Binding: UnitsOfTime (required): A unit of time (units from UCUM).
frequency	Σ	0..1	integer	Frequency
frequencyMax	Σ	0..1	integer	maximumValue
period	Σ	0..1	decimal	Interval
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	WeekDay Binding: DaysOfWeek (required)
timeOfDay	Σ	0..*	time	AdministrationTime
when	Σ	0..*	code	TimeOfDay Binding: EventTiming (required)
offset	Σ	0..1	unsignedInt	Minutes from event (before or after)
code	Σ	0..1	CodeableConcept	BID | TID | QID | AM | PM | QD | QOD | Q4H | Q6H + Binding: TimingAbbreviation (preferred): Code for a known / defined timing pattern.
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet	URI
Timing.repeat.durationUnit	required	UnitsOfTime http://hl7.org/fhir/ValueSet/units-of-time|3.0.2 From the FHIR Standard
Timing.repeat.periodUnit	required	UnitsOfTime http://hl7.org/fhir/ValueSet/units-of-time|3.0.2 From the FHIR Standard
Timing.repeat.dayOfWeek	required	DaysOfWeek http://hl7.org/fhir/ValueSet/days-of-week|3.0.2 From the FHIR Standard
Timing.repeat.when	required	EventTiming http://hl7.org/fhir/ValueSet/event-timing|3.0.2 From the FHIR Standard
Timing.code	preferred	TimingAbbreviation http://hl7.org/fhir/ValueSet/timing-abbreviation|3.0.2 From the FHIR Standard

Constraints

Id	Grade	Path(s)	Details	Requirements
ele-1	error	**ALL** elements	All FHIR elements must have a @value or children : hasValue() | (children().count() > id.count())
tim-1	error	Timing.repeat	if there's a duration, there needs to be duration units : duration.empty() or durationUnit.exists()
tim-2	error	Timing.repeat	if there's a period, there needs to be period units : period.empty() or periodUnit.exists()
tim-4	error	Timing.repeat	duration SHALL be a non-negative value : duration.exists() implies duration >= 0
tim-5	error	Timing.repeat	period SHALL be a non-negative value : period.exists() implies period >= 0
tim-6	error	Timing.repeat	If there's a periodMax, there must be a period : periodMax.empty() or period.exists()
tim-7	error	Timing.repeat	If there's a durationMax, there must be a duration : durationMax.empty() or duration.exists()
tim-8	error	Timing.repeat	If there's a countMax, there must be a count : countMax.empty() or count.exists()
tim-9	error	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	Timing.repeat	If there's a timeOfDay, there cannot be be a when, or vice versa : timeOfDay.empty() or when.empty()

This structure is derived from Timing

Summary

Other representations of profile: CSV, Excel, Schematron