API Reference
Handling Data
FHIR
More Info
Legacy API Reference
List Patient Suspects
curl --request GET \
--url https://api.sandbox.metriport.com/medical/v1/patient/{patientId}/suspects \
--header 'x-api-key: <api-key>'Suspects
List Patient Suspects
Lists suspected conditions for a single patient as FHIR Bundles (analytics).
GET
/
medical
/
v1
/
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>'Analytics must be enabled for your account to receive data
from this endpoint. Contact
us to get started.
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
The Metriport Patient ID.
Query Params
Maximum number of results to return. Must be between 1 and
100. Defaults to
20.Number of results to skip for pagination. Must be 0 or
greater. Defaults to
0.Response
Array of FHIR Bundle resources. Each bundle contains a
Patient, a Condition, and its supporting evidence.Show Bundle properties
Show Bundle properties
The patient this suspected condition applies to.
Show Patient properties
Show Patient properties
Always
"Patient".The Metriport patient id.
Your system’s version of the patient id. Each entry uses
Metriport’s external-id system and
use: "secondary".Name when present. Each entry may include
given (string
array) and/or family (string).Administrative gender when present:
male, female,
other, or unknown (FHIR).Date of birth as an ISO 8601 date (
YYYY-MM-DD) when
present.The suspected condition.
Show Condition properties
Show Condition properties
Always
"Condition".The unique identifier for this suspected condition.
Show subject properties
Show subject properties
Patient reference in the format
Patient/{patientId}.Always
unconfirmed — the condition has been flagged as a potential suspect but has not been clinically confirmed.Metriport-specific extensions summarizing the evidence.
Show Extension properties
Show Extension properties
URL:
https://public.metriport.com/fhir/StructureDefinition/suspect-type. Either "suspect" (new suspected condition) or "recapture" (previously diagnosed condition requiring re-documentation).URL:
https://public.metriport.com/fhir/StructureDefinition/evidence-count. Total number of supporting evidence records.URL:
https://public.metriport.com/fhir/StructureDefinition/first-evidence-date. Date of the earliest supporting evidence.URL:
https://public.metriport.com/fhir/StructureDefinition/last-evidence-date. Date of the most recent supporting evidence.URL:
https://public.metriport.com/fhir/StructureDefinition/hcc-code. The Hierarchical Condition Category code for this condition.URL:
https://public.metriport.com/fhir/StructureDefinition/job-id. The analytics job that produced this result.The suspected manifestations and their supporting evidence references.
Show ConditionEvidence properties
Show ConditionEvidence properties
The suspect manifestation definition coded using the Metriport
suspect-manifestation CodeSystem. Includes a human-readable text field describing the clinical rule.Evidence resources supporting the suspicion.
Show Observation properties
Show Observation properties
Always
"Observation".The unique identifier for this observation.
One of
registered, preliminary, final, amended, corrected, cancelled, entered-in-error, or unknown.The observation type. Uses LOINC where available, falling back to the source coding system.
Show code properties
Show code properties
One or more codings for the observation type.
The date/time the observation was recorded (ISO 8601).
The observation category (e.g.
laboratory, vital-signs).Clinical interpretation of the result (e.g.
H for high, L for low).Free-text notes associated with the observation.
Reference to the patient (present when a
patientId filter is applied).Show Procedure properties
Show Procedure properties
Always
"Procedure".The unique identifier for this procedure.
One of
preparation, in-progress, not-done, on-hold, stopped, completed, entered-in-error, or unknown.The procedure type. Uses CPT and/or SNOMED-CT where available.
Show code properties
Show code properties
One or more codings for the procedure type.
The date the procedure was performed (ISO 8601).
Reference to the patient (present when a
patientId filter is applied).Show MedicationRequest properties
Show MedicationRequest properties
Always
"MedicationRequest".The unique identifier for this medication request.
One of
active, on-hold, cancelled, completed, entered-in-error, stopped, draft, or unknown.One of
proposal, plan, order, original-order, reflex-order, filler-order, instance-order, or option. Defaults to "order".The medication. Uses RxNorm and/or NDC where available.
Show medicationCodeableConcept properties
Show medicationCodeableConcept properties
One or more codings for the medication.
The date the prescription was written (ISO 8601).
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"
}
}
}
]
}
]
}
⌘I
Assistant
Responses are generated using AI and may contain mistakes.