athenahealth
Athena offers medical groups, hospitals, and health systems cloud-based EHR, practice management, and patient engagement services that seamlessly connect care and drive results for every client.
Athena offers medical groups, hospitals, and health systems cloud-based EHR, practice management, and patient engagement services that seamlessly connect care and drive results for every client.
Category: EHR Integrations. Adds 5 actions to a care flow.
What to configure
Set these once, on the extension in Awell Studio. An action fails at run time if a required setting is missing.
| Setting | Required | Notes |
|---|---|---|
| API URL | Yes | The base URL of the resource server/API |
| Auth server URL | Yes | Used to perform the Client Credential grant to obtain an access token |
| Client ID | Yes | Used to perform the Client Credential grant to obtain an access token Stored as a secret. |
| Client secret | Yes | Used to perform the Client Credential grant to obtain an access token Stored as a secret. |
| Practice ID | Yes | The ID of your practice within athenahealth |
| Scope | Yes | The value is a space-delimited, case-sensitive string of requested scopes. |
Actions
athenahealth adds these 5 actions to a care flow. Add one to a step, then fill in its inputs.
Add clinical document to chart
Add clinical document to patient chart
This action can be previewed in Studio before you publish.
| Input | Type | Required | Description |
|---|---|---|---|
| Department ID | string | Yes | — |
| Patient ID | string | Yes | — |
| Content | html | No | — |
Returns:
| Data point | Type |
|---|---|
clinicalDocumentId | string |
Create appointment note
Creates a note for a specific appointment
This action can be previewed in Studio before you publish.
| Input | Type | Required | Description |
|---|---|---|---|
| Appointment ID | string | Yes | — |
| Note text | text | Yes | — |
| Add note to homepage | boolean | No | Add appointment note to homepage display |
Create a note which will be appended to an appointment
Create patient
Create a patient in athena
This action can be previewed in Studio before you publish.
| Input | Type | Required | Description |
|---|---|---|---|
| Department ID | string | Yes | — |
| First name | string | Yes | — |
| Last name | string | Yes | — |
| Date of birth | date | Yes | — |
string | Yes | — |
Returns:
| Data point | Type |
|---|---|
createdPatientId | string |
Creates a patient in athenahealth. First name, last name, date of birth, email, and department ID are required. If a patient with the same name, date of birth, and email already exists, a new patient record will not be created. Instead, the existing patient's ID will be returned.
Get appointment
Retrieve appointment details from Athena
This action can be previewed in Studio before you publish.
| Input | Type | Required | Description |
|---|---|---|---|
| Appointment ID | string | Yes | — |
Returns:
| Data point | Type |
|---|---|
appointmentTypeId | string |
appointmentTypeName | string |
date | date |
duration | number |
patientId | string |
startTime | string |
status | string |
Retrieve the details of an appointment.
Get patient
Retrieve patient details from Athena
This action can be previewed in Studio before you publish.
| Input | Type | Required | Description |
|---|---|---|---|
| Patient ID | string | Yes | Logical identifier of the patient in Athena |
Returns:
| Data point | Type |
|---|---|
dob | date |
email | string |
firstName | string |
lastName | string |
Retrieve the details of a given patient within a given practice.
Setup and notes
Athenahealth
Athena offers medical groups, hospitals, and health systems cloud-based EHR, practice management, and patient engagement services that seamlessly connect care and drive results for every client.
Extension settings
For the extension to function correctly, you must configure the following settings:
- Auth server URL (e.g. https://api.preview.platform.athenahealth.com/oauth2/v1/token)
- Client ID
- Client secret
- API URL (https://api.preview.platform.athenahealth.com)
- Scope
- Practice ID
Changelog
Athena changelog
Where this page comes from
The settings, actions, inputs, outputs and webhooks above are generated from the
extension's own code, at @awell-health/awell-extensions v2.1.159. They match what the
platform actually does rather than a description of it.
Field-level detail also appears in Awell Studio when you configure the action. Something wrong or missing? Email support@awellhealth.com.