> ## Documentation Index
> Fetch the complete documentation index at: https://docs.morf.health/docs/llms.txt
> Use this file to discover all available pages before exploring further.

# Get Form Answer Group

> Documentation for the Get Form Answer Group action for Healthie

![images/healthie.svg](https://mintcdn.com/morfhealth/EU2WCxuXGIUQcziR/images/healthie.svg?fit=max\&auto=format\&n=EU2WCxuXGIUQcziR\&q=85\&s=d168a24dbae69f2202ca63dd7aa2e1f3)

# Parameters

**Action** `Parameters`

**parameters**

**ID** `string` *required*

This field maps to the destination API `id` field.

```json Result Object Example theme={null}
{
  "$result_object_key": {
    "associated_appointment_id": "597220",
    "autoscored_sections": [
      {
        "section_key": "results",
        "section_title": "Results",
        "value": 42
      }
    ],
    "charting_note_addenda": [
      {
        "content": "Extra data for the charting note",
        "created_at": "2025-11-04T11:31:16Z",
        "id": "604888"
      }
    ],
    "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?",
        "matrix_answers": [
          {
            "cpt_code": "99215",
            "modifiers": "95",
            "units": "1"
          },
          {
            "cpt_code": "G2017",
            "units": "2"
          }
        ],
        "read_only": false
      }
    ],
    "signings": [
      {
        "created_at": "2024-07-05T13:37:19+00:00",
        "first_name": "Brian",
        "id": "2401221",
        "last_name": "Hippocrates",
        "npi": "1000321231",
        "qualifications": "MD",
        "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"
  }
}
```

```json Result Object Description theme={null}
{
  "$result_object_key": {
    "associated_appointment_id": "ID of the Appointment associated with the Form Answer Group (optional)",
    "autoscored_sections": {
      "section_key": "Section key",
      "section_title": "Section title",
      "value": "Value of the auto-scored section"
    },
    "charting_note_addenda": {
      "content": "Content string for the addendum",
      "created_at": "Timestamp for the creation of the addendum",
      "id": "Unique charting note addendum ID"
    },
    "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",
        "matrix_answers": "Matrix answers (a map of column name -> value effectively), only populated if the CustomModule type is \"matrix\"",
        "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",
      "matrix_answers": "Matrix answers (a map of column name -> value effectively), only populated if the CustomModule type is \"matrix\"",
      "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",
      "first_name": "First name of the provider",
      "id": "ID for the form response (Form Answer Group) signing event",
      "last_name": "Last name of the provider",
      "npi": "The User (Provider) who signed the form response's NPI",
      "qualifications": "Qualifications of the provider",
      "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"
  }
}
```

### Result Object Field Details

You can use the result of the action's data as inputs to downstream workflow actions.

Each fetch action requires an object name, which nests the action's result data inside the downstream data context in the workflow. See [Passing Data Between Actions](https://docs.morf.health/docs/knowledge_base/passing_data_between_actions.md) for how to set it and reference the result from downstream nodes.

Here we demonstrate how to refer to this data using the prefix `$result_object_key`.

**FormAnswerGroup** `Fetch Action Response Object`

**fields**

**form\_answer\_group\_id** `string` *required*

ID of the form response (Form Answer Group)

```json CEL theme={null}
$result_object_key.form_answer_group_id
```

```json Example theme={null}
"4231415"
```

**user\_id** `string` *required*

`ID` ID of the User (Patient) for whom the form response (Form Answer Group) pertains to

```json CEL theme={null}
$result_object_key.user_id
```

```json Example theme={null}
"2718281"
```

**custom\_module\_form\_id** `string` *required*

ID of the form (Custom Module Form) for the form response (Form Answer Group)

```json CEL theme={null}
$result_object_key.custom_module_form_id
```

```json Example theme={null}
"1380649"
```

**filler\_id** `string`

`ID` ID of the User (Patient or Provider) who filled out the form response (Form Answer Group)

```json CEL theme={null}
$result_object_key.filler_id
```

```json Example theme={null}
"2718281"
```

**filler\_is\_patient** `bool`

`HI` Whether or not the User who filled out the form is a Patient

```json CEL theme={null}
$result_object_key.filler_is_patient
```

```json Example theme={null}
true
```

**filler\_email** `string`

`PII` Email of the User who completed the form response (Form Answer Group)

```json CEL theme={null}
$result_object_key.filler_email
```

```json Example theme={null}
"patient0@example.com"
```

**finished** `bool` *required*

Is the form response (Form Answer Group) completed

```json CEL theme={null}
$result_object_key.finished
```

```json Example theme={null}
true
```

**timing** `object` *required*

Create and update times

```json CEL theme={null}
$result_object_key.timing
```

```json Example theme={null}
{
"created_at": "2022-07-01T00:01:00+00:00",
"updated_at": "2022-07-01T00:01:00+00:00"
}
```

**timing.created\_at** `timing.v1.Timestamp` *required*

Time the object was created

```json CEL theme={null}
$result_object_key.timing.created_at
```

```json Example theme={null}
"2022-07-01T00:01:00+00:00"
```

**timing.updated\_at** `timing.v1.Timestamp` *required*

Time the object was updated

```json CEL theme={null}
$result_object_key.timing.updated_at
```

```json Example theme={null}
"2022-07-01T00:01:00+00:00"
```

**locked\_at** `timing.v1.Timestamp`

Time the form response (Form Answer Group) was locked, if it was locked

```json CEL theme={null}
$result_object_key.locked_at
```

```json Example theme={null}
"2024-07-04T10:35:44+00:00"
```

**locked\_by\_id** `string`

ID of the User (Provider) who locked the form response (Form Answer Group), if it was locked

```json CEL theme={null}
$result_object_key.locked_by_id
```

```json Example theme={null}
"100070"
```

**locked\_by\_email** `string`

Email of the User (Provider) who locked the form response (Form Answer Group), if it was locked

```json CEL theme={null}
$result_object_key.locked_by_email
```

```json Example theme={null}
"drfleming@example.com"
```

**deleted\_at** `timing.v1.Timestamp`

Time the form response (Form Answer Group) was deleted, if it was deleted

```json CEL theme={null}
$result_object_key.deleted_at
```

```json Example theme={null}
"2024-07-04T10:35:45+00:00"
```

**form\_answers** `Map\<string,dynamic (any)\>` *required*

`HI` `PII` Question ID (Custom Module ID) to answer (Form Answer) map (dictionary)

```json CEL theme={null}
$result_object_key.form_answers
```

```json Example theme={null}
{
"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?"
}
}
```

**form\_answer\_group\_name** `string`

Name of the form for the (Form Answer Group), i.e. the Custom Module Form name

```json CEL theme={null}
$result_object_key.form_answer_group_name
```

```json Example theme={null}
"PHQ-8 Form"
```

**dietician\_organization\_id** `string`

Organization ID for the User's (Patient's) registered dietitian

