Skip to main content
GET
/
medical
/
v1
/
patient
/
{patientId}
/
consolidated
/
query
Get Consolidated Data Query Status
curl --request GET \
  --url https://api.sandbox.metriport.com/medical/v1/patient/{patientId}/consolidated/query \
  --header 'x-api-key: <api-key>'
import { MetriportMedicalApi } from "@metriport/api-sdk";

const metriport = new MetriportMedicalApi(apiToken);

const status = await metriport.getConsolidatedQueryStatus(patientId);

Documentation Index

Fetch the complete documentation index at: https://docs.metriport.com/llms.txt

Use this file to discover all available pages before exploring further.

This endpoint returns all the queries that are currently in progress. To return the status of a single query, see Get Single Consolidated Data Query Status. To trigger a new query you can start a consolidated query.

​
Path Params

​
patientId
string
required
The ID of the Patient.

​
Response

Returns the status of the last query for consolidated data performed for the given patient. 
import { MetriportMedicalApi } from "@metriport/api-sdk";

const metriport = new MetriportMedicalApi(apiToken);

const status = await metriport.getConsolidatedQueryStatus(patientId);
​
queries
ConsolidatedQuery[]
required
​
message
string
An optional message for the request.
{
  "queries": [
    {
      "requestId": "5f4b3b4b-4b3b-4b3b-4b3b-4b3b4b3b4b3b",
      "status": "processing",
      "startedAt": "2021-01-01T00:00:00Z",
      "dateFrom": "2021-01-01",
      "dateTo": "2021-01-31",
      "resources": ["Observation", "MedicationRequest"],
      "conversionType": "pdf"
    },
    {
      "requestId": "1a2b3c4d-5e6f-7a8b-9c0d-1e2f3a4b5c6d",
      "status": "completed",
      "startedAt": "2023-01-01T00:00:00Z",
      "dateFrom": "2023-01-01",
      "dateTo": "2023-01-31",
      "resources": ["MedicationRequest"],
      "conversionType": "html"
    }
  ],
  "message": "Trigger a new query by POST /patient/:id/consolidated/query; data will be sent through Webhook"
}