Location

ResourceBase · EntitiesTrial useMaturity 3

Details and position information for a physical place where services are provided and resources and participants may be stored, found, contained, or accommodated.

StructureSearch parametersHL7 specificationStructureDefinition JSON

Tested supportFull test results →

Backends

PostgreSQLElasticsearch

Interactions

CreateReadUpdatePatchDelete

Search

14 of 15 parameters tested

Structure

Show inherited elements (14)

Element	Card.	Type	Description
identifierΣ	0..*	Identifier	Unique code or number identifying the location to its users
status?!Σ	0..1	code	active | suspended | inactiveBinding (required): location-status
operationalStatusΣ	0..1	Coding	The operational status of the location (typically only for a bed/room)Binding (preferred): v2-0116
nameΣ	0..1	string	Name of the location as used by humans
alias	0..*	string	A list of alternate names that the location is known as, or was known as, in the past
descriptionΣ	0..1	string	Additional details about the location that could be displayed as further information to identify the location beyond its name
modeΣ	0..1	code	instance | kindBinding (required): location-mode
typeΣ	0..*	CodeableConcept	Type of function performedBinding (extensible): v3-ServiceDeliveryLocationRoleType
telecom	0..*	ContactPoint	Contact details of the location
address	0..1	Address	Physical location
physicalTypeΣ	0..1	CodeableConcept	Physical form of the locationBinding (example): location-physical-type
position	0..1	BackboneElement	The absolute geographic location
longitudeRequired	1..1	decimal	Longitude with WGS84 datum
latitudeRequired	1..1	decimal	Latitude with WGS84 datum
altitude	0..1	decimal	Altitude with WGS84 datum
managingOrganizationΣ	0..1	Reference(Organization)	Organization responsible for provisioning and upkeep
partOf	0..1	Reference(Location)	Another Location this one is physically a part of
hoursOfOperation	0..*	BackboneElement	What days/times during a week is this location usually open
daysOfWeek	0..*	code	mon | tue | wed | thu | fri | sat | sunBinding (required): days-of-week
allDay	0..1	boolean	The Location is open all day
openingTime	0..1	time	Time that the Location opens
closingTime	0..1	time	Time that the Location closes
availabilityExceptions	0..1	string	Description of availability exceptions
endpoint	0..*	Reference(Endpoint)	Technical endpoints providing access to services operated for the location

Σ in _summary results · ?! modifier element · 1.. required · inherited elements in grey

Search parameters

Query with GET [base]/Location?[parameter]=[value]. Type decides which modifiers and prefixes apply, see search features.

Parameter	Type	Description	PG	ES
address	string	A (part of the) address of the location Location.address
address-city	string	A city specified in an address Location.address.city
address-country	string	A country specified in an address Location.address.country
address-postalcode	string	A postal code specified in an address Location.address.postalCode
address-state	string	A state specified in an address Location.address.state
address-use	token	A use code specified in an address Location.address.use
endpoint	reference	Technical endpoints providing access to services operated for the location Location.endpoint
identifier	token	An identifier for the location Location.identifier
name	string	A portion of the location's name or alias Location.name | Location.alias
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). 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) Servers may search using various techniques that might have differing accuracies, depending on implementation efficiency. Requires the near-distance parameter to be provided also Location.position
operational-status	token	Searches for locations (typically bed/room) that have an operational status (e.g. contaminated, housekeeping) Location.operationalStatus
organization	reference	Searches for locations that are managed by the provided organization Location.managingOrganization
partof	reference	A location of which this location is a part Location.partOf
status	token	Searches for locations with a specific kind of status Location.status
type	token	A code for the type of location Location.type

PG: PostgreSQL, ES: Elasticsearch. passes its TestScript checks, fails, not tested yet.

Common parameters on every resource (8)

_haste-health-author	reference	The author of the resource
_id	token	Logical id of this artifact
_lastUpdated	date	When the resource version last changed
_profile	uri	Profiles this resource claims to conform to
_security	token	Security Labels applied to this resource
_source	uri	Identifies where the resource comes from
_tag	token	Tags applied to this resource
_type	token	Derived from the R4B Definition