ca.uhn.hl7v2.model.v231.message

Class BAR_P06

java.lang.Object

ca.uhn.hl7v2.model.AbstractStructure

ca.uhn.hl7v2.model.AbstractGroup

ca.uhn.hl7v2.model.AbstractMessage

ca.uhn.hl7v2.model.v231.message.BAR_P06

All Implemented Interfaces:

Group, Message, Structure, Serializable

public class BAR_P06
extends AbstractMessage

Represents a BAR_P06 message structure (see chapter ?). This structure contains the following elements:

• 1: MSH (MSH - message header segment)
• 2: EVN (EVN - event type segment)
• 3: BAR_P06_PIDPV1 (a Group object) repeating

See Also:

Serialized Form

Field Summary

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

log

Constructor Summary

Constructors

Constructor and Description
BAR_P06() Creates a new BAR_P06 message with DefaultModelClassFactory.
BAR_P06(ModelClassFactory factory) Creates a new BAR_P06 message with custom ModelClassFactory.

Method Summary

Methods

Modifier and Type	Method and Description
EVN	getEVN() Returns EVN (EVN - event type segment) - creates it if necessary
MSH	getMSH() Returns MSH (MSH - message header segment) - creates it if necessary
BAR_P06_PIDPV1	getPIDPV1() Returns the first repetition of PIDPV1 (a Group object) - creates it if necessary
BAR_P06_PIDPV1	getPIDPV1(int rep) Returns a specific repetition of PIDPV1 (a Group object) - creates it if necessary
List<BAR_P06_PIDPV1>	getPIDPV1All() Returns a non-modifiable List containing all current existing repetitions of PIDPV1.
int	getPIDPV1Reps() Returns the number of existing repetitions of PIDPV1
String	getVersion() Returns "2.3.1"
void	insertPIDPV1(BAR_P06_PIDPV1 structure, int rep) Inserts a specific repetition of PIDPV1 (a Group object)
BAR_P06_PIDPV1	insertPIDPV1(int rep) Inserts a specific repetition of PIDPV1 (a Group object)
BAR_P06_PIDPV1	removePIDPV1(int rep) Removes a specific repetition of PIDPV1 (a Group object)

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

encode, generateACK, generateACK, getEncodingCharactersValue, getFieldSeparatorValue, getMessage, getParent, getParser, getValidationContext, initQuickstart, parse, printStructure, setParser, setValidationContext, toString

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 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, isGroup, isRepeating, isRequired

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

getName

Constructor Detail

BAR_P06

public BAR_P06()

Creates a new BAR_P06 message with DefaultModelClassFactory.

BAR_P06

public BAR_P06(ModelClassFactory factory)

Creates a new BAR_P06 message with custom ModelClassFactory.

Method Detail

getVersion

public String getVersion()

Returns "2.3.1"

Specified by:

getVersion in interface Message

Overrides:

getVersion in class AbstractMessage

getMSH

public MSH getMSH()

Returns MSH (MSH - message header segment) - creates it if necessary

getEVN

public EVN getEVN()

Returns EVN (EVN - event type segment) - creates it if necessary

getPIDPV1

public BAR_P06_PIDPV1 getPIDPV1()

Returns the first repetition of PIDPV1 (a Group object) - creates it if necessary

getPIDPV1

public BAR_P06_PIDPV1 getPIDPV1(int rep)

Returns a specific repetition of PIDPV1 (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.

getPIDPV1Reps

public int getPIDPV1Reps()

Returns the number of existing repetitions of PIDPV1

getPIDPV1All

public List<BAR_P06_PIDPV1> getPIDPV1All()
                                  throws HL7Exception

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

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

Throws:

HL7Exception

insertPIDPV1

public void insertPIDPV1(BAR_P06_PIDPV1 structure,
                int rep)
                  throws HL7Exception

Inserts a specific repetition of PIDPV1 (a Group object)

Throws:

HL7Exception

See Also:

AbstractGroup#insertRepetition(Structure, int)

insertPIDPV1

public BAR_P06_PIDPV1 insertPIDPV1(int rep)
                            throws HL7Exception

Inserts a specific repetition of PIDPV1 (a Group object)

Throws:

HL7Exception

See Also:

AbstractGroup#insertRepetition(Structure, int)

removePIDPV1

public BAR_P06_PIDPV1 removePIDPV1(int rep)
                            throws HL7Exception

Removes a specific repetition of PIDPV1 (a Group object)

Throws:

HL7Exception

See Also:

AbstractGroup#removeRepetition(String, int)