fhir-types 0.1.115

Generated per-version FHIR types and terminology operation contracts
Documentation
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
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
// @generated by fhir-codegen from hl7.fhir.r6.core 6.0.0-ballot5. DO NOT EDIT.
// Change the emitter (tools/fhir-codegen) and regenerate.
// SPDX-FileCopyrightText: Cadasto B.V.
// SPDX-License-Identifier: Apache-2.0
//! Describes the context of use for a conformance or knowledge resource

/// Describes the context of use for a conformance or knowledge resource
///
/// Specifies clinical/business/etc. metadata that can be used to retrieve,
/// index and/or categorize an artifact. This metadata can either be specific to
/// the applicable population (e.g., age category, DRG) or the specific context
/// of care (e.g., venue, care setting, provider of care).
#[derive(Debug, Clone, PartialEq, Eq)]
pub struct UsageContext {
    /// 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.
    pub id: Option<std::string::String>,
    /// 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.
    pub extension: Vec<super::extension::Extension>,
    /// Type of context being specified
    ///
    /// A code that identifies the type of context being specified by this usage
    /// context.
    pub code: super::coding::Coding,
    /// Value(s) that define the context
    ///
    /// A value or set of possible values that defines the context specified in this
    /// context of use. The interpretation of the value is defined by the code. If a
    /// 'range' is specified, then the context means that the artifact applies for
    /// any value of the context that falls within range. If a 'valueset' is
    /// specified, then the context means that the artifact applies if a code
    /// matches the value set.
    pub value: UsageContextValue,
}

impl super::super::codec::Json for UsageContext {
    fn to_json(&self) -> Result<super::super::codec::Object, super::super::codec::EncodeError> {
        let mut object = super::super::codec::Object::new();
        if let Some(v) = &self.id {
            object.insert(
                std::string::String::from("id"),
                super::super::codec::Value::String(v.clone()),
            );
        }
        if !self.extension.is_empty() {
            let mut items = Vec::with_capacity(self.extension.len());
            for item in &self.extension {
                items.push(super::super::codec::Value::Object(
                    super::super::codec::Json::to_json(item)?,
                ));
            }
            object.insert(
                std::string::String::from("extension"),
                super::super::codec::Value::Array(items),
            );
        }
        object.insert(
            std::string::String::from("code"),
            super::super::codec::Value::Object(super::super::codec::Json::to_json(&self.code)?),
        );
        let (suffix, value, element) = self.value.to_json_parts()?;
        if let Some(value) = value {
            object.insert(format!("value{suffix}"), value);
        }
        if let Some(element) = element {
            object.insert(format!("_value{suffix}"), element);
        }
        Ok(object)
    }

    fn from_json(
        object: &super::super::codec::Object,
        path: &mut super::super::codec::Path,
    ) -> Result<Self, super::super::codec::DecodeError> {
        let mut raw_id: Option<&super::super::codec::Value> = None;
        let mut raw_extension: Option<&super::super::codec::Value> = None;
        let mut raw_code: Option<&super::super::codec::Value> = None;
        let mut raw_value = super::super::codec::ChoiceSlot::default();
        for (key, value) in object {
            match key.as_str() {
                "id" => {
                    raw_id = Some(value);
                }
                "extension" => {
                    raw_extension = Some(value);
                }
                "code" => {
                    raw_code = Some(value);
                }
                "valueCodeableConcept" => {
                    raw_value.value("CodeableConcept", value, path)?;
                }
                "_valueCodeableConcept" => {
                    raw_value.element("CodeableConcept", value, path)?;
                }
                "valueQuantity" => {
                    raw_value.value("Quantity", value, path)?;
                }
                "_valueQuantity" => {
                    raw_value.element("Quantity", value, path)?;
                }
                "valueRange" => {
                    raw_value.value("Range", value, path)?;
                }
                "_valueRange" => {
                    raw_value.element("Range", value, path)?;
                }
                "valueReference" => {
                    raw_value.value("Reference", value, path)?;
                }
                "_valueReference" => {
                    raw_value.element("Reference", value, path)?;
                }
                "valueCanonical" => {
                    raw_value.value("Canonical", value, path)?;
                }
                "_valueCanonical" => {
                    raw_value.element("Canonical", value, path)?;
                }
                other => {
                    return path.with(other, |path| {
                        Err(path.error(super::super::codec::DecodeErrorKind::UnknownProperty))
                    });
                }
            }
        }
        let field_id = raw_id
            .map(|value| {
                path.with("id", |path| {
                    let value = super::super::codec::expect_single(value, path)?;
                    super::primitives::checked_string(
                        super::super::codec::expect_string(value, path)?,
                        path,
                    )
                })
            })
            .transpose()?;
        let mut field_extension = Vec::new();
        if let Some(raw) = raw_extension {
            for (index, value) in super::super::codec::expect_array(raw, path)?
                .iter()
                .enumerate()
            {
                field_extension.push(path.with_index("extension", index, |path| {
                    super::super::codec::Json::from_json(
                        super::super::codec::expect_object(value, path)?,
                        path,
                    )
                })?);
            }
        }
        let field_code = path.with("code", |path| {
            let value = raw_code
                .ok_or_else(|| path.error(super::super::codec::DecodeErrorKind::MissingProperty))?;
            super::super::codec::Json::from_json(
                super::super::codec::expect_object(
                    super::super::codec::expect_single(value, path)?,
                    path,
                )?,
                path,
            )
        })?;
        let field_value = path.with("value", |path| {
            let suffix = raw_value
                .suffix
                .ok_or_else(|| path.error(super::super::codec::DecodeErrorKind::MissingProperty))?;
            UsageContextValue::from_json_parts(suffix, raw_value.value, raw_value.element, path)
        })?;
        Ok(Self {
            id: field_id,
            extension: field_extension,
            code: field_code,
            value: field_value,
        })
    }
}

