Skip to main content
GET
Read connected insurance and health records

Authorizations

Authorization
string
header
required

OAuth 2.1 with PKCE

Query Parameters

section
enum<string>
default:summary

Which slice to return. summary is the cheap overview with counts; everything returns all sections at once (large).

Available options:
summary,
coverage,
conditions,
medications,
allergies,
immunizations,
labs,
vitals,
visits,
claims,
everything
offset
integer
default:0

Row offset for paging a truncated view (ignored for summary)

Required range: x >= 0

Response

The requested section

Shape varies by section. Besides the named fields, each section contributes view blocks keyed by view name (coverage, coverage_class, problems, medication_request, allergies, immunizations, encounters, claims_header, ...), all with the capped-view shape { count, truncated?, showing?, nextOffset?, rows[] }, rows newest-first, count = the true total even when rows were capped.

section
string
connected
boolean

Only present (false) when no insurance is connected; offer POST /api/health-records/link.

message
string
howToConnect
string
connection
object

Insurance connection and sync state

demographics
object | null

Patient demographics row (summary, coverage, everything)

recordCounts
object

summary only, record count per category

note
string
sections
object

everything only, every category block keyed by section name