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

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

All Implemented Interfaces:

Group, Message, Structure, Serializable

public class RRI_I12
extends AbstractMessage

Represents a RRI_I12 message structure (see chapter ${chapter}). This structure contains the following elements:

• 1: MSH (MSH - message header segment)
• 2: MSA (MSA - message acknowledgment segment) optional
• 3: RF1 (Referral Infomation) optional
• 4: RRI_I12_AUTCTD (a Group object) optional
• 5: RRI_I12_PRDCTD (a Group object) repeating
• 6: PID (PID - patient identification segment)
• 7: ACC (ACC - accident segment) optional
• 8: DG1 (DG1 - diagnosis segment) optional repeating
• 9: DRG (DRG - diagnosis related group segment) optional repeating
• 10: AL1 (AL1 - patient allergy information segment) optional repeating
• 11: RRI_I12_PR1AUTCTD (a Group object) optional repeating
• 12: RRI_I12_OBRNTEOBXNTE (a Group object) optional repeating
• 13: RRI_I12_PV1PV2 (a Group object) optional
• 14: NTE (NTE - notes and comments segment) optional repeating

See Also:

Serialized Form

Constructor Summary

RRI_I12()
Creates a new RRI_I12 message with DefaultModelClassFactory.

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

Method Summary

ACC	getACC() Returns ACC (ACC - accident segment) - creates it if necessary
AL1	getAL1() Returns the first repetition of AL1 (AL1 - patient allergy information segment) - creates it if necessary
AL1	getAL1(int rep) Returns a specific repetition of AL1 (AL1 - patient allergy information segment) - creates it if necessary
int	getAL1Reps() Returns the number of existing repetitions of AL1
RRI_I12_AUTCTD	getAUTCTD() Returns AUTCTD (a Group object) - creates it if necessary
DG1	getDG1() Returns the first repetition of DG1 (DG1 - diagnosis segment) - creates it if necessary
DG1	getDG1(int rep) Returns a specific repetition of DG1 (DG1 - diagnosis segment) - creates it if necessary
int	getDG1Reps() Returns the number of existing repetitions of DG1
DRG	getDRG() Returns the first repetition of DRG (DRG - diagnosis related group segment) - creates it if necessary
DRG	getDRG(int rep) Returns a specific repetition of DRG (DRG - diagnosis related group segment) - creates it if necessary
int	getDRGReps() Returns the number of existing repetitions of DRG
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
int	getNTEReps() Returns the number of existing repetitions of NTE
RRI_I12_OBRNTEOBXNTE	getOBRNTEOBXNTE() Returns the first repetition of OBRNTEOBXNTE (a Group object) - creates it if necessary
RRI_I12_OBRNTEOBXNTE	getOBRNTEOBXNTE(int rep) Returns a specific repetition of OBRNTEOBXNTE (a Group object) - creates it if necessary
int	getOBRNTEOBXNTEReps() Returns the number of existing repetitions of OBRNTEOBXNTE
PID	getPID() Returns PID (PID - patient identification segment) - creates it if necessary
RRI_I12_PR1AUTCTD	getPR1AUTCTD() Returns the first repetition of PR1AUTCTD (a Group object) - creates it if necessary
RRI_I12_PR1AUTCTD	getPR1AUTCTD(int rep) Returns a specific repetition of PR1AUTCTD (a Group object) - creates it if necessary
int	getPR1AUTCTDReps() Returns the number of existing repetitions of PR1AUTCTD
RRI_I12_PRDCTD	getPRDCTD() Returns the first repetition of PRDCTD (a Group object) - creates it if necessary
RRI_I12_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
RRI_I12_PV1PV2	getPV1PV2() Returns PV1PV2 (a Group object) - creates it if necessary
RF1	getRF1() Returns RF1 (Referral Infomation) - creates it if necessary
String	getVersion() Returns "2.3.1"
void	insertAL1(AL1 structure, int rep) Inserts a specific repetition of AL1 (AL1 - patient allergy information segment)
AL1	insertAL1(int rep) Inserts a specific repetition of AL1 (AL1 - patient allergy information segment)
void	insertDG1(DG1 structure, int rep) Inserts a specific repetition of DG1 (DG1 - diagnosis segment)
DG1	insertDG1(int rep) Inserts a specific repetition of DG1 (DG1 - diagnosis segment)
void	insertDRG(DRG structure, int rep) Inserts a specific repetition of DRG (DRG - diagnosis related group segment)
DRG	insertDRG(int rep) Inserts a specific repetition of DRG (DRG - diagnosis related group 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)
RRI_I12_OBRNTEOBXNTE	insertOBRNTEOBXNTE(int rep) Inserts a specific repetition of OBRNTEOBXNTE (a Group object)
void	insertOBRNTEOBXNTE(RRI_I12_OBRNTEOBXNTE structure, int rep) Inserts a specific repetition of OBRNTEOBXNTE (a Group object)
RRI_I12_PR1AUTCTD	insertPR1AUTCTD(int rep) Inserts a specific repetition of PR1AUTCTD (a Group object)
void	insertPR1AUTCTD(RRI_I12_PR1AUTCTD structure, int rep) Inserts a specific repetition of PR1AUTCTD (a Group object)
RRI_I12_PRDCTD	insertPRDCTD(int rep) Inserts a specific repetition of PRDCTD (a Group object)
void	insertPRDCTD(RRI_I12_PRDCTD structure, int rep) Inserts a specific repetition of PRDCTD (a Group object)
AL1	removeAL1(int rep) Removes a specific repetition of AL1 (AL1 - patient allergy information segment)
DG1	removeDG1(int rep) Removes a specific repetition of DG1 (DG1 - diagnosis segment)
DRG	removeDRG(int rep) Removes a specific repetition of DRG (DRG - diagnosis related group segment)
NTE	removeNTE(int rep) Removes a specific repetition of NTE (NTE - notes and comments segment)
RRI_I12_OBRNTEOBXNTE	removeOBRNTEOBXNTE(int rep) Removes a specific repetition of OBRNTEOBXNTE (a Group object)
RRI_I12_PR1AUTCTD	removePR1AUTCTD(int rep) Removes a specific repetition of PR1AUTCTD (a Group object)
RRI_I12_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

