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

Class RQI_I01

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

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

  • 1: MSH (Message header segment)
  • 2: RQI_I01_PRDCTD (a Group object) repeating
  • 3: PID (Patient Identification)
  • 4: NK1 (Next of kin) optional repeating
  • 5: RQI_I01_GUARANTOR_INSURANCE (a Group object) optional
  • 6: NTE (Notes and comments segment) optional repeating
See Also:

  • Constructor Details

    • RQI_I01

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

    • RQI_I01

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

    • getPRDCTD

      public RQI_I01_PRDCTD getPRDCTD()

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

    • getPRDCTD

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

    • getPRDCTDAll

      public List<RQI_I01_PRDCTD> getPRDCTDAll() throws HL7Exception

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

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

      Throws:
      HL7Exception

    • insertPRDCTD

      public void insertPRDCTD(RQI_I01_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 RQI_I01_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 RQI_I01_PRDCTD removePRDCTD(int rep) throws HL7Exception

      Removes a specific repetition of PRDCTD (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:

    • getGUARANTOR_INSURANCE

      public RQI_I01_GUARANTOR_INSURANCE getGUARANTOR_INSURANCE()

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

    • getNTE

      public NTE getNTE()

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

    • getNTE

      public NTE getNTE(int rep)

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

    • 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 segment)

      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 segment)

      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 segment)

      Throws:
      HL7Exception
      See Also: