Agentforce Health Developer Guide

Agentforce Health Developer Guide
Health Cloud Data Model
Health Cloud Associated Objects
Health Cloud Fields on Standard Objects
Health Cloud Platform Events
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
HomeHealth
Slot Class
BookingStatus Enum
HealthCloudExt Namespace for Benefit Verification
HealthCloudExt Namespace for Unified Health Scoring
HealthCloudExt Namespace for Intelligent Content Management
id_verification Namespace
embeddedai Namespace
BatchProcessor
DocumentAI Namespace
hlthcrbilling Namespace
Health Cloud Business APIs
Health Cloud Tooling API Objects
Health Cloud Standard Invocable Actions
Metadata Types
Health Cloud FHIR APIs
MuleSoft Direct Integrations
API End-of-Life Policy
PDF

Note: This release is in preview. Features described here don’t become generally available until the latest general availability date that Salesforce announces for this release. Before then, and where features are noted as beta, pilot, or developer preview, we can’t guarantee general availability within any particular time frame or at all. Make your purchase decisions only on the basis of generally available products and features.

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;}

1healthcloudext.BookAppointmentResponse, appointmentId

Property Value

Type: String

jsonResponse

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

Signature

public String jsonResponse {get; set;}

1healthcloudext.BookAppointmentResponse, jsonResponse

Property Value

Type: String

note

Represents optional extra information added to the appointment.

Signature

public String note {get; set;}

1healthcloudext.BookAppointmentResponse, note

Property Value

Type: String

patientId

Represents the unique identifier of the patient in Health Cloud.

Signature

public String patientId {get; set;}

1healthcloudext.BookAppointmentResponse, patientId

Property Value

Type: String

slotEnd

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

Signature

public String slotEnd {get; set;}

1healthcloudext.BookAppointmentResponse, slotEnd

Property Value

Type: String

slotStart

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

Signature

public String slotStart {get; set;}

1healthcloudext.BookAppointmentResponse, slotStart

Property Value

Type: String

sourceAppointmentId

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

Signature

public String sourceAppointmentId {get; set;}

1healthcloudext.BookAppointmentResponse, sourceAppointmentId

Property Value

Type: String

sourcePatientId

Represents the ID of the patient in the source system.

Signature

public String sourcePatientId {get; set;}

1healthcloudext.BookAppointmentResponse, sourcePatientId

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;}

1healthcloudext.BookAppointmentResponse, sourceSystem

Property Value

Type: String

status

Represents the status of the appointment.

Signature

public healthcloudext.BookingStatus status {get; set;}

1healthcloudext.BookAppointmentResponse, status

Property Value

Type: healthcloudext.BookingStatus