athenahealth integration

Search Patients

Perform Search Patients through athenahealth.

View as Markdown

athena_search_patients

read

Inputs

query
expressionrequired
Query
Required literal value or workflow expression.
filter_type
select
Filter Type
Optional selected identifier or value.
Default: "NAME"
Options: Name ("NAME"), Patient ID ("ID")
max_results
number
Max Results
Optional numeric value.
Default: 20

Outputs

successSuccess
queryQuery
filter_typeFilter Type
result_countResult Count
countCount
matchesMatches
single_matchSingle Match
patient_idPatient Id
chart_idChart Id
first_patient_idFirst Patient Id
first_chart_idFirst Chart Id
response_lengthResponse Length
errorError
error_messageError Message

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": [
    "query"
  ],
  "properties": {
    "query": {
      "description": "Required literal value or workflow expression.",
      "x-workflow-field-type": "expression"
    },
    "filter_type": {
      "enum": [
        "NAME",
        "ID"
      ],
      "type": "string",
      "default": "NAME",
      "description": "Optional selected identifier or value.",
      "x-workflow-field-type": "select"
    },
    "max_results": {
      "type": "number",
      "default": 20,
      "description": "Optional numeric value.",
      "x-workflow-field-type": "number"
    }
  },
  "additionalProperties": false
}

Output schema

{
  "type": "object",
  "properties": {
    "count": {},
    "error": {},
    "query": {},
    "matches": {},
    "success": {},
    "chart_id": {},
    "patient_id": {},
    "filter_type": {},
    "result_count": {},
    "single_match": {},
    "error_message": {},
    "first_chart_id": {},
    "response_length": {},
    "first_patient_id": {}
  },
  "additionalProperties": true
}

View all athenahealth actions