api

Get Claim information

Get claim information associated with a prescription and that particular fill<br/><br/>Given a prescription token and a fill number, the claim information associated with a prescription and that particular fill can be retrieved via API<br/><br/>All claim information correlating to a specific fill is made available here, including claim rejections and reversals. Claim information is displayed in array format, with each object representing a claim record<br/><br/>If a claim is rejected, NCPDP codes are also displayed for the particular claim rejection within the claim_reject_codes field<br/><br/>Claim records are displayed in chronological order. If no claim information is available for a provided prescription_token and fill_number, an empty array is returned.

get/api/v1/prescription/{prescription_token}/fill/{fill_number}/claims

Request

Path parameters

prescription_tokenstring required

Prescription token associated with prescription

fill_numbernumber required

Fill number of particular fill

Response

OK

patient_copay_amountnumber

Expected patient copay amount from claim if adjudication is successful

transaction_codestring

Adjudication transaction type

claim_typestring

Insurance claim type

transmission_datestring date
payorstring

Payor's name

payor_adjudication_amountnumber

Payor adjudication amount

Example response

[
  {
    "patient_copay_amount": 10,
    "transaction_code": "B2",
    "claim_type": "Reversal",
    "transmission_date": "2021-09-15T03:07:01.000Z",
    "insurance": {
      "group_number": "GRP",
      "bin": "321654",
      "pcn": "321654",
      "cardholder_id": "321654"
    },
    "payor": "Health Partners"
  }
]

Changes

No recorded changes to this operation across all 5 revisions of this API.