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