Package ca.uhn.hl7v2.model.v251.group

Class PEX_P07_PEX_CAUSE

java.lang.Object

ca.uhn.hl7v2.model.AbstractStructure

ca.uhn.hl7v2.model.AbstractGroup

ca.uhn.hl7v2.model.v251.group.PEX_P07_PEX_CAUSE

All Implemented Interfaces:

Group, Structure, Visitable, Serializable

public class PEX_P07_PEX_CAUSE
extends AbstractGroup

Represents a PEX_P07_PEX_CAUSE 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: PCR (Possible Causal Relationship)
• 2: PEX_P07_RX_ORDER (a Group object) optional
• 3: PEX_P07_RX_ADMINISTRATION (a Group object) optional repeating
• 4: PRB (Problem Details) optional repeating
• 5: OBX (Observation/Result) optional repeating
• 6: NTE (Notes and Comments) optional repeating
• 7: PEX_P07_ASSOCIATED_PERSON (a Group object) optional
• 8: PEX_P07_STUDY (a Group object) optional repeating

See Also:

• Serialized Form

Field Summary

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

log

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
PEX_P07_ASSOCIATED_PERSON	getASSOCIATED_PERSON()	Returns ASSOCIATED_PERSON (a Group object) - creates it if necessary
NTE	getNTE()	Returns the first repetition of NTE (Notes and Comments) - creates it if necessary
NTE	getNTE(int rep)	Returns a specific repetition of NTE (Notes and Comments) - creates it if necessary
List<NTE>	getNTEAll()	Returns a non-modifiable List containing all current existing repetitions of NTE.
int	getNTEReps()	Returns the number of existing repetitions of NTE
OBX	getOBX()	Returns the first repetition of OBX (Observation/Result) - creates it if necessary
OBX	getOBX(int rep)	Returns a specific repetition of OBX (Observation/Result) - 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
PCR	getPCR()	Returns PCR (Possible Causal Relationship) - creates it if necessary
PRB	getPRB()	Returns the first repetition of PRB (Problem Details) - creates it if necessary
PRB	getPRB(int rep)	Returns a specific repetition of PRB (Problem Details) - 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
PEX_P07_RX_ADMINISTRATION	getRX_ADMINISTRATION()	Returns the first repetition of RX_ADMINISTRATION (a Group object) - creates it if necessary
PEX_P07_RX_ADMINISTRATION	getRX_ADMINISTRATION(int rep)	Returns a specific repetition of RX_ADMINISTRATION (a Group object) - creates it if necessary
List<PEX_P07_RX_ADMINISTRATION>	getRX_ADMINISTRATIONAll()	Returns a non-modifiable List containing all current existing repetitions of RX_ADMINISTRATION.
int	getRX_ADMINISTRATIONReps()	Returns the number of existing repetitions of RX_ADMINISTRATION
PEX_P07_RX_ORDER	getRX_ORDER()	Returns RX_ORDER (a Group object) - creates it if necessary
PEX_P07_STUDY	getSTUDY()	Returns the first repetition of STUDY (a Group object) - creates it if necessary
PEX_P07_STUDY	getSTUDY(int rep)	Returns a specific repetition of STUDY (a Group object) - creates it if necessary
List<PEX_P07_STUDY>	getSTUDYAll()	Returns a non-modifiable List containing all current existing repetitions of STUDY.
int	getSTUDYReps()	Returns the number of existing repetitions of STUDY
String	getVersion()	Returns "2.5.1"
NTE	insertNTE(int rep)	Inserts a specific repetition of NTE (Notes and Comments)
void	insertNTE(NTE structure, int rep)	Inserts a specific repetition of NTE (Notes and Comments)
OBX	insertOBX(int rep)	Inserts a specific repetition of OBX (Observation/Result)
void	insertOBX(OBX structure, int rep)	Inserts a specific repetition of OBX (Observation/Result)
PRB	insertPRB(int rep)	Inserts a specific repetition of PRB (Problem Details)
void	insertPRB(PRB structure, int rep)	Inserts a specific repetition of PRB (Problem Details)
PEX_P07_RX_ADMINISTRATION	insertRX_ADMINISTRATION(int rep)	Inserts a specific repetition of RX_ADMINISTRATION (a Group object)
void	insertRX_ADMINISTRATION(PEX_P07_RX_ADMINISTRATION structure, int rep)	Inserts a specific repetition of RX_ADMINISTRATION (a Group object)
PEX_P07_STUDY	insertSTUDY(int rep)	Inserts a specific repetition of STUDY (a Group object)
void	insertSTUDY(PEX_P07_STUDY structure, int rep)	Inserts a specific repetition of STUDY (a Group object)
NTE	removeNTE(int rep)	Removes a specific repetition of NTE (Notes and Comments)
OBX	removeOBX(int rep)	Removes a specific repetition of OBX (Observation/Result)
PRB	removePRB(int rep)	Removes a specific repetition of PRB (Problem Details)
PEX_P07_RX_ADMINISTRATION	removeRX_ADMINISTRATION(int rep)	Removes a specific repetition of RX_ADMINISTRATION (a Group object)
PEX_P07_STUDY	removeSTUDY(int rep)	Removes a specific repetition of STUDY (a Group object)

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_P07_PEX_CAUSE

public PEX_P07_PEX_CAUSE(Group parent,
 ModelClassFactory factory)

Creates a new PEX_P07_PEX_CAUSE group

Method Details

getVersion

public String getVersion()

Returns "2.5.1"

getPCR

public PCR getPCR()

Returns PCR (Possible Causal Relationship) - creates it if necessary

getRX_ORDER

public PEX_P07_RX_ORDER getRX_ORDER()

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

getRX_ADMINISTRATION

public PEX_P07_RX_ADMINISTRATION getRX_ADMINISTRATION()

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

getRX_ADMINISTRATION

public PEX_P07_RX_ADMINISTRATION getRX_ADMINISTRATION(int rep)

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

getRX_ADMINISTRATIONReps

public int getRX_ADMINISTRATIONReps()

Returns the number of existing repetitions of RX_ADMINISTRATION

getRX_ADMINISTRATIONAll

public List<PEX_P07_RX_ADMINISTRATION> getRX_ADMINISTRATIONAll()
                                                        throws HL7Exception

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

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

Throws:

HL7Exception

insertRX_ADMINISTRATION

public void insertRX_ADMINISTRATION(PEX_P07_RX_ADMINISTRATION structure,
 int rep)
                             throws HL7Exception

Inserts a specific repetition of RX_ADMINISTRATION (a Group object)

Throws:

HL7Exception

See Also:

• AbstractGroup#insertRepetition(Structure, int)

insertRX_ADMINISTRATION

public PEX_P07_RX_ADMINISTRATION insertRX_ADMINISTRATION(int rep)
                                                  throws HL7Exception

Inserts a specific repetition of RX_ADMINISTRATION (a Group object)

Throws:

HL7Exception

See Also:

• AbstractGroup#insertRepetition(Structure, int)

removeRX_ADMINISTRATION

public PEX_P07_RX_ADMINISTRATION removeRX_ADMINISTRATION(int rep)
                                                  throws HL7Exception

Removes a specific repetition of RX_ADMINISTRATION (a Group object)

Throws:

HL7Exception

See Also:

• AbstractGroup.removeRepetition(String, int)

getPRB

public PRB getPRB()

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

getPRB

public PRB getPRB(int rep)

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

Throws:

HL7Exception

See Also:

• AbstractGroup#insertRepetition(Structure, int)

insertPRB

public PRB insertPRB(int rep)
              throws HL7Exception

Inserts a specific repetition of PRB (Problem Details)

Throws:

HL7Exception

See Also:

• AbstractGroup#insertRepetition(Structure, int)

removePRB

public PRB removePRB(int rep)
              throws HL7Exception

Removes a specific repetition of PRB (Problem Details)

Throws:

HL7Exception

See Also:

• AbstractGroup.removeRepetition(String, int)

getOBX

public OBX getOBX()

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

getOBX

public OBX getOBX(int rep)

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

Throws:

HL7Exception

See Also:

• AbstractGroup#insertRepetition(Structure, int)

insertOBX

public OBX insertOBX(int rep)
              throws HL7Exception

Inserts a specific repetition of OBX (Observation/Result)

Throws:

HL7Exception

See Also:

• AbstractGroup#insertRepetition(Structure, int)

removeOBX

public OBX removeOBX(int rep)
              throws HL7Exception

Removes a specific repetition of OBX (Observation/Result)

Throws:

HL7Exception

See Also:

• AbstractGroup.removeRepetition(String, int)

getNTE

public NTE getNTE()

Returns the first repetition of NTE (Notes and Comments) - creates it if necessary

getNTE

public NTE getNTE(int rep)

Returns a specific repetition of NTE (Notes and Comments) - 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.

getNTEReps

public int getNTEReps()

Returns the number of existing repetitions of NTE

getNTEAll

public List<NTE> getNTEAll()
                    throws HL7Exception

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

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

Throws:

HL7Exception

insertNTE

public void insertNTE(NTE structure,
 int rep)
               throws HL7Exception

Inserts a specific repetition of NTE (Notes and Comments)

Throws:

HL7Exception

See Also:

• AbstractGroup#insertRepetition(Structure, int)

insertNTE

public NTE insertNTE(int rep)
              throws HL7Exception

Inserts a specific repetition of NTE (Notes and Comments)

Throws:

HL7Exception

See Also:

• AbstractGroup#insertRepetition(Structure, int)

removeNTE

public NTE removeNTE(int rep)
              throws HL7Exception

Removes a specific repetition of NTE (Notes and Comments)

Throws:

HL7Exception

See Also:

• AbstractGroup.removeRepetition(String, int)

getASSOCIATED_PERSON

public PEX_P07_ASSOCIATED_PERSON getASSOCIATED_PERSON()

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

getSTUDY

public PEX_P07_STUDY getSTUDY()

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

getSTUDY

public PEX_P07_STUDY getSTUDY(int rep)

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

getSTUDYReps

public int getSTUDYReps()

Returns the number of existing repetitions of STUDY

getSTUDYAll

public List<PEX_P07_STUDY> getSTUDYAll()
                                throws HL7Exception

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

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

Throws:

HL7Exception

insertSTUDY

public void insertSTUDY(PEX_P07_STUDY structure,
 int rep)
                 throws HL7Exception

Inserts a specific repetition of STUDY (a Group object)

Throws:

HL7Exception

See Also:

• AbstractGroup#insertRepetition(Structure, int)

insertSTUDY

public PEX_P07_STUDY insertSTUDY(int rep)
                          throws HL7Exception

Inserts a specific repetition of STUDY (a Group object)

Throws:

HL7Exception

See Also:

• AbstractGroup#insertRepetition(Structure, int)

removeSTUDY

public PEX_P07_STUDY removeSTUDY(int rep)
                          throws HL7Exception

Removes a specific repetition of STUDY (a Group object)

Throws:

HL7Exception

See Also:

• AbstractGroup.removeRepetition(String, int)