Collect Flat Datasets
Filter Options:
By Domain: Add the domain name directly as a query parameter (no value needed). You can combine multiple domains. For example:
- ?ALLERGIES - Filter for allergies only
- ?ENCOUNTERS&MEDICATIONS - Filter for encounters and medications
Available domains: AI_CITATIONS, AI_OUTPUTS, ALLERGIES, COMPOSITIONS, COVERAGES, DOCUMENT_REFERENCES, ENCOUNTERS, FAMILY_MEMBER_HISTORIES, IMMUNIZATIONS, LABS, LOCATIONS, MED_FILLS, MEDICATIONS, ORGANIZATIONS, PATIENTS, PRACTITIONERS, PROBLEMS, PROCEDURES, RECORD_SOURCES, SOCIAL_HISTORIES, SOURCES, TRANSITIONS, VITAL_SIGNS
License Requirements: AI_OUTPUTS and AI_CITATIONS require a Particle Snapshot license. MED_FILLS requires a Surescripts license.
By Specific Resource: Use the resource_type and resource_id parameters together to retrieve a single resource by ID (documented below).
Path parameters
Particle Patient ID
Query parameters
Filter based on when Particle last queried the network for data (ISO 8601 date format). Returns data that was retrieved from the network after this date, based on query execution date rather than clinical documentation dates.
Filter by resource type. Must be used together with resource_id.
Filter by specific resource ID. Must be used together with resource_type.
Response
OK
Example response
{
"patients": [
{
"address_city": "Brooklyn",
"address_lines": [
"999 Dev Drive"
],
"address_state": "New York",
"consent": [
{
"consent_date": "2021-01-01",
"partner": "Healthix",
"permission": "permit"
}
],
"date_of_birth": "1954-12-01",
"email": "john@doe.com",
"family_name": "Quark",
"gender": "MALE",
"given_name": "Kam",
"particle_patient_id": "1aa50979-1a8e-416d-8c13-a529033cc898",
"patient_id": "pati-enti-d123-4567",
"postal_code": "11111",
"ssn": "123-45-6789",
"telephone": "234-567-8910"
}
]
}