🧪 Simple DICOM Integration with InterSystems IRIS for Health + dcm4che Simulator

This repository provides hands-on examples of DICOM integration using InterSystems IRIS for Health and the dcm4che DICOM simulator.

You’ll find:

A working IRIS production for handling DICOM messages
Tools to simulate common DICOM workflows (store, query, retrieve)
A sample WorkList scenario integrated with a MySQL database

Perfect for testing, learning, or building healthcare imaging integrations.

🧰 Requirements

To run this project, you’ll need:

Git
Docker + Docker Compose
⚠️ On Windows, make sure Docker is using Linux containers
Visual Studio Code with InterSystems ObjectScript Extension Pack

🚀 Getting Started

Once you’ve got Docker installed, you can get up and running with:

docker-compose build
docker-compose up -d

That’s it — you’re ready to dive in!

🧭 Explore the IRIS Production

Open the DICOM production interface in your browser:

👉 DICOM.Production
🔐 Credentials: superuser / SYS

📥 Use Case 1: Receiving DICOM with Embedded PDF

Description: A DICOM file containing a PDF report is received by IRIS. The system extracts metadata from the DICOM header (e.g. patient name, study ID) and stores both the PDF and metadata in another system (like an EHR or document store).

How to run it:

Open a shell in the tools container:
```
docker exec -it tools bash
```

Generate a DICOM file with embedded PDF:

./pdf2dcm -f /shared/pdf/metadata.xml -- /shared/pdf/sample.pdf /shared/pdf/embeddedpdf.dcm

Send it to IRIS:

./storescu -b DCM_PDF_SCP -c IRIS_PDF_SCU@iris:2010 /shared/pdf/embeddedpdf.dcm

📨 Check the messages in IRIS:
👉 Message Viewer

🔍 Use Case 2: Query / Retrieve (C-FIND / C-MOVE)

Description: IRIS queries a PACS using a DICOM C-FIND to locate imaging studies, then uses C-MOVE to retrieve one of the matching documents.

Querying with C-FIND

Open the tools container:
```
docker exec -it tools bash
```
Inspect a DICOM file:
```
./dcmdump /shared/dicom/d1I00001.dcm
```

Create the DICOMDIR database:

./dcmdir -c /shared/DICOMDIR --fs-id SAMPLEDICOMS --fs-desc /shared/dicom/descriptor /shared/dicom

Start the simulated archive:

./dcmqrscp --ae-config /shared/ae.properties -b DCM_QRY_SCP:3010 --dicomdir /shared/DICOMDIR

Connect to IRIS:

docker exec -it iris bash
iris session iris

Run the C-FIND:
```
do ##class(DICOM.BS.QueryService).TestFind()
```
👉 View results in QueryService Messages

Retrieving with C-MOVE

Request a study using C-MOVE:
```
do ##class(DICOM.BS.MoveService).TestMove()
```
👉 Track the transfer:
MoveService |
DICOM Store In

📋 Use Case 3: WorkList Management (C-FIND + SQL)

Description: An imaging device sends a C-FIND request to IRIS to retrieve scheduled studies. IRIS queries an external MySQL database, builds the WorkList response, and sends it back.

🛢️ Check the external MySQL WorkList DB

Enter the MySQL container:

docker exec -it mysql bash
mysql --host=localhost --user=testuser testdb -p  # Password: testpassword

View WorkList data:
```
SELECT * FROM WorkList;
```

📡 Request the WorkList using C-FIND

Open the tools container:
```
docker exec -it tools bash
```

Send a WorkList query:

./findscu -b DCM_WL -c IRIS_WL@iris:1112 -m StudyDate=20250404

🧠 See how IRIS handled it

👉 Check DICOM WL Find In Messages

🌐 Use Case 4: Store Document over the Web

Description: An imaging device sends an image over HTTP using a STOW-RS (HTTP POST) request to IRIS, which receives, extracts, and processes the DICOM image.

Open the tools container:
```
docker exec -it tools bash
```

Send a DICOM image using STOW-RS:

./stowrs --url http://iris:52773/dicom/studies /shared/dicom/d1I00001.dcm

In IRIS, check the received message in the DICOM REST Service Messages

🎉 You’re All Set!

You now have a fully working, simulated DICOM integration lab using IRIS for Health and dcm4che. Use it to learn, test, build prototypes — and have fun doing it!

📚 Learn More

workshop-iris-dicom-interop