kcenon::pacs::services::xds::imaging_document_consumer Class Reference

IHE XDS-I.b Imaging Document Consumer Actor. More...

#include <imaging_document_consumer.h>

Collaboration diagram for kcenon::pacs::services::xds::imaging_document_consumer:

Public Member Functions
	imaging_document_consumer ()=default
	imaging_document_consumer (const imaging_document_consumer_config &config)
registry_query_result	query_registry (const registry_query_params &params) const
	Query the XDS registry for imaging documents.
document_retrieval_result	retrieve_document (const document_reference &doc_ref, bool is_imaging=true) const
	Retrieve a specific document from the XDS repository.
void	set_audit_handler (std::shared_ptr< kcenon::pacs::security::atna_service_auditor > auditor)
	Install an ATNA audit handler for XDS-I.b transactions.
document_retrieval_result	extract_references (const core::dicom_dataset &kos_dataset) const
	Extract image references from a KOS dataset.
std::string	build_wado_rs_url (const std::string &study_uid, const std::string &series_uid, const std::string &instance_uid) const
	Build a WADO-RS URL for retrieving a specific instance.
const imaging_document_consumer_config &	config () const noexcept
	Get current configuration.
void	set_config (const imaging_document_consumer_config &config)
	Set configuration.

Private Attributes
imaging_document_consumer_config	config_
std::shared_ptr< kcenon::pacs::security::atna_service_auditor >	auditor_

Detailed Description

IHE XDS-I.b Imaging Document Consumer Actor.

Queries XDS Document Registries for imaging documents (KOS) and provides the interface for retrieving referenced images via WADO-RS or DICOM C-MOVE.

Workflow

1. Query the registry for imaging documents using query_registry()
2. Retrieve specific KOS documents using retrieve_document()
3. Extract image references from the KOS document
4. Retrieve images via WADO-RS using build_wado_rs_url()

Example:

imaging_document_consumer_config config;
config.registry_url = "https://xds-registry.example.com/services/iti18";
config.wado_rs_url = "https://pacs.example.com/wado-rs";
 
imaging_document_consumer consumer{config};
 
// Query for patient's imaging documents
registry_query_params params;
params.patient_id = "12345^^^&1.2.3&ISO";
 
auto query_result = consumer.query_registry(params);
if (query_result.success) {
    for (const auto& doc : query_result.documents) {
        auto retrieval = consumer.retrieve_document(doc);
        // Process retrieved KOS document
    }
}

Definition at line 208 of file imaging_document_consumer.h.

Constructor & Destructor Documentation

imaging_document_consumer() [1/2]

kcenon::pacs::services::xds::imaging_document_consumer::imaging_document_consumer ( )

default

imaging_document_consumer() [2/2]

kcenon::pacs::services::xds::imaging_document_consumer::imaging_document_consumer ( const imaging_document_consumer_config & config )

explicit

Definition at line 38 of file imaging_document_consumer.cpp.

    : config_(config) {}

Member Function Documentation

build_wado_rs_url()

std::string kcenon::pacs::services::xds::imaging_document_consumer::build_wado_rs_url ( const std::string & study_uid, const std::string & series_uid, const std::string & instance_uid ) const

nodiscard

Build a WADO-RS URL for retrieving a specific instance.

Constructs a WADO-RS retrieve URL based on the configured WADO-RS base URL and the instance identifiers.

Parameters

study_uid	Study Instance UID
series_uid	Series Instance UID
instance_uid	SOP Instance UID

Returns

The WADO-RS retrieve URL

Definition at line 175 of file imaging_document_consumer.cpp.

                                         {
 
    std::ostringstream url;
    url << config_.wado_rs_url;
 
    // Ensure base URL doesn't end with '/'
    if (!config_.wado_rs_url.empty() && config_.wado_rs_url.back() == '/') {
        // Remove the trailing '/' already added
    } else {
        url << '/';
    }
 
    url << "studies/" << study_uid
        << "/series/" << series_uid
        << "/instances/" << instance_uid;
 
    return url.str();
}

References config_, and kcenon::pacs::services::xds::imaging_document_consumer_config::wado_rs_url.

config()

const imaging_document_consumer_config & kcenon::pacs::services::xds::imaging_document_consumer::config ( ) const

nodiscardnoexcept

Get current configuration.

Returns

Reference to configuration

Definition at line 198 of file imaging_document_consumer.cpp.

                                                 {
    return config_;
}

References config_.

Referenced by set_config().

Here is the caller graph for this function:

