SubstantiveValueDomain¶
Fully qualified class name: DDICDIModels::DDICDILibrary::Classes::Representations::SubstantiveValueDomain
Definition¶
Value domain for a substantive conceptual domain. Typically a description and/or enumeration of allowed values of interest.
Examples¶
All real decimal numbers relating to the subject matter of interest between 0 and 1 specified in Arabic numerals. (From the Generic Statistical Information Model [GSIM] 1.1). The codes “M” male and “F” for female .
Explanatory notes¶
In DDI-CDI the value domain for a variable is separated into “substantive” and “sentinel” values. Substantive values are the values of primary interest. Sentinel values are additional values that may carry supplementary information, such as reasons for missing. This duality is described in ISO 11404. Substantive values for height might be real numbers expressed in meters. The full value domain might also include codes for different kinds of missing values - one code for “refused” and another for “don’t know”. Sentinel values may also convey some substantive information and at the same time represent missing values.
An example might be where a numeric variable like number of employees be sometimes a count and sometimes a code representing a range of counts in order to avoid disclosure of information about a specific entity. The substantive value domain may use either a value description, for described values, or a codelist for enumerated values, or both. A value domain may consist of substantive values or sentinel values. Substantive values are those associated directly with some subject matter area. They do not address concerns around processing, such as missing values. Substantive values are called “regular values” in ISO/IEC 11404 - General Purpose Datatypes. The enumerated case is one where all values are listed.
An example is the categorical values for gender: the conceptual domain could consist of the concept of male and the concept of female. These might be represented in codes and associated labels as 1 (“Male”) 2 (“Female”). The described case is one where some description is needed to define the set of values. Take the following description for height in meters: “a real number between 0 and 3, represented to two Arabic decimal places”. This description might be structured in some way to be machine actionable (datatype=”double”, min=”0”, max=”3”, decimals=”2”).
Inheritance
ᐊ── Representations::SubstantiveValueDomain
Attributes
Associations
Syntax representations / encodings
All syntax representations except the Canonical XMI are provided as reference points for specific implementations, or for use as defaults if sufficient in the form presented.
Fragment for the class SubstantiveValueDomain (entire model as XMI)
1<packagedElement xmlns:StandardProfile="http://www.eclipse.org/uml2/5.0.0/UML/Profile/Standard"
2 xmlns:uml="http://www.eclipse.org/uml2/5.0.0/UML"
3 xmlns:xmi="http://www.omg.org/spec/XMI/20131001"
4 xmi:id="DDICDIModels-DDICDILibrary-Classes-Representations-SubstantiveValueDomain"
5 xmi:uuid="http://ddialliance.org/Specification/DDI-CDI/1.0/XMI/#SubstantiveValueDomain"
6 xmi:type="uml:Class">
7 <ownedComment xmi:id="DDICDIModels-DDICDILibrary-Classes-Representations-SubstantiveValueDomain-ownedComment"
8 xmi:uuid="http://ddialliance.org/Specification/DDI-CDI/1.0/XMI/#SubstantiveValueDomain-ownedComment"
9 xmi:type="uml:Comment">
10 <annotatedElement xmi:idref="DDICDIModels-DDICDILibrary-Classes-Representations-SubstantiveValueDomain"/>
11 <body>Definition
12==========
13Value domain for a substantive conceptual domain. Typically a description and/or enumeration of allowed values of interest.
14
15Examples
16========
17All real decimal numbers relating to the subject matter of interest between 0 and 1 specified in Arabic numerals. (From the Generic Statistical Information Model [GSIM] 1.1). The codes "M" male and "F" for female .
18
19Explanatory notes
20=================
21In DDI-CDI the value domain for a variable is separated into "substantive" and "sentinel" values. Substantive values are the values of primary interest. Sentinel values are additional values that may carry supplementary information, such as reasons for missing. This duality is described in ISO 11404. Substantive values for height might be real numbers expressed in meters. The full value domain might also include codes for different kinds of missing values - one code for "refused" and another for "don’t know". Sentinel values may also convey some substantive information and at the same time represent missing values.
22
23An example might be where a numeric variable like number of employees be sometimes a count and sometimes a code representing a range of counts in order to avoid disclosure of information about a specific entity. The substantive value domain may use either a value description, for described values, or a codelist for enumerated values, or both. A value domain may consist of substantive values or sentinel values. Substantive values are those associated directly with some subject matter area. They do not address concerns around processing, such as missing values. Substantive values are called "regular values" in ISO/IEC 11404 - General Purpose Datatypes. The enumerated case is one where all values are listed.
24
25An example is the categorical values for gender: the conceptual domain could consist of the concept of male and the concept of female. These might be represented in codes and associated labels as 1 ("Male") 2 ("Female"). The described case is one where some description is needed to define the set of values. Take the following description for height in meters: "a real number between 0 and 3, represented to two Arabic decimal places". This description might be structured in some way to be machine actionable (datatype="double”, min="0", max="3", decimals="2").</body>
26 </ownedComment>
27 <name>SubstantiveValueDomain</name>
28 <generalization xmi:id="DDICDIModels-DDICDILibrary-Classes-Representations-SubstantiveValueDomain-generalization"
29 xmi:uuid="http://ddialliance.org/Specification/DDI-CDI/1.0/XMI/#SubstantiveValueDomain-generalization"
30 xmi:type="uml:Generalization">
31 <general xmi:idref="DDICDIModels-DDICDILibrary-Classes-Representations-ValueDomain"/>
32 </generalization>
33 <ownedAttribute xmi:id="DDICDIModels-DDICDILibrary-Classes-Representations-SubstantiveValueDomain-ownedAttribute_1"
34 xmi:uuid="http://ddialliance.org/Specification/DDI-CDI/1.0/XMI/#SubstantiveValueDomain-ownedAttribute_1"
35 xmi:type="uml:Property">
36 <lowerValue xmi:id="DDICDIModels-DDICDILibrary-Classes-Representations-SubstantiveValueDomain-ownedAttribute_1-lowerValue"
37 xmi:uuid="http://ddialliance.org/Specification/DDI-CDI/1.0/XMI/#SubstantiveValueDomain-ownedAttribute_1-lowerValue"
38 xmi:type="uml:LiteralInteger"/>
39 <upperValue xmi:id="DDICDIModels-DDICDILibrary-Classes-Representations-SubstantiveValueDomain-ownedAttribute_1-upperValue"
40 xmi:uuid="http://ddialliance.org/Specification/DDI-CDI/1.0/XMI/#SubstantiveValueDomain-ownedAttribute_1-upperValue"
41 xmi:type="uml:LiteralUnlimitedNatural">
42 <value>1</value>
43 </upperValue>
44 <association xmi:idref="DDICDIModels-DDICDILibrary-Classes-Representations-SubstantiveValueDomain_takesValuesFrom_EnumerationDomain"/>
45 <type xmi:idref="DDICDIModels-DDICDILibrary-Classes-Representations-EnumerationDomain"/>
46 </ownedAttribute>
47 <ownedAttribute xmi:id="DDICDIModels-DDICDILibrary-Classes-Representations-SubstantiveValueDomain-ownedAttribute_2"
48 xmi:uuid="http://ddialliance.org/Specification/DDI-CDI/1.0/XMI/#SubstantiveValueDomain-ownedAttribute_2"
49 xmi:type="uml:Property">
50 <lowerValue xmi:id="DDICDIModels-DDICDILibrary-Classes-Representations-SubstantiveValueDomain-ownedAttribute_2-lowerValue"
51 xmi:uuid="http://ddialliance.org/Specification/DDI-CDI/1.0/XMI/#SubstantiveValueDomain-ownedAttribute_2-lowerValue"
52 xmi:type="uml:LiteralInteger"/>
53 <upperValue xmi:id="DDICDIModels-DDICDILibrary-Classes-Representations-SubstantiveValueDomain-ownedAttribute_2-upperValue"
54 xmi:uuid="http://ddialliance.org/Specification/DDI-CDI/1.0/XMI/#SubstantiveValueDomain-ownedAttribute_2-upperValue"
55 xmi:type="uml:LiteralUnlimitedNatural">
56 <value>1</value>
57 </upperValue>
58 <association xmi:idref="DDICDIModels-DDICDILibrary-Classes-Representations-SubstantiveValueDomain_isDescribedBy_ValueAndConceptDescription"/>
59 <type xmi:idref="DDICDIModels-DDICDILibrary-Classes-Representations-ValueAndConceptDescription"/>
60 </ownedAttribute>
61 <ownedAttribute xmi:id="DDICDIModels-DDICDILibrary-Classes-Representations-SubstantiveValueDomain-ownedAttribute_3"
62 xmi:uuid="http://ddialliance.org/Specification/DDI-CDI/1.0/XMI/#SubstantiveValueDomain-ownedAttribute_3"
63 xmi:type="uml:Property">
64 <lowerValue xmi:id="DDICDIModels-DDICDILibrary-Classes-Representations-SubstantiveValueDomain-ownedAttribute_3-lowerValue"
65 xmi:uuid="http://ddialliance.org/Specification/DDI-CDI/1.0/XMI/#SubstantiveValueDomain-ownedAttribute_3-lowerValue"
66 xmi:type="uml:LiteralInteger"/>
67 <upperValue xmi:id="DDICDIModels-DDICDILibrary-Classes-Representations-SubstantiveValueDomain-ownedAttribute_3-upperValue"
68 xmi:uuid="http://ddialliance.org/Specification/DDI-CDI/1.0/XMI/#SubstantiveValueDomain-ownedAttribute_3-upperValue"
69 xmi:type="uml:LiteralUnlimitedNatural">
70 <value>1</value>
71 </upperValue>
72 <association xmi:idref="DDICDIModels-DDICDILibrary-Classes-Conceptual-SubstantiveValueDomain_takesConceptsFrom_SubstantiveConceptualDomain"/>
73 <type xmi:idref="DDICDIModels-DDICDILibrary-Classes-Conceptual-SubstantiveConceptualDomain"/>
74 </ownedAttribute>
75</packagedElement>
Fragment for the class SubstantiveValueDomain (entire XML Schema)
1<xs:element name="SubstantiveValueDomain"
2 type="SubstantiveValueDomainXsdType"
3 xml:id="SubstantiveValueDomain">
4 <!-- based on the UML class DDICDIModels::DDICDILibrary::Classes::Representations::SubstantiveValueDomain -->
5 <xs:annotation>
6 <xs:documentation>Definition
7 ==========
8 Value domain for a substantive conceptual domain. Typically a description and/or enumeration of allowed values of interest.
9
10 Examples
11 ========
12 All real decimal numbers relating to the subject matter of interest between 0 and 1 specified in Arabic numerals. (From the Generic Statistical Information Model [GSIM] 1.1). The codes "M" male and "F" for female .
13
14 Explanatory notes
15 =================
16 In DDI-CDI the value domain for a variable is separated into "substantive" and "sentinel" values. Substantive values are the values of primary interest. Sentinel values are additional values that may carry supplementary information, such as reasons for missing. This duality is described in ISO 11404. Substantive values for height might be real numbers expressed in meters. The full value domain might also include codes for different kinds of missing values - one code for "refused" and another for "don’t know". Sentinel values may also convey some substantive information and at the same time represent missing values.
17
18 An example might be where a numeric variable like number of employees be sometimes a count and sometimes a code representing a range of counts in order to avoid disclosure of information about a specific entity. The substantive value domain may use either a value description, for described values, or a codelist for enumerated values, or both. A value domain may consist of substantive values or sentinel values. Substantive values are those associated directly with some subject matter area. They do not address concerns around processing, such as missing values. Substantive values are called "regular values" in ISO/IEC 11404 - General Purpose Datatypes. The enumerated case is one where all values are listed.
19
20 An example is the categorical values for gender: the conceptual domain could consist of the concept of male and the concept of female. These might be represented in codes and associated labels as 1 ("Male") 2 ("Female"). The described case is one where some description is needed to define the set of values. Take the following description for height in meters: "a real number between 0 and 3, represented to two Arabic decimal places". This description might be structured in some way to be machine actionable (datatype="double”, min="0", max="3", decimals="2").</xs:documentation>
21 </xs:annotation>
22</xs:element>
23<xs:complexType name="SubstantiveValueDomainXsdType"
24 xml:id="SubstantiveValueDomainXsdType">
25 <xs:annotation>
26 <xs:documentation>Definition
27 ==========
28 Value domain for a substantive conceptual domain. Typically a description and/or enumeration of allowed values of interest.
29
30 Examples
31 ========
32 All real decimal numbers relating to the subject matter of interest between 0 and 1 specified in Arabic numerals. (From the Generic Statistical Information Model [GSIM] 1.1). The codes "M" male and "F" for female .
33
34 Explanatory notes
35 =================
36 In DDI-CDI the value domain for a variable is separated into "substantive" and "sentinel" values. Substantive values are the values of primary interest. Sentinel values are additional values that may carry supplementary information, such as reasons for missing. This duality is described in ISO 11404. Substantive values for height might be real numbers expressed in meters. The full value domain might also include codes for different kinds of missing values - one code for "refused" and another for "don’t know". Sentinel values may also convey some substantive information and at the same time represent missing values.
37
38 An example might be where a numeric variable like number of employees be sometimes a count and sometimes a code representing a range of counts in order to avoid disclosure of information about a specific entity. The substantive value domain may use either a value description, for described values, or a codelist for enumerated values, or both. A value domain may consist of substantive values or sentinel values. Substantive values are those associated directly with some subject matter area. They do not address concerns around processing, such as missing values. Substantive values are called "regular values" in ISO/IEC 11404 - General Purpose Datatypes. The enumerated case is one where all values are listed.
39
40 An example is the categorical values for gender: the conceptual domain could consist of the concept of male and the concept of female. These might be represented in codes and associated labels as 1 ("Male") 2 ("Female"). The described case is one where some description is needed to define the set of values. Take the following description for height in meters: "a real number between 0 and 3, represented to two Arabic decimal places". This description might be structured in some way to be machine actionable (datatype="double”, min="0", max="3", decimals="2").</xs:documentation>
41 </xs:annotation>
42 <xs:complexContent>
43 <xs:extension base="ValueDomainXsdType">
44 <xs:sequence>
45 <xs:element name="SubstantiveValueDomain_takesValuesFrom_EnumerationDomain"
46 minOccurs="0"
47 maxOccurs="1"
48 xml:id="SubstantiveValueDomain_takesValuesFrom_EnumerationDomain">
49 <xs:annotation>
50 <xs:documentation>Any subtype of an enumeration domain enumerating the set of valid values.</xs:documentation>
51 </xs:annotation>
52 <xs:complexType>
53 <xs:complexContent>
54 <xs:restriction base="AssociationReferenceXsdType">
55 <xs:sequence>
56 <xs:element name="ddiReference"
57 type="InternationalRegistrationDataIdentifierXsdType"
58 minOccurs="0"
59 maxOccurs="1"
60 xml:id="SubstantiveValueDomain_takesValuesFrom_EnumerationDomain-ddiReference"/>
61 <xs:element name="validType"
62 minOccurs="0"
63 maxOccurs="unbounded"
64 xml:id="SubstantiveValueDomain_takesValuesFrom_EnumerationDomain-validType">
65 <xs:simpleType>
66 <xs:restriction base="xs:NMTOKEN">
67 <xs:enumeration value="CodeList"/>
68 <xs:enumeration value="EnumerationDomain"/>
69 <xs:enumeration value="StatisticalClassification"/>
70 </xs:restriction>
71 </xs:simpleType>
72 </xs:element>
73 </xs:sequence>
74 </xs:restriction>
75 </xs:complexContent>
76 </xs:complexType>
77 </xs:element>
78 <xs:element name="SubstantiveValueDomain_isDescribedBy_ValueAndConceptDescription"
79 minOccurs="0"
80 maxOccurs="1"
81 xml:id="SubstantiveValueDomain_isDescribedBy_ValueAndConceptDescription">
82 <xs:annotation>
83 <xs:documentation>A formal description of the set of valid values - for described value domains.</xs:documentation>
84 </xs:annotation>
85 <xs:complexType>
86 <xs:complexContent>
87 <xs:restriction base="AssociationReferenceXsdType">
88 <xs:sequence>
89 <xs:element name="ddiReference"
90 type="InternationalRegistrationDataIdentifierXsdType"
91 minOccurs="0"
92 maxOccurs="1"
93 xml:id="SubstantiveValueDomain_isDescribedBy_ValueAndConceptDescription-ddiReference"/>
94 <xs:element name="validType"
95 minOccurs="0"
96 maxOccurs="unbounded"
97 xml:id="SubstantiveValueDomain_isDescribedBy_ValueAndConceptDescription-validType">
98 <xs:simpleType>
99 <xs:restriction base="xs:NMTOKEN">
100 <xs:enumeration value="ValueAndConceptDescription"/>
101 </xs:restriction>
102 </xs:simpleType>
103 </xs:element>
104 </xs:sequence>
105 </xs:restriction>
106 </xs:complexContent>
107 </xs:complexType>
108 </xs:element>
109 <xs:element name="SubstantiveValueDomain_takesConceptsFrom_SubstantiveConceptualDomain"
110 minOccurs="0"
111 maxOccurs="1"
112 xml:id="SubstantiveValueDomain_takesConceptsFrom_SubstantiveConceptualDomain">
113 <xs:annotation>
114 <xs:documentation>Corresponding conceptual definition given by an substantive conceptual domain.</xs:documentation>
115 </xs:annotation>
116 <xs:complexType>
117 <xs:complexContent>
118 <xs:restriction base="AssociationReferenceXsdType">
119 <xs:sequence>
120 <xs:element name="ddiReference"
121 type="InternationalRegistrationDataIdentifierXsdType"
122 minOccurs="0"
123 maxOccurs="1"
124 xml:id="SubstantiveValueDomain_takesConceptsFrom_SubstantiveConceptualDomain-ddiReference"/>
125 <xs:element name="validType"
126 minOccurs="0"
127 maxOccurs="unbounded"
128 xml:id="SubstantiveValueDomain_takesConceptsFrom_SubstantiveConceptualDomain-validType">
129 <xs:simpleType>
130 <xs:restriction base="xs:NMTOKEN">
131 <xs:enumeration value="SubstantiveConceptualDomain"/>
132 </xs:restriction>
133 </xs:simpleType>
134 </xs:element>
135 </xs:sequence>
136 </xs:restriction>
137 </xs:complexContent>
138 </xs:complexType>
139 </xs:element>
140 </xs:sequence>
141 </xs:extension>
142 </xs:complexContent>
143</xs:complexType>
Fragment for the class SubstantiveValueDomain (main ontology)
1# class SubstantiveValueDomain
2# based on the UML class DDICDIModels::DDICDILibrary::Classes::Representations::SubstantiveValueDomain
3cdi:SubstantiveValueDomain
4 a rdfs:Class, owl:Class, ucmis:Class;
5 rdfs:label "SubstantiveValueDomain";
6 rdfs:comment "Definition \n==========\nValue domain for a substantive conceptual domain. Typically a description and/or enumeration of allowed values of interest. \n\nExamples \n========\nAll real decimal numbers relating to the subject matter of interest between 0 and 1 specified in Arabic numerals. (From the Generic Statistical Information Model [GSIM] 1.1). The codes \"M\" male and \"F\" for female . \n\nExplanatory notes \n=================\nIn DDI-CDI the value domain for a variable is separated into \"substantive\" and \"sentinel\" values. Substantive values are the values of primary interest. Sentinel values are additional values that may carry supplementary information, such as reasons for missing. This duality is described in ISO 11404. Substantive values for height might be real numbers expressed in meters. The full value domain might also include codes for different kinds of missing values - one code for \"refused\" and another for \"don’t know\". Sentinel values may also convey some substantive information and at the same time represent missing values.\n\nAn example might be where a numeric variable like number of employees be sometimes a count and sometimes a code representing a range of counts in order to avoid disclosure of information about a specific entity. The substantive value domain may use either a value description, for described values, or a codelist for enumerated values, or both. A value domain may consist of substantive values or sentinel values. Substantive values are those associated directly with some subject matter area. They do not address concerns around processing, such as missing values. Substantive values are called \"regular values\" in ISO/IEC 11404 - General Purpose Datatypes. The enumerated case is one where all values are listed.\n\nAn example is the categorical values for gender: the conceptual domain could consist of the concept of male and the concept of female. These might be represented in codes and associated labels as 1 (\"Male\") 2 (\"Female\"). The described case is one where some description is needed to define the set of values. Take the following description for height in meters: \"a real number between 0 and 3, represented to two Arabic decimal places\". This description might be structured in some way to be machine actionable (datatype=\"double”, min=\"0\", max=\"3\", decimals=\"2\")."@en;
7 rdfs:subClassOf cdi:ValueDomain;
8.
9
10
11cdi:SubstantiveValueDomain_takesConceptsFrom_SubstantiveConceptualDomain
12 a rdf:Property, owl:ObjectProperty, ucmis:Association;
13 # ASSOCIATION
14 rdfs:label "takesConceptsFrom";
15 skos:altLabel "SubstantiveValueDomain_takesConceptsFrom_SubstantiveConceptualDomain";
16 rdfs:comment "Corresponding conceptual definition given by an substantive conceptual domain."@en;
17 rdfs:domain cdi:SubstantiveValueDomain;
18 rdfs:range cdi:SubstantiveConceptualDomain;
19.
20
21cdi:SubstantiveValueDomain_isDescribedBy_ValueAndConceptDescription
22 a rdf:Property, owl:ObjectProperty, ucmis:Association;
23 # ASSOCIATION
24 rdfs:label "isDescribedBy";
25 skos:altLabel "SubstantiveValueDomain_isDescribedBy_ValueAndConceptDescription";
26 rdfs:comment "A formal description of the set of valid values - for described value domains."@en;
27 rdfs:domain cdi:SubstantiveValueDomain;
28 rdfs:range cdi:ValueAndConceptDescription;
29.
30
31cdi:SubstantiveValueDomain_takesValuesFrom_EnumerationDomain
32 a rdf:Property, owl:ObjectProperty, ucmis:Association;
33 # ASSOCIATION
34 rdfs:label "takesValuesFrom";
35 skos:altLabel "SubstantiveValueDomain_takesValuesFrom_EnumerationDomain";
36 rdfs:comment "Any subtype of an enumeration domain enumerating the set of valid values."@en;
37 rdfs:domain cdi:SubstantiveValueDomain;
38 rdfs:range cdi:EnumerationDomain;
39.
Fragment for the class SubstantiveValueDomain (main JSON-LD)
1{
2 "@context": [
3 "ValueDomain.jsonld",
4 {
5 "cdi": "http://ddialliance.org/Specification/DDI-CDI/1.0/RDF/",
6 "xsd": "http://www.w3.org/2001/XMLSchema#",
7
8
9 "takesConceptsFrom": {
10 "@id": "cdi:SubstantiveValueDomain_takesConceptsFrom_SubstantiveConceptualDomain",
11 "@type": "@id",
12 "@context": "SubstantiveConceptualDomain.jsonld"
13 },
14 "isDescribedBy": {
15 "@id": "cdi:SubstantiveValueDomain_isDescribedBy_ValueAndConceptDescription",
16 "@type": "@id",
17 "@context": "ValueAndConceptDescription.jsonld"
18 },
19 "takesValuesFrom": {
20 "@id": "cdi:SubstantiveValueDomain_takesValuesFrom_EnumerationDomain",
21 "@type": "@id",
22 "@context": "EnumerationDomain.jsonld"
23 },
24 "takesSubstantiveValuesFrom_SubstantiveValueDomain_OF_RepresentedVariable": {
25 "@reverse": "cdi:RepresentedVariable_takesSubstantiveValuesFrom_SubstantiveValueDomain",
26 "@type": "@id",
27 "@context": "RepresentedVariable.jsonld"
28 },
29 "hasValueFrom_SubstantiveValueDomain_OF_MainKeyMember": {
30 "@reverse": "cdi:MainKeyMember_hasValueFrom_SubstantiveValueDomain",
31 "@type": "@id",
32 "@context": "MainKeyMember.jsonld"
33 },
34 " comment ": "tag:json-should-support-trailing-commas"
35 }
36 ],
37 "generatedBy": "This code was generated by the Eclipse Acceleo project UCMIS M2T on 2025-01-25 16:58:33.",
38 "basedOn": "based on the UML data type DDICDIModels::DDICDILibrary::Classes::Representations::SubstantiveValueDomain"
39}
