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

#include <worklist_record.h>

Collaboration diagram for kcenon::pacs::storage::worklist_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 > station_ae
 Scheduled Station AE Title filter (exact match)
 
std::optional< std::string > modality
 Modality filter (exact match)
 
std::optional< std::string > scheduled_date_from
 Scheduled date range begin (inclusive, format: YYYYMMDD)
 
std::optional< std::string > scheduled_date_to
 Scheduled date range end (inclusive, format: YYYYMMDD)
 
std::optional< std::string > patient_id
 Patient ID filter (supports wildcards with '*')
 
std::optional< std::string > patient_name
 Patient Name filter (supports wildcards with '*')
 
std::optional< std::string > accession_no
 Accession Number filter (exact match)
 
std::optional< std::string > step_id
 Step ID filter (exact match)
 
bool include_all_status {false}
 Include non-SCHEDULED items (default: false, only SCHEDULED)
 
size_t limit {0}
 Maximum number of results to return (0 = unlimited)
 
size_t offset {0}
 Offset for pagination.
 

Detailed Description

Definition at line 214 of file worklist_record.h.

Member Function Documentation

◆ has_criteria()

auto kcenon::pacs::storage::worklist_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/worklist_record.h.

Definition at line 253 of file worklist_record.h.

253 {
254 return station_ae.has_value() || modality.has_value() ||
255 scheduled_date_from.has_value() || scheduled_date_to.has_value() ||
256 patient_id.has_value() || patient_name.has_value() ||
257 accession_no.has_value() || step_id.has_value();
258 }
std::optional< std::string > step_id
Step ID filter (exact match)
std::optional< std::string > modality
Modality filter (exact match)
std::optional< std::string > patient_name
Patient Name filter (supports wildcards with '*')
std::optional< std::string > scheduled_date_from
Scheduled date range begin (inclusive, format: YYYYMMDD)
std::optional< std::string > patient_id
Patient ID filter (supports wildcards with '*')
std::optional< std::string > scheduled_date_to
Scheduled date range end (inclusive, format: YYYYMMDD)
std::optional< std::string > accession_no
Accession Number filter (exact match)
std::optional< std::string > station_ae
Scheduled Station AE Title filter (exact match)

References accession_no, modality, patient_id, patient_name, scheduled_date_from, scheduled_date_to, station_ae, and step_id.

Member Data Documentation

◆ accession_no

std::optional<std::string> kcenon::pacs::storage::worklist_query::accession_no

Accession Number filter (exact match)

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

Definition at line 234 of file worklist_record.h.

Referenced by has_criteria().

◆ include_all_status

bool kcenon::pacs::storage::worklist_query::include_all_status {false}

Include non-SCHEDULED items (default: false, only SCHEDULED)

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

Definition at line 240 of file worklist_record.h.

240{false};

◆ limit

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

Maximum number of results to return (0 = unlimited)

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

Definition at line 243 of file worklist_record.h.

243{0};

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

◆ modality

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

Modality filter (exact match)

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

Definition at line 219 of file worklist_record.h.

Referenced by has_criteria().

◆ offset

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

◆ patient_id

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

Patient ID filter (supports wildcards with '*')

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

Definition at line 228 of file worklist_record.h.

Referenced by has_criteria().

◆ patient_name

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

Patient Name filter (supports wildcards with '*')

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

Definition at line 231 of file worklist_record.h.

Referenced by has_criteria().

◆ scheduled_date_from

std::optional<std::string> kcenon::pacs::storage::worklist_query::scheduled_date_from

Scheduled date range begin (inclusive, format: YYYYMMDD)

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

Definition at line 222 of file worklist_record.h.

Referenced by has_criteria().

◆ scheduled_date_to

std::optional<std::string> kcenon::pacs::storage::worklist_query::scheduled_date_to

Scheduled date range end (inclusive, format: YYYYMMDD)

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

Definition at line 225 of file worklist_record.h.

Referenced by has_criteria().

◆ station_ae

std::optional<std::string> kcenon::pacs::storage::worklist_query::station_ae

Scheduled Station AE Title filter (exact match)

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

Definition at line 216 of file worklist_record.h.

Referenced by has_criteria().

◆ step_id

std::optional<std::string> kcenon::pacs::storage::worklist_query::step_id

Step ID filter (exact match)

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

Definition at line 237 of file worklist_record.h.

Referenced by has_criteria().


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