Create Patient Note
Perform Create Patient Note through NikoHealth.
nikohealth_create_patient_notewritenikohealth
Inputs
- Note Request
note_requestexpressionOptional literal value or workflow expression.
- Document Id
document_idexpressionOptional literal value or workflow expression.
- Patient Id
patient_idexpressionOptional literal value or workflow expression.
- Subject
subjecttextOptional text value.
- Description
descriptiontextareaOptional text value.
- Is Pinned
is_pinnedbooleanOptional true-or-false value.
Default:
false - Skip If Empty
skip_if_emptybooleanOptional true-or-false value.
Default:
false - Idempotency Fingerprint
idempotency_fingerprintexpressionOptional literal value or workflow expression.
- Auto Push Action Key
auto_push_action_keyexpressionOptional literal value or workflow expression.
- Record Summary
record_summarybooleanOptional true-or-false value.
Default:
"false" - Dry Run
dry_runbooleanOptional true-or-false value.
Default:
false
Outputs
successSuccessnoteNoteskippedSkippeddry_runDry Rundocument_idDocument Idpatient_idPatient Idresource_typeResource Typeaction_typeAction Typenote_textNote TextidempotentIdempotentmessageMessageerrorError
Output schema completeness: best_effort_declared
Safety
- External effect
- write
- Confirmation recommended
- No
- Retry safe
- No
- Dry run supported
- Yes
Schemas
These schemas are first-pass authoring guidance. Runtime validation remains authoritative.
Input schema
{
"type": "object",
"properties": {
"dry_run": {
"type": "boolean",
"default": false,
"description": "Optional true-or-false value.",
"x-workflow-field-type": "boolean"
},
"subject": {
"type": "string",
"description": "Optional text value.",
"x-workflow-field-type": "text"
},
"is_pinned": {
"type": "boolean",
"default": false,
"description": "Optional true-or-false value.",
"x-workflow-field-type": "boolean"
},
"patient_id": {
"description": "Optional literal value or workflow expression.",
"x-workflow-field-type": "expression"
},
"description": {
"type": "string",
"description": "Optional text value.",
"x-workflow-field-type": "textarea"
},
"document_id": {
"description": "Optional literal value or workflow expression.",
"x-workflow-field-type": "expression"
},
"note_request": {
"description": "Optional literal value or workflow expression.",
"x-workflow-field-type": "expression"
},
"skip_if_empty": {
"type": "boolean",
"default": false,
"description": "Optional true-or-false value.",
"x-workflow-field-type": "boolean"
},
"record_summary": {
"type": "boolean",
"description": "Optional true-or-false value.",
"x-workflow-field-type": "boolean"
},
"auto_push_action_key": {
"description": "Optional literal value or workflow expression.",
"x-workflow-field-type": "expression"
},
"idempotency_fingerprint": {
"description": "Optional literal value or workflow expression.",
"x-workflow-field-type": "expression"
}
},
"additionalProperties": false
}Output schema
{
"type": "object",
"properties": {
"note": {},
"error": {},
"dry_run": {},
"message": {},
"skipped": {},
"success": {},
"note_text": {},
"idempotent": {},
"patient_id": {},
"action_type": {},
"document_id": {},
"resource_type": {}
},
"additionalProperties": true
}