{
  "$result_object_key": [
    {
      "appointments": [
        {
          "appointment_datetime": "2024-08-17T10:30:00-04:00",
          "appointment_id": "604821",
          "created_at": "2024-08-15T10:31:01-04:00",
          "provider_id": "224404",
          "provider_name": "Dr. John Doe",
          "updated_at": "2024-08-15T10:31:01-04:00"
        }
      ],
      "date_of_birth": "1950-08-04",
      "email_address": "john.doe@example.com",
      "first_name": "John",
      "id": "131391",
      "last_name": "Doe",
      "record_identifier": "8e11f3ba-3167-4f47-a549-f43dc19df353"
    }
  ]
}

{
  "$result_object_key": [
    {
      "appointments": {
        "appointment_datetime": "Date and time of the Appointment",
        "appointment_id": "ID for the Appointment",
        "created_at": "Time the appointment was created",
        "provider_id": "ID of the Provider on the Appointment",
        "provider_name": "Name of the Provider on the Appointment",
        "updated_at": "Time the appointment was last updated"
      },
      "date_of_birth": "Date of birth of the User",
      "email_address": "Email address of the User",
      "first_name": "First name of the User",
      "id": "ID for the User",
      "last_name": "Last name of the User",
      "record_identifier": "Record identifier for the User (external unique patient ID reference)"
    }
  ]
}

Parameters

Action

Parameters

Hide parameters

Keywords

string

required

This field maps to the destination API keywords field.

Active Status

string

This field maps to the destination API active_status field.

Order By

string

This field maps to the destination API order_by field.

{
  "$result_object_key": [
    {
      "appointments": [
        {
          "appointment_datetime": "2024-08-17T10:30:00-04:00",
          "appointment_id": "604821",
          "created_at": "2024-08-15T10:31:01-04:00",
          "provider_id": "224404",
          "provider_name": "Dr. John Doe",
          "updated_at": "2024-08-15T10:31:01-04:00"
        }
      ],
      "date_of_birth": "1950-08-04",
      "email_address": "john.doe@example.com",
      "first_name": "John",
      "id": "131391",
      "last_name": "Doe",
      "record_identifier": "8e11f3ba-3167-4f47-a549-f43dc19df353"
    }
  ]
}

{
  "$result_object_key": [
    {
      "appointments": {
        "appointment_datetime": "Date and time of the Appointment",
        "appointment_id": "ID for the Appointment",
        "created_at": "Time the appointment was created",
        "provider_id": "ID of the Provider on the Appointment",
        "provider_name": "Name of the Provider on the Appointment",
        "updated_at": "Time the appointment was last updated"
      },
      "date_of_birth": "Date of birth of the User",
      "email_address": "Email address of the User",
      "first_name": "First name of the User",
      "id": "ID for the User",
      "last_name": "Last name of the User",
      "record_identifier": "Record identifier for the User (external unique patient ID reference)"
    }
  ]
}

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.

[]UserSummary

Fetch Action Response Object

Hide fields

string

required

ID ID for the User

CEL

$result_object_key[*].id

Example

"131391"

first_name

string

PII First name of the User

CEL

$result_object_key[*].first_name

Example

"John"

last_name

string

PII Last name of the User

CEL

$result_object_key[*].last_name

Example

"Doe"

email_address

string

PII Email address of the User

CEL

$result_object_key[*].email_address

Example

"john.doe@example.com"

record_identifier

string

ID Record identifier for the User (external unique patient ID reference)

CEL

$result_object_key[*].record_identifier

Example

"8e11f3ba-3167-4f47-a549-f43dc19df353"

date_of_birth

values.v1.Date

PII Date of birth of the User

CEL

$result_object_key[*].date_of_birth

Example

"1950-08-04"

appointments

object

required

List of appointments for the User

CEL

$result_object_key[*].appointments

Example

[
{
"appointment_datetime": "2024-08-17T10:30:00-04:00",
"appointment_id": "604821",
"created_at": "2024-08-15T10:31:01-04:00",
"provider_id": "224404",
"provider_name": "Dr. John Doe",
"updated_at": "2024-08-15T10:31:01-04:00"
}
]

appointments.map(x, x.appointment_id)

[]string

required

Mapped array of: ID for the Appointment

CEL

$result_object_key[*].appointments.map(x, x.appointment_id)

Example

[
"604821"
]

appointments.map(x, x.appointment_datetime)

[]timing.v1.Timestamp

required

Mapped array of: Date and time of the Appointment

CEL

$result_object_key[*].appointments.map(x, x.appointment_datetime)

Example

[
"2024-08-17T10:30:00-04:00"
]

appointments.map(x, x.provider_id)

[]string

required

Mapped array of: ID of the Provider on the Appointment

CEL

$result_object_key[*].appointments.map(x, x.provider_id)

Example

[
"224404"
]

appointments.map(x, x.provider_name)

[]string

required

Mapped array of: Name of the Provider on the Appointment

CEL

$result_object_key[*].appointments.map(x, x.provider_name)

Example

[
"Dr. John Doe"
]

appointments.map(x, x.created_at)

[]timing.v1.Timestamp

required

Mapped array of: Time the appointment was created

CEL

$result_object_key[*].appointments.map(x, x.created_at)

Example

[
"2024-08-15T10:31:01-04:00"
]

appointments.map(x, x.updated_at)

[]timing.v1.Timestamp

required

Mapped array of: Time the appointment was last updated

CEL

$result_object_key[*].appointments.map(x, x.updated_at)

Example

[
"2024-08-15T10:31:01-04:00"
]

{
  "$result_object_key": [
    {
      "appointments": [
        {
          "appointment_datetime": "2024-08-17T10:30:00-04:00",
          "appointment_id": "604821",
          "created_at": "2024-08-15T10:31:01-04:00",
          "provider_id": "224404",
          "provider_name": "Dr. John Doe",
          "updated_at": "2024-08-15T10:31:01-04:00"
        }
      ],
      "date_of_birth": "1950-08-04",
      "email_address": "john.doe@example.com",
      "first_name": "John",
      "id": "131391",
      "last_name": "Doe",
      "record_identifier": "8e11f3ba-3167-4f47-a549-f43dc19df353"
    }
  ]
}

{
  "$result_object_key": [
    {
      "appointments": {
        "appointment_datetime": "Date and time of the Appointment",
        "appointment_id": "ID for the Appointment",
        "created_at": "Time the appointment was created",
        "provider_id": "ID of the Provider on the Appointment",
        "provider_name": "Name of the Provider on the Appointment",
        "updated_at": "Time the appointment was last updated"
      },
      "date_of_birth": "Date of birth of the User",
      "email_address": "Email address of the User",
      "first_name": "First name of the User",
      "id": "ID for the User",
      "last_name": "Last name of the User",
      "record_identifier": "Record identifier for the User (external unique patient ID reference)"
    }
  ]
}

{
  "$result_object_key": [
    {
      "appointments": [
        {
          "appointment_datetime": "2024-08-17T10:30:00-04:00",
          "appointment_id": "604821",
          "created_at": "2024-08-15T10:31:01-04:00",
          "provider_id": "224404",
          "provider_name": "Dr. John Doe",
          "updated_at": "2024-08-15T10:31:01-04:00"
        }
      ],
      "date_of_birth": "1950-08-04",
      "email_address": "john.doe@example.com",
      "first_name": "John",
      "id": "131391",
      "last_name": "Doe",
      "record_identifier": "8e11f3ba-3167-4f47-a549-f43dc19df353"
    }
  ]
}

{
  "$result_object_key": [
    {
      "appointments": {
        "appointment_datetime": "Date and time of the Appointment",
        "appointment_id": "ID for the Appointment",
        "created_at": "Time the appointment was created",
        "provider_id": "ID of the Provider on the Appointment",
        "provider_name": "Name of the Provider on the Appointment",
        "updated_at": "Time the appointment was last updated"
      },
      "date_of_birth": "Date of birth of the User",
      "email_address": "Email address of the User",
      "first_name": "First name of the User",
      "id": "ID for the User",
      "last_name": "Last name of the User",
      "record_identifier": "Record identifier for the User (external unique patient ID reference)"
    }
  ]
}

Parameters

Action

Parameters

Hide parameters

Keywords

string

required

This field maps to the destination API keywords field.

Active Status

string

This field maps to the destination API active_status field.

Order By

string

This field maps to the destination API order_by field.

{
  "$result_object_key": [
    {
      "appointments": [
        {
          "appointment_datetime": "2024-08-17T10:30:00-04:00",
          "appointment_id": "604821",
          "created_at": "2024-08-15T10:31:01-04:00",
          "provider_id": "224404",
          "provider_name": "Dr. John Doe",
          "updated_at": "2024-08-15T10:31:01-04:00"
        }
      ],
      "date_of_birth": "1950-08-04",
      "email_address": "john.doe@example.com",
      "first_name": "John",
      "id": "131391",
      "last_name": "Doe",
      "record_identifier": "8e11f3ba-3167-4f47-a549-f43dc19df353"
    }
  ]
}

