Skip to documentation
Brightree integration

Create Patient From Document

Create or reuse a Brightree patient from an organization-owned document's extracted first name, last name, and birth date. Requires configured Brightree credentials and an organization strategy supporting patient search/create. The action checks for an existing patient before creation. success=true with created=false means an existing patient was reused. patient_id is local; patient_key identifies Brightree. An unverified existing link or ambiguous match requires review. Use fail_branch with an error edge to handle failures. No dry run is declared. After a timeout or uncertain external write, reconcile the Brightree record before retrying; an existence check is not an exactly-once guarantee. This is the supported document-based alternative to the unavailable legacy brightree_create_patient action.

View as Markdown
brightree_create_patient_from_document
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": {},
  "handler": "brightree_create_patient_from_document"
}

Action contracts and connections · Run recovery

Inputs

  • document_id
    expressionrequired
    Document Id

    Required organization-owned GenHealth document UUID. Its extracted patient must have first_name, last_name, and birth_date before this action runs.

Outputs

  • successSuccess
  • document_idDocument Id
  • patient_idPatient Id
  • patient_namePatient Name
  • birth_dateBirth Date
  • patient_keyPatient Key
  • external_idExternal Id
  • createdCreated
  • messageMessage
  • 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",
  "required": [
    "document_id"
  ],
  "properties": {
    "document_id": {
      "description": "Required organization-owned GenHealth document UUID. Its extracted patient must have first_name, last_name, and birth_date before this action runs.",
      "x-workflow-field-type": "expression"
    }
  },
  "additionalProperties": false
}
Output schema
{
  "type": "object",
  "properties": {
    "created": {
      "type": "boolean",
      "description": "With success=true, false indicates reuse of an existing patient."
    },
    "message": {},
    "success": {
      "type": "boolean"
    },
    "birth_date": {},
    "patient_id": {
      "type": [
        "string",
        "null"
      ],
      "description": "Local GenHealth patient ID."
    },
    "document_id": {
      "type": [
        "string",
        "null"
      ]
    },
    "external_id": {
      "type": [
        "string",
        "null"
      ]
    },
    "patient_key": {
      "type": [
        "integer",
        "string",
        "null"
      ],
      "description": "Brightree patient key. Check success before using it."
    },
    "patient_name": {},
    "error_message": {
      "type": [
        "string",
        "null"
      ]
    }
  },
  "additionalProperties": true
}
View all Brightree actions