impl serde::Serialize for UsageContext {
    fn serialize<S: serde::Serializer>(&self, serializer: S) -> Result<S::Ok, S::Error> {
        let mut map = serde::Serializer::serialize_map(serializer, None)?;
        if let UsageContextValue::Canonical(inner) = &self.value {
            super::super::codec::element_entry(&mut map, "_valueCanonical", inner)?;
        }
        serde::ser::SerializeMap::serialize_entry(&mut map, "code", &self.code)?;
        if !self.extension.is_empty() {
            serde::ser::SerializeMap::serialize_entry(&mut map, "extension", &self.extension)?;
        }
        if let Some(v) = &self.id {
            serde::ser::SerializeMap::serialize_entry(&mut map, "id", v)?;
        }
        match &self.value {
            UsageContextValue::Canonical(inner) => {
                super::super::codec::value_entry(&mut map, "valueCanonical", inner)?;
            }
            UsageContextValue::CodeableConcept(inner) => {
                serde::ser::SerializeMap::serialize_entry(
                    &mut map,
                    "valueCodeableConcept",
                    inner.as_ref(),
                )?;
            }
            UsageContextValue::Quantity(inner) => {
                serde::ser::SerializeMap::serialize_entry(
                    &mut map,
                    "valueQuantity",
                    inner.as_ref(),
                )?;
            }
            UsageContextValue::Range(inner) => {
                serde::ser::SerializeMap::serialize_entry(&mut map, "valueRange", inner.as_ref())?;
            }
            UsageContextValue::Reference(inner) => {
                serde::ser::SerializeMap::serialize_entry(
                    &mut map,
                    "valueReference",
                    inner.as_ref(),
                )?;
            }
        }
        serde::ser::SerializeMap::end(map)
    }
}

impl<'de> serde::Deserialize<'de> for UsageContext {
    fn deserialize<D: serde::Deserializer<'de>>(deserializer: D) -> Result<Self, D::Error> {
        let value = <super::super::codec::Value as serde::Deserialize>::deserialize(deserializer)?;
        let mut path = super::super::codec::Path::root("UsageContext");
        let object =
            super::super::codec::expect_object(&value, &path).map_err(serde::de::Error::custom)?;
        super::super::codec::Json::from_json(object, &mut path).map_err(serde::de::Error::custom)
    }
}

/// The \`value\[x\]\` choice of \`UsageContext\`.
///
/// A value or set of possible values that defines the context specified in this
/// context of use. The interpretation of the value is defined by the code. If a
/// 'range' is specified, then the context means that the artifact applies for
/// any value of the context that falls within range. If a 'valueset' is
/// specified, then the context means that the artifact applies if a code
/// matches the value set.
#[derive(Debug, Clone, PartialEq, Eq)]
pub enum UsageContextValue {
    /// The `CodeableConcept` form.
    CodeableConcept(Box<super::codeable_concept::CodeableConcept>),
    /// The `Quantity` form.
    Quantity(Box<super::quantity::Quantity>),
    /// The `Range` form.
    Range(Box<super::range::Range>),
    /// The `Reference` form.
    Reference(Box<super::reference::Reference>),
    /// The `canonical` form.
    Canonical(super::primitives::Canonical),
}

impl UsageContextValue {
    /// The key suffix, the value part, and the `_name` part of this form.
    ///
    /// # Errors
    ///
    /// Returns [`super::super::codec::EncodeError`] when a held value has no JSON form.
    pub fn to_json_parts(
        &self,
    ) -> Result<
        (
            &'static str,
            Option<super::super::codec::Value>,
            Option<super::super::codec::Value>,
        ),
        super::super::codec::EncodeError,
    > {
        match self {
            Self::CodeableConcept(inner) => Ok((
                "CodeableConcept",
                Some(super::super::codec::Value::Object(
                    super::super::codec::Json::to_json(inner.as_ref())?,
                )),
                None,
            )),
            Self::Quantity(inner) => Ok((
                "Quantity",
                Some(super::super::codec::Value::Object(
                    super::super::codec::Json::to_json(inner.as_ref())?,
                )),
                None,
            )),
            Self::Range(inner) => Ok((
                "Range",
                Some(super::super::codec::Value::Object(
                    super::super::codec::Json::to_json(inner.as_ref())?,
                )),
                None,
            )),
            Self::Reference(inner) => Ok((
                "Reference",
                Some(super::super::codec::Value::Object(
                    super::super::codec::Json::to_json(inner.as_ref())?,
                )),
                None,
            )),
            Self::Canonical(inner) => Ok((
                "Canonical",
                super::super::codec::Primitive::value_json(inner)?,
                super::super::codec::Primitive::element_json(inner)?,
            )),
        }
    }

    /// Decodes the form named by `suffix` from its value and `_name` parts.
    ///
    /// # Errors
    ///
    /// Returns [`super::super::codec::DecodeError`] for an unknown suffix or a malformed part.
    pub fn from_json_parts(
        suffix: &str,
        value: Option<&super::super::codec::Value>,
        element: Option<&super::super::codec::Value>,
        path: &mut super::super::codec::Path,
    ) -> Result<Self, super::super::codec::DecodeError> {
        match suffix {
            "CodeableConcept" => {
                if element.is_some() {
                    return Err(path.error(super::super::codec::DecodeErrorKind::WrongType {
                        expected: "no underscore form for a complex type",
                    }));
                }
                let value = value.ok_or_else(|| {
                    path.error(super::super::codec::DecodeErrorKind::MissingProperty)
                })?;
                let inner = super::super::codec::Json::from_json(
                    super::super::codec::expect_object(
                        super::super::codec::expect_single(value, path)?,
                        path,
                    )?,
                    path,
                )?;
                Ok(Self::CodeableConcept(Box::new(inner)))
            }
            "Quantity" => {
                if element.is_some() {
                    return Err(path.error(super::super::codec::DecodeErrorKind::WrongType {
                        expected: "no underscore form for a complex type",
                    }));
                }
                let value = value.ok_or_else(|| {
                    path.error(super::super::codec::DecodeErrorKind::MissingProperty)
                })?;
                let inner = super::super::codec::Json::from_json(
                    super::super::codec::expect_object(
                        super::super::codec::expect_single(value, path)?,
                        path,
                    )?,
                    path,
                )?;
                Ok(Self::Quantity(Box::new(inner)))
            }
            "Range" => {
                if element.is_some() {
                    return Err(path.error(super::super::codec::DecodeErrorKind::WrongType {
                        expected: "no underscore form for a complex type",
                    }));
                }
                let value = value.ok_or_else(|| {
                    path.error(super::super::codec::DecodeErrorKind::MissingProperty)
                })?;
                let inner = super::super::codec::Json::from_json(
                    super::super::codec::expect_object(
                        super::super::codec::expect_single(value, path)?,
                        path,
                    )?,
                    path,
                )?;
                Ok(Self::Range(Box::new(inner)))
            }
            "Reference" => {
                if element.is_some() {
                    return Err(path.error(super::super::codec::DecodeErrorKind::WrongType {
                        expected: "no underscore form for a complex type",
                    }));
                }
                let value = value.ok_or_else(|| {
                    path.error(super::super::codec::DecodeErrorKind::MissingProperty)
                })?;
                let inner = super::super::codec::Json::from_json(
                    super::super::codec::expect_object(
                        super::super::codec::expect_single(value, path)?,
                        path,
                    )?,
                    path,
                )?;
                Ok(Self::Reference(Box::new(inner)))
            }
            "Canonical" => Ok(Self::Canonical(
                super::super::codec::Primitive::from_json_parts(value, element, path)?,
            )),
            _ => Err(path.error(super::super::codec::DecodeErrorKind::UnknownProperty)),
        }
    }
}