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
//! Dosage
//!
//! URL: http://hl7.org/fhir/StructureDefinition/Dosage
//!
//! Version: 5.0.0
//!
//! Dosage Type: Indicates how the medication is/was taken or should be taken by the patient.
//!
//! FHIR: <https://build.fhir.org/>
//!
//! UML: <https://build.fhir.org/uml.html>
// Allow unused crate::r5::types as types;
#![allow(unused_imports)]
use crate::r5::types;
use ::serde::{Deserialize, Serialize};
use fhir_derive_macros::{Builder, Validate};
/// Dosage indicates how a medication is, was, or should be taken by the patient.
///
/// It captures the full instruction set for administering a medication,
/// including timing, route, site, method, dose amounts and rates, and upper
/// limits on how much may be taken per period, per administration, or over a
/// lifetime. In FHIR R5 it is a complex datatype used throughout medication
/// resources such as MedicationRequest, MedicationStatement, and
/// MedicationDispense.
///
/// # Examples
///
/// ```
/// use fhir::r5::types::dosage::Dosage;
///
/// let value = Dosage::default();
/// let json = ::serde_json::to_value(&value).unwrap();
/// let back: Dosage = ::serde_json::from_value(json).unwrap();
/// assert_eq!(value, back);
/// ```
#[serde_with::skip_serializing_none]
#[derive(Debug, Default, Clone, Serialize, Deserialize, PartialEq, Eq, Validate, Builder)]
#[serde(rename_all = "camelCase")]
pub struct Dosage {
/// Unique id for inter-element referencing
pub id: Option<types::String>,
/// Additional content defined by implementations
#[serde(default, skip_serializing_if = "Vec::is_empty")]
pub extension: Vec<types::Extension>,
/// Extensions that cannot be ignored even if unrecognized
#[serde(default, skip_serializing_if = "Vec::is_empty")]
pub modifier_extension: Vec<types::Extension>,
/// The order of the dosage instructions
pub sequence: Option<types::Integer>,
/// Primitive extension sibling for [`sequence`](Self::sequence) (FHIR `_sequence`).
#[serde(rename = "_sequence")]
pub sequence_ext: Option<types::Element>,
/// Free text dosage instructions e.g. SIG
pub text: Option<types::String>,
/// Primitive extension sibling for [`text`](Self::text) (FHIR `_text`).
#[serde(rename = "_text")]
pub text_ext: Option<types::Element>,
/// Supplemental instruction or warnings to the patient - e.g. "with meals", "may cause drowsiness"
#[serde(default, skip_serializing_if = "Vec::is_empty")]
pub additional_instruction: Vec<types::CodeableConcept>,
/// Patient or consumer oriented instructions
pub patient_instruction: Option<types::String>,
/// Primitive extension sibling for [`patient_instruction`](Self::patient_instruction) (FHIR `_patientInstruction`).
#[serde(rename = "_patientInstruction")]
pub patient_instruction_ext: Option<types::Element>,
/// When medication should be administered
pub timing: Option<types::Timing>,
/// Take "as needed"
pub as_needed: Option<types::Boolean>,
/// Primitive extension sibling for [`as_needed`](Self::as_needed) (FHIR `_asNeeded`).
#[serde(rename = "_asNeeded")]
pub as_needed_ext: Option<types::Element>,
/// Take "as needed" (for x)
#[serde(default, skip_serializing_if = "Vec::is_empty")]
pub as_needed_for: Vec<types::CodeableConcept>,
/// Body site to administer to
pub site: Option<types::CodeableConcept>,
/// How drug should enter body
pub route: Option<types::CodeableConcept>,
/// Technique for administering medication
pub method: Option<types::CodeableConcept>,
/// Amount of medication administered, to be administered or typical amount to be administered
#[serde(default, skip_serializing_if = "Vec::is_empty")]
pub dose_and_rate: Vec<DosageDoseAndRate>,
/// Upper limit on medication per unit of time
#[serde(default, skip_serializing_if = "Vec::is_empty")]
pub max_dose_per_period: Vec<types::Ratio>,
/// Upper limit on medication per administration
pub max_dose_per_administration: Option<types::Quantity>,
/// Upper limit on medication per lifetime of the patient
pub max_dose_per_lifetime: Option<types::Quantity>,
}
/// The amount of medication administered, to be administered, or the typical
/// amount to be administered, optionally paired with the kind of dose or rate.
///
/// This nested backbone element expresses a single dose-and-rate pairing within
/// a [`Dosage`], covering the dose amount (as a range or quantity) and the rate
/// at which it is administered (as a ratio, range, or quantity).
#[serde_with::skip_serializing_none]
#[derive(Debug, Default, Clone, Serialize, Deserialize, PartialEq, Eq, Validate)]
#[serde(rename_all = "camelCase")]
pub struct DosageDoseAndRate {
/// Unique id for inter-element referencing
pub id: Option<types::String>,
/// Additional content defined by implementations
#[serde(default, skip_serializing_if = "Vec::is_empty")]
pub extension: Vec<types::Extension>,
/// The kind of dose or rate specified
pub r#type: Option<types::CodeableConcept>,
/// The `Dosage.doseAndRate.dose[x]` choice element (0..1); see [`DosageDoseAndRateDose`].
#[serde(flatten)]
pub dose: Option<DosageDoseAndRateDose>,
/// The `Dosage.doseAndRate.rate[x]` choice element (0..1); see [`DosageDoseAndRateRate`].
#[serde(flatten)]
pub rate: Option<DosageDoseAndRateRate>,
}
#[cfg(test)]
mod tests {
use super::*;
type T = Dosage;
#[test]
fn test_default() {
let _ = T::default();
}
#[test]
fn test_serde_round_trip() {
let value = T::default();
let json = ::serde_json::to_value(&value).expect("to_value");
let back: T = ::serde_json::from_value(json).expect("from_value");
assert_eq!(value, back);
}
}
/// The `Dosage.doseAndRate.dose[x]` choice element (see spec/11-choice-types.md).
#[derive(Debug, Clone, PartialEq, Eq, fhir_derive_macros::FhirChoice, Validate)]
#[allow(clippy::large_enum_variant)]
pub enum DosageDoseAndRateDose {
/// `doseRange` variant.
#[fhir("doseRange")]
Range(Box<types::Range>),
/// `doseQuantity` variant.
#[fhir("doseQuantity")]
Quantity(Box<types::Quantity>),
}
/// The `Dosage.doseAndRate.rate[x]` choice element (see spec/11-choice-types.md).
#[derive(Debug, Clone, PartialEq, Eq, fhir_derive_macros::FhirChoice, Validate)]
#[allow(clippy::large_enum_variant)]
pub enum DosageDoseAndRateRate {
/// `rateRatio` variant.
#[fhir("rateRatio")]
Ratio(Box<types::Ratio>),
/// `rateRange` variant.
#[fhir("rateRange")]
Range(Box<types::Range>),
/// `rateQuantity` variant.
#[fhir("rateQuantity")]
Quantity(Box<types::Quantity>),
}