Metriport home pagelight logo
Patient
Get Patient's Consolidated Data
GET

/medical/v1/patient/{id}/consolidated

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

​
Path Params

idrequired
string

The ID of the Patient.

​
Query Params

You can optionally filter resources by date, using the dateFrom and dateTo query params. Note that not all resources will support this filter - see the FHIR R4 docs for a list of supported resources.

resourcesoptional
string

A comma separated, case sensitive list of resources to be returned. If none are provided all resources will be included.

dateFromoptional
string

The start date (inclusive) for which to filter returned resources - formatted YYYY-MM-DD as per ISO 8601. If not provided, no start date filter will be applied.

dateTooptional
string

The end date (inclusive) for which to filter returned resources - formatted YYYY-MM-DD as per ISO 8601. If not provided, no end date filter will be applied.

You can scroll to the bottom of the page to view all available resources.

​
Response

Returns a Bundle that contains a property entry which is simply an array of FHIR resources.

{
  "resourceType": "Bundle",
  "total": 1,
  "type": "searchset",
  "entry": [
    {
      "id": 1234,
      "content": {
        "resourceType": "DocumentReference",
        "contained": [],
        "type": {
          "coding": [
            {
              "system": "http://loinc.org/",
              "code": "1234-1",
              "display": "HIV 1 and 2 tests - Meaningful Use set"
            }
          ]
        },
        "status": "current",
        "description": "Summarization Of Episode Notes - provided by Metriport",
        "mimeType": "application/pdf",
        "location": "https://www.w3.org/WAI/ER/tests/xhtml/testfiles/resources/pdf/dummy.pdf",
        "context": {
          "event": [
            {
              "coding": [
                {
                  "system": "http://snomed.info/sct",
                  "code": "62479008",
                  "display": "AIDS"
                }
              ]
            }
          ],
          "period": {
            "start": "2022-10-05T22:00:00Z",
            "end": "2022-10-05T23:00:00Z"
          }
        }
      }
    }
  ]
};

​
Available FHIR resources

This is the list of all available FHIR resources you can query for: