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