search

Search for record locations (healthcare organizations and their patient portals) by name, with optional location and EHR platform filters. Each result includes brand, portal, and endpoint identifiers that can be passed to the consent flow.

Request Body — REQUIRED
searchQuery string — REQUIRED Possible values: length ≤ 200 Free-text search term, typically a healthcare organization or brand name.
filters object Optional location and EHR platform filters. zipcode string 5-digit US ZIP code used to filter results city string City name used to filter results state string Two-letter US state code used to filter results ehrPlatform string Possible values: [epic, cerner, meditech, athena, eclinicalworks, practicefusion, allscripts, nextgen, advancedmd, modmedema, drchrono, medhost, chbase, maximeyes, netsmart, qualifacts-carelogic, qualifacts-credible, qualifacts-insync, onemedical, vahealth, medicare, anthem, unitedhealthcare, aetna, humana, cigna, bcbsal, questdiagnostics, darena, careevolution, dynamichealthit, edifecs, flatiron, healthit, logica, kaiser, medicarev3, nextgenoffice, nhs] Filter results to record locations served by a specific EHR platform.
pagination object Optional pagination controls. limit number Possible values: 1 ≤ value ≤ 100 Maximum number of results to return. offset number Possible values: value ≤ 1000 Number of results to skip for pagination.

Responses

200 A page of matching record locations. Schema — OPTIONAL totalHits number Total number of matching record locations across all pages. offset number Offset applied to this page of results. limit number Maximum number of results requested for this page. hasMore boolean Whether more results are available beyond this page. results object[] Matching record locations for this page. brandId string Opaque identifier for the record location (brand), used to start a consent flow. brandName string Human-readable name of the record location. matchedVia string Possible values: [name, alias, ehrPlatform] Why this record location matched the search query: its primary name, a known alias, or the EHR platform name. matchedAlias string — OPTIONAL The alias that matched the search query. Present only when matchedVia is alias. serviceArea — OPTIONAL Approximate geographic area the record location serves. The shape depends on the type discriminator. portals object[] Patient portals associated with this record location. portalId string Opaque identifier for the patient portal, used to start a consent flow. portalName string Human-readable name of the patient portal. endpoints object[] Connection endpoints available for this portal. endpointId string Opaque identifier for the connection endpoint, used to start a consent flow. ehrPlatform string EHR platform that backs this endpoint.