1#[doc = "Indicates the mechanism used to compare versions to determine which is more current."]
3#[derive(Default, Debug, Clone, PartialEq)]
4pub enum SubscriptionTopicVersionAlgorithm {
5 String(super::super::types::String),
6 Coding(Box<super::super::types::Coding>),
7 #[default]
8 Invalid,
9}
10#[doc = "The FHIR query based rules that the server should use to determine when to trigger a notification for this subscription topic."]
11#[derive(Debug, Clone, PartialEq)]
12pub struct SubscriptionTopicResourceTriggerQueryCriteria {
13 #[doc = "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces."]
14 pub r#id: Option<std::string::String>,
15 #[doc = "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension."]
16 pub r#extension: Vec<super::super::types::Extension>,
17 #[doc = "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself)."]
18 pub r#modifier_extension: Vec<super::super::types::Extension>,
19 #[doc = "The FHIR query based rules are applied to the previous resource state (e.g., state before an update)."]
20 pub r#previous: Option<super::super::types::String>,
21 #[doc = "For `create` interactions, should the `previous` criteria count as an automatic pass or an automatic fail. If not present, the testing behavior during `create` interactions is unspecified (server discretion)."]
22 pub r#result_for_create: Option<super::super::types::Code>,
23 #[doc = "The FHIR query based rules are applied to the current resource state (e.g., state after an update)."]
24 pub r#current: Option<super::super::types::String>,
25 #[doc = "For 'delete' interactions, should the 'current' query criteria count as an automatic pass or an automatic fail. If not present, the testing behavior during `delete` interactions is unspecified (server discretion)."]
26 pub r#result_for_delete: Option<super::super::types::Code>,
27 #[doc = "If set to `true`, both the `current` and `previous` query criteria must evaluate `true` to trigger a notification for this topic. If set to `false` or not present, a notification for this topic will be triggered if either the `current` or `previous` tests evaluate to `true`."]
28 pub r#require_both: Option<super::super::types::Boolean>,
29}
30#[allow(clippy::derivable_impls)]
31impl Default for SubscriptionTopicResourceTriggerQueryCriteria {
32 fn default() -> Self {
33 Self {
34 r#id: Default::default(),
35 r#extension: Default::default(),
36 r#modifier_extension: Default::default(),
37 r#previous: Default::default(),
38 r#result_for_create: Default::default(),
39 r#current: Default::default(),
40 r#result_for_delete: Default::default(),
41 r#require_both: Default::default(),
42 }
43 }
44}
45#[doc = "A definition of a resource-based event that triggers a notification based on the SubscriptionTopic. The criteria may be just a human readable description and/or a full FHIR search string or FHIRPath expression. Multiple triggers are considered OR joined (e.g., a resource update matching ANY of the definitions will trigger a notification)."]
46#[derive(Debug, Clone, PartialEq)]
47pub struct SubscriptionTopicResourceTrigger {
48 #[doc = "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces."]
49 pub r#id: Option<std::string::String>,
50 #[doc = "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension."]
51 pub r#extension: Vec<super::super::types::Extension>,
52 #[doc = "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself)."]
53 pub r#modifier_extension: Vec<super::super::types::Extension>,
54 #[doc = "The human readable description of this resource trigger for the SubscriptionTopic - for example, \"An Encounter enters the 'in-progress' state\"."]
55 pub r#description: Option<super::super::types::Markdown>,
56 #[doc = "URL of the Resource that is the type used in this resource trigger. Relative URLs are relative to the StructureDefinition root of the implemented FHIR version (e.g., <http://hl7.org/fhir/StructureDefinition>). For example, \"Patient\" maps to <http://hl7.org/fhir/StructureDefinition/Patient>. For more information, see <a href=\"elementdefinition-definitions.html#ElementDefinition.type.code\">ElementDefinition.type.code</a>."]
57 pub r#resource: super::super::types::Uri,
58 #[doc = "The FHIR RESTful interaction which can be used to trigger a notification for the SubscriptionTopic. Multiple values are considered OR joined (e.g., CREATE or UPDATE). If not present, all supported interactions are assumed."]
59 pub r#supported_interaction: Vec<super::super::types::Code>,
60 #[doc = "The FHIR query based rules that the server should use to determine when to trigger a notification for this subscription topic."]
61 pub r#query_criteria: Option<SubscriptionTopicResourceTriggerQueryCriteria>,
62 #[doc = "The FHIRPath based rules that the server should use to determine when to trigger a notification for this topic."]
63 pub r#fhir_path_criteria: Option<super::super::types::String>,
64}
65#[allow(clippy::derivable_impls)]
66impl Default for SubscriptionTopicResourceTrigger {
67 fn default() -> Self {
68 Self {
69 r#id: Default::default(),
70 r#extension: Default::default(),
71 r#modifier_extension: Default::default(),
72 r#description: Default::default(),
73 r#resource: super::super::types::Uri {
74 id: Some("$invalid".to_string()),
75 ..Default::default()
76 },
77 r#supported_interaction: Default::default(),
78 r#query_criteria: Default::default(),
79 r#fhir_path_criteria: Default::default(),
80 }
81 }
82}
83#[doc = "Event definition which can be used to trigger the SubscriptionTopic."]
84#[derive(Debug, Clone, PartialEq)]
85pub struct SubscriptionTopicEventTrigger {
86 #[doc = "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces."]
87 pub r#id: Option<std::string::String>,
88 #[doc = "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension."]
89 pub r#extension: Vec<super::super::types::Extension>,
90 #[doc = "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself)."]
91 pub r#modifier_extension: Vec<super::super::types::Extension>,
92 #[doc = "The human readable description of an event to trigger a notification for the SubscriptionTopic - for example, \"Patient Admission, as defined in HL7v2 via message ADT^A01\". Multiple values are considered OR joined (e.g., matching any single event listed)."]
93 pub r#description: Option<super::super::types::Markdown>,
94 #[doc = "A well-defined event which can be used to trigger notifications from the SubscriptionTopic."]
95 pub r#event: Box<super::super::types::CodeableConcept>,
96 #[doc = "URL of the Resource that is the focus type used in this event trigger. Relative URLs are relative to the StructureDefinition root of the implemented FHIR version (e.g., <http://hl7.org/fhir/StructureDefinition>). For example, \"Patient\" maps to <http://hl7.org/fhir/StructureDefinition/Patient>. For more information, see <a href=\"elementdefinition-definitions.html#ElementDefinition.type.code\">ElementDefinition.type.code</a>."]
97 pub r#resource: super::super::types::Uri,
98}
99#[allow(clippy::derivable_impls)]
100impl Default for SubscriptionTopicEventTrigger {
101 fn default() -> Self {
102 Self {
103 r#id: Default::default(),
104 r#extension: Default::default(),
105 r#modifier_extension: Default::default(),
106 r#description: Default::default(),
107 r#event: Box::new(super::super::types::CodeableConcept {
108 id: Some("$invalid".to_string()),
109 ..Default::default()
110 }),
111 r#resource: super::super::types::Uri {
112 id: Some("$invalid".to_string()),
113 ..Default::default()
114 },
115 }
116 }
117}
118#[doc = "List of properties by which Subscriptions on the SubscriptionTopic can be filtered. May be defined Search Parameters (e.g., Encounter.patient) or parameters defined within this SubscriptionTopic context (e.g., hub.event)."]
119#[derive(Debug, Clone, PartialEq)]
120pub struct SubscriptionTopicCanFilterBy {
121 #[doc = "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces."]
122 pub r#id: Option<std::string::String>,
123 #[doc = "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension."]
124 pub r#extension: Vec<super::super::types::Extension>,
125 #[doc = "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself)."]
126 pub r#modifier_extension: Vec<super::super::types::Extension>,
127 #[doc = "Description of how this filtering parameter is intended to be used."]
128 pub r#description: Option<super::super::types::Markdown>,
129 #[doc = "URL of the Resource that is the type used in this filter. This is the \"focus\" of the topic (or one of them if there are more than one). It will be the same, a generality, or a specificity of SubscriptionTopic.resourceTrigger.resource or SubscriptionTopic.eventTrigger.resource when they are present."]
130 pub r#resource: Option<super::super::types::Uri>,
131 #[doc = "Either the canonical URL to a search parameter (like \"<http://hl7.org/fhir/SearchParameter/encounter>-patient\") or topic-defined parameter (like \"hub.event\") which is a label for the filter."]
132 pub r#filter_parameter: super::super::types::String,
133 #[doc = "Either the canonical URL to a search parameter (like \"<http://hl7.org/fhir/SearchParameter/encounter>-patient\") or the officially-defined URI for a shared filter concept (like \"<http://example.org/concepts/shared>-common-event\")."]
134 pub r#filter_definition: Option<super::super::types::Uri>,
135 #[doc = "Comparators allowed for the filter parameter."]
136 pub r#comparator: Vec<super::super::types::Code>,
137 #[doc = "Modifiers allowed for the filter parameter."]
138 pub r#modifier: Vec<super::super::types::Code>,
139}
140#[allow(clippy::derivable_impls)]
141impl Default for SubscriptionTopicCanFilterBy {
142 fn default() -> Self {
143 Self {
144 r#id: Default::default(),
145 r#extension: Default::default(),
146 r#modifier_extension: Default::default(),
147 r#description: Default::default(),
148 r#resource: Default::default(),
149 r#filter_parameter: super::super::types::String {
150 id: Some("$invalid".to_string()),
151 ..Default::default()
152 },
153 r#filter_definition: Default::default(),
154 r#comparator: Default::default(),
155 r#modifier: Default::default(),
156 }
157 }
158}
159#[doc = "List of properties to describe the shape (e.g., resources) included in notifications from this Subscription Topic."]
160#[derive(Debug, Clone, PartialEq)]
161pub struct SubscriptionTopicNotificationShape {
162 #[doc = "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces."]
163 pub r#id: Option<std::string::String>,
164 #[doc = "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension."]
165 pub r#extension: Vec<super::super::types::Extension>,
166 #[doc = "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself)."]
167 pub r#modifier_extension: Vec<super::super::types::Extension>,
168 #[doc = "URL of the Resource that is the type used in this shape. This is the 'focus' resource of the topic (or one of them if there are more than one) and the root resource for this shape definition. It will be the same, a generality, or a specificity of SubscriptionTopic.resourceTrigger.resource or SubscriptionTopic.eventTrigger.resource when they are present."]
169 pub r#resource: super::super::types::Uri,
170 #[doc = "Search-style _include directives, rooted in the resource for this shape. Servers SHOULD include resources listed here, if they exist and the user is authorized to receive them. Clients SHOULD be prepared to receive these additional resources, but SHALL function properly without them."]
171 pub r#include: Vec<super::super::types::String>,
172 #[doc = "Search-style _revinclude directives, rooted in the resource for this shape. Servers SHOULD include resources listed here, if they exist and the user is authorized to receive them. Clients SHOULD be prepared to receive these additional resources, but SHALL function properly without them."]
173 pub r#rev_include: Vec<super::super::types::String>,
174}
175#[allow(clippy::derivable_impls)]
176impl Default for SubscriptionTopicNotificationShape {
177 fn default() -> Self {
178 Self {
179 r#id: Default::default(),
180 r#extension: Default::default(),
181 r#modifier_extension: Default::default(),
182 r#resource: super::super::types::Uri {
183 id: Some("$invalid".to_string()),
184 ..Default::default()
185 },
186 r#include: Default::default(),
187 r#rev_include: Default::default(),
188 }
189 }
190}
191#[doc = "Describes a stream of resource state changes identified by trigger criteria and annotated with labels useful to filter projections from this topic."]
192#[derive(Debug, Clone, PartialEq)]
193pub struct SubscriptionTopic {
194 #[doc = "The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes."]
195 pub r#id: Option<super::super::types::Id>,
196 #[doc = "The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource."]
197 pub r#meta: Option<Box<super::super::types::Meta>>,
198 #[doc = "A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc."]
199 pub r#implicit_rules: Option<super::super::types::Uri>,
200 #[doc = "The base language in which the resource is written."]
201 pub r#language: Option<super::super::types::Code>,
202 #[doc = "A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it \"clinically safe\" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety."]
203 pub r#text: Option<Box<super::super::types::Narrative>>,
204 #[doc = "These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, nor can they have their own independent transaction scope. This is allowed to be a Parameters resource if and only if it is referenced by a resource that provides context/meaning."]
205 pub r#contained: Vec<super::super::Resource>,
206 #[doc = "May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension."]
207 pub r#extension: Vec<super::super::types::Extension>,
208 #[doc = "May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself)."]
209 pub r#modifier_extension: Vec<super::super::types::Extension>,
210 #[doc = "An absolute URI that is used to identify this subscription topic when it is referenced in a specification, model, design or an instance; also called its canonical identifier. This SHOULD be globally unique and SHOULD be a literal address at which an authoritative instance of this subscription topic is (or will be) published. This URL can be the target of a canonical reference. It SHALL remain the same when the subscription topic is stored on different servers."]
211 pub r#url: super::super::types::Uri,
212 #[doc = "Business identifiers assigned to this subscription topic by the performer and/or other systems. These identifiers remain constant as the resource is updated and propagates from server to server."]
213 pub r#identifier: Vec<super::super::types::Identifier>,
214 #[doc = "The identifier that is used to identify this version of the subscription topic when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the Topic author and is not expected to be globally unique. For example, it might be a timestamp (e.g. yyyymmdd) if a managed version is not available. There is also no expectation that versions are orderable."]
215 pub r#version: Option<super::super::types::String>,
216 #[doc = "Indicates the mechanism used to compare versions to determine which is more current."]
217 pub r#version_algorithm: Option<SubscriptionTopicVersionAlgorithm>,
218 #[doc = "A natural language name identifying the subscription topic This name should be usable as an identifier for the module by machine processing applications such as code generation."]
219 pub r#name: Option<super::super::types::String>,
220 #[doc = "A short, descriptive, user-friendly title for the subscription topic. For example, \"admission\"."]
221 pub r#title: Option<super::super::types::String>,
222 #[doc = "The canonical URL pointing to another FHIR-defined SubscriptionTopic that is adhered to in whole or in part by this SubscriptionTopic."]
223 pub r#derived_from: Vec<super::super::types::Canonical>,
224 #[doc = "The current state of the SubscriptionTopic."]
225 pub r#status: super::super::types::Code,
226 #[doc = "A flag to indicate that this TopSubscriptionTopicic is authored for testing purposes (or education/evaluation/marketing), and is not intended to be used for genuine usage."]
227 pub r#experimental: Option<super::super::types::Boolean>,
228 #[doc = "The date (and optionally time) when the subscription topic was last significantly changed. The date must change when the business version changes and it must change if the status code changes. In addition, it should change when the substantive content of the subscription topic changes."]
229 pub r#date: Option<super::super::types::DateTime>,
230 #[doc = "Helps establish the \"authority/credibility\" of the SubscriptionTopic. May also allow for contact."]
231 pub r#publisher: Option<super::super::types::String>,
232 #[doc = "Contact details to assist a user in finding and communicating with the publisher."]
233 pub r#contact: Vec<super::super::types::ContactDetail>,
234 #[doc = "A free text natural language description of the Topic from the consumer's perspective."]
235 pub r#description: Option<super::super::types::Markdown>,
236 #[doc = "The content was developed with a focus and intent of supporting the contexts that are listed. These terms may be used to assist with indexing and searching of code system definitions."]
237 pub r#use_context: Vec<super::super::types::UsageContext>,
238 #[doc = "A jurisdiction in which the Topic is intended to be used."]
239 pub r#jurisdiction: Vec<super::super::types::CodeableConcept>,
240 #[doc = "Explains why this Topic is needed and why it has been designed as it has."]
241 pub r#purpose: Option<super::super::types::Markdown>,
242 #[doc = "A copyright statement relating to the SubscriptionTopic and/or its contents. Copyright statements are generally legal restrictions on the use and publishing of the SubscriptionTopic."]
243 pub r#copyright: Option<super::super::types::Markdown>,
244 #[doc = "A short string (<50 characters), suitable for inclusion in a page footer that identifies the copyright holder, effective period, and optionally whether rights are resctricted. (e.g. 'All rights reserved', 'Some rights reserved')."]
245 pub r#copyright_label: Option<super::super::types::String>,
246 #[doc = "The date on which the asset content was approved by the publisher. Approval happens once when the content is officially approved for usage."]
247 pub r#approval_date: Option<super::super::types::Date>,
248 #[doc = "The date on which the asset content was last reviewed. Review happens periodically after that, but doesn't change the original approval date."]
249 pub r#last_review_date: Option<super::super::types::Date>,
250 #[doc = "The period during which the SubscriptionTopic content was or is planned to be effective."]
251 pub r#effective_period: Option<Box<super::super::types::Period>>,
252 #[doc = "A definition of a resource-based event that triggers a notification based on the SubscriptionTopic. The criteria may be just a human readable description and/or a full FHIR search string or FHIRPath expression. Multiple triggers are considered OR joined (e.g., a resource update matching ANY of the definitions will trigger a notification)."]
253 pub r#resource_trigger: Vec<SubscriptionTopicResourceTrigger>,
254 #[doc = "Event definition which can be used to trigger the SubscriptionTopic."]
255 pub r#event_trigger: Vec<SubscriptionTopicEventTrigger>,
256 #[doc = "List of properties by which Subscriptions on the SubscriptionTopic can be filtered. May be defined Search Parameters (e.g., Encounter.patient) or parameters defined within this SubscriptionTopic context (e.g., hub.event)."]
257 pub r#can_filter_by: Vec<SubscriptionTopicCanFilterBy>,
258 #[doc = "List of properties to describe the shape (e.g., resources) included in notifications from this Subscription Topic."]
259 pub r#notification_shape: Vec<SubscriptionTopicNotificationShape>,
260}
261#[allow(clippy::derivable_impls)]
262impl Default for SubscriptionTopic {
263 fn default() -> Self {
264 Self {
265 r#id: Default::default(),
266 r#meta: Default::default(),
267 r#implicit_rules: Default::default(),
268 r#language: Default::default(),
269 r#text: Default::default(),
270 r#contained: Default::default(),
271 r#extension: Default::default(),
272 r#modifier_extension: Default::default(),
273 r#url: super::super::types::Uri {
274 id: Some("$invalid".to_string()),
275 ..Default::default()
276 },
277 r#identifier: Default::default(),
278 r#version: Default::default(),
279 r#version_algorithm: Default::default(),
280 r#name: Default::default(),
281 r#title: Default::default(),
282 r#derived_from: Default::default(),
283 r#status: super::super::types::Code {
284 id: Some("$invalid".to_string()),
285 ..Default::default()
286 },
287 r#experimental: Default::default(),
288 r#date: Default::default(),
289 r#publisher: Default::default(),
290 r#contact: Default::default(),
291 r#description: Default::default(),
292 r#use_context: Default::default(),
293 r#jurisdiction: Default::default(),
294 r#purpose: Default::default(),
295 r#copyright: Default::default(),
296 r#copyright_label: Default::default(),
297 r#approval_date: Default::default(),
298 r#last_review_date: Default::default(),
299 r#effective_period: Default::default(),
300 r#resource_trigger: Default::default(),
301 r#event_trigger: Default::default(),
302 r#can_filter_by: Default::default(),
303 r#notification_shape: Default::default(),
304 }
305 }
306}