Skip to documentation
CareWebQI integration

Add Episode Note

Perform Add Episode Note through CareWebQI.

View as Markdown
carewebqi_add_episode_note
writecarewebqi

Inputs

  • episode_id
    expressionrequired
    Episode Id

    Required literal value or workflow expression.

  • subject
    selectrequireddynamic options
    Subject

    Required selected identifier or value. Retrieve allowed values from the dynamic options endpoint.

  • note_text
    textarearequired
    Note Text

    Required text value.

  • include_discharged
    boolean
    Include Discharged

    Optional true-or-false value.

    Default: true

Outputs

  • successSuccess
  • savedSaved
  • exitedExited
  • episode_idEpisode Id
  • subjectSubject
  • subject_codeSubject Code
  • note_updated_atNote Updated At
  • note_authorNote Author
  • 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": [
    "episode_id",
    "subject",
    "note_text"
  ],
  "properties": {
    "subject": {
      "type": "string",
      "description": "Required selected identifier or value. Retrieve allowed values from the dynamic options endpoint.",
      "x-dynamic-options": true,
      "x-workflow-field-type": "select"
    },
    "note_text": {
      "type": "string",
      "description": "Required text value.",
      "x-workflow-field-type": "textarea"
    },
    "episode_id": {
      "description": "Required literal value or workflow expression.",
      "x-workflow-field-type": "expression"
    },
    "include_discharged": {
      "type": "boolean",
      "default": true,
      "description": "Optional true-or-false value.",
      "x-workflow-field-type": "boolean"
    }
  },
  "additionalProperties": false
}
Output schema
{
  "type": "object",
  "properties": {
    "error": {},
    "saved": {},
    "exited": {},
    "subject": {},
    "success": {},
    "episode_id": {},
    "note_author": {},
    "subject_code": {},
    "note_updated_at": {}
  },
  "additionalProperties": true
}
View all CareWebQI actions