Athena Core Implementation Guide
2.33.0 - release
Athena Core Implementation Guide
2.33.0 - release
Athena Core Implementation Guide - Local Development build (v2.33.0) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions
| Official URL: https://fhir.athena.io/ImplementationGuide/athena-core-ext | Version: 2.33.0 | |||
| Active as of 2024-04-12 | Computable Name: AthenaCoreImplementationGuide | |||
This is the athenahealth Core Implementation Guide.
The athenahealth Core Implementation Guide is based on FHIR® Version R4 and the US Core Implementation Guide (STU3). It defines FHIR artifacts required for use in various contexts when interacting with athenahealth’s FHIR Server.
athenahealth provides a multi-tenant SaaS platform on which our customers provide healthcare services to their patients. The athenahealth FHIR Server is one way customers and partners can access healthcare data in a secure and controlled manner.
Various FHIR artifacts are defined to facilitate the use of our FHIR Server.
Profiles are typically defined to further constrain or extend (with specified Extensions) core FHIR resources or other profiles from supported Implementation Guides.
athenahealth also defines profiles to help document our FHIR RESTful APIs for inclusion in our Developer Portals. These profiles use athena-specific FHIR Shorthand RuleSets to capture information required in order to generate FHIR API documentation. They also document those optional data elements not supported by athenahealth.
athenahealth provides various organizational configurations for our customers’ use in organizing the management of their patients and their patients’ associated healthcare data. These organizational configurations support both the grouping of associated data and the setting of boundaries for access to this data. Defined as FHIR Organizations, these configurations do not necessarily represent ownership of the associated data. Rather, they define organizational relationships with that data, and these relationships can be used to define scopes for access of this data.
Extensions are defined to support the organizational configurations described above.
These extensions provide references to the athenahealth FHIR Organizations that represent these organizational configurations.
When appropriate, one or more of these extensions will be included in data returned via read and search interactions with athenahealth’s FHIR APIs.
Search parameters define named search items that can be used to search/filter on a resource. These are used to provide documentation for athenahealth search parameters in our FHIR server’s CapabilityStatement.
Operation definitions are defined to support public-facing FHIR operations. These can include “profiled” operation definitions where additional parameters have been added to the base operation definition as well as athenahealth specific operations. These are used to provide documentation for athenahealth operations in our FHIR server’s CapabilityStatement.
Naming systems define curated namespaces that issues unique symbols within that namespace for the identification of concepts, people, devices, etc.
They represent a “System” used within the Identifier and Coding data types.
These are used to provide documentation for athenahealth system values used in Identifiers and CodingSystems.
The following Postman collections are available:
These Postman collections are created for athenahealth’s FHIR R4 APIs accessed via the public Apigee API URLs. To use these Postman collections, you will need to register with the athenahealth Developer Portal (see) to obtain your credentials.
Familiarity with Postman collections is assumed.
Collection variables are used to store collection specific data that may/must be overridden.
These are found in the collection’s “Variables” tab.
This allows you to configure the collection for your requirements.
Specifically, clientId, clientSecret, and scope must be overridden with your personal authorization credentials.
After adding your personal authorization credentials, navigate to the “Authorization” tab. Scroll to the bottom and click on the “Get New Access Token” button. In the “Authentication Complete” dialog, click on the “Proceed” button or wait a few seconds for it to automatically transition to the “MANAGE ACCESS TOKENS” dialog. Review the content and click on the “Use Token” button. You are now ready to exercise the API requests in the collection.