001package org.hl7.fhir.r4.model.codesystems; 002 003/*- 004 * #%L 005 * org.hl7.fhir.r4 006 * %% 007 * Copyright (C) 2014 - 2019 Health Level 7 008 * %% 009 * Licensed under the Apache License, Version 2.0 (the "License"); 010 * you may not use this file except in compliance with the License. 011 * You may obtain a copy of the License at 012 * 013 * http://www.apache.org/licenses/LICENSE-2.0 014 * 015 * Unless required by applicable law or agreed to in writing, software 016 * distributed under the License is distributed on an "AS IS" BASIS, 017 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 018 * See the License for the specific language governing permissions and 019 * limitations under the License. 020 * #L% 021 */ 022 023 024/* 025 Copyright (c) 2011+, HL7, Inc. 026 All rights reserved. 027 028 Redistribution and use in source and binary forms, with or without modification, 029 are permitted provided that the following conditions are met: 030 031 * Redistributions of source code must retain the above copyright notice, this 032 list of conditions and the following disclaimer. 033 * Redistributions in binary form must reproduce the above copyright notice, 034 this list of conditions and the following disclaimer in the documentation 035 and/or other materials provided with the distribution. 036 * Neither the name of HL7 nor the names of its contributors may be used to 037 endorse or promote products derived from this software without specific 038 prior written permission. 039 040 THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND 041 ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED 042 WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. 043 IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, 044 INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT 045 NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR 046 PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, 047 WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) 048 ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE 049 POSSIBILITY OF SUCH DAMAGE. 050 051*/ 052 053// Generated on Wed, Jan 30, 2019 16:19-0500 for FHIR v4.0.0 054 055 056import org.hl7.fhir.exceptions.FHIRException; 057 058public enum V3RoleClass { 059 060 /** 061 * Corresponds to the Role class 062 */ 063 ROL, 064 /** 065 * A general association between two entities that is neither partitive nor ontological. 066 */ 067 _ROLECLASSASSOCIATIVE, 068 /** 069 * 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). 070 */ 071 _ROLECLASSMUTUALRELATIONSHIP, 072 /** 073 * A relationship between two entities that is formally recognized, frequently by a contract or similar agreement. 074 */ 075 _ROLECLASSRELATIONSHIPFORMAL, 076 /** 077 * 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. 078 079 080 Example: A healthcare provider is affiliated with another provider as a business associate. 081 */ 082 AFFL, 083 /** 084 * An entity (player) that acts or is authorized to act on behalf of another entity (scoper). 085 */ 086 AGNT, 087 /** 088 * 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. 089 */ 090 ASSIGNED, 091 /** 092 * An Entity that is authorized to issue or instantiate permissions, privileges, credentials or other formal/legal authorizations. 093 */ 094 COMPAR, 095 /** 096 * The role of a person (player) who is the officer or signature authority for of a scoping entity, usually an organization (scoper). 097 */ 098 SGNOFF, 099 /** 100 * 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. 101 */ 102 CON, 103 /** 104 * An entity to be contacted in the event of an emergency. 105 */ 106 ECON, 107 /** 108 * An individual designated for notification as the next of kin for a given entity. 109 */ 110 NOK, 111 /** 112 * Guardian of a ward 113 */ 114 GUARD, 115 /** 116 * Citizen of apolitical entity 117 */ 118 CIT, 119 /** 120 * 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. 121 122 123 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. 124 125 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. 126 */ 127 COVPTY, 128 /** 129 * 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. 130 131 132 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. 133 134 135 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. 136 137 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. 138 139 140 Example: A claimant under automobile policy that is not the named insured. 141 */ 142 CLAIM, 143 /** 144 * 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. 145 146 147 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. 148 149 150 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. 151 152 153 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. 154 */ 155 NAMED, 156 /** 157 * 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. 158 159 160 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. 161 162 163 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. 164 */ 165 DEPEN, 166 /** 167 * 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. 168 169 170 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. 171 172 173 Example: The individual insured under a comprehensive automobile, disability, or property and casualty policy that is the policy holder. 174 */ 175 INDIV, 176 /** 177 * 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. 178 179 180 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. 181 182 183 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. 184 185 186 Example: An employee or a member of an association. 187 */ 188 SUBSCR, 189 /** 190 * 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. 191 192 193 Discussion: A program as typically government administered coverage for parties determined eligible under the terms of the program. 194 195 196 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. 197 198 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. 199 200 201 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. 202 */ 203 PROG, 204 /** 205 * 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. 206 */ 207 CRINV, 208 /** 209 * 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. 210 */ 211 CRSPNSR, 212 /** 213 * 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.) 214 */ 215 EMP, 216 /** 217 * 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.) 218 */ 219 MIL, 220 /** 221 * A person or organization (player) that serves as a financial guarantor for another person or organization (scoper). 222 */ 223 GUAR, 224 /** 225 * An entity that is the subject of an investigation. This role is scoped by the party responsible for the investigation. 226 */ 227 INVSBJ, 228 /** 229 * 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) 230 */ 231 CASEBJ, 232 /** 233 * Definition:Specifies the administrative functionality within a formal experimental design for which the ResearchSubject role was established. 234 235 236 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. 237 */ 238 RESBJ, 239 /** 240 * 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). 241 */ 242 LIC, 243 /** 244 * notary public 245 */ 246 NOT, 247 /** 248 * An Entity (player) that is authorized to provide health care services by some authorizing agency (scoper). 249 */ 250 PROV, 251 /** 252 * A Role of a LivingSubject (player) as an actual or potential recipient of health care services from a healthcare provider organization (scoper). 253 254 255 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. 256 */ 257 PAT, 258 /** 259 * 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. 260 */ 261 PAYEE, 262 /** 263 * 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. 264 */ 265 PAYOR, 266 /** 267 * A role played by a person or organization that holds an insurance policy. The underwriter of that policy is the scoping entity. 268 269 270 Discussion:The identifier of the policy is captured in 'Role.id' when the Role is a policy holder. 271 272 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. 273 */ 274 POLHOLD, 275 /** 276 * 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. 277 */ 278 QUAL, 279 /** 280 * 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 281 282 283 284 a policy holder of the plan; 285 286 287 288 where the sponsor is the policy holder, who may become a subscriber or a dependent to a policy under the plan; or 289 290 291 292 where the sponsor is a government agency, who may become program eligibles under a program. 293 294 295 296 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. 297 298 299 Example: An employer, union, government agency, or association. 300 */ 301 SPNSR, 302 /** 303 * A role played by an individual who is a student of a school, which is the scoping entity. 304 */ 305 STD, 306 /** 307 * A role played by a person or an organization. It is the party that 308 309 310 311 accepts fiscal responsibility for insurance plans and the policies created under those plans; 312 313 314 315 administers and accepts fiscal responsibility for a program that provides coverage for services to eligible individuals; and/or 316 317 318 319 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. 320 321 322 323 324 Example: 325 326 327 328 329 A health insurer; 330 331 332 333 Medicaid Program; 334 335 336 337 Lloyd's of London 338 */ 339 UNDWRT, 340 /** 341 * A person responsible for the primary care of a patient at home. 342 */ 343 CAREGIVER, 344 /** 345 * 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. 346 */ 347 PRS, 348 /** 349 * 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. 350 351 352 Usage: 353 354 355 playing and scoping entities must have same classcode, but need not have identical attributes or values. 356 357 358 Example: 359 360 361 a provider registry maintains sets of conflicting demographic data for what is reported to be the same individual. 362 */ 363 SELF, 364 /** 365 * 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. 366 */ 367 _ROLECLASSPASSIVE, 368 /** 369 * 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. 370 */ 371 ACCESS, 372 /** 373 * 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. 374 375 376 Examples: the colon is connected (and therefore adjacent) to the jejunum; the colon is adjacent to the liver (even if not actually connected.) 377 378 379 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. 380 */ 381 ADJY, 382 /** 383 * An adjacency of two Entities held together by a bond which attaches to each of the two entities. 384 385 386 Examples: biceps brachii muscle connected to the radius bone, port 3 on a network switch connected to port 5 on a patch panel. 387 388 389 UsageConstraints: See Adjacency for the assignment of scoper (larger, more central) and player (smaller, more distant). 390 */ 391 CONC, 392 /** 393 * A connection between two atoms of a molecule. 394 395 396 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. 397 398 399 UsageConstraints: See connection and adjacency for the assignment of player and scoper. 400 */ 401 BOND, 402 /** 403 * A connection between two regional parts. 404 405 406 Examples: the connection between ascending aorta and the aortic arc, connection between descending colon and sigmoid. 407 408 409 UsageConstraints: See connection and adjacency for the assignment of player and scoper. 410 */ 411 CONY, 412 /** 413 * A material (player) that can be administered to an Entity (scoper). 414 */ 415 ADMM, 416 /** 417 * Relates a place (playing Entity) as the location where a living subject (scoping Entity) was born. 418 */ 419 BIRTHPL, 420 /** 421 * Definition: Relates a place (playing Entity) as the location where a living subject (scoping Entity) died. 422 */ 423 DEATHPLC, 424 /** 425 * A material (player) distributed by a distributor (scoper) who functions between a manufacturer and a buyer or retailer. 426 */ 427 DST, 428 /** 429 * Material (player) sold by a retailer (scoper), who also give advice to prospective buyers. 430 */ 431 RET, 432 /** 433 * A role played by a place at which the location of an event may be recorded. 434 */ 435 EXLOC, 436 /** 437 * A role played by a place at which services may be provided. 438 */ 439 SDLOC, 440 /** 441 * 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." 442 */ 443 DSDLOC, 444 /** 445 * A role played by a place at which health care services may be provided without prior designation or authorization. 446 */ 447 ISDLOC, 448 /** 449 * 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. 450 451 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." 452 */ 453 EXPR, 454 /** 455 * Entity that is currently in the possession of a holder (scoper), who holds, or uses it, usually based on some agreement with the owner. 456 */ 457 HLD, 458 /** 459 * The role of a material (player) that is the physical health chart belonging to an organization (scoper). 460 */ 461 HLTHCHRT, 462 /** 463 * A role in which the scoping entity designates an identifier for a playing entity. 464 */ 465 IDENT, 466 /** 467 * Scoped by the manufacturer 468 */ 469 MANU, 470 /** 471 * A manufactured material (player) that is used for its therapeutic properties. The manufacturer is the scoper. 472 */ 473 THER, 474 /** 475 * 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. 476 */ 477 MNT, 478 /** 479 * 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. 480 */ 481 OWN, 482 /** 483 * A product regulated by some governmentatl orgnization. The role is played by Material and scoped by Organization. 484 485 Rationale: To support an entity clone used to identify the NDC number for a drug product. 486 */ 487 RGPR, 488 /** 489 * 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. 490 */ 491 TERR, 492 /** 493 * Description:An entity (player) that is used by another entity (scoper) 494 */ 495 USED, 496 /** 497 * 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. 498 */ 499 WRTE, 500 /** 501 * A relationship in which the scoping Entity defines or specifies what the playing Entity is. Thus, the player's "being" (Greek: ontos) is specified. 502 */ 503 _ROLECLASSONTOLOGICAL, 504 /** 505 * 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. 506 507 508 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.) 509 */ 510 EQUIV, 511 /** 512 * 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. 513 514 515 Usage: 516 517 518 playing and scoping entities must have same classCode, but need not have identical attributes or values. 519 520 521 Example: 522 523 524 a provider registry maintains sets of conflicting demographic data for what is reported to be the same individual. 525 */ 526 SAME, 527 /** 528 * Relates a prevailing record of an Entity (scoper) with another record (player) that it subsumes. 529 530 531 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. 532 533 534 Constraints: Both the player and scoper must have the same classCode. 535 */ 536 SUBY, 537 /** 538 * Relates a specialized material concept (player) to its generalization (scoper). 539 */ 540 GEN, 541 /** 542 * A special link between pharmaceuticals indicating that the target (scoper) is a generic for the source (player). 543 */ 544 GRIC, 545 /** 546 * An individual piece of material (player) instantiating a class of material (scoper). 547 */ 548 INST, 549 /** 550 * 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. 551 552 The use of this code is deprecated in favor of the term SUBY which is its inverse and is more ontologically correct. 553 */ 554 SUBS, 555 /** 556 * 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. 557 */ 558 _ROLECLASSPARTITIVE, 559 /** 560 * 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. 561 */ 562 CONT, 563 /** 564 * 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). 565 */ 566 EXPAGTCAR, 567 /** 568 * 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). 569 */ 570 EXPVECTOR, 571 /** 572 * 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). 573 */ 574 FOMITE, 575 /** 576 * 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. 577 */ 578 INGR, 579 /** 580 * 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). 581 */ 582 ACTI, 583 /** 584 * 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. 585 586 587 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. 588 */ 589 ACTIB, 590 /** 591 * 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. 592 593 594 Examples: 1 mL of Betopic 5mg/mL eye drops contains 5.6 mg betaxolol hydrochloride equivalent to betaxolol base 5 mg. 595 */ 596 ACTIM, 597 /** 598 * 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. 599 600 601 Examples: Toprol-XL 50 mg contains 47.5 mg of metoprolol succinate equivalent to 50 mg of metoprolol tartrate. 602 */ 603 ACTIR, 604 /** 605 * 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. 606 */ 607 ADJV, 608 /** 609 * An ingredient (player) that is added to a base (scoper), that amounts to a minor part of the overall mixture. 610 */ 611 ADTV, 612 /** 613 * 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. 614 */ 615 BASE, 616 /** 617 * An ingredient whose presence is not intended but may not be reasonably avoided given the circumstances of the mixture's nature or origin. 618 */ 619 CNTM, 620 /** 621 * 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. 622 */ 623 IACT, 624 /** 625 * A substance (player) influencing the optical aspect of material (scoper). 626 */ 627 COLR, 628 /** 629 * 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). 630 */ 631 FLVR, 632 /** 633 * A substance (player) added to a mixture (scoper) to prevent microorganisms (fungi, bacteria) to spoil the mixture. 634 */ 635 PRSV, 636 /** 637 * A stabilizer (player) added to a mixture (scoper) in order to prevent the molecular disintegration of the main substance. 638 */ 639 STBL, 640 /** 641 * 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. 642 643 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. 644 */ 645 MECH, 646 /** 647 * Relates an entity (player) to a location (scoper) at which it is present in some way. This presence may be limited in time. 648 */ 649 LOCE, 650 /** 651 * Relates an entity (player) (e.g. a device) to a location (scoper) at which it is normally found or stored when not used. 652 */ 653 STOR, 654 /** 655 * A role played by an entity that is a member of a group. The group provides the scope for this role. 656 657 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. 658 */ 659 MBR, 660 /** 661 * 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. 662 663 664 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). 665 */ 666 PART, 667 /** 668 * 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). 669 670 Examples: heparin-sodium and heparin-potassium have the same active moiety, heparin; the active moiety of morphine-hydrochloride is morphine. 671 */ 672 ACTM, 673 /** 674 * A role played by a material entity that is a specimen for an act. It is scoped by the source of the specimen. 675 */ 676 SPEC, 677 /** 678 * A portion (player) of an original or source specimen (scoper) used for testing or transportation. 679 */ 680 ALQT, 681 /** 682 * A microorganism that has been isolated from other microorganisms or a source matrix. 683 */ 684 ISLT, 685 /** 686 * The player of the role is a child of the scoping entity, in a generic sense. 687 */ 688 CHILD, 689 /** 690 * A role played by an entity that receives credentials from the scoping entity. 691 */ 692 CRED, 693 /** 694 * nurse practitioner 695 */ 696 NURPRAC, 697 /** 698 * nurse 699 */ 700 NURS, 701 /** 702 * physician assistant 703 */ 704 PA, 705 /** 706 * physician 707 */ 708 PHYS, 709 /** 710 * added to help the parsers 711 */ 712 NULL; 713 public static V3RoleClass fromCode(String codeString) throws FHIRException { 714 if (codeString == null || "".equals(codeString)) 715 return null; 716 if ("ROL".equals(codeString)) 717 return ROL; 718 if ("_RoleClassAssociative".equals(codeString)) 719 return _ROLECLASSASSOCIATIVE; 720 if ("_RoleClassMutualRelationship".equals(codeString)) 721 return _ROLECLASSMUTUALRELATIONSHIP; 722 if ("_RoleClassRelationshipFormal".equals(codeString)) 723 return _ROLECLASSRELATIONSHIPFORMAL; 724 if ("AFFL".equals(codeString)) 725 return AFFL; 726 if ("AGNT".equals(codeString)) 727 return AGNT; 728 if ("ASSIGNED".equals(codeString)) 729 return ASSIGNED; 730 if ("COMPAR".equals(codeString)) 731 return COMPAR; 732 if ("SGNOFF".equals(codeString)) 733 return SGNOFF; 734 if ("CON".equals(codeString)) 735 return CON; 736 if ("ECON".equals(codeString)) 737 return ECON; 738 if ("NOK".equals(codeString)) 739 return NOK; 740 if ("GUARD".equals(codeString)) 741 return GUARD; 742 if ("CIT".equals(codeString)) 743 return CIT; 744 if ("COVPTY".equals(codeString)) 745 return COVPTY; 746 if ("CLAIM".equals(codeString)) 747 return CLAIM; 748 if ("NAMED".equals(codeString)) 749 return NAMED; 750 if ("DEPEN".equals(codeString)) 751 return DEPEN; 752 if ("INDIV".equals(codeString)) 753 return INDIV; 754 if ("SUBSCR".equals(codeString)) 755 return SUBSCR; 756 if ("PROG".equals(codeString)) 757 return PROG; 758 if ("CRINV".equals(codeString)) 759 return CRINV; 760 if ("CRSPNSR".equals(codeString)) 761 return CRSPNSR; 762 if ("EMP".equals(codeString)) 763 return EMP; 764 if ("MIL".equals(codeString)) 765 return MIL; 766 if ("GUAR".equals(codeString)) 767 return GUAR; 768 if ("INVSBJ".equals(codeString)) 769 return INVSBJ; 770 if ("CASEBJ".equals(codeString)) 771 return CASEBJ; 772 if ("RESBJ".equals(codeString)) 773 return RESBJ; 774 if ("LIC".equals(codeString)) 775 return LIC; 776 if ("NOT".equals(codeString)) 777 return NOT; 778 if ("PROV".equals(codeString)) 779 return PROV; 780 if ("PAT".equals(codeString)) 781 return PAT; 782 if ("PAYEE".equals(codeString)) 783 return PAYEE; 784 if ("PAYOR".equals(codeString)) 785 return PAYOR; 786 if ("POLHOLD".equals(codeString)) 787 return POLHOLD; 788 if ("QUAL".equals(codeString)) 789 return QUAL; 790 if ("SPNSR".equals(codeString)) 791 return SPNSR; 792 if ("STD".equals(codeString)) 793 return STD; 794 if ("UNDWRT".equals(codeString)) 795 return UNDWRT; 796 if ("CAREGIVER".equals(codeString)) 797 return CAREGIVER; 798 if ("PRS".equals(codeString)) 799 return PRS; 800 if ("SELF".equals(codeString)) 801 return SELF; 802 if ("_RoleClassPassive".equals(codeString)) 803 return _ROLECLASSPASSIVE; 804 if ("ACCESS".equals(codeString)) 805 return ACCESS; 806 if ("ADJY".equals(codeString)) 807 return ADJY; 808 if ("CONC".equals(codeString)) 809 return CONC; 810 if ("BOND".equals(codeString)) 811 return BOND; 812 if ("CONY".equals(codeString)) 813 return CONY; 814 if ("ADMM".equals(codeString)) 815 return ADMM; 816 if ("BIRTHPL".equals(codeString)) 817 return BIRTHPL; 818 if ("DEATHPLC".equals(codeString)) 819 return DEATHPLC; 820 if ("DST".equals(codeString)) 821 return DST; 822 if ("RET".equals(codeString)) 823 return RET; 824 if ("EXLOC".equals(codeString)) 825 return EXLOC; 826 if ("SDLOC".equals(codeString)) 827 return SDLOC; 828 if ("DSDLOC".equals(codeString)) 829 return DSDLOC; 830 if ("ISDLOC".equals(codeString)) 831 return ISDLOC; 832 if ("EXPR".equals(codeString)) 833 return EXPR; 834 if ("HLD".equals(codeString)) 835 return HLD; 836 if ("HLTHCHRT".equals(codeString)) 837 return HLTHCHRT; 838 if ("IDENT".equals(codeString)) 839 return IDENT; 840 if ("MANU".equals(codeString)) 841 return MANU; 842 if ("THER".equals(codeString)) 843 return THER; 844 if ("MNT".equals(codeString)) 845 return MNT; 846 if ("OWN".equals(codeString)) 847 return OWN; 848 if ("RGPR".equals(codeString)) 849 return RGPR; 850 if ("TERR".equals(codeString)) 851 return TERR; 852 if ("USED".equals(codeString)) 853 return USED; 854 if ("WRTE".equals(codeString)) 855 return WRTE; 856 if ("_RoleClassOntological".equals(codeString)) 857 return _ROLECLASSONTOLOGICAL; 858 if ("EQUIV".equals(codeString)) 859 return EQUIV; 860 if ("SAME".equals(codeString)) 861 return SAME; 862 if ("SUBY".equals(codeString)) 863 return SUBY; 864 if ("GEN".equals(codeString)) 865 return GEN; 866 if ("GRIC".equals(codeString)) 867 return GRIC; 868 if ("INST".equals(codeString)) 869 return INST; 870 if ("SUBS".equals(codeString)) 871 return SUBS; 872 if ("_RoleClassPartitive".equals(codeString)) 873 return _ROLECLASSPARTITIVE; 874 if ("CONT".equals(codeString)) 875 return CONT; 876 if ("EXPAGTCAR".equals(codeString)) 877 return EXPAGTCAR; 878 if ("EXPVECTOR".equals(codeString)) 879 return EXPVECTOR; 880 if ("FOMITE".equals(codeString)) 881 return FOMITE; 882 if ("INGR".equals(codeString)) 883 return INGR; 884 if ("ACTI".equals(codeString)) 885 return ACTI; 886 if ("ACTIB".equals(codeString)) 887 return ACTIB; 888 if ("ACTIM".equals(codeString)) 889 return ACTIM; 890 if ("ACTIR".equals(codeString)) 891 return ACTIR; 892 if ("ADJV".equals(codeString)) 893 return ADJV; 894 if ("ADTV".equals(codeString)) 895 return ADTV; 896 if ("BASE".equals(codeString)) 897 return BASE; 898 if ("CNTM".equals(codeString)) 899 return CNTM; 900 if ("IACT".equals(codeString)) 901 return IACT; 902 if ("COLR".equals(codeString)) 903 return COLR; 904 if ("FLVR".equals(codeString)) 905 return FLVR; 906 if ("PRSV".equals(codeString)) 907 return PRSV; 908 if ("STBL".equals(codeString)) 909 return STBL; 910 if ("MECH".equals(codeString)) 911 return MECH; 912 if ("LOCE".equals(codeString)) 913 return LOCE; 914 if ("STOR".equals(codeString)) 915 return STOR; 916 if ("MBR".equals(codeString)) 917 return MBR; 918 if ("PART".equals(codeString)) 919 return PART; 920 if ("ACTM".equals(codeString)) 921 return ACTM; 922 if ("SPEC".equals(codeString)) 923 return SPEC; 924 if ("ALQT".equals(codeString)) 925 return ALQT; 926 if ("ISLT".equals(codeString)) 927 return ISLT; 928 if ("CHILD".equals(codeString)) 929 return CHILD; 930 if ("CRED".equals(codeString)) 931 return CRED; 932 if ("NURPRAC".equals(codeString)) 933 return NURPRAC; 934 if ("NURS".equals(codeString)) 935 return NURS; 936 if ("PA".equals(codeString)) 937 return PA; 938 if ("PHYS".equals(codeString)) 939 return PHYS; 940 throw new FHIRException("Unknown V3RoleClass code '"+codeString+"'"); 941 } 942 public String toCode() { 943 switch (this) { 944 case ROL: return "ROL"; 945 case _ROLECLASSASSOCIATIVE: return "_RoleClassAssociative"; 946 case _ROLECLASSMUTUALRELATIONSHIP: return "_RoleClassMutualRelationship"; 947 case _ROLECLASSRELATIONSHIPFORMAL: return "_RoleClassRelationshipFormal"; 948 case AFFL: return "AFFL"; 949 case AGNT: return "AGNT"; 950 case ASSIGNED: return "ASSIGNED"; 951 case COMPAR: return "COMPAR"; 952 case SGNOFF: return "SGNOFF"; 953 case CON: return "CON"; 954 case ECON: return "ECON"; 955 case NOK: return "NOK"; 956 case GUARD: return "GUARD"; 957 case CIT: return "CIT"; 958 case COVPTY: return "COVPTY"; 959 case CLAIM: return "CLAIM"; 960 case NAMED: return "NAMED"; 961 case DEPEN: return "DEPEN"; 962 case INDIV: return "INDIV"; 963 case SUBSCR: return "SUBSCR"; 964 case PROG: return "PROG"; 965 case CRINV: return "CRINV"; 966 case CRSPNSR: return "CRSPNSR"; 967 case EMP: return "EMP"; 968 case MIL: return "MIL"; 969 case GUAR: return "GUAR"; 970 case INVSBJ: return "INVSBJ"; 971 case CASEBJ: return "CASEBJ"; 972 case RESBJ: return "RESBJ"; 973 case LIC: return "LIC"; 974 case NOT: return "NOT"; 975 case PROV: return "PROV"; 976 case PAT: return "PAT"; 977 case PAYEE: return "PAYEE"; 978 case PAYOR: return "PAYOR"; 979 case POLHOLD: return "POLHOLD"; 980 case QUAL: return "QUAL"; 981 case SPNSR: return "SPNSR"; 982 case STD: return "STD"; 983 case UNDWRT: return "UNDWRT"; 984 case CAREGIVER: return "CAREGIVER"; 985 case PRS: return "PRS"; 986 case SELF: return "SELF"; 987 case _ROLECLASSPASSIVE: return "_RoleClassPassive"; 988 case ACCESS: return "ACCESS"; 989 case ADJY: return "ADJY"; 990 case CONC: return "CONC"; 991 case BOND: return "BOND"; 992 case CONY: return "CONY"; 993 case ADMM: return "ADMM"; 994 case BIRTHPL: return "BIRTHPL"; 995 case DEATHPLC: return "DEATHPLC"; 996 case DST: return "DST"; 997 case RET: return "RET"; 998 case EXLOC: return "EXLOC"; 999 case SDLOC: return "SDLOC"; 1000 case DSDLOC: return "DSDLOC"; 1001 case ISDLOC: return "ISDLOC"; 1002 case EXPR: return "EXPR"; 1003 case HLD: return "HLD"; 1004 case HLTHCHRT: return "HLTHCHRT"; 1005 case IDENT: return "IDENT"; 1006 case MANU: return "MANU"; 1007 case THER: return "THER"; 1008 case MNT: return "MNT"; 1009 case OWN: return "OWN"; 1010 case RGPR: return "RGPR"; 1011 case TERR: return "TERR"; 1012 case USED: return "USED"; 1013 case WRTE: return "WRTE"; 1014 case _ROLECLASSONTOLOGICAL: return "_RoleClassOntological"; 1015 case EQUIV: return "EQUIV"; 1016 case SAME: return "SAME"; 1017 case SUBY: return "SUBY"; 1018 case GEN: return "GEN"; 1019 case GRIC: return "GRIC"; 1020 case INST: return "INST"; 1021 case SUBS: return "SUBS"; 1022 case _ROLECLASSPARTITIVE: return "_RoleClassPartitive"; 1023 case CONT: return "CONT"; 1024 case EXPAGTCAR: return "EXPAGTCAR"; 1025 case EXPVECTOR: return "EXPVECTOR"; 1026 case FOMITE: return "FOMITE"; 1027 case INGR: return "INGR"; 1028 case ACTI: return "ACTI"; 1029 case ACTIB: return "ACTIB"; 1030 case ACTIM: return "ACTIM"; 1031 case ACTIR: return "ACTIR"; 1032 case ADJV: return "ADJV"; 1033 case ADTV: return "ADTV"; 1034 case BASE: return "BASE"; 1035 case CNTM: return "CNTM"; 1036 case IACT: return "IACT"; 1037 case COLR: return "COLR"; 1038 case FLVR: return "FLVR"; 1039 case PRSV: return "PRSV"; 1040 case STBL: return "STBL"; 1041 case MECH: return "MECH"; 1042 case LOCE: return "LOCE"; 1043 case STOR: return "STOR"; 1044 case MBR: return "MBR"; 1045 case PART: return "PART"; 1046 case ACTM: return "ACTM"; 1047 case SPEC: return "SPEC"; 1048 case ALQT: return "ALQT"; 1049 case ISLT: return "ISLT"; 1050 case CHILD: return "CHILD"; 1051 case CRED: return "CRED"; 1052 case NURPRAC: return "NURPRAC"; 1053 case NURS: return "NURS"; 1054 case PA: return "PA"; 1055 case PHYS: return "PHYS"; 1056 default: return "?"; 1057 } 1058 } 1059 public String getSystem() { 1060 return "http://terminology.hl7.org/CodeSystem/v3-RoleClass"; 1061 } 1062 public String getDefinition() { 1063 switch (this) { 1064 case ROL: return "Corresponds to the Role class"; 1065 case _ROLECLASSASSOCIATIVE: return "A general association between two entities that is neither partitive nor ontological."; 1066 case _ROLECLASSMUTUALRELATIONSHIP: 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)."; 1067 case _ROLECLASSRELATIONSHIPFORMAL: return "A relationship between two entities that is formally recognized, frequently by a contract or similar agreement."; 1068 case AFFL: 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."; 1069 case AGNT: return "An entity (player) that acts or is authorized to act on behalf of another entity (scoper)."; 1070 case ASSIGNED: 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."; 1071 case COMPAR: return "An Entity that is authorized to issue or instantiate permissions, privileges, credentials or other formal/legal authorizations."; 1072 case SGNOFF: return "The role of a person (player) who is the officer or signature authority for of a scoping entity, usually an organization (scoper)."; 1073 case CON: 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."; 1074 case ECON: return "An entity to be contacted in the event of an emergency."; 1075 case NOK: return "An individual designated for notification as the next of kin for a given entity."; 1076 case GUARD: return "Guardian of a ward"; 1077 case CIT: return "Citizen of apolitical entity"; 1078 case COVPTY: 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."; 1079 case CLAIM: 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."; 1080 case NAMED: 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."; 1081 case DEPEN: 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."; 1082 case INDIV: 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."; 1083 case SUBSCR: 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."; 1084 case PROG: 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."; 1085 case CRINV: 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."; 1086 case CRSPNSR: 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."; 1087 case EMP: 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.)"; 1088 case MIL: 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.)"; 1089 case GUAR: return "A person or organization (player) that serves as a financial guarantor for another person or organization (scoper)."; 1090 case INVSBJ: return "An entity that is the subject of an investigation. This role is scoped by the party responsible for the investigation."; 1091 case CASEBJ: 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)"; 1092 case RESBJ: 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."; 1093 case LIC: 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)."; 1094 case NOT: return "notary public"; 1095 case PROV: return "An Entity (player) that is authorized to provide health care services by some authorizing agency (scoper)."; 1096 case PAT: 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."; 1097 case PAYEE: 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."; 1098 case PAYOR: 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."; 1099 case POLHOLD: 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."; 1100 case QUAL: 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."; 1101 case SPNSR: 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."; 1102 case STD: return "A role played by an individual who is a student of a school, which is the scoping entity."; 1103 case UNDWRT: 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"; 1104 case CAREGIVER: return "A person responsible for the primary care of a patient at home."; 1105 case PRS: 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."; 1106 case SELF: 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."; 1107 case _ROLECLASSPASSIVE: 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."; 1108 case ACCESS: 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."; 1109 case ADJY: 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."; 1110 case CONC: 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)."; 1111 case BOND: 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."; 1112 case CONY: 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."; 1113 case ADMM: return "A material (player) that can be administered to an Entity (scoper)."; 1114 case BIRTHPL: return "Relates a place (playing Entity) as the location where a living subject (scoping Entity) was born."; 1115 case DEATHPLC: return "Definition: Relates a place (playing Entity) as the location where a living subject (scoping Entity) died."; 1116 case DST: return "A material (player) distributed by a distributor (scoper) who functions between a manufacturer and a buyer or retailer."; 1117 case RET: return "Material (player) sold by a retailer (scoper), who also give advice to prospective buyers."; 1118 case EXLOC: return "A role played by a place at which the location of an event may be recorded."; 1119 case SDLOC: return "A role played by a place at which services may be provided."; 1120 case DSDLOC: 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.\""; 1121 case ISDLOC: return "A role played by a place at which health care services may be provided without prior designation or authorization."; 1122 case EXPR: 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.\""; 1123 case HLD: 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."; 1124 case HLTHCHRT: return "The role of a material (player) that is the physical health chart belonging to an organization (scoper)."; 1125 case IDENT: return "A role in which the scoping entity designates an identifier for a playing entity."; 1126 case MANU: return "Scoped by the manufacturer"; 1127 case THER: return "A manufactured material (player) that is used for its therapeutic properties. The manufacturer is the scoper."; 1128 case MNT: 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."; 1129 case OWN: 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."; 1130 case RGPR: 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."; 1131 case TERR: 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."; 1132 case USED: return "Description:An entity (player) that is used by another entity (scoper)"; 1133 case WRTE: 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."; 1134 case _ROLECLASSONTOLOGICAL: 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."; 1135 case EQUIV: 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.)"; 1136 case SAME: 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."; 1137 case SUBY: 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."; 1138 case GEN: return "Relates a specialized material concept (player) to its generalization (scoper)."; 1139 case GRIC: return "A special link between pharmaceuticals indicating that the target (scoper) is a generic for the source (player)."; 1140 case INST: return "An individual piece of material (player) instantiating a class of material (scoper)."; 1141 case SUBS: 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."; 1142 case _ROLECLASSPARTITIVE: 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."; 1143 case CONT: 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."; 1144 case EXPAGTCAR: 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)."; 1145 case EXPVECTOR: 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)."; 1146 case FOMITE: 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)."; 1147 case INGR: 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."; 1148 case ACTI: 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)."; 1149 case ACTIB: 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."; 1150 case ACTIM: 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."; 1151 case ACTIR: 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."; 1152 case ADJV: 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."; 1153 case ADTV: return "An ingredient (player) that is added to a base (scoper), that amounts to a minor part of the overall mixture."; 1154 case BASE: 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."; 1155 case CNTM: return "An ingredient whose presence is not intended but may not be reasonably avoided given the circumstances of the mixture's nature or origin."; 1156 case IACT: 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."; 1157 case COLR: return "A substance (player) influencing the optical aspect of material (scoper)."; 1158 case FLVR: 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)."; 1159 case PRSV: return "A substance (player) added to a mixture (scoper) to prevent microorganisms (fungi, bacteria) to spoil the mixture."; 1160 case STBL: return "A stabilizer (player) added to a mixture (scoper) in order to prevent the molecular disintegration of the main substance."; 1161 case MECH: 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."; 1162 case LOCE: return "Relates an entity (player) to a location (scoper) at which it is present in some way. This presence may be limited in time."; 1163 case STOR: return "Relates an entity (player) (e.g. a device) to a location (scoper) at which it is normally found or stored when not used."; 1164 case MBR: 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."; 1165 case PART: 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)."; 1166 case ACTM: 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."; 1167 case SPEC: return "A role played by a material entity that is a specimen for an act. It is scoped by the source of the specimen."; 1168 case ALQT: return "A portion (player) of an original or source specimen (scoper) used for testing or transportation."; 1169 case ISLT: return "A microorganism that has been isolated from other microorganisms or a source matrix."; 1170 case CHILD: return "The player of the role is a child of the scoping entity, in a generic sense."; 1171 case CRED: return "A role played by an entity that receives credentials from the scoping entity."; 1172 case NURPRAC: return "nurse practitioner"; 1173 case NURS: return "nurse"; 1174 case PA: return "physician assistant"; 1175 case PHYS: return "physician"; 1176 default: return "?"; 1177 } 1178 } 1179 public String getDisplay() { 1180 switch (this) { 1181 case ROL: return "role"; 1182 case _ROLECLASSASSOCIATIVE: return "RoleClassAssociative"; 1183 case _ROLECLASSMUTUALRELATIONSHIP: return "RoleClassMutualRelationship"; 1184 case _ROLECLASSRELATIONSHIPFORMAL: return "RoleClassRelationshipFormal"; 1185 case AFFL: return "affiliate"; 1186 case AGNT: return "agent"; 1187 case ASSIGNED: return "assigned entity"; 1188 case COMPAR: return "commissioning party"; 1189 case SGNOFF: return "signing authority or officer"; 1190 case CON: return "contact"; 1191 case ECON: return "emergency contact"; 1192 case NOK: return "next of kin"; 1193 case GUARD: return "guardian"; 1194 case CIT: return "citizen"; 1195 case COVPTY: return "covered party"; 1196 case CLAIM: return "claimant"; 1197 case NAMED: return "named insured"; 1198 case DEPEN: return "dependent"; 1199 case INDIV: return "individual"; 1200 case SUBSCR: return "subscriber"; 1201 case PROG: return "program eligible"; 1202 case CRINV: return "clinical research investigator"; 1203 case CRSPNSR: return "clinical research sponsor"; 1204 case EMP: return "employee"; 1205 case MIL: return "military person"; 1206 case GUAR: return "guarantor"; 1207 case INVSBJ: return "Investigation Subject"; 1208 case CASEBJ: return "Case Subject"; 1209 case RESBJ: return "research subject"; 1210 case LIC: return "licensed entity"; 1211 case NOT: return "notary public"; 1212 case PROV: return "healthcare provider"; 1213 case PAT: return "patient"; 1214 case PAYEE: return "payee"; 1215 case PAYOR: return "invoice payor"; 1216 case POLHOLD: return "policy holder"; 1217 case QUAL: return "qualified entity"; 1218 case SPNSR: return "coverage sponsor"; 1219 case STD: return "student"; 1220 case UNDWRT: return "underwriter"; 1221 case CAREGIVER: return "caregiver"; 1222 case PRS: return "personal relationship"; 1223 case SELF: return "self"; 1224 case _ROLECLASSPASSIVE: return "RoleClassPassive"; 1225 case ACCESS: return "access"; 1226 case ADJY: return "adjacency"; 1227 case CONC: return "connection"; 1228 case BOND: return "molecular bond"; 1229 case CONY: return "continuity"; 1230 case ADMM: return "Administerable Material"; 1231 case BIRTHPL: return "birthplace"; 1232 case DEATHPLC: return "place of death"; 1233 case DST: return "distributed material"; 1234 case RET: return "retailed material"; 1235 case EXLOC: return "event location"; 1236 case SDLOC: return "service delivery location"; 1237 case DSDLOC: return "dedicated service delivery location"; 1238 case ISDLOC: return "incidental service delivery location"; 1239 case EXPR: return "exposed entity"; 1240 case HLD: return "held entity"; 1241 case HLTHCHRT: return "health chart"; 1242 case IDENT: return "identified entity"; 1243 case MANU: return "manufactured product"; 1244 case THER: return "therapeutic agent"; 1245 case MNT: return "maintained entity"; 1246 case OWN: return "owned entity"; 1247 case RGPR: return "regulated product"; 1248 case TERR: return "territory of authority"; 1249 case USED: return "used entity"; 1250 case WRTE: return "warranted product"; 1251 case _ROLECLASSONTOLOGICAL: return "RoleClassOntological"; 1252 case EQUIV: return "equivalent entity"; 1253 case SAME: return "same"; 1254 case SUBY: return "subsumed by"; 1255 case GEN: return "has generalization"; 1256 case GRIC: return "has generic"; 1257 case INST: return "instance"; 1258 case SUBS: return "subsumer"; 1259 case _ROLECLASSPARTITIVE: return "RoleClassPartitive"; 1260 case CONT: return "content"; 1261 case EXPAGTCAR: return "exposure agent carrier"; 1262 case EXPVECTOR: return "exposure vector"; 1263 case FOMITE: return "fomite"; 1264 case INGR: return "ingredient"; 1265 case ACTI: return "active ingredient"; 1266 case ACTIB: return "active ingredient - basis of strength"; 1267 case ACTIM: return "active ingredient - moiety is basis of strength"; 1268 case ACTIR: return "active ingredient - reference substance is basis of strength"; 1269 case ADJV: return "adjuvant"; 1270 case ADTV: return "additive"; 1271 case BASE: return "base"; 1272 case CNTM: return "contaminant ingredient"; 1273 case IACT: return "inactive ingredient"; 1274 case COLR: return "color additive"; 1275 case FLVR: return "flavor additive"; 1276 case PRSV: return "preservative"; 1277 case STBL: return "stabilizer"; 1278 case MECH: return "mechanical ingredient"; 1279 case LOCE: return "located entity"; 1280 case STOR: return "stored entity"; 1281 case MBR: return "member"; 1282 case PART: return "part"; 1283 case ACTM: return "active moiety"; 1284 case SPEC: return "specimen"; 1285 case ALQT: return "aliquot"; 1286 case ISLT: return "isolate"; 1287 case CHILD: return "child"; 1288 case CRED: return "credentialed entity"; 1289 case NURPRAC: return "nurse practitioner"; 1290 case NURS: return "nurse"; 1291 case PA: return "physician assistant"; 1292 case PHYS: return "physician"; 1293 default: return "?"; 1294 } 1295 } 1296 1297 1298} 1299