Package ca.uhn.hl7v2.model.v24.group

Class ADR_A19_QUERY_RESPONSE

java.lang.Object
ca.uhn.hl7v2.model.AbstractStructure
ca.uhn.hl7v2.model.AbstractGroup
ca.uhn.hl7v2.model.v24.group.ADR_A19_QUERY_RESPONSE
All Implemented Interfaces:
Group, Structure, Visitable, Serializable
public class ADR_A19_QUERY_RESPONSE extends AbstractGroup

Represents a ADR_A19_QUERY_RESPONSE group structure (a Group object). A Group is an ordered collection of message segments that can repeat together or be optionally in/excluded together. This Group contains the following elements:

  • 1: EVN (Event Type) optional
  • 2: PID (Patient identification)
  • 3: PD1 (patient additional demographic) optional
  • 4: ROL (Role) optional repeating
  • 5: NK1 (Next of kin / associated parties) optional repeating
  • 6: PV1 (Patient visit)
  • 7: PV2 (Patient visit - additional information) optional
  • 8: ROL (Role) optional repeating
  • 9: DB1 (Disability) optional repeating
  • 10: OBX (Observation/Result) optional repeating
  • 11: AL1 (Patient allergy information) optional repeating
  • 12: DG1 (Diagnosis) optional repeating
  • 13: DRG (Diagnosis Related Group) optional
  • 14: ADR_A19_PROCEDURE (a Group object) optional repeating
  • 15: GT1 (Guarantor) optional repeating
  • 16: ADR_A19_INSURANCE (a Group object) optional repeating
  • 17: ACC (Accident) optional
  • 18: UB1 (UB82) optional
  • 19: UB2 (UB92 Data) optional
See Also:

  • Constructor Details

  • Method Details

    • getVersion

      public String getVersion()
      Returns "2.4"

    • getEVN

      public EVN getEVN()
      Returns EVN (Event Type) - creates it if necessary

    • getPID

      public PID getPID()
      Returns PID (Patient identification) - creates it if necessary

    • getPD1

      public PD1 getPD1()
      Returns PD1 (patient additional demographic) - creates it if necessary

    • getROL

      public ROL getROL()
      Returns the first repetition of ROL (Role) - creates it if necessary

    • getROL

      public ROL getROL(int rep)
      Returns a specific repetition of ROL (Role) - 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.

    • getROLReps

      public int getROLReps()
      Returns the number of existing repetitions of ROL

    • getROLAll

      public List<ROL> getROLAll() throws HL7Exception

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

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

      Throws:
      HL7Exception

    • insertROL

      public void insertROL(ROL structure, int rep) throws HL7Exception
      Inserts a specific repetition of ROL (Role)
      Throws:
      HL7Exception
      See Also:
      • AbstractGroup#insertRepetition(Structure, int)

    • insertROL

      public ROL insertROL(int rep) throws HL7Exception
      Inserts a specific repetition of ROL (Role)
      Throws:
      HL7Exception
      See Also:
      • AbstractGroup#insertRepetition(Structure, int)

    • removeROL

      public ROL removeROL(int rep) throws HL7Exception
      Removes a specific repetition of ROL (Role)
      Throws:
      HL7Exception
      See Also:

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

    • getPV1

      public PV1 getPV1()
      Returns PV1 (Patient visit) - creates it if necessary

    • getPV2

      public PV2 getPV2()
      Returns PV2 (Patient visit - additional information) - creates it if necessary

    • getROL2

      public ROL getROL2()
      Returns the first repetition of ROL2 (Role) - creates it if necessary

    • getROL2

      public ROL getROL2(int rep)
      Returns a specific repetition of ROL (Role) - 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.

    • getROL2Reps

      public int getROL2Reps()
      Returns the number of existing repetitions of ROL2

    • getROL2All

      public List<ROL> getROL2All() throws HL7Exception

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

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

      Throws:
      HL7Exception

    • insertROL2

      public void insertROL2(ROL structure, int rep) throws HL7Exception
      Inserts a specific repetition of ROL2 (Role)
      Throws:
      HL7Exception
      See Also:
      • AbstractGroup#insertRepetition(Structure, int)

    • insertROL2

      public ROL insertROL2(int rep) throws HL7Exception
      Inserts a specific repetition of ROL2 (Role)
      Throws:
      HL7Exception
      See Also:
      • AbstractGroup#insertRepetition(Structure, int)

    • removeROL2

      public ROL removeROL2(int rep) throws HL7Exception
      Removes a specific repetition of ROL2 (Role)
      Throws:
      HL7Exception
      See Also:

    • getDB1

      public DB1 getDB1()
      Returns the first repetition of DB1 (Disability) - creates it if necessary

    • getDB1

      public DB1 getDB1(int rep)
      Returns a specific repetition of DB1 (Disability) - 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.

    • getDB1Reps

      public int getDB1Reps()
      Returns the number of existing repetitions of DB1

    • getDB1All

      public List<DB1> getDB1All() throws HL7Exception

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

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

      Throws:
      HL7Exception

    • insertDB1

      public void insertDB1(DB1 structure, int rep) throws HL7Exception
      Inserts a specific repetition of DB1 (Disability)
      Throws:
      HL7Exception
      See Also:
      • AbstractGroup#insertRepetition(Structure, int)

    • insertDB1

      public DB1 insertDB1(int rep) throws HL7Exception
      Inserts a specific repetition of DB1 (Disability)
      Throws:
      HL7Exception
      See Also:
      • AbstractGroup#insertRepetition(Structure, int)

    • removeDB1

      public DB1 removeDB1(int rep) throws HL7Exception
      Removes a specific repetition of DB1 (Disability)
      Throws:
      HL7Exception
      See Also:

    • getOBX

      public OBX getOBX()
      Returns the first repetition of OBX (Observation/Result) - creates it if necessary

    • getOBX

      public OBX getOBX(int rep)
      Returns a specific repetition of OBX (Observation/Result) - 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.

    • getOBXReps

      public int getOBXReps()
      Returns the number of existing repetitions of OBX

    • getOBXAll

      public List<OBX> getOBXAll() throws HL7Exception

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

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

      Throws:
      HL7Exception

    • insertOBX

      public void insertOBX(OBX structure, int rep) throws HL7Exception
      Inserts a specific repetition of OBX (Observation/Result)
      Throws:
      HL7Exception
      See Also:
      • AbstractGroup#insertRepetition(Structure, int)

    • insertOBX

      public OBX insertOBX(int rep) throws HL7Exception
      Inserts a specific repetition of OBX (Observation/Result)
      Throws:
      HL7Exception
      See Also:
      • AbstractGroup#insertRepetition(Structure, int)

    • removeOBX

      public OBX removeOBX(int rep) throws HL7Exception
      Removes a specific repetition of OBX (Observation/Result)
      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:

    • 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 DRG (Diagnosis Related Group) - creates it if necessary

    • getPROCEDURE

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

    • getPROCEDURE

      public ADR_A19_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<ADR_A19_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(ADR_A19_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 ADR_A19_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 ADR_A19_PROCEDURE removePROCEDURE(int rep) throws HL7Exception
      Removes a specific repetition of PROCEDURE (a Group object)
      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 ADR_A19_INSURANCE getINSURANCE()
      Returns the first repetition of INSURANCE (a Group object) - creates it if necessary

    • getINSURANCE

      public ADR_A19_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<ADR_A19_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(ADR_A19_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 ADR_A19_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 ADR_A19_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

    • getUB1

      public UB1 getUB1()
      Returns UB1 (UB82) - creates it if necessary

    • getUB2

      public UB2 getUB2()
      Returns UB2 (UB92 Data) - creates it if necessary