List Patient Suspects

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

import requests

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

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}/suspects', 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}/suspects",
  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}/suspects"

	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}/suspects")

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

GET

medical

patient

{patientId}

suspects

List Patient Suspects

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

import requests

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

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}/suspects', 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}/suspects",
  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}/suspects"

	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}/suspects")

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

Analytics must be enabled for your account to receive data from this endpoint. Contact us to get started.

Returns a paginated list of suspected conditions for the patient identified by patientId in the path. Each result is a FHIR Bundle that includes a Patient resource, the suspected Condition, and evidence resources (Observations, Procedures, MedicationRequests) that support the suspicion. For more context on suspecting and how to interpret results, see the Suspecting guide.

Path Params

string

required

The Metriport Patient ID.

Query Params

number

Maximum number of results to return. Must be between 1 and 100. Defaults to 20.

number

Number of results to skip for pagination. Must be 0 or greater. Defaults to 0.

Response

object

required

Pagination metadata.

Show metadata properties

number

required

Total number of suspected condition records matching the query for this patient.

number

required

The limit used for this request.

number

required

The offset used for this request.

Bundle[]

required

Array of FHIR Bundle resources. Each bundle contains a Patient, a Condition, and its supporting evidence.

Show Bundle properties

Patient

required

The patient this suspected condition applies to.

Show Patient properties

string

required

Always "Patient".

string

required

The Metriport patient id.

Identifier[]

Your system’s version of the patient id. Each entry uses Metriport’s external-id system and use: "secondary".

Show Identifier properties

string

required

The external id from your system.

string

required

Always https://public.metriport.com/fhir/StructureDefinition/external-id.json.

string

required

Always secondary.

HumanName[]

Name when present. Each entry may include given (string array) and/or family (string).

string

Administrative gender when present: male, female, other, or unknown (FHIR).

string

Date of birth as an ISO 8601 date (YYYY-MM-DD) when present.

Condition

required

The suspected condition.

Show Condition properties

string

required

Always "Condition".

string

required

The unique identifier for this suspected condition.

object

required

Show subject properties

string

required

Patient reference in the format Patient/{patientId}.

object

required

The ICD-10-CM coded condition.

Show code properties

Coding[]

required

Show Coding properties

string

required

Always "http://hl7.org/fhir/sid/icd-10-cm".

string

required

The ICD-10-CM code (e.g. "E11.9").

string

Human-readable condition name.

object

required

Always unconfirmed — the condition has been flagged as a potential suspect but has not been clinically confirmed.

Extension[]

required

Metriport-specific extensions summarizing the evidence.

Show Extension properties

string

required

URL: https://public.metriport.com/fhir/StructureDefinition/suspect-type. Either "suspect" (new suspected condition) or "recapture" (previously diagnosed condition requiring re-documentation).

integer

required

URL: https://public.metriport.com/fhir/StructureDefinition/evidence-count. Total number of supporting evidence records.

date

required

URL: https://public.metriport.com/fhir/StructureDefinition/first-evidence-date. Date of the earliest supporting evidence.

date

required

URL: https://public.metriport.com/fhir/StructureDefinition/last-evidence-date. Date of the most recent supporting evidence.

string

required

URL: https://public.metriport.com/fhir/StructureDefinition/hcc-code. The Hierarchical Condition Category code for this condition.

string

required

URL: https://public.metriport.com/fhir/StructureDefinition/job-id. The analytics job that produced this result.

ConditionEvidence[]

required

The suspected manifestations and their supporting evidence references.

Show ConditionEvidence properties

CodeableConcept[]

required

The suspect manifestation definition coded using the Metriport suspect-manifestation CodeSystem. Includes a human-readable text field describing the clinical rule.

Reference[]

References to the evidence resources in this bundle that support the suspicion.

Show Reference properties

string

required

Resource type (e.g. "Observation", "Procedure", "MedicationRequest").

string

required

Relative reference (e.g. "Observation/{id}").

Observation | Procedure | MedicationRequest

Evidence resources supporting the suspicion.

Show Observation properties

string

required

Always "Observation".

string

required

The unique identifier for this observation.

string

required

One of registered, preliminary, final, amended, corrected, cancelled, entered-in-error, or unknown.

object

required

The observation type. Uses LOINC where available, falling back to the source coding system.

Show code properties

Coding[]

required

One or more codings for the observation type.

string

The date/time the observation was recorded (ISO 8601).

object

The numeric result value.

Show valueQuantity properties

number

The numeric value.

string

The unit of measure (e.g. "mg/dL", "mL/min/1.73m2").

CodeableConcept[]

The observation category (e.g. laboratory, vital-signs).

CodeableConcept[]

Clinical interpretation of the result (e.g. H for high, L for low).

Annotation[]

Free-text notes associated with the observation.

object

Reference to the patient (present when a patientId filter is applied).

Show Procedure properties

string

required

Always "Procedure".

string

required

The unique identifier for this procedure.

string

required

One of preparation, in-progress, not-done, on-hold, stopped, completed, entered-in-error, or unknown.

object

required

The procedure type. Uses CPT and/or SNOMED-CT where available.

Show code properties

Coding[]

required

One or more codings for the procedure type.

string

The date the procedure was performed (ISO 8601).

object

Reference to the patient (present when a patientId filter is applied).

Show MedicationRequest properties

string

required

Always "MedicationRequest".

string

required

The unique identifier for this medication request.

string

required

One of active, on-hold, cancelled, completed, entered-in-error, stopped, draft, or unknown.

string

required

One of proposal, plan, order, original-order, reflex-order, filler-order, instance-order, or option. Defaults to "order".

object

required

The medication. Uses RxNorm and/or NDC where available.

Show medicationCodeableConcept properties

Coding[]

required

One or more codings for the medication.

string

The date the prescription was written (ISO 8601).

Dosage[]

Dosage instructions.

Show Dosage properties

object[]

Show doseAndRate properties

object

Show doseQuantity properties

number

The dose amount.

string

The dose unit.

object

When the medication should be administered.

object

Reference to the patient (present when a patientId filter is applied).

Response

{
  "metadata": {
    "total": 1,
    "limit": 20,
    "offset": 0
  },
  "results": [
    {
      "resourceType": "Bundle",
      "type": "collection",
      "entry": [
        {
          "fullUrl": "urn:uuid:11111111-1111-1111-1111-111111111111",
          "resource": {
            "resourceType": "Patient",
            "id": "00000000-0000-0000-0000-000000000000",
            "identifier": [
              {
                "value": "1234567890",
                "system": "https://public.metriport.com/fhir/StructureDefinition/external-id.json",
                "use": "secondary"
              }
            ],
            "name": [
              { "given": ["Sam"], "family": "Example" }
            ],
            "gender": "male",
            "birthDate": "1975-03-20"
          }
        },
        {
          "fullUrl": "urn:uuid:55555555-5555-5555-5555-555555555555",
          "resource": {
            "resourceType": "Condition",
            "id": "88888888-8888-8888-8888-888888888888",
            "subject": {
              "reference": "Patient/00000000-0000-0000-0000-000000000000"
            },
            "code": {
              "coding": [
                {
                  "system": "http://hl7.org/fhir/sid/icd-10-cm",
                  "code": "E11.9",
                  "display": "Type 2 diabetes mellitus without complications"
                }
              ]
            },
            "verificationStatus": {
              "coding": [
                {
                  "system": "http://terminology.hl7.org/CodeSystem/condition-ver-status",
                  "code": "unconfirmed",
                  "display": "Unconfirmed"
                }
              ]
            },
            "extension": [
              {
                "url": "https://public.metriport.com/fhir/StructureDefinition/suspect-type",
                "valueString": "suspect"
              },
              {
                "url": "https://public.metriport.com/fhir/StructureDefinition/evidence-count",
                "valueInteger": 3
              },
              {
                "url": "https://public.metriport.com/fhir/StructureDefinition/first-evidence-date",
                "valueDate": "2023-09-21"
              },
              {
                "url": "https://public.metriport.com/fhir/StructureDefinition/last-evidence-date",
                "valueDate": "2023-09-27"
              },
              {
                "url": "https://public.metriport.com/fhir/StructureDefinition/hcc-code",
                "valueString": "38"
              },
              {
                "url": "https://public.metriport.com/fhir/StructureDefinition/job-id",
                "valueString": "22222222-2222-2222-2222-222222222222"
              }
            ],
            "evidence": [
              {
                "code": [
                  {
                    "coding": [
                      {
                        "system": "https://public.metriport.com/fhir/CodeSystem/suspect-manifestation",
                        "code": "diabetes_fpg_126_199",
                        "display": "Diabetes (FPG 126-199 mg/dL)"
                      }
                    ],
                    "text": "Fasting glucose 126-199 mg/dL on two separate dates."
                  }
                ],
                "detail": [
                  {
                    "type": "Observation",
                    "reference": "Observation/33333333-3333-3333-3333-333333333333"
                  },
                  {
                    "type": "Observation",
                    "reference": "Observation/44444444-4444-4444-4444-444444444444"
                  }
                ]
              }
            ]
          }
        },
        {
          "fullUrl": "urn:uuid:66666666-6666-6666-6666-666666666666",
          "resource": {
            "resourceType": "Observation",
            "id": "33333333-3333-3333-3333-333333333333",
            "status": "final",
            "code": {
              "coding": [
                {
                  "system": "http://loinc.org",
                  "code": "1558-6"
                }
              ]
            },
            "effectiveDateTime": "2023-09-27",
            "valueQuantity": {
              "value": 141,
              "unit": "mg/dL"
            }
          }
        },
        {
          "fullUrl": "urn:uuid:77777777-7777-7777-7777-777777777777",
          "resource": {
            "resourceType": "Observation",
            "id": "44444444-4444-4444-4444-444444444444",
            "status": "final",
            "code": {
              "coding": [
                {
                  "system": "http://loinc.org",
                  "code": "1558-6"
                }
              ]
            },
            "effectiveDateTime": "2023-09-23",
            "valueQuantity": {
              "value": 152,
              "unit": "mg/dL"
            }
          }
        }
      ]
    }
  ]
}

Getting Started

API Reference

Handling Data

FHIR

API Tools

More Info

Legacy API Reference

List Patient Suspects

Path Params

Query Params

Response

​Path Params

​Query Params

​Response

Path Params

Query Params

Response