athenahealth FHIR
Category: EHR & Practice Mgmt
Node id: athenahealth-fhir
Standards: HIPAA, GDPR, SOC2
Integrates with athenaOne via FHIR R4 API for searching, reading, and patient lookup operations
What it does
- OAuth2 authentication with athenahealth-specific scopes
- FHIR R4 search and read operations
- Patient-specific search by demographics and identifier
- Practice-level scoping via X-Practice-Id header
Use cases
- Query patient records from athenaOne for population health analytics
- Search athenahealth for patients across practices
- Integrate athenaOne clinical data into multi-EHR pipelines
Runtime
- Performance tier:
variable
Input ports
| Name | Type | Required | Description |
|---|---|---|---|
search_params | json | No | Search parameters as key-value pairs |
resource_id | text | No | Resource ID for read operations |
family_name | text | No | Patient family name for patient_search |
given_name | text | No | Patient given name for patient_search |
birthdate | text | No | Patient birth date for patient_search |
identifier | text | No | Patient identifier for patient_search |
Output ports
| Name | Type | Required | Description |
|---|---|---|---|
result | json | No | Main result data from the athenahealth FHIR operation |
metadata | json | No | Response metadata including resource type, counts, and operation details |
success | boolean | No | Whether the operation succeeded |
Settings
Basic
| Setting | Name | Type | Required | Default | Allowed values | Description |
|---|---|---|---|---|---|---|
| athenahealth Base URL | athena_base_url | string | Yes | Base URL of the athenaOne instance | ||
| Operation | operation | enum | Yes | search | search, read, patient_search | FHIR operation to perform |
| Resource Type | resource_type | string | No | Patient | FHIR resource type to operate on |
Auth
| Setting | Name | Type | Required | Default | Allowed values | Description |
|---|---|---|---|---|---|---|
| Client ID | client_id | secret | Yes | OAuth2 client ID for athenahealth authentication | ||
| Client Secret | client_secret | secret | Yes | OAuth2 client secret for athenahealth authentication | ||
| Practice ID | practice_id | string | No | athenahealth practice ID (sent as X-Practice-Id header) |
Advanced
| Setting | Name | Type | Required | Default | Allowed values | Description |
|---|---|---|---|---|---|---|
| Search Parameters | search_params | json | No | Default search parameters as key-value pairs | ||
| Resource ID | resource_id | string | No | Resource ID for read operations (can also come from input) |
Errors
| Code | Description |
|---|---|
ATHENA_AUTH_FAILED | Failed to obtain OAuth2 token from athenahealth |
ATHENA_SEARCH_FAILED | athenahealth FHIR search returned an error |
ATHENA_READ_FAILED | athenahealth FHIR read returned an error |
RESOURCE_ID_REQUIRED | resource_id is required for read operation |
Runtime notes
- patient_search returns both a FHIR bundle and a flat patients array — downstream nodes can consume either format
- OAuth2 uses athenahealth-specific scopes (athena/service/Athenahealth.MDP.*); ensure the client app has these grants
- practice_id scopes all requests to a specific practice via X-Practice-Id header — omit for cross-practice queries
- search_params from the input port override matching keys in config search_params
See Build any workflow for how to put nodes together and Ports, types and data flow for how port types connect.
¿Algo no está claro? Envíe sus comentarios sobre la documentación por correo electrónico..