Implementation Guide
23.x.x - R4 APIs
Publish Box goes here
| Official URL: https://docs.mydata.athenahealth.com/fhir-r4 | Version: 23.x.x | |||
| Active as of 2023-03-16 | Computable Name: Athena IG | |||
This guide describes the API Services provided by the FHIR® API Server in athenaPractice and athenaFlow products. The API Server component supports delivery of API integration capabilities. These products meet the 2015 Edition Cures Update Criteria requirements for Certified Electronic Health Records Technology published by Office of the National Coordinator (ONC).
FHIR® is the registered trademark of HL7 and is used with the permission of HL7. The Flame Design mark is the registered trademark of HL7 and is used with the permission of HL7.
The Security section provides an overview of the security controls that have been integrated into the API Server.
The following API resources are provided to support access to system resources describing the configuration of the API Server and the athenaPractice or athenaFlow application, clinical Resources providing information about a patients chart, and practice management resources used in scheduling and billing. Use of the clinical resources in the athenaPractice product requires the product be provisioned with a chart license. Use of practice management resources requires that the athenaPractice product be configured with a practice management license. Both Chart and Practice Management resources are available in athenaFlow (except for the Schedule and Slot resources which are not supported by that product). Details on these resources is included via the links in the table below.
| System Resources | Clinical Resources | Practice Management Resources | Custom Resources |
|---|---|---|---|
|
1 Access to these resources is through a profile of the HL7 FHIR Basic Resource to support concepts not current supported in FHIR DSTU Release 2.0.
2 These resources are only available through the athenaPractice or Practice Management products. They are not available in athenaFlow.
3 athenaPractice supports non-FHIR custom resource types for some Practice Management data. Custom resources conform to the basic requirements for any FHIR Base Resource with id and meta elements. The remaining elements are defined to have information needed in a given custom resource type
The API Server supports interoperability using the HL7 FHIR Release 4, and the HL7 CCDA 2.1 Implementation Guide and CDA Release 2.0 standards.
athenaPractice and athenaFlow use industry standard terminology as well as locally defined codes for observations, orders, medications, conditions, allergies and immunizations and other categories of information. Standard terminology supported includes LOINC, SNOMED CT, ICD-9-CM, ICD-10-CM, CPT-4, HCPCS, RxNorm, NDC and CVX codes, as well as HL7 standard codes used in HL7 CDA documents and FHIR resources. Mappings from athenaPractice and athenaFlow local codes to standard codes are available through the ConceptMap resource. Value sets configured in the athenaPractice and athenaFlow product (e.g., through Quick lists, Flowsheets or other product capabilities) are available through the ValueSet resource.
User authorization in these products is supported by the SMART on FHIR and OAuth 2.0 frameworks. End to end encryption is supported via Transport Layer Security (TLS) 1.1 and 1.2.
athenaPractice and athenaFlow API Servers support the following interoperability capabilities: