Location

Normative Base

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

Endpoints

devhttps://api.sandbox.ovok.com/fhir/R5/Location

Interaction	Method	Path
Read	GET	/fhir/R5/Location/[id]
Vread	GET	/fhir/R5/Location/[id]/_history/[vid]
Update	PUT	/fhir/R5/Location/[id]
Patch	PATCH	/fhir/R5/Location/[id]
Delete	DELETE	/fhir/R5/Location/[id]
Create	POST	/fhir/R5/Location
Search	GET	/fhir/R5/Location?...
History	GET	/fhir/R5/Location/[id]/_history
Type-history	GET	/fhir/R5/Location/_history

Top-level elements

Element	Type(s)	Cardinality	Description
identifier	Identifier	0..*	Unique code or number identifying the location to its users
status	code	0..1	active
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	markdown	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
type	CodeableConcept	0..*	Type of function performed
contact	ExtendedContactDetail	0..*	Official contact details for the location
address	Address	0..1	Physical location
form	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
characteristic	CodeableConcept	0..*	Collection of characteristics (attributes)
hoursOfOperation	Availability	0..*	What days/times during a week is this location usually open (including exceptions)
virtualService	VirtualServiceDetail	0..*	Connection details of a virtual service (e.g. conference call)
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
characteristic	token	One of the Location's characteristics
contains	special	Select locations that contain the specified co-ordinates
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]
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 R5 spec: Location
• Maturity: Normative (FMM 5).