Skip to main content
POST
Start connecting health records

Authorizations

Authorization
string
header
required

OAuth 2.1 with PKCE

Body

application/json
ial2Mode
boolean

true for a nationwide TEFCA record search with identity verification; false or omitted for an insurer or provider-portal sign-in

patientId
string

Optional patient id (defaults to the primary patient)

Response

Link started

authorizationUrl
string<uri>
required

Give this to the user to open in their browser. Valid for 15 minutes and can be reopened.

Poll GET /api/health-records/link/{linkNonce} with it

notice
string

Notice at collection for the records connection. Relay it to the user before they open the link.

nextStep
string