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

Custom Module Form ID

string (Custom Module Form)

required

ID This field maps to the destination API id field.

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

string

required

Unique identifier for the onboarding flow

CEL

$result_object_key.id

Example

"567890"

name

string

Name of the onboarding flow

CEL

$result_object_key.name

Example

"New Patient Onboarding"

organization_has_multiple_providers

bool

required

Indicates if the organization has multiple providers

CEL

$result_object_key.organization_has_multiple_providers

Example

true

has_forms_after_welcome

bool

required

Indicates if there are forms to complete after the welcome screen

CEL

$result_object_key.has_forms_after_welcome

Example

true

onboarding_items

object

required

List of onboarding items in this flow

CEL

$result_object_key.onboarding_items

Example

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

onboarding_items.map(x, x.id)

[]string

required

Mapped array of: Unique identifier for the onboarding item

CEL

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

Example

[
"456789"
]

onboarding_items.map(x, x.item_id)

[]string

required

Mapped array of: Secondary identifier for the onboarding item

CEL

$result_object_key.onboarding_items.map(x, x.item_id)

Example

[
"345678"
]

onboarding_items.map(x, x.display_name)

[]string

required

Mapped array of: Display name of the onboarding item

CEL

$result_object_key.onboarding_items.map(x, x.display_name)

Example

[
"Complete Initial Assessment"
]

onboarding_items.map(x, x.incomplete_custom_module_form_id)

[]string

required

Mapped array of: ID of the custom module form that needs to be completed

CEL

$result_object_key.onboarding_items.map(x, x.incomplete_custom_module_form_id)

Example

[
"234567"
]

onboarding_items.map(x, x.is_last_item)

[]bool

required

Mapped array of: Indicates if this is the last item in the onboarding flow

CEL

$result_object_key.onboarding_items.map(x, x.is_last_item)

Example

[
false
]

onboarding_items.map(x, x.completed_onboarding_item)

[]bool

required

Mapped array of: Information about the completion status of this item

CEL

$result_object_key.onboarding_items.map(x, x.completed_onboarding_item)

Example

[
{
"id":  "123456",
"item_id":  "789012"
}
]

onboarding_items.map(x, x.completed_onboarding_item)

[]string

required

Mapped array of: Information about the completion status of this item

CEL

$result_object_key.onboarding_items.map(x, x.completed_onboarding_item)

Example

[
{
"id":  "123456",
"item_id":  "789012"
}
]

onboarding_items.map(x, x.completed_onboarding_item)

[]string

required

Mapped array of: Information about the completion status of this item

CEL

$result_object_key.onboarding_items.map(x, x.completed_onboarding_item)

Example

[
{
"id":  "123456",
"item_id":  "789012"
}
]

Get Appointment Get User

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

Events

Actions

Integrations

Get Onboarding Flow

Parameters

Result Object Field Details

Events

Actions

Integrations

​Parameters

​Result Object Field Details

Parameters

Result Object Field Details