POST api/patient/searchpatient

Search patient information.

Request Information

URI Parameters

None.

Body Parameters

searchpatient
NameDescriptionTypeAdditional information
api_key

API Key

string

Required

pharmacy_npi

Pharmacy NPI Number - string(10 digit)

string

None.

pharmacy_ncpdp

Pharmacy NCPDP - string(7 digit)

string

Required

unique_patient_id

Patient Unique ID - string

string

None.

last_name

string

string

Required

first_name

string

string

None.

dob

Date of Birth (MM/dd/yyyy) string

string

None.

cell_phone

string

string

None.

home_phone

string

string

None.

city

string

string

None.

state

State - string(2 Characters Only)

string

None.

zipcode

string

string

None.

Request Formats

application/json, text/json

Sample:
{
  "api_key": "sample string 1",
  "pharmacy_npi": "sample string 2",
  "pharmacy_ncpdp": "sample string 3",
  "unique_patient_id": "sample string 4",
  "last_name": "sample string 5",
  "first_name": "sample string 6",
  "dob": "sample string 7",
  "cell_phone": "sample string 8",
  "home_phone": "sample string 9",
  "city": "sample string 10",
  "state": "sample string 11",
  "zipcode": "sample string 12"
}

text/html

Sample:
{"api_key":"sample string 1","pharmacy_npi":"sample string 2","pharmacy_ncpdp":"sample string 3","unique_patient_id":"sample string 4","last_name":"sample string 5","first_name":"sample string 6","dob":"sample string 7","cell_phone":"sample string 8","home_phone":"sample string 9","city":"sample string 10","state":"sample string 11","zipcode":"sample string 12"}

application/xml, text/xml

Sample:
<searchpatient xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/PharmacyEligibilityAPI.Models">
  <api_key>sample string 1</api_key>
  <cell_phone>sample string 8</cell_phone>
  <city>sample string 10</city>
  <dob>sample string 7</dob>
  <first_name>sample string 6</first_name>
  <home_phone>sample string 9</home_phone>
  <last_name>sample string 5</last_name>
  <pharmacy_ncpdp>sample string 3</pharmacy_ncpdp>
  <pharmacy_npi>sample string 2</pharmacy_npi>
  <state>sample string 11</state>
  <unique_patient_id>sample string 4</unique_patient_id>
  <zipcode>sample string 12</zipcode>
</searchpatient>

application/x-www-form-urlencoded

Sample:

Failed to generate the sample for media type 'application/x-www-form-urlencoded'. Cannot use formatter 'JQueryMvcFormUrlEncodedFormatter' to write type 'searchpatient'.

Response Information

Resource Description

Patient details.

IHttpActionResult

None.

Response Formats

application/json, text/json, text/html, application/xml, text/xml

Sample:

Sample not available.