PAparticlehealth
Patients

List Patients

Changed on
get/api/v2/patients

Request

  • Base URL
    https://sandbox.particlehealth.com
  • URL
    https://sandbox.particlehealth.com/api/v2/patients
  • Auth
    API key in header Authorization

Query parameters

continuation_tokenstring

Continuation Token

filter'signal_enrolled'

Filter patients. Supported value: signal_enrolled, which returns only patients enrolled in Signal monitoring. If your project monitors all patients, every patient in the project is returned.

Response

OK

continuation_tokenstring

Example response

{
  "patients": [
    {
      "date_of_birth": "1954-12-01",
      "expected_completion_time": "2024-05-10T16:11:52.002655Z",
      "external_patient_id": "pati-enti-d123-4567",
      "family_name": "Quark",
      "file_count": "2",
      "gender": "MALE",
      "given_name": "Kam",
      "particle_patient_id": "ppid-fewff3-323ev",
      "query_date": "2020-01-01",
      "query_id": "pati-enti-d123-4567",
      "query_status": "COMPLETED",
      "request_endpoint": "DELTAS"
    }
  ]
}

Changes

  • b59a5413a488Revision changes
    • info

      added the new optional query request parameter filter

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status