README

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.

Introduction

Features include:
  • 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
      • RF2 Release File Specification as of 2022-08-31
      • Support for Relationships with concrete values
      • Official and Custom Reference Sets
      • Expression Constraint Language v2.1.0 spec, implementation
      • Compositional Grammar 2.3.1 spec, implementation
      • Expression Template Language 1.0.0 spec, implementation
    • With its modular design, the server can maintain multiple terminologies (including local codes, mapping sets, value sets)
  • Various set of APIs
  • 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
    • All the power of Elasticsearch is available (full-text search support, monitoring, analytics and many more)

Download

This distribution only includes features licensed under the Apache 2.0 license. To get access to the full set of features, please contact B2i Healthcare.
View the detailed release notes here.
Not the version you're looking for? View past releases.

Install and Run

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:
  • Run bin/snowowl.sh on unix, or bin/snowowl.bat on windows
  • Run curl http://localhost:8080/snowowl/info to access server health status information
  • Run curl http://localhost:8080/snowowl/fhir/metadata to access FHIR terminology capabilities
  • Navigate to http://localhost:8080/snowowl to access the REST API documentation page
  • See more documentation at SNOMED CT API docs and at FHIR API docs

Learn Snow Owl

Building from source

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/target folder, when the build is complete.
To run the test cases, use the following command:
mvn clean verify

Development

These instructions will get Snow Owl up and running on your local machine for development and testing purposes.

Prerequisites

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 (install the listed features via HelpInstall New Software...):
Note: you may have to untick the Show only the latest versions of the available software checkbox to get older versions of a feature. Please use the exact version specified below, not the latest point release.
  • MWE2 (https://download.eclipse.org/modeling/emft/mwe/updates/releases/2.12.1/)
    • MWE SDK 1.6.1 (MWE)
    • MWE2 Language SDK 2.12.1 (MWE)
  • 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)
  • Groovy Development Tools (https://dist.springsource.org/release/GRECLIPSE/4.4.0/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")
  • M2Eclipse (https://download.eclipse.org/technology/m2e/releases/1.19.0/)
    • M2E - Maven Integration for Eclipse (includes Incubating components) 1.19.0
    • M2E - PDE Integration 1.18.3
    • M2E - POM Editor using LemMinX language server (includes Incubating components) 1.18.3
  • M2E components (offered for installation after starting Eclipse)
    • m2e connector for build-helper-maven-plugin
    • Tycho Project Configurators

Eclipse Preferences

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)

Git configuration

  • Make sure the Git line endings are set to input (Preferences→Team→Git→Configuration - add key if missing core.autocrlf = input)

Maven Settings

  • Make sure the settings.xml in your ~/.m2/settings.xml location is updated with the content from the settings.xml from this repository's root folder.

First steps

  1. 1.
    Import all projects into your Eclipse workspace and wait for the build to complete
  2. 2.
    Select all projects and hit Alt + F5 and trigger an update to all Maven projects manually (to download dependencies from Maven)
  3. 3.
    Open the target-platform/target-platform.target file
  4. 4.
    Wait until Eclipse resolves the target platform (click on the Resolve button if it refuses to do so) and then click on Set as Active Target platform
  5. 5.
    Wait until the build is complete and you have no compile errors
  6. 6.
    Launch snow-owl-oss launch configuration in the Run Configurations menu
  7. 7.
    Navigate to http://localhost:8080/snowowl

Contributing

Please see CONTRIBUTING.md for details.

Versioning

Our releases use semantic versioning. You can find a chronologically ordered list of notable changes in CHANGELOG.md.

License

This project is licensed under the Apache 2.0 License. See LICENSE for details and refer to NOTICE for additional licensing notes and uses of third-party components.

Acknowledgements

In March 2015, SNOMED International generously licensed the Snow Owl Terminology Server components supporting SNOMED CT. They subsequently made the licensed code available to their members and the global community under an open-source license.
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).
Last modified 3d ago
Export as PDF
Copy link
Outline
Introduction
Download
Learn Snow Owl
Building from source
Development
Prerequisites
First steps
Contributing
Versioning
License
Acknowledgements