CancelAppointmentRequest Class

Contains set of options to cancel the booked appointment.

Namespace 

healthcloudext

CancelAppointmentRequest Properties 

The following are properties for CancelAppointmentRequest.

  • appointmentId

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

  • appointmentType

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

  • cancelationReason

    Represents the reason for canceling the appointment.

  • serviceType

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

  • slot

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

  • sourceFacilityId

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

  • sourcePatientId

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

  • sourcePractitionerId

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

  • 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

appointmentType 

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

Signature 

public String appointmentType {get; set;}

Property Value 

Type: String

cancelationReason 

Represents the reason for canceling the appointment.

Signature 

public String cancelationReason {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 healthcare facility where the encounter will occur in the external scheduling system.

Signature 

public String sourceFacilityId {get; set;}

Property Value 

Type: String

sourcePatientId 

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

Signature 

public String sourcePatientId {get; set;}

Property Value 

Type: String

sourcePractitionerId 

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

Signature 

public String sourcePractitionerId {get; set;}

Property Value 

Type: String

sourceSystem 

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

Signature 

public String sourceSystem {get; set;}

Property Value 

Type: String