Clinical Workflows (1.0.0)

Download OpenAPI specification:

Diagnosis, treatment plans, SOAP notes, risk scores, screening, pre-session briefs and session management

apis

apis_therapistnotes_data_list

Authorizations:
cookieAuthbasicAuthNone

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Get Therapist Notes by Record Type

Retrieves all non-deleted therapist notes for a specific client filtered by record type. The internal field therapistnotes_notetype_id is renamed to record_type in the response.

Request fields:

  • record_type_id (required): The note type identifier.
  • client_user_id (required): The client's user ID.

Returns: Array of therapist note objects with record_type, note data, approval status, signature, and timestamp fields (HTTP 200). HTTP 204 if no notes are found for the given criteria.

Authorizations:
cookieAuthbasicAuthNone
Request Body schema:
required
data
required
string
therapistnotes_notetype_id
integer or null
created_user_id
integer or null
updated_user_id
integer or null
client_user_id
integer or null
therapist_user_id
integer or null
therapist_client_id
integer or null
date
required
string <date-time>
therapist_session_id
integer or null

Responses

Request samples

Content type
{
  • "data": "string",
  • "therapistnotes_notetype_id": 0,
  • "created_user_id": 0,
  • "updated_user_id": 0,
  • "client_user_id": 0,
  • "therapist_user_id": 0,
  • "therapist_client_id": 0,
  • "date": "2019-08-24T14:15:22Z",
  • "therapist_session_id": 0
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "data": "string",
  • "therapistnotes_notetype_id": 0,
  • "created_user_id": 0,
  • "updated_user_id": 0,
  • "client_user_id": 0,
  • "therapist_user_id": 0,
  • "therapist_client_id": 0,
  • "date": "2019-08-24T14:15:22Z",
  • "attachment": "string",
  • "therapist_session_id": 0
}

apis_therapistnotes_data_retrieve

Authorizations:
cookieAuthbasicAuthNone
path Parameters
id
required
string

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "data": "string",
  • "therapistnotes_notetype_id": 0,
  • "created_user_id": 0,
  • "updated_user_id": 0,
  • "client_user_id": 0,
  • "therapist_user_id": 0,
  • "therapist_client_id": 0,
  • "date": "2019-08-24T14:15:22Z",
  • "attachment": "string",
  • "therapist_session_id": 0
}

apis_therapistnotes_data_update

Authorizations:
cookieAuthbasicAuthNone
path Parameters
id
required
string
Request Body schema:
required
data
required
string
therapistnotes_notetype_id
integer or null
created_user_id
integer or null
updated_user_id
integer or null
client_user_id
integer or null
therapist_user_id
integer or null
therapist_client_id
integer or null
date
required
string <date-time>
therapist_session_id
integer or null

Responses

Request samples

Content type
{
  • "data": "string",
  • "therapistnotes_notetype_id": 0,
  • "created_user_id": 0,
  • "updated_user_id": 0,
  • "client_user_id": 0,
  • "therapist_user_id": 0,
  • "therapist_client_id": 0,
  • "date": "2019-08-24T14:15:22Z",
  • "therapist_session_id": 0
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "data": "string",
  • "therapistnotes_notetype_id": 0,
  • "created_user_id": 0,
  • "updated_user_id": 0,
  • "client_user_id": 0,
  • "therapist_user_id": 0,
  • "therapist_client_id": 0,
  • "date": "2019-08-24T14:15:22Z",
  • "attachment": "string",
  • "therapist_session_id": 0
}

apis_therapistnotes_data_destroy

Authorizations:
cookieAuthbasicAuthNone
path Parameters
id
required
string

Responses

apis_therapistnotes_data_history_list

Authorizations:
cookieAuthbasicAuthNone

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Get Therapist Notes History by Record Type

Retrieves the 10 most recent therapist note history records for a specific client filtered by record type, ordered by ID descending. The internal field therapistnotes_notetype_id is renamed to record_type in the response.

Request fields:

  • record_type_id (required): The note type identifier.
  • client_user_id (required): The client's user ID.

