Saltar al contenido principal

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​

NameTypeRequiredDescription
search_paramsjsonNoSearch parameters as key-value pairs
resource_idtextNoResource ID for read operations
family_nametextNoPatient family name for patient_search
given_nametextNoPatient given name for patient_search
birthdatetextNoPatient birth date for patient_search
identifiertextNoPatient identifier for patient_search

Output ports​

NameTypeRequiredDescription
resultjsonNoMain result data from the athenahealth FHIR operation
metadatajsonNoResponse metadata including resource type, counts, and operation details
successbooleanNoWhether the operation succeeded

Settings​

Basic​

SettingNameTypeRequiredDefaultAllowed valuesDescription
athenahealth Base URLathena_base_urlstringYesBase URL of the athenaOne instance
OperationoperationenumYessearchsearch, read, patient_searchFHIR operation to perform
Resource Typeresource_typestringNoPatientFHIR resource type to operate on

Auth​

SettingNameTypeRequiredDefaultAllowed valuesDescription
Client IDclient_idsecretYesOAuth2 client ID for athenahealth authentication
Client Secretclient_secretsecretYesOAuth2 client secret for athenahealth authentication
Practice IDpractice_idstringNoathenahealth practice ID (sent as X-Practice-Id header)

Advanced​

SettingNameTypeRequiredDefaultAllowed valuesDescription
Search Parameterssearch_paramsjsonNoDefault search parameters as key-value pairs
Resource IDresource_idstringNoResource ID for read operations (can also come from input)

Errors​

CodeDescription
ATHENA_AUTH_FAILEDFailed to obtain OAuth2 token from athenahealth
ATHENA_SEARCH_FAILEDathenahealth FHIR search returned an error
ATHENA_READ_FAILEDathenahealth FHIR read returned an error
RESOURCE_ID_REQUIREDresource_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..