Package ca.uhn.hl7v2.model.v22.segment

Class NK1

java.lang.Object
ca.uhn.hl7v2.model.AbstractStructure
ca.uhn.hl7v2.model.AbstractSegment
ca.uhn.hl7v2.model.v22.segment.NK1
All Implemented Interfaces:
Segment, Structure, Visitable, Serializable
public class NK1 extends AbstractSegment

Represents an HL7 NK1 message segment (NEXT OF KIN). This segment has the following fields:

  • NK1-1: Set ID - Next of Kin (SI)
  • NK1-2: NK Name (PN) optional
  • NK1-3: Relationship (CE) optional
  • NK1-4: Address (AD) optional
  • NK1-5: Phone Number (TN) optional repeating
  • NK1-6: Business Phone Number (TN) optional
  • NK1-7: Contact Role (CE) optional
  • NK1-8: Start Date (DT) optional
  • NK1-9: End Date (DT) optional
  • NK1-10: Next of Kin (ST) optional
  • NK1-11: Next of kin job code / class (CM_JOB_CODE) optional
  • NK1-12: Next of Kin Employee Number (ST) optional
  • NK1-13: Organization Name (ST) optional
See Also:

  • Constructor Details

  • Method Details

    • getSetIDNextOfKin

      public SI getSetIDNextOfKin()
      Returns NK1-1: "Set ID - Next of Kin" - creates it if necessary

    • getNk11_SetIDNextOfKin

      public SI getNk11_SetIDNextOfKin()
      Returns NK1-1: "Set ID - Next of Kin" - creates it if necessary

    • getNKName

      public PN getNKName()
      Returns NK1-2: "NK Name" - creates it if necessary

    • getNk12_NKName

      public PN getNk12_NKName()
      Returns NK1-2: "NK Name" - creates it if necessary

    • getRelationship

      public CE getRelationship()
      Returns NK1-3: "Relationship" - creates it if necessary

    • getNk13_Relationship

      public CE getNk13_Relationship()
      Returns NK1-3: "Relationship" - creates it if necessary

    • getAddress

      public AD getAddress()
      Returns NK1-4: "Address" - creates it if necessary

    • getNk14_Address

      public AD getNk14_Address()
      Returns NK1-4: "Address" - creates it if necessary

    • getPhoneNumber

      public TN[] getPhoneNumber()
      Returns all repetitions of Phone Number (NK1-5).

    • getNk15_PhoneNumber

      public TN[] getNk15_PhoneNumber()
      Returns all repetitions of Phone Number (NK1-5).

    • getPhoneNumberReps

      public int getPhoneNumberReps()
      Returns a count of the current number of repetitions of Phone Number (NK1-5). This method does not create a repetition, so if no repetitions have currently been defined or accessed, it will return zero.

    • getPhoneNumber

      public TN getPhoneNumber(int rep)
      Returns a specific repetition of NK1-5: "Phone Number" - creates it if necessary
      Parameters:
      rep - The repetition index (0-indexed)

    • getNk15_PhoneNumber

      public TN getNk15_PhoneNumber(int rep)
      Returns a specific repetition of NK1-5: "Phone Number" - creates it if necessary
      Parameters:
      rep - The repetition index (0-indexed)

    • getNk15_PhoneNumberReps

      public int getNk15_PhoneNumberReps()
      Returns a count of the current number of repetitions of Phone Number (NK1-5). This method does not create a repetition, so if no repetitions have currently been defined or accessed, it will return zero.

    • insertPhoneNumber

      public TN insertPhoneNumber(int rep) throws HL7Exception
      Inserts a repetition of NK1-5: "Phone Number" at a specific index
      Parameters:
      rep - The repetition index (0-indexed)
      Throws:
      HL7Exception - If the rep is invalid (below 0, or too high for the allowable repetitions)

    • insertNk15_PhoneNumber

      public TN insertNk15_PhoneNumber(int rep) throws HL7Exception
      Inserts a repetition of NK1-5: "Phone Number" at a specific index
      Parameters:
      rep - The repetition index (0-indexed)
      Throws:
      HL7Exception - If the rep is invalid (below 0, or too high for the allowable repetitions)

    • removePhoneNumber

      public TN removePhoneNumber(int rep) throws HL7Exception
      Removes a repetition of NK1-5: "Phone Number" at a specific index
      Parameters:
      rep - The repetition index (0-indexed)
      Throws:
      HL7Exception - If the rep is invalid (below 0, or too high for the allowable repetitions)

    • removeNk15_PhoneNumber

      public TN removeNk15_PhoneNumber(int rep) throws HL7Exception
      Removes a repetition of NK1-5: "Phone Number" at a specific index
      Parameters:
      rep - The repetition index (0-indexed)
      Throws:
      HL7Exception - If the rep is invalid (below 0, or too high for the allowable repetitions)

    • getBusinessPhoneNumber

      public TN getBusinessPhoneNumber()
      Returns NK1-6: "Business Phone Number" - creates it if necessary

    • getNk16_BusinessPhoneNumber

      public TN getNk16_BusinessPhoneNumber()
      Returns NK1-6: "Business Phone Number" - creates it if necessary

    • getContactRole

      public CE getContactRole()
      Returns NK1-7: "Contact Role" - creates it if necessary

    • getNk17_ContactRole

      public CE getNk17_ContactRole()
      Returns NK1-7: "Contact Role" - creates it if necessary

    • getStartDate

      public DT getStartDate()
      Returns NK1-8: "Start Date" - creates it if necessary

    • getNk18_StartDate

      public DT getNk18_StartDate()
      Returns NK1-8: "Start Date" - creates it if necessary

    • getEndDate

      public DT getEndDate()
      Returns NK1-9: "End Date" - creates it if necessary

    • getNk19_EndDate

      public DT getNk19_EndDate()
      Returns NK1-9: "End Date" - creates it if necessary

    • getNextOfKin

      public ST getNextOfKin()
      Returns NK1-10: "Next of Kin" - creates it if necessary

    • getNk110_NextOfKin

      public ST getNk110_NextOfKin()
      Returns NK1-10: "Next of Kin" - creates it if necessary

    • getNextOfKinJobCodeClass

      public CM_JOB_CODE getNextOfKinJobCodeClass()
      Returns NK1-11: "Next of kin job code / class" - creates it if necessary

    • getNk111_NextOfKinJobCodeClass

      public CM_JOB_CODE getNk111_NextOfKinJobCodeClass()
      Returns NK1-11: "Next of kin job code / class" - creates it if necessary

    • getNextOfKinEmployeeNumber

      public ST getNextOfKinEmployeeNumber()
      Returns NK1-12: "Next of Kin Employee Number" - creates it if necessary

    • getNk112_NextOfKinEmployeeNumber

      public ST getNk112_NextOfKinEmployeeNumber()
      Returns NK1-12: "Next of Kin Employee Number" - creates it if necessary

    • getOrganizationName

      public ST getOrganizationName()
      Returns NK1-13: "Organization Name" - creates it if necessary

    • getNk113_OrganizationName

      public ST getNk113_OrganizationName()
      Returns NK1-13: "Organization Name" - creates it if necessary

    • createNewTypeWithoutReflection

      protected Type createNewTypeWithoutReflection(int field)
      Overrides:
      createNewTypeWithoutReflection in class AbstractSegment