Brightree integration

Find or Create Facility

Perform Find or Create Facility through Brightree.

View as Markdown

brightree_ensure_facility

writebrightree

Inputs

patient_key
expressionrequired
Patient Key
Required literal value or workflow expression.
facility_name
expressionrequired
Facility Name
Required literal value or workflow expression.
address_1
expression
Address 1
Optional literal value or workflow expression.
city
expression
City
Optional literal value or workflow expression.
state
expression
State
Optional literal value or workflow expression.
postal_code
expression
Postal Code
Optional literal value or workflow expression.
match_address_1
expression
Match Address 1
Optional literal value or workflow expression.
match_city
expression
Match City
Optional literal value or workflow expression.
match_state
expression
Match State
Optional literal value or workflow expression.
match_postal_code
expression
Match Postal Code
Optional literal value or workflow expression.
match_address_source
expression
Match Address Source
Optional literal value or workflow expression.
phone
expression
Phone
Optional literal value or workflow expression.
fax
expression
Fax
Optional literal value or workflow expression.
create_if_missing
boolean
Create If Missing
Optional true-or-false value.
Default: true
require_address
boolean
Require Address
Optional true-or-false value.
Default: true

Outputs

successSuccess
messageMessage
facilityFacility
facility_textFacility Text
facility_valueFacility Value
facility_keyFacility Key
createdCreated
foundFound
skippedSkipped
action_requiredAction Required
action_required_messageAction Required Message
selection_reasonSelection Reason
missing_fieldsMissing Fields
errorError

Output schema completeness: best_effort_declared

Safety

External effect: write
Confirmation recommended: No
Retry safe: No
Dry run supported: No

Schemas

These schemas are first-pass authoring guidance. Runtime validation remains authoritative.

Input schema

{
  "type": "object",
  "required": [
    "patient_key",
    "facility_name"
  ],
  "properties": {
    "fax": {
      "description": "Optional literal value or workflow expression.",
      "x-workflow-field-type": "expression"
    },
    "city": {
      "description": "Optional literal value or workflow expression.",
      "x-workflow-field-type": "expression"
    },
    "phone": {
      "description": "Optional literal value or workflow expression.",
      "x-workflow-field-type": "expression"
    },
    "state": {
      "description": "Optional literal value or workflow expression.",
      "x-workflow-field-type": "expression"
    },
    "address_1": {
      "description": "Optional literal value or workflow expression.",
      "x-workflow-field-type": "expression"
    },
    "match_city": {
      "description": "Optional literal value or workflow expression.",
      "x-workflow-field-type": "expression"
    },
    "match_state": {
      "description": "Optional literal value or workflow expression.",
      "x-workflow-field-type": "expression"
    },
    "patient_key": {
      "description": "Required literal value or workflow expression.",
      "x-workflow-field-type": "expression"
    },
    "postal_code": {
      "description": "Optional literal value or workflow expression.",
      "x-workflow-field-type": "expression"
    },
    "facility_name": {
      "description": "Required literal value or workflow expression.",
      "x-workflow-field-type": "expression"
    },
    "match_address_1": {
      "description": "Optional literal value or workflow expression.",
      "x-workflow-field-type": "expression"
    },
    "require_address": {
      "type": "boolean",
      "default": true,
      "description": "Optional true-or-false value.",
      "x-workflow-field-type": "boolean"
    },
    "create_if_missing": {
      "type": "boolean",
      "default": true,
      "description": "Optional true-or-false value.",
      "x-workflow-field-type": "boolean"
    },
    "match_postal_code": {
      "description": "Optional literal value or workflow expression.",
      "x-workflow-field-type": "expression"
    },
    "match_address_source": {
      "description": "Optional literal value or workflow expression.",
      "x-workflow-field-type": "expression"
    }
  },
  "additionalProperties": false
}

Output schema

{
  "type": "object",
  "properties": {
    "error": {},
    "found": {},
    "created": {},
    "message": {},
    "skipped": {},
    "success": {},
    "facility": {},
    "facility_key": {},
    "facility_text": {},
    "facility_value": {},
    "missing_fields": {},
    "action_required": {},
    "selection_reason": {},
    "action_required_message": {}
  },
  "additionalProperties": true
}

View all Brightree actions