ca.uhn.hl7v2.model.v231.segment

Class LRL

java.lang.Object

ca.uhn.hl7v2.model.AbstractStructure

ca.uhn.hl7v2.model.AbstractSegment

ca.uhn.hl7v2.model.v231.segment.LRL

All Implemented Interfaces:

Segment, Structure, Serializable

public class LRL
extends AbstractSegment

Represents an HL7 LRL message segment (LRL - location relationship segment). This segment has the following fields:

• LRL-1: Primary Key Value - LRL (PL)
• LRL-2: Segment Action Code (ID) optional
• LRL-3: Segment Unique Key (EI) optional
• LRL-4: Location Relationship ID (CE) optional
• LRL-5: Organizational Location Relationship Value (XON) optional repeating
• LRL-6: Patient Location Relationship Value (PL) optional

See Also:

Serialized Form

Field Summary

Fields inherited from class ca.uhn.hl7v2.model.AbstractStructure

log

Constructor Summary

Constructors

Constructor and Description
LRL(Group parent, ModelClassFactory factory) Creates a new LRL segment

Method Summary

Methods

Modifier and Type	Method and Description
protected Type	createNewTypeWithoutReflection(int field)
CE	getLocationRelationshipID() Returns LRL-4: "Location Relationship ID" - creates it if necessary
PL	getLrl1_PrimaryKeyValueLRL() Returns LRL-1: "Primary Key Value - LRL" - creates it if necessary
ID	getLrl2_SegmentActionCode() Returns LRL-2: "Segment Action Code" - creates it if necessary
EI	getLrl3_SegmentUniqueKey() Returns LRL-3: "Segment Unique Key" - creates it if necessary
CE	getLrl4_LocationRelationshipID() Returns LRL-4: "Location Relationship ID" - creates it if necessary
XON[]	getLrl5_OrganizationalLocationRelationshipValue() Returns all repetitions of Organizational Location Relationship Value (LRL-5).
XON	getLrl5_OrganizationalLocationRelationshipValue(int rep) Returns a specific repetition of LRL-5: "Organizational Location Relationship Value" - creates it if necessary
int	getLrl5_OrganizationalLocationRelationshipValueReps() Returns a count of the current number of repetitions of Organizational Location Relationship Value (LRL-5).
PL	getLrl6_PatientLocationRelationshipValue() Returns LRL-6: "Patient Location Relationship Value" - creates it if necessary
XON[]	getOrganizationalLocationRelationshipValue() Returns all repetitions of Organizational Location Relationship Value (LRL-5).
XON	getOrganizationalLocationRelationshipValue(int rep) Returns a specific repetition of LRL-5: "Organizational Location Relationship Value" - creates it if necessary
int	getOrganizationalLocationRelationshipValueReps() Returns a count of the current number of repetitions of Organizational Location Relationship Value (LRL-5).
PL	getPatientLocationRelationshipValue() Returns LRL-6: "Patient Location Relationship Value" - creates it if necessary
PL	getPrimaryKeyValueLRL() Returns LRL-1: "Primary Key Value - LRL" - creates it if necessary
ID	getSegmentActionCode() Returns LRL-2: "Segment Action Code" - creates it if necessary
EI	getSegmentUniqueKey() Returns LRL-3: "Segment Unique Key" - creates it if necessary
XON	insertLrl5_OrganizationalLocationRelationshipValue(int rep) Inserts a repetition of LRL-5: "Organizational Location Relationship Value" at a specific index
XON	insertOrganizationalLocationRelationshipValue(int rep) Inserts a repetition of LRL-5: "Organizational Location Relationship Value" at a specific index
XON	removeLrl5_OrganizationalLocationRelationshipValue(int rep) Removes a repetition of LRL-5: "Organizational Location Relationship Value" at a specific index
XON	removeOrganizationalLocationRelationshipValue(int rep) Removes a repetition of LRL-5: "Organizational Location Relationship Value" at a specific index

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

add, add, clear, encode, getField, getField, getLength, getMaxCardinality, getName, getNames, getReps, getTypedField, getTypedField, insertRepetition, isEmpty, isRequired, main, numFields, parse, removeRepetition

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

getMessage, getParent

Methods inherited from class java.lang.Object

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

Methods inherited from interface ca.uhn.hl7v2.model.Structure

getMessage, getParent

Constructor Detail

LRL

public LRL(Group parent,
   ModelClassFactory factory)

Creates a new LRL segment

Method Detail

getPrimaryKeyValueLRL

public PL getPrimaryKeyValueLRL()

Returns LRL-1: "Primary Key Value - LRL" - creates it if necessary

getLrl1_PrimaryKeyValueLRL

public PL getLrl1_PrimaryKeyValueLRL()

Returns LRL-1: "Primary Key Value - LRL" - creates it if necessary

getSegmentActionCode

public ID getSegmentActionCode()

Returns LRL-2: "Segment Action Code" - creates it if necessary

getLrl2_SegmentActionCode

public ID getLrl2_SegmentActionCode()

Returns LRL-2: "Segment Action Code" - creates it if necessary

getSegmentUniqueKey

public EI getSegmentUniqueKey()

Returns LRL-3: "Segment Unique Key" - creates it if necessary

getLrl3_SegmentUniqueKey

public EI getLrl3_SegmentUniqueKey()

Returns LRL-3: "Segment Unique Key" - creates it if necessary

getLocationRelationshipID

public CE getLocationRelationshipID()

Returns LRL-4: "Location Relationship ID" - creates it if necessary

getLrl4_LocationRelationshipID

public CE getLrl4_LocationRelationshipID()

Returns LRL-4: "Location Relationship ID" - creates it if necessary

getOrganizationalLocationRelationshipValue

public XON[] getOrganizationalLocationRelationshipValue()

Returns all repetitions of Organizational Location Relationship Value (LRL-5).

getLrl5_OrganizationalLocationRelationshipValue

public XON[] getLrl5_OrganizationalLocationRelationshipValue()

Returns all repetitions of Organizational Location Relationship Value (LRL-5).

getOrganizationalLocationRelationshipValueReps

public int getOrganizationalLocationRelationshipValueReps()

Returns a count of the current number of repetitions of Organizational Location Relationship Value (LRL-5). This method does not create a repetition, so if no repetitions have currently been defined or accessed, it will return zero.

getOrganizationalLocationRelationshipValue

public XON getOrganizationalLocationRelationshipValue(int rep)

Returns a specific repetition of LRL-5: "Organizational Location Relationship Value" - creates it if necessary

Parameters:

rep - The repetition index (0-indexed)

getLrl5_OrganizationalLocationRelationshipValue

public XON getLrl5_OrganizationalLocationRelationshipValue(int rep)

Returns a specific repetition of LRL-5: "Organizational Location Relationship Value" - creates it if necessary

Parameters:

rep - The repetition index (0-indexed)

getLrl5_OrganizationalLocationRelationshipValueReps

public int getLrl5_OrganizationalLocationRelationshipValueReps()

Returns a count of the current number of repetitions of Organizational Location Relationship Value (LRL-5). This method does not create a repetition, so if no repetitions have currently been defined or accessed, it will return zero.

insertOrganizationalLocationRelationshipValue

public XON insertOrganizationalLocationRelationshipValue(int rep)
                                                  throws HL7Exception

Inserts a repetition of LRL-5: "Organizational Location Relationship Value" 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)

insertLrl5_OrganizationalLocationRelationshipValue

public XON insertLrl5_OrganizationalLocationRelationshipValue(int rep)
                                                       throws HL7Exception

Inserts a repetition of LRL-5: "Organizational Location Relationship Value" 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)

removeOrganizationalLocationRelationshipValue

public XON removeOrganizationalLocationRelationshipValue(int rep)
                                                  throws HL7Exception

Removes a repetition of LRL-5: "Organizational Location Relationship Value" 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)

removeLrl5_OrganizationalLocationRelationshipValue

public XON removeLrl5_OrganizationalLocationRelationshipValue(int rep)
                                                       throws HL7Exception

Removes a repetition of LRL-5: "Organizational Location Relationship Value" 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)

getPatientLocationRelationshipValue

public PL getPatientLocationRelationshipValue()

Returns LRL-6: "Patient Location Relationship Value" - creates it if necessary

getLrl6_PatientLocationRelationshipValue

public PL getLrl6_PatientLocationRelationshipValue()

Returns LRL-6: "Patient Location Relationship Value" - creates it if necessary

createNewTypeWithoutReflection

protected Type createNewTypeWithoutReflection(int field)

Overrides:

createNewTypeWithoutReflection in class AbstractSegment