RationaleDefinition#

Fully qualified datatype name of the UML model DDI-CDI 1.0: DDICDIModels::DDICDILibrary::DataTypes::StructuredDataTypes::RationaleDefinition

Definition#

Textual description of the rationale/purpose for the version change and a coded value to provide an internal processing flag within and organization or system.

Diagram#

Diagram

Attributes#

Attributes
Attributes#

Name

Inherited from

Description

Data Type

Multiplicity

Default value

rationaleCode

- own datatype -

Rationale ode is primarily for internal processing flags within an organization or system. Supports the use of an external controlled vocabulary.

ControlledVocabularyEntry

0..1

rationaleDescription

- own datatype -

Textual description of the rationale/purpose for the version change to inform users as to the extent and implication of the version change. May be expressed in multiple languages.

InternationalString

0..1

Usage#

Usage
Usage#

Type

Package

Classifier

Attribute

DataType

StructuredDataTypes

Identifier

versionRationale

Encodings#

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 data type RationaleDefinition (entire model as XMI)

 1<packagedElement xmlns:StandardProfile="http://www.omg.org/spec/UML/20131001/StandardProfile"
 2                  xmlns:uml="http://www.omg.org/spec/UML/20131001"
 3                  xmlns:xmi="http://www.omg.org/spec/XMI/20131001"
 4                  xmi:id="DDICDIModels-DDICDILibrary-DataTypes-StructuredDataTypes-RationaleDefinition"
 5                  xmi:uuid="http://ddialliance.org/Specification/DDI-CDI/1.0/XMI/#RationaleDefinition"
 6                  xmi:type="uml:DataType">
 7   <ownedComment xmi:id="DDICDIModels-DDICDILibrary-DataTypes-StructuredDataTypes-RationaleDefinition-ownedComment"
 8                  xmi:uuid="http://ddialliance.org/Specification/DDI-CDI/1.0/XMI/#RationaleDefinition-ownedComment"
 9                  xmi:type="uml:Comment">
10      <annotatedElement xmi:idref="DDICDIModels-DDICDILibrary-DataTypes-StructuredDataTypes-RationaleDefinition"/>
11      <body>Definition
12============
13Textual description of the rationale/purpose for the version change and a coded value to provide an internal processing flag within and organization or system.</body>
14   </ownedComment>
15   <name>RationaleDefinition</name>
16   <ownedAttribute xmi:id="DDICDIModels-DDICDILibrary-DataTypes-StructuredDataTypes-RationaleDefinition-rationaleCode"
17                    xmi:uuid="http://ddialliance.org/Specification/DDI-CDI/1.0/XMI/#RationaleDefinition-rationaleCode"
18                    xmi:type="uml:Property">
19      <ownedComment xmi:id="DDICDIModels-DDICDILibrary-DataTypes-StructuredDataTypes-RationaleDefinition-rationaleCode-ownedComment"
20                     xmi:uuid="http://ddialliance.org/Specification/DDI-CDI/1.0/XMI/#RationaleDefinition-rationaleCode-ownedComment"
21                     xmi:type="uml:Comment">
22         <annotatedElement xmi:idref="DDICDIModels-DDICDILibrary-DataTypes-StructuredDataTypes-RationaleDefinition-rationaleCode"/>
23         <body>Rationale  ode is primarily for internal processing flags within an organization or system. Supports the use of an external controlled vocabulary.</body>
24      </ownedComment>
25      <lowerValue xmi:id="DDICDIModels-DDICDILibrary-DataTypes-StructuredDataTypes-RationaleDefinition-rationaleCode-lowerValue"
26                   xmi:uuid="http://ddialliance.org/Specification/DDI-CDI/1.0/XMI/#RationaleDefinition-rationaleCode-lowerValue"
27                   xmi:type="uml:LiteralInteger"/>
28      <upperValue xmi:id="DDICDIModels-DDICDILibrary-DataTypes-StructuredDataTypes-RationaleDefinition-rationaleCode-upperValue"
29                   xmi:uuid="http://ddialliance.org/Specification/DDI-CDI/1.0/XMI/#RationaleDefinition-rationaleCode-upperValue"
30                   xmi:type="uml:LiteralUnlimitedNatural">
31         <value>1</value>
32      </upperValue>
33      <name>rationaleCode</name>
34      <type xmi:idref="DDICDIModels-DDICDILibrary-DataTypes-StructuredDataTypes-ControlledVocabularyEntry"/>
35   </ownedAttribute>
36   <ownedAttribute xmi:id="DDICDIModels-DDICDILibrary-DataTypes-StructuredDataTypes-RationaleDefinition-rationaleDescription"
37                    xmi:uuid="http://ddialliance.org/Specification/DDI-CDI/1.0/XMI/#RationaleDefinition-rationaleDescription"
38                    xmi:type="uml:Property">
39      <ownedComment xmi:id="DDICDIModels-DDICDILibrary-DataTypes-StructuredDataTypes-RationaleDefinition-rationaleDescription-ownedComment"
40                     xmi:uuid="http://ddialliance.org/Specification/DDI-CDI/1.0/XMI/#RationaleDefinition-rationaleDescription-ownedComment"
41                     xmi:type="uml:Comment">
42         <annotatedElement xmi:idref="DDICDIModels-DDICDILibrary-DataTypes-StructuredDataTypes-RationaleDefinition-rationaleDescription"/>
43         <body>Textual description of the rationale/purpose for the version change to inform users as to the extent and implication of the version change. May be expressed in multiple languages.</body>
44      </ownedComment>
45      <lowerValue xmi:id="DDICDIModels-DDICDILibrary-DataTypes-StructuredDataTypes-RationaleDefinition-rationaleDescription-lowerValue"
46                   xmi:uuid="http://ddialliance.org/Specification/DDI-CDI/1.0/XMI/#RationaleDefinition-rationaleDescription-lowerValue"
47                   xmi:type="uml:LiteralInteger"/>
48      <upperValue xmi:id="DDICDIModels-DDICDILibrary-DataTypes-StructuredDataTypes-RationaleDefinition-rationaleDescription-upperValue"
49                   xmi:uuid="http://ddialliance.org/Specification/DDI-CDI/1.0/XMI/#RationaleDefinition-rationaleDescription-upperValue"
50                   xmi:type="uml:LiteralUnlimitedNatural">
51         <value>1</value>
52      </upperValue>
53      <name>rationaleDescription</name>
54      <type xmi:idref="DDICDIModels-DDICDILibrary-DataTypes-StructuredDataTypes-InternationalString"/>
55   </ownedAttribute>
56</packagedElement>

Fragment for the data type RationaleDefinition (entire XML Schema)

 1<xs:element name="RationaleDefinition"
 2            type="RationaleDefinitionXsdType"
 3            xml:id="RationaleDefinition">
 4  <!-- based on the UML data type DDICDIModels::DDICDILibrary::DataTypes::StructuredDataTypes::RationaleDefinition -->
 5  <xs:annotation>
 6    <xs:documentation>Definition
 7          ============
 8          Textual description of the rationale/purpose for the version change and a coded value to provide an internal processing flag within and organization or system.</xs:documentation>
 9  </xs:annotation>
10</xs:element>
11<xs:complexType name="RationaleDefinitionXsdType"
12                xml:id="RationaleDefinitionXsdType">
13  <xs:annotation>
14    <xs:documentation>Definition
15          ============
16          Textual description of the rationale/purpose for the version change and a coded value to provide an internal processing flag within and organization or system.</xs:documentation>
17  </xs:annotation>
18  <xs:sequence>
19    <xs:element name="rationaleCode"
20                type="ControlledVocabularyEntryXsdType"
21                minOccurs="0"
22                maxOccurs="1"
23                xml:id="RationaleDefinition-rationaleCode">
24      <xs:annotation>
25        <xs:documentation>Rationale  ode is primarily for internal processing flags within an organization or system. Supports the use of an external controlled vocabulary.</xs:documentation>
26      </xs:annotation>
27    </xs:element>
28    <xs:element name="rationaleDescription"
29                type="InternationalStringXsdType"
30                minOccurs="0"
31                maxOccurs="1"
32                xml:id="RationaleDefinition-rationaleDescription">
33      <xs:annotation>
34        <xs:documentation>Textual description of the rationale/purpose for the version change to inform users as to the extent and implication of the version change. May be expressed in multiple languages.</xs:documentation>
35      </xs:annotation>
36    </xs:element>
37  </xs:sequence>
38</xs:complexType>

Fragment for the data type RationaleDefinition (entire JSON Schema)

 1"dt-RationaleDefinition": {
 2  "description": "http://ddialliance.org/Specification/DDI-CDI/1.0/RDF/RationaleDefinition",
 3  "type": ["object"],
 4  "properties": {
 5    "rationaleCode": {
 6      "$comment": "cardinality 0..1 – from cdi:RationaleDefinition",
 7      "$ref": "#/defs/dt-ControlledVocabularyEntry"
 8    },
 9    "rationaleDescription": {
10      "$comment": "cardinality 0..1 – from cdi:RationaleDefinition",
11      "$ref": "#/defs/dt-InternationalString"
12    },
13    "@type": {
14      "const": "RationaleDefinition"
15    }
16  },
17  "required": ["@type"],
18  "additionalProperties": false
19},