RRI_I12

public RRI_I12()

Creates a new RRI_I12 message with DefaultModelClassFactory.

RRI_I12

public RRI_I12(ModelClassFactory factory)

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

getRF1

public RF1 getRF1()

Returns RF1 (Referral Infomation) - creates it if necessary

getAUTCTD

public RRI_I12_AUTCTD getAUTCTD()

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

getPRDCTD

public RRI_I12_PRDCTD getPRDCTD()

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

getPRDCTD

public RRI_I12_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(RRI_I12_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 RRI_I12_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 RRI_I12_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

getACC

public ACC getACC()

Returns ACC (ACC - accident segment) - creates it if necessary

getDG1

public DG1 getDG1()

Returns the first repetition of DG1 (DG1 - diagnosis segment) - creates it if necessary

getDG1

public DG1 getDG1(int rep)

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

getDG1Reps

public int getDG1Reps()

Returns the number of existing repetitions of DG1

insertDG1

public void insertDG1(DG1 structure,
                      int rep)
               throws HL7Exception

Inserts a specific repetition of DG1 (DG1 - diagnosis segment)

Throws:

HL7Exception

See Also:

AbstractGroup\#insertRepetition(Structure, int)

insertDG1

public DG1 insertDG1(int rep)
              throws HL7Exception

Inserts a specific repetition of DG1 (DG1 - diagnosis segment)

Throws:

HL7Exception

See Also:

AbstractGroup\#insertRepetition(Structure, int)

removeDG1

public DG1 removeDG1(int rep)
              throws HL7Exception

Removes a specific repetition of DG1 (DG1 - diagnosis segment)

Throws:

HL7Exception

See Also:

AbstractGroup\#removeRepetition(String, int)

getDRG

public DRG getDRG()

Returns the first repetition of DRG (DRG - diagnosis related group segment) - creates it if necessary

getDRG

public DRG getDRG(int rep)

Returns a specific repetition of DRG (DRG - diagnosis related group 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.

getDRGReps

public int getDRGReps()

Returns the number of existing repetitions of DRG

insertDRG

public void insertDRG(DRG structure,
                      int rep)
               throws HL7Exception

Inserts a specific repetition of DRG (DRG - diagnosis related group segment)

Throws:

HL7Exception

See Also:

AbstractGroup\#insertRepetition(Structure, int)

insertDRG

public DRG insertDRG(int rep)
              throws HL7Exception

Inserts a specific repetition of DRG (DRG - diagnosis related group segment)

Throws:

HL7Exception

See Also:

AbstractGroup\#insertRepetition(Structure, int)

removeDRG

public DRG removeDRG(int rep)
              throws HL7Exception

Removes a specific repetition of DRG (DRG - diagnosis related group segment)

Throws:

HL7Exception

See Also:

AbstractGroup\#removeRepetition(String, int)

getAL1

public AL1 getAL1()

Returns the first repetition of AL1 (AL1 - patient allergy information segment) - creates it if necessary

getAL1

public AL1 getAL1(int rep)

Returns a specific repetition of AL1 (AL1 - patient allergy information 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.

getAL1Reps

public int getAL1Reps()

Returns the number of existing repetitions of AL1

insertAL1

public void insertAL1(AL1 structure,
                      int rep)
               throws HL7Exception

Inserts a specific repetition of AL1 (AL1 - patient allergy information segment)

Throws:

HL7Exception

See Also:

AbstractGroup\#insertRepetition(Structure, int)

insertAL1

public AL1 insertAL1(int rep)
              throws HL7Exception

Inserts a specific repetition of AL1 (AL1 - patient allergy information segment)

Throws:

HL7Exception

See Also:

AbstractGroup\#insertRepetition(Structure, int)

removeAL1

public AL1 removeAL1(int rep)
              throws HL7Exception

Removes a specific repetition of AL1 (AL1 - patient allergy information segment)

Throws:

HL7Exception

See Also:

AbstractGroup\#removeRepetition(String, int)

getPR1AUTCTD

public RRI_I12_PR1AUTCTD getPR1AUTCTD()

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

getPR1AUTCTD

public RRI_I12_PR1AUTCTD getPR1AUTCTD(int rep)

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

getPR1AUTCTDReps

public int getPR1AUTCTDReps()

Returns the number of existing repetitions of PR1AUTCTD

insertPR1AUTCTD

public void insertPR1AUTCTD(RRI_I12_PR1AUTCTD structure,
                            int rep)
                     throws HL7Exception

Inserts a specific repetition of PR1AUTCTD (a Group object)

Throws:

HL7Exception

See Also:

AbstractGroup\#insertRepetition(Structure, int)

insertPR1AUTCTD

public RRI_I12_PR1AUTCTD insertPR1AUTCTD(int rep)
                                  throws HL7Exception

Inserts a specific repetition of PR1AUTCTD (a Group object)

Throws:

HL7Exception

See Also:

AbstractGroup\#insertRepetition(Structure, int)

removePR1AUTCTD

public RRI_I12_PR1AUTCTD removePR1AUTCTD(int rep)
                                  throws HL7Exception

Removes a specific repetition of PR1AUTCTD (a Group object)

Throws:

HL7Exception

See Also:

AbstractGroup\#removeRepetition(String, int)

getOBRNTEOBXNTE

public RRI_I12_OBRNTEOBXNTE getOBRNTEOBXNTE()

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

getOBRNTEOBXNTE

public RRI_I12_OBRNTEOBXNTE getOBRNTEOBXNTE(int rep)

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

getOBRNTEOBXNTEReps

public int getOBRNTEOBXNTEReps()

Returns the number of existing repetitions of OBRNTEOBXNTE

insertOBRNTEOBXNTE

public void insertOBRNTEOBXNTE(RRI_I12_OBRNTEOBXNTE structure,
                               int rep)
                        throws HL7Exception

Inserts a specific repetition of OBRNTEOBXNTE (a Group object)

Throws:

HL7Exception

See Also:

AbstractGroup\#insertRepetition(Structure, int)

insertOBRNTEOBXNTE

public RRI_I12_OBRNTEOBXNTE insertOBRNTEOBXNTE(int rep)
                                        throws HL7Exception

Inserts a specific repetition of OBRNTEOBXNTE (a Group object)

Throws:

HL7Exception

See Also:

AbstractGroup\#insertRepetition(Structure, int)

removeOBRNTEOBXNTE

public RRI_I12_OBRNTEOBXNTE removeOBRNTEOBXNTE(int rep)
                                        throws HL7Exception

Removes a specific repetition of OBRNTEOBXNTE (a Group object)

Throws:

HL7Exception

See Also:

AbstractGroup\#removeRepetition(String, int)

getPV1PV2

public RRI_I12_PV1PV2 getPV1PV2()

Returns PV1PV2 (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)