Introduction to the Articles

This section of the documentation is home to the articles which are primarily used for describing each grouping or data class within the data model. The main feature of the articles is to demonstrate, both verbally and visually, how each data point fits into the data model and how each class leads into the next.

Layout:

Each article will begin by stating which class it is describing.

Then if the class has a parent class it states the class is a child and gives a link to the parent class, or in other words the class that the current class is within.

Next there will be a description of the contents of the class. This includes any other classes and any data points.

There will also then be an image showing a flow chart depiction of the class for a more visual description.

To navigate through the articles you can use the left hand navigation bar.

This is split into the main folders within the documentation.

  • Production - Which has a separate article for each data class within our live model and gives details on the available data points.
  • Investigating Data Points - Which is the location for data points that we have identified as wanting in the model but have not found a source for yet.
  • Pending Data Points - Which is the location for data points that are not yet in the data model but we do have a known source for.
  • Unavailable Data Points - Which is the location for data points that have undergone investigation and have either been found to not be useful for our data model or a viable source has not been found.
  • Attributes - Which describes the attributes that are available to tag on each data point to describe it.
  • Enumerations - Which describes the values that can be used for the attributes to help describe the data. It is also the location of our sources list for our data.
  • Legacy Model - Which is the location of our legacy model that is no longer in use in the platform but is stored as further documentation.