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

Class OMG_O19_ORDER

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

Represents a OMG_O19_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: OBR (Observation Request)
  • 3: NTE (Notes and Comments) optional repeating
  • 4: CTD (Contact Data) optional
  • 5: DG1 (Diagnosis) optional repeating
  • 6: OMG_O19_OBSERVATION (a Group object) optional repeating
  • 7: OMG_O19_PRIOR_RESULT (a Group object) optional repeating
  • 8: FT1 (Financial Transaction) optional repeating
  • 9: CTI (Clinical Trial Identification) optional repeating
  • 10: 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

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

    • getCTD

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

    • getDG1

      public DG1 getDG1()
      Returns the first repetition of DG1 (Diagnosis) - creates it if necessary

    • getDG1

      public DG1 getDG1(int rep)
      Returns a specific repetition of DG1 (Diagnosis) - 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.

    • getDG1Reps

      public int getDG1Reps()
      Returns the number of existing repetitions of DG1

    • getDG1All

      public List<DG1> getDG1All() throws HL7Exception

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

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

      Throws:
      HL7Exception

    • insertDG1

      public void insertDG1(DG1 structure, int rep) throws HL7Exception
      Inserts a specific repetition of DG1 (Diagnosis)
      Throws:
      HL7Exception
      See Also:
      • AbstractGroup#insertRepetition(Structure, int)

    • insertDG1

      public DG1 insertDG1(int rep) throws HL7Exception
      Inserts a specific repetition of DG1 (Diagnosis)
      Throws:
      HL7Exception
      See Also:
      • AbstractGroup#insertRepetition(Structure, int)

    • removeDG1

      public DG1 removeDG1(int rep) throws HL7Exception
      Removes a specific repetition of DG1 (Diagnosis)
      Throws:
      HL7Exception
      See Also:

    • getOBSERVATION

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

    • getOBSERVATION

      public OMG_O19_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<OMG_O19_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(OMG_O19_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 OMG_O19_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 OMG_O19_OBSERVATION removeOBSERVATION(int rep) throws HL7Exception
      Removes a specific repetition of OBSERVATION (a Group object)
      Throws:
      HL7Exception
      See Also:

    • getPRIOR_RESULT

      public OMG_O19_PRIOR_RESULT getPRIOR_RESULT()
      Returns the first repetition of PRIOR_RESULT (a Group object) - creates it if necessary

    • getPRIOR_RESULT

      public OMG_O19_PRIOR_RESULT getPRIOR_RESULT(int rep)
      Returns a specific repetition of PRIOR_RESULT (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.

    • getPRIOR_RESULTReps

      public int getPRIOR_RESULTReps()
      Returns the number of existing repetitions of PRIOR_RESULT

    • getPRIOR_RESULTAll

      public List<OMG_O19_PRIOR_RESULT> getPRIOR_RESULTAll() throws HL7Exception

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

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

      Throws:
      HL7Exception

    • insertPRIOR_RESULT

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

    • insertPRIOR_RESULT

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

    • removePRIOR_RESULT

      public OMG_O19_PRIOR_RESULT removePRIOR_RESULT(int rep) throws HL7Exception
      Removes a specific repetition of PRIOR_RESULT (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:

    • getBLG

      public BLG getBLG()
      Returns BLG (Billing) - creates it if necessary