v1

latestOpenAPI 3.1.02026-07-2218105157.9 KB
Patients

Match Suggestion (no-write)

Run the patient matcher against caller-supplied identifiers and return the verdict. Never persists. The verdict's kind tells the caller how to render its picker: hard (lock — external-id / name+DOB uniqueness), medium (pre-fill with override — phone/email + name heuristic), soft (pre-fill, confirm — a single same-name patient with no date of birth to confirm), or none. Used by the file detail page to lock or pre-fill its patient picker, and by future eligibility / prior-auth extraction surfaces. Identifiers are normalized with the same forgiving parsers the upsert endpoint uses, so callers can pass raw values from extracted document data.

post/v1/patients/match-suggestion

Request body

first_namestring nullable
last_namestring nullable
date_of_birthstring nullable

DOB in any of: YYYY-MM-DD, YYYYMMDD, MM/DD/YYYY, MM-DD-YYYY, MM/DD/YY. Unparseable values are ignored.

phone_numberstring nullable
emailstring nullable

Response

Successful Response

kind'hard' | 'medium' | 'soft' | 'none' required

How the caller should render the picker: hard = lock to the matched patient (DB-enforced uniqueness leaves exactly one valid choice); medium = pre-fill with override (contact-channel heuristic); soft = pre-fill with override (name-only suggestion, confirm before use); none = free.