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

Class ORG_O20_ORDER

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

Represents a ORG_O20_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: ORG_O20_TIMING (a Group object) optional repeating
  • 3: OBR (Observation Request) optional
  • 4: NTE (Notes and Comments) optional repeating
  • 5: CTI (Clinical Trial Identification) optional repeating
  • 6: ORG_O20_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

    • getTIMING

      public ORG_O20_TIMING getTIMING()
      Returns the first repetition of TIMING (a Group object) - creates it if necessary

    • getTIMING

      public ORG_O20_TIMING getTIMING(int rep)
      Returns a specific repetition of TIMING (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.

    • getTIMINGReps

      public int getTIMINGReps()
      Returns the number of existing repetitions of TIMING

    • getTIMINGAll

      public List<ORG_O20_TIMING> getTIMINGAll() throws HL7Exception

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

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

      Throws:
      HL7Exception

    • insertTIMING

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

    • insertTIMING

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

    • removeTIMING

      public ORG_O20_TIMING removeTIMING(int rep) throws HL7Exception
      Removes a specific repetition of TIMING (a Group object)
      Throws:
      HL7Exception
      See Also:

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

    • 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 ORG_O20_SPECIMEN getSPECIMEN()
      Returns the first repetition of SPECIMEN (a Group object) - creates it if necessary

    • getSPECIMEN

      public ORG_O20_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<ORG_O20_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(ORG_O20_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 ORG_O20_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 ORG_O20_SPECIMEN removeSPECIMEN(int rep) throws HL7Exception
      Removes a specific repetition of SPECIMEN (a Group object)
      Throws:
      HL7Exception
      See Also: