The Upgrade feature provides a smooth flow to help users easily navigate through the process of migrating to a newer version of the Code System that their resource depends on.
The upgrade is available for Value Sets, Reference Sets, Reference Set Collections, and Concept Maps.
Only enterprise owned resources can be upgraded.
You need write access to perform any sort of upgrade related actions.
Resources where a new domain version is available will be labeled with an tag as a visual indicator.
The tags are displayed both in the Resources page list and the Overview tab of the selected resource.
Clicking on the tag will invoke the upgrade wizard.
| Field | Description |
|---|---|
Upgrade title | The title of the upgrade (mandatory) Note: By default, the field is populated with the selected resource's title |
Current domain version | The version of the Code System domain that the resource currently depends on |
Upgrade domain version | The version of the Code System domain that the resource will be upgraded to Note: By default, the latest available version is selected. It can be changed using the dropdown |
Generate analysis report | If ticked, an upgrade analysis report will be generated that collects useful information about the content |
This will navigate users to the Upgrade dashboard.
The impact of the upgrade can be examined and addressed in the analysis report.
Running an upgrade is possible for single resources or Reference Set Collections.
In general, the two flows are the same in terms of the content validation types, but while the single resource upgrade only completes the process for the selected resource, the latter does that for the entirety of the Collection, i.e. all Reference Sets included in the selected Collection will undergo the upgrade process. This implies slight differences in the analysis as well, which are highlighted on the next page.
Once the required fields are populated, users can proceed with starting the upgrade process by pressing the button.
Resources with an ongoing upgrade process will be labeled with an tag.
You can leave the upgrade at any time, without interrupting the process. Your changes are autosaved and you can always return to it by clicking on the tag.
Once the necessary changes are made and the upgrade is considered complete, users can press the button to finalize the process.
The upgrade process can also be abandoned by selecting the Cancel option from the .
