VisitRecurrenceDetails Class

Represents one recurring series for home visits. Each series defines a recurrence pattern and can override request-level defaults.

healthcloudext

The following are properties for VisitRecurrenceDetails.

  • isTimeSlotFromOperatingHours

    Indicates whether time slots are derived from operating hours instead of the visitTimeSlots list. When true, operating hours take precedence over explicit slots.

  • nextStartDate

    Next recurrence occurrence after this series’ last scheduled visit. The value is written at the end of each scheduling run and used to start the next scheduling cycle.

  • operatingHoursId

    ID of the operating hours record used to derive time slots when isTimeSlotFromOperatingHours is true.

  • recurrenceOrder

    Position of this series relative to the other series in the request.

  • rrule

    RFC 5545 recurrence rule that defines the visit pattern for this series.

  • schedulingPolicyId

    ID of the scheduling policy for this series. This value overrides the request-level scheduling policy.

  • serviceTerritoryId

    ID of the service territory for this series. This value overrides the request-level service territory.

  • startDate

    Anchor date that the recurrence rule is expanded from, interpreted in the effective time zone.

  • visitAddress

    Visit address for this series. This value overrides the request-level visit address.

  • visitSourceId

    ID of the source record for this series. Series in the same request can reference different source records.

  • visitTimeSlots

    Explicit time-of-day slots for this series. These slots are ignored when isTimeSlotFromOperatingHours is true.

  • visitWorkTypes

    Work type configurations for this series. A non-null value replaces the request-level configuration for that field. A null value inherits the request-level configuration.

Indicates whether time slots are derived from operating hours instead of the visitTimeSlots list. When true, operating hours take precedence over explicit slots.

@AuraEnabled global Boolean isTimeSlotFromOperatingHours {get; set;}

Type: Boolean

Next recurrence occurrence after this series’ last scheduled visit. The value is written at the end of each scheduling run and used to start the next scheduling cycle.

@AuraEnabled global Date nextStartDate {get; set;}

Type: Date

ID of the operating hours record used to derive time slots when isTimeSlotFromOperatingHours is true.

@AuraEnabled global String operatingHoursId {get; set;}

Type: String

Position of this series relative to the other series in the request.

@AuraEnabled global Integer recurrenceOrder {get; set;}

Type: Integer

RFC 5545 recurrence rule that defines the visit pattern for this series.

@AuraEnabled global String rrule {get; set;}

Type: String

ID of the scheduling policy for this series. This value overrides the request-level scheduling policy.

@AuraEnabled global String schedulingPolicyId {get; set;}

Type: String

ID of the service territory for this series. This value overrides the request-level service territory.

@AuraEnabled global String serviceTerritoryId {get; set;}

Type: String

Anchor date that the recurrence rule is expanded from, interpreted in the effective time zone.

@AuraEnabled global Date startDate {get; set;}

Type: Date

Visit address for this series. This value overrides the request-level visit address.

@AuraEnabled global healthcloudext.VisitAddress visitAddress {get; set;}

Type: healthcloudext.VisitAddress

ID of the source record for this series. Series in the same request can reference different source records.

@AuraEnabled global String visitSourceId {get; set;}

Type: String

Explicit time-of-day slots for this series. These slots are ignored when isTimeSlotFromOperatingHours is true.

@AuraEnabled global List<healthcloudext.VisitTimeSlot> visitTimeSlots {get; set;}

Type: List<healthcloudext.VisitTimeSlot>

Work type configurations for this series. A non-null value replaces the request-level configuration for that field. A null value inherits the request-level configuration.

@AuraEnabled global List<healthcloudext.VisitWorkType> visitWorkTypes {get; set;}

Type: List<healthcloudext.VisitWorkType>