ca.uhn.hl7v2.model.v26.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.v26.message.OUL_R23

All Implemented Interfaces:

Group, Message, Structure, 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: UAC (User Authentication Credential Segment) optional
• 4: NTE (Notes and Comments) optional
• 5: OUL_R23_PATIENT (a Group object) optional
• 6: NK1 (Next of Kin / Associated Parties) optional repeating
• 7: OUL_R23_SPECIMEN (a Group object) repeating
• 8: 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
NK1	getNK1() Returns the first repetition of NK1 (Next of Kin / Associated Parties) - creates it if necessary
NK1	getNK1(int rep) Returns a specific repetition of NK1 (Next of Kin / Associated Parties) - creates it if necessary
List<NK1>	getNK1All() Returns a non-modifiable List containing all current existing repetitions of NK1.
int	getNK1Reps() Returns the number of existing repetitions of NK1
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_SPECIMEN	getSPECIMEN() Returns the first repetition of SPECIMEN (a Group object) - creates it if necessary
OUL_R23_SPECIMEN	getSPECIMEN(int rep) Returns a specific repetition of SPECIMEN (a Group object) - creates it if necessary
List<OUL_R23_SPECIMEN>	getSPECIMENAll() Returns a non-modifiable List containing all current existing repetitions of SPECIMEN.
int	getSPECIMENReps() Returns the number of existing repetitions of SPECIMEN
UAC	getUAC() Returns UAC (User Authentication Credential Segment) - creates it if necessary
String	getVersion() Returns "2.6"
NK1	insertNK1(int rep) Inserts a specific repetition of NK1 (Next of Kin / Associated Parties)
void	insertNK1(NK1 structure, int rep) Inserts a specific repetition of NK1 (Next of Kin / Associated Parties)
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_SPECIMEN	insertSPECIMEN(int rep) Inserts a specific repetition of SPECIMEN (a Group object)
void	insertSPECIMEN(OUL_R23_SPECIMEN structure, int rep) Inserts a specific repetition of SPECIMEN (a Group object)
NK1	removeNK1(int rep) Removes a specific repetition of NK1 (Next of Kin / Associated Parties)
SFT	removeSFT(int rep) Removes a specific repetition of SFT (Software Segment)
OUL_R23_SPECIMEN	removeSPECIMEN(int rep) Removes a specific repetition of SPECIMEN (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

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.6"

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)

getUAC

public UAC getUAC()

Returns UAC (User Authentication Credential Segment) - creates it if necessary

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

getNK1

public NK1 getNK1()

Returns the first repetition of NK1 (Next of Kin / Associated Parties) - creates it if necessary

getNK1

public NK1 getNK1(int rep)

Returns a specific repetition of NK1 (Next of Kin / Associated Parties) - 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.

getNK1Reps

public int getNK1Reps()

Returns the number of existing repetitions of NK1

getNK1All

public List<NK1> getNK1All()
                    throws HL7Exception

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

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

Throws:

HL7Exception

insertNK1

public void insertNK1(NK1 structure,
             int rep)
               throws HL7Exception

Inserts a specific repetition of NK1 (Next of Kin / Associated Parties)

Throws:

HL7Exception

See Also:

AbstractGroup#insertRepetition(Structure, int)

insertNK1

public NK1 insertNK1(int rep)
              throws HL7Exception

Inserts a specific repetition of NK1 (Next of Kin / Associated Parties)

Throws:

HL7Exception

See Also:

AbstractGroup#insertRepetition(Structure, int)

removeNK1

public NK1 removeNK1(int rep)
              throws HL7Exception

Removes a specific repetition of NK1 (Next of Kin / Associated Parties)

Throws:

HL7Exception

See Also:

AbstractGroup#removeRepetition(String, int)

getSPECIMEN

public OUL_R23_SPECIMEN getSPECIMEN()

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

getSPECIMEN

public OUL_R23_SPECIMEN getSPECIMEN(int rep)

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

getSPECIMENReps

public int getSPECIMENReps()

Returns the number of existing repetitions of SPECIMEN

getSPECIMENAll

public List<OUL_R23_SPECIMEN> getSPECIMENAll()
                                      throws HL7Exception

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

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

Throws:

HL7Exception

insertSPECIMEN

public void insertSPECIMEN(OUL_R23_SPECIMEN structure,
                  int rep)
                    throws HL7Exception

Inserts a specific repetition of SPECIMEN (a Group object)

Throws:

HL7Exception

See Also:

AbstractGroup#insertRepetition(Structure, int)

insertSPECIMEN

public OUL_R23_SPECIMEN insertSPECIMEN(int rep)
                                throws HL7Exception

Inserts a specific repetition of SPECIMEN (a Group object)

Throws:

HL7Exception

See Also:

AbstractGroup#insertRepetition(Structure, int)

removeSPECIMEN

public OUL_R23_SPECIMEN removeSPECIMEN(int rep)
                                throws HL7Exception

Removes a specific repetition of SPECIMEN (a Group object)

Throws:

HL7Exception

See Also:

AbstractGroup#removeRepetition(String, int)

getDSC

public DSC getDSC()

Returns DSC (Continuation Pointer) - creates it if necessary