Attached Data IP

The purpose of this integration point is to allow external systems to create or modify additional information related to the authorization without affecting its status or reprocessing the authorization. This information is referred to as 'Attached Data'. The attached data for an authorization resides in the entity 'Attached Authorization Data'. This entity can be extended to have dynamic fields and dynamic records.

The attached data has the following characteristics:

1. The information is not present at the time the authorization is entered and thus not relevant for authorization processing.

2. The information cannot readily be added to an authorization afterwards because the authorization is in a status (Approved or Denied) - that changes are no longer permitted unless it is unfinalized - thus creating a new version - and there is no need to reprocess the authorization after adding this information.

This integration point supports the following:

• Fetch Attached Data - The external system can request for existing attached data of an authorization through this request.

• Update Attached Data - The external system can modify attached data of an authorization through this request.

Fetch Attached Data

An external system can fetch attached data of an authorization by posting a request to the URL:

{apiurl}/\{authCode}/attachedData

Here, authCode is the code of the authorization whose attached data is requested by the external system. Oracle Health Insurance Authorizations sends the following message in the response:

<attachedAuthorizationData
  <!--single value non time valid dynamic fields-->
  {dynamic field}
  ...
  >
  <!--multi value non time valid dynamic fields  -->
  <{dynamic field}>
    <value>{value}</value>
  </{dynamic field}>
  ...
  <!--multi value non time valid dynamic records -->
  <{dynamic record}>
    <record
      {fields}
      ...
    />
  </{dynamic record}>
  ...
  <!-- single value non time valid dynamic records -->
  <{dynamic record}
    {field}
    ...
  />
  ...
</attachedAuthorizationData>

In a case of an error (for example, the authorization code is unknown), the response will be as specified in the section "Indicating Failure" in Response Messages for more details.

Update Attached Data

The external system can send a request to modify attached data of an authorization to the URL:

{apiurl}/\{authCode}/attachedData

Here, authCode is the code of the authorization whose attached data is requested to be modified.

The update request has the following structure:

<attachedAuthorizationData
<!--single value non time valid dynamic fields-->
  {dynamic field}
  ...
  >
  <!--multi value non time valid dynamic fields  -->
  <{dynamic field}>
    <value>{value}</value>
  </{dynamic field}>
  ...
  <!-- multi value non time valid-->
  <{dynamic record}>
    <record
      {fields}
      ...
    />
  </{dynamic record}>
  ...
  <!-- single value non time valid dynamic records -->
  <{dynamic record}
    {field}
    ...
  />
  ...
</attachedAuthorizationData>

The external system is not required to send all the dynamic records in the update request. The {dynamic record} element or {dynamic field} which is not specified in the request message is not updated. For details on how external system can provide values for dynamic fields and dynamic records in request messages and how they are handled by Oracle Health Insurance Authorizations, refer to the concepts in the Configuration Guide.

In a case of an error (for example the authorization code is unknown), the response will be as specified in the section "Indicating Failure" of the Response Messages page.

Example: Updating Attached Data for Correspondence Tracking

Suppose a record definition 'Correspondence Tracking' consisting of the following fields is created:

• Code

• Type

• Remarks

• Date Sent

• Date Received

It is then attached to the entity 'Attached Auth Data'.

Let’s suppose one correspondence letter for medical assessment required has been sent out for an authorization '1234'. In that case, the following information can be registered through the attached data integration point.

Table 1. Information for Attached Data Integration Point

Code	Type	Remarks	Date Sent	Date Received
1A3/AXDD	LETTERS	Medical assessment required	2015-12-09	-

To register such an information, the external system sends the following request message to 'Update Attached Data'

<attachedAuthorizationData>
  <correspondenceTracking>
    <record
      code=“1A3/AXDD "
      type=“LETTERS"
      reference=“Medical assessment required"
      sentDate="2015-12-09"
    />
  </correspondenceTracking>
</attachedAuthorizationData>

If a reminder letter is sent out later, then the attached data can be updated by sending the following request message:

<attachedAuthorizationData>
  <correspondenceTracking>
    <record
      code=“1A3/AXDD "
      type=“LETTERS"
      reference=“Medical assessment required"
      sentDate="2015-12-09"
    />
   <record
      code=“2A5/AXDD "
      type=“LETTERS"
      reference=“Reminder medical assessment required"
      sentDate="2015-12-19"
    />
  </correspondenceTracking>
</attachedAuthorizationData>

Suppose an external system wants to update a dynamic field 'Medical Assessment Date' defined on Attached Auth Data and also wants to update the correspondence tracking with the details of the received medical assessment form. This can be done by sending the following update attached data message:

<attachedAuthorizationData
  medicalAssessmentdate='2015-12-28'
  >
  <correspondenceTracking>
    <record
      code=“1A3/AXDD "
      type=“LETTERS"
      reference=“Medical assessment required"
      sentDate="2015-12-09"
    />
    <record
      code=“2A5/AXDD"
      type=“LETTERS"
      reference=“Reminder medical assessment required"
      sentDate="2015-12-19"
    />
    <record
      code=“2A5/AXRR"
      type=“FORM"
      reference=“Medical assessment complete"
      receivedDate="2016-01-02"
    />
  </correspondenceTracking>
</attachedAuthorizationData>

Messages

The following messages can be returned by the integration point:

Table 2. Messages

Code	Severity	Message
AUT-IP-ATAD-001	Fatal	Authorization code {} is unknown