Set Patient Custom Fields
Perform Set Patient Custom Fields through NikoHealth.
nikohealth_set_patient_custom_fieldsUse in a workflow
Copy the discovered node config and fill its params from the input contract. Validate the complete graph before publishing. Integration results use {{node_id.default.field}}. Check business success before dependent writes; completion alone does not prove success.
{
"_group": "NikoHealth",
"params": {
"dry_run": false,
"fail_when_any_unset": false
},
"handler": "nikohealth_set_patient_custom_fields"
}Inputs
- Patient Id
patient_idexpressionrequiredRequired literal value or workflow expression.
- Fields
fieldsrepeatable_grouprequiredRequired list of structured items.
- Name
nameselectrequireddynamic optionsRequired selected identifier or value. Retrieve allowed values from the dynamic options endpoint.
- Value
valueselectrequireddynamic optionsRequired selected identifier or value. Retrieve allowed values from the dynamic options endpoint.
- Fail When Any Unset
fail_when_any_unsetbooleanOptional true-or-false value.
Default:
false - Dry Run
dry_runbooleanOptional true-or-false value.
Default:
false
Outputs
successSuccessentity_idEntity IdchangedChangedfields_setFields Setunchanged_fieldsUnchanged Fieldsunset_fieldsUnset Fieldsunset_countUnset Countdry_runDry Runconfirmed_by_readbackConfirmed By Readbackfailure_categoryFailure CategoryerrorError
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",
"required": [
"patient_id",
"fields"
],
"properties": {
"fields": {
"type": "array",
"items": {
"type": "object",
"required": [
"name",
"value"
],
"properties": {
"name": {
"type": "string",
"description": "Required selected identifier or value. Retrieve allowed values from the dynamic options endpoint.",
"x-dynamic-options": true,
"x-workflow-field-type": "select"
},
"value": {
"type": "string",
"description": "Required selected identifier or value. Retrieve allowed values from the dynamic options endpoint.",
"x-dynamic-options": true,
"x-workflow-field-type": "select"
}
},
"additionalProperties": false
},
"description": "Required list of structured items.",
"x-workflow-field-type": "repeatable_group"
},
"dry_run": {
"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"
},
"fail_when_any_unset": {
"type": "boolean",
"default": false,
"description": "Optional true-or-false value.",
"x-workflow-field-type": "boolean"
}
},
"additionalProperties": false
}Output schema
{
"type": "object",
"properties": {
"error": {},
"changed": {},
"dry_run": {},
"success": {},
"entity_id": {},
"fields_set": {},
"unset_count": {},
"unset_fields": {},
"failure_category": {},
"unchanged_fields": {},
"confirmed_by_readback": {}
},
"additionalProperties": true
}