Skip to main content
Insurance connections are optional. The profile lists every connection by patient, source, and status. A patient can have multiple insurer connections, and dependents can have their own connections.

connect_insurance

Starts an insurance connection and returns a user-facing url, expiresIn, notice, and next. Relay the notice before the user opens the link. After sign-in, records import in the background and the connection appears in get_user_profile.connections. The same call can connect another insurer, connect a dependent using patientId, or renew consent for a connection with expired or failed status.

Example response

disconnect_connection

Requires connectionId, taken from get_user_profile.connections. It revokes access at the source and removes records imported through that connection; other connections are unaffected. Confirm with the user before disconnecting. The result contains disconnected and connectionId.

Example response

get_health_records

Call with no arguments for a summary, connection state, coverage header, demographics, and record counts. Select a section to read its records. The response can include section, connection, demographics, recordCounts, sections, labResults, and category-specific records. Rows are newest first, capped at 100 per view; count reports the total. labs excludes vital signs. If no insurance is connected, the response includes connected: false, message, howToConnect, and nextStep: "connect_insurance". Connection state and import progress are available in get_user_profile.connections.

Example response