BAR_P01_VISIT (HAPI - Java HL7 API - Generated Structures v2.1 2.1 API)

java.lang.Object
- ca.uhn.hl7v2.model.AbstractStructure
- - ca.uhn.hl7v2.model.AbstractGroup
  - - ca.uhn.hl7v2.model.v21.group.BAR_P01_VISIT

All Implemented Interfaces:

Group, Structure, Serializable
```
public class BAR_P01_VISIT
extends AbstractGroup
```
Represents a BAR_P01_VISIT 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: PV1 (PATIENT VISIT) optional
- 2: DG1 (DIAGNOSIS) optional repeating
- 3: PR1 (PROCEDURES) optional repeating
- 4: GT1 (GUARANTOR) optional repeating
- 5: NK1 (NEXT OF KIN) optional repeating
- 6: IN1 (INSURANCE) optional repeating
- 7: ACC (ACCIDENT) optional
- 8: UB1 (UB82 DATA) optional
See Also:
Serialized Form

Field Summary
- Fields inherited from class ca.uhn.hl7v2.model.AbstractStructure
  log

Constructor Summary

Constructors
Constructor and Description

BAR_P01_VISIT(Group parent, ModelClassFactory factory)
Creates a new BAR_P01_VISIT group

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

Method Summary

Methods
Modifier and Type	Method and Description
`ACC`	`getACC()` Returns ACC (ACCIDENT) - creates it if necessary
`DG1`	`getDG1()` Returns the first repetition of DG1 (DIAGNOSIS) - creates it if necessary
`DG1`	`getDG1(int rep)` Returns a specific repetition of DG1 (DIAGNOSIS) - creates it if necessary
`List<DG1>`	`getDG1All()` Returns a non-modifiable List containing all current existing repetitions of DG1.
`int`	`getDG1Reps()` Returns the number of existing repetitions of DG1
`GT1`	`getGT1()` Returns the first repetition of GT1 (GUARANTOR) - creates it if necessary
`GT1`	`getGT1(int rep)` Returns a specific repetition of GT1 (GUARANTOR) - creates it if necessary
`List<GT1>`	`getGT1All()` Returns a non-modifiable List containing all current existing repetitions of GT1.
`int`	`getGT1Reps()` Returns the number of existing repetitions of GT1
`IN1`	`getIN1()` Returns the first repetition of IN1 (INSURANCE) - creates it if necessary
`IN1`	`getIN1(int rep)` Returns a specific repetition of IN1 (INSURANCE) - creates it if necessary
`List<IN1>`	`getIN1All()` Returns a non-modifiable List containing all current existing repetitions of IN1.
`int`	`getIN1Reps()` Returns the number of existing repetitions of IN1
`NK1`	`getNK1()` Returns the first repetition of NK1 (NEXT OF KIN) - creates it if necessary
`NK1`	`getNK1(int rep)` Returns a specific repetition of NK1 (NEXT OF KIN) - creates it if necessary
`List<NK1>`	`getNK1All()` Returns a non-modifiable List containing all current existing repetitions of NK1.
`int`	`getNK1Reps()` Returns the number of existing repetitions of NK1
`PR1`	`getPR1()` Returns the first repetition of PR1 (PROCEDURES) - creates it if necessary
`PR1`	`getPR1(int rep)` Returns a specific repetition of PR1 (PROCEDURES) - creates it if necessary
`List<PR1>`	`getPR1All()` Returns a non-modifiable List containing all current existing repetitions of PR1.
`int`	`getPR1Reps()` Returns the number of existing repetitions of PR1
`PV1`	`getPV1()` Returns PV1 (PATIENT VISIT) - creates it if necessary
`UB1`	`getUB1()` Returns UB1 (UB82 DATA) - creates it if necessary
`String`	`getVersion()` Returns "2.1"
`void`	`insertDG1(DG1 structure, int rep)` Inserts a specific repetition of DG1 (DIAGNOSIS)
`DG1`	`insertDG1(int rep)` Inserts a specific repetition of DG1 (DIAGNOSIS)
`void`	`insertGT1(GT1 structure, int rep)` Inserts a specific repetition of GT1 (GUARANTOR)
`GT1`	`insertGT1(int rep)` Inserts a specific repetition of GT1 (GUARANTOR)
`void`	`insertIN1(IN1 structure, int rep)` Inserts a specific repetition of IN1 (INSURANCE)
`IN1`	`insertIN1(int rep)` Inserts a specific repetition of IN1 (INSURANCE)
`NK1`	`insertNK1(int rep)` Inserts a specific repetition of NK1 (NEXT OF KIN)
`void`	`insertNK1(NK1 structure, int rep)` Inserts a specific repetition of NK1 (NEXT OF KIN)
`PR1`	`insertPR1(int rep)` Inserts a specific repetition of PR1 (PROCEDURES)
`void`	`insertPR1(PR1 structure, int rep)` Inserts a specific repetition of PR1 (PROCEDURES)
`DG1`	`removeDG1(int rep)` Removes a specific repetition of DG1 (DIAGNOSIS)
`GT1`	`removeGT1(int rep)` Removes a specific repetition of GT1 (GUARANTOR)
`IN1`	`removeIN1(int rep)` Removes a specific repetition of IN1 (INSURANCE)
`NK1`	`removeNK1(int rep)` Removes a specific repetition of NK1 (NEXT OF KIN)
`PR1`	`removePR1(int rep)` Removes a specific repetition of PR1 (PROCEDURES)

Methods inherited from class ca.uhn.hl7v2.model.AbstractGroup
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, 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
  - BAR_P01_VISIT
```
public BAR_P01_VISIT(Group parent,
             ModelClassFactory factory)
```
    Creates a new BAR_P01_VISIT group
- Method Detail
  - getVersion
```
public String getVersion()
```
    Returns "2.1"
  - getPV1
```
public PV1 getPV1()
```
    Returns PV1 (PATIENT VISIT) - creates it if necessary
  - getDG1
```
public DG1 getDG1()
```
    Returns the first repetition of DG1 (DIAGNOSIS) - creates it if necessary
  - getDG1
```
public DG1 getDG1(int rep)
```
    Returns a specific repetition of DG1 (DIAGNOSIS) - 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.
  - getDG1Reps
```
public int getDG1Reps()
```
    Returns the number of existing repetitions of DG1
  - getDG1All
```
public List<DG1> getDG1All()
                    throws HL7Exception
```
    Returns a non-modifiable List containing all current existing repetitions of DG1.
    
    Note that unlike getDG1(), this method will not create any reps if none are already present, so an empty list may be returned.
    
    Throws:
    
    HL7Exception
  - insertDG1
```
public void insertDG1(DG1 structure,
             int rep)
               throws HL7Exception
```
    Inserts a specific repetition of DG1 (DIAGNOSIS)
    
    Throws:
    
    HL7Exception
    See Also:
    AbstractGroup#insertRepetition(Structure, int)
  - insertDG1
```
public DG1 insertDG1(int rep)
              throws HL7Exception
```
    Inserts a specific repetition of DG1 (DIAGNOSIS)
    
    Throws:
    
    HL7Exception
    See Also:
    AbstractGroup#insertRepetition(Structure, int)
  - removeDG1
```
public DG1 removeDG1(int rep)
              throws HL7Exception
```
    Removes a specific repetition of DG1 (DIAGNOSIS)
    
    Throws:
    
    HL7Exception
    See Also:
    AbstractGroup.removeRepetition(String, int)
  - getPR1
```
public PR1 getPR1()
```
    Returns the first repetition of PR1 (PROCEDURES) - creates it if necessary
  - getPR1
```
public PR1 getPR1(int rep)
```
    Returns a specific repetition of PR1 (PROCEDURES) - 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.
  - getPR1Reps
```
public int getPR1Reps()
```
    Returns the number of existing repetitions of PR1
  - getPR1All
```
public List<PR1> getPR1All()
                    throws HL7Exception
```
    Returns a non-modifiable List containing all current existing repetitions of PR1.
    
    Note that unlike getPR1(), this method will not create any reps if none are already present, so an empty list may be returned.
    
    Throws:
    
    HL7Exception
  - insertPR1
```
public void insertPR1(PR1 structure,
             int rep)
               throws HL7Exception
```
    Inserts a specific repetition of PR1 (PROCEDURES)
    
    Throws:
    
    HL7Exception
    See Also:
    AbstractGroup#insertRepetition(Structure, int)
  - insertPR1
```
public PR1 insertPR1(int rep)
              throws HL7Exception
```
    Inserts a specific repetition of PR1 (PROCEDURES)
    
    Throws:
    
    HL7Exception
    See Also:
    AbstractGroup#insertRepetition(Structure, int)
  - removePR1
```
public PR1 removePR1(int rep)
              throws HL7Exception
```
    Removes a specific repetition of PR1 (PROCEDURES)
    
    Throws:
    
    HL7Exception
    See Also:
    AbstractGroup.removeRepetition(String, int)
  - getGT1
```
public GT1 getGT1()
```
    Returns the first repetition of GT1 (GUARANTOR) - creates it if necessary
  - getGT1
```
public GT1 getGT1(int rep)
```
    Returns a specific repetition of GT1 (GUARANTOR) - 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.
  - getGT1Reps
```
public int getGT1Reps()
```
    Returns the number of existing repetitions of GT1
  - getGT1All
```
public List<GT1> getGT1All()
                    throws HL7Exception
```
    Returns a non-modifiable List containing all current existing repetitions of GT1.
    
    Note that unlike getGT1(), this method will not create any reps if none are already present, so an empty list may be returned.
    
    Throws:
    
    HL7Exception
  - insertGT1
