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
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
// @generated by fhirkit-gen from hl7.fhir.r4.core 4.0.1. Do not edit.
//! The FHIR R4 `CodeSystem` 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::*;

/// The CodeSystem resource is used to declare the existence of and describe a code system or code system supplement and its key properties, and optionally define a part or all of its content.
///
/// FHIR path: `CodeSystem`.
#[cfg(feature = "foundation")]
#[derive(Debug, Clone, PartialEq, Default)]
pub struct CodeSystem {
    /// `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>,
    /// `url` (0..1): Canonical identifier for this code system, represented as a URI (globally unique) (Coding.system)
    pub url: Option<Primitive<String>>,
    /// `identifier` (0..*): Additional identifier for the code system (business identifier)
    pub identifier: Vec<Identifier>,
    /// `version` (0..1): Business version of the code system (Coding.version)
    pub version: Option<Primitive<String>>,
    /// `name` (0..1): Name for this code system (computer friendly)
    pub name: Option<Primitive<String>>,
    /// `title` (0..1): Name for this code system (human friendly)
    pub title: Option<Primitive<String>>,
    /// `status` (1..1): draft | active | retired | unknown
    pub status: Option<Primitive<String>>,
    /// `experimental` (0..1): For testing purposes, not real usage
    pub experimental: Option<Primitive<bool>>,
    /// `date` (0..1): Date last changed
    pub date: Option<Primitive<String>>,
    /// `publisher` (0..1): Name of the publisher (organization or individual)
    pub publisher: Option<Primitive<String>>,
    /// `contact` (0..*): Contact details for the publisher
    pub contact: Vec<ContactDetail>,
    /// `description` (0..1): Natural language description of the code system
    pub description: Option<Primitive<String>>,
    /// `useContext` (0..*): The context that the content is intended to support
    pub use_context: Vec<UsageContext>,
    /// `jurisdiction` (0..*): Intended jurisdiction for code system (if applicable)
    pub jurisdiction: Vec<CodeableConcept>,
    /// `purpose` (0..1): Why this code system is defined
    pub purpose: Option<Primitive<String>>,
    /// `copyright` (0..1): Use and/or publishing restrictions
    pub copyright: Option<Primitive<String>>,
    /// `caseSensitive` (0..1): If code comparison is case sensitive
    pub case_sensitive: Option<Primitive<bool>>,
    /// `valueSet` (0..1): Canonical reference to the value set with entire code system
    pub value_set: Option<Primitive<String>>,
    /// `hierarchyMeaning` (0..1): grouped-by | is-a | part-of | classified-with
    pub hierarchy_meaning: Option<Primitive<String>>,
    /// `compositional` (0..1): If code system defines a compositional grammar
    pub compositional: Option<Primitive<bool>>,
    /// `versionNeeded` (0..1): If definitions are not stable
    pub version_needed: Option<Primitive<bool>>,
    /// `content` (1..1): not-present | example | fragment | complete | supplement
    pub content: Option<Primitive<String>>,
    /// `supplements` (0..1): Canonical URL of Code System this adds designations and properties to
    pub supplements: Option<Primitive<String>>,
    /// `count` (0..1): Total concepts in the code system
    pub count: Option<Primitive<i32>>,
    /// `filter` (0..*): Filter that can be used in a value set
    pub filter: Vec<CodeSystemFilter>,
    /// `property` (0..*): Additional information supplied about each concept
    pub property: Vec<CodeSystemProperty>,
    /// `concept` (0..*): Concepts in the code system
    pub concept: Vec<CodeSystemConcept>,
}

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

    fn decode(v: &Json, d: &mut Decoder) -> Option<Self> {
        let mut o = Obj::new(v, d)?;
        resource_type(&mut o, d, "CodeSystem");
        let r = CodeSystem {
            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"),
            url: o.prim(d, "url", Kind::Uri),
            identifier: o.list(d, "identifier"),
            version: o.prim(d, "version", Kind::String),
            name: o.prim(d, "name", Kind::String),
            title: o.prim(d, "title", Kind::String),
            status: o.prim(d, "status", Kind::Code),
            experimental: o.prim(d, "experimental", Kind::Boolean),
            date: o.prim(d, "date", Kind::DateTime),
            publisher: o.prim(d, "publisher", Kind::String),
            contact: o.list(d, "contact"),
            description: o.prim(d, "description", Kind::Markdown),
            use_context: o.list(d, "useContext"),
            jurisdiction: o.list(d, "jurisdiction"),
            purpose: o.prim(d, "purpose", Kind::Markdown),
            copyright: o.prim(d, "copyright", Kind::Markdown),
            case_sensitive: o.prim(d, "caseSensitive", Kind::Boolean),
            value_set: o.prim(d, "valueSet", Kind::Canonical),
            hierarchy_meaning: o.prim(d, "hierarchyMeaning", Kind::Code),
            compositional: o.prim(d, "compositional", Kind::Boolean),
            version_needed: o.prim(d, "versionNeeded", Kind::Boolean),
            content: o.prim(d, "content", Kind::Code),
            supplements: o.prim(d, "supplements", Kind::Canonical),
            count: o.prim(d, "count", Kind::UnsignedInt),
            filter: o.list(d, "filter"),
            property: o.list(d, "property"),
            concept: o.list(d, "concept"),
        };
        required(d, "status", &r.status);
        required(d, "content", &r.content);
        o.finish(d);
        Some(r)
    }

    fn encode(&self) -> Json {
        let mut w = ObjWriter::new();
        w.raw("resourceType", Json::String("CodeSystem".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.prim("url", &self.url);
        w.list("identifier", &self.identifier);
        w.prim("version", &self.version);
        w.prim("name", &self.name);
        w.prim("title", &self.title);
        w.prim("status", &self.status);
        w.prim("experimental", &self.experimental);
        w.prim("date", &self.date);
        w.prim("publisher", &self.publisher);
        w.list("contact", &self.contact);
        w.prim("description", &self.description);
        w.list("useContext", &self.use_context);
        w.list("jurisdiction", &self.jurisdiction);
        w.prim("purpose", &self.purpose);
        w.prim("copyright", &self.copyright);
        w.prim("caseSensitive", &self.case_sensitive);
        w.prim("valueSet", &self.value_set);
        w.prim("hierarchyMeaning", &self.hierarchy_meaning);
        w.prim("compositional", &self.compositional);
        w.prim("versionNeeded", &self.version_needed);
        w.prim("content", &self.content);
        w.prim("supplements", &self.supplements);
        w.prim("count", &self.count);
        w.list("filter", &self.filter);
        w.list("property", &self.property);
        w.list("concept", &self.concept);
        w.finish()
    }
}

/// Filter that can be used in a value set
///
/// FHIR path: `CodeSystem.filter`.
#[cfg(feature = "foundation")]
#[derive(Debug, Clone, PartialEq, Default)]
pub struct CodeSystemFilter {
    /// `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>,
    /// `code` (1..1): Code that identifies the filter
    pub code: Option<Primitive<String>>,
    /// `description` (0..1): How or why the filter is used
    pub description: Option<Primitive<String>>,
    /// `operator` (1..*): = | is-a | descendent-of | is-not-a | regex | in | not-in | generalizes | exists
    pub operator: Vec<Primitive<String>>,
    /// `value` (1..1): What to use for the value
    pub value: Option<Primitive<String>>,
}

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

    fn decode(v: &Json, d: &mut Decoder) -> Option<Self> {
        let mut o = Obj::new(v, d)?;
        let r = CodeSystemFilter {
            id: o.string(d, "id"),
            extension: o.list(d, "extension"),
            modifier_extension: o.list(d, "modifierExtension"),
            code: o.prim(d, "code", Kind::Code),
            description: o.prim(d, "description", Kind::String),
            operator: o.prim_list(d, "operator", Kind::Code),
            value: o.prim(d, "value", Kind::String),
        };
        required(d, "code", &r.code);
        required_list(d, "operator", &r.operator, 1);
        required(d, "value", &r.value);
        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("code", &self.code);
        w.prim("description", &self.description);
        w.prim_list("operator", &self.operator);
        w.prim("value", &self.value);
        w.finish()
    }
}

