public enum V3RoleClass extends Enum<V3RoleClass>
| Enum Constant and 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.
|
| Modifier and Type | Method and Description |
|---|---|
static V3RoleClass |
fromCode(String codeString) |
String |
getDefinition() |
String |
getDisplay() |
String |
getSystem() |
String |
toCode() |
static V3RoleClass |
valueOf(String name)
Returns the enum constant of this type with the specified name.
|
static V3RoleClass[] |
values()
Returns an array containing the constants of this enum type, in
the order they are declared.
|
public static final V3RoleClass ROL
public static final V3RoleClass _ROLECLASSASSOCIATIVE
public static final V3RoleClass _ROLECLASSMUTUALRELATIONSHIP
public static final V3RoleClass _ROLECLASSRELATIONSHIPFORMAL
public static final V3RoleClass AFFL
public static final V3RoleClass AGNT
public static final V3RoleClass ASSIGNED
public static final V3RoleClass COMPAR
public static final V3RoleClass SGNOFF
public static final V3RoleClass CON
public static final V3RoleClass ECON
public static final V3RoleClass NOK
public static final V3RoleClass GUARD
public static final V3RoleClass CIT
public static final V3RoleClass COVPTY
public static final V3RoleClass CLAIM
public static final V3RoleClass NAMED
public static final V3RoleClass DEPEN
public static final V3RoleClass INDIV
public static final V3RoleClass SUBSCR
public static final V3RoleClass PROG
public static final V3RoleClass CRINV
public static final V3RoleClass CRSPNSR
public static final V3RoleClass EMP
public static final V3RoleClass MIL
public static final V3RoleClass GUAR
public static final V3RoleClass INVSBJ
public static final V3RoleClass CASEBJ
public static final V3RoleClass RESBJ
public static final V3RoleClass LIC
public static final V3RoleClass NOT
public static final V3RoleClass PROV
public static final V3RoleClass PAT
public static final V3RoleClass PAYEE
public static final V3RoleClass PAYOR
public static final V3RoleClass POLHOLD
public static final V3RoleClass QUAL
public static final V3RoleClass SPNSR
public static final V3RoleClass STD
public static final V3RoleClass UNDWRT
public static final V3RoleClass CAREGIVER
public static final V3RoleClass PRS
public static final V3RoleClass SELF
public static final V3RoleClass _ROLECLASSPASSIVE
public static final V3RoleClass ACCESS
public static final V3RoleClass ADJY
public static final V3RoleClass CONC
public static final V3RoleClass BOND
public static final V3RoleClass CONY
public static final V3RoleClass ADMM
public static final V3RoleClass BIRTHPL
public static final V3RoleClass DEATHPLC
public static final V3RoleClass DST
public static final V3RoleClass RET
public static final V3RoleClass EXLOC
public static final V3RoleClass SDLOC
public static final V3RoleClass DSDLOC
public static final V3RoleClass ISDLOC
public static final V3RoleClass EXPR
public static final V3RoleClass HLD
public static final V3RoleClass HLTHCHRT
public static final V3RoleClass IDENT
public static final V3RoleClass MANU
public static final V3RoleClass THER
public static final V3RoleClass MNT
public static final V3RoleClass OWN
public static final V3RoleClass RGPR
public static final V3RoleClass TERR
public static final V3RoleClass USED
public static final V3RoleClass WRTE
public static final V3RoleClass _ROLECLASSONTOLOGICAL
public static final V3RoleClass EQUIV
public static final V3RoleClass SAME
public static final V3RoleClass SUBY
public static final V3RoleClass GEN
public static final V3RoleClass GRIC
public static final V3RoleClass INST
public static final V3RoleClass SUBS
public static final V3RoleClass _ROLECLASSPARTITIVE
public static final V3RoleClass CONT
public static final V3RoleClass EXPAGTCAR
public static final V3RoleClass EXPVECTOR
public static final V3RoleClass FOMITE
public static final V3RoleClass INGR
public static final V3RoleClass ACTI
public static final V3RoleClass ACTIB
public static final V3RoleClass ACTIM
public static final V3RoleClass ACTIR
public static final V3RoleClass ADJV
public static final V3RoleClass ADTV
public static final V3RoleClass BASE
public static final V3RoleClass CNTM
public static final V3RoleClass IACT
public static final V3RoleClass COLR
public static final V3RoleClass FLVR
public static final V3RoleClass PRSV
public static final V3RoleClass STBL
public static final V3RoleClass MECH
public static final V3RoleClass LOCE
public static final V3RoleClass STOR
public static final V3RoleClass MBR
public static final V3RoleClass PART
public static final V3RoleClass ACTM
public static final V3RoleClass SPEC
public static final V3RoleClass ALQT
public static final V3RoleClass ISLT
public static final V3RoleClass CHILD
public static final V3RoleClass CRED
public static final V3RoleClass NURPRAC
public static final V3RoleClass NURS
public static final V3RoleClass PA
public static final V3RoleClass PHYS
public static final V3RoleClass NULL
public static V3RoleClass[] values()
for (V3RoleClass c : V3RoleClass.values()) System.out.println(c);
public static V3RoleClass valueOf(String name)
name - the name of the enum constant to be returned.IllegalArgumentException - if this enum type has no constant with the specified nameNullPointerException - if the argument is nullpublic static V3RoleClass fromCode(String codeString) throws org.hl7.fhir.exceptions.FHIRException
org.hl7.fhir.exceptions.FHIRExceptionpublic String getDefinition()
public String getDisplay()
Copyright © 2014–2021 Health Level 7. All rights reserved.