Datatypes UML Documentation

Element

Datatypes
Class Repeat

"A set of rules that describe when the event is scheduled." - HL7 FHIR, Timing.repeat

Attributes
«CS» Code	bounds	"Either a duration for the length of the timing schedule, a range of possible length, or outer bounds for start and/or end limits of the timing schedule." - HL7 FHIR, Timing.repeat.bounds[x]
Integer	count	"A total count of the desired number of repetitions." - HL7 FHIR, Timing.repeat.count
Integer	countMax	"A maximum value for the count of the desired repetitions (e.g. do something 6-8 times)." - HL7 FHIR, Timing.repeat.countMax
«CS» Code	dayOfWeek	"If one or more days of week is provided, then the action happens only on the specified day(s)." - HL7 FHIR, Timing.repeat.dayOfWeek
«REAL» Decimal	duration	"How long this thing happens for when it happens." - HL7 FHIR, Timing.repeat.duration
«REAL» Decimal	durationMax	"The upper limit of how long this thing happens for when it happens." - HL7 FHIR, Timing.repeat.durationMax
«CS» Code	durationUnit	"The units of time for the duration, in UCUM units." - HL7 FHIR, Timing.repeat.durationUnit
Integer	frequency	"The number of times to repeat the action within the specified period / period range (i.e. both period and periodMax provided)." - HL7 FHIR, Timing.repeat.frequency
Integer	frequencyMax	"If present, indicates that the frequency is a range - so to repeat between [frequency] and [frequencyMax] times within the period or period range." - HL7 FHIR, Timing.repeat.frequencyMax
Integer	offset	"The number of minutes from the event. If the event code does not indicate whether the minutes is before or after the event, then the offset is assumed to be after the event." - HL7 FHIR, Timing.repeat.offset
«REAL» Decimal	period	"Indicates the duration of time over which repetitions are to occur; e.g. to express "3 times per day", 3 would be the frequency and "1 day" would be the period." - HL7 FHIR, Timing.repeat.period
«REAL» Decimal	periodMax	"If present, indicates that the period is a range from [period] to [periodMax], allowing expressing concepts such as "do this once every 3-5 days." - HL7 FHIR, Timing.repeat.periodMax
«CS» Code	periodUnit	"The units of time for the period in UCUM units." - HL7 FHIR, Timing.repeat.periodUnit
String	timeOfDay	"Specified time of day for action to take place." - HL7 FHIR, Timing.repeat.timeOfDay Note that FHIR uses a Time datatime, FHIM uses a string for now
«CS» Code	when	"Real world events that the occurrence of the event should be tied to." - HL7 FHIR, Timing.repeat.when

Properties:

Alias
Classifier Behavior
Is Abstract	false
Is Active	false
Is Leaf	false
Keywords
Name	Repeat
Name Expression
Namespace	Datatypes
Owned Template Signature
Owner	Datatypes
Owning Template Parameter
Package	Datatypes
Qualified Name	FHIM::Datatypes::Repeat
Representation
Stereotype
Template Parameter
Visibility	Public

Attribute Details

bounds

Public «CS» Code bounds

"Either a duration for the length of the timing schedule, a range of possible length, or outer bounds for start and/or end limits of the timing schedule." - HL7 FHIR, Timing.repeat.bounds[x]

Constraints:

Properties:

Aggregation	None
Alias
Association
Association End
Class	Repeat
Datatype
Default
Default Value
Is Composite	false
Is Derived	false
Is Derived Union	false
Is Leaf	false
Is Ordered	false
Is Read Only	false
Is Static	false
Is Unique	true
Keywords
Lower	0
Lower Value	(0)
Multiplicity	0..1
Name	bounds
Name Expression
Namespace	Repeat
Opposite
Owner	Repeat
Owning Association
Owning Template Parameter
Qualified Name	FHIM::Datatypes::Repeat::bounds
Stereotype
Template Parameter
Type	«CS» Code
Upper	1
Upper Value	(1)
Visibility	Public

count

Public Integer count

"A total count of the desired number of repetitions." - HL7 FHIR, Timing.repeat.count

