Clinic Patients API

Endpoints for managing patients within the clinic system.

List Patients

Get a paginated list of patients.

Endpoint: GET /v1/clinic/patients
Authentication: Required

Query Parameters

Parameter	Type	Required	Description
`page`	integer	No	Page number for pagination (default: 1)
`page_size`	integer	No	Number of items per page (default: 25)
`sort_by`	string	No	Field to sort by (e.g., “id”)
`sort_dir`	string	No	Sort direction (“ASC” or “DESC”)
`search`	string	No	Search term to filter patients

Example Request


GET /v1/clinic/patients?page=1&page_size=25&sort_by=id&sort_dir=DESC&search=Tyler HTTP/1.1
Content-Type: application/json
X-User-Token: your_token_here

Filter Patients

Filter patients with advanced criteria.

Endpoint: POST /v1/clinic/patients/filter_patients
Authentication: Required

Request Body Parameters

Parameter	Type	Required	Description
`search`	string	No	Search term
`sort_by`	string	No	Field to sort by
`sort_dir`	string	No	Sort direction
`filters`	object	No	Filter criteria with available parameters: `provider_name` (string)
`page_size`	integer	No	Number of items per page

Example Request


POST /v1/clinic/patients/filter_patients HTTP/1.1
Content-Type: application/json
X-User-Token: your_token_here
 
{
  "page": 1,
  "page_size": 25,
  "sort_by": "id",
  "sort_dir": "DESC",
  "search": "Tyler"
}

Get Patient Details

Retrieve detailed information about a specific patient.

Endpoint: GET /v1/clinic/patients/{id}
Authentication: Required

Path Parameters

Parameter	Type	Required	Description
`id`	integer	Yes	Patient ID

Example Request


GET /v1/clinic/patients/1049 HTTP/1.1
Content-Type: application/json
X-User-Token: your_token_here

Get Patient Medication History

Retrieve medication history for a specific patient.

Endpoint: GET /v1/clinic/patients/{id}/medication_history
Authentication: Required

Path Parameters

Parameter	Type	Required	Description
`id`	integer	Yes	Patient ID

Example Request


GET /v1/clinic/patients/1049/medication_history HTTP/1.1
Content-Type: application/json
X-User-Token: your_token_here

Patient Documents

Manage documents associated with patients.

Endpoint: GET /v1/clinic/patients/{patient_id}/documents
Authentication: Required

Path Parameters

Parameter	Type	Required	Description
`patient_id`	integer	Yes	Patient ID

Patient Appointments

List Patient Appointments

Endpoint: GET /v1/clinic/patients/appointments
Authentication: Required

Get Patient Appointment Details

Endpoint: GET /v1/clinic/patients/appointments/{id}
Authentication: Required

Patient Help Requests

List Help Requests

Endpoint: GET /v1/clinic/patients/help_requests
Authentication: Required

Create Help Request

Endpoint: POST /v1/clinic/patients/help_requests
Authentication: Required

Patient Treatment Plans

List Treatment Plans

Endpoint: GET /v1/clinic/patients/treatment_plans
Authentication: Required

Create Treatment Plan

Endpoint: POST /v1/clinic/patients/treatment_plans
Authentication: Required

Update Treatment Plan

Endpoint: PUT /v1/clinic/patients/treatment_plans/{id}
Authentication: Required

Get Treatment Plan Details

Endpoint: GET /v1/clinic/patients/treatment_plans/{id}
Authentication: Required

Get Last Treatment Plan

Endpoint: GET /v1/clinic/patients/treatment_plans/last
Authentication: Required

Patient Session Notes

List Session Notes

Endpoint: GET /v1/clinic/patients/session_notes
Authentication: Required

Create Session Note

Endpoint: POST /v1/clinic/patients/session_notes
Authentication: Required

Update Session Note

Endpoint: PUT /v1/clinic/patients/session_notes/{id}
Authentication: Required

Get Session Note Details

Endpoint: GET /v1/clinic/patients/session_notes/{id}
Authentication: Required

Get Last Session Note

Endpoint: GET /v1/clinic/patients/session_notes/last
Authentication: Required

Patient Questionnaires

List Questionnaires

Endpoint: GET /v1/clinic/patients/questionnaires
Authentication: Required

Get Questionnaire Details

Endpoint: GET /v1/clinic/patients/questionnaires/{id}
Authentication: Required

Patient Spots

Get Patient Spot

Endpoint: GET /v1/clinic/patients/{patient_id}/spot
Authentication: Required

Create Patient Spot

Endpoint: POST /v1/clinic/patients/{patient_id}/spot
Authentication: Required

Update Patient Spot

Endpoint: PATCH /v1/clinic/patients/{patient_id}/spot/{id}
Authentication: Required

Patient Filters

Get available filter options for patients.

Endpoint: GET /v1/clinic/patients/filters
Authentication: Required

Patient On-Call Appointments

Endpoint: GET /v1/clinic/patients/on_call/appointments/{id}
Authentication: Required