Parameters

Action

Parameters

Hide parameters

string

required

ID This field maps to the destination API intake-id field.

{
  "$result_object_key": {
    "appointment_id": "12342",
    "client_email": "john.smith@example.com",
    "client_id": 42,
    "client_name": "John Smith",
    "consent_forms": [
      {
        "document_type": "HIPAA",
        "id": "12342",
        "name": "HIPAA Consent",
        "signed": true,
        "submitted_at": "2024-01-23T10:30:00Z"
      }
    ],
    "created_at": "2024-01-23T10:00:00Z",
    "external_client_id": "a7699305-7142-4599-a661-717b6bcd3305",
    "id": "12342",
    "practitioner": "acbdefg",
    "practitioner_name": "Dr. Marie Curie",
    "questionnaire_name": "Initial Intake Form",
    "questions": [
      {
        "answer": "Back pain",
        "attachments": [
          {
            "content_type": "application/pdf",
            "file_name": "medical_report.pdf",
            "id": "12342",
            "url": "https://example.com/attachment.pdf"
          }
        ],
        "client_profile_field_id": "primary_concern",
        "column_names": [
          "Symptom",
          "Severity"
        ],
        "id": "12342",
        "office_note": "Patient reported severe pain",
        "office_use": false,
        "question_type": "text",
        "rows": [
          {
            "answers": [
              "Back pain",
              "Severe"
            ],
            "text": "Back pain"
          }
        ],
        "text": "What is your primary concern?"
      }
    ],
    "status": "Submitted",
    "submitted_at": "2024-01-23T10:30:00Z"
  }
}

{
  "$result_object_key": {
    "appointment_id": "ID of the associated appointment",
    "client_email": "Email address of the client",
    "client_id": "IntakeQ's unique identifier for the client",
    "client_name": "Full name of the client",
    "consent_forms": {
      "document_type": "Type of the consent document",
      "id": "Unique identifier for the consent form",
      "name": "Name of the consent form",
      "signed": "Whether the consent form has been signed",
      "submitted_at": "Time the consent form was submitted"
    },
    "created_at": "Time the intake form was created",
    "external_client_id": "External system client ID",
    "id": "Unique identifier for the intake form",
    "practitioner": "ID of the practitioner",
    "practitioner_name": "Name of the practitioner",
    "questionnaire_name": "Name of the questionnaire",
    "questions": {
      "answer": "Answer to the question",
      "attachments": {
        "content_type": "Content type of the attachment",
        "file_name": "Name of the attached file",
        "id": "Unique identifier for the attachment",
        "url": "URL of the attachment"
      },
      "client_profile_field_id": "ID of the client profile field this question maps to",
      "column_names": "Column names for table/grid questions",
      "id": "Unique identifier for the question",
      "office_note": "Office note for the question",
      "office_use": "Whether the question is for office use only",
      "question_type": "Type of the question",
      "rows": {
        "answers": "Answers for each column in the row",
        "text": "Text for the row"
      },
      "text": "Text of the question"
    },
    "status": "Status of the intake form",
    "submitted_at": "Time the intake form was submitted"
  }
}

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.

IntakeForm

Fetch Action Response Object

Hide fields

string

required

Unique identifier for the intake form

CEL

$result_object_key.id

Example

"12342"

client_name

string

PII Full name of the client

CEL

$result_object_key.client_name

Example

"John Smith"

client_email

string

PII Email address of the client

CEL

$result_object_key.client_email

Example

"john.smith@example.com"

client_id

int64

required

ID IntakeQ’s unique identifier for the client

CEL

$result_object_key.client_id

Example

status

string

required

Status of the intake form

CEL

$result_object_key.status

Example

"Submitted"

created_at

timing.v1.Timestamp

required

Time the intake form was created

CEL

$result_object_key.created_at

Example

"2024-01-23T10:00:00Z"

submitted_at

timing.v1.Timestamp

required

Time the intake form was submitted

CEL

$result_object_key.submitted_at

Example

"2024-01-23T10:30:00Z"

questionnaire_name

string

required

Name of the questionnaire

CEL

$result_object_key.questionnaire_name

Example

"Initial Intake Form"

practitioner

string

ID of the practitioner

CEL

$result_object_key.practitioner

Example

"acbdefg"

practitioner_name

string

Name of the practitioner

