Telephone#

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

Definition#

Details of a telephone number including the number, type of telephone number, a privacy setting and an indication of whether this is the preferred contact number.

Examples#

+12 345 67890123

Diagram#

Diagram
⤢

Attributes#

Attributes
Attributes#

Name

Inherited from

Description

Data Type

Multiplicity

Default value

effectiveDates

- own datatype -

Time period during which the telephone number is valid.

DateRange

0..1

isPreferred

- own datatype -

Set to True if this is the preferred telephone number for contact.

Boolean

0..1

false

privacy

- own datatype -

Specify the level privacy for the telephone number as public, restricted, or private. Supports the use of an external controlled vocabulary.

ControlledVocabularyEntry

0..1

telephoneNumber

- own datatype -

The telephone number including country code if appropriate.

String

0..1

typeOfTelephone

- own datatype -

Indicates type of telephone number provided (home, fax, office, cell, etc.). Supports the use of a controlled vocabulary.

ControlledVocabularyEntry

0..1

Usage#

Usage
Usage#

Type

Package

Classifier

Attribute

DataType

StructuredDataTypes

ContactInformation

telephone

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 Telephone (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-Telephone"
  5                  xmi:uuid="http://ddialliance.org/Specification/DDI-CDI/1.0/XMI/#Telephone"
  6                  xmi:type="uml:DataType">
  7   <ownedComment xmi:id="DDICDIModels-DDICDILibrary-DataTypes-StructuredDataTypes-Telephone-ownedComment"
  8                  xmi:uuid="http://ddialliance.org/Specification/DDI-CDI/1.0/XMI/#Telephone-ownedComment"
  9                  xmi:type="uml:Comment">
 10      <annotatedElement xmi:idref="DDICDIModels-DDICDILibrary-DataTypes-StructuredDataTypes-Telephone"/>
 11      <body>Definition
 12============
 13Details of a telephone number including the number, type of telephone number, a privacy setting and an indication of whether this is the preferred contact number.
 14
 15Examples
 16==========
 17+12 345 67890123</body>
 18   </ownedComment>
 19   <name>Telephone</name>
 20   <ownedAttribute xmi:id="DDICDIModels-DDICDILibrary-DataTypes-StructuredDataTypes-Telephone-effectiveDates"
 21                    xmi:uuid="http://ddialliance.org/Specification/DDI-CDI/1.0/XMI/#Telephone-effectiveDates"
 22                    xmi:type="uml:Property">
 23      <ownedComment xmi:id="DDICDIModels-DDICDILibrary-DataTypes-StructuredDataTypes-Telephone-effectiveDates-ownedComment"
 24                     xmi:uuid="http://ddialliance.org/Specification/DDI-CDI/1.0/XMI/#Telephone-effectiveDates-ownedComment"
 25                     xmi:type="uml:Comment">
 26         <annotatedElement xmi:idref="DDICDIModels-DDICDILibrary-DataTypes-StructuredDataTypes-Telephone-effectiveDates"/>
 27         <body>Time period during which the telephone number is valid.</body>
 28      </ownedComment>
 29      <lowerValue xmi:id="DDICDIModels-DDICDILibrary-DataTypes-StructuredDataTypes-Telephone-effectiveDates-lowerValue"
 30                   xmi:uuid="http://ddialliance.org/Specification/DDI-CDI/1.0/XMI/#Telephone-effectiveDates-lowerValue"
 31                   xmi:type="uml:LiteralInteger"/>
 32      <upperValue xmi:id="DDICDIModels-DDICDILibrary-DataTypes-StructuredDataTypes-Telephone-effectiveDates-upperValue"
 33                   xmi:uuid="http://ddialliance.org/Specification/DDI-CDI/1.0/XMI/#Telephone-effectiveDates-upperValue"
 34                   xmi:type="uml:LiteralUnlimitedNatural">
 35         <value>1</value>
 36      </upperValue>
 37      <name>effectiveDates</name>
 38      <type xmi:idref="DDICDIModels-DDICDILibrary-DataTypes-StructuredDataTypes-DateRange"/>
 39   </ownedAttribute>
 40   <ownedAttribute xmi:id="DDICDIModels-DDICDILibrary-DataTypes-StructuredDataTypes-Telephone-isPreferred"
 41                    xmi:uuid="http://ddialliance.org/Specification/DDI-CDI/1.0/XMI/#Telephone-isPreferred"
 42                    xmi:type="uml:Property">
 43      <ownedComment xmi:id="DDICDIModels-DDICDILibrary-DataTypes-StructuredDataTypes-Telephone-isPreferred-ownedComment"
 44                     xmi:uuid="http://ddialliance.org/Specification/DDI-CDI/1.0/XMI/#Telephone-isPreferred-ownedComment"
 45                     xmi:type="uml:Comment">
 46         <annotatedElement xmi:idref="DDICDIModels-DDICDILibrary-DataTypes-StructuredDataTypes-Telephone-isPreferred"/>
 47         <body>Set to True if this is the preferred telephone number for contact.</body>
 48      </ownedComment>
 49      <lowerValue xmi:id="DDICDIModels-DDICDILibrary-DataTypes-StructuredDataTypes-Telephone-isPreferred-lowerValue"
 50                   xmi:uuid="http://ddialliance.org/Specification/DDI-CDI/1.0/XMI/#Telephone-isPreferred-lowerValue"
 51                   xmi:type="uml:LiteralInteger"/>
 52      <upperValue xmi:id="DDICDIModels-DDICDILibrary-DataTypes-StructuredDataTypes-Telephone-isPreferred-upperValue"
 53                   xmi:uuid="http://ddialliance.org/Specification/DDI-CDI/1.0/XMI/#Telephone-isPreferred-upperValue"
 54                   xmi:type="uml:LiteralUnlimitedNatural">
 55         <value>1</value>
 56      </upperValue>
 57      <name>isPreferred</name>
 58      <defaultValue xmi:id="DDICDIModels-DDICDILibrary-DataTypes-StructuredDataTypes-Telephone-isPreferred-defaultValue"
 59                     xmi:uuid="http://ddialliance.org/Specification/DDI-CDI/1.0/XMI/#Telephone-isPreferred-defaultValue"
 60                     xmi:type="uml:LiteralBoolean">
 61         <value>False</value>
 62      </defaultValue>
 63      <type href="http://www.omg.org/spec/UML/20131001/PrimitiveTypes.xmi#Boolean"
 64             xmi:type="uml:PrimitiveType"/>
 65   </ownedAttribute>
 66   <ownedAttribute xmi:id="DDICDIModels-DDICDILibrary-DataTypes-StructuredDataTypes-Telephone-privacy"
 67                    xmi:uuid="http://ddialliance.org/Specification/DDI-CDI/1.0/XMI/#Telephone-privacy"
 68                    xmi:type="uml:Property">
 69      <ownedComment xmi:id="DDICDIModels-DDICDILibrary-DataTypes-StructuredDataTypes-Telephone-privacy-ownedComment"
 70                     xmi:uuid="http://ddialliance.org/Specification/DDI-CDI/1.0/XMI/#Telephone-privacy-ownedComment"
 71                     xmi:type="uml:Comment">
 72         <annotatedElement xmi:idref="DDICDIModels-DDICDILibrary-DataTypes-StructuredDataTypes-Telephone-privacy"/>
 73         <body>Specify the level privacy for the telephone number as public, restricted, or private. Supports the use of an external controlled vocabulary.</body>
 74      </ownedComment>
 75      <lowerValue xmi:id="DDICDIModels-DDICDILibrary-DataTypes-StructuredDataTypes-Telephone-privacy-lowerValue"
 76                   xmi:uuid="http://ddialliance.org/Specification/DDI-CDI/1.0/XMI/#Telephone-privacy-lowerValue"
 77                   xmi:type="uml:LiteralInteger"/>
 78      <upperValue xmi:id="DDICDIModels-DDICDILibrary-DataTypes-StructuredDataTypes-Telephone-privacy-upperValue"
 79                   xmi:uuid="http://ddialliance.org/Specification/DDI-CDI/1.0/XMI/#Telephone-privacy-upperValue"
 80                   xmi:type="uml:LiteralUnlimitedNatural">
 81         <value>1</value>
 82      </upperValue>
 83      <name>privacy</name>
 84      <type xmi:idref="DDICDIModels-DDICDILibrary-DataTypes-StructuredDataTypes-ControlledVocabularyEntry"/>
 85   </ownedAttribute>
 86   <ownedAttribute xmi:id="DDICDIModels-DDICDILibrary-DataTypes-StructuredDataTypes-Telephone-telephoneNumber"
 87                    xmi:uuid="http://ddialliance.org/Specification/DDI-CDI/1.0/XMI/#Telephone-telephoneNumber"
 88                    xmi:type="uml:Property">
 89      <ownedComment xmi:id="DDICDIModels-DDICDILibrary-DataTypes-StructuredDataTypes-Telephone-telephoneNumber-ownedComment"
 90                     xmi:uuid="http://ddialliance.org/Specification/DDI-CDI/1.0/XMI/#Telephone-telephoneNumber-ownedComment"
 91                     xmi:type="uml:Comment">
 92         <annotatedElement xmi:idref="DDICDIModels-DDICDILibrary-DataTypes-StructuredDataTypes-Telephone-telephoneNumber"/>
 93         <body>The telephone number including country code if appropriate.</body>
 94      </ownedComment>
 95      <lowerValue xmi:id="DDICDIModels-DDICDILibrary-DataTypes-StructuredDataTypes-Telephone-telephoneNumber-lowerValue"
 96                   xmi:uuid="http://ddialliance.org/Specification/DDI-CDI/1.0/XMI/#Telephone-telephoneNumber-lowerValue"
 97                   xmi:type="uml:LiteralInteger"/>
 98      <upperValue xmi:id="DDICDIModels-DDICDILibrary-DataTypes-StructuredDataTypes-Telephone-telephoneNumber-upperValue"
 99                   xmi:uuid="http://ddialliance.org/Specification/DDI-CDI/1.0/XMI/#Telephone-telephoneNumber-upperValue"
100                   xmi:type="uml:LiteralUnlimitedNatural">
101         <value>1</value>
102      </upperValue>
103      <name>telephoneNumber</name>
104      <type href="http://www.omg.org/spec/UML/20131001/PrimitiveTypes.xmi#String"
105             xmi:type="uml:PrimitiveType"/>
106   </ownedAttribute>
107   <ownedAttribute xmi:id="DDICDIModels-DDICDILibrary-DataTypes-StructuredDataTypes-Telephone-typeOfTelephone"
108                    xmi:uuid="http://ddialliance.org/Specification/DDI-CDI/1.0/XMI/#Telephone-typeOfTelephone"
109                    xmi:type="uml:Property">
110      <ownedComment xmi:id="DDICDIModels-DDICDILibrary-DataTypes-StructuredDataTypes-Telephone-typeOfTelephone-ownedComment"
111                     xmi:uuid="http://ddialliance.org/Specification/DDI-CDI/1.0/XMI/#Telephone-typeOfTelephone-ownedComment"
112                     xmi:type="uml:Comment">
113         <annotatedElement xmi:idref="DDICDIModels-DDICDILibrary-DataTypes-StructuredDataTypes-Telephone-typeOfTelephone"/>
114         <body>Indicates type of telephone number provided (home, fax, office, cell, etc.). Supports the use of a controlled vocabulary.</body>
115      </ownedComment>
116      <lowerValue xmi:id="DDICDIModels-DDICDILibrary-DataTypes-StructuredDataTypes-Telephone-typeOfTelephone-lowerValue"
117                   xmi:uuid="http://ddialliance.org/Specification/DDI-CDI/1.0/XMI/#Telephone-typeOfTelephone-lowerValue"
118                   xmi:type="uml:LiteralInteger"/>
119      <upperValue xmi:id="DDICDIModels-DDICDILibrary-DataTypes-StructuredDataTypes-Telephone-typeOfTelephone-upperValue"
120                   xmi:uuid="http://ddialliance.org/Specification/DDI-CDI/1.0/XMI/#Telephone-typeOfTelephone-upperValue"
121                   xmi:type="uml:LiteralUnlimitedNatural">
122         <value>1</value>
123      </upperValue>
124      <name>typeOfTelephone</name>
125      <type xmi:idref="DDICDIModels-DDICDILibrary-DataTypes-StructuredDataTypes-ControlledVocabularyEntry"/>
126   </ownedAttribute>
127</packagedElement>

Fragment for the data type Telephone (entire XML Schema)

 1<xs:element name="Telephone"
 2            type="TelephoneXsdType"
 3            xml:id="Telephone">
 4  <!-- based on the UML data type DDICDIModels::DDICDILibrary::DataTypes::StructuredDataTypes::Telephone -->
 5  <xs:annotation>
 6    <xs:documentation>Definition
 7          ============
 8          Details of a telephone number including the number, type of telephone number, a privacy setting and an indication of whether this is the preferred contact number.
 9          
10          Examples
11          ==========
12          +12 345 67890123</xs:documentation>
13  </xs:annotation>
14</xs:element>
15<xs:complexType name="TelephoneXsdType"
16                xml:id="TelephoneXsdType">
17  <xs:annotation>
18    <xs:documentation>Definition
19          ============
20          Details of a telephone number including the number, type of telephone number, a privacy setting and an indication of whether this is the preferred contact number.
21          
22          Examples
23          ==========
24          +12 345 67890123</xs:documentation>
25  </xs:annotation>
26  <xs:sequence>
27    <xs:element name="effectiveDates"
28                type="DateRangeXsdType"
29                minOccurs="0"
30                maxOccurs="1"
31                xml:id="Telephone-effectiveDates">
32      <xs:annotation>
33        <xs:documentation>Time period during which the telephone number is valid.</xs:documentation>
34      </xs:annotation>
35    </xs:element>
36    <xs:element name="isPreferred"
37                type="xs:boolean"
38                minOccurs="0"
39                maxOccurs="1"
40                xml:id="Telephone-isPreferred">
41      <xs:annotation>
42        <xs:documentation>Set to True if this is the preferred telephone number for contact.</xs:documentation>
43      </xs:annotation>
44    </xs:element>
45    <xs:element name="privacy"
46                type="ControlledVocabularyEntryXsdType"
47                minOccurs="0"
48                maxOccurs="1"
49                xml:id="Telephone-privacy">
50      <xs:annotation>
51        <xs:documentation>Specify the level privacy for the telephone number as public, restricted, or private. Supports the use of an external controlled vocabulary.</xs:documentation>
52      </xs:annotation>
53    </xs:element>
54    <xs:element name="telephoneNumber"
55                type="xs:string"
56                minOccurs="0"
57                maxOccurs="1"
58                xml:id="Telephone-telephoneNumber">
59      <xs:annotation>
60        <xs:documentation>The telephone number including country code if appropriate.</xs:documentation>
61      </xs:annotation>
62    </xs:element>
63    <xs:element name="typeOfTelephone"
64                type="ControlledVocabularyEntryXsdType"
65                minOccurs="0"
66                maxOccurs="1"
67                xml:id="Telephone-typeOfTelephone">
68      <xs:annotation>
69        <xs:documentation>Indicates type of telephone number provided (home, fax, office, cell, etc.). Supports the use of a controlled vocabulary.</xs:documentation>
70      </xs:annotation>
71    </xs:element>
72  </xs:sequence>
73</xs:complexType>

Fragment for the data type Telephone (entire JSON Schema)

 1"dt-Telephone": {
 2  "description": "http://ddialliance.org/Specification/DDI-CDI/1.0/RDF/Telephone",
 3  "type": ["object"],
 4  "properties": {
 5    "effectiveDates": {
 6      "$comment": "cardinality 0..1 – from cdi:Telephone",
 7      "$ref": "#/defs/dt-DateRange"
 8    },
 9    "isPreferred": {
10      "$comment": "cardinality 0..1 – from cdi:Telephone",
11      "$ref": "#/defs/xsd:boolean"
12    },
13    "privacy": {
14      "$comment": "cardinality 0..1 – from cdi:Telephone",
15      "$ref": "#/defs/dt-ControlledVocabularyEntry"
16    },
17    "telephoneNumber": {
18      "$comment": "cardinality 0..1 – from cdi:Telephone",
19      "$ref": "#/defs/xsd:string"
20    },
21    "typeOfTelephone": {
22      "$comment": "cardinality 0..1 – from cdi:Telephone",
23      "$ref": "#/defs/dt-ControlledVocabularyEntry"
24    },
25    "@type": {
26      "const": "Telephone"
27    }
28  },
29  "required": ["@type"],
30  "additionalProperties": false
31},

Fragment for the data type Telephone (main ontology)

 1# datatype Telephone
 2# based on the UML data type DDICDIModels::DDICDILibrary::DataTypes::StructuredDataTypes::Telephone
 3cdi:Telephone
 4  a rdfs:Class, owl:Class, ucmis:StructuredDataType;
 5  rdfs:label "Telephone";
 6  rdfs:comment "Definition\n============\nDetails of a telephone number including the number, type of telephone number, a privacy setting and an indication of whether this is the preferred contact number.\n\nExamples\n==========\n+12 345 67890123"@en;
 7  
 8  owl:hasKey (cdi:Telephone-effectiveDates cdi:Telephone-isPreferred cdi:Telephone-privacy cdi:Telephone-telephoneNumber cdi:Telephone-typeOfTelephone);
 9.
10
11cdi:Telephone-effectiveDates
12  a rdf:Property, owl:ObjectProperty, ucmis:Attribute;
13  rdfs:label "effectiveDates";
14  rdfs:comment "Time period during which the telephone number is valid."@en;
15  rdfs:domain cdi:Telephone;
16  rdfs:range cdi:DateRange;
17.
18
19cdi:Telephone-isPreferred
20  a rdf:Property, owl:DatatypeProperty, ucmis:Attribute;
21  rdfs:label "isPreferred";
22  rdfs:comment "Set to True if this is the preferred telephone number for contact."@en;
23  rdfs:domain cdi:Telephone;
24  rdfs:range xsd:boolean;
25.
26
27cdi:Telephone-privacy
28  a rdf:Property, owl:ObjectProperty, ucmis:Attribute;
29  rdfs:label "privacy";
30  rdfs:comment "Specify the level privacy for the telephone number as public, restricted, or private. Supports the use of an external controlled vocabulary."@en;
31  rdfs:domain cdi:Telephone;
32  rdfs:range cdi:ControlledVocabularyEntry;
33.
34
35cdi:Telephone-telephoneNumber
36  a rdf:Property, owl:DatatypeProperty, ucmis:Attribute;
37  rdfs:label "telephoneNumber";
38  rdfs:comment "The telephone number including country code if appropriate."@en;
39  rdfs:domain cdi:Telephone;
40  rdfs:range xsd:string;
41.
42
43cdi:Telephone-typeOfTelephone
44  a rdf:Property, owl:ObjectProperty, ucmis:Attribute;
45  rdfs:label "typeOfTelephone";
46  rdfs:comment "Indicates type of telephone number provided (home, fax, office, cell, etc.). Supports the use of a controlled vocabulary."@en;
47  rdfs:domain cdi:Telephone;
48  rdfs:range cdi:ControlledVocabularyEntry;
49.

Fragment for the data type Telephone (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      "effectiveDates": {
 8        "@id": "cdi:Telephone-effectiveDates",
 9        "@type": "@id",
10        "@context": "DateRange.jsonld"
11      },
12      "isPreferred": {
13        "@id": "cdi:Telephone-isPreferred",
14        "@type": "xsd:boolean"
15      },
16      "privacy": {
17        "@id": "cdi:Telephone-privacy",
18        "@type": "@id",
19        "@context": "ControlledVocabularyEntry.jsonld"
20      },
21      "telephoneNumber": {
22        "@id": "cdi:Telephone-telephoneNumber",
23        "@type": "xsd:string"
24      },
25      "typeOfTelephone": {
26        "@id": "cdi:Telephone-typeOfTelephone",
27        "@type": "@id",
28        "@context": "ControlledVocabularyEntry.jsonld"
29      },
30      
31      " comment ": "tag:json-should-support-trailing-commas" 
32    }
33  ],
34  "generatedBy": "This code was generated by the Eclipse Acceleo project UCMIS M2T on 2025-08-29 14:34:57.",
35  "basedOn": "based on the UML data type DDICDIModels::DDICDILibrary::DataTypes::StructuredDataTypes::Telephone"
36}

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

 1# datatype Telephone
 2# based on the UML data type DDICDIModels::DDICDILibrary::DataTypes::StructuredDataTypes::Telephone
 3<#Telephone> a sh:NodeShape;
 4    sh:targetClass cdi:Telephone;
 5	sh:message "See http://ddialliance.org/Specification/DDI-CDI/1.0/RDF/Telephone";
 6	sh:closed true;
 7	sh:ignoredProperties ( owl:sameAs );
 8    sh:property [
 9			sh:path rdf:type;
10			sh:in (   cdi:Telephone
11			 ) ;
12    ];
13    # attributes
14    sh:property <#Telephone-effectiveDates>;
15    sh:property <#Telephone-isPreferred>;
16    sh:property <#Telephone-privacy>;
17    sh:property <#Telephone-telephoneNumber>;
18    sh:property <#Telephone-typeOfTelephone>;
19
20
21
22.
23
24<#Telephone-effectiveDates> a sh:PropertyShape ;
25    sh:path cdi:Telephone-effectiveDates;
26    sh:node [ sh:property [ sh:path rdf:type; sh:minCount 1; sh:in (
27        cdi:DateRange
28      
29    ) ]];
30    sh:maxCount 1;
31.
32<#Telephone-isPreferred> a sh:PropertyShape ;
33    sh:path cdi:Telephone-isPreferred;
34    sh:datatype xsd:boolean;
35    sh:maxCount 1;
36.
37<#Telephone-privacy> a sh:PropertyShape ;
38    sh:path cdi:Telephone-privacy;
39    sh:node [ sh:property [ sh:path rdf:type; sh:minCount 1; sh:in (
40        cdi:ControlledVocabularyEntry
41      
42    ) ]];
43    sh:maxCount 1;
44.
45<#Telephone-telephoneNumber> a sh:PropertyShape ;
46    sh:path cdi:Telephone-telephoneNumber;
47    sh:datatype xsd:string;
48    sh:maxCount 1;
49.
50<#Telephone-typeOfTelephone> a sh:PropertyShape ;
51    sh:path cdi:Telephone-typeOfTelephone;
52    sh:node [ sh:property [ sh:path rdf:type; sh:minCount 1; sh:in (
53        cdi:ControlledVocabularyEntry
54      
55    ) ]];
56    sh:maxCount 1;
57.

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

 1# datatype Telephone
 2# based on the UML data type DDICDIModels::DDICDILibrary::DataTypes::StructuredDataTypes::Telephone
 3cdi:TelephoneShape CLOSED {
 4	a [cdi:Telephone];
 5	cdi:Telephone-effectiveDates	@cdi:DateRangeShape?;
 6	cdi:Telephone-isPreferred	xsd:boolean?;
 7	cdi:Telephone-privacy	@cdi:ControlledVocabularyEntryShape?;
 8	cdi:Telephone-telephoneNumber	xsd:string?;
 9	cdi:Telephone-typeOfTelephone	@cdi:ControlledVocabularyEntryShape?;
10	}