ca.uhn.hl7v2.model.v231.segment
Class ROL

java.lang.Object
  ca.uhn.hl7v2.model.AbstractSegment
      ca.uhn.hl7v2.model.v231.segment.ROL

All Implemented Interfaces:

Segment, Structure, Serializable

public class ROL
extends AbstractSegment

Represents an HL7 ROL message segment (Role). This segment has the following fields:

• ROL-1: Role Instance ID (EI)
• ROL-2: Action Code (ID)
• ROL-3: Role-ROL (CE)
• ROL-4: Role Person (XCN) repeating
• ROL-5: Role Begin Date/Time (TS) optional
• ROL-6: Role End Date/Time (TS) optional
• ROL-7: Role Duration (CE) optional
• ROL-8: Role Action Reason (CE) optional

See Also:

Serialized Form

Constructor Summary

ROL(Group parent, ModelClassFactory factory)
Creates a new ROL segment

Method Summary

protected Type	createNewTypeWithoutReflection(int field)
ID	getActionCode() Returns ROL-2: "Action Code" - creates it if necessary
EI	getRol1_RoleInstanceID() Returns ROL-1: "Role Instance ID" - creates it if necessary
ID	getRol2_ActionCode() Returns ROL-2: "Action Code" - creates it if necessary
CE	getRol3_RoleROL() Returns ROL-3: "Role-ROL" - creates it if necessary
XCN	getRol4_RolePerson(int rep) Returns a specific repetition of ROL-4: "Role Person" - creates it if necessary
int	getRol4_RolePersonReps() Returns a count of the current number of repetitions of Role Person (ROL-4).
TS	getRol5_RoleBeginDateTime() Returns ROL-5: "Role Begin Date/Time" - creates it if necessary
TS	getRol6_RoleEndDateTime() Returns ROL-6: "Role End Date/Time" - creates it if necessary
CE	getRol7_RoleDuration() Returns ROL-7: "Role Duration" - creates it if necessary
CE	getRol8_RoleActionReason() Returns ROL-8: "Role Action Reason" - creates it if necessary
CE	getRoleActionReason() Returns ROL-8: "Role Action Reason" - creates it if necessary
TS	getRoleBeginDateTime() Returns ROL-5: "Role Begin Date/Time" - creates it if necessary
CE	getRoleDuration() Returns ROL-7: "Role Duration" - creates it if necessary
TS	getRoleEndDateTime() Returns ROL-6: "Role End Date/Time" - creates it if necessary
EI	getRoleInstanceID() Returns ROL-1: "Role Instance ID" - creates it if necessary
XCN[]	getRolePerson() Returns all repetitions of Role Person (ROL-4).
XCN	getRolePerson(int rep) Returns a specific repetition of ROL-4: "Role Person" - creates it if necessary
int	getRolePersonReps() Returns a count of the current number of repetitions of Role Person (ROL-4).
CE	getRoleROL() Returns ROL-3: "Role-ROL" - creates it if necessary
XCN	insertRol4_RolePerson(int rep) Inserts a repetition of ROL-4: "Role Person" at a specific index
XCN	insertRolePerson(int rep) Inserts a repetition of ROL-4: "Role Person" at a specific index
XCN	removeRol4_RolePerson(int rep) Removes a repetition of ROL-4: "Role Person" at a specific index
XCN	removeRolePerson(int rep) Removes a repetition of ROL-4: "Role Person" at a specific index

Methods inherited from class ca.uhn.hl7v2.model.AbstractSegment

add, add, clear, encode, getField, getField, getLength, getMaxCardinality, getMessage, getName, getNames, getParent, insertRepetition, isRequired, main, numFields, parse, removeRepetition

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ROL

public ROL(Group parent,
           ModelClassFactory factory)

Creates a new ROL segment

Method Detail

getRoleInstanceID

public EI getRoleInstanceID()

Returns ROL-1: "Role Instance ID" - creates it if necessary

getRol1_RoleInstanceID

public EI getRol1_RoleInstanceID()

