mpps_scu.h

Go to the documentation of this file.

// BSD 3-Clause License
// Copyright (c) 2021-2025, 🍀☀🌕🌥 🌊
// See the LICENSE file in the project root for full license information.
 
#ifndef PACS_SERVICES_MPPS_SCU_HPP
#define PACS_SERVICES_MPPS_SCU_HPP
 
#include "mpps_scp.h"
 
#include "kcenon/pacs/core/dicom_dataset.h"
#include "kcenon/pacs/di/ilogger.h"
#include "kcenon/pacs/network/association.h"
#include "kcenon/pacs/network/dimse/dimse_message.h"
 
#include <atomic>
#include <chrono>
#include <memory>
#include <string>
#include <vector>
 
namespace kcenon::pacs::services {
 
// =============================================================================
// MPPS SCU Data Structures
// =============================================================================
 
struct performed_series_info {
    std::string series_uid;
 
    std::string series_description;
 
    std::string modality;
 
    std::string performing_physician;
 
    std::string operator_name;
 
    std::vector<std::string> sop_instance_uids;
 
    size_t num_instances{0};
};
 
struct mpps_create_data {
    // Scheduled Step Reference
    std::string scheduled_procedure_step_id;
    std::string study_instance_uid;
    std::string accession_number;
 
    // Patient Information
    std::string patient_name;
    std::string patient_id;
    std::string patient_birth_date;
    std::string patient_sex;
 
    // Performed Procedure Step Information
    std::string mpps_sop_instance_uid;          
    std::string procedure_step_start_date;      
    std::string procedure_step_start_time;      
    std::string modality;
    std::string station_ae_title;
    std::string station_name;
    std::string procedure_description;
 
    // Performing Information
    std::string performing_physician;
    std::string operator_name;
};
 
struct mpps_set_data {
    std::string mpps_sop_instance_uid;
 
    mpps_status status{mpps_status::completed};
 
    std::string procedure_step_end_date;
 
    std::string procedure_step_end_time;
 
    std::vector<performed_series_info> performed_series;
 
    std::string discontinuation_reason;
};
 
struct mpps_result {
    std::string mpps_sop_instance_uid;
 
    uint16_t status{0};
 
    std::string error_comment;
 
    std::chrono::milliseconds elapsed{0};
 
    [[nodiscard]] bool is_success() const noexcept {
        return status == 0x0000;
    }
 
    [[nodiscard]] bool is_warning() const noexcept {
        return (status & 0xF000) == 0xB000;
    }
 
    [[nodiscard]] bool is_error() const noexcept {
        return !is_success() && !is_warning();
    }
};
 
struct mpps_scu_config {
    std::chrono::milliseconds timeout{30000};
 
    bool auto_generate_uid{true};
};
 
// =============================================================================
// MPPS SCU Class
// =============================================================================
 
class mpps_scu {
public:
    // =========================================================================
    // Construction
    // =========================================================================
 
    explicit mpps_scu(std::shared_ptr<di::ILogger> logger = nullptr);
 
    explicit mpps_scu(const mpps_scu_config& config,
                      std::shared_ptr<di::ILogger> logger = nullptr);
 
    ~mpps_scu() = default;
 
    // Non-copyable, non-movable (due to atomic members)
    mpps_scu(const mpps_scu&) = delete;
    mpps_scu& operator=(const mpps_scu&) = delete;
    mpps_scu(mpps_scu&&) = delete;
    mpps_scu& operator=(mpps_scu&&) = delete;
 
    // =========================================================================
    // N-CREATE Operation
    // =========================================================================
 
    [[nodiscard]] network::Result<mpps_result> create(
        network::association& assoc,
        const mpps_create_data& data);
 
    // =========================================================================
    // N-SET Operations
    // =========================================================================
 
    [[nodiscard]] network::Result<mpps_result> set(
        network::association& assoc,
        const mpps_set_data& data);
 
    [[nodiscard]] network::Result<mpps_result> complete(
        network::association& assoc,
        std::string_view mpps_uid,
        const std::vector<performed_series_info>& performed_series);
 
    [[nodiscard]] network::Result<mpps_result> discontinue(
        network::association& assoc,
        std::string_view mpps_uid,
        std::string_view reason = "");
 
    // =========================================================================
    // Statistics
    // =========================================================================
 
    [[nodiscard]] size_t creates_performed() const noexcept;
 
    [[nodiscard]] size_t sets_performed() const noexcept;
 
    void reset_statistics() noexcept;
 
private:
    // =========================================================================
    // Private Implementation
    // =========================================================================
 
    [[nodiscard]] core::dicom_dataset build_create_dataset(
        const mpps_create_data& data) const;
 
    [[nodiscard]] core::dicom_dataset build_set_dataset(
        const mpps_set_data& data) const;
 
    [[nodiscard]] std::string generate_mpps_uid() const;
 
    [[nodiscard]] std::string get_current_date() const;
 
    [[nodiscard]] std::string get_current_time() const;
 
    [[nodiscard]] uint16_t next_message_id() noexcept;
 
    // =========================================================================
    // Private Members
    // =========================================================================
 
    std::shared_ptr<di::ILogger> logger_;
 
    mpps_scu_config config_;
 
    std::atomic<uint16_t> message_id_counter_{1};
 
    std::atomic<size_t> creates_performed_{0};
 
    std::atomic<size_t> sets_performed_{0};
};
 
// =============================================================================
// Additional MPPS Tags (for SCU use)
// =============================================================================
 
namespace mpps_tags {
 
inline constexpr core::dicom_tag performed_procedure_step_start_date{0x0040, 0x0244};
 
inline constexpr core::dicom_tag performed_procedure_step_start_time{0x0040, 0x0245};
 
inline constexpr core::dicom_tag performed_procedure_step_description{0x0040, 0x0254};
 
inline constexpr core::dicom_tag performed_protocol_code_sequence{0x0040, 0x0260};
 
inline constexpr core::dicom_tag retrieve_ae_title{0x0008, 0x0054};
 
inline constexpr core::dicom_tag referenced_image_sequence{0x0008, 0x1140};
 
inline constexpr core::dicom_tag performing_physicians_name{0x0008, 0x1050};
 
inline constexpr core::dicom_tag operators_name{0x0008, 0x1070};
 
inline constexpr core::dicom_tag series_description{0x0008, 0x103E};
 
inline constexpr core::dicom_tag discontinuation_reason_code_sequence{0x0040, 0x0281};
 
}  // namespace mpps_tags
 
}  // namespace kcenon::pacs::services
 
#endif  // PACS_SERVICES_MPPS_SCU_HPP