7 Data Structures

This section provides information on the core data structures/data models that are used by a Building Block. These data structures describe information that is exchanged between building blocks - they do not dictate internal data structures for a particular implementation. These data structures should also describe the minimum set of information that should be passed in an API call. The data structures can be extended for particular use cases.

Data Structures should consist of two sections. The first section should provide an overall resource model that shows the various data structures that are used by the Building Block and how these structures are inter-related.

The second section provides a more detailed breakdown of each data model. For each data model, the following information should be provided:

• Name

• Description

• Fields - the various fields in this data structure. Each field definition should contain the following:

  • Name

  • Type (string, Boolean, number, date, etc)

  • Description

  • You can also reference any standards that must be adhered to (ie. UTC standard for date/times)

  • Comments (any notes about this field)

Note that complete data structure definitions will be provided by the services APIs.

<Example Data Elements>

7.1 Resource Model

Note: Recommend using https://app.diagrams.net/ to create the resource model and store in BuildingBlock repository

<Example Resource Model>

7.2 Data Structures:

Note: any relevant standards that are applicable to the fields of the data structures can be defined here.

7.2.1 Worklist

Description: The WorkList data structure is used to track a list of subscribers to a particular session or event.

Fields:

Name	Type	Description	Notes
id	int	Unique identifier for this WorkList	Generated by building block on creation
name	string	Name for this WorkList
status	enum	Status of the WorkList	enum that is defined with the following fields: ACTIVE, SUSPENDED, CANCELED
start_time	date	Start date/time for the WorkList
end_time	date	End date/time for the WorkList
alerts	integer array	Array of assigned alerts for this WorkList