Communication Logs

Create communication log (beta)

🚧 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.

Health record systems: Works with Open Dental.

Supported for Open Dental locations only. Requests for a location on any other EHR are rejected with 422. This endpoint registers a request to append an entry to the patient's communication log in the connected EHR, for example a summary of a phone call or the transcript of a text conversation, and returns 202 Accepted with the request in in_progress status. The entry is written to the EHR asynchronously: poll this request to learn whether the write-back succeeded or failed. Entries are append-only and cannot be updated or deleted through the API. A request that succeeded wrote one entry, so do not resend it; a request that failed wrote nothing and is retried by submitting a new one.

post/communication_logs

Request

  • Base URL
    https://nexhealth.info
  • URL
    https://nexhealth.info/communication_logs
  • Auth
    API key in header Authorization

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

Headers

Nex-Api-Versionstring required

The NexHealth API version

Request body

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.

countinteger

Number of total objects, in case of collection.

Example response

{
  "description": "Description",
  "error": [
    "Error message"
  ],
  "data": {
    "id": "019965f2-4d1e-7a3c-9b0e-3f0c2a7d9e11",
    "patient_id": 162,
    "location_id": 21,
    "mode": "phone",
    "direction": "received",
    "note": "AI receptionist call summary: patient confirmed the cleaning on Tuesday at 10am.",
    "occurred_at": "2026-09-01T14:30:00.000Z",
    "status": "succeeded",
    "completed_at": "2026-09-01T14:31:07.000Z",
    "created_at": "2026-09-01T14:30:05.000Z"
  },
  "count": 2
}

Changes

No recorded changes to this operation across all 1 revision of this API.