# Location

Canonical page: https://docs.ovok.com/api/fhir/r4/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 [#top-level-elements]

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

## Resource-specific search parameters [#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 [#reference]

Official FHIR R4 spec: [Location](https://hl7.org/fhir/R4/location.html).  
Maturity: Trial Use 3 (FMM 3).
