Skip to content

Latest commit

 

History

History
82 lines (59 loc) · 2.79 KB

start-document-query.mdx

File metadata and controls

82 lines (59 loc) · 2.79 KB
Raw
title description api
Start Document Query
Triggers a document query for the specified patient across HIEs.
POST /medical/v1/document/query

When executed, this endpoint triggers an asynchronous document query across HIEs. This is a two step process where the documents will first be downloaded from the respective HIE and, if they are C-CDA/XML, then converted to FHIR.

Each process (download, conversion) will contain its own total and status as well as the count for successful operations and errors.

When the asynchronous document query finishes, it stores new/updated document references for future requests and updates the status of download to completed. Meanwhile, in the background, files will be converted and the convert count will be incremented. Once all documents have been converted it too will be marked as completed.

If there's no document to be converted, the total will be set to zero and the status to completed.

Once each process completes, a webhook request will be sent to your configured URL containing the available data. Note: the webhooks will only contain updates for new data fetched in the current document query.

Webhook message types - see the respective section on the webhooks page for more details:

  • medical.document-download: contains the newly downloaded documents for the patient;
  • medical.document-conversion: result of converting the newly downloaded C-CDA documents into FHIR.
If you were to trigger this endpoint again while the query is still processing, you will get a response that reflects the current query progress. So essentially, only a single document query will be running for a patient at any given time.

Query Params

The ID of the Patient for which to list available Documents. The ID of the Facility where the patient is receiving care.

Body

Response

{
  "download": {
    "status": "processing"
  },
  "requestId": "018a80c4-292a-7486-a223-6dcbc636c44c"
}
```javascript Metriport SDK import { MetriportMedicalApi } from "@metriport/api-sdk";

const metriportClient = new MetriportMedicalApi("YOUR_API_KEY");

const metadata = { youCan: "putAny", stringKeyValue: "pairsHere", };

const status = await api.startDocumentQuery( "2.16.840.1.113883.3.666.5.2004.4.2005", "2.16.840.1.113883.3.666.123", metadata );

</ResponseExample>