> For the complete documentation index, see [llms.txt](https://docs.b2ihealthcare.com/snowray/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.b2ihealthcare.com/snowray/v3.1/reference/resources/upgrade.md).

# Upgrade

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.

{% hint style="info" %}
The upgrade is available for Value Sets, Reference Sets, Reference Set Collections, and Concept Maps.
{% endhint %}

{% hint style="info" %}
Only enterprise owned resources can be upgraded.
{% endhint %}

{% hint style="info" %}
You need write access to perform any sort of upgrade related actions.
{% endhint %}

Resources where a new domain version is available will be labeled with an ![](/files/6GEH8BvMUOGcScIP060B) tag as a visual indicator.

{% hint style="info" %}
The tags are displayed both in the Resources page list and the ***Overview*** tab of the selected resource.
{% endhint %}

Clicking on the ![](/files/6GEH8BvMUOGcScIP060B) tag will invoke the upgrade wizard.&#x20;

<figure><img src="/files/eOWPYruUGPoUYL7JWiyT" alt=""><figcaption><p>Upgrade Wizard</p></figcaption></figure>

| Field                        | Description                                                                                                                                                                                     |
| ---------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| **Upgrade title**            | <p>The title of the upgrade (mandatory)<br><em>Note:</em> By default, the field is populated with the selected resource's title</p>                                                             |
| **Current domain version**   | The version of the Code System domain that the resource currently depends on                                                                                                                    |
| **Upgrade domain version**   | <p>The version of the Code System domain that the resource will be upgraded to<br><em>Note:</em> By default, the latest available version is selected. It can be changed using the dropdown</p> |
| **Generate analysis report** | If ticked, an upgrade analysis report will be generated that collects useful information about the content                                                                                      |

Once the required fields are populated, users can proceed with starting the upgrade process by pressing the ![](/files/PboLsADfrSXxuWqRD3Cn) button.&#x20;

{% hint style="info" %}
This will navigate users to the Upgrade dashboard.
{% endhint %}

Resources with an ongoing upgrade process will be labeled with an ![](/files/GrpF8Rf58ClEXdtJLwB7) tag.

The impact of the upgrade can be examined and addressed in the [analysis](/snowray/v3.1/reference/resources/upgrade/analysis.md) report.

{% hint style="info" %}
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 ![](/files/GrpF8Rf58ClEXdtJLwB7) tag.
{% endhint %}

Once the necessary changes are made and the upgrade is considered complete, users can press the ![](/files/cGD0UWV1BhzTHau3TN8T) button to finalize the process.

{% hint style="info" %}
The upgrade process can also be abandoned by selecting the *Cancel* option from the ![](/files/2Pde4e4u7yFLLT7H4tvC).
{% endhint %}

## Upgrade flows

Running an upgrade is possible for single resources or Reference Set Collections.&#x20;

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.


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://docs.b2ihealthcare.com/snowray/v3.1/reference/resources/upgrade.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
