Endpoints

Record request notes

POST/v0/companies/{company_id}/projects/{project_id}/patients/{patient_id}/record-requests/{record_request_id}/notes

Add a note to a record request

Creates a new note on the record request, authored by the caller. Each call adds another note, so retrying a request that succeeded creates a duplicate. Any webhook endpoints subscribed to record-request note events are notified. Returns an empty body on success.

Request bodyapplication/json

contentstring
The text of the note.
Free text. Surrounding whitespace is trimmed, and an empty or whitespace-only value is rejected.

Optional parameters

emailstring
Optional email to impersonate another user when creating the note. Requires ImpersonateUser permission and the target user must be in the same company.
Free text. Surrounding whitespace is trimmed, and an empty or whitespace-only value is rejected.

ReturnsSuccess

Errors

401404500

Request

curl

curl https://api.hermeshealth.ai/v0/companies/<company_id>/projects/<project_id>/patients/<patient_id>/record-requests/<record_request_id>/notes \
  -X POST \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "content": "string",
  "email": "string"
}'

import requests

response = requests.post(
    "https://api.hermeshealth.ai/v0/companies/<company_id>/projects/<project_id>/patients/<patient_id>/record-requests/<record_request_id>/notes",
    headers={"Authorization": "Bearer YOUR_API_KEY"},
    json={
        "content": "string",
        "email": "string",
    },
)
response.raise_for_status()

const response = await fetch("https://api.hermeshealth.ai/v0/companies/<company_id>/projects/<project_id>/patients/<patient_id>/record-requests/<record_request_id>/notes", {
    method: "POST",
    headers: {
        Authorization: "Bearer YOUR_API_KEY",
        "Content-Type": "application/json",
    },
    body: JSON.stringify({
      "content": "string",
      "email": "string"
    }),
});
if (!response.ok) throw new Error(`Request failed: ${response.status}`);

PATCH

/v0/companies/{company_id}/projects/{project_id}/patients/{patient_id}/record-requests/{record_request_id}/notes/{note_id}

Update a record request note

Replaces the note’s content. Only the note’s author can edit it; a note that does not exist, belongs to another user, or is not filed on this record request returns 404. Returns an empty body on success.

Parameters

note_idstringpath, required
The id of the note to update, as returned when listing the record request's notes.

Request bodyapplication/json

contentstring
The new text of the note, replacing the old text.
Free text. Surrounding whitespace is trimmed, and an empty or whitespace-only value is rejected.

ReturnsSuccess

Errors

401404500

Request

curl

curl https://api.hermeshealth.ai/v0/companies/<company_id>/projects/<project_id>/patients/<patient_id>/record-requests/<record_request_id>/notes/<note_id> \
  -X PATCH \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "content": "string"
}'

import requests

response = requests.patch(
    "https://api.hermeshealth.ai/v0/companies/<company_id>/projects/<project_id>/patients/<patient_id>/record-requests/<record_request_id>/notes/<note_id>",
    headers={"Authorization": "Bearer YOUR_API_KEY"},
    json={
        "content": "string",
    },
)
response.raise_for_status()

const response = await fetch("https://api.hermeshealth.ai/v0/companies/<company_id>/projects/<project_id>/patients/<patient_id>/record-requests/<record_request_id>/notes/<note_id>", {
    method: "PATCH",
    headers: {
        Authorization: "Bearer YOUR_API_KEY",
        "Content-Type": "application/json",
    },
    body: JSON.stringify({
      "content": "string"
    }),
});
if (!response.ok) throw new Error(`Request failed: ${response.status}`);

DELETE

/v0/companies/{company_id}/projects/{project_id}/patients/{patient_id}/record-requests/{record_request_id}/notes/{note_id}

Delete a record request note

Deletes the note when it is filed on this record request and the caller authored it. The call succeeds with an empty body even when no matching note exists, so repeating it is safe.

Parameters

note_idstringpath, required
The id of the note to delete, as returned when listing the record request's notes.

ReturnsSuccess

Errors

401404500

Request

curl

curl https://api.hermeshealth.ai/v0/companies/<company_id>/projects/<project_id>/patients/<patient_id>/record-requests/<record_request_id>/notes/<note_id> \
  -X DELETE \
  -H "Authorization: Bearer YOUR_API_KEY"

import requests

response = requests.delete(
    "https://api.hermeshealth.ai/v0/companies/<company_id>/projects/<project_id>/patients/<patient_id>/record-requests/<record_request_id>/notes/<note_id>",
    headers={"Authorization": "Bearer YOUR_API_KEY"},
)
response.raise_for_status()

const response = await fetch("https://api.hermeshealth.ai/v0/companies/<company_id>/projects/<project_id>/patients/<patient_id>/record-requests/<record_request_id>/notes/<note_id>", {
    method: "DELETE",
    headers: {
        Authorization: "Bearer YOUR_API_KEY",
    },
});
if (!response.ok) throw new Error(`Request failed: ${response.status}`);