```json CEL theme={null}
$result_object_key.dietician_organization_id
```

```json Example theme={null}
"123450"
```

**dietitian\_organization\_id** `string`

Organization ID for the User's (Patient's) registered dietitian

```json CEL theme={null}
$result_object_key.dietitian_organization_id
```

```json Example theme={null}
"123450"
```

**dietitian\_first\_name** `string`

First name of the User's (Patient's) registered dietitian

```json CEL theme={null}
$result_object_key.dietitian_first_name
```

```json Example theme={null}
"Alexander"
```

**dietitian\_last\_name** `string`

Last name of the User's (Patient's) registered dietitian

```json CEL theme={null}
$result_object_key.dietitian_last_name
```

```json Example theme={null}
"Fleming"
```

**dietitian\_email\_address** `string`

Email address of the User's (Patient's) registered dietitian

```json CEL theme={null}
$result_object_key.dietitian_email_address
```

```json Example theme={null}
"drfleming@example.com"
```

**dietitian\_id** `string`

ID of the User's (Patient's) registered dietitian

```json CEL theme={null}
$result_object_key.dietitian_id
```

```json Example theme={null}
"100070"
```

**signings** `[]object` *required*

`ID` Signings for this form response (Form Answer Group)

```json CEL theme={null}
$result_object_key.signings
```

