Fields available when submitting Patient Demographics

Below is a list of all of the required and optional fields needed to query for a patient on the Particle Health API.

Field	Required	Notes
Patient ID	FALSE	Your internal patient identifier; no impact on hit rate, but helpful for audit purposes
Family Name	TRUE	a.k.a. Last Name
Given Name	TRUE	a.k.a. First Name
Gender	TRUE	At this time, our API accepts two inputs, Male and Female. Note: Do not abbreviate
Date of Birth	TRUE	The patient's birth date (e.g. Jan 20th, 1993)
City	TRUE	City associated with patient's address
State	TRUE	Use the State's 2-letter abbreviation
Postal Code	TRUE	The patient's 5 digit (XXXXX) postal code. If a 9 digit postal code (XXXXX-XXXX) is passed through, the last 4 digits will be dropped.
Street Name	FALSE	i.e. 123 Main Street - Highly recommended
Purpose of Use	TRUE	TREATMENT in all cases. Please see Purposes of Use for more information
Phone Number	FALSE	Highly recommended
Email	FALSE	The patient's email. Can be helpful
SSN (Social Security Number)	FALSE	Can be helpful
NPI	FALSE	The querying provider's NPI; no impact on hit rate, but helpful for audit purposes
Hints	FALSE	An additional postal code for the patient; increases the surface area of our search