BookAppointmentRequest Class

Contains set of options to book a healthcare appointment.

healthcloudext

To book an appointment, we need to know the availability of a given practitioner at a given facility. To get this information, Health Cloud queries the specific source EHR system, using the IDs of the practitioner and the facility as stored in that source system.

Practitioner and Facility IDs:

• The source system ID comes from the Healthcare Practitioner Facility record for the practitioner+facility combination.
• The source system facility ID comes from an Identifier record that looks up to the Contact record for the practitioner, with the same source system as the Healthcare Practitioner Facility record.
• The source system facility ID comes from an Identifier record that looks up to the Account record for the facility, with the same source system as the Healthcare Practitioner Facility record.

The source system requires Appointment Type and Service Type codes that are derived from the “visit type” (Work Type record) selected by the call center agent. These codes are configured via Work Type Code Set Bundle records, one per Work Type, with lookups to Code Set Bundle and Code Sets for the Service Type and Appointment Type codes in each Source System the org integrates with.

• BookAppointmentRequest Properties

The following are properties for BookAppointmentRequest.

• appointmentType

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

• note

  Represents optional extra information about 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 ID in the source system of the facility where the encounter will occur.

• sourcePatientId

  Represents the ID in the source system of the patient.

• sourcePractitionerId

  Represents the ID in the source system of the practitioner with whom the encounter will occur.

• sourceSystem

  Represents the name of the source system the patient record came from.

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

public String appointmentType {get; set;}

Type: String

Represents optional extra information about the appointment.

public String note {get; set;}

Type: String

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

public String serviceType {get; set;}

Type: String

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

public String slot {get; set;}

Type: String

Represents the ID in the source system of the facility where the encounter will occur.

public String sourceFacilityId {get; set;}

Type: String

Represents the ID in the source system of the patient.

public String sourcePatientId {get; set;}

Type: String

Represents the ID in the source system of the practitioner with whom the encounter will occur.

public String sourcePractitionerId {get; set;}

Type: String

Represents the name of the source system the patient record came from.

public String sourceSystem {get; set;}

Type: String

j

Health Cloud 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

HealthCloudExt Namespace

HealthCloudExt Namespace for Intelligent Appointment Management

AppointmentBase Class

AppointmentBookingInterop Interface

AppointmentBookingInteropFhirAdapter Class

AppointmentProvider Class

BookAppointmentRequest Class

BookAppointmentResponse Class

CancelAppointmentRequest Class

CancelAppointmentResponse Class

FindSlotsRequest Class

GetSlotStatusRequest Class

HomeHealth

Slot Class

BookingStatus Enum

HealthCloudExt Namespace for Benefit Verification

HealthCloudExt Namespace for Unified Health Scoring

HealthCloudExt Namespace for Intelligent Content Management

id_verification Namespace

embeddedai Namespace

BatchProcessor

DocumentAI Namespace

hlthcrbilling Namespace

Health Cloud Business APIs

Health Cloud Tooling API Objects

Health Cloud Standard Invocable Actions

Metadata Types

Health Cloud FHIR APIs

MuleSoft Direct Integrations

API End-of-Life Policy

Health Cloud Managed Package

Previous Versions