View clinical notes

get

https://nexhealth.info/clinical_notes

This endpoint returns a list of clinical notes. You can filter by patient, procedure, entered_before, entered_after or updated_since. You must provide at least one filter.

Query Params

subdomain

string

required

Used to scope the request to the specified institution

location_id

int32

required

Used to scope the request to the specified location

patient_id

int32

Filter by patient

procedure_id

int32

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_before

date-time

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

entered_after

date-time

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

updated_since

date-time

Clinical notes updated after the specified time (UTC)

start_cursor

string

First item of the current page. Starts empty

end_cursor

string

Last item of the current page. Starts empty

per_page

int32

Defaults to 5

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

Headers

Nex-Api-Version

string

required

Defaults to v20240412

The NexHealth API version

Responses

Language

Credentials

Header

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200Successful

400Bad Request

401Unauthorized

403Forbidden

500Internal Server Error