...
📘 In this article:
| Table of Contents | ||||
|---|---|---|---|---|
|
What is “Structural Metadata”?
Structural Simply put, structural metadata describes the variables within a dataset and how they are organised.
What do I need to include?
We recommend sites to you provide a data dictionary of structural metadata that includes the following information:
Metadata Field | Completion Guidance | Constraints | Mandatory? |
|---|---|---|---|
Table Name * | Name of the table in the dataset. Use a fully qualified name if appropriate. | 255 characters max | Yes |
Table Description | Description of the table in the dataset. | 20,000 characters max | No |
Column Name *Column Name | Name of the column in the table dataset | 255 characters max | Yes |
Column Description | Description of the column in the table dataset. | 20,000 characters max | No |
Data Type Name *Name | Type of data contained in the column. | 255 characters max | Yes |
Sensitive * | Please indicate (True / False) whether the information must be treated as sensitive and may need additional constraints / removal / anonymisation / masking through the data access request process. Definition: An ODRL conformant policy expressing the rights associated with the resource. | True / False only. | Yes |
Where can I see some concrete examples of valid Structural Metadata?
Please see the following example for your reference.
If you require further clarification, we also have several fully populated submissions from other sites that we would be happy to walk through with you. Please contact us via Service Desk to arrange a session.
...
| View file | ||
|---|---|---|
|
Is an Excel spreadsheet the only
...
way I can upload metadata?
Definitely not! The
This simple excel template is used as the low common denominator that makes our "lite" user to make our interface as accessible as possible.
However, there are several different methods that supervisors can use to consume and update metadata. We've already used a few of these different formats, on request, with various other membersclients:
REST API that accepts well-formed XML, such as these:
| View file | ||
|---|---|---|
|
| View file | ||
|---|---|---|
|
2. We can also accept reports from a profiling tool called white rabbit (https://www.ohdsi.org/analytic-tools/whiterabbit-for-etl-design/). White Rabbit WhiteRabbit.
WhiteRabbit is a .jar (with a UI if you need) that you can point at a DB database and generate a profiling report from, which can then be used to create a detailed data dictionary.
| Info |
|---|
If you would like to know more about them these options please raise a Service Desk ticket and we 'd will be happy to arrange a call to walk through some of themthese with you. |