Package ca.uhn.hl7v2.model.v24.message

Class RRI_I12

java.lang.Object

ca.uhn.hl7v2.model.AbstractStructure

ca.uhn.hl7v2.model.AbstractGroup

ca.uhn.hl7v2.model.AbstractMessage

ca.uhn.hl7v2.model.v24.message.RRI_I12

All Implemented Interfaces:

Group, Message, Structure, Visitable, Serializable

public class RRI_I12
extends AbstractMessage

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

• 1: MSH (Message Header)
• 2: MSA (Message Acknowledgment) optional
• 3: RF1 (Referral Information) optional
• 4: RRI_I12_AUTHORIZATION_CONTACT (a Group object) optional
• 5: RRI_I12_PROVIDER_CONTACT (a Group object) repeating
• 6: PID (Patient identification)
• 7: ACC (Accident) optional
• 8: DG1 (Diagnosis) optional repeating
• 9: DRG (Diagnosis Related Group) optional repeating
• 10: AL1 (Patient allergy information) optional repeating
• 11: RRI_I12_PROCEDURE (a Group object) optional repeating
• 12: RRI_I12_OBSERVATION (a Group object) optional repeating
• 13: RRI_I12_PATIENT_VISIT (a Group object) optional
• 14: NTE (Notes and Comments) optional repeating

See Also:

• Serialized Form

Field Summary

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

log

Constructor Summary

Constructors

Constructor	Description
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

