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 V3EntityNamePartQualifier { 036 037 /** 038 * OrganizationNamePartQualifier 039 */ 040 _ORGANIZATIONNAMEPARTQUALIFIER, 041 /** 042 * Indicates that a prefix like "Dr." or a suffix like "M.D." or "Ph.D." is an academic title. 043 */ 044 AC, 045 /** 046 * The name the person was given at the time of adoption. 047 */ 048 AD, 049 /** 050 * A name that a person had shortly after being born. Usually for family names but may be used to mark given names at birth that may have changed later. 051 */ 052 BR, 053 /** 054 * A callme name is (usually a given name) that is preferred when a person is directly addressed. 055 */ 056 CL, 057 /** 058 * 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. Initials may consist of more than one letter, e.g. "Ph." could stand for "Philippe" or "Th." for "Thomas". 059 */ 060 IN, 061 /** 062 * For organizations a suffix indicating the legal status, e.g. "Inc.", "Co.", "AG", "GmbH", "B.V." "S.A.", "Ltd." etc. 063 */ 064 LS, 065 /** 066 * In Europe and Asia, there are still people with nobility titles (aristocrats). German "von" is generally a nobility title, not a mere voorvoegsel. Others are "Earl of" or "His Majesty King of..." etc. Rarely used nowadays, but some systems do keep track of this. 067 */ 068 NB, 069 /** 070 * Primarily in the British Imperial culture people tend to have an abbreviation of their professional organization as part of their credential suffices. 071 */ 072 PR, 073 /** 074 * The name assumed from the partner in a marital relationship (hence the "SP"). Usually the spouse's family name. Note that no inference about gender can be made from the existence of spouse names. 075 */ 076 SP, 077 /** 078 * Indicates that a prefix or a suffix is a title that applies to the whole name, not just the adjacent name part. 079 */ 080 TITLE, 081 /** 082 * A Dutch "voorvoegsel" is something like "van" or "de" that might have indicated nobility in the past but no longer so. Similar prefixes exist in other languages such as Spanish, French or Portugese. 083 */ 084 VV, 085 /** 086 * 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. 087 */ 088 PHARMACEUTICALENTITYNAMEPARTQUALIFIERS, 089 /** 090 * Description: This refers to the container if present in the medicinal product name. 091 092 EXAMPLES: 093 094 095 096 For Optaflu suspension for injection in pre-filled syringe Influenza vaccine (surface antigen, inactivated, prepared in cell culture) (2007/2008 season): pre-filled syringe 097 */ 098 CON, 099 /** 100 * Description: This refers to the qualifiers in the name for devices and is at the moment mainly applicable to insulins and inhalation products. 101 102 EXAMPLES: 103 104 105 106 For the medicinal product Actrapid FlexPen 100 IU/ml Solution for injection Subcutaneous use: FlexPen. 107 */ 108 DEV, 109 /** 110 * Description: This refers to a flavor of the medicinal product if present in the medicinal product name. 111 112 113 Examples: 114 115 116 117 For 'CoughCure Linctus Orange Flavor', the flavor part is "Orange" 118 For 'Wonderdrug Syrup Cherry Flavor', the flavor part is "Cherry" 119 */ 120 FLAV, 121 /** 122 * Description: This refers to the formulation of the medicinal product if present in the medicinal product name. 123 124 125 Examples: 126 127 128 129 For 'SpecialMed Sugar Free Cough Syrup', the formulation name part is "Sugar Free" 130 For 'QuickCure Gluten-free Bulk Fibre', the formulation name part is "gluten-free" 131 */ 132 FORMUL, 133 /** 134 * Description: This refers to the pharmaceutical form/ if present in the medicinal product name. 135 136 EXAMPLES: 137 138 139 140 For Agenerase 50 mg soft capsules: Soft Capsules 141 142 143 144 For Ludiomil 25mg-Filmtabletten: Filmtabletten 145 146 147 148 For Optaflu suspension for injection in pre-filled syringe Influenza vaccine (surface antigen, inactivated, prepared in cell culture) (2007/2008 season): suspension for injection 149 */ 150 FRM, 151 /** 152 * 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. 153 154 EXAMPLES: 155 156 157 158 Agenerase 159 160 161 162 Optaflu 163 164 165 166 Ludiomil 167 */ 168 INV, 169 /** 170 * Description: This refers to the target population for the medicinal product if present in the medicinal product name 171 172 173 Examples: 174 175 176 177 For 'Broncho-Drug 3.5 mg-capsules for children', the target population part is "children" 178 For 'Adult Chesty Cough Syrup', the target population part is "adult" 179 */ 180 POPUL, 181 /** 182 * 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. 183 184 EXAMPLES: 185 186 187 188 For Agenerase: N/A 189 190 191 192 For Optaflu: Influenza vaccine (surface antigen, inactivated, prepared in cell culture) (2007/2008 season) 193 194 195 196 For Ludiomil: N/A 197 */ 198 SCI, 199 /** 200 * Description: This refers to the strength if present in the medicinal product name. The use of decimal points should be accommodated if required. 201 202 EXAMPLES: 203 204 205 206 For Agenerase 50 mg soft capsules: 50mg 207 208 209 210 For Ludiomil 25mg-Filmtabletten: 25 mg 211 212 213 214 For Optaflu suspension for injection in pre-filled syringe Influenza vaccine (surface antigen, inactivated, prepared in cell culture) (2007/2008 season): N/A 215 */ 216 STR, 217 /** 218 * Description: This refers to a time or time period that may be specified in the text of the medicinal product name 219 220 221 Example: 222 223 224 225 For an influenza vaccine 'Drug-FLU season 2008/2009', the time/period part is "2008/2009 season" 226 */ 227 TIME, 228 /** 229 * Description: This refers to trademark/company element if present in the medicinal product name. 230 231 EXAMPLES: 232 233 234 235 for Insulin Human Winthrop Comb 15: Winthrop 236 */ 237 TMK, 238 /** 239 * 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. 240 241 242 243 Examples: 244 245 246 247 For 'Drug-BI Caplets - Heartburn Relief', the intended use part is: "Heartburn Relief" 248 For 'Medicine Honey Syrup for Soothing Coughs' the intended use part is "Soothing Coughs" 249 */ 250 USE, 251 /** 252 * PersonNamePartQualifier 253 */ 254 _PERSONNAMEPARTQUALIFIER, 255 /** 256 * PersonNamePartAffixTypes 257 */ 258 _PERSONNAMEPARTAFFIXTYPES, 259 /** 260 * PersonNamePartChangeQualifier 261 */ 262 _PERSONNAMEPARTCHANGEQUALIFIER, 263 /** 264 * PersonNamePartMiscQualifier 265 */ 266 _PERSONNAMEPARTMISCQUALIFIER, 267 /** 268 * added to help the parsers 269 */ 270 NULL; 271 public static V3EntityNamePartQualifier fromCode(String codeString) throws Exception { 272 if (codeString == null || "".equals(codeString)) 273 return null; 274 if ("_OrganizationNamePartQualifier".equals(codeString)) 275 return _ORGANIZATIONNAMEPARTQUALIFIER; 276 if ("AC".equals(codeString)) 277 return AC; 278 if ("AD".equals(codeString)) 279 return AD; 280 if ("BR".equals(codeString)) 281 return BR; 282 if ("CL".equals(codeString)) 283 return CL; 284 if ("IN".equals(codeString)) 285 return IN; 286 if ("LS".equals(codeString)) 287 return LS; 288 if ("NB".equals(codeString)) 289 return NB; 290 if ("PR".equals(codeString)) 291 return PR; 292 if ("SP".equals(codeString)) 293 return SP; 294 if ("TITLE".equals(codeString)) 295 return TITLE; 296 if ("VV".equals(codeString)) 297 return VV; 298 if ("PharmaceuticalEntityNamePartQualifiers".equals(codeString)) 299 return PHARMACEUTICALENTITYNAMEPARTQUALIFIERS; 300 if ("CON".equals(codeString)) 301 return CON; 302 if ("DEV".equals(codeString)) 303 return DEV; 304 if ("FLAV".equals(codeString)) 305 return FLAV; 306 if ("FORMUL".equals(codeString)) 307 return FORMUL; 308 if ("FRM".equals(codeString)) 309 return FRM; 310 if ("INV".equals(codeString)) 311 return INV; 312 if ("POPUL".equals(codeString)) 313 return POPUL; 314 if ("SCI".equals(codeString)) 315 return SCI; 316 if ("STR".equals(codeString)) 317 return STR; 318 if ("TIME".equals(codeString)) 319 return TIME; 320 if ("TMK".equals(codeString)) 321 return TMK; 322 if ("USE".equals(codeString)) 323 return USE; 324 if ("_PersonNamePartQualifier".equals(codeString)) 325 return _PERSONNAMEPARTQUALIFIER; 326 if ("_PersonNamePartAffixTypes".equals(codeString)) 327 return _PERSONNAMEPARTAFFIXTYPES; 328 if ("_PersonNamePartChangeQualifier".equals(codeString)) 329 return _PERSONNAMEPARTCHANGEQUALIFIER; 330 if ("_PersonNamePartMiscQualifier".equals(codeString)) 331 return _PERSONNAMEPARTMISCQUALIFIER; 332 throw new Exception("Unknown V3EntityNamePartQualifier code '"+codeString+"'"); 333 } 334 public String toCode() { 335 switch (this) { 336 case _ORGANIZATIONNAMEPARTQUALIFIER: return "_OrganizationNamePartQualifier"; 337 case AC: return "AC"; 338 case AD: return "AD"; 339 case BR: return "BR"; 340 case CL: return "CL"; 341 case IN: return "IN"; 342 case LS: return "LS"; 343 case NB: return "NB"; 344 case PR: return "PR"; 345 case SP: return "SP"; 346 case TITLE: return "TITLE"; 347 case VV: return "VV"; 348 case PHARMACEUTICALENTITYNAMEPARTQUALIFIERS: return "PharmaceuticalEntityNamePartQualifiers"; 349 case CON: return "CON"; 350 case DEV: return "DEV"; 351 case FLAV: return "FLAV"; 352 case FORMUL: return "FORMUL"; 353 case FRM: return "FRM"; 354 case INV: return "INV"; 355 case POPUL: return "POPUL"; 356 case SCI: return "SCI"; 357 case STR: return "STR"; 358 case TIME: return "TIME"; 359 case TMK: return "TMK"; 360 case USE: return "USE"; 361 case _PERSONNAMEPARTQUALIFIER: return "_PersonNamePartQualifier"; 362 case _PERSONNAMEPARTAFFIXTYPES: return "_PersonNamePartAffixTypes"; 363 case _PERSONNAMEPARTCHANGEQUALIFIER: return "_PersonNamePartChangeQualifier"; 364 case _PERSONNAMEPARTMISCQUALIFIER: return "_PersonNamePartMiscQualifier"; 365 default: return "?"; 366 } 367 } 368 public String getSystem() { 369 return "http://hl7.org/fhir/v3/EntityNamePartQualifier"; 370 } 371 public String getDefinition() { 372 switch (this) { 373 case _ORGANIZATIONNAMEPARTQUALIFIER: return "OrganizationNamePartQualifier"; 374 case AC: return "Indicates that a prefix like \"Dr.\" or a suffix like \"M.D.\" or \"Ph.D.\" is an academic title."; 375 case AD: return "The name the person was given at the time of adoption."; 376 case BR: return "A name that a person had shortly after being born. Usually for family names but may be used to mark given names at birth that may have changed later."; 377 case CL: return "A callme name is (usually a given name) that is preferred when a person is directly addressed."; 378 case IN: return "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. Initials may consist of more than one letter, e.g. \"Ph.\" could stand for \"Philippe\" or \"Th.\" for \"Thomas\"."; 379 case LS: return "For organizations a suffix indicating the legal status, e.g. \"Inc.\", \"Co.\", \"AG\", \"GmbH\", \"B.V.\" \"S.A.\", \"Ltd.\" etc."; 380 case NB: return "In Europe and Asia, there are still people with nobility titles (aristocrats). German \"von\" is generally a nobility title, not a mere voorvoegsel. Others are \"Earl of\" or \"His Majesty King of...\" etc. Rarely used nowadays, but some systems do keep track of this."; 381 case PR: return "Primarily in the British Imperial culture people tend to have an abbreviation of their professional organization as part of their credential suffices."; 382 case SP: return "The name assumed from the partner in a marital relationship (hence the \"SP\"). Usually the spouse's family name. Note that no inference about gender can be made from the existence of spouse names."; 383 case TITLE: return "Indicates that a prefix or a suffix is a title that applies to the whole name, not just the adjacent name part."; 384 case VV: return "A Dutch \"voorvoegsel\" is something like \"van\" or \"de\" that might have indicated nobility in the past but no longer so. Similar prefixes exist in other languages such as Spanish, French or Portugese."; 385 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."; 386 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"; 387 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."; 388 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\""; 389 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\""; 390 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"; 391 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"; 392 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\""; 393 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"; 394 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"; 395 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\""; 396 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"; 397 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\""; 398 case _PERSONNAMEPARTQUALIFIER: return "PersonNamePartQualifier"; 399 case _PERSONNAMEPARTAFFIXTYPES: return "PersonNamePartAffixTypes"; 400 case _PERSONNAMEPARTCHANGEQUALIFIER: return "PersonNamePartChangeQualifier"; 401 case _PERSONNAMEPARTMISCQUALIFIER: return "PersonNamePartMiscQualifier"; 402 default: return "?"; 403 } 404 } 405 public String getDisplay() { 406 switch (this) { 407 case _ORGANIZATIONNAMEPARTQUALIFIER: return "OrganizationNamePartQualifier"; 408 case AC: return "academic"; 409 case AD: return "adopted"; 410 case BR: return "birth"; 411 case CL: return "callme"; 412 case IN: return "initial"; 413 case LS: return "Legal status"; 414 case NB: return "nobility"; 415 case PR: return "professional"; 416 case SP: return "spouse"; 417 case TITLE: return "title"; 418 case VV: return "voorvoegsel"; 419 case PHARMACEUTICALENTITYNAMEPARTQUALIFIERS: return "PharmaceuticalEntityNamePartQualifiers"; 420 case CON: return "container name"; 421 case DEV: return "device name"; 422 case FLAV: return "FlavorName"; 423 case FORMUL: return "FormulationPartName"; 424 case FRM: return "form name"; 425 case INV: return "invented name"; 426 case POPUL: return "TargetPopulationName"; 427 case SCI: return "scientific name"; 428 case STR: return "strength name"; 429 case TIME: return "TimeOrPeriodName"; 430 case TMK: return "trademark name"; 431 case USE: return "intended use name"; 432 case _PERSONNAMEPARTQUALIFIER: return "PersonNamePartQualifier"; 433 case _PERSONNAMEPARTAFFIXTYPES: return "PersonNamePartAffixTypes"; 434 case _PERSONNAMEPARTCHANGEQUALIFIER: return "PersonNamePartChangeQualifier"; 435 case _PERSONNAMEPARTMISCQUALIFIER: return "PersonNamePartMiscQualifier"; 436 default: return "?"; 437 } 438 } 439 440 441} 442