Packet Response

A Packet Response is a single Patient's submission of a Packet. It groups the individual Response records for every Form inside that packet into one submission.

Contains PHI

Like Response, a Packet Response aggregates the patient's actual answers across every form in the packet, treat it as PHI.

Key fields

Field	Notes
id	Read-only
packet	The Packet this is a submission of
is_submitted	true once every form in the packet has been completed; the packet response is then locked
submitted_at	Read-only
is_archived
form_index	Position of the form the patient is currently on within the packet's sequence, used to resume a multi-form packet in order
is_queued	Whether the packet response has been added to the team's internal review queue in the dashboard
responses	Array of the individual Response IDs grouped under this packet response, one per Form in the packet

Lifecycle

1. A Packet Response is created when a patient opens a sent Packet.
2. form_index advances as the patient moves through each Form; each completed Form becomes its own Response, added to responses.
3. Once every Form in the Packet has been submitted, is_submitted flips to true and submitted_at is stamped.
4. Both the grouped JSON data and a single combined PDF can be pulled once the packet response is complete.

No standalone list/retrieve endpoint

Unlike other resources, Packet Response doesn't have its own list or retrieve operation. Reach it through the Responses API, each Response includes its parent packet_response, or download the combined PDF directly by ID.

See in API Reference

• Download packet response PDF
• Get responses. Filter or inspect by packet_response_id / packet_response