Activating your FHIR APIs

You can set up your FHIR APIs so that you can access your health information.

1. Using the link and special key provided by the practice, you’ll be directed to this screen. Once on the site, select Login.

Screenshot 2023-09-25 at 12.51.03 PM.png

2. Next, select Click Here to Activate.

Screenshot 2023-09-25 at 12.51.46 PM.png

3. Enter information as specified:

  • First Name (Legal Name)
  • Last Name (Legal Name)
  • Date of Birth (MM/DD/YY)
  • Special key (given to you by the practice in your invitation)
  • Submit

Screenshot 2023-09-25 at 12.52.21 PM.png

4. After you have activated your account, keep your login credentials safe.

5. You will then land on a screen similar to the one below to further explain the setup process following instructions for Postman to configure.

Postman FHIR API.png

Below is a simple example of what the invitation looks like.

Sample Patient Email

Subject: Welcome to the <<Practice Name>> FHIR APIs

Hello,

This email is your invitation to access your personal health data using our practice's FHIR APIs. Accessing your data this way is optional and no additional steps are necessary on your part.

Our FHIR APIs are a modern way to securely interact with and retrieve your health information from our practice. These APIs are one of two options you have to access your health information. For most patients, using OnPatient.com to access their personal health information is the easiest and best choice. Reach out to your practice if you have not already set up an OnPatient.com account.

Your API Account Activation Information:

Steps to Complete

  1. To activate your account, please access the site by clicking here.
  2. Select Login
  3. An option for Click Here to Activate will be shown below the username and password fields
  4. Once selected, you will need to provide your First Name, Last Name, Date of Birth, and Activation Key (myN/MymSf6fxFLT/a)
  5. Create a Username and Password. Keep these credentials as you will need them to access your account.

Once activated, keep these details safe:

  • Your API ID: 101358
  • Your Activation Key: myN/MymSf6fxFLT/a

Why am I receiving this?

The Fast Healthcare Interoperability Resources (FHIR) is a standard for exchanging healthcare information electronically. It is designed to facilitate the exchange of electronic health records (EHRs) and other healthcare data between different systems.

The Interoperability and Patient Access final rule requires the use of FHIR by a variety of CMS-regulated payers, including Medicare Advantage organizations, state Medicaid programs, and qualified health plans in the Federally Facilitated Marketplace by 2021.

Specifically, the rule requires FHIR APIs for Patient Access, Provider Directory, and Payer-to-Payer exchange. The primary goal of the rule is to put patients first by giving them access to their health information when they need it most and in a way they can best use it.

Patients and their healthcare providers will have the opportunity to be more informed, which can lead to better care and improved patient outcomes, while at the same time reducing burden.

Warm regards,

The <<Your Practice Name Here>> Team