Skip to documentation
Brightree integration

Resolve Patient Facility

Perform Resolve Patient Facility through Brightree.

View as Markdown
brightree_resolve_patient_facility
readbrightree

Inputs

  • patient_key
    expressionrequired
    Patient Key

    Required literal value or workflow expression.

  • facility_name
    expression
    Facility Name

    Optional literal value or workflow expression.

  • expected_address
    json
    Expected Address

    Optional JSON value.

  • facility
    json
    Facility

    Optional JSON value.

  • delivery_info
    json
    Delivery Info

    Optional JSON value.

  • facility_source
    expression
    Facility Source

    Optional literal value or workflow expression.

  • is_private_residence
    boolean
    Is Private Residence

    Optional true-or-false value.

    Default: false

  • skip_address_validation
    boolean
    Skip Address Validation

    Optional true-or-false value.

    Default: false

  • skip_if_missing
    boolean
    Skip If Missing

    Optional true-or-false value.

    Default: true

Outputs

  • successSuccess
  • facility_foundFacility Found
  • is_private_residenceIs Private Residence
  • delivery_infoDelivery Info
  • facilityFacility
  • facility_sourceFacility Source
  • expected_facility_addressExpected Facility Address
  • facility_textFacility Text
  • facility_valueFacility Value
  • facility_keyFacility Key
  • skip_facility_writeSkip Facility Write
  • skip_address_syncSkip Address Sync
  • facility_search_nameFacility Search Name
  • facility_search_countFacility Search Count
  • facility_selection_reasonFacility Selection Reason
  • selected_facilitySelected Facility
  • action_requiredAction Required
  • action_required_messageAction Required Message
  • errorError

Output schema completeness: best_effort_declared

Safety

External effect
read
Confirmation recommended
No
Retry safe
Yes
Dry run supported
No

Schemas

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

Input schema
{
  "type": "object",
  "required": [
    "patient_key"
  ],
  "properties": {
    "facility": {
      "description": "Optional JSON value.",
      "x-workflow-field-type": "json"
    },
    "patient_key": {
      "description": "Required literal value or workflow expression.",
      "x-workflow-field-type": "expression"
    },
    "delivery_info": {
      "description": "Optional JSON value.",
      "x-workflow-field-type": "json"
    },
    "facility_name": {
      "description": "Optional literal value or workflow expression.",
      "x-workflow-field-type": "expression"
    },
    "facility_source": {
      "description": "Optional literal value or workflow expression.",
      "x-workflow-field-type": "expression"
    },
    "skip_if_missing": {
      "type": "boolean",
      "default": true,
      "description": "Optional true-or-false value.",
      "x-workflow-field-type": "boolean"
    },
    "expected_address": {
      "description": "Optional JSON value.",
      "x-workflow-field-type": "json"
    },
    "is_private_residence": {
      "type": "boolean",
      "default": false,
      "description": "Optional true-or-false value.",
      "x-workflow-field-type": "boolean"
    },
    "skip_address_validation": {
      "type": "boolean",
      "default": false,
      "description": "Optional true-or-false value.",
      "x-workflow-field-type": "boolean"
    }
  },
  "additionalProperties": false
}
Output schema
{
  "type": "object",
  "properties": {
    "error": {},
    "success": {},
    "facility": {},
    "facility_key": {},
    "delivery_info": {},
    "facility_text": {},
    "facility_found": {},
    "facility_value": {},
    "action_required": {},
    "facility_source": {},
    "selected_facility": {},
    "skip_address_sync": {},
    "skip_facility_write": {},
    "facility_search_name": {},
    "is_private_residence": {},
    "facility_search_count": {},
    "action_required_message": {},
    "expected_facility_address": {},
    "facility_selection_reason": {}
  },
  "additionalProperties": true
}
View all Brightree actions