Release 5 Preview #3

This page is part of the FHIR Specification (v4.5.0: R5 Preview #3). The current version which supercedes this version is 5.0.0. For a full list of available versions, see the Directory of published versions . Page versions: R4B R4

Extension: extension

FHIR Infrastructure Work Group Maturity Level: 1InformativeUse Context: Any

URL for this extension:

http://hl7.org/fhir/StructureDefinition/contactpoint-extension

Status: draft. Extension maintained by: Health Level Seven, Inc. - FHIR Core WG

The number that may be dialed within a private phone network or after successfully connecting to a private phone network. This extension is used when a system wishes to designate specific parts of a phone number (and potentially place constraints on which components must be present and how they're filled in).

Comment:

The ContactPoint.value element SHOULD still be populated even if the extension is present.

Context of Use: Use on Element ID ContactPoint

Extension Content

Summary

NameFlagsCard.TypeDescription & Constraintsdoco
.. extension0..1stringURL = http://hl7.org/fhir/StructureDefinition/contactpoint-extension
extension: The number that may be dialed within a private phone network or after successfully connecting to a private phone network. This extension is used when a system wishes to designate specific parts of a phone number (and potentially place constraints on which components must be present and how they're filled in).


Use on Element ID ContactPoint

doco Documentation for this format

Full Structure

NameFlagsCard.TypeDescription & Constraintsdoco
.. extension0..1ExtensionURL = http://hl7.org/fhir/StructureDefinition/contactpoint-extension
extension: The number that may be dialed within a private phone network or after successfully connecting to a private phone network. This extension is used when a system wishes to designate specific parts of a phone number (and potentially place constraints on which components must be present and how they're filled in).


Use on Element ID ContactPoint
... extension I0..0
... url 1..1uri"http://hl7.org/fhir/StructureDefinition/contactpoint-extension"
... value[x] I1..1stringValue of extension

doco Documentation for this format

XML Template

<!-- extension -->doco

<extension xmlns="http://hl7.org/fhir"
     url="http://hl7.org/fhir/StructureDefinition/contactpoint-extension" >
  <!-- from Element: extension -->
 <valueString value="[string]"/><!-- ?? 1..1 Value of extension -->
</extension>

JSON Template

{ // extension
  // from Element: extension
    "extension" : [ //  sliced by value:url  in the specified order, Open ]
    "url" : "http://hl7.org/fhir/StructureDefinition/contactpoint-extension", // R! 
    "valueString" : "<string>" // C? R! Value of extension
  }

Summary

NameFlagsCard.TypeDescription & Constraintsdoco
.. extension0..1stringURL = http://hl7.org/fhir/StructureDefinition/contactpoint-extension
extension: The number that may be dialed within a private phone network or after successfully connecting to a private phone network. This extension is used when a system wishes to designate specific parts of a phone number (and potentially place constraints on which components must be present and how they're filled in).


Use on Element ID ContactPoint

doco Documentation for this format

Full Structure

NameFlagsCard.TypeDescription & Constraintsdoco
.. extension0..1ExtensionURL = http://hl7.org/fhir/StructureDefinition/contactpoint-extension
extension: The number that may be dialed within a private phone network or after successfully connecting to a private phone network. This extension is used when a system wishes to designate specific parts of a phone number (and potentially place constraints on which components must be present and how they're filled in).


Use on Element ID ContactPoint
... extension I0..0
... url 1..1uri"http://hl7.org/fhir/StructureDefinition/contactpoint-extension"
... value[x] I1..1stringValue of extension

doco Documentation for this format

XML Template

<!-- extension -->doco

<extension xmlns="http://hl7.org/fhir"
     url="http://hl7.org/fhir/StructureDefinition/contactpoint-extension" >
  <!-- from Element: extension -->
 <valueString value="[string]"/><!-- ?? 1..1 Value of extension -->
</extension>

JSON Template

{ // extension
  // from Element: extension
    "extension" : [ //  sliced by value:url  in the specified order, Open ]
    "url" : "http://hl7.org/fhir/StructureDefinition/contactpoint-extension", // R! 
    "valueString" : "<string>" // C? R! Value of extension
  }

 

Constraints

  • ele-1: All FHIR elements must have a @value or children (xpath: @value|f:*|h:div)
  • ext-1: Must have either extensions or value[x], not both (xpath: exists(f:extension)!=exists(f:*[starts-with(local-name(.), 'value')]))
  • ele-1: On Extension.extension: All FHIR elements must have a @value or children (xpath on Extension.extension: @value|f:*|h:div)
  • ext-1: On Extension.extension: Must have either extensions or value[x], not both (xpath on Extension.extension: exists(f:extension)!=exists(f:*[starts-with(local-name(.), "value")]))
  • ele-1: On Extension.value[x]: All FHIR elements must have a @value or children (xpath on Extension.value[x]: @value|f:*|h:div)