001package org.hl7.fhir.instance.model.valuesets; 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 Wed, Nov 11, 2015 10:54-0500 for FHIR v1.0.2 033 034 035public enum V3ActMood { 036 037 /** 038 * These are moods describing activities as they progress in the business cycle, from defined, through planned and ordered to completed. 039 */ 040 _ACTMOODCOMPLETIONTRACK, 041 /** 042 * Definition: A possible act. 043 */ 044 _ACTMOODPOTENTIAL, 045 /** 046 * Definition: A definition of a kind of act that can occur . 047 048 049 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. 050 */ 051 DEF, 052 /** 053 * Definition: A kind of act that defines a permission that has been granted. 054 */ 055 PERM, 056 /** 057 * Definition: A kind of act that may occur during the specified time period. 058 */ 059 SLOT, 060 /** 061 * Definition: An act that actually happens (may be an ongoing act or a documentation of a past act). 062 */ 063 EVN, 064 /** 065 * Definition: An intention or plan for an act. 066 067 068 >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. 069 */ 070 INT, 071 /** 072 * Definition: A desire to have an act occur. 073 */ 074 _ACTMOODDESIRE, 075 /** 076 * Definition: A request (or order) for an act that is part of a defined request/fulfillment cycle. 077 078 079 UsageNotes: Use of an HL7 defined request/fulfillment framework is not required to use this mood code. 080 */ 081 _ACTMOODACTREQUEST, 082 /** 083 * 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). 084 */ 085 ARQ, 086 /** 087 * 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. 088 */ 089 PERMRQ, 090 /** 091 * Definition: A request act that is specialized for an event request/fulfillment cycle. 092 093 094 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. 095 096 097 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." 098 099 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. 100 101 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. 102 */ 103 RQO, 104 /** 105 * Definition: A suggestion that an act might be performed. Not an explicit request, and professional responsibility may or may not be present. 106 */ 107 PRP, 108 /** 109 * 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. . 110 111 112 UsageNotes: Where there is no clear definition or applicable concept of "professional responsibility�, RMD becomes indistinguishable from PRP. . 113 */ 114 RMD, 115 /** 116 * 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. 117 118 119 UsageNotes: Commitments may be retracted or cancelled. 120 */ 121 PRMS, 122 /** 123 * Definition: An act that has been scheduled to be performed at a specific place and time. 124 */ 125 APT, 126 /** 127 * Definition: An act that expresses condition statements for other acts. 128 */ 129 _ACTMOODPREDICATE, 130 /** 131 * Deprecation Comment: 132 This concept This codes should no longer be used. Instead, set attribute Act.isCriterionInd to "true" and use the desired mood for your criterion. 133 134 135 Definition: A condition that must be true for the source act to be considered. 136 */ 137 CRT, 138 /** 139 * Deprecation Comment: 140 This concept This codes should no longer be used. Instead, set attribute Act.isCriterionInd to "true" and use the desired mood for your criterion. 141 142 143 Definition: A criterion (CRT) that has_match = an event (EVN). 144 */ 145 EVN_CRT, 146 /** 147 * A criterion expressed over goals (ActMood.GOL). 148 */ 149 GOL_CRT, 150 /** 151 * A criterion expressed over intents (ActMood.INT). 152 */ 153 INT_CRT, 154 /** 155 * A criterion expressed over promises (ActMood.PRMS). 156 */ 157 PRMS_CRT, 158 /** 159 * A criterion expressed over requests or orders (ActMood.RQO). 160 */ 161 RQO_CRT, 162 /** 163 * A criterion expressed over risks (ActMood.RSK). 164 */ 165 RSK_CRT, 166 /** 167 * Definition: An act that is considered to have some noteworthy likelihood of occurring in the future (has_match = event). 168 169 170 Examples:Prognosis of a condition, Expected date of discharge from hospital, patient will likely need an emergency decompression of the intracranial pressure by morning. 171 172 173 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. 174 */ 175 EXPEC, 176 /** 177 * Definition: An expectation that is considered to be desirable to occur in the future 178 179 180 Examples:Target weight below 80Kg, Stop smoking, Regain ability to walk, goal is to administer thrombolytics to candidate patients presenting with acute myocardial infarction. 181 182 183 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. 184 */ 185 GOL, 186 /** 187 * Definition:An act that may occur in the future and which is regarded as undesirable 188 189 190 Examples:Increased risk of DVT, at risk for sub-acute bacterial endocarditis. 191 192 193 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. 194 */ 195 RSK, 196 /** 197 * 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. 198 */ 199 OPT, 200 /** 201 * added to help the parsers 202 */ 203 NULL; 204 public static V3ActMood fromCode(String codeString) throws Exception { 205 if (codeString == null || "".equals(codeString)) 206 return null; 207 if ("_ActMoodCompletionTrack".equals(codeString)) 208 return _ACTMOODCOMPLETIONTRACK; 209 if ("_ActMoodPotential".equals(codeString)) 210 return _ACTMOODPOTENTIAL; 211 if ("DEF".equals(codeString)) 212 return DEF; 213 if ("PERM".equals(codeString)) 214 return PERM; 215 if ("SLOT".equals(codeString)) 216 return SLOT; 217 if ("EVN".equals(codeString)) 218 return EVN; 219 if ("INT".equals(codeString)) 220 return INT; 221 if ("_ActMoodDesire".equals(codeString)) 222 return _ACTMOODDESIRE; 223 if ("_ActMoodActRequest".equals(codeString)) 224 return _ACTMOODACTREQUEST; 225 if ("ARQ".equals(codeString)) 226 return ARQ; 227 if ("PERMRQ".equals(codeString)) 228 return PERMRQ; 229 if ("RQO".equals(codeString)) 230 return RQO; 231 if ("PRP".equals(codeString)) 232 return PRP; 233 if ("RMD".equals(codeString)) 234 return RMD; 235 if ("PRMS".equals(codeString)) 236 return PRMS; 237 if ("APT".equals(codeString)) 238 return APT; 239 if ("_ActMoodPredicate".equals(codeString)) 240 return _ACTMOODPREDICATE; 241 if ("CRT".equals(codeString)) 242 return CRT; 243 if ("EVN.CRT".equals(codeString)) 244 return EVN_CRT; 245 if ("GOL.CRT".equals(codeString)) 246 return GOL_CRT; 247 if ("INT.CRT".equals(codeString)) 248 return INT_CRT; 249 if ("PRMS.CRT".equals(codeString)) 250 return PRMS_CRT; 251 if ("RQO.CRT".equals(codeString)) 252 return RQO_CRT; 253 if ("RSK.CRT".equals(codeString)) 254 return RSK_CRT; 255 if ("EXPEC".equals(codeString)) 256 return EXPEC; 257 if ("GOL".equals(codeString)) 258 return GOL; 259 if ("RSK".equals(codeString)) 260 return RSK; 261 if ("OPT".equals(codeString)) 262 return OPT; 263 throw new Exception("Unknown V3ActMood code '"+codeString+"'"); 264 } 265 public String toCode() { 266 switch (this) { 267 case _ACTMOODCOMPLETIONTRACK: return "_ActMoodCompletionTrack"; 268 case _ACTMOODPOTENTIAL: return "_ActMoodPotential"; 269 case DEF: return "DEF"; 270 case PERM: return "PERM"; 271 case SLOT: return "SLOT"; 272 case EVN: return "EVN"; 273 case INT: return "INT"; 274 case _ACTMOODDESIRE: return "_ActMoodDesire"; 275 case _ACTMOODACTREQUEST: return "_ActMoodActRequest"; 276 case ARQ: return "ARQ"; 277 case PERMRQ: return "PERMRQ"; 278 case RQO: return "RQO"; 279 case PRP: return "PRP"; 280 case RMD: return "RMD"; 281 case PRMS: return "PRMS"; 282 case APT: return "APT"; 283 case _ACTMOODPREDICATE: return "_ActMoodPredicate"; 284 case CRT: return "CRT"; 285 case EVN_CRT: return "EVN.CRT"; 286 case GOL_CRT: return "GOL.CRT"; 287 case INT_CRT: return "INT.CRT"; 288 case PRMS_CRT: return "PRMS.CRT"; 289 case RQO_CRT: return "RQO.CRT"; 290 case RSK_CRT: return "RSK.CRT"; 291 case EXPEC: return "EXPEC"; 292 case GOL: return "GOL"; 293 case RSK: return "RSK"; 294 case OPT: return "OPT"; 295 default: return "?"; 296 } 297 } 298 public String getSystem() { 299 return "http://hl7.org/fhir/v3/ActMood"; 300 } 301 public String getDefinition() { 302 switch (this) { 303 case _ACTMOODCOMPLETIONTRACK: return "These are moods describing activities as they progress in the business cycle, from defined, through planned and ordered to completed."; 304 case _ACTMOODPOTENTIAL: return "Definition: A possible act."; 305 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."; 306 case PERM: return "Definition: A kind of act that defines a permission that has been granted."; 307 case SLOT: return "Definition: A kind of act that may occur during the specified time period."; 308 case EVN: return "Definition: An act that actually happens (may be an ongoing act or a documentation of a past act)."; 309 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."; 310 case _ACTMOODDESIRE: return "Definition: A desire to have an act occur."; 311 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."; 312 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)."; 313 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."; 314 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."; 315 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."; 316 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. ."; 317 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."; 318 case APT: return "Definition: An act that has been scheduled to be performed at a specific place and time."; 319 case _ACTMOODPREDICATE: return "Definition: An act that expresses condition statements for other acts."; 320 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."; 321 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)."; 322 case GOL_CRT: return "A criterion expressed over goals (ActMood.GOL)."; 323 case INT_CRT: return "A criterion expressed over intents (ActMood.INT)."; 324 case PRMS_CRT: return "A criterion expressed over promises (ActMood.PRMS)."; 325 case RQO_CRT: return "A criterion expressed over requests or orders (ActMood.RQO)."; 326 case RSK_CRT: return "A criterion expressed over risks (ActMood.RSK)."; 327 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."; 328 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."; 329 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."; 330 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."; 331 default: return "?"; 332 } 333 } 334 public String getDisplay() { 335 switch (this) { 336 case _ACTMOODCOMPLETIONTRACK: return "ActMoodCompletionTrack"; 337 case _ACTMOODPOTENTIAL: return "potential"; 338 case DEF: return "definition"; 339 case PERM: return "permission"; 340 case SLOT: return "resource slot"; 341 case EVN: return "event (occurrence)"; 342 case INT: return "intent"; 343 case _ACTMOODDESIRE: return "desire"; 344 case _ACTMOODACTREQUEST: return "act request"; 345 case ARQ: return "appointment request"; 346 case PERMRQ: return "permission request"; 347 case RQO: return "request"; 348 case PRP: return "proposal"; 349 case RMD: return "recommendation"; 350 case PRMS: return "promise"; 351 case APT: return "appointment"; 352 case _ACTMOODPREDICATE: return "ActMoodPredicate"; 353 case CRT: return "criterion"; 354 case EVN_CRT: return "event criterion"; 355 case GOL_CRT: return "goal criterion"; 356 case INT_CRT: return "intent criterion"; 357 case PRMS_CRT: return "promise criterion"; 358 case RQO_CRT: return "request criterion"; 359 case RSK_CRT: return "risk criterion"; 360 case EXPEC: return "expectation"; 361 case GOL: return "Goal"; 362 case RSK: return "risk"; 363 case OPT: return "option"; 364 default: return "?"; 365 } 366 } 367 368 369} 370