Package ca.uhn.hl7v2.model.v24.segment

Class FAC

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

Represents an HL7 FAC message segment (Facility). This segment has the following fields:

  • FAC-1: Facility ID-FAC (EI)
  • FAC-2: Facility Type (ID) optional
  • FAC-3: Facility Address (XAD) repeating
  • FAC-4: Facility Telecommunication (XTN)
  • FAC-5: Contact Person (XCN) optional repeating
  • FAC-6: Contact Title (ST) optional repeating
  • FAC-7: Contact Address (XAD) optional repeating
  • FAC-8: Contact Telecommunication (XTN) optional repeating
  • FAC-9: Signature Authority (XCN) repeating
  • FAC-10: Signature Authority Title (ST) optional
  • FAC-11: Signature Authority Address (XAD) optional repeating
  • FAC-12: Signature Authority Telecommunication (XTN) optional
See Also:

  • Constructor Details

  • Method Details

    • getFacilityIDFAC

      public EI getFacilityIDFAC()
      Returns FAC-1: "Facility ID-FAC" - creates it if necessary

    • getFac1_FacilityIDFAC

      public EI getFac1_FacilityIDFAC()
      Returns FAC-1: "Facility ID-FAC" - creates it if necessary

    • getFacilityType

      public ID getFacilityType()
      Returns FAC-2: "Facility Type" - creates it if necessary

    • getFac2_FacilityType

      public ID getFac2_FacilityType()
      Returns FAC-2: "Facility Type" - creates it if necessary

    • getFacilityAddress

      public XAD[] getFacilityAddress()
      Returns all repetitions of Facility Address (FAC-3).

    • getFac3_FacilityAddress

      public XAD[] getFac3_FacilityAddress()
      Returns all repetitions of Facility Address (FAC-3).

    • getFacilityAddressReps

      public int getFacilityAddressReps()
      Returns a count of the current number of repetitions of Facility Address (FAC-3). This method does not create a repetition, so if no repetitions have currently been defined or accessed, it will return zero.

    • getFacilityAddress

      public XAD getFacilityAddress(int rep)
      Returns a specific repetition of FAC-3: "Facility Address" - creates it if necessary
      Parameters:
      rep - The repetition index (0-indexed)

    • getFac3_FacilityAddress

      public XAD getFac3_FacilityAddress(int rep)
      Returns a specific repetition of FAC-3: "Facility Address" - creates it if necessary
      Parameters:
      rep - The repetition index (0-indexed)

    • getFac3_FacilityAddressReps

      public int getFac3_FacilityAddressReps()
      Returns a count of the current number of repetitions of Facility Address (FAC-3). This method does not create a repetition, so if no repetitions have currently been defined or accessed, it will return zero.

    • insertFacilityAddress

      public XAD insertFacilityAddress(int rep) throws HL7Exception
      Inserts a repetition of FAC-3: "Facility 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)

    • insertFac3_FacilityAddress

      public XAD insertFac3_FacilityAddress(int rep) throws HL7Exception
      Inserts a repetition of FAC-3: "Facility 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)

    • removeFacilityAddress

      public XAD removeFacilityAddress(int rep) throws HL7Exception
      Removes a repetition of FAC-3: "Facility 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)

    • removeFac3_FacilityAddress

      public XAD removeFac3_FacilityAddress(int rep) throws HL7Exception
      Removes a repetition of FAC-3: "Facility 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)

    • getFacilityTelecommunication

      public XTN getFacilityTelecommunication()
      Returns FAC-4: "Facility Telecommunication" - creates it if necessary

    • getFac4_FacilityTelecommunication

      public XTN getFac4_FacilityTelecommunication()
      Returns FAC-4: "Facility Telecommunication" - creates it if necessary

    • getContactPerson

      public XCN[] getContactPerson()
      Returns all repetitions of Contact Person (FAC-5).

    • getFac5_ContactPerson

      public XCN[] getFac5_ContactPerson()
      Returns all repetitions of Contact Person (FAC-5).

    • getContactPersonReps

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

    • getContactPerson

      public XCN getContactPerson(int rep)
      Returns a specific repetition of FAC-5: "Contact Person" - creates it if necessary
      Parameters:
      rep - The repetition index (0-indexed)

    • getFac5_ContactPerson

      public XCN getFac5_ContactPerson(int rep)
      Returns a specific repetition of FAC-5: "Contact Person" - creates it if necessary
      Parameters:
      rep - The repetition index (0-indexed)

    • getFac5_ContactPersonReps

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

    • insertContactPerson

      public XCN insertContactPerson(int rep) throws HL7Exception
      Inserts a repetition of FAC-5: "Contact Person" 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)

    • insertFac5_ContactPerson

      public XCN insertFac5_ContactPerson(int rep) throws HL7Exception
      Inserts a repetition of FAC-5: "Contact Person" 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)

    • removeContactPerson

      public XCN removeContactPerson(int rep) throws HL7Exception
      Removes a repetition of FAC-5: "Contact Person" 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)

    • removeFac5_ContactPerson

      public XCN removeFac5_ContactPerson(int rep) throws HL7Exception
      Removes a repetition of FAC-5: "Contact Person" 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)

    • getContactTitle

      public ST[] getContactTitle()
      Returns all repetitions of Contact Title (FAC-6).

    • getFac6_ContactTitle

      public ST[] getFac6_ContactTitle()
      Returns all repetitions of Contact Title (FAC-6).

    • getContactTitleReps

      public int getContactTitleReps()
      Returns a count of the current number of repetitions of Contact Title (FAC-6). This method does not create a repetition, so if no repetitions have currently been defined or accessed, it will return zero.

    • getContactTitle

      public ST getContactTitle(int rep)
      Returns a specific repetition of FAC-6: "Contact Title" - creates it if necessary
      Parameters:
      rep - The repetition index (0-indexed)

    • getFac6_ContactTitle

      public ST getFac6_ContactTitle(int rep)
      Returns a specific repetition of FAC-6: "Contact Title" - creates it if necessary
      Parameters:
      rep - The repetition index (0-indexed)

    • getFac6_ContactTitleReps

      public int getFac6_ContactTitleReps()
      Returns a count of the current number of repetitions of Contact Title (FAC-6). This method does not create a repetition, so if no repetitions have currently been defined or accessed, it will return zero.

    • insertContactTitle

      public ST insertContactTitle(int rep) throws HL7Exception
      Inserts a repetition of FAC-6: "Contact Title" 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)

    • insertFac6_ContactTitle

      public ST insertFac6_ContactTitle(int rep) throws HL7Exception
      Inserts a repetition of FAC-6: "Contact Title" 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)

    • removeContactTitle

      public ST removeContactTitle(int rep) throws HL7Exception
      Removes a repetition of FAC-6: "Contact Title" 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)

    • removeFac6_ContactTitle

      public ST removeFac6_ContactTitle(int rep) throws HL7Exception
      Removes a repetition of FAC-6: "Contact Title" 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)

    • getContactAddress

      public XAD[] getContactAddress()
      Returns all repetitions of Contact Address (FAC-7).

    • getFac7_ContactAddress

      public XAD[] getFac7_ContactAddress()
      Returns all repetitions of Contact Address (FAC-7).

    • getContactAddressReps

      public int getContactAddressReps()
      Returns a count of the current number of repetitions of Contact Address (FAC-7). This method does not create a repetition, so if no repetitions have currently been defined or accessed, it will return zero.

    • getContactAddress

      public XAD getContactAddress(int rep)
      Returns a specific repetition of FAC-7: "Contact Address" - creates it if necessary
      Parameters:
      rep - The repetition index (0-indexed)

    • getFac7_ContactAddress

      public XAD getFac7_ContactAddress(int rep)
      Returns a specific repetition of FAC-7: "Contact Address" - creates it if necessary
      Parameters:
      rep - The repetition index (0-indexed)

    • getFac7_ContactAddressReps

      public int getFac7_ContactAddressReps()
      Returns a count of the current number of repetitions of Contact Address (FAC-7). This method does not create a repetition, so if no repetitions have currently been defined or accessed, it will return zero.

    • insertContactAddress

      public XAD insertContactAddress(int rep) throws HL7Exception
      Inserts a repetition of FAC-7: "Contact 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)

    • insertFac7_ContactAddress

      public XAD insertFac7_ContactAddress(int rep) throws HL7Exception
      Inserts a repetition of FAC-7: "Contact 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)

    • removeContactAddress

      public XAD removeContactAddress(int rep) throws HL7Exception
      Removes a repetition of FAC-7: "Contact 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)

    • removeFac7_ContactAddress

      public XAD removeFac7_ContactAddress(int rep) throws HL7Exception
      Removes a repetition of FAC-7: "Contact 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)

    • getContactTelecommunication

      public XTN[] getContactTelecommunication()
      Returns all repetitions of Contact Telecommunication (FAC-8).

    • getFac8_ContactTelecommunication

      public XTN[] getFac8_ContactTelecommunication()
      Returns all repetitions of Contact Telecommunication (FAC-8).

    • getContactTelecommunicationReps

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

    • getContactTelecommunication

      public XTN getContactTelecommunication(int rep)
      Returns a specific repetition of FAC-8: "Contact Telecommunication" - creates it if necessary
      Parameters:
      rep - The repetition index (0-indexed)

    • getFac8_ContactTelecommunication

      public XTN getFac8_ContactTelecommunication(int rep)
      Returns a specific repetition of FAC-8: "Contact Telecommunication" - creates it if necessary
      Parameters:
      rep - The repetition index (0-indexed)

    • getFac8_ContactTelecommunicationReps

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

    • insertContactTelecommunication

      public XTN insertContactTelecommunication(int rep) throws HL7Exception
      Inserts a repetition of FAC-8: "Contact Telecommunication" 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)

    • insertFac8_ContactTelecommunication

      public XTN insertFac8_ContactTelecommunication(int rep) throws HL7Exception
      Inserts a repetition of FAC-8: "Contact Telecommunication" 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)

    • removeContactTelecommunication

      public XTN removeContactTelecommunication(int rep) throws HL7Exception
      Removes a repetition of FAC-8: "Contact Telecommunication" 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)

    • removeFac8_ContactTelecommunication

      public XTN removeFac8_ContactTelecommunication(int rep) throws HL7Exception
      Removes a repetition of FAC-8: "Contact Telecommunication" 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)

    • getSignatureAuthority

      public XCN[] getSignatureAuthority()
      Returns all repetitions of Signature Authority (FAC-9).

    • getFac9_SignatureAuthority

      public XCN[] getFac9_SignatureAuthority()
      Returns all repetitions of Signature Authority (FAC-9).

    • getSignatureAuthorityReps

      public int getSignatureAuthorityReps()
      Returns a count of the current number of repetitions of Signature Authority (FAC-9). This method does not create a repetition, so if no repetitions have currently been defined or accessed, it will return zero.

    • getSignatureAuthority

      public XCN getSignatureAuthority(int rep)
      Returns a specific repetition of FAC-9: "Signature Authority" - creates it if necessary
      Parameters:
      rep - The repetition index (0-indexed)

    • getFac9_SignatureAuthority

      public XCN getFac9_SignatureAuthority(int rep)
      Returns a specific repetition of FAC-9: "Signature Authority" - creates it if necessary
      Parameters:
      rep - The repetition index (0-indexed)

    • getFac9_SignatureAuthorityReps

      public int getFac9_SignatureAuthorityReps()
      Returns a count of the current number of repetitions of Signature Authority (FAC-9). This method does not create a repetition, so if no repetitions have currently been defined or accessed, it will return zero.

    • insertSignatureAuthority

      public XCN insertSignatureAuthority(int rep) throws HL7Exception
      Inserts a repetition of FAC-9: "Signature Authority" 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)

    • insertFac9_SignatureAuthority

      public XCN insertFac9_SignatureAuthority(int rep) throws HL7Exception
      Inserts a repetition of FAC-9: "Signature Authority" 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)

    • removeSignatureAuthority

      public XCN removeSignatureAuthority(int rep) throws HL7Exception
      Removes a repetition of FAC-9: "Signature Authority" 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)

    • removeFac9_SignatureAuthority

      public XCN removeFac9_SignatureAuthority(int rep) throws HL7Exception
      Removes a repetition of FAC-9: "Signature Authority" 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)

    • getSignatureAuthorityTitle

      public ST getSignatureAuthorityTitle()
      Returns FAC-10: "Signature Authority Title" - creates it if necessary

    • getFac10_SignatureAuthorityTitle

      public ST getFac10_SignatureAuthorityTitle()
      Returns FAC-10: "Signature Authority Title" - creates it if necessary

    • getSignatureAuthorityAddress

      public XAD[] getSignatureAuthorityAddress()
      Returns all repetitions of Signature Authority Address (FAC-11).

    • getFac11_SignatureAuthorityAddress

      public XAD[] getFac11_SignatureAuthorityAddress()
      Returns all repetitions of Signature Authority Address (FAC-11).

    • getSignatureAuthorityAddressReps

      public int getSignatureAuthorityAddressReps()
      Returns a count of the current number of repetitions of Signature Authority Address (FAC-11). This method does not create a repetition, so if no repetitions have currently been defined or accessed, it will return zero.

    • getSignatureAuthorityAddress

      public XAD getSignatureAuthorityAddress(int rep)
      Returns a specific repetition of FAC-11: "Signature Authority Address" - creates it if necessary
      Parameters:
      rep - The repetition index (0-indexed)

    • getFac11_SignatureAuthorityAddress

      public XAD getFac11_SignatureAuthorityAddress(int rep)
      Returns a specific repetition of FAC-11: "Signature Authority Address" - creates it if necessary
      Parameters:
      rep - The repetition index (0-indexed)

    • getFac11_SignatureAuthorityAddressReps

      public int getFac11_SignatureAuthorityAddressReps()
      Returns a count of the current number of repetitions of Signature Authority Address (FAC-11). This method does not create a repetition, so if no repetitions have currently been defined or accessed, it will return zero.

    • insertSignatureAuthorityAddress

      public XAD insertSignatureAuthorityAddress(int rep) throws HL7Exception
      Inserts a repetition of FAC-11: "Signature Authority 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)

    • insertFac11_SignatureAuthorityAddress

      public XAD insertFac11_SignatureAuthorityAddress(int rep) throws HL7Exception
      Inserts a repetition of FAC-11: "Signature Authority 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)

    • removeSignatureAuthorityAddress

      public XAD removeSignatureAuthorityAddress(int rep) throws HL7Exception
      Removes a repetition of FAC-11: "Signature Authority 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)

    • removeFac11_SignatureAuthorityAddress

      public XAD removeFac11_SignatureAuthorityAddress(int rep) throws HL7Exception
      Removes a repetition of FAC-11: "Signature Authority 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)

    • getSignatureAuthorityTelecommunication

      public XTN getSignatureAuthorityTelecommunication()
      Returns FAC-12: "Signature Authority Telecommunication" - creates it if necessary

    • getFac12_SignatureAuthorityTelecommunication

      public XTN getFac12_SignatureAuthorityTelecommunication()
      Returns FAC-12: "Signature Authority Telecommunication" - creates it if necessary

    • createNewTypeWithoutReflection

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