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

Class OUL_R21_OBSERVATION

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

Represents a OUL_R21_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: OBX (Observation/Result) optional
  • 2: TCD (Test Code Detail) optional
  • 3: SID (Substance Identifier) optional repeating
  • 4: NTE (Notes and Comments) optional repeating
See Also:

  • Constructor Details

  • Method Details

    • getVersion

      public String getVersion()
      Returns "2.4"

    • getOBX

      public OBX getOBX()
      Returns OBX (Observation/Result) - creates it if necessary

    • getTCD

      public TCD getTCD()
      Returns TCD (Test Code Detail) - creates it if necessary

    • getSID

      public SID getSID()
      Returns the first repetition of SID (Substance Identifier) - creates it if necessary

    • getSID

      public SID getSID(int rep)
      Returns a specific repetition of SID (Substance Identifier) - 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.

    • getSIDReps

      public int getSIDReps()
      Returns the number of existing repetitions of SID

    • getSIDAll

      public List<SID> getSIDAll() throws HL7Exception

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

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

      Throws:
      HL7Exception

    • insertSID

      public void insertSID(SID structure, int rep) throws HL7Exception
      Inserts a specific repetition of SID (Substance Identifier)
      Throws:
      HL7Exception
      See Also:
      • AbstractGroup#insertRepetition(Structure, int)

    • insertSID

      public SID insertSID(int rep) throws HL7Exception
      Inserts a specific repetition of SID (Substance Identifier)
      Throws:
      HL7Exception
      See Also:
      • AbstractGroup#insertRepetition(Structure, int)

    • removeSID

      public SID removeSID(int rep) throws HL7Exception
      Removes a specific repetition of SID (Substance Identifier)
      Throws:
      HL7Exception
      See Also:

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