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

Class RDS_O13_ENCODING

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

Represents a RDS_O13_ENCODING 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: RXE (Pharmacy/Treatment Encoded Order)
  • 2: NTE (Notes and Comments) optional repeating
  • 3: RDS_O13_TIMING_ENCODED (a Group object) repeating
  • 4: RXR (Pharmacy/Treatment Route) repeating
  • 5: RXC (Pharmacy/Treatment Component Order) optional repeating
See Also:

  • Constructor Details

  • Method Details

    • getVersion

      public String getVersion()
      Returns "2.5.1"

    • 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 RDS_O13_TIMING_ENCODED getTIMING_ENCODED()
      Returns the first repetition of TIMING_ENCODED (a Group object) - creates it if necessary

    • getTIMING_ENCODED

      public RDS_O13_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<RDS_O13_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(RDS_O13_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 RDS_O13_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 RDS_O13_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: