Get Single Consolidated Data Query Status

curl --request GET \
  --url https://api.sandbox.metriport.com/medical/v1/patient/{patientId}/consolidated/query/{requestId} \
  --header 'x-api-key: <api-key>'

import requests

url = "https://api.sandbox.metriport.com/medical/v1/patient/{patientId}/consolidated/query/{requestId}"

headers = {"x-api-key": "<api-key>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {'x-api-key': '<api-key>'}};

fetch('https://api.sandbox.metriport.com/medical/v1/patient/{patientId}/consolidated/query/{requestId}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.sandbox.metriport.com/medical/v1/patient/{patientId}/consolidated/query/{requestId}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "x-api-key: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.sandbox.metriport.com/medical/v1/patient/{patientId}/consolidated/query/{requestId}"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("x-api-key", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.sandbox.metriport.com/medical/v1/patient/{patientId}/consolidated/query/{requestId}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["x-api-key"] = '<api-key>'

response = http.request(request)
puts response.read_body

import { MetriportMedicalApi } from "@metriport/api-sdk";

const metriport = new MetriportMedicalApi(apiToken);

const status =
  await metriport.getSingleConsolidatedQueryStatus(
    patientId,
    requestId
  );

GET

medical

patient

{patientId}

consolidated

query

{requestId}

Get Single Consolidated Data Query Status

curl --request GET \
  --url https://api.sandbox.metriport.com/medical/v1/patient/{patientId}/consolidated/query/{requestId} \
  --header 'x-api-key: <api-key>'

import requests

url = "https://api.sandbox.metriport.com/medical/v1/patient/{patientId}/consolidated/query/{requestId}"

headers = {"x-api-key": "<api-key>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {'x-api-key': '<api-key>'}};

fetch('https://api.sandbox.metriport.com/medical/v1/patient/{patientId}/consolidated/query/{requestId}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.sandbox.metriport.com/medical/v1/patient/{patientId}/consolidated/query/{requestId}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "x-api-key: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.sandbox.metriport.com/medical/v1/patient/{patientId}/consolidated/query/{requestId}"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("x-api-key", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.sandbox.metriport.com/medical/v1/patient/{patientId}/consolidated/query/{requestId}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["x-api-key"] = '<api-key>'

response = http.request(request)
puts response.read_body

import { MetriportMedicalApi } from "@metriport/api-sdk";

const metriport = new MetriportMedicalApi(apiToken);

const status =
  await metriport.getSingleConsolidatedQueryStatus(
    patientId,
    requestId
  );

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

Path Params

string

required

The ID of the Patient.

string

required

The ID of consolidated query request.

Response

Returns the status of the specified query.

import { MetriportMedicalApi } from "@metriport/api-sdk";

const metriport = new MetriportMedicalApi(apiToken);

const status =
  await metriport.getSingleConsolidatedQueryStatus(
    patientId,
    requestId
  );

string

required

The ID of the request.

string

required

The status of the request. Can be one of processing, completed, or failed.

string

required

The format of the resulting data. Can be one of pdf, html, or json.

string

The date and time the request was started - formatted YYYY-MM-DDTHH:MM:SSZ as per ISO 8601.

string[]

Comma-separated list of resource types.

string

The start date (inclusive) for which to filter resources to count - formatted YYYY-MM-DD as per ISO 8601.

string

The end date (inclusive) for which to filter resources to count - formatted YYYY-MM-DD as per ISO 8601.

{
  "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"
}

Start Consolidated Data Query Get Consolidated Data Query Status

⌘I

Getting Started

API Reference

Handling Data

FHIR

API Tools

More Info

Legacy API Reference

Get Single Consolidated Data Query Status

Path Params

Response

​Path Params

​Response

Path Params

Response