ca.uhn.hl7v2.model.v231.group

Class PGL_PC6_OBRRXONTEVAROBXNTEVAR

java.lang.Object

ca.uhn.hl7v2.model.AbstractStructure

ca.uhn.hl7v2.model.AbstractGroup

ca.uhn.hl7v2.model.v231.group.PGL_PC6_OBRRXONTEVAROBXNTEVAR

All Implemented Interfaces:

Group, Structure, Serializable

public class PGL_PC6_OBRRXONTEVAROBXNTEVAR
extends AbstractGroup

Represents a PGL_PC6_OBRRXONTEVAROBXNTEVAR 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: OBR (OBR - observation request segment)
• 2: RXO (RXO - pharmacy/treatment order segment)
• 3: NTE (NTE - notes and comments segment) optional repeating
• 4: VAR (Variance) optional repeating
• 5: PGL_PC6_OBXNTEVAR (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 and Description
PGL_PC6_OBRRXONTEVAROBXNTEVAR(Group parent, ModelClassFactory factory) Creates a new PGL_PC6_OBRRXONTEVAROBXNTEVAR group

Method Summary

Methods

Modifier and Type	Method and Description
NTE	getNTE() Returns the first repetition of NTE (NTE - notes and comments segment) - creates it if necessary
NTE	getNTE(int rep) Returns a specific repetition of NTE (NTE - notes and comments segment) - 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
OBR	getOBR() Returns OBR (OBR - observation request segment) - creates it if necessary
PGL_PC6_OBXNTEVAR	getOBXNTEVAR() Returns the first repetition of OBXNTEVAR (a Group object) - creates it if necessary
PGL_PC6_OBXNTEVAR	getOBXNTEVAR(int rep) Returns a specific repetition of OBXNTEVAR (a Group object) - creates it if necessary
List<PGL_PC6_OBXNTEVAR>	getOBXNTEVARAll() Returns a non-modifiable List containing all current existing repetitions of OBXNTEVAR.
int	getOBXNTEVARReps() Returns the number of existing repetitions of OBXNTEVAR
RXO	getRXO() Returns RXO (RXO - pharmacy/treatment order segment) - creates it if necessary
VAR	getVAR() Returns the first repetition of VAR (Variance) - creates it if necessary
VAR	getVAR(int rep) Returns a specific repetition of VAR (Variance) - creates it if necessary
List<VAR>	getVARAll() Returns a non-modifiable List containing all current existing repetitions of VAR.
int	getVARReps() Returns the number of existing repetitions of VAR
String	getVersion() Returns "2.3.1"
NTE	insertNTE(int rep) Inserts a specific repetition of NTE (NTE - notes and comments segment)
void	insertNTE(NTE structure, int rep) Inserts a specific repetition of NTE (NTE - notes and comments segment)
PGL_PC6_OBXNTEVAR	insertOBXNTEVAR(int rep) Inserts a specific repetition of OBXNTEVAR (a Group object)
void	insertOBXNTEVAR(PGL_PC6_OBXNTEVAR structure, int rep) Inserts a specific repetition of OBXNTEVAR (a Group object)
VAR	insertVAR(int rep) Inserts a specific repetition of VAR (Variance)
void	insertVAR(VAR structure, int rep) Inserts a specific repetition of VAR (Variance)
NTE	removeNTE(int rep) Removes a specific repetition of NTE (NTE - notes and comments segment)
PGL_PC6_OBXNTEVAR	removeOBXNTEVAR(int rep) Removes a specific repetition of OBXNTEVAR (a Group object)
VAR	removeVAR(int rep) Removes a specific repetition of VAR (Variance)

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 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 Detail

PGL_PC6_OBRRXONTEVAROBXNTEVAR

public PGL_PC6_OBRRXONTEVAROBXNTEVAR(Group parent,
                             ModelClassFactory factory)

Creates a new PGL_PC6_OBRRXONTEVAROBXNTEVAR group

Method Detail

getVersion

public String getVersion()

Returns "2.3.1"

getOBR

public OBR getOBR()

Returns OBR (OBR - observation request segment) - creates it if necessary

getRXO

public RXO getRXO()

Returns RXO (RXO - pharmacy/treatment order segment) - creates it if necessary

getNTE

public NTE getNTE()

Returns the first repetition of NTE (NTE - notes and comments segment) - creates it if necessary

getNTE

public NTE getNTE(int rep)

Returns a specific repetition of NTE (NTE - notes and comments 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.

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 (NTE - notes and comments segment)

Throws:

HL7Exception

See Also:

AbstractGroup#insertRepetition(Structure, int)

insertNTE

public NTE insertNTE(int rep)
              throws HL7Exception

Inserts a specific repetition of NTE (NTE - notes and comments segment)

Throws:

HL7Exception

See Also:

AbstractGroup#insertRepetition(Structure, int)

removeNTE

public NTE removeNTE(int rep)
              throws HL7Exception

Removes a specific repetition of NTE (NTE - notes and comments segment)

Throws:

HL7Exception

See Also:

AbstractGroup.removeRepetition(String, int)

getVAR

public VAR getVAR()

Returns the first repetition of VAR (Variance) - creates it if necessary

getVAR

public VAR getVAR(int rep)

Returns a specific repetition of VAR (Variance) - 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.

getVARReps

public int getVARReps()

Returns the number of existing repetitions of VAR

getVARAll

public List<VAR> getVARAll()
                    throws HL7Exception

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

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

Throws:

HL7Exception

insertVAR

public void insertVAR(VAR structure,
             int rep)
               throws HL7Exception

Inserts a specific repetition of VAR (Variance)

Throws:

HL7Exception

See Also:

AbstractGroup#insertRepetition(Structure, int)

insertVAR

public VAR insertVAR(int rep)
              throws HL7Exception

Inserts a specific repetition of VAR (Variance)

Throws:

HL7Exception

See Also:

AbstractGroup#insertRepetition(Structure, int)

removeVAR

public VAR removeVAR(int rep)
              throws HL7Exception

Removes a specific repetition of VAR (Variance)

Throws:

HL7Exception

See Also:

AbstractGroup.removeRepetition(String, int)

getOBXNTEVAR

public PGL_PC6_OBXNTEVAR getOBXNTEVAR()

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

getOBXNTEVAR

public PGL_PC6_OBXNTEVAR getOBXNTEVAR(int rep)

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

getOBXNTEVARReps

public int getOBXNTEVARReps()

Returns the number of existing repetitions of OBXNTEVAR

getOBXNTEVARAll

public List<PGL_PC6_OBXNTEVAR> getOBXNTEVARAll()
                                        throws HL7Exception

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

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

Throws:

HL7Exception

insertOBXNTEVAR

public void insertOBXNTEVAR(PGL_PC6_OBXNTEVAR structure,
                   int rep)
                     throws HL7Exception

Inserts a specific repetition of OBXNTEVAR (a Group object)

Throws:

HL7Exception

See Also:

AbstractGroup#insertRepetition(Structure, int)

insertOBXNTEVAR

public PGL_PC6_OBXNTEVAR insertOBXNTEVAR(int rep)
                                  throws HL7Exception

Inserts a specific repetition of OBXNTEVAR (a Group object)

Throws:

HL7Exception

See Also:

AbstractGroup#insertRepetition(Structure, int)

removeOBXNTEVAR

public PGL_PC6_OBXNTEVAR removeOBXNTEVAR(int rep)
                                  throws HL7Exception

Removes a specific repetition of OBXNTEVAR (a Group object)

Throws:

HL7Exception

See Also:

AbstractGroup.removeRepetition(String, int)