/// Additional information supplied about each concept
///
/// FHIR path: `CodeSystem.property`.
#[cfg(feature = "foundation")]
#[derive(Debug, Clone, PartialEq, Default)]
pub struct CodeSystemProperty {
    /// `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>,
    /// `code` (1..1): Identifies the property on the concepts, and when referred to in operations
    pub code: Option<Primitive<String>>,
    /// `uri` (0..1): Formal identifier for the property
    pub uri: Option<Primitive<String>>,
    /// `description` (0..1): Why the property is defined, and/or what it conveys
    pub description: Option<Primitive<String>>,
    /// `type` (1..1): code | Coding | string | integer | boolean | dateTime | decimal
    pub type_: Option<Primitive<String>>,
}

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

    fn decode(v: &Json, d: &mut Decoder) -> Option<Self> {
        let mut o = Obj::new(v, d)?;
        let r = CodeSystemProperty {
            id: o.string(d, "id"),
            extension: o.list(d, "extension"),
            modifier_extension: o.list(d, "modifierExtension"),
            code: o.prim(d, "code", Kind::Code),
            uri: o.prim(d, "uri", Kind::Uri),
            description: o.prim(d, "description", Kind::String),
            type_: o.prim(d, "type", Kind::Code),
        };
        required(d, "code", &r.code);
        required(d, "type", &r.type_);
        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("code", &self.code);
        w.prim("uri", &self.uri);
        w.prim("description", &self.description);
        w.prim("type", &self.type_);
        w.finish()
    }
}

