Skip to main content

Upgrading Health Connect

Because Health Connect 2019.1 and later is powered by InterSystems IRIS, the process for upgrading Health Connect to a new major release or maintenance release is similar to upgrading the underlying InterSystems IRIS technology. Though all the steps may not apply to your Health Connect implementation, you should follow the upgrade process found in Upgrading InterSystems IRIS.

If you are upgrading from Health Connect 15.03 to Health Connect 2019.1 or later, see Upgrading from Health Connect 15.03.

Upgrading Pre-2021.1 FHIR Endpoints

FHIR server endpoints that were installed before Health Connect 2021.1 must be manually upgraded after installing the newer version of your product. These manual upgrade steps vary based on whether your FHIR server used custom subclasses of the architecture:

  • If your FHIR server used custom subclasses of the architecture, you must use an IDE to modify your subclasses before running a post-upgrade method in the InterSystems Terminal.

  • If your FHIR server used the default InteractionsStrategy (HS.FHIRServer.Storage.Json.InteractionsStrategy) without custom subclasses, you can skip to running the post-upgrade method in the InterSystems Terminal.

Modifying Architecture Subclasses

As part of the new FHIR architecture that was introduced in Health Connect 2020.1, you can use a custom InteractionsStrategy to implement a custom FHIR server. If your FHIR server’s endpoint used a custom InteractionsStrategy, you must complete the following steps before running the Terminal method that upgrades the FHIR server endpoints. Endpoints without customization can skip to Running the Post-Upgrade Method.

  1. Complete the upgrade of your Health Connect instance.

  2. Using an IDE, create a subclass of the HS.FHIRServer.API.RepoManager superclass.

  3. Add the following parameters to your subclass of the Repo Manager:

    • StrategyClass — Specifies the subclass of your InteractionsStrategy.

    • StrategyKey — Specifies the unique identifier of the InteractionsStrategy. This must match the value of the StrategyKey parameter in the InteractionsStrategy subclass.

  4. If your InteractionsStrategy subclass included custom code for the methods that manage the Service, you must move that logic to the new methods in the Repo Manager subclass that you created. Specifically, you must move custom code from the Create, Delete, Decommission, and Update methods to the corresponding methods in your Repo Manager subclass (CreateService, DeleteService, DecommissionService, and UpdateService ).

  5. Run the post-upgrade method in the InterSystems Terminal.

Running the Post-Upgrade Method

The last step in upgrading a pre-2020.4 FHIR endpoint is to run a post-upgrade method in the InterSystems Terminal. If your FHIR server used custom subclasses, be sure to modify the subclasses before completing the following procedure.

  1. If you have not already done so, complete the upgrade of your Health Connect instance.

  2. Open the InterSystems Terminal, and navigate to the HSLIB namespace. For example

    set $namespace = "HSLIB"
    Copy code to clipboard
  3. Execute the following command:

    set status = ##class(HS.HC.Util.Installer.Upgrade.FHIRServer).UpgradeFHIR()
    Copy code to clipboard
  4. Confirm that the post-upgrade method was successful by entering:

    write status
    Copy code to clipboard

    The result should be 1.

  5. Open the Management Portal, and navigate to Health > myFHIRnamespace > FHIR Configuration.

  6. Select the Server Configuration card.

  7. For each existing endpoint, select Reindex Now. When prompted, click Select All, and then select Reindex.

Upgrading from Health Connect 15.03

Health Connect 2019.1 was the first release of Health Connect that is powered by InterSystems IRIS. Because of this change in underlying technology, a special upgrade procedure is required when upgrading from a previous version of Health Connect. If you are upgrading to Health Connect 2019.1 or later from Health Connect 15.03, see the InterSystems IRIS In-Place Conversion Guide, which is available from the InterSystems WRC DocumentsOpens in a new window page.

FeedbackOpens in a new window