--- title: FHIR API docs now available — as a FHIR IG! description: Looking to use the FHIR API, or just wondering what it supports? The official Implementation Guide (IG) for the FHIR API for Bp Premier is now available! image: https://haloconnect.io/hubfs/AI-Generated%20Media/Images/The%20image%20is%20a%20stylised%20graphic%20representing%20data%20streaming%20across%20the%20internet%20The%20colours%20are%20mostly%20a%20rich%20purple%20and%20pink%20not%20too%20bright%20The%20overa.jpeg --- [![Halo Connect website ](https://haloconnect.io/hubfs/Halo%20Connect%20website%20.svg)](https://haloconnect.io) - [PRODUCTS](https://haloconnect.io/products) - [SERVICES](https://haloconnect.io/services) - RESOURCES - [CURRENT STATUS](https://status.haloconnect.io/) - [TRUST](https://haloconnect.io/trust) - [DOCS](https://docs.haloconnect.io/) - [BLOG](https://haloconnect.io/blog) - [FAQ](https://haloconnect.io/faq) - [ABOUT](https://haloconnect.io/about) - [ABOUT](https://haloconnect.io/about) - [CAREERS](https://haloconnect.notion.site/Halo-Connect-Careers-bbbcbc6352b84ada9d2bea34e01b447e) - CUSTOMER STORIES - [CUBIKO](https://haloconnect.io/cubiko) - [MESI / EBOS](https://haloconnect.io/mesi) - [CONTACT](https://haloconnect.io/contact-us) [BOOK A DEMO](https://meetings-ap1.hubspot.com/jasonbeem/external-booking-link-for-website) Interoperability # FHIR API docs now available — as a FHIR IG! Looking to use the FHIR API, or just wondering what it supports? The official Implementation Guide (IG) for the FHIR API for Bp Premier is now available! [Millie Macdonald](https://haloconnect.io/blog/author/millie-macdonald) Aug 28, 2025 --- The FHIR API for Bp Premier allows Bp Partners to query Best Practice Premier databases using the HL7® FHIR® standard. FHIR doesn’t just define a data standard though — it also defines a standard for documenting FHIR products, via something called an Implementation Guide, or IG. And now, the IG for the FHIR API for Bp Premier is live in the Bp Premier knowledge base! Click [here](https://kb.bpsoftware.net/au/bppremier/devportal/ImplementationGuide/index.html) to have a look - just note, you’ll need a login for the Bp Premier knowledge base to access it. (There’s also links in the knowledge base’s navigation menu, for next time you’re looking for the IG.) ## What does the IG cover? The IG includes a lot of information, at various levels of detail, including: - Getting started with the FHIR API and the IG - High-level explanations of different workflows and resource groups (e.g. the appointment booking workflow) - Details of individual resources (e.g. Patient, Appointment) and operations (e.g. Find Free Slots) available in the API - Supported search parameters for each resource For those familiar with the Bp Premier database, each resource’s page also includes information about how the resource maps to the SQL database, and any quirks of the translation between SQL and FHIR. For more information, check out the [Content Overview](https://kb.bpsoftware.net/au/bppremier/devportal/ImplementationGuide/index.html#content-overview) on the IG home page or the [How to read an IG page](https://kb.bpsoftware.net/au/bppremier/devportal/ImplementationGuide/how-to-read.html). ## How do I use an IG? An Implementation Guide (IG) is the official way to document a FHIR API. All official HL7 FHIR documentation is done as an IG, such as: - the [HL7 FHIR specification](https://hl7.org/fhir/), and - the [AU Base](https://build.fhir.org/ig/hl7au/au-fhir-base/index.html) and [AU Core](https://build.fhir.org/ig/hl7au/au-fhir-core/index.html) specifications Thanks to the tooling used to build IGs, all follow a similar format, making it easier to learn different FHIR products once you understand how to read any IG. However, the standard format is quite detailed and dense, and it can require some effort to learn how to read. So the IG includes a page that itself details the basics of [how to read an IG](https://kb.bpsoftware.net/au/bppremier/devportal/ImplementationGuide/how-to-read.html), with links to official guidance for the more detailed sections. There are also some resources available online for learning how to read an IG. InterSystems have a great series of videos explaining FHIR on Youtube. We recommend starting at the beginning with [**HL7 FHIR: What is it, really?**](https://www.youtube.com/watch?v=AkqNuxVBQKY&list=PLp4xNHWZ7IQkqH6bHsYVFkh1tX0P1_2VF&index=1&ab_channel=InterSystemsLearningServices) to get a general overview of FHIR, but if you want to skip to the videos specifically about IGs, jump to **[Understanding the Structure of HL7 FHIR Resources](https://www.youtube.com/watch?v=BmgAhxWQtZw&list=PLp4xNHWZ7IQkqH6bHsYVFkh1tX0P1_2VF&index=5&ab_channel=InterSystemsLearningServices).** As for official documentation, there is quite a bit in the HL7 FHIR specification which can get quite detailed. Much of it combines information about how to read an IG and how to implement the FHIR specification, so you will need to pick through the information available if you only need the former. Some particularly useful pages for learning how to read a FHIR IG are: - [Resource formats](https://hl7.org/fhir/R4/formats.html) - [Profiling FHIR](https://hl7.org/fhir/R4/profiling.html) (aka adapting FHIR resources for a use case, as we’ve done in the FHIR API for Bp Premier) - [Terminologies](https://hl7.org/fhir/R4/terminologies.html) (aka coded values) ## Everything you need, in one place The release of the official IG for our FHIR API for Bp Premier is a big step forward in making it easier for Partners to work with Best Practice data using a global standard. Whether you’re just starting with FHIR or already familiar with IGs, this guide is designed to help you get up to speed faster and build more confidently. We encourage you to explore the IG, bookmark it for future reference, and use it as your go-to resource when working with the FHIR API. ``` ``` [Interoperability](https://haloconnect.io/blog/tag/interoperability) [Best Practice](https://haloconnect.io/blog/tag/best-practice) [Features](https://haloconnect.io/blog/tag/features) [FHIR](https://haloconnect.io/blog/tag/fhir) ## Similar posts Interoperability ### [Announcing: A FHIR API for Best Practice Premier!](https://haloconnect.io/blog/fhir-for-bp-premier) In partnership with Bp Software, we have developed a FHIR facade that enables communication with practices running Bp Premier using the HL7 FHIR... Millie Macdonald Jun 19, 2024 Interoperability ### [What’s New in Halo: Desktop API, Webhooks, Integrator Portal, and FHIR Enhancements](https://haloconnect.io/blog/whatsnew2502) We've been busy! Here's a quick overview of the upcoming improvements across FHIR and security, plus three new features... Millie Macdonald May 21, 2025 Interoperability ### [New features to round out 2024!](https://haloconnect.io/blog/upcomingfeatures-1124) Interested in FHIR, OAuth, webhooks, or support portals? Here’s a round up of the new features we intend to release before the end of the year. Millie Macdonald Oct 31, 2024 © Halo Connect Pty Ltd 2023           All rights reserved           [Privacy Policy](https://haloconnect.io/privacy-policy)           [Terms and Conditions](https://haloconnect.io/terms-and-conditions)           [SLA](https://haloconnect.io/sla) ```json { "@context" : "https://schema.org", "@type" : "BlogPosting", "author" : { "@type" : "Person", "name" : "Millie Macdonald", "url" : "https://haloconnect.io/blog/author/millie-macdonald" }, "dateModified" : "2025-08-28T00:37:35.601Z", "datePublished" : "2025-08-28T00:37:35.000Z", "headline" : "FHIR API docs now available — as a FHIR IG!", "image" : [ "https://haloconnect.io/hubfs/AI-Generated%20Media/Images/The%20image%20is%20a%20stylised%20graphic%20representing%20data%20streaming%20across%20the%20internet%20The%20colours%20are%20mostly%20a%20rich%20purple%20and%20pink%20not%20too%20bright%20The%20overa.jpeg" ], "mainEntityOfPage" : { "@id" : "https://haloconnect.io/blog/fhir-ig-launch", "@type" : "WebPage" }, "publisher" : { "@type" : "Organization", "logo" : { "@type" : "ImageObject", "url" : "https://haloconnect.io/hubfs/Halo_logo.svg" }, "name" : "Halo Connect Pty Ltd" } } ```