V1 backend catalog

CareFlow API

Operational catalog for the CareFlow backend surface area.

Token Endpoint Health Check Django Admin Current User

Filter endpoints

Search by section, method, path, or description, then use the section links below for quick jumps through the catalog.

Sections
Authentication 8 endpoints Patient Portal 24 endpoints Organizations 13 endpoints Facilities 9 endpoints Patients 9 endpoints Insurance 6 endpoints Appointments 6 endpoints Clinical 5 endpoints Medications 4 endpoints Allergies 4 endpoints Billing 9 endpoints Audit 2 endpoints System 2 endpoints

Authentication

Token, session, and user bootstrap endpoints.

8 endpoints
POST /v1/users/token/
Obtain JWT access and refresh tokens.
GET /v1/users/csrf/
Issue a CSRF cookie for cookie-backed auth routes.
POST /v1/users/token/refresh/
Refresh an access token.
POST /v1/users/logout/
Clear the refresh cookie and end the current session.
POST /v1/users/demo-login/
Log in with demo credentials when demo mode is enabled.
POST /v1/users/register/
Register a new user.
GET /v1/users/me/
Return the current user, organization membership, and facility context.
PATCH /v1/users/me/preferences/
Update current-user preferences such as theme and last facility.

Patient Portal

Patient-scoped auth, self-service scheduling, profile, clinical summary, refills, and messaging.

24 endpoints
POST /v1/portal/auth/login/
Authenticate a patient portal account and issue a portal-scoped session.
POST /v1/portal/auth/refresh/
Refresh a portal-scoped access token.
POST /v1/portal/auth/logout/
Clear the portal refresh cookie and end the portal session.
POST /v1/portal/demo-login/
Log in with the synthetic patient demo account when demo mode is enabled.
GET /v1/portal/me/
Return the linked patient profile and portal preferences for the authenticated patient.
PATCH /v1/portal/me/
Update patient-managed profile fields and portal preferences.
PATCH /v1/portal/me/preferred-pharmacy/
Update the patient's preferred pharmacy within the effective facility pharmacy list.
GET /v1/portal/appointments/
List the patient's appointments.
POST /v1/portal/appointments/<id>/cancel/
Cancel an eligible portal appointment.
GET /v1/portal/scheduling/providers/
List providers available for portal self-scheduling.
GET /v1/portal/scheduling/appointment-types/
List appointment types exposed to portal self-scheduling.
GET /v1/portal/scheduling/slots/
List bookable portal scheduling slots.
POST /v1/portal/scheduling/book/
Book a portal appointment for the authenticated patient.
GET /v1/portal/medications/
List patient-visible active and historical medication records.
GET /v1/portal/refill-requests/
List the patient's refill requests.
POST /v1/portal/refill-requests/
Create a patient-initiated refill request for an active medication.
POST /v1/portal/refill-requests/<id>/cancel/
Cancel an eligible pending refill request.
GET /v1/portal/pharmacies/
List pharmacies available to the patient's facility.
GET /v1/portal/allergies/
List patient-visible allergy and adverse reaction records.
GET /v1/portal/medical-summary/
Return the patient's portal medical summary, including recent visits, vitals, medications, and allergies.
GET /v1/portal/messaging/threads/
List the patient's message threads.
POST /v1/portal/messaging/threads/
Start a patient message thread with the care team.
GET /v1/portal/messaging/threads/<id>/
Retrieve one patient message thread.
POST /v1/portal/messaging/threads/<id>/reply/
Reply to an open patient message thread.

Organizations

Organization profile and people administration.

13 endpoints
GET /v1/organizations/
Return the current organization for the authenticated user.
GET /v1/organizations/<id>/
Retrieve organization overview details, members, and summary data.
PATCH /v1/organizations/<id>/
Update organization contact and overview fields.
GET /v1/organizations/people/
List organization people and roles.
POST /v1/organizations/people/
Create a new organization-level user and membership.
PATCH /v1/organizations/people/<id>/
Update organization person details and membership role.
GET /v1/organizations/pharmacies/
List organization pharmacy preferences linked to the global directory.
POST /v1/organizations/pharmacies/
Link an existing pharmacy or import a custom pharmacy for the organization.
PATCH /v1/organizations/pharmacies/<id>/
Update organization pharmacy preference details.
GET /v1/organizations/facility-pharmacy-overrides/?facility_id=<id>
List facility-specific pharmacy overrides.
GET /v1/organizations/roles/
List organization role types.
GET /v1/organizations/security/
List organization role security permissions.
PATCH /v1/organizations/security/update-role/
Update organization role security permissions.

Facilities

Facility profile, staff, and configuration dictionaries.

9 endpoints
GET /v1/facilities/
List facilities for the current organization.
PATCH /v1/facilities/<id>/
Update facility profile, operating hours, and operational details.
GET /v1/facilities/staff/?facility_id=<id>
List facility staff assignments.
GET /v1/facilities/appointment-statuses/?facility_id=<id>
List appointment statuses for a facility.
GET /v1/facilities/appointment-types/?facility_id=<id>
List appointment types and scheduling defaults.
GET /v1/facilities/resources/?facility_id=<id>
List rooms, providers, and schedule resources for a facility.
GET /v1/facilities/staff-roles/?facility_id=<id>
List configurable staff roles.
GET /v1/facilities/staff-titles/?facility_id=<id>
List staff titles.
GET /v1/facilities/patient-genders/?facility_id=<id>
List patient gender options.

Patients

Patient records plus supporting clinical-contact data.

