Skip to documentation
ClearPathMD integration

Create Patient Note

Perform Create Patient Note through ClearPathMD.

View as Markdown
clearpath_create_patient_note
writeclearpathmd

Inputs

  • patient_id
    expressionrequired
    Patient Id

    Required literal value or workflow expression.

  • description
    textarearequired
    Description

    Required text value.

  • note_type_id
    text
    Note Type Id

    Optional text value.

  • note_type_label
    text
    Note Type Label

    Optional text value.

  • alert
    boolean
    Alert

    Optional true-or-false value.

    Default: false

Outputs

  • successSuccess
  • dataData
  • messageMessage
  • 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": [
    "patient_id",
    "description"
  ],
  "properties": {
    "alert": {
      "type": "boolean",
      "default": false,
      "description": "Optional true-or-false value.",
      "x-workflow-field-type": "boolean"
    },
    "patient_id": {
      "description": "Required literal value or workflow expression.",
      "x-workflow-field-type": "expression"
    },
    "description": {
      "type": "string",
      "description": "Required text value.",
      "x-workflow-field-type": "textarea"
    },
    "note_type_id": {
      "type": "string",
      "description": "Optional text value.",
      "x-workflow-field-type": "text"
    },
    "note_type_label": {
      "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