Patients

Collect Flat Datasets

Changed on Nov 3, 2026

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, 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).

get/api/v2/patients/{particle_patient_id}/flat

Request

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

Path parameters

particle_patient_idstring required

Particle Patient ID

Query parameters

ALLERGIESstring

Dataset filter. Pass dataset names as bare flags with no value, for example ?ALLERGIES; combine several to select multiple datasets, for example ?ALLERGIES&VITAL_SIGNS. Omit all dataset flags to return every dataset. Valid datasets: ALLERGIES, AI_OUTPUTS, AI_CITATIONS, COVERAGES, DOCUMENT_REFERENCES, ENCOUNTERS, FAMILY_MEMBER_HISTORIES, IMMUNIZATIONS, LABS, LOCATIONS, MEDICATIONS, MED_FILLS, ORGANIZATIONS, PRACTITIONERS, PATIENTS, PROBLEMS, PROCEDURES, SOCIAL_HISTORIES, TRANSITIONS, VITAL_SIGNS, RECORD_SOURCES, SOURCES. Only ALLERGIES is listed as a field here, as an example for the Try It console; every other dataset is passed the same way.

_sincestring

Return only data that Particle created or updated at or after this time, rather than filtering on clinical documentation dates. Accepts an ISO 8601 timestamp or date (e.g. 2024-01-01), or lastQuery to return data since the patient's latest completed query.

Filter by resource type. Must be used together with resource_id. When both resource_id and resource_type are given, dataset flags are ignored.

resource_idstring

Filter by specific resource ID. Must be used together with resource_type. When both resource_id and resource_type are given, dataset flags are ignored.

Response

Example response

{
  "labs": [
    {
      "lab_value_boolean": "True"
    }
  ]
}

Changes

Nov 3, 2026b59a5413a488 Revision changes
- breaking
  removed the enum value COMPOSITIONS from the query request parameter resource_type
- breaking
  the response property // became nullable for the status
- breaking
  the response property // became nullable for the status
- breaking
  the response property // became nullable for the status
- breaking
  the response property // became optional for the status
- breaking
  the response property // became optional for the status
- breaking
  the response property // became optional for the status
- breaking
  the response property // became optional for the status
- breaking
  the response property // became optional for the status
- breaking
  the response property // became optional for the status
- breaking
  the response property // became optional for the status
- breaking
  removed the required property // from the response with the status
- warning
  removed the optional property from the response with the status
- warning
  removed the optional property // from the response with the status
- warning
  removed the optional property from the response with the status
- warning
  removed the optional property from the response with the status
- warning
  removed the optional property // from the response with the status
- warning
  removed the optional property // from the response with the status
- warning
  removed the optional property // from the response with the status
- warning
  removed the optional property // from the response with the status
- warning
  removed the optional property // from the response with the status
- warning
  removed the optional property from the response with the status
- warning
  removed the optional property from the response with the status
- info
  added the new optional query request parameter ALLERGIES
- info
  added the new enum value AI_CITATIONS to the query request parameter resource_type
- info
  added the new enum value AI_OUTPUTS to the query request parameter resource_type
- info
  added the new enum value MED_FILLS to the query request parameter resource_type
- info
  added the new enum value RECORD_SOURCES to the query request parameter resource_type
- info
  added the new enum value SOURCES to the query request parameter resource_type
- info
  added the non-success response with the status
- info
  added the optional property to the response with the status
- info
  added the optional property to the response with the status
- info
  added the optional property // to the response with the status
- info
  added the optional property // to the response with the status
- info
  added the optional property // to the response with the status
- info
  added the optional property // to the response with the status
- info
  added the optional property // to the response with the status
- info
  added the optional property // to the response with the status
- info
  added the optional property // to the response with the status
- info
  added the optional property // to the response with the status
- info
  added the optional property // to the response with the status
- info
  added the optional property // to the response with the status
- info
  added the optional property // to the response with the status
- info
  added the optional property // to the response with the status
- info
  added the optional property // to the response with the status
- info
  added the optional property // to the response with the status
- info
  added the optional property // to the response with the status
- info
  added the optional property // to the response with the status
- info
  added the optional property // to the response with the status
- info
  added the optional property // to the response with the status
- info
  added the optional property // to the response with the status
- info
  added the optional property // to the response with the status
- info
  added the optional property // to the response with the status
- info
  added the optional property to the response with the status
- info
  added the optional property to the response with the status
- info
  added the optional property to the response with the status
- info
  added the optional property to the response with the status
- info
  added the optional property to the response with the status
- info
  added the optional property to the response with the status
- info
  added the optional property // to the response with the status
- info
  added the optional property // to the response with the status
- info
  added the optional property // to the response with the status
- info
  added the optional property // to the response with the status
- info
  added the optional property // to the response with the status
- info
  added the optional property // to the response with the status
- info
  added the optional property // to the response with the status
- info
  added the optional property // to the response with the status
- info
  added the optional property // to the response with the status
- info
  added the optional property // to the response with the status
- info
  added the optional property // to the response with the status
- info
  added the optional property // to the response with the status
- info
  added the optional property // to the response with the status
- info
  added the optional property // to the response with the status
- info
  added the optional property // to the response with the status
- info
  added the optional property // to the response with the status
- info
  added the optional property // to the response with the status
- info
  added the optional property // to the response with the status
- info
  added the optional property // to the response with the status
- info
  added the optional property // to the response with the status
- info
  added the optional property // to the response with the status
- info
  added the optional property // to the response with the status
- info
  added the optional property // to the response with the status
- info
  added the optional property // to the response with the status
- info
  added the optional property // to the response with the status
- info
  added the optional property // to the response with the status
- info
  added the optional property // to the response with the status
- info
  added the optional property // to the response with the status
- info
  added the optional property // to the response with the status
- info
  added the optional property // to the response with the status
- info
  added the optional property to the response with the status
- info
  added the optional property // to the response with the status
- info
  added the optional property // to the response with the status
- info
  added the optional property // to the response with the status
- info
  added the optional property // to the response with the status
- info
  added the optional property // to the response with the status
- info
  added the optional property // to the response with the status
- info
  added the optional property // to the response with the status
- info
  added the optional property // to the response with the status
- info
  added the optional property // to the response with the status
- info
  added the optional property // to the response with the status
- info
  added the optional property // to the response with the status
- info
  added the optional property // to the response with the status
- info
  added the optional property // to the response with the status
- info
  added the optional property // to the response with the status
- info
  added the optional property // to the response with the status
- info
  added the optional property // to the response with the status
- info
  added the optional property // to the response with the status
- info
  added the optional property // to the response with the status
- info
  added the optional property // to the response with the status
- info
  added the optional property // to the response with the status
- info
  added the optional property // to the response with the status
- info
  added the optional property // to the response with the status
- info
  added the optional property // to the response with the status
- info
  added the optional property // to the response with the status
- info
  added the optional property // to the response with the status
- info
  added the optional property // to the response with the status
- info
  added the optional property // to the response with the status
- info
  added the optional property // to the response with the status
- info
  added the optional property // to the response with the status
- info
  added the optional property to the response with the status
- info
  added the optional property // to the response with the status
- info
  added the optional property // to the response with the status
- info
  added the optional property // to the response with the status
- info
  added the optional property // to the response with the status
- info
  added the optional property // to the response with the status
- info
  added the optional property to the response with the status
- info
  added the optional property to the response with the status
- info
  added the optional property // to the response with the status
- info
  added the optional property // to the response with the status
- info
  added the optional property // to the response with the status
- info
  added the optional property // to the response with the status
- info
  added the optional property // to the response with the status

Operation history