Telephone¶
Fully qualified datatype name: 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
Attributes
Name |
Inherited from |
Description |
Data Type |
Multiplicity |
Default value |
|---|---|---|---|---|---|
effectiveDates |
- own datatype - |
Time period during which the telephone number is valid. |
0..1 |
||
isPreferred |
- own datatype - |
Set to True if this is the preferred telephone number for contact. |
Boolean |
0..1 |
|
privacy |
- own datatype - |
Specify the level privacy for the telephone number as public, restricted, or private. Supports the use of an external controlled vocabulary. |
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. |
0..1 |
Usage
Type |
Package |
Classifier |
Attribute |
|---|---|---|---|
DataType |
StructuredDataTypes |
telephone |
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 XMI model)
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-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 <type href="http://www.eclipse.org/uml2/5.0.0/UML/PrimitiveTypes.xmi#Boolean"
59 xmi:type="uml:PrimitiveType"/>
60 </ownedAttribute>
61 <ownedAttribute xmi:id="DDICDIModels-DDICDILibrary-DataTypes-StructuredDataTypes-Telephone-privacy"
62 xmi:uuid="http://ddialliance.org/Specification/DDI-CDI/1.0/XMI/#Telephone-privacy"
63 xmi:type="uml:Property">
64 <ownedComment xmi:id="DDICDIModels-DDICDILibrary-DataTypes-StructuredDataTypes-Telephone-privacy-ownedComment"
65 xmi:uuid="http://ddialliance.org/Specification/DDI-CDI/1.0/XMI/#Telephone-privacy-ownedComment"
66 xmi:type="uml:Comment">
67 <annotatedElement xmi:idref="DDICDIModels-DDICDILibrary-DataTypes-StructuredDataTypes-Telephone-privacy"/>
68 <body>Specify the level privacy for the telephone number as public, restricted, or private. Supports the use of an external controlled vocabulary.</body>
69 </ownedComment>
70 <lowerValue xmi:id="DDICDIModels-DDICDILibrary-DataTypes-StructuredDataTypes-Telephone-privacy-lowerValue"
71 xmi:uuid="http://ddialliance.org/Specification/DDI-CDI/1.0/XMI/#Telephone-privacy-lowerValue"
72 xmi:type="uml:LiteralInteger"/>
73 <upperValue xmi:id="DDICDIModels-DDICDILibrary-DataTypes-StructuredDataTypes-Telephone-privacy-upperValue"
74 xmi:uuid="http://ddialliance.org/Specification/DDI-CDI/1.0/XMI/#Telephone-privacy-upperValue"
75 xmi:type="uml:LiteralUnlimitedNatural">
76 <value>1</value>
77 </upperValue>
78 <name>privacy</name>
79 <type xmi:idref="DDICDIModels-DDICDILibrary-DataTypes-StructuredDataTypes-ControlledVocabularyEntry"/>
80 </ownedAttribute>
81 <ownedAttribute xmi:id="DDICDIModels-DDICDILibrary-DataTypes-StructuredDataTypes-Telephone-telephoneNumber"
82 xmi:uuid="http://ddialliance.org/Specification/DDI-CDI/1.0/XMI/#Telephone-telephoneNumber"
83 xmi:type="uml:Property">
84 <ownedComment xmi:id="DDICDIModels-DDICDILibrary-DataTypes-StructuredDataTypes-Telephone-telephoneNumber-ownedComment"
85 xmi:uuid="http://ddialliance.org/Specification/DDI-CDI/1.0/XMI/#Telephone-telephoneNumber-ownedComment"
86 xmi:type="uml:Comment">
87 <annotatedElement xmi:idref="DDICDIModels-DDICDILibrary-DataTypes-StructuredDataTypes-Telephone-telephoneNumber"/>
88 <body>The telephone number including country code if appropriate.</body>
89 </ownedComment>
90 <lowerValue xmi:id="DDICDIModels-DDICDILibrary-DataTypes-StructuredDataTypes-Telephone-telephoneNumber-lowerValue"
91 xmi:uuid="http://ddialliance.org/Specification/DDI-CDI/1.0/XMI/#Telephone-telephoneNumber-lowerValue"
92 xmi:type="uml:LiteralInteger"/>
93 <upperValue xmi:id="DDICDIModels-DDICDILibrary-DataTypes-StructuredDataTypes-Telephone-telephoneNumber-upperValue"
94 xmi:uuid="http://ddialliance.org/Specification/DDI-CDI/1.0/XMI/#Telephone-telephoneNumber-upperValue"
95 xmi:type="uml:LiteralUnlimitedNatural">
96 <value>1</value>
97 </upperValue>
98 <name>telephoneNumber</name>
99 <type href="http://www.eclipse.org/uml2/5.0.0/UML/PrimitiveTypes.xmi#String"
100 xmi:type="uml:PrimitiveType"/>
101 </ownedAttribute>
102 <ownedAttribute xmi:id="DDICDIModels-DDICDILibrary-DataTypes-StructuredDataTypes-Telephone-typeOfTelephone"
103 xmi:uuid="http://ddialliance.org/Specification/DDI-CDI/1.0/XMI/#Telephone-typeOfTelephone"
104 xmi:type="uml:Property">
105 <ownedComment xmi:id="DDICDIModels-DDICDILibrary-DataTypes-StructuredDataTypes-Telephone-typeOfTelephone-ownedComment"
106 xmi:uuid="http://ddialliance.org/Specification/DDI-CDI/1.0/XMI/#Telephone-typeOfTelephone-ownedComment"
107 xmi:type="uml:Comment">
108 <annotatedElement xmi:idref="DDICDIModels-DDICDILibrary-DataTypes-StructuredDataTypes-Telephone-typeOfTelephone"/>
109 <body>Indicates type of telephone number provided (home, fax, office, cell, etc.). Supports the use of a controlled vocabulary.</body>
110 </ownedComment>
111 <lowerValue xmi:id="DDICDIModels-DDICDILibrary-DataTypes-StructuredDataTypes-Telephone-typeOfTelephone-lowerValue"
112 xmi:uuid="http://ddialliance.org/Specification/DDI-CDI/1.0/XMI/#Telephone-typeOfTelephone-lowerValue"
113 xmi:type="uml:LiteralInteger"/>
114 <upperValue xmi:id="DDICDIModels-DDICDILibrary-DataTypes-StructuredDataTypes-Telephone-typeOfTelephone-upperValue"
115 xmi:uuid="http://ddialliance.org/Specification/DDI-CDI/1.0/XMI/#Telephone-typeOfTelephone-upperValue"
116 xmi:type="uml:LiteralUnlimitedNatural">
117 <value>1</value>
118 </upperValue>
119 <name>typeOfTelephone</name>
120 <type xmi:idref="DDICDIModels-DDICDILibrary-DataTypes-StructuredDataTypes-ControlledVocabularyEntry"/>
121 </ownedAttribute>
122</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 (main ontology, entire ontology as zip)
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 (main JSON-LD entire JSON-LD as zip)
1{
2 "@context": [
3 {
4 "cdi": "http://ddialliance.org/Specification/DDI-CDI/1.0/RDF/",
5 "xsd": "http://www.w3.org/2001/XMLSchema#",
6 "Telephone": "cdi:Telephone",
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 2024-03-16 23:40:14.",
35 "basedOn": "based on the UML data type DDICDIModels::DDICDILibrary::DataTypes::StructuredDataTypes::Telephone"
36}
