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
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
// @generated by fhirkit-gen from hl7.fhir.r4.core 4.0.1. Do not edit.
//! The FHIR R4 `Immunization` 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::*;

/// Describes the event of a patient being administered a vaccine or a record of an immunization as reported by a patient, a clinician or another party.
///
/// FHIR path: `Immunization`.
#[cfg(feature = "clinical")]
#[derive(Debug, Clone, PartialEq, Default)]
pub struct Immunization {
    /// `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>,
    /// `status` (1..1): completed | entered-in-error | not-done
    pub status: Option<Primitive<String>>,
    /// `statusReason` (0..1): Reason not done
    pub status_reason: Option<CodeableConcept>,
    /// `vaccineCode` (1..1): Vaccine product administered
    pub vaccine_code: Option<CodeableConcept>,
    /// `patient` (1..1): Who was immunized
    pub patient: Option<Reference>,
    /// `encounter` (0..1): Encounter immunization was part of
    pub encounter: Option<Reference>,
    /// `occurrence[x]` (1..1): Vaccine administration date
    pub occurrence: Option<ImmunizationOccurrence>,
    /// `recorded` (0..1): When the immunization was first captured in the subject's record
    pub recorded: Option<Primitive<String>>,
    /// `primarySource` (0..1): Indicates context the data was recorded in
    pub primary_source: Option<Primitive<bool>>,
    /// `reportOrigin` (0..1): Indicates the source of a secondarily reported record
    pub report_origin: Option<CodeableConcept>,
    /// `location` (0..1): Where immunization occurred
    pub location: Option<Reference>,
    /// `manufacturer` (0..1): Vaccine manufacturer
    pub manufacturer: Option<Reference>,
    /// `lotNumber` (0..1): Vaccine lot number
    pub lot_number: Option<Primitive<String>>,
    /// `expirationDate` (0..1): Vaccine expiration date
    pub expiration_date: Option<Primitive<String>>,
    /// `site` (0..1): Body site vaccine was administered
    pub site: Option<CodeableConcept>,
    /// `route` (0..1): How vaccine entered body
    pub route: Option<CodeableConcept>,
    /// `doseQuantity` (0..1): Amount of vaccine administered
    pub dose_quantity: Option<Quantity>,
    /// `performer` (0..*): Who performed event
    pub performer: Vec<ImmunizationPerformer>,
    /// `note` (0..*): Additional immunization notes
    pub note: Vec<Annotation>,
    /// `reasonCode` (0..*): Why immunization occurred
    pub reason_code: Vec<CodeableConcept>,
    /// `reasonReference` (0..*): Why immunization occurred
    pub reason_reference: Vec<Reference>,
    /// `isSubpotent` (0..1): Dose potency
    pub is_subpotent: Option<Primitive<bool>>,
    /// `subpotentReason` (0..*): Reason for being subpotent
    pub subpotent_reason: Vec<CodeableConcept>,
    /// `education` (0..*): Educational material presented to patient
    pub education: Vec<ImmunizationEducation>,
    /// `programEligibility` (0..*): Patient eligibility for a vaccination program
    pub program_eligibility: Vec<CodeableConcept>,
    /// `fundingSource` (0..1): Funding source for the vaccine
    pub funding_source: Option<CodeableConcept>,
    /// `reaction` (0..*): Details of a reaction that follows immunization
    pub reaction: Vec<ImmunizationReaction>,
    /// `protocolApplied` (0..*): Protocol followed by the provider
    pub protocol_applied: Vec<ImmunizationProtocolApplied>,
}

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

    fn decode(v: &Json, d: &mut Decoder) -> Option<Self> {
        let mut o = Obj::new(v, d)?;
        resource_type(&mut o, d, "Immunization");
        let r = Immunization {
            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"),
            status: o.prim(d, "status", Kind::Code),
            status_reason: o.one(d, "statusReason"),
            vaccine_code: o.one(d, "vaccineCode"),
            patient: o.one(d, "patient"),
            encounter: o.one(d, "encounter"),
            occurrence: o.choice(d, "occurrence"),
            recorded: o.prim(d, "recorded", Kind::DateTime),
            primary_source: o.prim(d, "primarySource", Kind::Boolean),
            report_origin: o.one(d, "reportOrigin"),
            location: o.one(d, "location"),
            manufacturer: o.one(d, "manufacturer"),
            lot_number: o.prim(d, "lotNumber", Kind::String),
            expiration_date: o.prim(d, "expirationDate", Kind::Date),
            site: o.one(d, "site"),
            route: o.one(d, "route"),
            dose_quantity: o.one(d, "doseQuantity"),
            performer: o.list(d, "performer"),
            note: o.list(d, "note"),
            reason_code: o.list(d, "reasonCode"),
            reason_reference: o.list(d, "reasonReference"),
            is_subpotent: o.prim(d, "isSubpotent", Kind::Boolean),
            subpotent_reason: o.list(d, "subpotentReason"),
            education: o.list(d, "education"),
            program_eligibility: o.list(d, "programEligibility"),
            funding_source: o.one(d, "fundingSource"),
            reaction: o.list(d, "reaction"),
            protocol_applied: o.list(d, "protocolApplied"),
        };
        required(d, "status", &r.status);
        required(d, "vaccineCode", &r.vaccine_code);
        required(d, "patient", &r.patient);
        required(d, "occurrence[x]", &r.occurrence);
        o.finish(d);
        Some(r)
    }

    fn encode(&self) -> Json {
        let mut w = ObjWriter::new();
        w.raw("resourceType", Json::String("Immunization".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("status", &self.status);
        w.one("statusReason", &self.status_reason);
        w.one("vaccineCode", &self.vaccine_code);
        w.one("patient", &self.patient);
        w.one("encounter", &self.encounter);
        w.choice("occurrence", &self.occurrence);
        w.prim("recorded", &self.recorded);
        w.prim("primarySource", &self.primary_source);
        w.one("reportOrigin", &self.report_origin);
        w.one("location", &self.location);
        w.one("manufacturer", &self.manufacturer);
        w.prim("lotNumber", &self.lot_number);
        w.prim("expirationDate", &self.expiration_date);
        w.one("site", &self.site);
        w.one("route", &self.route);
        w.one("doseQuantity", &self.dose_quantity);
        w.list("performer", &self.performer);
        w.list("note", &self.note);
        w.list("reasonCode", &self.reason_code);
        w.list("reasonReference", &self.reason_reference);
        w.prim("isSubpotent", &self.is_subpotent);
        w.list("subpotentReason", &self.subpotent_reason);
        w.list("education", &self.education);
        w.list("programEligibility", &self.program_eligibility);
        w.one("fundingSource", &self.funding_source);
        w.list("reaction", &self.reaction);
        w.list("protocolApplied", &self.protocol_applied);
        w.finish()
    }
}

/// Who performed event
///
/// FHIR path: `Immunization.performer`.
#[cfg(feature = "clinical")]
#[derive(Debug, Clone, PartialEq, Default)]
pub struct ImmunizationPerformer {
    /// `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>,
    /// `function` (0..1): What type of performance was done
    pub function: Option<CodeableConcept>,
    /// `actor` (1..1): Individual or organization who was performing
    pub actor: Option<Reference>,
}

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

    fn decode(v: &Json, d: &mut Decoder) -> Option<Self> {
        let mut o = Obj::new(v, d)?;
        let r = ImmunizationPerformer {
            id: o.string(d, "id"),
            extension: o.list(d, "extension"),
            modifier_extension: o.list(d, "modifierExtension"),
            function: o.one(d, "function"),
            actor: o.one(d, "actor"),
        };
        required(d, "actor", &r.actor);
        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.one("function", &self.function);
        w.one("actor", &self.actor);
        w.finish()
    }
}

