Skip to main content
POST
curl

Authorizations

Authorization
string
header
required

Partner API key sent as Authorization: Bearer . Test keys and live keys are separate.

Headers

Idempotency-Key
string

Accepted but not used for replay on this operation. Only POST /v1/partner/consultations stores and replays responses by Idempotency-Key.

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

Path Parameters

consultation_id
string<uuid>
required

The consultation id.

request_id
string<uuid>
required

The information request id.

Query Parameters

locale
string

Language for the question labels: one of en, es, zh. Defaults to the partner's default locale; any other value falls back to English.

Body

application/json

Send at least one answer, one upload or (on an identity_document_required request) the identity document; a body with none of them is refused with 422 invalid_request before the answer's contents are checked. null is the same as omitting a member; any other type is refused with 422 invalid_request.

answers
object[]
required

Answers for the requested question keys only; may be omitted when uploads or the identity document are sent. Each question may be answered once (otherwise 422 invalid_answers).

Minimum array length: 1

One entries-v1 answer: question_key plus exactly one payload, value, values or skip, as the question kind requires.

uploads
string<uuid>[] | null

upload_id values for requested documents: at most 10 (more is refused with 422 invalid_request). Each upload can be used once: a duplicate, here or between uploads and an upload answer in answers, is refused with 422 upload_unusable, as is an upload that does not exist, expired or was already used.

Maximum array length: 10
identity_document

The patient's identity document. Accepted only on a request with reason_code identity_document_required (on any other request it is refused with 422 invalid_request, field identity_document, code unexpected_field), and required there: once the body carries an answer or an upload, a missing document is refused with 422 identity_document_required (a body with no answer, upload or document is refused with 422 invalid_request first). Validated like patient.identity_document on submission: a document that breaks the rules (unknown issuing state, wrong check letter, number format), a non-object or unknown members is refused with 422 invalid_request, field identity_document, code invalid_identity_document; a structural error keeps its nested field error instead, for example field identity_document.type with code invalid_choice for an unsupported type, or identity_document.number with code required, blank or max_length. A document different from the one stored for the patient is refused with 409 patient_conflict. Never echoed or returned; live mode stores it on the patient's account, test mode stores nothing.

Response

The answered information request.

id
string<uuid>
required

The information request id.

object
enum<string>
required

Always info_request.

Available options:
info_request
consultation_id
string<uuid>
required

The consultation this belongs to.

status
enum<string>
required

open, answered or withdrawn.

Available options:
open,
answered,
withdrawn
reason_code
enum<string>
required

Why the doctor needs more information.

Available options:
answer_unclear,
answer_inconsistent,
photo_quality,
photo_missing,
measurement_check,
medication_history,
medical_history,
identity_check,
document_missing,
identity_document_required,
other_clarification
reason_label
string
required

Readable form of reason_code.

question_keys
string[]
required

Question keys the doctor asked to be answered again.

questions
object[]
required

The questions to answer.

documents_requested
string[]
required

Kinds of documents the doctor asked for; answer them with upload ids.

requested_at
string<date-time> | null
required

When the doctor raised the request.

answered_at
string<date-time> | null
required

When the request was answered; null while it is open.

withdrawn_at
string<date-time> | null
required

When the request was withdrawn; null if it was not.

answered_question_keys
string[]
required

The question keys the answer covered, in answer order; empty until answered. The answer values are never returned.

answer_count
integer
required

How many answer entries Hi Doctor accepted; 0 until answered.

Required range: x >= 0
answer_document_count
integer
required

How many files the answer attached; 0 until answered.

Required range: x >= 0