Fetch Patient By Email

POST

Fetches details of a specific patient by their email address, if exists.

To search, pass a JSON object in the Request Body with a single “email” attribute and the email to search for.

Request

This endpoint expects a map from strings to any.

Response

This endpoint returns an object.
firstNamestring

The patient’s first name.

lastNamestring

The patient’s last name.

idlongOptional

Unique identifier for the patient, managed by Impilo.

externalIdentifierstringOptional

Unique external identifier for the patient, managed by the customer.

dateOfBirthstringOptional

The patient’s date of birth in the format YYYY-MM-DD.

emailstringOptional

The patient’s email.

phoneNumberstringOptional

The patient’s phone number.

archivedbooleanOptional

True if the patient is archived, false otherwise.

addressobjectOptional

The patient’s shipping address. Required on all endpoints except PATCH patient.

siteobjectOptional

The site responsible for this patient.

enrolledbooleanOptional

The enrollment status. False if disenrolled.

sexenumOptional
Allowed values: otherfemalemaleunknown