Skip to main content
Use this endpoint to query clinical notes across your tenant. Filter by patient, author, encounter, note type, or date range and combine multiple filters in a single request. Results are paginated using cursor-based pagination. This endpoint queries FHIR DocumentReference resources stored on AWS HealthLake.

​
Request

​
patientId
string
Filter notes for a specific patient.
​
authorId
string
Filter notes written by a specific practitioner.
​
encounterId
string
Filter notes associated with a specific encounter.
​
type
string
Filter by note type (e.g. progress-note, discharge-summary).
​
dateFrom
string
Return notes dated on or after this date (YYYY-MM-DD).
​
dateTo
string
Return notes dated on or before this date (YYYY-MM-DD).
​
count
integer
Number of results per page. Default 20, maximum 100.
​
cursor
string
Pagination cursor from the previous response’s cursor field.
curl "https://api.clinikapi.com/v1/notes?patientId=pt_abc123&type=progress-note&sort=-date" \
  -H "x-api-key: clk_live_your_key"

​
Response

​
data
array
Array of note objects matching the search criteria.
​
total
integer
Total number of matching notes.
​
cursor
string
Cursor to pass as cursor in the next request. null when there are no more results.
​
hasMore
boolean
Whether additional pages of results exist.
Example response
{
  "data": {
    "data": [
      {
        "id": "note_abc123",
        "patientId": "pt_abc123",
        "authorId": "prac_def456",
        "encounterId": "enc_xyz789",
        "type": "progress-note",
        "title": "Follow-up Visit - Hypertension Management",
        "docStatus": "final",
        "category": "cardiology",
        "date": "2025-01-15",
        "createdAt": "2025-01-15T10:00:00Z"
      }
    ],
    "total": 1,
    "cursor": null,
    "hasMore": false
  },
  "meta": {
    "requestId": "req_l6m7n8o9",
    "timestamp": "2025-01-15T10:10:00Z",
    "status": 200
  }
}