Location Search Parameters

<a id="address"></a>

address

Description: A server defined search that may match any of the string fields in the Address, including line, city, district, state, country, postalCode, and/or text

Type: string

Expression: Location.address

Path: Location.address

Standards Status: normative

URL: http://hl7.org/fhir/build/SearchParameter/Location-address

<a id="address-city"></a>

address-city

Description: A city specified in an address

Type: string

Expression: Location.address.city

Path: Location.address.city

Standards Status: normative

URL: http://hl7.org/fhir/build/SearchParameter/Location-address-city

<a id="address-country"></a>

address-country

Description: A country specified in an address

Type: string

Expression: Location.address.country

Path: Location.address.country

Standards Status: normative

URL: http://hl7.org/fhir/build/SearchParameter/Location-address-country

<a id="address-postalcode"></a>

address-postalcode

Description: A postal code specified in an address

Type: string

Expression: Location.address.postalCode

Path: Location.address.postalCode

Standards Status: normative

URL: http://hl7.org/fhir/build/SearchParameter/Location-address-postalcode

<a id="address-state"></a>

address-state

Description: A state specified in an address

Type: string

Expression: Location.address.state

Path: Location.address.state

Standards Status: normative

URL: http://hl7.org/fhir/build/SearchParameter/Location-address-state

<a id="address-use"></a>

address-use

Description: A use code specified in an address

Type: token

Expression: Location.address.use

Path: Location.address.use

Standards Status: normative

URL: http://hl7.org/fhir/build/SearchParameter/Location-address-use

<a id="endpoint"></a>

endpoint

Description: Technical endpoints providing access to services operated for the location

Type: reference

Expression: Location.endpoint

Path: Location.endpoint

Standards Status: normative

URL: http://hl7.org/fhir/build/SearchParameter/Location-endpoint

<a id="identifier"></a>

identifier

Description: An identifier for the location

Type: token

Expression: Location.identifier

Path: Location.identifier

Standards Status: normative

URL: http://hl7.org/fhir/build/SearchParameter/Location-identifier

<a id="name"></a>

name

Description: A portion of the location's name or alias

Type: string

Expression: Location.name | Location.alias

Path: Location.name,Location.alias

Standards Status: normative

URL: http://hl7.org/fhir/build/SearchParameter/Location-name

<a id="near"></a>

near

Description: Search for locations where the location.position is near to, or within a specified distance of, the provided coordinates expressed as [latitude]|[longitude]|[distance]|[units] (using the WGS84 datum, see notes).

Servers which support the near parameter SHALL support the unit string 'km' for kilometers and SHOULD support '[mi_us]' for miles, support for other units is optional. If the units are omitted, then kms should be assumed. If the distance is omitted, then the server can use its own discretion as to what distances should be considered near (and units are irrelevant).

If the server is unable to understand the units (and does support the near search parameter), it MIGHT return an OperationOutcome and fail the search with a http status 400 BadRequest. If the server does not support the near parameter, the parameter MIGHT report the unused parameter in a bundled OperationOutcome and still perform the search ignoring the near parameter.

Note: The algorithm to determine the distance is not defined by the specification, and systems might have different engines that calculate things differently. They could consider geographic point to point, or path via road, or including current traffic conditions, or just simple neighboring postcodes/localities if that's all it had access to.

Type: special

Expression: Location.position

Path: Location.position

Standards Status: normative

URL: http://hl7.org/fhir/build/SearchParameter/Location-near

<a id="operational-status"></a>

operational-status

Description: Searches for locations (typically bed/room) that have an operational status (e.g. contaminated, housekeeping)

Type: token

Expression: Location.operationalStatus

Path: Location.operationalStatus

Standards Status: normative

URL: http://hl7.org/fhir/build/SearchParameter/Location-operational-status

<a id="organization"></a>

organization

Description: Searches for locations that are managed by the provided organization

Type: reference

Expression: Location.managingOrganization

Path: Location.managingOrganization

Standards Status: normative

URL: http://hl7.org/fhir/build/SearchParameter/Location-organization

<a id="partof"></a>

partof

Description: A location of which this location is a part

Type: reference

Expression: Location.partOf

Path: Location.partOf

Standards Status: normative

URL: http://hl7.org/fhir/build/SearchParameter/Location-partof

<a id="status"></a>

status

Description: Searches for locations with a specific kind of status

Type: token

Expression: Location.status

Path: Location.status

Standards Status: normative

URL: http://hl7.org/fhir/build/SearchParameter/Location-status

<a id="type"></a>

type

Description: A code for the type of location

Type: token

Expression: Location.type

Path: Location.type

Standards Status: normative

URL: http://hl7.org/fhir/build/SearchParameter/Location-type

<a id="contains"></a>

contains

Description: Select locations that contain the specified co-ordinates

Type: special

Expression: Location.extension('http://hl7.org/fhir/StructureDefinition/location-boundary-geojson').value

Standards Status: normative

URL: http://hl7.org/fhir/build/SearchParameter/location-contains

<a id="characteristic"></a>

characteristic

Description: One of the Location's characteristics

Type: token

Expression: Location.characteristic

Path: Location.characteristic

Standards Status: normative

URL: http://hl7.org/fhir/build/SearchParameter/Location-characteristic

<a id="characteristic"></a>

characteristic

Description: Physical form of the location (e.g. bed/ward/site/virtual)

Type: token

Expression: Location.form

Path: Location.form

Standards Status: normative

URL: http://hl7.org/fhir/build/SearchParameter/Location-form

<a id="mode"></a>

mode

Description: The mode of the location (instance | kind)

Type: token

Expression: Location.mode

Path: Location.mode

Standards Status: normative

URL: http://hl7.org/fhir/build/SearchParameter/Location-mode

<a id="code"></a>

code

Description: The code of the location

Type: token

Expression: Location.code

Path: Location.code

URL: http://hl7.org/fhir/build/SearchParameter/Location-code