Package ca.uhn.hl7v2.model.v23.group

Class PEX_P08_ASSOCIATED_PERSON

java.lang.Object

ca.uhn.hl7v2.model.AbstractStructure

ca.uhn.hl7v2.model.AbstractGroup

ca.uhn.hl7v2.model.v23.group.PEX_P08_ASSOCIATED_PERSON

All Implemented Interfaces:

Group, Structure, Visitable, Serializable

public class PEX_P08_ASSOCIATED_PERSON
extends AbstractGroup

Represents a PEX_P08_ASSOCIATED_PERSON 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: NK1 (Next of kin)
• 2: PEX_P08_ASSOCIATED_RX_ORDER (a Group object) optional
• 3: PEX_P08_ASSOCIATED_RX_ADMIN (a Group object) optional repeating
• 4: PRB (Problem Detail) optional repeating
• 5: OBX (Observation segment) optional repeating

See Also:

• Serialized Form

Field Summary

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

log

Constructor Summary

Constructors

Constructor	Description
PEX_P08_ASSOCIATED_PERSON(Group parent, ModelClassFactory factory)	Creates a new PEX_P08_ASSOCIATED_PERSON group

Method Summary

Modifier and Type	Method	Description
PEX_P08_ASSOCIATED_RX_ADMIN	getASSOCIATED_RX_ADMIN()	Returns the first repetition of ASSOCIATED_RX_ADMIN (a Group object) - creates it if necessary
PEX_P08_ASSOCIATED_RX_ADMIN	getASSOCIATED_RX_ADMIN(int rep)	Returns a specific repetition of ASSOCIATED_RX_ADMIN (a Group object) - creates it if necessary
List<PEX_P08_ASSOCIATED_RX_ADMIN>	getASSOCIATED_RX_ADMINAll()	Returns a non-modifiable List containing all current existing repetitions of ASSOCIATED_RX_ADMIN.
int	getASSOCIATED_RX_ADMINReps()	Returns the number of existing repetitions of ASSOCIATED_RX_ADMIN
PEX_P08_ASSOCIATED_RX_ORDER	getASSOCIATED_RX_ORDER()	Returns ASSOCIATED_RX_ORDER (a Group object) - creates it if necessary
NK1	getNK1()	Returns NK1 (Next of kin) - creates it if necessary
OBX	getOBX()	Returns the first repetition of OBX (Observation segment) - creates it if necessary
OBX	getOBX(int rep)	Returns a specific repetition of OBX (Observation segment) - creates it if necessary
List<OBX>	getOBXAll()	Returns a non-modifiable List containing all current existing repetitions of OBX.
int	getOBXReps()	Returns the number of existing repetitions of OBX
PRB	getPRB()	Returns the first repetition of PRB (Problem Detail) - creates it if necessary
PRB	getPRB(int rep)	Returns a specific repetition of PRB (Problem Detail) - creates it if necessary
List<PRB>	getPRBAll()	Returns a non-modifiable List containing all current existing repetitions of PRB.
int	getPRBReps()	Returns the number of existing repetitions of PRB
String	getVersion()	Returns "2.3"
PEX_P08_ASSOCIATED_RX_ADMIN	insertASSOCIATED_RX_ADMIN(int rep)	Inserts a specific repetition of ASSOCIATED_RX_ADMIN (a Group object)
void	insertASSOCIATED_RX_ADMIN(PEX_P08_ASSOCIATED_RX_ADMIN structure, int rep)	Inserts a specific repetition of ASSOCIATED_RX_ADMIN (a Group object)
OBX	insertOBX(int rep)	Inserts a specific repetition of OBX (Observation segment)
void	insertOBX(OBX structure, int rep)	Inserts a specific repetition of OBX (Observation segment)
PRB	insertPRB(int rep)	Inserts a specific repetition of PRB (Problem Detail)
void	insertPRB(PRB structure, int rep)	Inserts a specific repetition of PRB (Problem Detail)
PEX_P08_ASSOCIATED_RX_ADMIN	removeASSOCIATED_RX_ADMIN(int rep)	Removes a specific repetition of ASSOCIATED_RX_ADMIN (a Group object)
OBX	removeOBX(int rep)	Removes a specific repetition of OBX (Observation segment)
PRB	removePRB(int rep)	Removes a specific repetition of PRB (Problem Detail)

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 Details

PEX_P08_ASSOCIATED_PERSON

public PEX_P08_ASSOCIATED_PERSON(Group parent,
 ModelClassFactory factory)

Creates a new PEX_P08_ASSOCIATED_PERSON group

Method Details

getVersion

public String getVersion()

Returns "2.3"

getNK1

public NK1 getNK1()

Returns NK1 (Next of kin) - creates it if necessary

getASSOCIATED_RX_ORDER

public PEX_P08_ASSOCIATED_RX_ORDER getASSOCIATED_RX_ORDER()

Returns ASSOCIATED_RX_ORDER (a Group object) - creates it if necessary

getASSOCIATED_RX_ADMIN

public PEX_P08_ASSOCIATED_RX_ADMIN getASSOCIATED_RX_ADMIN()

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

getASSOCIATED_RX_ADMIN

public PEX_P08_ASSOCIATED_RX_ADMIN getASSOCIATED_RX_ADMIN(int rep)

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

getASSOCIATED_RX_ADMINReps

public int getASSOCIATED_RX_ADMINReps()

Returns the number of existing repetitions of ASSOCIATED_RX_ADMIN

getASSOCIATED_RX_ADMINAll

public List<PEX_P08_ASSOCIATED_RX_ADMIN> getASSOCIATED_RX_ADMINAll()
                                                            throws HL7Exception

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

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

Throws:

HL7Exception

insertASSOCIATED_RX_ADMIN

public void insertASSOCIATED_RX_ADMIN(PEX_P08_ASSOCIATED_RX_ADMIN structure,
 int rep)
                               throws HL7Exception

Inserts a specific repetition of ASSOCIATED_RX_ADMIN (a Group object)

Throws:

HL7Exception

See Also:

• AbstractGroup#insertRepetition(Structure, int)

insertASSOCIATED_RX_ADMIN

public PEX_P08_ASSOCIATED_RX_ADMIN insertASSOCIATED_RX_ADMIN(int rep)
                                                      throws HL7Exception

Inserts a specific repetition of ASSOCIATED_RX_ADMIN (a Group object)

Throws:

HL7Exception

See Also:

• AbstractGroup#insertRepetition(Structure, int)

removeASSOCIATED_RX_ADMIN

public PEX_P08_ASSOCIATED_RX_ADMIN removeASSOCIATED_RX_ADMIN(int rep)
                                                      throws HL7Exception

Removes a specific repetition of ASSOCIATED_RX_ADMIN (a Group object)

Throws:

HL7Exception

See Also:

• AbstractGroup.removeRepetition(String, int)

getPRB

public PRB getPRB()

Returns the first repetition of PRB (Problem Detail) - creates it if necessary

getPRB

public PRB getPRB(int rep)

Returns a specific repetition of PRB (Problem Detail) - 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.

getPRBReps

public int getPRBReps()

Returns the number of existing repetitions of PRB

getPRBAll

public List<PRB> getPRBAll()
                    throws HL7Exception

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

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

Throws:

HL7Exception

insertPRB

public void insertPRB(PRB structure,
 int rep)
               throws HL7Exception

Inserts a specific repetition of PRB (Problem Detail)

Throws:

HL7Exception

See Also:

• AbstractGroup#insertRepetition(Structure, int)

insertPRB

public PRB insertPRB(int rep)
              throws HL7Exception

Inserts a specific repetition of PRB (Problem Detail)

Throws:

HL7Exception

See Also:

• AbstractGroup#insertRepetition(Structure, int)

removePRB

public PRB removePRB(int rep)
              throws HL7Exception

Removes a specific repetition of PRB (Problem Detail)

Throws:

HL7Exception

See Also:

• AbstractGroup.removeRepetition(String, int)

getOBX

public OBX getOBX()

Returns the first repetition of OBX (Observation segment) - creates it if necessary

getOBX

public OBX getOBX(int rep)

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

getOBXReps

public int getOBXReps()

Returns the number of existing repetitions of OBX

getOBXAll

public List<OBX> getOBXAll()
                    throws HL7Exception

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

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

Throws:

HL7Exception

insertOBX

public void insertOBX(OBX structure,
 int rep)
               throws HL7Exception

Inserts a specific repetition of OBX (Observation segment)

Throws:

HL7Exception

See Also:

• AbstractGroup#insertRepetition(Structure, int)

insertOBX

public OBX insertOBX(int rep)
              throws HL7Exception

Inserts a specific repetition of OBX (Observation segment)

Throws:

HL7Exception

See Also:

• AbstractGroup#insertRepetition(Structure, int)

removeOBX

public OBX removeOBX(int rep)
              throws HL7Exception

Removes a specific repetition of OBX (Observation segment)

Throws:

HL7Exception

See Also:

• AbstractGroup.removeRepetition(String, int)