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