Package ca.uhn.hl7v2.model.v23.group

Class RAS_O01_ORDER

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

Represents a RAS_O01_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 segment)
  • 2: RAS_O01_ORDER_DETAIL (a Group object) optional
  • 3: RAS_O01_ENCODING (a Group object) optional
  • 4: RXA (Pharmacy administration segment) repeating
  • 5: RXR (Pharmacy route segment)
  • 6: RAS_O01_OBSERVATION (a Group object) optional repeating
  • 7: CTI (Clinical Trial Identification) optional repeating
See Also:

  • Constructor Details

  • Method Details

    • getVersion

      public String getVersion()
      Returns "2.3"

    • getORC

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

    • getORDER_DETAIL

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

    • getENCODING

      public RAS_O01_ENCODING getENCODING()
      Returns ENCODING (a Group object) - creates it if necessary

    • getRXA

      public RXA getRXA()
      Returns the first repetition of RXA (Pharmacy administration segment) - creates it if necessary

    • getRXA

      public RXA getRXA(int rep)
      Returns a specific repetition of RXA (Pharmacy administration 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.

    • getRXAReps

      public int getRXAReps()
      Returns the number of existing repetitions of RXA

    • getRXAAll

      public List<RXA> getRXAAll() throws HL7Exception

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

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

      Throws:
      HL7Exception

    • insertRXA

      public void insertRXA(RXA structure, int rep) throws HL7Exception
      Inserts a specific repetition of RXA (Pharmacy administration segment)
      Throws:
      HL7Exception
      See Also:
      • AbstractGroup#insertRepetition(Structure, int)

    • insertRXA

      public RXA insertRXA(int rep) throws HL7Exception
      Inserts a specific repetition of RXA (Pharmacy administration segment)
      Throws:
      HL7Exception
      See Also:
      • AbstractGroup#insertRepetition(Structure, int)

    • removeRXA

      public RXA removeRXA(int rep) throws HL7Exception
      Removes a specific repetition of RXA (Pharmacy administration segment)
      Throws:
      HL7Exception
      See Also:

    • getRXR

      public RXR getRXR()
      Returns RXR (Pharmacy route segment) - creates it if necessary

    • getOBSERVATION

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

    • getOBSERVATION

      public RAS_O01_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<RAS_O01_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(RAS_O01_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 RAS_O01_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 RAS_O01_OBSERVATION removeOBSERVATION(int rep) throws HL7Exception
      Removes a specific repetition of OBSERVATION (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: