imaging_document_source.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_XDS_IMAGING_DOCUMENT_SOURCE_HPP
#define PACS_SERVICES_XDS_IMAGING_DOCUMENT_SOURCE_HPP
 
#include "kcenon/pacs/core/dicom_dataset.h"
 
#include <cstdint>
#include <optional>
#include <string>
#include <vector>
 
namespace kcenon::pacs::services::xds {
 
// =============================================================================
// XDS Document Metadata
// =============================================================================
 
struct xds_document_entry {
    std::string entry_uuid;
 
    std::string unique_id;
 
    std::string patient_id;
 
    std::string source_patient_id;
 
    std::string class_code;
    std::string class_code_scheme;
    std::string class_code_display;
 
    std::string type_code;
    std::string type_code_scheme;
    std::string type_code_display;
 
    std::string format_code;
    std::string format_code_scheme;
 
    std::string mime_type{"application/dicom"};
 
    std::string creation_time;
 
    std::string service_start_time;
    std::string service_stop_time;
 
    std::string facility_type_code;
    std::string facility_type_code_scheme;
 
    std::string practice_setting_code;
    std::string practice_setting_code_scheme;
 
    std::string author_person;
    std::string author_institution;
 
    std::string title;
 
    std::string language_code{"en-US"};
 
    std::string availability_status{"Approved"};
};
 
struct xds_submission_set {
    std::string unique_id;
 
    std::string source_id;
 
    std::string patient_id;
 
    std::string content_type_code;
    std::string content_type_code_scheme;
    std::string content_type_code_display;
 
    std::string submission_time;
 
    std::string author_person;
    std::string author_institution;
};
 
// =============================================================================
// KOS Document Reference
// =============================================================================
 
struct kos_instance_reference {
    std::string sop_class_uid;
 
    std::string sop_instance_uid;
 
    std::string series_instance_uid;
 
    std::string study_instance_uid;
};
 
struct kos_creation_result {
    bool success{false};
 
    std::optional<core::dicom_dataset> kos_dataset;
 
    std::string kos_instance_uid;
 
    std::string error_message;
 
    size_t reference_count{0};
};
 
// =============================================================================
// Publication Result
// =============================================================================
 
struct publication_result {
    bool success{false};
 
    std::string document_entry_uuid;
 
    std::string error_message;
 
    int http_status{0};
};
 
// =============================================================================
// Imaging Document Source Configuration
// =============================================================================
 
struct imaging_document_source_config {
    std::string registry_url;
 
    std::string source_oid;
 
    std::string assigning_authority_oid;
 
    std::string facility_type_code{"Radiology"};
    std::string facility_type_code_scheme{"2.16.840.1.113883.5.11"};
 
    std::string practice_setting_code{"Radiology"};
    std::string practice_setting_code_scheme{"2.16.840.1.113883.6.96"};
 
    uint32_t timeout_ms{30000};
 
    bool include_all_instances{true};
};
 
// =============================================================================
// Imaging Document Source
// =============================================================================
 
class imaging_document_source {
public:
    imaging_document_source() = default;
    explicit imaging_document_source(const imaging_document_source_config& config);
 
    [[nodiscard]] kos_creation_result create_kos_document(
        const std::string& study_instance_uid,
        const std::vector<kos_instance_reference>& references,
        const std::optional<core::dicom_dataset>& patient_demographics = std::nullopt) const;
 
    [[nodiscard]] xds_document_entry build_document_entry(
        const core::dicom_dataset& kos_dataset) const;
 
    [[nodiscard]] xds_submission_set build_submission_set(
        const std::string& patient_id) const;
 
    [[nodiscard]] publication_result publish_document(
        const core::dicom_dataset& kos_dataset,
        const xds_document_entry& entry) const;
 
    [[nodiscard]] const imaging_document_source_config& config() const noexcept;
 
    void set_config(const imaging_document_source_config& config);
 
private:
    imaging_document_source_config config_;
 
    [[nodiscard]] std::string generate_uid() const;
 
    void build_evidence_sequence(
        core::dicom_dataset& kos_dataset,
        const std::vector<kos_instance_reference>& references) const;
};
 
}  // namespace kcenon::pacs::services::xds
 
#endif  // PACS_SERVICES_XDS_IMAGING_DOCUMENT_SOURCE_HPP