Patient Purchase History API

Patient Purchase History API

This API is used for creating the patient purchase history by UCIJIS and pharmacies from the EVS.

Introduction

The Patient Purchase History API is secured by OAuth token validation, allowing customer to access any or all the following depending on the API use case:

1. Fetch live feed of purchases as they are completed at the various pharmacies.

Overview

The Patient Purchase History API is a REST-based solution that deals with secure and convenient customer and business access to orders data.

Patient Purchase History API is secured by Mule OAuth

The Patient Purchase History API provides information about Patient Purchase History details from the EVS. It has below endpoints

/ping: This endpoint returns API health.

This endpoint consists of GET method, which gives the health status of the API.

/ purchaseHistory: This endpoint will create the patient purchase history in EVS.

This endpoint consists of POST method which is used to create patient purchase history in in EVS

Key features and benefits

The following are features and benefits of the Patient Purchase History API:

1. Provides access to account details including token validation and initiates/retrieves for a Patient Purchase History.
2. Puts your customers in control of their data sharing permissions and grants through our Security.

How it works

The following diagram illustrates how the purchase history API works

1. The customer sends client ID and Secret requesting authorization token to access Mule API.
2. Mule API sends the secure token.
3. The customer enters their secure token and valid Json request for Patient Purchase History.
4. Mule OAuth provider processes the customer credentials and token to determine the authorization.
5. If the access is successful, the request is passed from Mule Api to EVS.
6. Response received from EVS is captured.
7. Mule API sends the response back to the customer in Json format.
8. If there is any error in the flow or validation error, Mule API handles and reverts the specific error with the customer along with standard error codes.