v1

latestOpenAPI 3.0.0Apache 2.02026-07-246175132.0 KB
Flat

Collect Flat Datasets

Query parameter filtering is not included by default. If you require access, please contact support@particlehealth.com.

get/flat/{id}/collect-data

Path parameters

idstring required

Query ID

Query parameters

ALLERGIESstring

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

COMPOSITIONSstring

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

COVERAGESstring

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

DOCUMENT_REFERENCESstring

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

ENCOUNTERSstring

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

FAMILY_MEMBER_HISTORIESstring

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

IMMUNIZATIONSstring

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

LABSstring

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

LOCATIONSstring

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

MEDICATIONSstring

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

MED_FILLSstring

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

MEDRECSstring

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

ORGANIZATIONSstring

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

PRACTITIONERSstring

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

PATIENTSstring

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

PROBLEMSstring

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

PROCEDURESstring

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

PROVENANCESstring

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

RELATED_PERSONSstring

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

SOCIAL_HISTORIESstring

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

TRANSITIONSstring

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

VITAL_SIGNSstring

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

Response

OK

Example response

{
  "patients": [
    {
      "address_city": "Brooklyn",
      "address_lines": [
        "999 Dev Drive"
      ],
      "address_state": "New York",
      "consent": [
        {
          "consent_date": "2021-01-01",
          "partner": "Healthix",
          "permission": "permit"
        }
      ],
      "date_of_birth": "1954-12-01",
      "email": "john@doe.com",
      "family_name": "Quark",
      "gender": "MALE",
      "given_name": "Kam",
      "particle_patient_id": "1aa50979-1a8e-416d-8c13-a529033cc898",
      "patient_id": "pati-enti-d123-4567",
      "postal_code": "11111",
      "ssn": "123-45-6789",
      "telephone": "234-567-8910"
    }
  ]
}