Query Completion Time

Overview

Particle enables customers to pull expected query completion time, per query. We understand that depending on a customer's use case, the turn-around-time needs for a patient's data will vary across customers. The existing /queries/{id} API gives customers visibility when a particular query is expected to complete given the variables that impact the query completion time.

Throughout this process, the main factor that impacts the query completion time is the number of documents retrieved for a patient. Because the HIEs and networks that Particle pulls data from do not have the ability to request patient data based on a time period, Particle may download and process thousands of documents for a patient, prolonging the query completion time.

Upon receiving a request for a patient's data, Particle queries the HIEs and networks to pull the data. During this step Particle is impacted by both the rate limits imposed by the HIEs and networks, and the rate limits imposed by the EMRs. Because Particle generally prioritizes data completeness over data speed when the requests to retrieve relevant patient documents time out, Particle conducts multiple retries to retrieve all data that it can possibly pull for the patient.

Once all of the relevant patient documents are retrieved, Particle converts the XML CCDAs to FHIR. Depending on a customer's configuration for additional data processing, e.g. deduplication, normalization, etc., Particle will then go through the additional data processing.

Once all data processing has completed, Particle uploads the data to the FHIR store (if being used by the customer). If configured for a customer, Particle will also convert the data into Particle's FLAT data format and/or display the data in the Particle UI.

Ultimately, patient requests that result in less documents process and complete quicker than patient requests that result in thousands of documents.

API

Customers can pull the query completion time for all query methods i.e. CCDA, FHIR, FLAT, DELTA. Expected query completion times are based on the number of files pulled for the patient. Note the fields 'start_time'and expected_completion_time.

Added two new fields to the existing API response!

We added two new fields to the existing API response; the rest of the fields remain as before.

Example Request

/api/v1/queries/{id}

Example Response

{  
  "demographics": {  
    "address_city": "Brooklyn",  
    "address_lines": [  
      "999 Dev Drive"  
    ],  
    "address_state": "New York",  
    "date_of_birth": "1954-12-01",  
    "email": "[[email protected]](mailto:[email protected])",  
    "family_name": "Quark",  
    "gender": "MALE",  
    "given_name": "Kam",  
    "hints": [  
      "11111"  
    ],  
    "npi": "9876543210",  
    "patient_id": "string",  
    "postal_code": "11111",  
    "purpose_of_use": "TREATMENT",  
    "specialties": [  
      "ONCOLOGY"  
    ],  
    "ssn": "123-45-6789",  
    "telephone": "234-567-8910"  
  },  
  "expected_completion_time": "2020-01-01T00:00:00Z",  
  "files": [  
    {  
      "authenticator": "Jane Doe MD",  
      "author_name": "John Doe",  
      "author_organization": "Particle Health",  
      "class_code": "72170-4",  
      "confidentiality_code": "N",  
      "creation_time": "2020-01-01T00:00:00Z",  
      "event_code": "AMB",  
      "file_size": 2454,  
      "format_code": "urn:ihe:iti:xds:2017:mimeTypeSufficient",  
      "healthcare_facility_type_code": "35971002",  
      "id": "ac53cf7c-77ff-434f-8aa3-5966bc5c10ae",  
      "language_code": "en-US",  
      "practice_setting_code": "132",  
      "service_start_time": "2020-01-01T00:00:00Z",  
      "service_stop_time": "2020-01-01T00:00:00Z",  
      "status_code": "current",  
      "title": "Medical Summary",  
      "type": "application/xml",  
      "type_code": "34133-9",  
      "url": "/api/v1/files/4bcd32df-a013-432f-a56a-c8a8705f6653/ac53cf7c-77ff-434f-8aa3-5966bc5c10ae"  
    }  
  ],  
  "id": "4bcd32df-a013-432f-a56a-c8a8705f6653",  
  "start_time": "2020-01-01T00:00:00Z",  
  "state": "COMPLETE"  
}\`