Demographics for Patient Queries

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.

FieldRequiredNotes
Patient IDFALSEYour internal patient identifier; no impact on hit rate, but helpful for audit purposes
Family NameTRUEa.k.a. Last Name
Given NameTRUEa.k.a. First Name
GenderTRUEAt this time, our API accepts two inputs, Male and Female. Note: Do not abbreviate
CityTRUECity associated with patient's address
StateTRUEUse the State's 2-letter abbreviation
Postal CodeTRUEFor patients with multiple known addresses, we provide the ability to query a second zip code (using the “Hints” parameter; this increases the surface area of our search)
Street NameFALSEi.e. 123 Main Street - Highly recommended
Purpose of UseTRUETREATMENT in all cases. Please see Purposes of Use for more information
Phone NumberFALSEHighly recommended
EmailFALSEThe patient's email. Can be helpful
SSN (Social Security Number)FALSECan be helpful
NPIFALSEThe provider's NPI; no impact on hit rate, but helpful for audit purposes
HintsFALSEAn additional postal code for the patient; increases the surface area of our search

Did this page help you?