7 Data Structures

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

7.1 Resource Model

The resource model shows the relationship between data objects that are used by this Building Block.

7.2 Data Structures

The Data Structures provide detail for the Resource Model defined above. This section will list the core/required fields for each resource.

7.2.1 Minimum Required Data

Description: The Data Structures can be extended for a particular use case, but they must always contain, at the minimum, the fields defined here.

Fields:

NameTypeDescriptionNotes

Database ID

integer

Unique identifier of a database.

Required

Database name

varchar

Name that will define the database content. Name is public.

Required

Schema ID

integer

Database schema ID

Required

Database schema

json object

Database schema. See example in Chapters 7.3.1 and 7.3.2.

Required

Version

numeric

Database version. Each change in schema will produce the next version of the database and API services.

Required

Data ID

integer

Data element unique identifier.

Required

Registry number

varchar

Additional registry identifier. Unique identifier in the registry.

Required

Field type

varchar

Field type: datetime, date, boolean, text, number, file.

Required

Field value

datetime, date, boolean, text, number

Field value, data stored in the field.

Required

Audit log old value

datetime, date, boolean, text, number

Field value before change.

Required

Audit log new value

datetime, date, boolean, text, number

Field value after the change.

Required

Standards/Protocols

The following standards are applicable to data structures in the Digital Registries Building Block:

Last updated

Copyright © 2024