Brightree integration

Set Patient Hold Account

Perform Set Patient Hold Account through Brightree.

View as Markdown

brightree_set_patient_hold_account

writebrightree

Inputs

patient_key
expressionrequired
Patient Key
Required literal value or workflow expression.
hold_account
boolean
Hold Account
Optional true-or-false value.
Default: true
skip
boolean
Skip
Optional true-or-false value.
Default: false
dry_run
boolean
Dry Run
Optional true-or-false value.
Default: false

Outputs

successSuccess
messageMessage
updated_fieldsUpdated Fields
verification_detailsVerification Details
skippedSkipped
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",
  "required": [
    "patient_key"
  ],
  "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"
    },
    "hold_account": {
      "type": "boolean",
      "default": true,
      "description": "Optional true-or-false value.",
      "x-workflow-field-type": "boolean"
    }
  },
  "additionalProperties": false
}

Output schema

{
  "type": "object",
  "properties": {
    "error": {},
    "message": {},
    "skipped": {},
    "success": {},
    "updated_fields": {},
    "verification_details": {}
  },
  "additionalProperties": true
}

View all Brightree actions