Location

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

Response Description

Sample Response

{

  "resourceType": "Location",

  "id": "DEV--OF1",

  "meta": {

     "lastUpdated": "2016-11-21T12:00:00-05:00",

     "profile": [

        "http://hl7.org/fhir/us/core/StructureDefinition/us-core-location"

     ]

  },

  "text": {

     "status": "generated",

     "div": "<div xmlns=\"http://www.w3.org/1999/xhtml\"><span>OF1</span><table><tbody><tr><td>Name:</td><td>GreenTree Medical Office</td></tr><tr><td>Phone #:</td><td></td></tr><tr><td>Address:</td><td>95 Great Valley Parkway<br/>MALVERN, PA  19355</td></tr></tbody></table></div>"

  },

  "identifier": [

     {

        "system": "https://pai.healthcare",

        "value": "OF1"

     }

  ],

  "status": "active",

  "name": "GreenTree Medical Office",

  "telecom": [

     {

        "system": "phone",

        "value": "(610) 334-5433",

        "use": "work"

     }

  ],

  "address": {

     "line": [

        "95 Great Valley Parkway"

     ],

     "city": "MALVERN",

     "state": "PA",

     "postalCode": "19355",

     "country": "US",

     "period": {

        "start": "2022-09-21",

        "end": "2022-09-21"

     }

  }

}

Location.id

The logical ID of the resource, as used in the URL for the resource. Once assigned, this value never changes.

Location.meta

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.

Location.text

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.

Location.status

Indicates whether the location is still in use.

Location.name

A name associated with the Location.

Location.telecom

The contact details of communication devices available at the Location. This can include phone numbers, fax numbers, mobile numbers, email addresses and web sites.

Location.address

Physical location.

Location.address.line

Street name, number, direction & P.O. Box etc.

Location.address.city

Name of city, town etc.

Location.address.state

Sub-unit of country (abbreviations ok).

Location.address.postalCode

US Zip Codes.

Location.address.period

Time period when address was/is in use.

Location.managingOrganization

The organization responsible for the provisioning and upkeep of the Location.

Search

URL Syntax

Two HTTP methods are supported for searching: GET and POST. It is recommended to use HTTP POST.

Visit the FHIR Sandbox to try requests.

HTTP GET - searching

https://sandbox.pai.healthcare/preview/fhir/Location?{query string}

HTTP GET - return single record

https://sandbox.pai.healthcare/preview/fhir/Location/{resource id}

HTTP POST - searching

https://sandbox.pai.healthcare/preview/fhir/Location/_search

•Set the Content-Type header to application/x-www-urlencoded

•The body of the request is a similar query string used in the GET type of request detailed above.

Error Handling

If no records are returned or invalid search parameters are provided, then an HTTP 400 Bad Request is returned.

The body of the response will be an OperationOutcome.

Supported Search Parameters

_id

name

address