BAR_P12 (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.AbstractMessage
    - - ca.uhn.hl7v2.model.v281.message.BAR_P12

All Implemented Interfaces:

Group, Message, Structure, Visitable, Serializable
```
public class BAR_P12
extends AbstractMessage
```
Represents a BAR_P12 message structure (see chapter 6.4.9). This structure contains the following elements:
- 1: MSH (Message Header)
- 2: SFT (Software Segment) optional repeating
- 3: UAC (User Authentication Credential Segment) optional
- 4: EVN (Event Type)
- 5: PID (Patient Identification)
- 6: PV1 (Patient Visit)
- 7: DG1 (Diagnosis) optional repeating
- 8: DRG (Diagnosis Related Group) optional
- 9: BAR_P12_PROCEDURE (a Group object) optional repeating
- 10: OBX (Observation/Result) optional
See Also:

Serialized Form

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

Constructor Summary

Constructors
Constructor and Description
`BAR_P12()` Creates a new BAR_P12 message with DefaultModelClassFactory.
`BAR_P12(ModelClassFactory factory)` Creates a new BAR_P12 message with custom ModelClassFactory.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`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
`DRG`	`getDRG()` Returns DRG (Diagnosis Related Group) - creates it if necessary
`EVN`	`getEVN()` Returns EVN (Event Type) - creates it if necessary
`MSH`	`getMSH()` Returns MSH (Message Header) - creates it if necessary
`OBX`	`getOBX()` Returns OBX (Observation/Result) - creates it if necessary
`PID`	`getPID()` Returns PID (Patient Identification) - creates it if necessary
`BAR_P12_PROCEDURE`	`getPROCEDURE()` Returns the first repetition of PROCEDURE (a Group object) - creates it if necessary
`BAR_P12_PROCEDURE`	`getPROCEDURE(int rep)` Returns a specific repetition of PROCEDURE (a Group object) - creates it if necessary
`List<BAR_P12_PROCEDURE>`	`getPROCEDUREAll()` Returns a non-modifiable List containing all current existing repetitions of PROCEDURE.
`int`	`getPROCEDUREReps()` Returns the number of existing repetitions of PROCEDURE
`PV1`	`getPV1()` Returns PV1 (Patient Visit) - creates it if necessary
`SFT`	`getSFT()` Returns the first repetition of SFT (Software Segment) - creates it if necessary
`SFT`	`getSFT(int rep)` Returns a specific repetition of SFT (Software Segment) - creates it if necessary
`List<SFT>`	`getSFTAll()` Returns a non-modifiable List containing all current existing repetitions of SFT.
`int`	`getSFTReps()` Returns the number of existing repetitions of SFT
`UAC`	`getUAC()` Returns UAC (User Authentication Credential Segment) - creates it if necessary
`String`	`getVersion()` Returns "2.8.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`	`insertPROCEDURE(BAR_P12_PROCEDURE structure, int rep)` Inserts a specific repetition of PROCEDURE (a Group object)
`BAR_P12_PROCEDURE`	`insertPROCEDURE(int rep)` Inserts a specific repetition of PROCEDURE (a Group object)
`SFT`	`insertSFT(int rep)` Inserts a specific repetition of SFT (Software Segment)
`void`	`insertSFT(SFT structure, int rep)` Inserts a specific repetition of SFT (Software Segment)
`DG1`	`removeDG1(int rep)` Removes a specific repetition of DG1 (Diagnosis)
`BAR_P12_PROCEDURE`	`removePROCEDURE(int rep)` Removes a specific repetition of PROCEDURE (a Group object)
`SFT`	`removeSFT(int rep)` Removes a specific repetition of SFT (Software Segment)

Methods inherited from class ca.uhn.hl7v2.model.AbstractMessage
accept, encode, fillResponseHeader, generateACK, generateACK, generateACK, getEncodingCharactersValue, getFieldSeparatorValue, getMessage, getParent, getParser, getValidationContext, initQuickstart, parse, printStructure, printStructure, setParser, toString

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, provideLocation, removeRepetition, tryToInstantiateStructure, visitNestedStructures

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface ca.uhn.hl7v2.model.Group
addNonstandardSegment, addNonstandardSegment, get, get, getAll, getClass, getNames, isChoiceElement, isGroup, isRepeating, isRequired

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

Methods inherited from interface ca.uhn.hl7v2.model.Visitable
isEmpty, provideLocation

- Constructor Detail
  - BAR_P12
```
public BAR_P12()
```
    Creates a new BAR_P12 message with DefaultModelClassFactory.
  - BAR_P12
```
public BAR_P12(ModelClassFactory factory)
```
    Creates a new BAR_P12 message with custom ModelClassFactory.
- Method Detail
  - getVersion
```
public String getVersion()
```
    Returns "2.8.1"
    
    Specified by:
    
    getVersion in interface Message
    
    Overrides:
    
    getVersion in class AbstractMessage
  - getMSH
```
public MSH getMSH()
```
    Returns MSH (Message Header) - creates it if necessary
  - getSFT
```
public SFT getSFT()
```
    Returns the first repetition of SFT (Software Segment) - creates it if necessary
  - getSFT
```
public SFT getSFT(int rep)
```
    Returns a specific repetition of SFT (Software Segment) - 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.
  - getSFTReps
```
public int getSFTReps()
```
    Returns the number of existing repetitions of SFT
  - getSFTAll
```
public List<SFT> getSFTAll()
                    throws HL7Exception
```
    Returns a non-modifiable List containing all current existing repetitions of SFT.
    
    Note that unlike getSFT(), this method will not create any reps if none are already present, so an empty list may be returned.
    
    Throws:
    
    HL7Exception
  - insertSFT
```
public void insertSFT(SFT structure,
                      int rep)
               throws HL7Exception
```
    Inserts a specific repetition of SFT (Software Segment)
    
    Throws:
    
    HL7Exception
    
    See Also:
    
    AbstractGroup#insertRepetition(Structure, int)
  - insertSFT
```
public SFT insertSFT(int rep)
              throws HL7Exception
```
    Inserts a specific repetition of SFT (Software Segment)
    
    Throws:
    
    HL7Exception
    
    See Also:
    
    AbstractGroup#insertRepetition(Structure, int)
  - removeSFT
```
public SFT removeSFT(int rep)
              throws HL7Exception
```
    Removes a specific repetition of SFT (Software Segment)
    
    Throws:
    
    HL7Exception
    
    See Also:
    
    AbstractGroup.removeRepetition(String, int)
  - getUAC
```
public UAC getUAC()
```
    Returns UAC (User Authentication Credential Segment) - creates it if necessary
  - getEVN
```
public EVN getEVN()
```
    Returns EVN (Event Type) - creates it if necessary
  - getPID
```
public PID getPID()
```
    Returns PID (Patient Identification) - creates it if necessary
  - 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)
  - getDRG
