Add Messages

This long-running operation allows the user to add a specific message to multiple claims and claim lines by performing the following POST request with the payload:

http://[hostName]:[portNumber]/[api-context-root]/claims/addmessage

{
    "messageCode": "MESSAGE_001",
    "level": "claim",
    "claimList": [
        {
            "id": 123,
            "claimLineList": [
                {
                    "id": 456
                },
                {
                    "code": "CLAIM_LINE_001 "
                }
            ]
        },
        {
            "code": "CLAIM_001",
            "claimLineList": [
                {
                    "id": 345
                },
                {
                    "code": "CLAIM_LINE_002"
                }
            ]
        }
    ]
}

Details

• It is mandatory to pass the Message Code and Claim id/code.

• It is possible to add Message to claims only when a claim is in the following statuses:

  • In Process

  • Change

  • Manual Benefit

  • Manual Pricing Adjudication

  • Manual Adjudication

• The default level is considered to be a claim.

• Add message on claim level:

  • When level is set as claim, the message is added at the claim level.

• Add Message on claim line level:

  • When level is set as claim line, the message is added at the claim line level.

    • When claim line details are passed in the payload, the system adds the message only to those specified claim lines.

    • If no claim line details are passed on to the payload, then the message is added to all the claim lines that belong to the claim.

    • NOTE: Adding a message at the claim line level is not applicable when the claim code’s process category is Large Claim System.

Process

• The system starts a long-running operation when a POST request with a valid message code is performed on the aforementioned end-point.

• Responds with the HTTP 201 (Created) with links to long-running operation operator and monitor.

  • See Long-Running Operation Through REST for more details.

• After successfully processing this integration point, when a fatal message is added to a claim or claim line with the status Manual Benefit, Manual Adjudication, or Manual Pricing Adjudication, the system applies several updates to the claim lines.

  • See Generic Claim Resource Behavior - Adding a Fatal Claim Message & Adding a Fatal Claim Line Message for details.

Authorization

A user authorization configuration protects access to this feature. The relevant access restriction is claims.addmessage IP.

Response Messages

It is possible that the message cannot be added on one or more claim or claim lines. For example, the message is already present. The claim or claim line itself does not exist.

The IP returns a link in the location header, following which a user can track the status of the long-running operation and the related messages.

The potential failure responses that a user may encounter are as follows:

Table 1. Response Messages

Code	Severity	Message
CLA-IP-AMSG-001	Fatal	Claim {id/code} is unknown
CLA-IP-AMSG-002	Fatal	Claim Line {id/code} is unknown
CLA-IP-AMSG-003	Fatal	Message {code} is unknown
CLA-IP-AMSG-004	Fatal	It is not possible to add a message on claim {id/code} with status {claim status}
CLA-IP-AMSG-005	Fatal	Claim line {id/code} does not belong to Claim {id/code}
CLA-IP-AMSG-006	Fatal	Level cannot be Claim Line for the Claim {id/code} as the process category is Large Claim.
CLA-IP-AMSG-007	Fatal	Level can only be either claim or claim Line
CLA-IP-AMSG-008	Fatal	Message code is not specified
CLA-IP-AMSG-009	Fatal	Atleast one claim id or code is not specified

The response can also contain generic error messages not specific to this web service. See Response Messages for more details.