Generating API Credentials from the Patient Portal

Portal-enabled patients now have the ability to generate API credentials to be utilized against our FHIR API. For instructions on enabling patients for the Patient Portal, please see our guides for the Basic and Premium Portals. Open documentation on www.icanotes.com for a PDF download of this guide. 

To generate API credentials, log in to the Patient Portal (https://patientonlineportal.com) with patient credentials. From the top menu, click My History

From My History, look to the section labeled FHIR API Access. Click Generate New Credentials

Give a name to the credentials you are generating. For example, if a patient wants to provide their API to an application on their phone, such as a health app, they can name the credentials as such. Click Submit.

Credentials have been generated. Use the copy button  to the right of the key and secret to copy the credentials to your computer’s clipboard (or use your mouse and keyboard shortcuts to copy), then paste where desired, such as in Notepad

For security purposes, once you click Done you will not be able to copy the key and secret again. The credentials will remain active within the Portal until they are deleted, which can be done by clicking the trash icon on the far right

A toast notification will appear at the bottom right corner of the Portal confirming the deletion

Multiple API credentials may be generated as needed. Once a set of credentials is deleted it will no longer share data, effectively severing the connection. If sharing API across multiple apps or vendors, it is a good idea to generate separate credentials.