Struct SearchQuery 

pub struct SearchQuery {

    pub resource_type: String,
    pub parameters: Vec<SearchParameter>,
    pub reverse_chains: Vec<ReverseChainedParameter>,
    pub list: Vec<String>,
    pub contained: ContainedMode,
    pub contained_return: ContainedReturn,
    pub includes: Vec<IncludeDirective>,
    pub sort: Vec<SortDirective>,
    pub count: Option<u32>,
    pub offset: Option<u32>,
    pub cursor: Option<String>,
    pub total: Option<TotalMode>,
    pub summary: Option<SummaryMode>,
    pub elements: Vec<String>,
    pub compartment: Option<CompartmentMembership>,
    pub raw_params: HashMap<String, Vec<String>>,
}

A complete search query with all parameters.

Fields

resource_type: String

The resource type being searched.

parameters: Vec<SearchParameter>

Standard search parameters.

reverse_chains: Vec<ReverseChainedParameter>

Reverse chain parameters (_has).

list: Vec<String>

_list filters: logical ids of List resources whose entry.item references restrict the result set. Multiple values are AND-ed (a result must be a member of every listed List). Resolved application-side into an _id filter by crate::search::list_resolver, so any backend can execute the rewritten query.

contained: ContainedMode

_contained mode: whether the search matches against resources nested in other resources’ contained[] arrays.

contained_return: ContainedReturn

_containedType: when a contained resource matches, whether to return the container resource (default) or the contained resource itself.

includes: Vec<IncludeDirective>

Include directives.

sort: Vec<SortDirective>

Sort directives.

count: Option<u32>

Result count limit (_count).

offset: Option<u32>

Offset for pagination.

cursor: Option<String>

Cursor for keyset pagination.

total: Option<TotalMode>

Whether to include total count (_total).

summary: Option<SummaryMode>

Summary mode (_summary).

elements: Vec<String>

Elements to include (_elements).

compartment: Option<CompartmentMembership>

Compartment membership filter, when this is a compartment search (GET /{compartmentType}/{id}/{targetType}). Restricts results to resources that reference the compartment via any of the membership params (OR), per the FHIR CompartmentDefinition.

raw_params: HashMap<String, Vec<String>>

Raw query parameters for debugging.

Implementations

impl SearchQuery

pub fn new(resource_type: impl Into<String>) -> Self

Creates a new search query for the given resource type.

pub fn wants_total(&self) -> bool

Returns true if the client requested a total count via _total=accurate or _total=estimate.

_total=none or an unspecified _total returns false, so backends skip the extra count query (FHIR allows omitting Bundle.total).

pub fn with_parameter(self, param: SearchParameter) -> Self

Adds a search parameter.

pub fn with_include(self, include: IncludeDirective) -> Self

Adds an include directive.

pub fn with_sort(self, sort: SortDirective) -> Self

Adds a sort directive.

pub fn with_count(self, count: u32) -> Self

Sets the count limit.

pub fn with_cursor(self, cursor: String) -> Self

Sets the cursor for keyset pagination.

pub fn requires_advanced_features(&self) -> bool

Returns true if this query uses any features that require special backend support.

Trait Implementations

impl Clone for SearchQuery

fn clone(&self) -> SearchQuery

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for SearchQuery

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for SearchQuery

fn default() -> SearchQuery

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for SearchQuery

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for SearchQuery

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.