Extension: Geolocation

FHIR Infrastructure Work Group

Maturity Level: 1

Trial Use

Use Context: Any

Official URL: `http://hl7.org/fhir/StructureDefinition/geolocation`				Version: 5.0.0-snapshot3
draft as of 2013-12-05				Computable Name: Geolocation
Flags: Non-Modifier				OID: TBD

Context of Use: Use on Element ID Address

Definition

The absolute geographic location of the Location, expressed using the WGS84 datum (This is the same co-ordinate system used in KML).

Comment:

The extension can be further extended to include unique geolocation identifiers, confidence, altitude, etc.

Summary

Name	Card.	Type	Description & Constraints
Geolocation	0..1	Extension	URL = http://hl7.org/fhir/StructureDefinition/geolocation Geolocation: The absolute geographic location of the Location, expressed using the WGS84 datum (This is the same co-ordinate system used in KML). Use on Element ID Address
latitude	1..1	decimal	Latitude with WGS84 datum
longitude	1..1	decimal	Longitude with WGS84 datum
Documentation for this format

Full Structure

Name	Card.	Type	Description & Constraints
extension	0..1	Extension	URL = http://hl7.org/fhir/StructureDefinition/geolocation Geolocation: The absolute geographic location of the Location, expressed using the WGS84 datum (This is the same co-ordinate system used in KML). Use on Element ID Address
Slices for extension	0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
extension:latitude	1..1	Extension	Latitude with WGS84 datum
id	0..1	id	Unique id for inter-element referencing
extension	0..0
url	1..1	uri	"latitude"
value[x]	1..1	decimal	Value of extension
extension:longitude	1..1	Extension	Longitude with WGS84 datum
id	0..1	id	Unique id for inter-element referencing
extension	0..0
url	1..1	uri	"longitude"
value[x]	1..1	decimal	Value of extension
url	1..1	uri	"http://hl7.org/fhir/StructureDefinition/geolocation"
value[x]	0..0
Documentation for this format

XML Template

<!-- Geolocation -->

<extension xmlns="http://hl7.org/fhir"
     url="http://hl7.org/fhir/StructureDefinition/geolocation" >
 <-- extension sliced by value:url  in the specified orderOpen-->
 <extension url="latitude"> I 1..1 Extension  <!-- I 1..1 Latitude with WGS84 datum -->
  <valueDecimal value="[decimal]"/><!-- I 1..1 Value of extension -->
 </extension>
 <extension url="longitude"> I 1..1 Extension  <!-- I 1..1 Longitude with WGS84 datum -->
  <valueDecimal value="[decimal]"/><!-- I 1..1 Value of extension -->
 </extension>
</extension>

JSON Template

{ // Geolocation
    "extension" : [ //  sliced by value:url  in the specified order, Open 
      { // Latitude with WGS84 datum // I R! 
        // from Element: extension
        "extension" : [ //  sliced by value:url  in the specified order, Open ]
        "url" : "latitude", // R! 
        "valueDecimal" : <decimal> // I R! Value of extension
      },
      { // Longitude with WGS84 datum // I R! 
        // from Element: extension
        "extension" : [ //  sliced by value:url  in the specified order, Open ]
        "url" : "longitude", // R! 
        "valueDecimal" : <decimal> // I R! Value of extension
      }
    ],
    "extension" : [{ Extension }], // IAdditional content defined by implementations
    "extension" : { Extension }, // I R! Latitude with WGS84 datum
    "extension" : { Extension }, // I R! Longitude with WGS84 datum
    "url" : "http://hl7.org/fhir/StructureDefinition/geolocation" // R! 
  // value[x]: Value of extension: Prohibited
  }

Summary

Name	Card.	Type	Description & Constraints
Geolocation	0..1	Extension	URL = http://hl7.org/fhir/StructureDefinition/geolocation Geolocation: The absolute geographic location of the Location, expressed using the WGS84 datum (This is the same co-ordinate system used in KML). Use on Element ID Address
latitude	1..1	decimal	Latitude with WGS84 datum
longitude	1..1	decimal	Longitude with WGS84 datum
Documentation for this format

Full Structure

Name	Card.	Type	Description & Constraints
extension	0..1	Extension	URL = http://hl7.org/fhir/StructureDefinition/geolocation Geolocation: The absolute geographic location of the Location, expressed using the WGS84 datum (This is the same co-ordinate system used in KML). Use on Element ID Address
Slices for extension	0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
extension:latitude	1..1	Extension	Latitude with WGS84 datum
id	0..1	id	Unique id for inter-element referencing
extension	0..0
url	1..1	uri	"latitude"
value[x]	1..1	decimal	Value of extension
extension:longitude	1..1	Extension	Longitude with WGS84 datum
id	0..1	id	Unique id for inter-element referencing
extension	0..0
url	1..1	uri	"longitude"
value[x]	1..1	decimal	Value of extension
url	1..1	uri	"http://hl7.org/fhir/StructureDefinition/geolocation"
value[x]	0..0
Documentation for this format

XML Template

<!-- Geolocation -->

<extension xmlns="http://hl7.org/fhir"
     url="http://hl7.org/fhir/StructureDefinition/geolocation" >
 <-- extension sliced by value:url  in the specified orderOpen-->
 <extension url="latitude"> I 1..1 Extension  <!-- I 1..1 Latitude with WGS84 datum -->
  <valueDecimal value="[decimal]"/><!-- I 1..1 Value of extension -->
 </extension>
 <extension url="longitude"> I 1..1 Extension  <!-- I 1..1 Longitude with WGS84 datum -->
  <valueDecimal value="[decimal]"/><!-- I 1..1 Value of extension -->
 </extension>
</extension>

JSON Template

{ // Geolocation
    "extension" : [ //  sliced by value:url  in the specified order, Open 
      { // Latitude with WGS84 datum // I R! 
        // from Element: extension
        "extension" : [ //  sliced by value:url  in the specified order, Open ]
        "url" : "latitude", // R! 
        "valueDecimal" : <decimal> // I R! Value of extension
      },
      { // Longitude with WGS84 datum // I R! 
        // from Element: extension
        "extension" : [ //  sliced by value:url  in the specified order, Open ]
        "url" : "longitude", // R! 
        "valueDecimal" : <decimal> // I R! Value of extension
      }
    ],
    "extension" : [{ Extension }], // IAdditional content defined by implementations
    "extension" : { Extension }, // I R! Latitude with WGS84 datum
    "extension" : { Extension }, // I R! Longitude with WGS84 datum
    "url" : "http://hl7.org/fhir/StructureDefinition/geolocation" // R! 
  // value[x]: Value of extension: Prohibited
  }

Constraints

ele-1: All FHIR elements must have a @value or children (xpath: hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (xpath: extension.exists() != value.exists())
ele-1: On Extension.extension: All FHIR elements must have a @value or children (xpath on Extension.extension: hasValue() or (children().count() > id.count()))
ext-1: On Extension.extension: Must have either extensions or value[x], not both (xpath on Extension.extension: extension.exists() != value.exists())
ele-1: On Extension.extension: All FHIR elements must have a @value or children (xpath on Extension.extension: hasValue() or (children().count() > id.count()))
ext-1: On Extension.extension: Must have either extensions or value[x], not both (xpath on Extension.extension: extension.exists() != value.exists())
ele-1: On Extension.extension.extension: All FHIR elements must have a @value or children (xpath on Extension.extension.extension: hasValue() or (children().count() > id.count()))
ext-1: On Extension.extension.extension: Must have either extensions or value[x], not both (xpath on Extension.extension.extension: extension.exists() != value.exists())
ele-1: On Extension.extension.value[x]: All FHIR elements must have a @value or children (xpath on Extension.extension.value[x]: hasValue() or (children().count() > id.count()))
ele-1: On Extension.extension: All FHIR elements must have a @value or children (xpath on Extension.extension: hasValue() or (children().count() > id.count()))
ext-1: On Extension.extension: Must have either extensions or value[x], not both (xpath on Extension.extension: extension.exists() != value.exists())
ele-1: On Extension.extension.extension: All FHIR elements must have a @value or children (xpath on Extension.extension.extension: hasValue() or (children().count() > id.count()))
ext-1: On Extension.extension.extension: Must have either extensions or value[x], not both (xpath on Extension.extension.extension: extension.exists() != value.exists())
ele-1: On Extension.extension.value[x]: All FHIR elements must have a @value or children (xpath on Extension.extension.value[x]: hasValue() or (children().count() > id.count()))
ele-1: On Extension.value[x]: All FHIR elements must have a @value or children (xpath on Extension.value[x]: hasValue() or (children().count() > id.count()))

Search

No Search Extensions defined for this resource

Examples of this extension

No examples found.