Returns: Array of therapist note history objects with record_type, note data, and timestamp fields (HTTP 200). HTTP 204 if no history records are found for the given criteria.

Authorizations:
cookieAuthbasicAuthNone
Request Body schema:
required
data
required
string
therapist_notes_id
integer or null
therapistnotes_notetype_id
integer or null
created_user_id
integer or null
updated_user_id
integer or null
client_user_id
integer or null
therapist_user_id
integer or null
therapist_client_id
integer or null
therapist_session_id
integer or null

Responses

Request samples

Content type
{
  • "data": "string",
  • "therapist_notes_id": 0,
  • "therapistnotes_notetype_id": 0,
  • "created_user_id": 0,
  • "updated_user_id": 0,
  • "client_user_id": 0,
  • "therapist_user_id": 0,
  • "therapist_client_id": 0,
  • "therapist_session_id": 0
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "data": "string",
  • "therapist_notes_id": 0,
  • "therapistnotes_notetype_id": 0,
  • "created_user_id": 0,
  • "updated_user_id": 0,
  • "client_user_id": 0,
  • "therapist_user_id": 0,
  • "therapist_client_id": 0,
  • "attachment": "string",
  • "therapist_session_id": 0
}

apis_therapistnotes_data_history_retrieve

Authorizations:
cookieAuthbasicAuthNone
path Parameters
id
required
string

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "data": "string",
  • "therapist_notes_id": 0,
  • "therapistnotes_notetype_id": 0,
  • "created_user_id": 0,
  • "updated_user_id": 0,
  • "client_user_id": 0,
  • "therapist_user_id": 0,
  • "therapist_client_id": 0,
  • "attachment": "string",
  • "therapist_session_id": 0
}

apis_therapistnotes_data_history_update

Authorizations:
cookieAuthbasicAuthNone
path Parameters
id
required
string
Request Body schema:
required
data
required
string
therapist_notes_id
integer or null
therapistnotes_notetype_id
integer or null
created_user_id
integer or null
updated_user_id
integer or null
client_user_id
integer or null
therapist_user_id
integer or null
therapist_client_id
integer or null
therapist_session_id
integer or null

Responses

Request samples

Content type
{
  • "data": "string",
  • "therapist_notes_id": 0,
  • "therapistnotes_notetype_id": 0,
  • "created_user_id": 0,
  • "updated_user_id": 0,
  • "client_user_id": 0,
  • "therapist_user_id": 0,
  • "therapist_client_id": 0,
  • "therapist_session_id": 0
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "data": "string",
  • "therapist_notes_id": 0,
  • "therapistnotes_notetype_id": 0,
  • "created_user_id": 0,
  • "updated_user_id": 0,
  • "client_user_id": 0,
  • "therapist_user_id": 0,
  • "therapist_client_id": 0,
  • "attachment": "string",
  • "therapist_session_id": 0
}

apis_therapistnotes_data_history_destroy

Authorizations:
cookieAuthbasicAuthNone
path Parameters
id
required
string

Responses

apis_therapistnotes_recordtype_list

Authorizations:
cookieAuthbasicAuthNone

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create or Update a Therapist Note

Creates a new therapist note or updates an existing one. Accepts multipart form data containing a JSON metadata field and optional file attachments.

Uploaded files are processed through the DocumentProcessService to extract their text content, which is appended to the note summary before being passed to the background worker. For all record types except Psychotherapy Notes (record_type=1), two async Celery tasks are dispatched: one to process and de-identify the clinical note, and one to update the session event status to "Therapist Summary Notes".

Request (multipart/form-data):

  • metadata (required): JSON string containing:
    • id (optional): ID of an existing note to update; omit to create.
    • data (required): Note content fields.
    • record_type (required): Note type identifier.
    • client_user_id (required): Client's user ID.
    • therapist_user_id (required): Therapist's user ID.
    • therapist_client_id (required): Therapist-client relationship ID.
    • therapist_session_id (optional): Associated session ID.
  • files (optional): One or more file attachments to include in the note.

Returns: The ID of the created or updated note record (HTTP 201).

