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