{
  "autoscored_sections": [
    {
      "section_key": "results",
      "section_title": "Results",
      "value": 42
    }
  ],
  "custom_module_form_id": "1380649",
  "deleted_at": "2024-07-04T10:35:45+00:00",
  "dietician_organization_id": "123450",
  "dietitian_email_address": "drfleming@example.com",
  "dietitian_first_name": "Alexander",
  "dietitian_id": "100070",
  "dietitian_last_name": "Fleming",
  "dietitian_organization_id": "123450",
  "filler_email": "patient0@example.com",
  "filler_id": "2718281",
  "filler_is_patient": true,
  "finished": true,
  "form_answer_group_id": "4231415",
  "form_answer_group_name": "PHQ-8 Form",
  "form_answers": {
    "1313912": {
      "answer": "Poorly",
      "created_at": "2024-07-04T10:32:12+00:00",
      "custom_module_id": "1313912",
      "id": "301412",
      "label": "How are you feeling?"
    },
    "1313913": {
      "answer": "Aches and pains",
      "created_at": "2024-07-04T10:32:17+00:00",
      "custom_module_id": "1313913",
      "id": "301414",
      "label": "What's the worst symptom?"
    }
  },
  "locked_at": "2024-07-04T10:35:44+00:00",
  "locked_by_email": "drfleming@example.com",
  "locked_by_id": "100070",
  "ordered_answers": [
    {
      "answer": "Happy",
      "created_at": "2024-07-04T09:39:18+00:00",
      "custom_module_id": "90129",
      "id": "672131",
      "label": "How are you feeling today?",
      "read_only": false
    }
  ],
  "signings": [
    {
      "created_at": "2024-07-05T13:37:19+00:00",
      "id": "2401221",
      "user_id": "2718281"
    }
  ],
  "timing": {
    "created_at": "2022-07-01T00:01:00+00:00",
    "updated_at": "2022-07-01T00:01:00+00:00"
  },
  "use_for_charting": false,
  "user_id": "2718281"
}
{
  "autoscored_sections": {
    "section_key": "Section key",
    "section_title": "Section title",
    "value": "Value of the auto-scored section"
  },
  "custom_module_form_id": "ID of the form (Custom Module Form) for the form response (Form Answer Group)",
  "deleted_at": "Time the form response (Form Answer Group) was deleted, if it was deleted",
  "dietician_organization_id": "Organization ID for the User's (Patient's) registered dietitian",
  "dietitian_email_address": "Email address of the User's (Patient's) registered dietitian",
  "dietitian_first_name": "First name of the User's (Patient's) registered dietitian",
  "dietitian_id": "ID of the User's (Patient's) registered dietitian",
  "dietitian_last_name": "Last name of the User's (Patient's) registered dietitian",
  "dietitian_organization_id": "Organization ID for the User's (Patient's) registered dietitian",
  "filler_email": "Email of the User who completed the form response (Form Answer Group)",
  "filler_id": "ID of the User (Patient or Provider) who filled out the form response (Form Answer Group)",
  "filler_is_patient": "Whether or not the User who filled out the form is a Patient",
  "finished": "Is the form response (Form Answer Group) completed",
  "form_answer_group_id": "ID of the form response (Form Answer Group)",
  "form_answer_group_name": "Name of the form for the (Form Answer Group), i.e. the Custom Module Form name",
  "form_answers": {
    "key": null,
    "value": {
      "answer": "Answer to the form question (Custom Module)",
      "created_at": "Time the form answer was registered",
      "custom_module_id": "ID of the form question (Custom Module)",
      "id": "ID for the form response (Form Answer Group) individual question answer (Form Answer)",
      "label": "Form question (Custom Module) text",
      "read_only": "Is this Answer a read-only value (from the Custom Module)"
    }
  },
  "locked_at": "Time the form response (Form Answer Group) was locked, if it was locked",
  "locked_by_email": "Email of the User (Provider) who locked the form response (Form Answer Group), if it was locked",
  "locked_by_id": "ID of the User (Provider) who locked the form response (Form Answer Group), if it was locked",
  "ordered_answers": {
    "answer": "Answer to the form question (Custom Module)",
    "created_at": "Time the form answer was registered",
    "custom_module_id": "ID of the form question (Custom Module)",
    "id": "ID for the form response (Form Answer Group) individual question answer (Form Answer)",
    "label": "Form question (Custom Module) text",
    "read_only": "Is this Answer a read-only value (from the Custom Module)"
  },
  "signings": {
    "created_at": "Time the form response (Form Answer Group) signing was performed",
    "id": "ID for the form response (Form Answer Group) signing event",
    "user_id": "ID of the User (Provider) who signed the form response (Form Answer Group)"
  },
  "timing": {
    "created_at": "Time the object was created",
    "updated_at": "Time the object was updated"
  },
  "use_for_charting": "Is the form (Custom Module Form) for this form response (Form Answer Group) used for charting",
  "user_id": "ID of the User (Patient) for whom the form response (Form Answer Group) pertains to"
}

Events

Triggering Webhook Types

