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