org.hl7.rim

Interface RoleLink

public interface RoleLink extends RimObject, InfrastructureRoot

Interface for RIM class RoleLink.

A connection between two roles expressing a dependency between those roles.

Examples: 1.) A role of assignment or agency depends on another role of employment, such that when the employment role is terminated, the assignments would be terminated as well. This is the dependency of the assignment role with the employment role, or in other words, the assignment is "part of" the employment.

2.) One role has authority over another (in organizational relationships). For example, an employee of type "manager" may have authority over employees of type "analyst" which would be indicated by a role link for "direct authority".

Discussion: RoleLink specifies the relationships between roles, not between people (or other entities). People (or other Entities) are primarily related by their direct player/scoper relationships around the player's Role and more generally through their interactions (i.e. their participations in acts).

Method Summary
IVL<TS>getEffectiveTime()
Gets attribute effectiveTime of type IVL and cardinality 0..1.
RolegetSource()
Gets association 'source' to RIM class Role with cardinality (1..1).
RolegetTarget()
Gets association 'target' to RIM class Role with cardinality (1..1).
CSgetTypeCode()
Gets attribute typeCode of type CS and cardinality 1..1.
voidsetEffectiveTime(IVL<TS> value)
Sets attribute effectiveTime of type IVL and cardinality 0..1.
voidsetSource(Role value)
Sets association 'source' to RIM class Role with cardinality (1..1).
voidsetTarget(Role value)
Sets association 'target' to RIM class Role with cardinality (1..1).
voidsetTypeCode(CS value)
Sets attribute typeCode of type CS and cardinality 1..1.

Method Detail

getEffectiveTime

public IVL<TS> getEffectiveTime()
Gets attribute effectiveTime of type IVL and cardinality 0..1.

An interval of time specifying the period during which the connection between Roles is in effect.

Returns: the attribute value

getSource

public Role getSource()
Gets association 'source' to RIM class Role with cardinality (1..1).

Returns: the reference to the linked class

getTarget

public Role getTarget()
Gets association 'target' to RIM class Role with cardinality (1..1).

Returns: the reference to the linked class

getTypeCode

public CS getTypeCode()
Gets attribute typeCode of type CS and cardinality 1..1.

A code specifying the kind of connection represented by this RoleLink, e.g., has-part, has-authority.

Returns: the attribute value

setEffectiveTime

public void setEffectiveTime(IVL<TS> value)
Sets attribute effectiveTime of type IVL and cardinality 0..1.

An interval of time specifying the period during which the connection between Roles is in effect.

Parameters: value the new attribute value

setSource

public void setSource(Role value)
Sets association 'source' to RIM class Role with cardinality (1..1).

Parameters: value the new association value

setTarget

public void setTarget(Role value)
Sets association 'target' to RIM class Role with cardinality (1..1).

Parameters: value the new association value

setTypeCode

public void setTypeCode(CS value)
Sets attribute typeCode of type CS and cardinality 1..1.

A code specifying the kind of connection represented by this RoleLink, e.g., has-part, has-authority.

Parameters: value the new attribute value