GET api/patients/{patientId}/eligibilities
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| patientId | integer |
Required |
Body Parameters
None.
Response Information
Resource Description
ListResponseOfPayerInformationResponse| Name | Description | Type | Additional information |
|---|---|---|---|
| Items | Collection of PayerInformationResponse |
None. |
|
| Result | Result |
None. |
Response Formats
application/json, text/json
Sample:
{
"Items": [
{
"PatientEligibilityId": 1,
"PayerName": "sample string 2",
"PharmacyEligibilities": [
{
"PharmacyType": 1,
"EligibilityStatus": 1,
"Name": "sample string 1"
},
{
"PharmacyType": 1,
"EligibilityStatus": 1,
"Name": "sample string 1"
}
],
"PlanName": "sample string 3",
"CoverageId": "sample string 4",
"PayerId": "sample string 5",
"BIN": "sample string 6",
"PCN": "sample string 7",
"FormularyId": "sample string 8",
"AlternativesId": "sample string 9",
"CopayId": "sample string 10",
"DemographicChanges": true,
"Demographics": {
"LastName": "sample string 1",
"FirstName": "sample string 2",
"MiddleName": "sample string 3",
"Suffix": "sample string 4",
"DateOfBirth": "2025-12-16T17:07:42.6049822+00:00",
"Gender": 1,
"Address": {
"AddressLine1": "sample string 1",
"AddressLine2": "sample string 2",
"City": "sample string 3",
"State": "sample string 4",
"ZipCode": "sample string 5"
}
},
"ErrorMessage": "sample string 12",
"InfoMessage": "sample string 13",
"MemberId": "sample string 14"
},
{
"PatientEligibilityId": 1,
"PayerName": "sample string 2",
"PharmacyEligibilities": [
{
"PharmacyType": 1,
"EligibilityStatus": 1,
"Name": "sample string 1"
},
{
"PharmacyType": 1,
"EligibilityStatus": 1,
"Name": "sample string 1"
}
],
"PlanName": "sample string 3",
"CoverageId": "sample string 4",
"PayerId": "sample string 5",
"BIN": "sample string 6",
"PCN": "sample string 7",
"FormularyId": "sample string 8",
"AlternativesId": "sample string 9",
"CopayId": "sample string 10",
"DemographicChanges": true,
"Demographics": {
"LastName": "sample string 1",
"FirstName": "sample string 2",
"MiddleName": "sample string 3",
"Suffix": "sample string 4",
"DateOfBirth": "2025-12-16T17:07:42.6049822+00:00",
"Gender": 1,
"Address": {
"AddressLine1": "sample string 1",
"AddressLine2": "sample string 2",
"City": "sample string 3",
"State": "sample string 4",
"ZipCode": "sample string 5"
}
},
"ErrorMessage": "sample string 12",
"InfoMessage": "sample string 13",
"MemberId": "sample string 14"
}
],
"Result": {
"ResultCode": "sample string 1",
"ResultDescription": "sample string 2"
}
}
application/xml, text/xml
Sample:
<ListResponseOfPayerInformationResponse8Vkccj_Sk xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/DoseSpot.UI.API.DataContracts._13">
<Result>
<ResultCode>sample string 1</ResultCode>
<ResultDescription>sample string 2</ResultDescription>
</Result>
<Items>
<PayerInformationResponse>
<AlternativesId>sample string 9</AlternativesId>
<BIN>sample string 6</BIN>
<CopayId>sample string 10</CopayId>
<CoverageId>sample string 4</CoverageId>
<DemographicChanges>true</DemographicChanges>
<Demographics>
<Address>
<AddressLine1>sample string 1</AddressLine1>
<AddressLine2>sample string 2</AddressLine2>
<City>sample string 3</City>
<State>sample string 4</State>
<ZipCode>sample string 5</ZipCode>
</Address>
<DateOfBirth>2025-12-16T17:07:42.6049822+00:00</DateOfBirth>
<FirstName>sample string 2</FirstName>
<Gender>Male</Gender>
<LastName>sample string 1</LastName>
<MiddleName>sample string 3</MiddleName>
<Suffix>sample string 4</Suffix>
</Demographics>
<ErrorMessage>sample string 12</ErrorMessage>
<FormularyId>sample string 8</FormularyId>
<InfoMessage>sample string 13</InfoMessage>
<MemberId>sample string 14</MemberId>
<PCN>sample string 7</PCN>
<PatientEligibilityId>1</PatientEligibilityId>
<PayerId>sample string 5</PayerId>
<PayerName>sample string 2</PayerName>
<PharmacyEligibilities>
<PharmacyEligibility>
<EligibilityStatus>Covered</EligibilityStatus>
<Name>sample string 1</Name>
<PharmacyType>MailOrder</PharmacyType>
</PharmacyEligibility>
<PharmacyEligibility>
<EligibilityStatus>Covered</EligibilityStatus>
<Name>sample string 1</Name>
<PharmacyType>MailOrder</PharmacyType>
</PharmacyEligibility>
</PharmacyEligibilities>
<PlanName>sample string 3</PlanName>
</PayerInformationResponse>
<PayerInformationResponse>
<AlternativesId>sample string 9</AlternativesId>
<BIN>sample string 6</BIN>
<CopayId>sample string 10</CopayId>
<CoverageId>sample string 4</CoverageId>
<DemographicChanges>true</DemographicChanges>
<Demographics>
<Address>
<AddressLine1>sample string 1</AddressLine1>
<AddressLine2>sample string 2</AddressLine2>
<City>sample string 3</City>
<State>sample string 4</State>
<ZipCode>sample string 5</ZipCode>
</Address>
<DateOfBirth>2025-12-16T17:07:42.6049822+00:00</DateOfBirth>
<FirstName>sample string 2</FirstName>
<Gender>Male</Gender>
<LastName>sample string 1</LastName>
<MiddleName>sample string 3</MiddleName>
<Suffix>sample string 4</Suffix>
</Demographics>
<ErrorMessage>sample string 12</ErrorMessage>
<FormularyId>sample string 8</FormularyId>
<InfoMessage>sample string 13</InfoMessage>
<MemberId>sample string 14</MemberId>
<PCN>sample string 7</PCN>
<PatientEligibilityId>1</PatientEligibilityId>
<PayerId>sample string 5</PayerId>
<PayerName>sample string 2</PayerName>
<PharmacyEligibilities>
<PharmacyEligibility>
<EligibilityStatus>Covered</EligibilityStatus>
<Name>sample string 1</Name>
<PharmacyType>MailOrder</PharmacyType>
</PharmacyEligibility>
<PharmacyEligibility>
<EligibilityStatus>Covered</EligibilityStatus>
<Name>sample string 1</Name>
<PharmacyType>MailOrder</PharmacyType>
</PharmacyEligibility>
</PharmacyEligibilities>
<PlanName>sample string 3</PlanName>
</PayerInformationResponse>
</Items>
</ListResponseOfPayerInformationResponse8Vkccj_Sk>