STF (HAPI - 04 - Generated Structures v2.4 1.2 API)

Overview

Package

Class

Use

Tree

Deprecated

Index

Help

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

ca.uhn.hl7v2.model.v24.segment
Class STF

java.lang.Object
  ca.uhn.hl7v2.model.AbstractSegment
      ca.uhn.hl7v2.model.v24.segment.STF

All Implemented Interfaces:: Segment, Structure, Serializable

public class STF
extends AbstractSegment
extends AbstractSegment

Represents an HL7 STF message segment (Staff Identification). This segment has the following fields:

STF-1: Primary Key Value - STF (CE) optional
STF-2: Staff ID Code (CX) optional repeating
STF-3: Staff Name (XPN) optional repeating
STF-4: Staff Type (IS) optional repeating
STF-5: Administrative Sex (IS) optional
STF-6: Date/Time Of Birth (TS) optional
STF-7: Active/Inactive Flag (ID) optional
STF-8: Department (CE) optional repeating
STF-9: Hospital Service (CE) optional repeating
STF-10: Phone (XTN) optional repeating
STF-11: Office/Home Address (XAD) optional repeating
STF-12: Institution Activation Date (DIN) optional repeating
STF-13: Institution Inactivation Date (DIN) optional repeating
STF-14: Backup Person ID (CE) optional repeating
STF-15: E-Mail Address (ST) optional repeating
STF-16: Preferred Method of Contact (CE) optional
STF-17: Marital Status (CE) optional
STF-18: Job Title (ST) optional
STF-19: Job Code/Class (JCC) optional
STF-20: Employment Status Code (CE) optional
STF-21: Additional Insured on Auto (ID) optional
STF-22: Driver's License Number - Staff (DLN) optional
STF-23: Copy Auto Ins (ID) optional
STF-24: Auto Ins. Expires (DT) optional
STF-25: Date Last DMV Review (DT) optional
STF-26: Date Next DMV Review (DT) optional
STF-27: Race (CE) optional
STF-28: Ethnic Group (CE) optional
STF-29: Re-activation Approval Indicator (ID) optional

See Also:: Serialized Form

Constructor Summary
`STF(Group parent, ModelClassFactory factory)` Creates a new STF segment

Method Summary
`protected Type`	`createNewTypeWithoutReflection(int field)`
`ID`	`getActiveInactiveFlag()` Returns STF-7: "Active/Inactive Flag" - creates it if necessary
`ID`	`getAdditionalInsuredOnAuto()` Returns STF-21: "Additional Insured on Auto" - creates it if necessary
`IS`	`getAdministrativeSex()` Returns STF-5: "Administrative Sex" - creates it if necessary
`DT`	`getAutoInsExpires()` Returns STF-24: "Auto Ins.
`CE[]`	`getBackupPersonID()` Returns all repetitions of Backup Person ID (STF-14).
`CE`	`getBackupPersonID(int rep)` Returns a specific repetition of STF-14: "Backup Person ID" - creates it if necessary
`int`	`getBackupPersonIDReps()` Returns a count of the current number of repetitions of Backup Person ID (STF-14).
`ID`	`getCopyAutoIns()` Returns STF-23: "Copy Auto Ins" - creates it if necessary
`DT`	`getDateLastDMVReview()` Returns STF-25: "Date Last DMV Review" - creates it if necessary
`DT`	`getDateNextDMVReview()` Returns STF-26: "Date Next DMV Review" - creates it if necessary
`TS`	`getDateTimeOfBirth()` Returns STF-6: "Date/Time Of Birth" - creates it if necessary
`CE[]`	`getDepartment()` Returns all repetitions of Department (STF-8).
`CE`	`getDepartment(int rep)` Returns a specific repetition of STF-8: "Department" - creates it if necessary
`int`	`getDepartmentReps()` Returns a count of the current number of repetitions of Department (STF-8).
`DLN`	`getDriverSLicenseNumberStaff()` Returns STF-22: "Driver's License Number - Staff" - creates it if necessary
`ST[]`	`getEMailAddress()` Returns all repetitions of E-Mail Address (STF-15).
`ST`	`getEMailAddress(int rep)` Returns a specific repetition of STF-15: "E-Mail Address" - creates it if necessary
`int`	`getEMailAddressReps()` Returns a count of the current number of repetitions of E-Mail Address (STF-15).
`CE`	`getEmploymentStatusCode()` Returns STF-20: "Employment Status Code" - creates it if necessary
`CE`	`getEthnicGroup()` Returns STF-28: "Ethnic Group" - creates it if necessary
`CE[]`	`getHospitalService()` Returns all repetitions of Hospital Service (STF-9).
`CE`	`getHospitalService(int rep)` Returns a specific repetition of STF-9: "Hospital Service" - creates it if necessary
`int`	`getHospitalServiceReps()` Returns a count of the current number of repetitions of Hospital Service (STF-9).
`DIN[]`	`getInstitutionActivationDate()` Returns all repetitions of Institution Activation Date (STF-12).
`DIN`	`getInstitutionActivationDate(int rep)` Returns a specific repetition of STF-12: "Institution Activation Date" - creates it if necessary
`int`	`getInstitutionActivationDateReps()` Returns a count of the current number of repetitions of Institution Activation Date (STF-12).
`DIN[]`	`getInstitutionInactivationDate()` Returns all repetitions of Institution Inactivation Date (STF-13).
`DIN`	`getInstitutionInactivationDate(int rep)` Returns a specific repetition of STF-13: "Institution Inactivation Date" - creates it if necessary
`int`	`getInstitutionInactivationDateReps()` Returns a count of the current number of repetitions of Institution Inactivation Date (STF-13).
`JCC`	`getJobCodeClass()` Returns STF-19: "Job Code/Class" - creates it if necessary
`ST`	`getJobTitle()` Returns STF-18: "Job Title" - creates it if necessary
`CE`	`getMaritalStatus()` Returns STF-17: "Marital Status" - creates it if necessary
`XAD[]`	`getOfficeHomeAddress()` Returns all repetitions of Office/Home Address (STF-11).
`XAD`	`getOfficeHomeAddress(int rep)` Returns a specific repetition of STF-11: "Office/Home Address" - creates it if necessary
`int`	`getOfficeHomeAddressReps()` Returns a count of the current number of repetitions of Office/Home Address (STF-11).
`XTN[]`	`getPhone()` Returns all repetitions of Phone (STF-10).
`XTN`	`getPhone(int rep)` Returns a specific repetition of STF-10: "Phone" - creates it if necessary
`int`	`getPhoneReps()` Returns a count of the current number of repetitions of Phone (STF-10).
`CE`	`getPreferredMethodOfContact()` Returns STF-16: "Preferred Method of Contact" - creates it if necessary
`CE`	`getPrimaryKeyValueSTF()` Returns STF-1: "Primary Key Value - STF" - creates it if necessary
`CE`	`getRace()` Returns STF-27: "Race" - creates it if necessary
`ID`	`getReActivationApprovalIndicator()` Returns STF-29: "Re-activation Approval Indicator" - creates it if necessary
`CX[]`	`getStaffIDCode()` Returns all repetitions of Staff ID Code (STF-2).
`CX`	`getStaffIDCode(int rep)` Returns a specific repetition of STF-2: "Staff ID Code" - creates it if necessary
`int`	`getStaffIDCodeReps()` Returns a count of the current number of repetitions of Staff ID Code (STF-2).
`XPN[]`	`getStaffName()` Returns all repetitions of Staff Name (STF-3).
`XPN`	`getStaffName(int rep)` Returns a specific repetition of STF-3: "Staff Name" - creates it if necessary
`int`	`getStaffNameReps()` Returns a count of the current number of repetitions of Staff Name (STF-3).
`IS[]`	`getStaffType()` Returns all repetitions of Staff Type (STF-4).
`IS`	`getStaffType(int rep)` Returns a specific repetition of STF-4: "Staff Type" - creates it if necessary
`int`	`getStaffTypeReps()` Returns a count of the current number of repetitions of Staff Type (STF-4).
`CE`	`getStf1_PrimaryKeyValueSTF()` Returns STF-1: "Primary Key Value - STF" - creates it if necessary
`XTN`	`getStf10_Phone(int rep)` Returns a specific repetition of STF-10: "Phone" - creates it if necessary
`int`	`getStf10_PhoneReps()` Returns a count of the current number of repetitions of Phone (STF-10).
`XAD`	`getStf11_OfficeHomeAddress(int rep)` Returns a specific repetition of STF-11: "Office/Home Address" - creates it if necessary
`int`	`getStf11_OfficeHomeAddressReps()` Returns a count of the current number of repetitions of Office/Home Address (STF-11).
`DIN`	`getStf12_InstitutionActivationDate(int rep)` Returns a specific repetition of STF-12: "Institution Activation Date" - creates it if necessary
`int`	`getStf12_InstitutionActivationDateReps()` Returns a count of the current number of repetitions of Institution Activation Date (STF-12).
`DIN`	`getStf13_InstitutionInactivationDate(int rep)` Returns a specific repetition of STF-13: "Institution Inactivation Date" - creates it if necessary
`int`	`getStf13_InstitutionInactivationDateReps()` Returns a count of the current number of repetitions of Institution Inactivation Date (STF-13).
`CE`	`getStf14_BackupPersonID(int rep)` Returns a specific repetition of STF-14: "Backup Person ID" - creates it if necessary
`int`	`getStf14_BackupPersonIDReps()` Returns a count of the current number of repetitions of Backup Person ID (STF-14).
`ST`	`getStf15_EMailAddress(int rep)` Returns a specific repetition of STF-15: "E-Mail Address" - creates it if necessary
`int`	`getStf15_EMailAddressReps()` Returns a count of the current number of repetitions of E-Mail Address (STF-15).
`CE`	`getStf16_PreferredMethodOfContact()` Returns STF-16: "Preferred Method of Contact" - creates it if necessary
`CE`	`getStf17_MaritalStatus()` Returns STF-17: "Marital Status" - creates it if necessary
`ST`	`getStf18_JobTitle()` Returns STF-18: "Job Title" - creates it if necessary
`JCC`	`getStf19_JobCodeClass()` Returns STF-19: "Job Code/Class" - creates it if necessary
`CX`	`getStf2_StaffIDCode(int rep)` Returns a specific repetition of STF-2: "Staff ID Code" - creates it if necessary
`int`	`getStf2_StaffIDCodeReps()` Returns a count of the current number of repetitions of Staff ID Code (STF-2).
`CE`	`getStf20_EmploymentStatusCode()` Returns STF-20: "Employment Status Code" - creates it if necessary
`ID`	`getStf21_AdditionalInsuredOnAuto()` Returns STF-21: "Additional Insured on Auto" - creates it if necessary
`DLN`	`getStf22_DriverSLicenseNumberStaff()` Returns STF-22: "Driver's License Number - Staff" - creates it if necessary
`ID`	`getStf23_CopyAutoIns()` Returns STF-23: "Copy Auto Ins" - creates it if necessary
`DT`	`getStf24_AutoInsExpires()` Returns STF-24: "Auto Ins.
`DT`	`getStf25_DateLastDMVReview()` Returns STF-25: "Date Last DMV Review" - creates it if necessary
`DT`	`getStf26_DateNextDMVReview()` Returns STF-26: "Date Next DMV Review" - creates it if necessary
`CE`	`getStf27_Race()` Returns STF-27: "Race" - creates it if necessary
`CE`	`getStf28_EthnicGroup()` Returns STF-28: "Ethnic Group" - creates it if necessary
`ID`	`getStf29_ReActivationApprovalIndicator()` Returns STF-29: "Re-activation Approval Indicator" - creates it if necessary
`XPN`	`getStf3_StaffName(int rep)` Returns a specific repetition of STF-3: "Staff Name" - creates it if necessary
`int`	`getStf3_StaffNameReps()` Returns a count of the current number of repetitions of Staff Name (STF-3).
`IS`	`getStf4_StaffType(int rep)` Returns a specific repetition of STF-4: "Staff Type" - creates it if necessary
`int`	`getStf4_StaffTypeReps()` Returns a count of the current number of repetitions of Staff Type (STF-4).
`IS`	`getStf5_AdministrativeSex()` Returns STF-5: "Administrative Sex" - creates it if necessary
`TS`	`getStf6_DateTimeOfBirth()` Returns STF-6: "Date/Time Of Birth" - creates it if necessary
`ID`	`getStf7_ActiveInactiveFlag()` Returns STF-7: "Active/Inactive Flag" - creates it if necessary
`CE`	`getStf8_Department(int rep)` Returns a specific repetition of STF-8: "Department" - creates it if necessary
`int`	`getStf8_DepartmentReps()` Returns a count of the current number of repetitions of Department (STF-8).
`CE`	`getStf9_HospitalService(int rep)` Returns a specific repetition of STF-9: "Hospital Service" - creates it if necessary
`int`	`getStf9_HospitalServiceReps()` Returns a count of the current number of repetitions of Hospital Service (STF-9).
`CE`	`insertBackupPersonID(int rep)` Inserts a repetition of STF-14: "Backup Person ID" at a specific index
`CE`	`insertDepartment(int rep)` Inserts a repetition of STF-8: "Department" at a specific index
`ST`	`insertEMailAddress(int rep)` Inserts a repetition of STF-15: "E-Mail Address" at a specific index
`CE`	`insertHospitalService(int rep)` Inserts a repetition of STF-9: "Hospital Service" at a specific index
`DIN`	`insertInstitutionActivationDate(int rep)` Inserts a repetition of STF-12: "Institution Activation Date" at a specific index
`DIN`	`insertInstitutionInactivationDate(int rep)` Inserts a repetition of STF-13: "Institution Inactivation Date" at a specific index
`XAD`	`insertOfficeHomeAddress(int rep)` Inserts a repetition of STF-11: "Office/Home Address" at a specific index
`XTN`	`insertPhone(int rep)` Inserts a repetition of STF-10: "Phone" at a specific index
`CX`	`insertStaffIDCode(int rep)` Inserts a repetition of STF-2: "Staff ID Code" at a specific index
`XPN`	`insertStaffName(int rep)` Inserts a repetition of STF-3: "Staff Name" at a specific index
`IS`	`insertStaffType(int rep)` Inserts a repetition of STF-4: "Staff Type" at a specific index
`XTN`	`insertStf10_Phone(int rep)` Inserts a repetition of STF-10: "Phone" at a specific index
`XAD`	`insertStf11_OfficeHomeAddress(int rep)` Inserts a repetition of STF-11: "Office/Home Address" at a specific index
`DIN`	`insertStf12_InstitutionActivationDate(int rep)` Inserts a repetition of STF-12: "Institution Activation Date" at a specific index
`DIN`	`insertStf13_InstitutionInactivationDate(int rep)` Inserts a repetition of STF-13: "Institution Inactivation Date" at a specific index
`CE`	`insertStf14_BackupPersonID(int rep)` Inserts a repetition of STF-14: "Backup Person ID" at a specific index
`ST`	`insertStf15_EMailAddress(int rep)` Inserts a repetition of STF-15: "E-Mail Address" at a specific index
`CX`	`insertStf2_StaffIDCode(int rep)` Inserts a repetition of STF-2: "Staff ID Code" at a specific index
`XPN`	`insertStf3_StaffName(int rep)` Inserts a repetition of STF-3: "Staff Name" at a specific index
`IS`	`insertStf4_StaffType(int rep)` Inserts a repetition of STF-4: "Staff Type" at a specific index
`CE`	`insertStf8_Department(int rep)` Inserts a repetition of STF-8: "Department" at a specific index
`CE`	`insertStf9_HospitalService(int rep)` Inserts a repetition of STF-9: "Hospital Service" at a specific index
`CE`	`removeBackupPersonID(int rep)` Removes a repetition of STF-14: "Backup Person ID" at a specific index
`CE`	`removeDepartment(int rep)` Removes a repetition of STF-8: "Department" at a specific index
`ST`	`removeEMailAddress(int rep)` Removes a repetition of STF-15: "E-Mail Address" at a specific index
`CE`	`removeHospitalService(int rep)` Removes a repetition of STF-9: "Hospital Service" at a specific index
`DIN`	`removeInstitutionActivationDate(int rep)` Removes a repetition of STF-12: "Institution Activation Date" at a specific index
`DIN`	`removeInstitutionInactivationDate(int rep)` Removes a repetition of STF-13: "Institution Inactivation Date" at a specific index
`XAD`	`removeOfficeHomeAddress(int rep)` Removes a repetition of STF-11: "Office/Home Address" at a specific index
`XTN`	`removePhone(int rep)` Removes a repetition of STF-10: "Phone" at a specific index
`CX`	`removeStaffIDCode(int rep)` Removes a repetition of STF-2: "Staff ID Code" at a specific index
`XPN`	`removeStaffName(int rep)` Removes a repetition of STF-3: "Staff Name" at a specific index
`IS`	`removeStaffType(int rep)` Removes a repetition of STF-4: "Staff Type" at a specific index
`XTN`	`removeStf10_Phone(int rep)` Removes a repetition of STF-10: "Phone" at a specific index
`XAD`	`removeStf11_OfficeHomeAddress(int rep)` Removes a repetition of STF-11: "Office/Home Address" at a specific index
`DIN`	`removeStf12_InstitutionActivationDate(int rep)` Removes a repetition of STF-12: "Institution Activation Date" at a specific index
`DIN`	`removeStf13_InstitutionInactivationDate(int rep)` Removes a repetition of STF-13: "Institution Inactivation Date" at a specific index
`CE`	`removeStf14_BackupPersonID(int rep)` Removes a repetition of STF-14: "Backup Person ID" at a specific index
`ST`	`removeStf15_EMailAddress(int rep)` Removes a repetition of STF-15: "E-Mail Address" at a specific index
`CX`	`removeStf2_StaffIDCode(int rep)` Removes a repetition of STF-2: "Staff ID Code" at a specific index
`XPN`	`removeStf3_StaffName(int rep)` Removes a repetition of STF-3: "Staff Name" at a specific index
`IS`	`removeStf4_StaffType(int rep)` Removes a repetition of STF-4: "Staff Type" at a specific index
`CE`	`removeStf8_Department(int rep)` Removes a repetition of STF-8: "Department" at a specific index
`CE`	`removeStf9_HospitalService(int rep)` Removes a repetition of STF-9: "Hospital Service" at a specific index

