Response
A Response is a single Patient's submission of a single Form, the actual answered data, not the form definition itself. This is the resource most EHR integrations ultimately read from.
Contains PHI
A Response holds the patient's actual answers, which, depending on the form, can include medical history, insurance details, and signed consent. Treat Response payloads as PHI.
Key fields
| Field | Notes |
|---|---|
id | Read-only |
patient | The Patient who submitted it |
form | The Form this is a submission of |
packet_response | The parent Packet Response, if this Response is part of a packet send, otherwise absent |
document | The PDF Document template this form renders from, if applicable |
answers | Array of answered questions (answer_raw, plus derived answer_text / answer_num / answer_date / answer_time / answer_datetime, notes, and any answer_choices) |
answer_signatures | E-signatures captured on the form |
answer_matrix_cells | Answers to matrix/grid questions |
answer_files | Uploaded files (e.g., insurance card photos) |
is_submitted | Once true, the response is locked. Zentake's own editing logic prevents further changes |
submitted_at | Read-only, set when is_submitted becomes true |
is_archived | |
user | The staff user who filled it out, if it was entered on the patient's behalf rather than self-submitted |
The list endpoint returns a lighter shape (ResponseList) with
form_id / form_name / document_id / document_name /
packet_response_id in place of the nested objects, to keep list pages
fast, fetch the individual response for the full nested payload.
Lifecycle
- A Response is created when a patient opens a sent Form (or a Form inside a sent Packet). It can exist before it's finished.
- As the patient answers questions,
answers/answer_signatures/answer_matrix_cells/answer_filesaccumulate. - Once every required field and required signature is satisfied,
is_submittedflips totrueandsubmitted_atis stamped. The Response is then read-only. - Your integration typically hears about this moment via a webhook, then fetches the Response as JSON or downloads it as a filled PDF.
Read-only via API
Responses are produced by the patient completing intake, not written by your integration. The API exposes list, retrieve, and download only.