ca.uhn.hl7v2.model.v231.group
Class OMN_O01_RQDRQ1NTEOBXNTE

java.lang.Object
  ca.uhn.hl7v2.model.AbstractGroup
      ca.uhn.hl7v2.model.v231.group.OMN_O01_RQDRQ1NTEOBXNTE

All Implemented Interfaces:

Group, Structure, Serializable

public class OMN_O01_RQDRQ1NTEOBXNTE
extends AbstractGroup

Represents a OMN_O01_RQDRQ1NTEOBXNTE 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: RQD (RQD - requisition detail segment)
• 2: RQ1 (RQ1 - requisition detail-1 segment) optional
• 3: NTE (NTE - notes and comments segment) optional repeating
• 4: OMN_O01_OBXNTE (a Group object) optional repeating

See Also:

Serialized Form

Constructor Summary

OMN_O01_RQDRQ1NTEOBXNTE(Group parent, ModelClassFactory factory)
Creates a new OMN_O01_RQDRQ1NTEOBXNTE group

Method Summary

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
int	getNTEReps() Returns the number of existing repetitions of NTE
OMN_O01_OBXNTE	getOBXNTE() Returns the first repetition of OBXNTE (a Group object) - creates it if necessary
OMN_O01_OBXNTE	getOBXNTE(int rep) Returns a specific repetition of OBXNTE (a Group object) - creates it if necessary
int	getOBXNTEReps() Returns the number of existing repetitions of OBXNTE
RQ1	getRQ1() Returns RQ1 (RQ1 - requisition detail-1 segment) - creates it if necessary
RQD	getRQD() Returns RQD (RQD - requisition detail segment) - creates it if necessary
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)
OMN_O01_OBXNTE	insertOBXNTE(int rep) Inserts a specific repetition of OBXNTE (a Group object)
void	insertOBXNTE(OMN_O01_OBXNTE structure, int rep) Inserts a specific repetition of OBXNTE (a Group object)
NTE	removeNTE(int rep) Removes a specific repetition of NTE (NTE - notes and comments segment)
OMN_O01_OBXNTE	removeOBXNTE(int rep) Removes a specific repetition of OBXNTE (a Group object)

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

add, add, addNonstandardSegment, addNonstandardSegment, clear, currentReps, get, get, getAll, getClass, getMessage, getModelClassFactory, getName, getNames, getParent, insertRepetition, insertRepetition, isGroup, isRepeating, isRequired, removeRepetition

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

OMN_O01_RQDRQ1NTEOBXNTE

public OMN_O01_RQDRQ1NTEOBXNTE(Group parent,
                               ModelClassFactory factory)

Creates a new OMN_O01_RQDRQ1NTEOBXNTE group

Method Detail

getVersion

public String getVersion()

Returns "2.3.1"

getRQD

public RQD getRQD()

Returns RQD (RQD - requisition detail segment) - creates it if necessary

getRQ1

public RQ1 getRQ1()

Returns RQ1 (RQ1 - requisition detail-1 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

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 OMN_O01_OBXNTE getOBXNTE()

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

getOBXNTE

public OMN_O01_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

insertOBXNTE

public void insertOBXNTE(OMN_O01_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 OMN_O01_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 OMN_O01_OBXNTE removeOBXNTE(int rep)
                            throws HL7Exception

Removes a specific repetition of OBXNTE (a Group object)

Throws:

HL7Exception

See Also:

AbstractGroup.removeRepetition(String, int)