Get, add, update and delete patient notes so NikoHealth stays in sync with your third-party platform.
Before You Start: Get the Note Subject ID
Every note needs a subject.
GET /v1/note-subjects/dictionary
Optional query parameters: name, includeArchived (default false), pageIndex (default 0) and pageSize (default 10).
{
"Items": [
{ "Id": "Alert", "Name": "Alert", "Archived": false, "Description": "Alert" },
{ "Id": "Billing", "Name": "Billing", "Archived": false, "Description": "Billing" },
{ "Id": "Compliance", "Name": "Compliance", "Archived": false, "Description": "Compliance" }
]
}GET /v1/patient-note-subjects/dictionary is deprecated. Use GET /v1/note-subjects/dictionary instead.
Add a Note
POST /v1/patients/{patientId}/notes
Fields
Field | Required | Notes |
| ✅ | The note content |
| ✅ | From |
| ✅ | Deprecated but still required. Send the same value as |
|
|
|
POST /v1/patients/10000105/notes
{
"Text": "Patient called to confirm delivery address for CPAP supplies.",
"Description": "Patient called to confirm delivery address for CPAP supplies.",
"SubjectId": "Alert",
"IsPinned": false
}
Response: 201 Created
{ "Id": "758" }
Get Notes for a Patient
All Notes for One Patient
GET /v1/patients/{patientId}/notes
Optional filters: text, subjectId, period.from, period.to, includeArchived, pageIndex and pageSize.
GET /v1/patients/10000105/notes?subjectId=Alert
One Note
GET /v1/patients/{patientId}/notes/{id}GET /v1/patients/10000105/notes/758
{
"Id": "758",
"Text": "Patient called to confirm delivery address for CPAP supplies.",
"Description": "Patient called to confirm delivery address for CPAP supplies.",
"Subject": { "Id": "Alert", "Name": "Alert" },
"IsPinned": false,
"Archived": false,
"CreatedBy": { "FirstName": "Jane", "LastName": "Smith" },
"CreatedOn": "2026-11-10T18:49:47+00:00"
}
Notes Across All Patients
GET /v1/patients/notes
Use this to pull notes in bulk, for example everything created since your last sync.
Optional filters: patientIds, text, subjectId, createdById, period.from, period.to, isPinned, includeArchivedNotes, includeArchivedPatients, pageIndex and pageSize.
GET /v1/patients/notes?period.from=2026-11-01T00:00:00Z&period.to=2026-11-10T23:59:59Z
Update a Note
PUT /v1/patients/{patientId}/notes/{id}
Send the full note. It uses the same required fields as creating one.
PUT /v1/patients/10000105/notes/758
{
"Text": "Patient confirmed new delivery address: 123 Main St, Birmingham, AL 35203.",
"Description": "Patient confirmed new delivery address: 123 Main St, Birmingham, AL 35203.",
"SubjectId": "Alert",
"IsPinned": true
}
Response: 200 OK
Delete a Note
DELETE /v1/patients/{patientId}/notes/{id}DELETE /v1/patients/10000105/notes/758
Response: 200 OK
Common Errors
Code | Meaning |
400 | Invalid request, such as a missing |
401 | The token is missing, expired or invalid |
403 | You don’t have permission to access this resource |
404 | The patient or note wasn’t found |
429 | Too many requests |
