Introduction

The Doceree Co-pay Spark API Integration document provides instructions to our Publisher partners so that they can configure and incorporate the required integration points, in their respective setup, to communicate with Doceree Co-pay Spark^TM.

Overview

The solution provided by Doceree Co-pay Spark^TM, enables our supply partners to generate contextually relevant affordability messages (branded as well as generic coupons) that can be distributed over different EHR (Electronic Health Record) systems, to patients whereby they (patients) can gain affordability benefits by utilizing these coupons in network pharmacies.

Affordability messages (coupons) thus generated are based on the patient’s prescription as administered by the corresponding Health Care Professional (HCP) using their specific EHR setups. Moreover, these messages appear on the e-prescription page of an EHR system in response to the medication selected by the HCP depending upon the fact whether a utilizable coupon, associated with the selected medicine, is available at that point of time for distribution to the patient.

Doceree Affordability Messaging Mechanism

There are two primary distribution channels of affordability messaging (coupons) within the Doceree affordability messaging landscape, namely (A) Pharmacies and (B) Patients. Furthermore, distribution of coupons to patients can take place using the following communication mediums: (1) Portal, (2) Pharmacy Notes, (3) Print, (4) E-mail, and (5) Text.

Distribution to Pharmacies

For distribution of coupons to pharmacies, the e-prescription (eRx) page or the concerned EHR system having the Doceree Co-pay Spark^TM API endpoint integrated on it, sends a coupon request to Doceree Exchange^TM.

The coupon request send by eRx\EHR would have the required NDC code of the drug that is prescribed by the HCP. However, for specific API integrations the coupon request send to Doceree Exchange^TM would also include the NCPDP (National Council for Prescription Drug Programs) as well.

After receiving the request, from the concerned eRx\EHR, Doceree Exchange^TM will return (1) a Branded Coupon if it is available against the corresponding NDC code or return (2) a Generic Coupon if it is available against the said NDC code and distribute it accordingly to the indicated distribution channel.

Next, a distribution signal along with the channel type for coupon distribution is also sent to Doceree Exchange^TM by the concerned eRx\EHR.

Then the pharmacy will receive the eRx and apply the said affordability message (coupon) on the bill before they hand over the prescribed medication to the concerned patient.

Coupon Distribution Option for Pharmacy

Distribution to Patients

In case of distribution of the affordability message (coupon) to patients, the e-prescription (eRx) page or the concerned EHR system having the Doceree Co-pay Spark^TM API endpoint integrated on it, sends a coupon request to Doceree Exchange^TM similar to the process flow for a distribution of coupons to pharmacies.

Here again the coupon request send by eRx\EHR would have the required NDC code of the drug that is prescribed by the HCP. However, for specific API integrations the coupon request send to Doceree Exchange^TM would also include the NCPDP (National Council for Prescription Drug Programs) as well.

Next, a distribution signal along with the channel type for coupon distribution is also sent to Doceree Exchange^TM by the concerned eRx\EHR.

Then the patient will receive the coupon as per their preferred choice of medium (portal, pharmacy notes, print, e-mail, or text) selected by the concerned HCP.

Coupon Distribution Options for Patient

The said patient can then present the affordability message (coupon) at the concerned pharmacy and take the benefit for the same, from the pharmacy, at the time of receiving the medication.

Here is a description of the five distinct approaches for the distribution of affordability messaging to patients:

Portal

As per the portal-based approach the said affordability message (coupon) is posted directly to the inbox section (depending on the integration between the EHR and pharmacy) of the concerned patient portal once the HCP creates a prescription.

The affordability message would display the following disclaimer message: ‘Program not applicable for federal healthcare program beneficiaries. To know more visit https://bit.ly/docpapp’.

Note: Adding the aforementioned disclaimer is mandatory.

Pharmacy Notes

As per the portal-based approach the said affordability message (coupon) is posted directly to the pharmacy notes section (depending on the integration between the EHR and pharmacy) of the concerned patient portal once the HCP creates a prescription.

The pharmacy notes section would display the following disclaimer message: ‘Program not applicable for federal healthcare program beneficiaries. To know more visit https://bit.ly/docpapp’.

Note: Adding the aforementioned disclaimer is mandatory and the disclaimer ought to appear at the beginning of the pharmacy note.

Note: It is also important to remember here that the pharmacy notes section allows a permissible character count, which varies from one e-prescribing system to another. However, when the abovementioned disclaimer message is added to the pharmacy notes, it should not exceed the permissible character count, and if so happens causing the HCP comments to be cut, then the coupon should not be dispensed at all.

Print

As per this approach the said affordability message (coupon) is printed out along in the HCPs office for manual delivery to the patient once the prescription is created.

The affordability message printout would display the following disclaimer message: ‘Program not applicable for federal healthcare program beneficiaries. To know more visit https://bit.ly/docpapp’.

Note: Adding the aforementioned disclaimer is mandatory.

Print Message

E-mail

As per the e-mail-based approach an e-mail message is sent to the patient’s e-mail inbox once the HCP creates a prescription.

The e-mail message would display the following disclaimer message: ‘Program not applicable for federal healthcare program beneficiaries. To know more visit https://bit.ly/docpapp’.

Note: Adding the aforementioned disclaimer is mandatory.

E-mail Message

Text

As per the text-based approach a text message is sent to the patient’s mobile phone once the prescription is created by the HCP.

The affordability message text would display the following disclaimer message: ‘Program not applicable for federal healthcare program beneficiaries. To know more visit https://bit.ly/docpapp’.

Note: Adding the aforementioned disclaimer is mandatory.

Text Message

Data Flow

To begin with the Publisher integrates the Doceree Co-pay Spark API at their end.

Once integrated the data flow of the Doceree Co-pay Spark API works as follows:

Coupon request call (Publisher)
Coupon response (Doceree)
Coupon View Tracker (Publisher to invoke Doceree coupon view URL)
Distribution Tracker (Publisher to invoke Doceree distribution URL)

The following diagram illustrates the flow of data once the Doceree Co-pay Spark API is integrated by the respective Publisher:

Data Flow Between Doceree and Publisher

Note: The coupon request call from the Publisher will certainly send the NDC (National Drug Code) code to Doceree and as per certain Publisher configurations the said coupon request call would additionally include the NCPDP ID, as well.

*The NDC code is a unique, universal product identifier for human drugs in the United States. It represents a unique 10-digit or 11-digit number comprising of three segments: the First segment establishes the name of the drug manufacturer or their labeler, the Second segment identifies the product code (specifically the form the drug dosage is in: capsule, tablet, syrup, suspension, etc.), and the Third segment represents the package code for identifying characteristics of the said package such as its size and type.

**The NCPDP ID is a unique, national identification number (an ID) that is assigned by NCPDP to every licensed pharmacy located across the United States and its territories.

Request

POST couponRequest

https://qa-bidder.doceree.com/v1/ndc_coupon?npi=1649275884&currentUrl=https://provider1.com

PARAMS
Npi	1649275884
currentUrl	dsads?npi=1649275884

BODY raw

{

"ndc":["0093-1118", "0093-1122"],

"ncpdp":["0202123","0201436"],

"placementId":"DOC_1x1mkl7sz4e4v"

}

Request Parameters

The two request query parameters included are: the NPI (National Provider Identifier) of the HCP and the page URL (Uniform Resource Locator).

The Npi parameter is a 10 digits number (string) that represents the identifier of the HCP accessing the page where the coupon is placed whereas the currentURl (string) is the URL of the page that has send the coupon request.

Request Payload

The request payload includes these parameters namely the ndc, the ncpdp, and the placementId.

The ndc (array of a string) represents the drug code, the ncpdp (array of a string) represents the ncpdp id of the pharmacy, and the placementId (string) represents the div id of the web page from where the said coupon request has come from.

Note: The ndc and the placementId parameters are mandatory whereas ncpdp is an optional parameter.

Response

Following is a sample response, from the Doceree ad server, for the coupon request that it receives from a Publisher for delivering a co-pay coupon:

{

"creativeType": "copay",

"placementID": "DOC_70c5kl8idzh8s",

"memberID": "PX207794",

"group": "DR33",

"bin": "15995",

"pcn": "GDC",

"width": "300",

"height": "250",

"sourceHTML": "<!DOCTYPE html>\n<html>\n<head><style>html,body{padding:0;margin:0;}</style><base href='https://doceree-qa.s3.amazonaws.com/brands/Etodolac_61cc2ab2fe9386001327671b/646a43699adeff0013d9ceb1web300x250-1684685830807/unzip/' target='_blank'>\n<meta charset='utf-8'/>\n<meta name='viewport' content='width=device-width, initial-scale=1'/>\n</head>\n<body onload='registerImpression()'>\n<link href=\"https://fonts.googleapis.com/css2?family=Work+Sans:wght@600&display=swap\" rel=\"stylesheet\">\n <link href=\"https://fonts.googleapis.com/css2?family=Work+Sans:wght@500;600&display=swap\" rel=\"stylesheet\">\n <link href=\"https://fonts.googleapis.com/css2?family=Work+Sans:ital,wght@0,500;0,600;1,200&display=swap\" rel=\"stylesheet\"><div style=\"width: 298px;height: 248px;margin: auto;font-family: 'Work sans'; border: 1px solid #ccc;\">\n <div style=\"width: 300px;float: left; font-family: 'Work sans';\">\n <div style=\"font-size: 19px;font-family: 'Work sans'; color: rgb(178, 178, 178);font-weight: bold;text-align: center;margin-top: 13px;\">Etodolac</div>\n <div style=\"font-size: 11px;font-weight: 600; color: rgb(178, 178, 178);margin-left: 7px;text-align: center;font-family: 'Work sans'; margin-bottom: 10px;\">30 TABLET, FILM COATED in 1 BOTTLE (0002-4182-61)</div>\n </div>\n <div style=\"width: 300px;float: left;height: 90px;background:#666666;font-family: 'Work sans'; \">\n <div style=\"font-size: 11px;margin-top: 11px; font-family: 'Work sans'; margin-bottom: 9px; color:rgb(0, 0, 0);text-align: center;margin-top: 24px;\">Discount price with this coupon</div>\n <div style=\"font-size: 28px;margin-top: 4px; font-family: 'Work sans'; line-height: 18px;font-weight: bold;margin-top: 7px; color:rgb(0, 0, 0);text-align: center;\">50%\n <span style=\"font-size: 12px;font-weight: normal;display: inline-block; width:290px; font-family: 'Work sans';\"></span></div>\n </div>\n <div style=\"font-family: 'Work sans';width: 280px; text-align: left; height:30px; display:inline-flex;border-bottom: 1.5px dotted #4D4D4D;padding: 10px;text-align: center; display: table-cell;vertical-align: middle;\">\n <div style=\"font-size: 12px;font-family: 'Work sans';line-height: 17px;word-break: break-all;\"></div>\n </div>\n <div style=\"width: 300px;text-align: left;margin: 8px 0px 10px 10px;font-family: 'Work sans';\">\n <div style=\"width: 24%;float: left; margin-left: 20px;font-family: 'Work sans';\">\n <div style=\"font-size: 11px; color: rgb(178, 178, 178);text-align: left;font-family: 'Work sans';\">Member ID</div>\n <div style=\"font-size: 11px;font-weight: 600; color: rgb(178, 178, 178);text-align: left;font-family: 'Work sans';\">PX207794</div>\n </div>\n <div style=\"width: 15%;float: left; margin-left: 20px;font-family: 'Work sans';\">\n <div style=\"font-size: 11px; color: rgb(178, 178, 178);text-align: left;font-family: 'Work sans';\">Group</div>\n <div style=\"font-size: 11px;font-weight: 600; color: rgb(178, 178, 178);text-align: left;font-family: 'Work sans';\">DR33</div>\n </div>\n <div style=\"width: 15%;float: left; margin-left: 25px;font-family: 'Work sans';\">\n <div style=\"font-size: 11px; color: rgb(178, 178, 178);text-align: left;font-family: 'Work sans';\">Bin</div>\n <div style=\"font-size: 11px;font-weight: 600; color: rgb(178, 178, 178);text-align: left;font-family: 'Work sans';\">15995</div>\n </div>\n <div style=\"width: 10%;float: left; margin-left: 15px;font-family: 'Work sans';\">\n <div style=\"font-size: 11px; color: rgb(178, 178, 178);text-align: left;font-family: 'Work sans';\">PCN</div>\n <div style=\"font-size: 11px;font-weight: 600; color: rgb(178, 178, 178);text-align: left;font-family: 'Work sans';\">GDC</div>\n </div>\n </div>\n \n</body>\n</html><script>function registerImpression(){var img = document.createElement('img');img.height='1px';img.width='1px';img.src = \"https://tracking.doceree.com/coupon_tracking/cp_impression?ad=633146128a99f8001434a023&brid=3858b694-7b39-46aa-ace3-92e262a59453&ca=&cr=646a4413082fed00140f4439&data=3858b694-7b39-46aa-ace3-92e262a59453_cp_impression&im=818c5834-cb23-44f6-98af-4b6dbeed2931&pb=6319a405a29830001479a8a1&sb=&ts=1692602675722&zrurl=\";document.body.append(img);}</script>",

"programID": "646a43699adeff0013d9ceb1",

"guid": "3858b694-7b39-46aa-ace3-92e262a59453",

"impressionUrl": "https://tracking.doceree.com/coupon_tracking/cp_impression?ad=633146128a99f8001434a023&brid=3858b694-7b39-46aa-ace3-92e262a59453&ca=&cr=646a4413082fed00140f4439&data=3858b694-7b39-46aa-ace3-92e262a59453_cp_impression&im=818c5834-cb23-44f6-98af-4b6dbeed2931&pb=6319a405a29830001479a8a1&sb=&ts=1692602675722&zrurl=",

"distributionUrl": "https://tracking.doceree.com/coupon_tracking/dispense?ad=633146128a99f8001434a023&brid=3858b694-7b39-46aa-ace3-92e262a59453&ca=&cr=646a4413082fed00140f4439&data=3858b694-7b39-46aa-ace3-92e262a59453_dispense&im=818c5834-cb23-44f6-98af-4b6dbeed2931&pb=6319a405a29830001479a8a1&sb=&ts=1692602675722&zrurl=",

"passbackTag": "",

"errMessage": "",

"debugMessage": ""

}

