Bonafide integration

Search Patients

Perform Search Patients through Bonafide.

View as Markdown

bonafide_search_patients

readbonafide

Inputs

first_name
expressionrequired
First Name
Required literal value or workflow expression.
last_name
expressionrequired
Last Name
Required literal value or workflow expression.
date_of_birth
date
Date Of Birth
Optional date in YYYY-MM-DD format.

Outputs

successSuccess
patient_foundPatient Found
single_matchSingle Match
match_countMatch Count
external_idExternal Id
customer_typeCustomer Type
urlUrl
matchesMatches
matched_byMatched By
ambiguousAmbiguous
identity_verifiedIdentity Verified
review_requiredReview Required
messageMessage
errorError
error_messageError Message

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": [
    "first_name",
    "last_name"
  ],
  "properties": {
    "last_name": {
      "description": "Required literal value or workflow expression.",
      "x-workflow-field-type": "expression"
    },
    "first_name": {
      "description": "Required literal value or workflow expression.",
      "x-workflow-field-type": "expression"
    },
    "date_of_birth": {
      "type": "string",
      "format": "date",
      "description": "Optional date in YYYY-MM-DD format.",
      "x-workflow-field-type": "date"
    }
  },
  "additionalProperties": false
}

Output schema

{
  "type": "object",
  "properties": {
    "url": {},
    "error": {},
    "matches": {},
    "message": {},
    "success": {},
    "ambiguous": {},
    "matched_by": {},
    "external_id": {},
    "match_count": {},
    "single_match": {},
    "customer_type": {},
    "error_message": {},
    "patient_found": {},
    "review_required": {},
    "identity_verified": {}
  },
  "additionalProperties": true
}

View all Bonafide actions