sr_storage.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_SOP_CLASSES_SR_STORAGE_HPP
#define PACS_SERVICES_SOP_CLASSES_SR_STORAGE_HPP
 
#include <array>
#include <cstdint>
#include <string>
#include <string_view>
#include <vector>
 
namespace kcenon::pacs::services::sop_classes {
 
// =============================================================================
// Structured Report Storage SOP Class UIDs
// =============================================================================
 
 
inline constexpr std::string_view basic_text_sr_storage_uid =
    "1.2.840.10008.5.1.4.1.1.88.11";
 
inline constexpr std::string_view enhanced_sr_storage_uid =
    "1.2.840.10008.5.1.4.1.1.88.22";
 
inline constexpr std::string_view comprehensive_sr_storage_uid =
    "1.2.840.10008.5.1.4.1.1.88.33";
 
inline constexpr std::string_view comprehensive_3d_sr_storage_uid =
    "1.2.840.10008.5.1.4.1.1.88.34";
 
inline constexpr std::string_view extensible_sr_storage_uid =
    "1.2.840.10008.5.1.4.1.1.88.35";
 
 
 
inline constexpr std::string_view mammography_cad_sr_storage_uid =
    "1.2.840.10008.5.1.4.1.1.88.50";
 
inline constexpr std::string_view chest_cad_sr_storage_uid =
    "1.2.840.10008.5.1.4.1.1.88.65";
 
inline constexpr std::string_view colon_cad_sr_storage_uid =
    "1.2.840.10008.5.1.4.1.1.88.69";
 
inline constexpr std::string_view xray_radiation_dose_sr_storage_uid =
    "1.2.840.10008.5.1.4.1.1.88.67";
 
inline constexpr std::string_view radiopharmaceutical_radiation_dose_sr_storage_uid =
    "1.2.840.10008.5.1.4.1.1.88.68";
 
inline constexpr std::string_view acquisition_context_sr_storage_uid =
    "1.2.840.10008.5.1.4.1.1.88.71";
 
inline constexpr std::string_view simplified_adult_echo_sr_storage_uid =
    "1.2.840.10008.5.1.4.1.1.88.72";
 
inline constexpr std::string_view patient_radiation_dose_sr_storage_uid =
    "1.2.840.10008.5.1.4.1.1.88.73";
 
inline constexpr std::string_view planned_imaging_agent_admin_sr_storage_uid =
    "1.2.840.10008.5.1.4.1.1.88.74";
 
inline constexpr std::string_view performed_imaging_agent_admin_sr_storage_uid =
    "1.2.840.10008.5.1.4.1.1.88.75";
 
inline constexpr std::string_view enhanced_xray_radiation_dose_sr_storage_uid =
    "1.2.840.10008.5.1.4.1.1.88.76";
 
 
 
inline constexpr std::string_view key_object_selection_document_storage_uid =
    "1.2.840.10008.5.1.4.1.1.88.59";
 
 
// =============================================================================
// SR-Specific Transfer Syntaxes
// =============================================================================
 
[[nodiscard]] std::vector<std::string> get_sr_transfer_syntaxes();
 
// =============================================================================
// SR Document Type
// =============================================================================
 
enum class sr_document_type {
    basic_text,             
    enhanced,               
    comprehensive,          
    comprehensive_3d,       
    extensible,             
    key_object_selection,   
    cad,                    
    dose_report,            
    procedure_log,          
    other                   
};
 
[[nodiscard]] sr_document_type get_sr_document_type(std::string_view uid) noexcept;
 
[[nodiscard]] std::string_view to_string(sr_document_type type) noexcept;
 
// =============================================================================
// SR Value Types
// =============================================================================
 
enum class sr_value_type {
    text,           
    code,           
    num,            
    datetime,       
    date,           
    time,           
    uidref,         
    pname,          
    composite,      
    image,          
    waveform,       
    scoord,         
    scoord3d,       
    tcoord,         
    container,      
    table,          
    unknown         
};
 
[[nodiscard]] std::string_view to_string(sr_value_type type) noexcept;
 
[[nodiscard]] sr_value_type parse_sr_value_type(std::string_view value) noexcept;
 
[[nodiscard]] bool is_valid_sr_value_type(std::string_view value) noexcept;
 
// =============================================================================
// SR Relationship Types
// =============================================================================
 
enum class sr_relationship_type {
    contains,           
    has_obs_context,    
    has_acq_context,    
    has_concept_mod,    
    has_properties,     
    inferred_from,      
    selected_from,      
    unknown             
};
 
[[nodiscard]] std::string_view to_string(sr_relationship_type type) noexcept;
 
[[nodiscard]] sr_relationship_type parse_sr_relationship_type(std::string_view value) noexcept;
 
// =============================================================================
// SR Completion and Verification
// =============================================================================
 
enum class sr_completion_flag {
    partial,    
    complete    
};
 
[[nodiscard]] std::string_view to_string(sr_completion_flag flag) noexcept;
 
[[nodiscard]] sr_completion_flag parse_sr_completion_flag(std::string_view value) noexcept;
 
enum class sr_verification_flag {
    unverified,     
    verified        
};
 
[[nodiscard]] std::string_view to_string(sr_verification_flag flag) noexcept;
 
[[nodiscard]] sr_verification_flag parse_sr_verification_flag(std::string_view value) noexcept;
 
// =============================================================================
// SR SOP Class Information
// =============================================================================
 
struct sr_sop_class_info {
    std::string_view uid;               
    std::string_view name;              
    std::string_view description;       
    sr_document_type document_type;     
    bool is_retired;                    
    bool supports_spatial_coords;       
    bool supports_waveform_ref;         
};
 
[[nodiscard]] std::vector<std::string>
get_sr_storage_sop_classes(bool include_cad = true, bool include_dose = true);
 
[[nodiscard]] const sr_sop_class_info*
get_sr_sop_class_info(std::string_view uid) noexcept;
 
[[nodiscard]] bool is_sr_storage_sop_class(std::string_view uid) noexcept;
 
[[nodiscard]] bool is_cad_sr_storage_sop_class(std::string_view uid) noexcept;
 
[[nodiscard]] bool is_dose_sr_storage_sop_class(std::string_view uid) noexcept;
 
[[nodiscard]] bool sr_supports_spatial_coords(std::string_view uid) noexcept;
 
// =============================================================================
// SR Template Identification
// =============================================================================
 
namespace sr_template {
 
inline constexpr std::string_view basic_diagnostic_imaging_report = "2000";
 
inline constexpr std::string_view mammography_cad_report = "4000";
 
inline constexpr std::string_view chest_cad_report = "4100";
 
inline constexpr std::string_view colon_cad_report = "4200";
 
inline constexpr std::string_view xray_radiation_dose_report = "10001";
 
inline constexpr std::string_view ct_radiation_dose_report = "10011";
 
inline constexpr std::string_view projection_xray_dose_report = "10020";
 
inline constexpr std::string_view key_object_selection = "2010";
 
inline constexpr std::string_view measurement_report = "1500";
 
}  // namespace sr_template
 
[[nodiscard]] std::string_view get_recommended_sr_template(std::string_view uid) noexcept;
 
}  // namespace kcenon::pacs::services::sop_classes
 
#endif  // PACS_SERVICES_SOP_CLASSES_SR_STORAGE_HPP