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

Class RDE_O11_ORDER

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

Represents a RDE_O11_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: RDE_O11_TIMING (a Group object) optional repeating
  • 3: RDE_O11_ORDER_DETAIL (a Group object) optional
  • 4: RXE (Pharmacy/Treatment Encoded Order)
  • 5: NTE (Notes and Comments) optional repeating
  • 6: RDE_O11_TIMING_ENCODED (a Group object) repeating
  • 7: RXR (Pharmacy/Treatment Route) repeating
  • 8: RXC (Pharmacy/Treatment Component Order) optional repeating
  • 9: RDE_O11_OBSERVATION (a Group object) optional repeating
  • 10: FT1 (Financial Transaction) optional repeating
  • 11: BLG (Billing) optional
  • 12: CTI (Clinical Trial Identification) optional 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 RDE_O11_TIMING getTIMING()
      Returns the first repetition of TIMING (a Group object) - creates it if necessary

    • getTIMING

      public RDE_O11_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<RDE_O11_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(RDE_O11_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 RDE_O11_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 RDE_O11_TIMING removeTIMING(int rep) throws HL7Exception
      Removes a specific repetition of TIMING (a Group object)
      Throws:
      HL7Exception
      See Also:

    • getORDER_DETAIL

      public RDE_O11_ORDER_DETAIL getORDER_DETAIL()
      Returns ORDER_DETAIL (a Group object) - creates it if necessary

    • getRXE

      public RXE getRXE()
      Returns RXE (Pharmacy/Treatment Encoded 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_ENCODED

      public RDE_O11_TIMING_ENCODED getTIMING_ENCODED()
      Returns the first repetition of TIMING_ENCODED (a Group object) - creates it if necessary

    • getTIMING_ENCODED

      public RDE_O11_TIMING_ENCODED getTIMING_ENCODED(int rep)
      Returns a specific repetition of TIMING_ENCODED (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_ENCODEDReps

      public int getTIMING_ENCODEDReps()
      Returns the number of existing repetitions of TIMING_ENCODED

    • getTIMING_ENCODEDAll

      public List<RDE_O11_TIMING_ENCODED> getTIMING_ENCODEDAll() throws HL7Exception

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

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

      Throws:
      HL7Exception

    • insertTIMING_ENCODED

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

    • insertTIMING_ENCODED

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

    • removeTIMING_ENCODED

      public RDE_O11_TIMING_ENCODED removeTIMING_ENCODED(int rep) throws HL7Exception
      Removes a specific repetition of TIMING_ENCODED (a Group object)
      Throws:
      HL7Exception
      See Also:

    • getRXR

      public RXR getRXR()
      Returns the first repetition of RXR (Pharmacy/Treatment Route) - creates it if necessary

    • getRXR

      public RXR getRXR(int rep)
      Returns a specific repetition of RXR (Pharmacy/Treatment Route) - 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.

    • getRXRReps

      public int getRXRReps()
      Returns the number of existing repetitions of RXR

    • getRXRAll

      public List<RXR> getRXRAll() throws HL7Exception

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

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

      Throws:
      HL7Exception

    • insertRXR

      public void insertRXR(RXR structure, int rep) throws HL7Exception
      Inserts a specific repetition of RXR (Pharmacy/Treatment Route)
      Throws:
      HL7Exception
      See Also:
      • AbstractGroup#insertRepetition(Structure, int)

    • insertRXR

      public RXR insertRXR(int rep) throws HL7Exception
      Inserts a specific repetition of RXR (Pharmacy/Treatment Route)
      Throws:
      HL7Exception
      See Also:
      • AbstractGroup#insertRepetition(Structure, int)

    • removeRXR

      public RXR removeRXR(int rep) throws HL7Exception
      Removes a specific repetition of RXR (Pharmacy/Treatment Route)
      Throws:
      HL7Exception
      See Also:

    • getRXC

      public RXC getRXC()
      Returns the first repetition of RXC (Pharmacy/Treatment Component Order) - creates it if necessary

    • getRXC

      public RXC getRXC(int rep)
      Returns a specific repetition of RXC (Pharmacy/Treatment Component Order) - 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.

    • getRXCReps

      public int getRXCReps()
      Returns the number of existing repetitions of RXC

    • getRXCAll

      public List<RXC> getRXCAll() throws HL7Exception

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

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

      Throws:
      HL7Exception

    • insertRXC

      public void insertRXC(RXC structure, int rep) throws HL7Exception
      Inserts a specific repetition of RXC (Pharmacy/Treatment Component Order)
      Throws:
      HL7Exception
      See Also:
      • AbstractGroup#insertRepetition(Structure, int)

    • insertRXC

      public RXC insertRXC(int rep) throws HL7Exception
      Inserts a specific repetition of RXC (Pharmacy/Treatment Component Order)
      Throws:
      HL7Exception
      See Also:
      • AbstractGroup#insertRepetition(Structure, int)

    • removeRXC

      public RXC removeRXC(int rep) throws HL7Exception
      Removes a specific repetition of RXC (Pharmacy/Treatment Component Order)
      Throws:
      HL7Exception
      See Also:

    • getOBSERVATION

      public RDE_O11_OBSERVATION getOBSERVATION()
      Returns the first repetition of OBSERVATION (a Group object) - creates it if necessary

    • getOBSERVATION

      public RDE_O11_OBSERVATION getOBSERVATION(int rep)
      Returns a specific repetition of OBSERVATION (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.

    • getOBSERVATIONReps

      public int getOBSERVATIONReps()
      Returns the number of existing repetitions of OBSERVATION

    • getOBSERVATIONAll

      public List<RDE_O11_OBSERVATION> getOBSERVATIONAll() throws HL7Exception

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

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

      Throws:
      HL7Exception

    • insertOBSERVATION

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

    • insertOBSERVATION

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

    • removeOBSERVATION

      public RDE_O11_OBSERVATION removeOBSERVATION(int rep) throws HL7Exception
      Removes a specific repetition of OBSERVATION (a Group object)
      Throws:
      HL7Exception
      See Also:

    • getFT1

      public FT1 getFT1()
      Returns the first repetition of FT1 (Financial Transaction) - creates it if necessary

    • getFT1

      public FT1 getFT1(int rep)
      Returns a specific repetition of FT1 (Financial Transaction) - 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.

    • getFT1Reps

      public int getFT1Reps()
      Returns the number of existing repetitions of FT1

    • getFT1All

      public List<FT1> getFT1All() throws HL7Exception

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

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

      Throws:
      HL7Exception

    • insertFT1

      public void insertFT1(FT1 structure, int rep) throws HL7Exception
      Inserts a specific repetition of FT1 (Financial Transaction)
      Throws:
      HL7Exception
      See Also:
      • AbstractGroup#insertRepetition(Structure, int)

    • insertFT1

      public FT1 insertFT1(int rep) throws HL7Exception
      Inserts a specific repetition of FT1 (Financial Transaction)
      Throws:
      HL7Exception
      See Also:
      • AbstractGroup#insertRepetition(Structure, int)

    • removeFT1

      public FT1 removeFT1(int rep) throws HL7Exception
      Removes a specific repetition of FT1 (Financial Transaction)
      Throws:
      HL7Exception
      See Also:

    • getBLG

      public BLG getBLG()
      Returns BLG (Billing) - creates it if necessary

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