Skip to main content
POST
cURL

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json
first_name
string

Patient's first name

Example:

"Jane"

last_name
string

Patient's last name

Example:

"Doe"

date_of_birth
string<date>

Patient's date of birth in YYYY-MM-DD format

Pattern: ^\d{4}-\d{2}-\d{2}$
Example:

"1990-01-01"

phone_number
string

Patient's phone number. US numbers in any common format are accepted.

Example:

"(555) 555-0123"

Response

The match outcome

The outcome of a patient match. Branch on status.

status
enum<string>
required
Available options:
matched
patient
object
required

A Clarion patient record returned by a patient match.

indistinguishable_resolution
enum<string>

How Clarion handled several records that look like the same patient. Present only when more than one record matched equally well.

Available options:
selected-upcoming,
undecided-multiple-upcoming,
selected-past,
undecided-multiple-past,
undecided-no-history,
not-duplicates,
warning,
error