Location-GET

Description

Retrieves detailed information on healthcare facility locations, enabling developers to access and display real-time data regarding the facility's attributes for streamlined operational analysis within clinical workflows.

Use Cases

Retrieve Location Details: Obtain information on a specific location
Access Facility Information: Retrieve details of a facility
Query Geographical Coordinates: Obtain latitude and longitude
Review Department Details: Access details of a department
Examine Service Areas: Retrieve information on service areas

Request Sample

Athena

Elation

Canvas

cURL

JavaScript

Java

Python

Source Specific Details

EHR	APIs	mandatory filters	optional filters
Athena	`${url}/v1/${practiceId}/departments` `${url}/v1/${practiceId}/chart/${patient}/pharmacies/default?departmentid=${departmentId}` `${url}/v1/${practiceId}/chart/${patient}/labs/default?departmentid=${departmentId}` `${url}/v1/${practiceId}/misc/patientlocations`	patient type departmentId	provider-list hospital-only full-provider-list _count _offset
Elation	`${url}/practices/${practiceId}`		_count _offset type physicalType
Canvas	`${url}/Location`		type

Filters

FilterName	Description	Default Value
_count	Pagination params
_offset	Pagination params. Athena: Starting point of entries; 0-indexed
departmentId	Identifier for the department
full-provider-list	If set to true, list providers who are configured to be able to see patients in this department
hospital-only	If set to true, return hospital only departments.
include	List of fields which needed to be shown in result
patient	Patient reference for any fhir resource
practitioner	Practitioner reference for the any fhir resource
provider-list	If set to true, list providers who see patients in this department
quorum	sets sync/async mode	true
type	Source of the information about the type of a location (exam room or office)

Location Export-POST

Location ID-DELETE