Returns ROL-1: "Role Instance ID" - creates it if necessary

getActionCode

public ID getActionCode()

Returns ROL-2: "Action Code" - creates it if necessary

getRol2_ActionCode

public ID getRol2_ActionCode()

Returns ROL-2: "Action Code" - creates it if necessary

getRoleROL

public CE getRoleROL()

Returns ROL-3: "Role-ROL" - creates it if necessary

getRol3_RoleROL

public CE getRol3_RoleROL()

Returns ROL-3: "Role-ROL" - creates it if necessary

getRolePerson

public XCN[] getRolePerson()

Returns all repetitions of Role Person (ROL-4).

getRolePersonReps

public int getRolePersonReps()

Returns a count of the current number of repetitions of Role Person (ROL-4). This method does not create a repetition, so if no repetitions have currently been defined or accessed, it will return zero.

getRolePerson

public XCN getRolePerson(int rep)

Returns a specific repetition of ROL-4: "Role Person" - creates it if necessary

Parameters:

rep - The repetition index (0-indexed)

getRol4_RolePerson

public XCN getRol4_RolePerson(int rep)

Returns a specific repetition of ROL-4: "Role Person" - creates it if necessary

Parameters:

rep - The repetition index (0-indexed)

getRol4_RolePersonReps

public int getRol4_RolePersonReps()

Returns a count of the current number of repetitions of Role Person (ROL-4). This method does not create a repetition, so if no repetitions have currently been defined or accessed, it will return zero.

insertRolePerson

public XCN insertRolePerson(int rep)
                     throws HL7Exception

Inserts a repetition of ROL-4: "Role Person" at a specific index

Parameters:

rep - The repetition index (0-indexed)

Throws:

HL7Exception - If the rep is invalid (below 0, or too high for the allowable repetitions)

insertRol4_RolePerson

public XCN insertRol4_RolePerson(int rep)
                          throws HL7Exception

Inserts a repetition of ROL-4: "Role Person" at a specific index

Parameters:

rep - The repetition index (0-indexed)

Throws:

HL7Exception - If the rep is invalid (below 0, or too high for the allowable repetitions)

removeRolePerson

public XCN removeRolePerson(int rep)
                     throws HL7Exception

Removes a repetition of ROL-4: "Role Person" at a specific index

Parameters:

rep - The repetition index (0-indexed)

Throws:

HL7Exception - If the rep is invalid (below 0, or too high for the allowable repetitions)

removeRol4_RolePerson

public XCN removeRol4_RolePerson(int rep)
                          throws HL7Exception

Removes a repetition of ROL-4: "Role Person" at a specific index

Parameters:

rep - The repetition index (0-indexed)

Throws:

HL7Exception - If the rep is invalid (below 0, or too high for the allowable repetitions)

getRoleBeginDateTime

public TS getRoleBeginDateTime()

Returns ROL-5: "Role Begin Date/Time" - creates it if necessary

getRol5_RoleBeginDateTime

public TS getRol5_RoleBeginDateTime()

Returns ROL-5: "Role Begin Date/Time" - creates it if necessary

getRoleEndDateTime

public TS getRoleEndDateTime()

Returns ROL-6: "Role End Date/Time" - creates it if necessary

getRol6_RoleEndDateTime

public TS getRol6_RoleEndDateTime()

Returns ROL-6: "Role End Date/Time" - creates it if necessary

getRoleDuration

public CE getRoleDuration()

Returns ROL-7: "Role Duration" - creates it if necessary

getRol7_RoleDuration

public CE getRol7_RoleDuration()

Returns ROL-7: "Role Duration" - creates it if necessary

getRoleActionReason

public CE getRoleActionReason()

Returns ROL-8: "Role Action Reason" - creates it if necessary

getRol8_RoleActionReason

public CE getRol8_RoleActionReason()

Returns ROL-8: "Role Action Reason" - creates it if necessary

createNewTypeWithoutReflection

protected Type createNewTypeWithoutReflection(int field)

Overrides:

createNewTypeWithoutReflection in class AbstractSegment