Publication of maps is out of scope of Snap2SNOMED. Therefore any publishing processes need to be completed outside this tool. However an is available for users to download their map in CSV, TSV or XLSX format from the tool.

Quality assurance and final testing should also be performed outside the tool prior to publishing.

Once a new map has been created, users of the map can then create an Author task to begin working on the map.

Users need to have the appropriate role to create tasks. Alternatively, tasks can be created by owners of the map and assigned to other users.

Please note that within an Author task, only those rows with a status of 'Unmapped', 'Draft', 'Mapped' and 'Rejected' may be edited. To restrict the map view to only these rows, please apply a filter to the Status field with the required status values.

To author map rows:

1. Open the map to be authored

2. Create a task containing the rows required to be mapped

3. Open the task, and begin mapping process.

• Work can be completed in the table view by searching for concepts and dragging them into the map.

• The detailed view can also be used to populate the map

• Once populated, the status can be changed by using the drop down fields in the table view and the buttons in the detailed view

Snap2SNOMED has been built using a collaborative iterative agile approach. The current release of Snap2SNOMED supports a range of features including

• Ability to create simple maps to SNOMED CT

• Online and easily accessible (requires login from SNOMED International)

• Collaborative workflow features

  • Allows teams of users to author and review a map

  • Dual independent workflow is not yet available

• Automated mapping suggestions are available as a bulk operation and for single source terms

• Map review process available in workflow for map content

• Intuitive UI to make browsing and mapping to SNOMED CT easy and efficient

• Ability to perform map maintenance

• Import your own code sets and maps

• Export to CSV, TSV and XLSX

This tool is provided by SNOMED International for use by Members at .

The codebase of Snap2SNOMED is available as open source with a standard Apache 2 license. This allows the software to be used for any purpose, distributed, modified, and for modified versions of the software to be distributed under the terms of the license without concern for royalties (). Please be aware however that the tool depends on , which is not open source.

PLEASE READ THESE TERMS AND CONDITIONS CAREFULLY BEFORE USING THIS SNOMED INTERNATIONAL SITE

By continuing to browse and use this website You are agreeing to comply with and be bound by the following terms and conditions of use, which govern our relationship with You in relation to this website.

"We", SNOMED International, operate this site. We are registered in the United Kingdom and have our registered office at 1 Kingdom Street, Paddington London, W2 6BD, United Kingdom. "You" are the user of this website.

TERMS AND CONDITIONS OF USE

We may update our website, including these terms, from time to time, and may change the content at any time, in each case, without notice. Please note that we do not guarantee that our site, or any content or information on it, is complete, up-to-date, error-free or free from inaccuracies or omissions.

The content on our website is provided for general information only. You should not rely on any information provided on our website, and it is your own responsibility to ensure that any products, services or information available through this website meet your specific requirements.

Depending on personnel resourcing availability and internal business requirements, there are different ways to set the author/review workflow.

Note: there is currently no notification system available to notify users that work has been done or comments have been left. Manual monitoring needs to be done to keep track of workflow by users within a project.

Snap2SNOMED allows maps to be exported in CSV, TSV and XLSX file formats.

To export a map, log in and open/view the required map. Then click EXPORT (near the top of the screen) and select the required export format:

• Comma separated (CSV)

• Tab separated (TSV)

• Excel (XLSC)

To get a copy of a map using non-english terms see

You can manage the membership as an of a map. To do this, click the EDIT button from within a map. This will give you a dialogue to manage the membership.

Create Map

After logging in, you can create a new map by clicking the "Create map" button.

Select Author Mode

First, you need to state the author mode for your project. This can't easily be changed once the map is created.

When creating a new map, choose the author mode that best fits your workflow:

• Single Author Mode : In this mode, one person is responsible for mapping, and a separate reviewer will review and validate the mapping.

• Dual Author Mode : Two mappers work independently (blindly) on the mapping process. If they select different targets, a reconciler will review and resolve any discrepancies.

Next, you need to define the key metadata for your map:

