View communication logs

get

https://nexhealth.info/communication_logs

🚧
Beta
Send Nex-Api-Version: v3.1.0 to use this endpoint. It is still changing, and access is limited to approved partner institutions. Contact NexHealth before you build on it.

This endpoint lists the communication log requests made through this API at the given location, each with the status of its write-back to the EHR (pending, succeeded or failed). Filter by patient_id, status or created_since. Only requests registered in the last 30 days are listed unless created_since reaches further back, up to 90 days. Entries recorded directly in the EHR are not available. Communication logs exist only for Open Dental locations, the only EHR the write-back currently supports.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

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

status

string

enum

Filter by write-back status

Allowed:

created_since

date-time

Requests registered after the specified time (UTC). Defaults to 30 days ago and cannot be more than 90 days ago

sort

string

Optional comma-separated string of fields to sort on.
Include a leading dash for descending order.

Available fields:

created_at
-created_at

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 v3.1.0

The NexHealth API version

Responses

Language

Credentials

Header

Loading…

Response

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

application/json

200Successful

400Bad Request

401Unauthorized

403Forbidden

404Not Found

500Internal Server Error