ca.uhn.hl7v2.model.v26.message

Class OPU_R25

java.lang.Object

ca.uhn.hl7v2.model.AbstractStructure

ca.uhn.hl7v2.model.AbstractGroup

ca.uhn.hl7v2.model.AbstractMessage

ca.uhn.hl7v2.model.v26.message.OPU_R25

All Implemented Interfaces:

Group, Message, Structure, Serializable

public class OPU_R25
extends AbstractMessage

Represents a OPU_R25 message structure (see chapter 7.3.10). 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: PV1 (Patient Visit)
• 6: PV2 (Patient Visit - Additional Information) optional
• 7: OBX (Observation/Result) optional repeating
• 8: NTE (Notes and Comments) optional repeating
• 9: ROL (Role) repeating
• 10: OPU_R25_ACCESSION_DETAIL (a Group object) repeating

See Also:

Serialized Form

Field Summary

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

log

Constructor Summary

Constructors

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

Method Summary

Methods

Modifier and Type	Method and Description
OPU_R25_ACCESSION_DETAIL	getACCESSION_DETAIL() Returns the first repetition of ACCESSION_DETAIL (a Group object) - creates it if necessary
OPU_R25_ACCESSION_DETAIL	getACCESSION_DETAIL(int rep) Returns a specific repetition of ACCESSION_DETAIL (a Group object) - creates it if necessary
List<OPU_R25_ACCESSION_DETAIL>	getACCESSION_DETAILAll() Returns a non-modifiable List containing all current existing repetitions of ACCESSION_DETAIL.
int	getACCESSION_DETAILReps() Returns the number of existing repetitions of ACCESSION_DETAIL
MSH	getMSH() Returns MSH (Message Header) - creates it if necessary
NTE	getNTE() Returns NTE (Notes and Comments) - creates it if necessary
NTE	getNTE2() Returns the first repetition of NTE2 (Notes and Comments) - creates it if necessary
NTE	getNTE2(int rep) Returns a specific repetition of NTE2 (Notes and Comments) - creates it if necessary
List<NTE>	getNTE2All() Returns a non-modifiable List containing all current existing repetitions of NTE2.
int	getNTE2Reps() Returns the number of existing repetitions of NTE2
OBX	getOBX() Returns the first repetition of OBX (Observation/Result) - creates it if necessary
OBX	getOBX(int rep) Returns a specific repetition of OBX (Observation/Result) - creates it if necessary
List<OBX>	getOBXAll() Returns a non-modifiable List containing all current existing repetitions of OBX.
int	getOBXReps() Returns the number of existing repetitions of OBX
PV1	getPV1() Returns PV1 (Patient Visit) - creates it if necessary
PV2	getPV2() Returns PV2 (Patient Visit - Additional Information) - creates it if necessary
ROL	getROL() Returns the first repetition of ROL (Role) - creates it if necessary
ROL	getROL(int rep) Returns a specific repetition of ROL (Role) - creates it if necessary
List<ROL>	getROLAll() Returns a non-modifiable List containing all current existing repetitions of ROL.
int	getROLReps() Returns the number of existing repetitions of ROL
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
UAC	getUAC() Returns UAC (User Authentication Credential Segment) - creates it if necessary
String	getVersion() Returns "2.6"
OPU_R25_ACCESSION_DETAIL	insertACCESSION_DETAIL(int rep) Inserts a specific repetition of ACCESSION_DETAIL (a Group object)
void	insertACCESSION_DETAIL(OPU_R25_ACCESSION_DETAIL structure, int rep) Inserts a specific repetition of ACCESSION_DETAIL (a Group object)
NTE	insertNTE2(int rep) Inserts a specific repetition of NTE2 (Notes and Comments)
void	insertNTE2(NTE structure, int rep) Inserts a specific repetition of NTE2 (Notes and Comments)
OBX	insertOBX(int rep) Inserts a specific repetition of OBX (Observation/Result)
void	insertOBX(OBX structure, int rep) Inserts a specific repetition of OBX (Observation/Result)
ROL	insertROL(int rep) Inserts a specific repetition of ROL (Role)
void	insertROL(ROL structure, int rep) Inserts a specific repetition of ROL (Role)
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)
OPU_R25_ACCESSION_DETAIL	removeACCESSION_DETAIL(int rep) Removes a specific repetition of ACCESSION_DETAIL (a Group object)
NTE	removeNTE2(int rep) Removes a specific repetition of NTE2 (Notes and Comments)
OBX	removeOBX(int rep) Removes a specific repetition of OBX (Observation/Result)
ROL	removeROL(int rep) Removes a specific repetition of ROL (Role)
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

OPU_R25

public OPU_R25()

Creates a new OPU_R25 message with DefaultModelClassFactory.

OPU_R25

public OPU_R25(ModelClassFactory factory)

Creates a new OPU_R25 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

getPV1

public PV1 getPV1()

Returns PV1 (Patient Visit) - creates it if necessary

getPV2

public PV2 getPV2()

