Get Resources Action

Search for available resources, such as healthcare providers or medical assets, based on specified search criteria.

This action is available in API version 65.0 and later.

Supported REST HTTP Methods

URI: /services/data/vXX.X/connect/health/appointment-management/resources

Where XX.X is the latest API version.

Formats: JSON

HTTP Methods: POST

Authentication: Authorization: Bearer TOKEN

Where TOKEN is your OAuth access token.

Inputs

Input	Type	Description
`resourceType`	String	The type of resource to search for. Valid values are: `Asset` `Provider`
`providerSearchCriteria`	Object	Search criteria specific to healthcare providers, such as specialties and languages spoken. Use this parameter when `resourceType` is set to `Provider`.
`assetSearchCriteria`	Object	Search criteria specific to medical assets, such as asset type IDs and categories. Use this parameter when `resourceType` is set to `Asset`.
`commonSearchCriteria`	Object	Search criteria that apply to both providers and assets, such as facility location and search radius.
`orderBy`	String	The field used to sort the search results.
`ascending`	Boolean	The sort order. Set to `true` for ascending or `false` for descending.
`offset`	Integer	The starting point for retrieving a subset of results, used for pagination.
`searchLimit`	Integer	The maximum number of search results to return.

Outputs

Output	Type	Description
`assetSearchResults`	List<Object>	A list of medical assets that match the search criteria. This is populated when `resourceType` is set to `Asset`.
`providerSearchResults`	List<Object>	A list of healthcare providers who match the search criteria. This is populated when `resourceType` is set to `Provider`.
`error`	List<Object>	A list of errors that occurred during the search, including error codes and messages.

Example

Sample Request

1{
2          "resourceType": "Asset",
3          "assetSearchCriteria": {
4          "assetName": "machine",
5          "assetTypeIds": [
6          "1Fwxx0000004C9bCAE",
7          "1Fwxx0000004C96CAE"
8          ],
9          "assetCategories": [
10          "Device",
11          "HealthcareService",
12          "Location"
13          ],
14          "status": "Active",
15          "productCode": "PC-45678"
16          },
17          "commonSearchCriteria": {
18          "radius": 5,
19          "distanceUnit": "miles"
20          },
21          "orderBy": "distance",
22          "ascending": true,
23          "offset": 0,
24          "searchLimit": 10
25          }

Sample Response

1{
2          "providerSearchResults": [],
3          "assetSearchResults": [
4          {
5          "assetId": "02iSG000000DA4p0AG",
6          "assetName": "MRI Machine Room 3",
7          "facilityId": "001SG000000EfT80AK",
8          "facilityName": "Downtown Imaging Center",
9          "assetCategories": ["Device", "Imaging"],
10          "status": "Active",
11          "productCode": "PC-45678"
12          }
13          ],
14          "error": []
15          }