Release 5 Ballot

This page is part of the FHIR Specification (v5.0.0-ballot: FHIR R5 Ballot Preview). 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: Geolocation

FHIR Infrastructure Work Group

Maturity Level: 1

Informative

Use Context: Any

Summary

Defining URL: http://hl7.org/fhir/StructureDefinition/geolocation

Version: 5.0.0-ballot

Name: Geolocation

Title: Geolocation

Modifier: This extension is not a modifier extension

Status: draft

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

Committee: FHIR Infrastructure Work Group

Status: draft. Extension maintained by: Health Level Seven International (FHIR Infrastructure)

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.

Context of Use: Use on Element ID Address

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. The value domain and the interpretation are the same as for the text of the latitude element in KML (see notes below).
longitude	1..1	decimal	Longitude. The value domain and the interpretation are the same as for the text of the longitude element in KML (see notes below).
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
valueBase64Binary		base64Binary
valueBoolean		boolean
valueCanonical		canonical(Any)
valueCode		code
valueDate		date
valueDateTime		dateTime
valueDecimal		decimal
valueId		id
valueInstant		instant
valueInteger		integer
valueInteger64		integer64
valueMarkdown		markdown
valueOid		oid
valuePositiveInt		positiveInt
valueString		string
valueTime		time
valueUnsignedInt		unsignedInt
valueUri		uri
valueUrl		url
valueUuid		uuid
valueAddress		Address
valueAge		Age
valueAnnotation		Annotation
valueAttachment		Attachment
valueCodeableConcept		CodeableConcept
valueCodeableReference		CodeableReference
valueCoding		Coding
valueContactPoint		ContactPoint
valueCount		Count
valueDistance		Distance
valueDuration		Duration
valueHumanName		HumanName
valueIdentifier		Identifier
valueMoney		Money
valuePeriod		Period
valueQuantity		Quantity
valueRange		Range
valueRatio		Ratio
valueRatioRange		RatioRange
valueReference		Reference(Any)
valueSampledData		SampledData
valueSignature		Signature
valueTiming		Timing
valueContactDetail		ContactDetail
valueDataRequirement		DataRequirement
valueExpression		Expression
valueParameterDefinition		ParameterDefinition
valueRelatedArtifact		RelatedArtifact
valueTriggerDefinition		TriggerDefinition
valueUsageContext		UsageContext
valueAvailability		Availability
valueExtendedContactDetail		ExtendedContactDetail
valueDosage		Dosage
valueMeta		Meta
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. The value domain and the interpretation are the same as for the text of the latitude element in KML (see notes below).
longitude	1..1	decimal	Longitude. The value domain and the interpretation are the same as for the text of the longitude element in KML (see notes below).
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
valueBase64Binary		base64Binary
valueBoolean		boolean
valueCanonical		canonical(Any)
valueCode		code
valueDate		date
valueDateTime		dateTime
valueDecimal		decimal
valueId		id
valueInstant		instant
valueInteger		integer
valueInteger64		integer64
valueMarkdown		markdown
valueOid		oid
valuePositiveInt		positiveInt
valueString		string
valueTime		time
valueUnsignedInt		unsignedInt
valueUri		uri
valueUrl		url
valueUuid		uuid
valueAddress		Address
valueAge		Age
valueAnnotation		Annotation
valueAttachment		Attachment
valueCodeableConcept		CodeableConcept
valueCodeableReference		CodeableReference
valueCoding		Coding
valueContactPoint		ContactPoint
valueCount		Count
valueDistance		Distance
valueDuration		Duration
valueHumanName		HumanName
valueIdentifier		Identifier
valueMoney		Money
valuePeriod		Period
valueQuantity		Quantity
valueRange		Range
valueRatio		Ratio
valueRatioRange		RatioRange
valueReference		Reference(Any)
valueSampledData		SampledData
valueSignature		Signature
valueTiming		Timing
valueContactDetail		ContactDetail
valueDataRequirement		DataRequirement
valueExpression		Expression
valueParameterDefinition		ParameterDefinition
valueRelatedArtifact		RelatedArtifact
valueTriggerDefinition		TriggerDefinition
valueUsageContext		UsageContext
valueAvailability		Availability
valueExtendedContactDetail		ExtendedContactDetail
valueDosage		Dosage
valueMeta		Meta
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: @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.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.extension.extension: All FHIR elements must have a @value or children (xpath on Extension.extension.extension: @value|f:*|h:div)
ext-1: On Extension.extension.extension: Must have either extensions or value[x], not both (xpath on Extension.extension.extension: exists(f:extension)!=exists(f:*[starts-with(local-name(.), "value")]))
ele-1: On Extension.extension.value[x]: All FHIR elements must have a @value or children (xpath on Extension.extension.value[x]: @value|f:*|h:div)
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.extension.extension: All FHIR elements must have a @value or children (xpath on Extension.extension.extension: @value|f:*|h:div)
ext-1: On Extension.extension.extension: Must have either extensions or value[x], not both (xpath on Extension.extension.extension: exists(f:extension)!=exists(f:*[starts-with(local-name(.), "value")]))
ele-1: On Extension.extension.value[x]: All FHIR elements must have a @value or children (xpath on Extension.extension.value[x]: @value|f:*|h:div)
ele-1: On Extension.value[x]: All FHIR elements must have a @value or children (xpath on Extension.value[x]: @value|f:*|h:div)

Search

No Search Extensions defined for this resource

Examples of this extension

No examples found.