ca.uhn.hl7v2.model.v25.group

Class ADT_A01_INSURANCE

java.lang.Object

ca.uhn.hl7v2.model.AbstractStructure

ca.uhn.hl7v2.model.AbstractGroup

ca.uhn.hl7v2.model.v25.group.ADT_A01_INSURANCE

All Implemented Interfaces:

Group, Structure, Serializable

public class ADT_A01_INSURANCE
extends AbstractGroup

Represents a ADT_A01_INSURANCE group structure (a Group object). A Group is an ordered collection of message segments that can repeat together or be optionally in/excluded together. This Group contains the following elements:

• 1: IN1 (Insurance)
• 2: IN2 (Insurance Additional Information) optional
• 3: IN3 (Insurance Additional Information, Certification) optional repeating
• 4: ROL (Role) optional repeating

See Also:

Serialized Form

Field Summary

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

log

Constructor Summary

Constructors

Constructor and Description
ADT_A01_INSURANCE(Group parent, ModelClassFactory factory) Creates a new ADT_A01_INSURANCE group

Method Summary

Methods

Modifier and Type	Method and Description
IN1	getIN1() Returns IN1 (Insurance) - creates it if necessary
IN2	getIN2() Returns IN2 (Insurance Additional Information) - creates it if necessary
IN3	getIN3() Returns the first repetition of IN3 (Insurance Additional Information, Certification) - creates it if necessary
IN3	getIN3(int rep) Returns a specific repetition of IN3 (Insurance Additional Information, Certification) - creates it if necessary
List<IN3>	getIN3All() Returns a non-modifiable List containing all current existing repetitions of IN3.
int	getIN3Reps() Returns the number of existing repetitions of IN3
ROL	getROL() Returns the first repetition of ROL (Role) - creates it if necessary
ROL	getROL(int rep) Returns a specific repetition of ROL (Role) - creates it if necessary
List<ROL>	getROLAll() Returns a non-modifiable List containing all current existing repetitions of ROL.
int	getROLReps() Returns the number of existing repetitions of ROL
String	getVersion() Returns "2.5"
void	insertIN3(IN3 structure, int rep) Inserts a specific repetition of IN3 (Insurance Additional Information, Certification)
IN3	insertIN3(int rep) Inserts a specific repetition of IN3 (Insurance Additional Information, Certification)
ROL	insertROL(int rep) Inserts a specific repetition of ROL (Role)
void	insertROL(ROL structure, int rep) Inserts a specific repetition of ROL (Role)
IN3	removeIN3(int rep) Removes a specific repetition of IN3 (Insurance Additional Information, Certification)
ROL	removeROL(int rep) Removes a specific repetition of ROL (Role)

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

add, add, addNonstandardSegment, addNonstandardSegment, clear, currentReps, get, get, getAll, getAllAsList, getClass, getFieldNumForName, getModelClassFactory, getName, getNames, getNonStandardNames, getReps, getTyped, getTyped, insert, insertRepetition, insertRepetition, isGroup, isRepeating, isRequired, removeRepetition, tryToInstantiateStructure

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

ADT_A01_INSURANCE

public ADT_A01_INSURANCE(Group parent,
                 ModelClassFactory factory)

Creates a new ADT_A01_INSURANCE group

Method Detail

getVersion

public String getVersion()

Returns "2.5"

getIN1

public IN1 getIN1()

Returns IN1 (Insurance) - creates it if necessary

getIN2

public IN2 getIN2()

Returns IN2 (Insurance Additional Information) - creates it if necessary

getIN3

public IN3 getIN3()

Returns the first repetition of IN3 (Insurance Additional Information, Certification) - creates it if necessary

getIN3

public IN3 getIN3(int rep)

Returns a specific repetition of IN3 (Insurance Additional Information, Certification) - creates it if necessary

Parameters:

rep - The repetition index (0-indexed, i.e. the first repetition is at index 0)

Throws:

HL7Exception - if the repetition requested is more than one greater than the number of existing repetitions.

getIN3Reps

public int getIN3Reps()

Returns the number of existing repetitions of IN3

getIN3All

public List<IN3> getIN3All()
                    throws HL7Exception

Returns a non-modifiable List containing all current existing repetitions of IN3.

Note that unlike getIN3(), this method will not create any reps if none are already present, so an empty list may be returned.

Throws:

HL7Exception

insertIN3

public void insertIN3(IN3 structure,
             int rep)
               throws HL7Exception

Inserts a specific repetition of IN3 (Insurance Additional Information, Certification)

Throws:

HL7Exception

See Also:

AbstractGroup#insertRepetition(Structure, int)

insertIN3

public IN3 insertIN3(int rep)
              throws HL7Exception

Inserts a specific repetition of IN3 (Insurance Additional Information, Certification)

Throws:

HL7Exception

See Also:

AbstractGroup#insertRepetition(Structure, int)

removeIN3

public IN3 removeIN3(int rep)
              throws HL7Exception

Removes a specific repetition of IN3 (Insurance Additional Information, Certification)

Throws:

HL7Exception

See Also:

AbstractGroup.removeRepetition(String, int)

getROL

public ROL getROL()

Returns the first repetition of ROL (Role) - creates it if necessary

getROL

public ROL getROL(int rep)

Returns a specific repetition of ROL (Role) - creates it if necessary

Parameters:

rep - The repetition index (0-indexed, i.e. the first repetition is at index 0)

Throws:

HL7Exception - if the repetition requested is more than one greater than the number of existing repetitions.

getROLReps

public int getROLReps()

Returns the number of existing repetitions of ROL

getROLAll

public List<ROL> getROLAll()
                    throws HL7Exception

Returns a non-modifiable List containing all current existing repetitions of ROL.

Note that unlike getROL(), this method will not create any reps if none are already present, so an empty list may be returned.

Throws:

HL7Exception

insertROL

public void insertROL(ROL structure,
             int rep)
               throws HL7Exception

Inserts a specific repetition of ROL (Role)

Throws:

HL7Exception

See Also:

AbstractGroup#insertRepetition(Structure, int)

insertROL

public ROL insertROL(int rep)
              throws HL7Exception

Inserts a specific repetition of ROL (Role)

Throws:

HL7Exception

See Also:

AbstractGroup#insertRepetition(Structure, int)

removeROL

public ROL removeROL(int rep)
              throws HL7Exception

Removes a specific repetition of ROL (Role)

Throws:

HL7Exception

See Also:

AbstractGroup.removeRepetition(String, int)