Methods inherited from class ca.uhn.hl7v2.model.AbstractSegment
`add, add, clear, encode, getField, getField, getLength, getMaxCardinality, getMessage, getName, getNames, getParent, insertRepetition, isRequired, main, numFields, parse, removeRepetition`

Methods inherited from class java.lang.Object
`clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait`

Constructor Detail

STF

public STF(Group parent,
           ModelClassFactory factory)

Creates a new STF segment

Method Detail

getPrimaryKeyValueSTF

public CE getPrimaryKeyValueSTF()

Returns STF-1: "Primary Key Value - STF" - creates it if necessary

getStf1_PrimaryKeyValueSTF

public CE getStf1_PrimaryKeyValueSTF()

Returns STF-1: "Primary Key Value - STF" - creates it if necessary

getStaffIDCode

public CX[] getStaffIDCode()

Returns all repetitions of Staff ID Code (STF-2).

getStaffIDCodeReps

public int getStaffIDCodeReps()

Returns a count of the current number of repetitions of Staff ID Code (STF-2). This method does not create a repetition, so if no repetitions have currently been defined or accessed, it will return zero.

getStaffIDCode

public CX getStaffIDCode(int rep)

Returns a specific repetition of STF-2: "Staff ID Code" - creates it if necessary

Parameters:: rep - The repetition index (0-indexed)

getStf2_StaffIDCode

public CX getStf2_StaffIDCode(int rep)

Returns a specific repetition of STF-2: "Staff ID Code" - creates it if necessary

Parameters:: rep - The repetition index (0-indexed)

getStf2_StaffIDCodeReps

public int getStf2_StaffIDCodeReps()

insertStaffIDCode

public CX insertStaffIDCode(int rep)
                     throws HL7Exception

Inserts a repetition of STF-2: "Staff ID Code" 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)

insertStf2_StaffIDCode

public CX insertStf2_StaffIDCode(int rep)
                          throws HL7Exception

Inserts a repetition of STF-2: "Staff ID Code" 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)

removeStaffIDCode

public CX removeStaffIDCode(int rep)
                     throws HL7Exception

Removes a repetition of STF-2: "Staff ID Code" 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)

removeStf2_StaffIDCode

public CX removeStf2_StaffIDCode(int rep)
                          throws HL7Exception

Removes a repetition of STF-2: "Staff ID Code" 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)

getStaffName

public XPN[] getStaffName()

Returns all repetitions of Staff Name (STF-3).

getStaffNameReps

public int getStaffNameReps()

Returns a count of the current number of repetitions of Staff Name (STF-3). This method does not create a repetition, so if no repetitions have currently been defined or accessed, it will return zero.

getStaffName

public XPN getStaffName(int rep)

Returns a specific repetition of STF-3: "Staff Name" - creates it if necessary

Parameters:: rep - The repetition index (0-indexed)

getStf3_StaffName

public XPN getStf3_StaffName(int rep)

Returns a specific repetition of STF-3: "Staff Name" - creates it if necessary

