toastcheng/dicomweb-go

A DICOMweb client for Golang.

DICOMweb Go

Introduction

A DICOMweb client for Golang.

There are plenty of packages that allow you to read DICOM files in Go whereas not much for communicating with DICOM server.

Currently there are DICOM servers such as dcm4chee, Orthanc, etc., that support read/write DICOM by HTTP protocol, known as DICOMweb.

This package provides a simple DICOMweb client that allows you to query DICOM info (QIDO), retrieve DICOM files (WADO), and store DICOM files (STOW).

Documentation

• pkg.go.dev : https://pkg.go.dev/github.com/toastcheng/dicomweb-go/dicomweb
• Dicomweb : https://www.dicomstandard.org/dicomweb

Getting Started

Installation

go get github.com/toastcheng/dicomweb-go/dicomweb

Requirements

• Go 1.12+

Quick Examples

note: for demonstration, the endpoint is set to a dcm4chee server hosted by dcmjs.org. Change it to your DICOM server instead.

Query all study

client := dicomweb.NewClient("https://server.dcmjs.org/dcm4chee-arc/aets/DCM4CHEE/rs")

qido := dicomweb.QIDORequest{
    Type: dicomweb.Study,
}
resp, err := client.Query(qido)
if err != nil {
    log.Fatalf("faild to query: %v", err)
}

Query all series under specific study

client := dicomweb.NewClient(dicomweb.ClientOption{
    QIDOEndpoint: "https://server.dcmjs.org/dcm4chee-arc/aets/DCM4CHEE/rs",
    WADOEndpoint: "https://server.dcmjs.org/dcm4chee-arc/aets/DCM4CHEE/rs",
    STOWEndpoint: "https://server.dcmjs.org/dcm4chee-arc/aets/DCM4CHEE/rs",
})

studyInstanceUID := "1.3.6.1.4.1.25403.345050719074.3824.20170126085406.1"
qido := dicomweb.QIDORequest{
    Type:              dicomweb.Series,
    StudyInstanceUID:  studyInstanceUID,

}
resp, err := client.Query(qido)
if err != nil {
    log.Fatalf("faild to query: %v", err)
}
log.Println(resp)

Retrieve the DICOM file

client := dicomweb.NewClient(dicomweb.ClientOption{
    QIDOEndpoint: "https://server.dcmjs.org/dcm4chee-arc/aets/DCM4CHEE/rs",
    WADOEndpoint: "https://server.dcmjs.org/dcm4chee-arc/aets/DCM4CHEE/rs",
    STOWEndpoint: "https://server.dcmjs.org/dcm4chee-arc/aets/DCM4CHEE/rs",
})
studyInstanceUID := "1.3.6.1.4.1.25403.345050719074.3824.20170126085406.1"
seriesInstanceUID := "1.3.6.1.4.1.25403.345050719074.3824.20170126085406.2"
instanceUID := "1.3.6.1.4.1.25403.345050719074.3824.20170126085406.3"

wado := dicomweb.WADORequest{
    Type:              dicomweb.InstanceRaw,
    StudyInstanceUID:  studyInstanceUID,
    SeriesInstanceUID: seriesInstanceUID,
    SOPInstanceUID:    instanceUID,
    FrameID:           1,
}
parts, err := client.Retrieve(wado)
if err != nil {
    log.Fatalf("faild to query: %v", err)
}

for i, p := range parts {
    // save it into file like this:
    err := ioutil.WriteFile("/tmp/test_"+strconv.Itoa(i)+".dcm", p, 0666)
    if err != nil {
        log.Fatalf("faild to retrieve: %v", err)
    }
}

Store the DICOM file

client := dicomweb.NewClient(dicomweb.ClientOption{
    STOWEndpoint: "https://server.dcmjs.org/dcm4chee-arc/aets/DCM4CHEE/rs",
})

parts := [][]byte{}
// read your data like this:
for i := 0; i < 10; i++ {
    fname := fmt.Sprintf("data_%d.dcm", i)
    b, err := ioutil.ReadFile(fname)
    if err != nil {
        log.Fatal(err)
    }
    parts = append(parts, b)
}

stow := dicomweb.STOWRequest{
    StudyInstanceUID: "1.2.840.113820.0.20200429.174041.3",
    Parts:            parts,
}
resp, err := c.Store(stow)
if err != nil {
    log.Fatalf("faild to query: %v", err)
}
log.Println(resp)

Contributing

This project is still in development, any contributions, issues and feature requests are welcome! Please check out the issues page.

License

dicomweb-go is available under the MIT license.

dicomweb-go's Issues

Using another way to upload new Instance?

Hi, it's really nice to see this project. I am working on a medical project and use Golang. Now, I am using a HTTP client as usual. So I have a question. Why don't you use /instances/ like mentioned in the official doc instead of that, you are using /studies/ ?