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

Class RQP_I04

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

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

  • 1: MSH (Message Header)
  • 2: RQP_I04_PROVIDER (a Group object) repeating
  • 3: PID (Patient identification)
  • 4: NK1 (Next of kin / associated parties) optional repeating
  • 5: GT1 (Guarantor) optional repeating
  • 6: NTE (Notes and Comments) optional repeating
See Also:

  • Constructor Details

    • RQP_I04

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

    • RQP_I04

      public RQP_I04(ModelClassFactory factory)
      Creates a new RQP_I04 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

    • getPROVIDER

      public RQP_I04_PROVIDER getPROVIDER()

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

    • getPROVIDER

      public RQP_I04_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<RQP_I04_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(RQP_I04_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 RQP_I04_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 RQP_I04_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 / 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

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

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

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