aurabx/dicomweb-parser

1.2.0 2025-04-20 07:26 UTC

Requires

• php: >=8.2
• ext-json: *
• aurabx/dicom-data: ^0.5.0

Requires (Dev)

• phpunit/phpunit: ^12.0
• squizlabs/php_codesniffer: ^3.6

MIT

README

A PHP library for parsing DICOMWeb JSON responses into structured PHP objects.

Requirements

• PHP 8.2 or higher
• aurabx/dicom-data

Installation

composer require your-vendor/dicomweb-parser

Usage

Basic Usage

<?php

use Aurabx\DicomWebParser\Parser;

// Your DICOMWeb JSON response
dollarjsonData = file_get_contents('dicom_response.json');

// Create a parser instance
$parser = new Parser();

// Parse the JSON into DICOM instances
$instances = $parser->parseInstances($jsonData);

// Display information about the first instance
$firstInstance = $instances[0];
echo "SOP Instance UID: " . $firstInstance->getSopInstanceUid() . "\n";
echo "Study Instance UID: " . $firstInstance->getStudyInstanceUid() . "\n";
echo "Series Instance UID: " . $firstInstance->getSeriesInstanceUid() . "\n";
echo "Modality: " . $firstInstance->getModality() . "\n";

// Access any DICOM tag by its tag ID
$patientId = $firstInstance->getFirstValue('00100020');
echo "Patient ID: " . $patientId . "\n";

// Access a DICOM tag by its standard name
$modality = $firstInstance->getFirstValueByName('Modality');
echo "Modality: " . $modality . "\n";

// Parse the response into a study structure
$study = $parser->parseStudy($jsonData);
echo "Study has " . $study->getSeriesCount() . " series and " .
     $study->getTotalInstanceCount() . " total instances\n";

Working with Series and Studies

<?php

use Aurabx\DicomWebParser\Parser;

$jsonData = file_get_contents('dicom_response.json');
$parser = new Parser();
$study = $parser->parseStudy($jsonData);

// Get all series in the study
$seriesList = $study->getSeries();

foreach ($seriesList as $series) {
    echo "Series UID: " . $series->getSeriesInstanceUid() . "\n";
    echo "Series has " . $series->getInstanceCount() . " instances\n";

    // Sort instances by instance number
    $series->sortInstancesByNumber();

    // Get all instances in this series
    $instances = $series->getInstances();

    foreach ($instances as $instance) {
        echo "  Instance UID: " . $instance->getSopInstanceUid() . "\n";
    }
}

Using Tag Utilities

<?php

use Aurabx\DicomData\DicomTag;

// Get the descriptive name for a tag
$tagName = DicomTag::getName('00100010');  // Returns "PatientName"

// Format a tag with a separator
$formattedTag = DicomTag::formatTag('00100010', 'comma');  // Returns "0010,0010"
$formattedTag = DicomTag::formatTag('00100010', 'both');   // Returns "(0010,0010)"

// Get the meaning of a Value Representation code
$vrMeaning = DicomTag::getVRMeaning('PN');  // Returns "Person Name"

Key Features

• Parse DICOMWeb JSON responses into structured PHP objects
• Full support for DICOM instances, series, and studies
• Access DICOM elements by tag ID or friendly name
• Preload tag dictionaries for testing or performance
• Includes tag metadata lookup, name resolution, VR decoding
• Fully type hinted (PHP 8.2+ recommended)

Class Structure

• Parser - Main parser for DICOMWeb JSON
• DicomElement - Represents a DICOM attribute
• DicomInstance - Single DICOM SOP instance
• DicomSeries - Group of instances
• DicomStudy - Group of series
• DicomTag - Static utilities for tags
• DicomTagLoader - Loads tag metadata from JSON
• DicomDictionary - Global tag lookup facade
• ParserException - Exception class

License

MIT