Get Resources Action

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

{
          "resourceType": "Asset",
          "assetSearchCriteria": {
          "assetName": "machine",
          "assetTypeIds": [
          "1Fwxx0000004C9bCAE",
          "1Fwxx0000004C96CAE"
          ],
          "assetCategories": [
          "Device",
          "HealthcareService",
          "Location"
          ],
          "status": "Active",
          "productCode": "PC-45678"
          },
          "commonSearchCriteria": {
          "radius": 5,
          "distanceUnit": "miles"
          },
          "orderBy": "distance",
          "ascending": true,
          "offset": 0,
          "searchLimit": 10
          }

Sample Response

{
          "providerSearchResults": [],
          "assetSearchResults": [
          {
          "assetId": "02iSG000000DA4p0AG",
          "assetName": "MRI Machine Room 3",
          "facilityId": "001SG000000EfT80AK",
          "facilityName": "Downtown Imaging Center",
          "assetCategories": ["Device", "Imaging"],
          "status": "Active",
          "productCode": "PC-45678"
          }
          ],
          "error": []
          }