Data Model Libraries
    Preparing search index...

    Class AppointmentRecurrenceTemplateComponent

    AppointmentRecurrenceTemplateComponent Class

    FHIR Specification

    • Short: Details of the recurrence pattern/template used to generate occurrences
    • Definition: The details of the recurrence pattern or template that is used to generate recurring appointments.

    Hierarchy (View Summary)

    Implements

    Index

    Constructors

    Properties

    Methods

    parse getTimezone setTimezone hasTimezone getRecurrenceType setRecurrenceType hasRecurrenceType getLastOccurrenceDateElement setLastOccurrenceDateElement hasLastOccurrenceDateElement getLastOccurrenceDate setLastOccurrenceDate hasLastOccurrenceDate getOccurrenceCountElement setOccurrenceCountElement hasOccurrenceCountElement getOccurrenceCount setOccurrenceCount hasOccurrenceCount getOccurrenceDateElement setOccurrenceDateElement addOccurrenceDateElement hasOccurrenceDateElement getOccurrenceDate setOccurrenceDate addOccurrenceDate hasOccurrenceDate getWeeklyTemplate setWeeklyTemplate hasWeeklyTemplate getMonthlyTemplate setMonthlyTemplate hasMonthlyTemplate getYearlyTemplate setYearlyTemplate hasYearlyTemplate getExcludingDateElement setExcludingDateElement addExcludingDateElement hasExcludingDateElement getExcludingDate setExcludingDate addExcludingDate hasExcludingDate getExcludingRecurrenceIdElement setExcludingRecurrenceIdElement addExcludingRecurrenceIdElement hasExcludingRecurrenceIdElement getExcludingRecurrenceId setExcludingRecurrenceId addExcludingRecurrenceId hasExcludingRecurrenceId fhirType isEmpty isRequiredFieldsEmpty copy toJSON getModifierExtension setModifierExtension hasModifierExtension getModifierExtensionByUrl addModifierExtension removeModifierExtension getId setId hasId getExtension setExtension hasExtension getExtensionByUrl addExtension removeExtension isResource isDataType isComplexDataType isPrimitive isBooleanPrimitive isStringPrimitive isNumberPrimitive isBigIntPrimitive isDateTimePrimitive copyValues initOccurrenceDate initExcludingDate initExcludingRecurrenceId

    Constructors

    Properties

    timezone?: CodeableConcept

    Appointment.recurrenceTemplate.timezone Element

    FHIR Specification

    • Short: The timezone of the occurrences
    • Definition: The timezone of the recurring appointment occurrences.
    • FHIR Type: CodeableConcept
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: false
    recurrenceType: null | CodeableConcept

    Appointment.recurrenceTemplate.recurrenceType Element

    FHIR Specification

    • Short: The frequency of the recurrence
    • Definition: How often the appointment series should recur.
    • FHIR Type: CodeableConcept
    • Cardinality: 1..1
    • isModifier: false
    • isSummary: false
    lastOccurrenceDate?: DateType

    Appointment.recurrenceTemplate.lastOccurrenceDate Element

    FHIR Specification

    • Short: The date when the recurrence should end
    • Definition: Recurring appointments will not occur after this date.
    • FHIR Type: date
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: false
    occurrenceCount?: PositiveIntType

    Appointment.recurrenceTemplate.occurrenceCount Element

    FHIR Specification

    • Short: The number of planned occurrences
    • Definition: How many appointments are planned in the recurrence.
    • FHIR Type: positiveInt
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: false
    occurrenceDate?: DateType[]

    Appointment.recurrenceTemplate.occurrenceDate Element

    FHIR Specification

    • Short: Specific dates for a recurring set of appointments (no template)
    • Definition: The list of specific dates that will have appointments generated.
    • FHIR Type: date
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: false

    Appointment.recurrenceTemplate.weeklyTemplate Element

    FHIR Specification

    • Short: Information about weekly recurring appointments
    • Definition: Information about weekly recurring appointments.
    • FHIR Type: BackboneElement
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: false

    Appointment.recurrenceTemplate.monthlyTemplate Element

    FHIR Specification

    • Short: Information about monthly recurring appointments
    • Definition: Information about monthly recurring appointments.
    • FHIR Type: BackboneElement
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: false

    Appointment.recurrenceTemplate.yearlyTemplate Element

    FHIR Specification

    • Short: Information about yearly recurring appointments
    • Definition: Information about yearly recurring appointments.
    • FHIR Type: BackboneElement
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: false
    excludingDate?: DateType[]

    Appointment.recurrenceTemplate.excludingDate Element

    FHIR Specification

    • Short: Any dates that should be excluded from the series
    • Definition: Any dates, such as holidays, that should be excluded from the recurrence.
    • Comment: excludingDate is an alternative to excludingRecurrenceId. You may say either that 12/25/XXXX should be excluded using excludingDate, or you may indicate the recurrenceId of the appointment that would fall on the excluded date in the excludingRecurrenceId property.
    • FHIR Type: date
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: false
    excludingRecurrenceId?: PositiveIntType[]

    Appointment.recurrenceTemplate.excludingRecurrenceId Element

    FHIR Specification

    • Short: Any recurrence IDs that should be excluded from the recurrence
    • Definition: Any dates, such as holidays, that should be excluded from the recurrence.
    • Comment: excludingRecurrenceId is an alternative to excludingDate. You may say either that 12/25/XXXX should be excluded using excludingDate, or you may indicate the recurrenceId of the appointment that would fall on the excluded date in the excludingRecurrenceId property.
    • FHIR Type: positiveInt
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: false

    Methods

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

      Parameters

      • sourceJson: Value

        JSON representing FHIR AppointmentRecurrenceTemplateComponent

      • OptionaloptSourceField: string

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

      Returns undefined | AppointmentRecurrenceTemplateComponent

      AppointmentRecurrenceTemplateComponent data model or undefined for AppointmentRecurrenceTemplateComponent

      JsonError if the provided JSON is not a valid JSON object

    • Determines if the modifierExtension 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 modifierExtension property exists and has any values.

      AssertionError for invalid url

    • 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

    • 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 the instance is a FHIR complex or primitive datatype; false otherwise