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

Class OML_O33_SPECIMEN

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

Represents a OML_O33_SPECIMEN 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: SPM (Specimen)
  • 2: OBX (Observation/Result) optional repeating
  • 3: SAC (Specimen Container detail) optional repeating
  • 4: OML_O33_ORDER (a Group object) repeating
See Also:

  • Constructor Details

  • Method Details

    • getVersion

      public String getVersion()
      Returns "2.5.1"

    • getSPM

      public SPM getSPM()
      Returns SPM (Specimen) - creates it if necessary

    • getOBX

      public OBX getOBX()
      Returns the first repetition of OBX (Observation/Result) - creates it if necessary

    • getOBX

      public OBX getOBX(int rep)
      Returns a specific repetition of OBX (Observation/Result) - 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.

    • getOBXReps

      public int getOBXReps()
      Returns the number of existing repetitions of OBX

    • getOBXAll

      public List<OBX> getOBXAll() throws HL7Exception

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

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

      Throws:
      HL7Exception

    • insertOBX

      public void insertOBX(OBX structure, int rep) throws HL7Exception
      Inserts a specific repetition of OBX (Observation/Result)
      Throws:
      HL7Exception
      See Also:
      • AbstractGroup#insertRepetition(Structure, int)

    • insertOBX

      public OBX insertOBX(int rep) throws HL7Exception
      Inserts a specific repetition of OBX (Observation/Result)
      Throws:
      HL7Exception
      See Also:
      • AbstractGroup#insertRepetition(Structure, int)

    • removeOBX

      public OBX removeOBX(int rep) throws HL7Exception
      Removes a specific repetition of OBX (Observation/Result)
      Throws:
      HL7Exception
      See Also:

    • getSAC

      public SAC getSAC()
      Returns the first repetition of SAC (Specimen Container detail) - creates it if necessary

    • getSAC

      public SAC getSAC(int rep)
      Returns a specific repetition of SAC (Specimen Container detail) - 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.

    • getSACReps

      public int getSACReps()
      Returns the number of existing repetitions of SAC

    • getSACAll

      public List<SAC> getSACAll() throws HL7Exception

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

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

      Throws:
      HL7Exception

    • insertSAC

      public void insertSAC(SAC structure, int rep) throws HL7Exception
      Inserts a specific repetition of SAC (Specimen Container detail)
      Throws:
      HL7Exception
      See Also:
      • AbstractGroup#insertRepetition(Structure, int)

    • insertSAC

      public SAC insertSAC(int rep) throws HL7Exception
      Inserts a specific repetition of SAC (Specimen Container detail)
      Throws:
      HL7Exception
      See Also:
      • AbstractGroup#insertRepetition(Structure, int)

    • removeSAC

      public SAC removeSAC(int rep) throws HL7Exception
      Removes a specific repetition of SAC (Specimen Container detail)
      Throws:
      HL7Exception
      See Also:

    • getORDER

      public OML_O33_ORDER getORDER()
      Returns the first repetition of ORDER (a Group object) - creates it if necessary

    • getORDER

      public OML_O33_ORDER getORDER(int rep)
      Returns a specific repetition of ORDER (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.

    • getORDERReps

      public int getORDERReps()
      Returns the number of existing repetitions of ORDER

    • getORDERAll

      public List<OML_O33_ORDER> getORDERAll() throws HL7Exception

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

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

      Throws:
      HL7Exception

    • insertORDER

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

    • insertORDER

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

    • removeORDER

      public OML_O33_ORDER removeORDER(int rep) throws HL7Exception
      Removes a specific repetition of ORDER (a Group object)
      Throws:
      HL7Exception
      See Also: