ca.uhn.hl7v2.model.v24.message
Class REF_I12

java.lang.Object
  ca.uhn.hl7v2.model.AbstractGroup
      ca.uhn.hl7v2.model.AbstractMessage
          ca.uhn.hl7v2.model.v24.message.REF_I12

All Implemented Interfaces:

Group, Message, Structure, Serializable

public class REF_I12
extends AbstractMessage

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

• 1: MSH (Message Header)
• 2: RF1 (Referral Information) optional
• 3: REF_I12_AUTHORIZATION_CONTACT (a Group object) optional
• 4: REF_I12_PROVIDER_CONTACT (a Group object) repeating
• 5: PID (Patient identification)
• 6: NK1 (Next of kin / associated parties) optional repeating
• 7: GT1 (Guarantor) optional repeating
• 8: REF_I12_INSURANCE (a Group object) optional repeating
• 9: ACC (Accident) optional
• 10: DG1 (Diagnosis) optional repeating
• 11: DRG (Diagnosis Related Group) optional repeating
• 12: AL1 (Patient allergy information) optional repeating
• 13: REF_I12_PROCEDURE (a Group object) optional repeating
• 14: REF_I12_OBSERVATION (a Group object) optional repeating
• 15: REF_I12_PATIENT_VISIT (a Group object) optional
• 16: NTE (Notes and Comments) optional repeating

See Also:

Serialized Form

Constructor Summary

REF_I12()
Creates a new REF_I12 message with DefaultModelClassFactory.

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

Method Summary

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
int	getAL1Reps() Returns the number of existing repetitions of AL1
REF_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
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
int	getDRGReps() Returns the number of existing repetitions of DRG
GT1	getGT1() Returns the first repetition of GT1 (Guarantor) - creates it if necessary
GT1	getGT1(int rep) Returns a specific repetition of GT1 (Guarantor) - creates it if necessary
int	getGT1Reps() Returns the number of existing repetitions of GT1
REF_I12_INSURANCE	getINSURANCE() Returns the first repetition of INSURANCE (a Group object) - creates it if necessary
REF_I12_INSURANCE	getINSURANCE(int rep) Returns a specific repetition of INSURANCE (a Group object) - creates it if necessary
int	getINSURANCEReps() Returns the number of existing repetitions of INSURANCE
MSH	getMSH() Returns MSH (Message Header) - creates it if necessary
NK1	getNK1() Returns the first repetition of NK1 (Next of kin / associated parties) - creates it if necessary
NK1	getNK1(int rep) Returns a specific repetition of NK1 (Next of kin / associated parties) - creates it if necessary
int	getNK1Reps() Returns the number of existing repetitions of NK1
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
int	getNTEReps() Returns the number of existing repetitions of NTE
REF_I12_OBSERVATION	getOBSERVATION() Returns the first repetition of OBSERVATION (a Group object) - creates it if necessary
REF_I12_OBSERVATION	getOBSERVATION(int rep) Returns a specific repetition of OBSERVATION (a Group object) - creates it if necessary
int	getOBSERVATIONReps() Returns the number of existing repetitions of OBSERVATION
REF_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
REF_I12_PROCEDURE	getPROCEDURE() Returns the first repetition of PROCEDURE (a Group object) - creates it if necessary
REF_I12_PROCEDURE	getPROCEDURE(int rep) Returns a specific repetition of PROCEDURE (a Group object) - creates it if necessary
int	getPROCEDUREReps() Returns the number of existing repetitions of PROCEDURE
REF_I12_PROVIDER_CONTACT	getPROVIDER_CONTACT() Returns the first repetition of PROVIDER_CONTACT (a Group object) - creates it if necessary
REF_I12_PROVIDER_CONTACT	getPROVIDER_CONTACT(int rep) Returns a specific repetition of PROVIDER_CONTACT (a Group object) - creates it if necessary
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"
void	insertAL1(AL1 structure, int rep) Inserts a specific repetition of AL1 (Patient allergy information)
AL1	insertAL1(int rep) Inserts a specific repetition of AL1 (Patient allergy information)
void	insertDG1(DG1 structure, int rep) Inserts a specific repetition of DG1 (Diagnosis)
DG1	insertDG1(int rep) Inserts a specific repetition of DG1 (Diagnosis)
void	insertDRG(DRG structure, int rep) Inserts a specific repetition of DRG (Diagnosis Related Group)
DRG	insertDRG(int rep) Inserts a specific repetition of DRG (Diagnosis Related Group)
void	insertGT1(GT1 structure, int rep) Inserts a specific repetition of GT1 (Guarantor)
GT1	insertGT1(int rep) Inserts a specific repetition of GT1 (Guarantor)
REF_I12_INSURANCE	insertINSURANCE(int rep) Inserts a specific repetition of INSURANCE (a Group object)
void	insertINSURANCE(REF_I12_INSURANCE structure, int rep) Inserts a specific repetition of INSURANCE (a Group object)
NK1	insertNK1(int rep) Inserts a specific repetition of NK1 (Next of kin / associated parties)
void	insertNK1(NK1 structure, int rep) Inserts a specific repetition of NK1 (Next of kin / associated parties)
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)
REF_I12_OBSERVATION	insertOBSERVATION(int rep) Inserts a specific repetition of OBSERVATION (a Group object)
void	insertOBSERVATION(REF_I12_OBSERVATION structure, int rep) Inserts a specific repetition of OBSERVATION (a Group object)
REF_I12_PROCEDURE	insertPROCEDURE(int rep) Inserts a specific repetition of PROCEDURE (a Group object)
void	insertPROCEDURE(REF_I12_PROCEDURE structure, int rep) Inserts a specific repetition of PROCEDURE (a Group object)
REF_I12_PROVIDER_CONTACT	insertPROVIDER_CONTACT(int rep) Inserts a specific repetition of PROVIDER_CONTACT (a Group object)
void	insertPROVIDER_CONTACT(REF_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)
GT1	removeGT1(int rep) Removes a specific repetition of GT1 (Guarantor)
REF_I12_INSURANCE	removeINSURANCE(int rep) Removes a specific repetition of INSURANCE (a Group object)
NK1	removeNK1(int rep) Removes a specific repetition of NK1 (Next of kin / associated parties)
NTE	removeNTE(int rep) Removes a specific repetition of NTE (Notes and Comments)
REF_I12_OBSERVATION	removeOBSERVATION(int rep) Removes a specific repetition of OBSERVATION (a Group object)
REF_I12_PROCEDURE	removePROCEDURE(int rep) Removes a specific repetition of PROCEDURE (a Group object)
REF_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

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

