Skip to main content
GET
/
medical
/
v1
/
patient
/
{patientId}
/
care-gaps
List Patient Care Gaps
curl --request GET \
  --url https://api.sandbox.metriport.com/medical/v1/patient/{patientId}/care-gaps \
  --header 'x-api-key: <api-key>'
Analytics must be enabled for your account to receive data from this endpoint. Contact us to get started.
Returns a paginated list of care gaps for the patient identified by patientId in the path. Each result is a FHIR Bundle with a Patient entry, a MeasureReport, and a Parameters resource with supporting calculation details. For more context on care gaps and how to interpret results, see the Care Gaps guide.

​
Path Params

​
patientId
string
required
The Metriport Patient ID.

​
Query Params

​
limit
number
Maximum number of results to return. Must be between 1 and 100. Defaults to 20.
​
offset
number
Number of results to skip for pagination. Must be 0 or greater. Defaults to 0.

​
Response

​
metadata
object
required
Pagination metadata.
​
results
Bundle[]
required
Array of FHIR Bundle resources. Each bundle contains a Patient, a MeasureReport, and a Parameters resource.
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": ["Alex"], "family": "Example" }
            ],
            "gender": "female",
            "birthDate": "1980-01-15"
          }
        },
        {
          "fullUrl": "urn:uuid:22222222-2222-2222-2222-222222222222",
          "resource": {
            "resourceType": "MeasureReport",
            "id": "BreastCancerScreening.00000000-0000-0000-0000-000000000000.2025-01-01",
            "status": "complete",
            "type": "individual",
            "measure": "http://ncqa.org/fhir/Measure/BreastCancerScreening",
            "subject": {
              "reference": "Patient/00000000-0000-0000-0000-000000000000"
            },
            "period": {
              "start": "2025-01-01",
              "end": "2025-12-31"
            },
            "extension": [
              {
                "url": "https://public.metriport.com/fhir/StructureDefinition/job-id",
                "valueString": "99999999-9999-9999-9999-999999999999"
              }
            ],
            "group": [
              {
                "id": "BreastCancerScreening",
                "code": {
                  "coding": [
                    {
                      "system": "https://ncqa.org/fhir/CodeSystem/measure-group",
                      "code": "BreastCancerScreening"
                    }
                  ]
                },
                "population": [
                  {
                    "code": {
                      "coding": [
                        {
                          "system": "https://ncqa.org/fhir/CodeSystem/measure-group",
                          "code": "initial-population"
                        }
                      ]
                    },
                    "count": 1
                  },
                  {
                    "code": {
                      "coding": [
                        {
                          "system": "https://ncqa.org/fhir/CodeSystem/measure-group",
                          "code": "denominator"
                        }
                      ]
                    },
                    "count": 1
                  },
                  {
                    "code": {
                      "coding": [
                        {
                          "system": "https://ncqa.org/fhir/CodeSystem/measure-group",
                          "code": "denominator-exclusion"
                        }
                      ]
                    },
                    "count": 0
                  },
                  {
                    "code": {
                      "coding": [
                        {
                          "system": "https://ncqa.org/fhir/CodeSystem/measure-group",
                          "code": "numerator"
                        }
                      ]
                    },
                    "count": 0
                  }
                ]
              }
            ]
          }
        },
        {
          "fullUrl": "urn:uuid:33333333-3333-3333-3333-333333333333",
          "resource": {
            "resourceType": "Parameters",
            "parameter": [
              {
                "name": "Age at end of measurement period",
                "valueInteger": 42
              },
              {
                "name": "Is continuously enrolled",
                "valueBoolean": true
              },
              {
                "name": "Mammography screening period",
                "valuePeriod": {
                  "start": "2023-10-01",
                  "end": "2025-12-31"
                }
              }
            ]
          }
        }
      ]
    }
  ]
}