BestNotes & Avea Integration

Connecting your API:

BestNotes and Avea have joined forces to offer an integration of Avea and BestNotes. This integration includes the ability to pull a BestNotes client into Avea. 

To get started, you will first need to contact Avea to be trained and implemented. Avea will provide you with the credentials you need to connect your API to BestNotes (Username and Password)

Next, submit a request to BestNotes at or by calling 208-543-6646. (BN Agent Resource)

Once BestNotes staff has completed the setup for the integration you will be notified. To manage the Avea and BestNotes integration you will need the "Manage API" permission (see Figure 1-1).

Figure 1-1. Manage API permission in the edit client screen

You will then need to log into BestNotes and navigate to the Settings page. Here you will select the "APIs" tab (see Figure 1-2). In the API window, select the "Third Party" tab in the popup (see Figure 1-3).

Figure 1-2. API setting

Figure 1-3. Third Party window

In the Third Party window select "Add Credentials". In the "Select Partner" dropdown, choose the "Avea Integration" option (see Figure 1-4).  Enter the username and password provided by Avea, make sure the "Active" checkbox has been checked, and select "Add" (see Figure 1-5).

Figure 1-4. Selecting the API partner

Figure 1-5. Entering Avea API credentials

Now that you have your API and integration set up (see Figure 1-6), you will now be able to send clients and their demographics to Avea. 

Figure 1-6. Connected Avea API

Adding a Client From BestNotes to Avea 

Create or navigate to the client you would like to add, from there go to the "Episode" tab. Here you will see the Avea symbol in red (see Figure 1-7).

Figure 1-7. Adding a client to Avea from the Episode tab

By selecting this symbol, there will be a popup in which you will have the option to add the client to the program within Avea you want them to be categorized (see Figure 1-8). The program list will be the "Practices" that you set up with Avea. Once you select the program, you will select "Add Client."

Figure 1-8. Selecting the practice for the client

You will then receive confirmation that your client has been added to Avea (see Figure 1-9). The Avea symbol will turn blue with a check mark, and upon hover, a message appears indicating that the client has been added to Avea and under which practice (see Figure 1-10).

Figure 1-9. Confirmation that the client was added to Avea

Figure 1-10. Status message after client has been added to Avea

The information you would like to have imported will need to be entered into BestNotes BEFORE it is associated with Avea. The table below includes what will be imported, and where to input this information.

Data Imported
Original Input
First Name
Edit Client
Last Name
Edit Client
Middle Initial
Edit Client
Edit Client
Edit Client
Social Security Number
Edit Client
Edit Client
Edit Client
Edit Client

Import Verification:

When you have imported your first client, you will need to verify the import was successful. Once you have logged into your Avea account, select the practice to which you added your client (see Figure 1-11).

Figure 1-11. Selecting a practice

You will then select "Patients" in the left hand menu (see Figure 1-12).

Figure 1-12. Navigating to the "Patients" page

Once you have navigated to the "Patients" page, you then need to update your filters. The first filter "Show Admitted Patients" is set to "Active" by default. You will need to change this to "ALL" (see Figure 1-13). 

Figure 1-13. Viewing "All" patients

Now that all of your filters are set, you will be able to see the client(s) you have added. These are listed in alphabetical order, based on the client last name (see Figure 1-14).

Figure 1-14. Patients added from BestNotes are visible here

If you have any questions regarding BestNotes, you can reach out to us at or call 208-543-6646. If you have any questions regarding Avea functionality, you can contact Avea at 508-867-8853.

Back to top of page