Skip to content

Data model ​

Profile ​

A dataset and its columns.

SlotTypeRequiredDescription
titlestringnoName of the dataset.
descriptionstringnoDefinition of the dataset, column or value.
identifierstringnoPersistent identifier of the dataset. A DOI or URL is preferred.
licensestringnoIRI of the license, or a statement of the terms of use.
citationstringnoPreferred citation.
access_rightsstringnoWho may access the dataset.
landing_pagestringnoIRI of a web page about the dataset.
rowsintegernoNumber of rows of the table.
columnslist of ColumnyesColumns, in table order.

Column ​

One column of the table, described as a variable.

SlotTypeRequiredDescription
namestringyesHeader of the column, exactly as in the table.
labelstringnoHuman-readable name of the column or value.
descriptionstringnoDefinition of the dataset, column or value.
datatypeDatatypenoHow values are stored.
formatstringnoHow dates, times or numbers are written in the table, for example %d/%m/%Y, in the notation of the source.
languagestringnoLanguage of the text in a free-text column, as a lower-case BCP 47 language tag such as nl or en-gb. Set it only for columns of prose.
levelLevelnoLevel of measurement.
unitstringnoUnit as text, for example years.
unit_iristringnoIRI of the unit, for example from QUDT.
variablestringnoIRI of the variable concept the column measures.
sourcestringnoIRI of a web page that documents the column or its variable.
valueslist of ValuenoCodes the column may hold, with their labels. Other codes may occur unless closed is true.
closedbooleannoTrue if values lists every code the column may hold, apart from missing values. A list taken from data is not closed.
observedlist of CountnoCodes found in the data, in order of first occurrence, with their counts. They say what occurred, not what is allowed.
missing_valueslist of stringnoCodes that mean no value and have no label.
missing_rangeRangenoNumbers that mean no value.
completenessfloatnoShare of the rows that have a value, between 0 and 1.
applies_whenstringnoCondition under which the column has a value, as the source writes it, for example REDCap branching logic. Rows that do not meet it are missing by design.
minimumfloatnoSmallest number the column may hold, apart from missing values. A limit of the source, not the smallest number found.
maximumfloatnoLargest number the column may hold, apart from missing values.
groupstringnoName of the group of columns that the column belongs to, for example the form of a REDCap field.
identifyingbooleannoTrue if the values identify a person or a record: names, record numbers, contact details. Such a column needs care when the data are shared or synthesized.
mappingslist of MappingnoLinks to concepts.

Value ​

A code that the column may hold, with its label.

SlotTypeRequiredDescription
codestringyesThe code as stored in the table, as text.
labelstringnoHuman-readable name of the column or value.
descriptionstringnoDefinition of the dataset, column or value.
missingbooleannoTrue if the code means no value.
mappingslist of MappingnoLinks to concepts.

Count ​

A code found in the data and how often it occurs.

SlotTypeRequiredDescription
codestringyesThe code as stored in the table, as text.
countintegeryesHow many rows hold the code.

Mapping ​

A link from a column or value to a concept. It is approved when it has a reviewer_id.

SlotTypeRequiredDescription
match_typeMatchTypeyesHow the concept relates to the column or value.
object_idstringyesIRI of the concept.
object_labelstringnoName of the concept.
confidencefloatnoConfidence between 0 and 1.
provenancestringnoWhere the link came from, for example the name of a service.
retrieved_atstringnoWhen the link was made, as an ISO 8601 date or time.
reviewer_idstringnoWho approved the link. A link without a reviewer is a draft.
descriptionstringnoDefinition of the dataset, column or value.

Range ​

An inclusive range of numbers.

SlotTypeRequiredDescription
lowfloatyesSmallest number.
highfloatyesLargest number.

Datatype ​

Storage type, named as in CSV on the Web.

ValueMeaning
string
number
integer
boolean
date
datetime

Level ​

Level of measurement, as defined by DSV.

ValueMeaning
categoricaldsvo:CategoricalDataType
nominaldsvo:NominalDataType
ordinaldsvo:OrdinalDataType
numericaldsvo:NumericalDataType
intervaldsvo:IntervalDataType
ratiodsvo:RatioDataType

MatchType ​

Relation of a concept to a column or value, as defined by SKOS.

ValueMeaning
exactskos:exactMatch
closeskos:closeMatch
broadskos:broadMatch
narrowskos:narrowMatch
relatedskos:relatedMatch