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