---
schema_version: "1"
id: ba7b535a74d857ce0780433626fe4c581c0fe3edd01aee3cd75ce16be63cda09
title: AppointmentReason
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_appointmentreason.md
canonical_url: https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/hc_sforce_api_objects_appointmentreason.htm
source_site: developer.salesforce.com
content_type: documentation
content_hash: fec552a407254a1657c4ce2de146b34d79f7d1d9ae83caac723f4b5249f36335
description: Represents a patient’s reason for making an appointment. Used for self-scheduling in Intelligent Appointment Management. This object is available in API version 53.0 and later.
---
# AppointmentReason

Represents a patient’s reason for making an appointment. Used for self-scheduling in Intelligent Appointment Management. This object is available in API version 53.0 and later.

## Supported Calls

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

## Fields

### AppointmentReason

- **Type**: picklist
- **Properties**: Create, Filter, Group, Sort, Update
- **Description**: The patient's reason for making the appointment. Not the same as visit type.

### AppointmentReasonImageId

- **Type**: reference
- **Properties**: Create, Filter, Group, Nillable, Sort, Update
- **Description**: Image related to the visit reason, such as a stethoscope or a splint.
    
    This field is a relationship field.
- **Relationship Name**: AppointmentReasonImage
- **Relationship Type**: Lookup
- **Refers To**: ContentDocument

### DefaultImage

- **Type**: string
- **Properties**: Create, Filter, Group, Nillable, Sort, Update
- **Description**: Generic image for all visit reasons. A custom image overrides the default image if present.

### DefaultWorkTypeId

- **Type**: reference
- **Properties**: Create, Filter, Group, Sort, Update
- **Description**: Specifies the default appointment parameters for a new patient.
    
    This field is a relationship field.
- **Relationship Name**: DefaultWorkType
- **Relationship Type**: Lookup
- **Refers To**: WorkType

### Description

- **Type**: string
- **Properties**: Create, Filter, Group, Nillable, Sort, Update
- **Description**: Detailed information about the patient's reason for making the appointment.

### EstablishedWorkTypeId

- **Type**: reference
- **Properties**: Create, Filter, Group, Nillable, Sort, Update
- **Description**: Specifies appointment parameters for an established patient (has been seen within the last three years) if different from the default work type.
    
    This field is a relationship field.
- **Relationship Name**: EstablishedWorkType
- **Relationship Type**: Lookup
- **Refers To**: WorkType

### IsActive

- **Type**: boolean
- **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update
- **Description**: Indicates if the appointment reason is active.
- **Default value**: false

### LastReferencedDate

- **Type**: dateTime
- **Properties**: Filter, Nillable, Sort
- **Description**: The date when this record was last modified. Its label in the user interface is Last Modified Date.

### LastViewedDate

- **Type**: dateTime
- **Properties**: Filter, Nillable, Sort
- **Description**: The timestamp for when a user most recently viewed this record.

### Name

- **Type**: string
- **Properties**: Create, Filter, Group, idLookup, Sort, Update
- **Description**: The name of the Appointment Reason record.

### OwnerId

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

### ResourceType

- **Type**: picklist
- **Properties**: Create, Filter, Group, Nillable, Restricted picklist, Sort, Update
- **Description**: Specifies the type of resource associated with the appointment reason.
- **Possible values**:
    - Asset
    - Provider

### Visibility

- **Type**: picklist
- **Properties**: Create, Filter, Group, Restricted picklist, Sort, Update
- **Description**: Indicates if this Appointment Reason is available for patients to self-schedule.
- **Possible values**:
    - PATIENT\_SELF\_SCHEDULING

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

[AppointmentReasonFeed](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.

[AppointmentReasonHistory](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.

[AppointmentReasonOwnerSharingRule](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/sforce_api_associated_objects_ownersharingrule.htm "StandardObjectNameOwnerSharingRule is the model for all owner sharing rule objects associated with standard objects. These objects represent a rule for sharing a standard object with users other than the owner.")

Sharing rules are available for the object.

[AppointmentReasonShare](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.