The following event types are associated with the Form Answer Group event payload from Healthie.

  • Healthie Form Answer Group Created
  • Healthie Form Answer Group Locked
  • Healthie Form Answer Group Signed
{
  "autoscored_sections": [
    {
      "section_key": "results",
      "section_title": "Results",
      "value": 42
    }
  ],
  "custom_module_form_id": "1380649",
  "deleted_at": "2024-07-04T10:35:45+00:00",
  "dietician_organization_id": "123450",
  "dietitian_email_address": "drfleming@example.com",
  "dietitian_first_name": "Alexander",
  "dietitian_id": "100070",
  "dietitian_last_name": "Fleming",
  "dietitian_organization_id": "123450",
  "filler_email": "patient0@example.com",
  "filler_id": "2718281",
  "filler_is_patient": true,
  "finished": true,
  "form_answer_group_id": "4231415",
  "form_answer_group_name": "PHQ-8 Form",
  "form_answers": {
    "1313912": {
      "answer": "Poorly",
      "created_at": "2024-07-04T10:32:12+00:00",
      "custom_module_id": "1313912",
      "id": "301412",
      "label": "How are you feeling?"
    },
    "1313913": {
      "answer": "Aches and pains",
      "created_at": "2024-07-04T10:32:17+00:00",
      "custom_module_id": "1313913",
      "id": "301414",
      "label": "What's the worst symptom?"
    }
  },
  "locked_at": "2024-07-04T10:35:44+00:00",
  "locked_by_email": "drfleming@example.com",
  "locked_by_id": "100070",
  "ordered_answers": [
    {
      "answer": "Happy",
      "created_at": "2024-07-04T09:39:18+00:00",
      "custom_module_id": "90129",
      "id": "672131",
      "label": "How are you feeling today?",
      "read_only": false
    }
  ],
  "signings": [
    {
      "created_at": "2024-07-05T13:37:19+00:00",
      "id": "2401221",
      "user_id": "2718281"
    }
  ],
  "timing": {
    "created_at": "2022-07-01T00:01:00+00:00",
    "updated_at": "2022-07-01T00:01:00+00:00"
  },
  "use_for_charting": false,
  "user_id": "2718281"
}
{
  "autoscored_sections": {
    "section_key": "Section key",
    "section_title": "Section title",
    "value": "Value of the auto-scored section"
  },
  "custom_module_form_id": "ID of the form (Custom Module Form) for the form response (Form Answer Group)",
  "deleted_at": "Time the form response (Form Answer Group) was deleted, if it was deleted",
  "dietician_organization_id": "Organization ID for the User's (Patient's) registered dietitian",
  "dietitian_email_address": "Email address of the User's (Patient's) registered dietitian",
  "dietitian_first_name": "First name of the User's (Patient's) registered dietitian",
  "dietitian_id": "ID of the User's (Patient's) registered dietitian",
  "dietitian_last_name": "Last name of the User's (Patient's) registered dietitian",
  "dietitian_organization_id": "Organization ID for the User's (Patient's) registered dietitian",
  "filler_email": "Email of the User who completed the form response (Form Answer Group)",
  "filler_id": "ID of the User (Patient or Provider) who filled out the form response (Form Answer Group)",
  "filler_is_patient": "Whether or not the User who filled out the form is a Patient",
  "finished": "Is the form response (Form Answer Group) completed",
  "form_answer_group_id": "ID of the form response (Form Answer Group)",
  "form_answer_group_name": "Name of the form for the (Form Answer Group), i.e. the Custom Module Form name",
  "form_answers": {
    "key": null,
    "value": {
      "answer": "Answer to the form question (Custom Module)",
      "created_at": "Time the form answer was registered",
      "custom_module_id": "ID of the form question (Custom Module)",
      "id": "ID for the form response (Form Answer Group) individual question answer (Form Answer)",
      "label": "Form question (Custom Module) text",
      "read_only": "Is this Answer a read-only value (from the Custom Module)"
    }
  },
  "locked_at": "Time the form response (Form Answer Group) was locked, if it was locked",
  "locked_by_email": "Email of the User (Provider) who locked the form response (Form Answer Group), if it was locked",
  "locked_by_id": "ID of the User (Provider) who locked the form response (Form Answer Group), if it was locked",
  "ordered_answers": {
    "answer": "Answer to the form question (Custom Module)",
    "created_at": "Time the form answer was registered",
    "custom_module_id": "ID of the form question (Custom Module)",
    "id": "ID for the form response (Form Answer Group) individual question answer (Form Answer)",
    "label": "Form question (Custom Module) text",
    "read_only": "Is this Answer a read-only value (from the Custom Module)"
  },
  "signings": {
    "created_at": "Time the form response (Form Answer Group) signing was performed",
    "id": "ID for the form response (Form Answer Group) signing event",
    "user_id": "ID of the User (Provider) who signed the form response (Form Answer Group)"
  },
  "timing": {
    "created_at": "Time the object was created",
    "updated_at": "Time the object was updated"
  },
  "use_for_charting": "Is the form (Custom Module Form) for this form response (Form Answer Group) used for charting",
  "user_id": "ID of the User (Patient) for whom the form response (Form Answer Group) pertains to"
}

Payload Field Details

Form Answer Group
Event Payload