5.3.2. Change

The operation change in case of a claim will replace an entity partially or completely, if the processes for handling and settling claims have not been completed, yet.

A change to a claim might be necessary, for example, if the claim needs to be linked to another policy, or if additional information about the claim has become available.

How to use variants

If you need to make changes to an existing claim, choose the operation change. If a particular handling variant is requested, use a variant. If not, select the default variant. The variant determines which attributes are mandatory.

A positive response to the operation changeClaim contains the AFD structure of the request as reference, with the result of the transaction (process.statusType).The requested information that was collected during the transaction, is also added to the output.

Different scenarios are possible, for example:

• If there is no immediate result available (because of manual processing), then the status is in process (in behandeling).
• If the change is accepted, then a complete return message (input message completed with result data) is returned.
  

If a negative response is generated, that means the request is technically incorrect, it follows the general rules as described in the Error section of the HTTP status codes and error handling chapter.

Variants

The variant enables a differentiation in requirements to suit the specific situations (listed below), and for each variant, to which AFD structure it applies.

<default> – Replace the entire claim with a new version

The default variant changes the claim by completeley replacing it with a new version. The claimStructure is used to change the claim. The mandatory attributes (in a generic way) are listed in the table Mandatory input and/or output (I/O) attributes.

Endpoint definition

Method	Endpoint	Request	Query parameter(s)	Response	Remarks
PUT	{ uri }/claims/{claimId}/change	claimStructure	N/A	claimStructure

Mandatory input and/or output (I/O) attributes

Entity	Attribute	I/O	Remarks
commonFunctional	dataCatalogVersion	I/O	Version of the data catalog on which the message is based.
commonFunctional	functionVariant	I/O	The function variant is used to determine the additional set of required and optional input and output data.
commonFunctional	businessLine	I/O	Classification of the type of contract. E.g. to be used for addressing within a company.
commonFunctional	porCompany	I/O	The identification of the insurer is necessary to find the correct product and rate combination.
commonFunctional	afdDefinitionName	I/O	Name of the AFD-definition.
commonFunctional	afdDefinitionVersion	I/O	Version of the AFD-definition.
process	statusType	O	The status of the process (codelist ADNSTS) within the entityType transaction.
claim	claimNumberCarrier	I/O	The identifying number of the claim at the company / underwriting agent. This number is linked to the claim file and (usually) does not change

Note: since the attribute “entityType” is mandatory for all used structures, it is not mentioned in this table for clarity reasons.

correction – Replace the entire claim file with a new version due to wrong input

The variant correction is applicable, if the entire claim file needs to be replaced with a new version due to wrong input. The claimStructure is used to change the claim. The mandatory attributes (in a generic way) are listed in the table Mandatory input and/or output (I/O) attributes.

Endpoint definition

Method	Endpoint	Request	Query parameter(s)	Response	Remarks
PUT	{ uri }/claims/{claimId}/correction	claimStructure	N/A	claimStructure

Mandatory input and/or output (I/O) attributes

Entity	Attribute	I/O	Remarks
commonFunctional	dataCatalogVersion	I/O	Version of the data catalog on which the message is based.
commonFunctional	functionVariant	I/O	The function variant is used to determine the additional set of required and optional input and output data.
commonFunctional	businessLine	I/O	Classification of the type of contract. E.g. to be used for addressing within a company.
commonFunctional	porCompany	I/O	The identification of the insurer is necessary to find the correct product and rate combination.
commonFunctional	afdDefinitionName	I/O	Name of the AFD-definition.
commonFunctional	afdDefinitionVersion	I/O	Version of the AFD-definition.
process	statusType	O	The status of the process (codelist ADNSTS) within the entityType transaction.
claim	claimNumberCarrier	I/O	The identifying number of the claim at the company / underwriting agent. This number is linked to the claim file and (usually) does not change

Note: since the attribute “entityType” is mandatory for all used structures, it is not mentioned in this table for clarity reasons.

detail – Apply a partial change to the claim

If not the complete claim needs to be replaced, but only a partial change to the claim file is needed, the variant detail is used. The claimStructure is used to change the claim. The mandatory attributes (in a generic way) are listed in the table Mandatory input and/or output (I/O) attributes.

Endpoint definition

Method	Endpoint	Request	Query parameter(s)	Response	Remarks
PATCH	{ uri }/claims/{claimId}/detail	claimStructure	N/A	claimStructure

Mandatory input and/or output (I/O) attributes

Entity	Attribute	I/O	Remarks
commonFunctional	dataCatalogVersion	I/O	Version of the data catalog on which the message is based.
commonFunctional	functionVariant	I/O	The function variant is used to determine the additional set of required and optional input and output data.
commonFunctional	businessLine	I/O	Classification of the type of contract. E.g. to be used for addressing within a company.
commonFunctional	porCompany	I/O	The identification of the insurer is necessary to find the correct product and rate combination.
commonFunctional	afdDefinitionName	I/O	Name of the AFD-definition.
commonFunctional	afdDefinitionVersion	I/O	Version of the AFD-definition.
process	statusType	O	The status of the process (codelist ADNSTS) within the entityType transaction.
claim	claimNumberCarrier	I/O	The identifying number of the claim at the company / underwriting agent. This number is linked to the claim file and (usually) does not change

Note: since the attribute “entityType” is mandatory for all used structures, it is not mentioned in this table for clarity reasons.

status – Changing the status of a claim

Adjusting the status of the claim allows multiple actions to be indicated on the claim. For example:

• Transfer the claim handling to the carrier of the policy.
• Reactivate a claim that has previously been closed.
• Close a claimfile (resetting settlement reserves to zero).
• Closing of a claim due to absence of policy coverage.
• Reject a claim.
• Reopen a claim.

The claimStructure is used to change the claim. The mandatory attributes (in a generic way) are listed in the table Mandatory input and/or output (I/O) attributes.

Endpoint definition

Method	Endpoint	Request	Query parameter(s)	Response	Remarks
PATCH	{ uri }/claims/{claimId}/change/status	claimStructure	N/A	claimStructure

Mandatory input and/or output (I/O) attributes

Entity	Attribute	I/O	Remarks
commonFunctional	dataCatalogVersion	I/O	Version of the data catalog on which the message is based.
commonFunctional	functionVariant	I/O	The function variant is used to determine the additional set of required and optional input and output data.
commonFunctional	businessLine	I/O	Classification of the type of contract. E.g. to be used for addressing within a company.
commonFunctional	porCompany	I/O	The identification of the insurer is necessary to find the correct product and rate combination.
commonFunctional	afdDefinitionName	I/O	Name of the AFD-definition.
commonFunctional	afdDefinitionVersion	I/O	Version of the AFD-definition.
process	statusType	O	The status of the process (codelist ADNSTS) within the entityType transaction.
claim	claimNumberCarrier	I/O	The identifying number of the claim at the company / underwriting agent. This number is linked to the claim file and (usually) does not change
claim	statusType	I/O	The status of the claim (codelist ADNSTS).

Note: since the attribute “entityType” is mandatory for all used structures, it is not mentioned in this table for clarity reasons.