pynetdicom Documentation

DICOM

DICOM is the international standard for medical images and related information. It defines the formats and communication protocols for media exchange in radiology, cardiology, radiotherapy and other medical domains. If you’ve ever had an X-ray, an MR scan, an ultrasound or one of many other medical procedures, then the chances are that the DICOM standard was involved in some way.

pynetdicom

pynetdicom is a pure Python 2.7/3.4+ package that implements the DICOM networking protocol. Working with pydicom, it allows the easy creation of DICOM Application Entities (AEs), which can then act as Service Class Users (SCUs) and Service Class Providers (SCPs) by associating with other AEs and using or providing the services available to the association.

Supported Service Classes

pynetdicom currently supports the following DICOM service classes:

• Verification Service Class
• Storage Service Class
• Query/Retrieve Service Class
• Basic Worklist Management Service Class
• Relevant Patient Information Query Service Class
• Substance Administration Query Service Class
• Non-Patient Object Storage Service Class
• Color Palette Query/Retrieve Service Class
• Defined Procedure Protocol Query/Retrieve Service Class
• Hanging Protocol Query/Retrieve Service Class
• Implant Template Query/Retrieve Service Class
• Display System Management Service Class
• Modality Performed Procedure Step Management

User Guide

The User Guide is intended as an introduction to pynetdicom and explains how to install the API and covers basic usage. For detailed documentation of the functions and classes see the API reference.

• User Guide
  • Installation
    • Installing the current release
    • Installing the development version
  • Important Concepts
    • UIDs
    • DICOM Information Model
    • Application Entities
    • Presentation Contexts
    • Association
  • Presentation Contexts
    • Introduction
    • Presentation Contexts and the Association Requestor
    • Presentation Contexts and the Association Acceptor
    • Presentation Context Negotiation
    • SCP/SCU Role Selection
  • Events
    • Notification Events
    • Intervention Events
    • Event Handlers
  • Application Entity
    • Creating an SCU
    • Creating an SCP
  • Association
    • Requesting an Association (SCU)
    • Using an Association (SCU)
    • Accessing User Identity Responses
    • Listening for Association Requests (SCP)
    • Providing DIMSE Services (SCP)

Examples

• Verification Service Examples

• Storage Service Examples

• Query/Retrieve (Find) Service Examples

• Query/Retrieve (Get) Service Examples

• Query/Retrieve (Move) Service Examples

• Basic Worklist Management Service Examples

• Relevant Patient Information Query Service Examples

• Display System Management Service Examples

• Modality Performed Procedure Step Management Service Examples

API Reference

The API Reference provides documentation of the important functions and classes.

Applications

• echoscu

• echoscp

• storescu

• storescp

Release Notes

• 1.3.1
• 1.3.0
• 1.2.0
• 1.1.0
• 1.0.0