React Health integration

List Patients

Perform List Patients through React Health.

View as Markdown

reacthealth_list_patients

readreacthealth

Inputs

page
numberrequired
Page
Required numeric value.
Default: 1
limit
numberrequired
Limit
Required numeric value.
Default: 50
order_by
select
Order By
Optional selected identifier or value.
Default: "therapy_start"
Options: Therapy Start ("therapy_start"), Name ("name"), Birth Date ("birth_date"), Created Date ("created"), Patient ID ("assigned_id"), Days on Service ("therapy_days"), Location ("org_location_name"), City / State ("city_state")
order_direction
select
Order Direction
Optional selected identifier or value.
Default: "desc"
Options: Ascending ("asc"), Descending ("desc")
first_name
expression
First Name
Optional literal value or workflow expression.
last_name
expression
Last Name
Optional literal value or workflow expression.
birth_date
date
Birth Date
Optional date in YYYY-MM-DD format.
patient_id
expression
Patient Id
Optional literal value or workflow expression.
serial_number
expression
Serial Number
Optional literal value or workflow expression.
active
select
Active
Optional selected identifier or value.
Options: All (""), Active ("1"), Inactive ("0")
compliance
expression
Compliance
Optional literal value or workflow expression.
organization
expression
Organization
Optional literal value or workflow expression.
location
expression
Location
Optional literal value or workflow expression.
group
expression
Group
Optional literal value or workflow expression.
clinician
expression
Clinician
Optional literal value or workflow expression.
date_type
select
Date Type
Optional selected identifier or value.
Default: "created"
Options: Created Date ("created"), Therapy Start ("therapy_start")
date_start
date
Date Start
Optional date in YYYY-MM-DD format.
date_end
date
Date End
Optional date in YYYY-MM-DD format.

Outputs

successSuccess
patientsPatients
countCount
current_pageCurrent Page
last_pageLast Page
per_pagePer Page
totalTotal
first_result_indexFirst Result Index
last_result_indexLast Result Index
next_page_urlNext Page Url
prev_page_urlPrev Page Url
truncatedTruncated
errorError

Output schema completeness: best_effort_declared

Safety

External effect: read
Confirmation recommended: No
Retry safe: Yes
Dry run supported: No

Schemas

These schemas are first-pass authoring guidance. Runtime validation remains authoritative.

Input schema

{
  "type": "object",
  "required": [
    "page",
    "limit"
  ],
  "properties": {
    "page": {
      "type": "number",
      "default": 1,
      "description": "Required numeric value.",
      "x-workflow-field-type": "number"
    },
    "group": {
      "description": "Optional literal value or workflow expression.",
      "x-workflow-field-type": "expression"
    },
    "limit": {
      "type": "number",
      "default": 50,
      "description": "Required numeric value.",
      "x-workflow-field-type": "number"
    },
    "active": {
      "enum": [
        "",
        "1",
        "0"
      ],
      "type": "string",
      "description": "Optional selected identifier or value.",
      "x-workflow-field-type": "select"
    },
    "date_end": {
      "type": "string",
      "format": "date",
      "description": "Optional date in YYYY-MM-DD format.",
      "x-workflow-field-type": "date"
    },
    "location": {
      "description": "Optional literal value or workflow expression.",
      "x-workflow-field-type": "expression"
    },
    "order_by": {
      "enum": [
        "therapy_start",
        "name",
        "birth_date",
        "created",
        "assigned_id",
        "therapy_days",
        "org_location_name",
        "city_state"
      ],
      "type": "string",
      "default": "therapy_start",
      "description": "Optional selected identifier or value.",
      "x-workflow-field-type": "select"
    },
    "clinician": {
      "description": "Optional literal value or workflow expression.",
      "x-workflow-field-type": "expression"
    },
    "date_type": {
      "enum": [
        "created",
        "therapy_start"
      ],
      "type": "string",
      "default": "created",
      "description": "Optional selected identifier or value.",
      "x-workflow-field-type": "select"
    },
    "last_name": {
      "description": "Optional literal value or workflow expression.",
      "x-workflow-field-type": "expression"
    },
    "birth_date": {
      "type": "string",
      "format": "date",
      "description": "Optional date in YYYY-MM-DD format.",
      "x-workflow-field-type": "date"
    },
    "compliance": {
      "description": "Optional literal value or workflow expression.",
      "x-workflow-field-type": "expression"
    },
    "date_start": {
      "type": "string",
      "format": "date",
      "description": "Optional date in YYYY-MM-DD format.",
      "x-workflow-field-type": "date"
    },
    "first_name": {
      "description": "Optional literal value or workflow expression.",
      "x-workflow-field-type": "expression"
    },
    "patient_id": {
      "description": "Optional literal value or workflow expression.",
      "x-workflow-field-type": "expression"
    },
    "organization": {
      "description": "Optional literal value or workflow expression.",
      "x-workflow-field-type": "expression"
    },
    "serial_number": {
      "description": "Optional literal value or workflow expression.",
      "x-workflow-field-type": "expression"
    },
    "order_direction": {
      "enum": [
        "asc",
        "desc"
      ],
      "type": "string",
      "default": "desc",
      "description": "Optional selected identifier or value.",
      "x-workflow-field-type": "select"
    }
  },
  "additionalProperties": false
}

Output schema

{
  "type": "object",
  "properties": {
    "count": {},
    "error": {},
    "total": {},
    "success": {},
    "patients": {},
    "per_page": {},
    "last_page": {},
    "truncated": {},
    "current_page": {},
    "next_page_url": {},
    "prev_page_url": {},
    "last_result_index": {},
    "first_result_index": {}
  },
  "additionalProperties": true
}

View all React Health actions