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 | |
object | |
completed_at | string or null <date-time> |
object or null | |
created_at | string <date-time> |
edited_at | string or null <date-time> |
email_to_patient_on_completion | boolean or null |
id | string <int64> |
object | |
name | string <= 255 characters |
object | |
restricted_to_practitioner | boolean or null |
object or null | |
updated_at | string <date-time> |
url | string or null <uri> |
{- "archived_at": "2019-08-24T14:15:22Z",
- "completed_at": "2019-08-24T14:15:22Z",
- "content": {
- "sections": [
- {
- "name": "string",
- "description": "string",
- "questions": [
- {
- "name": "string",
- "type": "checkboxes",
- "required": true,
- "signature_id": "1",
- "answer": "string",
- "answers": [
- {
- "value": null,
- "selected": null
}
], - "other": {
- "enabled": true,
- "selected": true,
- "value": "string"
}
}
]
}
]
}, - "created_at": "2019-08-24T14:15:22Z",
- "edited_at": "2019-08-24T14:15:22Z",
- "email_to_patient_on_completion": true,
- "id": "string",
- "name": "string",
- "restricted_to_practitioner": true,
- "signatures": {
}, - "updated_at": "2019-08-24T14:15:22Z",
}
successful operation
{- "patient_forms": [
- {
- "archived_at": "2019-08-24T14:15:22Z",
- "completed_at": "2019-08-24T14:15:22Z",
- "content": {
- "sections": [
- {
- "name": "string",
- "description": "string",
- "questions": [
- {
- "name": null,
- "type": null,
- "required": null,
- "signature_id": null,
- "answer": null,
- "answers": [ ],
- "other": { }
}
]
}
]
}, - "created_at": "2019-08-24T14:15:22Z",
- "edited_at": "2019-08-24T14:15:22Z",
- "email_to_patient_on_completion": true,
- "id": "string",
- "name": "string",
- "restricted_to_practitioner": true,
- "signatures": {
}, - "updated_at": "2019-08-24T14:15:22Z",
}
], - "total_entries": 1,
- "links": {
}
}
When creating a patient form with a patient_form_template_id
, the values for name
, content
, and restricted_to_practitioner
will be pulled from the template. However, you may provide any of those values to override the template, or even provide all of your own values and exclude the patient_form_template_id
altogether.
Resource was created
Resource could not be saved due to validation errors
{- "attendee_id": "1",
- "completed": true,
- "email_to_patient_on_completion": true,
- "patient_id": "1",
- "patient_form_template_id": "1",
- "content": {
- "sections": [
- {
- "name": "string",
- "description": "string",
- "questions": [
- {
- "name": "string",
- "type": "checkboxes",
- "required": true,
- "signature_id": "1",
- "answer": "string",
- "answers": [
- {
- "value": null,
- "selected": null
}
], - "other": {
- "enabled": true,
- "selected": true,
- "value": "string"
}
}
]
}
]
}, - "name": "string",
- "restricted_to_practitioner": true
}
{- "archived_at": "2019-08-24T14:15:22Z",
- "completed_at": "2019-08-24T14:15:22Z",
- "content": {
- "sections": [
- {
- "name": "string",
- "description": "string",
- "questions": [
- {
- "name": "string",
- "type": "checkboxes",
- "required": true,
- "signature_id": "1",
- "answer": "string",
- "answers": [
- {
- "value": null,
- "selected": null
}
], - "other": {
- "enabled": true,
- "selected": true,
- "value": "string"
}
}
]
}
]
}, - "created_at": "2019-08-24T14:15:22Z",
- "edited_at": "2019-08-24T14:15:22Z",
- "email_to_patient_on_completion": true,
- "id": "string",
- "name": "string",
- "restricted_to_practitioner": true,
- "signatures": {
}, - "updated_at": "2019-08-24T14:15:22Z",
}
q[] | Array of strings |
Successful operation
{- "archived_at": "2019-08-24T14:15:22Z",
- "completed_at": "2019-08-24T14:15:22Z",
- "content": {
- "sections": [
- {
- "name": "string",
- "description": "string",
- "questions": [
- {
- "name": "string",
- "type": "checkboxes",
- "required": true,
- "signature_id": "1",
- "answer": "string",
- "answers": [
- {
- "value": null,
- "selected": null
}
], - "other": {
- "enabled": true,
- "selected": true,
- "value": "string"
}
}
]
}
]
}, - "created_at": "2019-08-24T14:15:22Z",
- "edited_at": "2019-08-24T14:15:22Z",
- "email_to_patient_on_completion": true,
- "id": "string",
- "name": "string",
- "restricted_to_practitioner": true,
- "signatures": {
}, - "updated_at": "2019-08-24T14:15:22Z",
}
Resource was updated
Resource could not be saved due to validation errors
{- "attendee_id": "1",
- "completed": true,
- "email_to_patient_on_completion": true,
- "patient_id": "1",
- "patient_form_template_id": "1",
- "content": {
- "sections": [
- {
- "name": "string",
- "description": "string",
- "questions": [
- {
- "name": "string",
- "type": "checkboxes",
- "required": true,
- "signature_id": "1",
- "answer": "string",
- "answers": [
- {
- "value": null,
- "selected": null
}
], - "other": {
- "enabled": true,
- "selected": true,
- "value": "string"
}
}
]
}
]
}, - "name": "string",
- "restricted_to_practitioner": true
}
{- "archived_at": "2019-08-24T14:15:22Z",
- "completed_at": "2019-08-24T14:15:22Z",
- "content": {
- "sections": [
- {
- "name": "string",
- "description": "string",
- "questions": [
- {
- "name": "string",
- "type": "checkboxes",
- "required": true,
- "signature_id": "1",
- "answer": "string",
- "answers": [
- {
- "value": null,
- "selected": null
}
], - "other": {
- "enabled": true,
- "selected": true,
- "value": "string"
}
}
]
}
]
}, - "created_at": "2019-08-24T14:15:22Z",
- "edited_at": "2019-08-24T14:15:22Z",
- "email_to_patient_on_completion": true,
- "id": "string",
- "name": "string",
- "restricted_to_practitioner": true,
- "signatures": {
}, - "updated_at": "2019-08-24T14:15:22Z",
}
successful operation
{- "patient_forms": [
- {
- "archived_at": "2019-08-24T14:15:22Z",
- "completed_at": "2019-08-24T14:15:22Z",
- "content": {
- "sections": [
- {
- "name": "string",
- "description": "string",
- "questions": [
- {
- "name": null,
- "type": null,
- "required": null,
- "signature_id": null,
- "answer": null,
- "answers": [ ],
- "other": { }
}
]
}
]
}, - "created_at": "2019-08-24T14:15:22Z",
- "edited_at": "2019-08-24T14:15:22Z",
- "email_to_patient_on_completion": true,
- "id": "string",
- "name": "string",
- "restricted_to_practitioner": true,
- "signatures": {
}, - "updated_at": "2019-08-24T14:15:22Z",
}
], - "total_entries": 1,
}