ca.uhn.hl7v2.model.v231.group

Class ORF_R04_ORCOBRNTEOBXNTECTI

java.lang.Object

ca.uhn.hl7v2.model.AbstractStructure

ca.uhn.hl7v2.model.AbstractGroup

ca.uhn.hl7v2.model.v231.group.ORF_R04_ORCOBRNTEOBXNTECTI

All Implemented Interfaces:

Group, Structure, Visitable, Serializable

public class ORF_R04_ORCOBRNTEOBXNTECTI
extends AbstractGroup

Represents a ORF_R04_ORCOBRNTEOBXNTECTI 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: ORC (ORC - common order segment) optional
• 2: OBR (OBR - observation request segment)
• 3: NTE (NTE - notes and comments segment) optional repeating
• 4: ORF_R04_OBXNTE (a Group object) repeating
• 5: CTI (CTI - clinical trial identification segment) optional repeating

See Also:

Serialized Form

Field Summary

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

log

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
CTI	getCTI() Returns the first repetition of CTI (CTI - clinical trial identification segment) - creates it if necessary
CTI	getCTI(int rep) Returns a specific repetition of CTI (CTI - clinical trial identification segment) - creates it if necessary
List<CTI>	getCTIAll() Returns a non-modifiable List containing all current existing repetitions of CTI.
int	getCTIReps() Returns the number of existing repetitions of CTI
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
ORF_R04_OBXNTE	getOBXNTE() Returns the first repetition of OBXNTE (a Group object) - creates it if necessary
ORF_R04_OBXNTE	getOBXNTE(int rep) Returns a specific repetition of OBXNTE (a Group object) - creates it if necessary
List<ORF_R04_OBXNTE>	getOBXNTEAll() Returns a non-modifiable List containing all current existing repetitions of OBXNTE.
int	getOBXNTEReps() Returns the number of existing repetitions of OBXNTE
ORC	getORC() Returns ORC (ORC - common order segment) - creates it if necessary
String	getVersion() Returns "2.3.1"
void	insertCTI(CTI structure, int rep) Inserts a specific repetition of CTI (CTI - clinical trial identification segment)
CTI	insertCTI(int rep) Inserts a specific repetition of CTI (CTI - clinical trial identification segment)
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)
ORF_R04_OBXNTE	insertOBXNTE(int rep) Inserts a specific repetition of OBXNTE (a Group object)
void	insertOBXNTE(ORF_R04_OBXNTE structure, int rep) Inserts a specific repetition of OBXNTE (a Group object)
CTI	removeCTI(int rep) Removes a specific repetition of CTI (CTI - clinical trial identification segment)
NTE	removeNTE(int rep) Removes a specific repetition of NTE (NTE - notes and comments segment)
ORF_R04_OBXNTE	removeOBXNTE(int rep) Removes a specific repetition of OBXNTE (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 Detail

ORF_R04_ORCOBRNTEOBXNTECTI

public ORF_R04_ORCOBRNTEOBXNTECTI(Group parent,
                                  ModelClassFactory factory)

Creates a new ORF_R04_ORCOBRNTEOBXNTECTI group

Method Detail

getVersion

public String getVersion()

Returns "2.3.1"

getORC

public ORC getORC()

Returns ORC (ORC - common order segment) - creates it if necessary

getOBR

public OBR getOBR()

Returns OBR (OBR - observation request 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)

getOBXNTE

public ORF_R04_OBXNTE getOBXNTE()

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

getOBXNTE

public ORF_R04_OBXNTE getOBXNTE(int rep)

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

getOBXNTEReps

public int getOBXNTEReps()

Returns the number of existing repetitions of OBXNTE

getOBXNTEAll

public List<ORF_R04_OBXNTE> getOBXNTEAll()
                                  throws HL7Exception

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

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

Throws:

HL7Exception

insertOBXNTE

public void insertOBXNTE(ORF_R04_OBXNTE structure,
                         int rep)
                  throws HL7Exception

Inserts a specific repetition of OBXNTE (a Group object)

Throws:

HL7Exception

See Also:

AbstractGroup#insertRepetition(Structure, int)

insertOBXNTE

public ORF_R04_OBXNTE insertOBXNTE(int rep)
                            throws HL7Exception

Inserts a specific repetition of OBXNTE (a Group object)

Throws:

HL7Exception

See Also:

AbstractGroup#insertRepetition(Structure, int)

removeOBXNTE

public ORF_R04_OBXNTE removeOBXNTE(int rep)
                            throws HL7Exception

Removes a specific repetition of OBXNTE (a Group object)

Throws:

HL7Exception

See Also:

AbstractGroup.removeRepetition(String, int)

getCTI

public CTI getCTI()

Returns the first repetition of CTI (CTI - clinical trial identification segment) - creates it if necessary

getCTI

public CTI getCTI(int rep)

Returns a specific repetition of CTI (CTI - clinical trial identification 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.

getCTIReps

public int getCTIReps()

Returns the number of existing repetitions of CTI

getCTIAll

public List<CTI> getCTIAll()
                    throws HL7Exception

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

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

Throws:

HL7Exception

insertCTI

public void insertCTI(CTI structure,
                      int rep)
               throws HL7Exception

Inserts a specific repetition of CTI (CTI - clinical trial identification segment)

Throws:

HL7Exception

See Also:

AbstractGroup#insertRepetition(Structure, int)

insertCTI

public CTI insertCTI(int rep)
              throws HL7Exception

Inserts a specific repetition of CTI (CTI - clinical trial identification segment)

Throws:

HL7Exception

See Also:

AbstractGroup#insertRepetition(Structure, int)

removeCTI

public CTI removeCTI(int rep)
              throws HL7Exception

Removes a specific repetition of CTI (CTI - clinical trial identification segment)

Throws:

HL7Exception

See Also:

AbstractGroup.removeRepetition(String, int)