Dataset-JSON was adapted from the Dataset-XML Version 1.0 specification, but uses JSON format. Like Dataset-XML, each Dataset-JSON file is connected with a Define-XML file containing detailed information about the metadata. One aim of Dataset-JSON is to address as many of the relevant requirements in the PHUSE 2017 Transport for the Next Generation paper as possible, including the efficient use of storage space.
Dataset-JSON is using lowerCamelCase notation for attribute names, comparing to Dataset-XML PascalCase (e.g., clinicalData vs ClinicalData).
JSON format cannot specify order of attributes. For the efficiency of working with the file format it is strongly recommended to follow the order specified in details.
Top Level Attributes
At the top level of Dataset-JSON object, there are technical attributes and two main optional attributes: clinicalData and referenceData, corresponding to Dataset-XML elements. At least 1 of the main attributes must be provided. Subject data is stored in clinicalData and non-subject data is stored in referenceData.
| Attribute | Usage | Description | Attribute order |
|---|---|---|---|
| fileOID | Required | A unique identifier for this file. | 0 |
| creationDateTime | Required | Time of creation of the file containing the document. | 1 |
| asOfDateTime | Required | The date/time at which the source database was queried in order to create this document. | 2 |
| originator | Optional | The organization that generated the ODM file. | 3 |
| sourceSystem | Optional | The computer system or database management system that is the source of the information in this file. | 4 |
| sourceSystemVersion | Optional | The version of the "SourceSystem" above. | 5 |
| datasetJSONVersion | Required | Version of Dataset-JSON standard | 6 |
| clinicalData | Required | See ODM definition for study OID (STUDYOID). | 7 |
| referenceData | Required | See ODM definition for metadata version OID (METADATAVERSIONOID). | 8 |
{
"fileOID": "www.sponsor.xyz.org.project123.final",
"creationDateTime": "2023-03-22T11:53:27",
"asOfDateTime": "2023-02-15T10:23:15",
"originator": "Sponsor XYZ",
"sourceSystem": "Software ABC",
"sourceSystemVersion": "1.0.0",
"datasetJSONVersion": "",
"clinicalData": { ... },
"referenceData": { ... }
}
Both clinicalData and referenceData have the same structure. Each of these attributes contains study and metadata OIDs as well as an object describing an item group (dataset). The following attributes are defined on this level
| Attribute | Requirement | Description | Attribute order |
|---|---|---|---|
| studyOID | Required | See ODM definition for study OID (STUDYOID). | 0 |
| metaDataVersionOID | Required | See ODM definition for metadata version OID (METADATAVERSIONOID). | 1 |
| itemGroupData | Required | Object containing dataset information | 2 |
Values of the studyOID and metaDataVersionOID must match corresponding values in the Define-XML file.
{
"clinicalData": {
"studyOID": "xxx",
"metaDataVersionOID": "xxx",
"itemGroupData": { ... }
}
ItemGroupData attribute
itemGroupData is an object with attributes corresponding to individual datasets. The attribute name is OID of a described dataset, which must be the same as OID of the corresponding itemGroup in the Define-XML file.
"itemGroupData": {
"IG.DM": { ... }
}
The dataset description contains basic information about the dataset itself and its items.
- records - the total number of records in a dataset
- name - dataset name
- label - dataset description
- items - basic information about variables
- itemData - dataset data
"IG.DM": {
"records": 100,
"name": "DM",
"label": "Demographics",
"items": [ ... ],
"itemData": [ ... ]
}
items is an array of basic information about dataset variables. The order of elements in the array must be the same as the order of variables in the described dataset. The first element always describes the Record Identifier (ITEMGROUPDATASEQ).
- OID - OID of a variable (must correspond to the variable OID in the Define-XML file)
- name - variable name
- label - variable description
- type - type of the variable (i.e., "string", "integer", "decimal", "float", "double", "boolean"; see ODM types for details)
- length - variable length
The length attribute is optional.
"items": [
{
"OID": "ITEMGROUPDATASEQ",
"name": "ITEMGROUPDATASEQ",
"label": "Record identifier",
"type": "integer"
},
{
"OID": "IT.DM.STUDYID",
"name": "STUDYID",
"label": "Study Identifier",
"type": "string",
"length": 12
},
...
]
itemData is an array of records with variables values. Each record itself is also represented as an array of variables values. The first value is a unique sequence number for each record in the dataset.
"itemData": {
[1, "MyStudy", "001", "DM", 56],
[2, "MyStudy", "002", "DM", 26],
}
Missing values are represented by null in the case of numeric variables, and an empty string in case of character variables: [1, "MyStudy", "", "DM", null]
The following is a full example of a Dataset-JSON file:
{
"clinicalData": {
"studyOID": "xxx",
"metaDataVersionOID": "xxx",
"itemGroupData": {
"IG.DM": {
"records": 600,
"name": "DM",
"label": "Demographics",
"items": [
{"OID": "ITEMGROUPDATASEQ", "name": "ITEMGROUPDATASEQ", "label": "Record identifier", "type": "integer"},
{"OID": "IT.STUDYID", "name": "STUDYID", "label": "Study identifier", "type": "string", "length": 7},
{"OID": "IT.USUBJID", "name": "USUBJID", "label": "Unique Subject Identifier", "type": "string", "length": 3},
{"OID": "IT.DOMAIN", "name": "DOMAIN", "label": "Domain Identifier", "type": "string", "length": 2},
{"OID": "IT.AGE", "name": "AGE", "label": "Subject Age", "type": "integer", "length": 2}
],
"itemData": [
[1, "MyStudy", "001", "DM", 56],
[2, "MyStudy", "002", "DM", 26],
...
]
}
}
},
"referenceData": {
... Same structure as clinical data
}
}