AS2805 Helper Methods

AS2805_AClaimRequest(input)

Along the methods that are described in the 'AS2805 Message Holder base' section as a subclass of AS2805MessageHolder, the following properties and methods are provided on an instance of this class.

Name Type Description

quote

boolean

read-only property that identifies whether the Claim request is a "Quote".

origin

String

read-only property that identifies the origin of the request (holds the value of: ohi.as2805_a.claim.origin)

claimLineRecords

{ ClaimLineRecord }

read-only property that returns a collection of ClaimLineRecord(s) contained by the request.

ClaimLineRecord

The structure of a ClaimLineRecord consists of the following read-only properties.

Name Type Description

sequence

int

read-only property returning the sequence of the line in the collection (starts at 1).

patientID

String

read-only property returning the patient ID specified on the line.

procedureCode

String

read-only property returning the procedure that is specified on the line.

bodyPart

String

read-only property returning the body part that is specified on the line.

serviceDate

String

read-only property returning the service date of the line.

amountCharged

String

read-only property returning the amount charged specified on the line. (1)

(1) Note that the amount value is returned stripped from any leading zeros.

Exchange Properties

By invoking the AS2805_AClaimRequest a number of properties will automatically be set on the Exchange. The properties set are:

  • oigOrigin
    This is set to the value that is configured for ohi.as2805_a.claim.origin.

  • pathParameter
    This is set to claims, indicating the resource that will be called by the PROCESS integration step.

  • methodParameter
    This is set to PUT, indicating the HTTP Method that will be used by the PROCESS integration step.

  • retrievalReferenceNumber
    This is set to the value of the AS2805 retrieval reference number data element of the request. This is one of the elements used by the AS2805_A interface to look up the originating claim, should that claim be canceled.

  • settlementDate
    This is set to the value of the AS2805 settlement date data element of the request. This is the other element used by the AS2805_A interface to look up the originating claim, should that claim be canceled.

Additionally, calling AS2805_AClaimRequest stores information on the Exchange that assist in the reversal of a transaction should this become necessary.

AS2805_AClaimResponse

An instance of this class is obtained through a factory method on AS2805_AClaimRequest called createResponse(). A call results in:

A reference of the original AS2805_AClaimRequest is stored in the AS2805_AClaimResponse

Subsequently, the contents of the response is constructed with

  • message indicator set to 0210

  • processing code copied from the input message

  • transmission date time set to the current date and time

  • amount transaction copied from the input message

  • system audit trace number copied from the input message

  • date settlement copied from the input message

  • acquiring institution ID code copied from the input message

  • retrieval reference number copied from the input message

  • authorization identification response is set from a configured system property with the name 'ohi.as2805_a.auth.id.response'

  • card acceptor terminal ID copied from the input message

  • card acceptor ID code copied from the input message

Along the methods that are described in the 'AS2805 Message Holder base' section as a subclass of AS2805MessageHolder, the following additional properties and methods are provided on an instance of this class. The AS2805_AClaimResponse message will have the below fields initialized as null (not set).

Name Type Description

responseCode

String

property to get and set the response code for the response.

totalAmountSettlement

String

property to get and set the total amount settlement for the response.

memberNumber

String

property to get and set the member number for the response.

withAuthorizationRecord(int sequence)

AS2805_AAuthorizationRecord

constructs and stores a new instance of AS2805_AAuthorizationRecord in the response. The AS2805_AAuthorizationRecord instance that is returned, has a number of the fields from the input (line) copied.

as2805RawValue

String

a method that constructs the AS2805 representation.
(typically, called at the very end of the dynamic logic).

AS2805_AAuthorizationRecord

The structure of an A2805_AAuthorizationRecord consists of the following properties.

Name Type Description

sequence

int

property that refers to a specific input line from the request.

patientID

String

property for getting and setting the patient ID on the response record. Initially copied from the input line.

procedureCode

String

property for getting and setting the procedure on the response record. Initially copied from the input line.

bodyPart

String

property for getting and setting the body part on the response record. Initially copied from the input line.

serviceDate

String

property for getting and setting the service date on the response record. Initially copied from the input line.

amountClaimed

String

property for getting and setting the amount claimed on the response record. Initially copied from the input line.

amountCovered

String

property for getting and setting the amount covered on the response record.

itemResponseCode

String

property for getting and setting the item response code on the response record.