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

/// An order or request for both supply of the medication and the instructions for administration of the medication to a patient. The resource is called "MedicationRequest" rather than "MedicationPrescription" or "MedicationOrder" to generalize the use across inpatient and outpatient settings, including care plans, etc., and to harmonize with workflow patterns.
///
/// FHIR path: `MedicationRequest`.
#[cfg(feature = "clinical")]
#[derive(Debug, Clone, PartialEq, Default)]
pub struct MedicationRequest {
    /// `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..*): External ids for this request
    pub identifier: Vec<Identifier>,
    /// `status` (1..1): active | on-hold | cancelled | completed | entered-in-error | stopped | draft | unknown
    pub status: Option<Primitive<String>>,
    /// `statusReason` (0..1): Reason for current status
    pub status_reason: Option<CodeableConcept>,
    /// `intent` (1..1): proposal | plan | order | original-order | reflex-order | filler-order | instance-order | option
    pub intent: Option<Primitive<String>>,
    /// `category` (0..*): Type of medication usage
    pub category: Vec<CodeableConcept>,
    /// `priority` (0..1): routine | urgent | asap | stat
    pub priority: Option<Primitive<String>>,
    /// `doNotPerform` (0..1): True if request is prohibiting action
    pub do_not_perform: Option<Primitive<bool>>,
    /// `reported[x]` (0..1): Reported rather than primary record
    pub reported: Option<MedicationRequestReported>,
    /// `medication[x]` (1..1): Medication to be taken
    pub medication: Option<MedicationRequestMedication>,
    /// `subject` (1..1): Who or group medication request is for
    pub subject: Option<Reference>,
    /// `encounter` (0..1): Encounter created as part of encounter/admission/stay
    pub encounter: Option<Reference>,
    /// `supportingInformation` (0..*): Information to support ordering of the medication
    pub supporting_information: Vec<Reference>,
    /// `authoredOn` (0..1): When request was initially authored
    pub authored_on: Option<Primitive<String>>,
    /// `requester` (0..1): Who/What requested the Request
    pub requester: Option<Reference>,
    /// `performer` (0..1): Intended performer of administration
    pub performer: Option<Reference>,
    /// `performerType` (0..1): Desired kind of performer of the medication administration
    pub performer_type: Option<CodeableConcept>,
    /// `recorder` (0..1): Person who entered the request
    pub recorder: Option<Reference>,
    /// `reasonCode` (0..*): Reason or indication for ordering or not ordering the medication
    pub reason_code: Vec<CodeableConcept>,
    /// `reasonReference` (0..*): Condition or observation that supports why the prescription is being written
    pub reason_reference: Vec<Reference>,
    /// `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..*): What request fulfills
    pub based_on: Vec<Reference>,
    /// `groupIdentifier` (0..1): Composite request this is part of
    pub group_identifier: Option<Identifier>,
    /// `courseOfTherapyType` (0..1): Overall pattern of medication administration
    pub course_of_therapy_type: Option<CodeableConcept>,
    /// `insurance` (0..*): Associated insurance coverage
    pub insurance: Vec<Reference>,
    /// `note` (0..*): Information about the prescription
    pub note: Vec<Annotation>,
    /// `dosageInstruction` (0..*): How the medication should be taken
    pub dosage_instruction: Vec<Dosage>,
    /// `dispenseRequest` (0..1): Medication supply authorization
    pub dispense_request: Option<MedicationRequestDispenseRequest>,
    /// `substitution` (0..1): Any restrictions on medication substitution
    pub substitution: Option<MedicationRequestSubstitution>,
    /// `priorPrescription` (0..1): An order/prescription that is being replaced
    pub prior_prescription: Option<Reference>,
    /// `detectedIssue` (0..*): Clinical Issue with action
    pub detected_issue: Vec<Reference>,
    /// `eventHistory` (0..*): A list of events of interest in the lifecycle
    pub event_history: Vec<Reference>,
}

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

    fn decode(v: &Json, d: &mut Decoder) -> Option<Self> {
        let mut o = Obj::new(v, d)?;
        resource_type(&mut o, d, "MedicationRequest");
        let r = MedicationRequest {
            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"),
            intent: o.prim(d, "intent", Kind::Code),
            category: o.list(d, "category"),
            priority: o.prim(d, "priority", Kind::Code),
            do_not_perform: o.prim(d, "doNotPerform", Kind::Boolean),
            reported: o.choice(d, "reported"),
            medication: o.choice(d, "medication"),
            subject: o.one(d, "subject"),
            encounter: o.one(d, "encounter"),
            supporting_information: o.list(d, "supportingInformation"),
            authored_on: o.prim(d, "authoredOn", Kind::DateTime),
            requester: o.one(d, "requester"),
            performer: o.one(d, "performer"),
            performer_type: o.one(d, "performerType"),
            recorder: o.one(d, "recorder"),
            reason_code: o.list(d, "reasonCode"),
            reason_reference: o.list(d, "reasonReference"),
            instantiates_canonical: o.prim_list(d, "instantiatesCanonical", Kind::Canonical),
            instantiates_uri: o.prim_list(d, "instantiatesUri", Kind::Uri),
            based_on: o.list(d, "basedOn"),
            group_identifier: o.one(d, "groupIdentifier"),
            course_of_therapy_type: o.one(d, "courseOfTherapyType"),
            insurance: o.list(d, "insurance"),
            note: o.list(d, "note"),
            dosage_instruction: o.list(d, "dosageInstruction"),
            dispense_request: o.one(d, "dispenseRequest"),
            substitution: o.one(d, "substitution"),
            prior_prescription: o.one(d, "priorPrescription"),
            detected_issue: o.list(d, "detectedIssue"),
            event_history: o.list(d, "eventHistory"),
        };
        required(d, "status", &r.status);
        required(d, "intent", &r.intent);
        required(d, "medication[x]", &r.medication);
        required(d, "subject", &r.subject);
        o.finish(d);
        Some(r)
    }

    fn encode(&self) -> Json {
        let mut w = ObjWriter::new();
        w.raw("resourceType", Json::String("MedicationRequest".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.prim("intent", &self.intent);
        w.list("category", &self.category);
        w.prim("priority", &self.priority);
        w.prim("doNotPerform", &self.do_not_perform);
        w.choice("reported", &self.reported);
        w.choice("medication", &self.medication);
        w.one("subject", &self.subject);
        w.one("encounter", &self.encounter);
        w.list("supportingInformation", &self.supporting_information);
        w.prim("authoredOn", &self.authored_on);
        w.one("requester", &self.requester);
        w.one("performer", &self.performer);
        w.one("performerType", &self.performer_type);
        w.one("recorder", &self.recorder);
        w.list("reasonCode", &self.reason_code);
        w.list("reasonReference", &self.reason_reference);
        w.prim_list("instantiatesCanonical", &self.instantiates_canonical);
        w.prim_list("instantiatesUri", &self.instantiates_uri);
        w.list("basedOn", &self.based_on);
        w.one("groupIdentifier", &self.group_identifier);
        w.one("courseOfTherapyType", &self.course_of_therapy_type);
        w.list("insurance", &self.insurance);
        w.list("note", &self.note);
        w.list("dosageInstruction", &self.dosage_instruction);
        w.one("dispenseRequest", &self.dispense_request);
        w.one("substitution", &self.substitution);
        w.one("priorPrescription", &self.prior_prescription);
        w.list("detectedIssue", &self.detected_issue);
        w.list("eventHistory", &self.event_history);
        w.finish()
    }
}

/// Medication supply authorization
///
/// FHIR path: `MedicationRequest.dispenseRequest`.
#[cfg(feature = "clinical")]
#[derive(Debug, Clone, PartialEq, Default)]
pub struct MedicationRequestDispenseRequest {
    /// `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>,
    /// `initialFill` (0..1): First fill details
    pub initial_fill: Option<MedicationRequestDispenseRequestInitialFill>,
    /// `dispenseInterval` (0..1): Minimum period of time between dispenses
    pub dispense_interval: Option<Duration>,
    /// `validityPeriod` (0..1): Time period supply is authorized for
    pub validity_period: Option<Period>,
    /// `numberOfRepeatsAllowed` (0..1): Number of refills authorized
    pub number_of_repeats_allowed: Option<Primitive<i32>>,
    /// `quantity` (0..1): Amount of medication to supply per dispense
    pub quantity: Option<Quantity>,
    /// `expectedSupplyDuration` (0..1): Number of days supply per dispense
    pub expected_supply_duration: Option<Duration>,
    /// `performer` (0..1): Intended dispenser
    pub performer: Option<Reference>,
}

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

    fn decode(v: &Json, d: &mut Decoder) -> Option<Self> {
        let mut o = Obj::new(v, d)?;
        let r = MedicationRequestDispenseRequest {
            id: o.string(d, "id"),
            extension: o.list(d, "extension"),
            modifier_extension: o.list(d, "modifierExtension"),
            initial_fill: o.one(d, "initialFill"),
            dispense_interval: o.one(d, "dispenseInterval"),
            validity_period: o.one(d, "validityPeriod"),
            number_of_repeats_allowed: o.prim(d, "numberOfRepeatsAllowed", Kind::UnsignedInt),
            quantity: o.one(d, "quantity"),
            expected_supply_duration: o.one(d, "expectedSupplyDuration"),
            performer: o.one(d, "performer"),
        };
        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("initialFill", &self.initial_fill);
        w.one("dispenseInterval", &self.dispense_interval);
        w.one("validityPeriod", &self.validity_period);
        w.prim("numberOfRepeatsAllowed", &self.number_of_repeats_allowed);
        w.one("quantity", &self.quantity);
        w.one("expectedSupplyDuration", &self.expected_supply_duration);
        w.one("performer", &self.performer);
        w.finish()
    }
}

