Skip to main content
Version: 3.9.0-beta.64 (Latest)

URL

You can modify the URL at any state of the app to get the desired result. Here are different part of the APP that you can modify:

WorkList

The WorkList can be modified by adding the following query parameters:

PatientName

The patient name can be modified by adding the PatientName query parameter.

/?patientName=myQuery

MRN

The MRN can be modified by adding the MRN query parameter.

/?mrn=myQuery

Description

The description can be modified by adding the Description query parameter.

/?description=myQuery

Modality

The modality can be modified by adding the modalities query parameter.

/?modalities=MG

Accession Number

The accession number can be modified by adding the accession query parameter.

/?accession=myQuery

DataSources

If you happen to have multiple data sources configured, you can filter the WorkList by adding the dataSources query parameter.

/?dataSources=orthanc

Note1: You should pass the sourceName of the data source in the configuration file (not the friendly name nor the name) Note2: Make sure that the configuration file you are using actually includes that data source. You cannot use a data source from another configuration file.

tip

You can add sortBy and sortDirection query parameters to sort the WorkList

/?patientName=myquery&sortBy=studyDate&sortDirection=ascending

Viewer

The Viewer can be modified by adding the following query parameters:

Mode

As you have seen before, the Viewer can be configured to be in different modes. Each mode registers their id in the URL.

For instance

/viewer?StudyInstanceUIDs=1.3.6.1.4.1.14519.5.2.1.7009.2403.871108593056125491804754960339

will open the viewer in the basic (longitudinal) mode with the StudyInstanceUID 1.3.6.1.4.1.14519.5.2.1.7009.2403.871108593056125491804754960339.

And if configured, the same study can be opened in the tmtv mode

/tmtv?StudyInstanceUIDs=1.3.6.1.4.1.14519.5.2.1.7009.2403.871108593056125491804754960339

StudyInstanceUIDs

You can open more than one study in the Viewer by adding the StudyInstanceUIDs

/viewer?StudyInstanceUIDs=1.3.6.1.4.1.25403.345050719074.3824.20170125095722.1&StudyInstanceUIDs=1.3.6.1.4.1.25403.345050719074.3824.20170125095258.1
tip

You can use this feature to open a current and prior study in the Viewer. Read more in the Hanging Protocol Module section. You can also use commas to separate values.

SeriesInstanceUIDs

Sometimes you need to only retrieve a specific series in a study, you can do that by providing series level QIDO query parameters in the URL such as SeriesInstanceUIDs. This does NOT work with instance or study level parameters. For example:

http://localhost:3000/viewer?StudyInstanceUIDs=1.3.6.1.4.1.25403.345050719074.3824.20170125095438.5&SeriesInstanceUIDs=1.3.6.1.4.1.25403.345050719074.3824.20170125095449.8

This will only open the viewer with one series (one displaySet) loaded, and no queries made for any other series.

Sometimes you need to only retrieve a subset of series in a study, you can do that by providing more than one series, separated by commas. For example:

http://localhost:3000/viewer?StudyInstanceUIDs=1.3.6.1.4.1.25403.345050719074.3824.20170125095438.5&SeriesInstanceUIDs=1.3.6.1.4.1.25403.345050719074.3824.20170125095449.8,1.3.6.1.4.1.25403.345050719074.3824.20170125095506.10

This will only open the viewer with two series (two displaySets) loaded, and no queries made for any other series.

initialSeriesInstanceUID

Alternatively, sometimes you want to just open the study on a specified series, but allowing other series to be present too. This is the same behavior can be achieved by using the initialSeriesInstanceUID parameter. For example:

http://localhost:3000/viewer?StudyInstanceUIDs=1.3.6.1.4.1.25403.345050719074.3824.20170125095438.5&initialSeriesInstanceUID=1.3.6.1.4.1.25403.345050719074.3824.20170125095449.8

This will open all the series in the study, but the viewer will start with the series specified by the initialSeriesInstanceUID parameter.

Note that you can combine these, if you want to load a specific set of series plus show an initial one as the first one selected, for example:

http://localhost:3000/viewer?StudyInstanceUIDs=1.3.6.1.4.1.25403.345050719074.3824.20170125095438.5&SeriesInstanceUIDs=1.3.6.1.4.1.25403.345050719074.3824.20170125095449.8,1.3.6.1.4.1.25403.345050719074.3824.20170125095506.10&initialSeriesInstanceUID=1.3.6.1.4.1.25403.345050719074.3824.20170125095506.10

initialSopInstanceUID

You can also specify the initial SOP Instance to be displayed by using the initialSopInstanceUID parameter. For example:

http://localhost:3000/viewer?StudyInstanceUIDs=1.3.6.1.4.1.25403.345050719074.3824.20170125095438.5&SeriesInstanceUIDs=1.3.6.1.4.1.25403.345050719074.3824.20170125095449.8&initialSopInstanceUID=1.3.6.1.4.1.25403.345050719074.3824.20170125095501.9

This will open the study with the filtered series, and navigate to the slice 101 which happens to be the SOP Instance specified by the initialSopInstanceUID

Note: again you can mix and match

http://localhost:3000/viewer?StudyInstanceUIDs=1.3.6.1.4.1.25403.345050719074.3824.20170125095438.5&SeriesInstanceUIDs=1.3.6.1.4.1.25403.345050719074.3824.20170125095449.8,1.3.6.1.4.1.25403.345050719074.3824.20170125095506.10&initialSeriesInstanceUID=1.3.6.1.4.1.25403.345050719074.3824.20170125095506.10&initialSopInstanceUID=1.3.6.1.4.1.25403.345050719074.3824.20170125095510.8

You can even load the whole study and only specify the initial SOP Instance to be displayed. Although it will take more time to match, but it works as expected.

http://localhost:3000/viewer?StudyInstanceUIDs=1.3.6.1.4.1.25403.345050719074.3824.20170125095438.5&initialSopInstanceUID=1.3.6.1.4.1.25403.345050719074.3824.20170125095510.8

hangingProtocolId

You can select the initial hanging protocol to apply by using the hangingProtocolId parameter. The selected parameter must be available in a hangingProtocolModule registration, but does not have to be active.

For instance for loading a specific study in mpr mode from start you can use:

http://localhost:3000/viewer?StudyInstanceUIDs=1.3.6.1.4.1.25403.345050719074.3824.20170125095438.5&hangingProtocolId=@ohif/mnGrid

token

Although not recommended, you can use the token param in the URL which will inject the token into the Authorization header of the request.