Skip to main content

HS.FHIRModel.R4.TimingX.Repeat

class HS.FHIRModel.R4.TimingX.Repeat extends HS.FHIRModel.FHIRClassSuper

*****************************************
** TimingX.Repeat generated class schema
*****************************************
Specifies an event that may occur multiple times. Timing schedules are used to record when things are planned, expected or requested to occur. The most common usage is in dosage instructions for medications. They are also used when planning care of various kinds, and may be used for reporting the schedule to which past regular activities were carried out.

Property Inventory

Method Inventory

Parameters

parameter XMLTYPE = R4_TIMINGX_REPEAT;
Inherited description: This parameter provides the default XMLTYPE for the class. If it is empty then the class name will be used to construct a default XML type.

The default XMLTYPE is used when naming and referencing this type in a schema and the schema context did not provide an XML type name.

Properties

property _count as HS.FHIRModel.R4.Element;
Extensions for count
Property methods: _countGet(), _countGetSwizzled(), _countIsValid(), _countNewObject(), _countSet()
property _countMax as HS.FHIRModel.R4.Element;
Extensions for countMax
Property methods: _countMaxGet(), _countMaxGetSwizzled(), _countMaxIsValid(), _countMaxNewObject(), _countMaxSet()
property _dayOfWeek as HS.FHIRModel.R4.SeqOfElement;
Extensions for dayOfWeek
Property methods: _dayOfWeekGet(), _dayOfWeekGetSwizzled(), _dayOfWeekIsValid(), _dayOfWeekNewObject(), _dayOfWeekSet()
property _duration as HS.FHIRModel.R4.Element;
Extensions for duration
Property methods: _durationGet(), _durationGetSwizzled(), _durationIsValid(), _durationNewObject(), _durationSet()
property _durationMax as HS.FHIRModel.R4.Element;
Extensions for durationMax
Property methods: _durationMaxGet(), _durationMaxGetSwizzled(), _durationMaxIsValid(), _durationMaxNewObject(), _durationMaxSet()
property _durationUnit as HS.FHIRModel.R4.Element;
Extensions for durationUnit
Property methods: _durationUnitGet(), _durationUnitGetSwizzled(), _durationUnitIsValid(), _durationUnitNewObject(), _durationUnitSet()
property _frequency as HS.FHIRModel.R4.Element;
Extensions for frequency
Property methods: _frequencyGet(), _frequencyGetSwizzled(), _frequencyIsValid(), _frequencyNewObject(), _frequencySet()
property _frequencyMax as HS.FHIRModel.R4.Element;
Extensions for frequencyMax
Property methods: _frequencyMaxGet(), _frequencyMaxGetSwizzled(), _frequencyMaxIsValid(), _frequencyMaxNewObject(), _frequencyMaxSet()
property _offset as HS.FHIRModel.R4.Element;
Extensions for offset
Property methods: _offsetGet(), _offsetGetSwizzled(), _offsetIsValid(), _offsetNewObject(), _offsetSet()
property _period as HS.FHIRModel.R4.Element;
Extensions for period
Property methods: _periodGet(), _periodGetSwizzled(), _periodIsValid(), _periodNewObject(), _periodSet()
property _periodMax as HS.FHIRModel.R4.Element;
Extensions for periodMax
Property methods: _periodMaxGet(), _periodMaxGetSwizzled(), _periodMaxIsValid(), _periodMaxNewObject(), _periodMaxSet()
property _periodUnit as HS.FHIRModel.R4.Element;
Extensions for periodUnit
Property methods: _periodUnitGet(), _periodUnitGetSwizzled(), _periodUnitIsValid(), _periodUnitNewObject(), _periodUnitSet()
property _timeOfDay as HS.FHIRModel.R4.SeqOfElement;
Extensions for timeOfDay
Property methods: _timeOfDayGet(), _timeOfDayGetSwizzled(), _timeOfDayIsValid(), _timeOfDayNewObject(), _timeOfDaySet()
property _when as HS.FHIRModel.R4.SeqOfElement;
Extensions for when
Property methods: _whenGet(), _whenGetSwizzled(), _whenIsValid(), _whenNewObject(), _whenSet()
property boundsDuration as HS.FHIRModel.R4.Duration;
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.
Property methods: boundsDurationGet(), boundsDurationGetSwizzled(), boundsDurationIsValid(), boundsDurationNewObject(), boundsDurationSet()
property boundsPeriod as HS.FHIRModel.R4.Period;
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.
Property methods: boundsPeriodGet(), boundsPeriodGetSwizzled(), boundsPeriodIsValid(), boundsPeriodNewObject(), boundsPeriodSet()
property boundsRange as HS.FHIRModel.R4.Range;
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.
Property methods: boundsRangeGet(), boundsRangeGetSwizzled(), boundsRangeIsValid(), boundsRangeNewObject(), boundsRangeSet()
property count as %Integer;
A total count of the desired number of repetitions across the duration of the entire timing specification. If countMax is present, this element indicates the lower bound of the allowed range of count values.
Property methods: countDisplayToLogical(), countGet(), countIsValid(), countLogicalToDisplay(), countNormalize(), countSet(), countXSDToLogical()
property countMax as %Integer;
If present, indicates that the count is a range - so to perform the action between [count] and [countMax] times.
Property methods: countMaxDisplayToLogical(), countMaxGet(), countMaxIsValid(), countMaxLogicalToDisplay(), countMaxNormalize(), countMaxSet(), countMaxXSDToLogical()
property dayOfWeek as HS.FHIRModel.R4.SeqOfString;
If one or more days of week is provided, then the action happens only on the specified day(s).
Property methods: dayOfWeekGet(), dayOfWeekGetSwizzled(), dayOfWeekIsValid(), dayOfWeekNewObject(), dayOfWeekSet()
property duration as %Integer;
How long this thing happens for when it happens. If durationMax is present, this element indicates the lower bound of the allowed range of the duration.
Property methods: durationDisplayToLogical(), durationGet(), durationIsValid(), durationLogicalToDisplay(), durationNormalize(), durationSet(), durationXSDToLogical()
property durationMax as %Integer;
If present, indicates that the duration is a range - so to perform the action between [duration] and [durationMax] time length.
Property methods: durationMaxDisplayToLogical(), durationMaxGet(), durationMaxIsValid(), durationMaxLogicalToDisplay(), durationMaxNormalize(), durationMaxSet(), durationMaxXSDToLogical()
property durationUnit as %String (VALUELIST = ",s,min,h,d,wk,mo,a");
The units of time for the duration, in UCUM units.
Property methods: durationUnitDisplayToLogical(), durationUnitGet(), durationUnitIsValid(), durationUnitLogicalToDisplay(), durationUnitLogicalToOdbc(), durationUnitNormalize(), durationUnitSet()
property extension as HS.FHIRModel.R4.SeqOfExtension;
May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
Property methods: extensionGet(), extensionGetSwizzled(), extensionIsValid(), extensionNewObject(), extensionSet()
property fhirID as %String;
Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Property methods: fhirIDDisplayToLogical(), fhirIDGet(), fhirIDIsValid(), fhirIDLogicalToDisplay(), fhirIDLogicalToOdbc(), fhirIDNormalize(), fhirIDSet()
property frequency as %Integer;
The number of times to repeat the action within the specified period. If frequencyMax is present, this element indicates the lower bound of the allowed range of the frequency.
Property methods: frequencyDisplayToLogical(), frequencyGet(), frequencyIsValid(), frequencyLogicalToDisplay(), frequencyNormalize(), frequencySet(), frequencyXSDToLogical()
property frequencyMax as %Integer;
If present, indicates that the frequency is a range - so to repeat between [frequency] and [frequencyMax] times within the period or period range.
Property methods: frequencyMaxDisplayToLogical(), frequencyMaxGet(), frequencyMaxIsValid(), frequencyMaxLogicalToDisplay(), frequencyMaxNormalize(), frequencyMaxSet(), frequencyMaxXSDToLogical()
property modifierExtension as HS.FHIRModel.R4.SeqOfExtension;
May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
Property methods: modifierExtensionGet(), modifierExtensionGetSwizzled(), modifierExtensionIsValid(), modifierExtensionNewObject(), modifierExtensionSet()
property offset as %Integer;
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.
Property methods: offsetDisplayToLogical(), offsetGet(), offsetIsValid(), offsetLogicalToDisplay(), offsetNormalize(), offsetSet(), offsetXSDToLogical()
property period as %Integer;
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. If periodMax is present, this element indicates the lower bound of the allowed range of the period length.
Property methods: periodDisplayToLogical(), periodGet(), periodIsValid(), periodLogicalToDisplay(), periodNormalize(), periodSet(), periodXSDToLogical()
property periodMax as %Integer;
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.
Property methods: periodMaxDisplayToLogical(), periodMaxGet(), periodMaxIsValid(), periodMaxLogicalToDisplay(), periodMaxNormalize(), periodMaxSet(), periodMaxXSDToLogical()
property periodUnit as %String (VALUELIST = ",s,min,h,d,wk,mo,a");
The units of time for the period in UCUM units.
Property methods: periodUnitDisplayToLogical(), periodUnitGet(), periodUnitIsValid(), periodUnitLogicalToDisplay(), periodUnitLogicalToOdbc(), periodUnitNormalize(), periodUnitSet()
property timeOfDay as HS.FHIRModel.R4.SeqOfString;
Specified time of day for action to take place.
Property methods: timeOfDayGet(), timeOfDayGetSwizzled(), timeOfDayIsValid(), timeOfDayNewObject(), timeOfDaySet()
property when as %String (VALUELIST = ",MORN,MORN.early,MORN.late,NOON,AFT,AFT.early,AFT.late,EVE,EVE.early,EVE.late,NIGHT,PHS,HS,WAKE,C,CM,CD,CV,AC,ACM,ACD,ACV,PC,PCM,PCD,PCV");
An approximate time period during the day, potentially linked to an event of daily living that indicates when the action should occur.
Property methods: whenDisplayToLogical(), whenGet(), whenIsValid(), whenLogicalToDisplay(), whenLogicalToOdbc(), whenNormalize(), whenSet()

Methods

method IncludeBoundsDuration()
method IncludeBoundsPeriod()
method IncludeBoundsRange()
method IncludeDayOfWeek()
method IncludeExtension()
method IncludeModifierExtension()
method IncludeTimeOfDay()
method _getProperties() as %DynamicArray
Inherited description: Return an array of the defined properties of this class in the definition order that they were discovered in the the HL7FHIR JSchema document
method toDao() as %DynamicAbstractObject
Inherited description: >

The toDao() method casts the set to a DAO.

Inherited Members

Inherited Methods

FeedbackOpens in a new tab