DICOMweb Client

JavaScript client implementation of DICOMweb.

For further details please refer to PS3.18 of the DICOM standard.

Goal

This is work-in-progress and should not be used in clinical practice.

The main motivation for this project is:

• Support for storing, quering, retrieving DICOM objects over the web using RESTful services STOW-RS, QIDO-RS and WADO-RS, respectively
• Building a lightweight library to facilitate integration into web applications

Installation

Install the dicomweb-client package using the npm package manager:

npm install dicomweb-client

Building and testing

Build and test code locally:

git clone https://github.com/dcmjs-org/dicomweb-client ~/dicomweb-client
cd ~/dicomweb-client
npm install
npm run build
npm test

Usage

<script type="text/javascript" src="https://unpkg.com/dicomweb-client"></script>

const url = 'http://localhost:8080/dicomweb';
const client = new DICOMwebClient.api.DICOMwebClient({url});
client.searchForStudies().then(studies => {
  console.log(studies)
});

For maintainers

Use semantic commit messages to generate releases and change log entries: Semantic Release: How does it work?

Citation

Please cite the following article when using the client for scientific studies: Herrmann et al. J Path Inform. 2018:

@article{jpathinform-2018-9-37,
    Author={
        Herrmann, M. D. and Clunie, D. A. and Fedorov A. and Doyle, S. W. and Pieper, S. and
        Klepeis, V. and Le, L. P. and Mutter, G. L. and Milstone, D. S. and Schultz, T. J. and
        Kikinis, R. and Kotecha, G. K. and Hwang, D. H. and Andriole, K, P. and Iafrate, A. J. and
        Brink, J. A. and Boland, G. W. and Dreyer, K. J. and Michalski, M. and
        Golden, J. A. and Louis, D. N. and Lennerz, J. K.
    },
    Title={Implementing the {DICOM} standard for digital pathology},
    Journal={Journal of Pathology Informatics},
    Year={2018},
    Number={1},
    Volume={9},
    Number={37}
}

Support

The developers gratefully acknowledge their reseach support:

• Open Health Imaging Foundation (OHIF)
• Quantitative Image Informatics for Cancer Research (QIICR)
• Radiomics
• The Neuroimage Analysis Center
• The National Center for Image Guided Therapy
• The MGH & BWH Center for Clinical Data Science

Changelog

All notable changes to this project will be documented in this file.

The format is based on Keep a Changelog and this project adheres to Semantic Versioning.

[0.3.2] - 2018-09-26

Added

• Added DICOMWebClient.version and associated NPM script to make it easier to determine which version of the library is running in an application

Changed

• Added Babel to the Rollup configuration to produce a transpiled version of the library which can run on all browsers above Internet Explorer 11

[0.3.1] - 2018-09-25

Fixed

• Removed reference to 'window' so the library can be used in Node.js more easily

[0.3.0] - 2018-09-24

Added

• Added support for WADO-RS [RetrieveStudy](http://dicom.nema .org/medical/dicom/current/output/chtml/part18/sect_6.5.html#sect_6.5.1)
• Added support for WADO-RS RetrieveSeries
• Added support for WADO-RS RetrieveInstance
• Added support for WADO-RS RetrieveBulkData
• Added support for constructing WADO-URI URLs from the necessary parameters

Changed

• Switched from console.error() to throw new Error() for invalid handling input

Fixed

• Removed duplicated tests for StoreInstances

[0.2.0] - 2018-09-20

Added

• Added support for STOW-RS StoreInstances

Changed

• Switched from Mochify to Karma for running tests

Fixed

• Fixed exit code from test.sh script to ensure Continuous Integration server properly reports failures.