MyHealth@Eu Hospital Discharge Report - Local Development build (v0.0.1) 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: Timing: HDR

This profile constrains the Timing datatype for the purpose of this guide.

Usage:

• Use this DataType Constraint: Dosage: HDR

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
Timing		0..*	Timing	A timing schedule that specifies an event that may occur multiple times ele-1: All FHIR elements must have a @value or children
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
code	OΣ	0..1	CodeableConcept	BID | TID | QID | AM | PM | QD | QOD | + Binding: eHDSI Event Timing Combination (extensible) ele-1: All FHIR elements must have a @value or children Obligations Actor SHALL:handle HDR Handler
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet	URI
Timing.code	extensible	EHDSIEventTimingCombination http://fhir.ehdsi.eu/hdr/ValueSet/eHDSIEventTimingCombination from this IG

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 Timing

Name	Flags	Card.	Type	Description & Constraints
Timing			Timing
repeat
duration	O	0..1	decimal	Duration of the treatment Obligations Actor SHALL:handle HDR Handler
frequency	O	0..1	positiveInt	Frequency times per period Obligations Actor SHALL:handle HDR Handler
period	O	0..1	decimal	Duration of time over which repetitions are to occur Obligations Actor SHALL:handle HDR Handler
periodUnit	O	0..1	code	Unit of the period (e.g. day) Obligations Actor SHALL:handle HDR Handler
code	O	0..1	CodeableConcept	BID | TID | QID | AM | PM | QD | QOD | + Binding: eHDSI Event Timing Combination (extensible) Obligations Actor SHALL:handle HDR Handler
Documentation for this format

Terminology Bindings (Differential)

Path	Conformance	ValueSet	URI
Timing.code	extensible	EHDSIEventTimingCombination http://fhir.ehdsi.eu/hdr/ValueSet/eHDSIEventTimingCombination from this IG

Name	Flags	Card.	Type	Description & Constraints
Timing		0..*	Timing	A timing schedule that specifies an event that may occur multiple times
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 tim-1: if there's a duration, there needs to be duration units tim-2: if there's a period, there needs to be period units tim-4: duration SHALL be a non-negative value tim-5: period SHALL be a non-negative value tim-6: If there's a periodMax, there must be a period tim-7: If there's a durationMax, there must be a duration tim-8: If there's a countMax, there must be a count tim-9: If there's an offset, there must be a when (and not C, CM, CD, CV) tim-10: If there's a timeOfDay, there cannot be a when, or vice versa
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]	Σ	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	OΣ	0..1	decimal	Duration of the treatment Obligations Actor SHALL:handle HDR Handler
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	OΣ	0..1	positiveInt	Frequency times per period Obligations Actor SHALL:handle HDR Handler
frequencyMax	Σ	0..1	positiveInt	Event occurs up to frequencyMax times per period
period	OΣ	0..1	decimal	Duration of time over which repetitions are to occur Obligations Actor SHALL:handle HDR Handler
periodMax	Σ	0..1	decimal	Upper limit of period (3-4 hours)
periodUnit	OΣ	0..1	code	Unit of the period (e.g. day) Binding: UnitsOfTime (required): A unit of time (units from UCUM). Obligations Actor SHALL:handle HDR Handler
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	OΣ	0..1	CodeableConcept	BID | TID | QID | AM | PM | QD | QOD | + Binding: eHDSI Event Timing Combination (extensible) Obligations Actor SHALL:handle HDR Handler
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet	URI
Timing.repeat.durationUnit	required	UnitsOfTime http://hl7.org/fhir/ValueSet/units-of-time|4.0.1 from the FHIR Standard
Timing.repeat.periodUnit	required	UnitsOfTime http://hl7.org/fhir/ValueSet/units-of-time|4.0.1 from the FHIR Standard
Timing.repeat.dayOfWeek	required	DaysOfWeek http://hl7.org/fhir/ValueSet/days-of-week|4.0.1 from the FHIR Standard
Timing.repeat.when	required	EventTiming http://hl7.org/fhir/ValueSet/event-timing|4.0.1 from the FHIR Standard
Timing.code	extensible	EHDSIEventTimingCombination http://fhir.ehdsi.eu/hdr/ValueSet/eHDSIEventTimingCombination from this IG

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()
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 a when, or vice versa : timeOfDay.empty() or when.empty()

This structure is derived from Timing

