InternationalIdentifier#

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

Definition#

An identifier whose scope of uniqueness is broader than the local archive. Common forms of an international identifier are ISBN, ISSN, DOI or similar designator. Provides both the value of the identifier and the agency who manages it.

Explanatory notes#

For use in annotation or other citation format.

Diagram#

Diagram
⤢

Attributes#

Attributes
Attributes#

Name

Inherited from

Description

Data Type

Multiplicity

Default value

identifierContent

- own datatype -

An identifier as it should be listed for identification purposes.

String

0..1

isURI

- own datatype -

Set to True if Identifier is a URI.

Boolean

0..1

false

managingAgency

- own datatype -

The identification of the Agency which assigns and manages the identifier, i.e., ISBN, ISSN, DOI, etc.

ControlledVocabularyEntry

0..1

Usage#

Usage
Usage#

Type

Package

Classifier

Attribute

DataType

StructuredDataTypes

CatalogDetails

identifier

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 InternationalIdentifier (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-InternationalIdentifier"
 5                  xmi:uuid="http://ddialliance.org/Specification/DDI-CDI/1.0/XMI/#InternationalIdentifier"
 6                  xmi:type="uml:DataType">
 7   <ownedComment xmi:id="DDICDIModels-DDICDILibrary-DataTypes-StructuredDataTypes-InternationalIdentifier-ownedComment"
 8                  xmi:uuid="http://ddialliance.org/Specification/DDI-CDI/1.0/XMI/#InternationalIdentifier-ownedComment"
 9                  xmi:type="uml:Comment">
10      <annotatedElement xmi:idref="DDICDIModels-DDICDILibrary-DataTypes-StructuredDataTypes-InternationalIdentifier"/>
11      <body>Definition
12============
13An identifier whose scope of uniqueness is broader than the local archive. Common forms of an international identifier are ISBN, ISSN, DOI or similar designator. Provides both the value of the identifier and the agency who manages it.
14
15Explanatory notes
16===================
17For use in annotation or other citation format.</body>
18   </ownedComment>
19   <name>InternationalIdentifier</name>
20   <ownedAttribute xmi:id="DDICDIModels-DDICDILibrary-DataTypes-StructuredDataTypes-InternationalIdentifier-identifierContent"
21                    xmi:uuid="http://ddialliance.org/Specification/DDI-CDI/1.0/XMI/#InternationalIdentifier-identifierContent"
22                    xmi:type="uml:Property">
23      <ownedComment xmi:id="DDICDIModels-DDICDILibrary-DataTypes-StructuredDataTypes-InternationalIdentifier-identifierContent-ownedComment"
24                     xmi:uuid="http://ddialliance.org/Specification/DDI-CDI/1.0/XMI/#InternationalIdentifier-identifierContent-ownedComment"
25                     xmi:type="uml:Comment">
26         <annotatedElement xmi:idref="DDICDIModels-DDICDILibrary-DataTypes-StructuredDataTypes-InternationalIdentifier-identifierContent"/>
27         <body>An identifier as it should be listed for identification purposes.</body>
28      </ownedComment>
29      <lowerValue xmi:id="DDICDIModels-DDICDILibrary-DataTypes-StructuredDataTypes-InternationalIdentifier-identifierContent-lowerValue"
30                   xmi:uuid="http://ddialliance.org/Specification/DDI-CDI/1.0/XMI/#InternationalIdentifier-identifierContent-lowerValue"
31                   xmi:type="uml:LiteralInteger"/>
32      <upperValue xmi:id="DDICDIModels-DDICDILibrary-DataTypes-StructuredDataTypes-InternationalIdentifier-identifierContent-upperValue"
33                   xmi:uuid="http://ddialliance.org/Specification/DDI-CDI/1.0/XMI/#InternationalIdentifier-identifierContent-upperValue"
34                   xmi:type="uml:LiteralUnlimitedNatural">
35         <value>1</value>
36      </upperValue>
37      <name>identifierContent</name>
38      <type href="http://www.omg.org/spec/UML/20131001/PrimitiveTypes.xmi#String"
39             xmi:type="uml:PrimitiveType"/>
40   </ownedAttribute>
41   <ownedAttribute xmi:id="DDICDIModels-DDICDILibrary-DataTypes-StructuredDataTypes-InternationalIdentifier-isURI"
42                    xmi:uuid="http://ddialliance.org/Specification/DDI-CDI/1.0/XMI/#InternationalIdentifier-isURI"
43                    xmi:type="uml:Property">
44      <ownedComment xmi:id="DDICDIModels-DDICDILibrary-DataTypes-StructuredDataTypes-InternationalIdentifier-isURI-ownedComment"
45                     xmi:uuid="http://ddialliance.org/Specification/DDI-CDI/1.0/XMI/#InternationalIdentifier-isURI-ownedComment"
46                     xmi:type="uml:Comment">
47         <annotatedElement xmi:idref="DDICDIModels-DDICDILibrary-DataTypes-StructuredDataTypes-InternationalIdentifier-isURI"/>
48         <body>Set to True if Identifier is a URI.</body>
49      </ownedComment>
50      <lowerValue xmi:id="DDICDIModels-DDICDILibrary-DataTypes-StructuredDataTypes-InternationalIdentifier-isURI-lowerValue"
51                   xmi:uuid="http://ddialliance.org/Specification/DDI-CDI/1.0/XMI/#InternationalIdentifier-isURI-lowerValue"
52                   xmi:type="uml:LiteralInteger"/>
53      <upperValue xmi:id="DDICDIModels-DDICDILibrary-DataTypes-StructuredDataTypes-InternationalIdentifier-isURI-upperValue"
54                   xmi:uuid="http://ddialliance.org/Specification/DDI-CDI/1.0/XMI/#InternationalIdentifier-isURI-upperValue"
55                   xmi:type="uml:LiteralUnlimitedNatural">
56         <value>1</value>
57      </upperValue>
58      <name>isURI</name>
59      <defaultValue xmi:id="DDICDIModels-DDICDILibrary-DataTypes-StructuredDataTypes-InternationalIdentifier-isURI-defaultValue"
60                     xmi:uuid="http://ddialliance.org/Specification/DDI-CDI/1.0/XMI/#InternationalIdentifier-isURI-defaultValue"
61                     xmi:type="uml:LiteralBoolean">
62         <value>False</value>
63      </defaultValue>
64      <type href="http://www.omg.org/spec/UML/20131001/PrimitiveTypes.xmi#Boolean"
65             xmi:type="uml:PrimitiveType"/>
66   </ownedAttribute>
67   <ownedAttribute xmi:id="DDICDIModels-DDICDILibrary-DataTypes-StructuredDataTypes-InternationalIdentifier-managingAgency"
68                    xmi:uuid="http://ddialliance.org/Specification/DDI-CDI/1.0/XMI/#InternationalIdentifier-managingAgency"
69                    xmi:type="uml:Property">
70      <ownedComment xmi:id="DDICDIModels-DDICDILibrary-DataTypes-StructuredDataTypes-InternationalIdentifier-managingAgency-ownedComment"
71                     xmi:uuid="http://ddialliance.org/Specification/DDI-CDI/1.0/XMI/#InternationalIdentifier-managingAgency-ownedComment"
72                     xmi:type="uml:Comment">
73         <annotatedElement xmi:idref="DDICDIModels-DDICDILibrary-DataTypes-StructuredDataTypes-InternationalIdentifier-managingAgency"/>
74         <body>The identification of the Agency which assigns and manages the identifier, i.e., ISBN, ISSN, DOI, etc.</body>
75      </ownedComment>
76      <lowerValue xmi:id="DDICDIModels-DDICDILibrary-DataTypes-StructuredDataTypes-InternationalIdentifier-managingAgency-lowerValue"
77                   xmi:uuid="http://ddialliance.org/Specification/DDI-CDI/1.0/XMI/#InternationalIdentifier-managingAgency-lowerValue"
78                   xmi:type="uml:LiteralInteger"/>
79      <upperValue xmi:id="DDICDIModels-DDICDILibrary-DataTypes-StructuredDataTypes-InternationalIdentifier-managingAgency-upperValue"
80                   xmi:uuid="http://ddialliance.org/Specification/DDI-CDI/1.0/XMI/#InternationalIdentifier-managingAgency-upperValue"
81                   xmi:type="uml:LiteralUnlimitedNatural">
82         <value>1</value>
83      </upperValue>
84      <name>managingAgency</name>
85      <type xmi:idref="DDICDIModels-DDICDILibrary-DataTypes-StructuredDataTypes-ControlledVocabularyEntry"/>
86   </ownedAttribute>
87</packagedElement>

Fragment for the data type InternationalIdentifier (entire XML Schema)

 1<xs:element name="InternationalIdentifier"
 2            type="InternationalIdentifierXsdType"
 3            xml:id="InternationalIdentifier">
 4  <!-- based on the UML data type DDICDIModels::DDICDILibrary::DataTypes::StructuredDataTypes::InternationalIdentifier -->
 5  <xs:annotation>
 6    <xs:documentation>Definition
 7          ============
 8          An identifier whose scope of uniqueness is broader than the local archive. Common forms of an international identifier are ISBN, ISSN, DOI or similar designator. Provides both the value of the identifier and the agency who manages it.
 9          
10          Explanatory notes
11          ===================
12          For use in annotation or other citation format.</xs:documentation>
13  </xs:annotation>
14</xs:element>
15<xs:complexType name="InternationalIdentifierXsdType"
16                xml:id="InternationalIdentifierXsdType">
17  <xs:annotation>
18    <xs:documentation>Definition
19          ============
20          An identifier whose scope of uniqueness is broader than the local archive. Common forms of an international identifier are ISBN, ISSN, DOI or similar designator. Provides both the value of the identifier and the agency who manages it.
21          
22          Explanatory notes
23          ===================
24          For use in annotation or other citation format.</xs:documentation>
25  </xs:annotation>
26  <xs:sequence>
27    <xs:element name="identifierContent"
28                type="xs:string"
29                minOccurs="0"
30                maxOccurs="1"
31                xml:id="InternationalIdentifier-identifierContent">
32      <xs:annotation>
33        <xs:documentation>An identifier as it should be listed for identification purposes.</xs:documentation>
34      </xs:annotation>
35    </xs:element>
36    <xs:element name="isURI"
37                type="xs:boolean"
38                minOccurs="0"
39                maxOccurs="1"
40                xml:id="InternationalIdentifier-isURI">
41      <xs:annotation>
42        <xs:documentation>Set to True if Identifier is a URI.</xs:documentation>
43      </xs:annotation>
44    </xs:element>
45    <xs:element name="managingAgency"
46                type="ControlledVocabularyEntryXsdType"
47                minOccurs="0"
48                maxOccurs="1"
49                xml:id="InternationalIdentifier-managingAgency">
50      <xs:annotation>
51        <xs:documentation>The identification of the Agency which assigns and manages the identifier, i.e., ISBN, ISSN, DOI, etc.</xs:documentation>
52      </xs:annotation>
53    </xs:element>
54  </xs:sequence>
55</xs:complexType>

Fragment for the data type InternationalIdentifier (entire JSON Schema)

 1"dt-InternationalIdentifier": {
 2  "description": "http://ddialliance.org/Specification/DDI-CDI/1.0/RDF/InternationalIdentifier",
 3  "type": ["object"],
 4  "properties": {
 5    "identifierContent": {
 6      "$comment": "cardinality 0..1 – from cdi:InternationalIdentifier",
 7      "$ref": "#/defs/xsd:string"
 8    },
 9    "isURI": {
10      "$comment": "cardinality 0..1 – from cdi:InternationalIdentifier",
11      "$ref": "#/defs/xsd:boolean"
12    },
13    "managingAgency": {
14      "$comment": "cardinality 0..1 – from cdi:InternationalIdentifier",
15      "$ref": "#/defs/dt-ControlledVocabularyEntry"
16    },
17    "@type": {
18      "const": "InternationalIdentifier"
19    }
20  },
21  "required": ["@type"],
22  "additionalProperties": false
23},

Fragment for the data type InternationalIdentifier (main ontology)

 1# datatype InternationalIdentifier
 2# based on the UML data type DDICDIModels::DDICDILibrary::DataTypes::StructuredDataTypes::InternationalIdentifier
 3cdi:InternationalIdentifier
 4  a rdfs:Class, owl:Class, ucmis:StructuredDataType;
 5  rdfs:label "InternationalIdentifier";
 6  rdfs:comment "Definition\n============\nAn identifier whose scope of uniqueness is broader than the local archive. Common forms of an international identifier are ISBN, ISSN, DOI or similar designator. Provides both the value of the identifier and the agency who manages it.\n\nExplanatory notes\n===================\nFor use in annotation or other citation format."@en;
 7  
 8  owl:hasKey (cdi:InternationalIdentifier-identifierContent cdi:InternationalIdentifier-isURI cdi:InternationalIdentifier-managingAgency);
 9.
10
11cdi:InternationalIdentifier-identifierContent
12  a rdf:Property, owl:DatatypeProperty, ucmis:Attribute;
13  rdfs:label "identifierContent";
14  rdfs:comment "An identifier as it should be listed for identification purposes."@en;
15  rdfs:domain cdi:InternationalIdentifier;
16  rdfs:range xsd:string;
17.
18
19cdi:InternationalIdentifier-isURI
20  a rdf:Property, owl:DatatypeProperty, ucmis:Attribute;
21  rdfs:label "isURI";
22  rdfs:comment "Set to True if Identifier is a URI."@en;
23  rdfs:domain cdi:InternationalIdentifier;
24  rdfs:range xsd:boolean;
25.
26
27cdi:InternationalIdentifier-managingAgency
28  a rdf:Property, owl:ObjectProperty, ucmis:Attribute;
29  rdfs:label "managingAgency";
30  rdfs:comment "The identification of the Agency which assigns and manages the identifier, i.e., ISBN, ISSN, DOI, etc."@en;
31  rdfs:domain cdi:InternationalIdentifier;
32  rdfs:range cdi:ControlledVocabularyEntry;
33.

Fragment for the data type InternationalIdentifier (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      "identifierContent": {
 8        "@id": "cdi:InternationalIdentifier-identifierContent",
 9        "@type": "xsd:string"
10      },
11      "isURI": {
12        "@id": "cdi:InternationalIdentifier-isURI",
13        "@type": "xsd:boolean"
14      },
15      "managingAgency": {
16        "@id": "cdi:InternationalIdentifier-managingAgency",
17        "@type": "@id",
18        "@context": "ControlledVocabularyEntry.jsonld"
19      },
20      
21      " comment ": "tag:json-should-support-trailing-commas" 
22    }
23  ],
24  "generatedBy": "This code was generated by the Eclipse Acceleo project UCMIS M2T on 2025-08-29 14:34:56.",
25  "basedOn": "based on the UML data type DDICDIModels::DDICDILibrary::DataTypes::StructuredDataTypes::InternationalIdentifier"
26}

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

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

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

1# datatype InternationalIdentifier
2# based on the UML data type DDICDIModels::DDICDILibrary::DataTypes::StructuredDataTypes::InternationalIdentifier
3cdi:InternationalIdentifierShape CLOSED {
4	a [cdi:InternationalIdentifier];
5	cdi:InternationalIdentifier-identifierContent	xsd:string?;
6	cdi:InternationalIdentifier-isURI	xsd:boolean?;
7	cdi:InternationalIdentifier-managingAgency	@cdi:ControlledVocabularyEntryShape?;
8	}