---
title: "Changes to Collect Flat Datasets"
method: GET
path: "/api/v2/patients/{particle_patient_id}/flat"
---

# Changes to Collect Flat Datasets

`GET /api/v2/patients/{particle_patient_id}/flat`

> Every recorded change to this operation, newest first.

## Timeline

Changed in 1 of 2 revisions.

- **2026-11-03** `b59a5413a488`: 12 breaking, 11 warning, 109 info

## Changes

- **2026-11-03** `b59a5413a488`: 12 breaking, 11 warning, 109 info
  - removed the enum value `COMPOSITIONS` from the `query` request parameter `resource_type`
  - the response property `immunizations/items/immunization_dosage_value` became nullable for the status `200`
  - the response property `medications/items/medication_statement_dose_value` became nullable for the status `200`
  - the response property `vitalSigns/items/vital_sign_observation_value` became nullable for the status `200`
  - the response property `patients/items/address_city` became optional for the status `200`
  - the response property `patients/items/address_state` became optional for the status `200`
  - the response property `patients/items/date_of_birth` became optional for the status `200`
  - the response property `patients/items/family_name` became optional for the status `200`
  - the response property `patients/items/gender` became optional for the status `200`
  - the response property `patients/items/given_name` became optional for the status `200`
  - the response property `patients/items/patient_id` became optional for the status `200`
  - removed the required property `patients/items/postal_code` from the response with the `200` status
  - removed the optional property `composition` from the response with the `200` status
  - removed the optional property `documentReferences/items/document_reference_type_coding` from the response with the `200` status
  - removed the optional property `medFills` from the response with the `200` status
  - removed the optional property `medRecs` from the response with the `200` status
  - removed the optional property `patients/items/address_lines` from the response with the `200` status
  - removed the optional property `patients/items/consent` from the response with the `200` status
  - removed the optional property `patients/items/email` from the response with the `200` status
  - removed the optional property `patients/items/particle_patient_id` from the response with the `200` status
  - removed the optional property `patients/items/ssn` from the response with the `200` status
  - removed the optional property `provenances` from the response with the `200` status
  - removed the optional property `relatedPersons` from the response with the `200` status
  - added the new optional `query` request parameter `ALLERGIES`
  - added the new enum value `AI_CITATIONS` to the `query` request parameter `resource_type`
  - added the new enum value `AI_OUTPUTS` to the `query` request parameter `resource_type`
  - added the new enum value `MED_FILLS` to the `query` request parameter `resource_type`
  - added the new enum value `RECORD_SOURCES` to the `query` request parameter `resource_type`
  - added the new enum value `SOURCES` to the `query` request parameter `resource_type`
  - added the non-success response with the status `410`
  - added the optional property `aICitations` to the response with the `200` status
  - added the optional property `aIOutputs` to the response with the `200` status
  - added the optional property `allergies/items/allergy_code_rxnorm` to the response with the `200` status
  - added the optional property `allergies/items/allergy_code_rxnorm_name` to the response with the `200` status
  - added the optional property `allergies/items/allergy_code_snomed` to the response with the `200` status
  - added the optional property `allergies/items/allergy_code_snomed_name` to the response with the `200` status
  - added the optional property `allergies/items/reaction_manifestation_code_icd10` to the response with the `200` status
  - added the optional property `allergies/items/reaction_manifestation_code_icd10_name` to the response with the `200` status
  - added the optional property `allergies/items/reaction_manifestation_code_snomed` to the response with the `200` status
  - added the optional property `allergies/items/reaction_manifestation_code_snomed_name` to the response with the `200` status
  - …92 more

---

[Operation](https://skmtc.dev/particlehealth/apis/particle-health-api/docs/api/v2/patients/:particle_patient_id/flat/get.md) - [API](https://skmtc.dev/particlehealth/apis/particle-health-api.md) - [Page](https://skmtc.dev/particlehealth/apis/particle-health-api/changes/api/v2/patients/:particle_patient_id/flat/get)