SNOMED-in-5-minutes
SNOMED-in-5-minutes copied to clipboard
Easy-to-use tutorials for accessing SNOMED APIs within 5 min using various programming languages
SNOMED In 5 Minutes
This is an easy-to-use tutorial for accessing SNOMED APIs within 5 min using the SNOMED International terminology server, Snowstorm.
Table of Contents
- Project Structure
- Examples
- Resources
- Contributing
- License
Project Structure
-
top-level: aggregator for sub-modules (alphabetically):
- android-client-snomed-browser: examples for use in an Android client
- csharp-examples: examples with csharp (.net)
- curl-examples: examples with curl
- java-examples: examples with java
- javascript-examples: examples with javascript
- model: JAXB-enabled classes for representing the RF2 domain model
- php-examples: examples with php
- python3-examples: examples with python
- rest-client: a Java client for the REST services
- rest-client-csharp: a CSharp client for the REST services
- ruby-examples: examples with Ruby based on the Python examples
- go-examples: examples with golang
Examples
The following examples will be used to demonstrate accessing the SNOMED API through CSharp, Javascript, Curl, and Java (using Jersey).
- Find a concept by a string (e.g. "heart attack")
- Find/get a concept by a description SCTID (e.g. "679406011")
- Find/get a concept by a concept SCTID (e.g. "109152007")
- Find a concept by a string (e.g. "heart") but only in the Procedures semantic tag
All of the examples use a hard coded URL, edition name, and version number which point to a server hosted by SNOMED International (www.snomed.org). These are the APIs that back the SNOMED International browser (https://browser.ihtsdotools.org)
Back to top
Javascript
- Click for JavaScript examples.
Curl
- Click for Curl examples.
Python
- Click for Python examples.
Ruby
- Click for Ruby examples.
PHP
- Click for PHP examples.
Golang
- Click for GO examples.
Back to top
Needing some TLC
The following examples are out of date and need updating to wokr with Snowstorm. All contributions welcome!
Android client
- Click for Android examples.
CSharp (.net)
- Click for CSharp examples.
Java
- Click for Java examples.
Further Documentation
Find comprehensive documentation here: TBD
Resources
- SNOMED International SNOMED CT browser: http://browser.ihtsdotools.org
- Snowstorm SNOMED CT Terminology Server: https://github.com/IHTSDO/snowstorm (REST documentation here https://browser.ihtsdotools.org/snowstorm/snomed-ct/)
Back to top
Contributing
- Fork it!
- Create your feature branch:
git checkout -b my-new-feature
- Commit your changes:
git commit -am 'Add some feature'
- Push to the branch:
git push origin my-new-feature
- Submit a pull request
Back to top
Current Contributors
- Brian Carlsen
- Alejandro Lopez Osornio
- Jesse Efron
- Philip Wilford
- Omid Mavadati
- Ahmed Mohamed
- Kai Kewley
- Other Contributors
Back to top
License
Apache 2.0
See the included LICENSE file for details.
Back to top
Suggestions for Future Work
- 'supporting registration for a British GP' (i.e. searching within the GP/FP reference set & the UK language reference set)
- 'deriving ICD-10 codes from registered SNOMED concepts (i.e. retrieving all entries of a SNOMED-concept from the ICD-10 extended mapping reference set)