Treatment Note

Notes taken about a patient visit.

HTML is supported in answers to paragraph questions. We sanitize these answers to ensure the HTML is safe and our editor can support the formatting.

Currently, the following tags are supported: p, div, br, ul, ol, li, blockquote, h1, h2, b, i, u, and a.

The angle bracket characters (<, and >) should be sent as html encodings (ex: < should be sent as &lt;).

Content inside unescaped angle brackets could be indentified as unsupported HTML and will be stripped.

TreatmentNote

archived_at
string or null <date-time>
object
author_name
string or null
object
object or null
created_at
string <date-time>
deleted_at
string or null <date-time>
draft
boolean or null
finalized_at
string or null <date-time>
id
string <int64>
object
object
pinned_at
string or null <date-time>
object
title
string
object
updated_at
string <date-time>
{}

List treatment notes

get/treatment_notes
SecuritybasicAuth
Request
query Parameters
order
string
Deprecated
Enum: "asc" "desc"
page
integer
per_page
integer [ 1 .. 100 ]
q[]
Array of strings

Filter result by one or more fields.

See Filtering Results

Available filters:

Value Format
archived_at date-time
attendee_id int64
booking_id int64
created_at date-time
deleted_at date-time
draft boolean
id int64
patient_id int64
practitioner_id int64
treatment_note_template_id int64
updated_at date-time
sort
Array of strings

Comma separated search fields. See: Ordering

Example: sort=created_at:desc
Responses
200

successful operation

Request samples 
Response samples 
application/json
{}
Create treatment note
post/treatment_notes
SecuritybasicAuth 
Request 
Request Body schema: application/json
attendee_id
string <int64> 
attendee id


 
booking_id
string <int64> 
booking id


 
object or null
 
draft
boolean or null
 
patient_id
string <int64> 
patient id


 
title
string
 
treatment_note_template_id
string <int64> 
treatment note template id


 
Responses 
201
Resource was created


422
Resource could not be saved due to validation errors


Request samples 
application/json
{
  • "attendee_id": "1",
  • "booking_id": "1",
  • "content": {
    • "sections": [
      • {
        }
      ]
    },
  • "draft": true,
  • "patient_id": "1",
  • "title": "string",
  • "treatment_note_template_id": "1"
}
Response samples 
application/json
{}
Get treatment note
get/treatment_notes/{id}
SecuritybasicAuth 
Request 
path Parameters
id
required
string <int64> 
 
query Parameters
q[]
Array of strings
Filter result by one or more fields.


See Filtering Results


Available filters:






Value
Format





archived_at
date-time




deleted_at
date-time





 
Responses 
200
Successful operation


Request samples 
Response samples 
application/json
{}
Update treatment note
patch/treatment_notes/{id}
SecuritybasicAuth 
Request 
path Parameters
id
required
string <int64> 
 
Request Body schema: application/json
attendee_id
string <int64> 
attendee id


 
booking_id
string <int64> 
booking id


 
object or null
 
draft
boolean or null
 
patient_id
string <int64> 
patient id


 
title
string
 
treatment_note_template_id
string <int64> 
treatment note template id


 
Responses 
200
Resource was updated


422
Resource could not be saved due to validation errors


Request samples 
application/json
{
  • "attendee_id": "1",
  • "booking_id": "1",
  • "content": {
    • "sections": [
      • {
        }
      ]
    },
  • "draft": true,
  • "patient_id": "1",
  • "title": "string",
  • "treatment_note_template_id": "1"
}
Response samples 
application/json
{}
Archive treatment noteDeprecated
delete/treatment_notes/{id}
SecuritybasicAuth 
Request 
path Parameters
id
required
string <int64> 
 
Responses 
204
Resource was archived successfully


Request samples 
List treatment notes for patient
get/patients/{patient_id}/treatment_notes
SecuritybasicAuth 
Request 
path Parameters
patient_id
required
string <int64> 
 
query Parameters
order
string
 Deprecated 
 Enum: "asc" "desc"  
page
integer
 
per_page
integer  [ 1 .. 100 ] 
 
q[]
Array of strings
Filter result by one or more fields.


See Filtering Results


Available filters:






Value
Format





archived_at
date-time




attendee_id
int64




booking_id
int64




created_at
date-time




deleted_at
date-time




draft
boolean




id
int64




practitioner_id
int64




treatment_note_template_id
int64




updated_at
date-time





 
sort
Array of strings
Comma separated search fields. See: Ordering


 
 Example:  sort=created_at:desc
Responses 
200
successful operation


Request samples 
Response samples 
application/json
{}
Archive treatment note
post/treatment_notes/{id}/archive
SecuritybasicAuth 
Request 
path Parameters
id
required
string <int64> 
 
Responses 
204
Resource was archived


Request samples 
Unarchive treatment note
post/treatment_notes/{id}/unarchive
SecuritybasicAuth 
Request 
path Parameters
id
required
string <int64> 
 
Responses 
200
Resource was unarchived


Request samples 
Response samples 
application/json
{}