Skip to documentation
Brightree integration

Check Patient Exists

Match the extracted patient on an organization-owned document using the configured Brightree strategy. Requires extracted demographics and a strategy supporting patient search. Check success before exists: exists=null means unknown, not an absent patient. Create only when ready_for_patient_create=true. patient_id is a local GenHealth ID; patient_key identifies Brightree. Missing demographics or ambiguous matches require review. A returned error can fail the node; use an explicit fail_branch error route when review is required.

View as Markdown
brightree_check_patient_exists
writebrightree

Use 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": "Brightree",
  "params": {
    "force": false
  },
  "handler": "brightree_check_patient_exists"
}

Action contracts and connections · Run recovery

Inputs

  • document_id
    expression
    Document Id

    Organization-owned GenHealth document UUID with extracted patient demographics. Set this explicitly in params when authoring an independent workflow.

  • force
    boolean
    Force

    Re-run the configured match check rather than reuse a previously recorded result. Default false.

    Default: false

Outputs

  • successSuccess
  • document_idDocument Id
  • patient_idPatient Id
  • patient_namePatient Name
  • birth_dateBirth Date
  • existsExists
  • ready_for_patient_createReady For Patient Create
  • external_idExternal Id
  • patient_keyPatient Key
  • patient_urlPatient Url
  • statusStatus
  • error_messageError Message

Output schema completeness: reviewed_partial

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",
  "properties": {
    "force": {
      "type": "boolean",
      "default": false,
      "description": "Re-run the configured match check rather than reuse a previously recorded result. Default false.",
      "x-workflow-field-type": "boolean"
    },
    "document_id": {
      "description": "Organization-owned GenHealth document UUID with extracted patient demographics. Set this explicitly in params when authoring an independent workflow.",
      "x-workflow-field-type": "expression"
    }
  },
  "additionalProperties": false
}
Output schema
{
  "type": "object",
  "properties": {
    "exists": {
      "type": [
        "boolean",
        "null"
      ]
    },
    "status": {},
    "success": {
      "type": [
        "boolean",
        "null"
      ]
    },
    "birth_date": {},
    "patient_id": {
      "type": [
        "string",
        "null"
      ],
      "description": "Local GenHealth patient ID, not a Brightree key."
    },
    "document_id": {},
    "external_id": {},
    "patient_key": {
      "type": [
        "integer",
        "string",
        "null"
      ],
      "description": "Brightree patient key; use only after success and an existing match."
    },
    "patient_url": {},
    "patient_name": {},
    "error_message": {
      "type": [
        "string",
        "null"
      ]
    },
    "ready_for_patient_create": {
      "type": "boolean"
    }
  },
  "additionalProperties": true
}
View all Brightree actions