Data Model Libraries
    Preparing search index...

    Class TimingRepeatComponent

    TimingRepeatComponent Class

    FHIR Specification

    • Short: When the event is to occur
    • Definition: A set of rules that describe when the event is scheduled.
    • Requirements: Many timing schedules are determined by regular repetitions.

    FHIR Timing

    Hierarchy (View Summary)

    Implements

    Index

    Constructors

    constructor

    Properties

    bounds? count? countMax? duration? durationMax? durationUnit? frequency? frequencyMax? period? periodMax? periodUnit? daysOfWeekEnum dayOfWeek? timeOfDay? when? offset?

    Methods

    parse getBounds setBounds hasBounds getBoundsDuration hasBoundsDuration getBoundsRange hasBoundsRange getBoundsPeriod hasBoundsPeriod getCountElement setCountElement hasCountElement getCount setCount hasCount getCountMaxElement setCountMaxElement hasCountMaxElement getCountMax setCountMax hasCountMax getDurationElement setDurationElement hasDurationElement getDuration setDuration hasDuration getDurationMaxElement setDurationMaxElement hasDurationMaxElement getDurationMax setDurationMax hasDurationMax getDurationUnitElement setDurationUnitElement hasDurationUnitElement getDurationUnit setDurationUnit hasDurationUnit getFrequencyElement setFrequencyElement hasFrequencyElement getFrequency setFrequency hasFrequency getFrequencyMaxElement setFrequencyMaxElement hasFrequencyMaxElement getFrequencyMax setFrequencyMax hasFrequencyMax getPeriodElement setPeriodElement hasPeriodElement getPeriod setPeriod hasPeriod getPeriodMaxElement setPeriodMaxElement hasPeriodMaxElement getPeriodMax setPeriodMax hasPeriodMax getPeriodUnitElement setPeriodUnitElement hasPeriodUnitElement getPeriodUnit setPeriodUnit hasPeriodUnit getDayOfWeekEnumType setDayOfWeekEnumType addDayOfWeekEnumType hasDayOfWeekEnumType getDayOfWeekElement setDayOfWeekElement addDayOfWeekElement hasDayOfWeekElement getDayOfWeek setDayOfWeek addDayOfWeek hasDayOfWeek getTimeOfDayElement setTimeOfDayElement addTimeOfDayElement hasTimeOfDayElement getTimeOfDay setTimeOfDay addTimeOfDay hasTimeOfDay getWhenElement setWhenElement addWhenElement hasWhenElement getWhen setWhen addWhen hasWhen getOffsetElement setOffsetElement hasOffsetElement getOffset setOffset hasOffset fhirType isEmpty copy dataTypeName toJSON isDataType getId setId hasId getExtension setExtension hasExtension getExtensionByUrl addExtension removeExtension isRequiredFieldsEmpty isResource isComplexDataType isPrimitive isBooleanPrimitive isStringPrimitive isNumberPrimitive isBigIntPrimitive isDateTimePrimitive copyValues initDayOfWeek initTimeOfDay initWhen

    Constructors

    Properties

    bounds?: IDataType

    Timing.repeat.bounds[x] Element

    @ChoiceDataTypesMeta('Timing.repeat.bounds[x]', ['Duration','Range','Period',]

    FHIR Specification

    • Short: Length/Range of lengths, or (Start and/or end) limits
    • Definition: 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.
    • FHIR Types: 'Duration', 'Range', 'Period',
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: true
    count?: PositiveIntType

    Timing.repeat.count Element

    FHIR Specification

    • Short: Number of times to repeat
    • Definition: 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.
    • Comment: If you have both bounds and count, then this should be understood as within the bounds period, until count times happens.
    • Requirements: Repetitions may be limited by end time or total occurrences.
    • FHIR Type: positiveInt
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: true
    countMax?: PositiveIntType

    Timing.repeat.countMax Element

    FHIR Specification

    • Short: Maximum number of times to repeat
    • Definition: If present, indicates that the count is a range - so to perform the action between [count] and [countMax] times.
    • FHIR Type: positiveInt
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: true
    duration?: DecimalType

    Timing.repeat.duration Element

    FHIR Specification

    • Short: How long when it happens
    • Definition: 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.
    • Comment: For some events the duration is part of the definition of the event (e.g. IV infusions, where the duration is implicit in the specified quantity and rate). For others, it's part of the timing specification (e.g. exercise).
    • Requirements: Some activities are not instantaneous and need to be maintained for a period of time.
    • FHIR Type: decimal
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: true
    durationMax?: DecimalType

    Timing.repeat.durationMax Element

    FHIR Specification

    • Short: How long when it happens (Max)
    • Definition: If present, indicates that the duration is a range - so to perform the action between [duration] and [durationMax] time length.
    • Comment: For some events the duration is part of the definition of the event (e.g. IV infusions, where the duration is implicit in the specified quantity and rate). For others, it's part of the timing specification (e.g. exercise).
    • Requirements: Some activities are not instantaneous and need to be maintained for a period of time.
    • FHIR Type: decimal
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: true
    durationUnit?: CodeType

    Timing.repeat.durationUnit Element

    FHIR Specification

    • Short: s | min | h | d | wk | mo | a - unit of time (UCUM)
    • Definition: The units of time for the duration, in UCUM units Normal practice is to use the 'mo' code as a calendar month when calculating the next occurrence.
    • FHIR Type: code
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: true
    frequency?: PositiveIntType

    Timing.repeat.frequency Element

    FHIR Specification

    • Short: Indicates the number of repetitions that should occur within a period. I.e. Event occurs frequency times per period
    • Definition: 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.
    • FHIR Type: positiveInt
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: true
    frequencyMax?: PositiveIntType

    Timing.repeat.frequencyMax Element

    FHIR Specification

    • Short: Event occurs up to frequencyMax times per period
    • Definition: If present, indicates that the frequency is a range - so to repeat between [frequency] and [frequencyMax] times within the period or period range.
    • FHIR Type: positiveInt
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: true
    period?: DecimalType

    Timing.repeat.period Element

    FHIR Specification

    • Short: The duration to which the frequency applies. I.e. Event occurs frequency times per period
    • Definition: 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.
    • FHIR Type: decimal
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: true
    periodMax?: DecimalType

    Timing.repeat.periodMax Element

    FHIR Specification

    • Short: Upper limit of period (3-4 hours)
    • Definition: 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.
    • FHIR Type: decimal
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: true
    periodUnit?: CodeType

    Timing.repeat.periodUnit Element

    FHIR Specification

    • Short: s | min | h | d | wk | mo | a - unit of time (UCUM)
    • Definition: The units of time for the period in UCUM units Normal practice is to use the 'mo' code as a calendar month when calculating the next occurrence.
    • FHIR Type: code
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: true
    daysOfWeekEnum: DaysOfWeekEnum

    FHIR CodeSystem: DaysOfWeek

    DaysOfWeekEnum

    dayOfWeek?: EnumCodeType[]

    Timing.repeat.dayOfWeek Element

    FHIR Specification

    • Short: mon | tue | wed | thu | fri | sat | sun
    • Definition: If one or more days of week is provided, then the action happens only on the specified day(s).
    • Comment: If no days are specified, the action is assumed to happen every day as otherwise specified.
    • FHIR Type: code
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: true

    CodeSystem Enumeration: DaysOfWeekEnum

    timeOfDay?: TimeType[]

    Timing.repeat.timeOfDay Element

    FHIR Specification

    • Short: Time of day for action
    • Definition: Specified time of day for action to take place.
    • Comment: When time of day is specified, it is inferred that the action happens every day (as filtered by dayofWeek) on the specified times. If there's a timeOfDay, there cannot be a when, or vice versa.
    • FHIR Type: time
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: true
    when?: CodeType[]

    Timing.repeat.when Element

    FHIR Specification

    • Short: Code for time period of occurrence
    • Definition: An approximate time period during the day, potentially linked to an event of daily living that indicates when the action should occur.
    • Comment: When more than one event is listed, the event is tied to the union of the specified events.
    • Requirements: Timings are frequently determined by occurrences such as waking, eating and sleep.
    • FHIR Type: code
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: true
    offset?: UnsignedIntType

    Timing.repeat.offset Element

    FHIR Specification

    • Short: Minutes from event (before or after)
    • Definition: 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.
    • FHIR Type: unsignedInt
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: true

    Methods

    • Parse the provided TimingRepeatComponent JSON to instantiate the TimingRepeatComponent data model.

      Parameters

      • sourceJson: Value

        JSON representing FHIR TimingRepeatComponent

      • OptionaloptSourceField: string

        Optional data source field (e.g. <complexTypeName>.<complexTypeFieldName>); defaults to TimingRepeatComponent

      Returns undefined | TimingRepeatComponent

      TimingRepeatComponent data model or undefined for TimingRepeatComponent

      JsonError if the provided JSON is not a valid JSON object

    • Returns boolean

      true if the instance is a FHIR complex or primitive datatype; false otherwise

    • Returns undefined | string

      the id property value

    • Assigns the provided value to the id property.

      Parameters

      • value: undefined | string

        the id value

      Returns this

      this

      PrimitiveTypeError for invalid value

    • Returns boolean

      true if id exists and has a value; false otherwise

    • Assigns the provided array of Extension values to the extension property.

      Parameters

      • extension: undefined | IExtension[]

        array of Extensions

      Returns this

      this

    • Determines if the extension property exists.

      Parameters

      • Optionalurl: string

        the url that identifies a specific Extension

      Returns boolean

      true if an Extension has the provided url; false otherwise

      If the url is provided, determines if an Extension having the provided url exists. If the url is not provided, determines if the extension property exists and has any values.

      AssertionError for invalid url

    • Determines if the extension property exists.

      Parameters

      • url: string

        the url that identifies a specific Extension

      Returns undefined | IExtension

      an Extension having the provided url

      If the url is provided, determines if an Extension having the provided url exists. If the url is not provided, determines if the extension property exists and has any values.

      AssertionError for invalid url

    • Adds the provided Extension to the extension property array.

      Parameters

      • extension: undefined | IExtension

        the Extension value to add to the extension property array

      Returns this

      this

    • Removes the Extension having the provided url from the extension property array.

      Parameters

      • url: string

        the url that identifies a specific Extension to remove

      Returns void

      AssertionError for invalid url

    • Returns boolean

      true if and only if the data model has required fields (min cardinality > 0) and at least one of those required fields in the instance is empty; false otherwise

    • Returns boolean

      true if the instance is a FHIR resource; false otherwise

    • Returns boolean

      true if the instance is a FHIR primitive datatype; false otherwise

    • Returns boolean

      true if the instance is a FHIR primitive boolean datatype; false otherwise

    • Returns boolean

      true if the instance is a FHIR primitive string-based datatype; false otherwise

    • Returns boolean

      true if the instance is a FHIR primitive number-based datatype; false otherwise

    • Returns boolean

      true if the instance is a FHIR primitive bigint-based datatype; false otherwise

    • Returns boolean

      true if the instance is a FHIR primitive datetime-based datatype; false otherwise

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Methods
    parsegetBoundssetBoundshasBoundsgetBoundsDurationhasBoundsDurationgetBoundsRangehasBoundsRangegetBoundsPeriodhasBoundsPeriodgetCountElementsetCountElementhasCountElementgetCountsetCounthasCountgetCountMaxElementsetCountMaxElementhasCountMaxElementgetCountMaxsetCountMaxhasCountMaxgetDurationElementsetDurationElementhasDurationElementgetDurationsetDurationhasDurationgetDurationMaxElementsetDurationMaxElementhasDurationMaxElementgetDurationMaxsetDurationMaxhasDurationMaxgetDurationUnitElementsetDurationUnitElementhasDurationUnitElementgetDurationUnitsetDurationUnithasDurationUnitgetFrequencyElementsetFrequencyElementhasFrequencyElementgetFrequencysetFrequencyhasFrequencygetFrequencyMaxElementsetFrequencyMaxElementhasFrequencyMaxElementgetFrequencyMaxsetFrequencyMaxhasFrequencyMaxgetPeriodElementsetPeriodElementhasPeriodElementgetPeriodsetPeriodhasPeriodgetPeriodMaxElementsetPeriodMaxElementhasPeriodMaxElementgetPeriodMaxsetPeriodMaxhasPeriodMaxgetPeriodUnitElementsetPeriodUnitElementhasPeriodUnitElementgetPeriodUnitsetPeriodUnithasPeriodUnitgetDayOfWeekEnumTypesetDayOfWeekEnumTypeaddDayOfWeekEnumTypehasDayOfWeekEnumTypegetDayOfWeekElementsetDayOfWeekElementaddDayOfWeekElementhasDayOfWeekElementgetDayOfWeeksetDayOfWeekaddDayOfWeekhasDayOfWeekgetTimeOfDayElementsetTimeOfDayElementaddTimeOfDayElementhasTimeOfDayElementgetTimeOfDaysetTimeOfDayaddTimeOfDayhasTimeOfDaygetWhenElementsetWhenElementaddWhenElementhasWhenElementgetWhensetWhenaddWhenhasWhengetOffsetElementsetOffsetElementhasOffsetElementgetOffsetsetOffsethasOffsetfhirTypeisEmptycopydataTypeNametoJSONisDataTypegetIdsetIdhasIdgetExtensionsetExtensionhasExtensiongetExtensionByUrladdExtensionremoveExtensionisRequiredFieldsEmptyisResourceisComplexDataTypeisPrimitiveisBooleanPrimitiveisStringPrimitiveisNumberPrimitiveisBigIntPrimitiveisDateTimePrimitivecopyValuesinitDayOfWeekinitTimeOfDayinitWhen