Treatment Note Template

Templates that are the starting point for treatment notes.

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.

TreatmentNoteTemplate

archived_at
string or null <date-time>
object
created_at
string <date-time>
deleted_at
string or null <date-time>
id
string <int64>
object
name
string <= 255 characters
object or null
updated_at
string <date-time>
{
  • "archived_at": "2019-08-24T14:15:22Z",
  • "content": {
    • "sections": [
      • {
        }
      ]
    },
  • "created_at": "2019-08-24T14:15:22Z",
  • "deleted_at": "2019-08-24T14:15:22Z",
  • "id": "string",
  • "links": {},
  • "name": "string",
  • "print_settings": {
    • "include_patient_address": true,
    • "include_patient_dob": true,
    • "include_patient_medicare": true,
    • "include_patient_occupation": true,
    • "include_patient_reference_number": true,
    • "title": "string"
    },
  • "updated_at": "2019-08-24T14:15:22Z"
}

List treatment note templates

get/treatment_note_templates
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
created_at date-time
deleted_at date-time
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 template
post/treatment_note_templates
SecuritybasicAuth 
Request 
Request Body schema: application/json
object
 
name
string  <= 255 characters 
 
object
 
Responses 
201
Resource was created


422
Resource could not be saved due to validation errors


Request samples 
application/json
{
  • "content": {
    • "sections": [
      • {
        }
      ]
    },
  • "name": "string",
  • "print_settings": {
    • "include_patient_address": true,
    • "include_patient_dob": true,
    • "include_patient_medicare": true,
    • "include_patient_occupation": true,
    • "include_patient_reference_number": true,
    • "title": "string"
    }
}
Response samples 
application/json
{
  • "archived_at": "2019-08-24T14:15:22Z",
  • "content": {
    • "sections": [
      • {
        }
      ]
    },
  • "created_at": "2019-08-24T14:15:22Z",
  • "deleted_at": "2019-08-24T14:15:22Z",
  • "id": "string",
  • "links": {},
  • "name": "string",
  • "print_settings": {
    • "include_patient_address": true,
    • "include_patient_dob": true,
    • "include_patient_medicare": true,
    • "include_patient_occupation": true,
    • "include_patient_reference_number": true,
    • "title": "string"
    },
  • "updated_at": "2019-08-24T14:15:22Z"
}
Get treatment note template
get/treatment_note_templates/{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
{
  • "archived_at": "2019-08-24T14:15:22Z",
  • "content": {
    • "sections": [
      • {
        }
      ]
    },
  • "created_at": "2019-08-24T14:15:22Z",
  • "deleted_at": "2019-08-24T14:15:22Z",
  • "id": "string",
  • "links": {},
  • "name": "string",
  • "print_settings": {
    • "include_patient_address": true,
    • "include_patient_dob": true,
    • "include_patient_medicare": true,
    • "include_patient_occupation": true,
    • "include_patient_reference_number": true,
    • "title": "string"
    },
  • "updated_at": "2019-08-24T14:15:22Z"
}
Update treatment note template
patch/treatment_note_templates/{id}
SecuritybasicAuth 
Request 
path Parameters
id
required
string <int64> 
 
Request Body schema: application/json
object
 
name
string  <= 255 characters 
 
object
 
Responses 
200
Resource was updated


422
Resource could not be saved due to validation errors


Request samples 
application/json
{
  • "content": {
    • "sections": [
      • {
        }
      ]
    },
  • "name": "string",
  • "print_settings": {
    • "include_patient_address": true,
    • "include_patient_dob": true,
    • "include_patient_medicare": true,
    • "include_patient_occupation": true,
    • "include_patient_reference_number": true,
    • "title": "string"
    }
}
Response samples 
application/json
{
  • "archived_at": "2019-08-24T14:15:22Z",
  • "content": {
    • "sections": [
      • {
        }
      ]
    },
  • "created_at": "2019-08-24T14:15:22Z",
  • "deleted_at": "2019-08-24T14:15:22Z",
  • "id": "string",
  • "links": {},
  • "name": "string",
  • "print_settings": {
    • "include_patient_address": true,
    • "include_patient_dob": true,
    • "include_patient_medicare": true,
    • "include_patient_occupation": true,
    • "include_patient_reference_number": true,
    • "title": "string"
    },
  • "updated_at": "2019-08-24T14:15:22Z"
}
Archive treatment note templateDeprecated
delete/treatment_note_templates/{id}
SecuritybasicAuth 
Request 
path Parameters
id
required
string <int64> 
 
Responses 
204
Resource was archived successfully


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


Request samples