Location
Details and position information for a physical place where services are provided and resources and participants may be stored, found, contained, or accommodated.
http://hl7.org/fhir/us/core/STU3.1.1/StructureDefinition-us-core-location.html
The FHIR Location resource corresponds to Canvas Practice Locations.
Endpoints
Location read
Read a Location resource.
Path Parameters
Response Payload Attributes
The FHIR Resource name.
The identifier of the Location
Unique code or number identifying the location to its users. Currently this supports displaying the Group NPI.
The namespace for the identifier value.
The value that is unique.
The status property covers the general availability of the resource, not the current value which may be covered by the operationStatus, or by a schedule/slots if they are configured for the location.
Name of the location as used by humans. This is the practice location’s full name in Canvas.
A list of alternate names that the location is known as, or was known as, in the past. This is the practice location’s short name in Canvas.
Additional details about the location that could be displayed as further information to identify the location beyond its name. Canvas will produce this in the format Organization full name: Location full name
Physical location.
Purpose of this address
Street name, number, direction & P.O. Box etc. This repeating element order: The order in which lines should appear in an address label.
Name of city, town etc.
Sub-unit of country (Canvas uses abbreviations).
Postal code for area.
Country
Responses
Errors
Location search
Search for Location resources.
Query Parameters
The identifier of the Location.
Response Payload Attributes
The FHIR Resource name.
This element and value designate that the bundle is a search response. Search result bundles will always have the Bundle.type of searchset .
The number of resources that match the search parameter.
Attributes relevant to pagination, see our Pagination page for more detail.
The relation of the page search
The search url for the specific relation
The results bundle that lists out each object returned in the search
The attributes specific to the resource type, see the Attributes section below
Attributes
The FHIR Resource name.
The identifier of the Location
Unique code or number identifying the location to its users. Currently this supports displaying the Group NPI.
The namespace for the identifier value.
The value that is unique.
The status property covers the general availability of the resource, not the current value which may be covered by the operationStatus, or by a schedule/slots if they are configured for the location.
Name of the location as used by humans. This is the practice location’s full name in Canvas.
A list of alternate names that the location is known as, or was known as, in the past. This is the practice location’s short name in Canvas.
Additional details about the location that could be displayed as further information to identify the location beyond its name. Canvas will produce this in the format Organization full name: Location full name
Physical location.
Purpose of this address
Street name, number, direction & P.O. Box etc. This repeating element order: The order in which lines should appear in an address label.
Name of city, town etc.
Sub-unit of country (Canvas uses abbreviations).
Postal code for area.
Country
Responses
Errors
curl --request GET \ --url 'https://fumage-example.canvasmedical.com/Location/<id>' \ --header 'Authorization: Bearer <token>' \ --header 'accept: application/json'import requests url = "https://fumage-example.canvasmedical.com/Location/<id>" headers = { "accept": "application/json", "Authorization": "Bearer <token>" } response = requests.get(url, headers=headers) print(response.text)
{ "resourceType": "Location", "id": "a04b44ec-c7df-4808-9043-e9c4b1d352a9", "identifier": [ { "system": "http://hl7.org/fhir/sid/us-npi", "value": "12321" } ], "status": "active", "name": "Canvas Medical", "alias": [ "Canvas Medical HQ" ], "description": "Canvas Medical, San Francisco, CA", "address": { "use": "work", "line": [ "405 49th St" ], "city": "Oakland", "state": "CA", "postalCode": "94609", "country": "USA" } }{ "resourceType": "OperationOutcome", "issue": [ { "severity": "error", "code": "unknown", "details": { "text": "Authentication failed" } } ] }{ "resourceType": "OperationOutcome", "issue": [ { "severity": "error", "code": "forbidden", "details": { "text": "Authorization failed" } } ] }{ "resourceType": "OperationOutcome", "issue": [ { "severity": "error", "code": "not-found", "details": { "text": "Unknown Location resource 'a04b44ec-c7df-4808-9043-e9c4b1d352a9'" } } ] }
curl --request GET \ --url 'https://fumage-example.canvasmedical.com/Location' \ --header 'Authorization: Bearer <token>' \ --header 'accept: application/json'import requests url = "https://fumage-example.canvasmedical.com/Location" headers = { "accept": "application/json", "Authorization": "Bearer <token>" } response = requests.get(url, headers=headers) print(response.text)
{ "resourceType": "Bundle", "type": "searchset", "total": 1, "link": [ { "relation": "self", "url": "/Location?_count=10&_offset=0" }, { "relation": "first", "url": "/Location?_count=10&_offset=0" }, { "relation": "last", "url": "/Location?_count=10&_offset=0" } ], "entry": [ { "resource": { "resourceType": "Location", "id": "a04b44ec-c7df-4808-9043-e9c4b1d352a9", "identifier": [ { "system": "http://hl7.org/fhir/sid/us-npi", "value": "12321" } ], "status": "active", "name": "Canvas Medical", "alias": [ "Canvas Medical HQ" ], "description": "Canvas Medical, San Francisco, CA", "address": { "use": "work", "line": [ "405 49th St" ], "city": "Oakland", "state": "CA", "postalCode": "94609", "country": "USA" } } } ] }{ "resourceType": "OperationOutcome", "issue": [ { "severity": "error", "code": "invalid", "details": { "text": "Bad request" } } ] }{ "resourceType": "OperationOutcome", "issue": [ { "severity": "error", "code": "unknown", "details": { "text": "Authentication failed" } } ] }{ "resourceType": "OperationOutcome", "issue": [ { "severity": "error", "code": "forbidden", "details": { "text": "Authorization failed" } } ] }