CEL

$result_object_key.practitioner_name

Example

"Dr. Marie Curie"

questions

[]object

required

HI Questions and answers in the intake form

CEL

$result_object_key.questions

Example

[
{
"answer": "Back pain",
"attachments": [
{
  "content_type": "application/pdf",
  "file_name": "medical_report.pdf",
  "id": "12342",
  "url": "https://example.com/attachment.pdf"
}
],
"client_profile_field_id": "primary_concern",
"column_names": [
"Symptom",
"Severity"
],
"id": "12342",
"office_note": "Patient reported severe pain",
"office_use": false,
"question_type": "text",
"rows": [
{
  "answers": [
    "Back pain",
    "Severe"
  ],
  "text": "Back pain"
}
],
"text": "What is your primary concern?"
}
]

questions.map(x, x.id)

[]string

required

Mapped array of: Unique identifier for the question

CEL

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

Example

[
"12342"
]

questions.map(x, x.text)

[]string

required

Mapped array of: Text of the question

CEL

$result_object_key.questions.map(x, x.text)

Example

[
"What is your primary concern?"
]

questions.map(x, x.answer)

[]string

required

HI Mapped array of: Answer to the question

CEL

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

Example

[
"Back pain"
]

questions.map(x, x.question_type)

[]string

required

Mapped array of: Type of the question

CEL

$result_object_key.questions.map(x, x.question_type)

Example

[
"text"
]

questions.map(x, x.rows)

[]bool

required

HI Mapped array of: Rows for table/grid questions

CEL

$result_object_key.questions.map(x, x.rows)

Example

[
[
{
"answers": [
  "Back pain",
  "Severe"
],
"text": "Back pain"
}
]
]

questions.map(x, x.column_names)

[]bool

required

Mapped array of: Column names for table/grid questions

CEL

$result_object_key.questions.map(x, x.column_names)

Example

[
[
"Symptom",
"Severity"
]
]

questions.map(x, x.office_use)

[]bool

required

Mapped array of: Whether the question is for office use only

CEL

$result_object_key.questions.map(x, x.office_use)

Example

[
false
]

questions.map(x, x.office_note)

[]string

required

Mapped array of: Office note for the question

CEL

$result_object_key.questions.map(x, x.office_note)

Example

[
"Patient reported severe pain"
]

questions.map(x, x.client_profile_field_id)

[]string

required

Mapped array of: ID of the client profile field this question maps to

CEL

$result_object_key.questions.map(x, x.client_profile_field_id)

Example

[
"primary_concern"
]

questions.map(x, x.attachments)

[]bool

required

HI Mapped array of: Attachments associated with the question

CEL

$result_object_key.questions.map(x, x.attachments)

Example

[
[
{
"content_type": "application/pdf",
"file_name": "medical_report.pdf",
"id": "12342",
"url": "https://example.com/attachment.pdf"
}
]
]

appointment_id

string

ID of the associated appointment

CEL

$result_object_key.appointment_id

Example

"12342"

external_client_id

string

ID External system client ID

CEL

$result_object_key.external_client_id

Example

"a7699305-7142-4599-a661-717b6bcd3305"

HI Consent forms associated with the intake form

CEL

$result_object_key.consent_forms

Example

[
{
"document_type": "HIPAA",
"id": "12342",
"name": "HIPAA Consent",
"signed": true,
"submitted_at": "2024-01-23T10:30:00Z"
}
]

Mapped array of: Unique identifier for the consent form

CEL

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

Example

[
"12342"
]

Mapped array of: Name of the consent form

CEL

$result_object_key.consent_forms.map(x, x.name)

Example

[
"HIPAA Consent"
]

Mapped array of: Type of the consent document

CEL

$result_object_key.consent_forms.map(x, x.document_type)

Example

[
"HIPAA"
]

Mapped array of: Whether the consent form has been signed

CEL

$result_object_key.consent_forms.map(x, x.signed)

Example

[
true
]

Mapped array of: Time the consent form was submitted

CEL

$result_object_key.consent_forms.map(x, x.submitted_at)

Example

[
"2024-01-23T10:30:00Z"
]

Events

Actions

Get Full Intake Form

Parameters

Result Object Field Details

Events

Actions

Documentation Index

​Parameters

​Result Object Field Details

Parameters

Result Object Field Details