Modifier and Type	Method	Description
ACC	getACC()	Returns ACC (Accident) - creates it if necessary
AL1	getAL1()	Returns the first repetition of AL1 (Patient allergy information) - creates it if necessary
AL1	getAL1(int rep)	Returns a specific repetition of AL1 (Patient allergy information) - creates it if necessary
List<AL1>	getAL1All()	Returns a non-modifiable List containing all current existing repetitions of AL1.
int	getAL1Reps()	Returns the number of existing repetitions of AL1
RRI_I12_AUTHORIZATION_CONTACT	getAUTHORIZATION_CONTACT()	Returns AUTHORIZATION_CONTACT (a Group object) - creates it if necessary
DG1	getDG1()	Returns the first repetition of DG1 (Diagnosis) - creates it if necessary
DG1	getDG1(int rep)	Returns a specific repetition of DG1 (Diagnosis) - creates it if necessary
List<DG1>	getDG1All()	Returns a non-modifiable List containing all current existing repetitions of DG1.
int	getDG1Reps()	Returns the number of existing repetitions of DG1
DRG	getDRG()	Returns the first repetition of DRG (Diagnosis Related Group) - creates it if necessary
DRG	getDRG(int rep)	Returns a specific repetition of DRG (Diagnosis Related Group) - creates it if necessary
List<DRG>	getDRGAll()	Returns a non-modifiable List containing all current existing repetitions of DRG.
int	getDRGReps()	Returns the number of existing repetitions of DRG
MSA	getMSA()	Returns MSA (Message Acknowledgment) - creates it if necessary
MSH	getMSH()	Returns MSH (Message Header) - creates it if necessary
NTE	getNTE()	Returns the first repetition of NTE (Notes and Comments) - creates it if necessary
NTE	getNTE(int rep)	Returns a specific repetition of NTE (Notes and Comments) - 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
RRI_I12_OBSERVATION	getOBSERVATION()	Returns the first repetition of OBSERVATION (a Group object) - creates it if necessary
RRI_I12_OBSERVATION	getOBSERVATION(int rep)	Returns a specific repetition of OBSERVATION (a Group object) - creates it if necessary
List<RRI_I12_OBSERVATION>	getOBSERVATIONAll()	Returns a non-modifiable List containing all current existing repetitions of OBSERVATION.
int	getOBSERVATIONReps()	Returns the number of existing repetitions of OBSERVATION
RRI_I12_PATIENT_VISIT	getPATIENT_VISIT()	Returns PATIENT_VISIT (a Group object) - creates it if necessary
PID	getPID()	Returns PID (Patient identification) - creates it if necessary
RRI_I12_PROCEDURE	getPROCEDURE()	Returns the first repetition of PROCEDURE (a Group object) - creates it if necessary
RRI_I12_PROCEDURE	getPROCEDURE(int rep)	Returns a specific repetition of PROCEDURE (a Group object) - creates it if necessary
List<RRI_I12_PROCEDURE>	getPROCEDUREAll()	Returns a non-modifiable List containing all current existing repetitions of PROCEDURE.
int	getPROCEDUREReps()	Returns the number of existing repetitions of PROCEDURE
RRI_I12_PROVIDER_CONTACT	getPROVIDER_CONTACT()	Returns the first repetition of PROVIDER_CONTACT (a Group object) - creates it if necessary
RRI_I12_PROVIDER_CONTACT	getPROVIDER_CONTACT(int rep)	Returns a specific repetition of PROVIDER_CONTACT (a Group object) - creates it if necessary
List<RRI_I12_PROVIDER_CONTACT>	getPROVIDER_CONTACTAll()	Returns a non-modifiable List containing all current existing repetitions of PROVIDER_CONTACT.
int	getPROVIDER_CONTACTReps()	Returns the number of existing repetitions of PROVIDER_CONTACT
RF1	getRF1()	Returns RF1 (Referral Information) - creates it if necessary
String	getVersion()	Returns "2.4"
AL1	insertAL1(int rep)	Inserts a specific repetition of AL1 (Patient allergy information)
void	insertAL1(AL1 structure, int rep)	Inserts a specific repetition of AL1 (Patient allergy information)
DG1	insertDG1(int rep)	Inserts a specific repetition of DG1 (Diagnosis)
void	insertDG1(DG1 structure, int rep)	Inserts a specific repetition of DG1 (Diagnosis)
DRG	insertDRG(int rep)	Inserts a specific repetition of DRG (Diagnosis Related Group)
void	insertDRG(DRG structure, int rep)	Inserts a specific repetition of DRG (Diagnosis Related Group)
NTE	insertNTE(int rep)	Inserts a specific repetition of NTE (Notes and Comments)
void	insertNTE(NTE structure, int rep)	Inserts a specific repetition of NTE (Notes and Comments)
RRI_I12_OBSERVATION	insertOBSERVATION(int rep)	Inserts a specific repetition of OBSERVATION (a Group object)
void	insertOBSERVATION(RRI_I12_OBSERVATION structure, int rep)	Inserts a specific repetition of OBSERVATION (a Group object)
RRI_I12_PROCEDURE	insertPROCEDURE(int rep)	Inserts a specific repetition of PROCEDURE (a Group object)
void	insertPROCEDURE(RRI_I12_PROCEDURE structure, int rep)	Inserts a specific repetition of PROCEDURE (a Group object)
RRI_I12_PROVIDER_CONTACT	insertPROVIDER_CONTACT(int rep)	Inserts a specific repetition of PROVIDER_CONTACT (a Group object)
void	insertPROVIDER_CONTACT(RRI_I12_PROVIDER_CONTACT structure, int rep)	Inserts a specific repetition of PROVIDER_CONTACT (a Group object)
AL1	removeAL1(int rep)	Removes a specific repetition of AL1 (Patient allergy information)
DG1	removeDG1(int rep)	Removes a specific repetition of DG1 (Diagnosis)
DRG	removeDRG(int rep)	Removes a specific repetition of DRG (Diagnosis Related Group)
NTE	removeNTE(int rep)	Removes a specific repetition of NTE (Notes and Comments)
RRI_I12_OBSERVATION	removeOBSERVATION(int rep)	Removes a specific repetition of OBSERVATION (a Group object)
RRI_I12_PROCEDURE	removePROCEDURE(int rep)	Removes a specific repetition of PROCEDURE (a Group object)
RRI_I12_PROVIDER_CONTACT	removePROVIDER_CONTACT(int rep)	Removes a specific repetition of PROVIDER_CONTACT (a Group object)

Methods inherited from class ca.uhn.hl7v2.model.AbstractMessage

accept, copy, encode, fillResponseHeader, generateACK, generateACK, generateACK, getEncodingCharactersValue, getFieldSeparatorValue, getMessage, getParent, getParser, getValidationContext, initQuickstart, parse, printStructure, printStructure, setParser, toString

Methods inherited from class ca.uhn.hl7v2.model.AbstractGroup

add, add, add, addNonstandardSegment, addNonstandardSegment, clear, currentReps, get, get, getAll, getAllAsList, getClass, getFieldNumForName, getModelClassFactory, getName, getNames, getNonStandardNames, getReps, getTyped, getTyped, insert, insert, insertRepetition, insertRepetition, isChoiceElement, isEmpty, isGroup, isRepeating, isRequired, provideLocation, removeRepetition, tryToInstantiateStructure, visitNestedStructures

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, isChoiceElement, isGroup, isRepeating, isRequired

Methods inherited from interface ca.uhn.hl7v2.model.Structure

