2025 Releases

This page lists Halo Connect's 2025 releases and the changes made in each release.

Version 25.620

Includes:

Halo Link version 25.619.5767
- Staging: June 20, 2025
Halo Cloud version 25.619.5778
- Staging: June 20, 2025
Integrator Portal version 25.619.5784
- Staging: June 20, 2025

Features

Streamlined the process of collecting Halo Link log files for support cases

Improvements

Increased granularity of Integrator Portal access controls
Clarified UI wording in the Integrator Portal

Version 25.617

Includes:

Halo Link version 25.613.5663
- Staging: June 17, 2025
Halo Cloud version 25.616.5708
- Staging: June 17, 2025

Features

Webhook notifications now fully supported

An experimental version of webhook notifications was released late last year for feedback. Various improvements have now been made, including additional optional security features, and webhooks is generally available and fully supported as of this release.

Please see the webhooks documentation for more information, or contact Support to configure webhooks for your integration.

Stub Pairing API available for testing

Protecting practice data is one of our main goals, and a key aspect of that is locking down access to practice databases. In collaboration with Best Practice Software, we have designed a new authorisation workflow for practices running Bp Premier which adds additional layers of protection for their data.

The Pairing API will replace the step in onboarding a practice where integrators would currently trade a Bp Site ID for the practice's Halo GUID, and introduce a second identifier - a pairing code - to ensure the integrator connects to the correct practice. The pairing of an integrator and a practice will also be recorded, and integrators will not be able to retrieve or query practices they are not paired with.

Zedmed and D4W will also require integrators pair with a site by calling the pairing endpoint, however only Bp Premier will require a pairing code. Zedmed and D4W will continue to only require a PMS ID.

The full workflow will be added to Bp Premier in a future release. However, to give integrators time to transition, this Halo Cloud release includes a stub of the new endpoint for the Pairing API.

This stub:

Will allow integrators to see the shape of the new endpoint, and test it with dummy data
Will not validate the pairing code supplied, and therefore will not return errors

There will be no impact to integrators' ability to access databases as this time Restrictions based on pairing will roll out in a future release. As this is a breaking change, the rollout will come with at least 90 days notice.

Please see the API reference for details of the new endpoint, and please keep an eye out for further communications from Best Practice and Halo Connect regarding the future rollout.

Improvements

Upgraded Halo Link dependencies.

Bug fixes

Various bug fixes for Halo Link.

Version 25.603

Includes:

Halo Cloud version 25.602.5508
- Staging: June 3, 2025
Integrator Portal version 25.602.5500
- Staging: June 3, 2025

Features

Integrator Portal now available in staging

The Integrator Portal is no longer an MVP, and is now available for testing in staging ahead of its production release.

Its current functionality is focused on empowering self-service support and allows integrator staff to easily:

Check the connectivity status of Halo Link at a practice
Send a test query to a practice

To register for the Portal or to request features please contact Support.

Async result streaming endpoint

A new endpoint has been added for retrieving async query result pages via streaming, rather than as a JSON payload. This is an alternative option for those integrators who would like to use it -- the old endpoint is still supported.

Streaming query results is more performant and more robust, and is particularly recommended for any integrators handling large amounts of data. Clients may need to change HTTP processing logic in order to handle streamed responses.

The API reference has been updated with the new endpoint.

Please contact Support for more information.

Improvements

Various security improvements for the Desktop API.
Various performance improvements.

Version 25.513

Includes:

Halo Link version 25.513.5244
- Staging: May 13, 2025
- Production (alpha): May 27, 2025
- Production: June 5, 2025
Halo Cloud version 25.513.5251
- Staging: May 13, 2025
- Production: May 27, 2025

Features

Desktop API

The new Desktop API will enable desktop applications to securely connect to Halo Cloud with a different authentication workflow, which is based on the standard JWT protocol. This will enable integrators with desktop applications to avoid proxying all API requests through their cloud.

Please contact Support or the Bp Partnerships team to learn more.

Improvements

Various new clinical resources for the FHIR API for Bp Premier.

Bug fixes

Various bug fixes for multiple FHIR resources.

Version 25.506

Includes:

Halo Link version 25.407.4905
- Staging: May 6, 2025
- Production (alpha): May 13, 2025
- Production: June 3, 2025

Improvements

Improvements to Halo GUID and hostname sync

Previously, it was possible for a practice's Halo GUID and hostname to be different in Halo Cloud and Halo Link's registry entries. This created two issues:

For Bp Premier, the Halo GUID in the registry at a practice may not be the Halo GUID assigned to that practice by Halo Cloud after server changes. This issue did not cause service disruptions but it did mean that the local Halo GUID would be different to the Halo GUID integrators should use for routing queries.
For Zedmed and D4W, server changes such as database additions, removals, or changes were not automatically detected. This required manual intervention to trigger Halo Link to detect the changes and resync with Halo Cloud. New or changed databases would not be available for querying until this manual step was completed, and removed databases would appear available though queries would fail.

This version includes an improvement which solves both of these issues, by ensuring that Halo Cloud and Halo Link resynchronise each time Halo Link starts up. This results in two behavioural changes:

For Bp Premier, practices may notice the Halo GUID in the Halo Link registry change after a restart. This is intended, though it should only happen after server changes.
For Zedmed and D4W, database changes should now be automatically detected on Link restart. New or updated databases will receive a new Halo GUID, which integrators will need to fetch.

Version 25.401

Includes:

Halo Cloud version 25.331.4826
- Staging: April 1, 2025
- Production: April 14, 2025

Improvements

Various internal improvements.

Version 25.306

Includes:

Halo Link version 25.305.4578
- Staging: March 6, 2025
- Production (alpha): April 1, 2025
- Production: April 15, 2025

Improvements

Upgraded Web PubSub connection handling to improve resilience.
Various internal improvements.

Version 25.211

Includes:

Halo Link version 25.210.4417
- Staging: February 11, 2025
- Production (alpha): February 18, 2025
- Production: February 20, 2025
Halo Cloud version 25.205.4380
- Staging: February 11, 2025
- Production: February 18, 2025
Halo Portal version 24.1218.4149
- Staging: February 11, 2025

Improvements

Various security improvements.
Various new clinical resources for the FHIR API for Bp Premier.

Bug fixes

Fixed a bug that caused Zedmed database connections to not close correctly.
Fixed a bug in the FHIR API that incorrectly handled invalid resource IDs during reference search.
Fixed a bug in the FHIR API that added a redundant & to pagination URL links.
Fixed a bug with :missing not working correctly for certain FHIR resource fields.

Version 25.121

Includes:

Halo Link version 25.121.4280
- Staging: January 21, 2025
- Production (alpha): February 18, 2025
- Production: February 20, 2025
Halo Cloud version 25.109.4246
- Staging: January 21, 2025
- Production: January 30, 2025

Improvements

Various internal improvements.
Various new appointment booking related resources for the FHIR API for Bp Premier.

Bug fixes

Fixed a bug with immediate query timeouts. This may result in some error states that previously returned a Precondition Failed error now returning a Query Failed to Initialized error.
Applied fix for CVE 2024-43485.
Various bug fixes for the FHIR API for Bp Premier.