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