```json Example theme={null}
[
{
"created_at": "2024-07-05T13:37:19+00:00",
"first_name": "Brian",
"id": "2401221",
"last_name": "Hippocrates",
"npi": "1000321231",
"qualifications": "MD",
"user_id": "2718281"
}
]
```

**signings.map(x, x.id)** `[]string` *required*

Mapped array of: ID for the form response (Form Answer Group) signing event

```json CEL theme={null}
$result_object_key.signings.map(x, x.id)
```

```json Example theme={null}
[
"2401221"
]
```

**signings.map(x, x.created\_at)** `[]timing.v1.Timestamp` *required*

Mapped array of: Time the form response (Form Answer Group) signing was performed

```json CEL theme={null}
$result_object_key.signings.map(x, x.created_at)
```

```json Example theme={null}
[
"2024-07-05T13:37:19+00:00"
]
```

**signings.map(x, x.user\_id)** `[]string` *required*

`ID` Mapped array of: ID of the User (Provider) who signed the form response (Form Answer Group)

```json CEL theme={null}
$result_object_key.signings.map(x, x.user_id)
```

```json Example theme={null}
[
"2718281"
]
```

**signings.map(x, x.npi)** `[]string` *required*

Mapped array of: The User (Provider) who signed the form response's NPI

```json CEL theme={null}
$result_object_key.signings.map(x, x.npi)
```

```json Example theme={null}
[
"1000321231"
]
```

**signings.map(x, x.qualifications)** `[]string` *required*

Mapped array of: Qualifications of the provider

```json CEL theme={null}
$result_object_key.signings.map(x, x.qualifications)
```

```json Example theme={null}
[
"MD"
]
```

**signings.map(x, x.first\_name)** `[]string` *required*

Mapped array of: First name of the provider

```json CEL theme={null}
$result_object_key.signings.map(x, x.first_name)
```

```json Example theme={null}
[
"Brian"
]
```

**signings.map(x, x.last\_name)** `[]string` *required*

Mapped array of: Last name of the provider

```json CEL theme={null}
$result_object_key.signings.map(x, x.last_name)
```

```json Example theme={null}
[
"Hippocrates"
]
```

**autoscored\_sections** `[]object` *required*

`HI` Auto-scored sections for this form response (Form Answer Group)

```json CEL theme={null}
$result_object_key.autoscored_sections
```

```json Example theme={null}
[
{
"section_key": "results",
"section_title": "Results",
"value": 42
}
]
```

**autoscored\_sections.map(x, x.section\_key)** `[]string` *required*

Mapped array of: Section key

```json CEL theme={null}
$result_object_key.autoscored_sections.map(x, x.section_key)
```

```json Example theme={null}
[
"results"
]
```

**autoscored\_sections.map(x, x.section\_title)** `[]string` *required*

Mapped array of: Section title

```json CEL theme={null}
$result_object_key.autoscored_sections.map(x, x.section_title)
```

```json Example theme={null}
[
"Results"
]
```

**autoscored\_sections.map(x, x.value)** `[]float64 (double)` *required*

`HI` Mapped array of: Value of the auto-scored section

```json CEL theme={null}
$result_object_key.autoscored_sections.map(x, x.value)
```

```json Example theme={null}
[
42
]
```

**use\_for\_charting** `bool` *required*

Is the form (Custom Module Form) for this form response (Form Answer Group) used for charting

```json CEL theme={null}
$result_object_key.use_for_charting
```

```json Example theme={null}
false
```

**ordered\_answers** `[]object` *required*

`HI` `PII` Ordered form answers in the order they are defined in the form (Custom Module Form)

```json CEL theme={null}
$result_object_key.ordered_answers
```

