Snow Owl® is a highly scalable, open source terminology server with revision-control capabilities and collaborative authoring platform features. It allows you to store, search and author high volumes of terminology artifacts quickly and efficiently. If you’d like to see Snow Owl in action, the Snowray Terminology Service™ provides a managed terminology server and high-quality terminology content management from your web browser.
- Revision-controlled authoring
- Maintains multiple versions (including unpublished and published) for each terminology artifact and provides APIs to access them all
- Independent work branches offer work-in-process isolation, external business workflow integration and team collaboration
- SNOMED CT and others
- SNOMED CT terminology support
- With its modular design, the server can maintain multiple terminologies (including local codes, mapping sets, value sets)
- Highly extensible and configurable
- Simple to use plug-in system makes it easy to develop and add new terminology tooling/API or any other functionality
- Built on top of Elasticsearch (highly scalable, distributed, open source search engine)
- Connect to your existing cluster or use the embedded instance (supports up to Elasticsearch 8.x)
- All the power of Elasticsearch is available (full-text search support, monitoring, analytics and many more)
NOTE: You need to have version 17 of the JDK installed for local builds and running the development environment. Official releases include the runtime.
Once you have downloaded the appropriate package:
bin/snowowl.shon unix, or
curl http://localhost:8080/snowowl/infoto access server health status information
curl http://localhost:8080/snowowl/fhir/metadatato access FHIR terminology capabilities
- Navigate to
http://localhost:8080/snowowlto access the REST API documentation page
Snow Owl uses Maven for its build system. In order to create a distribution, simply run the following command in the cloned directory.
mvn clean package
The distribution packages can be found in the
releng/com.b2international.snowowl.server.update/targetfolder, when the build is complete.
To run the test cases, use the following command:
mvn clean verify
These instructions will get Snow Owl up and running on your local machine for development and testing purposes.
Snow Owl is an Equinox-OSGi based server. To develop plug-ins for Snow Owl you need to use Eclipse as IDE:
- Download Eclipse IDE for Eclipse Committers 2021-12 package from here: https://www.eclipse.org/downloads/packages/release/2021-12/r/eclipse-ide-eclipse-committers
Required Eclipse plug-ins in order (install the listed features via
Install New Software...):
Note: you may have to untick the
Show only the latest versions of the available softwarecheckbox to get older versions of a feature. Please use the exact version specified below, not the latest point release.
- Xtext/Xtend (https://download.eclipse.org/modeling/tmf/xtext/updates/releases/2.25.0/)
- Xtend IDE 2.25.0 (Xtext)
- Xtext Complete SDK 2.25.0 (Xtext)
- MWE2 (https://download.eclipse.org/modeling/emft/mwe/updates/releases/2.12.1/)
- MWE SDK 1.6.1 (MWE)
- Groovy Development Tools (https://groovy.jfrog.io/artifactory/plugins-release/e4.22)
- Eclipse Groovy Development Tools - 4.4.0 (in category "Main Package")
- Groovy-Eclipse M2E integration - 4.4.0 (in category "Maven Support")
- Groovy Compiler 3.0 - 4.4.0 (in category "More Compilers")
Make sure you have the following preferences enabled/disabled.
- Plug-in development API baseline errors is set to Ignored (Preferences > Plug-in Development > API Baselines)
- The Plugin execution not covered by lifecycle configuration: org.apache.maven.plugins:maven-clean-plugin:2.5:clean type of errors can be ignored or changed to Warnings in Preferences→Maven→Errors/Warnings.
- Set the workspace encoding to UTF-8 (Preferences→General→Workspace)
- Set the line endings to Unix style (Preferences →General→Workspace)
- Set the number of imports and static imports wildcard limit to 5 (Preferences→Java→Code Style→Organize Imports)
- Make sure the Git line endings are set to input (Preferences→Team→Git→Configuration - add key if missing core.autocrlf = input)
- Make sure the
settings.xmlin your ~/.m2/settings.xml location is updated with the content from the
settings.xmlfrom this repository's root folder.
- 1.Import all projects into your Eclipse workspace and wait for the build to complete
- 2.Select all projects and hit
F5and trigger an update to all Maven projects manually (to download dependencies from Maven)
- 3.Open the
- 4.Wait until Eclipse resolves the target platform (click on the
Resolvebutton if it refuses to do so) and then click on
Set as Active Target platform
- 5.Wait until the build is complete and you have no compile errors
snow-owl-osslaunch configuration in the Run Configurations menu
- 7.Navigate to
In March 2017, NHS Digital licensed the Snow Owl Terminology Server to support the mandatory adoption of SNOMED CT throughout all care settings in the United Kingdom by April 2020. In addition to driving the UK’s clinical terminology efforts by providing a platform to author national clinical codes, Snow Owl will support the maintenance and improvement of the dm+d drug extension which alone is used in over 156 million electronic prescriptions per month. Improvements to the terminology server made under this agreement will be made available to the global community.
Many other organizations have directly and indirectly contributed to Snow Owl, including: Singapore Ministry of Health; American Dental Association; University of Nebraska Medical Center (USA); Federal Public Service of Public Health (Belgium); Danish Health Data Authority; Health and Welfare Information Systems Centre (Estonia); Department of Health (Ireland); New Zealand Ministry of Health; Norwegian Directorate of eHealth; Integrated Health Information Systems (Singapore); National Board of Health and Welfare (Sweden); eHealth Suisse (Switzerland); and the National Library of Medicine (USA).