Parameters:: rep - The repetition index (0-indexed)

getStf3_StaffNameReps

public int getStf3_StaffNameReps()

insertStaffName

public XPN insertStaffName(int rep)
                    throws HL7Exception

Inserts a repetition of STF-3: "Staff Name" 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)

insertStf3_StaffName

public XPN insertStf3_StaffName(int rep)
                         throws HL7Exception

Inserts a repetition of STF-3: "Staff Name" 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)

removeStaffName

public XPN removeStaffName(int rep)
                    throws HL7Exception

Removes a repetition of STF-3: "Staff Name" 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)

removeStf3_StaffName

public XPN removeStf3_StaffName(int rep)
                         throws HL7Exception

Removes a repetition of STF-3: "Staff Name" 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)

getStaffType

public IS[] getStaffType()

Returns all repetitions of Staff Type (STF-4).

getStaffTypeReps

public int getStaffTypeReps()

Returns a count of the current number of repetitions of Staff Type (STF-4). This method does not create a repetition, so if no repetitions have currently been defined or accessed, it will return zero.

getStaffType

public IS getStaffType(int rep)

Returns a specific repetition of STF-4: "Staff Type" - creates it if necessary

Parameters:: rep - The repetition index (0-indexed)

getStf4_StaffType

public IS getStf4_StaffType(int rep)

Returns a specific repetition of STF-4: "Staff Type" - creates it if necessary

Parameters:: rep - The repetition index (0-indexed)

getStf4_StaffTypeReps

public int getStf4_StaffTypeReps()

insertStaffType

public IS insertStaffType(int rep)
                   throws HL7Exception

Inserts a repetition of STF-4: "Staff Type" 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)

insertStf4_StaffType

public IS insertStf4_StaffType(int rep)
                        throws HL7Exception

Inserts a repetition of STF-4: "Staff Type" 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)

removeStaffType

public IS removeStaffType(int rep)
                   throws HL7Exception

Removes a repetition of STF-4: "Staff Type" 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)

removeStf4_StaffType

public IS removeStf4_StaffType(int rep)
                        throws HL7Exception

Removes a repetition of STF-4: "Staff Type" 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)

getAdministrativeSex

public IS getAdministrativeSex()

Returns STF-5: "Administrative Sex" - creates it if necessary

getStf5_AdministrativeSex

public IS getStf5_AdministrativeSex()

Returns STF-5: "Administrative Sex" - creates it if necessary

getDateTimeOfBirth

public TS getDateTimeOfBirth()

Returns STF-6: "Date/Time Of Birth" - creates it if necessary

getStf6_DateTimeOfBirth

public TS getStf6_DateTimeOfBirth()

Returns STF-6: "Date/Time Of Birth" - creates it if necessary

getActiveInactiveFlag

public ID getActiveInactiveFlag()

Returns STF-7: "Active/Inactive Flag" - creates it if necessary

getStf7_ActiveInactiveFlag

public ID getStf7_ActiveInactiveFlag()

Returns STF-7: "Active/Inactive Flag" - creates it if necessary

getDepartment

public CE[] getDepartment()

Returns all repetitions of Department (STF-8).

getDepartmentReps

public int getDepartmentReps()

Returns a count of the current number of repetitions of Department (STF-8). This method does not create a repetition, so if no repetitions have currently been defined or accessed, it will return zero.

getDepartment

public CE getDepartment(int rep)

Returns a specific repetition of STF-8: "Department" - creates it if necessary

Parameters:: rep - The repetition index (0-indexed)

getStf8_Department

public CE getStf8_Department(int rep)

Returns a specific repetition of STF-8: "Department" - creates it if necessary

Parameters:: rep - The repetition index (0-indexed)

getStf8_DepartmentReps

public int getStf8_DepartmentReps()

insertDepartment

public CE insertDepartment(int rep)
                    throws HL7Exception

Inserts a repetition of STF-8: "Department" 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)

insertStf8_Department

public CE insertStf8_Department(int rep)
                         throws HL7Exception

Inserts a repetition of STF-8: "Department" 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)

removeDepartment

public CE removeDepartment(int rep)
                    throws HL7Exception

Removes a repetition of STF-8: "Department" 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)

removeStf8_Department

public CE removeStf8_Department(int rep)
                         throws HL7Exception

Removes a repetition of STF-8: "Department" 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)

getHospitalService

public CE[] getHospitalService()

Returns all repetitions of Hospital Service (STF-9).

getHospitalServiceReps

public int getHospitalServiceReps()

Returns a count of the current number of repetitions of Hospital Service (STF-9). This method does not create a repetition, so if no repetitions have currently been defined or accessed, it will return zero.

getHospitalService

public CE getHospitalService(int rep)

Returns a specific repetition of STF-9: "Hospital Service" - creates it if necessary

Parameters:: rep - The repetition index (0-indexed)

getStf9_HospitalService

public CE getStf9_HospitalService(int rep)

Returns a specific repetition of STF-9: "Hospital Service" - creates it if necessary

Parameters:: rep - The repetition index (0-indexed)

getStf9_HospitalServiceReps

public int getStf9_HospitalServiceReps()

insertHospitalService

public CE insertHospitalService(int rep)
                         throws HL7Exception

Inserts a repetition of STF-9: "Hospital Service" 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)

insertStf9_HospitalService

public CE insertStf9_HospitalService(int rep)
                              throws HL7Exception

Inserts a repetition of STF-9: "Hospital Service" 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)

removeHospitalService

public CE removeHospitalService(int rep)
                         throws HL7Exception

Removes a repetition of STF-9: "Hospital Service" 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)

removeStf9_HospitalService

public CE removeStf9_HospitalService(int rep)
                              throws HL7Exception

Removes a repetition of STF-9: "Hospital Service" 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)

getPhone

public XTN[] getPhone()

Returns all repetitions of Phone (STF-10).

getPhoneReps

public int getPhoneReps()

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

getPhone

public XTN getPhone(int rep)

Returns a specific repetition of STF-10: "Phone" - creates it if necessary

Parameters:: rep - The repetition index (0-indexed)

getStf10_Phone

public XTN getStf10_Phone(int rep)

Returns a specific repetition of STF-10: "Phone" - creates it if necessary

Parameters:: rep - The repetition index (0-indexed)

getStf10_PhoneReps

public int getStf10_PhoneReps()

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

insertPhone

public XTN insertPhone(int rep)
                throws HL7Exception

Inserts a repetition of STF-10: "Phone" 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)

insertStf10_Phone

public XTN insertStf10_Phone(int rep)
                      throws HL7Exception

Inserts a repetition of STF-10: "Phone" 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)

removePhone

public XTN removePhone(int rep)
                throws HL7Exception

Removes a repetition of STF-10: "Phone" 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)

removeStf10_Phone

public XTN removeStf10_Phone(int rep)
                      throws HL7Exception

Removes a repetition of STF-10: "Phone" 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)

getOfficeHomeAddress

public XAD[] getOfficeHomeAddress()

Returns all repetitions of Office/Home Address (STF-11).

getOfficeHomeAddressReps

public int getOfficeHomeAddressReps()

Returns a count of the current number of repetitions of Office/Home Address (STF-11). This method does not create a repetition, so if no repetitions have currently been defined or accessed, it will return zero.

getOfficeHomeAddress

public XAD getOfficeHomeAddress(int rep)

Returns a specific repetition of STF-11: "Office/Home Address" - creates it if necessary

Parameters:: rep - The repetition index (0-indexed)

getStf11_OfficeHomeAddress

public XAD getStf11_OfficeHomeAddress(int rep)

Returns a specific repetition of STF-11: "Office/Home Address" - creates it if necessary

Parameters:: rep - The repetition index (0-indexed)

getStf11_OfficeHomeAddressReps

public int getStf11_OfficeHomeAddressReps()

insertOfficeHomeAddress

public XAD insertOfficeHomeAddress(int rep)
                            throws HL7Exception

Inserts a repetition of STF-11: "Office/Home Address" 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)

insertStf11_OfficeHomeAddress

public XAD insertStf11_OfficeHomeAddress(int rep)
                                  throws HL7Exception

Inserts a repetition of STF-11: "Office/Home Address" 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)

removeOfficeHomeAddress

public XAD removeOfficeHomeAddress(int rep)
                            throws HL7Exception

Removes a repetition of STF-11: "Office/Home Address" 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)

removeStf11_OfficeHomeAddress

public XAD removeStf11_OfficeHomeAddress(int rep)
                                  throws HL7Exception

Removes a repetition of STF-11: "Office/Home Address" 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)

getInstitutionActivationDate

public DIN[] getInstitutionActivationDate()

Returns all repetitions of Institution Activation Date (STF-12).

getInstitutionActivationDateReps

public int getInstitutionActivationDateReps()

Returns a count of the current number of repetitions of Institution Activation Date (STF-12). This method does not create a repetition, so if no repetitions have currently been defined or accessed, it will return zero.

getInstitutionActivationDate

public DIN getInstitutionActivationDate(int rep)

Returns a specific repetition of STF-12: "Institution Activation Date" - creates it if necessary

Parameters:: rep - The repetition index (0-indexed)

getStf12_InstitutionActivationDate

public DIN getStf12_InstitutionActivationDate(int rep)

Returns a specific repetition of STF-12: "Institution Activation Date" - creates it if necessary

Parameters:: rep - The repetition index (0-indexed)

getStf12_InstitutionActivationDateReps

public int getStf12_InstitutionActivationDateReps()

insertInstitutionActivationDate

public DIN insertInstitutionActivationDate(int rep)
                                    throws HL7Exception

Inserts a repetition of STF-12: "Institution Activation Date" 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)

insertStf12_InstitutionActivationDate

public DIN insertStf12_InstitutionActivationDate(int rep)
                                          throws HL7Exception

Inserts a repetition of STF-12: "Institution Activation Date" 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)

removeInstitutionActivationDate

public DIN removeInstitutionActivationDate(int rep)
                                    throws HL7Exception

Removes a repetition of STF-12: "Institution Activation Date" 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)

removeStf12_InstitutionActivationDate

public DIN removeStf12_InstitutionActivationDate(int rep)
                                          throws HL7Exception

Removes a repetition of STF-12: "Institution Activation Date" 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)

getInstitutionInactivationDate

public DIN[] getInstitutionInactivationDate()

Returns all repetitions of Institution Inactivation Date (STF-13).

getInstitutionInactivationDateReps

public int getInstitutionInactivationDateReps()

Returns a count of the current number of repetitions of Institution Inactivation Date (STF-13). This method does not create a repetition, so if no repetitions have currently been defined or accessed, it will return zero.

getInstitutionInactivationDate

public DIN getInstitutionInactivationDate(int rep)

