Flexpa
Developer PortalFeedbackContact usOnboard

Guides

  • Home
  • Quickstart
  • Financial Data

Network

  • Network guide
  • Directory
  • Updates

Consent

  • Link SDK
  • Patient access

Records

  • FHIR API
  • Node SDK
  • FHIR Introduction
  • Usage
  • Terminology
    • AllergyIntolerance
    • Bundle
    • CarePlan
    • CareTeam
    • Condition
    • Coverage
    • Device
    • DiagnosticReport
    • DocumentReference
    • Encounter
    • ExplanationOfBenefit
      • Schema
      • Examples
      • API
    • Goal
    • Immunization
    • Location
    • Medication
    • MedicationDispense
    • MedicationRequest
    • Observation
    • OperationOutcome
    • Organization
    • Patient
    • Practitioner
    • PractitionerRole
    • Procedure
    • Provenance

Misc

  • Changelog
  • Support
  • Flexpa OS
  • We're hiring

ExplanationOfBenefit

Explanation of Benefit (EOB) is a FHIR resource ( JSON example) that contains a statement from a health insurance plan describing what costs will be covered for medical care received (e.g., a medical procedure or a prescription) by a covered person.

There are three main types of EOBs:

  1. Institutional - A claim for inpatient or outpatient institutional care. Based on UB-04 / CMS-1450. In Medicare, corresponds to Part A claims.
  2. Professional - A claim for physician or other professional care outside of an institution. Based on CMS-1500. In Medicare, corresponds to Part B claims.
  3. Pharmacy - A claim for a prescription or other pharmacy product. Based on NCPDP standards.

A history of EOBs can aid in workflows where the financial aspects of care are important, such as recommending the best health insurance plans during enrollment periods or calculating the patient's liability for a newly billed service.

As a core financial resource, almost all payers make this available and is one of the most important resources Flexpa uniquely provides access to today.

#Schema

An EOB response contains many fields. You can see an exhaustive list and explanation of each field in the HL7 FHIR documentation.

NameJSONDescription
Claim typetype.coding[].codeIndicates the type of EOB, either institutional, professional, or pharmacy
StatusstatusEither active or cancelled, see Payment for details about whether the claim was approved
PatientpatientThe patient for whom the claim was generated
ProviderproviderThe provider who rendered the service including NPI codes
Diagnosisdiagnosis[]Pertinent diagnosis information typically coded as ICD-10-CM
Procedureprocedure[]Clinical procedures performed typically coded as ICD-10-CM or CPT
Line itemsitem[]Line item amounts, amount types and the in network or out of network payment status of the line typically coded as AMA CPT, CMS HCPCS, CMS HIPPS, or NDC
Supporting informationsupportingInfo[]Additional information codes such as admission type, discharge status, DRG, or refill number
PaymentpaymentPayment details including an adjudication status of paid, denied, or partiallypaid
Adjudication totalstotal[]Including the amount the insurer paid and the amount the patient paid out-of-pocket

#Profiles

EOBs are profiled in the CARIN Blue Button 2.0 Implementation Guide to provide a standardized structure for EOBs. The following profiles are available in Flexpa:

  • C4BB ExplanationOfBenefit Inpatient Institutional ( JSON example)
  • C4BB ExplanationOfBenefit Outpatient Institutional ( JSON example)
  • C4BB ExplanationOfBenefit Pharmacy ( JSON example)
  • C4BB ExplanationOfBenefit Professional NonClinician ( JSON example)
  • C4BB ExplanationOfBenefit Oral ( JSON example)

#Examples

  • Humana
  • Kaiser Permanente
  • UnitedHealthcare

You can download a file with a broad set of EOB examples here.

#API

Explanation of Benefit is available in the Flexpa API via the following request:

GET https://api.flexpa.com/fhir/ExplanationOfBenefit

#Request

While some servers may support a resource-level search without any parameters, not all do. We recommend using the format below with the patient ID via the $PATIENT_ID wildcard as a search parameter.

This is a sample request using curl

ACCESS_TOKEN=flexpa-link-access-token

curl "https://api.flexpa.com/fhir/ExplanationOfBenefit?patient=$PATIENT_ID" \
  -H "Authorization: Bearer $ACCESS_TOKEN"

#Search parameters

The full list of search parameters can be found here. Some of the most important are:

Parameters

patientstring

The ID of the patient for whom the explanation of benefits was generated. We recommend using this search parameter along with the $PATIENT_ID wildcard

typestring

The type of claim. Can be one of the following: "institutional", "oral", "pharmacy", "professional" or "vision"

createdstring

The date the EOB was created. Can be a date range, e.g. created=gt2021-01-01&created=lt2021-02-01

statusstring

The status of the EOB. Can be one of the following: "active", "cancelled", "draft", "entered-in-error", "unknown". Draft ExplanationOfBenefits are not commonly available today.

#Sample Response

This is a sample response from Humana using Flexpa API in test mode

Status TwitterGitHub

© 2025 Flexpa. All rights reserved.

On this page
  • Schema
  • Profiles
  • Examples
  • API
  • Request
  • Search parameters
  • Sample Response