ca.uhn.hl7v2.model.v25.message

Class OMD_O03

java.lang.Object

ca.uhn.hl7v2.model.AbstractStructure

ca.uhn.hl7v2.model.AbstractGroup

ca.uhn.hl7v2.model.AbstractMessage

ca.uhn.hl7v2.model.v25.message.OMD_O03

All Implemented Interfaces:

Group, Message, Structure, Serializable

public class OMD_O03
extends AbstractMessage

Represents a OMD_O03 message structure (see chapter 4.7.1). This structure contains the following elements:

• 1: MSH (Message Header)
• 2: SFT (Software Segment) optional repeating
• 3: NTE (Notes and Comments) optional repeating
• 4: OMD_O03_PATIENT (a Group object) optional
• 5: OMD_O03_ORDER_DIET (a Group object) repeating
• 6: OMD_O03_ORDER_TRAY (a Group object) optional repeating

See Also:

Serialized Form

Field Summary

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

log

Constructor Summary

Constructors

Constructor and Description
OMD_O03() Creates a new OMD_O03 message with DefaultModelClassFactory.
OMD_O03(ModelClassFactory factory) Creates a new OMD_O03 message with custom ModelClassFactory.

Method Summary

Methods

Modifier and Type	Method and Description
MSH	getMSH() Returns MSH (Message Header) - creates it if necessary
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
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_O03_ORDER_DIET	getORDER_DIET() Returns the first repetition of ORDER_DIET (a Group object) - creates it if necessary
OMD_O03_ORDER_DIET	getORDER_DIET(int rep) Returns a specific repetition of ORDER_DIET (a Group object) - creates it if necessary
List<OMD_O03_ORDER_DIET>	getORDER_DIETAll() Returns a non-modifiable List containing all current existing repetitions of ORDER_DIET.
int	getORDER_DIETReps() Returns the number of existing repetitions of ORDER_DIET
OMD_O03_ORDER_TRAY	getORDER_TRAY() Returns the first repetition of ORDER_TRAY (a Group object) - creates it if necessary
OMD_O03_ORDER_TRAY	getORDER_TRAY(int rep) Returns a specific repetition of ORDER_TRAY (a Group object) - creates it if necessary
List<OMD_O03_ORDER_TRAY>	getORDER_TRAYAll() Returns a non-modifiable List containing all current existing repetitions of ORDER_TRAY.
int	getORDER_TRAYReps() Returns the number of existing repetitions of ORDER_TRAY
OMD_O03_PATIENT	getPATIENT() Returns PATIENT (a Group object) - creates it if necessary
SFT	getSFT() Returns the first repetition of SFT (Software Segment) - creates it if necessary
SFT	getSFT(int rep) Returns a specific repetition of SFT (Software Segment) - creates it if necessary
List<SFT>	getSFTAll() Returns a non-modifiable List containing all current existing repetitions of SFT.
int	getSFTReps() Returns the number of existing repetitions of SFT
String	getVersion() Returns "2.5"
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_ORDER_DIET	insertORDER_DIET(int rep) Inserts a specific repetition of ORDER_DIET (a Group object)
void	insertORDER_DIET(OMD_O03_ORDER_DIET structure, int rep) Inserts a specific repetition of ORDER_DIET (a Group object)
OMD_O03_ORDER_TRAY	insertORDER_TRAY(int rep) Inserts a specific repetition of ORDER_TRAY (a Group object)
void	insertORDER_TRAY(OMD_O03_ORDER_TRAY structure, int rep) Inserts a specific repetition of ORDER_TRAY (a Group object)
SFT	insertSFT(int rep) Inserts a specific repetition of SFT (Software Segment)
void	insertSFT(SFT structure, int rep) Inserts a specific repetition of SFT (Software Segment)
NTE	removeNTE(int rep) Removes a specific repetition of NTE (Notes and Comments)
OMD_O03_ORDER_DIET	removeORDER_DIET(int rep) Removes a specific repetition of ORDER_DIET (a Group object)
OMD_O03_ORDER_TRAY	removeORDER_TRAY(int rep) Removes a specific repetition of ORDER_TRAY (a Group object)
SFT	removeSFT(int rep) Removes a specific repetition of SFT (Software Segment)

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

encode, generateACK, generateACK, getEncodingCharactersValue, getFieldSeparatorValue, getMessage, getParent, getParser, getValidationContext, initQuickstart, parse, printStructure, setParser, setValidationContext, toString

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

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

Methods inherited from class java.lang.Object

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

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