Authorizations:
cookieAuthbasicAuthNone
Request Body schema:
required
data
required
string
therapistnotes_notetype_id
integer or null
created_user_id
integer or null
updated_user_id
integer or null
client_user_id
integer or null
therapist_user_id
integer or null
therapist_client_id
integer or null
create_timestamp
string or null <date-time>
update_timestamp
string or null <date-time>
required
object (TherapistNotesHistory)
file_content_json
any or null
therapist_session_id
integer or null

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "data": "string",
  • "therapistnotes_notetype_id": 0,
  • "created_user_id": 0,
  • "updated_user_id": 0,
  • "client_user_id": 0,
  • "therapist_user_id": 0,
  • "therapist_client_id": 0,
  • "create_timestamp": "2019-08-24T14:15:22Z",
  • "update_timestamp": "2019-08-24T14:15:22Z",
  • "history": {
    },
  • "file_content_json": null,
  • "therapist_session_id": 0
}

apis_therapistnotes_recordtype_retrieve

Authorizations:
cookieAuthbasicAuthNone
path Parameters
id
required
string

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "data": "string",
  • "therapistnotes_notetype_id": 0,
  • "created_user_id": 0,
  • "updated_user_id": 0,
  • "client_user_id": 0,
  • "therapist_user_id": 0,
  • "therapist_client_id": 0,
  • "create_timestamp": "2019-08-24T14:15:22Z",
  • "update_timestamp": "2019-08-24T14:15:22Z",
  • "history": {
    },
  • "file_content_json": null,
  • "therapist_session_id": 0
}

apis_therapistnotes_recordtype_update

Authorizations:
cookieAuthbasicAuthNone
path Parameters
id
required
string
Request Body schema:
required
data
required
string
therapistnotes_notetype_id
integer or null
created_user_id
integer or null
updated_user_id
integer or null
client_user_id
integer or null
therapist_user_id
integer or null
therapist_client_id
integer or null
create_timestamp
string or null <date-time>
update_timestamp
string or null <date-time>
required
object (TherapistNotesHistory)
file_content_json
any or null
therapist_session_id
integer or null

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "data": "string",
  • "therapistnotes_notetype_id": 0,
  • "created_user_id": 0,
  • "updated_user_id": 0,
  • "client_user_id": 0,
  • "therapist_user_id": 0,
  • "therapist_client_id": 0,
  • "create_timestamp": "2019-08-24T14:15:22Z",
  • "update_timestamp": "2019-08-24T14:15:22Z",
  • "history": {
    },
  • "file_content_json": null,
  • "therapist_session_id": 0
}

Soft-Delete a Therapist Note

Soft-deletes a therapist note by setting its is_deleted flag to True and recording the deletion timestamp. The record is retained in the database and will no longer appear in active queries.

Path parameter:

  • id (required): Primary key of the note to delete.

Returns: The ID of the deleted note (HTTP 204), or HTTP 404 if not found.

Authorizations:
cookieAuthbasicAuthNone
path Parameters
id
required
string

Responses

List Therapist Note Type Metadata

Returns all active (non-deleted) therapist note type metadata records, ordered by ID ascending. Each record describes a supported note/record type that can be used as a record_type value when creating or querying therapist notes.

Returns: Array of note type metadata objects (HTTP 200).

Authorizations:
cookieAuthbasicAuthNone

Responses

apis_therapistnotes_recordtype_meta_retrieve

Authorizations:
cookieAuthbasicAuthNone
path Parameters
id
required
string

Responses

apis_therapistnotes_soap_data_list

Authorizations:
cookieAuthbasicAuthNone

Responses

Response samples

Content type
application/json
[
  • {
    }
]

apis_therapistnotes_soap_data_retrieve

Authorizations:
cookieAuthbasicAuthNone
path Parameters
id
required
string

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "therapist_data": "string",
  • "is_override": true,
  • "therapist_notes_notetypeid": 0,
  • "created_user_id": 0,
  • "updated_user_id": 0,
  • "client_user_id": 0,
  • "therapist_user_id": 0,
  • "therapist_client_id": 0,
  • "is_approved": true,
  • "signature": "string",
  • "date": "2019-08-24T14:15:22Z",
  • "therapist_session_id": 0
}

apis_therapistnotes_soap_data_update

Authorizations:
cookieAuthbasicAuthNone
path Parameters
id
required
string
Request Body schema:
required
therapist_data
required
string
is_override
boolean or null
therapist_notes_notetypeid
integer or null
created_user_id
integer or null
updated_user_id
integer or null
client_user_id
integer or null
therapist_user_id
integer or null
therapist_client_id
integer or null
is_approved
boolean or null
signature
required
string or null
date
required
string <date-time>
therapist_session_id
integer or null

Responses

Request samples

Content type
{
  • "therapist_data": "string",
  • "is_override": true,
  • "therapist_notes_notetypeid": 0,
  • "created_user_id": 0,
  • "updated_user_id": 0,
  • "client_user_id": 0,
  • "therapist_user_id": 0,
  • "therapist_client_id": 0,
  • "is_approved": true,
  • "signature": "string",
  • "date": "2019-08-24T14:15:22Z",
  • "therapist_session_id": 0
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "therapist_data": "string",
  • "is_override": true,
  • "therapist_notes_notetypeid": 0,
  • "created_user_id": 0,
  • "updated_user_id": 0,
  • "client_user_id": 0,
  • "therapist_user_id": 0,
  • "therapist_client_id": 0,
  • "is_approved": true,
  • "signature": "string",
  • "date": "2019-08-24T14:15:22Z",
  • "therapist_session_id": 0
}

apis_therapistnotes_soap_data_destroy

Authorizations:
cookieAuthbasicAuthNone
path Parameters
id
required
string

Responses

apis_therapistnotes_soap_data_history_list

Authorizations:
cookieAuthbasicAuthNone

Responses

Response samples

Content type
application/json
[
  • {
    }
]

apis_therapistnotes_soap_data_history_retrieve

Authorizations:
cookieAuthbasicAuthNone
path Parameters
id
required
string

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "data": "string",
  • "is_override": true,
  • "therapist_notes_notetypeid": 0,
  • "created_user_id": 0,
  • "updated_user_id": 0,
  • "client_user_id": 0,
  • "therapist_user_id": 0,
  • "therapist_client_id": 0,
  • "therapist_soapnotes_id": 0,
  • "therapist_session_id": 0,
  • "session_start_time": "2019-08-24T14:15:22Z",
  • "session_end_time": "2019-08-24T14:15:22Z",
  • "is_approved": true,
  • "signature": "string",
  • "date": "2019-08-24T14:15:22Z"
}

apis_therapistnotes_soap_data_history_update

Authorizations:
cookieAuthbasicAuthNone
path Parameters
id
required
string
Request Body schema:
required
data
required
string
is_override
boolean or null
therapist_notes_notetypeid
integer or null
created_user_id
integer or null
updated_user_id
integer or null
client_user_id
integer or null
therapist_user_id
integer or null
therapist_client_id
integer or null
therapist_soapnotes_id
integer or null
therapist_session_id
integer or null
is_approved
boolean or null
signature
required
string or null
date
required
string <date-time>

Responses

Request samples

Content type
{
  • "data": "string",
  • "is_override": true,
  • "therapist_notes_notetypeid": 0,
  • "created_user_id": 0,
  • "updated_user_id": 0,
  • "client_user_id": 0,
  • "therapist_user_id": 0,
  • "therapist_client_id": 0,
  • "therapist_soapnotes_id": 0,
  • "therapist_session_id": 0,
  • "is_approved": true,
  • "signature": "string",
  • "date": "2019-08-24T14:15:22Z"
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "data": "string",
  • "is_override": true,
  • "therapist_notes_notetypeid": 0,
  • "created_user_id": 0,
  • "updated_user_id": 0,
  • "client_user_id": 0,
  • "therapist_user_id": 0,
  • "therapist_client_id": 0,
  • "therapist_soapnotes_id": 0,
  • "therapist_session_id": 0,
  • "session_start_time": "2019-08-24T14:15:22Z",
  • "session_end_time": "2019-08-24T14:15:22Z",
  • "is_approved": true,
  • "signature": "string",
  • "date": "2019-08-24T14:15:22Z"
}

apis_therapistnotes_soap_data_history_destroy

Authorizations:
cookieAuthbasicAuthNone
path Parameters
id
required
string

Responses

apis_therapistnotes_soap_data_partialhistory_list

Authorizations:
cookieAuthbasicAuthNone

Responses

Response samples

Content type
application/json
[
  • {
    }
]

apis_therapistnotes_soap_data_partialhistory_retrieve

Authorizations:
cookieAuthbasicAuthNone
path Parameters
id
required
string

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "data": "string",
  • "is_override": true,
  • "therapist_notes_notetypeid": 0,
  • "created_user_id": 0,
  • "updated_user_id": 0,
  • "client_user_id": 0,
  • "therapist_user_id": 0,
  • "therapist_client_id": 0,
  • "therapist_soapnotes_id": 0,
  • "therapist_session_id": 0,
  • "session_start_time": "2019-08-24T14:15:22Z",
  • "session_end_time": "2019-08-24T14:15:22Z",
  • "is_approved": true,
  • "signature": "string",
  • "date": "2019-08-24T14:15:22Z"
}

apis_therapistnotes_soap_data_partialhistory_update

Authorizations:
cookieAuthbasicAuthNone
path Parameters
id
required
string
Request Body schema:
required
data
required
string
is_override
boolean or null
therapist_notes_notetypeid
integer or null
created_user_id
integer or null
updated_user_id
integer or null
client_user_id
integer or null
therapist_user_id
integer or null
therapist_client_id
integer or null
therapist_soapnotes_id
integer or null
therapist_session_id
integer or null
is_approved
boolean or null
signature
required
string or null
date
required
string <date-time>

Responses

Request samples

Content type
{
  • "data": "string",
  • "is_override": true,
  • "therapist_notes_notetypeid": 0,
  • "created_user_id": 0,
  • "updated_user_id": 0,
  • "client_user_id": 0,
  • "therapist_user_id": 0,
  • "therapist_client_id": 0,
  • "therapist_soapnotes_id": 0,
  • "therapist_session_id": 0,
  • "is_approved": true,
  • "signature": "string",
  • "date": "2019-08-24T14:15:22Z"
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "data": "string",
  • "is_override": true,
  • "therapist_notes_notetypeid": 0,
  • "created_user_id": 0,
  • "updated_user_id": 0,
  • "client_user_id": 0,
  • "therapist_user_id": 0,
  • "therapist_client_id": 0,
  • "therapist_soapnotes_id": 0,
  • "therapist_session_id": 0,
  • "session_start_time": "2019-08-24T14:15:22Z",
  • "session_end_time": "2019-08-24T14:15:22Z",
  • "is_approved": true,
  • "signature": "string",
  • "date": "2019-08-24T14:15:22Z"
}

apis_therapistnotes_soap_data_partialhistory_destroy

Authorizations:
cookieAuthbasicAuthNone
path Parameters
id
required
string

Responses

apis_therapistnotes_soap_recordtype_list

Authorizations:
cookieAuthbasicAuthNone

Responses

Response samples

Content type
application/json
[
  • {
    }
]

apis_therapistnotes_soap_recordtype_retrieve

Authorizations:
cookieAuthbasicAuthNone
path Parameters
id
required
string

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "ml_data": "string",
  • "therapist_data": "string",
  • "is_override": true,
  • "therapist_notes_notetypeid": 0,
  • "created_user_id": 0,
  • "updated_user_id": 0,
  • "client_user_id": 0,
  • "therapist_user_id": 0,
  • "therapist_client_id": 0,
  • "create_timestamp": "2019-08-24T14:15:22Z",
  • "update_timestamp": "2019-08-24T14:15:22Z",
  • "history": {
    },
  • "is_approved": true,
  • "signature": "string",
  • "therapist_session_id": 0
}

apis_therapistnotes_soap_recordtype_update

