Package ca.uhn.hl7v2.model.v251.segment

Class ERR

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

Represents an HL7 ERR message segment (Error). This segment has the following fields:

  • ERR-1: Error Code and Location (ELD) optional repeating
  • ERR-2: Error Location (ERL) optional repeating
  • ERR-3: HL7 Error Code (CWE)
  • ERR-4: Severity (ID)
  • ERR-5: Application Error Code (CWE) optional
  • ERR-6: Application Error Parameter (ST) optional repeating
  • ERR-7: Diagnostic Information (TX) optional
  • ERR-8: User Message (TX) optional
  • ERR-9: Inform Person Indicator (IS) optional repeating
  • ERR-10: Override Type (CWE) optional
  • ERR-11: Override Reason Code (CWE) optional repeating
  • ERR-12: Help Desk Contact Point (XTN) optional repeating
See Also:

  • Constructor Details

  • Method Details

    • getErrorCodeAndLocation

      public ELD[] getErrorCodeAndLocation()
      Returns all repetitions of Error Code and Location (ERR-1).

    • getErr1_ErrorCodeAndLocation

      public ELD[] getErr1_ErrorCodeAndLocation()
      Returns all repetitions of Error Code and Location (ERR-1).

    • getErrorCodeAndLocationReps

      public int getErrorCodeAndLocationReps()
      Returns a count of the current number of repetitions of Error Code and Location (ERR-1). This method does not create a repetition, so if no repetitions have currently been defined or accessed, it will return zero.

    • getErrorCodeAndLocation

      public ELD getErrorCodeAndLocation(int rep)
      Returns a specific repetition of ERR-1: "Error Code and Location" - creates it if necessary
      Parameters:
      rep - The repetition index (0-indexed)

    • getErr1_ErrorCodeAndLocation

      public ELD getErr1_ErrorCodeAndLocation(int rep)
      Returns a specific repetition of ERR-1: "Error Code and Location" - creates it if necessary
      Parameters:
      rep - The repetition index (0-indexed)

    • getErr1_ErrorCodeAndLocationReps

      public int getErr1_ErrorCodeAndLocationReps()
      Returns a count of the current number of repetitions of Error Code and Location (ERR-1). This method does not create a repetition, so if no repetitions have currently been defined or accessed, it will return zero.

    • insertErrorCodeAndLocation

      public ELD insertErrorCodeAndLocation(int rep) throws HL7Exception
      Inserts a repetition of ERR-1: "Error Code and Location" 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)

    • insertErr1_ErrorCodeAndLocation

      public ELD insertErr1_ErrorCodeAndLocation(int rep) throws HL7Exception
      Inserts a repetition of ERR-1: "Error Code and Location" 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)

    • removeErrorCodeAndLocation

      public ELD removeErrorCodeAndLocation(int rep) throws HL7Exception
      Removes a repetition of ERR-1: "Error Code and Location" 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)

    • removeErr1_ErrorCodeAndLocation

      public ELD removeErr1_ErrorCodeAndLocation(int rep) throws HL7Exception
      Removes a repetition of ERR-1: "Error Code and Location" 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)

    • getErrorLocation

      public ERL[] getErrorLocation()
      Returns all repetitions of Error Location (ERR-2).

    • getErr2_ErrorLocation

      public ERL[] getErr2_ErrorLocation()
      Returns all repetitions of Error Location (ERR-2).

    • getErrorLocationReps

      public int getErrorLocationReps()
      Returns a count of the current number of repetitions of Error Location (ERR-2). This method does not create a repetition, so if no repetitions have currently been defined or accessed, it will return zero.

    • getErrorLocation

      public ERL getErrorLocation(int rep)
      Returns a specific repetition of ERR-2: "Error Location" - creates it if necessary
      Parameters:
      rep - The repetition index (0-indexed)

    • getErr2_ErrorLocation

      public ERL getErr2_ErrorLocation(int rep)
      Returns a specific repetition of ERR-2: "Error Location" - creates it if necessary
      Parameters:
      rep - The repetition index (0-indexed)

    • getErr2_ErrorLocationReps

      public int getErr2_ErrorLocationReps()
      Returns a count of the current number of repetitions of Error Location (ERR-2). This method does not create a repetition, so if no repetitions have currently been defined or accessed, it will return zero.

    • insertErrorLocation

      public ERL insertErrorLocation(int rep) throws HL7Exception
      Inserts a repetition of ERR-2: "Error Location" 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)

    • insertErr2_ErrorLocation

      public ERL insertErr2_ErrorLocation(int rep) throws HL7Exception
      Inserts a repetition of ERR-2: "Error Location" 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)

    • removeErrorLocation

      public ERL removeErrorLocation(int rep) throws HL7Exception
      Removes a repetition of ERR-2: "Error Location" 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)

    • removeErr2_ErrorLocation

      public ERL removeErr2_ErrorLocation(int rep) throws HL7Exception
      Removes a repetition of ERR-2: "Error Location" 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)

    • getHL7ErrorCode

      public CWE getHL7ErrorCode()
      Returns ERR-3: "HL7 Error Code" - creates it if necessary

    • getErr3_HL7ErrorCode

      public CWE getErr3_HL7ErrorCode()
      Returns ERR-3: "HL7 Error Code" - creates it if necessary

    • getSeverity

      public ID getSeverity()
      Returns ERR-4: "Severity" - creates it if necessary

    • getErr4_Severity

      public ID getErr4_Severity()
      Returns ERR-4: "Severity" - creates it if necessary

    • getApplicationErrorCode

      public CWE getApplicationErrorCode()
      Returns ERR-5: "Application Error Code" - creates it if necessary

    • getErr5_ApplicationErrorCode

      public CWE getErr5_ApplicationErrorCode()
      Returns ERR-5: "Application Error Code" - creates it if necessary

    • getApplicationErrorParameter

      public ST[] getApplicationErrorParameter()
      Returns all repetitions of Application Error Parameter (ERR-6).

    • getErr6_ApplicationErrorParameter

      public ST[] getErr6_ApplicationErrorParameter()
      Returns all repetitions of Application Error Parameter (ERR-6).

    • getApplicationErrorParameterReps

      public int getApplicationErrorParameterReps()
      Returns a count of the current number of repetitions of Application Error Parameter (ERR-6). This method does not create a repetition, so if no repetitions have currently been defined or accessed, it will return zero.

    • getApplicationErrorParameter

      public ST getApplicationErrorParameter(int rep)
      Returns a specific repetition of ERR-6: "Application Error Parameter" - creates it if necessary
      Parameters:
      rep - The repetition index (0-indexed)

    • getErr6_ApplicationErrorParameter

      public ST getErr6_ApplicationErrorParameter(int rep)
      Returns a specific repetition of ERR-6: "Application Error Parameter" - creates it if necessary
      Parameters:
      rep - The repetition index (0-indexed)

    • getErr6_ApplicationErrorParameterReps

      public int getErr6_ApplicationErrorParameterReps()
      Returns a count of the current number of repetitions of Application Error Parameter (ERR-6). This method does not create a repetition, so if no repetitions have currently been defined or accessed, it will return zero.

    • insertApplicationErrorParameter

      public ST insertApplicationErrorParameter(int rep) throws HL7Exception
      Inserts a repetition of ERR-6: "Application Error Parameter" 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)

    • insertErr6_ApplicationErrorParameter

      public ST insertErr6_ApplicationErrorParameter(int rep) throws HL7Exception
      Inserts a repetition of ERR-6: "Application Error Parameter" 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)

    • removeApplicationErrorParameter

      public ST removeApplicationErrorParameter(int rep) throws HL7Exception
      Removes a repetition of ERR-6: "Application Error Parameter" 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)

    • removeErr6_ApplicationErrorParameter

      public ST removeErr6_ApplicationErrorParameter(int rep) throws HL7Exception
      Removes a repetition of ERR-6: "Application Error Parameter" 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)

    • getDiagnosticInformation

      public TX getDiagnosticInformation()
      Returns ERR-7: "Diagnostic Information" - creates it if necessary

    • getErr7_DiagnosticInformation

      public TX getErr7_DiagnosticInformation()
      Returns ERR-7: "Diagnostic Information" - creates it if necessary

    • getUserMessage

      public TX getUserMessage()
      Returns ERR-8: "User Message" - creates it if necessary

    • getErr8_UserMessage

      public TX getErr8_UserMessage()
      Returns ERR-8: "User Message" - creates it if necessary

    • getInformPersonIndicator

      public IS[] getInformPersonIndicator()
      Returns all repetitions of Inform Person Indicator (ERR-9).

    • getErr9_InformPersonIndicator

      public IS[] getErr9_InformPersonIndicator()
      Returns all repetitions of Inform Person Indicator (ERR-9).

    • getInformPersonIndicatorReps

      public int getInformPersonIndicatorReps()
      Returns a count of the current number of repetitions of Inform Person Indicator (ERR-9). This method does not create a repetition, so if no repetitions have currently been defined or accessed, it will return zero.

    • getInformPersonIndicator

      public IS getInformPersonIndicator(int rep)
      Returns a specific repetition of ERR-9: "Inform Person Indicator" - creates it if necessary
      Parameters:
      rep - The repetition index (0-indexed)

    • getErr9_InformPersonIndicator

      public IS getErr9_InformPersonIndicator(int rep)
      Returns a specific repetition of ERR-9: "Inform Person Indicator" - creates it if necessary
      Parameters:
      rep - The repetition index (0-indexed)

    • getErr9_InformPersonIndicatorReps

      public int getErr9_InformPersonIndicatorReps()
      Returns a count of the current number of repetitions of Inform Person Indicator (ERR-9). This method does not create a repetition, so if no repetitions have currently been defined or accessed, it will return zero.

    • insertInformPersonIndicator

      public IS insertInformPersonIndicator(int rep) throws HL7Exception
      Inserts a repetition of ERR-9: "Inform Person Indicator" 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)

    • insertErr9_InformPersonIndicator

      public IS insertErr9_InformPersonIndicator(int rep) throws HL7Exception
      Inserts a repetition of ERR-9: "Inform Person Indicator" 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)

    • removeInformPersonIndicator

      public IS removeInformPersonIndicator(int rep) throws HL7Exception
      Removes a repetition of ERR-9: "Inform Person Indicator" 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)

    • removeErr9_InformPersonIndicator

      public IS removeErr9_InformPersonIndicator(int rep) throws HL7Exception
      Removes a repetition of ERR-9: "Inform Person Indicator" 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)

    • getOverrideType

      public CWE getOverrideType()
      Returns ERR-10: "Override Type" - creates it if necessary

    • getErr10_OverrideType

      public CWE getErr10_OverrideType()
      Returns ERR-10: "Override Type" - creates it if necessary

    • getOverrideReasonCode

      public CWE[] getOverrideReasonCode()
      Returns all repetitions of Override Reason Code (ERR-11).

    • getErr11_OverrideReasonCode

      public CWE[] getErr11_OverrideReasonCode()
      Returns all repetitions of Override Reason Code (ERR-11).

    • getOverrideReasonCodeReps

      public int getOverrideReasonCodeReps()
      Returns a count of the current number of repetitions of Override Reason Code (ERR-11). This method does not create a repetition, so if no repetitions have currently been defined or accessed, it will return zero.

    • getOverrideReasonCode

      public CWE getOverrideReasonCode(int rep)
      Returns a specific repetition of ERR-11: "Override Reason Code" - creates it if necessary
      Parameters:
      rep - The repetition index (0-indexed)

    • getErr11_OverrideReasonCode

      public CWE getErr11_OverrideReasonCode(int rep)
      Returns a specific repetition of ERR-11: "Override Reason Code" - creates it if necessary
      Parameters:
      rep - The repetition index (0-indexed)

    • getErr11_OverrideReasonCodeReps

      public int getErr11_OverrideReasonCodeReps()
      Returns a count of the current number of repetitions of Override Reason Code (ERR-11). This method does not create a repetition, so if no repetitions have currently been defined or accessed, it will return zero.

    • insertOverrideReasonCode

      public CWE insertOverrideReasonCode(int rep) throws HL7Exception
      Inserts a repetition of ERR-11: "Override Reason 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)

    • insertErr11_OverrideReasonCode

      public CWE insertErr11_OverrideReasonCode(int rep) throws HL7Exception
      Inserts a repetition of ERR-11: "Override Reason 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)

    • removeOverrideReasonCode

      public CWE removeOverrideReasonCode(int rep) throws HL7Exception
      Removes a repetition of ERR-11: "Override Reason 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)

    • removeErr11_OverrideReasonCode

      public CWE removeErr11_OverrideReasonCode(int rep) throws HL7Exception
      Removes a repetition of ERR-11: "Override Reason 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)

    • getHelpDeskContactPoint

      public XTN[] getHelpDeskContactPoint()
      Returns all repetitions of Help Desk Contact Point (ERR-12).

    • getErr12_HelpDeskContactPoint

      public XTN[] getErr12_HelpDeskContactPoint()
      Returns all repetitions of Help Desk Contact Point (ERR-12).

    • getHelpDeskContactPointReps

      public int getHelpDeskContactPointReps()
      Returns a count of the current number of repetitions of Help Desk Contact Point (ERR-12). This method does not create a repetition, so if no repetitions have currently been defined or accessed, it will return zero.

    • getHelpDeskContactPoint

      public XTN getHelpDeskContactPoint(int rep)
      Returns a specific repetition of ERR-12: "Help Desk Contact Point" - creates it if necessary
      Parameters:
      rep - The repetition index (0-indexed)

    • getErr12_HelpDeskContactPoint

      public XTN getErr12_HelpDeskContactPoint(int rep)
      Returns a specific repetition of ERR-12: "Help Desk Contact Point" - creates it if necessary
      Parameters:
      rep - The repetition index (0-indexed)

    • getErr12_HelpDeskContactPointReps

      public int getErr12_HelpDeskContactPointReps()
      Returns a count of the current number of repetitions of Help Desk Contact Point (ERR-12). This method does not create a repetition, so if no repetitions have currently been defined or accessed, it will return zero.

    • insertHelpDeskContactPoint

      public XTN insertHelpDeskContactPoint(int rep) throws HL7Exception
      Inserts a repetition of ERR-12: "Help Desk Contact Point" 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)

    • insertErr12_HelpDeskContactPoint

      public XTN insertErr12_HelpDeskContactPoint(int rep) throws HL7Exception
      Inserts a repetition of ERR-12: "Help Desk Contact Point" 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)

    • removeHelpDeskContactPoint

      public XTN removeHelpDeskContactPoint(int rep) throws HL7Exception
      Removes a repetition of ERR-12: "Help Desk Contact Point" 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)

    • removeErr12_HelpDeskContactPoint

      public XTN removeErr12_HelpDeskContactPoint(int rep) throws HL7Exception
      Removes a repetition of ERR-12: "Help Desk Contact Point" 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