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.

  • jsonResponse

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

  • note

    Represents optional extra information added to the appointment.

  • patientId

    Represents the unique identifier of the patient in Health Cloud.

  • slotEnd

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

  • slotStart

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

  • sourceAppointmentId

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

  • sourcePatientId

    Represents the ID of the patient in the source system.

  • sourceSystem

    Represents the name of the external scheduling system from which the record was sourced.

  • 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

jsonResponse 

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

Signature 

public String jsonResponse {get; set;}

Property Value 

Type: String

note 

Represents optional extra information added to the appointment.

Signature 

public String note {get; set;}

Property Value 

Type: String

patientId 

Represents the unique identifier of the patient in Health Cloud.

Signature 

public String patientId {get; set;}

Property Value 

Type: String

slotEnd 

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

Signature 

public String slotEnd {get; set;}

Property Value 

Type: String

slotStart 

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

Signature 

public String slotStart {get; set;}

Property Value 

Type: String

sourceAppointmentId 

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

Signature 

public String sourceAppointmentId {get; set;}

Property Value 

Type: String

sourcePatientId 

Represents the ID of the patient in the source system.

Signature 

public String sourcePatientId {get; set;}

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

Property Value 

Type: String

status 

Represents the status of the appointment.

Signature 

public healthcloudext.BookingStatus status {get; set;}

Property Value 

Type: healthcloudext.BookingStatus