Admin Clinic Session Notes API

Administrative endpoints for managing session notes within the clinic system.

Filter Session Notes

Filter and search session notes with advanced criteria.

Endpoint: POST /v1/admin/clinic/session_notes/filter_notes
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: `date` (object with start_date/end_date), `status` (string/array), `appointment_type` (string), `patient_name` (string), `provider_name` (string)
`page_size`	integer	No	Number of items per page

Example Request


POST /v1/admin/clinic/session_notes/filter_notes HTTP/1.1
Content-Type: application/json
X-User-Token: your_admin_token_here
 
{
  "search": "therapy session",
  "filters": {
    "date": {
      "start_date": "2023-10-01",
      "end_date": "2023-10-31"
    },
    "status": ["completed", "pending_review"],
    "appointment_type": "individual_therapy",
    "provider_name": "Dr. Smith"
  },
  "sort_by": "created_at",
  "sort_dir": "DESC",
  "page_size": 50
}

Response Format


{
  "session_notes": [
    {
      "id": 123,
      "appointment_id": 456,
      "provider_id": 789,
      "patient_id": 1011,
      "status": "completed",
      "session_summary": "Patient showed improvement...",
      "created_at": "2023-10-15T14:30:00.000Z",
      "updated_at": "2023-10-15T15:45:00.000Z"
    }
  ],
  "pagination": {
    "current_page": 1,
    "total_pages": 5,
    "total_count": 125,
    "per_page": 50
  }
}

Error Responses

422 Unprocessable Entity


{
  "errors": "No session notes were found."
}

Notes

All admin clinic endpoints require administrative privileges
Session notes are filtered based on clinic-wide access permissions
The status filter can accept either a single string or an array of status values
Date filters use ISO 8601 format (YYYY-MM-DD)