dicomweb-node-client

0.8.3 • Public • Published

Build Status

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-node-client package using the npm package manager:

npm install dicomweb-node-client

Building and testing

Build and test code locally:

git clone https://github.com/zhiva-ai/dicomweb-node-client ~/dicomweb-node-client
cd ~/dicomweb-node-client
npm install
npm run build

Usage

NodeJS

const DICOMWebNodeClient = require('dicomweb-node-client');

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

JS Application

Exactly the same as node, you can import it as DICOMwebClient to be inline with original repo.

import * as DICOMwebClient from 'dicomweb-node-client';

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

Direct browser import

<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)
});

Contributions

We made a for of the original dicomweb-client library and extended it with NodeJS support. If you're using this library you don't have to contribute us, but please contribute the amazing people responsible for the original implementation. More details on their GitHub: https://github.com/dcmjs-org/dicomweb-client#citation

Package Sidebar

Install

npm i dicomweb-node-client

Weekly Downloads

0

Version

0.8.3

License

MIT

Unpacked Size

460 kB

Total Files

9

Last publish

Collaborators

  • burnpiro