Package ca.uhn.hl7v2.model.v22.group

Class ORR_O02_PATIENT

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

Represents a ORR_O02_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) optional
  • 2: NTE (NOTES AND COMMENTS) optional repeating
  • 3: ORR_O02_ORDER (a Group object) repeating
See Also:

  • Constructor Details

  • Method Details

    • getVersion

      public String getVersion()
      Returns "2.2"

    • getPID

      public PID getPID()
      Returns PID (PATIENT IDENTIFICATION) - 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:

    • getORDER

      public ORR_O02_ORDER getORDER()
      Returns the first repetition of ORDER (a Group object) - creates it if necessary

    • getORDER

      public ORR_O02_ORDER getORDER(int rep)
      Returns a specific repetition of ORDER (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.

    • getORDERReps

      public int getORDERReps()
      Returns the number of existing repetitions of ORDER

    • getORDERAll

      public List<ORR_O02_ORDER> getORDERAll() throws HL7Exception

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

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

      Throws:
      HL7Exception

    • insertORDER

      public void insertORDER(ORR_O02_ORDER structure, int rep) throws HL7Exception
      Inserts a specific repetition of ORDER (a Group object)
      Throws:
      HL7Exception
      See Also:
      • AbstractGroup#insertRepetition(Structure, int)

    • insertORDER

      public ORR_O02_ORDER insertORDER(int rep) throws HL7Exception
      Inserts a specific repetition of ORDER (a Group object)
      Throws:
      HL7Exception
      See Also:
      • AbstractGroup#insertRepetition(Structure, int)

    • removeORDER

      public ORR_O02_ORDER removeORDER(int rep) throws HL7Exception
      Removes a specific repetition of ORDER (a Group object)
      Throws:
      HL7Exception
      See Also: