Skip to main content

HS.FHIR.vSTU3.Model.Base.Timing.Repeat

deprecated class HS.FHIR.vSTU3.Model.Base.Timing.Repeat extends HS.FHIR.vSTU3.Model.Base.Element

THIS DATA OBJECT MODEL CLASS IS DEPRECATED - Use %DynamicObject or HS.FHIRObject.* instead.
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.
If the element is present, it must have a value for at least one of the defined elements, an @id referenced from the Narrative, or extensions

Property Inventory

Method Inventory

Parameters

parameter ELEMENTQUALIFIED = 1;
Inherited description: ELEMENTQUALIFIED controls the format of exported XML. The ELEMENTQUALIFIED specification should be based on the elementFormDefault attribute of the schema that defines the type. To maintain compatibility, ELEMENTQUALIFIED will default to 1 (true) for literal format export and will default to 0 (false) for encoded or encoded12 format export. These were the values always previously assumed for the elementFormDefault attribute.

NOTE: Direct use of XMLExport method does not support the ELEMENTQUALIFIED. The export must be done using %XML.Writer or SOAP support.

parameter JSONTYPEFIELD;
Inherited description: Type property name for JSON export.
parameter XMLNAME = Timing.Repeat;
Inherited description: This parameter provides the default XMLNAME for the class. If it is empty then the class name will be used to construct a default XML name. The default XMLNAME is used as the top level tag when exporting objects and the export context did not provide an XML container name.
parameter XMLSEQUENCE = 1;
Inherited description: If the XMLSEQUENCE = 1, then the order of the XML elements must match the order of the class properties. This allows us to deal with XML where the same field appears multiple times and is distinguished by the order.
parameter XMLTYPE = Timing.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 boundsDuration as HS.FHIR.vSTU3.Model.Base.Duration (XMLNAME = "boundsDuration", XMLPROJECTION = "ELEMENT");
Property methods: boundsDurationGet(), boundsDurationGetSwizzled(), boundsDurationIsValid(), boundsDurationNewObject(), boundsDurationSet()
property boundsPeriod as HS.FHIR.vSTU3.Model.Base.Period (XMLNAME = "boundsPeriod", XMLPROJECTION = "ELEMENT");
Property methods: boundsPeriodGet(), boundsPeriodGetSwizzled(), boundsPeriodIsValid(), boundsPeriodNewObject(), boundsPeriodSet()
property boundsRange as HS.FHIR.vSTU3.Model.Base.Range (XMLNAME = "boundsRange", XMLPROJECTION = "ELEMENT");
Property methods: boundsRangeGet(), boundsRangeGetSwizzled(), boundsRangeIsValid(), boundsRangeNewObject(), boundsRangeSet()
property count as HS.FHIR.vSTU3.Model.Datatype.Integer (XMLNAME = "count", XMLPROJECTION = "ELEMENT");
A total count of the desired number of repetitions.
Property methods: countGet(), countGetSwizzled(), countIsValid(), countNewObject(), countSet()
property countMax as HS.FHIR.vSTU3.Model.Datatype.Integer (XMLNAME = "countMax", XMLPROJECTION = "ELEMENT");
A maximum value for the count of the desired repetitions (e.g. do something 6-8 times).
Property methods: countMaxGet(), countMaxGetSwizzled(), countMaxIsValid(), countMaxNewObject(), countMaxSet()
property dayOfWeek as list of HS.FHIR.vSTU3.Model.Datatype.Code (XMLNAME = "dayOfWeek", XMLPROJECTION = "ELEMENT");
If one or more days of week is provided, then the action happens only on the specified day(s).
Property methods: dayOfWeekBuildValueArray(), dayOfWeekCollectionToDisplay(), dayOfWeekCollectionToOdbc(), dayOfWeekDisplayToCollection(), dayOfWeekGet(), dayOfWeekGetObject(), dayOfWeekGetObjectId(), dayOfWeekGetSwizzled(), dayOfWeekIsValid(), dayOfWeekOdbcToCollection(), dayOfWeekSet(), dayOfWeekSetObject(), dayOfWeekSetObjectId()
property duration as HS.FHIR.vSTU3.Model.Datatype.Decimal (XMLNAME = "duration", XMLPROJECTION = "ELEMENT");
How long this thing happens for when it happens.
Property methods: durationGet(), durationGetSwizzled(), durationIsValid(), durationNewObject(), durationSet()
property durationMax as HS.FHIR.vSTU3.Model.Datatype.Decimal (XMLNAME = "durationMax", XMLPROJECTION = "ELEMENT");
The upper limit of how long this thing happens for when it happens.
Property methods: durationMaxGet(), durationMaxGetSwizzled(), durationMaxIsValid(), durationMaxNewObject(), durationMaxSet()
property durationUnit as HS.FHIR.vSTU3.Model.Base.UnitsOfTime (XMLNAME = "durationUnit", XMLPROJECTION = "ELEMENT");
The units of time for the duration, in UCUM units.
Property methods: durationUnitGet(), durationUnitGetSwizzled(), durationUnitIsValid(), durationUnitNewObject(), durationUnitSet()
property frequency as HS.FHIR.vSTU3.Model.Datatype.Integer (XMLNAME = "frequency", XMLPROJECTION = "ELEMENT");
The number of times to repeat the action within the specified period / period range (i.e. both period and periodMax provided).
Property methods: frequencyGet(), frequencyGetSwizzled(), frequencyIsValid(), frequencyNewObject(), frequencySet()
property frequencyMax as HS.FHIR.vSTU3.Model.Datatype.Integer (XMLNAME = "frequencyMax", XMLPROJECTION = "ELEMENT");
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: frequencyMaxGet(), frequencyMaxGetSwizzled(), frequencyMaxIsValid(), frequencyMaxNewObject(), frequencyMaxSet()
property offset as HS.FHIR.vSTU3.Model.Datatype.UnsignedInt (XMLNAME = "offset", XMLPROJECTION = "ELEMENT");
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: offsetGet(), offsetGetSwizzled(), offsetIsValid(), offsetNewObject(), offsetSet()
property period as HS.FHIR.vSTU3.Model.Datatype.Decimal (XMLNAME = "period", XMLPROJECTION = "ELEMENT");
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.
Property methods: periodGet(), periodGetSwizzled(), periodIsValid(), periodNewObject(), periodSet()
property periodMax as HS.FHIR.vSTU3.Model.Datatype.Decimal (XMLNAME = "periodMax", XMLPROJECTION = "ELEMENT");
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: periodMaxGet(), periodMaxGetSwizzled(), periodMaxIsValid(), periodMaxNewObject(), periodMaxSet()
property periodUnit as HS.FHIR.vSTU3.Model.Base.UnitsOfTime (XMLNAME = "periodUnit", XMLPROJECTION = "ELEMENT");
The units of time for the period in UCUM units.
Property methods: periodUnitGet(), periodUnitGetSwizzled(), periodUnitIsValid(), periodUnitNewObject(), periodUnitSet()
property timeOfDay as list of HS.FHIR.vSTU3.Model.Datatype.Time (XMLNAME = "timeOfDay", XMLPROJECTION = "ELEMENT");
Specified time of day for action to take place.
Property methods: timeOfDayBuildValueArray(), timeOfDayCollectionToDisplay(), timeOfDayCollectionToOdbc(), timeOfDayDisplayToCollection(), timeOfDayGet(), timeOfDayGetObject(), timeOfDayGetObjectId(), timeOfDayGetSwizzled(), timeOfDayIsValid(), timeOfDayOdbcToCollection(), timeOfDaySet(), timeOfDaySetObject(), timeOfDaySetObjectId()
property when as list of HS.FHIR.vSTU3.Model.Base.EventTiming (XMLNAME = "when", XMLPROJECTION = "ELEMENT");
Real world events that the occurrence of the event should be tied to.
Property methods: whenBuildValueArray(), whenCollectionToDisplay(), whenCollectionToOdbc(), whenDisplayToCollection(), whenGet(), whenGetObject(), whenGetObjectId(), whenGetSwizzled(), whenIsValid(), whenOdbcToCollection(), whenSet(), whenSetObject(), whenSetObjectId()

Methods

deprecated method SetBoundsPeriod(pStart As %String = "", pEnd As %String = "", pExtension As %RegisteredObject = "") as %Status
THIS DATA OBJECT MODEL CLASS IS DEPRECATED - Use %DynamicObject or HS.FHIRObject.* instead.
Set method for the "boundsPeriod" property.
deprecated method SetCount(pValue As %String = "", pExtension As %RegisteredObject = "", pId As %String = "") as %Status
THIS DATA OBJECT MODEL CLASS IS DEPRECATED - Use %DynamicObject or HS.FHIRObject.* instead.
Set method for the "count" property.
deprecated method SetCountMax(pValue As %String = "", pExtension As %RegisteredObject = "", pId As %String = "") as %Status
THIS DATA OBJECT MODEL CLASS IS DEPRECATED - Use %DynamicObject or HS.FHIRObject.* instead.
Set method for the "countMax" property.
deprecated method SetDayOfWeek(pValue As %String = "", pExtension As %RegisteredObject = "", pId As %String = "") as %Status
THIS DATA OBJECT MODEL CLASS IS DEPRECATED - Use %DynamicObject or HS.FHIRObject.* instead.
Insert method for the "dayOfWeek" property.
deprecated method SetDuration(pValue As %String = "", pExtension As %RegisteredObject = "", pId As %String = "") as %Status
THIS DATA OBJECT MODEL CLASS IS DEPRECATED - Use %DynamicObject or HS.FHIRObject.* instead.
Set method for the "duration" property.
deprecated method SetDurationMax(pValue As %String = "", pExtension As %RegisteredObject = "", pId As %String = "") as %Status
THIS DATA OBJECT MODEL CLASS IS DEPRECATED - Use %DynamicObject or HS.FHIRObject.* instead.
Set method for the "durationMax" property.
deprecated method SetDurationUnit(pValue As %String = "", pExtension As %RegisteredObject = "", pId As %String = "") as %Status
THIS DATA OBJECT MODEL CLASS IS DEPRECATED - Use %DynamicObject or HS.FHIRObject.* instead.
Set method for the "durationUnit" property.
deprecated method SetFrequency(pValue As %String = "", pExtension As %RegisteredObject = "", pId As %String = "") as %Status
THIS DATA OBJECT MODEL CLASS IS DEPRECATED - Use %DynamicObject or HS.FHIRObject.* instead.
Set method for the "frequency" property.
deprecated method SetFrequencyMax(pValue As %String = "", pExtension As %RegisteredObject = "", pId As %String = "") as %Status
THIS DATA OBJECT MODEL CLASS IS DEPRECATED - Use %DynamicObject or HS.FHIRObject.* instead.
Set method for the "frequencyMax" property.
deprecated method SetOffset(pValue As %String = "", pExtension As %RegisteredObject = "", pId As %String = "") as %Status
THIS DATA OBJECT MODEL CLASS IS DEPRECATED - Use %DynamicObject or HS.FHIRObject.* instead.
Set method for the "offset" property.
deprecated method SetPeriod(pValue As %String = "", pExtension As %RegisteredObject = "", pId As %String = "") as %Status
THIS DATA OBJECT MODEL CLASS IS DEPRECATED - Use %DynamicObject or HS.FHIRObject.* instead.
Set method for the "period" property.
deprecated method SetPeriodMax(pValue As %String = "", pExtension As %RegisteredObject = "", pId As %String = "") as %Status
THIS DATA OBJECT MODEL CLASS IS DEPRECATED - Use %DynamicObject or HS.FHIRObject.* instead.
Set method for the "periodMax" property.
deprecated method SetPeriodUnit(pValue As %String = "", pExtension As %RegisteredObject = "", pId As %String = "") as %Status
THIS DATA OBJECT MODEL CLASS IS DEPRECATED - Use %DynamicObject or HS.FHIRObject.* instead.
Set method for the "periodUnit" property.
deprecated method SetTimeOfDay(pValue As %String = "", pExtension As %RegisteredObject = "", pId As %String = "") as %Status
THIS DATA OBJECT MODEL CLASS IS DEPRECATED - Use %DynamicObject or HS.FHIRObject.* instead.
Insert method for the "timeOfDay" property.
deprecated method SetWhen(pValue As %String = "", pExtension As %RegisteredObject = "", pId As %String = "") as %Status
THIS DATA OBJECT MODEL CLASS IS DEPRECATED - Use %DynamicObject or HS.FHIRObject.* instead.
Insert method for the "when" property.

Inherited Members

Inherited Properties

Inherited Methods

FeedbackOpens in a new tab