Skip to documentation
ModMed integration

Search Patients

Perform Search Patients through ModMed.

View as Markdown
modmed_search_patients
readmodmed

Inputs

  • term
    expressionrequired
    Term

    Required literal value or workflow expression.

  • page_size
    number
    Page Size

    Optional numeric value.

    Default: 25

Outputs

  • successSuccess
  • patientsPatients
  • countCount
  • 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": [
    "term"
  ],
  "properties": {
    "term": {
      "description": "Required literal value or workflow expression.",
      "x-workflow-field-type": "expression"
    },
    "page_size": {
      "type": "number",
      "default": 25,
      "description": "Optional numeric value.",
      "x-workflow-field-type": "number"
    }
  },
  "additionalProperties": false
}
Output schema
{
  "type": "object",
  "properties": {
    "count": {},
    "error": {},
    "success": {},
    "patients": {}
  },
  "additionalProperties": true
}
View all ModMed actions