--- title: "Collect Flat Datasets" method: GET path: "/api/v2/patients/{particle_patient_id}/flat" tags: ["Patients"] --- # Collect Flat Datasets `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` **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). ## Path parameters - `particle_patient_id` string, required ## Query parameters - `ALLERGIES` string - `_since` string - `resource_type` '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' - `resource_id` string ## Response `200` OK - ApiDatasets - `aICitations` ApiAICitation[] - `ai_output_id` string - `citation_id` string - `particle_patient_id` string - `preferred_document_reference_id` string - `resource_reference_id` string - `resource_type` string - `text_snippet` string - `aIOutputs` ApiAIOutput[] - `ai_output_id` string - `created` string - `patient_id` string - `resource_reference_ids` string - `text` string - `type` string - `allergies` ApiAllergy[] - `allergy_code` string - `allergy_code_rxnorm` string - `allergy_code_rxnorm_name` string - `allergy_code_snomed` string - `allergy_code_snomed_name` string - `allergy_code_system` string - `allergy_id` string - `allergy_name` string - `allergy_onset_end` string - `allergy_onset_start` string - `patient_id` string - `practitioner_role_id` string - `reaction_manifestation` string - `reaction_manifestation_code` string - `reaction_manifestation_code_icd10` string - `reaction_manifestation_code_icd10_name` string - `reaction_manifestation_code_snomed` string - `reaction_manifestation_code_snomed_name` string - `reaction_manifestation_code_system` string - `recorded_date` string - `subject_patient_id` string - `coverages` ApiCoverage[] - `beneficiary_reference` string - `class_type_code` string - `class_type_code_system` string - `class_type_display` string - `class_value` string - `coverage_id` string - `identifier_system` string - `identifier_value` string - `order` string - `patient_id` string - `payor_reference` string - `relationship_code` string - `relationship_code_system` string - `relationship_display` string - `status` string - `subscriber_id` string - `subscriber_reference` string - `type_code` string - `type_code_system` string - `type_display` string - `documentReferences` ApiDocumentReference[] - `document_reference_content_data` string - `document_reference_content_type` string - `document_reference_id` string - `document_reference_type` string - `document_reference_type_code` string - `document_reference_type_code_snomed` string - `document_reference_type_code_snomed_name` string - `document_reference_type_coding_system` string - `encounter_reference_id` string - `last_updated` string - `patient_id` string - `practitioner_role_reference_id` string - `subject_patient_id` string - `encounters` ApiEncounter[] - `condition_id_references` string - `encounter_end_time` string - `encounter_id` string - `encounter_start_time` string - `encounter_text` string - `encounter_type_code` string - `encounter_type_code_cpt` string - `encounter_type_code_cpt_name` string - `encounter_type_code_icd10` string - `encounter_type_code_icd10_name` string - `encounter_type_code_snomed` string - `encounter_type_code_snomed_name` string - `encounter_type_code_system` string - `encounter_type_name` string - `hospitalization_discharge_disposition` string - `location_id_references` string - `patient_id` string - `practitioner_role_id_references` string - `subject_patient_id` string - `familyMemberHistories` ApiFamilyMemberHistory[] - `family_member_history_condition_code` string - `family_member_history_condition_code_system` string - `family_member_history_condition_display` string - `family_member_history_id` string - `family_member_history_relationship_code` string - `family_member_history_relationship_code_system` string - `family_member_history_relationship_display` string - `family_member_history_sex_code` string - `family_member_history_sex_code_system` string - `family_member_history_sex_display` string - `patient_id` string - `immunizations` ApiImmunization[] - `immunization_code` string - `immunization_code_cvx` string - `immunization_code_cvx_name` string - `immunization_code_ndc` string - `immunization_code_ndc_name` string - `immunization_code_rxnorm` string - `immunization_code_rxnorm_name` string - `immunization_code_snomed` string - `immunization_code_snomed_name` string - `immunization_code_system` string - `immunization_dosage_unit` string - `immunization_dosage_value` number, nullable - `immunization_id` string - `immunization_lot_number` string - `immunization_manufacturer_name` string - `immunization_name` string - `immunization_occurrence_time` string - `immunization_route` string - `immunization_route_code` string - `immunization_route_code_system` string - `immunization_site` string - `immunization_site_code` string - `immunization_site_code_system` string - `immunization_status` string - `patient_id` string - `performer_practitioner_role_reference_id` string - `subject_patient_id` string - `labs` ApiLab[] - `diagnostic_interpreter_practitioner_role_reference_id` string - `diagnostic_performer_practitioner_role_reference_id` string - `diagnostic_report_code` string - `diagnostic_report_code_cpt` string - `diagnostic_report_code_cpt_name` string - `diagnostic_report_code_loinc` string - `diagnostic_report_code_loinc_name` string - `diagnostic_report_code_snomed` string - `diagnostic_report_code_snomed_name` string - `diagnostic_report_code_system` string - `diagnostic_report_id` string - `diagnostic_report_name` string - `lab_code` string - `lab_code_cpt` string - `lab_code_cpt_name` string - `lab_code_loinc` string - `lab_code_loinc_name` string - `lab_code_snomed` string - `lab_code_snomed_name` string - `lab_code_system` string - `lab_interpretation` string - `lab_name` string - `lab_observation_id` string - `lab_reference_range_high` string - `lab_reference_range_interpretation` string - `lab_reference_range_interpretation_code` string - `lab_reference_range_low` string - `lab_reference_range_text` string - `lab_reference_range_unit` string - `lab_text` string - `lab_timestamp` string - `lab_unit` string - `lab_unit_quantity` string - `lab_value` string - `lab_value_boolean` string: The lab or observation result when it is a true/false value. Returned as the string "True" or "False"; empty when the result is not a true/false value. - `lab_value_code` string - `lab_value_code_system` string - `lab_value_quantity` string - `lab_value_string` string - `observation_category` string - `patient_id` string - `subject_patient_id` string - `locations` ApiLocation[] - `location_address` string - `location_address_use` string - `location_city` string - `location_id` string - `location_name` string - `location_postal_code` string - `location_state` string - `location_type` string - `location_type_code` string - `location_type_code_system` string - `patient_id` string - `medicationFills` ApiMedFill[] - `code_list_qualifier` string, nullable - `days_supply` string, nullable - `dea_schedule` string, nullable - `directions` string, nullable - `electronic_prescription` string, nullable - `history_source_fill_number` string, nullable - `last_filled_date` string, nullable - `medication_id` string, nullable - `medication_name` string, nullable - `medication_statement_start_time` string, nullable - `ndc_code` string, nullable - `patient_id` string, nullable - `pharmacy_city` string, nullable - `pharmacy_ncpdp_id` string, nullable - `pharmacy_npi` string, nullable - `pharmacy_state` string, nullable - `pharmacy_store_name` string, nullable - `prescriber_name` string, nullable - `prescriber_npi` string, nullable - `prescription_number` string, nullable - `product_code` string, nullable - `quantity_prescribed` string, nullable - `quantity_unit_code` string, nullable - `record_id` string, nullable - `refills_qualifier` string, nullable - `refills_value` string, nullable - `rxcui` string, nullable - `sent_time` string, nullable - `sold_date` string, nullable - `strength` string, nullable - `strength_code` string, nullable - `strength_source_code` string, nullable - `substitutions` string, nullable - `unit_source_code` string, nullable - `written_date` string, nullable - `medications` ApiMedication[] - `medication_code` string - `medication_code_ndc` string - `medication_code_ndc_name` string - `medication_code_rxnorm` string - `medication_code_rxnorm_name` string - `medication_code_snomed` string - `medication_code_snomed_name` string - `medication_code_system` string - `medication_context` string - `medication_id` string - `medication_name` string - `medication_reference` string - `medication_resource_type` string - `medication_statement_dose_route` string - `medication_statement_dose_unit` string - `medication_statement_dose_value` number, nullable - `medication_statement_end_time` string - `medication_statement_id` string - `medication_statement_patient_instructions` string - `medication_statement_start_time` string - `medication_statement_status` string - `medication_statement_text` string - `patient_id` string - `practitioner_role_id` string - `subject_patient_id` string - `organizations` ApiOrganization[] - `organization_address_city` string - `organization_address_country` string - `organization_address_lines` string - `organization_address_postal_code` string - `organization_address_state` string - `organization_address_use` string - `organization_id` string - `organization_name` string - `organization_telecom_system` string - `organization_telecom_use` string - `organization_telecom_value` string - `patient_id` string - `patients` ApiFlatPatient[] - `address_city` string - `address_county` string - `address_line` string - `address_postal_code` string - `address_state` string - `date_of_birth` string - `family_name` string - `gender` string - `given_name` string - `language` string - `marital_status` string - `patient_id` string - `race` string - `resource_id` string - `telephone` string - `practitioners` ApiPractitioner[] - `patient_id` string - `practitioner_address_city` string - `practitioner_address_state` string - `practitioner_address_street` string - `practitioner_address_use` string - `practitioner_family_name` string - `practitioner_given_name` string - `practitioner_id` string - `practitioner_identifier_system` string - `practitioner_identifier_value` string - `practitioner_name_suffix` string - `practitioner_role` string - `practitioner_role_code` string - `practitioner_role_code_system` string - `practitioner_role_id` string - `practitioner_role_specialty` string - `practitioner_role_specialty_code` string - `practitioner_role_specialty_code_system` string - `practitioner_telecom_system` string - `practitioner_telecom_value` string - `problems` ApiProblem[] - `condition_category_code` string - `condition_category_code_name` string - `condition_category_code_system` string - `condition_clinical_status` string - `condition_code` string - `condition_code_icd10` string - `condition_code_icd10_name` string - `condition_code_snomed` string - `condition_code_snomed_name` string - `condition_code_system` string - `condition_id` string - `condition_name` string - `condition_onset_date` string - `condition_recorded_date` string - `condition_text` string - `encounter_id` string - `patient_id` string - `subject_patient_id` string - `procedures` ApiProcedure[] - `asserter_practitioner_role_reference_id` string - `encounter_reference_id` string - `patient_id` string - `performer_practitioner_role_reference_id` string - `procedure_code` string - `procedure_code_cpt` string - `procedure_code_cpt_name` string - `procedure_code_snomed` string - `procedure_code_snomed_name` string - `procedure_code_system` string - `procedure_date_time` string - `procedure_id` string - `procedure_name` string - `procedure_reason` string - `procedure_reason_code` string - `procedure_reason_code_icd10` string - `procedure_reason_code_icd10_name` string - `procedure_reason_code_snomed` string - `procedure_reason_code_snomed_name` string - `procedure_reason_code_system` string - `procedure_text` string - `subject_patient_id` string - `recordSources` ApiRecordSource[] - `document_reference_id` string, nullable - `patient_id` string - `resource_id` string - `resource_id_name` string - `resource_type` string - `source_id` string - `socialHistories` ApiSocialHistory[] - `observation_category` string - `patient_id` string - `practitioner_role_reference_id` string - `social_history_observation_code` string - `social_history_observation_code_loinc` string - `social_history_observation_code_loinc_name` string - `social_history_observation_code_snomed` string - `social_history_observation_code_snomed_name` string - `social_history_observation_code_system` string - `social_history_observation_id` string - `social_history_observation_name` string - `social_history_observation_timestamp` string - `social_history_observation_value` string - `social_history_observation_value_code` string - `social_history_observation_value_code_system` string - `social_history_text` string - `subject_patient_id` string - `sources` ApiSource[] - `author_name` string - `class_code` string - `event_code` string - `healthcare_facility_type_code` string - `patient_id` string - `practice_setting_code` string - `service_end_time` string - `service_start_time` string - `source_id` string - `source_name` string - `title` string - `type` string - `transitions` ApiTransition[] - `address` string - `admitting_diagnosis_code` string - `admitting_diagnosis_code_system` string - `admitting_diagnosis_code_system_name` string - `admitting_diagnosis_description` string - `attending_physician_name` string - `attending_physician_npi` string - `city` string - `discharge_diagnosis_code` string - `discharge_diagnosis_code_system` string - `discharge_diagnosis_code_system_name` string - `discharge_diagnosis_description` string - `discharge_disposition` string - `discharge_disposition_code_hl7` string - `discharge_summary` string - `dob` string - `facility_name` string - `facility_npi` string - `facility_type` string - `first_name` string - `gender` string - `last_name` string - `particle_patient_id` string - `patient_id` string - `phone_number` string - `possible_observation_stays` string: Flags an inpatient transition that may be an observation stay. "true" when flagged, empty otherwise (never "false"). A suggestion to review the clinical documentation, not a determination. Not all inpatient transitions are eligible to be flagged. - `setting` string - `state` string - `status` string - `status_date_time` string - `transition_id` string - `visit_diagnosis_reference_ids` string - `visit_encounter_reference_ids` string - `visit_end_date_time` string - `visit_id` string - `visit_medication_reference_ids` string - `visit_start_date_time` string - `zip` string - `vitalSigns` ApiVitalSign[] - `observation_category` string - `patient_id` string - `subject_patient_id` string - `vital_sign_grouping_observation_id` string - `vital_sign_observation_code` string - `vital_sign_observation_code_loinc` string - `vital_sign_observation_code_loinc_name` string - `vital_sign_observation_code_snomed` string - `vital_sign_observation_code_snomed_name` string - `vital_sign_observation_code_system` string - `vital_sign_observation_id` string - `vital_sign_observation_name` string - `vital_sign_observation_text` string - `vital_sign_observation_time` string - `vital_sign_observation_unit` string - `vital_sign_observation_value` number, nullable ## Other responses - `400`: Bad Request - `401`: Unauthorized - `403`: Forbidden - `404`: Not Found - `406`: Not Acceptable - `410`: Gone - `500`: Internal Server Error ## 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` - …128 more [Operation history](https://skmtc.dev/particlehealth/apis/particle-health-api/changes/api/v2/patients/:particle_patient_id/flat/get.md) --- [API](https://skmtc.dev/particlehealth/apis/particle-health-api.md) - [All operations](https://skmtc.dev/particlehealth/apis/particle-health-api/llms.txt) - [OpenAPI document](https://skmtc.dev/particlehealth/apis/particle-health-api/revisions/b59a5413a488?raw)