Release 4 5 Preview #1

This page is part of the FHIR Specification (v4.0.1: R4 - Mixed Normative and STU ) in it's permanent home (it will always be available at this URL). (v4.2.0: R5 Preview #1). 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 : 1 Informative Use 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

Extension Content

Summary

Name Flags Card. Type Description & Constraints doco
. . location-distance 0..1 Distance URL = 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

Name Flags Card. Type Description & Constraints doco
. . extension 0..1 Extension URL = 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 I 0..0
. . . url 1..1 uri "http://hl7.org/fhir/StructureDefinition/location-distance"
. . . value[x] I 1..1 Distance Value 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>

 <valueDistance><!-- ?? 1..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 } // C? R! Value of extension

  }

Summary

Name Flags Card. Type Description & Constraints doco
. . location-distance 0..1 Distance URL = 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

Name Flags Card. Type Description & Constraints doco
. . extension 0..1 Extension URL = 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 I 0..0
. . . url 1..1 uri "http://hl7.org/fhir/StructureDefinition/location-distance"
. . . value[x] I 1..1 Distance Value 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>

 <valueDistance><!-- ?? 1..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 } // 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 )