Package ca.uhn.hl7v2.model.v23.message

Class RPA_I09

java.lang.Object
ca.uhn.hl7v2.model.AbstractStructure
ca.uhn.hl7v2.model.AbstractGroup
ca.uhn.hl7v2.model.AbstractMessage
ca.uhn.hl7v2.model.v23.message.RPA_I09
All Implemented Interfaces:
Group, Message, Structure, Visitable, Serializable
public class RPA_I09 extends AbstractMessage

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

  • 1: MSH (Message header segment)
  • 2: MSA (Message acknowledgement segment)
  • 3: RF1 (Referral Information Segment) optional
  • 4: RPA_I09_AUTHORIZATION (a Group object) optional
  • 5: RPA_I09_PROVIDER (a Group object) repeating
  • 6: PID (Patient Identification)
  • 7: NK1 (Next of kin) optional repeating
  • 8: GT1 (Guarantor) optional repeating
  • 9: RPA_I09_INSURANCE (a Group object) optional repeating
  • 10: ACC (Accident) optional
  • 11: DG1 (Diagnosis) optional repeating
  • 12: DRG (Diagnosis Related Group) optional repeating
  • 13: AL1 (Patient allergy information) optional repeating
  • 14: RPA_I09_PROCEDURE (a Group object) repeating
  • 15: RPA_I09_RESULTS (a Group object) optional repeating
  • 16: RPA_I09_VISIT (a Group object) optional
See Also:

  • Constructor Details

    • RPA_I09

      public RPA_I09()
      Creates a new RPA_I09 message with DefaultModelClassFactory.

    • RPA_I09

      public RPA_I09(ModelClassFactory factory)
      Creates a new RPA_I09 message with custom ModelClassFactory.

  • Method Details

    • getVersion

      public String getVersion()
      Returns "2.3"
      Specified by:
      getVersion in interface Message
      Overrides:
      getVersion in class AbstractMessage

    • getMSH

      public MSH getMSH()

      Returns MSH (Message header segment) - creates it if necessary

    • getMSA

      public MSA getMSA()

      Returns MSA (Message acknowledgement segment) - creates it if necessary

    • getRF1

      public RF1 getRF1()

      Returns RF1 (Referral Information Segment) - creates it if necessary

    • getAUTHORIZATION

      public RPA_I09_AUTHORIZATION getAUTHORIZATION()

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

    • getPROVIDER

      public RPA_I09_PROVIDER getPROVIDER()

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

    • getPROVIDER

      public RPA_I09_PROVIDER getPROVIDER(int rep)

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

    • getPROVIDERReps

      public int getPROVIDERReps()

      Returns the number of existing repetitions of PROVIDER

    • getPROVIDERAll

      public List<RPA_I09_PROVIDER> getPROVIDERAll() throws HL7Exception

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

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

      Throws:
      HL7Exception

    • insertPROVIDER

      public void insertPROVIDER(RPA_I09_PROVIDER structure, int rep) throws HL7Exception

      Inserts a specific repetition of PROVIDER (a Group object)

      Throws:
      HL7Exception
      See Also:
      • AbstractGroup#insertRepetition(Structure, int)

    • insertPROVIDER

      public RPA_I09_PROVIDER insertPROVIDER(int rep) throws HL7Exception

      Inserts a specific repetition of PROVIDER (a Group object)

      Throws:
      HL7Exception
      See Also:
      • AbstractGroup#insertRepetition(Structure, int)

    • removePROVIDER

      public RPA_I09_PROVIDER removePROVIDER(int rep) throws HL7Exception

      Removes a specific repetition of PROVIDER (a Group object)

      Throws:
      HL7Exception
      See Also:

    • 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) - creates it if necessary

    • getNK1

      public NK1 getNK1(int rep)

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

    • getNK1All

      public List<NK1> getNK1All() throws HL7Exception

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

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

      Throws:
      HL7Exception

    • insertNK1

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

      Inserts a specific repetition of NK1 (Next of kin)

      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)

      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)

      Throws:
      HL7Exception
      See Also:

    • 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

    • getGT1All

      public List<GT1> getGT1All() throws HL7Exception

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

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

      Throws:
      HL7Exception

    • 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:

    • getINSURANCE

      public RPA_I09_INSURANCE getINSURANCE()

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

    • getINSURANCE

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

    • getINSURANCEAll

      public List<RPA_I09_INSURANCE> getINSURANCEAll() throws HL7Exception

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

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

      Throws:
      HL7Exception

    • insertINSURANCE

      public void insertINSURANCE(RPA_I09_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 RPA_I09_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 RPA_I09_INSURANCE removeINSURANCE(int rep) throws HL7Exception

      Removes a specific repetition of INSURANCE (a Group object)

      Throws:
      HL7Exception
      See Also:

    • 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:

    • 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:

    • 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:

    • getPROCEDURE

      public RPA_I09_PROCEDURE getPROCEDURE()

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

    • getPROCEDURE

      public RPA_I09_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<RPA_I09_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(RPA_I09_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 RPA_I09_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 RPA_I09_PROCEDURE removePROCEDURE(int rep) throws HL7Exception

      Removes a specific repetition of PROCEDURE (a Group object)

      Throws:
      HL7Exception
      See Also:

    • getRESULTS

      public RPA_I09_RESULTS getRESULTS()

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

    • getRESULTS

      public RPA_I09_RESULTS getRESULTS(int rep)

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

    • getRESULTSReps

      public int getRESULTSReps()

      Returns the number of existing repetitions of RESULTS

    • getRESULTSAll

      public List<RPA_I09_RESULTS> getRESULTSAll() throws HL7Exception

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

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

      Throws:
      HL7Exception

    • insertRESULTS

      public void insertRESULTS(RPA_I09_RESULTS structure, int rep) throws HL7Exception

      Inserts a specific repetition of RESULTS (a Group object)

      Throws:
      HL7Exception
      See Also:
      • AbstractGroup#insertRepetition(Structure, int)

    • insertRESULTS

      public RPA_I09_RESULTS insertRESULTS(int rep) throws HL7Exception

      Inserts a specific repetition of RESULTS (a Group object)

      Throws:
      HL7Exception
      See Also:
      • AbstractGroup#insertRepetition(Structure, int)

    • removeRESULTS

      public RPA_I09_RESULTS removeRESULTS(int rep) throws HL7Exception

      Removes a specific repetition of RESULTS (a Group object)

      Throws:
      HL7Exception
      See Also:

    • getVISIT

      public RPA_I09_VISIT getVISIT()

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