5.3.3. Retrieve

The operation retrieve in case of a claim will fetch the data or the status of a claim. The retrieval of a single claim can be used as input to a step in the claims handling process, or to provide current claim information to a portal or account page of the broker or policyholder.

How to use variants

The retrieve operation is a webservice call without a body. The functionVariant and the claimNumberCarrier are included as a path parameter. For more information see the Retrieve operations section of the Design principles chapter.

The output of the retrieve operation uses the claimStructure as described in the claimStructure section.

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> – Obtain full details of a single claim based on the unique reference

The variant default retrieves full details of a single claim based on a unique reference (claimNumberCarrier), using the claimStructure. 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
GET	{ uri }/claims/{claimId}/retrieve	N/A	N/A	claimStructure

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

Entity	Attribute	I/O	Remarks
commonFunctional	dataCatalogVersion	O	Version of the data catalog on which the message is based.
commonFunctional	functionVariant	O	The function variant is used to determine the additional set of required and optional input and output data.
commonFunctional	businessLine	O	Classification of the type of contract. E.g. to be used for addressing within a company.
commonFunctional	porCompany	O	The identification of the insurer is necessary to find the correct product and rate combination.
commonFunctional	afdDefinitionName	O	Name of the AFD-definition.
commonFunctional	afdDefinitionVersion	O	Version of the AFD-definition.
claim	claimNumberCarrier	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 – Obtain status information of a single claim by a unique reference

The variant status retrieves all information about the status of a single claim by a unique reference (claimNumberCarrier), using the claimStructure. 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
GET	{ uri }/claims/{claimId}/retrieve/status	N/A	N/A	claimStructure

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

Entity	Attribute	I/O	Remarks
commonFunctional	dataCatalogVersion	O	Version of the data catalog on which the message is based.
commonFunctional	functionVariant	O	The function variant is used to determine the additional set of required and optional input and output data.
commonFunctional	businessLine	O	Classification of the type of contract. E.g. to be used for addressing within a company.
commonFunctional	porCompany	O	The identification of the insurer is necessary to find the correct product and rate combination.
commonFunctional	afdDefinitionName	O	Name of the AFD-definition.
commonFunctional	afdDefinitionVersion	O	Version of the AFD-definition.
claim	claimNumberCarrier	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	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.