REF_I12

public REF_I12()

Creates a new REF_I12 message with DefaultModelClassFactory.

REF_I12

public REF_I12(ModelClassFactory factory)

Creates a new REF_I12 message with custom ModelClassFactory.

Method Detail

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

getRF1

public RF1 getRF1()

Returns RF1 (Referral Information) - creates it if necessary

getAUTHORIZATION_CONTACT

public REF_I12_AUTHORIZATION_CONTACT getAUTHORIZATION_CONTACT()

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

getPROVIDER_CONTACT

public REF_I12_PROVIDER_CONTACT getPROVIDER_CONTACT()

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

getPROVIDER_CONTACT

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

insertPROVIDER_CONTACT

public void insertPROVIDER_CONTACT(REF_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 REF_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 REF_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

getNK1

public NK1 getNK1()

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

getNK1

public NK1 getNK1(int rep)

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

Throws:

HL7Exception

See Also:

AbstractGroup\#insertRepetition(Structure, int)

insertNK1

public NK1 insertNK1(int rep)
              throws HL7Exception

Inserts a specific repetition of NK1 (Next of kin / associated parties)

Throws:

HL7Exception

See Also:

AbstractGroup\#insertRepetition(Structure, int)

removeNK1

public NK1 removeNK1(int rep)
              throws HL7Exception

Removes a specific repetition of NK1 (Next of kin / associated parties)

Throws:

HL7Exception

See Also:

AbstractGroup\#removeRepetition(String, int)

getGT1

public GT1 getGT1()

Returns the first repetition of GT1 (Guarantor) - creates it if necessary

getGT1

public GT1 getGT1(int rep)

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

getGT1Reps

public int getGT1Reps()

Returns the number of existing repetitions of GT1

insertGT1

public void insertGT1(GT1 structure,
                      int rep)
               throws HL7Exception

Inserts a specific repetition of GT1 (Guarantor)

Throws:

HL7Exception

See Also:

AbstractGroup\#insertRepetition(Structure, int)

insertGT1

public GT1 insertGT1(int rep)
              throws HL7Exception

Inserts a specific repetition of GT1 (Guarantor)

Throws:

HL7Exception

See Also:

AbstractGroup\#insertRepetition(Structure, int)

removeGT1

public GT1 removeGT1(int rep)
              throws HL7Exception

Removes a specific repetition of GT1 (Guarantor)

Throws:

HL7Exception

See Also:

AbstractGroup\#removeRepetition(String, int)

getINSURANCE

public REF_I12_INSURANCE getINSURANCE()

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

getINSURANCE

public REF_I12_INSURANCE getINSURANCE(int rep)

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

getINSURANCEReps

public int getINSURANCEReps()

Returns the number of existing repetitions of INSURANCE

insertINSURANCE

public void insertINSURANCE(REF_I12_INSURANCE structure,
                            int rep)
                     throws HL7Exception

Inserts a specific repetition of INSURANCE (a Group object)

Throws:

HL7Exception

See Also:

AbstractGroup\#insertRepetition(Structure, int)

insertINSURANCE

public REF_I12_INSURANCE insertINSURANCE(int rep)
                                  throws HL7Exception

Inserts a specific repetition of INSURANCE (a Group object)

Throws:

HL7Exception

See Also:

AbstractGroup\#insertRepetition(Structure, int)

removeINSURANCE

public REF_I12_INSURANCE removeINSURANCE(int rep)
                                  throws HL7Exception

Removes a specific repetition of INSURANCE (a Group object)

Throws:

HL7Exception

See Also:

AbstractGroup\#removeRepetition(String, int)

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

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

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

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 REF_I12_PROCEDURE getPROCEDURE()

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

getPROCEDURE

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

insertPROCEDURE

public void insertPROCEDURE(REF_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 REF_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 REF_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 REF_I12_OBSERVATION getOBSERVATION()

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

getOBSERVATION

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

insertOBSERVATION

public void insertOBSERVATION(REF_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 REF_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 REF_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 REF_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

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)