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.

Headers

Idempotency-Key
string

Optional key that makes a retry safe. Generate one value per logical operation (8 to 128 ASCII letters, digits, underscores or hyphens) and resend the same value on every retry. A repeat of a completed request returns its original status with Idempotent-Replayed: true and a short body of state, resource_ids and response_hash; read the resources to recover their content. Reusing a key with a different request returns 422 idempotency_key_reuse; a request still running returns 409 idempotency_in_progress. Keys are kept for 30 days. See https://docs.hi-doctor.ai/api-reference/idempotency.

Pattern: ^[A-Za-z0-9_-]{8,128}$

Path Parameters

slug
string
required

Questionnaire category slug returned by the categories endpoint.

Body

application/json
data
object[]
required

Questionnaire step-answer records, using the current questionnaire schema.

renewal_origin
string

Renewal origin for this response or request.

renewal_changed
boolean

Whether renewal changed applies to this response or request.

treatment_id
string

Identifier of the related treatment.

consultation_id
string<uuid>

Identifier of the related consultation.

Response

Questionnaire submitted. Successful response example withheld pending an approved projection that does not expose private questionnaire metadata.

submission
object
required

Submission returned or accepted by this contract.

progress
object
required

Progress returned or accepted by this contract.

answer_status
object
required

Answer status returned or accepted by this contract.