Patient Form

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.

PatientForm

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>
{}

List patient forms

get/patient_forms
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
completed_at date-time
created_at date-time
id int64
patient_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 patient form
post/patient_forms
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.


SecuritybasicAuth 
Request 
Request Body schema: application/json
attendee_id
string <int64> 
attendee id


 
completed
boolean
 
object or null
 
email_to_patient_on_completion
boolean or null
 
name
string  <= 255 characters 
 
patient_form_template_id
string <int64> 
 
patient_id
string <int64> 
patient id


 
restricted_to_practitioner
boolean or null
 
Responses 
201
Resource was created


422
Resource could not be saved due to validation errors


Request samples 
application/json
{
  • "attendee_id": "1",
  • "completed": true,
  • "email_to_patient_on_completion": true,
  • "patient_id": "1",
  • "patient_form_template_id": "1",
  • "content": {
    • "sections": [
      • {
        }
      ]
    },
  • "name": "string",
  • "restricted_to_practitioner": true
}
Response samples 
application/json
{}
Get patient form
get/patient_forms/{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





 
Responses 
200
Successful operation


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


 
completed
boolean
 
object or null
 
email_to_patient_on_completion
boolean or null
 
name
string  <= 255 characters 
 
patient_form_template_id
string <int64> 
 
patient_id
string <int64> 
patient id


 
restricted_to_practitioner
boolean or null
 
Responses 
200
Resource was updated


422
Resource could not be saved due to validation errors


Request samples 
application/json
{
  • "attendee_id": "1",
  • "completed": true,
  • "email_to_patient_on_completion": true,
  • "patient_id": "1",
  • "patient_form_template_id": "1",
  • "content": {
    • "sections": [
      • {
        }
      ]
    },
  • "name": "string",
  • "restricted_to_practitioner": true
}
Response samples 
application/json
{}
List patient forms for attendeeDeprecated
get/attendees/{attendee_id}/patient_forms
SecuritybasicAuth 
Request 
path Parameters
attendee_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




completed_at
date-time




created_at
date-time




id
int64




patient_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 patient form
post/patient_forms/{id}/archive
SecuritybasicAuth 
Request 
path Parameters
id
required
string <int64> 
 
Responses 
204
Resource was archived


Request samples