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