R6 Ballot (1st Draft)

This page is part of the FHIR Specification v6.0.0-ballot1: Release 6 Ballot (1st Draft) (see Ballot Notes). The current version is 5.0.0. For a full list of available versions, see the Directory of published versions

8.7.16 Resource Location - Search Parameters

Patient Administration icon Work GroupMaturity Level: N/A  Trial UseSecurity 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 address

Parameter address:string

A (part of the) address of the location

ResourceLocation
ExpressionLocation.address
Processing ModeNormal
Multiples
  • multipleAnd: It's up to the server whether the parameter may repeat in order to specify multiple values that must all be true
  • multipleOr: It's up to the server whether the parameter can have multiple values (separated by comma) where at least one must be true
 
http://hl7.org/fhir/SearchParameter/Location-address-city

8.7.18 address-city

Parameter address-city:string

A city specified in an address

ResourceLocation
ExpressionLocation.address.city
Processing ModeNormal
Multiples
  • multipleAnd: It's up to the server whether the parameter may repeat in order to specify multiple values that must all be true
  • multipleOr: It's up to the server whether the parameter can have multiple values (separated by comma) where at least one must be true
 
http://hl7.org/fhir/SearchParameter/Location-address-country

8.7.19 address-country

Parameter address-country:string

A country specified in an address

ResourceLocation
ExpressionLocation.address.country
Processing ModeNormal
Multiples
  • multipleAnd: It's up to the server whether the parameter may repeat in order to specify multiple values that must all be true
  • multipleOr: It's up to the server whether the parameter can have multiple values (separated by comma) where at least one must be true
 
http://hl7.org/fhir/SearchParameter/Location-address-postalcode

8.7.20 address-postalcode

Parameter address-postalcode:string

A postal code specified in an address

ResourceLocation
ExpressionLocation.address.postalCode
Processing ModeNormal
Multiples
  • multipleAnd: It's up to the server whether the parameter may repeat in order to specify multiple values that must all be true
  • multipleOr: It's up to the server whether the parameter can have multiple values (separated by comma) where at least one must be true
 
http://hl7.org/fhir/SearchParameter/Location-address-state

8.7.21 address-state

Parameter address-state:string

A state specified in an address

ResourceLocation
ExpressionLocation.address.state
Processing ModeNormal
Multiples
  • multipleAnd: It's up to the server whether the parameter may repeat in order to specify multiple values that must all be true
  • multipleOr: It's up to the server whether the parameter can have multiple values (separated by comma) where at least one must be true
 
http://hl7.org/fhir/SearchParameter/Location-address-use

8.7.22 address-use

Parameter address-use:token

A use code specified in an address

ResourceLocation
ExpressionLocation.address.use
Processing ModeNormal
Multiples
  • multipleAnd: It's up to the server whether the parameter may repeat in order to specify multiple values that must all be true
  • multipleOr: It's up to the server whether the parameter can have multiple values (separated by comma) where at least one must be true
 
http://hl7.org/fhir/SearchParameter/Location-characteristic

8.7.23 characteristic

Parameter characteristic:token

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

ResourceLocation
ExpressionLocation.form
Processing ModeNormal
Multiples
  • multipleAnd: It's up to the server whether the parameter may repeat in order to specify multiple values that must all be true
  • multipleOr: It's up to the server whether the parameter can have multiple values (separated by comma) where at least one must be true
 
http://hl7.org/fhir/SearchParameter/Location-contains

8.7.24 contains

Parameter contains:special

Select locations that contain the specified co-ordinates

ResourceLocation
ExpressionLocation.extension('http://hl7.org/fhir/StructureDefinition/location-boundary-geojson').value
Processing ModeNormal
Multiples
  • multipleAnd: It's up to the server whether the parameter may repeat in order to specify multiple values that must all be true
  • multipleOr: It's up to the server whether the parameter can have multiple values (separated by comma) where at least one must be true
 
http://hl7.org/fhir/SearchParameter/Location-endpoint

8.7.25 endpoint

Parameter endpoint:reference

Technical endpoints providing access to services operated for the location

ResourceLocation
ExpressionLocation.endpoint
Processing ModeNormal
Target ResourcesEndpoint
Multiples
  • multipleAnd: It's up to the server whether the parameter may repeat in order to specify multiple values that must all be true
  • multipleOr: It's up to the server whether the parameter can have multiple values (separated by comma) where at least one must be true
 
http://hl7.org/fhir/SearchParameter/Location-identifier

8.7.26 identifier

Parameter identifier:token

An identifier for the location

ResourceLocation
ExpressionLocation.identifier
Processing ModeNormal
Multiples
  • multipleAnd: It's up to the server whether the parameter may repeat in order to specify multiple values that must all be true
  • multipleOr: It's up to the server whether the parameter can have multiple values (separated by comma) where at least one must be true
 
http://hl7.org/fhir/SearchParameter/Location-mode

8.7.27 mode

Parameter mode:token

The mode of the location (instance | kind)

ResourceLocation
ExpressionLocation.mode
Processing ModeNormal
Multiples
  • multipleAnd: It's up to the server whether the parameter may repeat in order to specify multiple values that must all be true
  • multipleOr: It's up to the server whether the parameter can have multiple values (separated by comma) where at least one must be true
 
http://hl7.org/fhir/SearchParameter/Location-name

8.7.28 name

Parameter name:string

A portion of the location's name or alias

ResourceLocation
ExpressionLocation.name | Location.alias
Processing ModeNormal
Multiples
  • multipleAnd: It's up to the server whether the parameter may repeat in order to specify multiple values that must all be true
  • multipleOr: It's up to the server whether the parameter can have multiple values (separated by comma) where at least one must be true
 
http://hl7.org/fhir/SearchParameter/Location-near

8.7.29 near

Parameter near:special

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.

ResourceLocation
ExpressionLocation.position
Processing ModeOther
Multiples
  • multipleAnd: It's up to the server whether the parameter may repeat in order to specify multiple values that must all be true
  • multipleOr: It's up to the server whether the parameter can have multiple values (separated by comma) where at least one must be true
 
http://hl7.org/fhir/SearchParameter/Location-operational-status

8.7.30 operational-status

Parameter operational-status:token

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

ResourceLocation
ExpressionLocation.operationalStatus
Processing ModeNormal
Multiples
  • multipleAnd: It's up to the server whether the parameter may repeat in order to specify multiple values that must all be true
  • multipleOr: It's up to the server whether the parameter can have multiple values (separated by comma) where at least one must be true
 
http://hl7.org/fhir/SearchParameter/Location-organization

8.7.31 organization

Parameter organization:reference

Searches for locations that are managed by the provided organization

ResourceLocation
ExpressionLocation.managingOrganization
Processing ModeNormal
Target ResourcesOrganization
Multiples
  • multipleAnd: It's up to the server whether the parameter may repeat in order to specify multiple values that must all be true
  • multipleOr: It's up to the server whether the parameter can have multiple values (separated by comma) where at least one must be true
 
http://hl7.org/fhir/SearchParameter/Location-partof

8.7.32 partof

Parameter partof:reference

A location of which this location is a part

ResourceLocation
ExpressionLocation.partOf
Processing ModeNormal
Target ResourcesLocation
Multiples
  • multipleAnd: It's up to the server whether the parameter may repeat in order to specify multiple values that must all be true
  • multipleOr: It's up to the server whether the parameter can have multiple values (separated by comma) where at least one must be true
 
http://hl7.org/fhir/SearchParameter/Location-status

8.7.33 status

Parameter status:token

Searches for locations with a specific kind of status

ResourceLocation
ExpressionLocation.status
Processing ModeNormal
Multiples
  • multipleAnd: It's up to the server whether the parameter may repeat in order to specify multiple values that must all be true
  • multipleOr: It's up to the server whether the parameter can have multiple values (separated by comma) where at least one must be true
 
http://hl7.org/fhir/SearchParameter/Location-type

8.7.34 type

Parameter type:token

A code for the type of location

ResourceLocation
ExpressionLocation.type
Processing ModeNormal
Multiples
  • multipleAnd: It's up to the server whether the parameter may repeat in order to specify multiple values that must all be true
  • multipleOr: It's up to the server whether the parameter can have multiple values (separated by comma) where at least one must be true