FHIR Extensions Pack
5.3.0-ballot-tc1 - (September 2025 Ballot) International flag

FHIR Extensions Pack, published by HL7 International / FHIR Infrastructure. This guide is not an authorized publication; it is the continuous build for version 5.3.0-ballot-tc1 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/HL7/fhir-extensions/ and changes regularly. See the Directory of published versions

Extension: Bundle Location Distance

Official URL: http://hl7.org/fhir/StructureDefinition/location-distance Version: 5.3.0-ballot-tc1
Standards status: Trial-use Maturity Level: 3 Computable Name: BundleLocationDistance
Other Identifiers: OID:2.16.840.1.113883.4.642.5.1155

This extension is only applicable to searchset Bundles. It is the result of a search on Location using the "near" parameter indicating the calculated distance between the geographic location of this Location resource and the geographic location provided in the search query.

This distance does not consider a location boundary extension if it exists on the resource.

If multiple near positions are included in the search query, the distance to the closest point provided may be included.

Context of Use

This extension may be used on the following element(s)

Usage info

Usages:

  • This Extension is not used by any profiles in this Implementation Guide

You can also check for usages in the FHIR IG Statistics

Changes since version 5.2.0:

  • No changes

    • Formal Views of Extension Content

    Description of Profiles, Differentials, Snapshots, and how the XML and JSON presentations work.

    This structure is derived from Extension

    Summary

    Simple Extension with the type Distance: This extension is only applicable to searchset Bundles. It is the result of a search on Location using the "near" parameter indicating the calculated distance between the geographic location of this Location resource and the geographic location provided in the search query.

    This distance does not consider a location boundary extension if it exists on the resource.

    If multiple near positions are included in the search query, the distance to the closest point provided may be included.

    Maturity: 3

    This structure is derived from Extension

    NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
    .. Extension 0..1 Extension The distance this resource is from a provided location (geocode point)
    ... extension 0..0
    ... url 1..1 uri "http://hl7.org/fhir/StructureDefinition/location-distance"
    ... value[x] 1..1 Distance Value of extension

    doco Documentation for this format
    NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
    .. Extension 0..1 Extension The distance this resource is from a provided location (geocode point)
    ... id 0..1 id Unique id for inter-element referencing
    ... extension 0..0
    ... url 1..1 uri "http://hl7.org/fhir/StructureDefinition/location-distance"

    doco Documentation for this format

    This structure is derived from Extension

    Summary

    Simple Extension with the type Distance: This extension is only applicable to searchset Bundles. It is the result of a search on Location using the "near" parameter indicating the calculated distance between the geographic location of this Location resource and the geographic location provided in the search query.

    This distance does not consider a location boundary extension if it exists on the resource.

    If multiple near positions are included in the search query, the distance to the closest point provided may be included.

    Maturity: 3

    Differential View

    This structure is derived from Extension

    NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
    .. Extension 0..1 Extension The distance this resource is from a provided location (geocode point)
    ... extension 0..0
    ... url 1..1 uri "http://hl7.org/fhir/StructureDefinition/location-distance"
    ... value[x] 1..1 Distance Value of extension

    doco Documentation for this format

    Snapshot View

    NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
    .. Extension 0..1 Extension The distance this resource is from a provided location (geocode point)
    ... id 0..1 id Unique id for inter-element referencing
    ... extension 0..0
    ... url 1..1 uri "http://hl7.org/fhir/StructureDefinition/location-distance"

    doco Documentation for this format

     

    Other representations of profile: CSV, Excel, Schematron

    Constraints

    IdGradePath(s)DetailsRequirements
    ele-1error**ALL** elementsAll FHIR elements must have a @value or children
    : hasValue() or (children().count() > id.count())
    ext-1error**ALL** extensionsMust have either extensions or value[x], not both
    : extension.exists() != value.exists()

    R4B

    The extension is not used in R4B

    • Duplicate Resource http://hl7.org/fhir/StructureDefinition/location-distance of type StructureDefinition (existing version 4.3.0, new version 5.3.0-ballot-tc1)

    R4

    The extension is not used in R4

    • Duplicate Resource http://hl7.org/fhir/StructureDefinition/location-distance of type StructureDefinition (existing version 4.0.1, new version 5.3.0-ballot-tc1)

    R3

    The extension is not used in R3

    • Duplicate Resource http://hl7.org/fhir/StructureDefinition/location-distance of type StructureDefinition (existing version null, new version 5.3.0-ballot-tc1)

    Search Parameters for this Extension

    (none found)