Package ca.uhn.hl7v2.model.v251.group

Class RSP_Z90_PATIENT

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

Represents a RSP_Z90_PATIENT 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: PID (Patient Identification)
  • 2: PD1 (Patient Additional Demographic) optional
  • 3: NK1 (Next of Kin / Associated Parties) optional repeating
  • 4: NTE (Notes and Comments) optional repeating
  • 5: RSP_Z90_VISIT (a Group object) optional
See Also:

  • Constructor Details

  • Method Details

    • getVersion

      public String getVersion()
      Returns "2.5.1"

    • 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

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

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

    • getVISIT

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