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
BookAppointmentResponse Class
BookAppointmentResponse Properties
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

BookAppointmentResponse Class

Represents the appointment booking details from the external scheduling system.

Namespace

healthcloudext

BookAppointmentResponse Properties

The following are properties for BookAppointmentResponse.

appointmentId

Represents the unique identifier of the appointment in Health Cloud.

Signature

public String appointmentId {get; set;}

Property Value

Type: String

jsonResponse

Represents the response from the external scheduling system encoded as JSON.

Signature

public String jsonResponse {get; set;}

Property Value

Type: String

note

Represents optional extra information added to the appointment.

Signature

public String note {get; set;}

Property Value

Type: String

patientId

Represents the unique identifier of the patient in Health Cloud.

Signature

public String patientId {get; set;}

Property Value

Type: String

slotEnd

Represents the date and time that the available time slot ends.

Signature

public String slotEnd {get; set;}

Property Value

Type: String

slotStart

Represents the date and time that the available time slot starts.

Signature

public String slotStart {get; set;}

Property Value

Type: String

sourceAppointmentId

Represents the unique identifier of the appointment in the source system.

Signature

public String sourceAppointmentId {get; set;}

Property Value

Type: String

sourcePatientId

Represents the ID of the patient in the source system.

Signature

public String sourcePatientId {get; set;}

Property Value

Type: String

sourceSystem

Represents the name of the external scheduling system from which the record was sourced.

Signature

public String sourceSystem {get; set;}

Property Value

Type: String

status

Represents the status of the appointment.

Signature

public healthcloudext.BookingStatus status {get; set;}

Property Value

Type: healthcloudext.BookingStatus