Returns PV2 (Patient Visit - Additional Information) - creates it if necessary

getOBX

public OBX getOBX()

Returns the first repetition of OBX (Observation/Result) - creates it if necessary

getOBX

public OBX getOBX(int rep)

Returns a specific repetition of OBX (Observation/Result) - 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.

getOBXReps

public int getOBXReps()

Returns the number of existing repetitions of OBX

getOBXAll

public List<OBX> getOBXAll()
                    throws HL7Exception

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

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

Throws:

HL7Exception

insertOBX

public void insertOBX(OBX structure,
             int rep)
               throws HL7Exception

Inserts a specific repetition of OBX (Observation/Result)

Throws:

HL7Exception

See Also:

AbstractGroup#insertRepetition(Structure, int)

insertOBX

public OBX insertOBX(int rep)
              throws HL7Exception

Inserts a specific repetition of OBX (Observation/Result)

Throws:

HL7Exception

See Also:

AbstractGroup#insertRepetition(Structure, int)

removeOBX

public OBX removeOBX(int rep)
              throws HL7Exception

Removes a specific repetition of OBX (Observation/Result)

Throws:

HL7Exception

See Also:

AbstractGroup#removeRepetition(String, int)

getNTE2

public NTE getNTE2()

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

getNTE2

public NTE getNTE2(int rep)

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

getNTE2Reps

public int getNTE2Reps()

Returns the number of existing repetitions of NTE2

getNTE2All

public List<NTE> getNTE2All()
                     throws HL7Exception

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

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

Throws:

HL7Exception

insertNTE2

public void insertNTE2(NTE structure,
              int rep)
                throws HL7Exception

Inserts a specific repetition of NTE2 (Notes and Comments)

Throws:

HL7Exception

See Also:

AbstractGroup#insertRepetition(Structure, int)

insertNTE2

public NTE insertNTE2(int rep)
               throws HL7Exception

Inserts a specific repetition of NTE2 (Notes and Comments)

Throws:

HL7Exception

See Also:

AbstractGroup#insertRepetition(Structure, int)

removeNTE2

public NTE removeNTE2(int rep)
               throws HL7Exception

Removes a specific repetition of NTE2 (Notes and Comments)

Throws:

HL7Exception

See Also:

AbstractGroup#removeRepetition(String, int)

getROL

public ROL getROL()

Returns the first repetition of ROL (Role) - creates it if necessary

getROL

public ROL getROL(int rep)

Returns a specific repetition of ROL (Role) - 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.

getROLReps

public int getROLReps()

Returns the number of existing repetitions of ROL

getROLAll

public List<ROL> getROLAll()
                    throws HL7Exception

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

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

Throws:

HL7Exception

insertROL

public void insertROL(ROL structure,
             int rep)
               throws HL7Exception

Inserts a specific repetition of ROL (Role)

Throws:

HL7Exception

See Also:

AbstractGroup#insertRepetition(Structure, int)

insertROL

public ROL insertROL(int rep)
              throws HL7Exception

Inserts a specific repetition of ROL (Role)

Throws:

HL7Exception

See Also:

AbstractGroup#insertRepetition(Structure, int)

removeROL

public ROL removeROL(int rep)
              throws HL7Exception

Removes a specific repetition of ROL (Role)

Throws:

HL7Exception

See Also:

AbstractGroup#removeRepetition(String, int)

getACCESSION_DETAIL

public OPU_R25_ACCESSION_DETAIL getACCESSION_DETAIL()

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

getACCESSION_DETAIL

public OPU_R25_ACCESSION_DETAIL getACCESSION_DETAIL(int rep)

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

getACCESSION_DETAILReps

public int getACCESSION_DETAILReps()

Returns the number of existing repetitions of ACCESSION_DETAIL

getACCESSION_DETAILAll

public List<OPU_R25_ACCESSION_DETAIL> getACCESSION_DETAILAll()
                                                      throws HL7Exception

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

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

Throws:

HL7Exception

insertACCESSION_DETAIL

public void insertACCESSION_DETAIL(OPU_R25_ACCESSION_DETAIL structure,
                          int rep)
                            throws HL7Exception

Inserts a specific repetition of ACCESSION_DETAIL (a Group object)

Throws:

HL7Exception

See Also:

AbstractGroup#insertRepetition(Structure, int)

insertACCESSION_DETAIL

public OPU_R25_ACCESSION_DETAIL insertACCESSION_DETAIL(int rep)
                                                throws HL7Exception

Inserts a specific repetition of ACCESSION_DETAIL (a Group object)

Throws:

HL7Exception

See Also:

AbstractGroup#insertRepetition(Structure, int)

removeACCESSION_DETAIL

public OPU_R25_ACCESSION_DETAIL removeACCESSION_DETAIL(int rep)
                                                throws HL7Exception

Removes a specific repetition of ACCESSION_DETAIL (a Group object)

Throws:

HL7Exception

See Also:

AbstractGroup#removeRepetition(String, int)