Using the NexHealth Developer Portal

Accessing the NexHealth Developer Portal

Creating an account:

If you are the first user for your organization, create your NexHealth Developer Portal Account here.

If your organization already exists, ask an admin to send you an invite from their Developer Portal account.

Logging into to the Developer Portal:

You can log into the Portal at developers.nexhealth.com or via the general login page, which can be accessed by visiting our website, nexhealth.com, and clicking the "Login" button in the top right corner.

Managing users

Use the navigation bar on the left sidebar of the Developer Portal to access the Users tab. You can invite users to the Developer Portal by clicking "Invite User" and entering their email. The new user will then receive an email invitation to the Portal.

You can also mark a user as an Admin, which will allow them to manage and invite other
users to the Portal. Admins are also able to delete users in the Portal.

Click the three dots to the right of a user invite to either resend or cancel the invitation.

Generating an API Key

In either test or production mode, click on the API Key tab in the left sidebar. Click on the Create sandbox API key (Create production API key button in production) to create the key. Note that the key will only be shown once for security reasons, so make sure to store it somewhere safe. If you forget your key, you can rotate it from this same page.

Once you have your key, you can use it to generate a bearer token.

Sandbox

Your developer portal account comes with a sandbox institution to make API requests against using your sandbox key (see Generating an API Key above). Visit the Institutions tab in test mode and click into your sandbox institution to access it.

Your sandbox contains sample patient and appointment data to test the API endpoints described in our Quickstart. API calls in the sandbox do not modify any actual electronic health records.

Use your bearer token alongside the subdomain and location_id to test the endpoints in the Quickstart. If you need to test with a hosted health record system, view our guide on setting up an Open Dental server.

The Institutions tab

After upgrading your account, you can use the Institutions tab to onboard new institutions and syncs. When you visit the Institutions tab, you will see any existing institutions in the center of your screen. You can also use the top left search bar to locate an institution by name.

Your institutions will be displayed in the following categories.

• TO DO: Institutions in this section require an action item from you. For example, starting the installation, selecting locations, or providing credentials.
• IN PROGRESS These institutions have started the Synchronizer installation process, but may need additional information or action. You may also see a failed state in this section.
• ALL: This section contains a comprehensive list of all of your institutions.

If you’re managing several institutions, use the “Filter by” button to sort your institutions by status and see your outstanding TO DO items quicker.

Creating an institution

1. Click "Create Institution" in the top right corner of the Portal.
2. Enter relevant information for the institution, including its address, contact information, and website.
   1. If the institution is a multi-location group, such as a Dental or Medical Service Organization, please enter the information for the parent organization or corporate office.
3. You’ll see the created institution in the TO DO section of the Portal. The next step is to install the NexHealth Synchronizer.

Installing the Synchronizer

1. After creating an institution, you will see a call to action to "Create sync" next to that institution in your TO DO section of the Portal. Click on "Create sync" to start the installation process.
2. Select the practice’s health record system within the modal that appears and click "Save". Please note that you will need to install the Synchronizer for every server within a given institution if that practice is using an on-prem health record system such as Dentrix or Open Dental.
3. If you are setting up an on-prem sync that is supported by the self-installer, the Developer Portal will display a product key for the Synchronizer installation. The product key is a unique identifier for each installation that links the practice’s health record system to the Synchronizer.
4. If you are setting up an on-prem sync or a cloud sync not supported by the self installer, please follow the installation steps for your customer’s health record system in this guide.

See more information on how to handle institution creation failures.

Sync Status

After successful installation of a sync, you will be able to view Sync Status, which details the last read and write time for an active sync.

Learn more about Sync Status here .

What to do if you encounter a matching institution

Some practice locations may already have the Synchronizer installed. This means you don’t need to install it again, but the practice must give consent for you to use their existing Synchronizer to read and write data to their health record system.

Here is what to do when you encounter a matching institution.

Matching: You will be notified during institution creation that a specific institution is already live with the Synchronizer, eliminating the need for the installation step. You will see a pop up modal on your screen indicating a match has been detected. Confirm the match by clicking "Request access'". The practice will then need to provide consent for you to use their existing Synchronizer. They can provide consent via email or the NexHealth web app.

Practice consent: If a practice is already using the NexHealth Synchronizer, they will receive an email requesting they provide consent for you to use their existing Synchronizer.

If the practice is using the NexHealth web app, they can then grant access directly from their web app. If the practice needs help, instruct them to navigate to the four squares at the top right of their NexHealth account, click Apps, and grant access.

If the practice is not using the NexHealth web app, they can grant access by responding to the email.

Once the practice approves the request to sync, you can continue.

Activating additional locations on an existing sync

If there are additional locations that are eligible to be added to an existing sync you already have access to, we will show an "Activate additional locations" button on that sync. Upon clicking on the button, you will be able to specify which additional locations you want activated and our team will fulfill your request shortly.

Deactivating an institution

If you create an institution by accident or a practice no longer uses your service and you wish to no longer be billed for it, you can remove the institution from your Developer Portal by deactivating it.

On the institution's page, click on the Deactivate button in the top right corner. In the modal that appears, you can choose to deactivate the entire institution or a subset of locations.

Bulk uploads

If you are creating multiple institutions and syncs at once - for example, migrating multiple offices off a previous service provider - use the "Upload CSV" button in the upper right to save time in submitting practice information. Download a sample CSV to ensure you use correct formatting. Keep in mind that using multiple rows with the same institution information is the way to create multiple syncs for that institution.

You will receive an alert in the Portal if there are any existing matches with practices that already have the Synchronizer installed. See more information on matching above.