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

Class ORP_O10_ORDER_DETAIL

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

Represents a ORP_O10_ORDER_DETAIL 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: RXO (Pharmacy/Treatment Order)
  • 2: NTE (Notes and Comments) optional repeating
  • 3: RXR (Pharmacy/Treatment Route) repeating
  • 4: ORP_O10_COMPONENT (a Group object) optional repeating
See Also:

  • Constructor Details

  • Method Details

    • getVersion

      public String getVersion()
      Returns "2.5.1"

    • 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 ORP_O10_COMPONENT getCOMPONENT()
      Returns the first repetition of COMPONENT (a Group object) - creates it if necessary

    • getCOMPONENT

      public ORP_O10_COMPONENT getCOMPONENT(int rep)
      Returns a specific repetition of COMPONENT (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.

    • getCOMPONENTReps

      public int getCOMPONENTReps()
      Returns the number of existing repetitions of COMPONENT

    • getCOMPONENTAll

      public List<ORP_O10_COMPONENT> getCOMPONENTAll() throws HL7Exception

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

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

      Throws:
      HL7Exception

    • insertCOMPONENT

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

    • insertCOMPONENT

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

    • removeCOMPONENT

      public ORP_O10_COMPONENT removeCOMPONENT(int rep) throws HL7Exception
      Removes a specific repetition of COMPONENT (a Group object)
      Throws:
      HL7Exception
      See Also: