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

Class RDS_O13_PATIENT

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

Represents a RDS_O13_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: NTE (Notes and Comments) optional repeating
  • 4: AL1 (Patient allergy information) optional repeating
  • 5: RDS_O13_PATIENT_VISIT (a Group object) optional
See Also:

  • Constructor Details

  • Method Details

    • getVersion

      public String getVersion()
      Returns "2.4"

    • 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

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

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

    • getPATIENT_VISIT

      public RDS_O13_PATIENT_VISIT getPATIENT_VISIT()
      Returns PATIENT_VISIT (a Group object) - creates it if necessary