Location

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

Properties

Name	Required	Type	Description
identifier		Identifier[]	Unique code or number identifying the location to its users Details Unique code or number identifying the location to its users.
status		code	active | suspended | inactive Details The status property covers the general availability of the resource, not the current value which may be covered by the operationStatus, or by a schedule/slots if they are configured for the location.
operationalStatus		Coding	The operational status of the location (typically only for a bed/room) Details The operational status covers operation values most relevant to beds (but can also apply to rooms/units/chairs/etc. such as an isolation unit/dialysis chair). This typically covers concepts such as contamination, housekeeping, and other activities like maintenance.
name		string	Name of the location as used by humans Details Name of the location as used by humans. Does not need to be unique. If the name of a location changes, consider putting the old name in the alias column so that it can still be located through searches.
alias		string[]	A list of alternate names that the location is known as, or was known as, in the past Details A list of alternate names that the location is known as, or was known as, in the past. There are no dates associated with the alias/historic names, as this is not intended to track when names were used, but to assist in searching so that older names can still result in identifying the location.
description		string	Additional details about the location that could be displayed as further information to identify the location beyond its name Details Description of the Location, which helps in finding or referencing the place.
mode		code	instance | kind Details Indicates whether a resource instance represents a specific location or a class of locations. This is labeled as a modifier because whether or not the location is a class of locations changes how it can be used and understood.
type		CodeableConcept[]	Type of function performed Details Indicates the type of function performed at the location.
telecom		ContactPoint[]	Contact details of the location Details The contact details of communication devices available at the location. This can include phone numbers, fax numbers, mobile numbers, email addresses and web sites.
address		Address	Physical location Details Physical location. Additional addresses should be recorded using another instance of the Location resource, or via the Organization.
physicalType		CodeableConcept	Physical form of the location Details Physical form of the location, e.g. building, room, vehicle, road.
position		LocationPosition	The absolute geographic location Details The absolute geographic location of the Location, expressed using the WGS84 datum (This is the same co-ordinate system used in KML).
id		string	Unique id for inter-element referencing Details Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
extension		Extension[]	Additional content defined by implementations Details May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
modifierExtension		Extension[]	Extensions that cannot be ignored even if unrecognized Details May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
longitude	✓	decimal	Longitude with WGS84 datum Details Longitude. The value domain and the interpretation are the same as for the text of the longitude element in KML (see notes below).
latitude	✓	decimal	Latitude with WGS84 datum Details Latitude. The value domain and the interpretation are the same as for the text of the latitude element in KML (see notes below).
altitude		decimal	Altitude with WGS84 datum Details Altitude. The value domain and the interpretation are the same as for the text of the altitude element in KML (see notes below).
managingOrganization		Reference<Organization>	Organization responsible for provisioning and upkeep Details The organization responsible for the provisioning and upkeep of the location. This can also be used as the part of the organization hierarchy where this location provides services. These services can be defined through the HealthcareService resource.
partOf		Reference<Location>	Another Location this one is physically a part of Details Another Location of which this Location is physically a part of.
hoursOfOperation		LocationHoursOfOperation[]	What days/times during a week is this location usually open Details What days/times during a week is this location usually open. This type of information is commonly found published in directories and on websites informing customers when the facility is available. Specific services within the location may have their own hours which could be shorter (or longer) than the locations hours.
id		string	Unique id for inter-element referencing Details Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
extension		Extension[]	Additional content defined by implementations Details May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
modifierExtension		Extension[]	Extensions that cannot be ignored even if unrecognized Details May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
daysOfWeek		code[]	mon | tue | wed | thu | fri | sat | sun Details Indicates which days of the week are available between the start and end Times.
allDay		boolean	The Location is open all day Details The Location is open all day.
openingTime		time	Time that the Location opens Details Time that the Location opens.
closingTime		time	Time that the Location closes Details Time that the Location closes.
availabilityExceptions		string	Description of availability exceptions Details A description of when the locations opening ours are different to normal, e.g. public holiday availability. Succinctly describing all possible exceptions to normal site availability as detailed in the opening hours Times.
endpoint		Reference<Endpoint>[]	Technical endpoints providing access to services operated for the location Details Technical endpoints providing access to services operated for the location.

Search Parameters

Name	Type	Description	Expression
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
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

Inherited Properties

Name	Required	Type	Description
id		string	Logical id of this artifact Details The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. The only time that a resource does not have an id is when it is being submitted to the server using a create operation.
meta		Meta	Metadata about the resource Details The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.
implicitRules		uri	A set of rules under which this content was created Details A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc. Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of it's narrative along with other profiles, value sets, etc.
language		code	Language of the resource content Details The base language in which the resource is written. Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute).
text		Narrative	Text summary of the resource, for human interpretation Details A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety. Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a "text blob" or where text is additionally entered raw or narrated and encoded information is added later.
contained		Resource[]	Contained, inline Resources Details These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope. This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags In their meta elements, but SHALL NOT have security labels.
extension		Extension[]	Additional content defined by implementations Details May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
modifierExtension		Extension[]	Extensions that cannot be ignored Details May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.