Package ca.uhn.hl7v2.model.v23.segment

Class RF1

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

Represents an HL7 RF1 message segment (Referral Information Segment). This segment has the following fields:

  • RF1-1: Referral Status (CE) optional
  • RF1-2: Referral Priority (CE) optional
  • RF1-3: Referral Type (CE) optional
  • RF1-4: Referral Disposition (CE) optional repeating
  • RF1-5: Referral Category (CE) optional
  • RF1-6: Originating Referral Identifier (EI)
  • RF1-7: Effective Date (TS) optional
  • RF1-8: Expiration Date (TS) optional
  • RF1-9: Process Date (TS) optional
  • RF1-10: Referral Reason (CE) optional repeating
  • RF1-11: External Referral Identifier (EI) optional repeating
See Also:

  • Constructor Details

  • Method Details

    • getReferralStatus

      public CE getReferralStatus()
      Returns RF1-1: "Referral Status" - creates it if necessary

    • getRf11_ReferralStatus

      public CE getRf11_ReferralStatus()
      Returns RF1-1: "Referral Status" - creates it if necessary

    • getReferralPriority

      public CE getReferralPriority()
      Returns RF1-2: "Referral Priority" - creates it if necessary

    • getRf12_ReferralPriority

      public CE getRf12_ReferralPriority()
      Returns RF1-2: "Referral Priority" - creates it if necessary

    • getReferralType

      public CE getReferralType()
      Returns RF1-3: "Referral Type" - creates it if necessary

    • getRf13_ReferralType

      public CE getRf13_ReferralType()
      Returns RF1-3: "Referral Type" - creates it if necessary

    • getReferralDisposition

      public CE[] getReferralDisposition()
      Returns all repetitions of Referral Disposition (RF1-4).

    • getRf14_ReferralDisposition

      public CE[] getRf14_ReferralDisposition()
      Returns all repetitions of Referral Disposition (RF1-4).

    • getReferralDispositionReps

      public int getReferralDispositionReps()
      Returns a count of the current number of repetitions of Referral Disposition (RF1-4). This method does not create a repetition, so if no repetitions have currently been defined or accessed, it will return zero.

    • getReferralDisposition

      public CE getReferralDisposition(int rep)
      Returns a specific repetition of RF1-4: "Referral Disposition" - creates it if necessary
      Parameters:
      rep - The repetition index (0-indexed)

    • getRf14_ReferralDisposition

      public CE getRf14_ReferralDisposition(int rep)
      Returns a specific repetition of RF1-4: "Referral Disposition" - creates it if necessary
      Parameters:
      rep - The repetition index (0-indexed)

    • getRf14_ReferralDispositionReps

      public int getRf14_ReferralDispositionReps()
      Returns a count of the current number of repetitions of Referral Disposition (RF1-4). This method does not create a repetition, so if no repetitions have currently been defined or accessed, it will return zero.

    • insertReferralDisposition

      public CE insertReferralDisposition(int rep) throws HL7Exception
      Inserts a repetition of RF1-4: "Referral Disposition" 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)

    • insertRf14_ReferralDisposition

      public CE insertRf14_ReferralDisposition(int rep) throws HL7Exception
      Inserts a repetition of RF1-4: "Referral Disposition" 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)

    • removeReferralDisposition

      public CE removeReferralDisposition(int rep) throws HL7Exception
      Removes a repetition of RF1-4: "Referral Disposition" 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)

    • removeRf14_ReferralDisposition

      public CE removeRf14_ReferralDisposition(int rep) throws HL7Exception
      Removes a repetition of RF1-4: "Referral Disposition" 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)

    • getReferralCategory

      public CE getReferralCategory()
      Returns RF1-5: "Referral Category" - creates it if necessary

    • getRf15_ReferralCategory

      public CE getRf15_ReferralCategory()
      Returns RF1-5: "Referral Category" - creates it if necessary

    • getOriginatingReferralIdentifier

      public EI getOriginatingReferralIdentifier()
      Returns RF1-6: "Originating Referral Identifier" - creates it if necessary

    • getRf16_OriginatingReferralIdentifier

      public EI getRf16_OriginatingReferralIdentifier()
      Returns RF1-6: "Originating Referral Identifier" - creates it if necessary

    • getEffectiveDate

      public TS getEffectiveDate()
      Returns RF1-7: "Effective Date" - creates it if necessary

    • getRf17_EffectiveDate

      public TS getRf17_EffectiveDate()
      Returns RF1-7: "Effective Date" - creates it if necessary

    • getExpirationDate

      public TS getExpirationDate()
      Returns RF1-8: "Expiration Date" - creates it if necessary

    • getRf18_ExpirationDate

      public TS getRf18_ExpirationDate()
      Returns RF1-8: "Expiration Date" - creates it if necessary

    • getProcessDate

      public TS getProcessDate()
      Returns RF1-9: "Process Date" - creates it if necessary

    • getRf19_ProcessDate

      public TS getRf19_ProcessDate()
      Returns RF1-9: "Process Date" - creates it if necessary

    • getReferralReason

      public CE[] getReferralReason()
      Returns all repetitions of Referral Reason (RF1-10).

    • getRf110_ReferralReason

      public CE[] getRf110_ReferralReason()
      Returns all repetitions of Referral Reason (RF1-10).

    • getReferralReasonReps

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

    • getReferralReason

      public CE getReferralReason(int rep)
      Returns a specific repetition of RF1-10: "Referral Reason" - creates it if necessary
      Parameters:
      rep - The repetition index (0-indexed)

    • getRf110_ReferralReason

      public CE getRf110_ReferralReason(int rep)
      Returns a specific repetition of RF1-10: "Referral Reason" - creates it if necessary
      Parameters:
      rep - The repetition index (0-indexed)

    • getRf110_ReferralReasonReps

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

    • insertReferralReason

      public CE insertReferralReason(int rep) throws HL7Exception
      Inserts a repetition of RF1-10: "Referral Reason" 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)

    • insertRf110_ReferralReason

      public CE insertRf110_ReferralReason(int rep) throws HL7Exception
      Inserts a repetition of RF1-10: "Referral Reason" 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)

    • removeReferralReason

      public CE removeReferralReason(int rep) throws HL7Exception
      Removes a repetition of RF1-10: "Referral Reason" 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)

    • removeRf110_ReferralReason

      public CE removeRf110_ReferralReason(int rep) throws HL7Exception
      Removes a repetition of RF1-10: "Referral Reason" 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)

    • getExternalReferralIdentifier

      public EI[] getExternalReferralIdentifier()
      Returns all repetitions of External Referral Identifier (RF1-11).

    • getRf111_ExternalReferralIdentifier

      public EI[] getRf111_ExternalReferralIdentifier()
      Returns all repetitions of External Referral Identifier (RF1-11).

    • getExternalReferralIdentifierReps

      public int getExternalReferralIdentifierReps()
      Returns a count of the current number of repetitions of External Referral Identifier (RF1-11). This method does not create a repetition, so if no repetitions have currently been defined or accessed, it will return zero.

    • getExternalReferralIdentifier

      public EI getExternalReferralIdentifier(int rep)
      Returns a specific repetition of RF1-11: "External Referral Identifier" - creates it if necessary
      Parameters:
      rep - The repetition index (0-indexed)

    • getRf111_ExternalReferralIdentifier

      public EI getRf111_ExternalReferralIdentifier(int rep)
      Returns a specific repetition of RF1-11: "External Referral Identifier" - creates it if necessary
      Parameters:
      rep - The repetition index (0-indexed)

    • getRf111_ExternalReferralIdentifierReps

      public int getRf111_ExternalReferralIdentifierReps()
      Returns a count of the current number of repetitions of External Referral Identifier (RF1-11). This method does not create a repetition, so if no repetitions have currently been defined or accessed, it will return zero.

    • insertExternalReferralIdentifier

      public EI insertExternalReferralIdentifier(int rep) throws HL7Exception
      Inserts a repetition of RF1-11: "External Referral Identifier" 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)

    • insertRf111_ExternalReferralIdentifier

      public EI insertRf111_ExternalReferralIdentifier(int rep) throws HL7Exception
      Inserts a repetition of RF1-11: "External Referral Identifier" 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)

    • removeExternalReferralIdentifier

      public EI removeExternalReferralIdentifier(int rep) throws HL7Exception
      Removes a repetition of RF1-11: "External Referral Identifier" 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)

    • removeRf111_ExternalReferralIdentifier

      public EI removeRf111_ExternalReferralIdentifier(int rep) throws HL7Exception
      Removes a repetition of RF1-11: "External Referral Identifier" 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)

    • createNewTypeWithoutReflection

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