# digital_form_response.completed A Patient completed a DigitalFormResponse. ## Payload schema - `object` - `api_version` (`any`) - `context` (`object`) - Present only when `source` is `api`. Identifies the acting project and API key. - `developer_platform_api_key_id` (`string | null`) - format: `uuid` - `developer_platform_project_id` (`string | null`) - format: `uuid` - `created_at` (`string`) - format: `date-time`; An ISO 8601 timestamp in UTC, with a `Z` suffix. For example, `2026-07-01T09:00:00Z`. - `data` (`object`) - `object` (`object`) - `answers` (`array`) - The answers currently recorded for the DigitalFormResponse. - `items` (`object`) - `attachment_url` (`string | null`) - format: `uri`; The temporary URL for an attached answer. - `date_value` (`string | null`) - format: `date`; The date supplied for a date question. - `digital_form_question` (`object`) - A question on a DigitalForm. Embedded on DigitalForm and on each DigitalFormResponse answer. - `choices` (`array`) - The choices available for a choice question. - `items` (`object`) - `id` (`string`) - format: `uuid`; The identifier of the DigitalFormQuestionChoice. - `numerical_value` (`number | null`) - The optional numerical value assigned to the choice. - `text_value` (`string | null`) - The optional machine-readable text value assigned to the choice. - `title` (`string`) - The choice shown to the Patient. - `help_text` (`string | null`) - The supplementary guidance shown with the question. - `id` (`string`) - format: `uuid`; The resource's unique identifier, formatted as an RFC 4122 version 4 UUID. - `is_answer_required` (`boolean`) - Whether the Patient must answer the question. - `list_order_number` (`integer | null`) - The position of the question in the DigitalForm. - `question_type` (`string`) - enum: `consent_required`, `information_statement`, `multiple_choice_input`, `single_choice_input`, `text_input`, `number_input`, `date_input`, `signature_input`; The input and consent behavior of the question. - `title` (`string`) - The question shown to the Patient. - `digital_form_question_choice_id` (`string | null`) - format: `uuid`; The selected DigitalFormQuestionChoice. - `digital_form_question_id` (`string`) - format: `uuid`; The DigitalFormQuestion answered. - `has_consented` (`boolean | null`) - Whether the Patient granted the requested consent. - `id` (`string`) - format: `uuid`; The identifier of the DigitalFormQuestionAnswer. - `numerical_value` (`number | null`) - The numerical answer. - `text_value` (`string | null`) - The text answer or selected choice title. - `booking_id` (`string | null`) - format: `uuid`; The Booking associated with the response. - `completed_at` (`string | null`) - format: `date-time`; An ISO 8601 timestamp in UTC, with a `Z` suffix. For example, `2026-07-01T09:00:00Z`. - `created_at` (`string`) - format: `date-time`; An ISO 8601 timestamp in UTC, with a `Z` suffix. For example, `2026-07-01T09:00:00Z`. - `digital_form` (`object`) - `attachment_url` (`string | null`) - format: `uri`; The temporary URL for the attachment displayed with the DigitalForm. - `created_at` (`string`) - format: `date-time`; An ISO 8601 timestamp in UTC, with a `Z` suffix. For example, `2026-07-01T09:00:00Z`. - `id` (`string`) - format: `uuid`; The resource's unique identifier, formatted as an RFC 4122 version 4 UUID. - `object` (`any`) - Discriminator value emitted at `object`. - `patient_instructions` (`string | null`) - The sanitized instructions shown to the Patient. - `questions` (`array`) - The ordered questions included in the DigitalForm. - `items` (`object`) - A question on a DigitalForm. Embedded on DigitalForm and on each DigitalFormResponse answer. - `choices` (`array`) - The choices available for a choice question. - `items` (`object`) - `id` (`string`) - format: `uuid`; The identifier of the DigitalFormQuestionChoice. - `numerical_value` (`number | null`) - The optional numerical value assigned to the choice. - `text_value` (`string | null`) - The optional machine-readable text value assigned to the choice. - `title` (`string`) - The choice shown to the Patient. - `help_text` (`string | null`) - The supplementary guidance shown with the question. - `id` (`string`) - format: `uuid`; The resource's unique identifier, formatted as an RFC 4122 version 4 UUID. - `is_answer_required` (`boolean`) - Whether the Patient must answer the question. - `list_order_number` (`integer | null`) - The position of the question in the DigitalForm. - `question_type` (`string`) - enum: `consent_required`, `information_statement`, `multiple_choice_input`, `single_choice_input`, `text_input`, `number_input`, `date_input`, `signature_input`; The input and consent behavior of the question. - `title` (`string`) - The question shown to the Patient. - `title` (`string`) - The title of the DigitalForm. - `updated_at` (`string`) - format: `date-time`; An ISO 8601 timestamp in UTC, with a `Z` suffix. For example, `2026-07-01T09:00:00Z`. - `due_at` (`string | null`) - format: `date-time`; An ISO 8601 timestamp in UTC, with a `Z` suffix. For example, `2026-07-01T09:00:00Z`. - `id` (`string`) - format: `uuid`; The resource's unique identifier, formatted as an RFC 4122 version 4 UUID. - `links` (`object`) - URLs to related resources. - `patient` (`string`) - format: `uri`; The full URL of a related resource. - `transmissions` (`string`) - format: `uri`; The full URL of a related resource. - `object` (`any`) - Discriminator value emitted at `object`. - `patient_id` (`string`) - format: `uuid`; The Patient asked to complete the DigitalForm. - `status` (`string`) - enum: `awaiting_completion`, `partially_completed`, `overdue`, `completed`; The completion status of the DigitalFormResponse. - `total_score` (`integer | null`) - The sum of numerical answers configured to contribute to the score. - `updated_at` (`string`) - format: `date-time`; An ISO 8601 timestamp in UTC, with a `Z` suffix. For example, `2026-07-01T09:00:00Z`. - `developer_platform_project_id` (`string | null`) - format: `uuid`; The project ID whose credential caused the change. Null for `dashboard` events. - `id` (`string`) - Event identifier prefixed with `evt_`. - `livemode` (`boolean`) - `false` for test-event deliveries. - `object` (`any`) - `source` (`string`) - enum: `api`, `dashboard`; Origin of the change. `api` means a Developer Platform mutation; `dashboard` means a Carebit-initiated change. - `type` (`any`) ### Example payload ```json { "id": "evt_00000000-0000-4000-8000-000000000012", "object": "event", "api_version": "v1", "created_at": "2026-01-01T09:00:00Z", "data": { "object": { "id": "00000000-0000-4000-8000-000000000021", "object": "digital_form_response", "answers": [ { "id": "00000000-0000-4000-8000-000000000024", "attachment_url": null, "date_value": null, "digital_form_question": { "id": "00000000-0000-4000-8000-000000000022", "choices": [ { "id": "00000000-0000-4000-8000-000000000023", "numerical_value": 1, "text_value": "yes", "title": "Yes" } ], "help_text": "Select every option that applies.", "is_answer_required": true, "list_order_number": 1, "question_type": "single_choice_input", "title": "Do you consent to the procedure?" }, "digital_form_question_choice_id": "00000000-0000-4000-8000-000000000023", "digital_form_question_id": "00000000-0000-4000-8000-000000000022", "has_consented": null, "numerical_value": 1, "text_value": "Yes" } ], "booking_id": "00000000-0000-4000-8000-000000000001", "completed_at": "2026-01-01T09:00:00Z", "created_at": "2026-01-01T09:00:00Z", "digital_form": { "id": "00000000-0000-4000-8000-000000000020", "object": "digital_form", "attachment_url": null, "created_at": "2026-01-01T09:00:00Z", "patient_instructions": "Please complete this consent form.", "questions": [ { "id": "00000000-0000-4000-8000-000000000022", "choices": [ { "id": "00000000-0000-4000-8000-000000000023", "numerical_value": 1, "text_value": "yes", "title": "Yes" } ], "help_text": "Select every option that applies.", "is_answer_required": true, "list_order_number": 1, "question_type": "single_choice_input", "title": "Do you consent to the procedure?" } ], "title": "Pre-operative consent", "updated_at": "2026-01-01T09:00:00Z" }, "due_at": "2026-01-01T08:30:00Z", "links": { "patient": "https://api.carebit.co/v1/patients/00000000-0000-4000-8000-000000000004", "transmissions": "https://api.carebit.co/v1/transmissions?patient_id=00000000-0000-4000-8000-000000000004&resource_type=digital_form_response" }, "patient_id": "00000000-0000-4000-8000-000000000004", "status": "completed", "total_score": 0, "updated_at": "2026-01-01T09:00:00Z" } }, "developer_platform_project_id": null, "livemode": false, "source": "dashboard", "type": "digital_form_response.completed" } ```