```
public void insertGT1(GT1 structure,
             int rep)
               throws HL7Exception
```
    Inserts a specific repetition of GT1 (GUARANTOR)
    
    Throws:
    
    HL7Exception
    See Also:
    AbstractGroup#insertRepetition(Structure, int)
  - insertGT1
```
public GT1 insertGT1(int rep)
              throws HL7Exception
```
    Inserts a specific repetition of GT1 (GUARANTOR)
    
    Throws:
    
    HL7Exception
    See Also:
    AbstractGroup#insertRepetition(Structure, int)
  - removeGT1
```
public GT1 removeGT1(int rep)
              throws HL7Exception
```
    Removes a specific repetition of GT1 (GUARANTOR)
    
    Throws:
    
    HL7Exception
    See Also:
    AbstractGroup.removeRepetition(String, int)
  - getNK1
```
public NK1 getNK1()
```
    Returns the first repetition of NK1 (NEXT OF KIN) - creates it if necessary
  - getNK1
```
public NK1 getNK1(int rep)
```
    Returns a specific repetition of NK1 (NEXT OF KIN) - 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.
  - getNK1Reps
```
public int getNK1Reps()
```
    Returns the number of existing repetitions of NK1
  - getNK1All
```
public List<NK1> getNK1All()
                    throws HL7Exception
```
    Returns a non-modifiable List containing all current existing repetitions of NK1.
    
    Note that unlike getNK1(), this method will not create any reps if none are already present, so an empty list may be returned.
    
    Throws:
    
    HL7Exception
  - insertNK1
```
public void insertNK1(NK1 structure,
             int rep)
               throws HL7Exception
```
    Inserts a specific repetition of NK1 (NEXT OF KIN)
    
    Throws:
    
    HL7Exception
    See Also:
    AbstractGroup#insertRepetition(Structure, int)
  - insertNK1
```
public NK1 insertNK1(int rep)
              throws HL7Exception
```
    Inserts a specific repetition of NK1 (NEXT OF KIN)
    
    Throws:
    
    HL7Exception
    See Also:
    AbstractGroup#insertRepetition(Structure, int)
  - removeNK1
```
public NK1 removeNK1(int rep)
              throws HL7Exception
```
    Removes a specific repetition of NK1 (NEXT OF KIN)
    
    Throws:
    
    HL7Exception
    See Also:
    AbstractGroup.removeRepetition(String, int)
  - getIN1
```
public IN1 getIN1()
```
    Returns the first repetition of IN1 (INSURANCE) - creates it if necessary
  - getIN1
```
public IN1 getIN1(int rep)
```
    Returns a specific repetition of IN1 (INSURANCE) - 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.
  - getIN1Reps
```
public int getIN1Reps()
```
    Returns the number of existing repetitions of IN1
  - getIN1All
```
public List<IN1> getIN1All()
                    throws HL7Exception
```
    Returns a non-modifiable List containing all current existing repetitions of IN1.
    
    Note that unlike getIN1(), this method will not create any reps if none are already present, so an empty list may be returned.
    
    Throws:
    
    HL7Exception
  - insertIN1
```
public void insertIN1(IN1 structure,
             int rep)
               throws HL7Exception
```
    Inserts a specific repetition of IN1 (INSURANCE)
    
    Throws:
    
    HL7Exception
    See Also:
    AbstractGroup#insertRepetition(Structure, int)
  - insertIN1
```
public IN1 insertIN1(int rep)
              throws HL7Exception
```
    Inserts a specific repetition of IN1 (INSURANCE)
    
    Throws:
    
    HL7Exception
    See Also:
    AbstractGroup#insertRepetition(Structure, int)
  - removeIN1
```
public IN1 removeIN1(int rep)
              throws HL7Exception
```
    Removes a specific repetition of IN1 (INSURANCE)
    
    Throws:
    
    HL7Exception
    See Also:
    AbstractGroup.removeRepetition(String, int)
  - getACC
```
public ACC getACC()
```
    Returns ACC (ACCIDENT) - creates it if necessary
  - getUB1
```
public UB1 getUB1()
```
    Returns UB1 (UB82 DATA) - creates it if necessary

Class BAR_P01_VISIT

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

BAR_P01_VISIT

Method Detail

getVersion

getPV1

getDG1

getDG1

getDG1Reps

getDG1All

insertDG1

insertDG1

removeDG1

getPR1

getPR1

getPR1Reps

getPR1All

insertPR1

insertPR1

removePR1

getGT1

getGT1

getGT1Reps

getGT1All

insertGT1

insertGT1

removeGT1

getNK1

getNK1

getNK1Reps

getNK1All

insertNK1

insertNK1

removeNK1

getIN1

getIN1

getIN1Reps

getIN1All

insertIN1

insertIN1

removeIN1

getACC

getUB1