R4 Ballot #2 (Mixed Normative/Trial use)

This page is part of the FHIR Specification (v3.5.0: R4 Ballot #2). 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

Extension: location-distance

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

URL for this extension: 

http://hl7.org/fhir/StructureDefinition/location-distance

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

A calculated distance between the resource and a provided location.

Comment:

This may be used with the Location.near/near-distance search parameter.

Context of Use: Use on Element ID Bundle.entry.search

usage info: insert a list of places where this extension is used

Extension Content

Summary

NameFlagsCard.TypeDescription & Constraintsdoco
.. location-distance0..1DistanceURL = http://hl7.org/fhir/StructureDefinition/location-distance
location-distance: A calculated distance between the resource and a provided location.


Use on Element ID Bundle.entry.search

doco Documentation for this format

Full Structure

NameFlagsCard.TypeDescription & Constraintsdoco
.. extension0..1ExtensionURL = http://hl7.org/fhir/StructureDefinition/location-distance
location-distance: A calculated distance between the resource and a provided location.


Use on Element ID Bundle.entry.search
... extension 0..0
... url 1..1uri"http://hl7.org/fhir/StructureDefinition/location-distance"
... valueDistance 0..1DistanceValue of extension

doco Documentation for this format

XML Template

<!-- location-distance -->doco

<extension xmlns="http://hl7.org/fhir"
     url="http://hl7.org/fhir/StructureDefinition/location-distance" >
  <!-- from Element: extension -->
 <valueDistance><!-- 0..1 Distance Value of extension --></valueDistance>
</extension>

JSON Template

{ // location-distance
  // from Element: extension
    "extension" : [ //  sliced by value:url  in the specified order, Open ]
    "url" : "http://hl7.org/fhir/StructureDefinition/location-distance", // R! 
    "valueDistance" : { Distance } //Value of extension
  }

Summary

NameFlagsCard.TypeDescription & Constraintsdoco
.. location-distance0..1DistanceURL = http://hl7.org/fhir/StructureDefinition/location-distance
location-distance: A calculated distance between the resource and a provided location.


Use on Element ID Bundle.entry.search

doco Documentation for this format

Full Structure

NameFlagsCard.TypeDescription & Constraintsdoco
.. extension0..1ExtensionURL = http://hl7.org/fhir/StructureDefinition/location-distance
location-distance: A calculated distance between the resource and a provided location.


Use on Element ID Bundle.entry.search
... extension 0..0
... url 1..1uri"http://hl7.org/fhir/StructureDefinition/location-distance"
... valueDistance 0..1DistanceValue of extension

doco Documentation for this format

XML Template

<!-- location-distance -->doco

<extension xmlns="http://hl7.org/fhir"
     url="http://hl7.org/fhir/StructureDefinition/location-distance" >
  <!-- from Element: extension -->
 <valueDistance><!-- 0..1 Distance Value of extension --></valueDistance>
</extension>

JSON Template

{ // location-distance
  // from Element: extension
    "extension" : [ //  sliced by value:url  in the specified order, Open ]
    "url" : "http://hl7.org/fhir/StructureDefinition/location-distance", // R! 
    "valueDistance" : { Distance } //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')]))