Fragment for the data type RationaleDefinition (main ontology)

 1# datatype RationaleDefinition
 2# based on the UML data type DDICDIModels::DDICDILibrary::DataTypes::StructuredDataTypes::RationaleDefinition
 3cdi:RationaleDefinition
 4  a rdfs:Class, owl:Class, ucmis:StructuredDataType;
 5  rdfs:label "RationaleDefinition";
 6  rdfs:comment "Definition\n============\nTextual description of the rationale/purpose for the version change and a coded value to provide an internal processing flag within and organization or system."@en;
 7  
 8  owl:hasKey (cdi:RationaleDefinition-rationaleCode cdi:RationaleDefinition-rationaleDescription);
 9.
10
11cdi:RationaleDefinition-rationaleCode
12  a rdf:Property, owl:ObjectProperty, ucmis:Attribute;
13  rdfs:label "rationaleCode";
14  rdfs:comment "Rationale  ode is primarily for internal processing flags within an organization or system. Supports the use of an external controlled vocabulary."@en;
15  rdfs:domain cdi:RationaleDefinition;
16  rdfs:range cdi:ControlledVocabularyEntry;
17.
18
19cdi:RationaleDefinition-rationaleDescription
20  a rdf:Property, owl:ObjectProperty, ucmis:Attribute;
21  rdfs:label "rationaleDescription";
22  rdfs:comment "Textual description of the rationale/purpose for the version change to inform users as to the extent and implication of the version change. May be expressed in multiple languages."@en;
23  rdfs:domain cdi:RationaleDefinition;
24  rdfs:range cdi:InternationalString;
25.

Fragment for the data type RationaleDefinition (entire JSON-LD)

 1{
 2  "@context": [
 3    {
 4      "cdi": "http://ddialliance.org/Specification/DDI-CDI/1.0/RDF/",
 5      "xsd": "http://www.w3.org/2001/XMLSchema#",
 6
 7      "rationaleCode": {
 8        "@id": "cdi:RationaleDefinition-rationaleCode",
 9        "@type": "@id",
10        "@context": "ControlledVocabularyEntry.jsonld"
11      },
12      "rationaleDescription": {
13        "@id": "cdi:RationaleDefinition-rationaleDescription",
14        "@type": "@id",
15        "@context": "InternationalString.jsonld"
16      },
17      
18      " comment ": "tag:json-should-support-trailing-commas" 
19    }
20  ],
21  "generatedBy": "This code was generated by the Eclipse Acceleo project UCMIS M2T on 2025-08-29 14:34:56.",
22  "basedOn": "based on the UML data type DDICDIModels::DDICDILibrary::DataTypes::StructuredDataTypes::RationaleDefinition"
23}

Fragment for the data type RationaleDefinition (entire SHACL - Shapes Constraint Language)

 1# datatype RationaleDefinition
 2# based on the UML data type DDICDIModels::DDICDILibrary::DataTypes::StructuredDataTypes::RationaleDefinition
 3<#RationaleDefinition> a sh:NodeShape;
 4    sh:targetClass cdi:RationaleDefinition;
 5	sh:message "See http://ddialliance.org/Specification/DDI-CDI/1.0/RDF/RationaleDefinition";
 6	sh:closed true;
 7	sh:ignoredProperties ( owl:sameAs );
 8    sh:property [
 9			sh:path rdf:type;
10			sh:in (   cdi:RationaleDefinition
11			 ) ;
12    ];
13    # attributes
14    sh:property <#RationaleDefinition-rationaleCode>;
15    sh:property <#RationaleDefinition-rationaleDescription>;
16
17
18
19.
20
21<#RationaleDefinition-rationaleCode> a sh:PropertyShape ;
22    sh:path cdi:RationaleDefinition-rationaleCode;
23    sh:node [ sh:property [ sh:path rdf:type; sh:minCount 1; sh:in (
24        cdi:ControlledVocabularyEntry
25      
26    ) ]];
27    sh:maxCount 1;
28.
29<#RationaleDefinition-rationaleDescription> a sh:PropertyShape ;
30    sh:path cdi:RationaleDefinition-rationaleDescription;
31    sh:node [ sh:property [ sh:path rdf:type; sh:minCount 1; sh:in (
32        cdi:InternationalString
33        cdi:BibliographicName
34        cdi:LabelForDisplay
35      
36    ) ]];
37    sh:maxCount 1;
38.

Fragment for the data type RationaleDefinition (entire ShEx - Shape Expressions)

1# datatype RationaleDefinition
2# based on the UML data type DDICDIModels::DDICDILibrary::DataTypes::StructuredDataTypes::RationaleDefinition
3cdi:RationaleDefinitionShape CLOSED {
4	a [cdi:RationaleDefinition];
5	cdi:RationaleDefinition-rationaleCode	@cdi:ControlledVocabularyEntryShape?;
6	cdi:RationaleDefinition-rationaleDescription	@cdi:InternationalStringShape?;
7	}