Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

JSON format does not allow to specify or control order of attributes. Despite of that, as most JSON engines allow to control the order of attributes it is strongly recommended to follow the attribute order specified in details. The reason for that is that due to a possible large size of Dataset-JSON files, following the specified order will enable a software using steaming approaches to read the file to work in an efficient and fast way.

Dataset-JSON must contain only one dataset.

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.

...

A unique identifier for this file.Version of Dataset-JSON standard
AttributeUsageDescriptionAttribute orderfileOIDRequired1
creationDateTimeRequiredTime of creation of the file containing the document.1
datasetJSONVersionRequiredVersion of Dataset-JSON standard2
fileOIDOptionalA unique identifier for this file.3
asOfDateTimeOptionalThe date/time at which the source database was queried in order to create this document.3datasetJSONVersionRequired4
originatorOptionalThe organization that generated the Dataset-JSON file.5
sourceSystemOptionalThe computer system or database management system that is the source of the information in this file.6
sourceSystemVersionOptionalThe version of the "sourceSystem" above.7
clinicalDataOptionalContains datasets for clinical data across multiple subjects.8
referenceDataOptionalContains datasets for non-subject data domains.9

...

AttributeRequirementDescriptionAttribute order
studyOIDRequiredOptionalSee ODM definition for study OID (ODM/Study/@OID).1
metaDataVersionOIDRequiredOptionalSee ODM definition for metadata version OID (ODM/Study/MetaDataVersion/@OID).2
metaDataRefOptionalURL for a metadata file describing the data.3
itemGroupDataRequiredObject containing dataset information4

...

itemGroupData is an object with a single attribute corresponding to an individual dataset. There must be only one dataset per Dataset-JSON file. The attribute name is OID of a described dataset, which must be the same as the OID of the corresponding itemGroupDef in the Define-XML file.

...