Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Athenhealth offers a testing sandbox to interact and develop against their athenaOne and FHIR APIs Server. If you want to try out the AthenaHealth Adapter in Iguana X, you’ll first need to login or signup for an Athenahealth developer account and get access credentials:

Expand
titleGo to https://developer.api.athena.io/ams-portal/ and login or signup for an Athenhealth developer account

Go to https://developer.api.athena.io/ams-portal/ and login or sign up with password reset!

image-20240410-142715.pngImage Added

Note: You computer Public IP needs to be in Athenahealth supported region (ex. US), otherwise you won’t be able to access Athenhealth Sandbox

Expand
titleOnce you're logged in, in the Build Apps tab, click Create a New App

image-20240410-143938.pngImage Added

Expand
titleChoose API Access and App Category

API Access

  • We use “My app will use 1+ non-Certified APIs“ options for interacting both AthenaOne and FHIR API

AP Category

  • Select the OAuth method you’ll be using - in our case, we’ll use 2-legged OAuth since Iguana is connecting at a system level

Pasted image 20240321110248.pngImage Added

Expand
titleEnter your App details and Click Create Application

Expand
titleEnter your App details and click Save

Enter the following required information:

  1. Public-facing app name

  2. Description

  3. App Contact Information

  4. Authentication Method

    1. For our example, we use “Secret“ but Iguana X is capable of supporting “JWK“ authentication Method

  5. Click on “I Agree“

image-20240410-150929.pngImage Added

Expand
titleSave App Credentials and Click OK

Once you submit the details, you’ll receive your application credentials (Client ID and Secret). Make sure to note these down as you’ll need to load them into the component in Iguana.

image-20240410-151228.pngImage Added

Expand
titleGo to the Scopes page to manage your permissions
  • By default, the application will be loaded with the athenaOne scopes, which gives full access to the athenaOne endpoints

  • If you plan to work with FHIR, edit the scopes to include the specific resources you’ll be working with

  • Copy the scope paths as you’ll need to load these into the component in Iguana

    image-20240405-204750.pngImage Added
Expand
titleOptional - Check API Rate Limits

Click on “Rate Limts“ tab and observe API Rate Limits

image-20240410-151732.pngImage Added

Note: This specifies the number of API calls permitted per second and per day, as well as the number of token requests that can be made per minute. This is especially important to note during development as you can easily make more calls than intended while troubleshooting or writing code