Add Workflow Note
Perform Add Workflow Note through MyForms.
myforms_add_workflow_notewrite
Inputs
- Workflow Id
workflow_idtextrequiredRequired text value.
- Note
notetextarearequiredRequired text value.
- Is Sticky
is_stickybooleanOptional true-or-false value.
Default:
false - Category
categorytextOptional text value.
Default:
"Patient Notes" - Timeout Seconds
timeout_secondsnumberOptional numeric value.
Default:
180
Outputs
successSuccessnote_addedNote Addederror_messageError Message
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": [
"workflow_id",
"note"
],
"properties": {
"note": {
"type": "string",
"description": "Required text value.",
"x-workflow-field-type": "textarea"
},
"category": {
"type": "string",
"default": "Patient Notes",
"description": "Optional text value.",
"x-workflow-field-type": "text"
},
"is_sticky": {
"type": "boolean",
"default": false,
"description": "Optional true-or-false value.",
"x-workflow-field-type": "boolean"
},
"workflow_id": {
"type": "string",
"description": "Required text value.",
"x-workflow-field-type": "text"
},
"timeout_seconds": {
"type": "number",
"default": 180,
"description": "Optional numeric value.",
"x-workflow-field-type": "number"
}
},
"additionalProperties": false
}Output schema
{
"type": "object",
"properties": {
"success": {},
"note_added": {},
"error_message": {}
},
"additionalProperties": true
}