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
- Feed tracking is available for the object.
- PartySchedulePreferenceHistory
- History is available for tracked fields of the object.
- PartySchedulePreferenceShare
- Sharing is available for the object.