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
- Log in to Salesforce and navigate to the Setup page.
- Enter
MuleSoftin the Quick Find box, and then select MuleSoft Direct. - If prompted, enter your MuleSoft login credentials.
- Select the athenahealth Integration Client application and click Enable.
- Enter the application display name, target business group, environment for deployment, and Update Deployment Target, then click Next.
- Enter these details to configure the application properties:
| Serial Number | Application property name(Key name) | Sample value | Description |
|---|---|---|---|
| 1 | athenahealth Base URL | - | Base URL of the athenahealth sandbox |
| 2 | athenahealth Client ID | - | Client ID for the athenahealth EHR system. |
| 3 | athenahealth Client Secret | - | Client Secret for the athenahealth EHR system. |
| 4 | Ignore Schedulable Permissions | true | athenahealth allows booking of appointments marked as schedulable via the web. This flag allows you to bypass that restriction for booking in athenahealth. |
- 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
- Application property name(Key name): for example,
| Serial Number | Application property name(Key name) | Sample value | Description |
|---|---|---|---|
| 1 | athena.scope | athena/service/Athenanet.MDP.* system/Patient.read | Scopes to access resources in the FHIR server |
| 2 | athena.api.version | v1 | athenahealth Client app API version |
- 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:
- Download the JAR from Exchange.
- Import the JAR into Anypoint Studio.
- Extract the athenahealth Integration Client app JAR.
- Use the Postman collection from the src.test.resources folder to test the application.