REST API

DexCare provides a RESTful service for customers to access business information and perform actions against their DexCare managed environments.

For the purposes of this documentation, we will reference DexCare’s service, web sites, and configuration.

Domains

Each DexCare customer is provided with two tiers, each with a specific domain to access the APIs.

There will be a user acceptance testing (UAT) tier, and a production (PRD) tier. This document presents all URL examples with the DexCare demo tier, Acme.

Using Acme as an example health system, there would be two tiers and the would be named the following:

  • UAT: api.care-uat.dexcarehealth.com

  • PRD: api.care.dexcarehealth.com

Because Acme is a demo tier, the UAT version of Acme doesn’t exist and is presented as an example. The PRD version of Acme will be used in all examples below and can be used to try out the calls.

Your health system will be provided with the domain to use in your URLs.

Authentication

Certain API calls require a JSON web token (JWT) for authentication that is returned by an OAuth sign-in or SSO process.

The calls that require a JWT in the header will be indicated with annotation of 

AUTH TOKEN REQUIRED

Booking APIs

The DexCare offers booking of in-clinic visits through its APIs.

Types of Booking

Two factors come into play when booking.

  • provider type: provider-agnostic / provider-direct
  • booking type: scheduled / on-demand

These two items define the four base booking mechanisms supported by the DexCare platform.

Provider Specific, Scheduled

This is for when the patient is booking for a specific timeslot and a specific provider.

Examples include primary care office visits and specialist office visits.

Provider Specific, On-Demand

This covers the use cases where the patient is getting in a queue to be seen as-soon-as-possible and are booking with a specific provider.

Provider Agnostic, Scheduled

Covers the use cases where the patient is booking a specific timeslot but are not booking with a specific provider.

Examples include low acuity clinics run with physicians from a pool and another would be physician’s office that support scheduled flu shots, vaccines, or COVID19 tests.

Provider Agnostic, On-Demand

Covers the use cases where the patient is getting in a queue to be seen as-soon-as-possible but are not booking with a specific provider.

Examples include DexCare’s virtual product where the patient enters the waiting room immediately upon booking.

Another example would be a patient “getting in line” or walking into an Urgent Care clinic.

Additional Use Case Support

In many of the calls to the DexCare platform you will see a product parameter.

This parameter is optional but allows DexCare to better support different use cases.

For instance, if you make timeslot calls from a Find A Doctor section you might make “product=findadoctor”.

If you were calling from a Get a Flu Shot web page you might make “product=flushot”.

Doing this allows DexCare to quickly identify which of your use cases are having issues.

API Pages

Below are links to the different functionality and uses cases supported by our API.

Patient API

Provider Agnostic Time Slots API

Provider Specific Time Slots API

Virtual Visit API

Reporting API