This page is part of the FHIR Specification (v3.2.0: R4 Ballot 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
FHIR Infrastructure Work Group | Maturity Level: N/A | Ballot Status: Informative |
Geolocation
{ "resourceType": "StructureDefinition", "id": "geolocation", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-wg", "valueCode": "fhir" }, { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fmm", "valueInteger": 1 } ], "url": "http://hl7.org/fhir/StructureDefinition/geolocation", "name": "Geolocation", "title": "Geolocation", "status": "draft", "date": "2013-12-05", "publisher": "Health Level Seven International (FHIR Infrastructure)", "contact": [ { "telecom": [ { "system": "url", "value": "http://www.hl7.org/Special/committees/fiwg" } ] } ], "description": "The absolute geographic location of the Location, expressed using the WGS84 datum (This is the same co-ordinate system used in KML).", "fhirVersion": "3.2.0", "mapping": [ { "identity": "rim", "uri": "http://hl7.org/v3", "name": "RIM Mapping" } ], "kind": "complex-type", "abstract": false, "contextType": "datatype", "context": [ "Address" ], "type": "Extension", "baseDefinition": "http://hl7.org/fhir/StructureDefinition/Extension", "derivation": "constraint", "snapshot": { "element": [ { "id": "Extension", "path": "Extension", "short": "The absolute geographic location", "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.", "min": 0, "max": "1", "base": { "path": "Extension", "min": 0, "max": "*" }, "condition": [ "ele-1" ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() | (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "Element" }, { "key": "ext-1", "severity": "error", "human": "Must have either extensions or value[x], not both", "expression": "extension.exists() != value.exists()", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), 'value')])", "source": "Extension" } ] }, { "id": "Extension.id", "path": "Extension.id", "representation": [ "xmlAttr" ], "short": "xml:id (or equivalent in JSON)", "definition": "unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", "min": 0, "max": "1", "base": { "path": "Element.id", "min": 0, "max": "1" }, "type": [ { "code": "string" } ], "mapping": [ { "identity": "rim", "map": "n/a" } ] }, { "id": "Extension.extension", "path": "Extension.extension", "slicing": { "discriminator": [ { "type": "value", "path": "url" } ], "description": "Extensions are always sliced by (at least) url", "rules": "open" }, "short": "Additional Content defined by implementations", "definition": "May be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "alias": [ "extensions", "user content" ], "min": 0, "max": "*", "base": { "path": "Element.extension", "min": 0, "max": "*" }, "type": [ { "code": "Extension" } ], "mapping": [ { "identity": "rim", "map": "n/a" } ] }, { "id": "Extension.extension:latitude", "path": "Extension.extension", "sliceName": "latitude", "short": "Latitude with WGS84 datum", "definition": "Latitude. The value domain and the interpretation are the same as for the text of the latitude element in KML (see notes below).", "min": 1, "max": "1", "base": { "path": "Element.extension", "min": 0, "max": "*" }, "type": [ { "code": "Extension" } ] }, { "id": "Extension.extension:latitude.id", "path": "Extension.extension.id", "representation": [ "xmlAttr" ], "short": "xml:id (or equivalent in JSON)", "definition": "unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", "min": 0, "max": "1", "base": { "path": "Element.id", "min": 0, "max": "1" }, "type": [ { "code": "string" } ], "mapping": [ { "identity": "rim", "map": "n/a" } ] }, { "id": "Extension.extension:latitude.extension", "path": "Extension.extension.extension", "slicing": { "discriminator": [ { "type": "value", "path": "url" } ], "description": "Extensions are always sliced by (at least) url", "rules": "open" }, "short": "Extension", "definition": "An Extension", "min": 0, "max": "0", "base": { "path": "Element.extension", "min": 0, "max": "*" }, "type": [ { "code": "Extension" } ] }, { "id": "Extension.extension:latitude.url", "path": "Extension.extension.url", "representation": [ "xmlAttr" ], "short": "identifies the meaning of the extension", "definition": "Source of the definition for the extension code - a logical name or a URL.", "comment": "The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension.", "min": 1, "max": "1", "base": { "path": "Extension.url", "min": 1, "max": "1" }, "type": [ { "code": "uri" } ], "fixedUri": "latitude", "mapping": [ { "identity": "rim", "map": "N/A" } ] }, { "id": "Extension.extension:latitude.valueDecimal", "path": "Extension.extension.valueDecimal", "short": "Value of extension", "definition": "Value of extension - may be a resource or one of a constrained set of the data types (see Extensibility in the spec for list).", "min": 0, "max": "1", "base": { "path": "Extension.value[x]", "min": 0, "max": "1" }, "type": [ { "code": "decimal" } ], "mapping": [ { "identity": "rim", "map": "N/A" } ] }, { "id": "Extension.extension:longitude", "path": "Extension.extension", "sliceName": "longitude", "short": "Longitude with WGS84 datum", "definition": "Longitude. The value domain and the interpretation are the same as for the text of the longitude element in KML (see notes below).", "min": 1, "max": "1", "base": { "path": "Element.extension", "min": 0, "max": "*" }, "type": [ { "code": "Extension" } ] }, { "id": "Extension.extension:longitude.id", "path": "Extension.extension.id", "representation": [ "xmlAttr" ], "short": "xml:id (or equivalent in JSON)", "definition": "unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", "min": 0, "max": "1", "base": { "path": "Element.id", "min": 0, "max": "1" }, "type": [ { "code": "string" } ], "mapping": [ { "identity": "rim", "map": "n/a" } ] }, { "id": "Extension.extension:longitude.extension", "path": "Extension.extension.extension", "slicing": { "discriminator": [ { "type": "value", "path": "url" } ], "description": "Extensions are always sliced by (at least) url", "rules": "open" }, "short": "Extension", "definition": "An Extension", "min": 0, "max": "0", "base": { "path": "Element.extension", "min": 0, "max": "*" }, "type": [ { "code": "Extension" } ] }, { "id": "Extension.extension:longitude.url", "path": "Extension.extension.url", "representation": [ "xmlAttr" ], "short": "identifies the meaning of the extension", "definition": "Source of the definition for the extension code - a logical name or a URL.", "comment": "The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension.", "min": 1, "max": "1", "base": { "path": "Extension.url", "min": 1, "max": "1" }, "type": [ { "code": "uri" } ], "fixedUri": "longitude", "mapping": [ { "identity": "rim", "map": "N/A" } ] }, { "id": "Extension.extension:longitude.valueDecimal", "path": "Extension.extension.valueDecimal", "short": "Value of extension", "definition": "Value of extension - may be a resource or one of a constrained set of the data types (see Extensibility in the spec for list).", "min": 0, "max": "1", "base": { "path": "Extension.value[x]", "min": 0, "max": "1" }, "type": [ { "code": "decimal" } ], "mapping": [ { "identity": "rim", "map": "N/A" } ] }, { "id": "Extension.url", "path": "Extension.url", "representation": [ "xmlAttr" ], "short": "identifies the meaning of the extension", "definition": "Source of the definition for the extension code - a logical name or a URL.", "comment": "The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension.", "min": 1, "max": "1", "base": { "path": "Extension.url", "min": 1, "max": "1" }, "type": [ { "code": "uri" } ], "fixedUri": "http://hl7.org/fhir/StructureDefinition/geolocation", "mapping": [ { "identity": "rim", "map": "N/A" } ] }, { "id": "Extension.value[x]", "path": "Extension.value[x]", "short": "Value of extension", "definition": "Value of extension - may be a resource or one of a constrained set of the data types (see Extensibility in the spec for list).", "min": 0, "max": "0", "base": { "path": "Extension.value[x]", "min": 0, "max": "1" }, "type": [ { "code": "base64Binary" }, { "code": "boolean" }, { "code": "code" }, { "code": "date" }, { "code": "dateTime" }, { "code": "decimal" }, { "code": "id" }, { "code": "instant" }, { "code": "integer" }, { "code": "markdown" }, { "code": "oid" }, { "code": "positiveInt" }, { "code": "string" }, { "code": "time" }, { "code": "unsignedInt" }, { "code": "uri" }, { "code": "Address" }, { "code": "Age" }, { "code": "Annotation" }, { "code": "Attachment" }, { "code": "CodeableConcept" }, { "code": "Coding" }, { "code": "ContactPoint" }, { "code": "Count" }, { "code": "Distance" }, { "code": "Duration" }, { "code": "HumanName" }, { "code": "Identifier" }, { "code": "Money" }, { "code": "Period" }, { "code": "Quantity" }, { "code": "Range" }, { "code": "Ratio" }, { "code": "Reference" }, { "code": "SampledData" }, { "code": "Signature" }, { "code": "Timing" }, { "code": "Dosage" }, { "code": "ContactDetail" }, { "code": "Contributor" }, { "code": "DataRequirement" }, { "code": "ParameterDefinition" }, { "code": "RelatedArtifact" }, { "code": "TriggerDefinition" }, { "code": "UsageContext" }, { "code": "Meta" } ], "mapping": [ { "identity": "rim", "map": "N/A" } ] } ] }, "differential": { "element": [ { "id": "Extension", "path": "Extension", "short": "The absolute geographic location", "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.", "min": 0, "max": "1" }, { "id": "Extension.extension:latitude", "path": "Extension.extension", "sliceName": "latitude", "short": "Latitude with WGS84 datum", "definition": "Latitude. The value domain and the interpretation are the same as for the text of the latitude element in KML (see notes below).", "min": 1, "max": "1", "type": [ { "code": "Extension" } ] }, { "id": "Extension.extension:latitude.extension", "path": "Extension.extension.extension", "max": "0" }, { "id": "Extension.extension:latitude.url", "path": "Extension.extension.url", "type": [ { "code": "uri" } ], "fixedUri": "latitude" }, { "id": "Extension.extension:latitude.valueDecimal", "path": "Extension.extension.valueDecimal", "type": [ { "code": "decimal" } ] }, { "id": "Extension.extension:longitude", "path": "Extension.extension", "sliceName": "longitude", "short": "Longitude with WGS84 datum", "definition": "Longitude. The value domain and the interpretation are the same as for the text of the longitude element in KML (see notes below).", "min": 1, "max": "1", "type": [ { "code": "Extension" } ] }, { "id": "Extension.extension:longitude.extension", "path": "Extension.extension.extension", "max": "0" }, { "id": "Extension.extension:longitude.url", "path": "Extension.extension.url", "type": [ { "code": "uri" } ], "fixedUri": "longitude" }, { "id": "Extension.extension:longitude.valueDecimal", "path": "Extension.extension.valueDecimal", "type": [ { "code": "decimal" } ] }, { "id": "Extension.url", "path": "Extension.url", "type": [ { "code": "uri" } ], "fixedUri": "http://hl7.org/fhir/StructureDefinition/geolocation" }, { "id": "Extension.value[x]", "path": "Extension.value[x]", "min": 0, "max": "0" } ] } }
Usage note: every effort has been made to ensure that the examples are correct and useful, but they are not a normative part of the specification.