README.md

This is the Snowstorm-X project, a beta version of Snowstorm with the latest implementation-focused features and enhancements. Please be aware these features have not yet been fully tested.

Snowstorm is an open source terminology server with special support for SNOMED CT. It is built on top of Elasticsearch, with a focus on performance and enterprise scalability.

SNOMED International is not able to offer commercial support for this product. Support is provided by the community via this repository.

APIs

Snowstorm has two APIs:

• HL7 FHIR API 🔥
  • Implements the Terminology Module
  • Recommended for implementers
  • Supports SNOMED CT, LOINC, ICD-10, ICD-10-CM and other code systems
• Specialist SNOMED CT API
  • Supports the management of SNOMED CT code systems
  • Supports the SNOMED CT Browser
  • Supports authoring SNOMED CT editions

Advice for Implementers

SNOMED International recommends that implementers of SNOMED CT use a terminology service, such as Snowstorm, and a standard interface, such as the HL7 FHIR API.

This approach allows loose coupling of applications as well as access to powerful terminology features.

Snowstorm is a good choice for teams who are just getting started or who have terminology and technical support capability. Other terminology servers are available, some offer commercial support.

SNOMED CT Browser Support

Snowstorm provides the terminology server API for the SNOMED International Browser including the International Edition and around fourteen national Editions.

Snowstorm can be used in local implementations to query SNOMED CT with the following features:

• Hosting multiple extensions alongside the International Edition of SNOMED CT
• Multi-lingual search and content retrieval
• Fully ECL v2.0 compliant
• Full history (depends on full RF2 import)
• Read-only FHIR API 🔥

Authoring Use

Snowstorm also provides the terminology server API for the SNOMED International Authoring Platform.

The Authoring Platform is used for the maintenance of the International Edition of SNOMED CT as well as nine national Editions and several community content Extensions.

Documentation

• Setup
  • Getting Started (plain installation)
  • Configuration Guide
    • Security Configuration Guide
    • Nginx Setup (SSL)
  • Docker Quickstart
  • Elasticsearch Index Mapping Changes
• Loading SNOMED CT content
  • Loading SNOMED
  • Loading & updating SNOMED CT with local Extensions or Editions
• Authoring SNOMED CT
  • Extension Authoring
• Use
  • Using the FHIR API
  • Using the Specialist SNOMED API
    • Code Systems & Branches
    • Search Guide
    • Language Specific Search Behaviour
• Productionization
  • Load Balancing

Contributing

We welcome questions, ideas, issues and code contributions to this project.

Use the issues page to get in touch with the community.

If you would like to make a code contribution please fork the repository and create a GitHub pull request to the develop branch.

License

Apache 2.0

See the included LICENSE file for details.

Tools

For Java performance profiling we recommend the JProfiler Java profiler.