Release 5 Draft Ballot

This page is part of the FHIR Specification (v4.6.0: R5 Draft Ballot). 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 R3 R2

Extension: preferredContact

Patient Administration Work Group Maturity Level: 1InformativeUse Context: Any

URL for this extension:

http://hl7.org/fhir/StructureDefinition/organization-preferredContact

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

This Contact is the preferred contact at this organization for the purpose of the contact

There can be multiple contacts on an Organizations record with this value set to true, but these should all have different purpose values.

Context of Use: Use on Element ID Organization.contact

Extension Content

Summary

NameFlagsCard.TypeDescription & Constraintsdoco
.. preferredContact0..1booleanURL = http://hl7.org/fhir/StructureDefinition/organization-preferredContact
preferredContact: This Contact is the preferred contact at this organization for the purpose of the contact



There can be multiple contacts on an Organizations record with this value set to true, but these should all have different purpose values.


Use on Element ID Organization.contact

doco Documentation for this format

Full Structure

NameFlagsCard.TypeDescription & Constraintsdoco
.. extension0..1ExtensionURL = http://hl7.org/fhir/StructureDefinition/organization-preferredContact
preferredContact: This Contact is the preferred contact at this organization for the purpose of the contact



There can be multiple contacts on an Organizations record with this value set to true, but these should all have different purpose values.


Use on Element ID Organization.contact
... extension 0..0
... url 1..1uri"http://hl7.org/fhir/StructureDefinition/organization-preferredContact"
... value[x] 1..1booleanValue of extension

doco Documentation for this format

XML Template

<!-- preferredContact -->doco

<extension xmlns="http://hl7.org/fhir"
     url="http://hl7.org/fhir/StructureDefinition/organization-preferredContact" >
  <!-- from Element: extension -->
 <valueBoolean value="[boolean]"/><!-- ?? 1..1 Value of extension -->
</extension>

JSON Template

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

Summary

NameFlagsCard.TypeDescription & Constraintsdoco
.. preferredContact0..1booleanURL = http://hl7.org/fhir/StructureDefinition/organization-preferredContact
preferredContact: This Contact is the preferred contact at this organization for the purpose of the contact



There can be multiple contacts on an Organizations record with this value set to true, but these should all have different purpose values.


Use on Element ID Organization.contact

doco Documentation for this format

Full Structure

NameFlagsCard.TypeDescription & Constraintsdoco
.. extension0..1ExtensionURL = http://hl7.org/fhir/StructureDefinition/organization-preferredContact
preferredContact: This Contact is the preferred contact at this organization for the purpose of the contact



There can be multiple contacts on an Organizations record with this value set to true, but these should all have different purpose values.


Use on Element ID Organization.contact
... extension 0..0
... url 1..1uri"http://hl7.org/fhir/StructureDefinition/organization-preferredContact"
... value[x] 1..1booleanValue of extension

doco Documentation for this format

XML Template

<!-- preferredContact -->doco

<extension xmlns="http://hl7.org/fhir"
     url="http://hl7.org/fhir/StructureDefinition/organization-preferredContact" >
  <!-- from Element: extension -->
 <valueBoolean value="[boolean]"/><!-- ?? 1..1 Value of extension -->
</extension>

JSON Template

{ // preferredContact
  // from Element: extension
    "extension" : [ //  sliced by value:url  in the specified order, Open ]
    "url" : "http://hl7.org/fhir/StructureDefinition/organization-preferredContact", // R! 
    "valueBoolean" : <boolean> // 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)