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

Class MFN_M02_MF_STAFF

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

Represents a MFN_M02_MF_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: MFE (Master File Entry)
  • 2: STF (Staff Identification)
  • 3: PRA (Practitioner Detail) optional repeating
  • 4: ORG (Practitioner Organization Unit) optional repeating
  • 5: AFF (Professional Affiliation) optional repeating
  • 6: LAN (Language Detail) optional repeating
  • 7: EDU (Educational Detail) optional repeating
  • 8: CER (Certificate Detail) optional repeating
  • 9: NTE (Notes and Comments) optional repeating
See Also:

  • Constructor Details

  • Method Details

    • getVersion

      public String getVersion()
      Returns "2.5.1"

    • getMFE

      public MFE getMFE()
      Returns MFE (Master File Entry) - creates it if necessary

    • getSTF

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

    • getPRA

      public PRA getPRA()
      Returns the first repetition of PRA (Practitioner Detail) - creates it if necessary

    • getPRA

      public PRA getPRA(int rep)
      Returns a specific repetition of PRA (Practitioner 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.

    • getPRAReps

      public int getPRAReps()
      Returns the number of existing repetitions of PRA

    • getPRAAll

      public List<PRA> getPRAAll() throws HL7Exception

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

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

      Throws:
      HL7Exception

    • insertPRA

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

    • insertPRA

      public PRA insertPRA(int rep) throws HL7Exception
      Inserts a specific repetition of PRA (Practitioner Detail)
      Throws:
      HL7Exception
      See Also:
      • AbstractGroup#insertRepetition(Structure, int)

    • removePRA

      public PRA removePRA(int rep) throws HL7Exception
      Removes a specific repetition of PRA (Practitioner Detail)
      Throws:
      HL7Exception
      See Also:

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

    • getCER

      public CER getCER()
      Returns the first repetition of CER (Certificate Detail) - creates it if necessary

    • getCER

      public CER getCER(int rep)
      Returns a specific repetition of CER (Certificate 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.

    • getCERReps

      public int getCERReps()
      Returns the number of existing repetitions of CER

    • getCERAll

      public List<CER> getCERAll() throws HL7Exception

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

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

      Throws:
      HL7Exception

    • insertCER

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

    • insertCER

      public CER insertCER(int rep) throws HL7Exception
      Inserts a specific repetition of CER (Certificate Detail)
      Throws:
      HL7Exception
      See Also:
      • AbstractGroup#insertRepetition(Structure, int)

    • removeCER

      public CER removeCER(int rep) throws HL7Exception
      Removes a specific repetition of CER (Certificate Detail)
      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: