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

Class SRM_S01_PATIENT

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

Represents a SRM_S01_PATIENT 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: PID (Patient identification)
  • 2: PV1 (Patient visit) optional
  • 3: PV2 (Patient visit - additional information) optional
  • 4: OBX (Observation/Result) optional repeating
  • 5: DG1 (Diagnosis) optional repeating
See Also:

  • Constructor Details

  • Method Details

    • getVersion

      public String getVersion()
      Returns "2.4"

    • getPID

      public PID getPID()
      Returns PID (Patient identification) - creates it if necessary

    • getPV1

      public PV1 getPV1()
      Returns PV1 (Patient visit) - creates it if necessary

    • getPV2

      public PV2 getPV2()
      Returns PV2 (Patient visit - additional information) - 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:

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