ca.uhn.hl7v2.model.v24.group
Class OMD_O03_DIET

java.lang.Object
  ca.uhn.hl7v2.model.AbstractGroup
      ca.uhn.hl7v2.model.v24.group.OMD_O03_DIET

All Implemented Interfaces:

Group, Structure, Serializable

public class OMD_O03_DIET
extends AbstractGroup

Represents a OMD_O03_DIET 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 (Dietary Orders, Supplements, and Preferences) repeating
• 2: NTE (Notes and Comments) optional repeating
• 3: OMD_O03_OBSERVATION (a Group object) optional repeating

See Also:

Serialized Form

Constructor Summary

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

Method Summary

NTE	getNTE() Returns the first repetition of NTE (Notes and Comments) - creates it if necessary
NTE	getNTE(int rep) Returns a specific repetition of NTE (Notes and Comments) - creates it if necessary
int	getNTEReps() Returns the number of existing repetitions of NTE
OMD_O03_OBSERVATION	getOBSERVATION() Returns the first repetition of OBSERVATION (a Group object) - creates it if necessary
OMD_O03_OBSERVATION	getOBSERVATION(int rep) Returns a specific repetition of OBSERVATION (a Group object) - creates it if necessary
int	getOBSERVATIONReps() Returns the number of existing repetitions of OBSERVATION
ODS	getODS() Returns the first repetition of ODS (Dietary Orders, Supplements, and Preferences) - creates it if necessary
ODS	getODS(int rep) Returns a specific repetition of ODS (Dietary Orders, Supplements, and Preferences) - creates it if necessary
int	getODSReps() Returns the number of existing repetitions of ODS
String	getVersion() Returns "2.4"
NTE	insertNTE(int rep) Inserts a specific repetition of NTE (Notes and Comments)
void	insertNTE(NTE structure, int rep) Inserts a specific repetition of NTE (Notes and Comments)
OMD_O03_OBSERVATION	insertOBSERVATION(int rep) Inserts a specific repetition of OBSERVATION (a Group object)
void	insertOBSERVATION(OMD_O03_OBSERVATION structure, int rep) Inserts a specific repetition of OBSERVATION (a Group object)
ODS	insertODS(int rep) Inserts a specific repetition of ODS (Dietary Orders, Supplements, and Preferences)
void	insertODS(ODS structure, int rep) Inserts a specific repetition of ODS (Dietary Orders, Supplements, and Preferences)
NTE	removeNTE(int rep) Removes a specific repetition of NTE (Notes and Comments)
OMD_O03_OBSERVATION	removeOBSERVATION(int rep) Removes a specific repetition of OBSERVATION (a Group object)
ODS	removeODS(int rep) Removes a specific repetition of ODS (Dietary Orders, Supplements, and Preferences)

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

OMD_O03_DIET

public OMD_O03_DIET(Group parent,
                    ModelClassFactory factory)

Creates a new OMD_O03_DIET group

Method Detail

getVersion

public String getVersion()

Returns "2.4"

getODS

public ODS getODS()

Returns the first repetition of ODS (Dietary Orders, Supplements, and Preferences) - creates it if necessary

getODS

public ODS getODS(int rep)

Returns a specific repetition of ODS (Dietary Orders, Supplements, and Preferences) - 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 (Dietary Orders, Supplements, and Preferences)

Throws:

HL7Exception

See Also:

AbstractGroup#insertRepetition(Structure, int)

insertODS

public ODS insertODS(int rep)
              throws HL7Exception

Inserts a specific repetition of ODS (Dietary Orders, Supplements, and Preferences)

Throws:

HL7Exception

See Also:

AbstractGroup#insertRepetition(Structure, int)

removeODS

public ODS removeODS(int rep)
              throws HL7Exception

Removes a specific repetition of ODS (Dietary Orders, Supplements, and Preferences)

Throws:

HL7Exception

See Also:

AbstractGroup.removeRepetition(String, int)

getNTE

public NTE getNTE()

Returns the first repetition of NTE (Notes and Comments) - creates it if necessary

getNTE

public NTE getNTE(int rep)

Returns a specific repetition of NTE (Notes and Comments) - 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 (Notes and Comments)

Throws:

HL7Exception

See Also:

AbstractGroup#insertRepetition(Structure, int)

insertNTE

public NTE insertNTE(int rep)
              throws HL7Exception

Inserts a specific repetition of NTE (Notes and Comments)

Throws:

HL7Exception

See Also:

AbstractGroup#insertRepetition(Structure, int)

removeNTE

public NTE removeNTE(int rep)
              throws HL7Exception

Removes a specific repetition of NTE (Notes and Comments)

Throws:

HL7Exception

See Also:

AbstractGroup.removeRepetition(String, int)

getOBSERVATION

public OMD_O03_OBSERVATION getOBSERVATION()

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

getOBSERVATION

public OMD_O03_OBSERVATION getOBSERVATION(int rep)

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

getOBSERVATIONReps

public int getOBSERVATIONReps()

Returns the number of existing repetitions of OBSERVATION

insertOBSERVATION

public void insertOBSERVATION(OMD_O03_OBSERVATION structure,
                              int rep)
                       throws HL7Exception

Inserts a specific repetition of OBSERVATION (a Group object)

Throws:

HL7Exception

See Also:

AbstractGroup#insertRepetition(Structure, int)

insertOBSERVATION

public OMD_O03_OBSERVATION insertOBSERVATION(int rep)
                                      throws HL7Exception

Inserts a specific repetition of OBSERVATION (a Group object)

Throws:

HL7Exception

See Also:

AbstractGroup#insertRepetition(Structure, int)

removeOBSERVATION

public OMD_O03_OBSERVATION removeOBSERVATION(int rep)
                                      throws HL7Exception

Removes a specific repetition of OBSERVATION (a Group object)

Throws:

HL7Exception

See Also:

AbstractGroup.removeRepetition(String, int)