# ExplanationOfBenefit

Canonical page: https://docs.ovok.com/api/fhir/r4/explanation-of-benefit

This resource provides: the claim details; adjudication details from the processing of a Claim; and optionally account balance information, for informing the subscriber of the benefits provided.

These interaction paths describe standard FHIR R4 patterns. Availability can depend on the API capabilities enabled for your Ovok project.

| **Interaction** | **Method** | **Path** |
| --- | --- | --- |
| Read | `GET` | `/fhir/R4/ExplanationOfBenefit/[id]` |
| Vread | `GET` | `/fhir/R4/ExplanationOfBenefit/[id]/_history/[vid]` |
| Update | `PUT` | `/fhir/R4/ExplanationOfBenefit/[id]` |
| Patch | `PATCH` | `/fhir/R4/ExplanationOfBenefit/[id]` |
| Delete | `DELETE` | `/fhir/R4/ExplanationOfBenefit/[id]` |
| Create | `POST` | `/fhir/R4/ExplanationOfBenefit` |
| Search | `GET` | `/fhir/R4/ExplanationOfBenefit` |
| History | `GET` | `/fhir/R4/ExplanationOfBenefit/[id]/_history` |

## Top-level elements [#top-level-elements]

| **Element** | **Type** | **Cardinality** | **Description** |
| --- | --- | --- | --- |
| <span id="element-id"></span>`id` | [string](/fhir-elements/primitive/string) | `0..1` | Logical id of this artifact |
| <span id="element-meta"></span>`meta` | [Meta](/fhir-elements/complex/meta) | `0..1` | Metadata about the resource |
| <span id="element-implicit-rules"></span>`implicitRules` | [uri](/fhir-elements/primitive/uri) | `0..1` | A set of rules under which this content was created |
| <span id="element-language"></span>`language` | [code](/fhir-elements/primitive/code) | `0..1` | Language of the resource content |
| <span id="element-text"></span>`text` | [Narrative](/fhir-elements/complex/narrative) | `0..1` | Text summary of the resource, for human interpretation |
| <span id="element-contained"></span>`contained` | [Resource](/fhir-elements/foundation/resource) | `0..*` | Contained, inline Resources |
| <span id="element-extension"></span>`extension` | [Extension](/fhir-elements/complex/extension) | `0..*` | Additional content defined by implementations |
| <span id="element-modifier-extension"></span>`modifierExtension` | [Extension](/fhir-elements/complex/extension) | `0..*` | Extensions that cannot be ignored |
| <span id="element-identifier"></span>`identifier` | [Identifier](/fhir-elements/complex/identifier) | `0..*` | Business Identifier for the resource |
| <span id="element-status"></span>`status` | [code](/fhir-elements/primitive/code) | `1..1` | active \| cancelled \| draft \| entered-in-error |
| <span id="element-type"></span>`type` | [CodeableConcept](/fhir-elements/complex/codeable-concept) | `1..1` | Category or discipline |
| <span id="element-sub-type"></span>`subType` | [CodeableConcept](/fhir-elements/complex/codeable-concept) | `0..1` | More granular claim type |
| <span id="element-use"></span>`use` | [code](/fhir-elements/primitive/code) | `1..1` | claim \| preauthorization \| predetermination |
| <span id="element-patient"></span>`patient` | [Reference](/fhir-elements/complex/reference) | `1..1` | The recipient of the products and services |
| <span id="element-billable-period"></span>`billablePeriod` | [Period](/fhir-elements/complex/period) | `0..1` | Relevant time frame for the claim |
| <span id="element-created"></span>`created` | [dateTime](/fhir-elements/primitive/date-time) | `1..1` | Response creation date |
| <span id="element-enterer"></span>`enterer` | [Reference](/fhir-elements/complex/reference) | `0..1` | Author of the claim |
| <span id="element-insurer"></span>`insurer` | [Reference](/fhir-elements/complex/reference) | `1..1` | Party responsible for reimbursement |
| <span id="element-provider"></span>`provider` | [Reference](/fhir-elements/complex/reference) | `1..1` | Party responsible for the claim |
| <span id="element-priority"></span>`priority` | [CodeableConcept](/fhir-elements/complex/codeable-concept) | `0..1` | Desired processing urgency |
| <span id="element-funds-reserve-requested"></span>`fundsReserveRequested` | [CodeableConcept](/fhir-elements/complex/codeable-concept) | `0..1` | For whom to reserve funds |
| <span id="element-funds-reserve"></span>`fundsReserve` | [CodeableConcept](/fhir-elements/complex/codeable-concept) | `0..1` | Funds reserved status |
| <span id="element-related"></span>`related` | [BackboneElement](/fhir-elements/complex/backbone-element) | `0..*` | Prior or corollary claims |
| <span id="element-prescription"></span>`prescription` | [Reference](/fhir-elements/complex/reference) | `0..1` | Prescription authorizing services or products |
| <span id="element-original-prescription"></span>`originalPrescription` | [Reference](/fhir-elements/complex/reference) | `0..1` | Original prescription if superceded by fulfiller |
| <span id="element-payee"></span>`payee` | [BackboneElement](/fhir-elements/complex/backbone-element) | `0..1` | Recipient of benefits payable |
| <span id="element-referral"></span>`referral` | [Reference](/fhir-elements/complex/reference) | `0..1` | Treatment Referral |
| <span id="element-facility"></span>`facility` | [Reference](/fhir-elements/complex/reference) | `0..1` | Servicing Facility |
| <span id="element-claim"></span>`claim` | [Reference](/fhir-elements/complex/reference) | `0..1` | Claim reference |
| <span id="element-claim-response"></span>`claimResponse` | [Reference](/fhir-elements/complex/reference) | `0..1` | Claim response reference |
| <span id="element-outcome"></span>`outcome` | [code](/fhir-elements/primitive/code) | `1..1` | queued \| complete \| error \| partial |
| <span id="element-disposition"></span>`disposition` | [string](/fhir-elements/primitive/string) | `0..1` | Disposition Message |
| <span id="element-pre-auth-ref"></span>`preAuthRef` | [string](/fhir-elements/primitive/string) | `0..*` | Preauthorization reference |
| <span id="element-pre-auth-ref-period"></span>`preAuthRefPeriod` | [Period](/fhir-elements/complex/period) | `0..*` | Preauthorization in-effect period |
| <span id="element-care-team"></span>`careTeam` | [BackboneElement](/fhir-elements/complex/backbone-element) | `0..*` | Care Team members |
| <span id="element-supporting-info"></span>`supportingInfo` | [BackboneElement](/fhir-elements/complex/backbone-element) | `0..*` | Supporting information |
| <span id="element-diagnosis"></span>`diagnosis` | [BackboneElement](/fhir-elements/complex/backbone-element) | `0..*` | Pertinent diagnosis information |
| <span id="element-procedure"></span>`procedure` | [BackboneElement](/fhir-elements/complex/backbone-element) | `0..*` | Clinical procedures performed |
| <span id="element-precedence"></span>`precedence` | [positiveInt](/fhir-elements/primitive/positive-int) | `0..1` | Precedence (primary, secondary, etc.) |
| <span id="element-insurance"></span>`insurance` | [BackboneElement](/fhir-elements/complex/backbone-element) | `1..*` | Patient insurance information |
| <span id="element-accident"></span>`accident` | [BackboneElement](/fhir-elements/complex/backbone-element) | `0..1` | Details of the event |
| <span id="element-item"></span>`item` | [BackboneElement](/fhir-elements/complex/backbone-element) | `0..*` | Product or service provided |
| <span id="element-add-item"></span>`addItem` | [BackboneElement](/fhir-elements/complex/backbone-element) | `0..*` | Insurer added line items |
| <span id="element-adjudication"></span>`adjudication` | [BackboneElement](/fhir-elements/complex/backbone-element) | `0..*` | Header-level adjudication |
| <span id="element-total"></span>`total` | [BackboneElement](/fhir-elements/complex/backbone-element) | `0..*` | Adjudication totals |
| <span id="element-payment"></span>`payment` | [BackboneElement](/fhir-elements/complex/backbone-element) | `0..1` | Payment Details |
| <span id="element-form-code"></span>`formCode` | [CodeableConcept](/fhir-elements/complex/codeable-concept) | `0..1` | Printed form identifier |
| <span id="element-form"></span>`form` | [Attachment](/fhir-elements/complex/attachment) | `0..1` | Printed reference or actual form |
| <span id="element-process-note"></span>`processNote` | [BackboneElement](/fhir-elements/complex/backbone-element) | `0..*` | Note concerning adjudication |
| <span id="element-benefit-period"></span>`benefitPeriod` | [Period](/fhir-elements/complex/period) | `0..1` | When the benefits are applicable |
| <span id="element-benefit-balance"></span>`benefitBalance` | [BackboneElement](/fhir-elements/complex/backbone-element) | `0..*` | Balance by Benefit Category |