9 endpoints
GET /v1/patients/?facility_id=<id>&search=smith
Quick patient lookup by last name or "Last, First".
POST /v1/patients/?facility_id=<id>
Create a patient record in the selected facility.
PATCH /v1/patients/<id>/?facility_id=<id>
Update patient demographics, care team, and pharmacy details.
GET /v1/patients/<id>/reveal-ssn/?facility_id=<id>
Reveal a masked patient SSN and record an audit event.
GET /v1/patients/document-categories/?facility_id=<id>
List patient document categories for a facility.
GET /v1/patients/documents/?facility_id=<id>&patient_id=<id>
List document metadata for a patient.
POST /v1/patients/documents/bundle/view/?facility_id=<id>
Build a combined preview PDF for selected patient documents.
GET /v1/patients/pharmacies/?facility_id=<id>
List facility-effective pharmacies from organization pharmacy settings and facility overrides.
GET /v1/patients/providers/?facility_id=<id>
List PCP and referring provider records for the selected facility.

Insurance

Insurance carrier dictionary and patient coverage records.

6 endpoints
GET /v1/insurance/carriers/?facility_id=<id>
List facility-effective insurance carriers from organization payer settings and facility overrides.
GET /v1/insurance/organization-carriers/
List organization payer preferences.
GET /v1/insurance/facility-carrier-overrides/?facility_id=<id>
List facility-specific payer overrides.
GET /v1/insurance/policies/?facility_id=<id>&patient_id=<id>
List patient insurance policies within the selected facility.
POST /v1/insurance/policies/?facility_id=<id>
Create a patient insurance policy.
PATCH /v1/insurance/policies/<id>/?facility_id=<id>
Update patient insurance policy details.

Appointments

Scheduling, visit logistics, and appointment notes.

6 endpoints
GET /v1/appointments/?facility_id=<id>&date=2026-04-21
List appointments for a selected date.
POST /v1/appointments/?facility_id=<id>
Create an appointment with visit mode, room, and instructions.
PATCH /v1/appointments/<id>/?facility_id=<id>
Update appointment schedule, status, and operational notes.
GET /v1/appointments/heatmap/?facility_id=<id>&month=2026-04
Return appointment counts per local date for a schedule heatmap.
GET /v1/appointments/<id>/edit-session/?facility_id=<id>
Check appointment edit-session occupancy.
GET /v1/appointments/<id>/history/?facility_id=<id>
List audit-style history for an appointment.

Clinical

Facility-scoped encounters and progress note charting.

5 endpoints
GET /v1/clinical/encounters/?facility_id=<id>&patient_id=<id>
List patient encounters and nested progress notes.
POST /v1/clinical/encounters/?facility_id=<id>
Start a clinical encounter with an optional draft progress note.
PATCH /v1/clinical/progress-notes/<id>/?facility_id=<id>
Update a draft progress note.
POST /v1/clinical/progress-notes/<id>/sign/?facility_id=<id>
Sign a progress note and lock it from further edits.
POST /v1/clinical/progress-notes/<id>/unsign/?facility_id=<id>
Reopen a signed progress note when the user is permitted.

Medications

Facility-scoped patient medication records.

4 endpoints
GET /v1/medications/?facility_id=<id>&patient_id=<id>
List medication records for a patient.
POST /v1/medications/?facility_id=<id>
Create a patient medication record.
PATCH /v1/medications/<id>/?facility_id=<id>
Update medication details, status, dates, and notes.
DELETE /v1/medications/<id>/?facility_id=<id>
Mark a medication as discontinued.

Allergies

Facility-scoped patient allergy and adverse reaction records.

4 endpoints
GET /v1/allergies/patient-allergies/?facility_id=<id>&patient_id=<id>
List allergy and adverse reaction records for a patient.
POST /v1/allergies/patient-allergies/?facility_id=<id>
Create a patient allergy or adverse reaction record.
PATCH /v1/allergies/patient-allergies/<id>/?facility_id=<id>
Update allergy reaction, severity, status, onset, and notes.
DELETE /v1/allergies/patient-allergies/<id>/?facility_id=<id>
Mark an allergy record as entered in error.

Billing

Encounter-linked superbills and charge capture.

9 endpoints
GET /v1/billing/encounter-billing-records/?facility_id=<id>&patient_id=<id>
List patient superbills and charge-capture records.
POST /v1/billing/encounter-billing-records/?facility_id=<id>
Create a billing record for a signed encounter.
PATCH /v1/billing/encounter-billing-records/<id>/?facility_id=<id>
Update diagnosis codes, charge lines, and billing status.
GET /v1/billing/fee-schedule-items/?facility_id=<id>
List facility-effective fee schedule items merged from organization defaults and facility overrides.
GET /v1/billing/organization-fee-schedules/
List organization fee schedule sheets.
GET /v1/billing/facility-fee-schedules/?facility_id=<id>
List facility-specific fee schedule sheets.
POST /v1/billing/facility-fee-schedules/copy-from-org/?facility_id=<id>
Create a facility fee schedule from an organization schedule.
GET /v1/billing/cpt-catalog/
List predefined CPT codes with descriptions and suggested fees.
POST /v1/billing/organization-fee-schedules/<id>/populate/
Populate a fee schedule sheet with all predefined CPT codes that are not already present.

Audit

Read-only audit trail for organization admins and facility-scoped facility admins.

2 endpoints
GET /v1/audit/events/
List audit events. Organization admins can use scope=organization for org-only activity; facility admins must filter to a facility they manage. Filterable by action, app_label, facility, patient, and scope.
GET /v1/audit/events/<id>/
Retrieve a single audit event.

System

Health and operational entrypoints.

2 endpoints
GET /health/
Basic health check endpoint.
GET /admin/
Django admin console.