Class TbsERR_28

Unit

BSHL7DT28

Declaration

type TbsERR_28 = class(TbsHL7Segment)

Description

Error The ERR segment is used to add error comments to acknowledgment messages. Use Cases: Severity: A receiving application needs to communicate 2 "error or exception statements." One is an "error;" the other is a "warning". To accomplish this, an acknowledgement message with 2 ERR segments is sent. Upon receipt, the sending application can display both, including the appropriate severity, to the user. Application Error Code: A receiving application generates an error that reports an application error code and returns this information in its response. This code in turn is used by helpdesk staff to pinpoint the exact cause of the error, or by the application to prompt an appropriate response from the user. (Ex. Deceased date must be greater than or equal to birth date). Application Error Parameter: A receiving application encounters an error during processing of a transaction. In addition to an error code, the application provides an error parameter that gives greater detail as to the exact nature of the error. The receiving application looks up the message corresponding to the error code, substitutes in the parameter, and displays the resulting message to the user. Diagnostic Information: While processing a transaction, a receiving application encounters an exception. When the exception is thrown, it provides a volume of detailed information relating to the error encountered. The receiving application captures the information and sends it in its response. The user reports the error to the help desk, and on request, faxes a copy of the diagnostic information to assist analyzing the problem. User Message: A user executes an application function that generates a transaction that is sent to another application for further processing. During this processing, the receiving application encounters an error and, as part of the error handling routine, retrieves a User Message that it returns in its response. The originating application receives the error and displays it to the end user with the intent that the error condition can be resolved and the user can re-execute the function without error. Inform Person Code: After submitting a dispense transaction, a response is returned to the user indicating that the patient may be abusing drugs. Given the sensitivity of this warning, the error is returned with an indicator stating that the patient should not be informed of the error with the implication that steps should be taken to rule out or confirm the warning. Override Type: If a business rule states that a prescription on hold cannot be dispensed, an override type might be "Dispense Held Prescription" to allow the prescription to be dispensed in exception to the rule. Override Reason Codes: A patient is given a prescription; however, before completing the prescription, the remaining pills are spoiled. The patient returns to their pharmacy and explains the situation to their pharmacist. The pharmacist decides to replace the spoiled drugs; however, when attempting to record the event, a message is returned indicating that the dispense would exceed the maximum amount prescribed. The pharmacist overrides the rule and specifies an Override Reason Code indicating a replacement of lost product. Help Desk Contact: Help desk contact information is stored in a database. When an application error is encountered, the database is queried and the most current help desk contact information is returned in the error message. This is displayed to the user by the receiving application. Better Error Location Information: Receiving system detects an error with the 3rd repetition of the ROL.4 (Role Person - XCN).16 (Name Context - CE).4(Alternate Identifier - CWE). The application identifies the specific repetition and component when raising the error, simplifying diagnosis of the problem. Support for multiple Error Locations: Two fields are marked as conditional, with the condition that one of the two must be specified. The sending application leaves both blank. The receiving application detects the problem, and sends back a single error indicating that one of the fields must be filled in. The ERR segment identifies both positions within the message that relate to the error.

Hierarchy

• TBSTypedObject
• TBSTypedComposite
• TBSHL7Object
• TBSHL7Segment
• TbsERR_28

Overview

Methods

	function ErrorLocationRepCount : Integer;
	function ApplicationErrorParameterRepCount : Integer;
	function InformPersonIndicatorRepCount : Integer;
	function OverrideReasonCodeRepCount : Integer;
	function HelpDeskContactPointRepCount : Integer;

Properties

	property ErrorCodeAndLocation : TbsST_28 read GetErrorCodeAndLocation write SetErrorCodeAndLocation;
	property ErrorLocation[RepCount:Integer]: TbsERL_28 read GetErrorLocation write SetErrorLocation;
	property Hl7ErrorCode : TbsCWE_28 read GetHl7ErrorCode write SetHl7ErrorCode;
	property Severity : TbsID_28 read GetSeverity write SetSeverity;
	property ApplicationErrorCode : TbsCWE_28 read GetApplicationErrorCode write SetApplicationErrorCode;
	property ApplicationErrorParameter[RepCount:Integer]: TbsST_28 read GetApplicationErrorParameter write SetApplicationErrorParameter;
	property DiagnosticInformation : TbsTX_28 read GetDiagnosticInformation write SetDiagnosticInformation;
	property UserMessage : TbsTX_28 read GetUserMessage write SetUserMessage;
	property InformPersonIndicator[RepCount:Integer]: TbsCWE_28 read GetInformPersonIndicator write SetInformPersonIndicator;
	property OverrideType : TbsCWE_28 read GetOverrideType write SetOverrideType;
	property OverrideReasonCode[RepCount:Integer]: TbsCWE_28 read GetOverrideReasonCode write SetOverrideReasonCode;
	property HelpDeskContactPoint[RepCount:Integer]: TbsXTN_28 read GetHelpDeskContactPoint write SetHelpDeskContactPoint;

Description

Methods

	function ErrorLocationRepCount : Integer;

	function ApplicationErrorParameterRepCount : Integer;

	function InformPersonIndicatorRepCount : Integer;

	function OverrideReasonCodeRepCount : Integer;

	function HelpDeskContactPointRepCount : Integer;

Properties

	property ErrorCodeAndLocation : TbsST_28 read GetErrorCodeAndLocation write SetErrorCodeAndLocation;
Error Code And Location, Min : 0, Max : 1

	property ErrorLocation[RepCount:Integer]: TbsERL_28 read GetErrorLocation write SetErrorLocation;
Error Location, Min : 0, Max : *

	property Hl7ErrorCode : TbsCWE_28 read GetHl7ErrorCode write SetHl7ErrorCode;
Hl7 Error Code, Min : 1, Max : 1

	property Severity : TbsID_28 read GetSeverity write SetSeverity;
Severity, Min : 1, Max : 1

	property ApplicationErrorCode : TbsCWE_28 read GetApplicationErrorCode write SetApplicationErrorCode;
Application Error Code, Min : 0, Max : 1

	property ApplicationErrorParameter[RepCount:Integer]: TbsST_28 read GetApplicationErrorParameter write SetApplicationErrorParameter;
Application Error Parameter, Min : 0, Max : 10

	property DiagnosticInformation : TbsTX_28 read GetDiagnosticInformation write SetDiagnosticInformation;
Diagnostic Information, Min : 0, Max : 1

	property UserMessage : TbsTX_28 read GetUserMessage write SetUserMessage;
User Message, Min : 0, Max : 1

	property InformPersonIndicator[RepCount:Integer]: TbsCWE_28 read GetInformPersonIndicator write SetInformPersonIndicator;
Inform Person Indicator, Min : 0, Max : *

	property OverrideType : TbsCWE_28 read GetOverrideType write SetOverrideType;
Override Type, Min : 0, Max : 1

	property OverrideReasonCode[RepCount:Integer]: TbsCWE_28 read GetOverrideReasonCode write SetOverrideReasonCode;
Override Reason Code, Min : 0, Max : *

	property HelpDeskContactPoint[RepCount:Integer]: TbsXTN_28 read GetHelpDeskContactPoint write SetHelpDeskContactPoint;
Help Desk Contact Point, Min : 0, Max : *