Enable EMIS API access

To complete the integration between Appt Health and EMIS Web, you'll need to activate the Partner API and configure user access. Follow these steps to finalise the setup.

Step 1: Activate the partner API

1. Open the EMIS main menu (EMIS ball).
2. Navigate to System Tools.
3. Select EMAS Manager.

‍Troubleshooting: If you cannot access EMAS Manager, check that your role profile includes the RBAC activity B0062 Local System Administration. If needed, this can be configured in Organisation Configuration.

Step 2: Enable Appt Health as a partner application

1. In the bottom left corner, select Partner API.
2. Locate and select Appt Health.
3. Click Activate Application in the main toolbar (or deactivate and then reactivate!)
4. Once activated, a ✅ green tick should appear next to Appt Health.

Step 3: Grant user access to the API

With Appt Health still selected in the list of partner products

1. Click Edit Users in the main toolbar.
2. Locate the user created in Step 1 – Setting up an EMIS user. The name should be User, Appt.
3. Tick the box next to their name.
4. When prompted, enter the password you created for this user in Step 1.

Step 4: Enable login access

Again, with Appt Health still selected as the partner product.

1. Select Login Access in the main toolbar.
2. Locate the User, Appt account created in Step 1.
3. Tick the boxes for:‍

• Auto Login
• Allow Login

Step 5: Enable ApptHealthEngagement as a partner application

Repeat steps 2 to 4 for ApptHealthEngagement, namely:

1. Find ApptHealthEngagement in list of Partner API products.
2. Click Activate Application in the main toolbar (or deactivate and then reactivate!)
3. Once activated, a ✅ green tick should appear next to ApptHealthEngagement.
4. Edit Appt user as in step 3, but with ApptHealthEngagement selected as partner product.
5. Enable login access as in step 4, again with ApptHealthEngagement selected as partner product.

Step 6: Get organisation CDB code

We will also need your practice's ID (CDB code) - this is different from your practice's ODS code.
This is usually a four-digit code, found on the top bar of the EMIS Web application, next to your organisation name.

Final check before proceeding

You’ve now completed Step 2. Ensure you have the following details, as you’ll need them shortly:
‍
✅ Your Organisation's CDB code (found in this step)
✅ Your API username (from Step 1)
✅ Your API password (from Step 1)

You can now progress to the final stage of this setup - integrating EMIS Web with our platform in the following guide.