fhirkit 0.1.0

FHIR R4 for Rust: typed models for every resource and datatype generated from the official specification, lossless JSON with path-precise validation, typed search queries, FHIRPath
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
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
// @generated by fhirkit-gen from hl7.fhir.r4.core 4.0.1. Do not edit.
//! The FHIR R4 `RequestGroup` resource.

#![allow(
    unused_imports,
    clippy::large_enum_variant,
    clippy::too_many_lines,
    clippy::doc_markdown
)]

use crate::decode::{
    choice_key, required, required_list, resource_type, Choice, Decoder, FhirJson, Obj, ObjWriter,
};
use crate::json::Json;
use crate::primitive::{Decimal, Kind, Primitive};
use crate::r4::*;

/// A group of related requests that can be used to capture intended activities that have inter-dependencies such as "give this medication after that one".
///
/// FHIR path: `RequestGroup`.
#[cfg(feature = "clinical")]
#[derive(Debug, Clone, PartialEq, Default)]
pub struct RequestGroup {
    /// `id` (0..1): Logical id of this artifact
    pub id: Option<String>,
    /// `meta` (0..1): Metadata about the resource
    pub meta: Option<Meta>,
    /// `implicitRules` (0..1): A set of rules under which this content was created
    pub implicit_rules: Option<Primitive<String>>,
    /// `language` (0..1): Language of the resource content
    pub language: Option<Primitive<String>>,
    /// `text` (0..1): Text summary of the resource, for human interpretation
    pub text: Option<Narrative>,
    /// `contained` (0..*): Contained, inline Resources
    pub contained: Vec<Resource>,
    /// `extension` (0..*): Additional content defined by implementations
    pub extension: Vec<Extension>,
    /// `modifierExtension` (0..*): Extensions that cannot be ignored
    pub modifier_extension: Vec<Extension>,
    /// `identifier` (0..*): Business identifier
    pub identifier: Vec<Identifier>,
    /// `instantiatesCanonical` (0..*): Instantiates FHIR protocol or definition
    pub instantiates_canonical: Vec<Primitive<String>>,
    /// `instantiatesUri` (0..*): Instantiates external protocol or definition
    pub instantiates_uri: Vec<Primitive<String>>,
    /// `basedOn` (0..*): Fulfills plan, proposal, or order
    pub based_on: Vec<Reference>,
    /// `replaces` (0..*): Request(s) replaced by this request
    pub replaces: Vec<Reference>,
    /// `groupIdentifier` (0..1): Composite request this is part of
    pub group_identifier: Option<Identifier>,
    /// `status` (1..1): draft | active | on-hold | revoked | completed | entered-in-error | unknown
    pub status: Option<Primitive<String>>,
    /// `intent` (1..1): proposal | plan | directive | order | original-order | reflex-order | filler-order | instance-order | option
    pub intent: Option<Primitive<String>>,
    /// `priority` (0..1): routine | urgent | asap | stat
    pub priority: Option<Primitive<String>>,
    /// `code` (0..1): What's being requested/ordered
    pub code: Option<CodeableConcept>,
    /// `subject` (0..1): Who the request group is about
    pub subject: Option<Reference>,
    /// `encounter` (0..1): Created as part of
    pub encounter: Option<Reference>,
    /// `authoredOn` (0..1): When the request group was authored
    pub authored_on: Option<Primitive<String>>,
    /// `author` (0..1): Device or practitioner that authored the request group
    pub author: Option<Reference>,
    /// `reasonCode` (0..*): Why the request group is needed
    pub reason_code: Vec<CodeableConcept>,
    /// `reasonReference` (0..*): Why the request group is needed
    pub reason_reference: Vec<Reference>,
    /// `note` (0..*): Additional notes about the response
    pub note: Vec<Annotation>,
    /// `action` (0..*): Proposed actions, if any
    pub action: Vec<RequestGroupAction>,
}

#[cfg(feature = "clinical")]
impl FhirJson for RequestGroup {
    const TYPE_NAME: &'static str = "RequestGroup";

    fn decode(v: &Json, d: &mut Decoder) -> Option<Self> {
        let mut o = Obj::new(v, d)?;
        resource_type(&mut o, d, "RequestGroup");
        let r = RequestGroup {
            id: o.string(d, "id"),
            meta: o.one(d, "meta"),
            implicit_rules: o.prim(d, "implicitRules", Kind::Uri),
            language: o.prim(d, "language", Kind::Code),
            text: o.one(d, "text"),
            contained: o.list(d, "contained"),
            extension: o.list(d, "extension"),
            modifier_extension: o.list(d, "modifierExtension"),
            identifier: o.list(d, "identifier"),
            instantiates_canonical: o.prim_list(d, "instantiatesCanonical", Kind::Canonical),
            instantiates_uri: o.prim_list(d, "instantiatesUri", Kind::Uri),
            based_on: o.list(d, "basedOn"),
            replaces: o.list(d, "replaces"),
            group_identifier: o.one(d, "groupIdentifier"),
            status: o.prim(d, "status", Kind::Code),
            intent: o.prim(d, "intent", Kind::Code),
            priority: o.prim(d, "priority", Kind::Code),
            code: o.one(d, "code"),
            subject: o.one(d, "subject"),
            encounter: o.one(d, "encounter"),
            authored_on: o.prim(d, "authoredOn", Kind::DateTime),
            author: o.one(d, "author"),
            reason_code: o.list(d, "reasonCode"),
            reason_reference: o.list(d, "reasonReference"),
            note: o.list(d, "note"),
            action: o.list(d, "action"),
        };
        required(d, "status", &r.status);
        required(d, "intent", &r.intent);
        o.finish(d);
        Some(r)
    }

    fn encode(&self) -> Json {
        let mut w = ObjWriter::new();
        w.raw("resourceType", Json::String("RequestGroup".into()));
        w.string("id", &self.id);
        w.one("meta", &self.meta);
        w.prim("implicitRules", &self.implicit_rules);
        w.prim("language", &self.language);
        w.one("text", &self.text);
        w.list("contained", &self.contained);
        w.list("extension", &self.extension);
        w.list("modifierExtension", &self.modifier_extension);
        w.list("identifier", &self.identifier);
        w.prim_list("instantiatesCanonical", &self.instantiates_canonical);
        w.prim_list("instantiatesUri", &self.instantiates_uri);
        w.list("basedOn", &self.based_on);
        w.list("replaces", &self.replaces);
        w.one("groupIdentifier", &self.group_identifier);
        w.prim("status", &self.status);
        w.prim("intent", &self.intent);
        w.prim("priority", &self.priority);
        w.one("code", &self.code);
        w.one("subject", &self.subject);
        w.one("encounter", &self.encounter);
        w.prim("authoredOn", &self.authored_on);
        w.one("author", &self.author);
        w.list("reasonCode", &self.reason_code);
        w.list("reasonReference", &self.reason_reference);
        w.list("note", &self.note);
        w.list("action", &self.action);
        w.finish()
    }
}

/// Proposed actions, if any
///
/// FHIR path: `RequestGroup.action`.
#[cfg(feature = "clinical")]
#[derive(Debug, Clone, PartialEq, Default)]
pub struct RequestGroupAction {
    /// `id` (0..1): Unique id for inter-element referencing
    pub id: Option<String>,
    /// `extension` (0..*): Additional content defined by implementations
    pub extension: Vec<Extension>,
    /// `modifierExtension` (0..*): Extensions that cannot be ignored even if unrecognized
    pub modifier_extension: Vec<Extension>,
    /// `prefix` (0..1): User-visible prefix for the action (e.g. 1. or A.)
    pub prefix: Option<Primitive<String>>,
    /// `title` (0..1): User-visible title
    pub title: Option<Primitive<String>>,
    /// `description` (0..1): Short description of the action
    pub description: Option<Primitive<String>>,
    /// `textEquivalent` (0..1): Static text equivalent of the action, used if the dynamic aspects cannot be interpreted by the receiving system
    pub text_equivalent: Option<Primitive<String>>,
    /// `priority` (0..1): routine | urgent | asap | stat
    pub priority: Option<Primitive<String>>,
    /// `code` (0..*): Code representing the meaning of the action or sub-actions
    pub code: Vec<CodeableConcept>,
    /// `documentation` (0..*): Supporting documentation for the intended performer of the action
    pub documentation: Vec<RelatedArtifact>,
    /// `condition` (0..*): Whether or not the action is applicable
    pub condition: Vec<RequestGroupActionCondition>,
    /// `relatedAction` (0..*): Relationship to another action
    pub related_action: Vec<RequestGroupActionRelatedAction>,
    /// `timing[x]` (0..1): When the action should take place
    pub timing: Option<RequestGroupActionTiming>,
    /// `participant` (0..*): Who should perform the action
    pub participant: Vec<Reference>,
    /// `type` (0..1): create | update | remove | fire-event
    pub type_: Option<CodeableConcept>,
    /// `groupingBehavior` (0..1): visual-group | logical-group | sentence-group
    pub grouping_behavior: Option<Primitive<String>>,
    /// `selectionBehavior` (0..1): any | all | all-or-none | exactly-one | at-most-one | one-or-more
    pub selection_behavior: Option<Primitive<String>>,
    /// `requiredBehavior` (0..1): must | could | must-unless-documented
    pub required_behavior: Option<Primitive<String>>,
    /// `precheckBehavior` (0..1): yes | no
    pub precheck_behavior: Option<Primitive<String>>,
    /// `cardinalityBehavior` (0..1): single | multiple
    pub cardinality_behavior: Option<Primitive<String>>,
    /// `resource` (0..1): The target of the action
    pub resource: Option<Reference>,
    /// `action` (0..*): Sub action
    pub action: Vec<RequestGroupAction>,
}

#[cfg(feature = "clinical")]
impl FhirJson for RequestGroupAction {
    const TYPE_NAME: &'static str = "RequestGroupAction";

    fn decode(v: &Json, d: &mut Decoder) -> Option<Self> {
        let mut o = Obj::new(v, d)?;
        let r = RequestGroupAction {
            id: o.string(d, "id"),
            extension: o.list(d, "extension"),
            modifier_extension: o.list(d, "modifierExtension"),
            prefix: o.prim(d, "prefix", Kind::String),
            title: o.prim(d, "title", Kind::String),
            description: o.prim(d, "description", Kind::String),
            text_equivalent: o.prim(d, "textEquivalent", Kind::String),
            priority: o.prim(d, "priority", Kind::Code),
            code: o.list(d, "code"),
            documentation: o.list(d, "documentation"),
            condition: o.list(d, "condition"),
            related_action: o.list(d, "relatedAction"),
            timing: o.choice(d, "timing"),
            participant: o.list(d, "participant"),
            type_: o.one(d, "type"),
            grouping_behavior: o.prim(d, "groupingBehavior", Kind::Code),
            selection_behavior: o.prim(d, "selectionBehavior", Kind::Code),
            required_behavior: o.prim(d, "requiredBehavior", Kind::Code),
            precheck_behavior: o.prim(d, "precheckBehavior", Kind::Code),
            cardinality_behavior: o.prim(d, "cardinalityBehavior", Kind::Code),
            resource: o.one(d, "resource"),
            action: o.list(d, "action"),
        };
        o.finish(d);
        Some(r)
    }

    fn encode(&self) -> Json {
        let mut w = ObjWriter::new();
        w.string("id", &self.id);
        w.list("extension", &self.extension);
        w.list("modifierExtension", &self.modifier_extension);
        w.prim("prefix", &self.prefix);
        w.prim("title", &self.title);
        w.prim("description", &self.description);
        w.prim("textEquivalent", &self.text_equivalent);
        w.prim("priority", &self.priority);
        w.list("code", &self.code);
        w.list("documentation", &self.documentation);
        w.list("condition", &self.condition);
        w.list("relatedAction", &self.related_action);
        w.choice("timing", &self.timing);
        w.list("participant", &self.participant);
        w.one("type", &self.type_);
        w.prim("groupingBehavior", &self.grouping_behavior);
        w.prim("selectionBehavior", &self.selection_behavior);
        w.prim("requiredBehavior", &self.required_behavior);
        w.prim("precheckBehavior", &self.precheck_behavior);
        w.prim("cardinalityBehavior", &self.cardinality_behavior);
        w.one("resource", &self.resource);
        w.list("action", &self.action);
        w.finish()
    }
}

/// Whether or not the action is applicable
///
/// FHIR path: `RequestGroup.action.condition`.
#[cfg(feature = "clinical")]
#[derive(Debug, Clone, PartialEq, Default)]
pub struct RequestGroupActionCondition {
    /// `id` (0..1): Unique id for inter-element referencing
    pub id: Option<String>,
    /// `extension` (0..*): Additional content defined by implementations
    pub extension: Vec<Extension>,
    /// `modifierExtension` (0..*): Extensions that cannot be ignored even if unrecognized
    pub modifier_extension: Vec<Extension>,
    /// `kind` (1..1): applicability | start | stop
    pub kind: Option<Primitive<String>>,
    /// `expression` (0..1): Boolean-valued expression
    pub expression: Option<Expression>,
}

#[cfg(feature = "clinical")]
impl FhirJson for RequestGroupActionCondition {
    const TYPE_NAME: &'static str = "RequestGroupActionCondition";

    fn decode(v: &Json, d: &mut Decoder) -> Option<Self> {
        let mut o = Obj::new(v, d)?;
        let r = RequestGroupActionCondition {
            id: o.string(d, "id"),
            extension: o.list(d, "extension"),
            modifier_extension: o.list(d, "modifierExtension"),
            kind: o.prim(d, "kind", Kind::Code),
            expression: o.one(d, "expression"),
        };
        required(d, "kind", &r.kind);
        o.finish(d);
        Some(r)
    }

    fn encode(&self) -> Json {
        let mut w = ObjWriter::new();
        w.string("id", &self.id);
        w.list("extension", &self.extension);
        w.list("modifierExtension", &self.modifier_extension);
        w.prim("kind", &self.kind);
        w.one("expression", &self.expression);
        w.finish()
    }
}

/// Relationship to another action
///
/// FHIR path: `RequestGroup.action.relatedAction`.
#[cfg(feature = "clinical")]
#[derive(Debug, Clone, PartialEq, Default)]
pub struct RequestGroupActionRelatedAction {
    /// `id` (0..1): Unique id for inter-element referencing
    pub id: Option<String>,
    /// `extension` (0..*): Additional content defined by implementations
    pub extension: Vec<Extension>,
    /// `modifierExtension` (0..*): Extensions that cannot be ignored even if unrecognized
    pub modifier_extension: Vec<Extension>,
    /// `actionId` (1..1): What action this is related to
    pub action_id: Option<Primitive<String>>,
    /// `relationship` (1..1): before-start | before | before-end | concurrent-with-start | concurrent | concurrent-with-end | after-start | after | after-end
    pub relationship: Option<Primitive<String>>,
    /// `offset[x]` (0..1): Time offset for the relationship
    pub offset: Option<RequestGroupActionRelatedActionOffset>,
}

#[cfg(feature = "clinical")]
impl FhirJson for RequestGroupActionRelatedAction {
    const TYPE_NAME: &'static str = "RequestGroupActionRelatedAction";

    fn decode(v: &Json, d: &mut Decoder) -> Option<Self> {
        let mut o = Obj::new(v, d)?;
        let r = RequestGroupActionRelatedAction {
            id: o.string(d, "id"),
            extension: o.list(d, "extension"),
            modifier_extension: o.list(d, "modifierExtension"),
            action_id: o.prim(d, "actionId", Kind::Id),
            relationship: o.prim(d, "relationship", Kind::Code),
            offset: o.choice(d, "offset"),
        };
        required(d, "actionId", &r.action_id);
        required(d, "relationship", &r.relationship);
        o.finish(d);
        Some(r)
    }

    fn encode(&self) -> Json {
        let mut w = ObjWriter::new();
        w.string("id", &self.id);
        w.list("extension", &self.extension);
        w.list("modifierExtension", &self.modifier_extension);
        w.prim("actionId", &self.action_id);
        w.prim("relationship", &self.relationship);
        w.choice("offset", &self.offset);
        w.finish()
    }
}

/// The types `RequestGroup.action.timing[x]` allows.
#[cfg(feature = "clinical")]
#[derive(Debug, Clone, PartialEq)]
pub enum RequestGroupActionTiming {
    /// `dateTime`
    DateTime(Primitive<String>),
    /// `Age`
    Age(Age),
    /// `Period`
    Period(Period),
    /// `Duration`
    Duration(Duration),
    /// `Range`
    Range(Range),
    /// `Timing`
    Timing(Timing),
}

#[cfg(feature = "clinical")]
impl Choice for RequestGroupActionTiming {
    const TYPES: &'static [&'static str] =
        &["dateTime", "Age", "Period", "Duration", "Range", "Timing"];

    fn decode_as(code: &str, key: &str, o: &mut Obj<'_>, d: &mut Decoder) -> Option<Self> {
        match code {
            "dateTime" => o.prim(d, key, Kind::DateTime).map(Self::DateTime),
            "Age" => o.one(d, key).map(Self::Age),
            "Period" => o.one(d, key).map(Self::Period),
            "Duration" => o.one(d, key).map(Self::Duration),
            "Range" => o.one(d, key).map(Self::Range),
            "Timing" => o.one(d, key).map(Self::Timing),
            _ => None,
        }
    }

    fn encode_into(&self, base: &str, w: &mut ObjWriter) {
        match self {
            Self::DateTime(v) => w.prim_value(&choice_key(base, "dateTime"), v),
            Self::Age(v) => w.value(&choice_key(base, "Age"), v),
            Self::Period(v) => w.value(&choice_key(base, "Period"), v),
            Self::Duration(v) => w.value(&choice_key(base, "Duration"), v),
            Self::Range(v) => w.value(&choice_key(base, "Range"), v),
            Self::Timing(v) => w.value(&choice_key(base, "Timing"), v),
        }
    }
}

/// The types `RequestGroup.action.relatedAction.offset[x]` allows.
#[cfg(feature = "clinical")]
#[derive(Debug, Clone, PartialEq)]
pub enum RequestGroupActionRelatedActionOffset {
    /// `Duration`
    Duration(Duration),
    /// `Range`
    Range(Range),
}

#[cfg(feature = "clinical")]
impl Choice for RequestGroupActionRelatedActionOffset {
    const TYPES: &'static [&'static str] = &["Duration", "Range"];

    fn decode_as(code: &str, key: &str, o: &mut Obj<'_>, d: &mut Decoder) -> Option<Self> {
        match code {
            "Duration" => o.one(d, key).map(Self::Duration),
            "Range" => o.one(d, key).map(Self::Range),
            _ => None,
        }
    }

    fn encode_into(&self, base: &str, w: &mut ObjWriter) {
        match self {
            Self::Duration(v) => w.value(&choice_key(base, "Duration"), v),
            Self::Range(v) => w.value(&choice_key(base, "Range"), v),
        }
    }
}