/// Concepts in the code system
///
/// FHIR path: `CodeSystem.concept`.
#[cfg(feature = "foundation")]
#[derive(Debug, Clone, PartialEq, Default)]
pub struct CodeSystemConcept {
    /// `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>,
    /// `code` (1..1): Code that identifies concept
    pub code: Option<Primitive<String>>,
    /// `display` (0..1): Text to display to the user
    pub display: Option<Primitive<String>>,
    /// `definition` (0..1): Formal definition
    pub definition: Option<Primitive<String>>,
    /// `designation` (0..*): Additional representations for the concept
    pub designation: Vec<CodeSystemConceptDesignation>,
    /// `property` (0..*): Property value for the concept
    pub property: Vec<CodeSystemConceptProperty>,
    /// `concept` (0..*): Child Concepts (is-a/contains/categorizes)
    pub concept: Vec<CodeSystemConcept>,
}

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

    fn decode(v: &Json, d: &mut Decoder) -> Option<Self> {
        let mut o = Obj::new(v, d)?;
        let r = CodeSystemConcept {
            id: o.string(d, "id"),
            extension: o.list(d, "extension"),
            modifier_extension: o.list(d, "modifierExtension"),
            code: o.prim(d, "code", Kind::Code),
            display: o.prim(d, "display", Kind::String),
            definition: o.prim(d, "definition", Kind::String),
            designation: o.list(d, "designation"),
            property: o.list(d, "property"),
            concept: o.list(d, "concept"),
        };
        required(d, "code", &r.code);
        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("code", &self.code);
        w.prim("display", &self.display);
        w.prim("definition", &self.definition);
        w.list("designation", &self.designation);
        w.list("property", &self.property);
        w.list("concept", &self.concept);
        w.finish()
    }
}

