001package org.hl7.fhir.r4.model.codesystems; 002 003/*- 004 * #%L 005 * org.hl7.fhir.r4 006 * %% 007 * Copyright (C) 2014 - 2019 Health Level 7 008 * %% 009 * Licensed under the Apache License, Version 2.0 (the "License"); 010 * you may not use this file except in compliance with the License. 011 * You may obtain a copy of the License at 012 * 013 * http://www.apache.org/licenses/LICENSE-2.0 014 * 015 * Unless required by applicable law or agreed to in writing, software 016 * distributed under the License is distributed on an "AS IS" BASIS, 017 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 018 * See the License for the specific language governing permissions and 019 * limitations under the License. 020 * #L% 021 */ 022 023 024/* 025 Copyright (c) 2011+, HL7, Inc. 026 All rights reserved. 027 028 Redistribution and use in source and binary forms, with or without modification, 029 are permitted provided that the following conditions are met: 030 031 * Redistributions of source code must retain the above copyright notice, this 032 list of conditions and the following disclaimer. 033 * Redistributions in binary form must reproduce the above copyright notice, 034 this list of conditions and the following disclaimer in the documentation 035 and/or other materials provided with the distribution. 036 * Neither the name of HL7 nor the names of its contributors may be used to 037 endorse or promote products derived from this software without specific 038 prior written permission. 039 040 THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND 041 ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED 042 WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. 043 IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, 044 INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT 045 NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR 046 PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, 047 WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) 048 ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE 049 POSSIBILITY OF SUCH DAMAGE. 050 051*/ 052 053// Generated on Wed, Jan 30, 2019 16:19-0500 for FHIR v4.0.0 054 055 056import org.hl7.fhir.exceptions.FHIRException; 057 058public enum V3EntityNamePartQualifierR2 { 059 060 /** 061 * 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. 062 063 064 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). 065 */ 066 AD, 067 /** 068 * 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. 069 */ 070 SP, 071 /** 072 * Description:A name that a person was given at birth or established as a consequence of adoption. 073 074 075 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". 076 */ 077 BR, 078 /** 079 * Description:Used to indicate which of the various name parts is used when interacting with the person. 080 */ 081 CL, 082 /** 083 * 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". 084 */ 085 IN, 086 /** 087 * Description:For organizations a suffix indicating the legal status, e.g., "Inc.", "Co.", "AG", "GmbH", "B.V." "S.A.", "Ltd." etc. 088 */ 089 LS, 090 /** 091 * Description:Indicates that the name part is a middle name. 092 093 094 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. 095 */ 096 MID, 097 /** 098 * 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). 099 */ 100 PFX, 101 /** 102 * 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. 103 */ 104 PHARMACEUTICALENTITYNAMEPARTQUALIFIERS, 105 /** 106 * Description: This refers to the container if present in the medicinal product name. 107 108 EXAMPLES: 109 110 111 112 For Optaflu suspension for injection in pre-filled syringe Influenza vaccine (surface antigen, inactivated, prepared in cell culture) (2007/2008 season): pre-filled syringe 113 */ 114 CON, 115 /** 116 * Description: This refers to the qualifiers in the name for devices and is at the moment mainly applicable to insulins and inhalation products. 117 118 EXAMPLES: 119 120 121 122 For the medicinal product Actrapid FlexPen 100 IU/ml Solution for injection Subcutaneous use: FlexPen. 123 */ 124 DEV, 125 /** 126 * Description: This refers to a flavor of the medicinal product if present in the medicinal product name. 127 128 129 Examples: 130 131 132 133 For 'CoughCure Linctus Orange Flavor', the flavor part is "Orange" 134 For 'Wonderdrug Syrup Cherry Flavor', the flavor part is "Cherry" 135 */ 136 FLAV, 137 /** 138 * Description: This refers to the formulation of the medicinal product if present in the medicinal product name. 139 140 141 Examples: 142 143 144 145 For 'SpecialMed Sugar Free Cough Syrup', the formulation name part is "Sugar Free" 146 For 'QuickCure Gluten-free Bulk Fibre', the formulation name part is "gluten-free" 147 */ 148 FORMUL, 149 /** 150 * Description: This refers to the pharmaceutical form/ if present in the medicinal product name. 151 152 EXAMPLES: 153 154 155 156 For Agenerase 50 mg soft capsules: Soft Capsules 157 158 159 160 For Ludiomil 25mg-Filmtabletten: Filmtabletten 161 162 163 164 For Optaflu suspension for injection in pre-filled syringe Influenza vaccine (surface antigen, inactivated, prepared in cell culture) (2007/2008 season): suspension for injection 165 */ 166 FRM, 167 /** 168 * 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. 169 170 EXAMPLES: 171 172 173 174 Agenerase 175 176 177 178 Optaflu 179 180 181 182 Ludiomil 183 */ 184 INV, 185 /** 186 * Description: This refers to the target population for the medicinal product if present in the medicinal product name 187 188 189 Examples: 190 191 192 193 For 'Broncho-Drug 3.5 mg-capsules for children', the target population part is "children" 194 For 'Adult Chesty Cough Syrup', the target population part is "adult" 195 */ 196 POPUL, 197 /** 198 * 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. 199 200 EXAMPLES: 201 202 203 204 For Agenerase: N/A 205 206 207 208 For Optaflu: Influenza vaccine (surface antigen, inactivated, prepared in cell culture) (2007/2008 season) 209 210 211 212 For Ludiomil: N/A 213 */ 214 SCI, 215 /** 216 * Description: This refers to the strength if present in the medicinal product name. The use of decimal points should be accommodated if required. 217 218 EXAMPLES: 219 220 221 222 For Agenerase 50 mg soft capsules: 50mg 223 224 225 226 For Ludiomil 25mg-Filmtabletten: 25 mg 227 228 229 230 For Optaflu suspension for injection in pre-filled syringe Influenza vaccine (surface antigen, inactivated, prepared in cell culture) (2007/2008 season): N/A 231 */ 232 STR, 233 /** 234 * Description: This refers to a time or time period that may be specified in the text of the medicinal product name 235 236 237 Example: 238 239 240 241 For an influenza vaccine 'Drug-FLU season 2008/2009', the time/period part is "2008/2009 season" 242 */ 243 TIME, 244 /** 245 * Description: This refers to trademark/company element if present in the medicinal product name. 246 247 EXAMPLES: 248 249 250 251 for Insulin Human Winthrop Comb 15: Winthrop 252 */ 253 TMK, 254 /** 255 * 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. 256 257 258 259 Examples: 260 261 262 263 For 'Drug-BI Caplets - Heartburn Relief', the intended use part is: "Heartburn Relief" 264 For 'Medicine Honey Syrup for Soothing Coughs' the intended use part is "Soothing Coughs" 265 */ 266 USE, 267 /** 268 * 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). 269 */ 270 SFX, 271 /** 272 * Description:Extra information about the style of a title 273 */ 274 TITLESTYLES, 275 /** 276 * Description:Indicates that a title like "Dr.", "M.D." or "Ph.D." is an academic title. 277 */ 278 AC, 279 /** 280 * Description:A honorific such as "The Right Honourable" or "Weledelgeleerde Heer". 281 */ 282 HON, 283 /** 284 * Description:A nobility title such as Sir, Count, Grafin. 285 */ 286 NB, 287 /** 288 * Description:Primarily in the British Imperial culture people tend to have an abbreviation of their professional organization as part of their credential titles. 289 */ 290 PR, 291 /** 292 * added to help the parsers 293 */ 294 NULL; 295 public static V3EntityNamePartQualifierR2 fromCode(String codeString) throws FHIRException { 296 if (codeString == null || "".equals(codeString)) 297 return null; 298 if ("AD".equals(codeString)) 299 return AD; 300 if ("SP".equals(codeString)) 301 return SP; 302 if ("BR".equals(codeString)) 303 return BR; 304 if ("CL".equals(codeString)) 305 return CL; 306 if ("IN".equals(codeString)) 307 return IN; 308 if ("LS".equals(codeString)) 309 return LS; 310 if ("MID".equals(codeString)) 311 return MID; 312 if ("PFX".equals(codeString)) 313 return PFX; 314 if ("PharmaceuticalEntityNamePartQualifiers".equals(codeString)) 315 return PHARMACEUTICALENTITYNAMEPARTQUALIFIERS; 316 if ("CON".equals(codeString)) 317 return CON; 318 if ("DEV".equals(codeString)) 319 return DEV; 320 if ("FLAV".equals(codeString)) 321 return FLAV; 322 if ("FORMUL".equals(codeString)) 323 return FORMUL; 324 if ("FRM".equals(codeString)) 325 return FRM; 326 if ("INV".equals(codeString)) 327 return INV; 328 if ("POPUL".equals(codeString)) 329 return POPUL; 330 if ("SCI".equals(codeString)) 331 return SCI; 332 if ("STR".equals(codeString)) 333 return STR; 334 if ("TIME".equals(codeString)) 335 return TIME; 336 if ("TMK".equals(codeString)) 337 return TMK; 338 if ("USE".equals(codeString)) 339 return USE; 340 if ("SFX".equals(codeString)) 341 return SFX; 342 if ("TitleStyles".equals(codeString)) 343 return TITLESTYLES; 344 if ("AC".equals(codeString)) 345 return AC; 346 if ("HON".equals(codeString)) 347 return HON; 348 if ("NB".equals(codeString)) 349 return NB; 350 if ("PR".equals(codeString)) 351 return PR; 352 throw new FHIRException("Unknown V3EntityNamePartQualifierR2 code '"+codeString+"'"); 353 } 354 public String toCode() { 355 switch (this) { 356 case AD: return "AD"; 357 case SP: return "SP"; 358 case BR: return "BR"; 359 case CL: return "CL"; 360 case IN: return "IN"; 361 case LS: return "LS"; 362 case MID: return "MID"; 363 case PFX: return "PFX"; 364 case PHARMACEUTICALENTITYNAMEPARTQUALIFIERS: return "PharmaceuticalEntityNamePartQualifiers"; 365 case CON: return "CON"; 366 case DEV: return "DEV"; 367 case FLAV: return "FLAV"; 368 case FORMUL: return "FORMUL"; 369 case FRM: return "FRM"; 370 case INV: return "INV"; 371 case POPUL: return "POPUL"; 372 case SCI: return "SCI"; 373 case STR: return "STR"; 374 case TIME: return "TIME"; 375 case TMK: return "TMK"; 376 case USE: return "USE"; 377 case SFX: return "SFX"; 378 case TITLESTYLES: return "TitleStyles"; 379 case AC: return "AC"; 380 case HON: return "HON"; 381 case NB: return "NB"; 382 case PR: return "PR"; 383 default: return "?"; 384 } 385 } 386 public String getSystem() { 387 return "http://terminology.hl7.org/CodeSystem/v3-EntityNamePartQualifierR2"; 388 } 389 public String getDefinition() { 390 switch (this) { 391 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)."; 392 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."; 393 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\"."; 394 case CL: return "Description:Used to indicate which of the various name parts is used when interacting with the person."; 395 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\"."; 396 case LS: return "Description:For organizations a suffix indicating the legal status, e.g., \"Inc.\", \"Co.\", \"AG\", \"GmbH\", \"B.V.\" \"S.A.\", \"Ltd.\" etc."; 397 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."; 398 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)."; 399 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."; 400 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"; 401 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."; 402 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\""; 403 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\""; 404 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"; 405 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"; 406 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\""; 407 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"; 408 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"; 409 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\""; 410 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"; 411 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\""; 412 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)."; 413 case TITLESTYLES: return "Description:Extra information about the style of a title"; 414 case AC: return "Description:Indicates that a title like \"Dr.\", \"M.D.\" or \"Ph.D.\" is an academic title."; 415 case HON: return "Description:A honorific such as \"The Right Honourable\" or \"Weledelgeleerde Heer\"."; 416 case NB: return "Description:A nobility title such as Sir, Count, Grafin."; 417 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."; 418 default: return "?"; 419 } 420 } 421 public String getDisplay() { 422 switch (this) { 423 case AD: return "acquired"; 424 case SP: return "spouse"; 425 case BR: return "birth"; 426 case CL: return "callme"; 427 case IN: return "initial"; 428 case LS: return "legal status"; 429 case MID: return "middle name"; 430 case PFX: return "prefix"; 431 case PHARMACEUTICALENTITYNAMEPARTQUALIFIERS: return "PharmaceuticalEntityNamePartQualifiers"; 432 case CON: return "container name"; 433 case DEV: return "device name"; 434 case FLAV: return "FlavorName"; 435 case FORMUL: return "FormulationPartName"; 436 case FRM: return "form name"; 437 case INV: return "invented name"; 438 case POPUL: return "TargetPopulationName"; 439 case SCI: return "scientific name"; 440 case STR: return "strength name"; 441 case TIME: return "TimeOrPeriodName"; 442 case TMK: return "trademark name"; 443 case USE: return "intended use name"; 444 case SFX: return "suffix"; 445 case TITLESTYLES: return "TitleStyles"; 446 case AC: return "academic"; 447 case HON: return "honorific"; 448 case NB: return "nobility"; 449 case PR: return "professional"; 450 default: return "?"; 451 } 452 } 453 454 455} 456