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
Copy
Ask AI
{
"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"
}
Copy
Ask AI
{
"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
Hide fields
Hide fields
ID of the form response (Form Answer Group)
CEL
Copy
Ask AI
form_answer_group_id
Example
Copy
Ask AI
"4231415"
ID
ID of the User (Patient) for whom the form response (Form Answer Group) pertains toCEL
Copy
Ask AI
user_id
Example
Copy
Ask AI
"2718281"
ID of the form (Custom Module Form) for the form response (Form Answer Group)
CEL
Copy
Ask AI
custom_module_form_id
Example
Copy
Ask AI
"1380649"
ID
ID of the User (Patient or Provider) who filled out the form response (Form Answer Group)CEL
Copy
Ask AI
filler_id
Example
Copy
Ask AI
"2718281"
HI
Whether or not the User who filled out the form is a PatientCEL
Copy
Ask AI
filler_is_patient
Example
Copy
Ask AI
true
PII
Email of the User who completed the form response (Form Answer Group)CEL
Copy
Ask AI
filler_email
Example
Copy
Ask AI
"patient0@example.com"
Is the form response (Form Answer Group) completed
CEL
Copy
Ask AI
finished
Example
Copy
Ask AI
true
Create and update times
CEL
Copy
Ask AI
timing
Example
Copy
Ask AI
{
"created_at": "2022-07-01T00:01:00+00:00",
"updated_at": "2022-07-01T00:01:00+00:00"
}
Time the object was created
CEL
Copy
Ask AI
timing.created_at
Example
Copy
Ask AI
"2022-07-01T00:01:00+00:00"
Time the object was updated
CEL
Copy
Ask AI
timing.updated_at
Example
Copy
Ask AI
"2022-07-01T00:01:00+00:00"
Time the form response (Form Answer Group) was locked, if it was locked
CEL
Copy
Ask AI
locked_at
Example
Copy
Ask AI
"2024-07-04T10:35:44+00:00"
ID of the User (Provider) who locked the form response (Form Answer Group), if it was locked
CEL
Copy
Ask AI
locked_by_id
Example
Copy
Ask AI
"100070"
Email of the User (Provider) who locked the form response (Form Answer Group), if it was locked
CEL
Copy
Ask AI
locked_by_email
Example
Copy
Ask AI
"drfleming@example.com"
Time the form response (Form Answer Group) was deleted, if it was deleted
CEL
Copy
Ask AI
deleted_at
Example
Copy
Ask AI
"2024-07-04T10:35:45+00:00"
HI
PII
Question ID (Custom Module ID) to answer (Form Answer) map (dictionary)CEL
Copy
Ask AI
form_answers
Example
Copy
Ask AI
{
"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?"
}
}
Name of the form for the (Form Answer Group), i.e. the Custom Module Form name
CEL
Copy
Ask AI
form_answer_group_name
Example
Copy
Ask AI
"PHQ-8 Form"
Organization ID for the User’s (Patient’s) registered dietitian
CEL
Copy
Ask AI
dietician_organization_id
Example
Copy
Ask AI
"123450"
Organization ID for the User’s (Patient’s) registered dietitian
CEL
Copy
Ask AI
dietitian_organization_id
Example
Copy
Ask AI
"123450"
First name of the User’s (Patient’s) registered dietitian
CEL
Copy
Ask AI
dietitian_first_name
Example
Copy
Ask AI
"Alexander"
Last name of the User’s (Patient’s) registered dietitian
CEL
Copy
Ask AI
dietitian_last_name
Example
Copy
Ask AI
"Fleming"
Email address of the User’s (Patient’s) registered dietitian
CEL
Copy
Ask AI
dietitian_email_address
Example
Copy
Ask AI
"drfleming@example.com"
ID of the User’s (Patient’s) registered dietitian
CEL
Copy
Ask AI
dietitian_id
Example
Copy
Ask AI
"100070"
ID
Signings for this form response (Form Answer Group)CEL
Copy
Ask AI
signings
Example
Copy
Ask AI
[
{
"created_at": "2024-07-05T13:37:19+00:00",
"id": "2401221",
"user_id": "2718281"
}
]
Mapped array of: ID for the form response (Form Answer Group) signing event
CEL
Copy
Ask AI
signings.map(x, x.id)
Example
Copy
Ask AI
[
"2401221"
]
Mapped array of: Time the form response (Form Answer Group) signing was performed
CEL
Copy
Ask AI
signings.map(x, x.created_at)
Example
Copy
Ask AI
[
"2024-07-05T13:37:19+00:00"
]
ID
Mapped array of: ID of the User (Provider) who signed the form response (Form Answer Group)CEL
Copy
Ask AI
signings.map(x, x.user_id)
Example
Copy
Ask AI
[
"2718281"
]
HI
Auto-scored sections for this form response (Form Answer Group)CEL
Copy
Ask AI
autoscored_sections
Example
Copy
Ask AI
[
{
"section_key": "results",
"section_title": "Results",
"value": 42
}
]
Mapped array of: Section key
CEL
Copy
Ask AI
autoscored_sections.map(x, x.section_key)
Example
Copy
Ask AI
[
"results"
]
Mapped array of: Section title
CEL
Copy
Ask AI
autoscored_sections.map(x, x.section_title)
Example
Copy
Ask AI
[
"Results"
]
HI
Mapped array of: Value of the auto-scored sectionCEL
Copy
Ask AI
autoscored_sections.map(x, x.value)
Example
Copy
Ask AI
[
42
]
Is the form (Custom Module Form) for this form response (Form Answer Group) used for charting
CEL
Copy
Ask AI
use_for_charting
Example
Copy
Ask AI
false
HI
PII
Ordered form answers in the order they are defined in the form (Custom Module Form)CEL
Copy
Ask AI
ordered_answers
Example
Copy
Ask AI
[
{
"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
}
]
Mapped array of: ID for the form response (Form Answer Group) individual question answer (Form Answer)
CEL
Copy
Ask AI
ordered_answers.map(x, x.id)
Example
Copy
Ask AI
[
"672131"
]
Mapped array of: ID of the form question (Custom Module)
CEL
Copy
Ask AI
ordered_answers.map(x, x.custom_module_id)
Example
Copy
Ask AI
[
"90129"
]
HI
PII
Mapped array of: Answer to the form question (Custom Module)CEL
Copy
Ask AI
ordered_answers.map(x, x.answer)
Example
Copy
Ask AI
[
"Happy"
]
Mapped array of: Time the form answer was registered
CEL
Copy
Ask AI
ordered_answers.map(x, x.created_at)
Example
Copy
Ask AI
[
"2024-07-04T09:39:18+00:00"
]
Mapped array of: Form question (Custom Module) text
CEL
Copy
Ask AI
ordered_answers.map(x, x.label)
Example
Copy
Ask AI
[
"How are you feeling today?"
]
Mapped array of: Is this Answer a read-only value (from the Custom Module)
CEL
Copy
Ask AI
ordered_answers.map(x, x.read_only)
Example
Copy
Ask AI
[
false
]