Onboard a location
Connect one practice's health record system to your app.
You onboard a location once for each practice, in the Developer Portal.
Before you start
- Switch the portal to production mode. See the Go-live checklist.
- Check that the practice's system is one of the supported systems.
- Talk to the practice first. Getting to know a healthcare office has the questions to ask.
1. Create the institution
- Click Create Institution at the top right of the portal.
- Enter the practice's address, contact information and website. For a group with several locations, enter the parent organization.
- The institution appears in the TO DO section.
2. If the practice already uses NexHealth
Some practices already have the Synchronizer installed. The portal tells you when the details you entered match one.
- Click Request access on the match.
- The practice gets an email asking for consent. They can approve by replying to the email, or in the NexHealth web app under Apps.
- Once the practice approves, you can make calls for that institution. There is nothing to install.
3. Create the sync
Open the institution and click create sync. Choose the practice's health record system and click Create. What happens next depends on the system.
| System | What happens | Guide |
|---|---|---|
| Dentrix, Eaglesoft, Open Dental | The portal shows a product key. The practice runs the installer on its server and enters the key. | Installing the NexHealth Synchronizer |
| Other server-based systems | NexHealth's installation team does the install with the practice's IT. You schedule it from the portal. | Scheduled installs |
| Cloud-based systems | The practice creates a dedicated user for NexHealth. You submit the system URL and that login. Setup can take up to 72 business hours. Most cloud systems also need the NexHealth Chrome extension on every workstation that changes the schedule. | Cloud systems installation |
A practice with a server-based system needs one sync for each server.
4. Track it to done
The portal sorts institutions into TO DO, IN PROGRESS and ALL. An institution in TO DO needs something from you, such as starting the install, choosing locations or providing credentials. A failed install shows in IN PROGRESS.
When the sync is running, confirm it with GET /sync_status. See Interpreting sync status.
If the install does not finish, see Troubleshooting install failures.
Onboarding many practices at once
Use Upload CSV at the top right of the portal. Download the sample CSV for the format. Several rows with the same institution details create several syncs for that institution. The portal alerts you to any match with a practice that already has the Synchronizer.
Updated about 21 hours ago