--- title: "Get Deltas Query Status" method: GET path: "/deltas/{particle_patient_id}" tags: ["Deltas"] --- # Get Deltas Query Status `GET /deltas/{particle_patient_id}` ## Request - Base URL: `https://sandbox.particlehealth.com` - URL: `https://sandbox.particlehealth.com/deltas/{particle_patient_id}` - Auth: API key in header `Authorization` Returns the patient's latest completed Deltas query, or `404` if none has completed yet. ## Path parameters - `particle_patient_id` string, required ## Response `200` OK - ApiQuery - `demographics` ApiDemographics - `address_city` string: 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: The patient's home state. - `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. - `encounter_date` string: Encounter Date for which this query is being made - `encounter_type` string: Encounter Type for which this query is being made - `family_name` string: 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: The patient's given name (first name), this field is required. - `hints` string[]: Postal codes hinting at the believed location of records. - `npi` string: The National Provider Identifier of the provider that this request is being made by. - `patient_id` string: The unique patient id in an external system - `postal_code` string: The patient's home postal (zip) code. - `purpose_of_use` string, required: The purpose of use for which this request is being made - `specialties` string[]: The list of specialty searches requested for this patient - `ssn` string: The patient's social security number, must be a valid US social security number. - `telephone` string: The patient's telephone number. - `expected_completion_time` string - `files` ApiFile[] - `authenticator` string: Authenticator represents a participant who has attested to the accuracy of the document, but who does not have privileges to legally authenticate the document. - `author_name` string: Author Name provided by the source system - `author_organization` string: Author Organization provided by the source system. - `class_code` string: The code specifying the high-level kind of document (e.g. Prescription, Discharge Summary, Report, etc.). Reference - https://www.hl7.org/fhir/r4/valueset-document-classcodes.html - `confidentiality_code` string: The code specifying the security classification of the document. Reference -https://terminology.hl7.org/2.1.0/CodeSystem-v3-Confidentiality.html - `creation_time` string: The timestamp representing when the document was created. In the format of RFC3339 - `event_code` string: The code specifying the event that resulted in the document being created. Reference - https://www.hl7.org/fhir/valueset-event-codes.html - `file_size` integer: Size in bytes of the file. - `file_source` string: FileSource indicates the source network of the file. - `format_code` string: The code specifying the technical format of the document. Reference - https://build.fhir.org/ig/IHE/FormatCode/CodeSystem-formatcode.html - `healthcare_facility_type_code` string: The code specifying the type of organizational setting of the clinical encounter during which the documented act occurred. Reference - https://www.hl7.org/fhir/valueset-c80-facilitycodes.html - `id` string: Unique ID of the file generated by Particle. - `language_code` string: Language of the document. Reference - https://build.fhir.org/valueset-languages.html - `practice_setting_code` string: The code specifying the clinical specialty where the act that resulted in the document was performed (e.g., Family Practice, Laboratory, Radiology). Reference - https://www.hl7.org/fhir/valueset-c80-practice-codes.html - `service_start_time` string: The start time of the service being documented. In the format of RFC3339 - `service_stop_time` string: The stop time of the service being documented. In the format of RFC3339 - `status_code` string: StatusCode indicates the current status of this document. - `title` string: Title of the file as provided by the source system. - `type` string: Mime Type of the file. - `type_code` string: The code specifying the precise type of document from the user perspective (e.g., LOINC code). Reference - https://www.hl7.org/fhir/r4/valueset-doc-typecodes.html - `url` string: URL path to retrieve the file from. - `id` string, required - `particle_patient_id` string - `start_time` string - `state` string, required ## Other responses - `400`: Bad Request - `401`: Unauthorized - `404`: Not Found - `500`: Internal Server Error ## Changes - **2026-11-03** `b59a5413a488`: 1 breaking, 4 info - removed the success response with the status `202` - added the optional property `error_code` to the response with the `400` status - added the optional property `error_code` to the response with the `401` status - added the optional property `error_code` to the response with the `404` status - …1 more [Operation history](https://skmtc.dev/particlehealth/apis/particle-health-api/changes/deltas/:particle_patient_id/get.md) --- [API](https://skmtc.dev/particlehealth/apis/particle-health-api.md) - [All operations](https://skmtc.dev/particlehealth/apis/particle-health-api/llms.txt) - [OpenAPI document](https://skmtc.dev/particlehealth/apis/particle-health-api/revisions/b59a5413a488?raw)