Constraints:

Properties:

Aggregation	None
Alias
Association
Association End
Class	Repeat
Datatype
Default
Default Value
Is Composite	false
Is Derived	false
Is Derived Union	false
Is Leaf	false
Is Ordered	false
Is Read Only	false
Is Static	false
Is Unique	true
Keywords
Lower	0
Lower Value	(0)
Multiplicity	0..1
Name	count
Name Expression
Namespace	Repeat
Opposite
Owner	Repeat
Owning Association
Owning Template Parameter
Qualified Name	FHIM::Datatypes::Repeat::count
Stereotype
Template Parameter
Type	Integer
Upper	1
Upper Value	(1)
Visibility	Public

countMax

Public Integer countMax

"A maximum value for the count of the desired repetitions (e.g. do something 6-8 times)." - HL7 FHIR, Timing.repeat.countMax

Constraints:

Properties:

Aggregation	None
Alias
Association
Association End
Class	Repeat
Datatype
Default
Default Value
Is Composite	false
Is Derived	false
Is Derived Union	false
Is Leaf	false
Is Ordered	false
Is Read Only	false
Is Static	false
Is Unique	true
Keywords
Lower	0
Lower Value	(0)
Multiplicity	0..1
Name	countMax
Name Expression
Namespace	Repeat
Opposite
Owner	Repeat
Owning Association
Owning Template Parameter
Qualified Name	FHIM::Datatypes::Repeat::countMax
Stereotype
Template Parameter
Type	Integer
Upper	1
Upper Value	(1)
Visibility	Public

dayOfWeek

Public «CS» Code dayOfWeek

"If one or more days of week is provided, then the action happens only on the specified day(s)." - HL7 FHIR, Timing.repeat.dayOfWeek

Constraints:

Properties:

Aggregation	None
Alias
Association
Association End
Class	Repeat
Datatype
Default
Default Value
Is Composite	false
Is Derived	false
Is Derived Union	false
Is Leaf	false
Is Ordered	false
Is Read Only	false
Is Static	false
Is Unique	true
Keywords
Lower	0
Lower Value	(0)
Multiplicity	*
Name	dayOfWeek
Name Expression
Namespace	Repeat
Opposite
Owner	Repeat
Owning Association
Owning Template Parameter
Qualified Name	FHIM::Datatypes::Repeat::dayOfWeek
Stereotype
Template Parameter
Type	«CS» Code
Upper	*
Upper Value	(*)
Visibility	Public

duration

Public «REAL» Decimal duration

"How long this thing happens for when it happens." - HL7 FHIR, Timing.repeat.duration

Constraints:

Properties:

Aggregation	None
Alias
Association
Association End
Class	Repeat
Datatype
Default
Default Value
Is Composite	false
Is Derived	false
Is Derived Union	false
Is Leaf	false
Is Ordered	false
Is Read Only	false
Is Static	false
Is Unique	true
Keywords
Lower	0
Lower Value	(0)
Multiplicity	0..1
Name	duration
Name Expression
Namespace	Repeat
Opposite
Owner	Repeat
Owning Association
Owning Template Parameter
Qualified Name	FHIM::Datatypes::Repeat::duration
Stereotype
Template Parameter
Type	«REAL» Decimal
Upper	1
Upper Value	(1)
Visibility	Public

durationMax

Public «REAL» Decimal durationMax

"The upper limit of how long this thing happens for when it happens." - HL7 FHIR, Timing.repeat.durationMax

Constraints:

Properties:

Aggregation	None
Alias
Association
Association End
Class	Repeat
Datatype
Default
Default Value
Is Composite	false
Is Derived	false
Is Derived Union	false
Is Leaf	false
Is Ordered	false
Is Read Only	false
Is Static	false
Is Unique	true
Keywords
Lower	0
Lower Value	(0)
Multiplicity	0..1
Name	durationMax
Name Expression
Namespace	Repeat
Opposite
Owner	Repeat
Owning Association
Owning Template Parameter
Qualified Name	FHIM::Datatypes::Repeat::durationMax
Stereotype
Template Parameter
Type	«REAL» Decimal
Upper	1
Upper Value	(1)
Visibility	Public