/// Additional representations for the concept
///
/// FHIR path: `CodeSystem.concept.designation`.
#[cfg(feature = "foundation")]
#[derive(Debug, Clone, PartialEq, Default)]
pub struct CodeSystemConceptDesignation {
    /// `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>,
    /// `language` (0..1): Human language of the designation
    pub language: Option<Primitive<String>>,
    /// `use` (0..1): Details how this designation would be used
    pub use_: Option<Coding>,
    /// `value` (1..1): The text value for this designation
    pub value: Option<Primitive<String>>,
}

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

    fn decode(v: &Json, d: &mut Decoder) -> Option<Self> {
        let mut o = Obj::new(v, d)?;
        let r = CodeSystemConceptDesignation {
            id: o.string(d, "id"),
            extension: o.list(d, "extension"),
            modifier_extension: o.list(d, "modifierExtension"),
            language: o.prim(d, "language", Kind::Code),
            use_: o.one(d, "use"),
            value: o.prim(d, "value", Kind::String),
        };
        required(d, "value", &r.value);
        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("language", &self.language);
        w.one("use", &self.use_);
        w.prim("value", &self.value);
        w.finish()
    }
}

/// Property value for the concept
///
/// FHIR path: `CodeSystem.concept.property`.
#[cfg(feature = "foundation")]
#[derive(Debug, Clone, PartialEq, Default)]
pub struct CodeSystemConceptProperty {
    /// `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>,
    /// `code` (1..1): Reference to CodeSystem.property.code
    pub code: Option<Primitive<String>>,
    /// `value[x]` (1..1): Value of the property for this concept
    pub value: Option<CodeSystemConceptPropertyValue>,
}

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

    fn decode(v: &Json, d: &mut Decoder) -> Option<Self> {
        let mut o = Obj::new(v, d)?;
        let r = CodeSystemConceptProperty {
            id: o.string(d, "id"),
            extension: o.list(d, "extension"),
            modifier_extension: o.list(d, "modifierExtension"),
            code: o.prim(d, "code", Kind::Code),
            value: o.choice(d, "value"),
        };
        required(d, "code", &r.code);
        required(d, "value[x]", &r.value);
        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("code", &self.code);
        w.choice("value", &self.value);
        w.finish()
    }
}

/// The types `CodeSystem.concept.property.value[x]` allows.
#[cfg(feature = "foundation")]
#[derive(Debug, Clone, PartialEq)]
pub enum CodeSystemConceptPropertyValue {
    /// `code`
    Code(Primitive<String>),
    /// `Coding`
    Coding(Coding),
    /// `string`
    String(Primitive<String>),
    /// `integer`
    Integer(Primitive<i32>),
    /// `boolean`
    Boolean(Primitive<bool>),
    /// `dateTime`
    DateTime(Primitive<String>),
    /// `decimal`
    Decimal(Primitive<Decimal>),
}

#[cfg(feature = "foundation")]
impl Choice for CodeSystemConceptPropertyValue {
    const TYPES: &'static [&'static str] = &[
        "code", "Coding", "string", "integer", "boolean", "dateTime", "decimal",
    ];

    fn decode_as(code: &str, key: &str, o: &mut Obj<'_>, d: &mut Decoder) -> Option<Self> {
        match code {
            "code" => o.prim(d, key, Kind::Code).map(Self::Code),
            "Coding" => o.one(d, key).map(Self::Coding),
            "string" => o.prim(d, key, Kind::String).map(Self::String),
            "integer" => o.prim(d, key, Kind::Integer).map(Self::Integer),
            "boolean" => o.prim(d, key, Kind::Boolean).map(Self::Boolean),
            "dateTime" => o.prim(d, key, Kind::DateTime).map(Self::DateTime),
            "decimal" => o.prim(d, key, Kind::Decimal).map(Self::Decimal),
            _ => None,
        }
    }

    fn encode_into(&self, base: &str, w: &mut ObjWriter) {
        match self {
            Self::Code(v) => w.prim_value(&choice_key(base, "code"), v),
            Self::Coding(v) => w.value(&choice_key(base, "Coding"), v),
            Self::String(v) => w.prim_value(&choice_key(base, "string"), v),
            Self::Integer(v) => w.prim_value(&choice_key(base, "integer"), v),
            Self::Boolean(v) => w.prim_value(&choice_key(base, "boolean"), v),
            Self::DateTime(v) => w.prim_value(&choice_key(base, "dateTime"), v),
            Self::Decimal(v) => w.prim_value(&choice_key(base, "decimal"), v),
        }
    }
}