Skip to main content
POST
curl

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

slug
string
required

Questionnaire category slug returned by the categories endpoint.

Query Parameters

locale
enum<string>

Presentation language. The query parameter wins over a body locale; otherwise the account locale is used, with English as the fallback.

Available options:
en,
es

Body

application/json
question_key
string

Stable question key returned by current or review.

value

Scalar for a single choice, array for multi-select, field map for input or grid questions, or an owned document UUID for uploads.

values

Alias of value. Send only one of value and values.

option_inputs
object

Follow-up values keyed by option_input_key.

additional_info
string

Optional free-text additional information.

skip
boolean

Send true, without values, to skip an optional question explicitly.

values_key
string

Select one grid item; value[values_key] is then required.

option_input_key
string

Select one follow-up item; option_inputs[option_input_key] is then required.

answers
object[]

Atomic batch of answers. Send it instead of a single answer; an invalid entry saves nothing.

expected_revision
string

Revision from the last response. A stale value returns 409.

locale
string

en or es. Other values fall back to English.

renewal_origin
string

Renewal context; send the same value on every guided call and on submit.

renewal_changed
boolean

Renewal context: whether the patient reports a change.

treatment_id
string

Renewal context: the treatment being renewed.

dosage
string

Renewal context. Dosage eligibility is enforced at submit.

consultation_id
string<uuid>

Renewal context: the consultation being renewed.

Response

The next applicable item, progress and the current revision.

question
required

Descriptor of the next item to show, or null when nothing is pending.

complete
boolean
required

True when every required answer is valid. Matches review.ready_to_submit; an unanswered optional question can still be returned.

revision
string
required

Opaque content token for optimistic concurrency. Send it back as expected_revision.

status
string
required

in_progress, or ready_to_submit when complete is true.

category_title
string
required

Localized questionnaire title.

answered_count
integer
required

Applicable items answered or explicitly skipped.

applicable_total
integer
required

Items that currently apply, including grid items and active required follow-ups.

progress
object
required

Navigation progress; not a measure of clinical validity.

reusable_prefill
object | null

A previous answer the patient may confirm for this question. It does not count as answered.

dropped_question_keys
string[]

Parent answers removed from the draft because a branch closed.

dropped_option_inputs
object[]

Follow-up values removed while their parent answer was kept.

moved_back
boolean

True when an answered item was selected (back only).

at_start
boolean

True when no earlier item precedes the returned question; also true for an empty questionnaire.