Get Explanation of Benefit
GET {{baseUrl}}/api/v2/ExplanationOfBenefit?patient=<integer>
Overview:
Retrieves detailed information on insurance claims, enabling healthcare developers to access and display real-time data regarding the financial details and coverage outcomes associated with specific patient encounters for streamlined reimbursement tracking within clinical workflows.
This is only supported in ATHENA.
Use Cases:
Retrieve Claim Details: Obtain information on a specific claim
Access Reimbursement Data: Retrieve reimbursement details
Query Adjudication Results: Obtain results of claim adjudication
Review Benefit Explanations: Access explanations for benefits
Examine Payment Information: Retrieve payment details for a claim
Request Params
| Key | Datatype | Required | Description |
|---|---|---|---|
patient | string | (Required) The patient identifier associated with the explanation of benefit. |
HEADERS
| Key | Datatype | Required | Description |
|---|---|---|---|
x-source-id | string | (Required) The source id provided for connecting to the data source | |
Authorization | string |
RESPONSES
status: OK
[{"context":{"requestId":"\u003cstring\u003e","source":"\u003cstring\u003e","quorum":"\u003cboolean\u003e","notify":"\u003cboolean\u003e"},"data":{"resourceType":"Bundle","total":"\u003cinteger\u003e","type":"transaction-response","entry":[{"resource":{"resourceType":"ExplanationOfBenefit","id":"\u003cstring\u003e","identifier":[{"value":"\u003cstring\u003e","type":{"text":"\u003cstring\u003e"}},{"value":"\u003cstring\u003e","type":{"text":"\u003cstring\u003e"}}],"status":"entered-in-error","use":"claim","outcome":"queued","insurance":[{"extension":[{"url":"\u003cstring\u003e","valueString":"\u003cstring\u003e"},{"url":"\u003cstring\u003e","valueString":"\u003cstring\u003e"}]},{"extension":[{"url":"\u003cstring\u003e","valueString":"\u003cstring\u003e"},{"url":"\u003cstring\u003e","valueString":"\u003cstring\u003e"}]}],"provider":{"reference":"\u003cstring\u003e"},"extension":[{"url":"\u003cstring\u003e","valueString":"\u003cstring\u003e","valueBoolean":"\u003cboolean\u003e"},{"url":"\u003cstring\u003e","valueString":"\u003cstring\u003e","valueBoolean":"\u003cboolean\u003e"}],"patient":{"reference":"\u003cstring\u003e"},"benefitPeriod":{}}},{"resource":{"resourceType":"ExplanationOfBenefit","id":"\u003cstring\u003e","identifier":[{"value":"\u003cstring\u003e","type":{"text":"\u003cstring\u003e"}},{"value":"\u003cstring\u003e","type":{"text":"\u003cstring\u003e"}}],"status":"active","use":"preauthorization","outcome":"queued","insurance":[{"extension":[{"url":"\u003cstring\u003e","valueString":"\u003cstring\u003e"},{"url":"\u003cstring\u003e","valueString":"\u003cstring\u003e"}]},{"extension":[{"url":"\u003cstring\u003e","valueString":"\u003cstring\u003e"},{"url":"\u003cstring\u003e","valueString":"\u003cstring\u003e"}]}],"provider":{"reference":"\u003cstring\u003e"},"extension":[{"url":"\u003cstring\u003e","valueString":"\u003cstring\u003e","valueBoolean":"\u003cboolean\u003e"},{"url":"\u003cstring\u003e","valueString":"\u003cstring\u003e","valueBoolean":"\u003cboolean\u003e"}],"patient":{"reference":"\u003cstring\u003e"},"benefitPeriod":{}}}]}},{"context":{"requestId":"\u003cstring\u003e","source":"\u003cstring\u003e","quorum":"\u003cboolean\u003e","notify":"\u003cboolean\u003e"},"data":{"resourceType":"Bundle","total":"\u003cinteger\u003e","type":"document","entry":[{"resource":{"resourceType":"ExplanationOfBenefit","id":"\u003cstring\u003e","identifier":[{"value":"\u003cstring\u003e","type":{"text":"\u003cstring\u003e"}},{"value":"\u003cstring\u003e","type":{"text":"\u003cstring\u003e"}}],"status":"entered-in-error","use":"preauthorization","outcome":"complete","insurance":[{"extension":[{"url":"\u003cstring\u003e","valueString":"\u003cstring\u003e"},{"url":"\u003cstring\u003e","valueString":"\u003cstring\u003e"}]},{"extension":[{"url":"\u003cstring\u003e","valueString":"\u003cstring\u003e"},{"url":"\u003cstring\u003e","valueString":"\u003cstring\u003e"}]}],"provider":{"reference":"\u003cstring\u003e"},"extension":[{"url":"\u003cstring\u003e","valueString":"\u003cstring\u003e","valueBoolean":"\u003cboolean\u003e"},{"url":"\u003cstring\u003e","valueString":"\u003cstring\u003e","valueBoolean":"\u003cboolean\u003e"}],"patient":{"reference":"\u003cstring\u003e"},"benefitPeriod":{}}},{"resource":{"resourceType":"ExplanationOfBenefit","id":"\u003cstring\u003e","identifier":[{"value":"\u003cstring\u003e","type":{"text":"\u003cstring\u003e"}},{"value":"\u003cstring\u003e","type":{"text":"\u003cstring\u003e"}}],"status":"cancelled","use":"predetermination","outcome":"complete","insurance":[{"extension":[{"url":"\u003cstring\u003e","valueString":"\u003cstring\u003e"},{"url":"\u003cstring\u003e","valueString":"\u003cstring\u003e"}]},{"extension":[{"url":"\u003cstring\u003e","valueString":"\u003cstring\u003e"},{"url":"\u003cstring\u003e","valueString":"\u003cstring\u003e"}]}],"provider":{"reference":"\u003cstring\u003e"},"extension":[{"url":"\u003cstring\u003e","valueString":"\u003cstring\u003e","valueBoolean":"\u003cboolean\u003e"},{"url":"\u003cstring\u003e","valueString":"\u003cstring\u003e","valueBoolean":"\u003cboolean\u003e"}],"patient":{"reference":"\u003cstring\u003e"},"benefitPeriod":{}}}]}}]