Authorizations:
cookieAuthbasicAuthNone
path Parameters
id
required
string
Request Body schema:
required
ml_data
required
string
therapist_data
required
string
is_override
boolean or null
therapist_notes_notetypeid
integer or null
created_user_id
integer or null
updated_user_id
integer or null
client_user_id
integer or null
therapist_user_id
integer or null
therapist_client_id
integer or null
create_timestamp
string or null <date-time>
update_timestamp
string or null <date-time>
required
object (TherapistSoapHistory)
is_approved
boolean or null
signature
required
string or null
therapist_session_id
integer or null

Responses

Request samples

Content type
{
  • "ml_data": "string",
  • "therapist_data": "string",
  • "is_override": true,
  • "therapist_notes_notetypeid": 0,
  • "created_user_id": 0,
  • "updated_user_id": 0,
  • "client_user_id": 0,
  • "therapist_user_id": 0,
  • "therapist_client_id": 0,
  • "create_timestamp": "2019-08-24T14:15:22Z",
  • "update_timestamp": "2019-08-24T14:15:22Z",
  • "history": {
    },
  • "is_approved": true,
  • "signature": "string",
  • "therapist_session_id": 0
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "ml_data": "string",
  • "therapist_data": "string",
  • "is_override": true,
  • "therapist_notes_notetypeid": 0,
  • "created_user_id": 0,
  • "updated_user_id": 0,
  • "client_user_id": 0,
  • "therapist_user_id": 0,
  • "therapist_client_id": 0,
  • "create_timestamp": "2019-08-24T14:15:22Z",
  • "update_timestamp": "2019-08-24T14:15:22Z",
  • "history": {
    },
  • "is_approved": true,
  • "signature": "string",
  • "therapist_session_id": 0
}

apis_therapistnotes_soap_recordtype_destroy

Authorizations:
cookieAuthbasicAuthNone
path Parameters
id
required
string

Responses

apis_therapistnotes_soap_trigger_retrieve

Authorizations:
cookieAuthbasicAuthNone

Responses

apis_therapistnotes_soap_trigger_retrieve_2

Authorizations:
cookieAuthbasicAuthNone
path Parameters
id
required
string

Responses

apis_therapistnotes_soap_trigger_update

Authorizations:
cookieAuthbasicAuthNone
path Parameters
id
required
string

Responses

apis_therapistnotes_soap_trigger_destroy

Authorizations:
cookieAuthbasicAuthNone
path Parameters
id
required
string

Responses

Get SOAP Notes by Record Type

Retrieves all SOAP notes for a specific client filtered by note/record type. Returns the complete set of non-deleted records. Internal field names are renamed so that therapist_notes_notetypeid is exposed as record_type and therapist_data as data.

Request fields:

  • record_type_id (required): The note type identifier.
  • client_user_id (required): The client's user ID.

Returns: Array of SOAP note objects with record_type, data, approval status, signature, session ID, and timestamp fields (HTTP 200). HTTP 204 if no notes are found for the given criteria.

Authorizations:
cookieAuthbasicAuthNone
Request Body schema:
required
therapist_data
required
string
is_override
boolean or null
therapist_notes_notetypeid
integer or null
created_user_id
integer or null
updated_user_id
integer or null
client_user_id
integer or null
therapist_user_id
integer or null
therapist_client_id
integer or null
is_approved
boolean or null
signature
required
string or null
date
required
string <date-time>
therapist_session_id
integer or null

Responses

Request samples

Content type
{
  • "therapist_data": "string",
  • "is_override": true,
  • "therapist_notes_notetypeid": 0,
  • "created_user_id": 0,
  • "updated_user_id": 0,
  • "client_user_id": 0,
  • "therapist_user_id": 0,
  • "therapist_client_id": 0,
  • "is_approved": true,
  • "signature": "string",
  • "date": "2019-08-24T14:15:22Z",
  • "therapist_session_id": 0
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "therapist_data": "string",
  • "is_override": true,
  • "therapist_notes_notetypeid": 0,
  • "created_user_id": 0,
  • "updated_user_id": 0,
  • "client_user_id": 0,
  • "therapist_user_id": 0,
  • "therapist_client_id": 0,
  • "is_approved": true,
  • "signature": "string",
  • "date": "2019-08-24T14:15:22Z",
  • "therapist_session_id": 0
}