{
  "$result_object_key": [
    {
      "appointments": {
        "appointment_datetime": "Date and time of the Appointment",
        "appointment_id": "ID for the Appointment",
        "created_at": "Time the appointment was created",
        "provider_id": "ID of the Provider on the Appointment",
        "provider_name": "Name of the Provider on the Appointment",
        "updated_at": "Time the appointment was last updated"
      },
      "date_of_birth": "Date of birth of the User",
      "email_address": "Email address of the User",
      "first_name": "First name of the User",
      "id": "ID for the User",
      "last_name": "Last name of the User",
      "record_identifier": "Record identifier for the User (external unique patient ID reference)"
    }
  ]
}

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.

[]UserSummary

Fetch Action Response Object

Hide fields

string

required

ID ID for the User

CEL

$result_object_key[*].id

Example

"131391"

first_name

string

PII First name of the User

CEL

$result_object_key[*].first_name

Example

"John"

last_name

string

PII Last name of the User

CEL

$result_object_key[*].last_name

Example

"Doe"

email_address

string

PII Email address of the User

CEL

$result_object_key[*].email_address

Example

"john.doe@example.com"

record_identifier

string

ID Record identifier for the User (external unique patient ID reference)

CEL

$result_object_key[*].record_identifier

Example

"8e11f3ba-3167-4f47-a549-f43dc19df353"

date_of_birth

values.v1.Date

PII Date of birth of the User

CEL

$result_object_key[*].date_of_birth

Example

"1950-08-04"

appointments

object

required

List of appointments for the User

CEL

$result_object_key[*].appointments

Example

[
{
"appointment_datetime": "2024-08-17T10:30:00-04:00",
"appointment_id": "604821",
"created_at": "2024-08-15T10:31:01-04:00",
"provider_id": "224404",
"provider_name": "Dr. John Doe",
"updated_at": "2024-08-15T10:31:01-04:00"
}
]

appointments.map(x, x.appointment_id)

[]string

required

Mapped array of: ID for the Appointment

CEL

$result_object_key[*].appointments.map(x, x.appointment_id)

Example

[
"604821"
]

appointments.map(x, x.appointment_datetime)

[]timing.v1.Timestamp

required

Mapped array of: Date and time of the Appointment

CEL

$result_object_key[*].appointments.map(x, x.appointment_datetime)

Example

[
"2024-08-17T10:30:00-04:00"
]

appointments.map(x, x.provider_id)

[]string

required

Mapped array of: ID of the Provider on the Appointment

CEL

$result_object_key[*].appointments.map(x, x.provider_id)

Example

[
"224404"
]

appointments.map(x, x.provider_name)

[]string

required

Mapped array of: Name of the Provider on the Appointment

CEL

$result_object_key[*].appointments.map(x, x.provider_name)

Example

[
"Dr. John Doe"
]

appointments.map(x, x.created_at)

[]timing.v1.Timestamp

required

Mapped array of: Time the appointment was created

CEL

$result_object_key[*].appointments.map(x, x.created_at)

Example

[
"2024-08-15T10:31:01-04:00"
]

appointments.map(x, x.updated_at)

[]timing.v1.Timestamp

required

Mapped array of: Time the appointment was last updated

CEL

$result_object_key[*].appointments.map(x, x.updated_at)

Example

[
"2024-08-15T10:31:01-04:00"
]

{
  "$result_object_key": [
    {
      "appointments": [
        {
          "appointment_datetime": "2024-08-17T10:30:00-04:00",
          "appointment_id": "604821",
          "created_at": "2024-08-15T10:31:01-04:00",
          "provider_id": "224404",
          "provider_name": "Dr. John Doe",
          "updated_at": "2024-08-15T10:31:01-04:00"
        }
      ],
      "date_of_birth": "1950-08-04",
      "email_address": "john.doe@example.com",
      "first_name": "John",
      "id": "131391",
      "last_name": "Doe",
      "record_identifier": "8e11f3ba-3167-4f47-a549-f43dc19df353"
    }
  ]
}

{
  "$result_object_key": [
    {
      "appointments": {
        "appointment_datetime": "Date and time of the Appointment",
        "appointment_id": "ID for the Appointment",
        "created_at": "Time the appointment was created",
        "provider_id": "ID of the Provider on the Appointment",
        "provider_name": "Name of the Provider on the Appointment",
        "updated_at": "Time the appointment was last updated"
      },
      "date_of_birth": "Date of birth of the User",
      "email_address": "Email address of the User",
      "first_name": "First name of the User",
      "id": "ID for the User",
      "last_name": "Last name of the User",
      "record_identifier": "Record identifier for the User (external unique patient ID reference)"
    }
  ]
}

Search Users

Parameters

Result Object Field Details

Search Users

Parameters

Result Object Field Details

​Parameters

​Result Object Field Details

​Parameters

​Result Object Field Details

Parameters

Result Object Field Details

Parameters

Result Object Field Details