GET api/ClaimHistory/{patientId}

Request Information

URI Parameters

Name	Description	Type	Additional information
patientId		integer	Required

Body Parameters

None.

Response Information

Resource Description

PatientClaimHistoryResponse

Name	Type	Additional information
RequestID	string	None.
PatientID	integer	None.
PhysicianID	integer	None.
AnnualBenefitConsumed	decimal number	None.
AnnualBenefitRemaining	decimal number	None.
Success	string	None.
Error	string	None.
ErrorCode	string	None.
claim	Collection of AddClaimRequest	None.

Response Formats

application/json, text/json

Sample:

{
  "RequestID": "sample string 1",
  "PatientID": 2,
  "PhysicianID": 3,
  "AnnualBenefitConsumed": 4.0,
  "AnnualBenefitRemaining": 5.0,
  "Success": "sample string 6",
  "Error": "sample string 7",
  "ErrorCode": "sample string 8",
  "claim": [
    {
      "ApiUserID": "sample string 1",
      "ClaimID": 2,
      "ClaimCreateDate": "sample string 3",
      "ClaimDateofService": "sample string 4",
      "ClaimTherapeuticUse": "sample string 5",
      "ClaimPatientCoPay": 6.0,
      "ClaimPatientProgramBenefit": 7.0,
      "ClaimPatientOutofPocket": 8.0,
      "ClaimPaidDate": "sample string 9",
      "ClaimClosedDate": "sample string 10",
      "ClaimPaidAmount": 11.0,
      "ClaimDocumentationType": "sample string 12",
      "ClaimStatusID": 13,
      "PatientID": 14,
      "PayorGroupID": "sample string 15",
      "PayorMemberID": "sample string 16",
      "PayorName": "sample string 17",
      "PayorPrimarySubscriber": true,
      "PayorProviderServicesPhone": "sample string 18",
      "PhysicianID": 1,
      "PhysicianNPI": "sample string 19",
      "PhysicianTaxID": "sample string 20",
      "PurchasedDrugSPP": true,
      "TotalAmountBilled": 22.0,
      "ExtCampaignID": "sample string 23",
      "Archive": true,
      "EOBReceived": true,
      "RejectedReasons": "sample string 27",
      "RxDate": "sample string 28",
      "RxAmount": 29.0
    },
    {
      "ApiUserID": "sample string 1",
      "ClaimID": 2,
      "ClaimCreateDate": "sample string 3",
      "ClaimDateofService": "sample string 4",
      "ClaimTherapeuticUse": "sample string 5",
      "ClaimPatientCoPay": 6.0,
      "ClaimPatientProgramBenefit": 7.0,
      "ClaimPatientOutofPocket": 8.0,
      "ClaimPaidDate": "sample string 9",
      "ClaimClosedDate": "sample string 10",
      "ClaimPaidAmount": 11.0,
      "ClaimDocumentationType": "sample string 12",
      "ClaimStatusID": 13,
      "PatientID": 14,
      "PayorGroupID": "sample string 15",
      "PayorMemberID": "sample string 16",
      "PayorName": "sample string 17",
      "PayorPrimarySubscriber": true,
      "PayorProviderServicesPhone": "sample string 18",
      "PhysicianID": 1,
      "PhysicianNPI": "sample string 19",
      "PhysicianTaxID": "sample string 20",
      "PurchasedDrugSPP": true,
      "TotalAmountBilled": 22.0,
      "ExtCampaignID": "sample string 23",
      "Archive": true,
      "EOBReceived": true,
      "RejectedReasons": "sample string 27",
      "RxDate": "sample string 28",
      "RxAmount": 29.0
    }
  ]
}

application/xml, text/xml

Sample:

<PatientClaimHistoryResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/botox.webapi.Models.RequestReponse">
  <AnnualBenefitConsumed>4</AnnualBenefitConsumed>
  <AnnualBenefitRemaining>5</AnnualBenefitRemaining>
  <Error>sample string 7</Error>
  <ErrorCode>sample string 8</ErrorCode>
  <PatientID>2</PatientID>
  <PhysicianID>3</PhysicianID>
  <RequestID>sample string 1</RequestID>
  <Success>sample string 6</Success>
  <claim>
    <AddClaimRequest>
      <AOBFlag>true</AOBFlag>
      <ApiUserID>sample string 1</ApiUserID>
      <Archive>true</Archive>
      <ClaimClosedDate>sample string 10</ClaimClosedDate>
      <ClaimCreateDate>sample string 3</ClaimCreateDate>
      <ClaimDateofService>sample string 4</ClaimDateofService>
      <ClaimDocumentationType>sample string 12</ClaimDocumentationType>
      <ClaimID>2</ClaimID>
      <ClaimNumbers xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:string>sample string 1</d4p1:string>
        <d4p1:string>sample string 2</d4p1:string>
      </ClaimNumbers>
      <ClaimPaidAmount>11</ClaimPaidAmount>
      <ClaimPaidDate>sample string 9</ClaimPaidDate>
      <ClaimPatientCoPay>6</ClaimPatientCoPay>
      <ClaimPatientOutofPocket>8</ClaimPatientOutofPocket>
      <ClaimPatientProgramBenefit>7</ClaimPatientProgramBenefit>
      <ClaimStatusID>13</ClaimStatusID>
      <ClaimTherapeuticUse>sample string 5</ClaimTherapeuticUse>
      <EOBFileNames xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:string>sample string 1</d4p1:string>
        <d4p1:string>sample string 2</d4p1:string>
      </EOBFileNames>
      <EOBReceived>true</EOBReceived>
      <ExtCampaignID>sample string 23</ExtCampaignID>
      <NumberOfLinesOfService>1</NumberOfLinesOfService>
      <PatientID>14</PatientID>
      <PatientResponsibility>25</PatientResponsibility>
      <PayorGroupID>sample string 15</PayorGroupID>
      <PayorMemberID>sample string 16</PayorMemberID>
      <PayorName>sample string 17</PayorName>
      <PayorPrimarySubscriber>true</PayorPrimarySubscriber>
      <PayorProviderServicesPhone>sample string 18</PayorProviderServicesPhone>
      <PhysicianID>1</PhysicianID>
      <PhysicianNPI>sample string 19</PhysicianNPI>
      <PhysicianTaxID>sample string 20</PhysicianTaxID>
      <PreferredPayee>sample string 26</PreferredPayee>
      <PurchasedDrugSPP>true</PurchasedDrugSPP>
      <RejectedReasons>sample string 27</RejectedReasons>
      <RxAmount>29</RxAmount>
      <RxDate>sample string 28</RxDate>
      <SiteOfService>
        <City>sample string 4</City>
        <ClaimID>1</ClaimID>
        <State>sample string 5</State>
        <StreetAddress1>sample string 2</StreetAddress1>
        <StreetAddress2>sample string 3</StreetAddress2>
        <ZipCode>sample string 6</ZipCode>
      </SiteOfService>
      <TotalAmountBilled>22</TotalAmountBilled>
    </AddClaimRequest>
    <AddClaimRequest>
      <AOBFlag>true</AOBFlag>
      <ApiUserID>sample string 1</ApiUserID>
      <Archive>true</Archive>
      <ClaimClosedDate>sample string 10</ClaimClosedDate>
      <ClaimCreateDate>sample string 3</ClaimCreateDate>
      <ClaimDateofService>sample string 4</ClaimDateofService>
      <ClaimDocumentationType>sample string 12</ClaimDocumentationType>
      <ClaimID>2</ClaimID>
      <ClaimNumbers xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:string>sample string 1</d4p1:string>
        <d4p1:string>sample string 2</d4p1:string>
      </ClaimNumbers>
      <ClaimPaidAmount>11</ClaimPaidAmount>
      <ClaimPaidDate>sample string 9</ClaimPaidDate>
      <ClaimPatientCoPay>6</ClaimPatientCoPay>
      <ClaimPatientOutofPocket>8</ClaimPatientOutofPocket>
      <ClaimPatientProgramBenefit>7</ClaimPatientProgramBenefit>
      <ClaimStatusID>13</ClaimStatusID>
      <ClaimTherapeuticUse>sample string 5</ClaimTherapeuticUse>
      <EOBFileNames xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:string>sample string 1</d4p1:string>
        <d4p1:string>sample string 2</d4p1:string>
      </EOBFileNames>
      <EOBReceived>true</EOBReceived>
      <ExtCampaignID>sample string 23</ExtCampaignID>
      <NumberOfLinesOfService>1</NumberOfLinesOfService>
      <PatientID>14</PatientID>
      <PatientResponsibility>25</PatientResponsibility>
      <PayorGroupID>sample string 15</PayorGroupID>
      <PayorMemberID>sample string 16</PayorMemberID>
      <PayorName>sample string 17</PayorName>
      <PayorPrimarySubscriber>true</PayorPrimarySubscriber>
      <PayorProviderServicesPhone>sample string 18</PayorProviderServicesPhone>
      <PhysicianID>1</PhysicianID>
      <PhysicianNPI>sample string 19</PhysicianNPI>
      <PhysicianTaxID>sample string 20</PhysicianTaxID>
      <PreferredPayee>sample string 26</PreferredPayee>
      <PurchasedDrugSPP>true</PurchasedDrugSPP>
      <RejectedReasons>sample string 27</RejectedReasons>
      <RxAmount>29</RxAmount>
      <RxDate>sample string 28</RxDate>
      <SiteOfService>
        <City>sample string 4</City>
        <ClaimID>1</ClaimID>
        <State>sample string 5</State>
        <StreetAddress1>sample string 2</StreetAddress1>
        <StreetAddress2>sample string 3</StreetAddress2>
        <ZipCode>sample string 6</ZipCode>
      </SiteOfService>
      <TotalAmountBilled>22</TotalAmountBilled>
    </AddClaimRequest>
  </claim>
</PatientClaimHistoryResponse>