Location - FHIR v6.0.0-ballot2

FHIR CI-Build

This is the Continuous Integration Build of FHIR (will be incorrect/inconsistent at times).
See the Directory of published versions icon

8.7.15 Resource Location - Search Parameters

Patient Administration icon

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

Generated Narrative: SearchParameter Location-address

8.7.16 address

Parameter address:string

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

Resource Location

Expression Location.address

Processing Mode Normal

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

Generated Narrative: SearchParameter Location-address-city

8.7.17 address-city

Parameter address-city:string

A city specified in an address

Resource Location

Expression Location.address.city

Processing Mode Normal

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

Generated Narrative: SearchParameter Location-address-country

8.7.18 address-country

Parameter address-country:string

A country specified in an address

Resource Location

Expression Location.address.country

Processing Mode Normal

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

Generated Narrative: SearchParameter Location-address-postalcode

8.7.19 address-postalcode

Parameter address-postalcode:string

A postal code specified in an address

Resource Location

Expression Location.address.postalCode

Processing Mode Normal

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

Generated Narrative: SearchParameter Location-address-state

8.7.20 address-state

Parameter address-state:string

A state specified in an address

Resource Location

Expression Location.address.state

Processing Mode Normal

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

Generated Narrative: SearchParameter Location-address-use

8.7.21 address-use

Parameter address-use:token

A use code specified in an address

Resource Location

Expression Location.address.use

Processing Mode Normal

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

Generated Narrative: SearchParameter Location-characteristic

8.7.22 characteristic

Parameter characteristic:token

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

Resource Location

Expression Location.form

Processing Mode Normal

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

Generated Narrative: SearchParameter Location-contains

8.7.23 contains

Parameter contains:special

Select locations that contain the specified co-ordinates

Resource Location

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

Processing Mode Normal

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

Generated Narrative: SearchParameter Location-endpoint

8.7.24 endpoint

Parameter endpoint:reference

Technical endpoints providing access to services operated for the location

Resource Location

Expression Location.endpoint

Processing Mode Normal

Target Resources Endpoint

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

Generated Narrative: SearchParameter Location-identifier

8.7.25 identifier

Parameter identifier:token

An identifier for the location

Resource Location

Expression Location.identifier

Processing Mode Normal

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

Generated Narrative: SearchParameter Location-mode

8.7.26 mode

Parameter mode:token

The mode of the location (instance | kind)

Resource Location

Expression Location.mode

Processing Mode Normal

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

Generated Narrative: SearchParameter Location-name

8.7.27 name

Parameter name:string

A portion of the location's name or alias

Resource Location

Expression Location.name | Location.alias

Processing Mode Normal

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

Generated Narrative: SearchParameter Location-near

8.7.28 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.

Resource Location

Expression Location.position

Processing Mode Other

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

Generated Narrative: SearchParameter Location-operational-status

8.7.29 operational-status

Parameter operational-status:token

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

Resource Location

Expression Location.operationalStatus

Processing Mode Normal

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

Generated Narrative: SearchParameter Location-organization

8.7.30 organization

Parameter organization:reference

Searches for locations that are managed by the provided organization

Resource Location

Expression Location.managingOrganization

Processing Mode Normal

Target Resources Organization

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

Generated Narrative: SearchParameter Location-partof

8.7.31 partof

Parameter partof:reference

A location of which this location is a part

Resource Location

Expression Location.partOf

Processing Mode Normal

Target Resources Location

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

Generated Narrative: SearchParameter Location-status

8.7.32 status

Parameter status:token

Searches for locations with a specific kind of status

Resource Location

Expression Location.status

Processing Mode Normal

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

Generated Narrative: SearchParameter Location-type

8.7.33 type

Parameter type:token

A code for the type of location

Resource Location

Expression Location.type

Processing Mode Normal

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