athenahealth Integration Client

Setup

Pre-requisites
  • Be familiar with Intelligent Appointment Management and EHR setup. You must connect to Athenahealth and obtain the appropriate connect credentials.
  • athenahealth systems require both a practice ID and a department ID. To fulfill this requirement, you must include the practice ID and department ID in the ID Value in this format: practice.id=xxx__department.id=xxx.
Setup
  1. Log in to Salesforce and navigate to the Setup page.
  2. Enter MuleSoft in the Quick Find box, and then select MuleSoft Direct.
  3. If prompted, enter your MuleSoft login credentials.
  4. Select the athenahealth Integration Client application and click Enable.
  5. Enter the application display name, target business group, environment for deployment, and Update Deployment Target, then click Next.
  6. Enter these details to configure the application properties:
Serial NumberApplication property name(Key name)Sample valueDescription
1athenahealth Base URL-Base URL of the athenahealth sandbox
2athenahealth Client ID-Client ID for the athenahealth EHR system.
3athenahealth Client Secret-Client Secret for the athenahealth EHR system.
4Ignore Schedulable Permissionstrueathenahealth allows booking of appointments marked as schedulable via the web. This flag allows you to bypass that restriction for booking in athenahealth.
  1. If adding additional parameters as required by the athenahealth Integration Client app, for example, scope, click Add Additional parameters and then enter these details to configure the application properties:
    • Application property name(Key name): for example, scope
    • Sample value: for example, system/Observation.read system/Patient.read
    • Description: for example, Scopes required to send to an external FHIR server
Serial NumberApplication property name(Key name)Sample valueDescription
1athena.scopeathena/service/Athenanet.MDP.* system/Patient.read athena/service/Athenanet.MDP.* system/Organization.read system/CareTeam.read system/Medication.read system/MedicationRequest.read system/Practitioner.read system/PractitionerRole.read system/AllergyIntolerance.read system/Coverage.readScopes to access resources in the FHIR server
2athena.api.versionv1athenahealth Client app API version
3athena.ah-practice1959071PracticeID of Athena
  1. Click Proceed to deploy the application.
Requesting Access

To use the deployed app, you must request access in Anypoint Exchange to obtain the application credentials (Client ID and Client Secret).

For detailed steps, see Requesting Access.

Post-Deployment

MuleSoft endpoints can be triggered as mentioned in the API Specification.

To edit the app locally:

  1. Download the JAR from Exchange.
  2. Import the JAR into Anypoint Studio.
  3. Extract the athenahealth Integration Client app JAR.
  4. Use the Postman collection from the src.test.resources folder to test the application.

Security notice: Configure TLS and the keystore for production

This application includes a sample Java KeyStore (athena-client-app-keystore.jks) to help you deploy quickly and test locally. Don't use this keystore in production.

You're responsible for provisioning your production keys. Before you send production traffic to the application, replace the sample keystore with your organization's own private key and certificate.

Follow the steps for your deployment model.

If you deploy to CloudHub 2.0 Private Spaces.

You can manage your certificates at the platform level, without changing the application.
1. In Anypoint Platform, go to Runtime Manager > Private Spaces.
2. Select your private space, and then click Domains & TLS tab.
3. In the TLS context configuration, upload your organization's PEM or JKS file.
4. Enter the passwords and aliases that your organization's certificate requires.

For more information, see CloudHub 2.0 Private Space TLS Documentation.

If you deploy to CloudHub 1.0, Runtime Fabric, or a standalone runtime.

Before you deploy, add your own keystore to the application artifact.
1. Generate a new, organization-specific JKS using your own PKI or the Java keytool.
2. Open the application artifact (or import it into Anypoint Studio), and go to src/main/resources/tls/.
3. Delete the default athena-client-app-keystore.jks file, and then add your new .jks file.
4. Update the application's configuration properties to match your new keystore. You can do this on the Properties tab in Runtime Manager or in your YAML configuration file.
keystore.alias: keystore.storeSecret: * keystore.secret: 5. Deploy the updated application artifact.

For more information, see MuleSoft TLS Configuration Guide.

TypeApplication
OrganizationMuleSoft
Published by
MuleSoft Organization
Published onNov 4, 2026
Asset overview
Industries CloudHealth
Custom fields

Asset versions for 1.0.x

Asset versions
VersionActions
1.0.7
1.0.6
1.0.5
1.0.4
1.0.3
1.0.2