Flat

Collect Flat Datasets

Changed on Nov 3, 2026

Returns the Flat datasets for a query. Add dataset names as query parameters (e.g. ?LABS&ENCOUNTERS) to return only those datasets.

get/flat/{id}/collect-data

Request

Base URL
https://sandbox.particlehealth.com
URL
https://sandbox.particlehealth.com/flat/{id}/collect-data
Auth
API key in header Authorization

Path parameters

idstring required

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

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.

Filter by resource type. Must be used together with resource_id. 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
  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
  deleted the query request parameter COMPOSITIONS
- warning
  deleted the query request parameter COVERAGES
- warning
  deleted the query request parameter DOCUMENT_REFERENCES
- warning
  deleted the query request parameter ENCOUNTERS
- warning
  deleted the query request parameter FAMILY_MEMBER_HISTORIES
- warning
  deleted the query request parameter IMMUNIZATIONS
- warning
  deleted the query request parameter LABS
- warning
  deleted the query request parameter LOCATIONS
- warning
  deleted the query request parameter MEDICATIONS
- warning
  deleted the query request parameter MEDRECS
- warning
  deleted the query request parameter MED_FILLS
- warning
  deleted the query request parameter ORGANIZATIONS
- warning
  deleted the query request parameter PATIENTS
- warning
  deleted the query request parameter PRACTITIONERS
- warning
  deleted the query request parameter PROBLEMS
- warning
  deleted the query request parameter PROCEDURES
- warning
  deleted the query request parameter PROVENANCES
- warning
  deleted the query request parameter RELATED_PERSONS
- warning
  deleted the query request parameter SOCIAL_HISTORIES
- warning
  deleted the query request parameter TRANSITIONS
- warning
  deleted the query request parameter VITAL_SIGNS
- 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 resource_id
- info
  added the new optional 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
- info
  added the success response with the status

Operation history