Clinic Session Notes API

Endpoints for managing session notes and related documentation within the clinic system.

Session Note Addendums

Create Session Note Addendum

Create an addendum for a session note.

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

Request Body Parameters

Parameter	Type	Required	Description
`session_note_id`	integer	Yes	ID of the session note
`addendum`	object	Yes	Addendum data object
`addendum.instructions`	string	Yes	Instructions for the addendum
`addendum.signature`	string	No	Base64 encoded signature image

Example Request


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

Update Session Note Addendum

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

Path Parameters

Parameter	Type	Required	Description
`id`	integer	Yes	Addendum ID

Request Body Parameters

Parameter	Type	Required	Description
`session_note_id`	integer	Yes	ID of the session note
`addendum`	object	Yes	Addendum data object
`addendum.instructions_response`	string	No	Response to the instructions
`addendum.responded_signature`	string	No	Base64 encoded response signature

Example Request


PUT /v1/clinic/session_notes/addendums/39 HTTP/1.1
Content-Type: application/json
X-User-Token: your_token_here
 
{
  "session_note_id": 46,
  "addendum": {
    "instructions_response": "Fixing the names with the correct data"
  }
}

Session Note Sign-offs

Create Session Note Sign-off

Create a sign-off for a session note.

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

Request Body Parameters

Parameter	Type	Required	Description
`session_note_id`	integer	Yes	ID of the session note
`sign_off`	object	Yes	Sign-off data object
`sign_off.instructions`	string	No	Instructions for the sign-off
`sign_off.review_date`	string	Yes	Review date (ISO 8601 format)
`sign_off.signature`	string	Yes	Base64 encoded signature image

Example Request


POST /v1/clinic/session_notes/sign_offs HTTP/1.1
Content-Type: application/json
X-User-Token: your_token_here
 
{
  "session_note_id": 99,
  "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/clinic/session_notes/sign_offs/{id}
Authentication: Required

Path Parameters

Parameter	Type	Required	Description
`id`	integer	Yes	Sign-off ID

Request Body Parameters

Parameter	Type	Required	Description
`session_note_id`	integer	Yes	ID of the session note
`sign_off`	object	Yes	Sign-off data object
`sign_off.instructions`	string	No	Updated instructions
`sign_off.review_date`	string	No	Updated review date
`sign_off.signature`	string	No	Updated signature

Response Format

Addendum Response


{
  "id": 39,
  "session_note_id": 46,
  "instructions": "Please fix this issue asap, names don't match",
  "instructions_response": "Fixing the names with the correct data",
  "signature": "data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAABgAAAAYCAYAAADgdz34...",
  "responded_signature": null,
  "created_at": "2023-10-20T10:00:00.000Z",
  "updated_at": "2023-10-20T15:30:00.000Z"
}

Sign-off Response


{
  "id": 25,
  "session_note_id": 99,
  "instructions": "Please fix this issue asap, names don't match",
  "review_date": "2023-10-27T21:40:00.000Z",
  "signature": "data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAABgAAAAYCAYAAADgdz34...",
  "reviewer_id": 123,
  "created_at": "2023-10-20T10:00:00.000Z",
  "updated_at": "2023-10-20T10:00:00.000Z"
}

Error Responses

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

Signatures should be provided as base64 encoded PNG images
The data:image/png;base64, prefix is required for signature fields
Review dates must be in ISO 8601 format
Both addendums and sign-offs are linked to specific session notes via session_note_id