Returns a specific repetition of STF-13: "Institution Inactivation Date" - creates it if necessary

Parameters:: rep - The repetition index (0-indexed)

getStf13_InstitutionInactivationDate

public DIN getStf13_InstitutionInactivationDate(int rep)

Returns a specific repetition of STF-13: "Institution Inactivation Date" - creates it if necessary

Parameters:: rep - The repetition index (0-indexed)

getStf13_InstitutionInactivationDateReps

public int getStf13_InstitutionInactivationDateReps()

insertInstitutionInactivationDate

public DIN insertInstitutionInactivationDate(int rep)
                                      throws HL7Exception

Inserts a repetition of STF-13: "Institution Inactivation Date" 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)

insertStf13_InstitutionInactivationDate

public DIN insertStf13_InstitutionInactivationDate(int rep)
                                            throws HL7Exception

Inserts a repetition of STF-13: "Institution Inactivation Date" 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)

removeInstitutionInactivationDate

public DIN removeInstitutionInactivationDate(int rep)
                                      throws HL7Exception

Removes a repetition of STF-13: "Institution Inactivation Date" 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)

removeStf13_InstitutionInactivationDate

public DIN removeStf13_InstitutionInactivationDate(int rep)
                                            throws HL7Exception

Removes a repetition of STF-13: "Institution Inactivation Date" 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)

getBackupPersonID

public CE[] getBackupPersonID()

Returns all repetitions of Backup Person ID (STF-14).

getBackupPersonIDReps

public int getBackupPersonIDReps()

Returns a count of the current number of repetitions of Backup Person ID (STF-14). This method does not create a repetition, so if no repetitions have currently been defined or accessed, it will return zero.

getBackupPersonID

public CE getBackupPersonID(int rep)

Returns a specific repetition of STF-14: "Backup Person ID" - creates it if necessary

Parameters:: rep - The repetition index (0-indexed)

getStf14_BackupPersonID

public CE getStf14_BackupPersonID(int rep)

Returns a specific repetition of STF-14: "Backup Person ID" - creates it if necessary

Parameters:: rep - The repetition index (0-indexed)

getStf14_BackupPersonIDReps

public int getStf14_BackupPersonIDReps()

insertBackupPersonID

public CE insertBackupPersonID(int rep)
                        throws HL7Exception

Inserts a repetition of STF-14: "Backup Person ID" 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)

insertStf14_BackupPersonID

public CE insertStf14_BackupPersonID(int rep)
                              throws HL7Exception

Inserts a repetition of STF-14: "Backup Person ID" 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)

removeBackupPersonID

public CE removeBackupPersonID(int rep)
                        throws HL7Exception

Removes a repetition of STF-14: "Backup Person ID" 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)

removeStf14_BackupPersonID

public CE removeStf14_BackupPersonID(int rep)
                              throws HL7Exception

Removes a repetition of STF-14: "Backup Person ID" 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)

getEMailAddress

public ST[] getEMailAddress()

Returns all repetitions of E-Mail Address (STF-15).

getEMailAddressReps

public int getEMailAddressReps()

Returns a count of the current number of repetitions of E-Mail Address (STF-15). This method does not create a repetition, so if no repetitions have currently been defined or accessed, it will return zero.

getEMailAddress

public ST getEMailAddress(int rep)

Returns a specific repetition of STF-15: "E-Mail Address" - creates it if necessary

Parameters:: rep - The repetition index (0-indexed)

getStf15_EMailAddress

public ST getStf15_EMailAddress(int rep)

Returns a specific repetition of STF-15: "E-Mail Address" - creates it if necessary

Parameters:: rep - The repetition index (0-indexed)

getStf15_EMailAddressReps

public int getStf15_EMailAddressReps()

insertEMailAddress

public ST insertEMailAddress(int rep)
                      throws HL7Exception

Inserts a repetition of STF-15: "E-Mail Address" 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)

insertStf15_EMailAddress

public ST insertStf15_EMailAddress(int rep)
                            throws HL7Exception

Inserts a repetition of STF-15: "E-Mail Address" 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)

removeEMailAddress

public ST removeEMailAddress(int rep)
                      throws HL7Exception

Removes a repetition of STF-15: "E-Mail Address" 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)

removeStf15_EMailAddress

public ST removeStf15_EMailAddress(int rep)
                            throws HL7Exception

Removes a repetition of STF-15: "E-Mail Address" 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)

getPreferredMethodOfContact

public CE getPreferredMethodOfContact()

Returns STF-16: "Preferred Method of Contact" - creates it if necessary

getStf16_PreferredMethodOfContact

public CE getStf16_PreferredMethodOfContact()

Returns STF-16: "Preferred Method of Contact" - creates it if necessary

getMaritalStatus

public CE getMaritalStatus()

Returns STF-17: "Marital Status" - creates it if necessary

getStf17_MaritalStatus

public CE getStf17_MaritalStatus()

Returns STF-17: "Marital Status" - creates it if necessary

getJobTitle

public ST getJobTitle()

Returns STF-18: "Job Title" - creates it if necessary

getStf18_JobTitle

public ST getStf18_JobTitle()

Returns STF-18: "Job Title" - creates it if necessary

getJobCodeClass

public JCC getJobCodeClass()

Returns STF-19: "Job Code/Class" - creates it if necessary

getStf19_JobCodeClass

public JCC getStf19_JobCodeClass()

Returns STF-19: "Job Code/Class" - creates it if necessary

