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

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

All Implemented Interfaces:

Group, Structure, Serializable

public class ORR_O02_ORCOBRRQDRQ1RXOODSODTNTECTI
extends AbstractGroup

Represents a ORR_O02_ORCOBRRQDRQ1RXOODSODTNTECTI 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)
• 2: OBR (OBR - observation request segment)
• 3: RQD (RQD - requisition detail segment)
• 4: RQ1 (RQ1 - requisition detail-1 segment)
• 5: RXO (RXO - pharmacy/treatment order segment)
• 6: ODS (ODS - dietary orders, supplements, and preferences segment)
• 7: ODT (ODT - diet tray instructions segment)
• 8: NTE (NTE - notes and comments segment) optional repeating
• 9: CTI (CTI - clinical trial identification segment) optional repeating

See Also:

Serialized Form

Constructor Summary

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

Method Summary

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
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
int	getNTEReps() Returns the number of existing repetitions of NTE
OBR	getOBR() Returns OBR (OBR - observation request segment) - creates it if necessary
ODS	getODS() Returns ODS (ODS - dietary orders, supplements, and preferences segment) - creates it if necessary
ODT	getODT() Returns ODT (ODT - diet tray instructions segment) - creates it if necessary
ORC	getORC() Returns ORC (ORC - common order segment) - creates it if necessary
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
RXO	getRXO() Returns RXO (RXO - pharmacy/treatment 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)
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)

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

ORR_O02_ORCOBRRQDRQ1RXOODSODTNTECTI

public ORR_O02_ORCOBRRQDRQ1RXOODSODTNTECTI(Group parent,
                                           ModelClassFactory factory)

Creates a new ORR_O02_ORCOBRRQDRQ1RXOODSODTNTECTI 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

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

getRXO

public RXO getRXO()

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

getODS

public ODS getODS()

Returns ODS (ODS - dietary orders, supplements, and preferences segment) - creates it if necessary

getODT

public ODT getODT()

Returns ODT (ODT - diet tray instructions 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)

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

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)