Admin Clinic Patients API

Administrative endpoints for managing patients within the clinic system.

Filter Patients

Filter and search patients with advanced criteria.

Endpoint: POST /v1/admin/clinic/patients/filter_patients
Authentication: Required (Admin role)

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: `eligibility_status` (string), `insurance_plan_id` (integer), `ready_for_services` (boolean), `date` (object with start_date/end_date), `member_ids` (array), `provider_name` (string)
`page_size`	integer	No	Number of items per page

Example Request


POST /v1/admin/clinic/patients/filter_patients HTTP/1.1
Content-Type: application/json
X-User-Token: your_admin_token_here
 
{
  "search": "anxiety treatment",
  "filters": {
    "eligibility_status": "active",
    "insurance_plan_id": 123,
    "ready_for_services": true,
    "date": {
      "start_date": "2023-10-01",
      "end_date": "2023-10-31"
    },
    "member_ids": ["MEM001", "MEM002"],
    "provider_name": "Dr. Johnson"
  },
  "sort_by": "updated_at",
  "sort_dir": "DESC",
  "page_size": 25
}

Response Format


{
  "patients": [
    {
      "id": 1049,
      "user_id": 2048,
      "eligibility_status": "active",
      "insurance_plan_id": 123,
      "ready_for_services": true,
      "created_at": "2023-10-01T10:00:00.000Z",
      "updated_at": "2023-10-15T14:30:00.000Z",
      "user": {
        "first_name": "John",
        "last_name": "Doe",
        "email": "[email protected]"
      }
    }
  ],
  "pagination": {
    "current_page": 1,
    "total_pages": 3,
    "total_count": 75,
    "per_page": 25
  }
}

Error Responses

422 Unprocessable Entity


{
  "errors": "No patients were found."
}

Notes

All admin clinic endpoints require administrative privileges
Patients are filtered based on clinic-wide access permissions
The member_ids filter accepts an array of member ID strings
The ready_for_services filter is a boolean indicating patient readiness
Date filters use ISO 8601 format (YYYY-MM-DD)