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
// @generated by fhirkit-gen from hl7.fhir.r4.core 4.0.1. Do not edit.
//! The FHIR R4 `ActivityDefinition` 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::*;

/// This resource allows for the definition of some activity to be performed, independent of a particular patient, practitioner, or other performance context.
///
/// FHIR path: `ActivityDefinition`.
#[cfg(feature = "specialized")]
#[derive(Debug, Clone, PartialEq, Default)]
pub struct ActivityDefinition {
    /// `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 activity definition, represented as a URI (globally unique)
    pub url: Option<Primitive<String>>,
    /// `identifier` (0..*): Additional identifier for the activity definition
    pub identifier: Vec<Identifier>,
    /// `version` (0..1): Business version of the activity definition
    pub version: Option<Primitive<String>>,
    /// `name` (0..1): Name for this activity definition (computer friendly)
    pub name: Option<Primitive<String>>,
    /// `title` (0..1): Name for this activity definition (human friendly)
    pub title: Option<Primitive<String>>,
    /// `subtitle` (0..1): Subordinate title of the activity definition
    pub subtitle: 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>>,
    /// `subject[x]` (0..1): Type of individual the activity definition is intended for
    pub subject: Option<ActivityDefinitionSubject>,
    /// `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 activity definition
    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 activity definition (if applicable)
    pub jurisdiction: Vec<CodeableConcept>,
    /// `purpose` (0..1): Why this activity definition is defined
    pub purpose: Option<Primitive<String>>,
    /// `usage` (0..1): Describes the clinical usage of the activity definition
    pub usage: Option<Primitive<String>>,
    /// `copyright` (0..1): Use and/or publishing restrictions
    pub copyright: Option<Primitive<String>>,
    /// `approvalDate` (0..1): When the activity definition was approved by publisher
    pub approval_date: Option<Primitive<String>>,
    /// `lastReviewDate` (0..1): When the activity definition was last reviewed
    pub last_review_date: Option<Primitive<String>>,
    /// `effectivePeriod` (0..1): When the activity definition is expected to be used
    pub effective_period: Option<Period>,
    /// `topic` (0..*): E.g. Education, Treatment, Assessment, etc.
    pub topic: Vec<CodeableConcept>,
    /// `author` (0..*): Who authored the content
    pub author: Vec<ContactDetail>,
    /// `editor` (0..*): Who edited the content
    pub editor: Vec<ContactDetail>,
    /// `reviewer` (0..*): Who reviewed the content
    pub reviewer: Vec<ContactDetail>,
    /// `endorser` (0..*): Who endorsed the content
    pub endorser: Vec<ContactDetail>,
    /// `relatedArtifact` (0..*): Additional documentation, citations, etc.
    pub related_artifact: Vec<RelatedArtifact>,
    /// `library` (0..*): Logic used by the activity definition
    pub library: Vec<Primitive<String>>,
    /// `kind` (0..1): Kind of resource
    pub kind: Option<Primitive<String>>,
    /// `profile` (0..1): What profile the resource needs to conform to
    pub profile: Option<Primitive<String>>,
    /// `code` (0..1): Detail type of activity
    pub code: Option<CodeableConcept>,
    /// `intent` (0..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>>,
    /// `doNotPerform` (0..1): True if the activity should not be performed
    pub do_not_perform: Option<Primitive<bool>>,
    /// `timing[x]` (0..1): When activity is to occur
    pub timing: Option<ActivityDefinitionTiming>,
    /// `location` (0..1): Where it should happen
    pub location: Option<Reference>,
    /// `participant` (0..*): Who should participate in the action
    pub participant: Vec<ActivityDefinitionParticipant>,
    /// `product[x]` (0..1): What's administered/supplied
    pub product: Option<ActivityDefinitionProduct>,
    /// `quantity` (0..1): How much is administered/consumed/supplied
    pub quantity: Option<Quantity>,
    /// `dosage` (0..*): Detailed dosage instructions
    pub dosage: Vec<Dosage>,
    /// `bodySite` (0..*): What part of body to perform on
    pub body_site: Vec<CodeableConcept>,
    /// `specimenRequirement` (0..*): What specimens are required to perform this action
    pub specimen_requirement: Vec<Reference>,
    /// `observationRequirement` (0..*): What observations are required to perform this action
    pub observation_requirement: Vec<Reference>,
    /// `observationResultRequirement` (0..*): What observations must be produced by this action
    pub observation_result_requirement: Vec<Reference>,
    /// `transform` (0..1): Transform to apply the template
    pub transform: Option<Primitive<String>>,
    /// `dynamicValue` (0..*): Dynamic aspects of the definition
    pub dynamic_value: Vec<ActivityDefinitionDynamicValue>,
}

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

    fn decode(v: &Json, d: &mut Decoder) -> Option<Self> {
        let mut o = Obj::new(v, d)?;
        resource_type(&mut o, d, "ActivityDefinition");
        let r = ActivityDefinition {
            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),
            subtitle: o.prim(d, "subtitle", Kind::String),
            status: o.prim(d, "status", Kind::Code),
            experimental: o.prim(d, "experimental", Kind::Boolean),
            subject: o.choice(d, "subject"),
            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),
            usage: o.prim(d, "usage", Kind::String),
            copyright: o.prim(d, "copyright", Kind::Markdown),
            approval_date: o.prim(d, "approvalDate", Kind::Date),
            last_review_date: o.prim(d, "lastReviewDate", Kind::Date),
            effective_period: o.one(d, "effectivePeriod"),
            topic: o.list(d, "topic"),
            author: o.list(d, "author"),
            editor: o.list(d, "editor"),
            reviewer: o.list(d, "reviewer"),
            endorser: o.list(d, "endorser"),
            related_artifact: o.list(d, "relatedArtifact"),
            library: o.prim_list(d, "library", Kind::Canonical),
            kind: o.prim(d, "kind", Kind::Code),
            profile: o.prim(d, "profile", Kind::Canonical),
            code: o.one(d, "code"),
            intent: o.prim(d, "intent", Kind::Code),
            priority: o.prim(d, "priority", Kind::Code),
            do_not_perform: o.prim(d, "doNotPerform", Kind::Boolean),
            timing: o.choice(d, "timing"),
            location: o.one(d, "location"),
            participant: o.list(d, "participant"),
            product: o.choice(d, "product"),
            quantity: o.one(d, "quantity"),
            dosage: o.list(d, "dosage"),
            body_site: o.list(d, "bodySite"),
            specimen_requirement: o.list(d, "specimenRequirement"),
            observation_requirement: o.list(d, "observationRequirement"),
            observation_result_requirement: o.list(d, "observationResultRequirement"),
            transform: o.prim(d, "transform", Kind::Canonical),
            dynamic_value: o.list(d, "dynamicValue"),
        };
        required(d, "status", &r.status);
        o.finish(d);
        Some(r)
    }

    fn encode(&self) -> Json {
        let mut w = ObjWriter::new();
        w.raw("resourceType", Json::String("ActivityDefinition".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("subtitle", &self.subtitle);
        w.prim("status", &self.status);
        w.prim("experimental", &self.experimental);
        w.choice("subject", &self.subject);
        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("usage", &self.usage);
        w.prim("copyright", &self.copyright);
        w.prim("approvalDate", &self.approval_date);
        w.prim("lastReviewDate", &self.last_review_date);
        w.one("effectivePeriod", &self.effective_period);
        w.list("topic", &self.topic);
        w.list("author", &self.author);
        w.list("editor", &self.editor);
        w.list("reviewer", &self.reviewer);
        w.list("endorser", &self.endorser);
        w.list("relatedArtifact", &self.related_artifact);
        w.prim_list("library", &self.library);
        w.prim("kind", &self.kind);
        w.prim("profile", &self.profile);
        w.one("code", &self.code);
        w.prim("intent", &self.intent);
        w.prim("priority", &self.priority);
        w.prim("doNotPerform", &self.do_not_perform);
        w.choice("timing", &self.timing);
        w.one("location", &self.location);
        w.list("participant", &self.participant);
        w.choice("product", &self.product);
        w.one("quantity", &self.quantity);
        w.list("dosage", &self.dosage);
        w.list("bodySite", &self.body_site);
        w.list("specimenRequirement", &self.specimen_requirement);
        w.list("observationRequirement", &self.observation_requirement);
        w.list(
            "observationResultRequirement",
            &self.observation_result_requirement,
        );
        w.prim("transform", &self.transform);
        w.list("dynamicValue", &self.dynamic_value);
        w.finish()
    }
}

/// Who should participate in the action
///
/// FHIR path: `ActivityDefinition.participant`.
#[cfg(feature = "specialized")]
#[derive(Debug, Clone, PartialEq, Default)]
pub struct ActivityDefinitionParticipant {
    /// `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>,
    /// `type` (1..1): patient | practitioner | related-person | device
    pub type_: Option<Primitive<String>>,
    /// `role` (0..1): E.g. Nurse, Surgeon, Parent, etc.
    pub role: Option<CodeableConcept>,
}

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

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

/// Dynamic aspects of the definition
///
/// FHIR path: `ActivityDefinition.dynamicValue`.
#[cfg(feature = "specialized")]
#[derive(Debug, Clone, PartialEq, Default)]
pub struct ActivityDefinitionDynamicValue {
    /// `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>,
    /// `path` (1..1): The path to the element to be set dynamically
    pub path: Option<Primitive<String>>,
    /// `expression` (1..1): An expression that provides the dynamic value for the customization
    pub expression: Option<Expression>,
}

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

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

/// The types `ActivityDefinition.subject[x]` allows.
#[cfg(feature = "specialized")]
#[derive(Debug, Clone, PartialEq)]
pub enum ActivityDefinitionSubject {
    /// `CodeableConcept`
    CodeableConcept(CodeableConcept),
    /// `Reference`
    Reference(Reference),
}

#[cfg(feature = "specialized")]
impl Choice for ActivityDefinitionSubject {
    const TYPES: &'static [&'static str] = &["CodeableConcept", "Reference"];

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

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

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

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

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

    fn encode_into(&self, base: &str, w: &mut ObjWriter) {
        match self {
            Self::Timing(v) => w.value(&choice_key(base, "Timing"), v),
            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::Range(v) => w.value(&choice_key(base, "Range"), v),
            Self::Duration(v) => w.value(&choice_key(base, "Duration"), v),
        }
    }
}

/// The types `ActivityDefinition.product[x]` allows.
#[cfg(feature = "specialized")]
#[derive(Debug, Clone, PartialEq)]
pub enum ActivityDefinitionProduct {
    /// `Reference`
    Reference(Reference),
    /// `CodeableConcept`
    CodeableConcept(CodeableConcept),
}

#[cfg(feature = "specialized")]
impl Choice for ActivityDefinitionProduct {
    const TYPES: &'static [&'static str] = &["Reference", "CodeableConcept"];

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

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