Salesforce Docs Portal

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
Feed tracking is available for the object.
AppointmentReasonHistory
History is available for tracked fields of the object.
AppointmentReasonOwnerSharingRule
Sharing rules are available for the object.
AppointmentReasonShare
Sharing is available for the object.