durationUnit

Public «CS» Code durationUnit

"The units of time for the duration, in UCUM units." - HL7 FHIR, Timing.repeat.durationUnit

Constraints:

Properties:

Aggregation	None
Alias
Association
Association End
Class	Repeat
Datatype
Default
Default Value
Is Composite	false
Is Derived	false
Is Derived Union	false
Is Leaf	false
Is Ordered	false
Is Read Only	false
Is Static	false
Is Unique	true
Keywords
Lower	0
Lower Value	(0)
Multiplicity	0..1
Name	durationUnit
Name Expression
Namespace	Repeat
Opposite
Owner	Repeat
Owning Association
Owning Template Parameter
Qualified Name	FHIM::Datatypes::Repeat::durationUnit
Stereotype
Template Parameter
Type	«CS» Code
Upper	1
Upper Value	(1)
Visibility	Public

frequency

Public Integer frequency

"The number of times to repeat the action within the specified period / period range (i.e. both period and periodMax provided)." - HL7 FHIR, Timing.repeat.frequency

Constraints:

Properties:

Aggregation	None
Alias
Association
Association End
Class	Repeat
Datatype
Default
Default Value
Is Composite	false
Is Derived	false
Is Derived Union	false
Is Leaf	false
Is Ordered	false
Is Read Only	false
Is Static	false
Is Unique	true
Keywords
Lower	0
Lower Value	(0)
Multiplicity	0..1
Name	frequency
Name Expression
Namespace	Repeat
Opposite
Owner	Repeat
Owning Association
Owning Template Parameter
Qualified Name	FHIM::Datatypes::Repeat::frequency
Stereotype
Template Parameter
Type	Integer
Upper	1
Upper Value	(1)
Visibility	Public

frequencyMax

Public Integer frequencyMax

"If present, indicates that the frequency is a range - so to repeat between [frequency] and [frequencyMax] times within the period or period range." - HL7 FHIR, Timing.repeat.frequencyMax

Constraints:

Properties:

Aggregation	None
Alias
Association
Association End
Class	Repeat
Datatype
Default
Default Value
Is Composite	false
Is Derived	false
Is Derived Union	false
Is Leaf	false
Is Ordered	false
Is Read Only	false
Is Static	false
Is Unique	true
Keywords
Lower	0
Lower Value	(0)
Multiplicity	0..1
Name	frequencyMax
Name Expression
Namespace	Repeat
Opposite
Owner	Repeat
Owning Association
Owning Template Parameter
Qualified Name	FHIM::Datatypes::Repeat::frequencyMax
Stereotype
Template Parameter
Type	Integer
Upper	1
Upper Value	(1)
Visibility	Public

offset

Public Integer offset

"The number of minutes from the event. If the event code does not indicate whether the minutes is before or after the event, then the offset is assumed to be after the event." - HL7 FHIR, Timing.repeat.offset

Constraints:

Properties:

Aggregation	None
Alias
Association
Association End
Class	Repeat
Datatype
Default
Default Value
Is Composite	false
Is Derived	false
Is Derived Union	false
Is Leaf	false
Is Ordered	false
Is Read Only	false
Is Static	false
Is Unique	true
Keywords
Lower	0
Lower Value	(0)
Multiplicity	0..1
Name	offset
Name Expression
Namespace	Repeat
Opposite
Owner	Repeat
Owning Association
Owning Template Parameter
Qualified Name	FHIM::Datatypes::Repeat::offset
Stereotype
Template Parameter
Type	Integer
Upper	1
Upper Value	(1)
Visibility	Public

period

Public «REAL» Decimal period

"Indicates the duration of time over which repetitions are to occur; e.g. to express "3 times per day", 3 would be the frequency and "1 day" would be the period." - HL7 FHIR, Timing.repeat.period

Constraints:

Properties:

