ClearPathMD integration

Search Orders

Perform Search Orders through ClearPathMD.

View as Markdown

clearpath_search_orders

readclearpathmd

Inputs

order_statuses
multi_select
Order Statuses
Optional list of selected values.
Options: Pending ("1"), Ready For Delivery ("2"), Completed ("3"), Incomplete ("4"), Archived ("5")
max_records
number
Max Records
Optional numeric value.
Default: 500
sort
text
Sort
Optional text value.
Default: "OrderID-desc"
order_id
expression
Order Id
Optional literal value or workflow expression.
patient_id
expression
Patient Id
Optional literal value or workflow expression.
patient_first_name
text
Patient First Name
Optional text value.
patient_last_name
text
Patient Last Name
Optional text value.
practice_id
expression
Practice Id
Optional literal value or workflow expression.
location_id
expression
Location Id
Optional literal value or workflow expression.
provider_id
expression
Provider Id
Optional literal value or workflow expression.
insurance_id
expression
Insurance Id
Optional literal value or workflow expression.
from_order_date
text
From Order Date
Optional text value.
to_order_date
text
To Order Date
Optional text value.
hcpcs
text
Hcpcs
Optional text value.
product_id
expression
Product Id
Optional literal value or workflow expression.
item_type
expression
Item Type
Optional literal value or workflow expression.

Outputs

successSuccess
dataData
messageMessage
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",
  "properties": {
    "sort": {
      "type": "string",
      "default": "OrderID-desc",
      "description": "Optional text value.",
      "x-workflow-field-type": "text"
    },
    "hcpcs": {
      "type": "string",
      "description": "Optional text value.",
      "x-workflow-field-type": "text"
    },
    "order_id": {
      "description": "Optional literal value or workflow expression.",
      "x-workflow-field-type": "expression"
    },
    "item_type": {
      "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"
    },
    "product_id": {
      "description": "Optional literal value or workflow expression.",
      "x-workflow-field-type": "expression"
    },
    "location_id": {
      "description": "Optional literal value or workflow expression.",
      "x-workflow-field-type": "expression"
    },
    "max_records": {
      "type": "number",
      "default": 500,
      "description": "Optional numeric value.",
      "x-workflow-field-type": "number"
    },
    "practice_id": {
      "description": "Optional literal value or workflow expression.",
      "x-workflow-field-type": "expression"
    },
    "provider_id": {
      "description": "Optional literal value or workflow expression.",
      "x-workflow-field-type": "expression"
    },
    "insurance_id": {
      "description": "Optional literal value or workflow expression.",
      "x-workflow-field-type": "expression"
    },
    "to_order_date": {
      "type": "string",
      "description": "Optional text value.",
      "x-workflow-field-type": "text"
    },
    "order_statuses": {
      "type": "array",
      "items": {
        "enum": [
          "1",
          "2",
          "3",
          "4",
          "5"
        ],
        "type": "string"
      },
      "description": "Optional list of selected values.",
      "x-workflow-field-type": "multi_select"
    },
    "from_order_date": {
      "type": "string",
      "description": "Optional text value.",
      "x-workflow-field-type": "text"
    },
    "patient_last_name": {
      "type": "string",
      "description": "Optional text value.",
      "x-workflow-field-type": "text"
    },
    "patient_first_name": {
      "type": "string",
      "description": "Optional text value.",
      "x-workflow-field-type": "text"
    }
  },
  "additionalProperties": false
}

Output schema

{
  "type": "object",
  "properties": {
    "data": {},
    "error": {},
    "message": {},
    "success": {}
  },
  "additionalProperties": true
}

View all ClearPathMD actions