now supports the Flexpa APIPatient $expunge route.
This route allows you to delete all data scoped in a specific Patient resource compartment while preserving the ability to refresh the patient access token.
We've updated the
https://api.flexpa.com/fhir/metadata route to return Flexpa's CapabilityStatement.
We've also removed the requirement for an
Authorization header when making requests to this route.
Previously, this route returned a CapabilityStatement that was generated by the Endpoint FHIR server that a patient was authorized to.
This was not a Flexpa-specific CapabilityStatement and did not include Flexpa-specific information.
Flexpa's CapabilityStatement is the only CapabilityStatement needed to use Flexpa's new API successfully.
will show all payers available in the US, including the appropriate status to indicate whether Flexpa is still implementing.
For payers we are still implementing, it will show "Not yet available" and allow the user to request the endpoint.
This feature allows users to know concretely that they've searched for their payer correctly and allow them to contact Flexpa about that payer. Flexpa Link
Previously, only showed payers that Flexpa had completed implementation with and established connectivity. Flexpa Link
We've added a new argument to the
create method of : Flexpa Link
This argument allows you to pass in a
user object that will be associated with the patient access token generated by . Flexpa Link
user object yields the following outcomes:
- The user can be associated with multiple Patient Access Tokens, allowing for improved insights into user behavior.
- Flexpa enforces logical isolation of the user's data between family members if the payer does not implement appropriate Access Control Limits.
We've updated the Flexpa API architecture to ensure we consistently deliver the operations and search parameters needed by customers and ensure a reliable, expectable, and performant API experience when making FHIR requests.
You can read more about the new Flexpa API architecture here.
The feature is in beta and can be utilized by adding the HTTP header
X-Flexpa-Raw: 0 to FHIR requests.
This will be the API behavior once released to general availability.
After the initial stabilization period, all customers will be migrated to this new architecture.
We've added patient access token logs to Flexpa Portal for more streamlined troubleshooting and improved understanding of user behaviors.
You can now see a history of all patient links through your application with information about their state, error messages, and endpoints.
We have added details around how customers can validate their live mode connection using our "Flexpa Live Mode Sample Patient" endpoint.
This allows customers to validate their live mode credentials and configuration without having to have a patient authorize with a payer.
We've fixed a bug related to CORS issues and updated our Quickstart to route FHIR requests through the local backend server.
If you are testing with our Quickstart, we recommend synchronizing this latest version to understand how to route requests through the backend server.
We've enhanced the workspace dashboard in Flexpa Portal, adding step-by-step user guidance for test and live mode setup.
This guided experience is designed to offer greater clarity on getting started with Flexpa.
Additionally, the application and team management sections have been moved to separate pages in the sidebar navigation.
You can provide
autoExit: false to 's Flexpa Link
create method to prevent the modal/dialog from closing automatically upon completion.
true if not provided.
We added new documentation about installing in Flexpa Linkmobile applications to better assist implementers.
We deprecated the /payers route and the
payer response property of the endpoints API.
Instead, developers should reference the /organizations route and the
organization response property of the endpoints API.
This is the final step of a renaming initiative that was described on 2023-07-19.
We renamed the "payers" API to "organizations" and renamed the
payer response property of the endpoints API to
Both old and new naming conventions will be supported until August 9, 2023, after which only the new naming convention will be used.
We did this because an "organization" can be either a payer, provider, or a vendor entity.
GET /link/introspect in now has a Flexpa API
state field in its response. This can be used to determine if a Patient Access Token is not only valid but potentially usable or refreshable.
We removed the string " application" from all application names in our database. This string was previously appended due to legacy code which we have since deprecated.
With this update, 's header now is cleaner and easier for users to read when they link their health plans. Flexpa Link
Previously, there was no easy way to handle errors that occurred during the authorization flow. This could leave developers in the dark about issues that users were encountering, and it could leave users frustrated with a broken experience. Flexpa Link
With this update, the
onExit callback now has an optional
error parameter, provided when members proceed through the authorization flow but encounter an error. This enables developers to handle these errors gracefully, by perhaps showing the user an error message or logging the error for later debugging.
We are making a change to improve the user experience within . From now on, endpoints undergoing downtime will be automatically deactivated and will no longer be available for user selection. Flexpa Link
Flexpa is committed to providing a seamless user experience. As part of our quality assurance process, we routinely monitor our connected endpoints to ensure they are functional. In instances where we detect downtime, we have previously shown their status in but still allowed users to proceed. Flexpa Link
However, we recognized that this could potentially result in a suboptimal user experience as unsuccessful connections may occur. To prevent such issues, we have updated our system to automatically deactivate any endpoints detected to be experiencing downtime.
This change will ensure a smoother and more reliable connection experience for our users. We appreciate your understanding and cooperation.
is now available in both English and Spanish. Users can smoothly toggle between languages using designated buttons in the UI, ensuring a more inclusive user experience. Flexpa Link
Understanding the health of the endpoints you and your users care about is important. While we previously surfaced this information in , we've now added this information to our general documentation. Flexpa Link
In order to provide the best visibility into the status of endpoints you may need to connect to, we've added the
status detail to our endpoint list. This detail will provide a high-level overview of the status of an endpoint, including whether it is currently available.
This is also programmatically available via the Flexpa API.
Link exchange and refresh responses may now include a
refresh_expires_in value. This represents the time in seconds for which the
access_token is refreshable, after which the user will be required to re-authorize your application to the payer.
The availability of
refresh_expires_in is subject to the Endpoint's support of the feature.
In this update, we've made some significant enhancements to the loading screen and user flow to ensure a more seamless and transparent experience.
- To make the loading process more intuitive and user-friendly, we've enriched the loading screen with troubleshooting tips and guidance for handling common authorization challenges.
- To improve patients' understanding of the process, we've introduced a new step in the flow. This step provides a clear explanation of what happens when you are redirected to a payer's member portal or identity provider to validate your credentials.
- To increase context on errors, we've improved the error screen when a patient's plan is ineligible, allowing the patient to request support for their plan.
The revoke endpoint of the now invalidates all authorizations that a patient had previously made to an application. Read more about these details on the Flexpa APIrevoke section of the Flexpa API documentation.
Flexpa's API now works behind the scenes to standardize code system URIs in FHIR responses.
We've added a page that references which code system URIs developers can expect to see in FHIR payloads.
While MyFlexpa has existed for a long time, our documentation on its value and use for patients and developers have not.
We've added a page that details how to best use this tool alongside other Flexpa offerings.
We've added a new way to use our docs: FlexpaGPT. Ask questions about Flexpa and get back responses instantly.
- A button displayed on the bottom right of the page that will open up a chat window
- Ask questions about Flexpa and get answers instantly
- FlexpaGPT links to relevant documentation, code snippets, and more
We've added an indicator to the endpoint selection screen to notify patients when an endpoint connection is unstable. Flexpa Link
- The indicator will display as a message in red above the affected endpoint's label
- This enhancement improves the patient experience by increasing their awareness of known endpoint issues and encouraging them to retry later
now displays health plan logos in the selection screen. This update should improve plan recognition and help patients identify their health plan correctly. Flexpa Link
We've updated the styling of the health plan selection screen in for better usability. This new design removes the coloured backgrounds to improve the contrast ratio and provide a more consistent experience. Flexpa Link
We also have updated our health plan search to more robustly identify the plans a patient may be searching for. This includes fuzzy matching on searches and searching across applicable brand names a payer may use.
The exchange endpoint of the now returns additional metadata about the health plan ( Flexpa APIEndpoint) a patient has used to authorize your application.
This metadata includes attributes such as the Endpoint name, whether or not the authorization is refreshable, and a list of FHIR Resources available for this Endpoint.
Read more about these details on the exchange section of the Flexpa API documentation.
(0.0.10) now supports Flexpa Link
onLoad callback functions passed to
onExit is called when the user exits the authorization flow without succesfully authorizing
onLoad is called when Link is loaded and ready to be used
We have released Flexpa Connections, an application that lets patients manage their health plan authorizations.
- Patients can log in with their health plan and view a history of applications they've connected through Flexpa Link
- Patients can disconnect apps they no longer want their health plans connected to and reconnect them anytime through Flexpa Link
- Check out the Flexpa Connections documentation for more information
After user testing and customer feedback, we have removed all minimums from our Basic plan. This pure usage-based pricing should allow early testing and onboarding, aligning value with predictable cost. Check out additional details here.
The introspect endpoint of the now returns additional metadata about the specific endpoint associated with the access token you are using. Read more about these details on the Flexpa APIintrospect section of the Flexpa API documentation.
(0.0.8) now supports the option to skip the health plan search / select step in our authorization flow. Flexpa Link
This supports an improved UX flow in cases where a patient's health plan is known to the application implementing prior to starting the authorization. Flexpa Link
Patient access tokens created with now have support for a refresh mechanism. Flexpa LinkRefreshing a patient access token allows your application to make requests after the original one has expired.
- Where possible, Flexpa obtains an
offline_access scope and exposes a refresh route
- Refreshing a patient access token will invalidate the previous patient access token and return a new one
Note that not all patient access tokens support refreshing. Major payer support includes Kaiser Permanente, Cigna, Humana, UnitedHealth, and Anthem.
We are launching a small guide on basic data analysis with FHIR bundles you get from . Flexpa API
- This guide explains how to go from raw FHIR bundles from , and transform them into structured tables that conform to Flexpa APITuva's data model
- We've co-developed a FHIR parser with Tuva that converts FHIR bundles into database-ready CSVs for structured analysis
We are launching pagination support to simplify accessing FHIR Resource search results.
- Developers can pass the query parameter
_count into search requests and use the returned
link object to access the paginated results
- More information about pagination is available on the API reference page
We are launching the Flexpa Portal, a new way for developers to manage their Flexpa account.
- This new option allows for developers to create an account, generate API keys, and invite other members of their organization to collaborate.
- Our portal can be accessed here
We are launching the ability to customize the appearance of with the Flexpa Link
customLinkConfig configuration object.
- This new configuration object provides a way to configure to match implementers' UI/UX more closely Flexpa Link
- Initially supporting four
- Instructions on implementation available here
We are launching the new patient access guide and FHIR Resource reference pages.
- The newly updated patient access guide provides a background on Patient Access APIs and the data they make available
- The FHIR Resource pages provide sample request and response data for FHIR Resources (ex. Coverage) that can be accessed using Flexpa API
We are launching the Wildcard Parameters feature in . This allows you to reference real values provided by the Flexpa APIPatient Access Token in each request.
The first parameter we are supporting is
$PATIENT_ID, allowing you to use the currently authorized
patient_id in each request without having to know what it is.
- Removes the
patient_id as a field in the response of
- Updates FHIR Server to accept Wildcard Parameter,
GET /fhir/Patient/$PATIENT_ID -H "Authorization: $ACCESS_TOKEN"
GET /fhir/Coverage?patient=$PATIENT_ID&_count=5 -H "Authorization: $ACCESS_TOKEN"
GET /fhir/ExplanationOfBenefit?patient=$PATIENT_ID -H "Authorization: $ACCESS_TOKEN"
Note: Using the introspect endpoint and sending the actual
patient_id will also continue to work.
We are launching the NodeJS-based Quickstart repository and accompanying guide.
- The Quickstart Github repository is a cloneable project to help you get started with Flexpa in just a few steps
- The Quickstart guide walks through how to build and run Flexpa's quickstart example
We are launching and Flexpa Link, including our major feature release of self-service test mode API keys. Flexpa API
- is a client-side component to help your users link health plan data sources Flexpa Link
- is a unified HL7 FHIR API (HTTP + JSON) to access health plan, claims, and clinical data Flexpa API