{
  "$result_object_key": {
    "has_forms_after_welcome": true,
    "id": "567890",
    "name": "New Patient Onboarding",
    "onboarding_items": [
      {
        "completed_onboarding_item": {
          "id": "123456",
          "item_id": "789012"
        },
        "display_name": "Complete Initial Assessment",
        "id": "456789",
        "incomplete_custom_module_form_id": "234567",
        "is_last_item": false,
        "item_id": "345678"
      }
    ],
    "organization_has_multiple_providers": true
  }
}

{
  "$result_object_key": {
    "has_forms_after_welcome": "Indicates if there are forms to complete after the welcome screen",
    "id": "Unique identifier for the onboarding flow",
    "name": "Name of the onboarding flow",
    "onboarding_items": {
      "completed_onboarding_item": {
        "id": "Unique identifier for the completed onboarding item",
        "item_id": "ID of the associated onboarding item"
      },
      "display_name": "Display name of the onboarding item",
      "id": "Unique identifier for the onboarding item",
      "incomplete_custom_module_form_id": "ID of the custom module form that needs to be completed",
      "is_last_item": "Indicates if this is the last item in the onboarding flow",
      "item_id": "Secondary identifier for the onboarding item"
    },
    "organization_has_multiple_providers": "Indicates if the organization has multiple providers"
  }
}

​
Parameters

​
Action
Parameters
{
  "$result_object_key": {
    "has_forms_after_welcome": true,
    "id": "567890",
    "name": "New Patient Onboarding",
    "onboarding_items": [
      {
        "completed_onboarding_item": {
          "id": "123456",
          "item_id": "789012"
        },
        "display_name": "Complete Initial Assessment",
        "id": "456789",
        "incomplete_custom_module_form_id": "234567",
        "is_last_item": false,
        "item_id": "345678"
      }
    ],
    "organization_has_multiple_providers": true
  }
}

{
  "$result_object_key": {
    "has_forms_after_welcome": "Indicates if there are forms to complete after the welcome screen",
    "id": "Unique identifier for the onboarding flow",
    "name": "Name of the onboarding flow",
    "onboarding_items": {
      "completed_onboarding_item": {
        "id": "Unique identifier for the completed onboarding item",
        "item_id": "ID of the associated onboarding item"
      },
      "display_name": "Display name of the onboarding item",
      "id": "Unique identifier for the onboarding item",
      "incomplete_custom_module_form_id": "ID of the custom module form that needs to be completed",
      "is_last_item": "Indicates if this is the last item in the onboarding flow",
      "item_id": "Secondary identifier for the onboarding item"
    },
    "organization_has_multiple_providers": "Indicates if the organization has multiple providers"
  }
}

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

​
OnboardingFlow
Fetch Action Response Object