Step 1: Install the Taxonomy
Before You Start
Prerequisites
Retrieve your API Key. Depending on how you set up the app, downloading the taxonomy solution can add nearly 10,000 entities to your account. Prior to downloading the app, consult with your CSM to confirm whether your account can take on the required entities. Once confirmed, your CSM will share an API key that is required to complete the app installation. You will copy and paste this API key in the first step of the installation flow, detailed in Step 6 below.
We highly recommend testing out the solution in a sandbox account prior to installing on your production account. You can create a sandbox account by signing up for a playground account , which will include all of the necessary products and licenses to install taxonomy items. Keep in mind that these accounts have a 30-day expiration date, so let your CSM know if you’d like to extend your testing period.
Steps to Install
Follow the steps below to add the Healthcare Taxonomy Solution app to a sandbox or production account:
- Navigate to Apps > Directory. Select the Healthcare Taxonomy Solution from the list of apps (use the search in the top-left corner to find it quickly).
- Click Install. You will be redirected to the opening page of the app installation flow. Select Install on Yext.
- You will be brought to an overview of the API endpoints that the app will be granted permission to on your account. Click Authorize.
- Input the API key given to you by your CSM (see the Prerequisite for more details). Click Continue.
- Check off the entity types you would like to import, and then click Continue. We recommend adding as many taxonomy entities as your capacity allows, as they will only make your Search experience more advanced and/or your Pages most robust. For reference, here is an overview of the number of entities included for each type:
- Specialty: 64
- Subspecialty: 224
- Procedure: 2,006
- Conditions Treated: 3,560
- Reasons for Visit: 422
- Choose your data model and click Continue.
- The Doctors-to-Specialties model requires a lighter initial lift, while the Doctors-to-Terms model allows for more customized relationships.
- For more information, see the FAQ section of this guide.
- On the next page, you have the option to add a Search experience backend to your account. You can also learn how to install a function that will maintain parity between your doctors’ Listings categories and specialties. For more information on this function, see the Integrate your Doctors section of this guide.
- After choosing your options for adding a Search backend and the function, click Continue.
- Review your selections on this page. If you need to make any changes, go back through the flow and edit accordingly. If everything looks good, click Confirm.
- The app will now add resources to your account according to your selections. Feel free to leave this page, and allow at least 30 minutes for all the entities to be imported. You can confirm that the solution has been fully installed once all taxonomy-related connectors in your account have a “Last Run” time listed on the Connectors overview page.
Feedback
<% elem.innerText %>