/// Educational material presented to patient
///
/// FHIR path: `Immunization.education`.
#[cfg(feature = "clinical")]
#[derive(Debug, Clone, PartialEq, Default)]
pub struct ImmunizationEducation {
    /// `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>,
    /// `documentType` (0..1): Educational material document identifier
    pub document_type: Option<Primitive<String>>,
    /// `reference` (0..1): Educational material reference pointer
    pub reference: Option<Primitive<String>>,
    /// `publicationDate` (0..1): Educational material publication date
    pub publication_date: Option<Primitive<String>>,
    /// `presentationDate` (0..1): Educational material presentation date
    pub presentation_date: Option<Primitive<String>>,
}

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

    fn decode(v: &Json, d: &mut Decoder) -> Option<Self> {
        let mut o = Obj::new(v, d)?;
        let r = ImmunizationEducation {
            id: o.string(d, "id"),
            extension: o.list(d, "extension"),
            modifier_extension: o.list(d, "modifierExtension"),
            document_type: o.prim(d, "documentType", Kind::String),
            reference: o.prim(d, "reference", Kind::Uri),
            publication_date: o.prim(d, "publicationDate", Kind::DateTime),
            presentation_date: o.prim(d, "presentationDate", Kind::DateTime),
        };
        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("documentType", &self.document_type);
        w.prim("reference", &self.reference);
        w.prim("publicationDate", &self.publication_date);
        w.prim("presentationDate", &self.presentation_date);
        w.finish()
    }
}

/// Details of a reaction that follows immunization
///
/// FHIR path: `Immunization.reaction`.
#[cfg(feature = "clinical")]
#[derive(Debug, Clone, PartialEq, Default)]
pub struct ImmunizationReaction {
    /// `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>,
    /// `date` (0..1): When reaction started
    pub date: Option<Primitive<String>>,
    /// `detail` (0..1): Additional information on reaction
    pub detail: Option<Reference>,
    /// `reported` (0..1): Indicates self-reported reaction
    pub reported: Option<Primitive<bool>>,
}

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

    fn decode(v: &Json, d: &mut Decoder) -> Option<Self> {
        let mut o = Obj::new(v, d)?;
        let r = ImmunizationReaction {
            id: o.string(d, "id"),
            extension: o.list(d, "extension"),
            modifier_extension: o.list(d, "modifierExtension"),
            date: o.prim(d, "date", Kind::DateTime),
            detail: o.one(d, "detail"),
            reported: o.prim(d, "reported", Kind::Boolean),
        };
        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("date", &self.date);
        w.one("detail", &self.detail);
        w.prim("reported", &self.reported);
        w.finish()
    }
}

/// Protocol followed by the provider
///
/// FHIR path: `Immunization.protocolApplied`.
#[cfg(feature = "clinical")]
#[derive(Debug, Clone, PartialEq, Default)]
pub struct ImmunizationProtocolApplied {
    /// `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>,
    /// `series` (0..1): Name of vaccine series
    pub series: Option<Primitive<String>>,
    /// `authority` (0..1): Who is responsible for publishing the recommendations
    pub authority: Option<Reference>,
    /// `targetDisease` (0..*): Vaccine preventatable disease being targetted
    pub target_disease: Vec<CodeableConcept>,
    /// `doseNumber[x]` (1..1): Dose number within series
    pub dose_number: Option<ImmunizationProtocolAppliedDoseNumber>,
    /// `seriesDoses[x]` (0..1): Recommended number of doses for immunity
    pub series_doses: Option<ImmunizationProtocolAppliedSeriesDoses>,
}

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

    fn decode(v: &Json, d: &mut Decoder) -> Option<Self> {
        let mut o = Obj::new(v, d)?;
        let r = ImmunizationProtocolApplied {
            id: o.string(d, "id"),
            extension: o.list(d, "extension"),
            modifier_extension: o.list(d, "modifierExtension"),
            series: o.prim(d, "series", Kind::String),
            authority: o.one(d, "authority"),
            target_disease: o.list(d, "targetDisease"),
            dose_number: o.choice(d, "doseNumber"),
            series_doses: o.choice(d, "seriesDoses"),
        };
        required(d, "doseNumber[x]", &r.dose_number);
        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("series", &self.series);
        w.one("authority", &self.authority);
        w.list("targetDisease", &self.target_disease);
        w.choice("doseNumber", &self.dose_number);
        w.choice("seriesDoses", &self.series_doses);
        w.finish()
    }
}

/// The types `Immunization.occurrence[x]` allows.
#[cfg(feature = "clinical")]
#[derive(Debug, Clone, PartialEq)]
pub enum ImmunizationOccurrence {
    /// `dateTime`
    DateTime(Primitive<String>),
    /// `string`
    String(Primitive<String>),
}

#[cfg(feature = "clinical")]
impl Choice for ImmunizationOccurrence {
    const TYPES: &'static [&'static str] = &["dateTime", "string"];

    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),
            "string" => o.prim(d, key, Kind::String).map(Self::String),
            _ => None,
        }
    }

    fn encode_into(&self, base: &str, w: &mut ObjWriter) {
        match self {
            Self::DateTime(v) => w.prim_value(&choice_key(base, "dateTime"), v),
            Self::String(v) => w.prim_value(&choice_key(base, "string"), v),
        }
    }
}

/// The types `Immunization.protocolApplied.doseNumber[x]` allows.
#[cfg(feature = "clinical")]
#[derive(Debug, Clone, PartialEq)]
pub enum ImmunizationProtocolAppliedDoseNumber {
    /// `positiveInt`
    PositiveInt(Primitive<i32>),
    /// `string`
    String(Primitive<String>),
}

#[cfg(feature = "clinical")]
impl Choice for ImmunizationProtocolAppliedDoseNumber {
    const TYPES: &'static [&'static str] = &["positiveInt", "string"];

    fn decode_as(code: &str, key: &str, o: &mut Obj<'_>, d: &mut Decoder) -> Option<Self> {
        match code {
            "positiveInt" => o.prim(d, key, Kind::PositiveInt).map(Self::PositiveInt),
            "string" => o.prim(d, key, Kind::String).map(Self::String),
            _ => None,
        }
    }

    fn encode_into(&self, base: &str, w: &mut ObjWriter) {
        match self {
            Self::PositiveInt(v) => w.prim_value(&choice_key(base, "positiveInt"), v),
            Self::String(v) => w.prim_value(&choice_key(base, "string"), v),
        }
    }
}

/// The types `Immunization.protocolApplied.seriesDoses[x]` allows.
#[cfg(feature = "clinical")]
#[derive(Debug, Clone, PartialEq)]
pub enum ImmunizationProtocolAppliedSeriesDoses {
    /// `positiveInt`
    PositiveInt(Primitive<i32>),
    /// `string`
    String(Primitive<String>),
}

#[cfg(feature = "clinical")]
impl Choice for ImmunizationProtocolAppliedSeriesDoses {
    const TYPES: &'static [&'static str] = &["positiveInt", "string"];

    fn decode_as(code: &str, key: &str, o: &mut Obj<'_>, d: &mut Decoder) -> Option<Self> {
        match code {
            "positiveInt" => o.prim(d, key, Kind::PositiveInt).map(Self::PositiveInt),
            "string" => o.prim(d, key, Kind::String).map(Self::String),
            _ => None,
        }
    }

    fn encode_into(&self, base: &str, w: &mut ObjWriter) {
        match self {
            Self::PositiveInt(v) => w.prim_value(&choice_key(base, "positiveInt"), v),
            Self::String(v) => w.prim_value(&choice_key(base, "string"), v),
        }
    }
}