Summary

Maturity: 1

Key Elements View

Name	Flags	Card.	Type	Description & Constraints
Timing		0..*	Timing	A timing schedule that specifies an event that may occur multiple times ele-1: All FHIR elements must have a @value or children
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
code	OΣ	0..1	CodeableConcept	BID | TID | QID | AM | PM | QD | QOD | + Binding: eHDSI Event Timing Combination (extensible) ele-1: All FHIR elements must have a @value or children Obligations Actor SHALL:handle HDR Handler
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet	URI
Timing.code	extensible	EHDSIEventTimingCombination http://fhir.ehdsi.eu/hdr/ValueSet/eHDSIEventTimingCombination from this IG

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()

Differential View

This structure is derived from Timing

Name	Flags	Card.	Type	Description & Constraints
Timing			Timing
repeat
duration	O	0..1	decimal	Duration of the treatment Obligations Actor SHALL:handle HDR Handler
frequency	O	0..1	positiveInt	Frequency times per period Obligations Actor SHALL:handle HDR Handler
period	O	0..1	decimal	Duration of time over which repetitions are to occur Obligations Actor SHALL:handle HDR Handler
periodUnit	O	0..1	code	Unit of the period (e.g. day) Obligations Actor SHALL:handle HDR Handler
code	O	0..1	CodeableConcept	BID | TID | QID | AM | PM | QD | QOD | + Binding: eHDSI Event Timing Combination (extensible) Obligations Actor SHALL:handle HDR Handler
Documentation for this format

Terminology Bindings (Differential)

Path	Conformance	ValueSet	URI
Timing.code	extensible	EHDSIEventTimingCombination http://fhir.ehdsi.eu/hdr/ValueSet/eHDSIEventTimingCombination from this IG

Snapshot View

Name	Flags	Card.	Type	Description & Constraints
Timing		0..*	Timing	A timing schedule that specifies an event that may occur multiple times
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 tim-1: if there's a duration, there needs to be duration units tim-2: if there's a period, there needs to be period units tim-4: duration SHALL be a non-negative value tim-5: period SHALL be a non-negative value tim-6: If there's a periodMax, there must be a period tim-7: If there's a durationMax, there must be a duration tim-8: If there's a countMax, there must be a count tim-9: If there's an offset, there must be a when (and not C, CM, CD, CV) tim-10: If there's a timeOfDay, there cannot be a when, or vice versa
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]	Σ	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	OΣ	0..1	decimal	Duration of the treatment Obligations Actor SHALL:handle HDR Handler
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	OΣ	0..1	positiveInt	Frequency times per period Obligations Actor SHALL:handle HDR Handler
frequencyMax	Σ	0..1	positiveInt	Event occurs up to frequencyMax times per period
period	OΣ	0..1	decimal	Duration of time over which repetitions are to occur Obligations Actor SHALL:handle HDR Handler
periodMax	Σ	0..1	decimal	Upper limit of period (3-4 hours)
periodUnit	OΣ	0..1	code	Unit of the period (e.g. day) Binding: UnitsOfTime (required): A unit of time (units from UCUM). Obligations Actor SHALL:handle HDR Handler
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	OΣ	0..1	CodeableConcept	BID | TID | QID | AM | PM | QD | QOD | + Binding: eHDSI Event Timing Combination (extensible) Obligations Actor SHALL:handle HDR Handler
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet	URI
Timing.repeat.durationUnit	required	UnitsOfTime http://hl7.org/fhir/ValueSet/units-of-time|4.0.1 from the FHIR Standard
Timing.repeat.periodUnit	required	UnitsOfTime http://hl7.org/fhir/ValueSet/units-of-time|4.0.1 from the FHIR Standard
Timing.repeat.dayOfWeek	required	DaysOfWeek http://hl7.org/fhir/ValueSet/days-of-week|4.0.1 from the FHIR Standard
Timing.repeat.when	required	EventTiming http://hl7.org/fhir/ValueSet/event-timing|4.0.1 from the FHIR Standard
Timing.code	extensible	EHDSIEventTimingCombination http://fhir.ehdsi.eu/hdr/ValueSet/eHDSIEventTimingCombination from this IG

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()
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 a when, or vice versa : timeOfDay.empty() or when.empty()

This structure is derived from Timing

Summary

Maturity: 1

Other representations of profile: CSV, Excel, Schematron