Athena Health

This page contains the setup guide and reference information for the Athena Health connector.

Prerequisites

Before connecting your Athena Health account, make sure that

  • You are an athenaOne client with athenaCollector and athenaClinicals enabled.
  • You have signed the A&C form with Athena to authorize the Keragon integration.
  • You have access to your Practice ID from the Athena portal.

Keragon integrates with the athenaOne API, as documented here.

Production and Preview environments

Athena treats your Production environment and your Preview (sandbox) environment separately. Each one has its own authorization with Athena, and your Preview practice ID may be different from your production practice ID. When you connect in Keragon, select the environment that matches the practice ID you are using.

  • Production is authorized through the standard A&C form below.
  • Preview needs a separate request so Athena can link your preview practice to Keragon's test app. See Connect your Athena Preview environment.

Complete the Authorization & Consent (A&C) Form

Before you can connect Athena Health to Keragon, your practice must complete the Authorization & Consent (A&C) form. This is a requirement from Athena Health for all third party integrations and authorizes Keragon to access your practice's data through the Athena Health API.

What is the A&C form?

The A&C form is Athena Health's standard authorization document. By completing it, your practice confirms that you have reviewed and approved Keragon as an integration partner and that you consent to sharing your practice data through the Athena Health Marketplace.

How to complete the A&C form

  1. Open the Keragon A&C form.
  2. Enter your practice information, including your Practice Name and Athena Health Practice ID. If you need help finding your Practice ID, see How to find your Practice ID in Athena Health.
  3. Provide the name and email of an authorized signer at your practice. This should be someone with administrative authority.
  4. Review and sign the form electronically.
  5. After submission, Athena Health's Marketplace team processes the request and links your practice ID to Keragon's production app. This typically takes 3 to 5 business days.

What happens next?

Once the A&C form is processed

  • Keragon is authorized to connect to your Athena Health production instance.
  • You can connect your Athena Health account in Keragon by selecting Production and entering your Practice ID.

Common questions

Who should sign the A&C form? An authorized administrator or practice manager. This is typically the same person who signed your Athena Health Master Services Agreement.

Does the A&C form cost anything? No. The A&C form is a free authorization step required by Athena Health for all Marketplace integrations.

I submitted the form but have not heard back. Processing usually takes 3 to 5 business days, and requests through the Athena partner portal can take longer. If it has been more than 6 business days, contact us through the Get Help button in your Keragon account and we will follow up with Athena Health on your behalf. If you have a point of contact at Athena, you can also ask them to confirm your practice ID is linked to Keragon's production app (client ID 0oarazkofyi2sFBwJ297).

Can I start building workflows before the A&C is approved? Yes. You can explore Keragon and set up your workflow logic, but you will not be able to connect or test live data from Athena Health until the A&C form is fully processed.

Connect your Athena Preview environment

Use Preview if you want to build and test workflows without touching live patient data. The production A&C form does not cover Preview, so your preview practice must be linked to Keragon's test app before Simple authentication will work.

  1. Find your preview practice ID (also called your preview Tablespace ID) by logging into your Athena Preview environment and copying it from the department selection box. Confirm it with your Athena contact if you are unsure, since it may differ from your production practice ID.
  2. Request the link with Athena. If you have an Athena point of contact, ask them to open a support case to connect your preview practice ID to Keragon's test app, client ID 0oar7tvz5eYRVfJXi297. If you do not have one, contact us through the Get Help button and we will open the case through the Athena partner portal for you.
  3. Complete the Partner Preview Authorization and Consent form if Athena requests it. Enter Keragon as the Partner Name, your preview practice ID as the Context ID, and complete the signature fields on page 2.
  4. Once Athena confirms the link, go to Authentications in Keragon, click Create new, select Athena Health, choose Preview as the environment, paste your preview practice ID, keep Simple selected, and click Connect.

Plan ahead for Preview

Preview requests go through Athena's partner portal and can take a few weeks. If you are implementing Athena and want to test before go live, start this request as early as possible.

Setup Guide

Follow these steps to locate your Practice ID and connect Athena Health to Keragon.

  1. Go to identity.athenahealth.com and log into your Athena Health account.
  2. Copy your Practice ID directly from the department selection box or the URL in your browser's address bar.
  3. Open app.keragon.com and go to Authentications.
  4. Click Create new and select Athena Health.
  5. Select the Environment that matches your practice ID, Production or Preview.
  6. Paste the Practice ID and make sure there are no extra spaces before or after it.
  7. Keep Simple (recommended) selected and click Connect.

Need more help connecting?

Check the fully extended Athena Health connector setup guide for screenshots and detailed steps.

Once connected, Keragon uses this practice ID to authorize and interact with Athena's APIs.

How Tos

How to "Create Patient" in Athena

This guide walks you through creating a patient in Athena using Keragon.

  1. Go to app.keragon.com.
  2. Start by adding a new step in your workflow.
  3. In the search bar, type "Athena".
  4. Click Athena Health to view available actions.
  5. Select "Create patient".
  6. Choose your existing authentication or click "+ Connect new account" if needed.
  7. Under Department, use the variable selector to choose a department for the patient's registration.
  8. Fill in the required fields First Name, Last Name, Date of Birth and Email.
  9. In addition to name and date of birth, at least one of these fields is required. Email, Guarantor Email, SSN, Home Phone, Mobile Phone, Work Phone or Zip Code.
  10. Click Save to store the configuration.
  11. Click Test Step to confirm the setup.
  12. Review Inputs and Outputs for verification.

This lets you register new patients in Athena dynamically from triggers or prior steps in your Keragon workflow.

Troubleshooting and Common Errors

Error Message Cause Suggested Fix
Failed to create new authentication Athena has not yet linked your practice ID to Keragon's app for the selected environment, or the practice ID was entered incorrectly. Confirm the practice ID was copied from the department selection box with no extra spaces and that the right environment is selected. For Production, check that your A&C form has been processed. For Preview, follow Connect your Athena Preview environment.
401 Unauthorized Invalid or expired authentication token Reconnect the Athena Health connector in Keragon.
Subscription limit exceeded Attempted to register multiple subscriptions for the same event or entity Keragon allows only one subscription per event type, so reconfigure as needed.
No changes returned Incorrect filter or no new data available Make sure new data is being added to Athena and your filter parameters are accurate.
Department ID not recognized Invalid or deprecated department ID used in a trigger Confirm the department ID in the Athena UI and adjust filter settings if used.

Limitations and Notes

  • Athena integration uses a polling trigger model, so real time webhooks are not supported.
  • Triggers may take up to 20 minutes to become active.
  • Only one subscription per entity per practice ID (for example appointments or patients triggers) is allowed at a time.
  • Dashboard and API differences. Some actions may be permitted in the Athena UI but blocked or unsupported through the API.
  • Department filtering. The departmentid filter is available but not yet required. If your practice has many departments, this filter may be enforced later to improve efficiency.
  • Keragon integrates with athenaOne APIs, which are supported for all eligible clients.
Was this article helpful?
0 out of 0 found this helpful

Articles in this section