Dicoogle Client

This is a web service client API to Dicoogle, the open-source PACS archive, for use in JavaScript applications. This library is compatible with browser-based JavaScript and Node.js. A CLI application for searching medical images in Dicoogle is also included (dicoogle-query).

This library intends to be fully compatible with Dicoogle versions 2 and 3, and may be updated as future versions of Dicoogle are released.

Using the JavaScript API

The full API is documented here. Documentation was built from our TypeScript definitions, which are also available.

Quick Start

import dicoogleClient from "dicoogle-client";

// obtain a dicoogle access object
const Dicoogle = dicoogleClient("localhost:8080");

// if required, login to the system before using
await Dicoogle.login('admin', 'mysecretpassword');

// Ok! Start using Dicoogle!
let outcome = await Dicoogle.search("PatientName:Pinho^Eduardo", {provider: 'lucene'});
// use outcome
const {elapsedTime, results} = outcome;
for (const r of result) {
  console.log(`> ${r.uri}`);
}

Using the CLI client

Install this package globally (npm install -g dicoogle-client), then use dicoogle-query.

Usage: dicoogle-query [OPTIONS] QUERY

Options:

• -h, --help : show this help
• -k, --keyword : forcefully perform a keyword-based query
• -F, --free-text : forcefully perform a free text query
• -T, --tty : force terminal (TTY) output instead of minified JSON
• -p, --provider <name> : include this query provider
• -s, --server <url> : set the Dicoogle server's base endpoint
• -D, --debug : output additional information

Environment variables:

• DICOOGLE_USERNAME : The client's unique user name.
• DICOOGLE_PASSWORD : The user's password.

Example: dicoogle-query -p lucene -s "http://demo.dicoogle.com" "Modality:MR"

License

Copyright (C) 2016 Universidade de Aveiro, DETI/IEETA, Bioinformatics Group - http://bioinformatics.ua.pt/ Copyright (C) 2026 Dicoogle Team - https://dicoogle.com

This software is part of Dicoogle.

Dicoogle/dicoogle-client-js is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.

Dicoogle/dicoogle-client-js is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

You should have received a copy of the GNU General Public License along with Dicoogle. If not, see http://www.gnu.org/licenses/.