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 Location.

Endpoints

get
/Location/{id}
 get
/Location

Attributes

id
string

The identifier of the Location

identifier
array[json]

Unique code or number identifying the location to its users.
Supported: Group NPI values using the http://hl7.org/fhir/sid/us-npi system

status
string

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
string

Name of the location as used by humans

alias
array[string]

A list of alternate names that the location is known as, or was known as, in the past

description
string

Additional details about the location that could be displayed as further information to identify the location beyond its name

address
json

Physical address

get
/Location/{id}

Location read

Read a Location resource.

Path Parameters

id required
string
The unique identifier for the Location

Responses

200 OK
Request was successful.

Errors

401 Unauthorized
The request requires user authentication.
403 Forbidden
The request requires user authorization.
404 Not Found
The requested resource was not found.
get
/Location

Location search

Search for Location resources.

Query Parameters

_id
string

The identifier of the Location

Responses

200 OK
Request was successful.

Errors

400 Bad Request
The request was invalid or cannot be otherwise served. An accompanying error message will explain further.
401 Unauthorized
The request requires user authentication.
403 Forbidden
The request requires user authorization.
  • 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"
      }
    }
  ]
}