Location

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

These interaction paths describe standard FHIR R4 patterns. Availability can depend on the API capabilities enabled for your Ovok project.

Interaction	Method	Path
Read	GET	/fhir/R4/Location/[id]
Vread	GET	/fhir/R4/Location/[id]/_history/[vid]
Update	PUT	/fhir/R4/Location/[id]
Patch	PATCH	/fhir/R4/Location/[id]
Delete	DELETE	/fhir/R4/Location/[id]
Create	POST	/fhir/R4/Location
Search	GET	/fhir/R4/Location
History	GET	/fhir/R4/Location/[id]/_history

Top-level elements

Element	Type	Cardinality	Description
id	string	0..1	Logical id of this artifact
meta	Meta	0..1	Metadata about the resource
implicitRules	uri	0..1	A set of rules under which this content was created
language	code	0..1	Language of the resource content
text	Narrative	0..1	Text summary of the resource, for human interpretation
contained	Resource	0..*	Contained, inline Resources
extension	Extension	0..*	Additional content defined by implementations
modifierExtension	Extension	0..*	Extensions that cannot be ignored
identifier	Identifier	0..*	Unique code or number identifying the location to its users
status	code	0..1	active | suspended | inactive
operationalStatus	Coding	0..1	The operational status of the location (typically only for a bed/room)
name	string	0..1	Name of the location as used by humans
alias	string	0..*	A list of alternate names that the location is known as, or was known as, in the past
description	string	0..1	Additional details about the location that could be displayed as further information to identify the location beyond its name
mode	code	0..1	instance | kind
type	CodeableConcept	0..*	Type of function performed
telecom	ContactPoint	0..*	Contact details of the location
address	Address	0..1	Physical location
physicalType	CodeableConcept	0..1	Physical form of the location
position	BackboneElement	0..1	The absolute geographic location
managingOrganization	Reference	0..1	Organization responsible for provisioning and upkeep
partOf	Reference	0..1	Another Location this one is physically a part of
hoursOfOperation	BackboneElement	0..*	What days/times during a week is this location usually open
availabilityExceptions	string	0..1	Description of availability exceptions
endpoint	Reference	0..*	Technical endpoints providing access to services operated for the location

Resource-specific search parameters

Parameter	Type	Description
address	string	A (part of the) address of the location
address-city	string	A city specified in an address
address-country	string	A country specified in an address
address-postalcode	string	A postal code specified in an address
address-state	string	A state specified in an address
address-use	token	A use code specified in an address
endpoint	reference	Technical endpoints providing access to services operated for the location
identifier	token	An identifier for the location
name	string	A portion of the location's name or 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
operational-status	token	Searches for locations (typically bed/room) that have an operational status (e.g. contaminated, housekeeping)
organization	reference	Searches for locations that are managed by the provided organization
partof	reference	A location of which this location is a part
status	token	Searches for locations with a specific kind of status
type	token	A code for the type of location

Reference

Official FHIR R4 spec: Location.
Maturity: Trial Use 3 (FMM 3).