getName

Methods inherited from interface ca.uhn.hl7v2.model.Visitable

isEmpty, provideLocation

Constructor Details

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 Details

getVersion

public String getVersion()

Returns "2.4"

Specified by:

getVersion in interface Message

Overrides:

getVersion in class AbstractMessage

getMSH

public MSH getMSH()

Returns MSH (Message Header) - creates it if necessary

getMSA

public MSA getMSA()

Returns MSA (Message Acknowledgment) - creates it if necessary

getRF1

public RF1 getRF1()

Returns RF1 (Referral Information) - creates it if necessary

getAUTHORIZATION_CONTACT

public RRI_I12_AUTHORIZATION_CONTACT getAUTHORIZATION_CONTACT()

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

getPROVIDER_CONTACT

public RRI_I12_PROVIDER_CONTACT getPROVIDER_CONTACT()

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

getPROVIDER_CONTACT

public RRI_I12_PROVIDER_CONTACT getPROVIDER_CONTACT(int rep)

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

getPROVIDER_CONTACTReps

public int getPROVIDER_CONTACTReps()

Returns the number of existing repetitions of PROVIDER_CONTACT

getPROVIDER_CONTACTAll

public List<RRI_I12_PROVIDER_CONTACT> getPROVIDER_CONTACTAll()
                                                      throws HL7Exception

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

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

Throws:

HL7Exception

insertPROVIDER_CONTACT

public void insertPROVIDER_CONTACT(RRI_I12_PROVIDER_CONTACT structure,
 int rep)
                            throws HL7Exception

Inserts a specific repetition of PROVIDER_CONTACT (a Group object)

Throws:

HL7Exception

See Also:

• AbstractGroup#insertRepetition(Structure, int)

insertPROVIDER_CONTACT

public RRI_I12_PROVIDER_CONTACT insertPROVIDER_CONTACT(int rep)
                                                throws HL7Exception

Inserts a specific repetition of PROVIDER_CONTACT (a Group object)

Throws:

HL7Exception

See Also:

• AbstractGroup#insertRepetition(Structure, int)

removePROVIDER_CONTACT

public RRI_I12_PROVIDER_CONTACT removePROVIDER_CONTACT(int rep)
                                                throws HL7Exception

Removes a specific repetition of PROVIDER_CONTACT (a Group object)

Throws:

HL7Exception

See Also:

• AbstractGroup.removeRepetition(String, int)

getPID

public PID getPID()

Returns PID (Patient identification) - creates it if necessary

getACC

public ACC getACC()

Returns ACC (Accident) - creates it if necessary

getDG1

public DG1 getDG1()

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

getDG1

public DG1 getDG1(int rep)

Returns a specific repetition of DG1 (Diagnosis) - 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

getDG1All

public List<DG1> getDG1All()
                    throws HL7Exception

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

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

Throws:

HL7Exception

insertDG1

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

Inserts a specific repetition of DG1 (Diagnosis)

Throws:

HL7Exception

See Also:

• AbstractGroup#insertRepetition(Structure, int)

insertDG1

public DG1 insertDG1(int rep)
              throws HL7Exception

Inserts a specific repetition of DG1 (Diagnosis)

Throws:

HL7Exception

See Also:

• AbstractGroup#insertRepetition(Structure, int)

removeDG1

public DG1 removeDG1(int rep)
              throws HL7Exception

Removes a specific repetition of DG1 (Diagnosis)

Throws:

HL7Exception

See Also:

• AbstractGroup.removeRepetition(String, int)

getDRG

public DRG getDRG()

Returns the first repetition of DRG (Diagnosis Related Group) - creates it if necessary

getDRG

public DRG getDRG(int rep)

Returns a specific repetition of DRG (Diagnosis Related Group) - 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

getDRGAll

public List<DRG> getDRGAll()
                    throws HL7Exception

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

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

Throws:

HL7Exception

insertDRG

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

Inserts a specific repetition of DRG (Diagnosis Related Group)

Throws:

HL7Exception

See Also:

• AbstractGroup#insertRepetition(Structure, int)

insertDRG

public DRG insertDRG(int rep)
              throws HL7Exception

Inserts a specific repetition of DRG (Diagnosis Related Group)

Throws:

HL7Exception

See Also:

• AbstractGroup#insertRepetition(Structure, int)

removeDRG

public DRG removeDRG(int rep)
              throws HL7Exception

Removes a specific repetition of DRG (Diagnosis Related Group)

Throws:

HL7Exception

