General properties

The groupStructure serves to communicate relationship and contract details of a group. A group can be a collection of employees of a company, but also members of an association or participants in a foundation who have a joint agreement with, for example, an insurance company. The groupStructure consists of a single group master agreement (as a masterAgreement of entityType collectiveDiscount), possibly one or more group packages and/or contracts (loans, pensions and/or policies), and one or more participants (as party-entities of entityType policyHolder). Each participant in turn also consists of exactly one masterAgreement and any contracts and packages. Each policy, loan or pension in this structure is described in accordance with their relevant structure, for example the policyStructure for policies.

Mandatory components

The table below contains the mandatory entities and attributes of the groupStructure. Please note: these are only the mandatory components; in this case only the presence of a group masterAgreement of entityType collectiveDiscount. In many functions and messages, the message will be more extensive, often including party entities, a commonFunctional entity for meta-data and one or more instances of the loanStructure, policyStructure and/or pensionStructure. See later in this section for a more detailed example.

Name Occur. Type Description
groupStructure 1..1 entity Structure of group related data, based on AFD attributes.
masterAgreement 1..* entity Used for grouping data about the master agreement of the group.
entityType 1..1 string At least one masterAgreement entity of entityType ‘collectiveDiscount’ must occur.
party 1..* entity One party of entityType ‘policyHolder’ for each participant of the group agreements.
entityType 1..1 string At least one party of entityType ‘policyHolder’ must occur.
masterAgreement 1..* entity Used for grouping data about the master agreement of the participant.
entityType 1..1 string At least one masterAgreement entity of entityType ‘collectiveDiscount’ must occur.

JSON example

Below is an example of a groupStructure. Note that at the top level within JSON, the groupStructure entity is not explicitly mentioned. In XML, the structure is always explicitly defined at the highest level as well. In order to formulate a clear example, only one instance of a participant (party with entityType policyHolder) is used here.

{
	"commonFunctional": [ {
		"entityType": "default",
		"functionVariant": "new",
		"dataCatalogVersion": "34C"
	} ],
	"masterAgreement": [ { 
		"entityType": "collectiveDiscount",
		"discount": 300.00
	} ],
	"party": [ {
		"entityType": "policyHolder",
		"firstName": "Maria",
		"surname": "de Jong",
		"masterAgreement": [ {
			"entityType": "collectiveDiscount"
		},
		{
			"entityType": "package",
			"contractNumber": "P20190101-010a",
		} ]
	} ]
}

Feedback

Thanks for your feedback.

Post your comment on this topic.

Post Comment