Skip to content

Data Sources

Data sources are where subject-related data is stored.

A data source can provide the subjects themselves (including the organisational structure those subjects sit within), structured data related to the subjects for rendering in visualisations, or both.

There are two types of data sources in AireFrame:

Bundled Data Sources

Bundle data sources are out-of-the-box integrations with AireSuite systems.

All you need to do to consume data from these sources is to add the data source and if required, configure the options.

The current bundled data sources are:

  • Internal - The internal data source stores subjects and uploaded documents within AireInnovate's secure cloud storage.
  • forms4health (AireForms) - The AireForms data source exposes data captured from within forms.
  • AireFlow - The AireFlow data source exposes tasks created from workflows.
  • AireGlu - The AireGlu data source exposes data returned by user-configured AireGlu endpoints.

Custom Data Sources

You can use the AireFrame SDK to build custom data sources that integrate with external systems, such as EHRs and databases.

INFO

A custom data source must be using the same authority host as the AireFrame instance. (AireIdentity if using the SaaS instance)

Configuration Options

Data sources may ask you to provide configuration values, the use of these will depend on the data source.

For example, a custom data source may require you to provide a secret key to authenticate with the external system.

All configuration options are set and stored in AireVault. Secret values are encrypted and stored securely.

Capabilities

Data sources provide one or more of the following capabilities:

  • Subject - Surfaces subject and organisational structure data.
    • SubjectRead - Surfaced data is read-only.
    • SubjectWrite - Allows creation, update and deletion via the AireFrame UI.
  • StructuredData - Surfaces structured data related to subjects that can be used to create visualisations.
    • DataChangeNotification - The data source sends notification when structured data changes. This allows aireframe to cache the data to offer sorting and filtering capabilities as well as real-time updates.