Edit Patient Note
Perform Edit Patient Note through ClearPathMD.
clearpath_update_patient_notewriteclearpathmd
Inputs
- Patient Id
patient_idexpressionrequiredRequired literal value or workflow expression.
- Patient Note Id
patient_note_idexpressionrequiredRequired literal value or workflow expression.
- Description
descriptiontextarearequiredRequired text value.
- Note Type Id
note_type_idtextrequiredRequired text value.
- Note Type Label
note_type_labeltextrequiredRequired text value.
- Alert
alertbooleanrequiredRequired true-or-false value.
Outputs
successSuccessdataDatamessageMessageerrorError
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",
"patient_note_id",
"description",
"note_type_id",
"note_type_label",
"alert"
],
"properties": {
"alert": {
"type": "boolean",
"description": "Required 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": "Required text value.",
"x-workflow-field-type": "text"
},
"note_type_label": {
"type": "string",
"description": "Required text value.",
"x-workflow-field-type": "text"
},
"patient_note_id": {
"description": "Required literal value or workflow expression.",
"x-workflow-field-type": "expression"
}
},
"additionalProperties": false
}Output schema
{
"type": "object",
"properties": {
"data": {},
"error": {},
"message": {},
"success": {}
},
"additionalProperties": true
}