Get SOAP Notes History

Retrieves the 10 most recent SOAP note history records for a specific client filtered by record type, ordered by ID descending.

Typical use cases:

  • Viewing the clinical note history for a client.
  • Populating pre-session briefs with past notes.

Request fields:

  • record_type_id (required): The note type identifier.
  • client_user_id (required): The client's user ID.

Returns: Array of SOAP note history records with record_type and data fields (HTTP 200). HTTP 204 if no notes are found for the given criteria.

Authorizations:
cookieAuthbasicAuthNone
Request Body schema:
required
data
required
string
is_override
boolean or null
therapist_notes_notetypeid
integer or null
created_user_id
integer or null
updated_user_id
integer or null
client_user_id
integer or null
therapist_user_id
integer or null
therapist_client_id
integer or null
therapist_soapnotes_id
integer or null
therapist_session_id
integer or null
is_approved
boolean or null
signature
required
string or null
date
required
string <date-time>

Responses

Request samples

Content type
{
  • "data": "string",
  • "is_override": true,
  • "therapist_notes_notetypeid": 0,
  • "created_user_id": 0,
  • "updated_user_id": 0,
  • "client_user_id": 0,
  • "therapist_user_id": 0,
  • "therapist_client_id": 0,
  • "therapist_soapnotes_id": 0,
  • "therapist_session_id": 0,
  • "is_approved": true,
  • "signature": "string",
  • "date": "2019-08-24T14:15:22Z"
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "data": "string",
  • "is_override": true,
  • "therapist_notes_notetypeid": 0,
  • "created_user_id": 0,
  • "updated_user_id": 0,
  • "client_user_id": 0,
  • "therapist_user_id": 0,
  • "therapist_client_id": 0,
  • "therapist_soapnotes_id": 0,
  • "therapist_session_id": 0,
  • "session_start_time": "2019-08-24T14:15:22Z",
  • "session_end_time": "2019-08-24T14:15:22Z",
  • "is_approved": true,
  • "signature": "string",
  • "date": "2019-08-24T14:15:22Z"
}

Get Partial SOAP Notes History

Retrieves a filtered view of SOAP note history for a specific client and record type. Considers the 30 most recent history entries (ordered by update_timestamp descending) and returns only:

  • The single most recent record, regardless of approval status.
  • All approved (is_approved=True) records within those 30 entries.

This surfaces the latest draft alongside previously approved notes, giving a clinically relevant and de-cluttered history without showing every unapproved revision.

Request fields:

  • record_type_id (required): The note type identifier.
  • client_user_id (required): The client's user ID.

Returns: Array of SOAP note history objects including data, approval status, signature, session start/end times, and timestamp fields (HTTP 200). HTTP 204 if no matching history records are found.

Authorizations:
cookieAuthbasicAuthNone
Request Body schema:
required
data
required
string
is_override
boolean or null
therapist_notes_notetypeid
integer or null
created_user_id
integer or null
updated_user_id
integer or null
client_user_id
integer or null
therapist_user_id
integer or null
therapist_client_id
integer or null
therapist_soapnotes_id
integer or null
therapist_session_id
integer or null
is_approved
boolean or null
signature
required
string or null
date
required
string <date-time>

Responses

Request samples

Content type
{
  • "data": "string",
  • "is_override": true,
  • "therapist_notes_notetypeid": 0,
  • "created_user_id": 0,
  • "updated_user_id": 0,
  • "client_user_id": 0,
  • "therapist_user_id": 0,
  • "therapist_client_id": 0,
  • "therapist_soapnotes_id": 0,
  • "therapist_session_id": 0,
  • "is_approved": true,
  • "signature": "string",
  • "date": "2019-08-24T14:15:22Z"
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "data": "string",
  • "is_override": true,
  • "therapist_notes_notetypeid": 0,
  • "created_user_id": 0,
  • "updated_user_id": 0,
  • "client_user_id": 0,
  • "therapist_user_id": 0,
  • "therapist_client_id": 0,
  • "therapist_soapnotes_id": 0,
  • "therapist_session_id": 0,
  • "session_start_time": "2019-08-24T14:15:22Z",
  • "session_end_time": "2019-08-24T14:15:22Z",
  • "is_approved": true,
  • "signature": "string",
  • "date": "2019-08-24T14:15:22Z"
}

