---
schema_version: "1"
id: 0df4b4b44639dcfe5beeb4d5ee08bcc2719ecc736c9de7b8156c62e61d6bb923
title: VisitRecurrenceDetails Class
collection: legacydeveloper
version: current
locale: en-us
portal_url: https://docs.salesforce.com/legacydeveloper/current/en-us/health_cloud_object_reference/apex_class_healthcloudext_VisitRecurrenceDetails.md
canonical_url: https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/apex_class_healthcloudext_VisitRecurrenceDetails.htm
source_site: developer.salesforce.com
content_type: documentation
content_hash: ffb7afe3487978daaa0c7758521afa72b9377e5eefae625ec1a4f684de1ad939
description: Represents one recurring series for home visits. Each series defines a recurrence pattern and can override request-level defaults.Indicates whether time slots are derived from operating hours instead of the visitTimeSlots list. When true, operating hours take precedence over explicit slots.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.ID of the operating hours record used to derive time slots when isTimeSlotFromOperatingHours is true.Position of this series relative to the other series in the request.RFC 5545 recurrence rule that defines the visit pattern for this series.ID of the scheduling policy for this series. This value overrides the request-level scheduling policy.ID of the service territory for this series. This value overrides the request-level service territory.Anchor date that the recurrence rule is expanded from, interpreted in the effective time zone.Visit address for this series. This value overrides the request-level visit address.ID of the source record for this series. Series in the same request can reference different source records.Explicit time-of-day slots for this series. These slots are ignored when isTimeSlotFromOperatingHours is true.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.
---
# VisitRecurrenceDetails Class

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

## Namespace

[healthcloudext](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/apex_namespace_healthcloudext.htm "The HealthCloudExt namespace provides an interface and classes for Health Cloud to integrate with a source electronic health records (EHR) system.")

