Carebit API
API reference
Every endpoint below returns a flat JSON object. Nested resources are linked from a links map so you can traverse without a second query.
Use this healthcare API reference to connect practice management systems, EHR and EPR software, laboratories, patient applications, and clinical workflows with Carebit.
OAuth
Create, inspect, and revoke OAuth 2.0 access tokens.
Agenda
A Clinician's diary, including Bookings, availability, and unavailability.
Availability Periods
Set when Clinicians can and cannot be booked, including repeating schedules.
Availability Slots
Find slots that a Clinician can be booked into.
Bookings
Appointments booked for Patients.
Clinicians
Clinicians enabled in the Organization.
Digital Form Responses
Patient responses to DigitalForms.
Digital Forms
Forms and consent requests that Patients can complete.
Expirable Files
Temporary files created by asynchronous API requests.
Human Tasks
Work assigned to staff members.
Invoices
Invoices associated with Bookings and Patients.
Leads
Patient inquiries and referrals received by the Organization.
Letters
Letters written or received on behalf of a Patient.
Lists
Lists and the Patients who belong to them.
- get
/v1/listsList Lists - post
/v1/listsCreate a List - get
/v1/lists/:idGet a List - patch
/v1/lists/:idUpdate a List - delete
/v1/lists/:idDelete a List - get
/v1/lists/:list_id/membersList members of a List - post
/v1/lists/:list_id/membersAdd a member to a List - delete
/v1/lists/:list_id/members/:idRemove a member from a List
Locations
Locations where Bookings can take place.
Notes
Free-form Notes attached to Patients and Bookings.
Organization
The Organization connected to the access token.
Patient Connections
Unlocked registrations between a Patient and an Organization, including GP practices.
- get
/v1/patients/:patient_id/connectionsList a Patient's unlocked PatientConnections - post
/v1/patients/:patient_id/connectionsCreate a PatientConnection - get
/v1/patients/:patient_id/connections/:idGet an unlocked PatientConnection - patch
/v1/patients/:patient_id/connections/:idUpdate this Organization's PatientConnection
Patients
Patients with an active connection to the Organization.
Payments
Payments collected for Invoices and Patients.
Payors
The people and organizations responsible for a Patient's charges.
- get
/v1/alternative_payorsList Alternative Payors - get
/v1/alternative_payors/:idGet an Alternative Payor - get
/v1/insurance_companiesList Insurance Companies - get
/v1/insurance_companies/:idGet an Insurance Company - get
/v1/patients/:patient_id/payorsList a Patient's Payors - post
/v1/patients/:patient_id/payorsCreate a Patient Payor - get
/v1/patients/:patient_id/payors/:idGet a Patient Payor - patch
/v1/patients/:patient_id/payors/:idUpdate a Patient Payor
Remote File Import Batches
The progress of files being imported in the background.
Reports
Reports created asynchronously by Carebit.
Services
The Services offered by the Organization and the ServiceVariants that can be booked.
Staff Members
Staff members in the Organization who can be assigned HumanTasks.
Test Results
Structured or file-based Test Results.
Transmissions
Delivery logs for DigitalForms sent to Patients.