Document
Get Document Query Status
Returns the document query status for the specified patient.
GET
/medical/v1/document/query
x-api-key*
curl --request GET \
--url https://api.sandbox.metriport.com/medical/v1/document/query \
--header 'x-api-key: <x-api-key>'
Returns the document query status and a request ID for the specified patient - use this to check the progress of the document query.
See more on Start Document Query.
To get updates about the document query progress, including download and conversion status, check out our webhooks guide.
Query Params
patientIdrequired
string
The ID of the Patient for which to return the status of document querying across HIEs.
Response
download
Progress
convert
Progress
requestId
string
The ID of your request. This can be referenced for support.
{
"download": {
"status": "completed",
"total": 100,
"successful": 95,
"errors": 5
},
"convert": {
"status": "processing",
"total": 20,
"successful": 15,
"errors": 1
},
"requestId": "018a80c4-292a-7486-a223-6dcbc636c44c"
}
import { MetriportMedicalApi } from "@metriport/api-sdk";
const metriportClient = new MetriportMedicalApi("YOUR_API_KEY");
const status = await api.getDocumentQueryStatus(
"2.16.840.1.113883.3.666.5.2004.4.2005"
);
curl --request GET \
--url https://api.sandbox.metriport.com/medical/v1/document/query \
--header 'x-api-key: <x-api-key>'
import { MetriportMedicalApi } from "@metriport/api-sdk";
const metriportClient = new MetriportMedicalApi("YOUR_API_KEY");
const status = await api.getDocumentQueryStatus(
"2.16.840.1.113883.3.666.5.2004.4.2005"
);