| Fields | Description | Required | DDI Documentation |
|---|
| StudyUnit |
|
|
| Holds information about the sweeps of the study | Yes | https://ddialliance.github.io/ddimodel-web/DDI-L-3.2/item-types/StudyUnit/ |
| Agency |
|
| The DDI agency identifier for the metadata e.g. uk.alspac, uk.cls.mcs | Yes | https://ddialliance.github.io/ddimodel-web/DDI-L-3.2/item-types/StudyUnit/ |
| Abstract |
|
| A brief description of the sweep | Yes | https://ddialliance.github.io/ddimodel-web/DDI-L-3.2/item-types/StudyUnit/ |
| AnalysisUnit |
|
| A description of the unit of analysis. Most commonly this is individual or household in CLOSER. | Yes | https://ddialliance.github.io/ddimodel-web/DDI-L-3.2/item-types/StudyUnit/ |
| KindOfData |
|
| A list of the kinds of data included in the sweep, using a controlled vocabulary | Yes | https://ddialliance.github.io/ddimodel-web/DDI-L-3.2/item-types/StudyUnit/ |
| Universe |
|
| A description of the population of the sweep | Yes | https://ddialliance.github.io/ddimodel-web/DDI-L-3.2/item-types/StudyUnit/ |
| Citation |
|
| Holds reference information about the sweep | Yes | https://ddialliance.github.io/ddimodel-web/DDI-L-3.2/item-types/StudyUnit/ |
|
| Title |
| The official name of the sweep | Yes | https://ddialliance.github.io/ddimodel-web/DDI-L-3.2/composite-types/CitationType/ |
|
| AlternateTitle |
| An alternate title by which the sweep is known e.g. the first sweep of the 1970 British Cohort Study is also known as the British Births Study | No | https://ddialliance.github.io/ddimodel-web/DDI-L-3.2/composite-types/CitationType/ |
|
| Creator |
| The Principal Investigator at the time of the sweep | Yes | https://ddialliance.github.io/ddimodel-web/DDI-L-3.2/composite-types/CitationType/ |
|
| Publisher |
| The host institution at the time of the sweep | Yes | https://ddialliance.github.io/ddimodel-web/DDI-L-3.2/composite-types/CitationType/ |
| FundingInformation |
|
| Holds information about the funders at the time of the sweep | Yes | https://ddialliance.github.io/ddimodel-web/DDI-L-3.2/item-types/StudyUnit/ |
|
| Organization |
| The organisation providing the funding | Yes | https://ddialliance.github.io/ddimodel-web/DDI-L-3.2/composite-types/FundingInformationType/ |
|
| GrantNumber |
| The grant number of the funding | No | https://ddialliance.github.io/ddimodel-web/DDI-L-3.2/composite-types/FundingInformationType/ |
| Coverage |
|
| Holds information about the coverage of the sweep | Yes | https://ddialliance.github.io/ddimodel-web/DDI-L-3.2/item-types/StudyUnit/ |
|
| SpatialCoverage |
| Holds information about the spatial coverage of the sweep | Yes | https://ddialliance.github.io/ddimodel-web/DDI-L-3.2/composite-types/CoverageType/ |
|
|
| CountryCode | A code for the country covered by the sweep using the ISO 3166 codes e.g GB-ENG, GB-WLS | Yes | https://ddialliance.github.io/ddimodel-web/DDI-L-3.2/composite-types/GeographicCoverageType/ |
|
|
| Description | Where the country code is not adequate, this allows a description of the spatial coverage | No | https://ddialliance.github.io/ddimodel-web/DDI-L-3.2/composite-types/GeographicCoverageType/ |
|
|
| TopLevelReference | The highest geographical level at which data is available (e.g. country, county, district, etc.) | No | https://ddialliance.github.io/ddimodel-web/DDI-L-3.2/composite-types/GeographicCoverageType/ |
|
|
| LowestLevelReference | The lowest geographical level at which data is available (e.g. postcode, grid reference) | No | https://ddialliance.github.io/ddimodel-web/DDI-L-3.2/composite-types/GeographicCoverageType/ |
|
| TemporalCoverage |
| Holds information about the time period covered by the sweep | Yes | https://ddialliance.github.io/ddimodel-web/DDI-L-3.2/composite-types/TemporalCoverageType/ |
|
|
| Start date | This can be a year, a month and year or a full date | Yes | https://ddialliance.github.io/ddimodel-web/DDI-L-3.2/composite-types/ReferenceDateType/ |
|
|
| End date | This can be a year, a month and year or a full date and can be in a different format to start date | No | https://ddialliance.github.io/ddimodel-web/DDI-L-3.2/composite-types/ReferenceDateType/ |
| Life Stage |
|
| Controlled vocabulary listing the life stage of the sweep | Yes | https://ddialliance.github.io/ddimodel-web/DDI-L-3.2/composite-types/StandardKeyValuePairType/ |
| Version |
|
| Version number | Yes | https://ddialliance.github.io/ddimodel-web/DDI-L-3.2/item-types/Versionable/ |
| Dataset |
|
| References the datasets in the sweep | Yes | https://ddialliance.github.io/ddimodel-web/DDI-L-3.2/item-types/PhysicalInstance/ |
| DataCollection |
|
| References the data collections in the sweep | Yes | https://ddialliance.github.io/ddimodel-web/DDI-L-3.2/item-types/DataCollection/ |