Veradigm EHR
FHIR for Veradigm EHR
FHIR for Veradigm EHR gives your application read-only access to clinical data in Veradigm EHR through the Fast Healthcare Interoperability Resources (FHIR) standard. The FHIR standard keeps evolving, and our implementation supports FHIR release 4 (“R4”) along with the United States Core Data for Interoperability (“USCDI”) guidelines and requirements for data sharing.
Applications authenticate with User/Provider, Patient, or System credentials. Launch flows, System authentication, response formats and the Capability Statement are covered on the Configuration tab.
If you are looking for a bi-directional API with both read/write integration, you will need to use Unity.
EHR version 24.5 and later supports Single Sign-On. If your client is on an earlier version, use Unity to launch your application.
What FHIR connects to
Veradigm’s FHIR API provides standards-based, read-only access to clinical data in Veradigm EHR. To integrate with Veradigm Practice Management, developers must utilize Unity to read or write patient demographics, appointment, or financial data.
- US Core FHIR R4 resources
- US Core 3.1.1 and US Core 6.1 supported — US Core 6.1 uses separate base URLs containing
/USCore6.1/ - SMART on FHIR patient and provider launch
- Bulk data export for population-level queries
- Register and build entirely in the Veradigm Developer Program
Build with FHIR for Veradigm EHR
Five steps, in order — each one unblocks the next.
Read the API documentation
Understand what FHIR offers before you register anything.
- Tell us about your app. A guided intake that asks what you’re building and recommends the capabilities, resources, and scopes that fit your use case. Tell us about your app →
- Browse API Documentation. API Documentation lists every FHIR resource available by product, with endpoints, supported interactions, and required scopes.
- Confirm FHIR is the right API. FHIR is read-only. Use Veradigm proprietary APIs if your integration needs to write data back.
Register your app
Register your FHIR application to begin testing.
- Create the app. On the Veradigm Developer Program Dashboard, go to the My Apps tile and select + Create App.
- Add the required information. Every field is described in the reference below — App Type in particular must be accurate, since it determines which scope prefix you may request.
Application field reference
Fields on the FHIR App registration page.
| Field | Description |
|---|---|
| App Name | Enter an App Name that clearly identifies your company and product. This name will appear in our client License Management Portal where clients will elect to license your application, as well as our App Expo. |
| App Type | Intended audience for the application — Patient, Provider, or System. It is important to identify the App Type accurately.
|
| App Description | Detailed description of how and why the application is used. |
| Additional info link | Link to more information on the application — for example, the partner’s marketing website. Both the App Description and the Additional info link are displayed in the client License Management Portal to help EHR organizations identify the application when authorizing it. |
| JWKS URL (optional) | URL for backend authentication access (JWKS) tokens. A SMART on FHIR application developer is expected to stand up a JWKS endpoint for their public key, so keys can be recycled when necessary without contacting every FHIR API vendor they communicate with. |
| Redirect URLs | Up to five redirect URLs. Include redirect_uri urn:ietf:wg:oauth:2.0:oob for desktop applications; if you are developing a web client, use a URL pointing back to your website — for example, https://yourdomain.com/callback. |
| Launch URLs (optional) | URL used to launch a SMART on FHIR application. Enter up to three values. |
| Client Type | Indicate if this is a Confidential Client (trusted) or a Public Client (not trusted). |
| App Platform | Indicate if this is a Native App (desktop) or a Web App (mobile). |
- Select Purpose of Use. Required to understand why information is accessed or used, based on privacy rules and patient consent. Purpose of Use definitions are available on the FHIR test app.
Important
Purpose of Use drives the authorization of clinical data and is used by Veradigm EHR to leverage the consent workflow. An incorrect POU can lead to redacted information, so be sure to read through the definitions and select appropriately. For security reasons, POU cannot be changed once your application is in production.
- Select the appropriate scopes for the application. Scopes control what information the application can request from the EHR.
- Scopes must match the FHIR App Type and cannot be mixed. Patient apps use
patient/scopes, Provider apps useuser/scopes, and System apps usesystem/scopes. - If the application requires a refresh token, include the scope
offline_access.
SMART version 1 scopes end in
.read; SMART version 2 scopes end in.rs. Do not combine version 1 and version 2 scopes in a single FHIR application. The app will not be approved, and registration will be delayed. - Scopes must match the FHIR App Type and cannot be mixed. Patient apps use
- Collect your OAuth/FHIR credentials. The portal generates and displays your Client ID, Client Secret, and Client Secret Expiration Date.
As of 6/1/2025, Veradigm no longer provides support for DSTU2 as it approaches deprecation. The API is not turned off, but there is no longer technical support or resolution provided for any issues that arise.
The API returns DSTU2 or R4 according to the FHIR version installed at the organization. Before debugging an unexpected response shape, call [FHIR path]/metadata and confirm the Capability Statement reports "fhirVersion": "4.0.1". To request R4 from a version-less environment, add fhirVersion=4.0 to the Accept header, and check the organization’s version in the Endpoint Directory.
Test in the sandbox
Validate your integration against Veradigm EHR’s test environment before going live.
- Request sandbox credentials on the Sandboxes page. Sandbox credentials and connection details will be sent via email after your developer portal account has been validated. Use the Veradigm EHR credentials for authentication.
- Review the Configuration and Code Samples. Configuration & Code Samples walks through the token, auth, and call sequence, and lists the settings your app needs before you run your first sandbox call.
- Pick a test utility. Most API test utilities work. The Veradigm FHIR API team uses Postman to test Patient and Provider applications. System applications need a custom utility to generate the signed client assertion — see the C# sample on the Code Samples tab.
Path to production
Once testing is complete, ask the Veradigm Developer Program to promote your app.
- Verify your app’s details. Purpose of Use, scopes, and app details must all be production-ready. Incomplete apps cannot be activated.
- Request production access. Once testing is complete, navigate to your FHIR test application and request production access.
- Veradigm Developer Program reviews the app. The FHIR application is reviewed, and the developer is emailed by the Veradigm Developer Program to ensure validity. Once approved, clients can begin activating the FHIR application.
Do not request production access for the application until the application name, type, and Purpose of Use are finalized and the application is fully tested. These values cannot be changed once production access is granted.
Client Licensing
Make your app available to Veradigm EHR clients for licensing.
- Clients discover and license your app. Patient applications are auto licensed unless manually changed by the client. Provider and System apps require clients to use a separate portal called the License Management Portal for licensing and managing FHIR applications linked to their organization. Veradigm Developer Program and its developers cannot license applications on behalf of the client. Clients must activate applications themselves through the client License Management Portal.
Learn more about the client licensing process in the Veradigm Developer Program License Management Portal documentation. - Connect to the client’s production endpoint. Once your application is licensed, use the Endpoint Directory to look up the client’s FHIR endpoint URL and authenticate with your registered credentials. The Endpoint Directory is not part of the licensing process itself — it is the discovery mechanism you use afterward to determine how to connect to a given client organization.
