...
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 in the Define-XML file.
...
The dataset description contains basic information about the dataset itself and its items.
| Attribute | Requirement | Description | Attribute order |
|---|---|---|---|
| records | Required | The total number of records in a dataset | 1 |
| name | Required | Dataset name | 2 |
label | Required | Dataset description | 3 |
| items | Required | Basic information about variables | 4 |
| itemData | Required | Dataset data | 5 |
| Code Block | ||
|---|---|---|
| ||
"IG.DM": {
"records": 100,
"name": "DM",
"label": "Demographics",
"items": [ ... ],
"itemData": [ ... ]
} |
items is an array of basic information about dataset variables. The order of the 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).
| Attribute | Requirement | Description | Attribute order |
|---|---|---|---|
| OID | Required | OID of a variable (must correspond to the variable OID in the Define-XML file) | 1 |
| name | Required | Variable name | 2 |
label | Required | Variable description | 3 |
| type | Required | Type of the variable (i.e., "string", "integer", "decimal", "float", "double", "boolean"; see ODM types for details) | 4 |
| length | Optional | Variable length | 5 |
| displayFormat | Optional | Display format supports data visualization of numeric float and date values. | 6 |
| keySequence | Optional | Indicates that this item is a key variable in the dataset structure. It also provides an ordering for the keys. | 7 |
| Code Block | ||
|---|---|---|
| ||
"items": [
{
"OID": "ITEMGROUPDATASEQ",
"name": "ITEMGROUPDATASEQ",
"label": "Record identifier",
"type": "integer",
},
{
"OID": "IT.DM.STUDYID",
"name": "STUDYID",
"label": "Study Identifier",
"type": "string",
"length": 12,
"keySequence": "1",
},
...
] |
...