extract_references()

document_retrieval_result kcenon::pacs::services::xds::imaging_document_consumer::extract_references ( const core::dicom_dataset & kos_dataset ) const

nodiscard

Extract image references from a KOS dataset.

Parses a KOS (Key Object Selection) document and extracts the referenced SOP Instance UIDs, organized by study and series.

Parameters

kos_dataset

The KOS dataset to parse

Returns

Retrieval result with extracted references

Definition at line 111 of file imaging_document_consumer.cpp.

                                                {
 
    document_retrieval_result result;
    result.success = true;
 
    // Parse Current Requested Procedure Evidence Sequence (0040,A375)
    const auto* evidence_elem = kos_dataset.get(
        consumer_tags::current_requested_procedure_evidence_sequence);
 
    if (!evidence_elem || !evidence_elem->is_sequence()) {
        result.error_message = "KOS document does not contain evidence sequence";
        result.success = false;
        return result;
    }
 
    for (const auto& study_item : evidence_elem->sequence_items()) {
        // Extract Study Instance UID
        auto study_uid = study_item.get_string(tags::study_instance_uid);
        if (!study_uid.empty()) {
            if (std::find(result.referenced_study_uids.begin(),
                         result.referenced_study_uids.end(),
                         study_uid) == result.referenced_study_uids.end()) {
                result.referenced_study_uids.push_back(study_uid);
            }
        }
 
        // Parse Referenced Series Sequence
        const auto* series_elem = study_item.get(
            consumer_tags::referenced_series_sequence);
        if (!series_elem || !series_elem->is_sequence()) {
            continue;
        }
 
        for (const auto& series_item : series_elem->sequence_items()) {
            auto series_uid = series_item.get_string(tags::series_instance_uid);
            if (!series_uid.empty()) {
                if (std::find(result.referenced_series_uids.begin(),
                             result.referenced_series_uids.end(),
                             series_uid) == result.referenced_series_uids.end()) {
                    result.referenced_series_uids.push_back(series_uid);
                }
            }
 
            // Parse Referenced SOP Sequence
            const auto* sop_elem = series_item.get(
                consumer_tags::referenced_sop_sequence);
            if (!sop_elem || !sop_elem->is_sequence()) {
                continue;
            }
 
            for (const auto& sop_item : sop_elem->sequence_items()) {
                auto instance_uid = sop_item.get_string(
                    consumer_tags::referenced_sop_instance_uid);
                if (!instance_uid.empty()) {
                    result.referenced_instance_uids.push_back(instance_uid);
                }
            }
        }
    }
 
    return result;
}

References kcenon::pacs::services::xds::consumer_tags::current_requested_procedure_evidence_sequence, kcenon::pacs::services::xds::document_retrieval_result::error_message, kcenon::pacs::core::dicom_dataset::get(), kcenon::pacs::services::xds::document_retrieval_result::referenced_instance_uids, kcenon::pacs::services::xds::consumer_tags::referenced_series_sequence, kcenon::pacs::services::xds::document_retrieval_result::referenced_series_uids, kcenon::pacs::services::xds::consumer_tags::referenced_sop_instance_uid, kcenon::pacs::services::xds::consumer_tags::referenced_sop_sequence, kcenon::pacs::services::xds::document_retrieval_result::referenced_study_uids, kcenon::pacs::core::tags::series_instance_uid, kcenon::pacs::core::tags::study_instance_uid, and kcenon::pacs::services::xds::document_retrieval_result::success.

Here is the call graph for this function:

query_registry()

registry_query_result kcenon::pacs::services::xds::imaging_document_consumer::query_registry ( const registry_query_params & params ) const

nodiscard

Query the XDS registry for imaging documents.

Performs an ITI-18 (Registry Stored Query) to find imaging documents matching the specified criteria.

Parameters

params

Query parameters

Returns

Query result with document references

Definition at line 42 of file imaging_document_consumer.cpp.

                                                                {
 
    registry_query_result result;
 
    if (config_.registry_url.empty()) {
        result.error_message = "XDS registry URL not configured";
        return result;
    }
 
    // NOTE: Actual SOAP request to the XDS registry (ITI-18)
    // would be implemented here using the network layer.
    // The ITI-18 transaction uses SOAP/XML encoding with
    // the AdhocQueryRequest/AdhocQueryResponse pattern.
    result.success = true;
 
    return result;
}

References config_, kcenon::pacs::services::xds::registry_query_result::error_message, kcenon::pacs::services::xds::imaging_document_consumer_config::registry_url, and kcenon::pacs::services::xds::registry_query_result::success.

