---
schema_version: "1"
id: f3dbc92f4dd9b0f1bd212e807a86f89a8f13d8d7a4bf225897531d3448a42439
title: BookAppointmentResponse 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_BookAppointmentResponse.md
canonical_url: https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/apex_class_healthcloudext_BookAppointmentResponse.htm
source_site: developer.salesforce.com
content_type: documentation
content_hash: 79d9947e84e640e3f37a37bc8f92b13cc09e8813dc5c5020e12070fb92b1efb7
description: Represents the appointment booking details from the external scheduling system.Represents the unique identifier of the appointment in Health Cloud.Represents the response from the external scheduling system encoded as JSON.Represents optional extra information added to the appointment.Represents the unique identifier of the patient in Health Cloud.Represents the date and time that the available time slot ends.Represents the date and time that the available time slot starts.Represents the unique identifier of the appointment in the source system.Represents the ID of the patient in the source system.Represents the name of the external scheduling system from which the record was sourced.Represents the status of the appointment.
---
# BookAppointmentResponse Class

Represents the appointment booking details from the external scheduling system.

## 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.")

- **[BookAppointmentResponse Properties](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/apex_class_healthcloudext_BookAppointmentResponse.htm#apex_healthcloudext_BookAppointmentResponse_properties)**

## BookAppointmentResponse Properties

The following are properties for BookAppointmentResponse.

- **[appointmentId](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/apex_class_healthcloudext_BookAppointmentResponse.htm#apex_healthcloudext_BookAppointmentResponse_appointmentId)**  
    Represents the unique identifier of the appointment in Health Cloud.
- **[jsonResponse](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/apex_class_healthcloudext_BookAppointmentResponse.htm#apex_healthcloudext_BookAppointmentResponse_jsonResponse)**  
    Represents the response from the external scheduling system encoded as JSON.
- **[note](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/apex_class_healthcloudext_BookAppointmentResponse.htm#apex_healthcloudext_BookAppointmentResponse_note)**  
    Represents optional extra information added to the appointment.
- **[patientId](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/apex_class_healthcloudext_BookAppointmentResponse.htm#apex_healthcloudext_BookAppointmentResponse_patientId)**  
    Represents the unique identifier of the patient in Health Cloud.
- **[slotEnd](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/apex_class_healthcloudext_BookAppointmentResponse.htm#apex_healthcloudext_BookAppointmentResponse_slotEnd)**  
    Represents the date and time that the available time slot ends.
- **[slotStart](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/apex_class_healthcloudext_BookAppointmentResponse.htm#apex_healthcloudext_BookAppointmentResponse_slotStart)**  
    Represents the date and time that the available time slot starts.
- **[sourceAppointmentId](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/apex_class_healthcloudext_BookAppointmentResponse.htm#apex_healthcloudext_BookAppointmentResponse_sourceAppointmentId)**  
    Represents the unique identifier of the appointment in the source system.
- **[sourcePatientId](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/apex_class_healthcloudext_BookAppointmentResponse.htm#apex_healthcloudext_BookAppointmentResponse_sourcePatientId)**  
    Represents the ID of the patient in the source system.
- **[sourceSystem](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/apex_class_healthcloudext_BookAppointmentResponse.htm#apex_healthcloudext_BookAppointmentResponse_sourceSystem)**  
    Represents the name of the external scheduling system from which the record was sourced.
- **[status](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/apex_class_healthcloudext_BookAppointmentResponse.htm#apex_healthcloudext_BookAppointmentResponse_status)**  
    Represents the status of the appointment.

### appointmentId

Represents the unique identifier of the appointment in Health Cloud.

#### 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)

### jsonResponse

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

#### Signature

public String jsonResponse {get; set;}

#### Property Value

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

### note

Represents optional extra information added to the appointment.

#### Signature

public String note {get; set;}

#### Property Value

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

### patientId

Represents the unique identifier of the patient in Health Cloud.

#### Signature

public String patientId {get; set;}

#### Property Value

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

### slotEnd

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

#### Signature

public String slotEnd {get; set;}

#### Property Value

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

### slotStart

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

#### Signature

public String slotStart {get; set;}

#### Property Value

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

### sourceAppointmentId

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

#### Signature

public String sourceAppointmentId {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 source 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)

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

### status

Represents the status of the appointment.

#### Signature

public healthcloudext.BookingStatus status {get; set;}

#### Property Value

Type: [healthcloudext.BookingStatus](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/apex_enum_healthcloudext_BookingStatus.htm "Represents a possible status of a healthcare appointment.")