nearbySuggestions

Suggest nearby record locations based on location only. Organization tokens use the supplied zipcode (or the request's approximate location); patient tokens additionally consider the patient's verified (IAL2) location.

Query Parameters
zipcode string 5-digit USA ZIP code used to find nearby record locations. Takes precedence over any other location signal. Recommended for server-to-server callers.

Responses

200 Nearby record locations. The results array may be empty when nothing relevant is found. Schema — OPTIONAL results object[] Matching record locations. May be empty when nothing relevant is found. brandId string Opaque identifier for the record location (brand), used to start a consent flow. brandName string Human-readable name of the record location. brandState string Two-letter USA state code the record location is associated with, when known. portalId string Opaque identifier for the patient portal, used to start a consent flow. portalName string Human-readable name of the patient portal, when known. endpointId string Opaque identifier for the connection endpoint, used to start a consent flow. ehrPlatform string EHR platform that backs this endpoint, when known.