Location

Supported Formats

json

Errors

Code	Description
401	Unauthorized
500	Server crashed for some <%= reason %>

Examples

GET /Location?patient=1&access_token=6b5h9crwD1EP2zzNDifB5GNZi1rgmU3vmjsdJE9G9BfhQUL3Pm7stAUvJCgwSbAb
200
{
  "resourceType": "Bundle",
  "id": "c904b563df7f18bfe9e9075ba53191ff",
  "type": "search set",
  "entry": [
    {
      "full_url": "/Location/1001",
      "resource": {
        "resourceType": "Location",
        "id": "1001",
        "meta": {
          "versionId": "1",
          "lastUpdated": "2021-03-23T19:36:17.299+00:00",
          "source": "#E1VolYkq84D3M96u",
          "profile": [
            "http://hl7.org/fhir/3.0/StructureDefinition/Location"
          ]
        },
        "status": "active",
        "name": "Newburry Facility",
        "mode": "instance",
        "address": [
          {
            "line": [
              "street 123"
            ],
            "postalCode": "55555",
            "city": "springfield",
            "state": "FL",
            "country": "US",
            "period": {
              "start": "2012-12-13"
            }
          }
        ],
        "managingOrganization": {
          "reference": "Organization/{}",
          "type": "Organization"
        }
      }
    }
  ],
  "total": 1
}

Params

Param name	Description
access_token required	CarePaths User OAuth Token Validations: Must be String.
start_date optional	Start date for dataset; Format YYYY-MM-DD Validations: Must be Date.
end_date optional	End date for dataset; Format YYYY-MM-DD Validations: Must be Date.

Returns

Code: 200

Description:

List of resources

Param name	Description
resource_type required	Bundle Validations: Must be String.
type required	Validations: Must be String.

Supported Formats

json

Errors

Code	Description
401	Unauthorized
500	Server crashed for some <%= reason %>

Examples

GET /Location/1001?access_token=6b5h9crwD1EP2zzNDifB5GNZi1rgmU3vmjsdJE9G9BfhQUL3Pm7stAUvJCgwSbAb
200
{
  "resourceType": "Location",
  "id": "1001",
  "meta": {
    "versionId": "1",
    "lastUpdated": "2021-03-23T19:36:17.299+00:00",
    "source": "#E1VolYkq84D3M96u",
    "profile": [
      "http://hl7.org/fhir/3.0/StructureDefinition/Location"
    ]
  },
  "status": "active",
  "name": "Newburry Facility",
  "mode": "instance",
  "address": [
    {
      "line": [
        "street 123"
      ],
      "postalCode": "55555",
      "city": "springfield",
      "state": "FL",
      "country": "US",
      "period": {
        "start": "2012-12-13"
      }
    }
  ],
  "managingOrganization": {
    "reference": "Organization/{}",
    "type": "Organization"
  }
}

Params

Param name	Description
access_token required	CarePaths User OAuth Token Validations: Must be String.
id optional	ID of requested location Validations: Must be number.

Returns

Code: 200

Description:

List of resources

Param name	Description
resource_type required	CareTeam Validations: Must be String.
status required	Validations: Must be String.
subject required	Validations: Must be Hash.
participant required	Validations: Must be Array.

Supported Formats

json

Errors

Code	Description
401	Unauthorized
500	Server crashed for some <%= reason %>

Params

Param name	Description
access_token required	CarePaths User OAuth Token Validations: Must be String.
start_date optional	Start date for dataset; Format YYYY-MM-DD Validations: Must be Date.
end_date optional	End date for dataset; Format YYYY-MM-DD Validations: Must be Date.