Location Resource

The FHIR Location resource is used to represent physical locations within a healthcare environment, such as clinics, imaging centres, or other sites. Within AdvaPACS, Location resources correspond to configured Sites. Each Location belongs to an Organization, allowing resources and activities to be associated with a specific site within an organisation.

For full information on the ImagingStudy resource, please refer to the FHIR standard.

Note

Location resources are available when the Organisations & Sites feature is enabled for the AdvaPACS tenant.

Supported Transactions

AdvaPACS supports the following transactions for the Location resource:

Function	Method	Endpoint	Description
Get Location	GET	/Location/{id}	Retrieves a specific Location resource by its logical ID.
Search Locations	GET	/Location	Searches for Location resources matching the supplied search parameters.

Examples

The following examples show how to retrieve and search for Location resources using the AdvaPACS FHIR API. These examples demonstrate how Sites are represented as FHIR Location resources and how they can be associated with Organizations.

Get a Location

A specific Location can be retrieved using the logical ID assigned to the resource. The response contains information about the corresponding AdvaPACS Site, including its name, status, and associated Organization.

GET /fhir/R5/Location/[Location_ID]
Authorization: ID=<ApiId>,Secret=<ApiSecret>
Accept: application/fhir+json
Host: <FhirEndpoint>

For example, to retrieve a location with logical ID 542ba027-1adf-4d5d-b961-9e26f8e8e4b7:

GET /fhir/R5/Location/542ba027-1adf-4d5d-b961-9e26f8e8e4b7
Authorization: ID=<ApiId>,Secret=<ApiSecret>
Accept: application/fhir+json
Host: <FhirEndpoint>

A successful request returns the requested Location resource:

{
  "resourceType": "Location",
  "id": "542ba027-1adf-4d5d-b961-9e26f8e8e4b7",
  "identifier": [
    {
      "value": "EXAMPLE"
    }
  ],
  "status": "active",
  "name": "Example Site",
  "managingOrganization": {
    "reference": "Organization/b0eef8ff-6f17-4222-a85e-5f5fd3259618"
  }
}

Search Locations

Location resources can be searched using supported FHIR search parameters. One or more parameters can be included in the request to narrow the Locations returned by the FHIR API. The following search parameters are supported:

Parameter	Description	Example
_id	Search by the logical FHIR resource ID.	?_id=542ba027-1adf-4d5d-b961-9e26f8e8e4b7
identifier	Search by a Location identifier.	?identifier=EXAMPLE
name	Search by the Location name.	?name=Example Site
status	Search by the Location status.	?status=active
organization	Search for Locations associated with a specific Organization.	?organization=Organization/b0eef8ff-6f17-4222-a85e-5f5fd3259618

For example, to search for Locations with the name Example Site:

GET /fhir/R5/Location?name=Example%20Site
Authorization: ID=<ApiId>,Secret=<ApiSecret>
Accept: application/fhir+json
Host: <FhirEndpoint>

A successful request returns a FHIR search Bundle containing the matching Location resources:

{
  "resourceType": "Bundle",
  "type": "searchset",
  "entry": [
    {
      "resource": {
        "resourceType": "Location",
        "id": "542ba027-1adf-4d5d-b961-9e26f8e8e4b7",
        "identifier": [
          {
            "value": "EXAMPLE"
          }
        ],
        "status": "active",
        "name": "Example Site",
        "managingOrganization": {
          "reference": "Organization/b0eef8ff-6f17-4222-a85e-5f5fd3259618"
        }
      }
    }
  ]
}

Multiple search parameters can be combined to further narrow the results. For example, to return active Locations associated with a specific Organization:

GET /fhir/R5/Location?organization=Organization/b0eef8ff-6f17-4222-a85e-5f5fd3259618&status=active
Authorization: ID=<ApiId>,Secret=<ApiSecret>
Accept: application/fhir+json
Host: <FhirEndpoint>