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
Health Cloud Business APIs
Health Cloud Tooling API Objects
Health Cloud Standard Invocable Actions
Book Appointment Action
Cancel Appointment Action
Create Referral Action
Create Quote for Home Visits Action
Create Template of Service Appointment Action
Get Data Using Context Definition Action
Get Resources Action
Get Resources for Manual Scheduling Action
Get Slots Action
Get Transcript from Conversation Action
Handle Resource Absence Action
Process Received Document Action
Parse Eligibility and Benefit Verification (EBV) FHIR Response Action
Build Eligibility and Benefit Verification (EBV) Request Action
Parse Eligibility and Benefit Verification (EBV) Response Action
Reschedule Recurring Home Visits Action
Schedule Group Visits Action
Schedule Home Visit Action
Schedule Home Visits Manually Action
Schedule Recurring Home Visit Action
Update Appointment Action
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.

Cancel Appointment Action

Cancel an existing appointment.

This action is available in API version 65.0 and later.

Supported REST HTTP Methods

URI
/services/data/67.0/connect/health/appointment-management/appointment/{id}
Formats
JSON, XML
HTTP Methods
PATCH
Authentication
Authorization: Bearer Token

Inputs

Input Details
cancellationReason
Type
String
Description
Reason for the cancellation.
comment
Type
String
Description
Additional notes or comments for the cancellation.
id
Type
String
Description
Required
Unique identifier of the appointment to update. This is part of the request URL.
status
Type
String
Description
Required
New status for the appointment. Must be a valid cancellation status such as Cancelled.

Outputs

Output Details
errorMessages
Type
Array
Description
A list of errors, if any occurred.
id
Type
String
Description
The id of the Appointment.
isSuccess
Type
Boolean
Description
Indicates whether the appointment was cancelled successfully or not.
status
Type
String
Description
The status of the Appointment, like Scheduled, Rejected.

Usage

PATCH

This sample request is for the Cancel Appointment action.

1{
2    "id": "08xxG000000Axx6YAC",
3    "status": "Cancelled",
4    "cancellationReason": "Patient requested cancellation.",
5    "comment": "Patient will call back to reschedule."
6}

This sample response is for the Cancel Appointment action.

1{
2    "id": "08pxx000000Axx6YAC",
3    "isSuccess": true,
4    "status": "Cancelled",
5    "errorMessages": []
6}