retrieve_document()

document_retrieval_result kcenon::pacs::services::xds::imaging_document_consumer::retrieve_document ( const document_reference & doc_ref, bool is_imaging = true ) const

nodiscard

Retrieve a specific document from the XDS repository.

Performs an ITI-43 (Retrieve Document Set) or RAD-69 (Retrieve Imaging Document Set) transaction to fetch a KOS document identified by the document reference. When an ATNA audit handler is installed, an Import audit event is emitted for both success and failure paths.

Parameters

doc_ref	The document reference from a registry query
is_imaging	true for RAD-69 (Retrieve Imaging Document Set), false for ITI-43 (Retrieve Document Set). Controls the transaction code recorded in the ATNA audit.

Returns

Retrieval result with the KOS dataset

Definition at line 61 of file imaging_document_consumer.cpp.

                           {
 
    document_retrieval_result result;
 
    const auto transaction =
        is_imaging
            ? security::atna_service_auditor::xds_consumer_transaction::rad_69
            : security::atna_service_auditor::xds_consumer_transaction::iti_43;
 
    if (config_.repository_url.empty()) {
        result.error_message = "XDS repository URL not configured";
        if (auditor_) {
            auditor_->audit_xds_retrieve(
                transaction,
                doc_ref.repository_unique_id,  // remote source
                config_.repository_url,        // local destination (empty)
                doc_ref.unique_id,             // document/study identifier
                doc_ref.patient_id,
                {doc_ref.unique_id},           // SOP-level reference
                false);
        }
        return result;
    }
 
    // NOTE: Actual SOAP/MTOM request to the XDS repository (ITI-43 / RAD-69)
    // would be implemented here. The response contains the KOS
    // document as an MTOM attachment.
    result.success = true;
 
    if (auditor_) {
        auditor_->audit_xds_retrieve(
            transaction,
            doc_ref.repository_unique_id,
            config_.repository_url,
            doc_ref.unique_id,
            doc_ref.patient_id,
            {doc_ref.unique_id},
            true);
    }
 
    return result;
}

References kcenon::pacs::security::atna_service_auditor::audit_xds_retrieve(), auditor_, config_, kcenon::pacs::services::xds::document_retrieval_result::error_message, kcenon::pacs::security::atna_service_auditor::iti_43, kcenon::pacs::services::xds::document_reference::patient_id, kcenon::pacs::security::atna_service_auditor::rad_69, kcenon::pacs::services::xds::document_reference::repository_unique_id, kcenon::pacs::services::xds::imaging_document_consumer_config::repository_url, kcenon::pacs::services::xds::document_retrieval_result::success, and kcenon::pacs::services::xds::document_reference::unique_id.

Here is the call graph for this function:

set_audit_handler()

void kcenon::pacs::services::xds::imaging_document_consumer::set_audit_handler

(

std::shared_ptr< kcenon::pacs::security::atna_service_auditor >

auditor

)

Install an ATNA audit handler for XDS-I.b transactions.

When set, an audit event is emitted for each retrieve_document() call (ITI-43 or RAD-69) on both success and failure paths. Passing nullptr disables auditing for this consumer.

Parameters

auditor

Shared pointer to an ATNA service auditor

Definition at line 106 of file imaging_document_consumer.cpp.

                                                                   {
    auditor_ = std::move(auditor);
}

References auditor_.

set_config()

void kcenon::pacs::services::xds::imaging_document_consumer::set_config

(

const imaging_document_consumer_config &

config

)

Set configuration.

Parameters

config

New configuration

Definition at line 202 of file imaging_document_consumer.cpp.

                                                    {
    config_ = config;
}

References config(), and config_.

Here is the call graph for this function:

Member Data Documentation

auditor_

std::shared_ptr<kcenon::pacs::security::atna_service_auditor> kcenon::pacs::services::xds::imaging_document_consumer::auditor_

private

Definition at line 298 of file imaging_document_consumer.h.

Referenced by retrieve_document(), and set_audit_handler().

config_

imaging_document_consumer_config kcenon::pacs::services::xds::imaging_document_consumer::config_

private

Definition at line 297 of file imaging_document_consumer.h.

Referenced by build_wado_rs_url(), config(), query_registry(), retrieve_document(), and set_config().

---

The documentation for this class was generated from the following files:

• include/kcenon/pacs/services/xds/imaging_document_consumer.h
• src/services/xds/imaging_document_consumer.cpp