Newer Version Available

This content describes an older version of this product. View Latest

Intelligent Appointment Management Operations

The available operations for Intelligent Appointment Management include finding available appointment time slots, determining the status of an appointment slot, creating an appointment, getting a scheduled appointment, and canceling an appointment.

These APIs calls out to an external system, while the Appointment Management APIs call into the system.

The URL for each operation is formed from two parts:

Protocol + Domain
This is defined in a Named Credential for appointment management.
  • Create a named credential in Setup.
  • The name of the credential must be Appointment_Management.
  • Associate the named credential with Intelligent Appointment Management in Setup under Intelligent Appointment Management Configuration.
Path
For each operation this defines the URI path following the value obtained from the Named Credential.

Each operation uses the default URI paths shown below. The default URI path for each operation can be overridden in Setup under Intelligent Appointment Management URL Configuration. If you override default URI paths with custom URIs, make corresponding changes in a custom Apex class that connects with your electronic health record (EHR) system’s middleware. Consistency between custom URI paths and custom Apex ensures that data from each endpoint is parsed as expected.

The comments in these JSON samples are for documentation purposes only and aren’t meant to be valid JSON.

Note