Parameters

Action

Parameters

Hide parameters

string

required

This field maps to the destination API id field.

{
  "$result_object_key": {
    "associated_appointment_id": "597220",
    "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?",
        "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"
  }
}

{
  "$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"
    },
    "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 a result object key to be specified which will nest the action’s result data inside the downstream data context in the Workflow. Here we demonstrate how to refer to this data using the prefix $result_object_key.

FormAnswerGroup

Fetch Action Response Object

Hide fields

form_answer_group_id

string

required

ID of the form response (Form Answer Group)

CEL

$result_object_key.form_answer_group_id

Example

"4231415"

user_id

string

required

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

CEL

$result_object_key.user_id

Example

"2718281"

custom_module_form_id

string

required

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

CEL

$result_object_key.custom_module_form_id

Example

"1380649"

filler_id

string

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

CEL

$result_object_key.filler_id

Example

"2718281"

filler_is_patient

bool

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

CEL

$result_object_key.filler_is_patient

Example

true

filler_email

string

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

CEL

$result_object_key.filler_email

Example

"patient0@example.com"

finished

bool

required

Is the form response (Form Answer Group) completed

CEL

$result_object_key.finished

Example

true

timing

object

required

Create and update times

CEL

$result_object_key.timing

Example

{
"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

CEL

$result_object_key.timing.created_at

Example

"2022-07-01T00:01:00+00:00"

timing.updated_at

timing.v1.Timestamp

required

Time the object was updated

CEL

$result_object_key.timing.updated_at

Example

"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

CEL

$result_object_key.locked_at

Example

"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

CEL

$result_object_key.locked_by_id

Example

"100070"

locked_by_email

string

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

CEL

$result_object_key.locked_by_email

Example

"drfleming@example.com"

deleted_at

timing.v1.Timestamp

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

CEL

$result_object_key.deleted_at

Example

"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)

CEL

$result_object_key.form_answers

Example

{
"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

CEL

$result_object_key.form_answer_group_name

Example

"PHQ-8 Form"

dietician_organization_id

string

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

CEL

$result_object_key.dietician_organization_id

Example

"123450"

dietitian_organization_id

string

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

CEL

$result_object_key.dietitian_organization_id

Example

"123450"

dietitian_first_name

string

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

CEL

$result_object_key.dietitian_first_name

Example

"Alexander"

dietitian_last_name

string

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

CEL

$result_object_key.dietitian_last_name

Example

"Fleming"

dietitian_email_address

string

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

CEL

$result_object_key.dietitian_email_address

Example

"drfleming@example.com"

dietitian_id

string

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

CEL

$result_object_key.dietitian_id

Example

"100070"

signings

object

required

ID Signings for this form response (Form Answer Group)

CEL

$result_object_key.signings

Example

[
{
"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

CEL

$result_object_key.signings.map(x, x.id)

Example

[
"2401221"
]

signings.map(x, x.created_at)

[]timing.v1.Timestamp

required

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

CEL

$result_object_key.signings.map(x, x.created_at)

Example

[
"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)

CEL

$result_object_key.signings.map(x, x.user_id)

Example

[
"2718281"
]

signings.map(x, x.npi)

[]string

required

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

CEL

$result_object_key.signings.map(x, x.npi)

Example

[
"1000321231"
]

signings.map(x, x.qualifications)

[]string

required

Mapped array of: Qualifications of the provider

CEL

$result_object_key.signings.map(x, x.qualifications)

Example

[
"MD"
]

signings.map(x, x.first_name)

[]string

required

Mapped array of: First name of the provider

CEL

$result_object_key.signings.map(x, x.first_name)

Example

[
"Brian"
]

signings.map(x, x.last_name)

[]string

required

Mapped array of: Last name of the provider

CEL

$result_object_key.signings.map(x, x.last_name)

Example

[
"Hippocrates"
]

autoscored_sections

object

required

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

CEL

$result_object_key.autoscored_sections

Example

[
{
"section_key": "results",
"section_title": "Results",
"value": 42
}
]

autoscored_sections.map(x, x.section_key)

[]string

required

Mapped array of: Section key

CEL

$result_object_key.autoscored_sections.map(x, x.section_key)

Example

[
"results"
]

autoscored_sections.map(x, x.section_title)

[]string

required

Mapped array of: Section title

CEL

$result_object_key.autoscored_sections.map(x, x.section_title)

Example

[
"Results"
]

autoscored_sections.map(x, x.value)

[]float64 (double)

required

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

CEL

$result_object_key.autoscored_sections.map(x, x.value)

Example

[
42
]

use_for_charting

bool

required

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

CEL

$result_object_key.use_for_charting

Example

false

ordered_answers

object

required

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

CEL

$result_object_key.ordered_answers

Example

[
{
"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)

CEL

$result_object_key.ordered_answers.map(x, x.id)

Example

[
"672131"
]

ordered_answers.map(x, x.custom_module_id)

[]string

required

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

CEL

$result_object_key.ordered_answers.map(x, x.custom_module_id)

Example

[
"90129"
]

ordered_answers.map(x, x.answer)

[]string

required

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

CEL

$result_object_key.ordered_answers.map(x, x.answer)

Example

[
"Happy"
]

ordered_answers.map(x, x.created_at)

[]timing.v1.Timestamp

required

Mapped array of: Time the form answer was registered

CEL

$result_object_key.ordered_answers.map(x, x.created_at)

Example

[
"2024-07-04T09:39:18+00:00"
]

ordered_answers.map(x, x.label)

[]string

required

Mapped array of: Form question (Custom Module) text

CEL

$result_object_key.ordered_answers.map(x, x.label)

Example

[
"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)

CEL

$result_object_key.ordered_answers.map(x, x.read_only)

Example

[
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”

CEL

$result_object_key.ordered_answers.map(x, x.matrix_answers)

Example

[
[
{
"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)

CEL

$result_object_key.associated_appointment_id

Example

"597220"

Events

Actions

Integrations

Get Form Answer Group

Parameters

Result Object Field Details

Events

Actions

Integrations

​Parameters

​Result Object Field Details

Parameters

Result Object Field Details