PACS System 0.1.0
PACS DICOM system library
Loading...
Searching...
No Matches
kcenon::pacs::storage::study_query Struct Reference

#include <study_record.h>

Collaboration diagram for kcenon::pacs::storage::study_query:
Collaboration graph

Public Member Functions

auto has_criteria () const noexcept -> bool
 Check if any filter criteria is set.
 

Public Attributes

std::optional< std::string > patient_id
 Patient ID for filtering by patient (exact match or wildcard)
 
std::optional< std::string > patient_name
 Patient name pattern (supports * wildcard)
 
std::optional< std::string > study_uid
 Study Instance UID (exact match)
 
std::optional< std::string > study_id
 Study ID pattern (supports * wildcard)
 
std::optional< std::string > study_date
 Study date (exact match, format: YYYYMMDD)
 
std::optional< std::string > study_date_from
 Study date range start (inclusive)
 
std::optional< std::string > study_date_to
 Study date range end (inclusive)
 
std::optional< std::string > accession_number
 Accession number pattern (supports * wildcard)
 
std::optional< std::string > modality
 Modality filter (exact match, e.g., "CT", "MR")
 
std::optional< std::string > referring_physician
 Referring physician pattern (supports * wildcard)
 
std::optional< std::string > study_description
 Study description pattern (supports * wildcard)
 
size_t limit {0}
 Maximum number of results to return (0 = unlimited)
 
size_t offset {0}
 Offset for pagination.
 

Detailed Description

Examples
db_browser/main.cpp, and qr_scp/main.cpp.

Definition at line 101 of file study_record.h.

Member Function Documentation

◆ has_criteria()

auto kcenon::pacs::storage::study_query::has_criteria ( ) const -> bool
inlinenodiscardnoexcept

Check if any filter criteria is set.

Returns
true if at least one filter field is set
Examples
/home/runner/work/pacs_system/pacs_system/include/kcenon/pacs/storage/study_record.h.

Definition at line 146 of file study_record.h.

146 {
147 return patient_id.has_value() || patient_name.has_value() ||
148 study_uid.has_value() || study_id.has_value() ||
149 study_date.has_value() || study_date_from.has_value() ||
150 study_date_to.has_value() || accession_number.has_value() ||
151 modality.has_value() || referring_physician.has_value() ||
152 study_description.has_value();
153 }
std::optional< std::string > study_uid
Study Instance UID (exact match)
std::optional< std::string > accession_number
Accession number pattern (supports * wildcard)
std::optional< std::string > modality
Modality filter (exact match, e.g., "CT", "MR")
std::optional< std::string > study_date_to
Study date range end (inclusive)
std::optional< std::string > study_date
Study date (exact match, format: YYYYMMDD)
std::optional< std::string > patient_name
Patient name pattern (supports * wildcard)
std::optional< std::string > referring_physician
Referring physician pattern (supports * wildcard)
std::optional< std::string > study_id
Study ID pattern (supports * wildcard)
std::optional< std::string > study_date_from
Study date range start (inclusive)
std::optional< std::string > study_description
Study description pattern (supports * wildcard)
std::optional< std::string > patient_id
Patient ID for filtering by patient (exact match or wildcard)

References accession_number, modality, patient_id, patient_name, referring_physician, study_date, study_date_from, study_date_to, study_description, study_id, and study_uid.

Member Data Documentation

◆ accession_number

std::optional<std::string> kcenon::pacs::storage::study_query::accession_number

Accession number pattern (supports * wildcard)

Examples
/home/runner/work/pacs_system/pacs_system/include/kcenon/pacs/storage/study_record.h, and qr_scp/main.cpp.

Definition at line 124 of file study_record.h.

Referenced by has_criteria().

◆ limit

size_t kcenon::pacs::storage::study_query::limit {0}

Maximum number of results to return (0 = unlimited)

Examples
/home/runner/work/pacs_system/pacs_system/include/kcenon/pacs/storage/study_record.h.

Definition at line 136 of file study_record.h.

136{0};

Referenced by kcenon::pacs::web::endpoints::register_study_endpoints_impl().

◆ modality

std::optional<std::string> kcenon::pacs::storage::study_query::modality

Modality filter (exact match, e.g., "CT", "MR")

Examples
/home/runner/work/pacs_system/pacs_system/include/kcenon/pacs/storage/study_record.h.

Definition at line 127 of file study_record.h.

Referenced by has_criteria().

◆ offset

size_t kcenon::pacs::storage::study_query::offset {0}

◆ patient_id

std::optional<std::string> kcenon::pacs::storage::study_query::patient_id

Patient ID for filtering by patient (exact match or wildcard)

Examples
/home/runner/work/pacs_system/pacs_system/include/kcenon/pacs/storage/study_record.h, and qr_scp/main.cpp.

Definition at line 103 of file study_record.h.

Referenced by has_criteria().

◆ patient_name

std::optional<std::string> kcenon::pacs::storage::study_query::patient_name

Patient name pattern (supports * wildcard)

Examples
/home/runner/work/pacs_system/pacs_system/include/kcenon/pacs/storage/study_record.h, and qr_scp/main.cpp.

Definition at line 106 of file study_record.h.

Referenced by has_criteria().

◆ referring_physician

std::optional<std::string> kcenon::pacs::storage::study_query::referring_physician

Referring physician pattern (supports * wildcard)

Examples
/home/runner/work/pacs_system/pacs_system/include/kcenon/pacs/storage/study_record.h.

Definition at line 130 of file study_record.h.

Referenced by has_criteria().

◆ study_date

std::optional<std::string> kcenon::pacs::storage::study_query::study_date

Study date (exact match, format: YYYYMMDD)

Examples
/home/runner/work/pacs_system/pacs_system/include/kcenon/pacs/storage/study_record.h, and qr_scp/main.cpp.

Definition at line 115 of file study_record.h.

Referenced by has_criteria().

◆ study_date_from

std::optional<std::string> kcenon::pacs::storage::study_query::study_date_from

Study date range start (inclusive)

Examples
/home/runner/work/pacs_system/pacs_system/include/kcenon/pacs/storage/study_record.h.

Definition at line 118 of file study_record.h.

Referenced by has_criteria().

◆ study_date_to

std::optional<std::string> kcenon::pacs::storage::study_query::study_date_to

Study date range end (inclusive)

Examples
/home/runner/work/pacs_system/pacs_system/include/kcenon/pacs/storage/study_record.h.

Definition at line 121 of file study_record.h.

Referenced by has_criteria().

◆ study_description

std::optional<std::string> kcenon::pacs::storage::study_query::study_description

Study description pattern (supports * wildcard)

Examples
/home/runner/work/pacs_system/pacs_system/include/kcenon/pacs/storage/study_record.h, and qr_scp/main.cpp.

Definition at line 133 of file study_record.h.

Referenced by has_criteria().

◆ study_id

std::optional<std::string> kcenon::pacs::storage::study_query::study_id

Study ID pattern (supports * wildcard)

Examples
/home/runner/work/pacs_system/pacs_system/include/kcenon/pacs/storage/study_record.h.

Definition at line 112 of file study_record.h.

Referenced by has_criteria().

◆ study_uid

std::optional<std::string> kcenon::pacs::storage::study_query::study_uid

Study Instance UID (exact match)

Examples
/home/runner/work/pacs_system/pacs_system/include/kcenon/pacs/storage/study_record.h, and qr_scp/main.cpp.

Definition at line 109 of file study_record.h.

Referenced by has_criteria().


The documentation for this struct was generated from the following file: