Patients Card API

Patient Card API

This Api is used between UCIJIS and EVS using MuleSoft API.

Introduction

The Patient Card API allows to fetch/initiate details from ICS account. Patient Card Api is secured by OAuth token validation, allowing customer to access any or all the following depending on the API use case:

1. Fetch all Patient Card details.
2. Fetch Patient Card details with specific query parameters.
3. Create Patient Card.

Overview

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

Patient Card Api is secured by Mule OAuth

The Patient Card API provides information about Patient Card 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.

/Patientcards: This endpoint returns patient card details from the EVS.

This endpoint consists of POST method, these are used to create the Patient Card Api.

1. When the Patient Card details are passed from the request it initiate Patient Card detailsPOST: This method creates patient card details in EVS system. While creating patient card records below are the validation performed. 1.The firstName, lastName, DOB and required to fetch patient details.2.The required fields to be passed for respective patient card. for instance: firstName, lastName, cardNumber need to be passed while creating a patient card record.

/ Patienthistory: This endpoint Check Patient purchase history from the EVS.

This endpoint consists of GET method, these are used to fetch the Patient history Api.

1. When the Patient Card details are passed in queryparms them it retrieves Patient Card details.GET: This method returns Patient Card details by using below query parameters.1. patientNumber: This is the EVS Patient Card ID generated by the EVS system. This is an optional field. This can fetch patient details on user search criteria.

2 .careGiverNumber: This is the EVS Patient Card ID generated by the EVS system. This is an optional field. This can fetch patient details on user search criteria.

3.personSalesforceID: It is an optional field used for querying the patient card details. This can fetch patient details on user search criteria.

4.cardNumber: It is an optional field used for querying the patient card details with specific card number. This can fetch patient details on user search criteria.

**Note : For restrictedDosageForms under patientRecommendations please refer following document (*Disclaimer\*: This document is for reference only and needs to be validated with Utah State and might get stale over the period)

https://docs.google.com/spreadsheets/d/1mRwlKaeJzkMvs0hKtT9XZw0NUw-FnCrrOAQwEoEOKm4/edit?gid=0#gid=0

Key features and benefits

The following are features and benefits of the Patient Card API:

1. Provides access to account details including token validation and initiates/retrieves for a Patient Card.
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 Patient Card 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 Card.
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.

Use cases

The Patient Card API supports data access for the following use cases.