Overview

Reports are distinct representations of electronic health records. Different reports are designed to serve different use cases. Human readable reports are available in PDF or HTML while reports for programmatic use cases are available as JSON.

Reports are compiled shortly after we get an authorization from an individual and retrieve the data from their healthcare providers.

📘

How to use reports and the reports endpoint

Please see the PDF attachment in the guide

To retrieve information on the user's available reports, query the /medical/reports/ endpoint:

GET https://api.humanapi.co/v1/human/medical/reports

To retrieve the contents of a specific report, query the /human/medical/reports/{{idOfReport}}/raw?format=json endpoint like so:

GET https://api.humanapi.co/v1/human/medical/reports/631842b9075d9b00110b61c7-000000-000000000000000000000000/raw?format=json

Types of available reports and formats

Code

Description

Available Formats

unity

Health Summary

A concise longitudinal view of the patient's key medical data that is divided into sections including:

  • Demographics, social history, list of prescriptions, conditions, procedures and vitals.
  • List of Encounters including reason for visit and associated diagnoses for in-person and remote care.
  • Test results.

This report is built separately for each healthcare provider. Each provider authorized by the end consumer will have their own report.

JSON
HTML
PDF

healthcheck

Health Summary

Provides a summary of profile and health measurements related to test results. Organizes results by chemistries, cardiovascular risk, BMI, blood pressure, lipid panel.

JSON
HTML
PDF

highlights

Health Summary

Provides a summary of profile and health measurements. Organizes results by test results, social history and key conditions.

JSON
HTML
PDF

ccdraw

Complete medical record

The entire medical record of a patient , directly rendered from the CCD-A documents. This report renders the data as close as it can get to the original charts retrieved from the source EHR.

This report is generated only when the user connects a data source that provides CCDA files. It’s typically not available from pharmacies or independent lab networks.

This report is built separately for each healthcare provider. Each provider authorized by the end consumer may have their own report.

HTML
PDF

apidata

Bulk export of the clinical API

This report aggregates the output of the main clinical API endpoints for a given individual. It’s equivalent to calling all the ​Clinical API​ endpoints (except ccd and narratives) and concatenating the responses together.

JSON

timeline

Chronological health history

This is a longitudinal view of a user’s data organized in a timeline.

JSON

covid

Condition check

The COVID-19 report is an extract of the patient’s medical records including findings related to COVID-19 illness.

JSON