ca.uhn.hl7v2.model.v231.group

Class OMD_O01_ODSNTEOBXNTE

java.lang.Object

ca.uhn.hl7v2.model.AbstractStructure

ca.uhn.hl7v2.model.AbstractGroup

ca.uhn.hl7v2.model.v231.group.OMD_O01_ODSNTEOBXNTE

All Implemented Interfaces:

Group, Structure, Visitable, Serializable

public class OMD_O01_ODSNTEOBXNTE
extends AbstractGroup

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

See Also:

Serialized Form

Field Summary

Fields inherited from class ca.uhn.hl7v2.model.AbstractStructure

log

Constructor Summary

Constructors

Constructor and Description
OMD_O01_ODSNTEOBXNTE(Group parent, ModelClassFactory factory) Creates a new OMD_O01_ODSNTEOBXNTE group

Method Summary

Modifier and Type	Method and Description
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
List<NTE>	getNTEAll() Returns a non-modifiable List containing all current existing repetitions of NTE.
int	getNTEReps() Returns the number of existing repetitions of NTE
OMD_O01_OBXNTE	getOBXNTE() Returns the first repetition of OBXNTE (a Group object) - creates it if necessary
OMD_O01_OBXNTE	getOBXNTE(int rep) Returns a specific repetition of OBXNTE (a Group object) - creates it if necessary
List<OMD_O01_OBXNTE>	getOBXNTEAll() Returns a non-modifiable List containing all current existing repetitions of OBXNTE.
int	getOBXNTEReps() Returns the number of existing repetitions of OBXNTE
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
List<ODS>	getODSAll() Returns a non-modifiable List containing all current existing repetitions of ODS.
int	getODSReps() Returns the number of existing repetitions of ODS
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)
OMD_O01_OBXNTE	insertOBXNTE(int rep) Inserts a specific repetition of OBXNTE (a Group object)
void	insertOBXNTE(OMD_O01_OBXNTE structure, int rep) Inserts a specific repetition of OBXNTE (a Group object)
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)
OMD_O01_OBXNTE	removeOBXNTE(int rep) Removes a specific repetition of OBXNTE (a Group object)
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

accept, add, add, add, addNonstandardSegment, addNonstandardSegment, clear, currentReps, get, get, getAll, getAllAsList, getClass, getFieldNumForName, getModelClassFactory, getName, getNames, getNonStandardNames, getReps, getTyped, getTyped, insert, insert, insertRepetition, insertRepetition, isChoiceElement, isEmpty, isGroup, isRepeating, isRequired, provideLocation, removeRepetition, tryToInstantiateStructure, visitNestedStructures

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

getMessage, getParent

Methods inherited from class java.lang.Object

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

Methods inherited from interface ca.uhn.hl7v2.model.Structure

getMessage, getParent

Constructor Detail

OMD_O01_ODSNTEOBXNTE

public OMD_O01_ODSNTEOBXNTE(Group parent,
                            ModelClassFactory factory)

Creates a new OMD_O01_ODSNTEOBXNTE group

Method Detail

getVersion

public String getVersion()

Returns "2.3.1"

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

getODSAll

public List<ODS> getODSAll()
                    throws HL7Exception

Returns a non-modifiable List containing all current existing repetitions of ODS.

Note that unlike getODS(), this method will not create any reps if none are already present, so an empty list may be returned.

Throws:

HL7Exception

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

getNTEAll

public List<NTE> getNTEAll()
                    throws HL7Exception

Returns a non-modifiable List containing all current existing repetitions of NTE.

Note that unlike getNTE(), this method will not create any reps if none are already present, so an empty list may be returned.

Throws:

HL7Exception

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

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

getOBXNTE

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

getOBXNTEAll

public List<OMD_O01_OBXNTE> getOBXNTEAll()
                                  throws HL7Exception

Returns a non-modifiable List containing all current existing repetitions of OBXNTE.

Note that unlike getOBXNTE(), this method will not create any reps if none are already present, so an empty list may be returned.

Throws:

HL7Exception

insertOBXNTE

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

Removes a specific repetition of OBXNTE (a Group object)

Throws:

HL7Exception

See Also:

AbstractGroup.removeRepetition(String, int)