Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Addressed Lex's comments

...

AttributeUsageDescriptionAttribute order
fileOIDRequiredA unique identifier for this file.1
creationDateTimeRequiredTime of creation of the file containing the document.2
asOfDateTimeRequiredThe date/time at which the source database was queried in order to create this document.3
datasetJSONVersionRequiredVersion of Dataset-JSON standard4
originatorOptionalThe organization that generated the ODM 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
clinicalDataOptionalSee ODM definition for study OID (STUDYOID)Contains datasets for clinical data across multiple subjects.8
referenceDataOptionalSee ODM definition for metadata version OID (METADATAVERSIONOID)Contains datasets for non-subject data domains.9
Code Block
languagejs
{
    "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": { ... }
}

...

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

...

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

Code Block
languagejs
"itemGroupData": { 
    "IG.DM": { ... }
}

...

AttributeRequirementDescriptionAttribute order
OIDRequiredOID of a variable (must correspond to the variable OID in the Define-XML file)1
nameRequiredVariable name2

label

RequiredVariable description3
typeRequiredType of the variable (i.e., . Allowed values: "string", "integer", "decimal", "float", "double", "boolean"; see . See ODM types for details).4
lengthOptionalVariable length5
displayFormatOptionalDisplay format supports data visualization of numeric float and date values. 6
keySequenceOptionalIndicates that this item is a key variable in the dataset structure. It also provides an ordering for the keys.7

...

Code Block
languagejs
{
    "fileOID": "www.sponsor.org.project123.final",
    "creationDateTime": "2023-03-22T11:53:27",
    "asOfDateTime": "2023-02-15T10:23:15",
    "originatordatasetJSONVersion": "Sponsor XYZ1.0.0",    
    "sourceSystemoriginator": "SoftwareSponsor ABCXYZ",
    "sourceSystemVersionsourceSystem": "1.2.3Software ABC",
    "datasetJSONVersionsourceSystemVersion": "1.02.03",
    "clinicalData": {
        "studyOID": "xxx",
        "metaDataVersionOID": "xxx",
        "metaDataRef": "https://metadata.location.org/api.link",
        "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, "keySequence": 1}, 
                    {"OID": "IT.USUBJID", "name": "USUBJID", "label": "Unique Subject Identifier", "type": "string", "length": 3, "keySequence": 2}, 
                    {"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],
                    ...
                ]
            }
        }
    },
}

...