/// First fill details
///
/// FHIR path: `MedicationRequest.dispenseRequest.initialFill`.
#[cfg(feature = "clinical")]
#[derive(Debug, Clone, PartialEq, Default)]
pub struct MedicationRequestDispenseRequestInitialFill {
    /// `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>,
    /// `quantity` (0..1): First fill quantity
    pub quantity: Option<Quantity>,
    /// `duration` (0..1): First fill duration
    pub duration: Option<Duration>,
}

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

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

/// Any restrictions on medication substitution
///
/// FHIR path: `MedicationRequest.substitution`.
#[cfg(feature = "clinical")]
#[derive(Debug, Clone, PartialEq, Default)]
pub struct MedicationRequestSubstitution {
    /// `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>,
    /// `allowed[x]` (1..1): Whether substitution is allowed or not
    pub allowed: Option<MedicationRequestSubstitutionAllowed>,
    /// `reason` (0..1): Why should (not) substitution be made
    pub reason: Option<CodeableConcept>,
}

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

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

/// The types `MedicationRequest.reported[x]` allows.
#[cfg(feature = "clinical")]
#[derive(Debug, Clone, PartialEq)]
pub enum MedicationRequestReported {
    /// `boolean`
    Boolean(Primitive<bool>),
    /// `Reference`
    Reference(Reference),
}

#[cfg(feature = "clinical")]
impl Choice for MedicationRequestReported {
    const TYPES: &'static [&'static str] = &["boolean", "Reference"];

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

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

/// The types `MedicationRequest.medication[x]` allows.
#[cfg(feature = "clinical")]
#[derive(Debug, Clone, PartialEq)]
pub enum MedicationRequestMedication {
    /// `CodeableConcept`
    CodeableConcept(CodeableConcept),
    /// `Reference`
    Reference(Reference),
}

#[cfg(feature = "clinical")]
impl Choice for MedicationRequestMedication {
    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 `MedicationRequest.substitution.allowed[x]` allows.
#[cfg(feature = "clinical")]
#[derive(Debug, Clone, PartialEq)]
pub enum MedicationRequestSubstitutionAllowed {
    /// `boolean`
    Boolean(Primitive<bool>),
    /// `CodeableConcept`
    CodeableConcept(CodeableConcept),
}

#[cfg(feature = "clinical")]
impl Choice for MedicationRequestSubstitutionAllowed {
    const TYPES: &'static [&'static str] = &["boolean", "CodeableConcept"];

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

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