The Developer Portal allows technical client users to access and use ThoroughCare's FHIR APIs easily and independently. Any user with the customer administrator role can assign the new role of "Developer" to any user, which will grant that user access to the Developer Portal.
Developer User Role
The developer role can be assigned in conjunction with any other role; for example, a physician user can also be a developer user. To assign this role, navigate to the "Users" section of the menu and either create a new user or edit an existing user.
If creating a new user, fill out the user's first and last name, give them a username and password, and assign them any necessary practices. Scroll down to the roles section of the modal and find the Developer role. Select the checkbox and save. The user will see the Developer Portal the next time they log into ThoroughCare.
Developer Portal Functionality
When logging into ThoroughCare with the developer role, the user will see a new section in the hamburger menu titled "Developer".
API Key Management
Upon selecting the Developer menu option, the user will land on the API Key Management page. From this page, users can generate keys to authorize their use of the API. Users can generate as many new keys as they like, but the credentials do not expire. We recommend writing down your credentials after generating them because the secret will be partially hidden after navigating away from the page. The Client ID will mimic the user's current access; meaning that will be able to access data for any practice they have access to via the APIs.
FHIR API Documentation
The second tab available to developer users is the FHIR API Documentation. From this tab, users can access all available FHIR APIs that ThoroughCare has available. Users will be able to retrieve, update, and delete data from all their practices using these APIs.
ADT API Documentation
The third tab within the developer portal is the ADT API Documentation. This is a PDF file containing information regarding how to access the ADT API, as well as the information users are able to retrieve via the API. The ADT API currently uses separate credentials from what's generated in the developer portal; please reach out to the ThoroughCare support team for credentials to utilize the ADT API.
To access other helpful ThoroughCare articles in the Knowledge Base or to get help from the ThoroughCare Support team members, click the ‘i’ icon in the top right corner of the software next to the username and use the appropriate link!