ca.uhn.hl7v2.model.v231.message

Class OMD_O01

java.lang.Object

ca.uhn.hl7v2.model.AbstractStructure

ca.uhn.hl7v2.model.AbstractGroup

ca.uhn.hl7v2.model.AbstractMessage

ca.uhn.hl7v2.model.v231.message.OMD_O01

All Implemented Interfaces:

Group, Message, Structure, Serializable

public class OMD_O01
extends AbstractMessage

Represents a OMD_O01 message structure (see chapter 4.6). This structure contains the following elements:

• 1: MSH (MSH - message header segment)
• 2: NTE (NTE - notes and comments segment) optional repeating
• 3: OMD_O01_PIDPD1NTEPV1PV2IN1IN2IN3GT1AL1 (a Group object) optional
• 4: OMD_O01_ORCODSNTEOBXNTE (a Group object) repeating
• 5: OMD_O01_ORCODTNTE (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_O01() Creates a new OMD_O01 message with DefaultModelClassFactory.
OMD_O01(ModelClassFactory factory) Creates a new OMD_O01 message with custom ModelClassFactory.

Method Summary

Methods

Modifier and Type	Method and Description
MSH	getMSH() Returns MSH (MSH - message header segment) - creates it if necessary
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_ORCODSNTEOBXNTE	getORCODSNTEOBXNTE() Returns the first repetition of ORCODSNTEOBXNTE (a Group object) - creates it if necessary
OMD_O01_ORCODSNTEOBXNTE	getORCODSNTEOBXNTE(int rep) Returns a specific repetition of ORCODSNTEOBXNTE (a Group object) - creates it if necessary
List<OMD_O01_ORCODSNTEOBXNTE>	getORCODSNTEOBXNTEAll() Returns a non-modifiable List containing all current existing repetitions of ORCODSNTEOBXNTE.
int	getORCODSNTEOBXNTEReps() Returns the number of existing repetitions of ORCODSNTEOBXNTE
OMD_O01_ORCODTNTE	getORCODTNTE() Returns the first repetition of ORCODTNTE (a Group object) - creates it if necessary
OMD_O01_ORCODTNTE	getORCODTNTE(int rep) Returns a specific repetition of ORCODTNTE (a Group object) - creates it if necessary
List<OMD_O01_ORCODTNTE>	getORCODTNTEAll() Returns a non-modifiable List containing all current existing repetitions of ORCODTNTE.
int	getORCODTNTEReps() Returns the number of existing repetitions of ORCODTNTE
OMD_O01_PIDPD1NTEPV1PV2IN1IN2IN3GT1AL1	getPIDPD1NTEPV1PV2IN1IN2IN3GT1AL1() Returns PIDPD1NTEPV1PV2IN1IN2IN3GT1AL1 (a Group object) - 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)
OMD_O01_ORCODSNTEOBXNTE	insertORCODSNTEOBXNTE(int rep) Inserts a specific repetition of ORCODSNTEOBXNTE (a Group object)
void	insertORCODSNTEOBXNTE(OMD_O01_ORCODSNTEOBXNTE structure, int rep) Inserts a specific repetition of ORCODSNTEOBXNTE (a Group object)
OMD_O01_ORCODTNTE	insertORCODTNTE(int rep) Inserts a specific repetition of ORCODTNTE (a Group object)
void	insertORCODTNTE(OMD_O01_ORCODTNTE structure, int rep) Inserts a specific repetition of ORCODTNTE (a Group object)
NTE	removeNTE(int rep) Removes a specific repetition of NTE (NTE - notes and comments segment)
OMD_O01_ORCODSNTEOBXNTE	removeORCODSNTEOBXNTE(int rep) Removes a specific repetition of ORCODSNTEOBXNTE (a Group object)
OMD_O01_ORCODTNTE	removeORCODTNTE(int rep) Removes a specific repetition of ORCODTNTE (a Group object)

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_O01

public OMD_O01()

Creates a new OMD_O01 message with DefaultModelClassFactory.

OMD_O01

public OMD_O01(ModelClassFactory factory)

Creates a new OMD_O01 message with custom ModelClassFactory.

Method Detail

getVersion

public String getVersion()

Returns "2.3.1"

Specified by:

getVersion in interface Message

Overrides:

getVersion in class AbstractMessage

getMSH

public MSH getMSH()

Returns MSH (MSH - message header segment) - creates it if necessary

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)

getPIDPD1NTEPV1PV2IN1IN2IN3GT1AL1

public OMD_O01_PIDPD1NTEPV1PV2IN1IN2IN3GT1AL1 getPIDPD1NTEPV1PV2IN1IN2IN3GT1AL1()

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

getORCODSNTEOBXNTE

public OMD_O01_ORCODSNTEOBXNTE getORCODSNTEOBXNTE()

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

getORCODSNTEOBXNTE

public OMD_O01_ORCODSNTEOBXNTE getORCODSNTEOBXNTE(int rep)

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

getORCODSNTEOBXNTEReps

public int getORCODSNTEOBXNTEReps()

Returns the number of existing repetitions of ORCODSNTEOBXNTE

getORCODSNTEOBXNTEAll

public List<OMD_O01_ORCODSNTEOBXNTE> getORCODSNTEOBXNTEAll()
                                                    throws HL7Exception

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

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

Throws:

HL7Exception

insertORCODSNTEOBXNTE

public void insertORCODSNTEOBXNTE(OMD_O01_ORCODSNTEOBXNTE structure,
                         int rep)
                           throws HL7Exception

Inserts a specific repetition of ORCODSNTEOBXNTE (a Group object)

Throws:

HL7Exception

See Also:

AbstractGroup#insertRepetition(Structure, int)

insertORCODSNTEOBXNTE

public OMD_O01_ORCODSNTEOBXNTE insertORCODSNTEOBXNTE(int rep)
                                              throws HL7Exception

Inserts a specific repetition of ORCODSNTEOBXNTE (a Group object)

Throws:

HL7Exception

See Also:

AbstractGroup#insertRepetition(Structure, int)

removeORCODSNTEOBXNTE

public OMD_O01_ORCODSNTEOBXNTE removeORCODSNTEOBXNTE(int rep)
                                              throws HL7Exception

Removes a specific repetition of ORCODSNTEOBXNTE (a Group object)

Throws:

HL7Exception

See Also:

AbstractGroup#removeRepetition(String, int)

getORCODTNTE

public OMD_O01_ORCODTNTE getORCODTNTE()

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

getORCODTNTE

public OMD_O01_ORCODTNTE getORCODTNTE(int rep)

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

getORCODTNTEReps

public int getORCODTNTEReps()

Returns the number of existing repetitions of ORCODTNTE

getORCODTNTEAll

public List<OMD_O01_ORCODTNTE> getORCODTNTEAll()
                                        throws HL7Exception

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

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

Throws:

HL7Exception

insertORCODTNTE

public void insertORCODTNTE(OMD_O01_ORCODTNTE structure,
                   int rep)
                     throws HL7Exception

Inserts a specific repetition of ORCODTNTE (a Group object)

Throws:

HL7Exception

See Also:

AbstractGroup#insertRepetition(Structure, int)

insertORCODTNTE

public OMD_O01_ORCODTNTE insertORCODTNTE(int rep)
                                  throws HL7Exception

Inserts a specific repetition of ORCODTNTE (a Group object)

Throws:

HL7Exception

See Also:

AbstractGroup#insertRepetition(Structure, int)

removeORCODTNTE

public OMD_O01_ORCODTNTE removeORCODTNTE(int rep)
                                  throws HL7Exception

Removes a specific repetition of ORCODTNTE (a Group object)

Throws:

HL7Exception

See Also:

AbstractGroup#removeRepetition(String, int)