Step 1: Install the Taxonomy

light bulb
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 your CSM who will check whether your account can intake 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.

Once you have retrieved an API key from your CSM, you are ready to apply the Healthcare Taxonomy Solution!

Note: We highly recommend testing out the solution in a sandbox account prior to installing on your production account. You can easily 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. Whether you’re installing in sandbox or production, follow the steps below to add the solution to your account!

  1. Log into your Yext account and navigate to the Apps > Directory section of the platform.
  2. Select the Healthcare Taxonomy Solution from the list of apps– you can use the search in the top-left corner to find it quickly!
  3. Click Install to start the installation flow.
  4. You will be redirected to the opening page of the app installation flow. Select Install on Yext.
  5. The following page offers an overview of the API endpoints on your account that the app will be granted permission. Click Authorize.
  6. Input the API key given to you when your CSM approved this app installation (see Prerequisite: Retrieve your API Key for more details). Click Continue.
  7. 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 amount of entities for each type:
    • ~115 Specialties
    • ~225 Subspecialties
    • ~6300 Conditions Treated
    • ~2400 Procedures
    • ~450 Reasons for Visit
  8. Choose your data model and click Continue. In short, the Doctors-to-Specialties model requires a lighter initial lift, while the Doctors-to-Terms model allows for more customized relationships.
    • For more information, go to the FAQ section below and read the answer to “What is the difference between the Specialties and Terms data models?”
  9. On the next page, you have the option to add a Search experience backend to your account. On this page, 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 following section of this guide ( Step 2: Integrate your Doctors ). Click Continue.
  10. Finally, 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, select Confirm.
  11. 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.

With the above steps completed, you have successfully installed the Healthcare Taxonomy Solution onto your account and are ready to integrate the data with your healthcare provider entities!

Feedback