Struct CapabilityStatementRestResourceSearchParam

pub struct CapabilityStatementRestResourceSearchParam {
    pub id: Option<String>,
    pub extension: Vec<Extension>,
    pub modifier_extension: Vec<Extension>,
    pub name: String,
    pub name_ext: Option<FieldExtension>,
    pub definition: Option<String>,
    pub definition_ext: Option<FieldExtension>,
    pub type: SearchParamType,
    pub type_ext: Option<FieldExtension>,
    pub documentation: Option<String>,
    pub documentation_ext: Option<FieldExtension>,
}

Sub-fields of the searchParam field in CapabilityStatementRestResource

Fields

id: Option<String>

Unique id for inter-element referencing

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

extension: Vec<Extension>

Additional content defined by implementations

May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

modifier_extension: Vec<Extension>

Extensions that cannot be ignored even if unrecognized

May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element’s descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

name: String

Name for parameter in search url

The label used for the search parameter in this particular system’s API - i.e. the ‘name’ portion of the name-value pair that will appear as part of the search URL. This SHOULD be the same as the SearchParameter.code of the defining SearchParameter. However, it can sometimes differ if necessary to disambiguate when a server supports multiple SearchParameters that happen to share the same code.

Parameter names cannot overlap with standard parameter names, and standard parameters cannot be redefined. There is no correspondence whatsoever between CapabilityStatement’s searchParam.name and SearchParameter.name - the latter is used as a class name when generating code for the search parameter.

name_ext: Option<FieldExtension>

Extension field.

definition: Option<String>

Source of definition for parameter

An absolute URI that is a formal reference to where this parameter was first defined, so that a client can be confident of the meaning of the search parameter (a reference to SearchParameter.url). This element SHALL be populated if the search parameter refers to a SearchParameter defined by the FHIR core specification or externally defined IGs.

This SHOULD be present, and matches refers to a SearchParameter by its canonical URL. If systems wish to document their support for modifiers, comparators, target resource types, and chained parameters, they should do using a search parameter resource. This element SHALL be populated if the search parameter refers to a SearchParameter defined by the FHIR core specification or externally defined IGs.

definition_ext: Option<FieldExtension>

Extension field.

type: SearchParamType

SearchParamType; number | date | string | token | reference | composite | quantity | uri | special

The type of value a search parameter refers to, and how the content is interpreted.

While this can be looked up from the definition, it is included here as a convenience for systems that autogenerate a query interface based on the server capability statement. It SHALL be the same as the type in the search parameter definition.

type_ext: Option<FieldExtension>

Extension field.

documentation: Option<String>

Server-specific usage

This allows documentation of any distinct behaviors about how the search parameter is used. For example, text matching algorithms.

documentation_ext: Option<FieldExtension>

Extension field.

Implementations

impl CapabilityStatementRestResourceSearchParam

pub fn builder() -> CapabilityStatementRestResourceSearchParamBuilder

Start building a new instance

Trait Implementations

impl Clone for CapabilityStatementRestResourceSearchParam

fn clone(&self) -> CapabilityStatementRestResourceSearchParam

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for CapabilityStatementRestResourceSearchParam

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for CapabilityStatementRestResourceSearchParam

fn deserialize<__D>( __deserializer: __D, ) -> Result<CapabilityStatementRestResourceSearchParam, <__D as Deserializer<'de>>::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for CapabilityStatementRestResourceSearchParam

fn eq(&self, other: &CapabilityStatementRestResourceSearchParam) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for CapabilityStatementRestResourceSearchParam

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for CapabilityStatementRestResourceSearchParam