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

Class SSU_U03_SPECIMEN_CONTAINER

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

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

  • Constructor Details

  • Method Details

    • getVersion

      public String getVersion()
      Returns "2.5.1"

    • getSAC

      public SAC getSAC()
      Returns SAC (Specimen Container detail) - 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:

    • getSPECIMEN

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

    • getSPECIMEN

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