addNonstandardSegment, addNonstandardSegment, get, get, getAll, getClass, getNames, isGroup, isRepeating, isRequired

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

getName

Constructor Detail

OMD_O03

public OMD_O03()

Creates a new OMD_O03 message with DefaultModelClassFactory.

OMD_O03

public OMD_O03(ModelClassFactory factory)

Creates a new OMD_O03 message with custom ModelClassFactory.

Method Detail

getVersion

public String getVersion()

Returns "2.5"

Specified by:

getVersion in interface Message

Overrides:

getVersion in class AbstractMessage

getMSH

public MSH getMSH()

Returns MSH (Message Header) - creates it if necessary

getSFT

public SFT getSFT()

Returns the first repetition of SFT (Software Segment) - creates it if necessary

getSFT

public SFT getSFT(int rep)

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

getSFTReps

public int getSFTReps()

Returns the number of existing repetitions of SFT

getSFTAll

public List<SFT> getSFTAll()
                    throws HL7Exception

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

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

Throws:

HL7Exception

insertSFT

public void insertSFT(SFT structure,
             int rep)
               throws HL7Exception

Inserts a specific repetition of SFT (Software Segment)

Throws:

HL7Exception

See Also:

AbstractGroup#insertRepetition(Structure, int)

insertSFT

public SFT insertSFT(int rep)
              throws HL7Exception

Inserts a specific repetition of SFT (Software Segment)

Throws:

HL7Exception

See Also:

AbstractGroup#insertRepetition(Structure, int)

removeSFT

public SFT removeSFT(int rep)
              throws HL7Exception

Removes a specific repetition of SFT (Software Segment)

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

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

getPATIENT

public OMD_O03_PATIENT getPATIENT()

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

getORDER_DIET

public OMD_O03_ORDER_DIET getORDER_DIET()

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

getORDER_DIET

public OMD_O03_ORDER_DIET getORDER_DIET(int rep)

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

getORDER_DIETReps

public int getORDER_DIETReps()

Returns the number of existing repetitions of ORDER_DIET

getORDER_DIETAll

public List<OMD_O03_ORDER_DIET> getORDER_DIETAll()
                                          throws HL7Exception

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

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

Throws:

HL7Exception

insertORDER_DIET

public void insertORDER_DIET(OMD_O03_ORDER_DIET structure,
                    int rep)
                      throws HL7Exception

Inserts a specific repetition of ORDER_DIET (a Group object)

Throws:

HL7Exception

See Also:

AbstractGroup#insertRepetition(Structure, int)

insertORDER_DIET

public OMD_O03_ORDER_DIET insertORDER_DIET(int rep)
                                    throws HL7Exception

Inserts a specific repetition of ORDER_DIET (a Group object)

Throws:

HL7Exception

See Also:

AbstractGroup#insertRepetition(Structure, int)

removeORDER_DIET

public OMD_O03_ORDER_DIET removeORDER_DIET(int rep)
                                    throws HL7Exception

Removes a specific repetition of ORDER_DIET (a Group object)

Throws:

HL7Exception

See Also:

AbstractGroup#removeRepetition(String, int)

getORDER_TRAY

public OMD_O03_ORDER_TRAY getORDER_TRAY()

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

getORDER_TRAY

public OMD_O03_ORDER_TRAY getORDER_TRAY(int rep)

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

getORDER_TRAYReps

public int getORDER_TRAYReps()

Returns the number of existing repetitions of ORDER_TRAY

getORDER_TRAYAll

public List<OMD_O03_ORDER_TRAY> getORDER_TRAYAll()
                                          throws HL7Exception

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

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

Throws:

HL7Exception

insertORDER_TRAY

public void insertORDER_TRAY(OMD_O03_ORDER_TRAY structure,
                    int rep)
                      throws HL7Exception

Inserts a specific repetition of ORDER_TRAY (a Group object)

Throws:

HL7Exception

See Also:

AbstractGroup#insertRepetition(Structure, int)

insertORDER_TRAY

public OMD_O03_ORDER_TRAY insertORDER_TRAY(int rep)
                                    throws HL7Exception

Inserts a specific repetition of ORDER_TRAY (a Group object)

Throws:

HL7Exception

See Also:

AbstractGroup#insertRepetition(Structure, int)

removeORDER_TRAY

public OMD_O03_ORDER_TRAY removeORDER_TRAY(int rep)
                                    throws HL7Exception

Removes a specific repetition of ORDER_TRAY (a Group object)

Throws:

HL7Exception

See Also:

AbstractGroup#removeRepetition(String, int)