FHIR® Implementation Guide (IG)

This guide describes the API Services provided by the API Server. The API Server is a new component introduced in athenaPractice 12.3 and athenaFlow 9.12 products to support delivery of API integration capabilities. These products meet the 2015 Certified Electronic Health Records requirements from ONC.

FHIR® is the registered trademark of HL7 and is used with the permission of HL7.

Organization of this Guide

The Security section provides an overview of the security controls that have been integrated into the API Server.

Supported APIs

35 different 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

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.

Supported Standards and Vocabulary

The API Server supports interoperability using the HL7 FHIR Standard for Trial Use Release 2.0 , 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 , Rx-NORM , 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 protocols. End to end encryption is supported via Transport Layer Security (TLS) 1.1 and 1.2 .

Service Pack 2 adds support for the following additional interoperability capabilities:

  • Argonaut Data Query Implementation Guide support for the following profiles

    • AllergyIntolerance
    • CarePlan
    • Condition
    • Device
    • Observation Results
    • Goal
    • Immunization
    • Medication
    • MedicationOrder
    • MedicationStatement
    • Patient
    • Procedure
    • Smoking Status Observation
  • IHE Scanned Document (XDS-SD ) Profile via the $convert-cda operation
  • HL7 CCDA 2.1 Unstructured Document Template also via the $convert-cda operation
  • IHE Patient Identifier Cross Referencing for Mobile profile (PIXm ),
  • IHE Patient Demographic Query for Mobile (PDQm ),
  • IHE Query for Existing Data for Mobile Profile (QEDm ), and
  • HL7 FHIR Standard for Trial Use Release 3.0 resources supporting the above mentioned IHE profiles for mobile access. STU3 resources can be accessed from [base]/ihe/fhir instead of [base]/fhir.