GET Track Coupon View

https://tracking.doceree.com/coupon_tracking/cp_impression?ad=633146128a99f8001434a023&brid=3858b694-7b39-46aa-ace3-92e262a59453&ca=&cr=646a4413082fed00140f4439&data=3858b694-7b39-46aa-ace3-92e262a59453_cp_impression&im=818c5834-cb23-44f6-98af-4b6dbeed2931&pb=6319a405a29830001479a8a1&sb=&ts=1692602675722&zrurl=

HEADERS
Upgrade-Insecure-Requests	1
User-Agent	Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/103.0.0.0 Safari/537.36
sec-ch-ua	".Not/A)Brand";v="99", "Google Chrome";v="103", "Chromium";v="103"
sec-ch-ua-mobile	?0
sec-ch-ua-platform	"macOS"

PARAMS
Ad	5ee4dbf75729300013e79b1d
Brid	a6207ecb-10e9-474b-8165-5507cd5aa006
Ca
Cr	62725e478326678b77838907
Data	a6207ecb-10e9-474b-8165-5507cd5aa006_cp_view
Im	519bc705-6328-4c9d-8876-a0c100843d5f
Pb	5e34269f4bf9660013e4a971
Sb
Ts	1655114590212
Zrurl

GET Track distribution

https://tracking.doceree.com/coupon_tracking/dispense?ad=633146128a99f8001434a023&brid=3858b694-7b39-46aa-ace3-92e262a59453&ca=&cr=646a4413082fed00140f4439&data=3858b694-7b39-46aa-ace3-92e262a59453_dispense&im=818c5834-cb23-44f6-98af-4b6dbeed2931&pb=6319a405a29830001479a8a1&sb=&ts=1692602675722&zrurl=

HEADERS
Upgrade-Insecure-Requests	1
User-Agent	Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/103.0.0.0 Safari/537.36
sec-ch-ua	".Not/A)Brand";v="99", "Google Chrome";v="103", "Chromium";v="103"
sec-ch-ua-mobile	?0
sec-ch-ua-platform	"macOS"

PARAMS
Ad	5ee4dbf75729300013e79b1d
Brid	4729746c-a4b1-479e-aac0-18171edc01fc
Ca
Cr	62725e478326678b77838907
Data	4729746c-a4b1-479e-aac0-18171edc01fc_distribution
Im	8d057ed6-8f3b-45b2-9fc7-422e304f6512
Pb	5e34269f4bf9660013e4a971
Sb
Ts	1654673286149
Zrurl

Doceree Co-pay Spark API Integration Guide

Introduction

Overview

Distribution to Pharmacies