## Resource-specific search parameters [#resource-specific-search-parameters]

| **Parameter** | **Type** | **Description** |
| --- | --- | --- |
| `care-team` | reference | Member of the CareTeam |
| `claim` | reference | The reference to the claim |
| `coverage` | reference | The plan under which the claim was adjudicated |
| `created` | date | The creation date for the EOB |
| `detail-udi` | reference | UDI associated with a line item detail product or service |
| `disposition` | string | The contents of the disposition message |
| `encounter` | reference | Encounters associated with a billed line item |
| `enterer` | reference | The party responsible for the entry of the Claim |
| `facility` | reference | Facility responsible for the goods and services |
| `identifier` | token | The business identifier of the Explanation of Benefit |
| `item-udi` | reference | UDI associated with a line item product or service |
| `patient` | reference | The reference to the patient |
| `payee` | reference | The party receiving any payment for the Claim |
| `procedure-udi` | reference | UDI associated with a procedure |
| `provider` | reference | The reference to the provider |
| `status` | token | Status of the instance |
| `subdetail-udi` | reference | UDI associated with a line item detail subdetail product or service |

## Reference [#reference]

Official FHIR R4 spec: [ExplanationOfBenefit](https://hl7.org/fhir/R4/explanationofbenefit.html).  
Maturity: Trial Use 2 (FMM 2).
