Location

Trial Use 3 Base

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

Endpoints

alphahttps://api.dev.ovok.com/fhir/R4/Location

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(s)	Cardinality	Description
identifier	Identifier	0..*	Unique code or number identifying the location to its users
status	code	0..1	active | suspended | inactive modifier
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
_compartment	string
_count	string	https://www.hl7.org/fhir/search.html#_count
_elements	string	https://www.hl7.org/fhir/search.html#_elements
_id	string
_lastUpdated	string
_profile	string
_security	string
_sort	string	https://www.hl7.org/fhir/search.html#_sort
_source	string
_summary	string	https://www.hl7.org/fhir/search.html#_summary
_tag	string
_total	string	https://www.hl7.org/fhir/search.html#_total
address	string	http://hl7.org/fhir/SearchParameter/Location-address
address-city	string	http://hl7.org/fhir/SearchParameter/Location-address-city
address-country	string	http://hl7.org/fhir/SearchParameter/Location-address-country
address-postalcode	string	http://hl7.org/fhir/SearchParameter/Location-address-postalcode
address-state	string	http://hl7.org/fhir/SearchParameter/Location-address-state
address-use	string	http://hl7.org/fhir/SearchParameter/Location-address-use
endpoint	string	http://hl7.org/fhir/SearchParameter/Location-endpoint
identifier	string	http://hl7.org/fhir/SearchParameter/Location-identifier
name	string	http://hl7.org/fhir/SearchParameter/Location-name
near	string	http://hl7.org/fhir/SearchParameter/Location-near
operational-status	string	http://hl7.org/fhir/SearchParameter/Location-operational-status
organization	string	http://hl7.org/fhir/SearchParameter/Location-organization
partof	string	http://hl7.org/fhir/SearchParameter/Location-partof
physical-type	string	https://medplum.com/fhir/SearchParameter/Location-physical-type
status	string	http://hl7.org/fhir/SearchParameter/Location-status
type	string	http://hl7.org/fhir/SearchParameter/Location-type

Reference

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