Clinic Supervisors API

Endpoints for supervisor-level operations within the clinic system.

Supervisor Session Notes

List Supervisor Session Notes

Get a list of session notes for supervisor review.

Endpoint: GET /v1/clinic/supervisors/session_notes
Authentication: Required (Supervisor role)

Query Parameters

Parameter	Type	Required	Description
`page`	integer	No	Page number for pagination
`page_size`	integer	No	Number of items per page
`sort_by`	string	No	Field to sort by
`sort_dir`	string	No	Sort direction (“ASC” or “DESC”)

Filter Supervisor Session Notes

Endpoint: POST /v1/clinic/supervisors/session_notes/filter_notes
Authentication: Required (Supervisor 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/clinic/supervisors/session_notes/filter_notes HTTP/1.1
Content-Type: application/json
X-User-Token: your_token_here
 
{
  "search": "supervision",
  "filters": {
    "date": {
      "start_date": "2023-10-01",
      "end_date": "2023-10-31"
    },
    "status": "pending_supervision",
    "provider_name": "Dr. Smith"
  },
  "sort_by": "created_at",
  "sort_dir": "DESC",
  "page_size": 50
}

Get Supervisor Session Note Details

Endpoint: GET /v1/clinic/supervisors/session_notes/{id}
Authentication: Required (Supervisor role)

Path Parameters

Parameter	Type	Required	Description
`id`	integer	Yes	Session note ID

Supervisor Session Note Filters

Get available filter options for supervisor session notes.

Endpoint: GET /v1/clinic/supervisors/session_notes/filters
Authentication: Required (Supervisor role)

Session Notes Requiring Supervision

Get session notes that require supervisor review.

Endpoint: GET /v1/clinic/supervisors/session_notes/require_supervision
Authentication: Required (Supervisor role)

Query Parameters

Parameter	Type	Required	Description
`page`	integer	No	Page number for pagination
`page_size`	integer	No	Number of items per page
`status`	string	No	Filter by supervision status
`provider_id`	integer	No	Filter by provider ID

Supervisor Appointments

List Supervisor Appointments

Get a list of appointments under supervisor oversight.

Endpoint: GET /v1/clinic/supervisors/appointments
Authentication: Required (Supervisor role)

Query Parameters

Parameter	Type	Required	Description
`page`	integer	No	Page number for pagination
`page_size`	integer	No	Number of items per page
`sort_by`	string	No	Field to sort by
`sort_dir`	string	No	Sort direction (“ASC” or “DESC”)
`provider_id`	integer	No	Filter by provider ID
`patient_id`	integer	No	Filter by patient ID
`status`	string	No	Filter by appointment status

Get Supervisor Appointment Details

Endpoint: GET /v1/clinic/supervisors/appointments/{id}
Authentication: Required (Supervisor role)

Path Parameters

Parameter	Type	Required	Description
`id`	integer	Yes	Appointment ID

Response Format

Session Note Response


{
  "id": 123,
  "patient_id": 1049,
  "provider_id": 456,
  "appointment_id": 789,
  "content": "Session notes content...",
  "status": "pending_supervision",
  "supervision_required": true,
  "supervisor_id": 171,
  "created_at": "2023-10-20T10:00:00.000Z",
  "updated_at": "2023-10-20T15:30:00.000Z",
  "addendums": [],
  "sign_offs": []
}

Appointment Response


{
  "id": 789,
  "patient_id": 1049,
  "provider_id": 456,
  "supervisor_id": 171,
  "scheduled_at": "2023-10-27T14:30:00.000Z",
  "status": "completed",
  "supervision_status": "reviewed",
  "session_note": {
    "id": 123,
    "status": "approved"
  },
  "created_at": "2023-10-20T10:00:00.000Z",
  "updated_at": "2023-10-20T15:30:00.000Z"
}

Error Responses

403 Forbidden


{
  "errors": "Supervisor access required"
}

404 Not Found


{
  "errors": "Session note not found or not under your supervision"
}

422 Unprocessable Entity


{
  "errors": {
    "provider_id": ["must be under your supervision"]
  }
}

Notes

All supervisor endpoints require supervisor-level authentication
Supervisors can only access session notes and appointments for providers under their supervision
The require_supervision endpoint returns session notes that need supervisor review before completion
Filtering options are available to help supervisors manage their oversight responsibilities efficiently