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 <
).
Content inside unescaped angle brackets could be indentified as unsupported HTML and will be stripped.
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> |
{- "archived_at": "2019-08-24T14:15:22Z",
- "author_name": "string",
- "content": {
- "sections": [
- {
- "name": "string",
- "description": "string",
- "questions": [
- {
- "name": "string",
- "type": "bodycharts",
- "answer": "string",
- "answers": [
- {
- "value": null,
- "selected": null
}
], - "other": {
- "enabled": true,
- "selected": true,
- "value": "string"
}, - "body_chart_ids": [
- "1"
]
}
]
}
]
}, - "created_at": "2019-08-24T14:15:22Z",
- "deleted_at": "2019-08-24T14:15:22Z",
- "draft": true,
- "finalized_at": "2019-08-24T14:15:22Z",
- "id": "string",
- "pinned_at": "2019-08-24T14:15:22Z",
- "title": "string",
- "treatment_note_template": {
}, - "updated_at": "2019-08-24T14:15:22Z"
}
order | string Deprecated Enum: "asc" "desc" |
page | integer |
per_page | integer [ 1 .. 100 ] |
q[] | |
sort |
successful operation
{- "treatment_notes": [
- {
- "archived_at": "2019-08-24T14:15:22Z",
- "author_name": "string",
- "content": {
- "sections": [
- {
- "name": "string",
- "description": "string",
- "questions": [
- {
- "name": null,
- "type": null,
- "answer": null,
- "answers": [ ],
- "other": { },
- "body_chart_ids": [ ]
}
]
}
]
}, - "created_at": "2019-08-24T14:15:22Z",
- "deleted_at": "2019-08-24T14:15:22Z",
- "draft": true,
- "finalized_at": "2019-08-24T14:15:22Z",
- "id": "string",
- "pinned_at": "2019-08-24T14:15:22Z",
- "title": "string",
- "treatment_note_template": {
}, - "updated_at": "2019-08-24T14:15:22Z"
}
], - "total_entries": 1,
- "links": {
}
}
Resource was created
Resource could not be saved due to validation errors
{- "attendee_id": "1",
- "booking_id": "1",
- "content": {
- "sections": [
- {
- "name": "string",
- "description": "string",
- "questions": [
- {
- "name": "string",
- "type": "bodycharts",
- "answer": "string",
- "answers": [
- {
- "value": null,
- "selected": null
}
], - "other": {
- "enabled": true,
- "selected": true,
- "value": "string"
}, - "body_chart_ids": [
- "1"
]
}
]
}
]
}, - "draft": true,
- "patient_id": "1",
- "title": "string",
- "treatment_note_template_id": "1"
}
{- "archived_at": "2019-08-24T14:15:22Z",
- "author_name": "string",
- "content": {
- "sections": [
- {
- "name": "string",
- "description": "string",
- "questions": [
- {
- "name": "string",
- "type": "bodycharts",
- "answer": "string",
- "answers": [
- {
- "value": null,
- "selected": null
}
], - "other": {
- "enabled": true,
- "selected": true,
- "value": "string"
}, - "body_chart_ids": [
- "1"
]
}
]
}
]
}, - "created_at": "2019-08-24T14:15:22Z",
- "deleted_at": "2019-08-24T14:15:22Z",
- "draft": true,
- "finalized_at": "2019-08-24T14:15:22Z",
- "id": "string",
- "pinned_at": "2019-08-24T14:15:22Z",
- "title": "string",
- "treatment_note_template": {
}, - "updated_at": "2019-08-24T14:15:22Z"
}
Successful operation
{- "archived_at": "2019-08-24T14:15:22Z",
- "author_name": "string",
- "content": {
- "sections": [
- {
- "name": "string",
- "description": "string",
- "questions": [
- {
- "name": "string",
- "type": "bodycharts",
- "answer": "string",
- "answers": [
- {
- "value": null,
- "selected": null
}
], - "other": {
- "enabled": true,
- "selected": true,
- "value": "string"
}, - "body_chart_ids": [
- "1"
]
}
]
}
]
}, - "created_at": "2019-08-24T14:15:22Z",
- "deleted_at": "2019-08-24T14:15:22Z",
- "draft": true,
- "finalized_at": "2019-08-24T14:15:22Z",
- "id": "string",
- "pinned_at": "2019-08-24T14:15:22Z",
- "title": "string",
- "treatment_note_template": {
}, - "updated_at": "2019-08-24T14:15:22Z"
}
Resource was updated
Resource could not be saved due to validation errors
{- "attendee_id": "1",
- "booking_id": "1",
- "content": {
- "sections": [
- {
- "name": "string",
- "description": "string",
- "questions": [
- {
- "name": "string",
- "type": "bodycharts",
- "answer": "string",
- "answers": [
- {
- "value": null,
- "selected": null
}
], - "other": {
- "enabled": true,
- "selected": true,
- "value": "string"
}, - "body_chart_ids": [
- "1"
]
}
]
}
]
}, - "draft": true,
- "patient_id": "1",
- "title": "string",
- "treatment_note_template_id": "1"
}
{- "archived_at": "2019-08-24T14:15:22Z",
- "author_name": "string",
- "content": {
- "sections": [
- {
- "name": "string",
- "description": "string",
- "questions": [
- {
- "name": "string",
- "type": "bodycharts",
- "answer": "string",
- "answers": [
- {
- "value": null,
- "selected": null
}
], - "other": {
- "enabled": true,
- "selected": true,
- "value": "string"
}, - "body_chart_ids": [
- "1"
]
}
]
}
]
}, - "created_at": "2019-08-24T14:15:22Z",
- "deleted_at": "2019-08-24T14:15:22Z",
- "draft": true,
- "finalized_at": "2019-08-24T14:15:22Z",
- "id": "string",
- "pinned_at": "2019-08-24T14:15:22Z",
- "title": "string",
- "treatment_note_template": {
}, - "updated_at": "2019-08-24T14:15:22Z"
}
successful operation
{- "treatment_notes": [
- {
- "archived_at": "2019-08-24T14:15:22Z",
- "author_name": "string",
- "content": {
- "sections": [
- {
- "name": "string",
- "description": "string",
- "questions": [
- {
- "name": null,
- "type": null,
- "answer": null,
- "answers": [ ],
- "other": { },
- "body_chart_ids": [ ]
}
]
}
]
}, - "created_at": "2019-08-24T14:15:22Z",
- "deleted_at": "2019-08-24T14:15:22Z",
- "draft": true,
- "finalized_at": "2019-08-24T14:15:22Z",
- "id": "string",
- "pinned_at": "2019-08-24T14:15:22Z",
- "title": "string",
- "treatment_note_template": {
}, - "updated_at": "2019-08-24T14:15:22Z"
}
], - "total_entries": 1,
}
Resource was unarchived
{- "archived_at": "2019-08-24T14:15:22Z",
- "author_name": "string",
- "content": {
- "sections": [
- {
- "name": "string",
- "description": "string",
- "questions": [
- {
- "name": "string",
- "type": "bodycharts",
- "answer": "string",
- "answers": [
- {
- "value": null,
- "selected": null
}
], - "other": {
- "enabled": true,
- "selected": true,
- "value": "string"
}, - "body_chart_ids": [
- "1"
]
}
]
}
]
}, - "created_at": "2019-08-24T14:15:22Z",
- "deleted_at": "2019-08-24T14:15:22Z",
- "draft": true,
- "finalized_at": "2019-08-24T14:15:22Z",
- "id": "string",
- "pinned_at": "2019-08-24T14:15:22Z",
- "title": "string",
- "treatment_note_template": {
}, - "updated_at": "2019-08-24T14:15:22Z"
}