1#[doc = "The intended subjects for the ResearchElementDefinition. If this element is not provided, a Patient subject is assumed, but the subject of the ResearchElementDefinition can be anything."]
3#[derive(Default, Debug, Clone, PartialEq)]
4pub enum ResearchElementDefinitionSubject {
5 CodeableConcept(Box<super::super::types::CodeableConcept>),
6 Reference(Box<super::super::types::Reference>),
7 #[default]
8 Invalid,
9}
10#[doc = "Define members of the research element using Codes (such as condition, medication, or observation), Expressions ( using an expression language such as FHIRPath or CQL) or DataRequirements (such as Diabetes diagnosis onset in the last year)."]
11#[derive(Default, Debug, Clone, PartialEq)]
12pub enum ResearchElementDefinitionCharacteristicDefinition {
13 CodeableConcept(Box<super::super::types::CodeableConcept>),
14 Canonical(super::super::types::Canonical),
15 Expression(Box<super::super::types::Expression>),
16 DataRequirement(Box<super::super::types::DataRequirement>),
17 #[default]
18 Invalid,
19}
20#[doc = "Indicates what effective period the study covers."]
21#[derive(Default, Debug, Clone, PartialEq)]
22pub enum ResearchElementDefinitionCharacteristicStudyEffective {
23 DateTime(super::super::types::DateTime),
24 Period(Box<super::super::types::Period>),
25 Duration(Box<super::super::types::Duration>),
26 Timing(Box<super::super::types::Timing>),
27 #[default]
28 Invalid,
29}
30#[doc = "Indicates what effective period the study covers."]
31#[derive(Default, Debug, Clone, PartialEq)]
32pub enum ResearchElementDefinitionCharacteristicParticipantEffective {
33 DateTime(super::super::types::DateTime),
34 Period(Box<super::super::types::Period>),
35 Duration(Box<super::super::types::Duration>),
36 Timing(Box<super::super::types::Timing>),
37 #[default]
38 Invalid,
39}
40#[doc = "A characteristic that defines the members of the research element. Multiple characteristics are applied with \"and\" semantics."]
41#[derive(Debug, Clone, PartialEq)]
42pub struct ResearchElementDefinitionCharacteristic {
43 #[doc = "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces."]
44 pub r#id: Option<std::string::String>,
45 #[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 manageable, 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."]
46 pub r#extension: Vec<super::super::types::Extension>,
47 #[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 manageable, 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)."]
48 pub r#modifier_extension: Vec<super::super::types::Extension>,
49 #[doc = "Define members of the research element using Codes (such as condition, medication, or observation), Expressions ( using an expression language such as FHIRPath or CQL) or DataRequirements (such as Diabetes diagnosis onset in the last year)."]
50 pub r#definition: ResearchElementDefinitionCharacteristicDefinition,
51 #[doc = "Use UsageContext to define the members of the population, such as Age Ranges, Genders, Settings."]
52 pub r#usage_context: Vec<super::super::types::UsageContext>,
53 #[doc = "When true, members with this characteristic are excluded from the element."]
54 pub r#exclude: Option<super::super::types::Boolean>,
55 #[doc = "Specifies the UCUM unit for the outcome."]
56 pub r#unit_of_measure: Option<Box<super::super::types::CodeableConcept>>,
57 #[doc = "A narrative description of the time period the study covers."]
58 pub r#study_effective_description: Option<super::super::types::String>,
59 #[doc = "Indicates what effective period the study covers."]
60 pub r#study_effective: Option<ResearchElementDefinitionCharacteristicStudyEffective>,
61 #[doc = "Indicates duration from the study initiation."]
62 pub r#study_effective_time_from_start: Option<Box<super::super::types::Duration>>,
63 #[doc = "Indicates how elements are aggregated within the study effective period."]
64 pub r#study_effective_group_measure: Option<super::super::types::Code>,
65 #[doc = "A narrative description of the time period the study covers."]
66 pub r#participant_effective_description: Option<super::super::types::String>,
67 #[doc = "Indicates what effective period the study covers."]
68 pub r#participant_effective:
69 Option<ResearchElementDefinitionCharacteristicParticipantEffective>,
70 #[doc = "Indicates duration from the participant's study entry."]
71 pub r#participant_effective_time_from_start: Option<Box<super::super::types::Duration>>,
72 #[doc = "Indicates how elements are aggregated within the study effective period."]
73 pub r#participant_effective_group_measure: Option<super::super::types::Code>,
74}
75#[allow(clippy::derivable_impls)]
76impl Default for ResearchElementDefinitionCharacteristic {
77 fn default() -> Self {
78 Self {
79 r#id: Default::default(),
80 r#extension: Default::default(),
81 r#modifier_extension: Default::default(),
82 r#definition: Default::default(),
83 r#usage_context: Default::default(),
84 r#exclude: Default::default(),
85 r#unit_of_measure: Default::default(),
86 r#study_effective_description: Default::default(),
87 r#study_effective: Default::default(),
88 r#study_effective_time_from_start: Default::default(),
89 r#study_effective_group_measure: Default::default(),
90 r#participant_effective_description: Default::default(),
91 r#participant_effective: Default::default(),
92 r#participant_effective_time_from_start: Default::default(),
93 r#participant_effective_group_measure: Default::default(),
94 }
95 }
96}
97#[doc = "The ResearchElementDefinition resource describes a \"PICO\" element that knowledge (evidence, assertion, recommendation) is about.\n\nNeed to be able to define and reuse the definition of individual elements of a research question."]
98#[derive(Debug, Clone, PartialEq)]
99pub struct ResearchElementDefinition {
100 #[doc = "The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes."]
101 pub r#id: Option<super::super::types::Id>,
102 #[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."]
103 pub r#meta: Option<Box<super::super::types::Meta>>,
104 #[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."]
105 pub r#implicit_rules: Option<super::super::types::Uri>,
106 #[doc = "The base language in which the resource is written."]
107 pub r#language: Option<super::super::types::Code>,
108 #[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."]
109 pub r#text: Option<Box<super::super::types::Narrative>>,
110 #[doc = "These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope."]
111 pub r#contained: Vec<super::super::Resource>,
112 #[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 manageable, 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."]
113 pub r#extension: Vec<super::super::types::Extension>,
114 #[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 manageable, 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)."]
115 pub r#modifier_extension: Vec<super::super::types::Extension>,
116 #[doc = "An absolute URI that is used to identify this research element definition 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 at which an authoritative instance of this research element definition is (or will be) published. This URL can be the target of a canonical reference. It SHALL remain the same when the research element definition is stored on different servers."]
117 pub r#url: Option<super::super::types::Uri>,
118 #[doc = "A formal identifier that is used to identify this research element definition when it is represented in other formats, or referenced in a specification, model, design or an instance."]
119 pub r#identifier: Vec<super::super::types::Identifier>,
120 #[doc = "The identifier that is used to identify this version of the research element definition when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the research element definition 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 can be placed in a lexicographical sequence. To provide a version consistent with the Decision Support Service specification, use the format Major.Minor.Revision (e.g. 1.0.0). For more information on versioning knowledge assets, refer to the Decision Support Service specification. Note that a version is required for non-experimental active artifacts."]
121 pub r#version: Option<super::super::types::String>,
122 #[doc = "A natural language name identifying the research element definition. This name should be usable as an identifier for the module by machine processing applications such as code generation."]
123 pub r#name: Option<super::super::types::String>,
124 #[doc = "A short, descriptive, user-friendly title for the research element definition."]
125 pub r#title: Option<super::super::types::String>,
126 #[doc = "The short title provides an alternate title for use in informal descriptive contexts where the full, formal title is not necessary."]
127 pub r#short_title: Option<super::super::types::String>,
128 #[doc = "An explanatory or alternate title for the ResearchElementDefinition giving additional information about its content."]
129 pub r#subtitle: Option<super::super::types::String>,
130 #[doc = "The status of this research element definition. Enables tracking the life-cycle of the content."]
131 pub r#status: super::super::types::Code,
132 #[doc = "A Boolean value to indicate that this research element definition is authored for testing purposes (or education/evaluation/marketing) and is not intended to be used for genuine usage."]
133 pub r#experimental: Option<super::super::types::Boolean>,
134 #[doc = "The intended subjects for the ResearchElementDefinition. If this element is not provided, a Patient subject is assumed, but the subject of the ResearchElementDefinition can be anything."]
135 pub r#subject: Option<ResearchElementDefinitionSubject>,
136 #[doc = "The date (and optionally time) when the research element definition was published. 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 research element definition changes."]
137 pub r#date: Option<super::super::types::DateTime>,
138 #[doc = "The name of the organization or individual that published the research element definition."]
139 pub r#publisher: Option<super::super::types::String>,
140 #[doc = "Contact details to assist a user in finding and communicating with the publisher."]
141 pub r#contact: Vec<super::super::types::ContactDetail>,
142 #[doc = "A free text natural language description of the research element definition from a consumer's perspective."]
143 pub r#description: Option<super::super::types::Markdown>,
144 #[doc = "A human-readable string to clarify or explain concepts about the resource."]
145 pub r#comment: Vec<super::super::types::String>,
146 #[doc = "The content was developed with a focus and intent of supporting the contexts that are listed. These contexts may be general categories (gender, age, ...) or may be references to specific programs (insurance plans, studies, ...) and may be used to assist with indexing and searching for appropriate research element definition instances."]
147 pub r#use_context: Vec<super::super::types::UsageContext>,
148 #[doc = "A legal or geographic region in which the research element definition is intended to be used."]
149 pub r#jurisdiction: Vec<super::super::types::CodeableConcept>,
150 #[doc = "Explanation of why this research element definition is needed and why it has been designed as it has."]
151 pub r#purpose: Option<super::super::types::Markdown>,
152 #[doc = "A detailed description, from a clinical perspective, of how the ResearchElementDefinition is used."]
153 pub r#usage: Option<super::super::types::String>,
154 #[doc = "A copyright statement relating to the research element definition and/or its contents. Copyright statements are generally legal restrictions on the use and publishing of the research element definition."]
155 pub r#copyright: Option<super::super::types::Markdown>,
156 #[doc = "The date on which the resource content was approved by the publisher. Approval happens once when the content is officially approved for usage."]
157 pub r#approval_date: Option<super::super::types::Date>,
158 #[doc = "The date on which the resource content was last reviewed. Review happens periodically after approval but does not change the original approval date."]
159 pub r#last_review_date: Option<super::super::types::Date>,
160 #[doc = "The period during which the research element definition content was or is planned to be in active use."]
161 pub r#effective_period: Option<Box<super::super::types::Period>>,
162 #[doc = "Descriptive topics related to the content of the ResearchElementDefinition. Topics provide a high-level categorization grouping types of ResearchElementDefinitions that can be useful for filtering and searching."]
163 pub r#topic: Vec<super::super::types::CodeableConcept>,
164 #[doc = "An individiual or organization primarily involved in the creation and maintenance of the content."]
165 pub r#author: Vec<super::super::types::ContactDetail>,
166 #[doc = "An individual or organization primarily responsible for internal coherence of the content."]
167 pub r#editor: Vec<super::super::types::ContactDetail>,
168 #[doc = "An individual or organization primarily responsible for review of some aspect of the content."]
169 pub r#reviewer: Vec<super::super::types::ContactDetail>,
170 #[doc = "An individual or organization responsible for officially endorsing the content for use in some setting."]
171 pub r#endorser: Vec<super::super::types::ContactDetail>,
172 #[doc = "Related artifacts such as additional documentation, justification, or bibliographic references."]
173 pub r#related_artifact: Vec<super::super::types::RelatedArtifact>,
174 #[doc = "A reference to a Library resource containing the formal logic used by the ResearchElementDefinition."]
175 pub r#library: Vec<super::super::types::Canonical>,
176 #[doc = "The type of research element, a population, an exposure, or an outcome."]
177 pub r#type: super::super::types::Code,
178 #[doc = "The type of the outcome (e.g. Dichotomous, Continuous, or Descriptive)."]
179 pub r#variable_type: Option<super::super::types::Code>,
180 #[doc = "A characteristic that defines the members of the research element. Multiple characteristics are applied with \"and\" semantics."]
181 pub r#characteristic: Vec<ResearchElementDefinitionCharacteristic>,
182}
183#[allow(clippy::derivable_impls)]
184impl Default for ResearchElementDefinition {
185 fn default() -> Self {
186 Self {
187 r#id: Default::default(),
188 r#meta: Default::default(),
189 r#implicit_rules: Default::default(),
190 r#language: Default::default(),
191 r#text: Default::default(),
192 r#contained: Default::default(),
193 r#extension: Default::default(),
194 r#modifier_extension: Default::default(),
195 r#url: Default::default(),
196 r#identifier: Default::default(),
197 r#version: Default::default(),
198 r#name: Default::default(),
199 r#title: Default::default(),
200 r#short_title: Default::default(),
201 r#subtitle: Default::default(),
202 r#status: super::super::types::Code {
203 id: Some("$invalid".to_string()),
204 ..Default::default()
205 },
206 r#experimental: Default::default(),
207 r#subject: Default::default(),
208 r#date: Default::default(),
209 r#publisher: Default::default(),
210 r#contact: Default::default(),
211 r#description: Default::default(),
212 r#comment: Default::default(),
213 r#use_context: Default::default(),
214 r#jurisdiction: Default::default(),
215 r#purpose: Default::default(),
216 r#usage: Default::default(),
217 r#copyright: Default::default(),
218 r#approval_date: Default::default(),
219 r#last_review_date: Default::default(),
220 r#effective_period: Default::default(),
221 r#topic: Default::default(),
222 r#author: Default::default(),
223 r#editor: Default::default(),
224 r#reviewer: Default::default(),
225 r#endorser: Default::default(),
226 r#related_artifact: Default::default(),
227 r#library: Default::default(),
228 r#type: super::super::types::Code {
229 id: Some("$invalid".to_string()),
230 ..Default::default()
231 },
232 r#variable_type: Default::default(),
233 r#characteristic: Default::default(),
234 }
235 }
236}