ca.uhn.hl7v2.model.v231.message

Class RPR_I03

java.lang.Object

ca.uhn.hl7v2.model.AbstractStructure

ca.uhn.hl7v2.model.AbstractGroup

ca.uhn.hl7v2.model.AbstractMessage

ca.uhn.hl7v2.model.v231.message.RPR_I03

All Implemented Interfaces:

Group, Message, Structure, Serializable

public class RPR_I03
extends AbstractMessage

Represents a RPR_I03 message structure (see chapter ?). This structure contains the following elements:

• 1: MSH (MSH - message header segment)
• 2: MSA (MSA - message acknowledgment segment)
• 3: RPR_I03_PRDCTD (a Group object) repeating
• 4: PID (PID - patient identification segment) optional repeating
• 5: NTE (NTE - notes and comments segment) optional repeating

See Also:

Serialized Form

Field Summary

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

log

Constructor Summary

Constructors

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

Method Summary

Methods

Modifier and Type	Method and Description
MSA	getMSA() Returns MSA (MSA - message acknowledgment segment) - creates it if necessary
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
PID	getPID() Returns the first repetition of PID (PID - patient identification segment) - creates it if necessary
PID	getPID(int rep) Returns a specific repetition of PID (PID - patient identification segment) - creates it if necessary
List<PID>	getPIDAll() Returns a non-modifiable List containing all current existing repetitions of PID.
int	getPIDReps() Returns the number of existing repetitions of PID
RPR_I03_PRDCTD	getPRDCTD() Returns the first repetition of PRDCTD (a Group object) - creates it if necessary
RPR_I03_PRDCTD	getPRDCTD(int rep) Returns a specific repetition of PRDCTD (a Group object) - creates it if necessary
List<RPR_I03_PRDCTD>	getPRDCTDAll() Returns a non-modifiable List containing all current existing repetitions of PRDCTD.
int	getPRDCTDReps() Returns the number of existing repetitions of PRDCTD
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)
PID	insertPID(int rep) Inserts a specific repetition of PID (PID - patient identification segment)
void	insertPID(PID structure, int rep) Inserts a specific repetition of PID (PID - patient identification segment)
RPR_I03_PRDCTD	insertPRDCTD(int rep) Inserts a specific repetition of PRDCTD (a Group object)
void	insertPRDCTD(RPR_I03_PRDCTD structure, int rep) Inserts a specific repetition of PRDCTD (a Group object)
NTE	removeNTE(int rep) Removes a specific repetition of NTE (NTE - notes and comments segment)
PID	removePID(int rep) Removes a specific repetition of PID (PID - patient identification segment)
RPR_I03_PRDCTD	removePRDCTD(int rep) Removes a specific repetition of PRDCTD (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

RPR_I03

public RPR_I03()

Creates a new RPR_I03 message with DefaultModelClassFactory.

RPR_I03

public RPR_I03(ModelClassFactory factory)

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

getMSA

public MSA getMSA()

Returns MSA (MSA - message acknowledgment segment) - creates it if necessary

getPRDCTD

public RPR_I03_PRDCTD getPRDCTD()

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

getPRDCTD

public RPR_I03_PRDCTD getPRDCTD(int rep)

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

getPRDCTDReps

public int getPRDCTDReps()

Returns the number of existing repetitions of PRDCTD

getPRDCTDAll

public List<RPR_I03_PRDCTD> getPRDCTDAll()
                                  throws HL7Exception

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

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

Throws:

HL7Exception

insertPRDCTD

public void insertPRDCTD(RPR_I03_PRDCTD structure,
                int rep)
                  throws HL7Exception

Inserts a specific repetition of PRDCTD (a Group object)

Throws:

HL7Exception

See Also:

AbstractGroup#insertRepetition(Structure, int)

insertPRDCTD

public RPR_I03_PRDCTD insertPRDCTD(int rep)
                            throws HL7Exception

Inserts a specific repetition of PRDCTD (a Group object)

Throws:

HL7Exception

See Also:

AbstractGroup#insertRepetition(Structure, int)

removePRDCTD

public RPR_I03_PRDCTD removePRDCTD(int rep)
                            throws HL7Exception

Removes a specific repetition of PRDCTD (a Group object)

Throws:

HL7Exception

See Also:

AbstractGroup#removeRepetition(String, int)

getPID

public PID getPID()

Returns the first repetition of PID (PID - patient identification segment) - creates it if necessary

getPID

public PID getPID(int rep)

Returns a specific repetition of PID (PID - patient identification 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.

getPIDReps

public int getPIDReps()

Returns the number of existing repetitions of PID

getPIDAll

public List<PID> getPIDAll()
                    throws HL7Exception

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

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

Throws:

HL7Exception

insertPID

public void insertPID(PID structure,
             int rep)
               throws HL7Exception

Inserts a specific repetition of PID (PID - patient identification segment)

Throws:

HL7Exception

See Also:

AbstractGroup#insertRepetition(Structure, int)

insertPID

public PID insertPID(int rep)
              throws HL7Exception

Inserts a specific repetition of PID (PID - patient identification segment)

Throws:

HL7Exception

See Also:

AbstractGroup#insertRepetition(Structure, int)

removePID

public PID removePID(int rep)
              throws HL7Exception

Removes a specific repetition of PID (PID - patient identification segment)

Throws:

HL7Exception

See Also:

AbstractGroup#removeRepetition(String, int)

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)