query_builder.h

Go to the documentation of this file.

 
#ifndef QUERY_SCU_QUERY_BUILDER_HPP
#define QUERY_SCU_QUERY_BUILDER_HPP
 
#include "kcenon/pacs/core/dicom_dataset.h"
#include "kcenon/pacs/core/dicom_tag_constants.h"
#include "kcenon/pacs/encoding/vr_type.h"
#include "kcenon/pacs/services/query_scp.h"
 
#include <string>
#include <string_view>
 
namespace query_scu {
 
class query_builder {
public:
    using query_level = kcenon::pacs::services::query_level;
 
    query_builder() = default;
 
    query_builder& level(query_level lvl) {
        level_ = lvl;
        return *this;
    }
 
    // =========================================================================
    // Patient Level Attributes
    // =========================================================================
 
    query_builder& patient_name(std::string_view name) {
        patient_name_ = name;
        return *this;
    }
 
    query_builder& patient_id(std::string_view id) {
        patient_id_ = id;
        return *this;
    }
 
    query_builder& patient_birth_date(std::string_view date) {
        patient_birth_date_ = date;
        return *this;
    }
 
    query_builder& patient_sex(std::string_view sex) {
        patient_sex_ = sex;
        return *this;
    }
 
    // =========================================================================
    // Study Level Attributes
    // =========================================================================
 
    query_builder& study_date(std::string_view date) {
        study_date_ = date;
        return *this;
    }
 
    query_builder& study_time(std::string_view time) {
        study_time_ = time;
        return *this;
    }
 
    query_builder& accession_number(std::string_view accession) {
        accession_number_ = accession;
        return *this;
    }
 
    query_builder& study_instance_uid(std::string_view uid) {
        study_instance_uid_ = uid;
        return *this;
    }
 
    query_builder& study_id(std::string_view id) {
        study_id_ = id;
        return *this;
    }
 
    query_builder& study_description(std::string_view desc) {
        study_description_ = desc;
        return *this;
    }
 
    // =========================================================================
    // Series Level Attributes
    // =========================================================================
 
    query_builder& modality(std::string_view mod) {
        modality_ = mod;
        return *this;
    }
 
    query_builder& series_instance_uid(std::string_view uid) {
        series_instance_uid_ = uid;
        return *this;
    }
 
    query_builder& series_number(std::string_view num) {
        series_number_ = num;
        return *this;
    }
 
    query_builder& series_description(std::string_view desc) {
        series_description_ = desc;
        return *this;
    }
 
    // =========================================================================
    // Instance Level Attributes
    // =========================================================================
 
    query_builder& sop_instance_uid(std::string_view uid) {
        sop_instance_uid_ = uid;
        return *this;
    }
 
    query_builder& instance_number(std::string_view num) {
        instance_number_ = num;
        return *this;
    }
 
    // =========================================================================
    // Build
    // =========================================================================
 
    [[nodiscard]] kcenon::pacs::core::dicom_dataset build() const {
        using namespace kcenon::pacs::core;
        using namespace kcenon::pacs::encoding;
 
        dicom_dataset ds;
 
        // Set Query/Retrieve Level (required)
        ds.set_string(tags::query_retrieve_level, vr_type::CS,
                      std::string(kcenon::pacs::services::to_string(level_)));
 
        // Add return keys and search criteria based on level
        switch (level_) {
            case query_level::patient:
                add_patient_keys(ds);
                break;
            case query_level::study:
                add_patient_keys(ds);
                add_study_keys(ds);
                break;
            case query_level::series:
                add_patient_keys(ds);
                add_study_keys(ds);
                add_series_keys(ds);
                break;
            case query_level::image:
                add_patient_keys(ds);
                add_study_keys(ds);
                add_series_keys(ds);
                add_instance_keys(ds);
                break;
        }
 
        return ds;
    }
 
private:
    void add_patient_keys(kcenon::pacs::core::dicom_dataset& ds) const {
        using namespace kcenon::pacs::core;
        using namespace kcenon::pacs::encoding;
 
        // Patient Name - always include as return key
        ds.set_string(tags::patient_name, vr_type::PN, patient_name_);
 
        // Patient ID
        ds.set_string(tags::patient_id, vr_type::LO, patient_id_);
 
        // Patient Birth Date
        if (!patient_birth_date_.empty()) {
            ds.set_string(tags::patient_birth_date, vr_type::DA, patient_birth_date_);
        } else {
            ds.set_string(tags::patient_birth_date, vr_type::DA, "");
        }
 
        // Patient Sex
        if (!patient_sex_.empty()) {
            ds.set_string(tags::patient_sex, vr_type::CS, patient_sex_);
        } else {
            ds.set_string(tags::patient_sex, vr_type::CS, "");
        }
    }
 
