{
  "$result_object_key": [
    {
      "custom_module_form_id": "72028",
      "custom_module_form_name": "Intake Questionnaire",
      "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",
      "id": "57211",
      "patient_id": "121250"
    }
  ]
}

{
  "$result_object_key": [
    {
      "custom_module_form_id": "RequestedFormCompletion's custom module form ID",
      "custom_module_form_name": "RequestedFormCompletion's custom module form name",
      "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",
      "id": "RequestedFormCompletion object ID",
      "patient_id": "Patient's ID"
    }
  ]
}

{
  "$result_object_key": [
    {
      "custom_module_form_id": "72028",
      "custom_module_form_name": "Intake Questionnaire",
      "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",
      "id": "57211",
      "patient_id": "121250"
    }
  ]
}

{
  "$result_object_key": [
    {
      "custom_module_form_id": "RequestedFormCompletion's custom module form ID",
      "custom_module_form_name": "RequestedFormCompletion's custom module form name",
      "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",
      "id": "RequestedFormCompletion object ID",
      "patient_id": "Patient's ID"
    }
  ]
}

title: “List Requested Form Completion” description: “Documentation for the List Requested Form Completion action for Healthie” sidebarTitle: “List Requested Form Completion”

Parameters

Hide parameters

string

This field maps to the destination API keywords field.Optional search text passed to Healthie to narrow the requests returned.

string

This field maps to the destination API status field.Set to Open to return only requests the patient hasn’t completed yet. Completed requests drop out of the list, so an empty result means nothing is outstanding.

Checking whether a patient has completed a form

The result doesn’t include a status field. To check completion, filter the request with Status set to Open and look for the form in the result:

Form still outstanding

open_requests.exists(r, r.custom_module_form_id == "1252974")

Form completed (or never requested)

!open_requests.exists(r, r.custom_module_form_id == "1252974")

Replace open_requests with this node’s result object key and 1252974 with the Healthie form ID. A form that was never requested also has no open request, so the second check can’t tell “completed” from “never sent”; make sure the form is requested (for example, automatically when the appointment is booked) before relying on it.

{
  "$result_object_key": [
    {
      "custom_module_form_id": "72028",
      "custom_module_form_name": "Intake Questionnaire",
      "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",
      "id": "57211",
      "patient_id": "121250"
    }
  ]
}

{
  "$result_object_key": [
    {
      "custom_module_form_id": "RequestedFormCompletion's custom module form ID",
      "custom_module_form_name": "RequestedFormCompletion's custom module form name",
      "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",
      "id": "RequestedFormCompletion object ID",
      "patient_id": "Patient's ID"
    }
  ]
}

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 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.

Fetch Action Response Object

Hide fields

string

required

RequestedFormCompletion object ID

CEL

$result_object_key[*].id

Example

"57211"

string

required

ID Patient’s ID

CEL

$result_object_key[*].patient_id

Example

"121250"

string

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

CEL

$result_object_key[*].dietician_organization_id

Example

"123450"

string

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

CEL

$result_object_key[*].dietitian_organization_id

Example

"123450"

string

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

CEL

$result_object_key[*].dietitian_first_name

Example

"Alexander"

string

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

CEL

$result_object_key[*].dietitian_last_name

Example

"Fleming"

string

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

CEL

$result_object_key[*].dietitian_email_address

Example

"drfleming@example.com"

string

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

CEL

$result_object_key[*].dietitian_id

Example

"100070"

string

RequestedFormCompletion’s custom module form ID

CEL

$result_object_key[*].custom_module_form_id

Example

"72028"

string

RequestedFormCompletion’s custom module form name

CEL

$result_object_key[*].custom_module_form_name

Example

"Intake Questionnaire"

Events

Actions

List requested form completion

title: “List Requested Form Completion” description: “Documentation for the List Requested Form Completion action for Healthie” sidebarTitle: “List Requested Form Completion”

Parameters

Checking whether a patient has completed a form

Result Object Field Details

​title: “List Requested Form Completion” description: “Documentation for the List Requested Form Completion action for Healthie” sidebarTitle: “List Requested Form Completion”

​Parameters

​Checking whether a patient has completed a form

​Result Object Field Details

title: “List Requested Form Completion” description: “Documentation for the List Requested Form Completion action for Healthie” sidebarTitle: “List Requested Form Completion”

Parameters

Checking whether a patient has completed a form

Result Object Field Details