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

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

All Implemented Interfaces:

Group, Structure, Serializable

public class ORD_O02_ORCODSNTE
extends AbstractGroup

Represents a ORD_O02_ORCODSNTE 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: ODS (ODS - dietary orders, supplements, and preferences segment) optional repeating
• 3: NTE (NTE - notes and comments segment) optional repeating

See Also:

Serialized Form

Constructor Summary

ORD_O02_ORCODSNTE(Group parent, ModelClassFactory factory)
Creates a new ORD_O02_ORCODSNTE 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
ODS	getODS() Returns the first repetition of ODS (ODS - dietary orders, supplements, and preferences segment) - creates it if necessary
ODS	getODS(int rep) Returns a specific repetition of ODS (ODS - dietary orders, supplements, and preferences segment) - creates it if necessary
int	getODSReps() Returns the number of existing repetitions of ODS
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)
ODS	insertODS(int rep) Inserts a specific repetition of ODS (ODS - dietary orders, supplements, and preferences segment)
void	insertODS(ODS structure, int rep) Inserts a specific repetition of ODS (ODS - dietary orders, supplements, and preferences segment)
NTE	removeNTE(int rep) Removes a specific repetition of NTE (NTE - notes and comments segment)
ODS	removeODS(int rep) Removes a specific repetition of ODS (ODS - dietary orders, supplements, and preferences 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_ORCODSNTE

public ORD_O02_ORCODSNTE(Group parent,
                         ModelClassFactory factory)

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

getODS

public ODS getODS()

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

getODS

public ODS getODS(int rep)

Returns a specific repetition of ODS (ODS - dietary orders, supplements, and preferences 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.

getODSReps

public int getODSReps()

Returns the number of existing repetitions of ODS

insertODS

public void insertODS(ODS structure,
                      int rep)
               throws HL7Exception

Inserts a specific repetition of ODS (ODS - dietary orders, supplements, and preferences segment)

Throws:

HL7Exception

See Also:

AbstractGroup#insertRepetition(Structure, int)

insertODS

public ODS insertODS(int rep)
              throws HL7Exception

Inserts a specific repetition of ODS (ODS - dietary orders, supplements, and preferences segment)

Throws:

HL7Exception

See Also:

AbstractGroup#insertRepetition(Structure, int)

removeODS

public ODS removeODS(int rep)
              throws HL7Exception

Removes a specific repetition of ODS (ODS - dietary orders, supplements, and preferences 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)