---
schema_version: "1"
id: 9498d1059f5c3d5e18935748188320bef22db174cfe7088a15e7120f0433fd7c
title: CancelAppointmentRequest Class
collection: legacydeveloper
version: current
locale: en-us
portal_url: https://docs.salesforce.com/legacydeveloper/current/en-us/health_cloud_object_reference/apex_class_healthcloudext_CancelAppointmentRequest.md
canonical_url: https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/apex_class_healthcloudext_CancelAppointmentRequest.htm
source_site: developer.salesforce.com
content_type: documentation
content_hash: 6383ce5b1bf9df45c070284ed06cb86b04eee30f220b46ee8e2574ab06ad47b3
description: Contains set of options to cancel the booked appointment.Unique ID of the appointment in Health Cloud. The appointment ID comes from the ServiceAppointment object.Represents the type of appointment, such as annual physical or intake examination.Represents the reason for canceling the appointment.Specifies the type of service to be performed at the appointment, such as dental cleaning or surgery.Represents the time period slot that’s assigned to the appointment.Represents the healthcare facility where the encounter will occur in the external scheduling system.Represents the ID of the patient in the external scheduling system.ID of the practitioner who is performing care in the encounter.Name of the external scheduling system from which the record was sourced.
---
# CancelAppointmentRequest Class

Contains set of options to cancel the booked appointment.

## Namespace

[healthcloudext](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/apex_namespace_healthcloudext.htm "The HealthCloudExt namespace provides an interface and classes for Health Cloud to integrate with a source electronic health records (EHR) system.")

- **[CancelAppointmentRequest Properties](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/apex_class_healthcloudext_CancelAppointmentRequest.htm#apex_healthcloudext_CancelAppointmentRequest_properties)**

## CancelAppointmentRequest Properties

The following are properties for CancelAppointmentRequest.

- **[appointmentId](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/apex_class_healthcloudext_CancelAppointmentRequest.htm#apex_healthcloudext_CancelAppointmentRequest_appointmentId)**  
    Unique ID of the appointment in Health Cloud. The appointment ID comes from the ServiceAppointment object.
- **[appointmentType](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/apex_class_healthcloudext_CancelAppointmentRequest.htm#apex_healthcloudext_CancelAppointmentRequest_appointmentType)**  
    Represents the type of appointment, such as annual physical or intake examination.
- **[cancelationReason](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/apex_class_healthcloudext_CancelAppointmentRequest.htm#apex_healthcloudext_CancelAppointmentRequest_cancelationReason)**  
    Represents the reason for canceling the appointment.
- **[serviceType](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/apex_class_healthcloudext_CancelAppointmentRequest.htm#apex_healthcloudext_CancelAppointmentRequest_serviceType)**  
    Specifies the type of service to be performed at the appointment, such as dental cleaning or surgery.
- **[slot](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/apex_class_healthcloudext_CancelAppointmentRequest.htm#apex_healthcloudext_CancelAppointmentRequest_slot)**  
    Represents the time period slot that’s assigned to the appointment.
- **[sourceFacilityId](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/apex_class_healthcloudext_CancelAppointmentRequest.htm#apex_healthcloudext_CancelAppointmentRequest_sourceFacilityId)**  
    Represents the healthcare facility where the encounter will occur in the external scheduling system.
- **[sourcePatientId](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/apex_class_healthcloudext_CancelAppointmentRequest.htm#apex_healthcloudext_CancelAppointmentRequest_sourcePatientId)**  
    Represents the ID of the patient in the external scheduling system.
- **[sourcePractitionerId](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/apex_class_healthcloudext_CancelAppointmentRequest.htm#apex_healthcloudext_CancelAppointmentRequest_sourcePractitionerId)**  
    ID of the practitioner who is performing care in the encounter.
- **[sourceSystem](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/apex_class_healthcloudext_CancelAppointmentRequest.htm#apex_healthcloudext_CancelAppointmentRequest_sourceSystem)**  
    Name of the external scheduling system from which the record was sourced.

### appointmentId

Unique ID of the appointment in Health Cloud. The appointment ID comes from the ServiceAppointment object.

#### Signature

public String appointmentId {get; set;}

#### Property Value

Type: [String](https://developer.salesforce.com/docs/atlas.en-us.264.0.apexref.meta/apexref/apex_methods_system_string.htm)

### appointmentType

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

#### Signature

public String appointmentType {get; set;}

#### Property Value

Type: [String](https://developer.salesforce.com/docs/atlas.en-us.264.0.apexref.meta/apexref/apex_methods_system_string.htm)

### cancelationReason

Represents the reason for canceling the appointment.

#### Signature

public String cancelationReason {get; set;}

#### Property Value

Type: [String](https://developer.salesforce.com/docs/atlas.en-us.264.0.apexref.meta/apexref/apex_methods_system_string.htm)

### 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](https://developer.salesforce.com/docs/atlas.en-us.264.0.apexref.meta/apexref/apex_methods_system_string.htm)

### slot

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

#### Signature

public String slot {get; set;}

#### Property Value

Type: [String](https://developer.salesforce.com/docs/atlas.en-us.264.0.apexref.meta/apexref/apex_methods_system_string.htm)

### sourceFacilityId

Represents the healthcare facility where the encounter will occur in the external scheduling system.

#### Signature

public String sourceFacilityId {get; set;}

#### Property Value

Type: [String](https://developer.salesforce.com/docs/atlas.en-us.264.0.apexref.meta/apexref/apex_methods_system_string.htm)

### sourcePatientId

Represents the ID of the patient in the external scheduling system.

#### Signature

public String sourcePatientId {get; set;}

#### Property Value

Type: [String](https://developer.salesforce.com/docs/atlas.en-us.264.0.apexref.meta/apexref/apex_methods_system_string.htm)

### sourcePractitionerId

ID of the practitioner who is performing care in the encounter.

#### Signature

public String sourcePractitionerId {get; set;}

#### Property Value

Type: [String](https://developer.salesforce.com/docs/atlas.en-us.264.0.apexref.meta/apexref/apex_methods_system_string.htm)

### sourceSystem

Name of the external scheduling system from which the record was sourced.

#### Signature

public String sourceSystem {get; set;}

#### Property Value

Type: [String](https://developer.salesforce.com/docs/atlas.en-us.264.0.apexref.meta/apexref/apex_methods_system_string.htm)