Collect Flat Datasets

get https://sandbox.particlehealth.com/flat/{id}/collect-data

Path Params

string

required

Flat Patient ID

Query Params

ALLERGIES

string

Optional query parameter for filtering ALLERGIES dataset. Does not require a value.

COMPOSITIONS

string

Optional query parameter for filtering COMPOSITIONS dataset. Does not require a value.

COVERAGES

string

Optional query parameter for filtering COVERAGES dataset. Does not require a value.

DOCUMENT_REFERENCES

string

Optional query parameter for filtering DOCUMENT_REFERENCES dataset. Does not require a value.

ENCOUNTERS

string

Optional query parameter for filtering ENCOUNTERS dataset. Does not require a value.

FAMILY_MEMBER_HISTORIES

string

Optional query parameter for filtering FAMILY_MEMBER_HISTORIES dataset. Does not require a value.

IMMUNIZATIONS

string

Optional query parameter for filtering IMMUNIZATIONS dataset. Does not require a value.

LABS

string

Optional query parameter for filtering LABS dataset. Does not require a value.

LOCATIONS

string

Optional query parameter for filtering LOCATIONS dataset. Does not require a value.

MEDICATIONS

string

Optional query parameter for filtering MEDICATIONS dataset. Does not require a value.

MEDRECS

string

Optional query parameter for filtering MEDRECS dataset. Does not require a value.

ORGANIZATIONS

string

Optional query parameter for filtering ORGANIZATIONS dataset. Does not require a value.

PRACTITIONERS

string

Optional query parameter for filtering PRACTITIONERS dataset. Does not require a value.

PATIENTS

string

Optional query parameter for filtering PATIENTS dataset. Does not require a value.

PROBLEMS

string

Optional query parameter for filtering PROBLEMS dataset. Does not require a value.

PROCEDURES

string

Optional query parameter for filtering PROCEDURES dataset. Does not require a value.

PROVENANCES

string

Optional query parameter for filtering PROVENANCES dataset. Does not require a value.

RELATED_PERSONS

string

Optional query parameter for filtering RELATED_PERSONS dataset. Does not require a value.

SOCIAL_HISTORIES

string

Optional query parameter for filtering SOCIAL_HISTORIES dataset. Does not require a value.

VITAL_SIGNS

string

Optional query parameter for filtering VITAL_SIGNS dataset. Does not require a value.

Responses

Response body

object

allergies

array of objects

allergies

object

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

array of objects

composition

object

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

array of objects

coverages

object

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

array of objects

documentReferences

object

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

array of objects

encounters

object

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

array of objects

familyMemberHistories

object

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

array of objects

immunizations

object

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

array of objects

labs

object

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

array of objects

locations

object

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

medRecs

array of objects

medRecs

object

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

array of objects

medications

object

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

array of objects

organizations

object

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

array of objects

patients

object

address_city

string

required

The patient's home city.

address_lines

array of strings

The patient's home street address. This should not include the patient's city, state, or zip code.

address_lines

address_state

string

required

The patient's home state.

consent

array of objects

The patient's consent information.

consent

object

consent_date

string

required

partner

string

required

permission

string

required

permit deny

date_of_birth

string

required

The patient's date of birth, this field is required and must be of the format YYYY-MM-DD.

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

array of objects

practitioners

object

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

array of objects

problems

object

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

array of objects

procedures

object

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

array of objects

provenances

object

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

array of objects

relatedPersons

object

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

array of objects

socialHistories

object

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

array of objects

vitalSigns

object

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

Language

Credentials

Header


xxxxxxxxxx
1
curl --request GET \
2
     --url https://sandbox.particlehealth.com/flat/id/collect-data \
3
     --header 'accept: application/json'

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200OK

400Bad Request

401Unauthorized

403Forbidden

404Not Found

406Not Acceptable

500Internal Server Error