001package org.hl7.fhir.r4.model.codesystems; 002 003/* 004 Copyright (c) 2011+, HL7, Inc. 005 All rights reserved. 006 007 Redistribution and use in source and binary forms, with or without modification, 008 are permitted provided that the following conditions are met: 009 010 * Redistributions of source code must retain the above copyright notice, this 011 list of conditions and the following disclaimer. 012 * Redistributions in binary form must reproduce the above copyright notice, 013 this list of conditions and the following disclaimer in the documentation 014 and/or other materials provided with the distribution. 015 * Neither the name of HL7 nor the names of its contributors may be used to 016 endorse or promote products derived from this software without specific 017 prior written permission. 018 019 THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND 020 ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED 021 WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. 022 IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, 023 INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT 024 NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR 025 PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, 026 WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) 027 ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE 028 POSSIBILITY OF SUCH DAMAGE. 029 030*/ 031 032// Generated on Thu, Sep 13, 2018 09:04-0400 for FHIR v3.5.0 033 034 035import org.hl7.fhir.exceptions.FHIRException; 036 037public enum V3ActMood { 038 039 /** 040 * These are moods describing activities as they progress in the business cycle, from defined, through planned and ordered to completed. 041 */ 042 _ACTMOODCOMPLETIONTRACK, 043 /** 044 * Definition: A possible act. 045 */ 046 _ACTMOODPOTENTIAL, 047 /** 048 * Definition: A definition of a kind of act that can occur . 049 050 051 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. 052 */ 053 DEF, 054 /** 055 * Definition: A kind of act that defines a permission that has been granted. 056 */ 057 PERM, 058 /** 059 * Definition: A kind of act that may occur during the specified time period. 060 */ 061 SLOT, 062 /** 063 * Definition: An act that actually happens (may be an ongoing act or a documentation of a past act). 064 */ 065 EVN, 066 /** 067 * Definition: An intention or plan for an act. 068 069 070 >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. 071 */ 072 INT, 073 /** 074 * Definition: A desire to have an act occur. 075 */ 076 _ACTMOODDESIRE, 077 /** 078 * Definition: A request (or order) for an act that is part of a defined request/fulfillment cycle. 079 080 081 UsageNotes: Use of an HL7 defined request/fulfillment framework is not required to use this mood code. 082 */ 083 _ACTMOODACTREQUEST, 084 /** 085 * 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). 086 */ 087 ARQ, 088 /** 089 * 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. 090 */ 091 PERMRQ, 092 /** 093 * Definition: A request act that is specialized for an event request/fulfillment cycle. 094 095 096 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. 097 098 099 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." 100 101 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. 102 103 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. 104 */ 105 RQO, 106 /** 107 * Definition: A suggestion that an act might be performed. Not an explicit request, and professional responsibility may or may not be present. 108 */ 109 PRP, 110 /** 111 * 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. . 112 113 114 UsageNotes: Where there is no clear definition or applicable concept of "professional responsibility�, RMD becomes indistinguishable from PRP. . 115 */ 116 RMD, 117 /** 118 * 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. 119 120 121 UsageNotes: Commitments may be retracted or cancelled. 122 */ 123 PRMS, 124 /** 125 * Definition: An act that has been scheduled to be performed at a specific place and time. 126 */ 127 APT, 128 /** 129 * Definition: An act that expresses condition statements for other acts. 130 */ 131 _ACTMOODPREDICATE, 132 /** 133 * Deprecation Comment: 134 This concept This codes should no longer be used. Instead, set attribute Act.isCriterionInd to "true" and use the desired mood for your criterion. 135 136 137 Definition: A condition that must be true for the source act to be considered. 138 */ 139 CRT, 140 /** 141 * Deprecation Comment: 142 This concept This codes should no longer be used. Instead, set attribute Act.isCriterionInd to "true" and use the desired mood for your criterion. 143 144 145 Definition: A criterion (CRT) that has_match = an event (EVN). 146 */ 147 EVN_CRT, 148 /** 149 * A criterion expressed over goals (ActMood.GOL). 150 */ 151 GOL_CRT, 152 /** 153 * A criterion expressed over intents (ActMood.INT). 154 */ 155 INT_CRT, 156 /** 157 * A criterion expressed over promises (ActMood.PRMS). 158 */ 159 PRMS_CRT, 160 /** 161 * A criterion expressed over requests or orders (ActMood.RQO). 162 */ 163 RQO_CRT, 164 /** 165 * A criterion expressed over risks (ActMood.RSK). 166 */ 167 RSK_CRT, 168 /** 169 * Definition: An act that is considered to have some noteworthy likelihood of occurring in the future (has_match = event). 170 171 172 Examples:Prognosis of a condition, Expected date of discharge from hospital, patient will likely need an emergency decompression of the intracranial pressure by morning. 173 174 175 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. 176 */ 177 EXPEC, 178 /** 179 * Definition: An expectation that is considered to be desirable to occur in the future 180 181 182 Examples:Target weight below 80Kg, Stop smoking, Regain ability to walk, goal is to administer thrombolytics to candidate patients presenting with acute myocardial infarction. 183 184 185 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. 186 */ 187 GOL, 188 /** 189 * Definition:An act that may occur in the future and which is regarded as undesirable 190 191 192 Examples:Increased risk of DVT, at risk for sub-acute bacterial endocarditis. 193 194 195 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. 196 */ 197 RSK, 198 /** 199 * 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. 200 */ 201 OPT, 202 /** 203 * added to help the parsers 204 */ 205 NULL; 206 public static V3ActMood fromCode(String codeString) throws FHIRException { 207 if (codeString == null || "".equals(codeString)) 208 return null; 209 if ("_ActMoodCompletionTrack".equals(codeString)) 210 return _ACTMOODCOMPLETIONTRACK; 211 if ("_ActMoodPotential".equals(codeString)) 212 return _ACTMOODPOTENTIAL; 213 if ("DEF".equals(codeString)) 214 return DEF; 215 if ("PERM".equals(codeString)) 216 return PERM; 217 if ("SLOT".equals(codeString)) 218 return SLOT; 219 if ("EVN".equals(codeString)) 220 return EVN; 221 if ("INT".equals(codeString)) 222 return INT; 223 if ("_ActMoodDesire".equals(codeString)) 224 return _ACTMOODDESIRE; 225 if ("_ActMoodActRequest".equals(codeString)) 226 return _ACTMOODACTREQUEST; 227 if ("ARQ".equals(codeString)) 228 return ARQ; 229 if ("PERMRQ".equals(codeString)) 230 return PERMRQ; 231 if ("RQO".equals(codeString)) 232 return RQO; 233 if ("PRP".equals(codeString)) 234 return PRP; 235 if ("RMD".equals(codeString)) 236 return RMD; 237 if ("PRMS".equals(codeString)) 238 return PRMS; 239 if ("APT".equals(codeString)) 240 return APT; 241 if ("_ActMoodPredicate".equals(codeString)) 242 return _ACTMOODPREDICATE; 243 if ("CRT".equals(codeString)) 244 return CRT; 245 if ("EVN.CRT".equals(codeString)) 246 return EVN_CRT; 247 if ("GOL.CRT".equals(codeString)) 248 return GOL_CRT; 249 if ("INT.CRT".equals(codeString)) 250 return INT_CRT; 251 if ("PRMS.CRT".equals(codeString)) 252 return PRMS_CRT; 253 if ("RQO.CRT".equals(codeString)) 254 return RQO_CRT; 255 if ("RSK.CRT".equals(codeString)) 256 return RSK_CRT; 257 if ("EXPEC".equals(codeString)) 258 return EXPEC; 259 if ("GOL".equals(codeString)) 260 return GOL; 261 if ("RSK".equals(codeString)) 262 return RSK; 263 if ("OPT".equals(codeString)) 264 return OPT; 265 throw new FHIRException("Unknown V3ActMood code '"+codeString+"'"); 266 } 267 public String toCode() { 268 switch (this) { 269 case _ACTMOODCOMPLETIONTRACK: return "_ActMoodCompletionTrack"; 270 case _ACTMOODPOTENTIAL: return "_ActMoodPotential"; 271 case DEF: return "DEF"; 272 case PERM: return "PERM"; 273 case SLOT: return "SLOT"; 274 case EVN: return "EVN"; 275 case INT: return "INT"; 276 case _ACTMOODDESIRE: return "_ActMoodDesire"; 277 case _ACTMOODACTREQUEST: return "_ActMoodActRequest"; 278 case ARQ: return "ARQ"; 279 case PERMRQ: return "PERMRQ"; 280 case RQO: return "RQO"; 281 case PRP: return "PRP"; 282 case RMD: return "RMD"; 283 case PRMS: return "PRMS"; 284 case APT: return "APT"; 285 case _ACTMOODPREDICATE: return "_ActMoodPredicate"; 286 case CRT: return "CRT"; 287 case EVN_CRT: return "EVN.CRT"; 288 case GOL_CRT: return "GOL.CRT"; 289 case INT_CRT: return "INT.CRT"; 290 case PRMS_CRT: return "PRMS.CRT"; 291 case RQO_CRT: return "RQO.CRT"; 292 case RSK_CRT: return "RSK.CRT"; 293 case EXPEC: return "EXPEC"; 294 case GOL: return "GOL"; 295 case RSK: return "RSK"; 296 case OPT: return "OPT"; 297 default: return "?"; 298 } 299 } 300 public String getSystem() { 301 return "http://terminology.hl7.org/CodeSystem/v3-ActMood"; 302 } 303 public String getDefinition() { 304 switch (this) { 305 case _ACTMOODCOMPLETIONTRACK: return "These are moods describing activities as they progress in the business cycle, from defined, through planned and ordered to completed."; 306 case _ACTMOODPOTENTIAL: return "Definition: A possible act."; 307 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."; 308 case PERM: return "Definition: A kind of act that defines a permission that has been granted."; 309 case SLOT: return "Definition: A kind of act that may occur during the specified time period."; 310 case EVN: return "Definition: An act that actually happens (may be an ongoing act or a documentation of a past act)."; 311 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."; 312 case _ACTMOODDESIRE: return "Definition: A desire to have an act occur."; 313 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."; 314 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)."; 315 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."; 316 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."; 317 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."; 318 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. ."; 319 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."; 320 case APT: return "Definition: An act that has been scheduled to be performed at a specific place and time."; 321 case _ACTMOODPREDICATE: return "Definition: An act that expresses condition statements for other acts."; 322 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."; 323 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)."; 324 case GOL_CRT: return "A criterion expressed over goals (ActMood.GOL)."; 325 case INT_CRT: return "A criterion expressed over intents (ActMood.INT)."; 326 case PRMS_CRT: return "A criterion expressed over promises (ActMood.PRMS)."; 327 case RQO_CRT: return "A criterion expressed over requests or orders (ActMood.RQO)."; 328 case RSK_CRT: return "A criterion expressed over risks (ActMood.RSK)."; 329 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."; 330 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."; 331 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."; 332 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."; 333 default: return "?"; 334 } 335 } 336 public String getDisplay() { 337 switch (this) { 338 case _ACTMOODCOMPLETIONTRACK: return "ActMoodCompletionTrack"; 339 case _ACTMOODPOTENTIAL: return "potential"; 340 case DEF: return "definition"; 341 case PERM: return "permission"; 342 case SLOT: return "resource slot"; 343 case EVN: return "event (occurrence)"; 344 case INT: return "intent"; 345 case _ACTMOODDESIRE: return "desire"; 346 case _ACTMOODACTREQUEST: return "act request"; 347 case ARQ: return "appointment request"; 348 case PERMRQ: return "permission request"; 349 case RQO: return "request"; 350 case PRP: return "proposal"; 351 case RMD: return "recommendation"; 352 case PRMS: return "promise"; 353 case APT: return "appointment"; 354 case _ACTMOODPREDICATE: return "ActMoodPredicate"; 355 case CRT: return "criterion"; 356 case EVN_CRT: return "event criterion"; 357 case GOL_CRT: return "goal criterion"; 358 case INT_CRT: return "intent criterion"; 359 case PRMS_CRT: return "promise criterion"; 360 case RQO_CRT: return "request criterion"; 361 case RSK_CRT: return "risk criterion"; 362 case EXPEC: return "expectation"; 363 case GOL: return "Goal"; 364 case RSK: return "risk"; 365 case OPT: return "option"; 366 default: return "?"; 367 } 368 } 369 370 371} 372