1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
//! SearchParameter
//!
//! URL: http://hl7.org/fhir/StructureDefinition/SearchParameter
//!
//! Version: 4.0.1
//!
//! Search parameter for a resource
//!
//! FHIR R4: <https://hl7.org/fhir/R4/>
// The `types` import is unused by a handful of types that have only primitive fields.
#![allow(unused_imports)]
use crate::r4::types;
use ::serde::{Deserialize, Serialize};
use fhir_derive_macros::{Builder, Validate};
/// A search parameter that defines a named search item that can be used to
/// search/filter on a resource.
///
/// # Examples
///
/// ```ignore
/// use fhir::r4::resources::search_parameter::SearchParameter;
///
/// let value = SearchParameter::default();
/// let json = ::serde_json::to_value(&value).unwrap();
/// let back: SearchParameter = ::serde_json::from_value(json).unwrap();
/// assert_eq!(value, back);
/// ```
#[serde_with::skip_serializing_none]
#[derive(Debug, Clone, Serialize, Deserialize, PartialEq, Eq, Validate, Builder)]
#[serde(rename_all = "camelCase")]
#[fhir_version("r4")]
pub struct SearchParameter {
/// Logical id of this artifact
pub id: Option<types::String>,
/// Metadata about the resource
pub meta: Option<types::Meta>,
/// A set of rules under which this content was created
pub implicit_rules: Option<types::Uri>,
/// Primitive extension sibling for [`implicit_rules`](Self::implicit_rules) (FHIR `_implicitRules`):
/// carries `id` and/or `extension` for the primitive value.
#[serde(rename = "_implicitRules")]
pub implicit_rules_ext: Option<types::Element>,
/// Language of the resource content
pub language: Option<types::Code>,
/// Primitive extension sibling for [`language`](Self::language) (FHIR `_language`):
/// carries `id` and/or `extension` for the primitive value.
#[serde(rename = "_language")]
pub language_ext: Option<types::Element>,
/// Text summary of the resource, for human interpretation
pub text: Option<types::Narrative>,
/// Contained, inline Resources
#[serde(default, skip_serializing_if = "Vec::is_empty")]
pub contained: Vec<::serde_json::Value>,
/// Additional content defined by implementations
#[serde(default, skip_serializing_if = "Vec::is_empty")]
pub extension: Vec<types::Extension>,
/// Extensions that cannot be ignored
#[serde(default, skip_serializing_if = "Vec::is_empty")]
pub modifier_extension: Vec<types::Extension>,
/// Canonical identifier for this search parameter, represented as a URI
/// (globally unique)
pub url: types::Uri,
/// Primitive extension sibling for [`url`](Self::url) (FHIR `_url`):
/// carries `id` and/or `extension` for the primitive value.
#[serde(rename = "_url")]
pub url_ext: Option<types::Element>,
/// Business version of the search parameter
pub version: Option<types::String>,
/// Primitive extension sibling for [`version`](Self::version) (FHIR `_version`):
/// carries `id` and/or `extension` for the primitive value.
#[serde(rename = "_version")]
pub version_ext: Option<types::Element>,
/// Name for this search parameter (computer friendly)
pub name: types::String,
/// Primitive extension sibling for [`name`](Self::name) (FHIR `_name`):
/// carries `id` and/or `extension` for the primitive value.
#[serde(rename = "_name")]
pub name_ext: Option<types::Element>,
/// Original definition for the search parameter
pub derived_from: Option<types::Canonical>,
/// Primitive extension sibling for [`derived_from`](Self::derived_from) (FHIR `_derivedFrom`):
/// carries `id` and/or `extension` for the primitive value.
#[serde(rename = "_derivedFrom")]
pub derived_from_ext: Option<types::Element>,
/// draft | active | retired | unknown
pub status: crate::coded::Coded<crate::r4::codes::PublicationStatus>,
/// Primitive extension sibling for [`status`](Self::status) (FHIR `_status`):
/// carries `id` and/or `extension` for the primitive value.
#[serde(rename = "_status")]
pub status_ext: Option<types::Element>,
/// For testing purposes, not real usage
pub experimental: Option<types::Boolean>,
/// Primitive extension sibling for [`experimental`](Self::experimental) (FHIR `_experimental`):
/// carries `id` and/or `extension` for the primitive value.
#[serde(rename = "_experimental")]
pub experimental_ext: Option<types::Element>,
/// Date last changed
pub date: Option<types::DateTime>,
/// Primitive extension sibling for [`date`](Self::date) (FHIR `_date`):
/// carries `id` and/or `extension` for the primitive value.
#[serde(rename = "_date")]
pub date_ext: Option<types::Element>,
/// Name of the publisher (organization or individual)
pub publisher: Option<types::String>,
/// Primitive extension sibling for [`publisher`](Self::publisher) (FHIR `_publisher`):
/// carries `id` and/or `extension` for the primitive value.
#[serde(rename = "_publisher")]
pub publisher_ext: Option<types::Element>,
/// Contact details for the publisher
#[serde(default, skip_serializing_if = "Vec::is_empty")]
pub contact: Vec<types::ContactDetail>,
/// Natural language description of the search parameter
pub description: types::Markdown,
/// Primitive extension sibling for [`description`](Self::description) (FHIR `_description`):
/// carries `id` and/or `extension` for the primitive value.
#[serde(rename = "_description")]
pub description_ext: Option<types::Element>,
/// The context that the content is intended to support
#[serde(default, skip_serializing_if = "Vec::is_empty")]
pub use_context: Vec<types::UsageContext>,
/// Intended jurisdiction for search parameter (if applicable)
#[serde(default, skip_serializing_if = "Vec::is_empty")]
pub jurisdiction: Vec<types::CodeableConcept>,
/// Why this search parameter is defined
pub purpose: Option<types::Markdown>,
/// Primitive extension sibling for [`purpose`](Self::purpose) (FHIR `_purpose`):
/// carries `id` and/or `extension` for the primitive value.
#[serde(rename = "_purpose")]
pub purpose_ext: Option<types::Element>,
/// Code used in URL
pub code: types::Code,
/// Primitive extension sibling for [`code`](Self::code) (FHIR `_code`):
/// carries `id` and/or `extension` for the primitive value.
#[serde(rename = "_code")]
pub code_ext: Option<types::Element>,
/// The resource type(s) this search parameter applies to
pub base: ::vec1::Vec1<crate::coded::Coded<crate::r4::codes::ResourceTypes>>,
/// Primitive extension sibling for [`base`](Self::base) (FHIR `_base`):
/// carries `id` and/or `extension` for the primitive value.
#[serde(rename = "_base")]
#[serde(default, skip_serializing_if = "Vec::is_empty")]
pub base_ext: Vec<Option<types::Element>>,
/// number | date | string | token | reference | composite | quantity | uri
/// | special
pub r#type: crate::coded::Coded<crate::r4::codes::SearchParamType>,
/// Primitive extension sibling for [`r#type`](Self::r#type) (FHIR `_type`):
/// carries `id` and/or `extension` for the primitive value.
#[serde(rename = "_type")]
pub type_ext: Option<types::Element>,
/// FHIRPath expression that extracts the values
pub expression: Option<types::String>,
/// Primitive extension sibling for [`expression`](Self::expression) (FHIR `_expression`):
/// carries `id` and/or `extension` for the primitive value.
#[serde(rename = "_expression")]
pub expression_ext: Option<types::Element>,
/// XPath that extracts the values
pub xpath: Option<types::String>,
/// Primitive extension sibling for [`xpath`](Self::xpath) (FHIR `_xpath`):
/// carries `id` and/or `extension` for the primitive value.
#[serde(rename = "_xpath")]
pub xpath_ext: Option<types::Element>,
/// normal | phonetic | nearby | distance | other
pub xpath_usage: Option<crate::coded::Coded<crate::r4::codes::SearchXpathUsage>>,
/// Primitive extension sibling for [`xpath_usage`](Self::xpath_usage) (FHIR `_xpathUsage`):
/// carries `id` and/or `extension` for the primitive value.
#[serde(rename = "_xpathUsage")]
pub xpath_usage_ext: Option<types::Element>,
/// Types of resource (if a resource reference)
#[serde(default, skip_serializing_if = "Vec::is_empty")]
pub target: Vec<crate::coded::Coded<crate::r4::codes::ResourceTypes>>,
/// Primitive extension sibling for [`target`](Self::target) (FHIR `_target`):
/// carries `id` and/or `extension` for the primitive value.
#[serde(rename = "_target")]
#[serde(default, skip_serializing_if = "Vec::is_empty")]
pub target_ext: Vec<Option<types::Element>>,
/// Allow multiple values per parameter (or)
pub multiple_or: Option<types::Boolean>,
/// Primitive extension sibling for [`multiple_or`](Self::multiple_or) (FHIR `_multipleOr`):
/// carries `id` and/or `extension` for the primitive value.
#[serde(rename = "_multipleOr")]
pub multiple_or_ext: Option<types::Element>,
/// Allow multiple parameters (and)
pub multiple_and: Option<types::Boolean>,
/// Primitive extension sibling for [`multiple_and`](Self::multiple_and) (FHIR `_multipleAnd`):
/// carries `id` and/or `extension` for the primitive value.
#[serde(rename = "_multipleAnd")]
pub multiple_and_ext: Option<types::Element>,
/// eq | ne | gt | lt | ge | le | sa | eb | ap
#[serde(default, skip_serializing_if = "Vec::is_empty")]
pub comparator: Vec<crate::coded::Coded<crate::r4::codes::SearchComparator>>,
/// Primitive extension sibling for [`comparator`](Self::comparator) (FHIR `_comparator`):
/// carries `id` and/or `extension` for the primitive value.
#[serde(rename = "_comparator")]
#[serde(default, skip_serializing_if = "Vec::is_empty")]
pub comparator_ext: Vec<Option<types::Element>>,
/// missing | exact | contains | not | text | in | not-in | below | above |
/// type | identifier | ofType
#[serde(default, skip_serializing_if = "Vec::is_empty")]
pub modifier: Vec<crate::coded::Coded<crate::r4::codes::SearchModifierCode>>,
/// Primitive extension sibling for [`modifier`](Self::modifier) (FHIR `_modifier`):
/// carries `id` and/or `extension` for the primitive value.
#[serde(rename = "_modifier")]
#[serde(default, skip_serializing_if = "Vec::is_empty")]
pub modifier_ext: Vec<Option<types::Element>>,
/// Chained names supported
#[serde(default, skip_serializing_if = "Vec::is_empty")]
pub chain: Vec<types::String>,
/// Primitive extension sibling for [`chain`](Self::chain) (FHIR `_chain`):
/// carries `id` and/or `extension` for the primitive value.
#[serde(rename = "_chain")]
#[serde(default, skip_serializing_if = "Vec::is_empty")]
pub chain_ext: Vec<Option<types::Element>>,
/// For Composite resources to define the parts
#[serde(default, skip_serializing_if = "Vec::is_empty")]
pub component: Vec<SearchParameterComponent>,
}
/// Used to define the parts of a composite search parameter.
///
/// # Examples
///
/// ```
/// use fhir::r4::resources::search_parameter::SearchParameterComponent;
///
/// let value = SearchParameterComponent::default();
/// let json = ::serde_json::to_value(&value).unwrap();
/// let back: SearchParameterComponent = ::serde_json::from_value(json).unwrap();
/// assert_eq!(value, back);
/// ```
#[serde_with::skip_serializing_none]
#[derive(Debug, Default, Clone, Serialize, Deserialize, PartialEq, Eq, Validate)]
#[serde(rename_all = "camelCase")]
#[fhir_version("r4")]
pub struct SearchParameterComponent {
/// Unique id for inter-element referencing
pub id: Option<types::String>,
/// Additional content defined by implementations
#[serde(default, skip_serializing_if = "Vec::is_empty")]
pub extension: Vec<types::Extension>,
/// Extensions that cannot be ignored even if unrecognized
#[serde(default, skip_serializing_if = "Vec::is_empty")]
pub modifier_extension: Vec<types::Extension>,
/// Defines how the part works
pub definition: types::Canonical,
/// Primitive extension sibling for [`definition`](Self::definition) (FHIR `_definition`):
/// carries `id` and/or `extension` for the primitive value.
#[serde(rename = "_definition")]
pub definition_ext: Option<types::Element>,
/// Subexpression relative to main expression
pub expression: types::String,
/// Primitive extension sibling for [`expression`](Self::expression) (FHIR `_expression`):
/// carries `id` and/or `extension` for the primitive value.
#[serde(rename = "_expression")]
pub expression_ext: Option<types::Element>,
}