Loading SNOMED CT releases into Snowstorm using the Swagger interface

Leelo en español:

Cargar archivos de edición de SNOMED CT en Snowstorm usando la interfaz web Swagger

Sometimes it isn’t possible to access to the Snowstorm server by physically or even remotely, or simply don’t want to run commands in the terminal.

So that there’s a way to upload SNOMED CT release files through the Swagger web interface, by following a few steps.

Prerequisites

· A running Snowstorm instance, deployed as usual or using Docker:

NOTE: Snowstorm must be running in import mode, and not in read-only mode.

snowstorm/docs/getting-started.md at master · IHTSDO/snowstorm

snowstorm/docs/using-docker.md at master · IHTSDO/snowstorm

· SNOMED CT release files:

Get SNOMED CT | SNOMED International

File loading process

Now it’s time to start the loading of the zipped distribution file (SNOMED CT file), so accessing to the web interface.

By this moment you must know what your server IP address is, but for the sake of this tutorial, let’s assume that is your localhost:8080.

1. Make a POST request to generate a import job and retrieve the job ID.

These parameters are needed:

{ "branchPath": "MAIN", "createCodeSystemVersion": true, "type": "SNAPSHOT" }

Usually type is used with SNAPSHOT, but if your plan is to load a full type of distribution, use FULL string.

Further information of release types: https://confluence.ihtsdotools.org/display/DOCRELFMT/3.2+Release+Types

To find the proper option, look for an expandable item under the Import section, as following:

After executing this request, an import job ID is shown in the response section, as the response header location. You’ll see a full URL, within the last part the required identifier.
In this example there is the server address or domain, the imports resource, and the desired ID:

2. Go to file upload and fill it with the import job ID

Navigate again to another menu item, which allows to upload your SNOMED CT zipped file (do not decompress it).

Here, paste the import job ID on the ImportID section, and browse in your computer and upload the zipped file. Then click on Execute

It’ll take a while when uploading the file, depending on your network connection.

After a successful file upload, this is the answer (with the code 200 OK)

This doesn’t mean that the file was processed, just uploaded to the server. The real processing work just begun and it will take a longer time (30 to 60 minutes depending on the hardware capabilities).

3. Monitoring the import job status

Scroll once more to find this option, which makes a GET request to know the status of our process. Paste the import job ID on the text box and execute the query.

If the process is still in progress, the answer will be:

In the response body, the value of the key status shows us how the things are going.

If everything went well, a happy status of COMPLETED is shown. Anything different is an error in the process.

After these brief steps, our Snowstorm server is loaded with the SNOMED CT release file.