The FHIR documentation & Google search

Google search is the entry point to most websites.

The FHIR documentation is no exception. The problem is the results it returns are not ideal when searching for FHIR key words.

Go to your browser and search for these words:

  • fhir documentation
  • fhir servicerequest
  • fhir search

This is what you’re likely to see.

In all cases, the first result returned is a link to the v6 build pages. These are the continuously updated pages documenting a version of FHIR that has not yet been released.

If you’re lucky, the second result will show the correct and current page from the documentation.

The pattern seems to be that all non “resource specific” searches return the build pages first. But sometimes this also happens when searching for a resource type like “fhir servicerequest.”

The problem here is that the build pages look the same as the regular pages in the documentation. It’s hard to tell the difference.

People read and then link to the build pages in error thinking they’re the current pages. I’ve seen these links shared internally across teams and externally on posts and websites.

I’ve often done it myself by mistake.

Even when the correct results are returned, it’s easy to click the wrong result and end up on the build pages.

A search for “fhir patient” returns this.

The first result is the correct and expected result, but the page has no description and no official icon.

The second result — for the build page — has a FHIR icon and a full description of the page.

Which one do you think people click on?

Even knowing what I know, I find myself often clicking on the second result by mistake — my eye is drawn to the FHIR icon and the descriptive text.

These issues have existed for over a year now. To me, they seem fixable.

Maybe start by de-indexing the build pages, then move on to addressing the missing icon and descriptive text for the regular pages.

Simple changes but a huge improvement for everyone making FHIR related searches.

---

Download my “FHIR Architecture Decisions” book

FHIR Weekly

Join 1,100+ business and technical leaders.

Discover more from Darren Devitt

Subscribe now to keep reading and get access to the full archive.

Continue reading