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 Wed, Jan 30, 2019 16:19-0500 for FHIR v4.0.0 033 034import org.hl7.fhir.exceptions.FHIRException; 035 036public enum V3RoleClass { 037 038 /** 039 * Corresponds to the Role class 040 */ 041 ROL, 042 /** 043 * A general association between two entities that is neither partitive nor 044 * ontological. 045 */ 046 _ROLECLASSASSOCIATIVE, 047 /** 048 * A relationship that is based on mutual behavior of the two Entities as being 049 * related. The basis of such relationship may be agreements (e.g., spouses, 050 * contract parties) or they may be de facto behavior (e.g. friends) or may be 051 * an incidental involvement with each other (e.g. parties over a dispute, 052 * siblings, children). 053 */ 054 _ROLECLASSMUTUALRELATIONSHIP, 055 /** 056 * A relationship between two entities that is formally recognized, frequently 057 * by a contract or similar agreement. 058 */ 059 _ROLECLASSRELATIONSHIPFORMAL, 060 /** 061 * Player of the Affiliate role has a business/professional relationship with 062 * scoper. Player and scoper may be persons or organization. The Affiliate 063 * relationship does not imply membership in a group, nor does it exist for 064 * resource scheduling purposes. 065 * 066 * 067 * Example: A healthcare provider is affiliated with another provider as a 068 * business associate. 069 */ 070 AFFL, 071 /** 072 * An entity (player) that acts or is authorized to act on behalf of another 073 * entity (scoper). 074 */ 075 AGNT, 076 /** 077 * An agent role in which the agent is an Entity acting in the employ of an 078 * organization. The focus is on functional role on behalf of the organization, 079 * unlike the Employee role where the focus is on the 'Human Resources' 080 * relationship between the employee and the organization. 081 */ 082 ASSIGNED, 083 /** 084 * An Entity that is authorized to issue or instantiate permissions, privileges, 085 * credentials or other formal/legal authorizations. 086 */ 087 COMPAR, 088 /** 089 * The role of a person (player) who is the officer or signature authority for 090 * of a scoping entity, usually an organization (scoper). 091 */ 092 SGNOFF, 093 /** 094 * A person or an organization (player) which provides or receives information 095 * regarding another entity (scoper). Examples; patient NOK and emergency 096 * contacts; guarantor contact; employer contact. 097 */ 098 CON, 099 /** 100 * An entity to be contacted in the event of an emergency. 101 */ 102 ECON, 103 /** 104 * An individual designated for notification as the next of kin for a given 105 * entity. 106 */ 107 NOK, 108 /** 109 * Guardian of a ward 110 */ 111 GUARD, 112 /** 113 * Citizen of apolitical entity 114 */ 115 CIT, 116 /** 117 * A role class played by a person who receives benefit coverage under the terms 118 * of a particular insurance policy. The underwriter of that policy is the 119 * scoping entity. The covered party receives coverage because of some 120 * contractual or other relationship with the holder of that policy. 121 * 122 * 123 * Discussion:This reason for coverage is captured in 'Role.code' and a 124 * relationship link with type code of indirect authority should be included 125 * using the policy holder role as the source, and the covered party role as the 126 * target. 127 * 128 * Note that a particular policy may cover several individuals one of whom may 129 * be, but need not be, the policy holder. Thus the notion of covered party is a 130 * role that is distinct from that of the policy holder. 131 */ 132 COVPTY, 133 /** 134 * Description: A role played by a party making a claim for coverage under a 135 * policy or program. A claimant must be either a person or organization, or a 136 * group of persons or organizations. A claimant is not a named insured or a 137 * program eligible. 138 * 139 * 140 * Discussion: With respect to liability insurance such as property and casualty 141 * insurance, a claimant must file a claim requesting indemnification for a loss 142 * that the claimant considers covered under the policy of a named insured. The 143 * claims adjuster for the policy underwriter will review the claim to determine 144 * whether the loss meets the benefit coverage criteria under a policy, and base 145 * any indemnification or coverage payment on that review. If a third party is 146 * liable in whole or part for the loss, the underwriter may pursue third party 147 * liability recovery. A claimant may be involved in civil or criminal legal 148 * proceedings involving claims against a defendant party that is indemnified by 149 * an insurance policy or to protest the finding of a claims adjustor. With 150 * respect to life insurance, a beneficiary designated by a named insured 151 * becomes a claimant of the proceeds of coverage, as in the case of a life 152 * insurance policy. However, a claimant for coverage under life insurance is 153 * not necessarily a designated beneficiary. 154 * 155 * 156 * Note: A claimant is not a named insured. However, a named insured may make a 157 * claim under a policy, e.g., an insured driver may make a claim for an injury 158 * under his or her comprehensive automobile insurance policy. Similarly, a 159 * program eligible may make a claim under program, e.g., an unemployed worker 160 * may claim benefits under an unemployment insurance program, but parties 161 * playing these covered party role classes are not, for purposes of this 162 * vocabulary and in an effort to clearly distinguish role classes, considered 163 * claimants. 164 * 165 * In the case of a named insured making a claim, a role type code INSCLM 166 * (insured claimant) subtypes the class to indicate that either a named insured 167 * or an individual insured has filed a claim for a loss. In the case of a 168 * program eligible, a role type code INJWKR (injured worker) subtypes the class 169 * to indicate that the covered party in a workers compensation program is an 170 * injured worker, and as such, has filed a "claim" under the program for 171 * benefits. Likewise, a covered role type code UNEMP (unemployed worker) 172 * subtypes the program eligible class to indicate that the covered party in an 173 * unemployment insurance program has filed a claim for unemployment benefits. 174 * 175 * 176 * Example: A claimant under automobile policy that is not the named insured. 177 */ 178 CLAIM, 179 /** 180 * Description: A role played by a party to an insurance policy to which the 181 * insurer agrees to indemnify for losses, provides benefits for, or renders 182 * services. A named insured may be either a person, non-person living subject, 183 * or an organization, or a group of persons, non-person living subjects, or 184 * organizations. 185 * 186 * 187 * Discussion: The coded concept NAMED should not be used where a more specific 188 * child concept in this Specializable value set applies. In some cases, the 189 * named insured may not be the policy holder, e.g., where a policy holder 190 * purchases life insurance policy in which another party is the named insured 191 * and the policy holder is the beneficiary of the policy. 192 * 193 * 194 * Note: The party playing the role of a named insured is not a claimant in the 195 * sense conveyed by the RoleClassCoveredParty CLAIM (claimant). However, a 196 * named insured may make a claim under a policy, e.g., e.g., a party that is 197 * the named insured and policy holder under a comprehensive automobile 198 * insurance policy may become the claimant for coverage under that policy e.g., 199 * if injured in an automobile accident and there is no liable third party. In 200 * the case of a named insured making a claim, a role type code INSCLM (insured 201 * claimant) subtypes the class to indicate that a named insured has filed a 202 * claim for a loss. 203 * 204 * 205 * Example: The named insured under a comprehensive automobile, disability, or 206 * property and casualty policy that is the named insured and may or may not be 207 * the policy holder. 208 */ 209 NAMED, 210 /** 211 * Description: A role played by a person covered under a policy or program 212 * based on an association with a subscriber, which is recognized by the policy 213 * holder. 214 * 215 * 216 * Note: The party playing the role of a dependent is not a claimant in the 217 * sense conveyed by the RoleClassCoveredParty CLAIM (claimant). However, a 218 * dependent may make a claim under a policy, e.g., a dependent under a health 219 * insurance policy may become the claimant for coverage under that policy for 220 * wellness examines or if injured and there is no liable third party. In the 221 * case of a dependent making a claim, a role type code INSCLM (insured 222 * claimant) subtypes the class to indicate that the dependent has filed a claim 223 * for services covered under the health insurance policy. 224 * 225 * 226 * Example: The dependent has an association with the subscriber such as a 227 * financial dependency or personal relationship such as that of a spouse, or a 228 * natural or adopted child. The policy holder may be required by law to 229 * recognize certain associations or may have discretion about the associations. 230 * For example, a policy holder may dictate the criteria for the dependent 231 * status of adult children who are students, such as requiring full time 232 * enrollment, or may recognize domestic partners as dependents. Under certain 233 * circumstances, the dependent may be under the indirect authority of a 234 * responsible party acting as a surrogate for the subscriber, for example, if 235 * the subscriber is differently abled or deceased, a guardian ad Lidem or 236 * estate executor may be appointed to assume the subscriberaTMs legal standing 237 * in the relationship with the dependent. 238 */ 239 DEPEN, 240 /** 241 * Description: A role played by a party covered under a policy as the policy 242 * holder. An individual may be either a person or an organization. 243 * 244 * 245 * Note: The party playing the role of an individual insured is not a claimant 246 * in the sense conveyed by the RoleClassCoveredParty CLAIM (claimant). However, 247 * a named insured may make a claim under a policy, e.g., a party that is the 248 * named insured and policy holder under a comprehensive automobile insurance 249 * policy may become the claimant for coverage under that policy if injured in 250 * an automobile accident and there is no liable third party. In the case of an 251 * individual insured making a claim, a role type code INSCLM (insured claimant) 252 * subtypes the class to indicate that an individual insured has filed a claim 253 * for a loss. 254 * 255 * 256 * Example: The individual insured under a comprehensive automobile, disability, 257 * or property and casualty policy that is the policy holder. 258 */ 259 INDIV, 260 /** 261 * Description: A role played by a person covered under a policy based on 262 * association with a sponsor who is the policy holder, and whose association 263 * may provide for the eligibility of dependents for coverage. 264 * 265 * 266 * Discussion: The policy holder holds the contract with the policy or program 267 * underwriter. The subscriber holds a certificate of coverage under the 268 * contract. In legal proceedings concerning the policy or program, the terms of 269 * the contract takes precedence over the terms of the certificate of coverage 270 * if there are any inconsistencies. 271 * 272 * 273 * Note: The party playing the role of a subscriber is not a claimant in the 274 * sense conveyed by the RoleClassCoveredParty CLAIM (claimant). However, a 275 * subscriber may make a claim under a policy, e.g., a subscriber under a health 276 * insurance policy may become the claimant for coverage under that policy for 277 * wellness examines or if injured and there is no liable third party. In the 278 * case of a subscriber making a claim, a role type code INSCLM (insured 279 * claimant) subtypes the class to indicate that the subscriber has filed a 280 * claim for services covered under the health insurance policy. 281 * 282 * 283 * Example: An employee or a member of an association. 284 */ 285 SUBSCR, 286 /** 287 * Description: A role played by a party that meets the eligibility criteria for 288 * coverage under a program. A program eligible may be either a person, 289 * non-person living subject, or an organization, or a group of persons, 290 * non-person living subjects, or organizations. 291 * 292 * 293 * Discussion: A program as typically government administered coverage for 294 * parties determined eligible under the terms of the program. 295 * 296 * 297 * Note: The party playing a program eligible is not a claimant in the sense 298 * conveyed by the RoleClassCoveredParty CLAIM (claimant). However a program 299 * eligible may make a claim under program, e.g., an unemployed worker may claim 300 * benefits under an unemployment insurance program, but parties playing these 301 * covered party role classes are not, for purposes of this vocabulary and in an 302 * effort to clearly distinguish role classes, considered claimants. 303 * 304 * In the case of a program eligible, a role type code INJWKR (injured worker) 305 * subtypes the class to indicate that the covered party in a workers 306 * compensation program is an injured worker, and as such, has filed a "claim" 307 * under the program for benefits. Likewise, a covered role type code UNEMP 308 * (unemployed worker) subtypes the program eligible class to indicate that the 309 * covered party in an unemployment insurance program has filed a claim for 310 * unemployment benefits. 311 * 312 * 313 * Example: A party meeting eligibility criteria related to health or financial 314 * status, e.g., in the U.S., persons meeting health, demographic, or financial 315 * criteria established by state and federal law are eligible for Medicaid. 316 */ 317 PROG, 318 /** 319 * A role played by a provider, always a person, who has agency authority from a 320 * Clinical Research Sponsor to direct the conduct of a clinical research trial 321 * or study on behalf of the sponsor. 322 */ 323 CRINV, 324 /** 325 * A role played by an entity, usually an organization, that is the sponsor of a 326 * clinical research trial or study. The sponsor commissions the study, bears 327 * the expenses, is responsible for satisfying all legal requirements concerning 328 * subject safety and privacy, and is generally responsible for collection, 329 * storage and analysis of the data generated during the trial. No scoper is 330 * necessary, as a clinical research sponsor undertakes the role on its own 331 * authority and declaration. Clinical research sponsors are usually educational 332 * or other research organizations, government agencies or biopharmaceutical 333 * companies. 334 */ 335 CRSPNSR, 336 /** 337 * A relationship between a person or organization and a person or organization 338 * formed for the purpose of exchanging work for compensation. The purpose of 339 * the role is to identify the type of relationship the employee has to the 340 * employer, rather than the nature of the work actually performed. (Contrast 341 * with AssignedEntity.) 342 */ 343 EMP, 344 /** 345 * A role played by a member of a military service. Scoper is the military 346 * service (e.g. Army, Navy, Air Force, etc.) or, more specifically, the unit 347 * (e.g. Company C, 3rd Battalion, 4th Division, etc.) 348 */ 349 MIL, 350 /** 351 * A person or organization (player) that serves as a financial guarantor for 352 * another person or organization (scoper). 353 */ 354 GUAR, 355 /** 356 * An entity that is the subject of an investigation. This role is scoped by the 357 * party responsible for the investigation. 358 */ 359 INVSBJ, 360 /** 361 * A person, non-person living subject, or place that is the subject of an 362 * investigation related to a notifiable condition (health circumstance that is 363 * reportable within the applicable public health jurisdiction) 364 */ 365 CASEBJ, 366 /** 367 * Definition:Specifies the administrative functionality within a formal 368 * experimental design for which the ResearchSubject role was established. 369 * 370 * 371 * Examples: Screening - role is used for pre-enrollment evaluation portion of 372 * the design; enrolled - role is used for subjects admitted to the experimental 373 * portion of the design. 374 */ 375 RESBJ, 376 /** 377 * A relationship in which the scoper certifies the player ( e. g. a medical 378 * care giver, a medical device or a provider organization) to perform certain 379 * activities that fall under the jurisdiction of the scoper (e.g., a health 380 * authority licensing healthcare providers, a medical quality authority 381 * certifying healthcare professionals). 382 */ 383 LIC, 384 /** 385 * notary public 386 */ 387 NOT, 388 /** 389 * An Entity (player) that is authorized to provide health care services by some 390 * authorizing agency (scoper). 391 */ 392 PROV, 393 /** 394 * A Role of a LivingSubject (player) as an actual or potential recipient of 395 * health care services from a healthcare provider organization (scoper). 396 * 397 * 398 * Usage Note: Communication about relationships between patients and specific 399 * healthcare practitioners (people) is not done via scoper. Instead this is 400 * generally done using the CareProvision act. This allows linkage between 401 * patient and a particular healthcare practitioner role and also allows 402 * description of the type of care involved in the relationship. 403 */ 404 PAT, 405 /** 406 * The role of an organization or individual designated to receive payment for a 407 * claim against a particular coverage. The scoping entity is the organization 408 * that is the submitter of the invoice in question. 409 */ 410 PAYEE, 411 /** 412 * The role of an organization that undertakes to accept claims invoices, assess 413 * the coverage or payments due for those invoices and pay to the designated 414 * payees for those invoices. This role may be either the underwriter or a 415 * third-party organization authorized by the underwriter. The scoping entity is 416 * the organization that underwrites the claimed coverage. 417 */ 418 PAYOR, 419 /** 420 * A role played by a person or organization that holds an insurance policy. The 421 * underwriter of that policy is the scoping entity. 422 * 423 * 424 * Discussion:The identifier of the policy is captured in 'Role.id' when the 425 * Role is a policy holder. 426 * 427 * A particular policy may cover several individuals one of whom may be, but 428 * need not be, the policy holder. Thus the notion of covered party is a role 429 * that is distinct from that of the policy holder. 430 */ 431 POLHOLD, 432 /** 433 * An entity (player) that has been recognized as having certain 434 * training/experience or other characteristics that would make said entity an 435 * appropriate performer for a certain activity. The scoper is an organization 436 * that educates or qualifies entities. 437 */ 438 QUAL, 439 /** 440 * A role played by an entity, usually an organization that is the sponsor of an 441 * insurance plan or a health program. A sponsor is the party that is ultimately 442 * accountable for the coverage by employment contract or by law. A sponsor can 443 * be an employer, union, government agency, or association. Fully insured 444 * sponsors establish the terms of the plan and contract with health insurance 445 * plans to assume the risk and to administer the plan. Self-insured sponsors 446 * delegate coverage administration, but not risk, to third-party 447 * administrators. Program sponsors designate services to be covered in 448 * accordance with statute. Program sponsors may administer the coverage 449 * themselves, delegate coverage administration, but not risk to third-party 450 * administrators, or contract with health insurance plans to assume the risk 451 * and administrator a program. Sponsors qualify individuals who may become 452 * 453 * 454 * 455 * a policy holder of the plan; 456 * 457 * 458 * 459 * where the sponsor is the policy holder, who may become a subscriber or a 460 * dependent to a policy under the plan; or 461 * 462 * 463 * 464 * where the sponsor is a government agency, who may become program eligibles 465 * under a program. 466 * 467 * 468 * 469 * The sponsor role may be further qualified by the SponsorRole.code. Entities 470 * playing the sponsor role may also play the role of a Coverage Administrator. 471 * 472 * 473 * Example: An employer, union, government agency, or association. 474 */ 475 SPNSR, 476 /** 477 * A role played by an individual who is a student of a school, which is the 478 * scoping entity. 479 */ 480 STD, 481 /** 482 * A role played by a person or an organization. It is the party that 483 * 484 * 485 * 486 * accepts fiscal responsibility for insurance plans and the policies created 487 * under those plans; 488 * 489 * 490 * 491 * administers and accepts fiscal responsibility for a program that provides 492 * coverage for services to eligible individuals; and/or 493 * 494 * 495 * 496 * has the responsibility to assess the merits of each risk and decide a 497 * suitable premium for accepting all or part of the risk. If played by an 498 * organization, this role may be further specified by an appropriate RoleCode. 499 * 500 * 501 * 502 * 503 * Example: 504 * 505 * 506 * 507 * 508 * A health insurer; 509 * 510 * 511 * 512 * Medicaid Program; 513 * 514 * 515 * 516 * Lloyd's of London 517 */ 518 UNDWRT, 519 /** 520 * A person responsible for the primary care of a patient at home. 521 */ 522 CAREGIVER, 523 /** 524 * Links two entities with classCode PSN (person) in a personal relationship. 525 * The character of the relationship must be defined by a 526 * PersonalRelationshipRoleType code. The player and scoper are determined by 527 * PersonalRelationshipRoleType code as well. 528 */ 529 PRS, 530 /** 531 * The "same" roleclass asserts an identity between playing and scoping 532 * entities: that they are in fact instances of the same entity and, in the case 533 * of discrepancies (e.g different DOB, gender), that one or both are in error. 534 * 535 * 536 * Usage: 537 * 538 * 539 * playing and scoping entities must have same classcode, but need not have 540 * identical attributes or values. 541 * 542 * 543 * Example: 544 * 545 * 546 * a provider registry maintains sets of conflicting demographic data for what 547 * is reported to be the same individual. 548 */ 549 SELF, 550 /** 551 * An association for a playing Entity that is used, known, treated, handled, 552 * built, or destroyed, etc. under the auspices of the scoping Entity. The 553 * playing Entity is passive in these roles (even though it may be active in 554 * other roles), in the sense that the kinds of things done to it in this role 555 * happen without an agreement from the playing Entity. 556 */ 557 _ROLECLASSPASSIVE, 558 /** 559 * A role in which the playing entity (material) provides access to another 560 * entity. The principal use case is intravenous (or other bodily) access lines 561 * that preexist and need to be referred to for medication routing instructions. 562 */ 563 ACCESS, 564 /** 565 * A physical association whereby two Entities are in some (even lose) spatial 566 * relationship with each other such that they touch each other in some way. 567 * 568 * 569 * Examples: the colon is connected (and therefore adjacent) to the jejunum; the 570 * colon is adjacent to the liver (even if not actually connected.) 571 * 572 * 573 * UsageConstraints: Adjacency is in principle a symmetrical connection, but 574 * scoper and player of the role should, where applicable, be assigned to have 575 * scoper be the larger, more central Entity and player the smaller, more 576 * distant, appendage. 577 */ 578 ADJY, 579 /** 580 * An adjacency of two Entities held together by a bond which attaches to each 581 * of the two entities. 582 * 583 * 584 * Examples: biceps brachii muscle connected to the radius bone, port 3 on a 585 * network switch connected to port 5 on a patch panel. 586 * 587 * 588 * UsageConstraints: See Adjacency for the assignment of scoper (larger, more 589 * central) and player (smaller, more distant). 590 */ 591 CONC, 592 /** 593 * A connection between two atoms of a molecule. 594 * 595 * 596 * Examples: double bond between first and second C in ethane, peptide bond 597 * between two amino-acid, disulfide bridge between two proteins, chelate and 598 * ion associations, even the much weaker van-der-Waals bonds can be considered 599 * molecular bonds. 600 * 601 * 602 * UsageConstraints: See connection and adjacency for the assignment of player 603 * and scoper. 604 */ 605 BOND, 606 /** 607 * A connection between two regional parts. 608 * 609 * 610 * Examples: the connection between ascending aorta and the aortic arc, 611 * connection between descending colon and sigmoid. 612 * 613 * 614 * UsageConstraints: See connection and adjacency for the assignment of player 615 * and scoper. 616 */ 617 CONY, 618 /** 619 * A material (player) that can be administered to an Entity (scoper). 620 */ 621 ADMM, 622 /** 623 * Relates a place (playing Entity) as the location where a living subject 624 * (scoping Entity) was born. 625 */ 626 BIRTHPL, 627 /** 628 * Definition: Relates a place (playing Entity) as the location where a living 629 * subject (scoping Entity) died. 630 */ 631 DEATHPLC, 632 /** 633 * A material (player) distributed by a distributor (scoper) who functions 634 * between a manufacturer and a buyer or retailer. 635 */ 636 DST, 637 /** 638 * Material (player) sold by a retailer (scoper), who also give advice to 639 * prospective buyers. 640 */ 641 RET, 642 /** 643 * A role played by a place at which the location of an event may be recorded. 644 */ 645 EXLOC, 646 /** 647 * A role played by a place at which services may be provided. 648 */ 649 SDLOC, 650 /** 651 * A role of a place (player) that is intended to house the provision of 652 * services. Scoper is the Entity (typically Organization) that provides these 653 * services. This is not synonymous with "ownership." 654 */ 655 DSDLOC, 656 /** 657 * A role played by a place at which health care services may be provided 658 * without prior designation or authorization. 659 */ 660 ISDLOC, 661 /** 662 * A role played by an entity that has been exposed to a person or animal 663 * suffering a contagious disease, or with a location from which a toxin has 664 * been distributed. The player of the role is normally a person or animal, but 665 * it is possible that other entity types could become exposed. The role is 666 * scoped by the source of the exposure, and it is quite possible for a person 667 * playing the role of exposed party to also become the scoper a role played by 668 * another person. That is to say, once a person has become infected, it is 669 * possible, perhaps likely, for that person to infect others. 670 * 671 * Management of exposures and tracking exposed parties is a key function within 672 * public health, and within most public health contexts - exposed parties are 673 * known as "contacts." 674 */ 675 EXPR, 676 /** 677 * Entity that is currently in the possession of a holder (scoper), who holds, 678 * or uses it, usually based on some agreement with the owner. 679 */ 680 HLD, 681 /** 682 * The role of a material (player) that is the physical health chart belonging 683 * to an organization (scoper). 684 */ 685 HLTHCHRT, 686 /** 687 * A role in which the scoping entity designates an identifier for a playing 688 * entity. 689 */ 690 IDENT, 691 /** 692 * Scoped by the manufacturer 693 */ 694 MANU, 695 /** 696 * A manufactured material (player) that is used for its therapeutic properties. 697 * The manufacturer is the scoper. 698 */ 699 THER, 700 /** 701 * An entity (player) that is maintained by another entity (scoper). This is 702 * typical role held by durable equipment. The scoper assumes responsibility for 703 * proper operation, quality, and safety. 704 */ 705 MNT, 706 /** 707 * An Entity (player) for which someone (scoper) is granted by law the right to 708 * call the material (player) his own. This entitles the scoper to make 709 * decisions about the disposition of that material. 710 */ 711 OWN, 712 /** 713 * A product regulated by some governmentatl orgnization. The role is played by 714 * Material and scoped by Organization. 715 * 716 * Rationale: To support an entity clone used to identify the NDC number for a 717 * drug product. 718 */ 719 RGPR, 720 /** 721 * Relates a place entity (player) as the region over which the scoper 722 * (typically an Organization) has certain authority (jurisdiction). For 723 * example, the Calgary Regional Health Authority (scoper) has authority over 724 * the territory "Region 4 of Alberta" (player) in matters of health. 725 */ 726 TERR, 727 /** 728 * Description:An entity (player) that is used by another entity (scoper) 729 */ 730 USED, 731 /** 732 * A role a product plays when a guarantee is given to the purchaser by the 733 * seller (scoping entity) stating that the product is reliable and free from 734 * known defects and that the seller will repair or replace defective parts 735 * within a given time limit and under certain conditions. 736 */ 737 WRTE, 738 /** 739 * A relationship in which the scoping Entity defines or specifies what the 740 * playing Entity is. Thus, the player's "being" (Greek: ontos) is specified. 741 */ 742 _ROLECLASSONTOLOGICAL, 743 /** 744 * Description: Specifies the player Entity (the equivalent Entity) as an Entity 745 * that is considered to be equivalent to a reference Entity (scoper). The 746 * equivalence is in principle a symmetric relationship, however, it is expected 747 * that the scoper is a reference entity which serves as reference entity for 748 * multiple different equivalent entities. 749 * 750 * 751 * Examples: An innovator's medicine formulation is the reference for 752 * "generics", i.e., formulations manufactured differently but having been 753 * proven to be biologically equivalent to the reference medicine. Another 754 * example is a reference ingredient that serves as basis for quantity 755 * specifications (basis of strength, e.g., metoprolol succinate specified in 756 * terms of metoprolol tartrate.) 757 */ 758 EQUIV, 759 /** 760 * The "same" role asserts an identity between playing and scoping entities, 761 * i.e., that they are in fact two records of the same entity instance, and, in 762 * the case of discrepancies (e.g different DOB, gender), that one or both are 763 * in error. 764 * 765 * 766 * Usage: 767 * 768 * 769 * playing and scoping entities must have same classCode, but need not have 770 * identical attributes or values. 771 * 772 * 773 * Example: 774 * 775 * 776 * a provider registry maintains sets of conflicting demographic data for what 777 * is reported to be the same individual. 778 */ 779 SAME, 780 /** 781 * Relates a prevailing record of an Entity (scoper) with another record 782 * (player) that it subsumes. 783 * 784 * 785 * Examples: Show a correct new Person object (scoper) that subsumes one or more 786 * duplicate Person objects that had accidentally been created for the same 787 * physical person. 788 * 789 * 790 * Constraints: Both the player and scoper must have the same classCode. 791 */ 792 SUBY, 793 /** 794 * Relates a specialized material concept (player) to its generalization 795 * (scoper). 796 */ 797 GEN, 798 /** 799 * A special link between pharmaceuticals indicating that the target (scoper) is 800 * a generic for the source (player). 801 */ 802 GRIC, 803 /** 804 * An individual piece of material (player) instantiating a class of material 805 * (scoper). 806 */ 807 INST, 808 /** 809 * An entity that subsumes the identity of another. Used in the context of 810 * merging documented entity instances. Both the player and scoper must have the 811 * same classCode. 812 * 813 * The use of this code is deprecated in favor of the term SUBY which is its 814 * inverse and is more ontologically correct. 815 */ 816 SUBS, 817 /** 818 * An association between two Entities where the playing Entity is considered in 819 * some way "part" of the scoping Entity, e.g., as a member, component, 820 * ingredient, or content. Being "part" in the broadest sense of the word can 821 * mean anything from being an integral structural component to a mere 822 * incidental temporary association of a playing Entity with a (generally 823 * larger) scoping Entity. 824 */ 825 _ROLECLASSPARTITIVE, 826 /** 827 * Relates a material as the content (player) to a container (scoper). Unlike 828 * ingredients, the content and a container remain separate (not mixed) and the 829 * content can be removed from the container. A content is not part of an empty 830 * container. 831 */ 832 CONT, 833 /** 834 * An exposure agent carrier is an entity that is capable of conveying an 835 * exposure agent from one entity to another. The scoper of the role must be the 836 * exposure agent (e.g., pathogen). 837 */ 838 EXPAGTCAR, 839 /** 840 * Description: A vector is a living subject that carries an exposure agent. The 841 * vector does not cause the disease itself, but exposes targets to the exposure 842 * agent. A mosquito carrying malaria is an example of a vector. The scoper of 843 * the role must be the exposure agent (e.g., pathogen). 844 */ 845 EXPVECTOR, 846 /** 847 * Description: A fomite is a non-living entity that is capable of conveying 848 * exposure agent from one entity to another. A doorknob contaminated with a 849 * Norovirus is an example of a fomite. Anyone touching the doorknob would be 850 * exposed to the virus. The scoper of the role must be the exposure agent 851 * (e.g., pathogen). 852 */ 853 FOMITE, 854 /** 855 * Relates a component (player) to a mixture (scoper). E.g., Glucose and Water 856 * are ingredients of D5W, latex may be an ingredient in a tracheal tube. 857 */ 858 INGR, 859 /** 860 * Definition: a therapeutically active ingredient (player) in a mixture 861 * (scoper), where the mixture is typically a manufactured pharmaceutical. It is 862 * unknown if the quantity of such an ingredient is expressed precisely in terms 863 * of the playing ingredient substance, or, if it is specified in terms of a 864 * closely related substance (active moiety or reference substance). 865 */ 866 ACTI, 867 /** 868 * Description: Active ingredient, where the ingredient substance (player) is 869 * itself the "basis of strength", i.e., where the Role.quantity specifies 870 * exactly the quantity of the player substance in the medicine formulation. 871 * 872 * 873 * Examples: Lopressor 50 mg actually contains 50 mg of metoprolol succinate, 874 * even though the active moiety is metoprolol, but also: Tenormin 50 mg contain 875 * 50 mg of atenolol, as free base, i.e., where the active ingredient atenolol 876 * is also the active moiety. 877 */ 878 ACTIB, 879 /** 880 * Description: Active ingredient, where not the ingredient substance (player), 881 * but itaTMs active moiety is the "basis of strength", i.e., where the 882 * Role.quantity specifies the quantity of the player substance's active moiety 883 * in the medicine formulation. 884 * 885 * 886 * Examples: 1 mL of Betopic 5mg/mL eye drops contains 5.6 mg betaxolol 887 * hydrochloride equivalent to betaxolol base 5 mg. 888 */ 889 ACTIM, 890 /** 891 * Description: Active ingredient, where not the ingredient substance (player) 892 * but another reference substance with the same active moiety, is the "basis of 893 * strength", i.e., where the Role.quantity specifies the quantity of a 894 * reference substance, similar but different from the player substance's in the 895 * medicine formulation. 896 * 897 * 898 * Examples: Toprol-XL 50 mg contains 47.5 mg of metoprolol succinate equivalent 899 * to 50 mg of metoprolol tartrate. 900 */ 901 ACTIR, 902 /** 903 * A component (player) added to enhance the action of an active ingredient 904 * (scoper) (in the manner of a catalyst) but which has no active effect in and 905 * of itself. Such ingredients are significant in defining equivalence of 906 * products in a way that inactive ingredients are not. 907 */ 908 ADJV, 909 /** 910 * An ingredient (player) that is added to a base (scoper), that amounts to a 911 * minor part of the overall mixture. 912 */ 913 ADTV, 914 /** 915 * A base ingredient (player) is what comprises the major part of a mixture 916 * (scoper). E.g., Water in most i.v. solutions, or Vaseline in salves. Among 917 * all ingredients of a material, there should be only one base. A base 918 * substance can, in turn, be a mixture. 919 */ 920 BASE, 921 /** 922 * An ingredient whose presence is not intended but may not be reasonably 923 * avoided given the circumstances of the mixture's nature or origin. 924 */ 925 CNTM, 926 /** 927 * An ingredient which is not considered therapeutically active, e.g., colors, 928 * flavors, stabilizers, or preservatives, fillers, or structural components 929 * added to an active ingredient in order to facilitate administration of the 930 * active ingredient but without being considered therapeutically active. An 931 * inactive ingredient need not be biologically inert, e.g., might be active as 932 * an allergen or might have a pleasant taste, but is not an essential 933 * constituent delivering the therapeutic effect. 934 */ 935 IACT, 936 /** 937 * A substance (player) influencing the optical aspect of material (scoper). 938 */ 939 COLR, 940 /** 941 * A substance (player) added to a mixture (scoper) to make it taste a certain 942 * way. In food the use is obvious, in pharmaceuticals flavors can hide 943 * disgusting taste of the active ingredient (important in pediatric 944 * treatments). 945 */ 946 FLVR, 947 /** 948 * A substance (player) added to a mixture (scoper) to prevent microorganisms 949 * (fungi, bacteria) to spoil the mixture. 950 */ 951 PRSV, 952 /** 953 * A stabilizer (player) added to a mixture (scoper) in order to prevent the 954 * molecular disintegration of the main substance. 955 */ 956 STBL, 957 /** 958 * An ingredient (player) of a medication (scoper) that is inseparable from the 959 * active ingredients, but has no intended chemical or pharmaceutical effect 960 * itself, but which may have some systemic effect on the patient. 961 * 962 * An example is a collagen matrix used as a base for transplanting skin cells. 963 * The collagen matrix can be left permanently in the graft site. Because it is 964 * of bovine origin, the patient may exhibit allergies or may have cultural 965 * objections to its use. 966 */ 967 MECH, 968 /** 969 * Relates an entity (player) to a location (scoper) at which it is present in 970 * some way. This presence may be limited in time. 971 */ 972 LOCE, 973 /** 974 * Relates an entity (player) (e.g. a device) to a location (scoper) at which it 975 * is normally found or stored when not used. 976 */ 977 STOR, 978 /** 979 * A role played by an entity that is a member of a group. The group provides 980 * the scope for this role. 981 * 982 * Among other uses, groups as used in insurance (groups of covered individuals) 983 * and in scheduling where resources may be grouped for scheduling and 984 * logistical purposes. 985 */ 986 MBR, 987 /** 988 * Definition: an association between two Entities where the playing Entity (the 989 * part) is a component of the whole (scoper) in the sense of an integral 990 * structural component, that is distinct from other parts in the same whole, 991 * has a distinct function in the whole, and, as an effect, the full integrity 992 * of the whole depends (to some degree) on the presence of this part, even 993 * though the part may often be separable from the whole. 994 * 995 * 996 * Discussion: Part is defined in opposition to (a) ingredient (not separable), 997 * (b) content (not a functional component), and (c) member (not functionally 998 * distinct from other members). 999 */ 1000 PART, 1001 /** 1002 * The molecule or ion that is responsible for the intended pharmacological 1003 * action of the drug substance, excluding those appended or associated parts of 1004 * the molecule that make the molecule an ester, salt (including a salt with 1005 * hydrogen or coordination bonds), or other noncovalent derivative (such as a 1006 * complex, chelate, or clathrate). 1007 * 1008 * Examples: heparin-sodium and heparin-potassium have the same active moiety, 1009 * heparin; the active moiety of morphine-hydrochloride is morphine. 1010 */ 1011 ACTM, 1012 /** 1013 * A role played by a material entity that is a specimen for an act. It is 1014 * scoped by the source of the specimen. 1015 */ 1016 SPEC, 1017 /** 1018 * A portion (player) of an original or source specimen (scoper) used for 1019 * testing or transportation. 1020 */ 1021 ALQT, 1022 /** 1023 * A microorganism that has been isolated from other microorganisms or a source 1024 * matrix. 1025 */ 1026 ISLT, 1027 /** 1028 * The player of the role is a child of the scoping entity, in a generic sense. 1029 */ 1030 CHILD, 1031 /** 1032 * A role played by an entity that receives credentials from the scoping entity. 1033 */ 1034 CRED, 1035 /** 1036 * nurse practitioner 1037 */ 1038 NURPRAC, 1039 /** 1040 * nurse 1041 */ 1042 NURS, 1043 /** 1044 * physician assistant 1045 */ 1046 PA, 1047 /** 1048 * physician 1049 */ 1050 PHYS, 1051 /** 1052 * added to help the parsers 1053 */ 1054 NULL; 1055 1056 public static V3RoleClass fromCode(String codeString) throws FHIRException { 1057 if (codeString == null || "".equals(codeString)) 1058 return null; 1059 if ("ROL".equals(codeString)) 1060 return ROL; 1061 if ("_RoleClassAssociative".equals(codeString)) 1062 return _ROLECLASSASSOCIATIVE; 1063 if ("_RoleClassMutualRelationship".equals(codeString)) 1064 return _ROLECLASSMUTUALRELATIONSHIP; 1065 if ("_RoleClassRelationshipFormal".equals(codeString)) 1066 return _ROLECLASSRELATIONSHIPFORMAL; 1067 if ("AFFL".equals(codeString)) 1068 return AFFL; 1069 if ("AGNT".equals(codeString)) 1070 return AGNT; 1071 if ("ASSIGNED".equals(codeString)) 1072 return ASSIGNED; 1073 if ("COMPAR".equals(codeString)) 1074 return COMPAR; 1075 if ("SGNOFF".equals(codeString)) 1076 return SGNOFF; 1077 if ("CON".equals(codeString)) 1078 return CON; 1079 if ("ECON".equals(codeString)) 1080 return ECON; 1081 if ("NOK".equals(codeString)) 1082 return NOK; 1083 if ("GUARD".equals(codeString)) 1084 return GUARD; 1085 if ("CIT".equals(codeString)) 1086 return CIT; 1087 if ("COVPTY".equals(codeString)) 1088 return COVPTY; 1089 if ("CLAIM".equals(codeString)) 1090 return CLAIM; 1091 if ("NAMED".equals(codeString)) 1092 return NAMED; 1093 if ("DEPEN".equals(codeString)) 1094 return DEPEN; 1095 if ("INDIV".equals(codeString)) 1096 return INDIV; 1097 if ("SUBSCR".equals(codeString)) 1098 return SUBSCR; 1099 if ("PROG".equals(codeString)) 1100 return PROG; 1101 if ("CRINV".equals(codeString)) 1102 return CRINV; 1103 if ("CRSPNSR".equals(codeString)) 1104 return CRSPNSR; 1105 if ("EMP".equals(codeString)) 1106 return EMP; 1107 if ("MIL".equals(codeString)) 1108 return MIL; 1109 if ("GUAR".equals(codeString)) 1110 return GUAR; 1111 if ("INVSBJ".equals(codeString)) 1112 return INVSBJ; 1113 if ("CASEBJ".equals(codeString)) 1114 return CASEBJ; 1115 if ("RESBJ".equals(codeString)) 1116 return RESBJ; 1117 if ("LIC".equals(codeString)) 1118 return LIC; 1119 if ("NOT".equals(codeString)) 1120 return NOT; 1121 if ("PROV".equals(codeString)) 1122 return PROV; 1123 if ("PAT".equals(codeString)) 1124 return PAT; 1125 if ("PAYEE".equals(codeString)) 1126 return PAYEE; 1127 if ("PAYOR".equals(codeString)) 1128 return PAYOR; 1129 if ("POLHOLD".equals(codeString)) 1130 return POLHOLD; 1131 if ("QUAL".equals(codeString)) 1132 return QUAL; 1133 if ("SPNSR".equals(codeString)) 1134 return SPNSR; 1135 if ("STD".equals(codeString)) 1136 return STD; 1137 if ("UNDWRT".equals(codeString)) 1138 return UNDWRT; 1139 if ("CAREGIVER".equals(codeString)) 1140 return CAREGIVER; 1141 if ("PRS".equals(codeString)) 1142 return PRS; 1143 if ("SELF".equals(codeString)) 1144 return SELF; 1145 if ("_RoleClassPassive".equals(codeString)) 1146 return _ROLECLASSPASSIVE; 1147 if ("ACCESS".equals(codeString)) 1148 return ACCESS; 1149 if ("ADJY".equals(codeString)) 1150 return ADJY; 1151 if ("CONC".equals(codeString)) 1152 return CONC; 1153 if ("BOND".equals(codeString)) 1154 return BOND; 1155 if ("CONY".equals(codeString)) 1156 return CONY; 1157 if ("ADMM".equals(codeString)) 1158 return ADMM; 1159 if ("BIRTHPL".equals(codeString)) 1160 return BIRTHPL; 1161 if ("DEATHPLC".equals(codeString)) 1162 return DEATHPLC; 1163 if ("DST".equals(codeString)) 1164 return DST; 1165 if ("RET".equals(codeString)) 1166 return RET; 1167 if ("EXLOC".equals(codeString)) 1168 return EXLOC; 1169 if ("SDLOC".equals(codeString)) 1170 return SDLOC; 1171 if ("DSDLOC".equals(codeString)) 1172 return DSDLOC; 1173 if ("ISDLOC".equals(codeString)) 1174 return ISDLOC; 1175 if ("EXPR".equals(codeString)) 1176 return EXPR; 1177 if ("HLD".equals(codeString)) 1178 return HLD; 1179 if ("HLTHCHRT".equals(codeString)) 1180 return HLTHCHRT; 1181 if ("IDENT".equals(codeString)) 1182 return IDENT; 1183 if ("MANU".equals(codeString)) 1184 return MANU; 1185 if ("THER".equals(codeString)) 1186 return THER; 1187 if ("MNT".equals(codeString)) 1188 return MNT; 1189 if ("OWN".equals(codeString)) 1190 return OWN; 1191 if ("RGPR".equals(codeString)) 1192 return RGPR; 1193 if ("TERR".equals(codeString)) 1194 return TERR; 1195 if ("USED".equals(codeString)) 1196 return USED; 1197 if ("WRTE".equals(codeString)) 1198 return WRTE; 1199 if ("_RoleClassOntological".equals(codeString)) 1200 return _ROLECLASSONTOLOGICAL; 1201 if ("EQUIV".equals(codeString)) 1202 return EQUIV; 1203 if ("SAME".equals(codeString)) 1204 return SAME; 1205 if ("SUBY".equals(codeString)) 1206 return SUBY; 1207 if ("GEN".equals(codeString)) 1208 return GEN; 1209 if ("GRIC".equals(codeString)) 1210 return GRIC; 1211 if ("INST".equals(codeString)) 1212 return INST; 1213 if ("SUBS".equals(codeString)) 1214 return SUBS; 1215 if ("_RoleClassPartitive".equals(codeString)) 1216 return _ROLECLASSPARTITIVE; 1217 if ("CONT".equals(codeString)) 1218 return CONT; 1219 if ("EXPAGTCAR".equals(codeString)) 1220 return EXPAGTCAR; 1221 if ("EXPVECTOR".equals(codeString)) 1222 return EXPVECTOR; 1223 if ("FOMITE".equals(codeString)) 1224 return FOMITE; 1225 if ("INGR".equals(codeString)) 1226 return INGR; 1227 if ("ACTI".equals(codeString)) 1228 return ACTI; 1229 if ("ACTIB".equals(codeString)) 1230 return ACTIB; 1231 if ("ACTIM".equals(codeString)) 1232 return ACTIM; 1233 if ("ACTIR".equals(codeString)) 1234 return ACTIR; 1235 if ("ADJV".equals(codeString)) 1236 return ADJV; 1237 if ("ADTV".equals(codeString)) 1238 return ADTV; 1239 if ("BASE".equals(codeString)) 1240 return BASE; 1241 if ("CNTM".equals(codeString)) 1242 return CNTM; 1243 if ("IACT".equals(codeString)) 1244 return IACT; 1245 if ("COLR".equals(codeString)) 1246 return COLR; 1247 if ("FLVR".equals(codeString)) 1248 return FLVR; 1249 if ("PRSV".equals(codeString)) 1250 return PRSV; 1251 if ("STBL".equals(codeString)) 1252 return STBL; 1253 if ("MECH".equals(codeString)) 1254 return MECH; 1255 if ("LOCE".equals(codeString)) 1256 return LOCE; 1257 if ("STOR".equals(codeString)) 1258 return STOR; 1259 if ("MBR".equals(codeString)) 1260 return MBR; 1261 if ("PART".equals(codeString)) 1262 return PART; 1263 if ("ACTM".equals(codeString)) 1264 return ACTM; 1265 if ("SPEC".equals(codeString)) 1266 return SPEC; 1267 if ("ALQT".equals(codeString)) 1268 return ALQT; 1269 if ("ISLT".equals(codeString)) 1270 return ISLT; 1271 if ("CHILD".equals(codeString)) 1272 return CHILD; 1273 if ("CRED".equals(codeString)) 1274 return CRED; 1275 if ("NURPRAC".equals(codeString)) 1276 return NURPRAC; 1277 if ("NURS".equals(codeString)) 1278 return NURS; 1279 if ("PA".equals(codeString)) 1280 return PA; 1281 if ("PHYS".equals(codeString)) 1282 return PHYS; 1283 throw new FHIRException("Unknown V3RoleClass code '" + codeString + "'"); 1284 } 1285 1286 public String toCode() { 1287 switch (this) { 1288 case ROL: 1289 return "ROL"; 1290 case _ROLECLASSASSOCIATIVE: 1291 return "_RoleClassAssociative"; 1292 case _ROLECLASSMUTUALRELATIONSHIP: 1293 return "_RoleClassMutualRelationship"; 1294 case _ROLECLASSRELATIONSHIPFORMAL: 1295 return "_RoleClassRelationshipFormal"; 1296 case AFFL: 1297 return "AFFL"; 1298 case AGNT: 1299 return "AGNT"; 1300 case ASSIGNED: 1301 return "ASSIGNED"; 1302 case COMPAR: 1303 return "COMPAR"; 1304 case SGNOFF: 1305 return "SGNOFF"; 1306 case CON: 1307 return "CON"; 1308 case ECON: 1309 return "ECON"; 1310 case NOK: 1311 return "NOK"; 1312 case GUARD: 1313 return "GUARD"; 1314 case CIT: 1315 return "CIT"; 1316 case COVPTY: 1317 return "COVPTY"; 1318 case CLAIM: 1319 return "CLAIM"; 1320 case NAMED: 1321 return "NAMED"; 1322 case DEPEN: 1323 return "DEPEN"; 1324 case INDIV: 1325 return "INDIV"; 1326 case SUBSCR: 1327 return "SUBSCR"; 1328 case PROG: 1329 return "PROG"; 1330 case CRINV: 1331 return "CRINV"; 1332 case CRSPNSR: 1333 return "CRSPNSR"; 1334 case EMP: 1335 return "EMP"; 1336 case MIL: 1337 return "MIL"; 1338 case GUAR: 1339 return "GUAR"; 1340 case INVSBJ: 1341 return "INVSBJ"; 1342 case CASEBJ: 1343 return "CASEBJ"; 1344 case RESBJ: 1345 return "RESBJ"; 1346 case LIC: 1347 return "LIC"; 1348 case NOT: 1349 return "NOT"; 1350 case PROV: 1351 return "PROV"; 1352 case PAT: 1353 return "PAT"; 1354 case PAYEE: 1355 return "PAYEE"; 1356 case PAYOR: 1357 return "PAYOR"; 1358 case POLHOLD: 1359 return "POLHOLD"; 1360 case QUAL: 1361 return "QUAL"; 1362 case SPNSR: 1363 return "SPNSR"; 1364 case STD: 1365 return "STD"; 1366 case UNDWRT: 1367 return "UNDWRT"; 1368 case CAREGIVER: 1369 return "CAREGIVER"; 1370 case PRS: 1371 return "PRS"; 1372 case SELF: 1373 return "SELF"; 1374 case _ROLECLASSPASSIVE: 1375 return "_RoleClassPassive"; 1376 case ACCESS: 1377 return "ACCESS"; 1378 case ADJY: 1379 return "ADJY"; 1380 case CONC: 1381 return "CONC"; 1382 case BOND: 1383 return "BOND"; 1384 case CONY: 1385 return "CONY"; 1386 case ADMM: 1387 return "ADMM"; 1388 case BIRTHPL: 1389 return "BIRTHPL"; 1390 case DEATHPLC: 1391 return "DEATHPLC"; 1392 case DST: 1393 return "DST"; 1394 case RET: 1395 return "RET"; 1396 case EXLOC: 1397 return "EXLOC"; 1398 case SDLOC: 1399 return "SDLOC"; 1400 case DSDLOC: 1401 return "DSDLOC"; 1402 case ISDLOC: 1403 return "ISDLOC"; 1404 case EXPR: 1405 return "EXPR"; 1406 case HLD: 1407 return "HLD"; 1408 case HLTHCHRT: 1409 return "HLTHCHRT"; 1410 case IDENT: 1411 return "IDENT"; 1412 case MANU: 1413 return "MANU"; 1414 case THER: 1415 return "THER"; 1416 case MNT: 1417 return "MNT"; 1418 case OWN: 1419 return "OWN"; 1420 case RGPR: 1421 return "RGPR"; 1422 case TERR: 1423 return "TERR"; 1424 case USED: 1425 return "USED"; 1426 case WRTE: 1427 return "WRTE"; 1428 case _ROLECLASSONTOLOGICAL: 1429 return "_RoleClassOntological"; 1430 case EQUIV: 1431 return "EQUIV"; 1432 case SAME: 1433 return "SAME"; 1434 case SUBY: 1435 return "SUBY"; 1436 case GEN: 1437 return "GEN"; 1438 case GRIC: 1439 return "GRIC"; 1440 case INST: 1441 return "INST"; 1442 case SUBS: 1443 return "SUBS"; 1444 case _ROLECLASSPARTITIVE: 1445 return "_RoleClassPartitive"; 1446 case CONT: 1447 return "CONT"; 1448 case EXPAGTCAR: 1449 return "EXPAGTCAR"; 1450 case EXPVECTOR: 1451 return "EXPVECTOR"; 1452 case FOMITE: 1453 return "FOMITE"; 1454 case INGR: 1455 return "INGR"; 1456 case ACTI: 1457 return "ACTI"; 1458 case ACTIB: 1459 return "ACTIB"; 1460 case ACTIM: 1461 return "ACTIM"; 1462 case ACTIR: 1463 return "ACTIR"; 1464 case ADJV: 1465 return "ADJV"; 1466 case ADTV: 1467 return "ADTV"; 1468 case BASE: 1469 return "BASE"; 1470 case CNTM: 1471 return "CNTM"; 1472 case IACT: 1473 return "IACT"; 1474 case COLR: 1475 return "COLR"; 1476 case FLVR: 1477 return "FLVR"; 1478 case PRSV: 1479 return "PRSV"; 1480 case STBL: 1481 return "STBL"; 1482 case MECH: 1483 return "MECH"; 1484 case LOCE: 1485 return "LOCE"; 1486 case STOR: 1487 return "STOR"; 1488 case MBR: 1489 return "MBR"; 1490 case PART: 1491 return "PART"; 1492 case ACTM: 1493 return "ACTM"; 1494 case SPEC: 1495 return "SPEC"; 1496 case ALQT: 1497 return "ALQT"; 1498 case ISLT: 1499 return "ISLT"; 1500 case CHILD: 1501 return "CHILD"; 1502 case CRED: 1503 return "CRED"; 1504 case NURPRAC: 1505 return "NURPRAC"; 1506 case NURS: 1507 return "NURS"; 1508 case PA: 1509 return "PA"; 1510 case PHYS: 1511 return "PHYS"; 1512 case NULL: 1513 return null; 1514 default: 1515 return "?"; 1516 } 1517 } 1518 1519 public String getSystem() { 1520 return "http://terminology.hl7.org/CodeSystem/v3-RoleClass"; 1521 } 1522 1523 public String getDefinition() { 1524 switch (this) { 1525 case ROL: 1526 return "Corresponds to the Role class"; 1527 case _ROLECLASSASSOCIATIVE: 1528 return "A general association between two entities that is neither partitive nor ontological."; 1529 case _ROLECLASSMUTUALRELATIONSHIP: 1530 return "A relationship that is based on mutual behavior of the two Entities as being related. The basis of such relationship may be agreements (e.g., spouses, contract parties) or they may be de facto behavior (e.g. friends) or may be an incidental involvement with each other (e.g. parties over a dispute, siblings, children)."; 1531 case _ROLECLASSRELATIONSHIPFORMAL: 1532 return "A relationship between two entities that is formally recognized, frequently by a contract or similar agreement."; 1533 case AFFL: 1534 return "Player of the Affiliate role has a business/professional relationship with scoper. Player and scoper may be persons or organization. The Affiliate relationship does not imply membership in a group, nor does it exist for resource scheduling purposes.\r\n\n \n Example: A healthcare provider is affiliated with another provider as a business associate."; 1535 case AGNT: 1536 return "An entity (player) that acts or is authorized to act on behalf of another entity (scoper)."; 1537 case ASSIGNED: 1538 return "An agent role in which the agent is an Entity acting in the employ of an organization. The focus is on functional role on behalf of the organization, unlike the Employee role where the focus is on the 'Human Resources' relationship between the employee and the organization."; 1539 case COMPAR: 1540 return "An Entity that is authorized to issue or instantiate permissions, privileges, credentials or other formal/legal authorizations."; 1541 case SGNOFF: 1542 return "The role of a person (player) who is the officer or signature authority for of a scoping entity, usually an organization (scoper)."; 1543 case CON: 1544 return "A person or an organization (player) which provides or receives information regarding another entity (scoper). Examples; patient NOK and emergency contacts; guarantor contact; employer contact."; 1545 case ECON: 1546 return "An entity to be contacted in the event of an emergency."; 1547 case NOK: 1548 return "An individual designated for notification as the next of kin for a given entity."; 1549 case GUARD: 1550 return "Guardian of a ward"; 1551 case CIT: 1552 return "Citizen of apolitical entity"; 1553 case COVPTY: 1554 return "A role class played by a person who receives benefit coverage under the terms of a particular insurance policy. The underwriter of that policy is the scoping entity. The covered party receives coverage because of some contractual or other relationship with the holder of that policy.\r\n\n \n Discussion:This reason for coverage is captured in 'Role.code' and a relationship link with type code of indirect authority should be included using the policy holder role as the source, and the covered party role as the target.\r\n\n Note that a particular policy may cover several individuals one of whom may be, but need not be, the policy holder. Thus the notion of covered party is a role that is distinct from that of the policy holder."; 1555 case CLAIM: 1556 return "Description: A role played by a party making a claim for coverage under a policy or program. A claimant must be either a person or organization, or a group of persons or organizations. A claimant is not a named insured or a program eligible.\r\n\n \n Discussion: With respect to liability insurance such as property and casualty insurance, a claimant must file a claim requesting indemnification for a loss that the claimant considers covered under the policy of a named insured. The claims adjuster for the policy underwriter will review the claim to determine whether the loss meets the benefit coverage criteria under a policy, and base any indemnification or coverage payment on that review. If a third party is liable in whole or part for the loss, the underwriter may pursue third party liability recovery. A claimant may be involved in civil or criminal legal proceedings involving claims against a defendant party that is indemnified by an insurance policy or to protest the finding of a claims adjustor. With respect to life insurance, a beneficiary designated by a named insured becomes a claimant of the proceeds of coverage, as in the case of a life insurance policy. However, a claimant for coverage under life insurance is not necessarily a designated beneficiary.\r\n\n \n Note: A claimant is not a named insured. However, a named insured may make a claim under a policy, e.g., an insured driver may make a claim for an injury under his or her comprehensive automobile insurance policy. Similarly, a program eligible may make a claim under program, e.g., an unemployed worker may claim benefits under an unemployment insurance program, but parties playing these covered party role classes are not, for purposes of this vocabulary and in an effort to clearly distinguish role classes, considered claimants.\r\n\n In the case of a named insured making a claim, a role type code INSCLM (insured claimant) subtypes the class to indicate that either a named insured or an individual insured has filed a claim for a loss. In the case of a program eligible, a role type code INJWKR (injured worker) subtypes the class to indicate that the covered party in a workers compensation program is an injured worker, and as such, has filed a \"claim\" under the program for benefits. Likewise, a covered role type code UNEMP (unemployed worker) subtypes the program eligible class to indicate that the covered party in an unemployment insurance program has filed a claim for unemployment benefits.\r\n\n \n Example: A claimant under automobile policy that is not the named insured."; 1557 case NAMED: 1558 return "Description: A role played by a party to an insurance policy to which the insurer agrees to indemnify for losses, provides benefits for, or renders services. A named insured may be either a person, non-person living subject, or an organization, or a group of persons, non-person living subjects, or organizations.\r\n\n \n Discussion: The coded concept NAMED should not be used where a more specific child concept in this Specializable value set applies. In some cases, the named insured may not be the policy holder, e.g., where a policy holder purchases life insurance policy in which another party is the named insured and the policy holder is the beneficiary of the policy.\r\n\n \n Note: The party playing the role of a named insured is not a claimant in the sense conveyed by the RoleClassCoveredParty CLAIM (claimant). However, a named insured may make a claim under a policy, e.g., e.g., a party that is the named insured and policy holder under a comprehensive automobile insurance policy may become the claimant for coverage under that policy e.g., if injured in an automobile accident and there is no liable third party. In the case of a named insured making a claim, a role type code INSCLM (insured claimant) subtypes the class to indicate that a named insured has filed a claim for a loss.\r\n\n \n Example: The named insured under a comprehensive automobile, disability, or property and casualty policy that is the named insured and may or may not be the policy holder."; 1559 case DEPEN: 1560 return "Description: A role played by a person covered under a policy or program based on an association with a subscriber, which is recognized by the policy holder.\r\n\n \n Note: The party playing the role of a dependent is not a claimant in the sense conveyed by the RoleClassCoveredParty CLAIM (claimant). However, a dependent may make a claim under a policy, e.g., a dependent under a health insurance policy may become the claimant for coverage under that policy for wellness examines or if injured and there is no liable third party. In the case of a dependent making a claim, a role type code INSCLM (insured claimant) subtypes the class to indicate that the dependent has filed a claim for services covered under the health insurance policy.\r\n\n \n Example: The dependent has an association with the subscriber such as a financial dependency or personal relationship such as that of a spouse, or a natural or adopted child. The policy holder may be required by law to recognize certain associations or may have discretion about the associations. For example, a policy holder may dictate the criteria for the dependent status of adult children who are students, such as requiring full time enrollment, or may recognize domestic partners as dependents. Under certain circumstances, the dependent may be under the indirect authority of a responsible party acting as a surrogate for the subscriber, for example, if the subscriber is differently abled or deceased, a guardian ad Lidem or estate executor may be appointed to assume the subscriberaTMs legal standing in the relationship with the dependent."; 1561 case INDIV: 1562 return "Description: A role played by a party covered under a policy as the policy holder. An individual may be either a person or an organization.\r\n\n \n Note: The party playing the role of an individual insured is not a claimant in the sense conveyed by the RoleClassCoveredParty CLAIM (claimant). However, a named insured may make a claim under a policy, e.g., a party that is the named insured and policy holder under a comprehensive automobile insurance policy may become the claimant for coverage under that policy if injured in an automobile accident and there is no liable third party. In the case of an individual insured making a claim, a role type code INSCLM (insured claimant) subtypes the class to indicate that an individual insured has filed a claim for a loss.\r\n\n \n Example: The individual insured under a comprehensive automobile, disability, or property and casualty policy that is the policy holder."; 1563 case SUBSCR: 1564 return "Description: A role played by a person covered under a policy based on association with a sponsor who is the policy holder, and whose association may provide for the eligibility of dependents for coverage.\r\n\n \n Discussion: The policy holder holds the contract with the policy or program underwriter. The subscriber holds a certificate of coverage under the contract. In legal proceedings concerning the policy or program, the terms of the contract takes precedence over the terms of the certificate of coverage if there are any inconsistencies.\r\n\n \n Note: The party playing the role of a subscriber is not a claimant in the sense conveyed by the RoleClassCoveredParty CLAIM (claimant). However, a subscriber may make a claim under a policy, e.g., a subscriber under a health insurance policy may become the claimant for coverage under that policy for wellness examines or if injured and there is no liable third party. In the case of a subscriber making a claim, a role type code INSCLM (insured claimant) subtypes the class to indicate that the subscriber has filed a claim for services covered under the health insurance policy.\r\n\n \n Example: An employee or a member of an association."; 1565 case PROG: 1566 return "Description: A role played by a party that meets the eligibility criteria for coverage under a program. A program eligible may be either a person, non-person living subject, or an organization, or a group of persons, non-person living subjects, or organizations.\r\n\n \n Discussion: A program as typically government administered coverage for parties determined eligible under the terms of the program.\r\n\n \n Note: The party playing a program eligible is not a claimant in the sense conveyed by the RoleClassCoveredParty CLAIM (claimant). However a program eligible may make a claim under program, e.g., an unemployed worker may claim benefits under an unemployment insurance program, but parties playing these covered party role classes are not, for purposes of this vocabulary and in an effort to clearly distinguish role classes, considered claimants.\r\n\n In the case of a program eligible, a role type code INJWKR (injured worker) subtypes the class to indicate that the covered party in a workers compensation program is an injured worker, and as such, has filed a \"claim\" under the program for benefits. Likewise, a covered role type code UNEMP (unemployed worker) subtypes the program eligible class to indicate that the covered party in an unemployment insurance program has filed a claim for unemployment benefits.\r\n\n \n Example: A party meeting eligibility criteria related to health or financial status, e.g., in the U.S., persons meeting health, demographic, or financial criteria established by state and federal law are eligible for Medicaid."; 1567 case CRINV: 1568 return "A role played by a provider, always a person, who has agency authority from a Clinical Research Sponsor to direct the conduct of a clinical research trial or study on behalf of the sponsor."; 1569 case CRSPNSR: 1570 return "A role played by an entity, usually an organization, that is the sponsor of a clinical research trial or study. The sponsor commissions the study, bears the expenses, is responsible for satisfying all legal requirements concerning subject safety and privacy, and is generally responsible for collection, storage and analysis of the data generated during the trial. No scoper is necessary, as a clinical research sponsor undertakes the role on its own authority and declaration. Clinical research sponsors are usually educational or other research organizations, government agencies or biopharmaceutical companies."; 1571 case EMP: 1572 return "A relationship between a person or organization and a person or organization formed for the purpose of exchanging work for compensation. The purpose of the role is to identify the type of relationship the employee has to the employer, rather than the nature of the work actually performed. (Contrast with AssignedEntity.)"; 1573 case MIL: 1574 return "A role played by a member of a military service. Scoper is the military service (e.g. Army, Navy, Air Force, etc.) or, more specifically, the unit (e.g. Company C, 3rd Battalion, 4th Division, etc.)"; 1575 case GUAR: 1576 return "A person or organization (player) that serves as a financial guarantor for another person or organization (scoper)."; 1577 case INVSBJ: 1578 return "An entity that is the subject of an investigation. This role is scoped by the party responsible for the investigation."; 1579 case CASEBJ: 1580 return "A person, non-person living subject, or place that is the subject of an investigation related to a notifiable condition (health circumstance that is reportable within the applicable public health jurisdiction)"; 1581 case RESBJ: 1582 return "Definition:Specifies the administrative functionality within a formal experimental design for which the ResearchSubject role was established.\r\n\n \n Examples: Screening - role is used for pre-enrollment evaluation portion of the design; enrolled - role is used for subjects admitted to the experimental portion of the design."; 1583 case LIC: 1584 return "A relationship in which the scoper certifies the player ( e. g. a medical care giver, a medical device or a provider organization) to perform certain activities that fall under the jurisdiction of the scoper (e.g., a health authority licensing healthcare providers, a medical quality authority certifying healthcare professionals)."; 1585 case NOT: 1586 return "notary public"; 1587 case PROV: 1588 return "An Entity (player) that is authorized to provide health care services by some authorizing agency (scoper)."; 1589 case PAT: 1590 return "A Role of a LivingSubject (player) as an actual or potential recipient of health care services from a healthcare provider organization (scoper).\r\n\n \n Usage Note: Communication about relationships between patients and specific healthcare practitioners (people) is not done via scoper. Instead this is generally done using the CareProvision act. This allows linkage between patient and a particular healthcare practitioner role and also allows description of the type of care involved in the relationship."; 1591 case PAYEE: 1592 return "The role of an organization or individual designated to receive payment for a claim against a particular coverage. The scoping entity is the organization that is the submitter of the invoice in question."; 1593 case PAYOR: 1594 return "The role of an organization that undertakes to accept claims invoices, assess the coverage or payments due for those invoices and pay to the designated payees for those invoices. This role may be either the underwriter or a third-party organization authorized by the underwriter. The scoping entity is the organization that underwrites the claimed coverage."; 1595 case POLHOLD: 1596 return "A role played by a person or organization that holds an insurance policy. The underwriter of that policy is the scoping entity.\r\n\n \n Discussion:The identifier of the policy is captured in 'Role.id' when the Role is a policy holder.\r\n\n A particular policy may cover several individuals one of whom may be, but need not be, the policy holder. Thus the notion of covered party is a role that is distinct from that of the policy holder."; 1597 case QUAL: 1598 return "An entity (player) that has been recognized as having certain training/experience or other characteristics that would make said entity an appropriate performer for a certain activity. The scoper is an organization that educates or qualifies entities."; 1599 case SPNSR: 1600 return "A role played by an entity, usually an organization that is the sponsor of an insurance plan or a health program. A sponsor is the party that is ultimately accountable for the coverage by employment contract or by law. A sponsor can be an employer, union, government agency, or association. Fully insured sponsors establish the terms of the plan and contract with health insurance plans to assume the risk and to administer the plan. Self-insured sponsors delegate coverage administration, but not risk, to third-party administrators. Program sponsors designate services to be covered in accordance with statute. Program sponsors may administer the coverage themselves, delegate coverage administration, but not risk to third-party administrators, or contract with health insurance plans to assume the risk and administrator a program. Sponsors qualify individuals who may become \r\n\n \n \n a policy holder of the plan;\r\n\n \n \n where the sponsor is the policy holder, who may become a subscriber or a dependent to a policy under the plan; or\r\n\n \n \n where the sponsor is a government agency, who may become program eligibles under a program. \r\n\n \n \n The sponsor role may be further qualified by the SponsorRole.code. Entities playing the sponsor role may also play the role of a Coverage Administrator.\r\n\n \n Example: An employer, union, government agency, or association."; 1601 case STD: 1602 return "A role played by an individual who is a student of a school, which is the scoping entity."; 1603 case UNDWRT: 1604 return "A role played by a person or an organization. It is the party that \r\n\n \n \n accepts fiscal responsibility for insurance plans and the policies created under those plans;\r\n\n \n \n administers and accepts fiscal responsibility for a program that provides coverage for services to eligible individuals; and/or\r\n\n \n \n has the responsibility to assess the merits of each risk and decide a suitable premium for accepting all or part of the risk. If played by an organization, this role may be further specified by an appropriate RoleCode.\r\n\n \n \n \n Example:\n \r\n\n \n \n A health insurer; \r\n\n \n \n Medicaid Program;\r\n\n \n \n Lloyd's of London"; 1605 case CAREGIVER: 1606 return "A person responsible for the primary care of a patient at home."; 1607 case PRS: 1608 return "Links two entities with classCode PSN (person) in a personal relationship. The character of the relationship must be defined by a PersonalRelationshipRoleType code. The player and scoper are determined by PersonalRelationshipRoleType code as well."; 1609 case SELF: 1610 return "The \"same\" roleclass asserts an identity between playing and scoping entities: that they are in fact instances of the same entity and, in the case of discrepancies (e.g different DOB, gender), that one or both are in error.\r\n\n \n Usage:\n \r\n\n playing and scoping entities must have same classcode, but need not have identical attributes or values. \r\n\n \n Example: \n \r\n\n a provider registry maintains sets of conflicting demographic data for what is reported to be the same individual."; 1611 case _ROLECLASSPASSIVE: 1612 return "An association for a playing Entity that is used, known, treated, handled, built, or destroyed, etc. under the auspices of the scoping Entity. The playing Entity is passive in these roles (even though it may be active in other roles), in the sense that the kinds of things done to it in this role happen without an agreement from the playing Entity."; 1613 case ACCESS: 1614 return "A role in which the playing entity (material) provides access to another entity. The principal use case is intravenous (or other bodily) access lines that preexist and need to be referred to for medication routing instructions."; 1615 case ADJY: 1616 return "A physical association whereby two Entities are in some (even lose) spatial relationship with each other such that they touch each other in some way.\r\n\n \n Examples: the colon is connected (and therefore adjacent) to the jejunum; the colon is adjacent to the liver (even if not actually connected.)\r\n\n \n UsageConstraints: Adjacency is in principle a symmetrical connection, but scoper and player of the role should, where applicable, be assigned to have scoper be the larger, more central Entity and player the smaller, more distant, appendage."; 1617 case CONC: 1618 return "An adjacency of two Entities held together by a bond which attaches to each of the two entities. \r\n\n \n Examples: biceps brachii muscle connected to the radius bone, port 3 on a network switch connected to port 5 on a patch panel.\r\n\n \n UsageConstraints: See Adjacency for the assignment of scoper (larger, more central) and player (smaller, more distant)."; 1619 case BOND: 1620 return "A connection between two atoms of a molecule.\r\n\n \n Examples: double bond between first and second C in ethane, peptide bond between two amino-acid, disulfide bridge between two proteins, chelate and ion associations, even the much weaker van-der-Waals bonds can be considered molecular bonds.\r\n\n \n UsageConstraints: See connection and adjacency for the assignment of player and scoper."; 1621 case CONY: 1622 return "A connection between two regional parts.\r\n\n \n Examples: the connection between ascending aorta and the aortic arc, connection between descending colon and sigmoid.\r\n\n \n UsageConstraints: See connection and adjacency for the assignment of player and scoper."; 1623 case ADMM: 1624 return "A material (player) that can be administered to an Entity (scoper)."; 1625 case BIRTHPL: 1626 return "Relates a place (playing Entity) as the location where a living subject (scoping Entity) was born."; 1627 case DEATHPLC: 1628 return "Definition: Relates a place (playing Entity) as the location where a living subject (scoping Entity) died."; 1629 case DST: 1630 return "A material (player) distributed by a distributor (scoper) who functions between a manufacturer and a buyer or retailer."; 1631 case RET: 1632 return "Material (player) sold by a retailer (scoper), who also give advice to prospective buyers."; 1633 case EXLOC: 1634 return "A role played by a place at which the location of an event may be recorded."; 1635 case SDLOC: 1636 return "A role played by a place at which services may be provided."; 1637 case DSDLOC: 1638 return "A role of a place (player) that is intended to house the provision of services. Scoper is the Entity (typically Organization) that provides these services. This is not synonymous with \"ownership.\""; 1639 case ISDLOC: 1640 return "A role played by a place at which health care services may be provided without prior designation or authorization."; 1641 case EXPR: 1642 return "A role played by an entity that has been exposed to a person or animal suffering a contagious disease, or with a location from which a toxin has been distributed. The player of the role is normally a person or animal, but it is possible that other entity types could become exposed. The role is scoped by the source of the exposure, and it is quite possible for a person playing the role of exposed party to also become the scoper a role played by another person. That is to say, once a person has become infected, it is possible, perhaps likely, for that person to infect others.\r\n\n Management of exposures and tracking exposed parties is a key function within public health, and within most public health contexts - exposed parties are known as \"contacts.\""; 1643 case HLD: 1644 return "Entity that is currently in the possession of a holder (scoper), who holds, or uses it, usually based on some agreement with the owner."; 1645 case HLTHCHRT: 1646 return "The role of a material (player) that is the physical health chart belonging to an organization (scoper)."; 1647 case IDENT: 1648 return "A role in which the scoping entity designates an identifier for a playing entity."; 1649 case MANU: 1650 return "Scoped by the manufacturer"; 1651 case THER: 1652 return "A manufactured material (player) that is used for its therapeutic properties. The manufacturer is the scoper."; 1653 case MNT: 1654 return "An entity (player) that is maintained by another entity (scoper). This is typical role held by durable equipment. The scoper assumes responsibility for proper operation, quality, and safety."; 1655 case OWN: 1656 return "An Entity (player) for which someone (scoper) is granted by law the right to call the material (player) his own. This entitles the scoper to make decisions about the disposition of that material."; 1657 case RGPR: 1658 return "A product regulated by some governmentatl orgnization. The role is played by Material and scoped by Organization.\r\n\n Rationale: To support an entity clone used to identify the NDC number for a drug product."; 1659 case TERR: 1660 return "Relates a place entity (player) as the region over which the scoper (typically an Organization) has certain authority (jurisdiction). For example, the Calgary Regional Health Authority (scoper) has authority over the territory \"Region 4 of Alberta\" (player) in matters of health."; 1661 case USED: 1662 return "Description:An entity (player) that is used by another entity (scoper)"; 1663 case WRTE: 1664 return "A role a product plays when a guarantee is given to the purchaser by the seller (scoping entity) stating that the product is reliable and free from known defects and that the seller will repair or replace defective parts within a given time limit and under certain conditions."; 1665 case _ROLECLASSONTOLOGICAL: 1666 return "A relationship in which the scoping Entity defines or specifies what the playing Entity is. Thus, the player's \"being\" (Greek: ontos) is specified."; 1667 case EQUIV: 1668 return "Description: Specifies the player Entity (the equivalent Entity) as an Entity that is considered to be equivalent to a reference Entity (scoper). The equivalence is in principle a symmetric relationship, however, it is expected that the scoper is a reference entity which serves as reference entity for multiple different equivalent entities. \r\n\n \n Examples: An innovator's medicine formulation is the reference for \"generics\", i.e., formulations manufactured differently but having been proven to be biologically equivalent to the reference medicine. Another example is a reference ingredient that serves as basis for quantity specifications (basis of strength, e.g., metoprolol succinate specified in terms of metoprolol tartrate.)"; 1669 case SAME: 1670 return "The \"same\" role asserts an identity between playing and scoping entities, i.e., that they are in fact two records of the same entity instance, and, in the case of discrepancies (e.g different DOB, gender), that one or both are in error.\r\n\n \n Usage:\n \r\n\n playing and scoping entities must have same classCode, but need not have identical attributes or values.\r\n\n \n Example: \n \r\n\n a provider registry maintains sets of conflicting demographic data for what is reported to be the same individual."; 1671 case SUBY: 1672 return "Relates a prevailing record of an Entity (scoper) with another record (player) that it subsumes.\r\n\n \n Examples: Show a correct new Person object (scoper) that subsumes one or more duplicate Person objects that had accidentally been created for the same physical person.\r\n\n \n Constraints: Both the player and scoper must have the same classCode."; 1673 case GEN: 1674 return "Relates a specialized material concept (player) to its generalization (scoper)."; 1675 case GRIC: 1676 return "A special link between pharmaceuticals indicating that the target (scoper) is a generic for the source (player)."; 1677 case INST: 1678 return "An individual piece of material (player) instantiating a class of material (scoper)."; 1679 case SUBS: 1680 return "An entity that subsumes the identity of another. Used in the context of merging documented entity instances. Both the player and scoper must have the same classCode.\r\n\n The use of this code is deprecated in favor of the term SUBY which is its inverse and is more ontologically correct."; 1681 case _ROLECLASSPARTITIVE: 1682 return "An association between two Entities where the playing Entity is considered in some way \"part\" of the scoping Entity, e.g., as a member, component, ingredient, or content. Being \"part\" in the broadest sense of the word can mean anything from being an integral structural component to a mere incidental temporary association of a playing Entity with a (generally larger) scoping Entity."; 1683 case CONT: 1684 return "Relates a material as the content (player) to a container (scoper). Unlike ingredients, the content and a container remain separate (not mixed) and the content can be removed from the container. A content is not part of an empty container."; 1685 case EXPAGTCAR: 1686 return "An exposure agent carrier is an entity that is capable of conveying an exposure agent from one entity to another. The scoper of the role must be the exposure agent (e.g., pathogen)."; 1687 case EXPVECTOR: 1688 return "Description: A vector is a living subject that carries an exposure agent. The vector does not cause the disease itself, but exposes targets to the exposure agent. A mosquito carrying malaria is an example of a vector. The scoper of the role must be the exposure agent (e.g., pathogen)."; 1689 case FOMITE: 1690 return "Description: A fomite is a non-living entity that is capable of conveying exposure agent from one entity to another. A doorknob contaminated with a Norovirus is an example of a fomite. Anyone touching the doorknob would be exposed to the virus. The scoper of the role must be the exposure agent (e.g., pathogen)."; 1691 case INGR: 1692 return "Relates a component (player) to a mixture (scoper). E.g., Glucose and Water are ingredients of D5W, latex may be an ingredient in a tracheal tube."; 1693 case ACTI: 1694 return "Definition: a therapeutically active ingredient (player) in a mixture (scoper), where the mixture is typically a manufactured pharmaceutical. It is unknown if the quantity of such an ingredient is expressed precisely in terms of the playing ingredient substance, or, if it is specified in terms of a closely related substance (active moiety or reference substance)."; 1695 case ACTIB: 1696 return "Description: Active ingredient, where the ingredient substance (player) is itself the \"basis of strength\", i.e., where the Role.quantity specifies exactly the quantity of the player substance in the medicine formulation. \r\n\n \n Examples: Lopressor 50 mg actually contains 50 mg of metoprolol succinate, even though the active moiety is metoprolol, but also: Tenormin 50 mg contain 50 mg of atenolol, as free base, i.e., where the active ingredient atenolol is also the active moiety."; 1697 case ACTIM: 1698 return "Description: Active ingredient, where not the ingredient substance (player), but itaTMs active moiety is the \"basis of strength\", i.e., where the Role.quantity specifies the quantity of the player substance's active moiety in the medicine formulation.\r\n\n \n Examples: 1 mL of Betopic 5mg/mL eye drops contains 5.6 mg betaxolol hydrochloride equivalent to betaxolol base 5 mg."; 1699 case ACTIR: 1700 return "Description: Active ingredient, where not the ingredient substance (player) but another reference substance with the same active moiety, is the \"basis of strength\", i.e., where the Role.quantity specifies the quantity of a reference substance, similar but different from the player substance's in the medicine formulation.\r\n\n \n Examples: Toprol-XL 50 mg contains 47.5 mg of metoprolol succinate equivalent to 50 mg of metoprolol tartrate."; 1701 case ADJV: 1702 return "A component (player) added to enhance the action of an active ingredient (scoper) (in the manner of a catalyst) but which has no active effect in and of itself. Such ingredients are significant in defining equivalence of products in a way that inactive ingredients are not."; 1703 case ADTV: 1704 return "An ingredient (player) that is added to a base (scoper), that amounts to a minor part of the overall mixture."; 1705 case BASE: 1706 return "A base ingredient (player) is what comprises the major part of a mixture (scoper). E.g., Water in most i.v. solutions, or Vaseline in salves. Among all ingredients of a material, there should be only one base. A base substance can, in turn, be a mixture."; 1707 case CNTM: 1708 return "An ingredient whose presence is not intended but may not be reasonably avoided given the circumstances of the mixture's nature or origin."; 1709 case IACT: 1710 return "An ingredient which is not considered therapeutically active, e.g., colors, flavors, stabilizers, or preservatives, fillers, or structural components added to an active ingredient in order to facilitate administration of the active ingredient but without being considered therapeutically active. An inactive ingredient need not be biologically inert, e.g., might be active as an allergen or might have a pleasant taste, but is not an essential constituent delivering the therapeutic effect."; 1711 case COLR: 1712 return "A substance (player) influencing the optical aspect of material (scoper)."; 1713 case FLVR: 1714 return "A substance (player) added to a mixture (scoper) to make it taste a certain way. In food the use is obvious, in pharmaceuticals flavors can hide disgusting taste of the active ingredient (important in pediatric treatments)."; 1715 case PRSV: 1716 return "A substance (player) added to a mixture (scoper) to prevent microorganisms (fungi, bacteria) to spoil the mixture."; 1717 case STBL: 1718 return "A stabilizer (player) added to a mixture (scoper) in order to prevent the molecular disintegration of the main substance."; 1719 case MECH: 1720 return "An ingredient (player) of a medication (scoper) that is inseparable from the active ingredients, but has no intended chemical or pharmaceutical effect itself, but which may have some systemic effect on the patient.\r\n\n An example is a collagen matrix used as a base for transplanting skin cells. The collagen matrix can be left permanently in the graft site. Because it is of bovine origin, the patient may exhibit allergies or may have cultural objections to its use."; 1721 case LOCE: 1722 return "Relates an entity (player) to a location (scoper) at which it is present in some way. This presence may be limited in time."; 1723 case STOR: 1724 return "Relates an entity (player) (e.g. a device) to a location (scoper) at which it is normally found or stored when not used."; 1725 case MBR: 1726 return "A role played by an entity that is a member of a group. The group provides the scope for this role.\r\n\n Among other uses, groups as used in insurance (groups of covered individuals) and in scheduling where resources may be grouped for scheduling and logistical purposes."; 1727 case PART: 1728 return "Definition: an association between two Entities where the playing Entity (the part) is a component of the whole (scoper) in the sense of an integral structural component, that is distinct from other parts in the same whole, has a distinct function in the whole, and, as an effect, the full integrity of the whole depends (to some degree) on the presence of this part, even though the part may often be separable from the whole.\r\n\n \n Discussion: Part is defined in opposition to (a) ingredient (not separable), (b) content (not a functional component), and (c) member (not functionally distinct from other members)."; 1729 case ACTM: 1730 return "The molecule or ion that is responsible for the intended pharmacological action of the drug substance, excluding those appended or associated parts of the molecule that make the molecule an ester, salt (including a salt with hydrogen or coordination bonds), or other noncovalent derivative (such as a complex, chelate, or clathrate).\r\n\n Examples: heparin-sodium and heparin-potassium have the same active moiety, heparin; the active moiety of morphine-hydrochloride is morphine."; 1731 case SPEC: 1732 return "A role played by a material entity that is a specimen for an act. It is scoped by the source of the specimen."; 1733 case ALQT: 1734 return "A portion (player) of an original or source specimen (scoper) used for testing or transportation."; 1735 case ISLT: 1736 return "A microorganism that has been isolated from other microorganisms or a source matrix."; 1737 case CHILD: 1738 return "The player of the role is a child of the scoping entity, in a generic sense."; 1739 case CRED: 1740 return "A role played by an entity that receives credentials from the scoping entity."; 1741 case NURPRAC: 1742 return "nurse practitioner"; 1743 case NURS: 1744 return "nurse"; 1745 case PA: 1746 return "physician assistant"; 1747 case PHYS: 1748 return "physician"; 1749 case NULL: 1750 return null; 1751 default: 1752 return "?"; 1753 } 1754 } 1755 1756 public String getDisplay() { 1757 switch (this) { 1758 case ROL: 1759 return "role"; 1760 case _ROLECLASSASSOCIATIVE: 1761 return "RoleClassAssociative"; 1762 case _ROLECLASSMUTUALRELATIONSHIP: 1763 return "RoleClassMutualRelationship"; 1764 case _ROLECLASSRELATIONSHIPFORMAL: 1765 return "RoleClassRelationshipFormal"; 1766 case AFFL: 1767 return "affiliate"; 1768 case AGNT: 1769 return "agent"; 1770 case ASSIGNED: 1771 return "assigned entity"; 1772 case COMPAR: 1773 return "commissioning party"; 1774 case SGNOFF: 1775 return "signing authority or officer"; 1776 case CON: 1777 return "contact"; 1778 case ECON: 1779 return "emergency contact"; 1780 case NOK: 1781 return "next of kin"; 1782 case GUARD: 1783 return "guardian"; 1784 case CIT: 1785 return "citizen"; 1786 case COVPTY: 1787 return "covered party"; 1788 case CLAIM: 1789 return "claimant"; 1790 case NAMED: 1791 return "named insured"; 1792 case DEPEN: 1793 return "dependent"; 1794 case INDIV: 1795 return "individual"; 1796 case SUBSCR: 1797 return "subscriber"; 1798 case PROG: 1799 return "program eligible"; 1800 case CRINV: 1801 return "clinical research investigator"; 1802 case CRSPNSR: 1803 return "clinical research sponsor"; 1804 case EMP: 1805 return "employee"; 1806 case MIL: 1807 return "military person"; 1808 case GUAR: 1809 return "guarantor"; 1810 case INVSBJ: 1811 return "Investigation Subject"; 1812 case CASEBJ: 1813 return "Case Subject"; 1814 case RESBJ: 1815 return "research subject"; 1816 case LIC: 1817 return "licensed entity"; 1818 case NOT: 1819 return "notary public"; 1820 case PROV: 1821 return "healthcare provider"; 1822 case PAT: 1823 return "patient"; 1824 case PAYEE: 1825 return "payee"; 1826 case PAYOR: 1827 return "invoice payor"; 1828 case POLHOLD: 1829 return "policy holder"; 1830 case QUAL: 1831 return "qualified entity"; 1832 case SPNSR: 1833 return "coverage sponsor"; 1834 case STD: 1835 return "student"; 1836 case UNDWRT: 1837 return "underwriter"; 1838 case CAREGIVER: 1839 return "caregiver"; 1840 case PRS: 1841 return "personal relationship"; 1842 case SELF: 1843 return "self"; 1844 case _ROLECLASSPASSIVE: 1845 return "RoleClassPassive"; 1846 case ACCESS: 1847 return "access"; 1848 case ADJY: 1849 return "adjacency"; 1850 case CONC: 1851 return "connection"; 1852 case BOND: 1853 return "molecular bond"; 1854 case CONY: 1855 return "continuity"; 1856 case ADMM: 1857 return "Administerable Material"; 1858 case BIRTHPL: 1859 return "birthplace"; 1860 case DEATHPLC: 1861 return "place of death"; 1862 case DST: 1863 return "distributed material"; 1864 case RET: 1865 return "retailed material"; 1866 case EXLOC: 1867 return "event location"; 1868 case SDLOC: 1869 return "service delivery location"; 1870 case DSDLOC: 1871 return "dedicated service delivery location"; 1872 case ISDLOC: 1873 return "incidental service delivery location"; 1874 case EXPR: 1875 return "exposed entity"; 1876 case HLD: 1877 return "held entity"; 1878 case HLTHCHRT: 1879 return "health chart"; 1880 case IDENT: 1881 return "identified entity"; 1882 case MANU: 1883 return "manufactured product"; 1884 case THER: 1885 return "therapeutic agent"; 1886 case MNT: 1887 return "maintained entity"; 1888 case OWN: 1889 return "owned entity"; 1890 case RGPR: 1891 return "regulated product"; 1892 case TERR: 1893 return "territory of authority"; 1894 case USED: 1895 return "used entity"; 1896 case WRTE: 1897 return "warranted product"; 1898 case _ROLECLASSONTOLOGICAL: 1899 return "RoleClassOntological"; 1900 case EQUIV: 1901 return "equivalent entity"; 1902 case SAME: 1903 return "same"; 1904 case SUBY: 1905 return "subsumed by"; 1906 case GEN: 1907 return "has generalization"; 1908 case GRIC: 1909 return "has generic"; 1910 case INST: 1911 return "instance"; 1912 case SUBS: 1913 return "subsumer"; 1914 case _ROLECLASSPARTITIVE: 1915 return "RoleClassPartitive"; 1916 case CONT: 1917 return "content"; 1918 case EXPAGTCAR: 1919 return "exposure agent carrier"; 1920 case EXPVECTOR: 1921 return "exposure vector"; 1922 case FOMITE: 1923 return "fomite"; 1924 case INGR: 1925 return "ingredient"; 1926 case ACTI: 1927 return "active ingredient"; 1928 case ACTIB: 1929 return "active ingredient - basis of strength"; 1930 case ACTIM: 1931 return "active ingredient - moiety is basis of strength"; 1932 case ACTIR: 1933 return "active ingredient - reference substance is basis of strength"; 1934 case ADJV: 1935 return "adjuvant"; 1936 case ADTV: 1937 return "additive"; 1938 case BASE: 1939 return "base"; 1940 case CNTM: 1941 return "contaminant ingredient"; 1942 case IACT: 1943 return "inactive ingredient"; 1944 case COLR: 1945 return "color additive"; 1946 case FLVR: 1947 return "flavor additive"; 1948 case PRSV: 1949 return "preservative"; 1950 case STBL: 1951 return "stabilizer"; 1952 case MECH: 1953 return "mechanical ingredient"; 1954 case LOCE: 1955 return "located entity"; 1956 case STOR: 1957 return "stored entity"; 1958 case MBR: 1959 return "member"; 1960 case PART: 1961 return "part"; 1962 case ACTM: 1963 return "active moiety"; 1964 case SPEC: 1965 return "specimen"; 1966 case ALQT: 1967 return "aliquot"; 1968 case ISLT: 1969 return "isolate"; 1970 case CHILD: 1971 return "child"; 1972 case CRED: 1973 return "credentialed entity"; 1974 case NURPRAC: 1975 return "nurse practitioner"; 1976 case NURS: 1977 return "nurse"; 1978 case PA: 1979 return "physician assistant"; 1980 case PHYS: 1981 return "physician"; 1982 case NULL: 1983 return null; 1984 default: 1985 return "?"; 1986 } 1987 } 1988 1989}