Skip to documentation
NikoHealth integration

Create Patient Note

Perform Create Patient Note through NikoHealth.

View as Markdown
nikohealth_create_patient_note
writenikohealth

Inputs

  • note_request
    expression
    Note Request

    Optional literal value or workflow expression.

  • document_id
    expression
    Document Id

    Optional literal value or workflow expression.

  • patient_id
    expression
    Patient Id

    Optional literal value or workflow expression.

  • subject
    text
    Subject

    Optional text value.

  • description
    textarea
    Description

    Optional text value.

  • is_pinned
    boolean
    Is Pinned

    Optional true-or-false value.

    Default: false

  • skip_if_empty
    boolean
    Skip If Empty

    Optional true-or-false value.

    Default: false

  • idempotency_fingerprint
    expression
    Idempotency Fingerprint

    Optional literal value or workflow expression.

  • auto_push_action_key
    expression
    Auto Push Action Key

    Optional literal value or workflow expression.

  • record_summary
    boolean
    Record Summary

    Optional true-or-false value.

    Default: "false"

  • dry_run
    boolean
    Dry Run

    Optional true-or-false value.

    Default: false

Outputs

  • successSuccess
  • noteNote
  • skippedSkipped
  • dry_runDry Run
  • document_idDocument Id
  • patient_idPatient Id
  • resource_typeResource Type
  • action_typeAction Type
  • note_textNote Text
  • idempotentIdempotent
  • messageMessage
  • errorError

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
}
View all NikoHealth actions