7 Data Structures

This section provides information on the core data structures/data models that are used by this Building Block.

The following standards are applicable to data structures in the Registration Building Block in addition to the general Architecture Requirements:

• QR code must be generated with the ISO/IEC 18004:2015 standard

7.1 Resource Model

The resource model provides a basic description of each data object that is used by the Building Block. It also shows the relationship between the data objects.

Illustration 4 - Resource model.

7.2 Data Structures

The data elements provide detail for the resource model defined above. This section will list the core/required fields for each resource. Note that the data elements can be extended for a particular use case, but they must always contain at least the fields defined here.

7.2.1 Registration (REQUIRED)

Description: Process through which an entity gets claims recorded in a registry and a credential proving the registration, in exchange for providing some requirements.

Fields:

Name	Type	Description	Notes
id	varchar	identity of the registration
name	varchar	nhe name of the registration
entity	varchar	the entity in charge of the registration.
determinants	object	determines if applicant is eligible for the registration
Results	object	results that this registration is creating/issuing
Requirements	object	requirements that this registration is requesting
Fees	object	fees that apply to receive the registraiton
properties	object	additional properties

7.2.2 Service (REQUIRED)

Description: Name given to a registration, or to a combination of registrations which can be undertaken simultaneously, by the entity(ies) in charge of organizing the registration process.

Fields:

Name	Type	Description	Notes
serviceId	varchar	service identifier
name	varchar	name of a service
version	varchar	version of the service
type	varchar	used for grouping
isExecutable	boolean	defines if service is active
isClosed	boolean	defines if service is closed
description	varchar	additional information about the service
serviceBody	object	additional information about the service

7.2.3 Screen/form (REQUIRED)

Description: A service is composed of one or several screens defined in the Screen Builder by the analyst.

Fields:

Name	Type	Description	Notes
eFormId	varchar	form identifier
name	varchar	name of the form
description	varchar	descriptions of the form
version	varchar	schema version number
latest	boolean	true if latest version
schema	object	schema of the form

7.2.4 Role screen/form (REQUIRED)

Description: One or several screens are defined in the Screen Builder. Screen(s) where a human operator will undertake actions to process an applicant file, usually enter data (e.g. registration number, or registration certificate) and press buttons (approve, send back for correction, etc.).

Fields:

Name	Type	Description	Notes
eFormId	varchar	form identifier
name	varchar	name of the form
description	varchar	descriptions of the form
version	varchar	schema version number
latest	boolean	true if latest version
schema	object	schema of the form

7.2.5 Workflow (RECOMMENDED)

Description: A workflow provides a visual representation of a business process. Workflow Engine executes processes that are defined in Business Process Model and Notation (BPMN), the global standard for process modelling. With BPMN, the analyst can automate most complex business processes using an easy-to-adopt visual modelling language.

Fields:

Name	Type	Description	Notes
taskId	varchar	task identifier	Tasks are processed by operator role.
mainTaskId	varchar	main task identifier	groups all role tasks into group (parallel and in sequence)
name	varchar	name of the task
assigneeId	varchar	user identifier who has been assigened to process the task	may be empty
roleId	varchar	role name that is in charge of the processing	We call “processing role” (or simply “role”) each successive processing an application file will go through until final approval is given and the registration is completed.
created	datetime	time of creation
description	varchar	role description
serviceId	varchar	service identifier where this role belongs to
fileId	varchar	file identifier that this task is linked to
eFormId	varchar	reference to a form that this task role must process
formVariables	object	additional properties
status	object	task status code
data	object	data of the task

7.2.6 Role (REQUIRED)

Description: Human or bot actor in the workflow who must process the application file in the order set in the workflow.

A role is defined by 4 properties: Name of the role; Who is in charge of the role- Institution entity; Type: Action that will take place in the context of the role, either human or BOT; Status decision options of the application file in relation to the role (0=pending, 1=passed successfully, 2=send back for correction, 3=rejected).

Fields:

Name	Type	Description	Notes
id	varchar	role identifier
name	varchar	role name	e.g. verifier, registrar
registration	varchar	registration identifier that this role is serving
entity	varchar	name of the entity-institution in charge of this role	Operators are linked to Institutions (or sub-units) and roles, thus can only see the tasks relevant for their role and Institution.
position	object	position in the workflow
determinant	object	defines if the task is applicable for the role

7.2.7 Institution/entity (REQUIRED)

Description: Institution in charge of Registration and/or Role.

Fields:

Name	Type	Description	Notes
id	varchar	identitifier of the institution entity
name	varchar	name of the institution

7.2.8 Field/claim/data (REQUIRED)

Description: An attribute asserted by an entity, about itself or another entity.

Fields:

Name	Type	Description	Notes
id	varchar	identifier of a field
name	varchar	name of the field	e.g. First name
type	varchar	type of the field
properties	object	properties of the field	determinants, actions, validation/controls
registration	object	registration(s) requestiong the claim/data

7.2.9 Result/credential (REQUIRED)

Description: The result of a registration, in addition to the recording of information in a registry, is usually a credential (sometimes called: a certificate, license, permit, card, etc.) proving the registration.

Fields:

Name	Type	Description	Notes
id	varchar	result identifier
name	varchar	name of the result	e.g. Program certificate
templateId	varchar	template reference if applicable
determinant	object	determinant(s) that determine if result is applicable.
description	varchar	description of the result
properties	object	additional properties

7.2.10 Required document (REQUIRED)

Description: Information (i.e. claims and credentials) which must be provided in a registration process. The requirements may vary according to each subject.

Fields:

Name	Type	Description	Notes
id	varchar	document identifier
name	varchar	name of the document	e.g. Program certificate
templateId	varchar	template reference if applicable
determinant	object	determinant(s) that determine if requirement is applicable.
description	varchar	description of the result
properties	object	additional properties

7.2.11 Payment/fee (RECOMMENDED)

Description: Amount of money to be paid in relation to a registration.

Fields:

Name	Type	Description	Notes
id	varchar	identifier of a fee
type	varchar	type of the fee	e.g. fixed/calculated
formula	object	rules of fee calculation
currency	varchar	currency identifier	e.g. EUR, USD
description	varchar	description of the fee

7.2.12 Determinant (REQUIRED)

Description: A determinant is an attribute, defined in the rule, which determines/triggers if (1) an entity is subject to a registration and/or (2) what requirements this entity must provide to register.

Fields:

Name	Type	Description	Notes
id	varchar	identifier
name	varchar	name of the determinant
source	varchar	field or object where the source information is taken
rules	object	math rules
properties	object	additional business rules