001package org.hl7.fhir.r4.model.codesystems; 002 003/*- 004 * #%L 005 * org.hl7.fhir.r4 006 * %% 007 * Copyright (C) 2014 - 2019 Health Level 7 008 * %% 009 * Licensed under the Apache License, Version 2.0 (the "License"); 010 * you may not use this file except in compliance with the License. 011 * You may obtain a copy of the License at 012 * 013 * http://www.apache.org/licenses/LICENSE-2.0 014 * 015 * Unless required by applicable law or agreed to in writing, software 016 * distributed under the License is distributed on an "AS IS" BASIS, 017 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 018 * See the License for the specific language governing permissions and 019 * limitations under the License. 020 * #L% 021 */ 022 023 024/* 025 Copyright (c) 2011+, HL7, Inc. 026 All rights reserved. 027 028 Redistribution and use in source and binary forms, with or without modification, 029 are permitted provided that the following conditions are met: 030 031 * Redistributions of source code must retain the above copyright notice, this 032 list of conditions and the following disclaimer. 033 * Redistributions in binary form must reproduce the above copyright notice, 034 this list of conditions and the following disclaimer in the documentation 035 and/or other materials provided with the distribution. 036 * Neither the name of HL7 nor the names of its contributors may be used to 037 endorse or promote products derived from this software without specific 038 prior written permission. 039 040 THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND 041 ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED 042 WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. 043 IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, 044 INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT 045 NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR 046 PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, 047 WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) 048 ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE 049 POSSIBILITY OF SUCH DAMAGE. 050 051*/ 052 053// Generated on Wed, Jan 30, 2019 16:19-0500 for FHIR v4.0.0 054 055 056import org.hl7.fhir.exceptions.FHIRException; 057 058public enum V3ActMood { 059 060 /** 061 * These are moods describing activities as they progress in the business cycle, from defined, through planned and ordered to completed. 062 */ 063 _ACTMOODCOMPLETIONTRACK, 064 /** 065 * Definition: A possible act. 066 */ 067 _ACTMOODPOTENTIAL, 068 /** 069 * Definition: A definition of a kind of act that can occur . 070 071 072 OpenIssue: The semantic constructs embodied in DEF and CRT moods seem indistinguishable, and their uses can readily be determined by the context in which these are used. Therefore, this OpenIssue has been created to declare that it is likely that ActMood.DEF will be "retired" in the future in favor of the more general ActMood.CRT. 073 */ 074 DEF, 075 /** 076 * Definition: A kind of act that defines a permission that has been granted. 077 */ 078 PERM, 079 /** 080 * Definition: A kind of act that may occur during the specified time period. 081 */ 082 SLOT, 083 /** 084 * Definition: An act that actually happens (may be an ongoing act or a documentation of a past act). 085 */ 086 EVN, 087 /** 088 * Definition: An intention or plan for an act. 089 090 091 >UsageNotes: The final outcome of the intent, the act that is intended to occur, is always an event. However the final outcome may be reached indirectly via steps through other intents, such as promise, permission request, or an appointment that may lead to an actual event to occur. Alternatively, the intended act may never occur. 092 */ 093 INT, 094 /** 095 * Definition: A desire to have an act occur. 096 */ 097 _ACTMOODDESIRE, 098 /** 099 * Definition: A request (or order) for an act that is part of a defined request/fulfillment cycle. 100 101 102 UsageNotes: Use of an HL7 defined request/fulfillment framework is not required to use this mood code. 103 */ 104 _ACTMOODACTREQUEST, 105 /** 106 * Definition: A request act that is specialized for the appointment scheduling request/fulfillment cycle. An appointment request is fulfilled only and completely by an appointment (APT), i.e., all that the appointment request intends is to create an appointment (the actual act may well not happen if that is the professional decision during the appointment). 107 */ 108 ARQ, 109 /** 110 * Definition: A request for a permission to perform the act. Typically a payer (or possibly a supervisor) is being requested to give permission to perform the act. As opposed to the RQO, the requestee is not asked to perform or cause to perform the act but only to give the permission. 111 */ 112 PERMRQ, 113 /** 114 * Definition: A request act that is specialized for an event request/fulfillment cycle. 115 116 117 UsageNotes: The fulfillment cycle may involve intermediary fulfilling acts in moods such as PRMS, APT, or even another RQO before being fulfilled by the final event. 118 119 120 UsageNotes: The concepts of a "request" and an "order" are viewed as different, because there is an implication of a mandate associated with order. In practice, however, this distinction has no general functional value in the inter-operation of health care computing. "Orders" are commonly refused for a variety of clinical and business reasons, and the notion of a "request" obligates the recipient (the fulfiller) to respond to the sender (the author). Indeed, in many regions, including Australia and Europe, the common term used is "request." 121 122 Thus, the concept embodies both notions, as there is no useful distinction to be made. If a mandate is to be associated with a request, this will be embodied in the "local" business rules applied to the transactions. Should HL7 desire to provide a distinction between these in the future, the individual concepts could be added as specializations of this concept. 123 124 The critical distinction here, is the difference between this concept and an "intent", of which it is a specialization. An intent involves decisions by a single party, the author. A request, however, involves decisions by two parties, the author and the fulfiller, with an obligation on the part of the fulfiller to respond to the request indicating that the fulfiller will indeed fulfill the request. 125 */ 126 RQO, 127 /** 128 * Definition: A suggestion that an act might be performed. Not an explicit request, and professional responsibility may or may not be present. 129 */ 130 PRP, 131 /** 132 * Definition: A suggestion that an act should be performed with an acceptance of some degree of professional responsibility for the resulting act. Not an explicit request. . 133 134 135 UsageNotes: Where there is no clear definition or applicable concept of "professional responsibility�, RMD becomes indistinguishable from PRP. . 136 */ 137 RMD, 138 /** 139 * Definition: A commitment to perform an act (may be either solicited or unsolicited). The committer becomes responsible to the other party for executing the act, and, as a consequence, the other party may rely on the first party to perform or cause to perform the act. 140 141 142 UsageNotes: Commitments may be retracted or cancelled. 143 */ 144 PRMS, 145 /** 146 * Definition: An act that has been scheduled to be performed at a specific place and time. 147 */ 148 APT, 149 /** 150 * Definition: An act that expresses condition statements for other acts. 151 */ 152 _ACTMOODPREDICATE, 153 /** 154 * Deprecation Comment: 155 This concept This codes should no longer be used. Instead, set attribute Act.isCriterionInd to "true" and use the desired mood for your criterion. 156 157 158 Definition: A condition that must be true for the source act to be considered. 159 */ 160 CRT, 161 /** 162 * Deprecation Comment: 163 This concept This codes should no longer be used. Instead, set attribute Act.isCriterionInd to "true" and use the desired mood for your criterion. 164 165 166 Definition: A criterion (CRT) that has_match = an event (EVN). 167 */ 168 EVN_CRT, 169 /** 170 * A criterion expressed over goals (ActMood.GOL). 171 */ 172 GOL_CRT, 173 /** 174 * A criterion expressed over intents (ActMood.INT). 175 */ 176 INT_CRT, 177 /** 178 * A criterion expressed over promises (ActMood.PRMS). 179 */ 180 PRMS_CRT, 181 /** 182 * A criterion expressed over requests or orders (ActMood.RQO). 183 */ 184 RQO_CRT, 185 /** 186 * A criterion expressed over risks (ActMood.RSK). 187 */ 188 RSK_CRT, 189 /** 190 * Definition: An act that is considered to have some noteworthy likelihood of occurring in the future (has_match = event). 191 192 193 Examples:Prognosis of a condition, Expected date of discharge from hospital, patient will likely need an emergency decompression of the intracranial pressure by morning. 194 195 196 UsageNotes:INT (intent) reflects a plan for the future, which is a declaration to do something. This contrasts with expectation, which is a prediction that something will happen in the future. GOL (goal) reflects a hope rather than a prediction. RSK (risk) reflects a potential negative event that may or may not be expected to happen. 197 */ 198 EXPEC, 199 /** 200 * Definition: An expectation that is considered to be desirable to occur in the future 201 202 203 Examples:Target weight below 80Kg, Stop smoking, Regain ability to walk, goal is to administer thrombolytics to candidate patients presenting with acute myocardial infarction. 204 205 206 UsageNotes: INT (intent) reflects a plan for the future, which is a declaration to do something. This contrasts with goal which doesn't represent an intention to act, merely a hope for an eventual result. A goal is distinct from the intended actions to reach that goal. "I will reduce the dose of drug x to 20mg" is an intent. "I hope to be able to get the patient to the point where I can reduce the dose of drug x to 20mg" is a goal. EXPEC (expectation) reflects a prediction rather than a hope. RSK (risk) reflects a potential negative event rather than a hope. 207 */ 208 GOL, 209 /** 210 * Definition:An act that may occur in the future and which is regarded as undesirable 211 212 213 Examples:Increased risk of DVT, at risk for sub-acute bacterial endocarditis. 214 215 216 UsageNotes:Note: An observation in RSK mood expresses the undesirable act, and not the underlying risk factor. A risk factor that is present (e.g. obesity, smoking, etc) should be expressed in event mood. INT (intent) reflects a plan for the future, which is a declaration to do something. This contrasts with RSK (risk), which is the potential that something negative will occur that may or may not ever happen. GOL (goal) reflects a hope to achieve something. EXPEC (expectation) is the prediction of a positive or negative event. This contrasts with RSK (risk), which is the potential that something negative will occur that may or may not ever happen, and may not be expected to happen. 217 */ 218 RSK, 219 /** 220 * Definition: One of a set of acts that specify an option for the property values that the parent act may have. Typically used in definitions or orders to describe alternatives. An option can only be used as a group, that is, all assigned values must be used together. The actual mood of the act is the same as the parent act, and they must be linked by an actrelationship with type = OPTN. 221 */ 222 OPT, 223 /** 224 * added to help the parsers 225 */ 226 NULL; 227 public static V3ActMood fromCode(String codeString) throws FHIRException { 228 if (codeString == null || "".equals(codeString)) 229 return null; 230 if ("_ActMoodCompletionTrack".equals(codeString)) 231 return _ACTMOODCOMPLETIONTRACK; 232 if ("_ActMoodPotential".equals(codeString)) 233 return _ACTMOODPOTENTIAL; 234 if ("DEF".equals(codeString)) 235 return DEF; 236 if ("PERM".equals(codeString)) 237 return PERM; 238 if ("SLOT".equals(codeString)) 239 return SLOT; 240 if ("EVN".equals(codeString)) 241 return EVN; 242 if ("INT".equals(codeString)) 243 return INT; 244 if ("_ActMoodDesire".equals(codeString)) 245 return _ACTMOODDESIRE; 246 if ("_ActMoodActRequest".equals(codeString)) 247 return _ACTMOODACTREQUEST; 248 if ("ARQ".equals(codeString)) 249 return ARQ; 250 if ("PERMRQ".equals(codeString)) 251 return PERMRQ; 252 if ("RQO".equals(codeString)) 253 return RQO; 254 if ("PRP".equals(codeString)) 255 return PRP; 256 if ("RMD".equals(codeString)) 257 return RMD; 258 if ("PRMS".equals(codeString)) 259 return PRMS; 260 if ("APT".equals(codeString)) 261 return APT; 262 if ("_ActMoodPredicate".equals(codeString)) 263 return _ACTMOODPREDICATE; 264 if ("CRT".equals(codeString)) 265 return CRT; 266 if ("EVN.CRT".equals(codeString)) 267 return EVN_CRT; 268 if ("GOL.CRT".equals(codeString)) 269 return GOL_CRT; 270 if ("INT.CRT".equals(codeString)) 271 return INT_CRT; 272 if ("PRMS.CRT".equals(codeString)) 273 return PRMS_CRT; 274 if ("RQO.CRT".equals(codeString)) 275 return RQO_CRT; 276 if ("RSK.CRT".equals(codeString)) 277 return RSK_CRT; 278 if ("EXPEC".equals(codeString)) 279 return EXPEC; 280 if ("GOL".equals(codeString)) 281 return GOL; 282 if ("RSK".equals(codeString)) 283 return RSK; 284 if ("OPT".equals(codeString)) 285 return OPT; 286 throw new FHIRException("Unknown V3ActMood code '"+codeString+"'"); 287 } 288 public String toCode() { 289 switch (this) { 290 case _ACTMOODCOMPLETIONTRACK: return "_ActMoodCompletionTrack"; 291 case _ACTMOODPOTENTIAL: return "_ActMoodPotential"; 292 case DEF: return "DEF"; 293 case PERM: return "PERM"; 294 case SLOT: return "SLOT"; 295 case EVN: return "EVN"; 296 case INT: return "INT"; 297 case _ACTMOODDESIRE: return "_ActMoodDesire"; 298 case _ACTMOODACTREQUEST: return "_ActMoodActRequest"; 299 case ARQ: return "ARQ"; 300 case PERMRQ: return "PERMRQ"; 301 case RQO: return "RQO"; 302 case PRP: return "PRP"; 303 case RMD: return "RMD"; 304 case PRMS: return "PRMS"; 305 case APT: return "APT"; 306 case _ACTMOODPREDICATE: return "_ActMoodPredicate"; 307 case CRT: return "CRT"; 308 case EVN_CRT: return "EVN.CRT"; 309 case GOL_CRT: return "GOL.CRT"; 310 case INT_CRT: return "INT.CRT"; 311 case PRMS_CRT: return "PRMS.CRT"; 312 case RQO_CRT: return "RQO.CRT"; 313 case RSK_CRT: return "RSK.CRT"; 314 case EXPEC: return "EXPEC"; 315 case GOL: return "GOL"; 316 case RSK: return "RSK"; 317 case OPT: return "OPT"; 318 default: return "?"; 319 } 320 } 321 public String getSystem() { 322 return "http://terminology.hl7.org/CodeSystem/v3-ActMood"; 323 } 324 public String getDefinition() { 325 switch (this) { 326 case _ACTMOODCOMPLETIONTRACK: return "These are moods describing activities as they progress in the business cycle, from defined, through planned and ordered to completed."; 327 case _ACTMOODPOTENTIAL: return "Definition: A possible act."; 328 case DEF: return "Definition: A definition of a kind of act that can occur .\r\n\n \n OpenIssue: The semantic constructs embodied in DEF and CRT moods seem indistinguishable, and their uses can readily be determined by the context in which these are used. Therefore, this OpenIssue has been created to declare that it is likely that ActMood.DEF will be \"retired\" in the future in favor of the more general ActMood.CRT."; 329 case PERM: return "Definition: A kind of act that defines a permission that has been granted."; 330 case SLOT: return "Definition: A kind of act that may occur during the specified time period."; 331 case EVN: return "Definition: An act that actually happens (may be an ongoing act or a documentation of a past act)."; 332 case INT: return "Definition: An intention or plan for an act. \r\n\n \n >UsageNotes: The final outcome of the intent, the act that is intended to occur, is always an event. However the final outcome may be reached indirectly via steps through other intents, such as promise, permission request, or an appointment that may lead to an actual event to occur. Alternatively, the intended act may never occur."; 333 case _ACTMOODDESIRE: return "Definition: A desire to have an act occur."; 334 case _ACTMOODACTREQUEST: return "Definition: A request (or order) for an act that is part of a defined request/fulfillment cycle.\r\n\n \n UsageNotes: Use of an HL7 defined request/fulfillment framework is not required to use this mood code."; 335 case ARQ: return "Definition: A request act that is specialized for the appointment scheduling request/fulfillment cycle. An appointment request is fulfilled only and completely by an appointment (APT), i.e., all that the appointment request intends is to create an appointment (the actual act may well not happen if that is the professional decision during the appointment)."; 336 case PERMRQ: return "Definition: A request for a permission to perform the act. Typically a payer (or possibly a supervisor) is being requested to give permission to perform the act. As opposed to the RQO, the requestee is not asked to perform or cause to perform the act but only to give the permission."; 337 case RQO: return "Definition: A request act that is specialized for an event request/fulfillment cycle. \r\n\n \n UsageNotes: The fulfillment cycle may involve intermediary fulfilling acts in moods such as PRMS, APT, or even another RQO before being fulfilled by the final event. \r\n\n \n UsageNotes: The concepts of a \"request\" and an \"order\" are viewed as different, because there is an implication of a mandate associated with order. In practice, however, this distinction has no general functional value in the inter-operation of health care computing. \"Orders\" are commonly refused for a variety of clinical and business reasons, and the notion of a \"request\" obligates the recipient (the fulfiller) to respond to the sender (the author). Indeed, in many regions, including Australia and Europe, the common term used is \"request.\"\r\n\n Thus, the concept embodies both notions, as there is no useful distinction to be made. If a mandate is to be associated with a request, this will be embodied in the \"local\" business rules applied to the transactions. Should HL7 desire to provide a distinction between these in the future, the individual concepts could be added as specializations of this concept.\r\n\n The critical distinction here, is the difference between this concept and an \"intent\", of which it is a specialization. An intent involves decisions by a single party, the author. A request, however, involves decisions by two parties, the author and the fulfiller, with an obligation on the part of the fulfiller to respond to the request indicating that the fulfiller will indeed fulfill the request."; 338 case PRP: return "Definition: A suggestion that an act might be performed. Not an explicit request, and professional responsibility may or may not be present."; 339 case RMD: return "Definition: A suggestion that an act should be performed with an acceptance of some degree of professional responsibility for the resulting act. Not an explicit request. .\r\n\n \n UsageNotes: Where there is no clear definition or applicable concept of \"professional responsibility�, RMD becomes indistinguishable from PRP. ."; 340 case PRMS: return "Definition: A commitment to perform an act (may be either solicited or unsolicited). The committer becomes responsible to the other party for executing the act, and, as a consequence, the other party may rely on the first party to perform or cause to perform the act.\r\n\n \n UsageNotes: Commitments may be retracted or cancelled."; 341 case APT: return "Definition: An act that has been scheduled to be performed at a specific place and time."; 342 case _ACTMOODPREDICATE: return "Definition: An act that expresses condition statements for other acts."; 343 case CRT: return "Deprecation Comment: \n This concept This codes should no longer be used. Instead, set attribute Act.isCriterionInd to \"true\" and use the desired mood for your criterion.\r\n\n \n Definition: A condition that must be true for the source act to be considered."; 344 case EVN_CRT: return "Deprecation Comment: \n This concept This codes should no longer be used. Instead, set attribute Act.isCriterionInd to \"true\" and use the desired mood for your criterion.\r\n\n \n Definition: A criterion (CRT) that has_match = an event (EVN)."; 345 case GOL_CRT: return "A criterion expressed over goals (ActMood.GOL)."; 346 case INT_CRT: return "A criterion expressed over intents (ActMood.INT)."; 347 case PRMS_CRT: return "A criterion expressed over promises (ActMood.PRMS)."; 348 case RQO_CRT: return "A criterion expressed over requests or orders (ActMood.RQO)."; 349 case RSK_CRT: return "A criterion expressed over risks (ActMood.RSK)."; 350 case EXPEC: return "Definition: An act that is considered to have some noteworthy likelihood of occurring in the future (has_match = event).\r\n\n \n Examples:Prognosis of a condition, Expected date of discharge from hospital, patient will likely need an emergency decompression of the intracranial pressure by morning.\r\n\n \n UsageNotes:INT (intent) reflects a plan for the future, which is a declaration to do something. This contrasts with expectation, which is a prediction that something will happen in the future. GOL (goal) reflects a hope rather than a prediction. RSK (risk) reflects a potential negative event that may or may not be expected to happen."; 351 case GOL: return "Definition: An expectation that is considered to be desirable to occur in the future \r\n\n \n Examples:Target weight below 80Kg, Stop smoking, Regain ability to walk, goal is to administer thrombolytics to candidate patients presenting with acute myocardial infarction.\r\n\n \n UsageNotes: INT (intent) reflects a plan for the future, which is a declaration to do something. This contrasts with goal which doesn't represent an intention to act, merely a hope for an eventual result. A goal is distinct from the intended actions to reach that goal. \"I will reduce the dose of drug x to 20mg\" is an intent. \"I hope to be able to get the patient to the point where I can reduce the dose of drug x to 20mg\" is a goal. EXPEC (expectation) reflects a prediction rather than a hope. RSK (risk) reflects a potential negative event rather than a hope."; 352 case RSK: return "Definition:An act that may occur in the future and which is regarded as undesirable \r\n\n \n Examples:Increased risk of DVT, at risk for sub-acute bacterial endocarditis.\r\n\n \n UsageNotes:Note: An observation in RSK mood expresses the undesirable act, and not the underlying risk factor. A risk factor that is present (e.g. obesity, smoking, etc) should be expressed in event mood. INT (intent) reflects a plan for the future, which is a declaration to do something. This contrasts with RSK (risk), which is the potential that something negative will occur that may or may not ever happen. GOL (goal) reflects a hope to achieve something. EXPEC (expectation) is the prediction of a positive or negative event. This contrasts with RSK (risk), which is the potential that something negative will occur that may or may not ever happen, and may not be expected to happen."; 353 case OPT: return "Definition: One of a set of acts that specify an option for the property values that the parent act may have. Typically used in definitions or orders to describe alternatives. An option can only be used as a group, that is, all assigned values must be used together. The actual mood of the act is the same as the parent act, and they must be linked by an actrelationship with type = OPTN."; 354 default: return "?"; 355 } 356 } 357 public String getDisplay() { 358 switch (this) { 359 case _ACTMOODCOMPLETIONTRACK: return "ActMoodCompletionTrack"; 360 case _ACTMOODPOTENTIAL: return "potential"; 361 case DEF: return "definition"; 362 case PERM: return "permission"; 363 case SLOT: return "resource slot"; 364 case EVN: return "event (occurrence)"; 365 case INT: return "intent"; 366 case _ACTMOODDESIRE: return "desire"; 367 case _ACTMOODACTREQUEST: return "act request"; 368 case ARQ: return "appointment request"; 369 case PERMRQ: return "permission request"; 370 case RQO: return "request"; 371 case PRP: return "proposal"; 372 case RMD: return "recommendation"; 373 case PRMS: return "promise"; 374 case APT: return "appointment"; 375 case _ACTMOODPREDICATE: return "ActMoodPredicate"; 376 case CRT: return "criterion"; 377 case EVN_CRT: return "event criterion"; 378 case GOL_CRT: return "goal criterion"; 379 case INT_CRT: return "intent criterion"; 380 case PRMS_CRT: return "promise criterion"; 381 case RQO_CRT: return "request criterion"; 382 case RSK_CRT: return "risk criterion"; 383 case EXPEC: return "expectation"; 384 case GOL: return "Goal"; 385 case RSK: return "risk"; 386 case OPT: return "option"; 387 default: return "?"; 388 } 389 } 390 391 392} 393