API Reference

Forms

🚧

Supported Integrations

Forms are currently available for the following integrations: Open Dental, Eaglesoft, Dentrix, Dentrix Ascend, Dentrix Enterprise, Curve, eClinicalWorks, Denticon, and athenahealth.

NexHealth lets you create electronic forms that sync directly with a practice's health record system. Using our API you can view these forms, and share them with patients to collect valuable data.

Forms can be created and configured via the NexHealth web app. If you are interested in setting up a new form for a practice you are working with reach out to [email protected]

Form Requests

Once a form is created in NexHealth, it can be shared with a patient for them to complete. We call this process a form request. Creating a form request generates a link a patient can use to complete a form

In order to create a form request, you must provide a valid NexHealth patient or appointment ID so the form can be associated with the correct record in the health record system.

Then you can share the link with the patient via email, text, or directly in your application. You can track the status of the form request using the endpoint Get /forms/request/{id} and viewing the request_status property. Possible statuses are DRAFT, NOT_CLICKED, CLICKED, VIEWED, IN_PROGRESS, COMPLETE, and UPLOADED.

Upon completion, if any form fields are configured to be written into the health record system, they are synced. In addition, the completed form is written into the health record system’s document center as a PDF associated with the patient for future reference.

📘

Downloading a Completed Form Request

You can download a pdf of a completed form by making a Get request to /forms/requests/{id}/download.

Form Syncs

The form sync process can be broken down into two parts:

  • As configured during form set up, demographic fields like patient name and medical alert information-- like a patient being diabetic-- are mapped to fields in the health record system.
  • Then, the form is inserted into the health record systems document center as a PDF.

By default forms automatically sync with the health record system upon completion. However this can be disabled via the NexHealth web app if you want each form to undergo manual or automatic review before insertion. In this case you can manually initiate a sync by making a request to /forms/requests/{id}/sync.

Forms Response Object

{
  "code": false,
  "description": [
    [
      "Description"
    ]
  ],
  "error": [
    [
      "Error"
    ]
  ],
  "data": {
    "id": "ee0913ee13af4e0aa4df2af1738d43d6",
    "name": "Form name",
    "url": "/api/documents/ee0913ee13af4e0aa4df2af1738d43d6.pdf"
  },
  "count": 2
}

Form Request Response Object

{
  "code": false,
  "description": "Description",
  "error": [
    "Error"
  ],
  "data": [
    {
      "id": "d2594a76862247209d4c35a92e0902f8",
      "url": "/s/yLXaync6PK/",
      "form_ids": [
        [
          "ee0913ee13af4e0aa4df2af1738d43d6"
        ]
      ],
      "request_status": "NOT_CLICKED",
      "sync_status": "never_synced",
      "autosync": true,
      "last_synced_at": "2020-06-05T20:16:57.007Z",
      "patient": {
        "id": 415,
        "email": "[email protected]",
        "first_name": "John",
        "last_name": "Smith"
      },
      "created_at": "2020-06-04T20:16:57.007Z",
      "due_date": "2020-06-10T20:16:57.007Z"
    }
  ],
  "count": 2
}