API Requirements

Examples:

We have completed API integration with multiple EMR vendors, including:

• TELUS CHR

• TELUS Practice Solution and MedAccess

• OSCAR EMR

• Pabau

Core Requirements

Our primary requirement is the ability to periodically (e.g. every 15 minutes) access all appointment data for a specific date in a read-only format. Having this ability will support 95% of key CHIME use cases

There are additional requirements to support specific features:

• To support the use case of a robust self check-in process, we need to receive patient demographic data.

• To support the use case of allowing staff to check-in patients within the EMR, we need the ability to be pull appointment data updates on a more frequent basis (e.g. every 30 seconds). For efficiency reasons, this means we need to be able to check for only “recently updated” appointment data.

• To support the use case of updating appointment data within the EMR (E.g. to denote a particular patient as checked in), we need the ability to write updates to appointments back into the EMR.

Core Required Fields

We require the following fields:

• appointment id

• appointment status

• appointment start date/time

• appointment duration

• appointment service name or id

• appointment reason/note

• appointment type

• appointment location

• clinician id

• clinician name

• patient name

Recommended Fields

The following fields are recommended, but not strictly required:

• patient preferred name

• patient phone number

• patient email address

• patient mailing address

• patient health card information (E.g. number and version code)

• patient date of birth

Exemplary Endpoints

Being provided endpoints that perform as follows is typically sufficient:

getAppointments

• parameters: time range, optional (updated since)

• response: the core and recommended fields for every matching appointment

updateAppointment

• parameters: id, updated fields

• response: success / failure