ca.uhn.hl7v2.model.v231.message
Class RPI_I04

java.lang.Object
  ca.uhn.hl7v2.model.AbstractGroup
      ca.uhn.hl7v2.model.AbstractMessage
          ca.uhn.hl7v2.model.v231.message.RPI_I04

All Implemented Interfaces:

Group, Message, Structure, Serializable

public class RPI_I04
extends AbstractMessage

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

• 1: MSH (MSH - message header segment)
• 2: MSA (MSA - message acknowledgment segment)
• 3: RPI_I04_PRDCTD (a Group object) repeating
• 4: PID (PID - patient identification segment)
• 5: NK1 (NK1 - next of kin / associated parties segment-) optional repeating
• 6: RPI_I04_GT1IN1IN2IN3 (a Group object) optional
• 7: NTE (NTE - notes and comments segment) optional repeating

See Also:

Serialized Form

Constructor Summary

RPI_I04()
Creates a new RPI_I04 message with DefaultModelClassFactory.

RPI_I04(ModelClassFactory factory)
Creates a new RPI_I04 message with custom ModelClassFactory.

Method Summary

RPI_I04_GT1IN1IN2IN3	getGT1IN1IN2IN3() Returns GT1IN1IN2IN3 (a Group object) - creates it if necessary
MSA	getMSA() Returns MSA (MSA - message acknowledgment segment) - creates it if necessary
MSH	getMSH() Returns MSH (MSH - message header segment) - creates it if necessary
NK1	getNK1() Returns the first repetition of NK1 (NK1 - next of kin / associated parties segment-) - creates it if necessary
NK1	getNK1(int rep) Returns a specific repetition of NK1 (NK1 - next of kin / associated parties segment-) - creates it if necessary
int	getNK1Reps() Returns the number of existing repetitions of NK1
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
int	getNTEReps() Returns the number of existing repetitions of NTE
PID	getPID() Returns PID (PID - patient identification segment) - creates it if necessary
RPI_I04_PRDCTD	getPRDCTD() Returns the first repetition of PRDCTD (a Group object) - creates it if necessary
RPI_I04_PRDCTD	getPRDCTD(int rep) Returns a specific repetition of PRDCTD (a Group object) - creates it if necessary
int	getPRDCTDReps() Returns the number of existing repetitions of PRDCTD
String	getVersion() Returns "2.3.1"
NK1	insertNK1(int rep) Inserts a specific repetition of NK1 (NK1 - next of kin / associated parties segment-)
void	insertNK1(NK1 structure, int rep) Inserts a specific repetition of NK1 (NK1 - next of kin / associated parties segment-)
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)
RPI_I04_PRDCTD	insertPRDCTD(int rep) Inserts a specific repetition of PRDCTD (a Group object)
void	insertPRDCTD(RPI_I04_PRDCTD structure, int rep) Inserts a specific repetition of PRDCTD (a Group object)
NK1	removeNK1(int rep) Removes a specific repetition of NK1 (NK1 - next of kin / associated parties segment-)
NTE	removeNTE(int rep) Removes a specific repetition of NTE (NTE - notes and comments segment)
RPI_I04_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, 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, getClass, getModelClassFactory, getName, getNames, getParent, insertRepetition, insertRepetition, isGroup, isRepeating, isRequired, removeRepetition

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, getParent

Constructor Detail

RPI_I04

public RPI_I04()

Creates a new RPI_I04 message with DefaultModelClassFactory.

RPI_I04

public RPI_I04(ModelClassFactory factory)

Creates a new RPI_I04 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 RPI_I04_PRDCTD getPRDCTD()

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

getPRDCTD

public RPI_I04_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

insertPRDCTD

public void insertPRDCTD(RPI_I04_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 RPI_I04_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 RPI_I04_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 PID (PID - patient identification segment) - creates it if necessary

getNK1

public NK1 getNK1()

Returns the first repetition of NK1 (NK1 - next of kin / associated parties segment-) - creates it if necessary

getNK1

public NK1 getNK1(int rep)

Returns a specific repetition of NK1 (NK1 - next of kin / associated parties 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.

getNK1Reps

public int getNK1Reps()

Returns the number of existing repetitions of NK1

insertNK1

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

Inserts a specific repetition of NK1 (NK1 - next of kin / associated parties segment-)

Throws:

HL7Exception

See Also:

AbstractGroup\#insertRepetition(Structure, int)

insertNK1

public NK1 insertNK1(int rep)
              throws HL7Exception

Inserts a specific repetition of NK1 (NK1 - next of kin / associated parties segment-)

Throws:

HL7Exception

See Also:

AbstractGroup\#insertRepetition(Structure, int)

removeNK1

public NK1 removeNK1(int rep)
              throws HL7Exception

Removes a specific repetition of NK1 (NK1 - next of kin / associated parties segment-)

Throws:

HL7Exception

See Also:

AbstractGroup\#removeRepetition(String, int)

getGT1IN1IN2IN3

public RPI_I04_GT1IN1IN2IN3 getGT1IN1IN2IN3()

Returns GT1IN1IN2IN3 (a Group object) - 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

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)