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