- **[VisitRecurrenceDetails Properties](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/apex_class_healthcloudext_VisitRecurrenceDetails.htm#apex_healthcloudext_VisitRecurrenceDetails_properties)**

## VisitRecurrenceDetails Properties

The following are properties for VisitRecurrenceDetails.

- **[isTimeSlotFromOperatingHours](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/apex_class_healthcloudext_VisitRecurrenceDetails.htm#apex_healthcloudext_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](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/apex_class_healthcloudext_VisitRecurrenceDetails.htm#apex_healthcloudext_VisitRecurrenceDetails_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](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/apex_class_healthcloudext_VisitRecurrenceDetails.htm#apex_healthcloudext_VisitRecurrenceDetails_operatingHoursId)**  
    ID of the operating hours record used to derive time slots when isTimeSlotFromOperatingHours is true.
- **[recurrenceOrder](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/apex_class_healthcloudext_VisitRecurrenceDetails.htm#apex_healthcloudext_VisitRecurrenceDetails_recurrenceOrder)**  
    Position of this series relative to the other series in the request.
- **[rrule](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/apex_class_healthcloudext_VisitRecurrenceDetails.htm#apex_healthcloudext_VisitRecurrenceDetails_rrule)**  
    RFC 5545 recurrence rule that defines the visit pattern for this series.
- **[schedulingPolicyId](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/apex_class_healthcloudext_VisitRecurrenceDetails.htm#apex_healthcloudext_VisitRecurrenceDetails_schedulingPolicyId)**  
    ID of the scheduling policy for this series. This value overrides the request-level scheduling policy.
- **[serviceTerritoryId](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/apex_class_healthcloudext_VisitRecurrenceDetails.htm#apex_healthcloudext_VisitRecurrenceDetails_serviceTerritoryId)**  
    ID of the service territory for this series. This value overrides the request-level service territory.
- **[startDate](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/apex_class_healthcloudext_VisitRecurrenceDetails.htm#apex_healthcloudext_VisitRecurrenceDetails_startDate)**  
    Anchor date that the recurrence rule is expanded from, interpreted in the effective time zone.
- **[visitAddress](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/apex_class_healthcloudext_VisitRecurrenceDetails.htm#apex_healthcloudext_VisitRecurrenceDetails_visitAddress)**  
    Visit address for this series. This value overrides the request-level visit address.
- **[visitSourceId](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/apex_class_healthcloudext_VisitRecurrenceDetails.htm#apex_healthcloudext_VisitRecurrenceDetails_visitSourceId)**  
    ID of the source record for this series. Series in the same request can reference different source records.
- **[visitTimeSlots](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/apex_class_healthcloudext_VisitRecurrenceDetails.htm#apex_healthcloudext_VisitRecurrenceDetails_visitTimeSlots)**  
    Explicit time-of-day slots for this series. These slots are ignored when isTimeSlotFromOperatingHours is true.
- **[visitWorkTypes](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/apex_class_healthcloudext_VisitRecurrenceDetails.htm#apex_healthcloudext_VisitRecurrenceDetails_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.

### isTimeSlotFromOperatingHours

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

#### Signature

@AuraEnabled global Boolean isTimeSlotFromOperatingHours {get; set;}

#### Property Value

Type: [Boolean](https://developer.salesforce.com/docs/atlas.en-us.264.0.apexref.meta/apexref/apex_methods_system_boolean.htm)

### 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.

#### Signature

@AuraEnabled global Date nextStartDate {get; set;}

#### Property Value

Type: [Date](https://developer.salesforce.com/docs/atlas.en-us.264.0.apexref.meta/apexref/apex_methods_system_date.htm)

### operatingHoursId

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

#### Signature

@AuraEnabled global String operatingHoursId {get; set;}

#### Property Value

Type: [String](https://developer.salesforce.com/docs/atlas.en-us.264.0.apexref.meta/apexref/apex_methods_system_string.htm)

### recurrenceOrder

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

#### Signature

@AuraEnabled global Integer recurrenceOrder {get; set;}

#### Property Value

Type: [Integer](https://developer.salesforce.com/docs/atlas.en-us.264.0.apexref.meta/apexref/apex_methods_system_integer.htm)

### rrule

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

#### Signature

@AuraEnabled global String rrule {get; set;}

#### Property Value

Type: [String](https://developer.salesforce.com/docs/atlas.en-us.264.0.apexref.meta/apexref/apex_methods_system_string.htm)

### schedulingPolicyId

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

#### Signature

@AuraEnabled global String schedulingPolicyId {get; set;}

#### Property Value

Type: [String](https://developer.salesforce.com/docs/atlas.en-us.264.0.apexref.meta/apexref/apex_methods_system_string.htm)

### serviceTerritoryId

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

#### Signature

@AuraEnabled global String serviceTerritoryId {get; set;}

#### Property Value

Type: [String](https://developer.salesforce.com/docs/atlas.en-us.264.0.apexref.meta/apexref/apex_methods_system_string.htm)

### startDate

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

#### Signature

@AuraEnabled global Date startDate {get; set;}

#### Property Value

Type: [Date](https://developer.salesforce.com/docs/atlas.en-us.264.0.apexref.meta/apexref/apex_methods_system_date.htm)

### visitAddress

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

#### Signature

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

#### Property Value

Type: [healthcloudext.VisitAddress](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/apex_class_healthcloudext_VisitAddress.htm#apex_class_healthcloudext_VisitAddress "Represents an address for recurring home visits.")

### visitSourceId

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

#### Signature

@AuraEnabled global String visitSourceId {get; set;}

#### Property Value

Type: [String](https://developer.salesforce.com/docs/atlas.en-us.264.0.apexref.meta/apexref/apex_methods_system_string.htm)

### visitTimeSlots

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

#### Signature

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

#### Property Value

Type: List<[healthcloudext.VisitTimeSlot](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/apex_class_healthcloudext_VisitTimeSlot.htm#apex_class_healthcloudext_VisitTimeSlot "Represents a time slot within a day for recurring home visits.")\>

### 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.

#### Signature

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

#### Property Value

Type: List<[healthcloudext.VisitWorkType](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/apex_class_healthcloudext_VisitWorkType.htm#apex_class_healthcloudext_VisitWorkType "Represents a work type configuration for recurring home visits.")\>