6 Data Structures

The resource model shows the relationship between data objects that are used by this Building Block.
6.1 Standards/Protocols
The following standards are applicable to data structures in the registration building block:
1.All dates should follow ISO 8601.
2.RFC 7159 - The JavaScript Object Notation (JSON)
3.Open -API Version 3.1.0
4.QR code must be generated with the ISO/IEC 18004:2015 standard
6.2 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 data objects.
Illustration 4 - Resource model. See editable diagram here
6.3 Data Elements
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.
Data Element
Description
Required
Registration
Process through which an entity gets claims recorded in a registry and a credential proving the registration, in exchange of providing some requirements.
yes
Service
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.
yes
Screen/form
A service is composed of one or several screens defined in the Screen Builder by the analyst.
yes
Role screen/form
One or several screens defined in the Screen builder.
Screen(s) where a human operator will undertake actions to process an applicant file, usually enter data (eg registration number, or registration certificate) and press buttons (approve, send back for correction, etc.).
yes
Workflow
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 modeling. With BPMN, the analyst can automate most complex business processes using an easy-to-adopt visual modeling language.
no
Role
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 and;
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 with the role (0=pending, 1=passed successfully, 2=send back for correction, 3=rejected)
no
Institution /entity
Institution in charge of Registration and/or Role.
yes
Field/claim/data
An attribute asserted by an entity, about itself or another entity
no
Result/credential
The result of a registration, in addition to the recording of information in a registry, is usually a credential (sometimes called: certificate, license, permit, card, etc.) proving the registration.
no
Required document
Information (i.e. claims and credentials) which must be provided in a registration process. The requirements may vary according to each subject.
no
Payment/fee
Amount of money to be paid in relation to a registration.
no
Determinant
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.
no

Data Element	Description	Required
Registration	Process through which an entity gets claims recorded in a registry and a credential proving the registration, in exchange of providing some requirements.	yes
Service	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.	yes
Screen/form	A service is composed of one or several screens defined in the Screen Builder by the analyst.	yes
Role screen/form	One or several screens defined in the Screen builder. Screen(s) where a human operator will undertake actions to process an applicant file, usually enter data (eg registration number, or registration certificate) and press buttons (approve, send back for correction, etc.).	yes
Workflow	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 modeling. With BPMN, the analyst can automate most complex business processes using an easy-to-adopt visual modeling language.	no
Role	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 and; 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 with the role (0=pending, 1=passed successfully, 2=send back for correction, 3=rejected)	no
Institution /entity	Institution in charge of Registration and/or Role.	yes
Field/claim/data	An attribute asserted by an entity, about itself or another entity	no
Result/credential	The result of a registration, in addition to the recording of information in a registry, is usually a credential (sometimes called: certificate, license, permit, card, etc.) proving the registration.	no
Required document	Information (i.e. claims and credentials) which must be provided in a registration process. The requirements may vary according to each subject.	no
Payment/fee	Amount of money to be paid in relation to a registration.	no
Determinant	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.	no

5 Functional Requirements

7 Service APIs

Last modified 10mo ago