FHIR Directory API
What is the FHIR Directory API
The FHIR Directory API provides secure, system-to-system access to eHealth Exchange directory information. Designed for participants that want to consume directory data through technical integrations, it supports automated workflows and large-scale data retrieval.
What you can do with the FHIR Directory API
The FHIR Directory API provides structured, standards-based access aligned with modern interoperability frameworks enabling participants to:
Access production and non-production environments
Integrate directory data directly into internal systems
Support localized real-time operational workflows
Download and transform directory data for internal consumption
Monitory directory history and changes over time
Need to update directory data?
Any time you introduce a new subparticipant to the network, the directory needs to be updated with that information immediately.
The My Directory Portal enables organizations to update their sub-participants in the eHealth Exchange directory, ensuring compliance with OPP-17.
This helps participants understand who is requesting data and why, strengthening transparency and trust across the network for everyone involved.
Note: As a reminder, eHealth Exchange participants are required to review and update directory information annually.
Carequality and TEFCA™ participants
Participants connected to Carequality and/or the eHealth Exchange QHIN™ access and download directory data through the same FHIR API framework.
Who It's For
The FHIR Directory API is ideal for participants who have technical or engineering resources who can leverage system-to-system APIs to consume directory information.
Helpful Resources
FHIR API Directories - Technical Overview
Technical Specifications
Accessing Participant Directories via FHIR
Get Started
Participants can request a FHIR API key and receive support by contacting an eHealth Exchange administrator.
