ApptBookingConfig | Salesforce Health Cloud Developer Guide

Where possible, we changed noninclusive terms to align with our company value of Equality. We maintained certain terms to avoid any effect on customer implementations.

Important

Supported SOAP API Calls

create(), delete(), describeSObjects(), query(), retrieve(), update(), upsert()

Supported REST API Methods

DELETE, GET, HEAD, PATCH, POST, Query

Fields

Field	Details
ApexClassId	Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description The Apex class that's used when scheduling an appointment using an external scheduling system. If not specified, the default Health Cloud-supplied Apex class is used. Relationship Name ApexClass Relationship Type Lookup Refers To ApexClass
AssignedProviderRole	Type string Properties Create, Filter, Group, Nillable, Sort, Update Description Role used in an Account Contact Relation record to associate a patient (Person Account) with their assigned provider (Contact).
AttendanceThresholdPct	Type double Properties Create, Filter, Nillable, Sort, Update Description Percentage of attended appointments above which a time slot is highlighted in the scheduling console.
BestTimeSlotsDefinition	Type string Properties Create, Filter, Group, Nillable, Sort, Update Description ID of the attendance prediction taken from Einstein Discovery.
CanCreateDuplicateRecord	Type boolean Properties Create, Defaulted on create, Filter, Group, Sort, Update Description If true, Health Cloud creates a new record when two or more existing records contain duplicate data. If false, Health Cloud stops processing and creates a case you can review to reconcile the duplicates.
DeveloperName	Type string Properties Create, Filter, Group, Sort, Update Description The unique name of the object in the API. This name can contain only underscores and alphanumeric characters, and must be unique in your org. It must begin with a letter, not include spaces, not end with an underscore, and not contain two consecutive underscores. In managed packages, this field prevents naming conflicts on package installations. With this field, a developer can change the object’s name in a managed package and the changes are reflected in a subscriber’s organization. Label is Record Type Name. This field is automatically generated, but you can supply your own value if you create the record using the API. When creating large sets of data, always specify a unique DeveloperName for each record. If no DeveloperName is specified, performance may slow as a DeveloperName is generated for each record. Note
GetSlotStatusTimeout	Type int Properties Create, Filter, Group, Nillable, Sort, Update Description The number of milliseconds before a request to retrieve time slot statuses from a scheduling system times out. Valid values are from 0 through 60000. This field is available in API version 62.0 and later.
IsActive	Type boolean Properties Create, Defaulted on create, Filter, Group, Sort, Update Description Indicates whether a configuration is active. The default value is `false`.
IsSingleSourceSystem	Type boolean Properties Create, Defaulted on create, Filter, Group, Sort, Update Description Indicates whether the configuration is associated with a single source system. The default value is `false`.
Language	Type picklist Properties Create, Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description The language of the appointment booking configuration. Possible values are: `da`—Danish `de`—German `en_US`—English `es`—Spanish `es_MX`—Spanish (Mexico) `fi`—Finnish `fr`—French `it`—Italian `ja`—Japanese `ko`—Korean `nl_NL`—Dutch `no`—Norwegian `pt_BR`—Portuguese (Brazil) `ru`—Russian `sv`—Swedish `th`—Thai `zh_CN`—Chinese (Simplified) `zh_TW`—Chinese (Traditional)
MasterLabel	Type string Properties Create, Filter, Group, Sort, Update Description The UI label of Appointment Booking Configuration
NamedCredentialId	Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description The fully-qualified named credential used by the Apex class to connect to an external scheduling system. This field is a relationship field. Relationship Name NamedCredential Relationship Type Lookup Refers To NamedCredential
ServiceApptRecordTypeName	Type string Properties Create, Filter, Group, Nillable, Sort, Update Description The record type of the service appointment used for appointment scheduling.