Release 4 5 Ballot

This page is part of the FHIR Specification (v4.0.1: R4 (v5.0.0-ballot: R5 Ballot - Mixed Normative and STU see ballot notes ) in it's permanent home (it will always be available at this URL). ). 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

Extension: namespace

8.7.15 Resource Location - Search Parameters

FHIR Infrastructure Patient Administration icon Work Group   Maturity Level : 1 N/A Standards Status : Informative Use Context Security Category : Any Business Compartments : Not linked to any defined compartments

URL Search Parameter Registry for this extension: the location resource

http://hl7.org/fhir/StructureDefinition/elementdefinition-namespace 8.7.16 Status: draft. Extension maintained by: Health Level Seven, Inc. - FHIR Core WG Use this extension to indicate tha the element has an XML namespace different to http://hl7.org/fhir. Search Parameters Comment :

If Search parameter list for this is specified resource. The common parameters also apply. See Searching for more information about searching in a structure definition (logical models only), every element has the specified namespace. REST, messaging, and services.

0..1 uri Name Card. URL = http://hl7.org/fhir/StructureDefinition/elementdefinition-namespace namespace: Use this extension to indicate tha the element has an XML namespace different to http://hl7.org/fhir. Use on Element ID ElementDefinition or Element ID StructureDefinition url 1..1 I 1..1 uri 0..1 uri URL = http://hl7.org/fhir/StructureDefinition/elementdefinition-namespace namespace: Use this extension to indicate tha the element has an XML namespace different to http://hl7.org/fhir. Use on Element ID ElementDefinition or Element ID StructureDefinition "http://hl7.org/fhir/StructureDefinition/elementdefinition-namespace" Documentation for this format
http://hl7.org/fhir/SearchParameter/Location-address

8.7.17 address

Parameter address : string

Context A (part of Use: Use on Element ID ElementDefinition or Element ID StructureDefinition the) address of the location

Extension Content Full Structure XML
Resource Summary Location
Expression JSON Location.address
Multiples The parameter cannot repeat or have multiple values
 
http://hl7.org/fhir/SearchParameter/Location-address-city

8.7.18 address-city All

Parameter address-city : string Summary

A city specified in an address

Name Flags Type
Resource Location
Expression Card. Location.address.city
Multiples The parameter cannot repeat or have multiple values
 
http://hl7.org/fhir/SearchParameter/Location-address-country

8.7.19 address-country Description & Constraints

Parameter address-country : string

A country specified in an address

namespace
Resource Location
Expression Location.address.country
Multiples The parameter cannot repeat or have multiple values
 
http://hl7.org/fhir/SearchParameter/Location-address-postalcode

8.7.20 address-postalcode URL = http://hl7.org/fhir/StructureDefinition/elementdefinition-namespace namespace: Use this extension to indicate tha the element has

Parameter address-postalcode : string

A postal code specified in an XML namespace different to http://hl7.org/fhir. address

Resource Location Use on Element ID ElementDefinition or Element ID StructureDefinition
Expression Location.address.postalCode Documentation for this format
Multiples The parameter cannot repeat or have multiple values
Full Structure
 
Flags http://hl7.org/fhir/SearchParameter/Location-address-state
Type

8.7.21 address-state Description & Constraints

Parameter address-state : string

A state specified in an address

0..1 Extension
Resource Location
Expression extension Location.address.state
Multiples The parameter cannot repeat or have multiple values
 
http://hl7.org/fhir/SearchParameter/Location-address-use extension

8.7.22 address-use

Parameter address-use : token

A use code specified in an address

0..0
Resource I Location
Expression Location.address.use
Multiples The parameter cannot repeat or have multiple values
 
http://hl7.org/fhir/SearchParameter/Location-characteristic

8.7.23 characteristic

Parameter characteristic : token

One of the Location's characteristics

"http://hl7.org/fhir/StructureDefinition/elementdefinition-namespace" value[x]
Resource uri Location
Expression Location.characteristic
Multiples The parameter cannot repeat or have multiple values
 
http://hl7.org/fhir/SearchParameter/Location-contains

8.7.24 contains

Parameter contains : special

Select locations that contain the specified co-ordinates

Value of extension
Resource Location
Expression Location.extension('http://hl7.org/fhir/StructureDefinition/location-boundary-geojson').value Documentation for this format
Multiples The parameter cannot repeat or have multiple values
XML Template
 
http://hl7.org/fhir/SearchParameter/Location-endpoint

8.7.25 endpoint

<!-- namespace --> < xmlns="http://hl7.org/fhir" url="" > <!-- from Element: < </extension>

Parameter endpoint : reference JSON Template

Technical endpoints providing access to services operated for the location

{ // // from Element: " ] " " }
Resource Location
Expression Location.endpoint
Target Resources Endpoint
Multiples The parameter cannot repeat or have multiple values
 
http://hl7.org/fhir/SearchParameter/Location-identifier

8.7.26 identifier

Parameter identifier : token Summary

An identifier for the location

Name Flags Type
Resource Location
Expression Card. Location.identifier
Multiples The parameter cannot repeat or have multiple values
 
http://hl7.org/fhir/SearchParameter/Location-name

8.7.27 name Description & Constraints

Parameter name : string

A portion of the location's name or alias

namespace
Resource Location
Expression Location.name | Location.alias
Multiples The parameter cannot repeat or have multiple values
 
http://hl7.org/fhir/SearchParameter/Location-near

8.7.28 near URL = http://hl7.org/fhir/StructureDefinition/elementdefinition-namespace namespace: Use this extension

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 indicate tha what distances should be considered near (and units are irrelevant).

If the element has server is unable to understand the units (and does support the near search parameter), it MIGHT return an XML namespace 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 http://hl7.org/fhir. Use on Element ID ElementDefinition point, or Element ID StructureDefinition 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 Documentation for this format
Multiples The parameter cannot repeat or have multiple values
 
http://hl7.org/fhir/SearchParameter/Location-operational-status

8.7.29 operational-status

Parameter operational-status : token Full Structure

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

Name Flags Type
Resource Location
Expression Card. Location.operationalStatus
Multiples The parameter cannot repeat or have multiple values
 
http://hl7.org/fhir/SearchParameter/Location-organization

8.7.30 organization Description & Constraints

Parameter organization : reference

Searches for locations that are managed by the provided organization

0..1 Extension
Resource Location
Expression Location.managingOrganization
Target Resources extension Organization
Multiples The parameter cannot repeat or have multiple values
 
http://hl7.org/fhir/SearchParameter/Location-partof extension

8.7.31 partof

Parameter partof : reference I

A location of which this location is a part

0..0 url 1..1 uri
Resource Location
Expression Location.partOf
Target Resources Location
Multiples The parameter cannot repeat or have multiple values
 
http://hl7.org/fhir/SearchParameter/Location-status value[x]

8.7.32 status

Parameter status : token

Searches for locations with a specific kind of status

1..1 Value of extension
Resource I Location
Expression uri Location.status
Multiples The parameter cannot repeat or have multiple values
 
http://hl7.org/fhir/SearchParameter/Location-type

8.7.33 XML Template type <!-- namespace --> < xmlns="http://hl7.org/fhir" url="" > <!-- from Element: < </extension> JSON Template

{ // // from Element: " ] " " }

  Parameter type : token

Constraints A code for the type of location

ele-1 : All FHIR elements must have a @value or children (xpath: @value|f:*|h:div ) ele-1 : On Extension.extension: All FHIR elements must have a @value or children (xpath on Extension.extension: @value|f:*|h:div ) ext-1 : On Extension.extension: Must have either extensions or value[x], not both (xpath on Extension.extension: exists(f:extension)!=exists(f:*[starts-with(local-name(.), "value")]) )
Resource ext-1 : Must have either extensions or value[x], not both (xpath: exists(f:extension)!=exists(f:*[starts-with(local-name(.), 'value')]) ) Location
Expression ele-1 : On Extension.value[x]: All FHIR elements must have a @value Location.type
Multiples The parameter cannot repeat or children (xpath on Extension.value[x]: @value|f:*|h:div ) have multiple values