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