Salesforce Health Cloud Developer Guide

Health Cloud Developer Guide
Health Cloud Data Model
Health Cloud Associated Objects
Health Cloud Fields on Standard Objects
Creating and Importing Documents
Intelligent Appointment Management
Working With Electronic Health Records
Emergency Response Management
Apex Reference
HealthCloudExt Namespace
HealthCloudExt Namespace for Intelligent Appointment Management
AppointmentBase Class
AppointmentBookingInterop Interface
AppointmentBookingInteropFhirAdapter Class
AppointmentProvider Class
BookAppointmentRequest Class
BookAppointmentRequest Properties
BookAppointmentResponse Class
CancelAppointmentRequest Class
CancelAppointmentResponse Class
FindSlotsRequest Class
GetSlotStatusRequest Class
Slot Class
BookingStatus Enum
HealthCloudExt Namespace for Benefit Verification
HealthCloudExt Namespace for Unified Health Scoring
id_verification Namespace
Health Cloud Business APIs
Health Cloud Tooling API Objects
Metadata Types
Health Cloud Custom Metadata Types
Health Cloud Empower Components for Experience Cloud Sites
API End-of-Life
PDF

Newer Version Available

This content describes an older version of this product. View Latest

BookAppointmentRequest Class

Contains set of options to book a healthcare appointment.

Namespace

healthcloudext

Usage

To book an appointment, we need to know the availability of a given practitioner at a given facility. To get this information, Health Cloud queries the specific source EHR system, using the IDs of the practitioner and the facility as stored in that source system.

Practitioner and Facility IDs:
  • The source system ID comes from the Healthcare Practitioner Facility record for the practitioner+facility combination.
  • The source system facility ID comes from an Identifier record that looks up to the Contact record for the practitioner, with the same source system as the Healthcare Practitioner Facility record.
  • The source system facility ID comes from an Identifier record that looks up to the Account record for the facility, with the same source system as the Healthcare Practitioner Facility record.

The source system requires Appointment Type and Service Type codes that are derived from the “visit type” (Work Type record) selected by the call center agent. These codes are configured via Work Type Code Set Bundle records, one per Work Type, with lookups to Code Set Bundle and Code Sets for the Service Type and Appointment Type codes in each Source System the org integrates with.

BookAppointmentRequest Properties

The following are properties for BookAppointmentRequest.

appointmentType

Represents the type of appointment, such as annual physical or intake examination.

Signature

public String appointmentType {get; set;}

Property Value

Type: String

note

Represents optional extra information about the appointment.

Signature

public String note {get; set;}

Property Value

Type: String

serviceType

Specifies the type of service to be performed at the appointment, such as dental cleaning or surgery.

Signature

public String serviceType {get; set;}

Property Value

Type: String

slot

Represents the time period slot that’s assigned to the appointment.

Signature

public String slot {get; set;}

Property Value

Type: String

sourceFacilityId

Represents the ID in the source system of the facility where the encounter will occur.

Signature

public String sourceFacilityId {get; set;}

Property Value

Type: String

sourcePatientId

Represents the ID in the source system of the patient.

Signature

public String sourcePatientId {get; set;}

Property Value

Type: String

sourcePractitionerId

Represents the ID in the source system of the practitioner with whom the encounter will occur.

Signature

public String sourcePractitionerId {get; set;}

Property Value

Type: String

sourceSystem

Represents the name of the source system the patient record came from.

Signature

public String sourceSystem {get; set;}

Property Value

Type: String