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

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

All Implemented Interfaces:

Segment, Structure, Serializable

public class AFF
extends AbstractSegment

Represents an HL7 AFF message segment (Professional Affiliation). This segment has the following fields:

• AFF-1: Set ID - AFF (SI)
• AFF-2: Professional Organization (XON)
• AFF-3: Professional Organization Address (XAD) optional
• AFF-4: Professional Organization Affiliation Date Range (DR) optional repeating
• AFF-5: Professional Affiliation Additional Information (ST) optional

See Also:

Serialized Form

Constructor Summary

AFF(Group parent, ModelClassFactory factory)
Creates a new AFF segment

Method Summary

protected Type	createNewTypeWithoutReflection(int field)
SI	getAff1_SetIDAFF() Returns AFF-1: "Set ID - AFF" - creates it if necessary
XON	getAff2_ProfessionalOrganization() Returns AFF-2: "Professional Organization" - creates it if necessary
XAD	getAff3_ProfessionalOrganizationAddress() Returns AFF-3: "Professional Organization Address" - creates it if necessary
DR	getAff4_ProfessionalOrganizationAffiliationDateRange(int rep) Returns a specific repetition of AFF-4: "Professional Organization Affiliation Date Range" - creates it if necessary
int	getAff4_ProfessionalOrganizationAffiliationDateRangeReps() Returns a count of the current number of repetitions of Professional Organization Affiliation Date Range (AFF-4).
ST	getAff5_ProfessionalAffiliationAdditionalInformation() Returns AFF-5: "Professional Affiliation Additional Information" - creates it if necessary
ST	getProfessionalAffiliationAdditionalInformation() Returns AFF-5: "Professional Affiliation Additional Information" - creates it if necessary
XON	getProfessionalOrganization() Returns AFF-2: "Professional Organization" - creates it if necessary
XAD	getProfessionalOrganizationAddress() Returns AFF-3: "Professional Organization Address" - creates it if necessary
DR[]	getProfessionalOrganizationAffiliationDateRange() Returns all repetitions of Professional Organization Affiliation Date Range (AFF-4).
DR	getProfessionalOrganizationAffiliationDateRange(int rep) Returns a specific repetition of AFF-4: "Professional Organization Affiliation Date Range" - creates it if necessary
int	getProfessionalOrganizationAffiliationDateRangeReps() Returns a count of the current number of repetitions of Professional Organization Affiliation Date Range (AFF-4).
SI	getSetIDAFF() Returns AFF-1: "Set ID - AFF" - creates it if necessary
DR	insertAff4_ProfessionalOrganizationAffiliationDateRange(int rep) Inserts a repetition of AFF-4: "Professional Organization Affiliation Date Range" at a specific index
DR	insertProfessionalOrganizationAffiliationDateRange(int rep) Inserts a repetition of AFF-4: "Professional Organization Affiliation Date Range" at a specific index
DR	removeAff4_ProfessionalOrganizationAffiliationDateRange(int rep) Removes a repetition of AFF-4: "Professional Organization Affiliation Date Range" at a specific index
DR	removeProfessionalOrganizationAffiliationDateRange(int rep) Removes a repetition of AFF-4: "Professional Organization Affiliation Date Range" 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

AFF

public AFF(Group parent,
           ModelClassFactory factory)

Creates a new AFF segment

Method Detail

getSetIDAFF

public SI getSetIDAFF()

Returns AFF-1: "Set ID - AFF" - creates it if necessary

getAff1_SetIDAFF

public SI getAff1_SetIDAFF()

Returns AFF-1: "Set ID - AFF" - creates it if necessary

getProfessionalOrganization

public XON getProfessionalOrganization()

Returns AFF-2: "Professional Organization" - creates it if necessary

getAff2_ProfessionalOrganization

public XON getAff2_ProfessionalOrganization()

Returns AFF-2: "Professional Organization" - creates it if necessary

getProfessionalOrganizationAddress

public XAD getProfessionalOrganizationAddress()

Returns AFF-3: "Professional Organization Address" - creates it if necessary

getAff3_ProfessionalOrganizationAddress

public XAD getAff3_ProfessionalOrganizationAddress()

Returns AFF-3: "Professional Organization Address" - creates it if necessary

getProfessionalOrganizationAffiliationDateRange

public DR[] getProfessionalOrganizationAffiliationDateRange()

Returns all repetitions of Professional Organization Affiliation Date Range (AFF-4).

getProfessionalOrganizationAffiliationDateRangeReps

public int getProfessionalOrganizationAffiliationDateRangeReps()

Returns a count of the current number of repetitions of Professional Organization Affiliation Date Range (AFF-4). This method does not create a repetition, so if no repetitions have currently been defined or accessed, it will return zero.

getProfessionalOrganizationAffiliationDateRange

public DR getProfessionalOrganizationAffiliationDateRange(int rep)

Returns a specific repetition of AFF-4: "Professional Organization Affiliation Date Range" - creates it if necessary

Parameters:

rep - The repetition index (0-indexed)

getAff4_ProfessionalOrganizationAffiliationDateRange

public DR getAff4_ProfessionalOrganizationAffiliationDateRange(int rep)

Returns a specific repetition of AFF-4: "Professional Organization Affiliation Date Range" - creates it if necessary

Parameters:

rep - The repetition index (0-indexed)

getAff4_ProfessionalOrganizationAffiliationDateRangeReps

public int getAff4_ProfessionalOrganizationAffiliationDateRangeReps()

Returns a count of the current number of repetitions of Professional Organization Affiliation Date Range (AFF-4). This method does not create a repetition, so if no repetitions have currently been defined or accessed, it will return zero.

insertProfessionalOrganizationAffiliationDateRange

public DR insertProfessionalOrganizationAffiliationDateRange(int rep)
                                                      throws HL7Exception

Inserts a repetition of AFF-4: "Professional Organization Affiliation Date Range" 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)

insertAff4_ProfessionalOrganizationAffiliationDateRange

public DR insertAff4_ProfessionalOrganizationAffiliationDateRange(int rep)
                                                           throws HL7Exception

Inserts a repetition of AFF-4: "Professional Organization Affiliation Date Range" 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)

removeProfessionalOrganizationAffiliationDateRange

public DR removeProfessionalOrganizationAffiliationDateRange(int rep)
                                                      throws HL7Exception

Removes a repetition of AFF-4: "Professional Organization Affiliation Date Range" 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)

removeAff4_ProfessionalOrganizationAffiliationDateRange

public DR removeAff4_ProfessionalOrganizationAffiliationDateRange(int rep)
                                                           throws HL7Exception

Removes a repetition of AFF-4: "Professional Organization Affiliation Date Range" 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)

getProfessionalAffiliationAdditionalInformation

public ST getProfessionalAffiliationAdditionalInformation()

Returns AFF-5: "Professional Affiliation Additional Information" - creates it if necessary

getAff5_ProfessionalAffiliationAdditionalInformation

public ST getAff5_ProfessionalAffiliationAdditionalInformation()

Returns AFF-5: "Professional Affiliation Additional Information" - creates it if necessary

createNewTypeWithoutReflection

protected Type createNewTypeWithoutReflection(int field)

Overrides:

createNewTypeWithoutReflection in class AbstractSegment