Location_GET
GET {{baseUrl}}/Location?endpoint=<string>&organization=<string>&partof=<string>&_id=<string>&_lastUpdated=<date>&_profile=<string>&_security=<string>&_tag=<string>&address=<string>&address-city=<string>&address-country=<string>&address-postalcode=<string>&address-state=<string>&address-use=<string>&identifier=<string>&name=<string>&near=<string>&near-distance=<integer>&operational-status=<string>&status=<string>&type=<string>&_format=<string>
Request Params
Key | Datatype | Required | Description |
---|---|---|---|
endpoint | string | Technical endpoints providing access to services operated for the location | |
organization | string | Searches for locations that are managed by the provided organization | |
partof | string | A location of which this location is a part | |
_id | string | Logical id of this artifact | |
_lastUpdated | string | When the resource version last changed | |
_profile | string | Profiles this resource claims to conform to | |
_security | string | Security Labels applied to this resource | |
_tag | string | Tags applied to this resource | |
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 | string | A use code specified in an address | |
identifier | string | An identifier for the location | |
name | string | A portion of the location's name or alias | |
near | string | The coordinates expressed as [latitude]:[longitude] (using the WGS84 datum, see notes) to find locations near to (servers may search using a square rather than a circle for efficiency) |
Requires the near-distance parameter to be provided also |
| near-distance
| string | | A distance quantity to limit the near search to locations within a specific distance
Requires the near parameter to also be included |
| operational-status
| string | | Searches for locations (typically bed/room) that have an operational status (e.g. contaminated, housekeeping) |
| status
| string | | Searches for locations with a specific kind of status |
| type
| string | | A code for the type of location |
| _format
| string | | |
RESPONSES
status: OK
[{"resourceType":"\u003cstring\u003e","id":"\u003cstring\u003e","text":{"status":"\u003cstring\u003e","div":"\u003cstring\u003e"},"extension":[{"url":"\u003cstring\u003e","valueString":"\u003cstring\u003e"}],"identifier":[{"value":"\u003cstring\u003e"}],"status":"\u003cstring\u003e","name":"\u003cstring\u003e","description":"\u003cstring\u003e","mode":"\u003cstring\u003e","telecom":[{"system":"\u003cstring\u003e","value":"\u003cstring\u003e","use":"\u003cstring\u003e"}],"address":{"use":"\u003cstring\u003e","line":["\u003cobject\u003e","\u003cobject\u003e"],"city":"\u003cstring\u003e","postalCode":"\u003cstring\u003e","country":"\u003cstring\u003e"},"physicalType":{"coding":[{"system":"\u003cstring\u003e","code":"\u003cstring\u003e","display":"\u003cstring\u003e"}]},"position":{"longitude":"\u003cnumber\u003e","latitude":"\u003cnumber\u003e","altitude":"\u003cnumber\u003e"},"managingOrganization":{"reference":"\u003cstring\u003e"}},{"resourceType":"\u003cstring\u003e","id":"\u003cstring\u003e","text":{"status":"\u003cstring\u003e","div":"\u003cstring\u003e"},"extension":[{"url":"\u003cstring\u003e","valueString":"\u003cstring\u003e"}],"identifier":[{"value":"\u003cstring\u003e"}],"status":"\u003cstring\u003e","name":"\u003cstring\u003e","description":"\u003cstring\u003e","mode":"\u003cstring\u003e","telecom":[{"system":"\u003cstring\u003e","value":"\u003cstring\u003e","use":"\u003cstring\u003e"}],"address":{"use":"\u003cstring\u003e","line":["\u003cobject\u003e","\u003cobject\u003e"],"city":"\u003cstring\u003e","postalCode":"\u003cstring\u003e","country":"\u003cstring\u003e"},"physicalType":{"coding":[{"system":"\u003cstring\u003e","code":"\u003cstring\u003e","display":"\u003cstring\u003e"}]},"position":{"longitude":"\u003cnumber\u003e","latitude":"\u003cnumber\u003e","altitude":"\u003cnumber\u003e"},"managingOrganization":{"reference":"\u003cstring\u003e"}}]