Skip to content

Commit

Permalink
docs(#5): add logos and introduction for OMI
Browse files Browse the repository at this point in the history
  • Loading branch information
nickamzol committed Jul 2, 2024
1 parent ddee7e3 commit 8250659
Show file tree
Hide file tree
Showing 5 changed files with 62 additions and 43 deletions.
80 changes: 40 additions & 40 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,31 +1,59 @@
<div align="center">

![DICOM-RST Logo[^1]](./dicom-rst-icon.png)
![DICOM-RST Logo[^1]](docs/images/dicom-rst-icon.png)

# DICOM-RST

**A robust DICOMweb server with interchangeable backends**
**DICOMweb-compatible gateway server with DIMSE and S3 implementations.**

Developed as part of the [Open Medical Inference](https://diz.ikim.nrw/en/project/omi/) methodology platform.

[Changelog](./CHANGELOG.md) | [Wiki](https://github.com/UMEssen/DICOM-RST/wiki)
[Documentation](https://umessen.github.io/DICOM-RST/usage-guide.html) | [Changelog](./CHANGELOG.md)

</div>

---

> [!WARNING]
> This project is highly experimental.
>
> We're still gathering information about potential compatibility issues with various PACS vendors.

DICOM-RST implements a DICOMweb-compatible HTTP server with support for QIDO-RS, WADO-RS and STOW-RS.
DICOM-RST is a robust DICOMweb-compatible gateway server that supports QIDO-RS, WADO-RS and STOW-RS independently of the
PACS vendor, ensuring robust and performant transfers of large amounts of imaging data with high parallelism from
multiple PACS to multiple clients.

This project is part of
the [Open Medical Inference](https://www.medizininformatik-initiative.de/de/omi-open-medical-inference) methodology
platform.

The OMI methodology platform aims to
improve the quality of medical diagnoses and treatment decisions by using
artificial intelligence (AI) to simplify time-consuming and repetitive tasks in medicine. To improve medical care, OMI
is developing an open protocol for data exchange on the common framework of the Medical Informatics Initiative (MII).
The project team is also actively involved in the MII interoperability working group.

OMI uses innovative methods to make AI models remotely usable for different hospitals. For example, the project is
creating the technical requirements for a hospital to be able to use the AI of other hospitals to analyze image data -
without having to keep it in its own data center. The semantically interoperable exchange of multimodal healthcare data
is also to be facilitated. OMI is particularly focused on image-based multimodal AI models, which have the potential to
achieve significant progress in the field of medical research and care. Funding is provided by the Federal Ministry of
Education and Research (BMBF).

<img src="docs/images/mii-omi.jpg" alt="MII-Logo" width="128"/>
<img src="docs/images/omi-logo.png" alt="OMI-Logo" width="128"/>

Currently, only the DIMSE backend is implemented, which translates DICOMweb requests into DIMSE-C operations.
## Available Backends

DICOM-RST provides multiple backend implementations for the DICOMweb gateway server:

**DIMSE**:
The DIMSE backend translates DICOMweb requests into DIMSE-C messages (e.g. WADO-RS to C-MOVE).
This is the preferred backend for most users due to the broad availability and support of DIMSE services in picture
archiving and communication systems.

**S3**:
The experimental S3 backend downloads DICOM instances from S3-compatible storage. Currently, only the WADO-RS
service is implemented.

## DICOMweb Features

Actual support may vary depending on the features implemented by the origin server.
> [!NOTE]
> Actual support may vary depending on the features implemented by the origin server.
### Retrieve DICOM objects (WADO-RS)

Expand Down Expand Up @@ -121,34 +149,6 @@ Returns a simple OK if the connection is still healthy.
|--------------|----------------|
| Health Check | `/aets/{aets}` |

## Deployment

### Docker

```shell
# Build the Docker image...
docker build -t dicom-rst .

# ...and run it!
docker run dicom-rst
```

### Cargo

Cargo makes it easy to build from source:

```shell
cargo install --git https://github.com/UMEssen/DICOM-RST dicom-rst
```

#### Crate Features

- `dimse` (default): Enables the DIMSE backend
- `s3`: Enables the S3 backend

> [!TIP]
> If the DIMSE backend is not needed, it can be removed by using the `--no-default-features` option.
[^1]: The [DICOM-RST logo](./dicom-rst-icon.png) is adapted from
the [Rust logo](https://github.com/rust-lang/rust-artwork)
owned by the Rust Foundation, used under CC-BY.
Binary file added docs/images/mii-logo.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/images/mii-omi.jpg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/images/omi-logo.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
25 changes: 22 additions & 3 deletions docs/topics/introduction.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,28 @@
# Introduction

%product% is a robust DICOMweb-compatible gateway server that supports QIDO-RS, WADO-RS and STOW-RS independently of the
PACS vendor,
ensuring robust and performant transfers of large amounts of imaging data with high parallelism from multiple PACS to
multiple clients.
PACS vendor, ensuring robust and performant transfers of large amounts of imaging data with high parallelism from
multiple PACS to multiple clients.

This project is part of
the [Open Medical Inference](https://www.medizininformatik-initiative.de/de/omi-open-medical-inference)
methodology platform.

The OMI methodology platform aims to
improve the quality of medical diagnoses and treatment decisions by using
artificial intelligence (AI) to simplify time-consuming and repetitive tasks in medicine. To improve medical care, OMI
is developing an open protocol for data exchange on the common framework of the Medical Informatics Initiative (MII).
The project team is also actively involved in the MII interoperability working group.

OMI uses innovative methods to make AI models remotely usable for different hospitals. For example, the project is
creating the technical requirements for a hospital to be able to use the AI of other hospitals to analyze image data -
without having to keep it in its own data center. The semantically interoperable exchange of multimodal healthcare data
is also to be facilitated. OMI is particularly focused on image-based multimodal AI models, which have the potential to
achieve significant progress in the field of medical research and care. Funding is provided by the Federal Ministry of
Education and Research (BMBF).

<img src="mii-omi.jpg" alt="MII-Logo" width="128" style="inline"/>
<img src="omi-logo.png" alt="OMI-Logo" width="128" style="inline"/>

This documentation provides a reference for the configuration file, the provided endpoints and a user guide for
installation
Expand Down

0 comments on commit 8250659

Please sign in to comment.