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

Class ORU_R01_ORDER_OBSERVATION

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

Represents a ORU_R01_ORDER_OBSERVATION 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) optional
  • 2: OBR (Observation Request)
  • 3: NTE (Notes and Comments) optional repeating
  • 4: ORU_R01_TIMING_QTY (a Group object) optional repeating
  • 5: CTD (Contact Data) optional
  • 6: ORU_R01_OBSERVATION (a Group object) optional repeating
  • 7: FT1 (Financial Transaction) optional repeating
  • 8: CTI (Clinical Trial Identification) optional repeating
  • 9: ORU_R01_SPECIMEN (a Group object) 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

    • getOBR

      public OBR getOBR()
      Returns OBR (Observation Request) - 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_QTY

      public ORU_R01_TIMING_QTY getTIMING_QTY()
      Returns the first repetition of TIMING_QTY (a Group object) - creates it if necessary

    • getTIMING_QTY

      public ORU_R01_TIMING_QTY getTIMING_QTY(int rep)
      Returns a specific repetition of TIMING_QTY (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_QTYReps

      public int getTIMING_QTYReps()
      Returns the number of existing repetitions of TIMING_QTY

    • getTIMING_QTYAll

      public List<ORU_R01_TIMING_QTY> getTIMING_QTYAll() throws HL7Exception

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

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

      Throws:
      HL7Exception

    • insertTIMING_QTY

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

    • insertTIMING_QTY

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

    • removeTIMING_QTY

      public ORU_R01_TIMING_QTY removeTIMING_QTY(int rep) throws HL7Exception
      Removes a specific repetition of TIMING_QTY (a Group object)
      Throws:
      HL7Exception
      See Also:

    • getCTD

      public CTD getCTD()
      Returns CTD (Contact Data) - creates it if necessary

    • getOBSERVATION

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

    • getOBSERVATION

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

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

    • getSPECIMEN

      public ORU_R01_SPECIMEN getSPECIMEN()
      Returns the first repetition of SPECIMEN (a Group object) - creates it if necessary

    • getSPECIMEN

      public ORU_R01_SPECIMEN getSPECIMEN(int rep)
      Returns a specific repetition of SPECIMEN (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.

    • getSPECIMENReps

      public int getSPECIMENReps()
      Returns the number of existing repetitions of SPECIMEN

    • getSPECIMENAll

      public List<ORU_R01_SPECIMEN> getSPECIMENAll() throws HL7Exception

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

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

      Throws:
      HL7Exception

    • insertSPECIMEN

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

    • insertSPECIMEN

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

    • removeSPECIMEN

      public ORU_R01_SPECIMEN removeSPECIMEN(int rep) throws HL7Exception
      Removes a specific repetition of SPECIMEN (a Group object)
      Throws:
      HL7Exception
      See Also: