Progenetix - GeoLocation
A GeoLocation
object is a geographic location formatted as a
GeoJSON feature. The format is compatible with RFC 7946, while currently
limiting its scope to features of type "Point". Also, the schema defines some
optional parameters compatible with the GeoJSON feature properties wrapper
object.
Provenance: IETF GeoJSON specification
Examples could be:
- an address, e.g. of a lab performing an analysis
- provenance of an individual, obfuscated to a larger order administrative entity (Suffolk, U.K.)
- a lat/long/alt position where an environmental sample was collected
Geolocation attributes were proposed as part of the original GA4GH Metadata Task
Team schemas. The current GeoLocation
object is being used by the Progenetix
resource and its BeaconPlus implementation of the Beacon v2 protocol.
Link(s)¶
- GeoLocation.json {S}[B] schema
- source
- Progenetix documentation
{S}[B] Contributors¶
- Michael Baudis 0000-0002-9551-6370
Schema Overview1¶
title: GeoLocation
type: object
properties:
type:
type: string
value: "Feature"
geometry:
$ref: '#/definitions/GeoJSONgeometry'
properties:
$ref: '#/definitions/GeoLabels'
definitions:
GeoJSONgeometry:
description: >-
The geographic point object uses the default units from the
[DCMI point scheme](http://dublincore.org/documents/dcmi-point/)and avoids
optional representation in non-standard units.
type: object
properties:
type:
type: string
value: "Point"
coordinates:
description: >-
An array of 2 (longitude, latitude) or 3 (longitude, latitude, altitude)
ordered values.
type: array
items:
type: number
format: float
minItems: 2
maxItems: 3
examples:
- - 47.37
- 8.55
- - 86.925026
- 27.987850
- 8848.86
GeoLabels:
description: >-
The `geoLabels` object represent an instance of the GeoJSON `properties`
object. The parameters provide additional information for the interpretation
of the location parameters, and also serve for optional "sanity checks" off
the corresponding latitude, longitude (, altitude).
type: object
properties:
label:
type: string
examples:
- Heidelberg, Germany
- Gainesville, United States of America
- Zurich, Switzerland
- 'Str Marasesti 5, 300077 Timisoara, Romania'
city:
type: string
description: >-
The optional name of the city the point location maps to. It should be
considered secondary to the location values in interpreting the geographic
location.
country:
type: string
description: >-
The optional name of the country the location maps to, for sanity checks
and procedural convenience (see notes for "city").
examples:
- Switzerland
ISO3166alpha3:
type: string
examples:
- USA
- CHE
latitude:
type: number
format: float
description: >-
Latitude in signed decimal degrees (North, relative to Equator). This is
an optional, named re-write of the primary `geometry` parameter.
examples:
- 47.37
longitude:
type: number
format: float
description: >-
Longitude signed decimal degrees (East, relative to IERS Reference
Meridian). This is an optional, named re-write of the primary `geometry`
parameter.
examples:
- 8.55
precision:
type: string
description: >-
Used together with coordinate annotation, precision represents an optional
label describing the precision that can be inferred from the coordinates.
For a precision level of "city"", coordinates would have to be interpreted
as representing any possible location within the city's administrative
boundaries, not necessarily at the exact position of the point
coordinates. The `precision` parameter can be used to indicate an
obfuscation of the coordinates, e.g. for privacy protection.
examples:
- city
-
Please note that the schema here is provided for illustration purposes, may represent an approximation and possibly excludes technical components of a proper JSON Schema format. ↩