recommendations

Personalized record location recommendations for the authenticated patient on a project they have consented to. Requires an active consent on the supplied projectId. Recommendations are derived from a record retrieval initiated under that project; when retrievalId is omitted the patient's most recent eligible retrieval for the project is used.

Query Parameters
projectId string — REQUIRED HealthEx project id the patient must have an active consent on.
retrievalId string Identifier of a prior record retrieval for this patient. When omitted, the patient's most recent retrieval is used. Must belong to the authenticated patient.

Responses

200 Recommended 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.