---
schema_version: "1"
id: 6187e6ad87b3bde7253b327f494684d5be867621ca7f3bcf1eb0b1932196fa86
title: PartySchedulePreference
collection: legacydeveloper
version: current
locale: en-us
portal_url: https://docs.salesforce.com/legacydeveloper/current/en-us/health_cloud_object_reference/hc_sforce_api_objects_partyschedulepreference.md
canonical_url: https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/hc_sforce_api_objects_partyschedulepreference.htm
source_site: developer.salesforce.com
content_type: documentation
content_hash: dbadf24e59380224efa746b2e16d47eb7c1ad81c2dd618fd0994a15d017c72a4
description: Represents the schedule preference that a patient has for their home healthcare visit. This object is available in API version 61.0 and later.
---
# PartySchedulePreference

Represents the schedule preference that a patient has for their home healthcare visit. This object is available in API version 61.0 and later.

## Supported Calls

create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert()

## Fields

### EndDateTime

- **Type**: dateTime
- **Properties**: Create, Filter, Sort, Update
- **Description**: The date and time until when the patient is available or unavailable for their home visit.

### LastReferencedDate

- **Type**: dateTime
- **Properties**: Filter, Nillable, Sort
- **Description**: The date and time when the record was last referenced.

### LastViewedDate

- **Type**: dateTime
- **Properties**: Filter, Nillable, Sort
- **Description**: The date and time when the record was last viewed.

### Name

- **Type**: string
- **Properties**: Autonumber, Defaulted on create, Filter, idLookup, Sort
- **Description**: The name of the record.

### OwnerId

- **Type**: reference
- **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update
- **Description**: The owner of the record.
    
    This field is a polymorphic relationship field.
- **Relationship Name**: Owner
- **Relationship Type**: Lookup
- **Refers To**: Group, User

### PartyId

- **Type**: reference
- **Properties**: Create, Filter, Group, Sort, Update
- **Description**: The ID of the patient whose schedule preference is recorded.
    
    This field is a polymorphic relationship field.
- **Relationship Name**: Party
- **Relationship Type**: Lookup
- **Refers To**: Account

### Reason

- **Type**: string
- **Properties**: Create, Filter, Group, Nillable, Sort, Update
- **Description**: The reason for the schedule preference.

### StartDateTime

- **Type**: dateTime
- **Properties**: Create, Filter, Sort, Update
- **Description**: The date and time from when the patient is available or unavailable for their home visit.

### Type

- **Type**: picklist
- **Properties**: Create, Defaulted on create, Filter, Group, Restricted picklist, Sort, Update
- **Description**: The type of schedule preference.
- **Default value**: Available
- **Possible values**:
    - Available
    - Unavailable

## Associated Objects

This object has the following associated objects. If the API version isn’t specified, they’re available in the same API versions as this object. Otherwise, they’re available in the specified API version and later.

[PartySchedulePreferenceFeed](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/sforce_api_associated_objects_feed.htm "StandardObjectNameFeed is the model for all feed objects associated with standard objects. These objects represent the posts and feed-tracked changes of a standard object.")

Feed tracking is available for the object.

[PartySchedulePreferenceHistory](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/sforce_api_associated_objects_history.htm "StandardObjectNameHistory is the model for all history objects associated with standard objects. These objects represent the history of changes to the values in the fields of a standard object.")

History is available for tracked fields of the object.

[PartySchedulePreferenceShare](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/sforce_api_associated_objects_share.htm "StandardObjectNameShare is the model for all share objects associated with standard objects. These objects represent a sharing entry on the standard object.")

Sharing is available for the object.