Clinic Providers API

Endpoints for managing healthcare providers within the clinic system.

Get Provider Details

Retrieve detailed information about a specific provider.

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

Path Parameters

Parameter	Type	Required	Description
`id`	integer	Yes	Provider ID

Example Request


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

Update Provider

Update provider information.

Endpoint: PUT /v1/clinic/providers/{id}
Authentication: Required

Path Parameters

Parameter	Type	Required	Description
`id`	integer	Yes	Provider ID

Request Body Parameters

Parameter	Type	Required	Description
`provider`	object	Yes	Provider data object

Example Request


PUT /v1/clinic/providers/928 HTTP/1.1
Content-Type: application/json
X-User-Token: your_token_here
 
{
  "provider": {
    "roles": ["supervisor"],
    "has_supervisor": true,
    "supervisor_id": 171
  }
}

Provider Appointments

List Provider Appointments

Get a list of appointments for a provider.

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

Query Parameters

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

Filter Provider Appointments

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

Example Request


POST /v1/clinic/providers/appointments/filter_appointments HTTP/1.1
Content-Type: application/json
X-User-Token: your_token_here
 
{
  "search": "therapy",
  "filters": {
    "date": {
      "start_date": "2023-10-01",
      "end_date": "2023-10-31"
    },
    "status": "completed",
    "appointment_type": "individual_therapy"
  },
  "sort_by": "scheduled_at",
  "sort_dir": "DESC",
  "page_size": 50
}

Get Provider Appointment Details

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

Create Provider Appointment

Endpoint: POST /v1/clinic/providers/appointments
Authentication: Required

Update Provider Appointment

Endpoint: PUT /v1/clinic/providers/appointments/{id}
Authentication: Required

Auto-save Provider Appointment

Endpoint: PATCH /v1/clinic/providers/appointments/{id}/auto_save
Authentication: Required

Delete Provider Appointment

Endpoint: DELETE /v1/clinic/providers/appointments/{id}
Authentication: Required

Mark Provider Running Late

Endpoint: POST /v1/clinic/providers/appointments/{appointment_id}/running_late
Authentication: Required

Request Body Parameters

Parameter	Type	Required	Description
`language`	string	No	Language for notification
`minutes`	integer	Yes	Minutes late

Provider Appointment Filters

Get available filter options for provider appointments.

Endpoint: GET /v1/clinic/providers/appointments/filters
Authentication: Required

Provider Appointment Reviews

List Appointment Reviews

Endpoint: GET /v1/clinic/providers/appointments/{appointment_id}/reviews
Authentication: Required

Create Appointment Review

Endpoint: POST /v1/clinic/providers/appointments/{appointment_id}/reviews
Authentication: Required

Get Appointment Review Details

Endpoint: GET /v1/clinic/providers/appointments/{appointment_id}/reviews/{id}
Authentication: Required

Update Appointment Review

Endpoint: PUT /v1/clinic/providers/appointments/{appointment_id}/reviews/{id}
Authentication: Required

Delete Appointment Review

Endpoint: DELETE /v1/clinic/providers/appointments/{appointment_id}/reviews/{id}
Authentication: Required

Provider Session Notes

List Provider Session Notes

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

Filter Provider Session Notes

Endpoint: POST /v1/clinic/providers/session_notes/filter_notes
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: `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/providers/session_notes/filter_notes HTTP/1.1
Content-Type: application/json
X-User-Token: your_token_here
 
{
  "search": "anxiety",
  "filters": {
    "date": {
      "start_date": "2023-10-01",
      "end_date": "2023-10-31"
    },
    "status": ["completed", "pending_review"],
    "appointment_type": "individual_therapy"
  },
  "sort_by": "created_at",
  "sort_dir": "DESC",
  "page_size": 50
}

Get Provider Session Note Details

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

Create Provider Session Note

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

Update Provider Session Note

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

Delete Provider Session Note

Endpoint: DELETE /v1/clinic/providers/session_notes/{id}
Authentication: Required

Provider Session Note Filters

Get available filter options for provider session notes.

Endpoint: GET /v1/clinic/providers/session_notes/filters
Authentication: Required

Provider Session Notes - Addendum Requested

Get session notes that require addendums.

Endpoint: GET /v1/clinic/providers/session_notes/addendum_requested
Authentication: Required

Provider Invites

Validate Provider Invite

Endpoint: GET /v1/clinic/providers/invites/validate
Authentication: Required

Accept Provider Invite

Endpoint: POST /v1/clinic/providers/invites/accept
Authentication: Required

List Provider Invites

Endpoint: GET /v1/clinic/providers/invites
Authentication: Required

Create Provider Invite

Endpoint: POST /v1/clinic/providers/invites
Authentication: Required

Get Provider Invite Details

Endpoint: GET /v1/clinic/providers/invites/{id}
Authentication: Required

Update Provider Invite

Endpoint: PUT /v1/clinic/providers/invites/{id}
Authentication: Required

Delete Provider Invite

Endpoint: DELETE /v1/clinic/providers/invites/{id}
Authentication: Required