See Also:

• AbstractGroup.removeRepetition(String, int)

getAL1

public AL1 getAL1()

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

getAL1

public AL1 getAL1(int rep)

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

getAL1All

public List<AL1> getAL1All()
                    throws HL7Exception

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

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

Throws:

HL7Exception

insertAL1

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

Inserts a specific repetition of AL1 (Patient allergy information)

Throws:

HL7Exception

See Also:

• AbstractGroup#insertRepetition(Structure, int)

insertAL1

public AL1 insertAL1(int rep)
              throws HL7Exception

Inserts a specific repetition of AL1 (Patient allergy information)

Throws:

HL7Exception

See Also:

• AbstractGroup#insertRepetition(Structure, int)

removeAL1

public AL1 removeAL1(int rep)
              throws HL7Exception

Removes a specific repetition of AL1 (Patient allergy information)

Throws:

HL7Exception

See Also:

• AbstractGroup.removeRepetition(String, int)

getPROCEDURE

public RRI_I12_PROCEDURE getPROCEDURE()

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

getPROCEDURE

public RRI_I12_PROCEDURE getPROCEDURE(int rep)

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

getPROCEDUREReps

public int getPROCEDUREReps()

Returns the number of existing repetitions of PROCEDURE

getPROCEDUREAll

public List<RRI_I12_PROCEDURE> getPROCEDUREAll()
                                        throws HL7Exception

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

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

Throws:

HL7Exception

insertPROCEDURE

public void insertPROCEDURE(RRI_I12_PROCEDURE structure,
 int rep)
                     throws HL7Exception

Inserts a specific repetition of PROCEDURE (a Group object)

Throws:

HL7Exception

See Also:

• AbstractGroup#insertRepetition(Structure, int)

insertPROCEDURE

public RRI_I12_PROCEDURE insertPROCEDURE(int rep)
                                  throws HL7Exception

Inserts a specific repetition of PROCEDURE (a Group object)

Throws:

HL7Exception

See Also:

• AbstractGroup#insertRepetition(Structure, int)

removePROCEDURE

public RRI_I12_PROCEDURE removePROCEDURE(int rep)
                                  throws HL7Exception

Removes a specific repetition of PROCEDURE (a Group object)

Throws:

HL7Exception

See Also:

• AbstractGroup.removeRepetition(String, int)

getOBSERVATION

public RRI_I12_OBSERVATION getOBSERVATION()

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

getOBSERVATION

public RRI_I12_OBSERVATION getOBSERVATION(int rep)

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

getOBSERVATIONReps

public int getOBSERVATIONReps()

Returns the number of existing repetitions of OBSERVATION

getOBSERVATIONAll

public List<RRI_I12_OBSERVATION> getOBSERVATIONAll()
                                            throws HL7Exception

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

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

Throws:

HL7Exception

insertOBSERVATION

public void insertOBSERVATION(RRI_I12_OBSERVATION structure,
 int rep)
                       throws HL7Exception

Inserts a specific repetition of OBSERVATION (a Group object)

Throws:

HL7Exception

See Also:

• AbstractGroup#insertRepetition(Structure, int)

insertOBSERVATION

public RRI_I12_OBSERVATION insertOBSERVATION(int rep)
                                      throws HL7Exception

Inserts a specific repetition of OBSERVATION (a Group object)

Throws:

HL7Exception

See Also:

• AbstractGroup#insertRepetition(Structure, int)

removeOBSERVATION

public RRI_I12_OBSERVATION removeOBSERVATION(int rep)
                                      throws HL7Exception

Removes a specific repetition of OBSERVATION (a Group object)

Throws:

HL7Exception

See Also:

• AbstractGroup.removeRepetition(String, int)

getPATIENT_VISIT

public RRI_I12_PATIENT_VISIT getPATIENT_VISIT()

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

getNTE

public NTE getNTE()

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

getNTE

public NTE getNTE(int rep)

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

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 (Notes and Comments)

Throws:

HL7Exception

See Also:

• AbstractGroup#insertRepetition(Structure, int)

insertNTE

public NTE insertNTE(int rep)
              throws HL7Exception

Inserts a specific repetition of NTE (Notes and Comments)

Throws:

HL7Exception

See Also:

• AbstractGroup#insertRepetition(Structure, int)

removeNTE

public NTE removeNTE(int rep)
              throws HL7Exception

Removes a specific repetition of NTE (Notes and Comments)

Throws:

HL7Exception

See Also:

• AbstractGroup.removeRepetition(String, int)