API Reference
StatusPortal
Start typing to search…

Create Query

post
https://sandbox.particlehealth.com/api/v1/queries

Starts a one‑time network query using demographics.

Body Params

Demographics

string

The patient's home city.

address_lines
array of strings

The patient's home street address. This should not include the patient's city, state, or zip code.

address_lines
string

The patient's home state.

string
required

The patient's date of birth, this field is required and must be of the format YYYY-MM-DD.

string

The patient's email, must be a valid email address.

string

Encounter Date for which this query is being made

string

Encounter Type for which this query is being made

string

The patient's family name (last name), this field is required.

string
required

The patient's gender, must be either FEMALE or MALE.

string

The patient's given name (first name), this field is required.

hints
array of strings

Postal codes hinting at the believed location of records.

hints
string

The National Provider Identifier of the provider that this request is being made by.

string

The unique patient id in an external system

string

The patient's home postal (zip) code.

string
required

The purpose of use for which this request is being made

specialties
array of strings

The list of specialty searches requested for this patient

specialties
string

The patient's social security number, must be a valid US social security number.

string

The patient's telephone number.

Responses

Updated 8 months ago

Language
Credentials
Header
Response 
Click Try It! to start a request and see the response here! Or choose an example:
application/json
Updated 8 months ago