getEmploymentStatusCode

public CE getEmploymentStatusCode()

Returns STF-20: "Employment Status Code" - creates it if necessary

getStf20_EmploymentStatusCode

public CE getStf20_EmploymentStatusCode()

Returns STF-20: "Employment Status Code" - creates it if necessary

getAdditionalInsuredOnAuto

public ID getAdditionalInsuredOnAuto()

Returns STF-21: "Additional Insured on Auto" - creates it if necessary

getStf21_AdditionalInsuredOnAuto

public ID getStf21_AdditionalInsuredOnAuto()

Returns STF-21: "Additional Insured on Auto" - creates it if necessary

getDriverSLicenseNumberStaff

public DLN getDriverSLicenseNumberStaff()

Returns STF-22: "Driver's License Number - Staff" - creates it if necessary

getStf22_DriverSLicenseNumberStaff

public DLN getStf22_DriverSLicenseNumberStaff()

Returns STF-22: "Driver's License Number - Staff" - creates it if necessary

getCopyAutoIns

public ID getCopyAutoIns()

Returns STF-23: "Copy Auto Ins" - creates it if necessary

getStf23_CopyAutoIns

public ID getStf23_CopyAutoIns()

Returns STF-23: "Copy Auto Ins" - creates it if necessary

getAutoInsExpires

public DT getAutoInsExpires()

Returns STF-24: "Auto Ins. Expires" - creates it if necessary

getStf24_AutoInsExpires

public DT getStf24_AutoInsExpires()

Returns STF-24: "Auto Ins. Expires" - creates it if necessary

getDateLastDMVReview

public DT getDateLastDMVReview()

Returns STF-25: "Date Last DMV Review" - creates it if necessary

getStf25_DateLastDMVReview

public DT getStf25_DateLastDMVReview()

Returns STF-25: "Date Last DMV Review" - creates it if necessary

getDateNextDMVReview

public DT getDateNextDMVReview()

Returns STF-26: "Date Next DMV Review" - creates it if necessary

getStf26_DateNextDMVReview

public DT getStf26_DateNextDMVReview()

Returns STF-26: "Date Next DMV Review" - creates it if necessary

getRace

public CE getRace()

Returns STF-27: "Race" - creates it if necessary

getStf27_Race

public CE getStf27_Race()

Returns STF-27: "Race" - creates it if necessary

getEthnicGroup

public CE getEthnicGroup()

Returns STF-28: "Ethnic Group" - creates it if necessary

getStf28_EthnicGroup

public CE getStf28_EthnicGroup()

Returns STF-28: "Ethnic Group" - creates it if necessary

getReActivationApprovalIndicator

public ID getReActivationApprovalIndicator()

Returns STF-29: "Re-activation Approval Indicator" - creates it if necessary

getStf29_ReActivationApprovalIndicator

public ID getStf29_ReActivationApprovalIndicator()

Returns STF-29: "Re-activation Approval Indicator" - creates it if necessary

createNewTypeWithoutReflection

protected Type createNewTypeWithoutReflection(int field)

Overrides:: createNewTypeWithoutReflection in class AbstractSegment

Overview

Package

Class

Use

Tree

Deprecated

Index

Help

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

ca.uhn.hl7v2.model.v24.segment Class STF

STF

getPrimaryKeyValueSTF

getStf1_PrimaryKeyValueSTF

getStaffIDCode

getStaffIDCodeReps

getStaffIDCode

getStf2_StaffIDCode

getStf2_StaffIDCodeReps

insertStaffIDCode

insertStf2_StaffIDCode

removeStaffIDCode

removeStf2_StaffIDCode

getStaffName

getStaffNameReps

getStaffName

getStf3_StaffName

getStf3_StaffNameReps

insertStaffName

insertStf3_StaffName

removeStaffName

removeStf3_StaffName

getStaffType

getStaffTypeReps

getStaffType

getStf4_StaffType

getStf4_StaffTypeReps

insertStaffType

insertStf4_StaffType

removeStaffType

removeStf4_StaffType

getAdministrativeSex

getStf5_AdministrativeSex

getDateTimeOfBirth

getStf6_DateTimeOfBirth

getActiveInactiveFlag

getStf7_ActiveInactiveFlag

getDepartment

getDepartmentReps

getDepartment

getStf8_Department

getStf8_DepartmentReps

insertDepartment

insertStf8_Department

removeDepartment

removeStf8_Department

getHospitalService

getHospitalServiceReps

getHospitalService

getStf9_HospitalService

getStf9_HospitalServiceReps

insertHospitalService

insertStf9_HospitalService

removeHospitalService

removeStf9_HospitalService

getPhone

getPhoneReps

getPhone

getStf10_Phone

getStf10_PhoneReps

insertPhone

insertStf10_Phone

removePhone

removeStf10_Phone

getOfficeHomeAddress

getOfficeHomeAddressReps

getOfficeHomeAddress

getStf11_OfficeHomeAddress

getStf11_OfficeHomeAddressReps

insertOfficeHomeAddress

insertStf11_OfficeHomeAddress

removeOfficeHomeAddress

removeStf11_OfficeHomeAddress

getInstitutionActivationDate

getInstitutionActivationDateReps

getInstitutionActivationDate

getStf12_InstitutionActivationDate

getStf12_InstitutionActivationDateReps

insertInstitutionActivationDate

insertStf12_InstitutionActivationDate

ca.uhn.hl7v2.model.v24.segment
Class STF