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

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

All Implemented Interfaces:

Group, Structure, Serializable

public class ORD_O02_ORCODTNTE
extends AbstractGroup

Represents a ORD_O02_ORCODTNTE 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: ODT (ODT - diet tray instructions segment) optional repeating
• 3: NTE (NTE - notes and comments segment) optional repeating

See Also:

Serialized Form

Constructor Summary

ORD_O02_ORCODTNTE(Group parent, ModelClassFactory factory)
Creates a new ORD_O02_ORCODTNTE 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
ODT	getODT() Returns the first repetition of ODT (ODT - diet tray instructions segment) - creates it if necessary
ODT	getODT(int rep) Returns a specific repetition of ODT (ODT - diet tray instructions segment) - creates it if necessary
int	getODTReps() Returns the number of existing repetitions of ODT
ORC	getORC() Returns ORC (ORC - common order 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)
ODT	insertODT(int rep) Inserts a specific repetition of ODT (ODT - diet tray instructions segment)
void	insertODT(ODT structure, int rep) Inserts a specific repetition of ODT (ODT - diet tray instructions segment)
NTE	removeNTE(int rep) Removes a specific repetition of NTE (NTE - notes and comments segment)
ODT	removeODT(int rep) Removes a specific repetition of ODT (ODT - diet tray instructions 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

ORD_O02_ORCODTNTE

public ORD_O02_ORCODTNTE(Group parent,
                         ModelClassFactory factory)

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

getODT

public ODT getODT()

Returns the first repetition of ODT (ODT - diet tray instructions segment) - creates it if necessary

getODT

public ODT getODT(int rep)

Returns a specific repetition of ODT (ODT - diet tray instructions 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.

getODTReps

public int getODTReps()

Returns the number of existing repetitions of ODT

insertODT

public void insertODT(ODT structure,
                      int rep)
               throws HL7Exception

Inserts a specific repetition of ODT (ODT - diet tray instructions segment)

Throws:

HL7Exception

See Also:

AbstractGroup#insertRepetition(Structure, int)

insertODT

public ODT insertODT(int rep)
              throws HL7Exception

Inserts a specific repetition of ODT (ODT - diet tray instructions segment)

Throws:

HL7Exception

See Also:

AbstractGroup#insertRepetition(Structure, int)

removeODT

public ODT removeODT(int rep)
              throws HL7Exception

Removes a specific repetition of ODT (ODT - diet tray instructions segment)

Throws:

HL7Exception

See Also:

AbstractGroup.removeRepetition(String, int)

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)