ca.uhn.hl7v2.model.v25.message

Class OUL_R23

java.lang.Object

ca.uhn.hl7v2.model.AbstractStructure

ca.uhn.hl7v2.model.AbstractGroup

ca.uhn.hl7v2.model.AbstractMessage

ca.uhn.hl7v2.model.v25.message.OUL_R23

All Implemented Interfaces:

Group, Message, Structure, Visitable, Serializable

public class OUL_R23
extends AbstractMessage

Represents a OUL_R23 message structure (see chapter 7.3.8). This structure contains the following elements:

• 1: MSH (Message Header)
• 2: SFT (Software Segment) optional repeating
• 3: NTE (Notes and Comments) optional
• 4: OUL_R23_PATIENT (a Group object) optional
• 5: OUL_R23_VISIT (a Group object) optional
• 6: OUL_R23_SPMOBXSACINVOBRORCNTETQ1TQ2OBXTCDSIDNTECTI (a Group object) repeating
• 7: DSC (Continuation Pointer) optional

See Also:

Serialized Form

Field Summary

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

log

Constructor Summary

Constructors

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

Method Summary

Methods

Modifier and Type	Method and Description
DSC	getDSC() Returns DSC (Continuation Pointer) - creates it if necessary
MSH	getMSH() Returns MSH (Message Header) - creates it if necessary
NTE	getNTE() Returns NTE (Notes and Comments) - creates it if necessary
OUL_R23_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
OUL_R23_SPMOBXSACINVOBRORCNTETQ1TQ2OBXTCDSIDNTECTI	getSPMOBXSACINVOBRORCNTETQ1TQ2OBXTCDSIDNTECTI() Returns the first repetition of SPMOBXSACINVOBRORCNTETQ1TQ2OBXTCDSIDNTECTI (a Group object) - creates it if necessary
OUL_R23_SPMOBXSACINVOBRORCNTETQ1TQ2OBXTCDSIDNTECTI	getSPMOBXSACINVOBRORCNTETQ1TQ2OBXTCDSIDNTECTI(int rep) Returns a specific repetition of SPMOBXSACINVOBRORCNTETQ1TQ2OBXTCDSIDNTECTI (a Group object) - creates it if necessary
List<OUL_R23_SPMOBXSACINVOBRORCNTETQ1TQ2OBXTCDSIDNTECTI>	getSPMOBXSACINVOBRORCNTETQ1TQ2OBXTCDSIDNTECTIAll() Returns a non-modifiable List containing all current existing repetitions of SPMOBXSACINVOBRORCNTETQ1TQ2OBXTCDSIDNTECTI.
int	getSPMOBXSACINVOBRORCNTETQ1TQ2OBXTCDSIDNTECTIReps() Returns the number of existing repetitions of SPMOBXSACINVOBRORCNTETQ1TQ2OBXTCDSIDNTECTI
String	getVersion() Returns "2.5"
OUL_R23_VISIT	getVISIT() Returns VISIT (a Group object) - creates it if necessary
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)
OUL_R23_SPMOBXSACINVOBRORCNTETQ1TQ2OBXTCDSIDNTECTI	insertSPMOBXSACINVOBRORCNTETQ1TQ2OBXTCDSIDNTECTI(int rep) Inserts a specific repetition of SPMOBXSACINVOBRORCNTETQ1TQ2OBXTCDSIDNTECTI (a Group object)
void	insertSPMOBXSACINVOBRORCNTETQ1TQ2OBXTCDSIDNTECTI(OUL_R23_SPMOBXSACINVOBRORCNTETQ1TQ2OBXTCDSIDNTECTI structure, int rep) Inserts a specific repetition of SPMOBXSACINVOBRORCNTETQ1TQ2OBXTCDSIDNTECTI (a Group object)
SFT	removeSFT(int rep) Removes a specific repetition of SFT (Software Segment)
OUL_R23_SPMOBXSACINVOBRORCNTETQ1TQ2OBXTCDSIDNTECTI	removeSPMOBXSACINVOBRORCNTETQ1TQ2OBXTCDSIDNTECTI(int rep) Removes a specific repetition of SPMOBXSACINVOBRORCNTETQ1TQ2OBXTCDSIDNTECTI (a Group object)

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

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

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

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 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, isChoiceElement, isGroup, isRepeating, isRequired

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

getName

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

isEmpty, provideLocation

Constructor Detail

OUL_R23

public OUL_R23()

Creates a new OUL_R23 message with DefaultModelClassFactory.

OUL_R23

public OUL_R23(ModelClassFactory factory)

Creates a new OUL_R23 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 NTE (Notes and Comments) - creates it if necessary

getPATIENT

public OUL_R23_PATIENT getPATIENT()

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

getVISIT

public OUL_R23_VISIT getVISIT()

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

getSPMOBXSACINVOBRORCNTETQ1TQ2OBXTCDSIDNTECTI

public OUL_R23_SPMOBXSACINVOBRORCNTETQ1TQ2OBXTCDSIDNTECTI getSPMOBXSACINVOBRORCNTETQ1TQ2OBXTCDSIDNTECTI()

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

getSPMOBXSACINVOBRORCNTETQ1TQ2OBXTCDSIDNTECTI

public OUL_R23_SPMOBXSACINVOBRORCNTETQ1TQ2OBXTCDSIDNTECTI getSPMOBXSACINVOBRORCNTETQ1TQ2OBXTCDSIDNTECTI(int rep)

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

getSPMOBXSACINVOBRORCNTETQ1TQ2OBXTCDSIDNTECTIReps

public int getSPMOBXSACINVOBRORCNTETQ1TQ2OBXTCDSIDNTECTIReps()

Returns the number of existing repetitions of SPMOBXSACINVOBRORCNTETQ1TQ2OBXTCDSIDNTECTI

getSPMOBXSACINVOBRORCNTETQ1TQ2OBXTCDSIDNTECTIAll

public List<OUL_R23_SPMOBXSACINVOBRORCNTETQ1TQ2OBXTCDSIDNTECTI> getSPMOBXSACINVOBRORCNTETQ1TQ2OBXTCDSIDNTECTIAll()
                                                                                                          throws HL7Exception

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

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

Throws:

HL7Exception

insertSPMOBXSACINVOBRORCNTETQ1TQ2OBXTCDSIDNTECTI

public void insertSPMOBXSACINVOBRORCNTETQ1TQ2OBXTCDSIDNTECTI(OUL_R23_SPMOBXSACINVOBRORCNTETQ1TQ2OBXTCDSIDNTECTI structure,
                                                    int rep)
                                                      throws HL7Exception

Inserts a specific repetition of SPMOBXSACINVOBRORCNTETQ1TQ2OBXTCDSIDNTECTI (a Group object)

Throws:

HL7Exception

See Also:

AbstractGroup#insertRepetition(Structure, int)

insertSPMOBXSACINVOBRORCNTETQ1TQ2OBXTCDSIDNTECTI

public OUL_R23_SPMOBXSACINVOBRORCNTETQ1TQ2OBXTCDSIDNTECTI insertSPMOBXSACINVOBRORCNTETQ1TQ2OBXTCDSIDNTECTI(int rep)
                                                                                                    throws HL7Exception

Inserts a specific repetition of SPMOBXSACINVOBRORCNTETQ1TQ2OBXTCDSIDNTECTI (a Group object)

Throws:

HL7Exception

See Also:

AbstractGroup#insertRepetition(Structure, int)

removeSPMOBXSACINVOBRORCNTETQ1TQ2OBXTCDSIDNTECTI

public OUL_R23_SPMOBXSACINVOBRORCNTETQ1TQ2OBXTCDSIDNTECTI removeSPMOBXSACINVOBRORCNTETQ1TQ2OBXTCDSIDNTECTI(int rep)
                                                                                                    throws HL7Exception

Removes a specific repetition of SPMOBXSACINVOBRORCNTETQ1TQ2OBXTCDSIDNTECTI (a Group object)

Throws:

HL7Exception

See Also:

AbstractGroup.removeRepetition(String, int)

getDSC

public DSC getDSC()

Returns DSC (Continuation Pointer) - creates it if necessary