Patients

Create Query

Changed on Nov 3, 2026

post/api/v2/patients/{particle_patient_id}/query

Request

Base URL
https://sandbox.particlehealth.com
URL
https://sandbox.particlehealth.com/api/v2/patients/{particle_patient_id}/query
Auth
API key in header Authorization

Path parameters

particle_patient_idstring required

Particle Patient ID

Request body

hintsstring[]

Postal codes hinting at the believed location of records.

npistring

The National Provider Identifier (NPI) of the treating provider. Must be exactly 10 digits if provided.

purpose_of_usestring required

The purpose of use for which this request is being made.

specialtiesstring[]

The list of specialty searches requested for this patient

Example request

{
  "hints": [
    "11111",
    "22222",
    "33333"
  ],
  "npi": "1234567890",
  "purpose_of_use": "TREATMENT",
  "specialties": [
    "CKD",
    "DIABETES",
    "RENAL",
    "ONCOLOGY",
    "ORTHOPEDICS",
    "CARDIOLOGY",
    "PULMONOLOGY",
    "GASTROENTEROLOGY"
  ]
}

Response

external_patient_idstring

The external patient id of the patient.

hintsstring[]

Postal codes hinting at the believed location of records.

npistring

The National Provider Identifier (NPI) of the treating provider, if provided.

particle_patient_idstring

The particle patient id that corresponds to the patient that the query is meant to be run against.

purpose_of_usestring

The purpose of use for which this request is being made.

query_idstring

The unique ID of the query that was initiated.