Admin Session Notes API

Administrative endpoints for managing session notes across the entire system.

List All Session Notes

Get a comprehensive list of all session notes in the system.

Endpoint: GET /v1/admin/clinic/session_notes
Authentication: Required (Admin role)

Query Parameters

Example Request

GET /v1/admin/clinic/session_notes?page=1&page_size=100&status=pending_review HTTP/1.1
Content-Type: application/json
X-User-Token: your_admin_token_here

Filter Session Notes

Filter session notes with advanced administrative criteria.

Endpoint: POST /v1/admin/clinic/session_notes/filter_notes
Authentication: Required (Admin role)

Request Body Parameters

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": "anxiety",
  "filters": {
    "date_range": {
      "start": "2023-10-01",
      "end": "2023-10-31"
    },
    "status": "completed",
    "provider_id": 456
  },
  "page_size": 50
}

Get Session Note Details

Endpoint: GET /v1/admin/clinic/session_notes/{id}
Authentication: Required (Admin role)

Path Parameters

Example Request

GET /v1/admin/clinic/session_notes/123 HTTP/1.1
Content-Type: application/json
X-User-Token: your_admin_token_here

Delete Session Note

Endpoint: DELETE /v1/admin/clinic/session_notes/{id}
Authentication: Required (Admin role)

Path Parameters

Session Note Addendums

Create Session Note Addendum

Endpoint: POST /v1/admin/clinic/session_notes/addendums
Authentication: Required (Admin role)

Request Body Parameters

Example Request

POST /v1/admin/clinic/session_notes/addendums HTTP/1.1
Content-Type: application/json
X-User-Token: your_admin_token_here
 
{
  "session_note_id": 46,
  "addendum": {
    "instructions": "Please fix this issue asap, names don't match"
  }
}

Update Session Note Addendum

Endpoint: PUT /v1/admin/clinic/session_notes/addendums/{id}
Authentication: Required (Admin role)

Path Parameters

Request Body Parameters

Example Request

PUT /v1/admin/clinic/session_notes/addendums/33 HTTP/1.1
Content-Type: application/json
X-User-Token: your_admin_token_here
 
{
  "addendum": {
    "instructions_response": "Fixing the names with the correct data"
  }
}

Session Note Sign-offs

Create Session Note Sign-off

Endpoint: POST /v1/admin/clinic/session_notes/sign_offs
Authentication: Required (Admin role)

Request Body Parameters

Example Request

POST /v1/admin/clinic/session_notes/sign_offs HTTP/1.1
Content-Type: application/json
X-User-Token: your_admin_token_here
 
{
  "session_note_id": 46,
  "sign_off": {
    "instructions": "Please fix this issue asap, names don't match",
    "review_date": "2023-10-27T21:40:00.000Z",
    "signature": "data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAABgAAAAYCAYAAADgdz34..."
  }
}

Update Session Note Sign-off

Endpoint: PUT /v1/admin/clinic/session_notes/sign_offs/{id}
Authentication: Required (Admin role)

Delete Session Note Sign-off

Endpoint: DELETE /v1/admin/clinic/session_notes/sign_offs/{id}
Authentication: Required (Admin role)

Session Note Filters

Get available filter options for admin session note searches.

Endpoint: GET /v1/admin/clinic/session_notes/filters
Authentication: Required (Admin role)

Response Format

Session Note Response

{
  "id": 123,
  "patient_id": 1049,
  "provider_id": 456,
  "appointment_id": 789,
  "content": "Session notes content...",
  "status": "completed",
  "supervision_required": true,
  "supervisor_id": 171,
  "created_at": "2023-10-20T10:00:00.000Z",
  "updated_at": "2023-10-20T15:30:00.000Z",
  "addendums": [
    {
      "id": 39,
      "instructions": "Please clarify diagnosis",
      "instructions_response": "Updated with DSM-5 criteria"
    }
  ],
  "sign_offs": [
    {
      "id": 25,
      "reviewer_id": 171,
      "review_date": "2023-10-27T21:40:00.000Z",
      "signature": "data:image/png;base64,..."
    }
  ]
}

Session Note Status Values

• draft - Session note is being written
• pending_review - Waiting for supervisor review
• pending_signature - Waiting for signature
• completed - Session note is complete
• requires_addendum - Addendum requested
• archived - Session note has been archived

Error Responses

403 Forbidden

{
  "errors": "Admin access required"
}

422 Unprocessable Entity

{
  "errors": {
    "session_note_id": ["can't be blank"],
    "instructions": ["can't be blank"],
    "signature": ["invalid format"]
  }
}

404 Not Found

{
  "errors": "Session note not found"
}

Notes

• All admin session note endpoints require administrative privileges
• Session notes can be filtered by multiple criteria for compliance reporting
• Addendums allow for corrections and clarifications to completed notes
• Sign-offs provide supervisor approval and compliance tracking
• Signatures should be provided as base64 encoded PNG images
• Deletion of session notes may be restricted based on compliance requirements
• All changes to session notes are tracked for audit purposes