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

Class ORI_O24_ORDER

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

Represents a ORI_O24_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: ORC (Common Order)
  • 2: ORI_O24_TIMING (a Group object) optional repeating
  • 3: OBR (Observation Request)
  • 4: NTE (Notes and Comments) optional repeating
  • 5: IPC (Imaging Procedure Control Segment) repeating
See Also:

  • Constructor Details

  • Method Details

    • getVersion

      public String getVersion()
      Returns "2.5.1"

    • getORC

      public ORC getORC()
      Returns ORC (Common Order) - creates it if necessary

    • getTIMING

      public ORI_O24_TIMING getTIMING()
      Returns the first repetition of TIMING (a Group object) - creates it if necessary

    • getTIMING

      public ORI_O24_TIMING getTIMING(int rep)
      Returns a specific repetition of TIMING (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.

    • getTIMINGReps

      public int getTIMINGReps()
      Returns the number of existing repetitions of TIMING

    • getTIMINGAll

      public List<ORI_O24_TIMING> getTIMINGAll() throws HL7Exception

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

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

      Throws:
      HL7Exception

    • insertTIMING

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

    • insertTIMING

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

    • removeTIMING

      public ORI_O24_TIMING removeTIMING(int rep) throws HL7Exception
      Removes a specific repetition of TIMING (a Group object)
      Throws:
      HL7Exception
      See Also:

    • getOBR

      public OBR getOBR()
      Returns OBR (Observation Request) - 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:

    • getIPC

      public IPC getIPC()
      Returns the first repetition of IPC (Imaging Procedure Control Segment) - creates it if necessary

    • getIPC

      public IPC getIPC(int rep)
      Returns a specific repetition of IPC (Imaging Procedure Control Segment) - 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.

    • getIPCReps

      public int getIPCReps()
      Returns the number of existing repetitions of IPC

    • getIPCAll

      public List<IPC> getIPCAll() throws HL7Exception

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

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

      Throws:
      HL7Exception

    • insertIPC

      public void insertIPC(IPC structure, int rep) throws HL7Exception
      Inserts a specific repetition of IPC (Imaging Procedure Control Segment)
      Throws:
      HL7Exception
      See Also:
      • AbstractGroup#insertRepetition(Structure, int)

    • insertIPC

      public IPC insertIPC(int rep) throws HL7Exception
      Inserts a specific repetition of IPC (Imaging Procedure Control Segment)
      Throws:
      HL7Exception
      See Also:
      • AbstractGroup#insertRepetition(Structure, int)

    • removeIPC

      public IPC removeIPC(int rep) throws HL7Exception
      Removes a specific repetition of IPC (Imaging Procedure Control Segment)
      Throws:
      HL7Exception
      See Also: