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

Class RSP_K25_STAFF

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

Represents a RSP_K25_STAFF 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: STF (Staff Identification)
  • 2: PRA (Practitioner Detail) optional
  • 3: ORG (Practitioner Organization Unit) optional repeating
  • 4: AFF (Professional Affiliation) optional repeating
  • 5: LAN (Language Detail) optional repeating
  • 6: EDU (Educational Detail) optional repeating
See Also:

  • Constructor Details

  • Method Details

    • getVersion

      public String getVersion()
      Returns "2.4"

    • getSTF

      public STF getSTF()
      Returns STF (Staff Identification) - creates it if necessary

    • getPRA

      public PRA getPRA()
      Returns PRA (Practitioner Detail) - creates it if necessary

    • getORG

      public ORG getORG()
      Returns the first repetition of ORG (Practitioner Organization Unit) - creates it if necessary

    • getORG

      public ORG getORG(int rep)
      Returns a specific repetition of ORG (Practitioner Organization Unit) - 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.

    • getORGReps

      public int getORGReps()
      Returns the number of existing repetitions of ORG

    • getORGAll

      public List<ORG> getORGAll() throws HL7Exception

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

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

      Throws:
      HL7Exception

    • insertORG

      public void insertORG(ORG structure, int rep) throws HL7Exception
      Inserts a specific repetition of ORG (Practitioner Organization Unit)
      Throws:
      HL7Exception
      See Also:
      • AbstractGroup#insertRepetition(Structure, int)

    • insertORG

      public ORG insertORG(int rep) throws HL7Exception
      Inserts a specific repetition of ORG (Practitioner Organization Unit)
      Throws:
      HL7Exception
      See Also:
      • AbstractGroup#insertRepetition(Structure, int)

    • removeORG

      public ORG removeORG(int rep) throws HL7Exception
      Removes a specific repetition of ORG (Practitioner Organization Unit)
      Throws:
      HL7Exception
      See Also:

    • getAFF

      public AFF getAFF()
      Returns the first repetition of AFF (Professional Affiliation) - creates it if necessary

    • getAFF

      public AFF getAFF(int rep)
      Returns a specific repetition of AFF (Professional Affiliation) - 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.

    • getAFFReps

      public int getAFFReps()
      Returns the number of existing repetitions of AFF

    • getAFFAll

      public List<AFF> getAFFAll() throws HL7Exception

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

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

      Throws:
      HL7Exception

    • insertAFF

      public void insertAFF(AFF structure, int rep) throws HL7Exception
      Inserts a specific repetition of AFF (Professional Affiliation)
      Throws:
      HL7Exception
      See Also:
      • AbstractGroup#insertRepetition(Structure, int)

    • insertAFF

      public AFF insertAFF(int rep) throws HL7Exception
      Inserts a specific repetition of AFF (Professional Affiliation)
      Throws:
      HL7Exception
      See Also:
      • AbstractGroup#insertRepetition(Structure, int)

    • removeAFF

      public AFF removeAFF(int rep) throws HL7Exception
      Removes a specific repetition of AFF (Professional Affiliation)
      Throws:
      HL7Exception
      See Also:

    • getLAN

      public LAN getLAN()
      Returns the first repetition of LAN (Language Detail) - creates it if necessary

    • getLAN

      public LAN getLAN(int rep)
      Returns a specific repetition of LAN (Language 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.

    • getLANReps

      public int getLANReps()
      Returns the number of existing repetitions of LAN

    • getLANAll

      public List<LAN> getLANAll() throws HL7Exception

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

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

      Throws:
      HL7Exception

    • insertLAN

      public void insertLAN(LAN structure, int rep) throws HL7Exception
      Inserts a specific repetition of LAN (Language Detail)
      Throws:
      HL7Exception
      See Also:
      • AbstractGroup#insertRepetition(Structure, int)

    • insertLAN

      public LAN insertLAN(int rep) throws HL7Exception
      Inserts a specific repetition of LAN (Language Detail)
      Throws:
      HL7Exception
      See Also:
      • AbstractGroup#insertRepetition(Structure, int)

    • removeLAN

      public LAN removeLAN(int rep) throws HL7Exception
      Removes a specific repetition of LAN (Language Detail)
      Throws:
      HL7Exception
      See Also:

    • getEDU

      public EDU getEDU()
      Returns the first repetition of EDU (Educational Detail) - creates it if necessary

    • getEDU

      public EDU getEDU(int rep)
      Returns a specific repetition of EDU (Educational 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.

    • getEDUReps

      public int getEDUReps()
      Returns the number of existing repetitions of EDU

    • getEDUAll

      public List<EDU> getEDUAll() throws HL7Exception

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

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

      Throws:
      HL7Exception

    • insertEDU

      public void insertEDU(EDU structure, int rep) throws HL7Exception
      Inserts a specific repetition of EDU (Educational Detail)
      Throws:
      HL7Exception
      See Also:
      • AbstractGroup#insertRepetition(Structure, int)

    • insertEDU

      public EDU insertEDU(int rep) throws HL7Exception
      Inserts a specific repetition of EDU (Educational Detail)
      Throws:
      HL7Exception
      See Also:
      • AbstractGroup#insertRepetition(Structure, int)

    • removeEDU

      public EDU removeEDU(int rep) throws HL7Exception
      Removes a specific repetition of EDU (Educational Detail)
      Throws:
      HL7Exception
      See Also: