--- 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` **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` string, required ## Query parameters - `_since` string - `resource_type` 'ALLERGIES' | 'COMPOSITIONS' | 'COVERAGES' | 'DOCUMENT_REFERENCES' | 'ENCOUNTERS' | 'FAMILY_MEMBER_HISTORIES' | 'IMMUNIZATIONS' | 'LABS' | 'LOCATIONS' | 'MEDICATIONS' | 'ORGANIZATIONS' | 'PRACTITIONERS' | 'PATIENTS' | 'PROBLEMS' | 'PROCEDURES' | 'SOCIAL_HISTORIES' | 'TRANSITIONS' | 'VITAL_SIGNS' - `resource_id` string ## Response `200` OK - ApiDatasets - `allergies` ApiAllergy[] - `allergy_code` 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_system` string - `recorded_date` string - `composition` ApiComposition[] - `composition_all_allergy_ids` string - `composition_all_document_reference_ids` string - `composition_all_encounter_ids` string - `composition_all_immunization_ids` string - `composition_all_lab_ids` string - `composition_all_location_ids` string - `composition_all_medication_statements_ids` string - `composition_all_practitioner_role_ids` string - `composition_all_problem_ids` string - `composition_all_procedure_ids` string - `composition_all_social_history_ids` string - `composition_all_vital_sign_ids` string - `composition_custodian_organization_id` string - `composition_date` string - `composition_encounter_id` string - `composition_event` string - `composition_event_code` string - `composition_event_code_system` string - `composition_event_encounter_reference_id` string - `composition_event_period_end` string - `composition_event_period_start` string - `composition_id` string - `composition_original_file_name` string - `composition_title` string - `composition_type` string - `composition_type_code` string - `composition_type_code_system` string - `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_coding` string - `document_reference_type_coding_system` string - `encounter_reference_id` string - `patient_id` string - `practitioner_role_reference_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_system` string - `encounter_type_name` string - `hospitalization_discharge_disposition` string - `location_id_references` string - `patient_id` string - `practitioner_role_id_references` 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_system` string - `immunization_dosage_unit` string - `immunization_dosage_value` number - `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 - `labs` ApiLab[] - `diagnostic_interpreter_practitioner_role_reference_id` string - `diagnostic_performer_practitioner_role_reference_id` string - `diagnostic_report_id` string - `diagnostic_report_name` string - `lab_code` string - `lab_code_system` string - `lab_interpretation` string - `lab_name` string - `lab_observation_id` string - `lab_text` string - `lab_timestamp` string - `lab_unit` string - `lab_unit_quantity` string - `lab_value` string - `lab_value_boolean` string - `lab_value_code` string - `lab_value_code_system` string - `lab_value_quantity` string - `lab_value_string` string - `observation_category` string - `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 - `medFills` ApiMedFill[] - `code_list_qualifier` string - `days_supply` string - `directions` string - `last_filled_date` string - `medication_statement_id` string - `medication_statement_start_time` string - `ndc_code` string - `patient_id` string - `potency_unit_code` string - `product_code` string - `record_id` string - `refills_qualifier` string - `refills_value` string - `rxcui` string - `sold_date` string - `strength` string - `strength_code` string - `strength_source_code` string - `subject_patient_id` string - `substitutions` string - `unit_source_code` string - `version` string - `written_date` string - `medRecs` ApiMedRec[] - `brand_name` string - `class_1_code` string - `class_1_name` string - `class_2_code` string - `class_2_name` string - `class_3_code` string - `class_3_name` string - `class_4_code` string - `class_4_name` string - `drug_name` string - `generic_name` string - `med_rec_id` string - `medication_id` string - `medication_reference` string - `medication_resource_type` string - `medication_statement_id` string - `normalized_package_ndc` string - `package_ndc` string - `patient_id` string - `product_ndc` string - `rxcui` string - `medications` ApiMedication[] - `medication_code` string - `medication_code_system` 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 - `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 - `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` ApiPatient[] - `address_city` string, required — The patient's home city. - `address_lines` string[] — The patient's home street address. This should not include the patient's city, state, or zip code. - `address_state` string, required — The patient's home state. - `consent` ApiConsent[] — The patient's consent information. - `consent_date` string, required - `partner` string, required - `permission` 'permit' | 'deny', required - `date_of_birth` string, required — The patient's date of birth, this field is required and must be of the format YYYY-MM-DD. - `email` string — The patient's email, must be a valid email address. - `family_name` string, required — The patient's family name (last name), this field is required. - `gender` string, required — The patient's gender, must be either FEMALE or MALE. - `given_name` string, required — The patient's given name (first name), this field is required. - `particle_patient_id` string — The Particle Assigned Patient ID. Output only. - `patient_id` string, required — The unique patient id in an external system. - `postal_code` string, required — The patient's home postal (zip) code. - `ssn` string — The patient's social security number, must be a valid US social security number. - `telephone` string — The patient's telephone number. - `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_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 - `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_system` string - `procedure_date_time` string - `procedure_id` string - `procedure_name` string - `procedure_reason` string - `procedure_reason_code` string - `procedure_reason_code_system` string - `procedure_text` string - `provenances` ApiProvenance[] - `patient_id` string - `provenance_activity_code` string - `provenance_activity_code_system` string - `provenance_agent_type_code` string - `provenance_agent_type_code_system` string - `provenance_entity_role` string - `provenance_entity_what_display` string - `provenance_entity_what_identifier` string - `provenance_id` string - `provenance_target` string - `provenance_who` string - `recorded_date` string - `relatedPersons` ApiRelatedPerson[] - `patient_id` string - `project_id` string - `related_person_address_city` string - `related_person_address_country` string - `related_person_address_lines` string - `related_person_address_postal_code` string - `related_person_address_state` string - `related_person_address_use` string - `related_person_id` string - `related_person_identifier_system` string - `related_person_identifier_value` string - `related_person_name` string - `related_person_patient_reference_id` string - `related_person_period_end` string - `related_person_period_start` string - `related_person_relationship_code` string - `related_person_relationship_display` string - `related_person_relationship_system` string - `related_person_telecom_system` string - `related_person_telecom_value` string - `socialHistories` ApiSocialHistory[] - `observation_category` string - `patient_id` string - `practitioner_role_reference_id` string - `social_history_observation_code` 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 - `vitalSigns` ApiVitalSign[] - `observation_category` string - `patient_id` string - `vital_sign_grouping_observation_id` string - `vital_sign_observation_code` 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 ## Other responses - `400` — Bad Request - `401` — Unauthorized - `403` — Forbidden - `404` — Not Found - `406` — Not Acceptable - `500` — Internal Server Error --- [API](https://skmtc.net/particlehealth/apis/particle-health-api.md) · [All operations](https://skmtc.net/particlehealth/apis/particle-health-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/particlehealth/particle-health-api/revisions/5aead0b7515e/schema)