    void add_study_keys(kcenon::pacs::core::dicom_dataset& ds) const {
        using namespace kcenon::pacs::core;
        using namespace kcenon::pacs::encoding;
 
        // Study Instance UID - required for Study level
        ds.set_string(tags::study_instance_uid, vr_type::UI, study_instance_uid_);
 
        // Study Date
        ds.set_string(tags::study_date, vr_type::DA, study_date_);
 
        // Study Time
        if (!study_time_.empty()) {
            ds.set_string(tags::study_time, vr_type::TM, study_time_);
        } else {
            ds.set_string(tags::study_time, vr_type::TM, "");
        }
 
        // Accession Number
        ds.set_string(tags::accession_number, vr_type::SH, accession_number_);
 
        // Study ID
        if (!study_id_.empty()) {
            ds.set_string(tags::study_id, vr_type::SH, study_id_);
        } else {
            ds.set_string(tags::study_id, vr_type::SH, "");
        }
 
        // Study Description
        ds.set_string(tags::study_description, vr_type::LO, study_description_);
 
        // Referring Physician's Name (return key)
        ds.set_string(tags::referring_physician_name, vr_type::PN, "");
 
        // Number of Study Related Series (return key)
        ds.set_string(tags::number_of_study_related_series, vr_type::IS, "");
 
        // Number of Study Related Instances (return key)
        ds.set_string(tags::number_of_study_related_instances, vr_type::IS, "");
 
        // Modalities in Study (return key)
        ds.set_string(tags::modalities_in_study, vr_type::CS, modality_);
    }
 
    void add_series_keys(kcenon::pacs::core::dicom_dataset& ds) const {
        using namespace kcenon::pacs::core;
        using namespace kcenon::pacs::encoding;
 
        // Series Instance UID - required for Series level
        ds.set_string(tags::series_instance_uid, vr_type::UI, series_instance_uid_);
 
        // Modality
        ds.set_string(tags::modality, vr_type::CS, modality_);
 
        // Series Number
        if (!series_number_.empty()) {
            ds.set_string(tags::series_number, vr_type::IS, series_number_);
        } else {
            ds.set_string(tags::series_number, vr_type::IS, "");
        }
 
        // Series Description
        ds.set_string(tags::series_description, vr_type::LO, series_description_);
 
        // Number of Series Related Instances (return key)
        ds.set_string(tags::number_of_series_related_instances, vr_type::IS, "");
    }
 
    void add_instance_keys(kcenon::pacs::core::dicom_dataset& ds) const {
        using namespace kcenon::pacs::core;
        using namespace kcenon::pacs::encoding;
 
        // SOP Instance UID - required for Instance level
        ds.set_string(tags::sop_instance_uid, vr_type::UI, sop_instance_uid_);
 
        // SOP Class UID (return key)
        ds.set_string(tags::sop_class_uid, vr_type::UI, "");
 
        // Instance Number
        if (!instance_number_.empty()) {
            ds.set_string(tags::instance_number, vr_type::IS, instance_number_);
        } else {
            ds.set_string(tags::instance_number, vr_type::IS, "");
        }
    }
 
    // Query level
    query_level level_{query_level::study};
 
    // Patient level
    std::string patient_name_;
    std::string patient_id_;
    std::string patient_birth_date_;
    std::string patient_sex_;
 
    // Study level
    std::string study_date_;
    std::string study_time_;
    std::string accession_number_;
    std::string study_instance_uid_;
    std::string study_id_;
    std::string study_description_;
 
    // Series level
    std::string modality_;
    std::string series_instance_uid_;
    std::string series_number_;
    std::string series_description_;
 
    // Instance level
    std::string sop_instance_uid_;
    std::string instance_number_;
};
 
}  // namespace query_scu
 
#endif  // QUERY_SCU_QUERY_BUILDER_HPP