ADT_A01_INSURANCE (HAPI - Java HL7 API - Generated Structures v2.8.1 2.3 API)

java.lang.Object
- ca.uhn.hl7v2.model.AbstractStructure
- - ca.uhn.hl7v2.model.AbstractGroup
  - - ca.uhn.hl7v2.model.v281.group.ADT_A01_INSURANCE

All Implemented Interfaces:

Group, Structure, Visitable, 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
- 5: AUT (Authorization Information) optional repeating
- 6: RF1 (Referral Information) 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

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

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`AUT`	`getAUT()` Returns the first repetition of AUT (Authorization Information) - creates it if necessary
`AUT`	`getAUT(int rep)` Returns a specific repetition of AUT (Authorization Information) - creates it if necessary
`List<AUT>`	`getAUTAll()` Returns a non-modifiable List containing all current existing repetitions of AUT.
`int`	`getAUTReps()` Returns the number of existing repetitions of AUT
`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
`RF1`	`getRF1()` Returns the first repetition of RF1 (Referral Information) - creates it if necessary
`RF1`	`getRF1(int rep)` Returns a specific repetition of RF1 (Referral Information) - creates it if necessary
`List<RF1>`	`getRF1All()` Returns a non-modifiable List containing all current existing repetitions of RF1.
`int`	`getRF1Reps()` Returns the number of existing repetitions of RF1
`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.8.1"
`void`	`insertAUT(AUT structure, int rep)` Inserts a specific repetition of AUT (Authorization Information)
`AUT`	`insertAUT(int rep)` Inserts a specific repetition of AUT (Authorization Information)
`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)
`RF1`	`insertRF1(int rep)` Inserts a specific repetition of RF1 (Referral Information)
`void`	`insertRF1(RF1 structure, int rep)` Inserts a specific repetition of RF1 (Referral Information)
`ROL`	`insertROL(int rep)` Inserts a specific repetition of ROL (Role)
`void`	`insertROL(ROL structure, int rep)` Inserts a specific repetition of ROL (Role)
`AUT`	`removeAUT(int rep)` Removes a specific repetition of AUT (Authorization Information)
`IN3`	`removeIN3(int rep)` Removes a specific repetition of IN3 (Insurance Additional Information, Certification)
`RF1`	`removeRF1(int rep)` Removes a specific repetition of RF1 (Referral Information)
`ROL`	`removeROL(int rep)` Removes a specific repetition of ROL (Role)

Methods inherited from class ca.uhn.hl7v2.model.AbstractGroup
accept, add, add, add, addNonstandardSegment, addNonstandardSegment, clear, currentReps, get, get, getAll, getAllAsList, getClass, getFieldNumForName, getModelClassFactory, getName, getNames, getNonStandardNames, getReps, getTyped, getTyped, insert, insert, insertRepetition, insertRepetition, isChoiceElement, isEmpty, isGroup, isRepeating, isRequired, provideLocation, removeRepetition, tryToInstantiateStructure, visitNestedStructures

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.8.1"
  - 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)
  - getAUT
```
public AUT getAUT()
```
    Returns the first repetition of AUT (Authorization Information) - creates it if necessary
  - getAUT
```
public AUT getAUT(int rep)
```
    Returns a specific repetition of AUT (Authorization Information) - 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.
  - getAUTReps
```
public int getAUTReps()
```
    Returns the number of existing repetitions of AUT
  - getAUTAll
```
public List<AUT> getAUTAll()
                    throws HL7Exception
```
    Returns a non-modifiable List containing all current existing repetitions of AUT.
    
    Note that unlike getAUT(), this method will not create any reps if none are already present, so an empty list may be returned.
    
    Throws:
    
    HL7Exception
  - insertAUT
```
public void insertAUT(AUT structure,
                      int rep)
               throws HL7Exception
```
    Inserts a specific repetition of AUT (Authorization Information)
    
    Throws:
    
    HL7Exception
    
    See Also:
    
    AbstractGroup#insertRepetition(Structure, int)
  - insertAUT
```
public AUT insertAUT(int rep)
              throws HL7Exception
```
    Inserts a specific repetition of AUT (Authorization Information)
    
    Throws:
    
    HL7Exception
    
    See Also:
    
    AbstractGroup#insertRepetition(Structure, int)
  - removeAUT
```
public AUT removeAUT(int rep)
              throws HL7Exception
```
    Removes a specific repetition of AUT (Authorization Information)
    
    Throws:
    
    HL7Exception
    
    See Also:
    
    AbstractGroup.removeRepetition(String, int)
  - getRF1
```
public RF1 getRF1()
```
    Returns the first repetition of RF1 (Referral Information) - creates it if necessary
  - getRF1
```
public RF1 getRF1(int rep)
```
    Returns a specific repetition of RF1 (Referral Information) - 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.
  - getRF1Reps
```
public int getRF1Reps()
```
    Returns the number of existing repetitions of RF1
  - getRF1All
```
public List<RF1> getRF1All()
                    throws HL7Exception
```
    Returns a non-modifiable List containing all current existing repetitions of RF1.
    
    Note that unlike getRF1(), this method will not create any reps if none are already present, so an empty list may be returned.
    
    Throws:
    
    HL7Exception
  - insertRF1
```
public void insertRF1(RF1 structure,
                      int rep)
               throws HL7Exception
```
    Inserts a specific repetition of RF1 (Referral Information)
    
    Throws:
    
    HL7Exception
    
    See Also:
    
    AbstractGroup#insertRepetition(Structure, int)
  - insertRF1
```
public RF1 insertRF1(int rep)
              throws HL7Exception
```
    Inserts a specific repetition of RF1 (Referral Information)
    
    Throws:
    
    HL7Exception
    
    See Also:
    
    AbstractGroup#insertRepetition(Structure, int)
  - removeRF1
```
public RF1 removeRF1(int rep)
              throws HL7Exception
```
    Removes a specific repetition of RF1 (Referral Information)
    
    Throws:
    
    HL7Exception
    
    See Also:
    
    AbstractGroup.removeRepetition(String, int)

Class ADT_A01_INSURANCE

Field Summary

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

Constructor Summary

Method Summary

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

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

Methods inherited from class java.lang.Object

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

Constructor Detail

ADT_A01_INSURANCE

Method Detail

getVersion

getIN1

getIN2

getIN3

getIN3

getIN3Reps

getIN3All

insertIN3

insertIN3

removeIN3

getROL

getROL

getROLReps

getROLAll

insertROL

insertROL

removeROL

getAUT

getAUT

getAUTReps

getAUTAll

insertAUT

insertAUT

removeAUT

getRF1

getRF1

getRF1Reps

getRF1All

insertRF1

insertRF1

removeRF1