sr_iod_validator.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_VALIDATION_SR_IOD_VALIDATOR_HPP
#define PACS_SERVICES_VALIDATION_SR_IOD_VALIDATOR_HPP
 
#include "kcenon/pacs/core/dicom_dataset.h"
#include "kcenon/pacs/core/dicom_tag.h"
#include "kcenon/pacs/services/validation/us_iod_validator.h"  // For validation_result types
 
#include <optional>
#include <string>
#include <vector>
 
namespace kcenon::pacs::services::validation {
 
// =============================================================================
// SR Validation Options
// =============================================================================
 
struct sr_validation_options {
    bool check_type1 = true;
 
    bool check_type2 = true;
 
    bool check_conditional = true;
 
    bool validate_content_sequence = true;
 
    bool validate_value_types = true;
 
    bool validate_relationships = true;
 
    bool validate_references = true;
 
    bool validate_coded_entries = true;
 
    bool validate_template_id = true;
 
    bool validate_document_status = true;
 
    bool validate_key_object_selection = true;
 
    bool strict_mode = false;
};
 
// =============================================================================
// SR IOD Validator
// =============================================================================
 
class sr_iod_validator {
public:
    sr_iod_validator() = default;
 
    explicit sr_iod_validator(const sr_validation_options& options);
 
    [[nodiscard]] validation_result validate(const core::dicom_dataset& dataset) const;
 
    [[nodiscard]] validation_result
    validate_basic_text_sr(const core::dicom_dataset& dataset) const;
 
    [[nodiscard]] validation_result
    validate_enhanced_sr(const core::dicom_dataset& dataset) const;
 
    [[nodiscard]] validation_result
    validate_comprehensive_sr(const core::dicom_dataset& dataset) const;
 
    [[nodiscard]] validation_result
    validate_key_object_selection(const core::dicom_dataset& dataset) const;
 
    [[nodiscard]] validation_result
    validate_content_tree(const core::dicom_dataset& dataset) const;
 
    [[nodiscard]] validation_result
    validate_references(const core::dicom_dataset& dataset) const;
 
    [[nodiscard]] bool quick_check(const core::dicom_dataset& dataset) const;
 
    [[nodiscard]] const sr_validation_options& options() const noexcept;
 
    void set_options(const sr_validation_options& options);
 
private:
    // Module validation methods
    void validate_patient_module(
        const core::dicom_dataset& dataset,
        std::vector<validation_finding>& findings) const;
 
    void validate_general_study_module(
        const core::dicom_dataset& dataset,
        std::vector<validation_finding>& findings) const;
 
    void validate_sr_document_series_module(
        const core::dicom_dataset& dataset,
        std::vector<validation_finding>& findings) const;
 
    void validate_general_equipment_module(
        const core::dicom_dataset& dataset,
        std::vector<validation_finding>& findings) const;
 
    void validate_sr_document_general_module(
        const core::dicom_dataset& dataset,
        std::vector<validation_finding>& findings) const;
 
    void validate_sr_document_content_module(
        const core::dicom_dataset& dataset,
        std::vector<validation_finding>& findings) const;
 
    void validate_sop_common_module(
        const core::dicom_dataset& dataset,
        std::vector<validation_finding>& findings) const;
 
    void validate_evidence_sequences(
        const core::dicom_dataset& dataset,
        std::vector<validation_finding>& findings) const;
 
    // Content tree validation
    void validate_content_sequence(
        const core::dicom_dataset& dataset,
        std::vector<validation_finding>& findings) const;
 
    void validate_content_item(
        const core::dicom_dataset& item,
        size_t depth,
        std::string_view parent_value_type,
        std::vector<validation_finding>& findings) const;
 
    void validate_coded_entry(
        const core::dicom_dataset& coded_entry,
        std::string_view context,
        std::vector<validation_finding>& findings) const;
 
    // Value type specific validation
    void validate_text_content_item(
        const core::dicom_dataset& item,
        std::vector<validation_finding>& findings) const;
 
    void validate_code_content_item(
        const core::dicom_dataset& item,
        std::vector<validation_finding>& findings) const;
 
    void validate_num_content_item(
        const core::dicom_dataset& item,
        std::vector<validation_finding>& findings) const;
 
    void validate_image_content_item(
        const core::dicom_dataset& item,
        std::vector<validation_finding>& findings) const;
 
    void validate_scoord_content_item(
        const core::dicom_dataset& item,
        std::vector<validation_finding>& findings) const;
 
    void validate_scoord3d_content_item(
        const core::dicom_dataset& item,
        std::vector<validation_finding>& findings) const;
 
    // Attribute validation helpers
    void check_type1_attribute(
        const core::dicom_dataset& dataset,
        core::dicom_tag tag,
        std::string_view name,
        std::vector<validation_finding>& findings) const;
 
    void check_type2_attribute(
        const core::dicom_dataset& dataset,
        core::dicom_tag tag,
        std::string_view name,
        std::vector<validation_finding>& findings) const;
 
    void check_modality(
        const core::dicom_dataset& dataset,
        std::vector<validation_finding>& findings) const;
 
    void check_completion_flag(
        const core::dicom_dataset& dataset,
        std::vector<validation_finding>& findings) const;
 
    void check_verification_flag(
        const core::dicom_dataset& dataset,
        std::vector<validation_finding>& findings) const;
 
    sr_validation_options options_;
};
 
// =============================================================================
// Convenience Functions
// =============================================================================
 
[[nodiscard]] validation_result validate_sr_iod(const core::dicom_dataset& dataset);
 
[[nodiscard]] bool is_valid_sr_dataset(const core::dicom_dataset& dataset);
 
[[nodiscard]] bool is_sr_complete(const core::dicom_dataset& dataset);
 
[[nodiscard]] bool is_sr_verified(const core::dicom_dataset& dataset);
 
[[nodiscard]] size_t get_content_item_count(const core::dicom_dataset& dataset);
 
[[nodiscard]] std::string get_sr_document_title(const core::dicom_dataset& dataset);
 
}  // namespace kcenon::pacs::services::validation
 
#endif  // PACS_SERVICES_VALIDATION_SR_IOD_VALIDATOR_HPP