Aggregation	None
Alias
Association
Association End
Class	Repeat
Datatype
Default
Default Value
Is Composite	false
Is Derived	false
Is Derived Union	false
Is Leaf	false
Is Ordered	false
Is Read Only	false
Is Static	false
Is Unique	true
Keywords
Lower	0
Lower Value	(0)
Multiplicity	0..1
Name	period
Name Expression
Namespace	Repeat
Opposite
Owner	Repeat
Owning Association
Owning Template Parameter
Qualified Name	FHIM::Datatypes::Repeat::period
Stereotype
Template Parameter
Type	«REAL» Decimal
Upper	1
Upper Value	(1)
Visibility	Public

periodMax

Public «REAL» Decimal periodMax

"If present, indicates that the period is a range from [period] to [periodMax], allowing expressing concepts such as "do this once every 3-5 days." - HL7 FHIR, Timing.repeat.periodMax

Constraints:

Properties:

Aggregation	None
Alias
Association
Association End
Class	Repeat
Datatype
Default
Default Value
Is Composite	false
Is Derived	false
Is Derived Union	false
Is Leaf	false
Is Ordered	false
Is Read Only	false
Is Static	false
Is Unique	true
Keywords
Lower	0
Lower Value	(0)
Multiplicity	0..1
Name	periodMax
Name Expression
Namespace	Repeat
Opposite
Owner	Repeat
Owning Association
Owning Template Parameter
Qualified Name	FHIM::Datatypes::Repeat::periodMax
Stereotype
Template Parameter
Type	«REAL» Decimal
Upper	1
Upper Value	(1)
Visibility	Public

periodUnit

Public «CS» Code periodUnit

"The units of time for the period in UCUM units." - HL7 FHIR, Timing.repeat.periodUnit

Constraints:

Properties:

Aggregation	None
Alias
Association
Association End
Class	Repeat
Datatype
Default
Default Value
Is Composite	false
Is Derived	false
Is Derived Union	false
Is Leaf	false
Is Ordered	false
Is Read Only	false
Is Static	false
Is Unique	true
Keywords
Lower	0
Lower Value	(0)
Multiplicity	0..1
Name	periodUnit
Name Expression
Namespace	Repeat
Opposite
Owner	Repeat
Owning Association
Owning Template Parameter
Qualified Name	FHIM::Datatypes::Repeat::periodUnit
Stereotype
Template Parameter
Type	«CS» Code
Upper	1
Upper Value	(1)
Visibility	Public

timeOfDay

Public String timeOfDay

"Specified time of day for action to take place." - HL7 FHIR, Timing.repeat.timeOfDay
Note that FHIR uses a Time datatime, FHIM uses a string for now

Constraints:

Properties:

Aggregation	None
Alias
Association
Association End
Class	Repeat
Datatype
Default
Default Value
Is Composite	false
Is Derived	false
Is Derived Union	false
Is Leaf	false
Is Ordered	false
Is Read Only	false
Is Static	false
Is Unique	true
Keywords
Lower	0
Lower Value	(0)
Multiplicity	*
Name	timeOfDay
Name Expression
Namespace	Repeat
Opposite
Owner	Repeat
Owning Association
Owning Template Parameter
Qualified Name	FHIM::Datatypes::Repeat::timeOfDay
Stereotype
Template Parameter
Type	String
Upper	*
Upper Value	(*)
Visibility	Public

when

Public «CS» Code when

"Real world events that the occurrence of the event should be tied to." - HL7 FHIR, Timing.repeat.when

Constraints:

Properties:

Aggregation	None
Alias
Association
Association End
Class	Repeat
Datatype
Default
Default Value
Is Composite	false
Is Derived	false
Is Derived Union	false
Is Leaf	false
Is Ordered	false
Is Read Only	false
Is Static	false
Is Unique	true
Keywords
Lower	0
Lower Value	(0)
Multiplicity	*
Name	when
Name Expression
Namespace	Repeat
Opposite
Owner	Repeat
Owning Association
Owning Template Parameter
Qualified Name	FHIM::Datatypes::Repeat::when
Stereotype
Template Parameter
Type	«CS» Code
Upper	*
Upper Value	(*)
Visibility	Public

Overview

Top

Package

Element

Datatypes UML Documentation

Summary:AttributesProperties

Detail:Attributes