v1

latestOpenAPI 3.0.0NexHealth License 1.02026-07-2688180386.6 KB

Clinical Notes

View clinical notes

This endpoint returns the clinical notes for the specified location. At least one of the patient_id, procedure_id, entered_before, entered_after, or updated_since filters must be provided. Results are cursor-paginated.

get/clinical_notes

Query parameters

subdomainstring required

Used to scope the request to the specified institution

location_idinteger required

Used to scope the request to the specified location

patient_idinteger

Filter by the id of the associated patient

procedure_idinteger

Filter by procedure, only return clinical notes that are associated with the procedure ID. This association only exists in certain EHRs and for certain types of notes

entered_beforestring date-time

Only return clinical notes that were created on or before the provided datetime

entered_afterstring date-time

Only return clinical notes that were created on or after the provided datetime

updated_sincestring date-time

Only return clinical notes updated after the specified time (UTC)

start_cursorstring

First item of the current page. Starts empty

end_cursorstring

Last item of the current page. Starts empty

per_pageinteger

Number of results to return per page. Maximum allowed amount is 1000.

Headers

Nex-Api-Versionstring required

The NexHealth API version

Response

Successful

codeboolean

Indicates the success or failure of the request

descriptionstring

Additional context on the request to help with debugging.

errorstring[]

Any errors that occur during the execution of the request.

page_infoobject

Pagination information that can be used for fetching previous and next pages.

Example response

{
  "description": "Description",
  "error": [
    "Error message"
  ],
  "data": [
    {
      "id": 113,
      "patient_id": 115,
      "procedure_id": 116,
      "entered_at": "2021-01-01T00:00:00Z",
      "content": "Patient has a fever",
      "signed": true,
      "completed": true,
      "updated_at": "2020-06-05T20:16:57.007Z"
    }
  ],
  "page_info": {
    "has_previous_page": false,
    "has_next_page": false,
    "start_cursor": "AAAAA",
    "end_cursor": "BBBBBB"
  }
}