• Title : Provide a descriptive name for the map (e.g., Example Map).

• Version : Assign a version number to track changes (e.g., 0.1).

• Description : Briefly explain the purpose of the map (e.g., An example map from common diseases to SNOMED CT).

In this step, assign roles to team members based on their responsibilities in the project:

• Owner : Has full control over the project, including managing roles, creating new versions, and handling project settings.

• Member : Can author mappings, review and reconcile differences, and create tasks.

• Viewer : Has read-only access and can view the project but cannot make changes.

How to Assign Roles:

1. Search for an individual in the list.

2. Select their role from the dropdown menu.

Proper role assignment ensures clear responsibilities and effective collaboration within the projec

Once you have filled in all mandatory (*) fields, click the "Save" button to create your new map.

Tasks are the way that Snap2SNOMED manages the workflow. All work being done within a map should be done through the tasking process.

Each task has a task type, an assigned user and assigned rows. Permissions for creating tasks is determined by the user's role (see table X)\

Task types

There are two different task types

• Author tasks

• Review tasks

Author tasks

Author tasks allow an assigned user to edit a source code mapping by adding or updating target codes, or adding "No Map" flags.

Review tasks allow an assigned users to review mapped source codes by giving them statuses of ACCEPTED and REJECTED.

This is the user who is able to complete the task. Users who are not the assigned user are not able to access the task.

These are the rows that are assigned to a task. They allow users to interact with these rows within the task.

