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

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

All Implemented Interfaces:

Group, Structure, Serializable

public class ORM_O01_OBRRQDRQ1ODSODTRXONTEDG1RXRRXCNTEOBXNTE
extends AbstractGroup

Represents a ORM_O01_OBRRQDRQ1ODSODTRXONTEDG1RXRRXCNTEOBXNTE 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: RQD (RQD - requisition detail segment)
• 3: RQ1 (RQ1 - requisition detail-1 segment)
• 4: ODS (ODS - dietary orders, supplements, and preferences segment)
• 5: ODT (ODT - diet tray instructions segment)
• 6: RXO (RXO - pharmacy/treatment order segment)
• 7: NTE (NTE - notes and comments segment) optional repeating
• 8: DG1 (DG1 - diagnosis segment) optional repeating
• 9: RXR (RXR - pharmacy/treatment route segment) repeating
• 10: ORM_O01_RXCNTE (a Group object) optional
• 11: ORM_O01_OBXNTE (a Group object) optional repeating

See Also:

Serialized Form

Constructor Summary

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

Method Summary

DG1	getDG1() Returns the first repetition of DG1 (DG1 - diagnosis segment) - creates it if necessary
DG1	getDG1(int rep) Returns a specific repetition of DG1 (DG1 - diagnosis segment) - creates it if necessary
int	getDG1Reps() Returns the number of existing repetitions of DG1
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
ORM_O01_OBXNTE	getOBXNTE() Returns the first repetition of OBXNTE (a Group object) - creates it if necessary
ORM_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
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
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
ORM_O01_RXCNTE	getRXCNTE() Returns RXCNTE (a Group object) - creates it if necessary
RXO	getRXO() Returns RXO (RXO - pharmacy/treatment order segment) - creates it if necessary
RXR	getRXR() Returns the first repetition of RXR (RXR - pharmacy/treatment route segment) - creates it if necessary
RXR	getRXR(int rep) Returns a specific repetition of RXR (RXR - pharmacy/treatment route segment) - creates it if necessary
int	getRXRReps() Returns the number of existing repetitions of RXR
String	getVersion() Returns "2.3.1"
void	insertDG1(DG1 structure, int rep) Inserts a specific repetition of DG1 (DG1 - diagnosis segment)
DG1	insertDG1(int rep) Inserts a specific repetition of DG1 (DG1 - diagnosis 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)
ORM_O01_OBXNTE	insertOBXNTE(int rep) Inserts a specific repetition of OBXNTE (a Group object)
void	insertOBXNTE(ORM_O01_OBXNTE structure, int rep) Inserts a specific repetition of OBXNTE (a Group object)
RXR	insertRXR(int rep) Inserts a specific repetition of RXR (RXR - pharmacy/treatment route segment)
void	insertRXR(RXR structure, int rep) Inserts a specific repetition of RXR (RXR - pharmacy/treatment route segment)
DG1	removeDG1(int rep) Removes a specific repetition of DG1 (DG1 - diagnosis segment)
NTE	removeNTE(int rep) Removes a specific repetition of NTE (NTE - notes and comments segment)
ORM_O01_OBXNTE	removeOBXNTE(int rep) Removes a specific repetition of OBXNTE (a Group object)
RXR	removeRXR(int rep) Removes a specific repetition of RXR (RXR - pharmacy/treatment route 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

ORM_O01_OBRRQDRQ1ODSODTRXONTEDG1RXRRXCNTEOBXNTE

public ORM_O01_OBRRQDRQ1ODSODTRXONTEDG1RXRRXCNTEOBXNTE(Group parent,
                                                       ModelClassFactory factory)

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

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

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

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

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)

getDG1

public DG1 getDG1()

Returns the first repetition of DG1 (DG1 - diagnosis segment) - creates it if necessary

getDG1

public DG1 getDG1(int rep)

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

getDG1Reps

public int getDG1Reps()

Returns the number of existing repetitions of DG1

insertDG1

public void insertDG1(DG1 structure,
                      int rep)
               throws HL7Exception

Inserts a specific repetition of DG1 (DG1 - diagnosis segment)

Throws:

HL7Exception

See Also:

AbstractGroup#insertRepetition(Structure, int)

insertDG1

public DG1 insertDG1(int rep)
              throws HL7Exception

Inserts a specific repetition of DG1 (DG1 - diagnosis segment)

Throws:

HL7Exception

See Also:

AbstractGroup#insertRepetition(Structure, int)

removeDG1

public DG1 removeDG1(int rep)
              throws HL7Exception

Removes a specific repetition of DG1 (DG1 - diagnosis segment)

Throws:

HL7Exception

See Also:

AbstractGroup.removeRepetition(String, int)

getRXR

public RXR getRXR()

Returns the first repetition of RXR (RXR - pharmacy/treatment route segment) - creates it if necessary

getRXR

public RXR getRXR(int rep)

Returns a specific repetition of RXR (RXR - pharmacy/treatment route 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.

getRXRReps

public int getRXRReps()

Returns the number of existing repetitions of RXR

insertRXR

public void insertRXR(RXR structure,
                      int rep)
               throws HL7Exception

Inserts a specific repetition of RXR (RXR - pharmacy/treatment route segment)

Throws:

HL7Exception

See Also:

AbstractGroup#insertRepetition(Structure, int)

insertRXR

public RXR insertRXR(int rep)
              throws HL7Exception

Inserts a specific repetition of RXR (RXR - pharmacy/treatment route segment)

Throws:

HL7Exception

See Also:

AbstractGroup#insertRepetition(Structure, int)

removeRXR

public RXR removeRXR(int rep)
              throws HL7Exception

Removes a specific repetition of RXR (RXR - pharmacy/treatment route segment)

Throws:

HL7Exception

See Also:

AbstractGroup.removeRepetition(String, int)

getRXCNTE

public ORM_O01_RXCNTE getRXCNTE()

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

getOBXNTE

public ORM_O01_OBXNTE getOBXNTE()

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

getOBXNTE

public ORM_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(ORM_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 ORM_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 ORM_O01_OBXNTE removeOBXNTE(int rep)
                            throws HL7Exception

Removes a specific repetition of OBXNTE (a Group object)

Throws:

HL7Exception

See Also:

AbstractGroup.removeRepetition(String, int)