Knowledge Base
CCDA-to-FHIR Parser Workflow
The CCDA-to-FHIR parser can be used in lieu of the implementer directly handling the category-specific methods. Instead, when a data category request is received from an API user, the server will request a CCDA from the Data Holder to be parsed for more granular data elements using CCDA-to-FHIR. This process eliminates a significant amount of work for developers, thus allowing for more rapid phiQuery integration. Here we explain the Parser’s workflow in more detail.
There are three actors ultimately involved: 1) a 3rd party Client App leveraging public OAuth and HL7 FHIR APIs (such as HealthToGo) 2) Interoperability Engine® software, and 3) the Data Holder’s phiQuery listener, which enables 3rd party apps to access their clinical data. The customers’ phiQuery instance returns the requested CCDA according to their authentication and authorization policy logic.
This CCDA-to-FHIR workflow is enabled by bidirectional communication between FHIR Client Apps and the Interoperability Engine software using FHIR APIs, and between the Interoperability Engine and the Common Clinical Data Set (CCDS) using the phiQuery Integration API.The phiQuery API enables an EHR or other health information Data Holder to respond to queries made by 3rd party client applications through the Interoperability Engine’s public API.
CCDA-to-FHIR Workflow:
1. FHIR Client App requests authentication to an EMR Direct-hosted FHIR endpoint using publicly available documentation
2. User enters credentials into the Interoperability Engine OAuth sign in page
3. An AuthenticateAPIUser request is called with session credentials; Identifies data source and user; returns true or false.
a. If true, the OAuth process continues and the Client App is given an access token
b. If false, an error is returned
4. If true, Client App may request ONE of the following, leading to the workflow specified under each:
a. App requests patient list with search parameters
-GetPatientID called with params; data holder returns list of authorized Patient ID’s
b. App requests CCD with dates OR App requests data category with dates
-phiQuery requests IsAPIUserAuthorized & GetCCD from the Data Holder
5. If the App requests data category with dates, CCDA to FHIR is invoked. The FHIR Response is returned to Client App.
This workflow can only be achieved if the CCDA documents are suitable for use with the parser; as one example to consider, the parser is appropriate only when a candidate CCDA format has been tested with the parser and has been validated as returning the correct results. Contact support@emrdirect.com for additional information, to evaluate the phiQuery CCDA-to-FHIR parser using CCDAs returned by your system, or to switch back to phiQuery without CCDA-to-FHIR.
Did this article answer your question? If not, please contact us.