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

Class OUL_R23_ORDER

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

Represents a OUL_R23_ORDER 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: OBR (Observation Request)
  • 2: ORC (Common Order) optional
  • 3: NTE (Notes and Comments) optional repeating
  • 4: OUL_R23_TIMING_QTY (a Group object) optional repeating
  • 5: OUL_R23_RESULT (a Group object) optional repeating
  • 6: CTI (Clinical Trial Identification) optional repeating
See Also:

  • Constructor Details

  • Method Details

    • getVersion

      public String getVersion()
      Returns "2.5.1"

    • getOBR

      public OBR getOBR()
      Returns OBR (Observation Request) - creates it if necessary

    • getORC

      public ORC getORC()
      Returns ORC (Common Order) - 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:

    • getTIMING_QTY

      public OUL_R23_TIMING_QTY getTIMING_QTY()
      Returns the first repetition of TIMING_QTY (a Group object) - creates it if necessary

    • getTIMING_QTY

      public OUL_R23_TIMING_QTY getTIMING_QTY(int rep)
      Returns a specific repetition of TIMING_QTY (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.

    • getTIMING_QTYReps

      public int getTIMING_QTYReps()
      Returns the number of existing repetitions of TIMING_QTY

    • getTIMING_QTYAll

      public List<OUL_R23_TIMING_QTY> getTIMING_QTYAll() throws HL7Exception

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

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

      Throws:
      HL7Exception

    • insertTIMING_QTY

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

    • insertTIMING_QTY

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

    • removeTIMING_QTY

      public OUL_R23_TIMING_QTY removeTIMING_QTY(int rep) throws HL7Exception
      Removes a specific repetition of TIMING_QTY (a Group object)
      Throws:
      HL7Exception
      See Also:

    • getRESULT

      public OUL_R23_RESULT getRESULT()
      Returns the first repetition of RESULT (a Group object) - creates it if necessary

    • getRESULT

      public OUL_R23_RESULT getRESULT(int rep)
      Returns a specific repetition of RESULT (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.

    • getRESULTReps

      public int getRESULTReps()
      Returns the number of existing repetitions of RESULT

    • getRESULTAll

      public List<OUL_R23_RESULT> getRESULTAll() throws HL7Exception

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

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

      Throws:
      HL7Exception

    • insertRESULT

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

    • insertRESULT

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

    • removeRESULT

      public OUL_R23_RESULT removeRESULT(int rep) throws HL7Exception
      Removes a specific repetition of RESULT (a Group object)
      Throws:
      HL7Exception
      See Also:

    • getCTI

      public CTI getCTI()
      Returns the first repetition of CTI (Clinical Trial Identification) - creates it if necessary

    • getCTI

      public CTI getCTI(int rep)
      Returns a specific repetition of CTI (Clinical Trial Identification) - 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.

    • getCTIReps

      public int getCTIReps()
      Returns the number of existing repetitions of CTI

    • getCTIAll

      public List<CTI> getCTIAll() throws HL7Exception

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

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

      Throws:
      HL7Exception

    • insertCTI

      public void insertCTI(CTI structure, int rep) throws HL7Exception
      Inserts a specific repetition of CTI (Clinical Trial Identification)
      Throws:
      HL7Exception
      See Also:
      • AbstractGroup#insertRepetition(Structure, int)

    • insertCTI

      public CTI insertCTI(int rep) throws HL7Exception
      Inserts a specific repetition of CTI (Clinical Trial Identification)
      Throws:
      HL7Exception
      See Also:
      • AbstractGroup#insertRepetition(Structure, int)

    • removeCTI

      public CTI removeCTI(int rep) throws HL7Exception
      Removes a specific repetition of CTI (Clinical Trial Identification)
      Throws:
      HL7Exception
      See Also: