Registration Integration Point

The Registration Integration Point supports the maintenance of financial registrations and registration invoices. A financial registration is either a bill or a payment that is used to collect or pay all the invoices that are attached to it; the registration originates from the financial system.

The Registration IP will typically be used by two external systems: the financial system and the 'Remittance Advice' system.

• The financial system sends in requests to create, update and delete registrations but is not expected to deliver information on the paper or EDI remittance advice.

• The Remittance Advice system only sends in remittance update information but is not expected to create or delete registrations or update any information other than the remittance data.

Request

The registration import process is implemented as a global activity of type REGISTRATION_IMPORT which processes a data file that is loaded by the Data File Set Integration Point (described in the HTTP Integration Points section of the Integration Guide). The activity can be initiated by using the Activities Integration Point or from the UI.

The parameters are:

1. Data File Set Code
   The code of the data file set that holds the imported data file(s) with registrations

2. Response Data File Set Code
   The code of the data file set that will hold the data file(s) with response messages

Each request may contain the details of one or more registrations.

The system accepts the registration request in the following format:

<registrations>
  <registration
    type = "P"
    codeType = "EFT"
    code = "123123123"
    delete= "false"
    amount = "495.00"
    sentDate = "12-02-2016"
    receiver = "South Shore Hospital"
    bankName = "Bank of America"
    bankIdentifierCode = "BOFAUS3N"
    bankAccountNumber = "123433124121"
    paperRemittanceDate = "12-02-2016"
    paperRemittanceCode = "123123123"
    ediRemittanceDate = "12-02-2016"
    ediRemittanceCode = "123123123"
    correlationId = "64364034"
    payDate = "12-02-2016"
    policyCode="POL-0012002"
    >
    <dynamicFields/>
    <registrationInvoiceList>
      <registrationInvoice id = "12312">
      <registrationInvoice id = "12313">
      ...
    </registrationInvoiceList>
  </registration>
  ...
</registrations>

The data file with registrations will be processed to:

• Create or update a registration including a list of associated invoice identifiers
  The combination of the type, code type and code of the registration drives whether a registration is created or an existing registration is updated.

  • If the combination of the type, code type and code does not exist then a new registration and its registration invoices are added to the system.

  • If the combination of the type, code type and code exists then the registration details and/or its registration invoices are updated as per the data provided in the request.

  When updating the list of registration invoice for a registration all elements in the list have to be present. For example, suppose that the original registration contains the registration invoices 0001, 0002 and 0003. If the goal is to remove registration invoice 0002 from the list of registration invoices, then the request that represents the update should contain registration invoices 0001 and 0003. If the goal is to add registration invoice 0004 to the list of registration invoices, then the request that represents the update should contain registration invoices 0001, 0002, 0003 and 0004. After the registrations and their registration invoices have been loaded, the activity will match the registrations invoices to invoices already present in OHI. If a registration invoice could not be matched to an invoice in OHI the informative message FIN-IP-REGI-001 is added to the activity.

• Delete a registration
  If a registration in the import file is marked as to be deleted, the registration and its registration invoices are removed from the database.
  If a registration in the import file is marked as to be deleted, but it cannot be found in the database, the informative message FIN-IP-REGI-002 is added to the activity.

Response

The data file set response will point to one or more data files which may contain response messages (messages that were added to the activity while processing); for more detail of the generic structure see File Based Import (described in the HTTP Integration Points section of the Integration Guide).

The following error messages that are specific to the registration interface may be returned:

Code	Severity	Message
FIN-IP-REGI-001	Informative	Invoice with id {invoiceId} in {type} {codeType} {code} is unknown.
FIN-IP-REGI-002	Informative	{type} {codeType} {code} is unknown and could not be deleted.

In addition, the type of the registration should have value 'B' (Bill) or 'P' (Payment). If another value is sent in, the generic message GEN-HTTP-001 'Value {value} is not part of domain' will be added.