!!! note "Highly encouraged"
Only name and description properties are required.
For categorical variables, constraints.enum and enumLabels (where applicable) properties are highly encouraged.
For studies using HEAL or other common data elements (CDEs), standardsMappings information is highly encouraged.
type and format properties may be particularly useful for some variable types (e.g. date-like variables)
The version of the schema used in agreed upon convention of major.minor.path (e.g., 1.0.2)
NOTE: This is NOT for versioning of each indiviual data dictionary instance.
Rather, it is the
version of THIS schema document. See version property (below) if specifying the individual data dictionary instance
version.
If generating a vlmd document as a csv file, include this version in
every row/record to indicate this is a schema level property
(not applicable for the json version as this property is already at the schema/root level)
\d+\.\d+\.\d+ "1.0.0"
+ HEAL Variable Level Metadata Fields HEAL Variable Level Metadata Fields
Type: object
!!! note "Highly encouraged"
- Only
name and description properties are required. - For categorical variables,
constraints.enum and enumLabels (where applicable) properties are highly encouraged. - For studies using HEAL or other common data elements (CDEs),
standardsMappings information is highly encouraged. type and format properties may be particularly useful for some variable types (e.g. date-like variables)
Type: string
The version of the schema used in agreed upon convention of major.minor.path (e.g., 1.0.2)
NOTE: This is NOT for versioning of each indiviual data dictionary instance.
Rather, it is the
version of THIS schema document. See version property (below) if specifying the individual data dictionary instance
version.
If generating a vlmd document as a csv file, include this version in
every row/record to indicate this is a schema level property
(not applicable for the json version as this property is already at the schema/root level)
Must match regular expression: \d+\.\d+\.\d+
Examples:
"1.0.0"
"0.2.0"
Type: string
The section, form, survey instrument, set of measures or other broad category used
to group variables. Previously called "module."
Examples:
"Demographics"
"PROMIS"
@@ -24,4 +24,4 @@
Type: stringFormat: uri
The url that links out to the published, standardized mapping of a variable (e.g., common data element)
Example:
"https://evs.nci.nih.gov/ftp1/CDISC/SDTM/SDTM%20Terminology.html#CL.C74457.RACE"
Type: string
The source of the standardized variable. Note, this property is required if
an id is specified.
Example:
"CDISC"
Type: string
The id locating the individual mapping within the given source.
Note, the standardsMappings[0].source property is required if
this property is specified.
Example:
"C74457"
-
\ No newline at end of file
+An abbreviated name/acronym from a controlled vocabulary referencing the resource (e.g., program or repository)
containing the instrument, or a set of items which encompass a variable in this variable level metadata document (if at the root level or the document level)
or the individual variable (if at the field level).
"Adult demographics"
"adult-demographics"
A code or other string that identifies the instrument within the source.
This should always be from the source's formal, standardized identification system
"5141"
-!!! note "Highly encouraged"
Only name and description properties are required.
For categorical variables, constraints.enum and enumLabels (where applicable) properties are highly encouraged.
For studies using HEAL or other common data elements (CDEs), standardsMappings information is highly encouraged.
type and format properties may be particularly useful for some variable types (e.g. date-like variables)
The version of the schema used in agreed upon convention of major.minor.path (e.g., 1.0.2)
NOTE: This is NOT for versioning of each indiviual data dictionary instance.
Rather, it is the
version of THIS schema document. See version property (below) if specifying the individual data dictionary instance
version.
If generating a vlmd document as a csv file, include this version in
every row/record to indicate this is a schema level property
(not applicable for the json version as this property is already at the schema/root level)
\d+\.\d+\.\d+ "1.0.0"
+!!! note "Highly encouraged"
name and description properties are required. constraints.enum and enumLabels (where applicable) properties are highly encouraged. standardsMappings information is highly encouraged.type and format properties may be particularly useful for some variable types (e.g. date-like variables)The version of the schema used in agreed upon convention of major.minor.path (e.g., 1.0.2)
NOTE: This is NOT for versioning of each indiviual data dictionary instance.
Rather, it is the
version of THIS schema document. See version property (below) if specifying the individual data dictionary instance
version.
If generating a vlmd document as a csv file, include this version in
every row/record to indicate this is a schema level property
(not applicable for the json version as this property is already at the schema/root level)
\d+\.\d+\.\d+ "1.0.0"
"0.2.0"
The section, form, survey instrument, set of measures or other broad category used
to group variables. Previously called "module."
"Demographics"
"PROMIS"
@@ -126,4 +126,4 @@
A standardized item (ie field, variable etc) mapped to this individual variable.
The url that links out to the published, standardized mapping of a variable (e.g., common data element)
"https://evs.nci.nih.gov/ftp1/CDISC/SDTM/SDTM%20Terminology.html#CL.C74457.RACE"
The source of the standardized variable. Note, this property is required if
an id is specified.
"CDISC"
The id locating the individual mapping within the given source.
Note, the standardsMappings[0].source property is required if
this property is specified.
"C74457"
-