This page is part of the FHIR Specification (v5.0.0: R5 - STU). This is the current published version in it's permanent home (it will always be available at this URL). For a full list of available versions, see the Directory of published versions
Patient Administration Work Group | Maturity Level: N/A | Trial Use | Security Category: Business | Compartments: No defined compartments |
Search parameters for the Resource Location - Search Parameters resource. Also check the Extensions registry for search parameters on extensions related to this resource.
The common parameters also apply. See Searching for more information about searching in REST, messaging, and services.
http://hl7.org/fhir/SearchParameter/Location-address | ||||||||||
8.7.17 addressParameter A (part of the) address of the location
| ||||||||||
http://hl7.org/fhir/SearchParameter/Location-address-city | ||||||||||
8.7.18 address-cityParameter A city specified in an address
| ||||||||||
http://hl7.org/fhir/SearchParameter/Location-address-country | ||||||||||
8.7.19 address-countryParameter A country specified in an address
| ||||||||||
http://hl7.org/fhir/SearchParameter/Location-address-postalcode | ||||||||||
8.7.20 address-postalcodeParameter A postal code specified in an address
| ||||||||||
http://hl7.org/fhir/SearchParameter/Location-address-state | ||||||||||
8.7.21 address-stateParameter A state specified in an address
| ||||||||||
http://hl7.org/fhir/SearchParameter/Location-address-use | ||||||||||
8.7.22 address-useParameter A use code specified in an address
| ||||||||||
http://hl7.org/fhir/SearchParameter/Location-characteristic | ||||||||||
8.7.23 characteristicParameter One of the Location's characteristics
| ||||||||||
http://hl7.org/fhir/SearchParameter/Location-contains | ||||||||||
8.7.24 containsParameter Select locations that contain the specified co-ordinates
| ||||||||||
http://hl7.org/fhir/SearchParameter/Location-endpoint | ||||||||||
http://hl7.org/fhir/SearchParameter/Location-identifier | ||||||||||
8.7.26 identifierParameter An identifier for the location
| ||||||||||
http://hl7.org/fhir/SearchParameter/Location-name | ||||||||||
8.7.27 nameParameter A portion of the location's name or alias
| ||||||||||
http://hl7.org/fhir/SearchParameter/Location-near | ||||||||||
8.7.28 nearParameter 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.
| ||||||||||
http://hl7.org/fhir/SearchParameter/Location-operational-status | ||||||||||
8.7.29 operational-statusParameter Searches for locations (typically bed/room) that have an operational status (e.g. contaminated, housekeeping)
| ||||||||||
http://hl7.org/fhir/SearchParameter/Location-organization | ||||||||||
8.7.30 organizationParameter Searches for locations that are managed by the provided organization
| ||||||||||
http://hl7.org/fhir/SearchParameter/Location-partof | ||||||||||
http://hl7.org/fhir/SearchParameter/Location-status | ||||||||||
8.7.32 statusParameter Searches for locations with a specific kind of status
| ||||||||||
http://hl7.org/fhir/SearchParameter/Location-type | ||||||||||
8.7.33 typeParameter A code for the type of location
| ||||||||||