Set Patient User Fields
Perform Set Patient User Fields through Brightree.
brightree_set_patient_user_fieldswritebrightree
Inputs
- Patient Key
patient_keyexpressionrequiredRequired literal value or workflow expression.
- User Fields
user_fieldsexpressionrequiredRequired literal value or workflow expression.
- Skip
skipbooleanOptional true-or-false value.
Default:
false - Dry Run
dry_runbooleanOptional true-or-false value.
Default:
false
Outputs
successSuccessmessageMessageupdated_fieldsUpdated Fieldsverification_detailsVerification DetailsskippedSkippederrorError
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_key",
"user_fields"
],
"properties": {
"skip": {
"type": "boolean",
"default": false,
"description": "Optional true-or-false value.",
"x-workflow-field-type": "boolean"
},
"dry_run": {
"type": "boolean",
"default": false,
"description": "Optional true-or-false value.",
"x-workflow-field-type": "boolean"
},
"patient_key": {
"description": "Required literal value or workflow expression.",
"x-workflow-field-type": "expression"
},
"user_fields": {
"description": "Required literal value or workflow expression.",
"x-workflow-field-type": "expression"
}
},
"additionalProperties": false
}Output schema
{
"type": "object",
"properties": {
"error": {},
"message": {},
"skipped": {},
"success": {},
"updated_fields": {},
"verification_details": {}
},
"additionalProperties": true
}