ContactPoint.xml 1 <?xml version="1.0" encoding="utf-8"?> 2 <StructureDefinition xmlns="http://hl7.org/fhir"> 3 <id value="ContactPoint" /> 4 <meta> 5 <lastUpdated value="2019-10-31T23:29:23.356+01:00" /> 6 </meta> 7 <extension url="http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status"> 8 <valueCode value="normative" /> 9 </extension> 10 <extension url="http://hl7.org/fhir/StructureDefinition/structuredefinition-normative-version"> 11 <valueCode value="4.0.0" /> 12 </extension> 13 <url value="http://hl7.org/fhir/StructureDefinition/ContactPoint" /> 14 <version value="4.0.1" /> 15 <name value="ContactPoint" /> 16 <status value="active" /> 17 <date value="2019-10-31T23:29:23.0000000+01:00" /> 18 <publisher value="HL7 FHIR Standard" /> 19 <contact> 20 <telecom> 21 <system value="url" /> 22 <value value="http://hl7.org/fhir" /> 23 </telecom> 24 </contact> 25 <description value="Base StructureDefinition for ContactPoint Type: Details for all kinds of technology mediated contact points for a person or organization, including telephone, email, etc." /> 26 <purpose value="Need to track phone, fax, mobile, sms numbers, email addresses, twitter tags, etc." /> 27 <fhirVersion value="4.0.1" /> 28 <mapping> 29 <identity value="v2" /> 30 <uri value="http://hl7.org/v2" /> 31 <name value="HL7 v2 Mapping" /> 32 </mapping> 33 <mapping> 34 <identity value="rim" /> 35 <uri value="http://hl7.org/v3" /> 36 <name value="RIM Mapping" /> 37 </mapping> 38 <mapping> 39 <identity value="servd" /> 40 <uri value="http://www.omg.org/spec/ServD/1.0/" /> 41 <name value="ServD" /> 42 </mapping> 43 <kind value="complex-type" /> 44 <abstract value="false" /> 45 <type value="ContactPoint" /> 46 <baseDefinition value="http://hl7.org/fhir/StructureDefinition/Element" /> 47 <derivation value="specialization" /> 48 <snapshot> 49 <element id="ContactPoint"> 50 <extension url="http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status"> 51 <valueCode value="normative" /> 52 </extension> 53 <extension url="http://hl7.org/fhir/StructureDefinition/structuredefinition-normative-version"> 54 <valueCode value="4.0.0" /> 55 </extension> 56 <path value="ContactPoint" /> 57 <short value="Details of a Technology mediated contact point (phone, fax, email, etc.)" /> 58 <definition value="Details for all kinds of technology mediated contact points for a person or organization, including telephone, email, etc." /> 59 <min value="0" /> 60 <max value="*" /> 61 <base> 62 <path value="ContactPoint" /> 63 <min value="0" /> 64 <max value="*" /> 65 </base> 66 <condition value="ele-1" /> 67 <constraint> 68 <key value="cpt-2" /> 69 <severity value="error" /> 70 <human value="A system is required if a value is provided." /> 71 <expression value="value.empty() or system.exists()" /> 72 <xpath value="not(exists(f:value)) or exists(f:system)" /> 73 </constraint> 74 <constraint> 75 <key value="ele-1" /> 76 <severity value="error" /> 77 <human value="All FHIR elements must have a @value or children" /> 78 <expression value="hasValue() or (children().count() > id.count())" /> 79 <xpath value="@value|f:*|h:div" /> 80 <source value="http://hl7.org/fhir/StructureDefinition/Element" /> 81 </constraint> 82 <isModifier value="false" /> 83 <mapping> 84 <identity value="rim" /> 85 <map value="n/a" /> 86 </mapping> 87 <mapping> 88 <identity value="v2" /> 89 <map value="XTN" /> 90 </mapping> 91 <mapping> 92 <identity value="rim" /> 93 <map value="TEL" /> 94 </mapping> 95 <mapping> 96 <identity value="servd" /> 97 <map value="ContactPoint" /> 98 </mapping> 99 </element> 100 <element id="ContactPoint.id"> 101 <path value="ContactPoint.id" /> 102 <representation value="xmlAttr" /> 103 <short value="Unique id for inter-element referencing" /> 104 <definition value="Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces." /> 105 <min value="0" /> 106 <max value="1" /> 107 <base> 108 <path value="Element.id" /> 109 <min value="0" /> 110 <max value="1" /> 111 </base> 112 <type> 113 <extension url="http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type"> 114 <valueUrl value="string" /> 115 </extension> 116 <code value="http://hl7.org/fhirpath/System.String" /> 117 </type> 118 <isModifier value="false" /> 119 <isSummary value="false" /> 120 <mapping> 121 <identity value="rim" /> 122 <map value="n/a" /> 123 </mapping> 124 </element> 125 <element id="ContactPoint.extension"> 126 <path value="ContactPoint.extension" /> 127 <slicing> 128 <discriminator> 129 <type value="value" /> 130 <path value="url" /> 131 </discriminator> 132 <description value="Extensions are always sliced by (at least) url" /> 133 <rules value="open" /> 134 </slicing> 135 <short value="Additional content defined by implementations" /> 136 <definition value="May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension." /> 137 <comment value="There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone." /> 138 <alias value="extensions" /> 139 <alias value="user content" /> 140 <min value="0" /> 141 <max value="*" /> 142 <base> 143 <path value="Element.extension" /> 144 <min value="0" /> 145 <max value="*" /> 146 </base> 147 <type> 148 <code value="Extension" /> 149 </type> 150 <constraint> 151 <key value="ele-1" /> 152 <severity value="error" /> 153 <human value="All FHIR elements must have a @value or children" /> 154 <expression value="hasValue() or (children().count() > id.count())" /> 155 <xpath value="@value|f:*|h:div" /> 156 <source value="http://hl7.org/fhir/StructureDefinition/Element" /> 157 </constraint> 158 <constraint> 159 <key value="ext-1" /> 160 <severity value="error" /> 161 <human value="Must have either extensions or value[x], not both" /> 162 <expression value="extension.exists() != value.exists()" /> 163 <xpath value="exists(f:extension)!=exists(f:*[starts-with(local-name(.), "value")])" /> 164 <source value="http://hl7.org/fhir/StructureDefinition/Extension" /> 165 </constraint> 166 <isModifier value="false" /> 167 <isSummary value="false" /> 168 <mapping> 169 <identity value="rim" /> 170 <map value="n/a" /> 171 </mapping> 172 </element> 173 <element id="ContactPoint.system"> 174 <path value="ContactPoint.system" /> 175 <short value="phone | fax | email | pager | url | sms | other" /> 176 <definition value="Telecommunications form for contact point - what communications system is required to make use of the contact." /> 177 <min value="0" /> 178 <max value="1" /> 179 <base> 180 <path value="ContactPoint.system" /> 181 <min value="0" /> 182 <max value="1" /> 183 </base> 184 <type> 185 <code value="code" /> 186 </type> 187 <condition value="cpt-2" /> 188 <constraint> 189 <key value="ele-1" /> 190 <severity value="error" /> 191 <human value="All FHIR elements must have a @value or children" /> 192 <expression value="hasValue() or (children().count() > id.count())" /> 193 <xpath value="@value|f:*|h:div" /> 194 <source value="http://hl7.org/fhir/StructureDefinition/Element" /> 195 </constraint> 196 <isModifier value="false" /> 197 <isSummary value="true" /> 198 <binding> 199 <extension url="http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName"> 200 <valueString value="ContactPointSystem" /> 201 </extension> 202 <strength value="required" /> 203 <description value="Telecommunications form for contact point." /> 204 <valueSet value="http://hl7.org/fhir/ValueSet/contact-point-system|4.0.1" /> 205 </binding> 206 <mapping> 207 <identity value="v2" /> 208 <map value="XTN.3" /> 209 </mapping> 210 <mapping> 211 <identity value="rim" /> 212 <map value="./scheme" /> 213 </mapping> 214 <mapping> 215 <identity value="servd" /> 216 <map value="./ContactPointType" /> 217 </mapping> 218 </element> 219 <element id="ContactPoint.value"> 220 <path value="ContactPoint.value" /> 221 <short value="The actual contact point details" /> 222 <definition value="The actual contact point details, in a form that is meaningful to the designated communication system (i.e. phone number or email address)." /> 223 <comment value="Additional text data such as phone extension numbers, or notes about use of the contact are sometimes included in the value." /> 224 <requirements value="Need to support legacy numbers that are not in a tightly controlled format." /> 225 <min value="0" /> 226 <max value="1" /> 227 <base> 228 <path value="ContactPoint.value" /> 229 <min value="0" /> 230 <max value="1" /> 231 </base> 232 <type> 233 <code value="string" /> 234 </type> 235 <constraint> 236 <key value="ele-1" /> 237 <severity value="error" /> 238 <human value="All FHIR elements must have a @value or children" /> 239 <expression value="hasValue() or (children().count() > id.count())" /> 240 <xpath value="@value|f:*|h:div" /> 241 <source value="http://hl7.org/fhir/StructureDefinition/Element" /> 242 </constraint> 243 <isModifier value="false" /> 244 <isSummary value="true" /> 245 <mapping> 246 <identity value="v2" /> 247 <map value="XTN.1 (or XTN.12)" /> 248 </mapping> 249 <mapping> 250 <identity value="rim" /> 251 <map value="./url" /> 252 </mapping> 253 <mapping> 254 <identity value="servd" /> 255 <map value="./Value" /> 256 </mapping> 257 </element> 258 <element id="ContactPoint.use"> 259 <path value="ContactPoint.use" /> 260 <short value="home | work | temp | old | mobile - purpose of this contact point" /> 261 <definition value="Identifies the purpose for the contact point." /> 262 <comment value="Applications can assume that a contact is current unless it explicitly says that it is temporary or old." /> 263 <requirements value="Need to track the way a person uses this contact, so a user can choose which is appropriate for their purpose." /> 264 <min value="0" /> 265 <max value="1" /> 266 <base> 267 <path value="ContactPoint.use" /> 268 <min value="0" /> 269 <max value="1" /> 270 </base> 271 <type> 272 <code value="code" /> 273 </type> 274 <constraint> 275 <key value="ele-1" /> 276 <severity value="error" /> 277 <human value="All FHIR elements must have a @value or children" /> 278 <expression value="hasValue() or (children().count() > id.count())" /> 279 <xpath value="@value|f:*|h:div" /> 280 <source value="http://hl7.org/fhir/StructureDefinition/Element" /> 281 </constraint> 282 <isModifier value="true" /> 283 <isModifierReason value="This is labeled as "Is Modifier" because applications should not mistake a temporary or old contact etc.for a current/permanent one" /> 284 <isSummary value="true" /> 285 <binding> 286 <extension url="http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName"> 287 <valueString value="ContactPointUse" /> 288 </extension> 289 <strength value="required" /> 290 <description value="Use of contact point." /> 291 <valueSet value="http://hl7.org/fhir/ValueSet/contact-point-use|4.0.1" /> 292 </binding> 293 <mapping> 294 <identity value="v2" /> 295 <map value="XTN.2 - but often indicated by field" /> 296 </mapping> 297 <mapping> 298 <identity value="rim" /> 299 <map value="unique(./use)" /> 300 </mapping> 301 <mapping> 302 <identity value="servd" /> 303 <map value="./ContactPointPurpose" /> 304 </mapping> 305 </element> 306 <element id="ContactPoint.rank"> 307 <path value="ContactPoint.rank" /> 308 <short value="Specify preferred order of use (1 = highest)" /> 309 <definition value="Specifies a preferred order in which to use a set of contacts. ContactPoints with lower rank values are more preferred than those with higher rank values." /> 310 <comment value="Note that rank does not necessarily follow the order in which the contacts are represented in the instance." /> 311 <min value="0" /> 312 <max value="1" /> 313 <base> 314 <path value="ContactPoint.rank" /> 315 <min value="0" /> 316 <max value="1" /> 317 </base> 318 <type> 319 <code value="positiveInt" /> 320 </type> 321 <constraint> 322 <key value="ele-1" /> 323 <severity value="error" /> 324 <human value="All FHIR elements must have a @value or children" /> 325 <expression value="hasValue() or (children().count() > id.count())" /> 326 <xpath value="@value|f:*|h:div" /> 327 <source value="http://hl7.org/fhir/StructureDefinition/Element" /> 328 </constraint> 329 <isModifier value="false" /> 330 <isSummary value="true" /> 331 <mapping> 332 <identity value="v2" /> 333 <map value="n/a" /> 334 </mapping> 335 <mapping> 336 <identity value="rim" /> 337 <map value="n/a" /> 338 </mapping> 339 </element> 340 <element id="ContactPoint.period"> 341 <path value="ContactPoint.period" /> 342 <short value="Time period when the contact point was/is in use" /> 343 <definition value="Time period when the contact point was/is in use." /> 344 <min value="0" /> 345 <max value="1" /> 346 <base> 347 <path value="ContactPoint.period" /> 348 <min value="0" /> 349 <max value="1" /> 350 </base> 351 <type> 352 <code value="Period" /> 353 </type> 354 <constraint> 355 <key value="ele-1" /> 356 <severity value="error" /> 357 <human value="All FHIR elements must have a @value or children" /> 358 <expression value="hasValue() or (children().count() > id.count())" /> 359 <xpath value="@value|f:*|h:div" /> 360 <source value="http://hl7.org/fhir/StructureDefinition/Element" /> 361 </constraint> 362 <isModifier value="false" /> 363 <isSummary value="true" /> 364 <mapping> 365 <identity value="v2" /> 366 <map value="N/A" /> 367 </mapping> 368 <mapping> 369 <identity value="rim" /> 370 <map value="./usablePeriod[type="IVL<TS>"]" /> 371 </mapping> 372 <mapping> 373 <identity value="servd" /> 374 <map value="./StartDate and ./EndDate" /> 375 </mapping> 376 </element> 377 </snapshot> 378 <differential> 379 <element id="ContactPoint"> 380 <extension url="http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status"> 381 <valueCode value="normative" /> 382 </extension> 383 <extension url="http://hl7.org/fhir/StructureDefinition/structuredefinition-normative-version"> 384 <valueCode value="4.0.0" /> 385 </extension> 386 <path value="ContactPoint" /> 387 <short value="Details of a Technology mediated contact point (phone, fax, email, etc.)" /> 388 <definition value="Details for all kinds of technology mediated contact points for a person or organization, including telephone, email, etc." /> 389 <min value="0" /> 390 <max value="*" /> 391 <constraint> 392 <key value="cpt-2" /> 393 <severity value="error" /> 394 <human value="A system is required if a value is provided." /> 395 <expression value="value.empty() or system.exists()" /> 396 <xpath value="not(exists(f:value)) or exists(f:system)" /> 397 </constraint> 398 <mapping> 399 <identity value="v2" /> 400 <map value="XTN" /> 401 </mapping> 402 <mapping> 403 <identity value="rim" /> 404 <map value="TEL" /> 405 </mapping> 406 <mapping> 407 <identity value="servd" /> 408 <map value="ContactPoint" /> 409 </mapping> 410 </element> 411 <element id="ContactPoint.system"> 412 <path value="ContactPoint.system" /> 413 <short value="phone | fax | email | pager | url | sms | other" /> 414 <definition value="Telecommunications form for contact point - what communications system is required to make use of the contact." /> 415 <min value="0" /> 416 <max value="1" /> 417 <type> 418 <code value="code" /> 419 </type> 420 <condition value="cpt-2" /> 421 <isSummary value="true" /> 422 <binding> 423 <extension url="http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName"> 424 <valueString value="ContactPointSystem" /> 425 </extension> 426 <strength value="required" /> 427 <description value="Telecommunications form for contact point." /> 428 <valueSet value="http://hl7.org/fhir/ValueSet/contact-point-system|4.0.1" /> 429 </binding> 430 <mapping> 431 <identity value="v2" /> 432 <map value="XTN.3" /> 433 </mapping> 434 <mapping> 435 <identity value="rim" /> 436 <map value="./scheme" /> 437 </mapping> 438 <mapping> 439 <identity value="servd" /> 440 <map value="./ContactPointType" /> 441 </mapping> 442 </element> 443 <element id="ContactPoint.value"> 444 <path value="ContactPoint.value" /> 445 <short value="The actual contact point details" /> 446 <definition value="The actual contact point details, in a form that is meaningful to the designated communication system (i.e. phone number or email address)." /> 447 <comment value="Additional text data such as phone extension numbers, or notes about use of the contact are sometimes included in the value." /> 448 <requirements value="Need to support legacy numbers that are not in a tightly controlled format." /> 449 <min value="0" /> 450 <max value="1" /> 451 <type> 452 <code value="string" /> 453 </type> 454 <isSummary value="true" /> 455 <mapping> 456 <identity value="v2" /> 457 <map value="XTN.1 (or XTN.12)" /> 458 </mapping> 459 <mapping> 460 <identity value="rim" /> 461 <map value="./url" /> 462 </mapping> 463 <mapping> 464 <identity value="servd" /> 465 <map value="./Value" /> 466 </mapping> 467 </element> 468 <element id="ContactPoint.use"> 469 <path value="ContactPoint.use" /> 470 <short value="home | work | temp | old | mobile - purpose of this contact point" /> 471 <definition value="Identifies the purpose for the contact point." /> 472 <comment value="Applications can assume that a contact is current unless it explicitly says that it is temporary or old." /> 473 <requirements value="Need to track the way a person uses this contact, so a user can choose which is appropriate for their purpose." /> 474 <min value="0" /> 475 <max value="1" /> 476 <type> 477 <code value="code" /> 478 </type> 479 <isModifier value="true" /> 480 <isModifierReason value="This is labeled as "Is Modifier" because applications should not mistake a temporary or old contact etc.for a current/permanent one" /> 481 <isSummary value="true" /> 482 <binding> 483 <extension url="http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName"> 484 <valueString value="ContactPointUse" /> 485 </extension> 486 <strength value="required" /> 487 <description value="Use of contact point." /> 488 <valueSet value="http://hl7.org/fhir/ValueSet/contact-point-use|4.0.1" /> 489 </binding> 490 <mapping> 491 <identity value="v2" /> 492 <map value="XTN.2 - but often indicated by field" /> 493 </mapping> 494 <mapping> 495 <identity value="rim" /> 496 <map value="unique(./use)" /> 497 </mapping> 498 <mapping> 499 <identity value="servd" /> 500 <map value="./ContactPointPurpose" /> 501 </mapping> 502 </element> 503 <element id="ContactPoint.rank"> 504 <path value="ContactPoint.rank" /> 505 <short value="Specify preferred order of use (1 = highest)" /> 506 <definition value="Specifies a preferred order in which to use a set of contacts. ContactPoints with lower rank values are more preferred than those with higher rank values." /> 507 <comment value="Note that rank does not necessarily follow the order in which the contacts are represented in the instance." /> 508 <min value="0" /> 509 <max value="1" /> 510 <type> 511 <code value="positiveInt" /> 512 </type> 513 <isSummary value="true" /> 514 <mapping> 515 <identity value="v2" /> 516 <map value="n/a" /> 517 </mapping> 518 <mapping> 519 <identity value="rim" /> 520 <map value="n/a" /> 521 </mapping> 522 </element> 523 <element id="ContactPoint.period"> 524 <path value="ContactPoint.period" /> 525 <short value="Time period when the contact point was/is in use" /> 526 <definition value="Time period when the contact point was/is in use." /> 527 <min value="0" /> 528 <max value="1" /> 529 <type> 530 <code value="Period" /> 531 </type> 532 <isSummary value="true" /> 533 <mapping> 534 <identity value="v2" /> 535 <map value="N/A" /> 536 </mapping> 537 <mapping> 538 <identity value="rim" /> 539 <map value="./usablePeriod[type="IVL<TS>"]" /> 540 </mapping> 541 <mapping> 542 <identity value="servd" /> 543 <map value="./StartDate and ./EndDate" /> 544 </mapping> 545 </element> 546 </differential> 547 </StructureDefinition>