Package ca.uhn.hl7v2.model.v251.message

Class BAR_P01

java.lang.Object

ca.uhn.hl7v2.model.AbstractStructure

ca.uhn.hl7v2.model.AbstractGroup

ca.uhn.hl7v2.model.AbstractMessage

ca.uhn.hl7v2.model.v251.message.BAR_P01

All Implemented Interfaces:

Group, Message, Structure, Visitable, Serializable

public class BAR_P01
extends AbstractMessage

Represents a BAR_P01 message structure (see chapter 6.4.1). This structure contains the following elements:

• 1: MSH (Message Header)
• 2: SFT (Software Segment) optional repeating
• 3: EVN (Event Type)
• 4: PID (Patient Identification)
• 5: PD1 (Patient Additional Demographic) optional
• 6: ROL (Role) optional repeating
• 7: BAR_P01_VISIT (a Group object) repeating

See Also:

• Serialized Form

Field Summary

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

log

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
EVN	getEVN()	Returns EVN (Event Type) - creates it if necessary
MSH	getMSH()	Returns MSH (Message Header) - creates it if necessary
PD1	getPD1()	Returns PD1 (Patient Additional Demographic) - creates it if necessary
PID	getPID()	Returns PID (Patient Identification) - creates it if necessary
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
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
String	getVersion()	Returns "2.5.1"
BAR_P01_VISIT	getVISIT()	Returns the first repetition of VISIT (a Group object) - creates it if necessary
BAR_P01_VISIT	getVISIT(int rep)	Returns a specific repetition of VISIT (a Group object) - creates it if necessary
List<BAR_P01_VISIT>	getVISITAll()	Returns a non-modifiable List containing all current existing repetitions of VISIT.
int	getVISITReps()	Returns the number of existing repetitions of VISIT
ROL	insertROL(int rep)	Inserts a specific repetition of ROL (Role)
void	insertROL(ROL structure, int rep)	Inserts a specific repetition of ROL (Role)
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)
BAR_P01_VISIT	insertVISIT(int rep)	Inserts a specific repetition of VISIT (a Group object)
void	insertVISIT(BAR_P01_VISIT structure, int rep)	Inserts a specific repetition of VISIT (a Group object)
ROL	removeROL(int rep)	Removes a specific repetition of ROL (Role)
SFT	removeSFT(int rep)	Removes a specific repetition of SFT (Software Segment)
BAR_P01_VISIT	removeVISIT(int rep)	Removes a specific repetition of VISIT (a Group object)

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

accept, copy, 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 Details

BAR_P01

public BAR_P01()

Creates a new BAR_P01 message with DefaultModelClassFactory.

BAR_P01

public BAR_P01(ModelClassFactory factory)

Creates a new BAR_P01 message with custom ModelClassFactory.

Method Details

getVersion

public String getVersion()

Returns "2.5.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)

getEVN

public EVN getEVN()

Returns EVN (Event Type) - creates it if necessary

getPID

public PID getPID()

Returns PID (Patient Identification) - creates it if necessary

getPD1

public PD1 getPD1()

Returns PD1 (Patient Additional Demographic) - creates it if necessary

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)

getVISIT

public BAR_P01_VISIT getVISIT()

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

getVISIT

public BAR_P01_VISIT getVISIT(int rep)

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

getVISITReps

public int getVISITReps()

Returns the number of existing repetitions of VISIT

getVISITAll

public List<BAR_P01_VISIT> getVISITAll()
                                throws HL7Exception

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

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

Throws:

HL7Exception

insertVISIT

public void insertVISIT(BAR_P01_VISIT structure,
 int rep)
                 throws HL7Exception

Inserts a specific repetition of VISIT (a Group object)

Throws:

HL7Exception

See Also:

• AbstractGroup#insertRepetition(Structure, int)

insertVISIT

public BAR_P01_VISIT insertVISIT(int rep)
                          throws HL7Exception

Inserts a specific repetition of VISIT (a Group object)

Throws:

HL7Exception

See Also:

• AbstractGroup#insertRepetition(Structure, int)

removeVISIT

public BAR_P01_VISIT removeVISIT(int rep)
                          throws HL7Exception

Removes a specific repetition of VISIT (a Group object)

Throws:

HL7Exception

See Also:

• AbstractGroup.removeRepetition(String, int)