Trigger SOAP Note Generation

Manually triggers asynchronous SOAP note generation for a therapy session by dispatching the process_therapist_note_task Celery task.

The endpoint resolves the client's full name from client_user_id and attaches it to the task payload. Transcript and summary fields are set to null on entry since the note content is built entirely by the background worker.

Request fields:

  • client_user_id (required): Client's user ID (used to look up their full name).
  • therapist_user_id (required): Therapist's user ID.
  • therapist_client_id (required): Therapist-client relationship ID.
  • record_type (required): Note type identifier passed through to the task.
  • therapist_session_id (optional): Associated session ID.

Returns: {"detail": "Processing"} immediately (HTTP 200). Note generation continues asynchronously in the background.

Authorizations:
cookieAuthbasicAuthNone

Responses

soap-notes

Create or Update a SOAP Note

Creates a new SOAP note or updates an existing one, depending on whether an id is provided in the request body.

Sender roles:

  • ml: The ML service submits the note. Both ml_data and therapist_data are stored. No downstream tasks are triggered.
  • therapist: The therapist submits or reviews the note. Only therapist_data is written. When is_approved is true, two async Celery tasks are dispatched — one to process and persist the clinical note, and one to update the session event status to "Reviewed".

Request fields:

  • id (optional): ID of an existing SOAP note to update; omit to create.
  • data (required): Note content (SOAP fields).
  • sender_role (required): "ml" or "therapist".
  • record_type (required): Note type identifier.
  • client_user_id (required): Client's user ID.
  • therapist_user_id (required): Therapist's user ID.
  • therapist_client_id (required): Therapist-client relationship ID.
  • is_approved (required): Whether the therapist has approved the note.
  • signature (optional): Therapist signature (Base64-encoded binary).
  • therapist_session_id (optional): Associated session ID.

Returns: The ID of the created or updated SOAP note record (HTTP 201).

Authorizations:
cookieAuthbasicAuthNone
Request Body schema:
required
ml_data
required
string
therapist_data
required
string
is_override
boolean or null
therapist_notes_notetypeid
integer or null
created_user_id
integer or null
updated_user_id
integer or null
client_user_id
integer or null
therapist_user_id
integer or null
therapist_client_id
integer or null
create_timestamp
string or null <date-time>
update_timestamp
string or null <date-time>
required
object (TherapistSoapHistory)
is_approved
boolean or null
signature
required
string or null
therapist_session_id
integer or null

Responses

Request samples

Content type
{
  • "ml_data": "string",
  • "therapist_data": "string",
  • "is_override": true,
  • "therapist_notes_notetypeid": 0,
  • "created_user_id": 0,
  • "updated_user_id": 0,
  • "client_user_id": 0,
  • "therapist_user_id": 0,
  • "therapist_client_id": 0,
  • "create_timestamp": "2019-08-24T14:15:22Z",
  • "update_timestamp": "2019-08-24T14:15:22Z",
  • "history": {
    },
  • "is_approved": true,
  • "signature": "string",
  • "therapist_session_id": 0
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "ml_data": "string",
  • "therapist_data": "string",
  • "is_override": true,
  • "therapist_notes_notetypeid": 0,
  • "created_user_id": 0,
  • "updated_user_id": 0,
  • "client_user_id": 0,
  • "therapist_user_id": 0,
  • "therapist_client_id": 0,
  • "create_timestamp": "2019-08-24T14:15:22Z",
  • "update_timestamp": "2019-08-24T14:15:22Z",
  • "history": {
    },
  • "is_approved": true,
  • "signature": "string",
  • "therapist_session_id": 0
}