Enum V3RoleClass

    • Enum Constant Summary

      Enum Constants 
      Enum Constant Description
      _ROLECLASSASSOCIATIVE
      A general association between two entities that is neither partitive nor ontological.
      _ROLECLASSMUTUALRELATIONSHIP
      A relationship that is based on mutual behavior of the two Entities as being related.
      _ROLECLASSONTOLOGICAL
      A relationship in which the scoping Entity defines or specifies what the playing Entity is.
      _ROLECLASSPARTITIVE
      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.
      _ROLECLASSPASSIVE
      An association for a playing Entity that is used, known, treated, handled, built, or destroyed, etc.
      _ROLECLASSRELATIONSHIPFORMAL
      A relationship between two entities that is formally recognized, frequently by a contract or similar agreement.
      ACCESS
      A role in which the playing entity (material) provides access to another entity.
      ACTI
      Definition: a therapeutically active ingredient (player) in a mixture (scoper), where the mixture is typically a manufactured pharmaceutical.
      ACTIB
      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.
      ACTIM
      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.
      ACTIR
      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.
      ACTM
      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).
      ADJV
      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.
      ADJY
      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.
      ADMM
      A material (player) that can be administered to an Entity (scoper).
      ADTV
      An ingredient (player) that is added to a base (scoper), that amounts to a minor part of the overall mixture.
      AFFL
      Player of the Affiliate role has a business/professional relationship with scoper.
      AGNT
      An entity (player) that acts or is authorized to act on behalf of another entity (scoper).
      ALQT
      A portion (player) of an original or source specimen (scoper) used for testing or transportation.
      ASSIGNED
      An agent role in which the agent is an Entity acting in the employ of an organization.
      BASE
      A base ingredient (player) is what comprises the major part of a mixture (scoper).
      BIRTHPL
      Relates a place (playing Entity) as the location where a living subject (scoping Entity) was born.
      BOND
      A connection between two atoms of a molecule.
      CAREGIVER
      A person responsible for the primary care of a patient at home.
      CASEBJ
      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)
      CHILD
      The player of the role is a child of the scoping entity, in a generic sense.
      CIT
      Citizen of apolitical entity
      CLAIM
      Description: A role played by a party making a claim for coverage under a policy or program.
      CNTM
      An ingredient whose presence is not intended but may not be reasonably avoided given the circumstances of the mixture's nature or origin.
      COLR
      A substance (player) influencing the optical aspect of material (scoper).
      COMPAR
      An Entity that is authorized to issue or instantiate permissions, privileges, credentials or other formal/legal authorizations.
      CON
      A person or an organization (player) which provides or receives information regarding another entity (scoper).
      CONC
      An adjacency of two Entities held together by a bond which attaches to each of the two entities.
      CONT
      Relates a material as the content (player) to a container (scoper).
      CONY
      A connection between two regional parts.
      COVPTY
      A role class played by a person who receives benefit coverage under the terms of a particular insurance policy.
      CRED
      A role played by an entity that receives credentials from the scoping entity.
      CRINV
      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.
      CRSPNSR
      A role played by an entity, usually an organization, that is the sponsor of a clinical research trial or study.
      DEATHPLC
      Definition: Relates a place (playing Entity) as the location where a living subject (scoping Entity) died.
      DEPEN
      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.
      DSDLOC
      A role of a place (player) that is intended to house the provision of services.
      DST
      A material (player) distributed by a distributor (scoper) who functions between a manufacturer and a buyer or retailer.
      ECON
      An entity to be contacted in the event of an emergency.
      EMP
      A relationship between a person or organization and a person or organization formed for the purpose of exchanging work for compensation.
      EQUIV
      Description: Specifies the player Entity (the equivalent Entity) as an Entity that is considered to be equivalent to a reference Entity (scoper).
      EXLOC
      A role played by a place at which the location of an event may be recorded.
      EXPAGTCAR
      An exposure agent carrier is an entity that is capable of conveying an exposure agent from one entity to another.
      EXPR
      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.
      EXPVECTOR
      Description: A vector is a living subject that carries an exposure agent.
      FLVR
      A substance (player) added to a mixture (scoper) to make it taste a certain way.
      FOMITE
      Description: A fomite is a non-living entity that is capable of conveying exposure agent from one entity to another.
      GEN
      Relates a specialized material concept (player) to its generalization (scoper).
      GRIC
      A special link between pharmaceuticals indicating that the target (scoper) is a generic for the source (player).
      GUAR
      A person or organization (player) that serves as a financial guarantor for another person or organization (scoper).
      GUARD
      Guardian of a ward
      HLD
      Entity that is currently in the possession of a holder (scoper), who holds, or uses it, usually based on some agreement with the owner.
      HLTHCHRT
      The role of a material (player) that is the physical health chart belonging to an organization (scoper).
      IACT
      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.
      IDENT
      A role in which the scoping entity designates an identifier for a playing entity.
      INDIV
      Description: A role played by a party covered under a policy as the policy holder.
      INGR
      Relates a component (player) to a mixture (scoper).
      INST
      An individual piece of material (player) instantiating a class of material (scoper).
      INVSBJ
      An entity that is the subject of an investigation.
      ISDLOC
      A role played by a place at which health care services may be provided without prior designation or authorization.
      ISLT
      A microorganism that has been isolated from other microorganisms or a source matrix.
      LIC
      A relationship in which the scoper certifies the player ( e.
      LOCE
      Relates an entity (player) to a location (scoper) at which it is present in some way.
      MANU
      Scoped by the manufacturer
      MBR
      A role played by an entity that is a member of a group.
      MECH
      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.
      MIL
      A role played by a member of a military service.
      MNT
      An entity (player) that is maintained by another entity (scoper).
      NAMED
      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.
      NOK
      An individual designated for notification as the next of kin for a given entity.
      NOT
      notary public
      NULL
      added to help the parsers
      NURPRAC
      nurse practitioner
      NURS
      nurse
      OWN
      An Entity (player) for which someone (scoper) is granted by law the right to call the material (player) his own.
      PA
      physician assistant
      PART
      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.
      PAT
      A Role of a LivingSubject (player) as an actual or potential recipient of health care services from a healthcare provider organization (scoper).
      PAYEE
      The role of an organization or individual designated to receive payment for a claim against a particular coverage.
      PAYOR
      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.
      PHYS
      physician
      POLHOLD
      A role played by a person or organization that holds an insurance policy.
      PROG
      Description: A role played by a party that meets the eligibility criteria for coverage under a program.
      PROV
      An Entity (player) that is authorized to provide health care services by some authorizing agency (scoper).
      PRS
      Links two entities with classCode PSN (person) in a personal relationship.
      PRSV
      A substance (player) added to a mixture (scoper) to prevent microorganisms (fungi, bacteria) to spoil the mixture.
      QUAL
      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.
      RESBJ
      Definition:Specifies the administrative functionality within a formal experimental design for which the ResearchSubject role was established.
      RET
      Material (player) sold by a retailer (scoper), who also give advice to prospective buyers.
      RGPR
      A product regulated by some governmentatl orgnization.
      ROL
      Corresponds to the Role class
      SAME
      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.
      SDLOC
      A role played by a place at which services may be provided.
      SELF
      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.
      SGNOFF
      The role of a person (player) who is the officer or signature authority for of a scoping entity, usually an organization (scoper).
      SPEC
      A role played by a material entity that is a specimen for an act.
      SPNSR
      A role played by an entity, usually an organization that is the sponsor of an insurance plan or a health program.
      STBL
      A stabilizer (player) added to a mixture (scoper) in order to prevent the molecular disintegration of the main substance.
      STD
      A role played by an individual who is a student of a school, which is the scoping entity.
      STOR
      Relates an entity (player) (e.g.
      SUBS
      An entity that subsumes the identity of another.
      SUBSCR
      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.
      SUBY
      Relates a prevailing record of an Entity (scoper) with another record (player) that it subsumes.
      TERR
      Relates a place entity (player) as the region over which the scoper (typically an Organization) has certain authority (jurisdiction).
      THER
      A manufactured material (player) that is used for its therapeutic properties.
      UNDWRT
      A role played by a person or an organization.
      USED
      Description:An entity (player) that is used by another entity (scoper)
      WRTE
      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.
    • Enum Constant Detail

      • ROL

        public static final V3RoleClass ROL
        Corresponds to the Role class
      • _ROLECLASSASSOCIATIVE

        public static final V3RoleClass _ROLECLASSASSOCIATIVE
        A general association between two entities that is neither partitive nor ontological.
      • _ROLECLASSMUTUALRELATIONSHIP

        public static final V3RoleClass _ROLECLASSMUTUALRELATIONSHIP
        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).
      • _ROLECLASSRELATIONSHIPFORMAL

        public static final V3RoleClass _ROLECLASSRELATIONSHIPFORMAL
        A relationship between two entities that is formally recognized, frequently by a contract or similar agreement.
      • AFFL

        public static final V3RoleClass AFFL
        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. Example: A healthcare provider is affiliated with another provider as a business associate.
      • AGNT

        public static final V3RoleClass AGNT
        An entity (player) that acts or is authorized to act on behalf of another entity (scoper).
      • ASSIGNED

        public static final V3RoleClass ASSIGNED
        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.
      • COMPAR

        public static final V3RoleClass COMPAR
        An Entity that is authorized to issue or instantiate permissions, privileges, credentials or other formal/legal authorizations.
      • SGNOFF

        public static final V3RoleClass SGNOFF
        The role of a person (player) who is the officer or signature authority for of a scoping entity, usually an organization (scoper).
      • CON

        public static final V3RoleClass CON
        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.
      • ECON

        public static final V3RoleClass ECON
        An entity to be contacted in the event of an emergency.
      • NOK

        public static final V3RoleClass NOK
        An individual designated for notification as the next of kin for a given entity.
      • CIT

        public static final V3RoleClass CIT
        Citizen of apolitical entity
      • COVPTY

        public static final V3RoleClass COVPTY
        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. 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. 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.
      • CLAIM

        public static final V3RoleClass CLAIM
        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. 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. 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. 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. Example: A claimant under automobile policy that is not the named insured.
      • NAMED

        public static final V3RoleClass NAMED
        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. 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. 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. 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.
      • DEPEN

        public static final V3RoleClass DEPEN
        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. 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. 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.
      • INDIV

        public static final V3RoleClass INDIV
        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. 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. Example: The individual insured under a comprehensive automobile, disability, or property and casualty policy that is the policy holder.
      • SUBSCR

        public static final V3RoleClass SUBSCR
        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. 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. 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. Example: An employee or a member of an association.
      • PROG

        public static final V3RoleClass PROG
        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. Discussion: A program as typically government administered coverage for parties determined eligible under the terms of the program. 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. 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. 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.
      • CRINV

        public static final V3RoleClass CRINV
        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.
      • CRSPNSR

        public static final V3RoleClass CRSPNSR
        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.
      • EMP

        public static final V3RoleClass EMP
        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.)
      • MIL

        public static final V3RoleClass MIL
        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.)
      • GUAR

        public static final V3RoleClass GUAR
        A person or organization (player) that serves as a financial guarantor for another person or organization (scoper).
      • INVSBJ

        public static final V3RoleClass INVSBJ
        An entity that is the subject of an investigation. This role is scoped by the party responsible for the investigation.
      • CASEBJ

        public static final V3RoleClass CASEBJ
        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)
      • RESBJ

        public static final V3RoleClass RESBJ
        Definition:Specifies the administrative functionality within a formal experimental design for which the ResearchSubject role was established. 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.
      • LIC

        public static final V3RoleClass LIC
        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).
      • PROV

        public static final V3RoleClass PROV
        An Entity (player) that is authorized to provide health care services by some authorizing agency (scoper).
      • PAT

        public static final V3RoleClass PAT
        A Role of a LivingSubject (player) as an actual or potential recipient of health care services from a healthcare provider organization (scoper). 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.
      • PAYEE

        public static final V3RoleClass PAYEE
        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.
      • PAYOR

        public static final V3RoleClass PAYOR
        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.
      • POLHOLD

        public static final V3RoleClass POLHOLD
        A role played by a person or organization that holds an insurance policy. The underwriter of that policy is the scoping entity. Discussion:The identifier of the policy is captured in 'Role.id' when the Role is a policy holder. 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.
      • QUAL

        public static final V3RoleClass QUAL
        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.
      • SPNSR

        public static final V3RoleClass SPNSR
        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 a policy holder of the plan; where the sponsor is the policy holder, who may become a subscriber or a dependent to a policy under the plan; or where the sponsor is a government agency, who may become program eligibles under a program. 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. Example: An employer, union, government agency, or association.
      • STD

        public static final V3RoleClass STD
        A role played by an individual who is a student of a school, which is the scoping entity.
      • UNDWRT

        public static final V3RoleClass UNDWRT
        A role played by a person or an organization. It is the party that accepts fiscal responsibility for insurance plans and the policies created under those plans; administers and accepts fiscal responsibility for a program that provides coverage for services to eligible individuals; and/or 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. Example: A health insurer; Medicaid Program; Lloyd's of London
      • CAREGIVER

        public static final V3RoleClass CAREGIVER
        A person responsible for the primary care of a patient at home.
      • PRS

        public static final V3RoleClass PRS
        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.
      • SELF

        public static final V3RoleClass SELF
        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. Usage: playing and scoping entities must have same classcode, but need not have identical attributes or values. Example: a provider registry maintains sets of conflicting demographic data for what is reported to be the same individual.
      • _ROLECLASSPASSIVE

        public static final V3RoleClass _ROLECLASSPASSIVE
        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.
      • ACCESS

        public static final V3RoleClass ACCESS
        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.
      • ADJY

        public static final V3RoleClass ADJY
        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. Examples: the colon is connected (and therefore adjacent) to the jejunum; the colon is adjacent to the liver (even if not actually connected.) 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.
      • CONC

        public static final V3RoleClass CONC
        An adjacency of two Entities held together by a bond which attaches to each of the two entities. Examples: biceps brachii muscle connected to the radius bone, port 3 on a network switch connected to port 5 on a patch panel. UsageConstraints: See Adjacency for the assignment of scoper (larger, more central) and player (smaller, more distant).
      • BOND

        public static final V3RoleClass BOND
        A connection between two atoms of a molecule. 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. UsageConstraints: See connection and adjacency for the assignment of player and scoper.
      • CONY

        public static final V3RoleClass CONY
        A connection between two regional parts. Examples: the connection between ascending aorta and the aortic arc, connection between descending colon and sigmoid. UsageConstraints: See connection and adjacency for the assignment of player and scoper.
      • ADMM

        public static final V3RoleClass ADMM
        A material (player) that can be administered to an Entity (scoper).
      • BIRTHPL

        public static final V3RoleClass BIRTHPL
        Relates a place (playing Entity) as the location where a living subject (scoping Entity) was born.
      • DEATHPLC

        public static final V3RoleClass DEATHPLC
        Definition: Relates a place (playing Entity) as the location where a living subject (scoping Entity) died.
      • DST

        public static final V3RoleClass DST
        A material (player) distributed by a distributor (scoper) who functions between a manufacturer and a buyer or retailer.
      • RET

        public static final V3RoleClass RET
        Material (player) sold by a retailer (scoper), who also give advice to prospective buyers.
      • EXLOC

        public static final V3RoleClass EXLOC
        A role played by a place at which the location of an event may be recorded.
      • SDLOC

        public static final V3RoleClass SDLOC
        A role played by a place at which services may be provided.
      • DSDLOC

        public static final V3RoleClass DSDLOC
        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."
      • ISDLOC

        public static final V3RoleClass ISDLOC
        A role played by a place at which health care services may be provided without prior designation or authorization.
      • EXPR

        public static final V3RoleClass EXPR
        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. 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."
      • HLD

        public static final V3RoleClass HLD
        Entity that is currently in the possession of a holder (scoper), who holds, or uses it, usually based on some agreement with the owner.
      • HLTHCHRT

        public static final V3RoleClass HLTHCHRT
        The role of a material (player) that is the physical health chart belonging to an organization (scoper).
      • IDENT

        public static final V3RoleClass IDENT
        A role in which the scoping entity designates an identifier for a playing entity.
      • THER

        public static final V3RoleClass THER
        A manufactured material (player) that is used for its therapeutic properties. The manufacturer is the scoper.
      • MNT

        public static final V3RoleClass MNT
        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.
      • OWN

        public static final V3RoleClass OWN
        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.
      • RGPR

        public static final V3RoleClass RGPR
        A product regulated by some governmentatl orgnization. The role is played by Material and scoped by Organization. Rationale: To support an entity clone used to identify the NDC number for a drug product.
      • TERR

        public static final V3RoleClass TERR
        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.
      • USED

        public static final V3RoleClass USED
        Description:An entity (player) that is used by another entity (scoper)
      • WRTE

        public static final V3RoleClass WRTE
        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.
      • _ROLECLASSONTOLOGICAL

        public static final V3RoleClass _ROLECLASSONTOLOGICAL
        A relationship in which the scoping Entity defines or specifies what the playing Entity is. Thus, the player's "being" (Greek: ontos) is specified.
      • EQUIV

        public static final V3RoleClass EQUIV
        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. 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.)
      • SAME

        public static final V3RoleClass SAME
        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. Usage: playing and scoping entities must have same classCode, but need not have identical attributes or values. Example: a provider registry maintains sets of conflicting demographic data for what is reported to be the same individual.
      • SUBY

        public static final V3RoleClass SUBY
        Relates a prevailing record of an Entity (scoper) with another record (player) that it subsumes. 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. Constraints: Both the player and scoper must have the same classCode.
      • GEN

        public static final V3RoleClass GEN
        Relates a specialized material concept (player) to its generalization (scoper).
      • GRIC

        public static final V3RoleClass GRIC
        A special link between pharmaceuticals indicating that the target (scoper) is a generic for the source (player).
      • INST

        public static final V3RoleClass INST
        An individual piece of material (player) instantiating a class of material (scoper).
      • SUBS

        public static final V3RoleClass SUBS
        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. The use of this code is deprecated in favor of the term SUBY which is its inverse and is more ontologically correct.
      • _ROLECLASSPARTITIVE

        public static final V3RoleClass _ROLECLASSPARTITIVE
        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.
      • CONT

        public static final V3RoleClass CONT
        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.
      • EXPAGTCAR

        public static final V3RoleClass EXPAGTCAR
        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).
      • EXPVECTOR

        public static final V3RoleClass EXPVECTOR
        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).
      • FOMITE

        public static final V3RoleClass FOMITE
        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).
      • INGR

        public static final V3RoleClass INGR
        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.
      • ACTI

        public static final V3RoleClass ACTI
        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).
      • ACTIB

        public static final V3RoleClass ACTIB
        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. 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.
      • ACTIM

        public static final V3RoleClass ACTIM
        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. Examples: 1 mL of Betopic 5mg/mL eye drops contains 5.6 mg betaxolol hydrochloride equivalent to betaxolol base 5 mg.
      • ACTIR

        public static final V3RoleClass ACTIR
        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. Examples: Toprol-XL 50 mg contains 47.5 mg of metoprolol succinate equivalent to 50 mg of metoprolol tartrate.
      • ADJV

        public static final V3RoleClass ADJV
        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.
      • ADTV

        public static final V3RoleClass ADTV
        An ingredient (player) that is added to a base (scoper), that amounts to a minor part of the overall mixture.
      • BASE

        public static final V3RoleClass BASE
        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.
      • CNTM

        public static final V3RoleClass CNTM
        An ingredient whose presence is not intended but may not be reasonably avoided given the circumstances of the mixture's nature or origin.
      • IACT

        public static final V3RoleClass IACT
        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.
      • COLR

        public static final V3RoleClass COLR
        A substance (player) influencing the optical aspect of material (scoper).
      • FLVR

        public static final V3RoleClass FLVR
        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).
      • PRSV

        public static final V3RoleClass PRSV
        A substance (player) added to a mixture (scoper) to prevent microorganisms (fungi, bacteria) to spoil the mixture.
      • STBL

        public static final V3RoleClass STBL
        A stabilizer (player) added to a mixture (scoper) in order to prevent the molecular disintegration of the main substance.
      • MECH

        public static final V3RoleClass MECH
        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. 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.
      • LOCE

        public static final V3RoleClass LOCE
        Relates an entity (player) to a location (scoper) at which it is present in some way. This presence may be limited in time.
      • STOR

        public static final V3RoleClass STOR
        Relates an entity (player) (e.g. a device) to a location (scoper) at which it is normally found or stored when not used.
      • MBR

        public static final V3RoleClass MBR
        A role played by an entity that is a member of a group. The group provides the scope for this role. 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.
      • PART

        public static final V3RoleClass PART
        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. 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).
      • ACTM

        public static final V3RoleClass ACTM
        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). Examples: heparin-sodium and heparin-potassium have the same active moiety, heparin; the active moiety of morphine-hydrochloride is morphine.
      • SPEC

        public static final V3RoleClass SPEC
        A role played by a material entity that is a specimen for an act. It is scoped by the source of the specimen.
      • ALQT

        public static final V3RoleClass ALQT
        A portion (player) of an original or source specimen (scoper) used for testing or transportation.
      • ISLT

        public static final V3RoleClass ISLT
        A microorganism that has been isolated from other microorganisms or a source matrix.
      • CHILD

        public static final V3RoleClass CHILD
        The player of the role is a child of the scoping entity, in a generic sense.
      • CRED

        public static final V3RoleClass CRED
        A role played by an entity that receives credentials from the scoping entity.
    • Method Detail

      • values

        public static V3RoleClass[] values()
        Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:
        for (V3RoleClass c : V3RoleClass.values())
            System.out.println(c);
        
        Returns:
        an array containing the constants of this enum type, in the order they are declared
      • valueOf

        public static V3RoleClass valueOf​(String name)
        Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)
        Parameters:
        name - the name of the enum constant to be returned.
        Returns:
        the enum constant with the specified name
        Throws:
        IllegalArgumentException - if this enum type has no constant with the specified name
        NullPointerException - if the argument is null
      • fromCode

        public static V3RoleClass fromCode​(String codeString)
                                    throws org.hl7.fhir.exceptions.FHIRException
        Throws:
        org.hl7.fhir.exceptions.FHIRException