Table of Contents

Use

The Feedback API is used to provide feedback to HMS concerning differences between data returned by HMS through the Search API and data available through the Client.

Note: Use of this service should be coordinated with HMS to establish specifics of format and specific types of feedback may be provided before attempting any calls to this API. This coordination is in addition to that involved in contracting for use of the Search API and issuance of security credentials.

Method

  • Method: PUT

URL

  • URL Structure: Root/Version/Request?Security

Within that structure, this section documents how the Request is used for feedback requests. The following points are relevant to structuring feedback requests:

  • Use of the Feedback service must be coordinated with HMS.

Request

The Request portion of a feedback request consists of the feedback command and the JSON containing the feedback.

  • Command = feedback

Feedback API URL Example

The full URL for the Feedback API is built as Root/VersionRequest&Security

Using the following values:

Root = https://trial/hmsonline.com

Version = v1

Request = feedback?

Security = timestamp=1369844777731&key=EU2BD6eHBQeUMpMxDW9dmg==&signature=8qrFmQbQgILzdDeQfbJTxHXeZvE=

Yields the following URL:

https://trial/hmsonline.com/v1/feedback?timestamp=1369844777731&key=EU2BD6eHBQeUMpMxDW9dmg==&signature=8qrFmQbQgILzdDeQfbJTxHXeZvE=

Note: All security values shown here and throughout this documentation are for illustration purposes only and will not work as shown. See Security Credentials for more information.

Body

The feedback to be provided is defined in the Body of the API call. The Body consists of a JSON string defining the return.

There is an auditing section and a feedback section in the example shown. This example is provided solely as an illustration. The feedback could look different for each Client. Attempts to use this API without prior communication and coordination with HMS will not work and can be construed as an abuse of the service.

Note: The JSON Body of the Feedback API is case sensitive and must be entered in lower case.

JSON Feedback Example

{
  "auditing": [
    {
      "feed": "hms",
      "uid": "PIID12334",
      "version": "1368200835" // epoch time
    },
    {
      "feed": "xyz",
      "uid": "foo",
      "version": "1368200700"
    }
  ],
  "feedback": {
    "practitioner": [
      {
        "target": "hms", //data that SF has in their system
        "source": "xyz",
        "action": "add",
        "data": {
          "first_name": "John"
        }
      },
      {
        "target": "hms", //data that is already available in HMS
        "source": "xyz",
        "action": "drop",
        "data": {
          "first_name": "James"
        }
      }
    ],
    "practitioner.address": [
      {
        "target": "hms",
        "source": "xyz",
        "action": "add",
        "data": {
          "address_line1": "530 mile rd",
          "city": "Philadelphia",
          "zip": "19000"
        }
      },
      {
        "target": "hms",
        "source": "xyz",
        "action": "drop",
        "data": {
          "address_line1": "555 main rd",
          "city": "Philadelphia",
          "zip": "19427",
          "address_key": "7796429"
        }
      }
    ]
  }
}