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
//! EventDefinition
//!
//! URL: http://hl7.org/fhir/StructureDefinition/EventDefinition
//!
//! Version: 5.0.0
//!
//! EventDefinition Resource: The EventDefinition resource provides a reusable description of when a particular event can occur.
//!
//! 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::Validate;
/// The EventDefinition resource provides a reusable description of when a
/// particular event can occur, defined in terms of one or more triggers.
/// It is used to describe events that may be referenced by other knowledge
/// artifacts such as plan definitions and clinical guidelines. Each event
/// definition captures the conditions under which the event fires along with
/// the metadata needed to publish and maintain it as a reusable resource.
///
/// Clinically and administratively, an EventDefinition acts as a shareable,
/// versionable building block: rather than embedding trigger logic directly
/// inside every plan or rule that needs it, authors can define the trigger
/// once and reference it by canonical URL from other artifacts, such as
/// `PlanDefinition` or `EventDefinition`-aware clinical decision support
/// modules. This supports consistent behavior across systems that need to
/// react to the same real-world or clinical occurrence (for example, "a
/// patient is admitted" or "a lab result is received"), while still allowing
/// each definition to carry its own publication status, jurisdiction,
/// authorship, and review metadata like a knowledge artifact.
///
/// # Related resources
///
/// - [`PlanDefinition`](crate::r5::resources::plan_definition::PlanDefinition)
/// often references an `EventDefinition` (directly or by canonical URL) to
/// describe when its actions should be triggered.
/// - The `subject` may be expressed as a [`CodeableConcept`](crate::r5::types::CodeableConcept)
/// or as a [`Reference`](crate::r5::types::Reference), for example to a
/// [`Patient`](crate::r5::resources::patient::Patient) or `Group`.
/// - The trigger conditions themselves are represented using
/// `TriggerDefinition`.
///
/// # Examples
///
/// ```ignore
/// use fhir::r5::resources::event_definition::EventDefinition;
///
/// let value = EventDefinition::default();
/// let json = ::serde_json::to_value(&value).unwrap();
/// let back: EventDefinition = ::serde_json::from_value(json).unwrap();
/// assert_eq!(value, back);
/// ```
#[serde_with::skip_serializing_none]
#[derive(Debug, Clone, Serialize, Deserialize, PartialEq, Eq, Validate)]
#[serde(rename_all = "camelCase")]
pub struct EventDefinition {
/// Logical id of this artifact
pub id: Option<types::String>,
/// Metadata about the resource
pub meta: Option<types::Meta>,
/// A set of rules under which this content was created
pub implicit_rules: Option<types::Uri>,
/// Primitive extension sibling for [`implicit_rules`](Self::implicit_rules) (FHIR `_implicitRules`).
#[serde(rename = "_implicitRules")]
pub implicit_rules_ext: Option<types::Element>,
/// Language of the resource content
pub language: Option<types::Code>,
/// Primitive extension sibling for [`language`](Self::language) (FHIR `_language`).
#[serde(rename = "_language")]
pub language_ext: Option<types::Element>,
/// Text summary of the resource, for human interpretation
pub text: Option<types::Narrative>,
/// Contained, inline Resources
#[serde(default, skip_serializing_if = "Vec::is_empty")]
pub contained: Vec<::serde_json::Value>,
/// Additional content defined by implementations
#[serde(default, skip_serializing_if = "Vec::is_empty")]
pub extension: Vec<types::Extension>,
/// Extensions that cannot be ignored
#[serde(default, skip_serializing_if = "Vec::is_empty")]
pub modifier_extension: Vec<types::Extension>,
/// Canonical identifier for this event definition, represented as a URI (globally unique); used by other artifacts to reference this definition
pub url: Option<types::Uri>,
/// Primitive extension sibling for [`url`](Self::url) (FHIR `_url`).
#[serde(rename = "_url")]
pub url_ext: Option<types::Element>,
/// Additional identifier for the event definition
#[serde(default, skip_serializing_if = "Vec::is_empty")]
pub identifier: Vec<types::Identifier>,
/// Business version of the event definition
pub version: Option<types::String>,
/// Primitive extension sibling for [`version`](Self::version) (FHIR `_version`).
#[serde(rename = "_version")]
pub version_ext: Option<types::Element>,
/// The `EventDefinition.versionAlgorithm[x]` choice element (0..1); see [`EventDefinitionVersionAlgorithm`].
#[serde(flatten)]
pub version_algorithm: Option<EventDefinitionVersionAlgorithm>,
/// Name for this event definition (computer friendly)
pub name: Option<types::String>,
/// Primitive extension sibling for [`name`](Self::name) (FHIR `_name`).
#[serde(rename = "_name")]
pub name_ext: Option<types::Element>,
/// Name for this event definition (human friendly)
pub title: Option<types::String>,
/// Primitive extension sibling for [`title`](Self::title) (FHIR `_title`).
#[serde(rename = "_title")]
pub title_ext: Option<types::Element>,
/// Subordinate title of the event definition
pub subtitle: Option<types::String>,
/// Primitive extension sibling for [`subtitle`](Self::subtitle) (FHIR `_subtitle`).
#[serde(rename = "_subtitle")]
pub subtitle_ext: Option<types::Element>,
/// Publication status of this definition: draft | active | retired | unknown, governing whether it is safe to reference and use
pub status: crate::r5::coded::Coded<crate::r5::codes::PublicationStatus>,
/// Primitive extension sibling for [`status`](Self::status) (FHIR `_status`).
#[serde(rename = "_status")]
pub status_ext: Option<types::Element>,
/// For testing purposes, not real usage
pub experimental: Option<types::Boolean>,
/// Primitive extension sibling for [`experimental`](Self::experimental) (FHIR `_experimental`).
#[serde(rename = "_experimental")]
pub experimental_ext: Option<types::Element>,
/// The `EventDefinition.subject[x]` choice element (0..1); see [`EventDefinitionSubject`].
#[serde(flatten)]
pub subject: Option<EventDefinitionSubject>,
/// Date last changed
pub date: Option<types::DateTime>,
/// Primitive extension sibling for [`date`](Self::date) (FHIR `_date`).
#[serde(rename = "_date")]
pub date_ext: Option<types::Element>,
/// Name of the publisher/steward (organization or individual)
pub publisher: Option<types::String>,
/// Primitive extension sibling for [`publisher`](Self::publisher) (FHIR `_publisher`).
#[serde(rename = "_publisher")]
pub publisher_ext: Option<types::Element>,
/// Contact details for the publisher
#[serde(default, skip_serializing_if = "Vec::is_empty")]
pub contact: Vec<types::ContactDetail>,
/// Natural language description of the event definition
pub description: Option<types::Markdown>,
/// Primitive extension sibling for [`description`](Self::description) (FHIR `_description`).
#[serde(rename = "_description")]
pub description_ext: Option<types::Element>,
/// The context that the content is intended to support
#[serde(default, skip_serializing_if = "Vec::is_empty")]
pub use_context: Vec<types::UsageContext>,
/// Intended jurisdiction for event definition (if applicable)
#[serde(default, skip_serializing_if = "Vec::is_empty")]
pub jurisdiction: Vec<types::CodeableConcept>,
/// Why this event definition is defined
pub purpose: Option<types::Markdown>,
/// Primitive extension sibling for [`purpose`](Self::purpose) (FHIR `_purpose`).
#[serde(rename = "_purpose")]
pub purpose_ext: Option<types::Element>,
/// Describes the clinical usage of the event definition
pub usage: Option<types::Markdown>,
/// Primitive extension sibling for [`usage`](Self::usage) (FHIR `_usage`).
#[serde(rename = "_usage")]
pub usage_ext: Option<types::Element>,
/// Use and/or publishing restrictions
pub copyright: Option<types::Markdown>,
/// Primitive extension sibling for [`copyright`](Self::copyright) (FHIR `_copyright`).
#[serde(rename = "_copyright")]
pub copyright_ext: Option<types::Element>,
/// Copyright holder and year(s)
pub copyright_label: Option<types::String>,
/// Primitive extension sibling for [`copyright_label`](Self::copyright_label) (FHIR `_copyrightLabel`).
#[serde(rename = "_copyrightLabel")]
pub copyright_label_ext: Option<types::Element>,
/// When the event definition was approved by publisher
pub approval_date: Option<types::Date>,
/// Primitive extension sibling for [`approval_date`](Self::approval_date) (FHIR `_approvalDate`).
#[serde(rename = "_approvalDate")]
pub approval_date_ext: Option<types::Element>,
/// When the event definition was last reviewed by the publisher
pub last_review_date: Option<types::Date>,
/// Primitive extension sibling for [`last_review_date`](Self::last_review_date) (FHIR `_lastReviewDate`).
#[serde(rename = "_lastReviewDate")]
pub last_review_date_ext: Option<types::Element>,
/// When the event definition is expected to be used
pub effective_period: Option<types::Period>,
/// E.g. Education, Treatment, Assessment, etc
#[serde(default, skip_serializing_if = "Vec::is_empty")]
pub topic: Vec<types::CodeableConcept>,
/// Who authored the content
#[serde(default, skip_serializing_if = "Vec::is_empty")]
pub author: Vec<types::ContactDetail>,
/// Who edited the content
#[serde(default, skip_serializing_if = "Vec::is_empty")]
pub editor: Vec<types::ContactDetail>,
/// Who reviewed the content
#[serde(default, skip_serializing_if = "Vec::is_empty")]
pub reviewer: Vec<types::ContactDetail>,
/// Who endorsed the content
#[serde(default, skip_serializing_if = "Vec::is_empty")]
pub endorser: Vec<types::ContactDetail>,
/// Additional documentation, citations, etc
#[serde(default, skip_serializing_if = "Vec::is_empty")]
pub related_artifact: Vec<types::RelatedArtifact>,
/// The condition(s) that define "when" the event occurs; if more than one trigger is present, they are combined with 'or' semantics
pub trigger: vec1::Vec1<types::TriggerDefinition>,
}
/// The `EventDefinition.subject[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 EventDefinitionSubject {
/// `subjectCodeableConcept` variant.
#[fhir("subjectCodeableConcept")]
CodeableConcept(Box<types::CodeableConcept>),
/// `subjectReference` variant.
#[fhir("subjectReference")]
Reference(Box<types::Reference>),
}
/// The `EventDefinition.versionAlgorithm[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 EventDefinitionVersionAlgorithm {
/// `versionAlgorithmString` variant.
#[fhir("versionAlgorithmString")]
String(crate::r5::choice::Primitive<types::String>),
/// `versionAlgorithmCoding` variant.
#[fhir("versionAlgorithmCoding")]
Coding(Box<types::Coding>),
}