Snap2SNOMED (https://snap.snomedtools.org) is a mapping tool that supports the collaborative authoring and maintenance of simple maps from other code systems to SNOMED CT. This Snap2SNOMED user guide explains the main features of the tool, and how these features can be used to create and maintain maps to SNOMED CT.

For information about mapping best practice and guidelines, please refer to the SNOMED CT Mapping Guide.

To contribute to future versions of the Snap2SNOMED mapping tool, please join the Mapping Tool User Group. To provide feedback on Snap2SNOMED, please use the 'Feedback' link at the bottom of each page in the tool, or email us at info@snomed.org.

If you import an existing map and some of the map targets contain errors, e.g. if some of the concepts are inactive, or not available in the selected Edition, the red flag will show for the involved map records (see image below).

Within the authoring task, you can see, in the Target properties section, that the concept is inactive.

Inactive Replacements

1. Within an authoring task, when editing a map record with an inactive target, click on the red triangle find suggested replacements. This feature uses the historical associations.

2. The suggested replacements are added to the "Inexact" section, for author consideration. If no suggestions are added to the "Inexact" section that means no historical associations were available and the author must find one manually instead. The existing inactive map target should be removed. Any suggested replacements can be dragged to the appropriate relationship type (Equivalent, Broader, Narrower).

\

Snap2SNOMED supports maintenance of maps that have been created within the tool and also allows upload of simple maps in a defined format for maintenance.

Maintenance is supported through the following workflows

To access Snap2SNOMED, you go to the front page of the system: https://snap.snomedtools.org/

To log in, you need a SNOMED International Confluence account, and if you don’t have one, you can request an account via this link: Request a SNOMED International Confluence account

Once you have your Confluence account, you log in to the tool by clicking on the login button. On the next screen, click on “SNOMED”, and then you are taken to a login page, where you can enter your Confluence user name and password.

To finish the login process, you need to click on the ‘Grant Access’ button to give Snap2Snomed consent to use your Confluence account details in the tool.

Provide Feedback

Snap2SNOMED supports the requirements of managing a variety of different workflows. Depending on business requirements and availability of personnel, a project owner can assign different roles to users to achieve different levels of control.

Participants can have one of three roles within a project:

To delete a map and all versions of the map, please follow these steps.

1. Login to Snap2Snomed and go to your list of maps

2. In this view, click on the following icon to the right of the column:

Once a new map has been mapped, users of the map can then create a Review task to begin reviewing the map.

Users need to have the appropriate role to create tasks. Alternatively, tasks can be created by owners of the map and assign them to other users

Please note that within a Review task, only those rows with a status of 'Mapped', 'In review', 'Accepted' and 'Rejected' may be edited. To restrict the map view to only these rows, please apply a filter to the Status field with the required status values.

To review map rows:

1. Open the map to be reviewed

2. Create a task containing the rows required to be reviewed.

1. Open task and begin reviewing.

Reviewing can be done

• in the table view of the map by changing the status

• in the detailed view by clicking the status buttons

Please note : Map rows need to be have an appropriate to be able to be reviewed even when assigned to a review task|

A project is a collection of one or map versions that have the same source and target code systems (but not necessarily the same code system versions).

For example a single project could contain 2 maps: ACME codes to SNOMED map v1 (source: ACME code system v1.0, target: SNOMED CT International version 20210131) and ACME codes to SNOMED map v2 (source: ACME code system v1.0, target SNOMED CT International version 202107031).

When creating a new map, a project is automatically created. When a new version of an existing map is created within the tool, it will be placed into the same project as the original version that has been copied.

Provide Feedback

To start working within a map project in Snap2SNOMED, tasks will need to be created, as all mapping work is performed within a task. One Member of the map project can be assigned to each task. Owners of a map project can create tasks, and assign these to the members of the project. Members of a mapping project can create tasks for themself.

Snap2SNOMED supports two types of mapping tasks; 'authoring' tasks and 'review' tasks. Within an authoring task, members can select map targets and update the details for the individual map records. Within a review task, members can accept or reject the map targets and relationships proposed by the author.

Create Task

To create a task, open the 'Tasks' panel by clicking on the 'Tasks' button from within the view of a map project.

To start creating the task, open the 'New Task' tab:

In the 'New Task' panel, a description, an assigned member, and the type of task should be specified. Furthermore, you also need to specify whether all or a selected number of the map rows should be included in the task. As shown in the diagram below, you can manually select the rows of the map to be included in the task. This will allow the mapping work to be split between a number of members of a mapping project.

Once tasks have been created, these are visible from the Tasks panel in the Author and Review tab respectively. Here, Owners and Memebers can see the progress of the tasks as a percentage, and they can delete or close the task.

To start working on a task, the member needs to select the task from the drop-down list at the top of the 'View Map' screen.

A task can be deleted by clicking on the red minus sign:

Each map between source and target should have a defined type of map relationship describing the type of relationship or degree of equivalence of source and target code.

Snap2SNOMED uses the following definitions

There are many different requirements for workflow and processes for people developing maps depending on their business situation.

A wide variety of different team sizes, management styles and business processes are in use and so Snap2SNOMED has been designed to provide workflow support for collaborative authoring and reviewing tasks when developing a map while remaining flexible enough to support as many different workflows as possible.

It is possible to import a map file in one of two ways:

1. During the map creation process

2. From the view screen of an existing map

This page explains the expected map file format, and the two import approaches.

Import Map File Format

An existing mapping file used to import a map into Snap2SNOMED must :

• Be a CSV or TSV file

• Have a header row

• Be in one of the following formats

  • source_code, target_code, target_display, relationship_type

Relationship type values in the map import file must be one of the following codes (from the first column of the table below):

You can import an existing map using the "Create map" dialogue. The "Import existing map" button will appear after uploading and/or selecting your source file.

Note: Large maps can take long to import, please do not refresh your browser while the import is running.

If there is an error in your imported map file, the import will fail, but a map with only the source code will be created. After correcting any errors, you can attempt to re-import your map file from within the new map (see 'Import into an existing map' below.

To import a map file into a map that has already been created in Snap2SNOMED, open/view the map, and click the IMPORT button near the top of the page (see screen shot below).

Snap2SNOMED supports the creation of mappings between source codes and SNOMED CT target codes in the form of a map.

A map is a tabular form of the associations between source codes and target codes, and the relationship between them.

A new map is automatically created when creating a new project. A new map version can also be created from an existing map in the tool.

Maps require a

• Name

• Version

• Source scope (upload a source code set)

• Target scope (SNOMED CT version and ECL subset)

Maps can be authored/updated in Snap2SNOMED and is managed through tasks.

Within an , the tool allows you to edit a row by interacting with the map table or by using the detailed view.

The map table view allows you to interact with the table directly (dragging and dropping terms from the search, selecting relationship and status from the drop downs etc.).

The detailed view is another view of a mapping which shows one source code and its associated information at a time. In this view you can add one or more target codes, update target codes, relationships and status.

Within a , much like authoring, the tool allows you to edit a row by interacting with the map table or by using the detailed view.

The map table view allows you to interact with the table directly (changing status to review).

The detailed view is another view of a mapping which shows one source code and its associated information at a time. In this view you can change status to review, leave comments and flag targets.

The system checks for duplicate source code pairs and an import error occurs if two rows in the source code set contain the same code. An example of this is shown in the image below.

Snap2SNOMED has two features to assist with mapping

Bulk Automap Feature

This feature is available to users within an author task.

The bulk automap feature will attempt to return a match within the target scope of the map. If no map can be found, the target will remain blank.

All matches found will be set with a relationship type of "INEXACT". This is because the automap feature is unable to determine the level of equivalency of the match.

It is strongly recommended that all matches suggested by the automap feature are checked by a human mapper.

Automated Match Suggestions

This feature is available in the detailed view of a source code. Users can use these suggestions for mapping by dragging and dropping their choices into the relationship box.

An owner can create a new version of a map within the Snap2SNOMED tool as part of maintenance.

After logging in

1. In the list of projects, select the version of the map from which you want to make a new version. Click the New Version button.

2. Update scope and target where required, then click save. This will migrate all the relevant map rows into the new map version.

1. To make updates to maps that are already in the 'Accepted' state, please first change the status of each row to 'Rejected' - either in the individual map rows, or as a 'Bulk edit' operation. This will allow the map authoring process to be restarted in the new map version.

To create a map file with non-english concept terms follow these steps.

Steps

1. Export the map from Snap2SNOMED using any of the CSV/TSV/Excel formats

2. Open the ValueSet Utility

3. Upload the map file using the "Choose File" button

4. The map will be loaded into the page with English terms

5. Select the "Translate target column" option at the bottom of the page

6. Select the Edition and Language-dialect containing the terms you want

7. Select "Translate Target Terms"

8. Finally download the map file with the non-english terms

Mapping is the process of defining a relationship between the source and target codes, concepts or terms.

General development process in Snap2SNOMED

Map development

Map maintenance

Provide Feedback

Roles are used to grant permissions to users to provide access to a project and to perform specific tasks within a project.

Users are unable to see projects until they have been given a role within a project by an owner.

There are three roles being used in the tool.

Snap2SNOMED is designed for collaborative map development. When creating a map, the user decides between two overall workflows, namely:

• Single author mode

• Dual author mode

Each of these overall approaches supports a range of options for collaboratively developing a map from a given source code set to SNOMED CT.

Single Author Mode

This overall approach supports multiple users working simultaneously on a map in a single author, single reviewer per source code manner. This means that work can be divided across a number of personnel to get work done.

A variety of workflows are currently supported, including:

• A single user completes all author tasks for the map and then completes a review process on all mapped rows

• A single user completes all author tasks for the map.

• No review process is required

• A single author completes all author tasks for the map.

• A second user, the reviewer, will complete a review process on all mapped rows.

• Two or more authors create mappings for each source code of the map.

• Two or more reviewers completes the review processes on all mapped rows.

  • NOTE: A user can act as both an author and reviewer within the overall map (as assigned in a task), however, rules have been implemented to discourage the scenario of a user to reviewing their own authoring work. This can be overridden by an owner if required.

Dual author mode allows two authors to independently map the same source codes. Conflicts arising from differing interpretations are identified and resolved through a reconciliation process. This workflow brings the advantage of diverse perspectives, allowing for a comprehensive assessment of mappings. It ensures a cross-validation process where conflicting interpretations can be discussed, resolved, and reconciled, leading to accurate and reliable mappings between different coding systems or terminologies.

A variety of workflows are currently supported, including:

• Two users user completes all author tasks for the map.

• A reconciler completes the reconciliation of conflicting maps.

• An assigned reviewer completes the review of all map rows.

• Two users user completes all author tasks for the map.

• A reconciler completes the reconciliation of conflicting maps.

• One or more users are assigned as reviewers for a specific set of source codes. Each map row is assigned to a single reviewer.

• Two or more users complete the author tasks that have been assigned to them. The work is divided so that two users are mapping each source code.

• One or more users are assigned as a reconciler. Each map row is assigned to one reconciler.

• One or more users are assigned as reviewers for a specific set of source codes. Each map row is assigned to a single reviewer.

• Two users complete all author tasks for the map.

• A reconciler completes the reconciliation of conflicting maps.

• No review process is required.

In Dual Author Mode, two independent mappers work separately on the same mapping task. The system keeps their mappings blinded until both have completed their work. Once both mappers submit their mappings, the system compares the results:

• If both mappers select the same target, the row is marked as MAPPED and requires no further action.

• If the mappers select different targets, the row automatically moves to RECONCILE, where a reconciler will review and determine the final mapping.

Key Considerations for Reviewing in Dual Author Mode

• No Dedicated Reviewer Role: Unlike Single Author Mode, this mode does not require a separate reviewer because the reconciliation process ensures that discrepancies are addressed.

• Modifying a Locked Mapping: Once a mapping is unblinded, it cannot be changed by either author. However, if adjustments are necessary, the status can be changed to RECONCILE using bulk change, or the Clear Targets option can be applied via bulk edit to reset the mapping and the blinding flag.

• Handling Rejected Rows: If a reviewer (in an assigned review workflow) rejects a row, its status can be changed to RECONCILE using the bulk change feature. A reconciliation task can then be assigned to ensure the mapping is corrected.

Status denotes the state of the mapping of a source code (not specifically to the targets).

The statuses used in this tool are split between the two task types, mapping and reviewing.

• Mapping statuses are UNMAPPED, DRAFT and MAPPED.

• Reviewing statuses are IN REVIEW, ACCEPTED and REJECTED.

In a mapping task, a user is able to transition a source code's status between UNMAPPED, DRAFT and MAPPED and where a source code has been rejected by a reviewer, the user can also change REJECTED to DRAFT or MAPPED. If a review process is being used, a status of MAPPED can also be considered the same as "ready for review".

In a review task, a user is able to transition a MAPPED source code to IN REVIEW, ACCEPTED and REJECTED. The IN REVIEW status is designed to be like a lock for the source code so no further changes can be made by the author. A reviewer can choose to bulk change all the status of the valid rows in their task to IN REVIEW if they wish to lock them while they are working.

In order to facilitate efficient mapping and assist workflow, a bulk edit feature has been provided.

Within a task, the bulk edit feature allows users to bulk change all rows or a selection of rows.

A user can

• Change relationship types

• Change mapping status

• Mark all as "No map"

• Remove all "No map"

• Clear targets

The bulk edit feature only allows one operation at a time, and can only enact changes on rows that have a to allow that change when following a normal mapping process.

Examples:

• Within an author task, a user is not able to change any status to APPROVED or IN REVIEW as these belong to review tasks only

• Within an author task, if the starting status is UNMAPPED (and so has no target assigned), then the bulk change will not be able to change the status to MAPPED

• Within a review task, a user is not able to change any status to MAPPED as these belong to author tasks only

NOTE: It is intended that the bulk edit function is used only within a task, however there is a bulk edit function available to Owners from the map view to allow Owners to manage workflow.

The bulk edit function in the map view will adhere to the normal rules for changing status. This means the Owner must complete a sequence of bulk actions in line with the status change rules.

For example, to clear all the content of a to a row containing a target code cannot be changed to UNMAPPED, a status of DRAFT cannot be changed to ACCEPTED