Package ca.uhn.hl7v2.model.v24.group

Class OMP_O09_ORDER

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

Represents a OMP_O09_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: RXO (Pharmacy/Treatment Order)
  • 3: NTE (Notes and Comments) optional repeating
  • 4: RXR (Pharmacy/Treatment Route) repeating
  • 5: OMP_O09_COMPONENT (a Group object) optional
  • 6: OMP_O09_OBSERVATION (a Group object) optional repeating
  • 7: FT1 (Financial Transaction) optional repeating
  • 8: BLG (Billing) optional
See Also:

  • Constructor Details

  • Method Details

    • getVersion

      public String getVersion()
      Returns "2.4"

    • getORC

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

    • getRXO

      public RXO getRXO()
      Returns RXO (Pharmacy/Treatment 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:

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

    • getCOMPONENT

      public OMP_O09_COMPONENT getCOMPONENT()
      Returns COMPONENT (a Group object) - creates it if necessary

    • getOBSERVATION

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

    • getOBSERVATION

      public OMP_O09_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<OMP_O09_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(OMP_O09_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 OMP_O09_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 OMP_O09_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