PDex $everything FHIR API Specification
Service Overview
InterSystems Payer Services Payer Data Exchange (PDex) APIs support the sharing of patient health data and are designed in compliance with the CMS-0057-F regulationsOpens in a new tab. The APIs allow providers to access clinical data for patients they have a relationship with, and payers to access health information held by a member's previous payer. These APIs use a REST-based FHIR endpoint.
The $everything operation allows providers to retrieve all information related to a specific resource. This implementation supports the Patient resource. It can be used by a provider to retrieve a patient's entire record from the patient's payer.
Refer to the Getting Started section for information on connectivity, authentication and how to get help. To use the APIs, you will need to know the server URL of the FHIR server you will be connecting to.
Workflow
A provider can use the $everything operation to request the medical record of a single patient they have an attributed treatment relationship with.
A typical workflow involving this API might be:
-
The provider uses the $member-match operation to request the unique member identifier for their patient from the patient's payer.
-
The payer returns the member's FHIR identifier to the provider.
-
Using the returned FHIR identifier, the provider invokes the $everything operation to retrieve the patient's data from the payer.
Endpoint: $everything
Base URL
The base URL of the $everything operation is:
<server url>/csp/healthshare/<namespace>/app/api/responder/FHIRResponderService
where <server url> and <namespace> have been provided to you by the payer organization you are connecting with.
Optional Capabilities
None.
Endpoint Prerequisites
You have the FHIR identifier for the patient whose data you want to retrieve.
Required Header Settings
-
Accept: application/fhir+json
Request Methods
where <patientID> is the FHIR identifier of the patient you are retrieving data for.
Query Parameters
None. Optional parameters such as start and end date are not supported.
Request Body
None.
Success Responses
The request succeeded. All resources relating to the requested patient are returned as a Bundle of FHIR resources.
Error Responses
The following response error codes are possible when using this operation:
Possible causes include:
-
No valid token found
Possible causes include:
-
Token does not include required OAuth scopes
Possible causes include:
-
The requested patient was not found
-
Your system has missing configuration
Possible causes include:
-
An internal request in the process timed out