Skip to content
Hermes Health API
GuidesOpenAPI spec

Endpoints

Patient search

PATCH/v0/companies/{company_id}/projects/{project_id}/patients/{patient_id}/search-level

Update a patient's requested searches

Update which searches are requested for a patient.

Patch semantics — an absent field leaves the patient’s current setting unchanged (unlike the create body, where an omitted flag means off). An empty body is rejected with a 400.

The response reports whether the capabilities now armed can actually run. ehrSearchBlockedReason: "MissingZipCode" means the patient has no ZIP code and the vendor requires one: the request is armed and goes out on its own once a ZIP code is set, and nothing else is needed. "DeceasedBeforeClinicalData" on siteSonarBlockedReason or patientHistoriesBlockedReason is the opposite kind of answer: the patient’s authorization documents date their death before any clearinghouse still holds records, so the search would be empty and is not run. Unlike the ZIP case nothing stays armed, so this reason is reported HERE and then goes back to null once the gate runs — from that point the answer lives on the patient’s searchStatus instead.

Request bodyapplication/json

Optional parameters

  • siteSonarboolean

    Request (`true`) or withdraw (`false`) site sonar — claims-based discovery of the facilities the patient visited. Absent: leave the patient's current setting unchanged.

  • patientHistoriesboolean

    Request (`true`) or withdraw (`false`) patient histories — diagnosis and treatment data retrieval, independent of site sonar. Absent: leave the patient's current setting unchanged.

  • ehrSearchboolean

    Request (`true`) or withdraw (`false`) the Veradigm EHR enrollment ("ehrSearch"), independent of the other flags. Absent: leave the patient's current setting unchanged. Records intent only.

ReturnsSuccess

Conditional attributes

  • ehrSearchBlockedReasonstring

    Why the patient's EHR Search will not run, or null when nothing is holding it back. Same value as `ehrSearchBlockedReason` on the patient.

  • patientHistoriesBlockedReasonstring

    Why the patient's Patient Histories run will not run, or null when nothing is holding it back. Same value as `patientHistoriesBlockedReason` on the patient.

  • siteSonarBlockedReasonstring

    Why the patient's Site Sonar run will not run, or null when nothing is holding it back. Same value as `siteSonarBlockedReason` on the patient.

Errors

400401403404500