> 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/snowray-v1.1.1/start.md).

# Getting Started

This page is dedicated to demonstrate a real-life workflow with the intention of helping users to get familiar with Snowray. As part of the workflow, users will start off by creating a [value set](/snowray/snowray-v1.1.1/reference/resources/valuesets.md) and then [editing ](/snowray/snowray-v1.1.1/reference/resources/valuesets.md#authoring)its content. Next, after learning how to browse and edit [resources](/snowray/snowray-v1.1.1/reference/resources.md), users will be introduced to release management. Finally, the [released](/snowray/snowray-v1.1.1/reference/resources/valuesets/release.md) value set will be [exported](/snowray/snowray-v1.1.1/reference/resources/valuesets/export.md) enabling it to be shared.

{% hint style="info" %}
To benefit the most from the tutorial, start from the very beginning, and continue step by step, as it will walk you through the most important functionalities of Snowray.
{% endhint %}

### Contents

1. :key2: [Log in](#login)
2. \*\*\*\*:blue\_book: \*\*\*\* [Create a Value Set](#create-a-value-set)
3. \*\*\*\*:pencil: [Add Clauses](#add-clauses)
4. :mag\_right: [Find Value Set](#find-value-set)
5. :clipboard: [Check Member Details](#check-member-details)
6. :calendar: [Create a Release](#create-a-release)
7. :pen\_ballpoint: [Edit Clauses](#edit-clauses)
8. :x: [Delete Clauses](#delete-clauses)
9. :white\_check\_mark: [Add Suggestions](#add-suggestions)
10. \*\*\*\*:blue\_book: \*\*\*\* [Create a Value Set and Add Clauses](#create-a-value-set-andadd-clauses)
11. \*\*\*\*:twisted\_rightwards\_arrows: [Merge Value Set](#merge-value-set)
12. :nerd:[ Optimize Value Set](#optimize-value-set)
13. :calendar: [Create a Second Release](#create-a-second-release)
14. :repeat: [Compare Value Sets](#compare-value-sets)
15. :arrow\_down: [Export Value Set](#export-value-set)

## :key2: Log in

To access Snowray, enter your username and password in the corresponding boxes of the login page, then press the![](https://1046423764-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F-MfXbzY7oaJUjXyvlBQk%2Fuploads%2Fgit-blob-cf74ee12bd3ee174dc4272ab81b04971ae55a218%2Flogin_button.png?alt=media)button. You will be taken to the [Dashboard](/snowray/snowray-v1.1.1/reference/dashboard.md) page.

![Login Page](https://1046423764-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F-MfXbzY7oaJUjXyvlBQk%2Fuploads%2Fgit-blob-42c14d9d62017eb83d2d185da863b86c6598115d%2Flogin_page.png?alt=media)

## :blue\_book: Create a Value Set

To create a [draft ](/snowray/snowray-v1.1.1/reference/resources.md#lifecycle)resource, press the![](https://1046423764-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F-MfXbzY7oaJUjXyvlBQk%2Fuploads%2Fgit-blob-240ff7fa0619907240b25b562592d357ad001fc4%2Fcreate_button.png?alt=media)button from the main menu bar. Then select value set as the resource type, fill out the required fields, and press Create. For now, do not create a SNOMED CT reference set.

![Create a New Value Set](https://1046423764-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F-MfXbzY7oaJUjXyvlBQk%2Fuploads%2Fgit-blob-4b68198760c46624bbf979265b7c84780cdbe0b5%2Fvalue_set_create.gif?alt=media)

:paperclip: **Read more about creating value sets:**

{% content-ref url="/pages/-MgGqxbZagcfHkcqa4cL" %}
[Create](/snowray/snowray-v1.1.1/reference/resources/valuesets/create.md)
{% endcontent-ref %}

## :pencil: Add Clauses

To add clauses, navigate to the authoring page by pressing the ![](https://1046423764-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F-MfXbzY7oaJUjXyvlBQk%2Fuploads%2Fgit-blob-c4aaa8bfb12e74c79b891fb0f386502e6f2cba11%2Fedit_button.png?alt=media) button. After that, you can [drag and drop](/snowray/snowray-v1.1.1/reference/resources/valuesets/authoring/dnd.md) concepts from the terminology tree or create a new clause with the [basic clause editor](/snowray/snowray-v1.1.1/reference/resources/valuesets/authoring/editor.md).

![Add Clauses to a Value Set](https://1046423764-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F-MfXbzY7oaJUjXyvlBQk%2Fuploads%2Fgit-blob-2d732d88078e108c95a3ca6bddc0228131264875%2Fgs_vs_add_clauses.gif?alt=media)

:paperclip: **Find out more about adding clauses:**

{% content-ref url="/pages/-MgLcMXzcbuGo0jbITv-" %}
[Authoring](/snowray/snowray-v1.1.1/reference/resources/valuesets/authoring.md)
{% endcontent-ref %}

## :mag\_right: Find Value Set

To find an already created value set that is not visible on the [Dashboard](/snowray/snowray-v1.1.1/reference/dashboard.md) (e.g. after finishing a session in Snowray and starting a new one later on), navigate to [Resources](/snowray/snowray-v1.1.1/reference/resources.md) from the main menu bar and type the value sets name into the filter search box.

![Find a Resource](https://1046423764-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F-MfXbzY7oaJUjXyvlBQk%2Fuploads%2Fgit-blob-f0ee8171c4c57413262af193a2e3df1ff10b8c62%2Fgs_find_resource.gif?alt=media)

:paperclip: **To read more about finding a resource we suggest checking out the following page:**

{% content-ref url="/pages/-MfXhF4t206h-20AqLaP" %}
[Resources](/snowray/snowray-v1.1.1/reference/resources.md)
{% endcontent-ref %}

## :clipboard: Check Member Details

To find out more about a certain member, navigate to the Members tab and click on a concept. This will take you to its [detail page](/snowray/snowray-v1.1.1/reference/resources/codesystems.md#concepts) where you can find more information on the selected member.

![Linking between Concepts](https://1046423764-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F-MfXbzY7oaJUjXyvlBQk%2Fuploads%2Fgit-blob-17461bfe83108689ea44b926be5833fecd2905e9%2Fgs_concept_linking.gif?alt=media)

{% hint style="info" %}
:bulb: Texts with blue fonts are usually links.
{% endhint %}

## :calendar: Create a Release

To create a release, navigate back to the value set, click the Releases tab, and press the![](https://1046423764-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F-MfXbzY7oaJUjXyvlBQk%2Fuploads%2Fgit-blob-a585451b26424cb7e7edf91ee4c421682473ce70%2Fcreate_release_button.png?alt=media)button. Fill out the fields and press the![](https://1046423764-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F-MfXbzY7oaJUjXyvlBQk%2Fuploads%2Fgit-blob-39bb2f51819e1ab31d356866cbf03a0bf19e5a4f%2Fpublish_release_button.png?alt=media)button.

![Create a Release](https://1046423764-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F-MfXbzY7oaJUjXyvlBQk%2Fuploads%2Fgit-blob-7edae028c9d381259bd298539827a759c5265e12%2Fgs_release.gif?alt=media)

{% hint style="info" %}
After creating a release, it is advised to change the resource's status to [active.](/snowray/snowray-v1.1.1/reference/resources.md#lifecycle)
{% endhint %}

:paperclip: **Find out more about creating a version:**

{% content-ref url="/pages/-MgGql6UbKK856TdmMb4" %}
[Release Management](/snowray/snowray-v1.1.1/reference/resources/valuesets/release.md)
{% endcontent-ref %}

## :pen\_ballpoint: Edit Clauses

To edit the value set, navigate to the authoring page by pressing the ![](https://1046423764-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F-MfXbzY7oaJUjXyvlBQk%2Fuploads%2Fgit-blob-c4aaa8bfb12e74c79b891fb0f386502e6f2cba11%2Fedit_button.png?alt=media) button. Hover over an existing clause to reveal the![](https://1046423764-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F-MfXbzY7oaJUjXyvlBQk%2Fuploads%2Fgit-blob-04a456c475f8e83a16830ff35129232038fb1ad2%2Fedit_icon.png?alt=media)icon, which enables editing the selected clause. To persist the changes you made, click on the green checkmark.

![Edit Clauses](https://1046423764-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F-MfXbzY7oaJUjXyvlBQk%2Fuploads%2Fgit-blob-1620d50ec960c008704bfe506a40e35170aedb98%2Fgs_edit_clause.gif?alt=media)

:paperclip: **Read more about authoring:**

{% content-ref url="/pages/-MgLcMXzcbuGo0jbITv-" %}
[Authoring](/snowray/snowray-v1.1.1/reference/resources/valuesets/authoring.md)
{% endcontent-ref %}

## :x: Delete Clauses

To edit the value set, navigate to the authoring page by pressing the ![](https://1046423764-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F-MfXbzY7oaJUjXyvlBQk%2Fuploads%2Fgit-blob-c4aaa8bfb12e74c79b891fb0f386502e6f2cba11%2Fedit_button.png?alt=media) button. You can then delete clauses either individually or in a batch using the ![](https://1046423764-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F-MfXbzY7oaJUjXyvlBQk%2Fuploads%2Fgit-blob-5dafe554031a3d375df1a5334048a2ebb68c0c01%2Fdelete_icon.png?alt=media) icon.

![Delete Clauses](https://1046423764-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F-MfXbzY7oaJUjXyvlBQk%2Fuploads%2Fgit-blob-62804bdf2110c41bc4071789c3168e5eae0c5d8e%2Fgs_delete_clause.gif?alt=media)

:paperclip: **Find out more about deleting:**

{% content-ref url="/pages/-Mgk5U7Wfz9Y7QCnNWxv" %}
[Delete/Retire](/snowray/snowray-v1.1.1/reference/resources/valuesets/delete.md)
{% endcontent-ref %}

## :white\_check\_mark: Add Suggestions

{% hint style="info" %}
Suggestions are meant to help users by advising clauses that could be missing from a value set.
{% endhint %}

To reveal suggested clauses, press the![](https://1046423764-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F-MfXbzY7oaJUjXyvlBQk%2Fuploads%2Fgit-blob-fcf7ea753c9cb05deb1de0b469347834a4b70216%2Fsuggestions_button.png?alt=media)button in the upper right corner of the authoring page. Check the boxes of ones that are applicable to your value set and press the<span data-gb-custom-inline data-tag="emoji" data-code="2795">:heavy\_plus\_sign:</span>button to add them.

![Add Suggestions](https://1046423764-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F-MfXbzY7oaJUjXyvlBQk%2Fuploads%2Fgit-blob-e9acefb15037a3261d4ff40ea20c4c0bef1fb238%2Fvalue_set_suggestions.gif?alt=media)

:paperclip: **A more detailed description of suggestions can be found here:**

{% content-ref url="/pages/-MgPbr4gZLf9I\_cfxi2a" %}
[Suggestions](/snowray/snowray-v1.1.1/reference/resources/valuesets/authoring/suggestions.md)
{% endcontent-ref %}

## :blue\_book: Create a Value Set and<span data-gb-custom-inline data-tag="emoji" data-code="1f4dd">:pencil:</span>Add Clauses

To create a [draft ](/snowray/snowray-v1.1.1/reference/resources.md#lifecycle)resource, press the![](https://1046423764-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F-MfXbzY7oaJUjXyvlBQk%2Fuploads%2Fgit-blob-240ff7fa0619907240b25b562592d357ad001fc4%2Fcreate_button.png?alt=media)button from the main menu bar. Then select value set as the resource type, fill out the required fields, and press Create. For now, do not create a SNOMED CT reference set.

To add clauses, navigate to the authoring page by pressing the ![](https://1046423764-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F-MfXbzY7oaJUjXyvlBQk%2Fuploads%2Fgit-blob-c4aaa8bfb12e74c79b891fb0f386502e6f2cba11%2Fedit_button.png?alt=media) button. After that, you can [drag and drop](/snowray/snowray-v1.1.1/reference/resources/valuesets/authoring/dnd.md) concepts from the terminology tree or create a new clause with the [basic clause editor](/snowray/snowray-v1.1.1/reference/resources/valuesets/authoring/editor.md).

![Create Value Set and Add Clauses](https://1046423764-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F-MfXbzY7oaJUjXyvlBQk%2Fuploads%2Fgit-blob-f06731d2a276572f9e12a4d1fef64521fefc8635%2Fgs_create_add_clauses.gif?alt=media)

:paperclip: **Read more about creating value sets:**

{% content-ref url="/pages/-MgGqxbZagcfHkcqa4cL" %}
[Create](/snowray/snowray-v1.1.1/reference/resources/valuesets/create.md)
{% endcontent-ref %}

:paperclip: **Find out more about adding clauses:**

{% content-ref url="/pages/-MgLcMXzcbuGo0jbITv-" %}
[Authoring](/snowray/snowray-v1.1.1/reference/resources/valuesets/authoring.md)
{% endcontent-ref %}

## :twisted\_rightwards\_arrows: Merge Value Set

To merge a value set into another, navigate to the authoring page of the value set you want to merge into by pressing the ![](https://1046423764-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F-MfXbzY7oaJUjXyvlBQk%2Fuploads%2Fgit-blob-c4aaa8bfb12e74c79b891fb0f386502e6f2cba11%2Fedit_button.png?alt=media) button. Then press the ![](https://1046423764-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F-MfXbzY7oaJUjXyvlBQk%2Fuploads%2Fgit-blob-3f03572d4b526d2da771e4a94257de4fbee9314d%2Fmerge_button.png?alt=media) button and select the value set which will be merged into the edited value set.

![Merge Existing Value Sets](https://1046423764-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F-MfXbzY7oaJUjXyvlBQk%2Fuploads%2Fgit-blob-8897c20d39df9da86aee7925851fbd3b2b858b03%2Fgs_merge_vs.gif?alt=media)

:paperclip: **A more detailed description of merging value sets can be found here:**

{% content-ref url="/pages/-MiW\_4LxOgXb-GawJKg-" %}
[Merge](/snowray/snowray-v1.1.1/reference/resources/valuesets/merge.md)
{% endcontent-ref %}

## :nerd: Optimize Value Set

{% hint style="info" %}
Optimizing helps to construct improved *includes* and *excludes* criteria by decreasing the number of clauses.
{% endhint %}

To invoke the function, press the![](https://1046423764-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F-MfXbzY7oaJUjXyvlBQk%2Fuploads%2Fgit-blob-6a4fb4f76e3bd9f363b9c9017b99e2e7557f54f9%2Foptimize_button.png?alt=media)button in the upper right corner of the authoring page. If the suggested changes are acceptable, press the![](https://1046423764-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F-MfXbzY7oaJUjXyvlBQk%2Fuploads%2Fgit-blob-afbba71512d1b27689d86c5dfd4f16674beed566%2Fapply_button.png?alt=media)button.

![Optimize Clauses](https://1046423764-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F-MfXbzY7oaJUjXyvlBQk%2Fuploads%2Fgit-blob-66448d1fc47a7a63a55a1151dec533ff2b708c4c%2Fgs_optimize.gif?alt=media)

\*\*\*\*:paperclip: **Read more about optimization:**

{% content-ref url="/pages/-MgLcMXzcbuGo0jbITv-" %}
[Authoring](/snowray/snowray-v1.1.1/reference/resources/valuesets/authoring.md)
{% endcontent-ref %}

## :calendar: Create a Second Release

To create additional releases, simply follow and complete the same steps as in the [Create a Release](#create-a-release) section.

![Create the Second Release](https://1046423764-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F-MfXbzY7oaJUjXyvlBQk%2Fuploads%2Fgit-blob-86cfaeaf304d686b59fa085f2d344ec247f58d94%2Fgs_second_release.gif?alt=media)

## :repeat: Compare Value Sets

To start comparing value sets, navigate to the [Releases page](/snowray/snowray-v1.1.1/reference/resources/valuesets/release.md#browse-releases), and press the![](https://1046423764-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F-MfXbzY7oaJUjXyvlBQk%2Fuploads%2Fgit-blob-02b722519efdb75f4f879a0497021e34c6cde5b5%2Fcompare_button.png?alt=media)button next to the version.

![Compare Versions](https://1046423764-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F-MfXbzY7oaJUjXyvlBQk%2Fuploads%2Fgit-blob-a17d47e27847d56c40353e2966ecf5b835955441%2Fgs_compare.gif?alt=media)

:paperclip: **A more detailed description can be found on the following page:**

{% content-ref url="/pages/-Mgo7Cvj9dsIf22CviYn" %}
[Compare](/snowray/snowray-v1.1.1/reference/resources/valuesets/compare.md)
{% endcontent-ref %}

## :arrow\_down: Export Value Set

To export a value set, press the![](https://1046423764-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F-MfXbzY7oaJUjXyvlBQk%2Fuploads%2Fgit-blob-8d4aaee91e5612f89cdf056e34e9492d24abd608%2Fexport_button.png?alt=media)button in the upper right corner of your resource's page, and select a format for your export file. Once you picked your desired format, the export process immediately starts.

{% hint style="info" %}
A progress indicator will notify you about the changes in the export process.
{% endhint %}

![Export Value Set](https://1046423764-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F-MfXbzY7oaJUjXyvlBQk%2Fuploads%2Fgit-blob-9376d612842916b5df91cd0fb37c0b22101e1ff9%2Fgs_export.gif?alt=media)

:paperclip: **Read more about supported export file formats:**

{% content-ref url="/pages/-MgGqpHPCIc3-TGfm2-g" %}
[Export](/snowray/snowray-v1.1.1/reference/resources/valuesets/export.md)
{% endcontent-ref %}
