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 V3EntityNamePartQualifierR2 { 036 037 /** 038 * Description:A name part a person acquired. The name part may be acquired by adoption, or the person may have chosen to use the name part for some other reason. 039 040 041 Note: this differs from an Other/Psuedonym/Alias in that an acquired name part is acquired on a formal basis rather than an informal one (e.g. registered as part of the official name). 042 */ 043 AD, 044 /** 045 * Description:The name assumed from the partner in a marital relationship. Usually the spouse's family name. Note that no inference about gender can be made from the existence of spouse names. 046 */ 047 SP, 048 /** 049 * Description:A name that a person was given at birth or established as a consequence of adoption. 050 051 052 Note: This is not used for temporary names assigned at birth such as "Baby of Smith" a" which is just a name with a use code of "TEMP". 053 */ 054 BR, 055 /** 056 * Description:Used to indicate which of the various name parts is used when interacting with the person. 057 */ 058 CL, 059 /** 060 * Description:Indicates that a name part is just an initial. Initials do not imply a trailing period since this would not work with non-Latin scripts. In some languages, initials may consist of more than one letter, e.g. "Ph" could stand for "Philippe" or "Th" For "Thomas". 061 */ 062 IN, 063 /** 064 * Description:For organizations a suffix indicating the legal status, e.g. "Inc.", "Co.", "AG", "GmbH", "B.V." "S.A.", "Ltd." etc. 065 */ 066 LS, 067 /** 068 * Description:Indicates that the name part is a middle name. 069 070 071 Usage Notes: In general, the english "middle name" concept is all of the given names after the first. This qualifier may be used to explicitly indicate which given names are considered to be middle names. The middle name qualifier may also be used with family names. This is a Scandinavian use case, matching the concept of "mellomnavn","mellannamn". Note that there are specific rules that indicate what names may be taken as a mellannamn in different Scandinavian countries. 072 */ 073 MID, 074 /** 075 * Description:A prefix has a strong association to the immediately following name part. A prefix has no implicit trailing white space (it has implicit leading white space though). 076 */ 077 PFX, 078 /** 079 * Description: Medication Name Parts are a means of specifying a range of acceptable "official" forms of the name of a product. They are used as patterns against which input name strings may be matched for automatic identification of products from input text reports. While they cover the concepts held under "doseForm" or "route" or "strength" the name parts are not the same and do not fit into a controlled vocabulary in the same way. By specifying up to 8 name parts a much larger range of possible names can be generated. 080 */ 081 PHARMACEUTICALENTITYNAMEPARTQUALIFIERS, 082 /** 083 * Description: This refers to the container if present in the medicinal product name. 084 085 EXAMPLES: 086 087 088 089 For Optaflu suspension for injection in pre-filled syringe Influenza vaccine (surface antigen, inactivated, prepared in cell culture) (2007/2008 season): pre-filled syringe 090 */ 091 CON, 092 /** 093 * Description: This refers to the qualifiers in the name for devices and is at the moment mainly applicable to insulins and inhalation products. 094 095 EXAMPLES: 096 097 098 099 For the medicinal product Actrapid FlexPen 100 IU/ml Solution for injection Subcutaneous use: FlexPen. 100 */ 101 DEV, 102 /** 103 * Description: This refers to a flavor of the medicinal product if present in the medicinal product name. 104 105 106 Examples: 107 108 109 110 For 'CoughCure Linctus Orange Flavor', the flavor part is "Orange" 111 For 'Wonderdrug Syrup Cherry Flavor', the flavor part is "Cherry" 112 */ 113 FLAV, 114 /** 115 * Description: This refers to the formulation of the medicinal product if present in the medicinal product name. 116 117 118 Examples: 119 120 121 122 For 'SpecialMed Sugar Free Cough Syrup', the formulation name part is "Sugar Free" 123 For 'QuickCure Gluten-free Bulk Fibre', the formulation name part is "gluten-free" 124 */ 125 FORMUL, 126 /** 127 * Description: This refers to the pharmaceutical form/ if present in the medicinal product name. 128 129 EXAMPLES: 130 131 132 133 For Agenerase 50 mg soft capsules: Soft Capsules 134 135 136 137 For Ludiomil 25mg-Filmtabletten: Filmtabletten 138 139 140 141 For Optaflu suspension for injection in pre-filled syringe Influenza vaccine (surface antigen, inactivated, prepared in cell culture) (2007/2008 season): suspension for injection 142 */ 143 FRM, 144 /** 145 * Description: This refers to the product name without the trademark or the name of the marketing authorization holder or any other descriptor reflected in the product name and, if appropriate, whether it is intended e.g. for babies, children or adults. 146 147 EXAMPLES: 148 149 150 151 Agenerase 152 153 154 155 Optaflu 156 157 158 159 Ludiomil 160 */ 161 INV, 162 /** 163 * Description: This refers to the target population for the medicinal product if present in the medicinal product name 164 165 166 Examples: 167 168 169 170 For 'Broncho-Drug 3.5 mg-capsules for children', the target population part is "children" 171 For 'Adult Chesty Cough Syrup', the target population part is "adult" 172 */ 173 POPUL, 174 /** 175 * Description: This refers to the product common or scientific name without the trademark or the name of the marketing authorization holder or any other descriptor reflected in the product name. 176 177 EXAMPLES: 178 179 180 181 For Agenerase: N/A 182 183 184 185 For Optaflu: Influenza vaccine (surface antigen, inactivated, prepared in cell culture) (2007/2008 season) 186 187 188 189 For Ludiomil: N/A 190 */ 191 SCI, 192 /** 193 * Description: This refers to the strength if present in the medicinal product name. The use of decimal points should be accommodated if required. 194 195 EXAMPLES: 196 197 198 199 For Agenerase 50 mg soft capsules: 50mg 200 201 202 203 For Ludiomil 25mg-Filmtabletten: 25 mg 204 205 206 207 For Optaflu suspension for injection in pre-filled syringe Influenza vaccine (surface antigen, inactivated, prepared in cell culture) (2007/2008 season): N/A 208 */ 209 STR, 210 /** 211 * Description: This refers to a time or time period that may be specified in the text of the medicinal product name 212 213 214 Example: 215 216 217 218 For an influenza vaccine 'Drug-FLU season 2008/2009', the time/period part is "2008/2009 season" 219 */ 220 TIME, 221 /** 222 * Description: This refers to trademark/company element if present in the medicinal product name. 223 224 EXAMPLES: 225 226 227 228 for Insulin Human Winthrop Comb 15: Winthrop 229 */ 230 TMK, 231 /** 232 * Description: This refers to the intended use if present in the medicinal product name without the trademark or the name of the marketing authorization holder or any other descriptor reflected in the product name. 233 234 235 236 Examples: 237 238 239 240 For 'Drug-BI Caplets - Heartburn Relief', the intended use part is: "Heartburn Relief" 241 For 'Medicine Honey Syrup for Soothing Coughs' the intended use part is "Soothing Coughs" 242 */ 243 USE, 244 /** 245 * Description:A suffix has a strong association to the immediately preceding name part. A suffix has no implicit leading white space (it has implicit trailing white space though). 246 */ 247 SFX, 248 /** 249 * Description:Extra information about the style of a title 250 */ 251 TITLESTYLES, 252 /** 253 * Description:Indicates that a title like "Dr.", "M.D." or "Ph.D." is an academic title. 254 */ 255 AC, 256 /** 257 * Description:A honorific such as "The Right Honorable" or "Weledelgeleerde Heer". 258 */ 259 HON, 260 /** 261 * Description:A nobility title such as Sir, Count, Grafin. 262 */ 263 NB, 264 /** 265 * Description:Primarily in the British Imperial culture people tend to have an abbreviation of their professional organization as part of their credential titles. 266 */ 267 PR, 268 /** 269 * added to help the parsers 270 */ 271 NULL; 272 public static V3EntityNamePartQualifierR2 fromCode(String codeString) throws Exception { 273 if (codeString == null || "".equals(codeString)) 274 return null; 275 if ("AD".equals(codeString)) 276 return AD; 277 if ("SP".equals(codeString)) 278 return SP; 279 if ("BR".equals(codeString)) 280 return BR; 281 if ("CL".equals(codeString)) 282 return CL; 283 if ("IN".equals(codeString)) 284 return IN; 285 if ("LS".equals(codeString)) 286 return LS; 287 if ("MID".equals(codeString)) 288 return MID; 289 if ("PFX".equals(codeString)) 290 return PFX; 291 if ("PharmaceuticalEntityNamePartQualifiers".equals(codeString)) 292 return PHARMACEUTICALENTITYNAMEPARTQUALIFIERS; 293 if ("CON".equals(codeString)) 294 return CON; 295 if ("DEV".equals(codeString)) 296 return DEV; 297 if ("FLAV".equals(codeString)) 298 return FLAV; 299 if ("FORMUL".equals(codeString)) 300 return FORMUL; 301 if ("FRM".equals(codeString)) 302 return FRM; 303 if ("INV".equals(codeString)) 304 return INV; 305 if ("POPUL".equals(codeString)) 306 return POPUL; 307 if ("SCI".equals(codeString)) 308 return SCI; 309 if ("STR".equals(codeString)) 310 return STR; 311 if ("TIME".equals(codeString)) 312 return TIME; 313 if ("TMK".equals(codeString)) 314 return TMK; 315 if ("USE".equals(codeString)) 316 return USE; 317 if ("SFX".equals(codeString)) 318 return SFX; 319 if ("TitleStyles".equals(codeString)) 320 return TITLESTYLES; 321 if ("AC".equals(codeString)) 322 return AC; 323 if ("HON".equals(codeString)) 324 return HON; 325 if ("NB".equals(codeString)) 326 return NB; 327 if ("PR".equals(codeString)) 328 return PR; 329 throw new Exception("Unknown V3EntityNamePartQualifierR2 code '"+codeString+"'"); 330 } 331 public String toCode() { 332 switch (this) { 333 case AD: return "AD"; 334 case SP: return "SP"; 335 case BR: return "BR"; 336 case CL: return "CL"; 337 case IN: return "IN"; 338 case LS: return "LS"; 339 case MID: return "MID"; 340 case PFX: return "PFX"; 341 case PHARMACEUTICALENTITYNAMEPARTQUALIFIERS: return "PharmaceuticalEntityNamePartQualifiers"; 342 case CON: return "CON"; 343 case DEV: return "DEV"; 344 case FLAV: return "FLAV"; 345 case FORMUL: return "FORMUL"; 346 case FRM: return "FRM"; 347 case INV: return "INV"; 348 case POPUL: return "POPUL"; 349 case SCI: return "SCI"; 350 case STR: return "STR"; 351 case TIME: return "TIME"; 352 case TMK: return "TMK"; 353 case USE: return "USE"; 354 case SFX: return "SFX"; 355 case TITLESTYLES: return "TitleStyles"; 356 case AC: return "AC"; 357 case HON: return "HON"; 358 case NB: return "NB"; 359 case PR: return "PR"; 360 default: return "?"; 361 } 362 } 363 public String getSystem() { 364 return "http://hl7.org/fhir/v3/EntityNamePartQualifierR2"; 365 } 366 public String getDefinition() { 367 switch (this) { 368 case AD: return "Description:A name part a person acquired. The name part may be acquired by adoption, or the person may have chosen to use the name part for some other reason.\r\n\n \n Note: this differs from an Other/Psuedonym/Alias in that an acquired name part is acquired on a formal basis rather than an informal one (e.g. registered as part of the official name)."; 369 case SP: return "Description:The name assumed from the partner in a marital relationship. Usually the spouse's family name. Note that no inference about gender can be made from the existence of spouse names."; 370 case BR: return "Description:A name that a person was given at birth or established as a consequence of adoption. \r\n\n \n Note: This is not used for temporary names assigned at birth such as \"Baby of Smith\" a\" which is just a name with a use code of \"TEMP\"."; 371 case CL: return "Description:Used to indicate which of the various name parts is used when interacting with the person."; 372 case IN: return "Description:Indicates that a name part is just an initial. Initials do not imply a trailing period since this would not work with non-Latin scripts. In some languages, initials may consist of more than one letter, e.g. \"Ph\" could stand for \"Philippe\" or \"Th\" For \"Thomas\"."; 373 case LS: return "Description:For organizations a suffix indicating the legal status, e.g. \"Inc.\", \"Co.\", \"AG\", \"GmbH\", \"B.V.\" \"S.A.\", \"Ltd.\" etc."; 374 case MID: return "Description:Indicates that the name part is a middle name.\r\n\n \n Usage Notes: In general, the english \"middle name\" concept is all of the given names after the first. This qualifier may be used to explicitly indicate which given names are considered to be middle names. The middle name qualifier may also be used with family names. This is a Scandinavian use case, matching the concept of \"mellomnavn\",\"mellannamn\". Note that there are specific rules that indicate what names may be taken as a mellannamn in different Scandinavian countries."; 375 case PFX: return "Description:A prefix has a strong association to the immediately following name part. A prefix has no implicit trailing white space (it has implicit leading white space though)."; 376 case PHARMACEUTICALENTITYNAMEPARTQUALIFIERS: return "Description: Medication Name Parts are a means of specifying a range of acceptable \"official\" forms of the name of a product. They are used as patterns against which input name strings may be matched for automatic identification of products from input text reports. While they cover the concepts held under \"doseForm\" or \"route\" or \"strength\" the name parts are not the same and do not fit into a controlled vocabulary in the same way. By specifying up to 8 name parts a much larger range of possible names can be generated."; 377 case CON: return "Description: This refers to the container if present in the medicinal product name.\r\n\n EXAMPLES: \r\n\n \n \n For Optaflu suspension for injection in pre-filled syringe Influenza vaccine (surface antigen, inactivated, prepared in cell culture) (2007/2008 season): pre-filled syringe"; 378 case DEV: return "Description: This refers to the qualifiers in the name for devices and is at the moment mainly applicable to insulins and inhalation products.\r\n\n EXAMPLES: \r\n\n \n \n For the medicinal product Actrapid FlexPen 100 IU/ml Solution for injection Subcutaneous use: FlexPen."; 379 case FLAV: return "Description: This refers to a flavor of the medicinal product if present in the medicinal product name.\r\n\n \n Examples:\n \r\n\n \n For 'CoughCure Linctus Orange Flavor', the flavor part is \"Orange\"\n For 'Wonderdrug Syrup Cherry Flavor', the flavor part is \"Cherry\""; 380 case FORMUL: return "Description: This refers to the formulation of the medicinal product if present in the medicinal product name.\r\n\n \n Examples:\n \r\n\n \n For 'SpecialMed Sugar Free Cough Syrup', the formulation name part is \"Sugar Free\"\n For 'QuickCure Gluten-free Bulk Fibre', the formulation name part is \"gluten-free\""; 381 case FRM: return "Description: This refers to the pharmaceutical form/ if present in the medicinal product name.\r\n\n EXAMPLES: \r\n\n \n \n For Agenerase 50 mg soft capsules: Soft Capsules\r\n\n \n \n For Ludiomil 25mg-Filmtabletten: Filmtabletten\r\n\n \n \n For Optaflu suspension for injection in pre-filled syringe Influenza vaccine (surface antigen, inactivated, prepared in cell culture) (2007/2008 season): suspension for injection"; 382 case INV: return "Description: This refers to the product name without the trademark or the name of the marketing authorization holder or any other descriptor reflected in the product name and, if appropriate, whether it is intended e.g. for babies, children or adults. \r\n\n EXAMPLES: \r\n\n \n \n Agenerase\r\n\n \n \n Optaflu\r\n\n \n \n Ludiomil"; 383 case POPUL: return "Description: This refers to the target population for the medicinal product if present in the medicinal product name\r\n\n \n Examples:\n \r\n\n \n For 'Broncho-Drug 3.5 mg-capsules for children', the target population part is \"children\"\n For 'Adult Chesty Cough Syrup', the target population part is \"adult\""; 384 case SCI: return "Description: This refers to the product common or scientific name without the trademark or the name of the marketing authorization holder or any other descriptor reflected in the product name.\r\n\n EXAMPLES: \r\n\n \n \n For Agenerase: N/A\r\n\n \n \n For Optaflu: Influenza vaccine (surface antigen, inactivated, prepared in cell culture) (2007/2008 season)\r\n\n \n \n For Ludiomil: N/A"; 385 case STR: return "Description: This refers to the strength if present in the medicinal product name. The use of decimal points should be accommodated if required.\r\n\n EXAMPLES:\r\n\n \n \n For Agenerase 50 mg soft capsules: 50mg\r\n\n \n \n For Ludiomil 25mg-Filmtabletten: 25 mg\r\n\n \n \n For Optaflu suspension for injection in pre-filled syringe Influenza vaccine (surface antigen, inactivated, prepared in cell culture) (2007/2008 season): N/A"; 386 case TIME: return "Description: This refers to a time or time period that may be specified in the text of the medicinal product name\r\n\n \n Example:\n \r\n\n \n For an influenza vaccine 'Drug-FLU season 2008/2009', the time/period part is \"2008/2009 season\""; 387 case TMK: return "Description: This refers to trademark/company element if present in the medicinal product name.\r\n\n EXAMPLES: \r\n\n \n \n for Insulin Human Winthrop Comb 15: Winthrop"; 388 case USE: return "Description: This refers to the intended use if present in the medicinal product name without the trademark or the name of the marketing authorization holder or any other descriptor reflected in the product name.\n\r\n\n \n Examples:\n \r\n\n \n For 'Drug-BI Caplets - Heartburn Relief', the intended use part is: \"Heartburn Relief\"\n For 'Medicine Honey Syrup for Soothing Coughs' the intended use part is \"Soothing Coughs\""; 389 case SFX: return "Description:A suffix has a strong association to the immediately preceding name part. A suffix has no implicit leading white space (it has implicit trailing white space though)."; 390 case TITLESTYLES: return "Description:Extra information about the style of a title"; 391 case AC: return "Description:Indicates that a title like \"Dr.\", \"M.D.\" or \"Ph.D.\" is an academic title."; 392 case HON: return "Description:A honorific such as \"The Right Honorable\" or \"Weledelgeleerde Heer\"."; 393 case NB: return "Description:A nobility title such as Sir, Count, Grafin."; 394 case PR: return "Description:Primarily in the British Imperial culture people tend to have an abbreviation of their professional organization as part of their credential titles."; 395 default: return "?"; 396 } 397 } 398 public String getDisplay() { 399 switch (this) { 400 case AD: return "acquired"; 401 case SP: return "spouse"; 402 case BR: return "birth"; 403 case CL: return "callme"; 404 case IN: return "initial"; 405 case LS: return "legal status"; 406 case MID: return "middle name"; 407 case PFX: return "prefix"; 408 case PHARMACEUTICALENTITYNAMEPARTQUALIFIERS: return "PharmaceuticalEntityNamePartQualifiers"; 409 case CON: return "container name"; 410 case DEV: return "device name"; 411 case FLAV: return "FlavorName"; 412 case FORMUL: return "FormulationPartName"; 413 case FRM: return "form name"; 414 case INV: return "invented name"; 415 case POPUL: return "TargetPopulationName"; 416 case SCI: return "scientific name"; 417 case STR: return "strength name"; 418 case TIME: return "TimeOrPeriodName"; 419 case TMK: return "trademark name"; 420 case USE: return "intended use name"; 421 case SFX: return "suffix"; 422 case TITLESTYLES: return "TitleStyles"; 423 case AC: return "academic"; 424 case HON: return "honorific"; 425 case NB: return "nobility"; 426 case PR: return "professional"; 427 default: return "?"; 428 } 429 } 430 431 432} 433