CareWebQI integration

Search Patients or Episodes

Perform Search Patients or Episodes through CareWebQI.

View as Markdown

carewebqi_search

writecarewebqi

Inputs

search_by
selectrequired
Search By
Required selected identifier or value.
Default: "episode"
Options: Patient ("patient"), Episode ("episode")
search_text
expressionrequired
Search Text
Required literal value or workflow expression.
include_discharged
boolean
Include Discharged
Optional true-or-false value.
Default: false

Outputs

successSuccess
search_bySearch By
search_textSearch Text
foundFound
match_countMatch Count
single_matchSingle Match
ambiguousAmbiguous
patientsPatients
episodesEpisodes
episode_idEpisode Id
patient_idPatient Id
patient_id_truncatedPatient Id Truncated
errorError

Output schema completeness: best_effort_declared

Safety

External effect: write
Confirmation recommended: No
Retry safe: No
Dry run supported: No

Schemas

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

Input schema

{
  "type": "object",
  "required": [
    "search_by",
    "search_text"
  ],
  "properties": {
    "search_by": {
      "enum": [
        "patient",
        "episode"
      ],
      "type": "string",
      "default": "episode",
      "description": "Required selected identifier or value.",
      "x-workflow-field-type": "select"
    },
    "search_text": {
      "description": "Required literal value or workflow expression.",
      "x-workflow-field-type": "expression"
    },
    "include_discharged": {
      "type": "boolean",
      "default": false,
      "description": "Optional true-or-false value.",
      "x-workflow-field-type": "boolean"
    }
  },
  "additionalProperties": false
}

Output schema

{
  "type": "object",
  "properties": {
    "error": {},
    "found": {},
    "success": {},
    "episodes": {},
    "patients": {},
    "ambiguous": {},
    "search_by": {},
    "episode_id": {},
    "patient_id": {},
    "match_count": {},
    "search_text": {},
    "single_match": {},
    "patient_id_truncated": {}
  },
  "additionalProperties": true
}

View all CareWebQI actions