```json Example theme={null}
[
{
"answer": "Happy",
"created_at": "2024-07-04T09:39:18+00:00",
"custom_module_id": "90129",
"id": "672131",
"label": "How are you feeling today?",
"matrix_answers": [
{
  "cpt_code": "99215",
  "modifiers": "95",
  "units": "1"
},
{
  "cpt_code": "G2017",
  "units": "2"
}
],
"read_only": false
}
]
```

**ordered\_answers.map(x, x.id)** `[]string` *required*

Mapped array of: ID for the form response (Form Answer Group) individual question answer (Form Answer)

```json CEL theme={null}
$result_object_key.ordered_answers.map(x, x.id)
```

```json Example theme={null}
[
"672131"
]
```

**ordered\_answers.map(x, x.custom\_module\_id)** `[]string` *required*

Mapped array of: ID of the form question (Custom Module)

```json CEL theme={null}
$result_object_key.ordered_answers.map(x, x.custom_module_id)
```

```json Example theme={null}
[
"90129"
]
```

**ordered\_answers.map(x, x.answer)** `[]string` *required*

`HI` `PII` Mapped array of: Answer to the form question (Custom Module)

```json CEL theme={null}
$result_object_key.ordered_answers.map(x, x.answer)
```

```json Example theme={null}
[
"Happy"
]
```

**ordered\_answers.map(x, x.created\_at)** `[]timing.v1.Timestamp` *required*

Mapped array of: Time the form answer was registered

```json CEL theme={null}
$result_object_key.ordered_answers.map(x, x.created_at)
```

```json Example theme={null}
[
"2024-07-04T09:39:18+00:00"
]
```

**ordered\_answers.map(x, x.label)** `[]string` *required*

Mapped array of: Form question (Custom Module) text

```json CEL theme={null}
$result_object_key.ordered_answers.map(x, x.label)
```

```json Example theme={null}
[
"How are you feeling today?"
]
```

**ordered\_answers.map(x, x.read\_only)** `[]bool` *required*

Mapped array of: Is this Answer a read-only value (from the Custom Module)

```json CEL theme={null}
$result_object_key.ordered_answers.map(x, x.read_only)
```

```json Example theme={null}
[
false
]
```

**ordered\_answers.map(x, x.matrix\_answers)** `[]bool` *required*

Mapped array of: Matrix answers (a map of column name -> value effectively), only populated if the CustomModule type is "matrix"

```json CEL theme={null}
$result_object_key.ordered_answers.map(x, x.matrix_answers)
```

```json Example theme={null}
[
[
{
"cpt_code": "99215",
"modifiers": "95",
"units": "1"
},
{
"cpt_code": "G2017",
"units": "2"
}
]
]
```

**associated\_appointment\_id** `string`

ID of the Appointment associated with the Form Answer Group (optional)

```json CEL theme={null}
$result_object_key.associated_appointment_id
```

```json Example theme={null}
"597220"
```

**charting\_note\_addenda** `[]object` *required*

Any associated charting note addenda for this Form Answer Group

```json CEL theme={null}
$result_object_key.charting_note_addenda
```

```json Example theme={null}
[
{
"content": "Extra data for the charting note",
"created_at": "2025-11-04T11:31:16Z",
"id": "604888"
}
]
```

**charting\_note\_addenda.map(x, x.id)** `[]string` *required*

Mapped array of: Unique charting note addendum ID

```json CEL theme={null}
$result_object_key.charting_note_addenda.map(x, x.id)
```

```json Example theme={null}
[
"604888"
]
```

**charting\_note\_addenda.map(x, x.content)** `[]string` *required*

Mapped array of: Content string for the addendum

```json CEL theme={null}
$result_object_key.charting_note_addenda.map(x, x.content)
```

```json Example theme={null}
[
"Extra data for the charting note"
]
```

**charting\_note\_addenda.map(x, x.created\_at)** `[]timing.v1.Timestamp` *required*

Mapped array of: Timestamp for the creation of the addendum

```json CEL theme={null}
$result_object_key.charting_note_addenda.map(x, x.created_at)
```

```json Example theme={null}
[
"2025-11-04T11:31:16Z"
]
```


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.