```
public DRG getDRG()
```
    Returns DRG (Diagnosis Related Group) - creates it if necessary
  - getPROCEDURE
```
public BAR_P12_PROCEDURE getPROCEDURE()
```
    Returns the first repetition of PROCEDURE (a Group object) - creates it if necessary
  - getPROCEDURE
```
public BAR_P12_PROCEDURE getPROCEDURE(int rep)
```
    Returns a specific repetition of PROCEDURE (a Group object) - 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.
  - getPROCEDUREReps
```
public int getPROCEDUREReps()
```
    Returns the number of existing repetitions of PROCEDURE
  - getPROCEDUREAll
```
public List<BAR_P12_PROCEDURE> getPROCEDUREAll()
                                        throws HL7Exception
```
    Returns a non-modifiable List containing all current existing repetitions of PROCEDURE.
    
    Note that unlike getPROCEDURE(), this method will not create any reps if none are already present, so an empty list may be returned.
    
    Throws:
    
    HL7Exception
  - insertPROCEDURE
```
public void insertPROCEDURE(BAR_P12_PROCEDURE structure,
                            int rep)
                     throws HL7Exception
```
    Inserts a specific repetition of PROCEDURE (a Group object)
    
    Throws:
    
    HL7Exception
    
    See Also:
    
    AbstractGroup#insertRepetition(Structure, int)
  - insertPROCEDURE
```
public BAR_P12_PROCEDURE insertPROCEDURE(int rep)
                                  throws HL7Exception
```
    Inserts a specific repetition of PROCEDURE (a Group object)
    
    Throws:
    
    HL7Exception
    
    See Also:
    
    AbstractGroup#insertRepetition(Structure, int)
  - removePROCEDURE
```
public BAR_P12_PROCEDURE removePROCEDURE(int rep)
                                  throws HL7Exception
```
    Removes a specific repetition of PROCEDURE (a Group object)
    
    Throws:
    
    HL7Exception
    
    See Also:
    
    AbstractGroup.removeRepetition(String, int)
  - getOBX
```
public OBX getOBX()
```
    Returns OBX (Observation/Result) - creates it if necessary

Class BAR_P12

Field Summary

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

Constructor Summary

Method Summary

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

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

Methods inherited from class java.lang.Object

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

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

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

Constructor Detail

BAR_P12

BAR_P12

Method Detail

getVersion

getMSH

getSFT

getSFT

getSFTReps

getSFTAll

insertSFT

insertSFT

removeSFT

getUAC

getEVN

getPID

getPV1

getDG1

getDG1

getDG1Reps

getDG1All

insertDG1

insertDG1

removeDG1

getDRG

getPROCEDURE

getPROCEDURE

getPROCEDUREReps

getPROCEDUREAll

insertPROCEDURE

insertPROCEDURE

removePROCEDURE

getOBX