# Check Patient Exists

> Perform Check Patient Exists through Brightree.

Source: [https://genhealth.ai/docs/workflows/integrations/brightree/brightree_check_patient_exists](https://genhealth.ai/docs/workflows/integrations/brightree/brightree_check_patient_exists)

Integration: [Brightree](https://genhealth.ai/docs/workflows/integrations/brightree.md)

- Handler: `brightree_check_patient_exists`

- Connection type: `brightree`

## Inputs

- `document_id` — Document Id (expression)
  Optional literal value or workflow expression.
- `force` — Force (boolean)
  Optional true-or-false value.
  Default: `false`

## Outputs

- `success` — Success
- `document_id` — Document Id
- `patient_id` — Patient Id
- `patient_name` — Patient Name
- `birth_date` — Birth Date
- `exists` — Exists
- `ready_for_patient_create` — Ready For Patient Create
- `external_id` — External Id
- `patient_key` — Patient Key
- `patient_url` — Patient Url
- `status` — Status
- `error_message` — Error Message

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

```json
{
  "type": "object",
  "properties": {
    "force": {
      "type": "boolean",
      "default": false,
      "description": "Optional true-or-false value.",
      "x-workflow-field-type": "boolean"
    },
    "document_id": {
      "description": "Optional literal value or workflow expression.",
      "x-workflow-field-type": "expression"
    }
  },
  "additionalProperties": false
}
```

### Output schema

```json
{
  "type": "object",
  "properties": {
    "exists": {},
    "status": {},
    "success": {},
    "birth_date": {},
    "patient_id": {},
    "document_id": {},
    "external_id": {},
    "patient_key": {},
    "patient_url": {},
    "patient_name": {},
    "error_message": {},
    "ready_for_patient_create": {}
  },
  "additionalProperties": true
}
```