This page is part of the FHIR Specification (v1.2.0: STU 3 Draft). The current version which supercedes this version is 5.0.0. For a full list of available versions, see the Directory of published versions . Page versions: R5 R4B R4 R3 R2
This resource is marked as a draft.
Financial Management Work Group | Maturity Level: 0 | Compartments: Not linked to any defined compartments |
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.
This resource has not yet undergone proper review by FM. At this time, it is to be considered as a draft.
The ExplanationOfBenefit resource combines key information from a Claim, a ClaimResponse and optional Account information to inform a patient of the goods and services rendered by a provider and the settlement made under the patients coverage in respect of that Claim.
This is the logical combination of the Claim, Claim Response and some Coverage accounting information in respect of a single payor prepared for consumption by the subscriber and/or patient. It is not simply a series of pointers to referred-to content models, is a physical subset scoped to the adjudication by a single payor which details the services rendered, the amounts to be settled and to whom, and optionally the coverage used and/or remaining.
Todo
Structure
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
ExplanationOfBenefit | Σ | DomainResource | Explanation of Benefit resource | |
identifier | Σ | 0..* | Identifier | Business Identifier |
claim | Σ | 0..1 | Reference(Claim) | Claim reference |
claimResponse | Σ | 0..1 | Reference(ClaimResponse) | Claim response reference |
ruleset | Σ | 0..1 | Coding | Current specification followed Ruleset Codes (Example) |
originalRuleset | Σ | 0..1 | Coding | Original specification followed Ruleset Codes (Example) |
created | Σ | 0..1 | dateTime | Creation date |
billablePeriod | Σ | 0..1 | Period | Period for charge submission |
disposition | Σ | 0..1 | string | Disposition Message |
provider | Σ | 0..1 | Reference(Practitioner) | Responsible provider for the claim |
organization | Σ | 0..1 | Reference(Organization) | Responsible organization for the claim |
facility | Σ | 0..1 | Reference(Location) | Servicing Facility |
relatedClaim | Σ | 0..* | Reference(Claim) | Related Claims |
prescription | Σ | 0..1 | Reference(MedicationOrder | VisionPrescription) | Prescription |
originalPrescription | Σ | 0..1 | Reference(MedicationOrder) | Original Prescription |
payee | Σ | 0..1 | BackboneElement | Payee |
type | Σ | 0..1 | Coding | Party to be paid any benefits payable Payee Type Codes (Example) |
provider | Σ | 0..1 | Reference(Practitioner) | Provider who is the payee |
organization | Σ | 0..1 | Reference(Organization) | Organization who is the payee |
person | Σ | 0..1 | Reference(Patient) | Other person who is the payee |
referral | Σ | 0..1 | Reference(ReferralRequest) | Treatment Referral |
diagnosis | Σ | 0..* | BackboneElement | Diagnosis |
sequence | Σ | 1..1 | positiveInt | Sequence of diagnosis |
diagnosis | Σ | 1..1 | Coding | Patient's list of diagnosis ICD-10 Codes (Example) |
specialCondition | Σ | 0..* | Coding | List of special Conditions Conditions Codes (Example) |
patient | Σ | 1..1 | Reference(Patient) | The subject of the Products and Services |
precedence | Σ | 0..1 | positiveInt | Precedence (primary, secondary, etc.) |
coverage | Σ | 1..1 | BackboneElement | Insurance or medical plan |
coverage | Σ | 1..1 | Reference(Coverage) | Insurance information |
relationship | Σ | 1..1 | Coding | Patient relationship to subscriber Surface Codes (Example) |
preAuthRef | Σ | 0..* | string | Pre-Authorization/Determination Reference |
exception | Σ | 0..* | Coding | Eligibility exceptions Exception Codes (Example) |
school | Σ | 0..1 | string | Name of School |
accidentDate | Σ | 0..1 | date | Accident Date |
accidentType | Σ | 0..1 | Coding | Accident Type ActIncidentCode (Required) |
accidentLocation[x] | Σ | 0..1 | Accident Place | |
accidentLocationString | string | |||
accidentLocationAddress | Address | |||
accidentLocationReference | Reference(Location) | |||
interventionException | Σ | 0..* | Coding | Intervention and exception code (Pharma) Intervention Codes (Example) |
onset[x] | Σ | 0..1 | Illness, injury or treatable condition date | |
onsetDate | date | |||
onsetPeriod | Period | |||
employmentImpacted | Σ | 0..1 | Period | Period unable to work |
hospitalization | Σ | 0..1 | Period | Period in hospital |
item | Σ | 0..* | BackboneElement | Goods and Services |
sequence | Σ | 1..1 | positiveInt | Service instance |
type | Σ | 1..1 | Coding | Group or type of product or service ActInvoiceGroupCode (Required) |
provider | Σ | 0..1 | Reference(Practitioner) | Responsible practitioner |
diagnosisLinkId | Σ | 0..* | positiveInt | Diagnosis Link |
service | Σ | 1..1 | Coding | Item Code USCLS Codes (Example) |
serviced[x] | Σ | 0..1 | Date or dates of Service | |
servicedDate | date | |||
servicedPeriod | Period | |||
place | Σ | 0..1 | Coding | Place of service Example Service Place Codes (Example) |
quantity | Σ | 0..1 | SimpleQuantity | Count of Products or Services |
unitPrice | Σ | 0..1 | Money | Fee, charge or cost per point |
factor | Σ | 0..1 | decimal | Price scaling factor |
points | Σ | 0..1 | decimal | Difficulty scaling factor |
net | Σ | 0..1 | Money | Total item cost |
udi | Σ | 0..1 | Coding | Unique Device Identifier UDI Codes (Example) |
bodySite | Σ | 0..1 | Coding | Service Location Surface Codes (Example) |
subSite | Σ | 0..* | Coding | Service Sub-location Surface Codes (Example) |
modifier | Σ | 0..* | Coding | Service/Product billing modifiers Modifier type Codes (Example) |
noteNumber | Σ | 0..* | positiveInt | List of note numbers which apply |
adjudication | Σ | 0..* | BackboneElement | Adjudication details |
category | Σ | 1..1 | Coding | Adjudication category such as co-pay, eligible, benefit, etc. Adjudication Codes (Extensible) |
reason | Σ | 0..1 | Coding | Adjudication reason Adjudication Reason Codes (Extensible) |
amount | Σ | 0..1 | Money | Monetary amount |
value | Σ | 0..1 | decimal | Non-monitory value |
detail | Σ | 0..* | BackboneElement | Additional items |
sequence | Σ | 1..1 | positiveInt | Service instance |
type | Σ | 1..1 | Coding | Group or type of product or service ActInvoiceGroupCode (Required) |
service | Σ | 1..1 | Coding | Additional item codes USCLS Codes (Example) |
quantity | Σ | 0..1 | SimpleQuantity | Count of Products or Services |
unitPrice | Σ | 0..1 | Money | Fee, charge or cost per point |
factor | Σ | 0..1 | decimal | Price scaling factor |
points | Σ | 0..1 | decimal | Difficulty scaling factor |
net | Σ | 0..1 | Money | Total additional item cost |
udi | Σ | 0..1 | Coding | Unique Device Identifier UDI Codes (Example) |
adjudication | Σ | 0..* | BackboneElement | Detail adjudication |
code | Σ | 1..1 | Coding | Adjudication category such as co-pay, eligible, benefit, etc. Adjudication Codes (Extensible) |
reason | Σ | 0..1 | Coding | Adjudication reason Adjudication Reason Codes (Extensible) |
amount | Σ | 0..1 | Money | Monetary amount |
value | Σ | 0..1 | decimal | Non-monitory value |
subDetail | Σ | 0..* | BackboneElement | Additional items |
sequence | Σ | 1..1 | positiveInt | Service instance |
type | Σ | 1..1 | Coding | Type of product or service ActInvoiceGroupCode (Required) |
service | Σ | 1..1 | Coding | Additional item codes USCLS Codes (Example) |
quantity | Σ | 0..1 | SimpleQuantity | Count of Products or Services |
unitPrice | Σ | 0..1 | Money | Fee, charge or cost per point |
factor | Σ | 0..1 | decimal | Price scaling factor |
points | Σ | 0..1 | decimal | Difficulty scaling factor |
net | Σ | 0..1 | Money | Net additional item cost |
udi | Σ | 0..1 | Coding | Unique Device Identifier UDI Codes (Example) |
adjudication | Σ | 0..* | BackboneElement | SubDetail adjudication |
code | Σ | 1..1 | Coding | Adjudication category such as co-pay, eligible, benefit, etc. Adjudication Codes (Extensible) |
reason | Σ | 0..1 | Coding | Adjudication reason Adjudication Reason Codes (Extensible) |
amount | Σ | 0..1 | Money | Monetary amount |
value | Σ | 0..1 | decimal | Non-monitory value |
prosthesis | Σ | 0..1 | BackboneElement | Prosthetic details |
initial | Σ | 0..1 | boolean | Is this the initial service |
priorDate | Σ | 0..1 | date | Initial service Date |
priorMaterial | Σ | 0..1 | Coding | Prosthetic Material Oral Prostho Material type Codes (Example) |
addItem | Σ | 0..* | BackboneElement | Insurer added line items |
sequenceLinkId | Σ | 0..* | positiveInt | Service instances |
service | Σ | 1..1 | Coding | Group, Service or Product USCLS Codes (Example) |
fee | Σ | 0..1 | Money | Professional fee or Product charge |
noteNumberLinkId | Σ | 0..* | positiveInt | List of note numbers which apply |
adjudication | Σ | 0..* | BackboneElement | Added items adjudication |
code | Σ | 1..1 | Coding | Adjudication category such as co-pay, eligible, benefit, etc. Adjudication Codes (Extensible) |
amount | Σ | 0..1 | Money | Monetary amount |
value | Σ | 0..1 | decimal | Non-monitory value |
detail | Σ | 0..* | BackboneElement | Added items details |
service | Σ | 1..1 | Coding | Service or Product USCLS Codes (Example) |
fee | Σ | 0..1 | Money | Professional fee or Product charge |
adjudication | Σ | 0..* | BackboneElement | Added items detail adjudication |
code | Σ | 1..1 | Coding | Adjudication category such as co-pay, eligible, benefit, etc. Adjudication Codes (Extensible) |
amount | Σ | 0..1 | Money | Monetary amount |
value | Σ | 0..1 | decimal | Non-monitory value |
claimTotal | Σ | 0..1 | Money | Total claim cost |
missingTeeth | Σ | 0..* | BackboneElement | Only if type = oral |
tooth | Σ | 1..1 | Coding | Tooth Code Teeth Codes (Example) |
reason | Σ | 0..1 | Coding | Reason for missing Missing Tooth Reason Codes (Example) |
extractionDate | Σ | 0..1 | date | Date of Extraction |
unallocDeductable | Σ | 0..1 | Money | Unallocated deductable |
totalBenefit | Σ | 0..1 | Money | Total benefit payable for the Claim |
paymentAdjustment | Σ | 0..1 | Money | Payment adjustment for non-Claim issues |
paymentAdjustmentReason | Σ | 0..1 | Coding | Reason for Payment adjustment Payment Adjustment Reason Codes (Extensible) |
paymentDate | Σ | 0..1 | date | Expected data of Payment |
paymentAmount | Σ | 0..1 | Money | Payment amount |
paymentRef | Σ | 0..1 | Identifier | Payment identifier |
reserved | Σ | 0..1 | Coding | Funds reserved status Funds Reservation Codes (Example) |
form | Σ | 0..1 | Coding | Printed Form Identifier Form Codes (Required) |
note | Σ | 0..* | BackboneElement | Processing notes |
number | Σ | 0..1 | positiveInt | Note Number for this note |
type | Σ | 0..1 | Coding | display | print | printoper NoteType (Required) |
text | Σ | 0..1 | string | Note explanitory text |
benefitBalance | Σ | 0..* | BackboneElement | Balance by Benefit Category |
category | Σ | 1..1 | Coding | Benefit Category Benefit Category Codes (Example) |
subCategory | Σ | 0..1 | Coding | Benefit SubCategory Benefit SubCategory Codes (Example) |
network | Σ | 0..1 | Coding | In or out of network Network Type Codes (Example) |
unit | Σ | 0..1 | Coding | Individual or family Unit Type Codes (Example) |
term | Σ | 0..1 | Coding | Annual or lifetime Benefit Term Codes (Example) |
financial | Σ | 0..* | BackboneElement | Benefit Summary |
type | Σ | 1..1 | Coding | Deductable, visits, benefit amount Benefit Type Codes (Example) |
benefit[x] | Σ | 0..1 | Benefits allowed | |
benefitUnsignedInt | unsignedInt | |||
benefitQuantity | Money | |||
benefitUsed[x] | Σ | 0..1 | Benefits used | |
benefitUsedUnsignedInt | unsignedInt | |||
benefitUsedQuantity | Money | |||
Documentation for this format |
UML Diagram
XML Template
<ExplanationOfBenefit xmlns="http://hl7.org/fhir"> <!-- from Resource: id, meta, implicitRules, and language --> <!-- from DomainResource: text, contained, extension, and modifierExtension --> <identifier><!-- 0..* Identifier Business Identifier --></identifier> <claim><!-- 0..1 Reference(Claim) Claim reference --></claim> <claimResponse><!-- 0..1 Reference(ClaimResponse) Claim response reference --></claimResponse> <ruleset><!-- 0..1 Coding Current specification followed --></ruleset> <originalRuleset><!-- 0..1 Coding Original specification followed --></originalRuleset> <created value="[dateTime]"/><!-- 0..1 Creation date --> <billablePeriod><!-- 0..1 Period Period for charge submission --></billablePeriod> <disposition value="[string]"/><!-- 0..1 Disposition Message --> <provider><!-- 0..1 Reference(Practitioner) Responsible provider for the claim --></provider> <organization><!-- 0..1 Reference(Organization) Responsible organization for the claim --></organization> <facility><!-- 0..1 Reference(Location) Servicing Facility --></facility> <relatedClaim><!-- 0..* Reference(Claim) Related Claims --></relatedClaim> <prescription><!-- 0..1 Reference(MedicationOrder|VisionPrescription) Prescription --></prescription> <originalPrescription><!-- 0..1 Reference(MedicationOrder) Original Prescription --></originalPrescription> <payee> <!-- 0..1 Payee --> <type><!-- 0..1 Coding Party to be paid any benefits payable --></type> <provider><!-- 0..1 Reference(Practitioner) Provider who is the payee --></provider> <organization><!-- 0..1 Reference(Organization) Organization who is the payee --></organization> <person><!-- 0..1 Reference(Patient) Other person who is the payee --></person> </payee> <referral><!-- 0..1 Reference(ReferralRequest) Treatment Referral --></referral> <diagnosis> <!-- 0..* Diagnosis --> <sequence value="[positiveInt]"/><!-- 1..1 Sequence of diagnosis --> <diagnosis><!-- 1..1 Coding Patient's list of diagnosis --></diagnosis> </diagnosis> <specialCondition><!-- 0..* Coding List of special Conditions --></specialCondition> <patient><!-- 1..1 Reference(Patient) The subject of the Products and Services --></patient> <precedence value="[positiveInt]"/><!-- 0..1 Precedence (primary, secondary, etc.) --> <coverage> <!-- 1..1 Insurance or medical plan --> <coverage><!-- 1..1 Reference(Coverage) Insurance information --></coverage> <relationship><!-- 1..1 Coding Patient relationship to subscriber --></relationship> <preAuthRef value="[string]"/><!-- 0..* Pre-Authorization/Determination Reference --> </coverage> <exception><!-- 0..* Coding Eligibility exceptions --></exception> <school value="[string]"/><!-- 0..1 Name of School --> <accidentDate value="[date]"/><!-- 0..1 Accident Date --> <accidentType><!-- 0..1 Coding Accident Type --></accidentType> <accidentLocation[x]><!-- 0..1 string|Address|Reference(Location) Accident Place --></accidentLocation[x]> <interventionException><!-- 0..* Coding Intervention and exception code (Pharma) --></interventionException> <onset[x]><!-- 0..1 date|Period Illness, injury or treatable condition date --></onset[x]> <employmentImpacted><!-- 0..1 Period Period unable to work --></employmentImpacted> <hospitalization><!-- 0..1 Period Period in hospital --></hospitalization> <item> <!-- 0..* Goods and Services --> <sequence value="[positiveInt]"/><!-- 1..1 Service instance --> <type><!-- 1..1 Coding Group or type of product or service --></type> <provider><!-- 0..1 Reference(Practitioner) Responsible practitioner --></provider> <diagnosisLinkId value="[positiveInt]"/><!-- 0..* Diagnosis Link --> <service><!-- 1..1 Coding Item Code --></service> <serviced[x]><!-- 0..1 date|Period Date or dates of Service --></serviced[x]> <place><!-- 0..1 Coding Place of service --></place> <quantity><!-- 0..1 Quantity(SimpleQuantity) Count of Products or Services --></quantity> <unitPrice><!-- 0..1 Quantity(Money) Fee, charge or cost per point --></unitPrice> <factor value="[decimal]"/><!-- 0..1 Price scaling factor --> <points value="[decimal]"/><!-- 0..1 Difficulty scaling factor --> <net><!-- 0..1 Quantity(Money) Total item cost --></net> <udi><!-- 0..1 Coding Unique Device Identifier --></udi> <bodySite><!-- 0..1 Coding Service Location --></bodySite> <subSite><!-- 0..* Coding Service Sub-location --></subSite> <modifier><!-- 0..* Coding Service/Product billing modifiers --></modifier> <noteNumber value="[positiveInt]"/><!-- 0..* List of note numbers which apply --> <adjudication> <!-- 0..* Adjudication details --> <category><!-- 1..1 Coding Adjudication category such as co-pay, eligible, benefit, etc. --></category> <reason><!-- 0..1 Coding Adjudication reason --></reason> <amount><!-- 0..1 Quantity(Money) Monetary amount --></amount> <value value="[decimal]"/><!-- 0..1 Non-monitory value --> </adjudication> <detail> <!-- 0..* Additional items --> <sequence value="[positiveInt]"/><!-- 1..1 Service instance --> <type><!-- 1..1 Coding Group or type of product or service --></type> <service><!-- 1..1 Coding Additional item codes --></service> <quantity><!-- 0..1 Quantity(SimpleQuantity) Count of Products or Services --></quantity> <unitPrice><!-- 0..1 Quantity(Money) Fee, charge or cost per point --></unitPrice> <factor value="[decimal]"/><!-- 0..1 Price scaling factor --> <points value="[decimal]"/><!-- 0..1 Difficulty scaling factor --> <net><!-- 0..1 Quantity(Money) Total additional item cost --></net> <udi><!-- 0..1 Coding Unique Device Identifier --></udi> <adjudication> <!-- 0..* Detail adjudication --> <code><!-- 1..1 Coding Adjudication category such as co-pay, eligible, benefit, etc. --></code> <reason><!-- 0..1 Coding Adjudication reason --></reason> <amount><!-- 0..1 Quantity(Money) Monetary amount --></amount> <value value="[decimal]"/><!-- 0..1 Non-monitory value --> </adjudication> <subDetail> <!-- 0..* Additional items --> <sequence value="[positiveInt]"/><!-- 1..1 Service instance --> <type><!-- 1..1 Coding Type of product or service --></type> <service><!-- 1..1 Coding Additional item codes --></service> <quantity><!-- 0..1 Quantity(SimpleQuantity) Count of Products or Services --></quantity> <unitPrice><!-- 0..1 Quantity(Money) Fee, charge or cost per point --></unitPrice> <factor value="[decimal]"/><!-- 0..1 Price scaling factor --> <points value="[decimal]"/><!-- 0..1 Difficulty scaling factor --> <net><!-- 0..1 Quantity(Money) Net additional item cost --></net> <udi><!-- 0..1 Coding Unique Device Identifier --></udi> <adjudication> <!-- 0..* SubDetail adjudication --> <code><!-- 1..1 Coding Adjudication category such as co-pay, eligible, benefit, etc. --></code> <reason><!-- 0..1 Coding Adjudication reason --></reason> <amount><!-- 0..1 Quantity(Money) Monetary amount --></amount> <value value="[decimal]"/><!-- 0..1 Non-monitory value --> </adjudication> </subDetail> </detail> <prosthesis> <!-- 0..1 Prosthetic details --> <initial value="[boolean]"/><!-- 0..1 Is this the initial service --> <priorDate value="[date]"/><!-- 0..1 Initial service Date --> <priorMaterial><!-- 0..1 Coding Prosthetic Material --></priorMaterial> </prosthesis> </item> <addItem> <!-- 0..* Insurer added line items --> <sequenceLinkId value="[positiveInt]"/><!-- 0..* Service instances --> <service><!-- 1..1 Coding Group, Service or Product --></service> <fee><!-- 0..1 Quantity(Money) Professional fee or Product charge --></fee> <noteNumberLinkId value="[positiveInt]"/><!-- 0..* List of note numbers which apply --> <adjudication> <!-- 0..* Added items adjudication --> <code><!-- 1..1 Coding Adjudication category such as co-pay, eligible, benefit, etc. --></code> <amount><!-- 0..1 Quantity(Money) Monetary amount --></amount> <value value="[decimal]"/><!-- 0..1 Non-monitory value --> </adjudication> <detail> <!-- 0..* Added items details --> <service><!-- 1..1 Coding Service or Product --></service> <fee><!-- 0..1 Quantity(Money) Professional fee or Product charge --></fee> <adjudication> <!-- 0..* Added items detail adjudication --> <code><!-- 1..1 Coding Adjudication category such as co-pay, eligible, benefit, etc. --></code> <amount><!-- 0..1 Quantity(Money) Monetary amount --></amount> <value value="[decimal]"/><!-- 0..1 Non-monitory value --> </adjudication> </detail> </addItem> <claimTotal><!-- 0..1 Quantity(Money) Total claim cost --></claimTotal> <missingTeeth> <!-- 0..* Only if type = oral --> <tooth><!-- 1..1 Coding Tooth Code --></tooth> <reason><!-- 0..1 Coding Reason for missing --></reason> <extractionDate value="[date]"/><!-- 0..1 Date of Extraction --> </missingTeeth> <unallocDeductable><!-- 0..1 Quantity(Money) Unallocated deductable --></unallocDeductable> <totalBenefit><!-- 0..1 Quantity(Money) Total benefit payable for the Claim --></totalBenefit> <paymentAdjustment><!-- 0..1 Quantity(Money) Payment adjustment for non-Claim issues --></paymentAdjustment> <paymentAdjustmentReason><!-- 0..1 Coding Reason for Payment adjustment --></paymentAdjustmentReason> <paymentDate value="[date]"/><!-- 0..1 Expected data of Payment --> <paymentAmount><!-- 0..1 Quantity(Money) Payment amount --></paymentAmount> <paymentRef><!-- 0..1 Identifier Payment identifier --></paymentRef> <reserved><!-- 0..1 Coding Funds reserved status --></reserved> <form><!-- 0..1 Coding Printed Form Identifier --></form> <note> <!-- 0..* Processing notes --> <number value="[positiveInt]"/><!-- 0..1 Note Number for this note --> <type><!-- 0..1 Coding display | print | printoper --></type> <text value="[string]"/><!-- 0..1 Note explanitory text --> </note> <benefitBalance> <!-- 0..* Balance by Benefit Category --> <category><!-- 1..1 Coding Benefit Category --></category> <subCategory><!-- 0..1 Coding Benefit SubCategory --></subCategory> <network><!-- 0..1 Coding In or out of network --></network> <unit><!-- 0..1 Coding Individual or family --></unit> <term><!-- 0..1 Coding Annual or lifetime --></term> <financial> <!-- 0..* Benefit Summary --> <type><!-- 1..1 Coding Deductable, visits, benefit amount --></type> <benefit[x]><!-- 0..1 unsignedInt|Quantity(Money) Benefits allowed --></benefit[x]> <benefitUsed[x]><!-- 0..1 unsignedInt|Quantity(Money) Benefits used --></benefitUsed[x]> </financial> </benefitBalance> </ExplanationOfBenefit>
JSON Template
{ "resourceType" : "ExplanationOfBenefit", // from Resource: id, meta, implicitRules, and language // from DomainResource: text, contained, extension, and modifierExtension "identifier" : [{ Identifier }], // Business Identifier "claim" : { Reference(Claim) }, // Claim reference "claimResponse" : { Reference(ClaimResponse) }, // Claim response reference "ruleset" : { Coding }, // Current specification followed "originalRuleset" : { Coding }, // Original specification followed "created" : "<dateTime>", // Creation date "billablePeriod" : { Period }, // Period for charge submission "disposition" : "<string>", // Disposition Message "provider" : { Reference(Practitioner) }, // Responsible provider for the claim "organization" : { Reference(Organization) }, // Responsible organization for the claim "facility" : { Reference(Location) }, // Servicing Facility "relatedClaim" : [{ Reference(Claim) }], // Related Claims "prescription" : { Reference(MedicationOrder|VisionPrescription) }, // Prescription "originalPrescription" : { Reference(MedicationOrder) }, // Original Prescription "payee" : { // Payee "type" : { Coding }, // Party to be paid any benefits payable "provider" : { Reference(Practitioner) }, // Provider who is the payee "organization" : { Reference(Organization) }, // Organization who is the payee "person" : { Reference(Patient) } // Other person who is the payee }, "referral" : { Reference(ReferralRequest) }, // Treatment Referral "diagnosis" : [{ // Diagnosis "sequence" : "<positiveInt>", // R! Sequence of diagnosis "diagnosis" : { Coding } // R! Patient's list of diagnosis }], "specialCondition" : [{ Coding }], // List of special Conditions "patient" : { Reference(Patient) }, // R! The subject of the Products and Services "precedence" : "<positiveInt>", // Precedence (primary, secondary, etc.) "coverage" : { // R! Insurance or medical plan "coverage" : { Reference(Coverage) }, // R! Insurance information "relationship" : { Coding }, // R! Patient relationship to subscriber "preAuthRef" : ["<string>"] // Pre-Authorization/Determination Reference }, "exception" : [{ Coding }], // Eligibility exceptions "school" : "<string>", // Name of School "accidentDate" : "<date>", // Accident Date "accidentType" : { Coding }, // Accident Type // accidentLocation[x]: Accident Place. One of these 3: "accidentLocationString" : "<string>", "accidentLocationAddress" : { Address }, "accidentLocationReference" : { Reference(Location) }, "interventionException" : [{ Coding }], // Intervention and exception code (Pharma) // onset[x]: Illness, injury or treatable condition date. One of these 2: "onsetDate" : "<date>", "onsetPeriod" : { Period }, "employmentImpacted" : { Period }, // Period unable to work "hospitalization" : { Period }, // Period in hospital "item" : [{ // Goods and Services "sequence" : "<positiveInt>", // R! Service instance "type" : { Coding }, // R! Group or type of product or service "provider" : { Reference(Practitioner) }, // Responsible practitioner "diagnosisLinkId" : ["<positiveInt>"], // Diagnosis Link "service" : { Coding }, // R! Item Code // serviced[x]: Date or dates of Service. One of these 2: "servicedDate" : "<date>", "servicedPeriod" : { Period }, "place" : { Coding }, // Place of service "quantity" : { Quantity(SimpleQuantity) }, // Count of Products or Services "unitPrice" : { Quantity(Money) }, // Fee, charge or cost per point "factor" : <decimal>, // Price scaling factor "points" : <decimal>, // Difficulty scaling factor "net" : { Quantity(Money) }, // Total item cost "udi" : { Coding }, // Unique Device Identifier "bodySite" : { Coding }, // Service Location "subSite" : [{ Coding }], // Service Sub-location "modifier" : [{ Coding }], // Service/Product billing modifiers "noteNumber" : ["<positiveInt>"], // List of note numbers which apply "adjudication" : [{ // Adjudication details "category" : { Coding }, // R! Adjudication category such as co-pay, eligible, benefit, etc. "reason" : { Coding }, // Adjudication reason "amount" : { Quantity(Money) }, // Monetary amount "value" : <decimal> // Non-monitory value }], "detail" : [{ // Additional items "sequence" : "<positiveInt>", // R! Service instance "type" : { Coding }, // R! Group or type of product or service "service" : { Coding }, // R! Additional item codes "quantity" : { Quantity(SimpleQuantity) }, // Count of Products or Services "unitPrice" : { Quantity(Money) }, // Fee, charge or cost per point "factor" : <decimal>, // Price scaling factor "points" : <decimal>, // Difficulty scaling factor "net" : { Quantity(Money) }, // Total additional item cost "udi" : { Coding }, // Unique Device Identifier "adjudication" : [{ // Detail adjudication "code" : { Coding }, // R! Adjudication category such as co-pay, eligible, benefit, etc. "reason" : { Coding }, // Adjudication reason "amount" : { Quantity(Money) }, // Monetary amount "value" : <decimal> // Non-monitory value }], "subDetail" : [{ // Additional items "sequence" : "<positiveInt>", // R! Service instance "type" : { Coding }, // R! Type of product or service "service" : { Coding }, // R! Additional item codes "quantity" : { Quantity(SimpleQuantity) }, // Count of Products or Services "unitPrice" : { Quantity(Money) }, // Fee, charge or cost per point "factor" : <decimal>, // Price scaling factor "points" : <decimal>, // Difficulty scaling factor "net" : { Quantity(Money) }, // Net additional item cost "udi" : { Coding }, // Unique Device Identifier "adjudication" : [{ // SubDetail adjudication "code" : { Coding }, // R! Adjudication category such as co-pay, eligible, benefit, etc. "reason" : { Coding }, // Adjudication reason "amount" : { Quantity(Money) }, // Monetary amount "value" : <decimal> // Non-monitory value }] }] }], "prosthesis" : { // Prosthetic details "initial" : <boolean>, // Is this the initial service "priorDate" : "<date>", // Initial service Date "priorMaterial" : { Coding } // Prosthetic Material } }], "addItem" : [{ // Insurer added line items "sequenceLinkId" : ["<positiveInt>"], // Service instances "service" : { Coding }, // R! Group, Service or Product "fee" : { Quantity(Money) }, // Professional fee or Product charge "noteNumberLinkId" : ["<positiveInt>"], // List of note numbers which apply "adjudication" : [{ // Added items adjudication "code" : { Coding }, // R! Adjudication category such as co-pay, eligible, benefit, etc. "amount" : { Quantity(Money) }, // Monetary amount "value" : <decimal> // Non-monitory value }], "detail" : [{ // Added items details "service" : { Coding }, // R! Service or Product "fee" : { Quantity(Money) }, // Professional fee or Product charge "adjudication" : [{ // Added items detail adjudication "code" : { Coding }, // R! Adjudication category such as co-pay, eligible, benefit, etc. "amount" : { Quantity(Money) }, // Monetary amount "value" : <decimal> // Non-monitory value }] }] }], "claimTotal" : { Quantity(Money) }, // Total claim cost "missingTeeth" : [{ // Only if type = oral "tooth" : { Coding }, // R! Tooth Code "reason" : { Coding }, // Reason for missing "extractionDate" : "<date>" // Date of Extraction }], "unallocDeductable" : { Quantity(Money) }, // Unallocated deductable "totalBenefit" : { Quantity(Money) }, // Total benefit payable for the Claim "paymentAdjustment" : { Quantity(Money) }, // Payment adjustment for non-Claim issues "paymentAdjustmentReason" : { Coding }, // Reason for Payment adjustment "paymentDate" : "<date>", // Expected data of Payment "paymentAmount" : { Quantity(Money) }, // Payment amount "paymentRef" : { Identifier }, // Payment identifier "reserved" : { Coding }, // Funds reserved status "form" : { Coding }, // Printed Form Identifier "note" : [{ // Processing notes "number" : "<positiveInt>", // Note Number for this note "type" : { Coding }, // display | print | printoper "text" : "<string>" // Note explanitory text }], "benefitBalance" : [{ // Balance by Benefit Category "category" : { Coding }, // R! Benefit Category "subCategory" : { Coding }, // Benefit SubCategory "network" : { Coding }, // In or out of network "unit" : { Coding }, // Individual or family "term" : { Coding }, // Annual or lifetime "financial" : [{ // Benefit Summary "type" : { Coding }, // R! Deductable, visits, benefit amount // benefit[x]: Benefits allowed. One of these 2: "benefitUnsignedInt" : "<unsignedInt>", "benefitQuantity" : { Quantity(Money) }, // benefitUsed[x]: Benefits used. One of these 2: "benefitUsedUnsignedInt" : "<unsignedInt>" "benefitUsedQuantity" : { Quantity(Money) } }] }] }
Structure
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
ExplanationOfBenefit | Σ | DomainResource | Explanation of Benefit resource | |
identifier | Σ | 0..* | Identifier | Business Identifier |
claim | Σ | 0..1 | Reference(Claim) | Claim reference |
claimResponse | Σ | 0..1 | Reference(ClaimResponse) | Claim response reference |
ruleset | Σ | 0..1 | Coding | Current specification followed Ruleset Codes (Example) |
originalRuleset | Σ | 0..1 | Coding | Original specification followed Ruleset Codes (Example) |
created | Σ | 0..1 | dateTime | Creation date |
billablePeriod | Σ | 0..1 | Period | Period for charge submission |
disposition | Σ | 0..1 | string | Disposition Message |
provider | Σ | 0..1 | Reference(Practitioner) | Responsible provider for the claim |
organization | Σ | 0..1 | Reference(Organization) | Responsible organization for the claim |
facility | Σ | 0..1 | Reference(Location) | Servicing Facility |
relatedClaim | Σ | 0..* | Reference(Claim) | Related Claims |
prescription | Σ | 0..1 | Reference(MedicationOrder | VisionPrescription) | Prescription |
originalPrescription | Σ | 0..1 | Reference(MedicationOrder) | Original Prescription |
payee | Σ | 0..1 | BackboneElement | Payee |
type | Σ | 0..1 | Coding | Party to be paid any benefits payable Payee Type Codes (Example) |
provider | Σ | 0..1 | Reference(Practitioner) | Provider who is the payee |
organization | Σ | 0..1 | Reference(Organization) | Organization who is the payee |
person | Σ | 0..1 | Reference(Patient) | Other person who is the payee |
referral | Σ | 0..1 | Reference(ReferralRequest) | Treatment Referral |
diagnosis | Σ | 0..* | BackboneElement | Diagnosis |
sequence | Σ | 1..1 | positiveInt | Sequence of diagnosis |
diagnosis | Σ | 1..1 | Coding | Patient's list of diagnosis ICD-10 Codes (Example) |
specialCondition | Σ | 0..* | Coding | List of special Conditions Conditions Codes (Example) |
patient | Σ | 1..1 | Reference(Patient) | The subject of the Products and Services |
precedence | Σ | 0..1 | positiveInt | Precedence (primary, secondary, etc.) |
coverage | Σ | 1..1 | BackboneElement | Insurance or medical plan |
coverage | Σ | 1..1 | Reference(Coverage) | Insurance information |
relationship | Σ | 1..1 | Coding | Patient relationship to subscriber Surface Codes (Example) |
preAuthRef | Σ | 0..* | string | Pre-Authorization/Determination Reference |
exception | Σ | 0..* | Coding | Eligibility exceptions Exception Codes (Example) |
school | Σ | 0..1 | string | Name of School |
accidentDate | Σ | 0..1 | date | Accident Date |
accidentType | Σ | 0..1 | Coding | Accident Type ActIncidentCode (Required) |
accidentLocation[x] | Σ | 0..1 | Accident Place | |
accidentLocationString | string | |||
accidentLocationAddress | Address | |||
accidentLocationReference | Reference(Location) | |||
interventionException | Σ | 0..* | Coding | Intervention and exception code (Pharma) Intervention Codes (Example) |
onset[x] | Σ | 0..1 | Illness, injury or treatable condition date | |
onsetDate | date | |||
onsetPeriod | Period | |||
employmentImpacted | Σ | 0..1 | Period | Period unable to work |
hospitalization | Σ | 0..1 | Period | Period in hospital |
item | Σ | 0..* | BackboneElement | Goods and Services |
sequence | Σ | 1..1 | positiveInt | Service instance |
type | Σ | 1..1 | Coding | Group or type of product or service ActInvoiceGroupCode (Required) |
provider | Σ | 0..1 | Reference(Practitioner) | Responsible practitioner |
diagnosisLinkId | Σ | 0..* | positiveInt | Diagnosis Link |
service | Σ | 1..1 | Coding | Item Code USCLS Codes (Example) |
serviced[x] | Σ | 0..1 | Date or dates of Service | |
servicedDate | date | |||
servicedPeriod | Period | |||
place | Σ | 0..1 | Coding | Place of service Example Service Place Codes (Example) |
quantity | Σ | 0..1 | SimpleQuantity | Count of Products or Services |
unitPrice | Σ | 0..1 | Money | Fee, charge or cost per point |
factor | Σ | 0..1 | decimal | Price scaling factor |
points | Σ | 0..1 | decimal | Difficulty scaling factor |
net | Σ | 0..1 | Money | Total item cost |
udi | Σ | 0..1 | Coding | Unique Device Identifier UDI Codes (Example) |
bodySite | Σ | 0..1 | Coding | Service Location Surface Codes (Example) |
subSite | Σ | 0..* | Coding | Service Sub-location Surface Codes (Example) |
modifier | Σ | 0..* | Coding | Service/Product billing modifiers Modifier type Codes (Example) |
noteNumber | Σ | 0..* | positiveInt | List of note numbers which apply |
adjudication | Σ | 0..* | BackboneElement | Adjudication details |
category | Σ | 1..1 | Coding | Adjudication category such as co-pay, eligible, benefit, etc. Adjudication Codes (Extensible) |
reason | Σ | 0..1 | Coding | Adjudication reason Adjudication Reason Codes (Extensible) |
amount | Σ | 0..1 | Money | Monetary amount |
value | Σ | 0..1 | decimal | Non-monitory value |
detail | Σ | 0..* | BackboneElement | Additional items |
sequence | Σ | 1..1 | positiveInt | Service instance |
type | Σ | 1..1 | Coding | Group or type of product or service ActInvoiceGroupCode (Required) |
service | Σ | 1..1 | Coding | Additional item codes USCLS Codes (Example) |
quantity | Σ | 0..1 | SimpleQuantity | Count of Products or Services |
unitPrice | Σ | 0..1 | Money | Fee, charge or cost per point |
factor | Σ | 0..1 | decimal | Price scaling factor |
points | Σ | 0..1 | decimal | Difficulty scaling factor |
net | Σ | 0..1 | Money | Total additional item cost |
udi | Σ | 0..1 | Coding | Unique Device Identifier UDI Codes (Example) |
adjudication | Σ | 0..* | BackboneElement | Detail adjudication |
code | Σ | 1..1 | Coding | Adjudication category such as co-pay, eligible, benefit, etc. Adjudication Codes (Extensible) |
reason | Σ | 0..1 | Coding | Adjudication reason Adjudication Reason Codes (Extensible) |
amount | Σ | 0..1 | Money | Monetary amount |
value | Σ | 0..1 | decimal | Non-monitory value |
subDetail | Σ | 0..* | BackboneElement | Additional items |
sequence | Σ | 1..1 | positiveInt | Service instance |
type | Σ | 1..1 | Coding | Type of product or service ActInvoiceGroupCode (Required) |
service | Σ | 1..1 | Coding | Additional item codes USCLS Codes (Example) |
quantity | Σ | 0..1 | SimpleQuantity | Count of Products or Services |
unitPrice | Σ | 0..1 | Money | Fee, charge or cost per point |
factor | Σ | 0..1 | decimal | Price scaling factor |
points | Σ | 0..1 | decimal | Difficulty scaling factor |
net | Σ | 0..1 | Money | Net additional item cost |
udi | Σ | 0..1 | Coding | Unique Device Identifier UDI Codes (Example) |
adjudication | Σ | 0..* | BackboneElement | SubDetail adjudication |
code | Σ | 1..1 | Coding | Adjudication category such as co-pay, eligible, benefit, etc. Adjudication Codes (Extensible) |
reason | Σ | 0..1 | Coding | Adjudication reason Adjudication Reason Codes (Extensible) |
amount | Σ | 0..1 | Money | Monetary amount |
value | Σ | 0..1 | decimal | Non-monitory value |
prosthesis | Σ | 0..1 | BackboneElement | Prosthetic details |
initial | Σ | 0..1 | boolean | Is this the initial service |
priorDate | Σ | 0..1 | date | Initial service Date |
priorMaterial | Σ | 0..1 | Coding | Prosthetic Material Oral Prostho Material type Codes (Example) |
addItem | Σ | 0..* | BackboneElement | Insurer added line items |
sequenceLinkId | Σ | 0..* | positiveInt | Service instances |
service | Σ | 1..1 | Coding | Group, Service or Product USCLS Codes (Example) |
fee | Σ | 0..1 | Money | Professional fee or Product charge |
noteNumberLinkId | Σ | 0..* | positiveInt | List of note numbers which apply |
adjudication | Σ | 0..* | BackboneElement | Added items adjudication |
code | Σ | 1..1 | Coding | Adjudication category such as co-pay, eligible, benefit, etc. Adjudication Codes (Extensible) |
amount | Σ | 0..1 | Money | Monetary amount |
value | Σ | 0..1 | decimal | Non-monitory value |
detail | Σ | 0..* | BackboneElement | Added items details |
service | Σ | 1..1 | Coding | Service or Product USCLS Codes (Example) |
fee | Σ | 0..1 | Money | Professional fee or Product charge |
adjudication | Σ | 0..* | BackboneElement | Added items detail adjudication |
code | Σ | 1..1 | Coding | Adjudication category such as co-pay, eligible, benefit, etc. Adjudication Codes (Extensible) |
amount | Σ | 0..1 | Money | Monetary amount |
value | Σ | 0..1 | decimal | Non-monitory value |
claimTotal | Σ | 0..1 | Money | Total claim cost |
missingTeeth | Σ | 0..* | BackboneElement | Only if type = oral |
tooth | Σ | 1..1 | Coding | Tooth Code Teeth Codes (Example) |
reason | Σ | 0..1 | Coding | Reason for missing Missing Tooth Reason Codes (Example) |
extractionDate | Σ | 0..1 | date | Date of Extraction |
unallocDeductable | Σ | 0..1 | Money | Unallocated deductable |
totalBenefit | Σ | 0..1 | Money | Total benefit payable for the Claim |
paymentAdjustment | Σ | 0..1 | Money | Payment adjustment for non-Claim issues |
paymentAdjustmentReason | Σ | 0..1 | Coding | Reason for Payment adjustment Payment Adjustment Reason Codes (Extensible) |
paymentDate | Σ | 0..1 | date | Expected data of Payment |
paymentAmount | Σ | 0..1 | Money | Payment amount |
paymentRef | Σ | 0..1 | Identifier | Payment identifier |
reserved | Σ | 0..1 | Coding | Funds reserved status Funds Reservation Codes (Example) |
form | Σ | 0..1 | Coding | Printed Form Identifier Form Codes (Required) |
note | Σ | 0..* | BackboneElement | Processing notes |
number | Σ | 0..1 | positiveInt | Note Number for this note |
type | Σ | 0..1 | Coding | display | print | printoper NoteType (Required) |
text | Σ | 0..1 | string | Note explanitory text |
benefitBalance | Σ | 0..* | BackboneElement | Balance by Benefit Category |
category | Σ | 1..1 | Coding | Benefit Category Benefit Category Codes (Example) |
subCategory | Σ | 0..1 | Coding | Benefit SubCategory Benefit SubCategory Codes (Example) |
network | Σ | 0..1 | Coding | In or out of network Network Type Codes (Example) |
unit | Σ | 0..1 | Coding | Individual or family Unit Type Codes (Example) |
term | Σ | 0..1 | Coding | Annual or lifetime Benefit Term Codes (Example) |
financial | Σ | 0..* | BackboneElement | Benefit Summary |
type | Σ | 1..1 | Coding | Deductable, visits, benefit amount Benefit Type Codes (Example) |
benefit[x] | Σ | 0..1 | Benefits allowed | |
benefitUnsignedInt | unsignedInt | |||
benefitQuantity | Money | |||
benefitUsed[x] | Σ | 0..1 | Benefits used | |
benefitUsedUnsignedInt | unsignedInt | |||
benefitUsedQuantity | Money | |||
Documentation for this format |
XML Template
<ExplanationOfBenefit xmlns="http://hl7.org/fhir"> <!-- from Resource: id, meta, implicitRules, and language --> <!-- from DomainResource: text, contained, extension, and modifierExtension --> <identifier><!-- 0..* Identifier Business Identifier --></identifier> <claim><!-- 0..1 Reference(Claim) Claim reference --></claim> <claimResponse><!-- 0..1 Reference(ClaimResponse) Claim response reference --></claimResponse> <ruleset><!-- 0..1 Coding Current specification followed --></ruleset> <originalRuleset><!-- 0..1 Coding Original specification followed --></originalRuleset> <created value="[dateTime]"/><!-- 0..1 Creation date --> <billablePeriod><!-- 0..1 Period Period for charge submission --></billablePeriod> <disposition value="[string]"/><!-- 0..1 Disposition Message --> <provider><!-- 0..1 Reference(Practitioner) Responsible provider for the claim --></provider> <organization><!-- 0..1 Reference(Organization) Responsible organization for the claim --></organization> <facility><!-- 0..1 Reference(Location) Servicing Facility --></facility> <relatedClaim><!-- 0..* Reference(Claim) Related Claims --></relatedClaim> <prescription><!-- 0..1 Reference(MedicationOrder|VisionPrescription) Prescription --></prescription> <originalPrescription><!-- 0..1 Reference(MedicationOrder) Original Prescription --></originalPrescription> <payee> <!-- 0..1 Payee --> <type><!-- 0..1 Coding Party to be paid any benefits payable --></type> <provider><!-- 0..1 Reference(Practitioner) Provider who is the payee --></provider> <organization><!-- 0..1 Reference(Organization) Organization who is the payee --></organization> <person><!-- 0..1 Reference(Patient) Other person who is the payee --></person> </payee> <referral><!-- 0..1 Reference(ReferralRequest) Treatment Referral --></referral> <diagnosis> <!-- 0..* Diagnosis --> <sequence value="[positiveInt]"/><!-- 1..1 Sequence of diagnosis --> <diagnosis><!-- 1..1 Coding Patient's list of diagnosis --></diagnosis> </diagnosis> <specialCondition><!-- 0..* Coding List of special Conditions --></specialCondition> <patient><!-- 1..1 Reference(Patient) The subject of the Products and Services --></patient> <precedence value="[positiveInt]"/><!-- 0..1 Precedence (primary, secondary, etc.) --> <coverage> <!-- 1..1 Insurance or medical plan --> <coverage><!-- 1..1 Reference(Coverage) Insurance information --></coverage> <relationship><!-- 1..1 Coding Patient relationship to subscriber --></relationship> <preAuthRef value="[string]"/><!-- 0..* Pre-Authorization/Determination Reference --> </coverage> <exception><!-- 0..* Coding Eligibility exceptions --></exception> <school value="[string]"/><!-- 0..1 Name of School --> <accidentDate value="[date]"/><!-- 0..1 Accident Date --> <accidentType><!-- 0..1 Coding Accident Type --></accidentType> <accidentLocation[x]><!-- 0..1 string|Address|Reference(Location) Accident Place --></accidentLocation[x]> <interventionException><!-- 0..* Coding Intervention and exception code (Pharma) --></interventionException> <onset[x]><!-- 0..1 date|Period Illness, injury or treatable condition date --></onset[x]> <employmentImpacted><!-- 0..1 Period Period unable to work --></employmentImpacted> <hospitalization><!-- 0..1 Period Period in hospital --></hospitalization> <item> <!-- 0..* Goods and Services --> <sequence value="[positiveInt]"/><!-- 1..1 Service instance --> <type><!-- 1..1 Coding Group or type of product or service --></type> <provider><!-- 0..1 Reference(Practitioner) Responsible practitioner --></provider> <diagnosisLinkId value="[positiveInt]"/><!-- 0..* Diagnosis Link --> <service><!-- 1..1 Coding Item Code --></service> <serviced[x]><!-- 0..1 date|Period Date or dates of Service --></serviced[x]> <place><!-- 0..1 Coding Place of service --></place> <quantity><!-- 0..1 Quantity(SimpleQuantity) Count of Products or Services --></quantity> <unitPrice><!-- 0..1 Quantity(Money) Fee, charge or cost per point --></unitPrice> <factor value="[decimal]"/><!-- 0..1 Price scaling factor --> <points value="[decimal]"/><!-- 0..1 Difficulty scaling factor --> <net><!-- 0..1 Quantity(Money) Total item cost --></net> <udi><!-- 0..1 Coding Unique Device Identifier --></udi> <bodySite><!-- 0..1 Coding Service Location --></bodySite> <subSite><!-- 0..* Coding Service Sub-location --></subSite> <modifier><!-- 0..* Coding Service/Product billing modifiers --></modifier> <noteNumber value="[positiveInt]"/><!-- 0..* List of note numbers which apply --> <adjudication> <!-- 0..* Adjudication details --> <category><!-- 1..1 Coding Adjudication category such as co-pay, eligible, benefit, etc. --></category> <reason><!-- 0..1 Coding Adjudication reason --></reason> <amount><!-- 0..1 Quantity(Money) Monetary amount --></amount> <value value="[decimal]"/><!-- 0..1 Non-monitory value --> </adjudication> <detail> <!-- 0..* Additional items --> <sequence value="[positiveInt]"/><!-- 1..1 Service instance --> <type><!-- 1..1 Coding Group or type of product or service --></type> <service><!-- 1..1 Coding Additional item codes --></service> <quantity><!-- 0..1 Quantity(SimpleQuantity) Count of Products or Services --></quantity> <unitPrice><!-- 0..1 Quantity(Money) Fee, charge or cost per point --></unitPrice> <factor value="[decimal]"/><!-- 0..1 Price scaling factor --> <points value="[decimal]"/><!-- 0..1 Difficulty scaling factor --> <net><!-- 0..1 Quantity(Money) Total additional item cost --></net> <udi><!-- 0..1 Coding Unique Device Identifier --></udi> <adjudication> <!-- 0..* Detail adjudication --> <code><!-- 1..1 Coding Adjudication category such as co-pay, eligible, benefit, etc. --></code> <reason><!-- 0..1 Coding Adjudication reason --></reason> <amount><!-- 0..1 Quantity(Money) Monetary amount --></amount> <value value="[decimal]"/><!-- 0..1 Non-monitory value --> </adjudication> <subDetail> <!-- 0..* Additional items --> <sequence value="[positiveInt]"/><!-- 1..1 Service instance --> <type><!-- 1..1 Coding Type of product or service --></type> <service><!-- 1..1 Coding Additional item codes --></service> <quantity><!-- 0..1 Quantity(SimpleQuantity) Count of Products or Services --></quantity> <unitPrice><!-- 0..1 Quantity(Money) Fee, charge or cost per point --></unitPrice> <factor value="[decimal]"/><!-- 0..1 Price scaling factor --> <points value="[decimal]"/><!-- 0..1 Difficulty scaling factor --> <net><!-- 0..1 Quantity(Money) Net additional item cost --></net> <udi><!-- 0..1 Coding Unique Device Identifier --></udi> <adjudication> <!-- 0..* SubDetail adjudication --> <code><!-- 1..1 Coding Adjudication category such as co-pay, eligible, benefit, etc. --></code> <reason><!-- 0..1 Coding Adjudication reason --></reason> <amount><!-- 0..1 Quantity(Money) Monetary amount --></amount> <value value="[decimal]"/><!-- 0..1 Non-monitory value --> </adjudication> </subDetail> </detail> <prosthesis> <!-- 0..1 Prosthetic details --> <initial value="[boolean]"/><!-- 0..1 Is this the initial service --> <priorDate value="[date]"/><!-- 0..1 Initial service Date --> <priorMaterial><!-- 0..1 Coding Prosthetic Material --></priorMaterial> </prosthesis> </item> <addItem> <!-- 0..* Insurer added line items --> <sequenceLinkId value="[positiveInt]"/><!-- 0..* Service instances --> <service><!-- 1..1 Coding Group, Service or Product --></service> <fee><!-- 0..1 Quantity(Money) Professional fee or Product charge --></fee> <noteNumberLinkId value="[positiveInt]"/><!-- 0..* List of note numbers which apply --> <adjudication> <!-- 0..* Added items adjudication --> <code><!-- 1..1 Coding Adjudication category such as co-pay, eligible, benefit, etc. --></code> <amount><!-- 0..1 Quantity(Money) Monetary amount --></amount> <value value="[decimal]"/><!-- 0..1 Non-monitory value --> </adjudication> <detail> <!-- 0..* Added items details --> <service><!-- 1..1 Coding Service or Product --></service> <fee><!-- 0..1 Quantity(Money) Professional fee or Product charge --></fee> <adjudication> <!-- 0..* Added items detail adjudication --> <code><!-- 1..1 Coding Adjudication category such as co-pay, eligible, benefit, etc. --></code> <amount><!-- 0..1 Quantity(Money) Monetary amount --></amount> <value value="[decimal]"/><!-- 0..1 Non-monitory value --> </adjudication> </detail> </addItem> <claimTotal><!-- 0..1 Quantity(Money) Total claim cost --></claimTotal> <missingTeeth> <!-- 0..* Only if type = oral --> <tooth><!-- 1..1 Coding Tooth Code --></tooth> <reason><!-- 0..1 Coding Reason for missing --></reason> <extractionDate value="[date]"/><!-- 0..1 Date of Extraction --> </missingTeeth> <unallocDeductable><!-- 0..1 Quantity(Money) Unallocated deductable --></unallocDeductable> <totalBenefit><!-- 0..1 Quantity(Money) Total benefit payable for the Claim --></totalBenefit> <paymentAdjustment><!-- 0..1 Quantity(Money) Payment adjustment for non-Claim issues --></paymentAdjustment> <paymentAdjustmentReason><!-- 0..1 Coding Reason for Payment adjustment --></paymentAdjustmentReason> <paymentDate value="[date]"/><!-- 0..1 Expected data of Payment --> <paymentAmount><!-- 0..1 Quantity(Money) Payment amount --></paymentAmount> <paymentRef><!-- 0..1 Identifier Payment identifier --></paymentRef> <reserved><!-- 0..1 Coding Funds reserved status --></reserved> <form><!-- 0..1 Coding Printed Form Identifier --></form> <note> <!-- 0..* Processing notes --> <number value="[positiveInt]"/><!-- 0..1 Note Number for this note --> <type><!-- 0..1 Coding display | print | printoper --></type> <text value="[string]"/><!-- 0..1 Note explanitory text --> </note> <benefitBalance> <!-- 0..* Balance by Benefit Category --> <category><!-- 1..1 Coding Benefit Category --></category> <subCategory><!-- 0..1 Coding Benefit SubCategory --></subCategory> <network><!-- 0..1 Coding In or out of network --></network> <unit><!-- 0..1 Coding Individual or family --></unit> <term><!-- 0..1 Coding Annual or lifetime --></term> <financial> <!-- 0..* Benefit Summary --> <type><!-- 1..1 Coding Deductable, visits, benefit amount --></type> <benefit[x]><!-- 0..1 unsignedInt|Quantity(Money) Benefits allowed --></benefit[x]> <benefitUsed[x]><!-- 0..1 unsignedInt|Quantity(Money) Benefits used --></benefitUsed[x]> </financial> </benefitBalance> </ExplanationOfBenefit>
JSON Template
{ "resourceType" : "ExplanationOfBenefit", // from Resource: id, meta, implicitRules, and language // from DomainResource: text, contained, extension, and modifierExtension "identifier" : [{ Identifier }], // Business Identifier "claim" : { Reference(Claim) }, // Claim reference "claimResponse" : { Reference(ClaimResponse) }, // Claim response reference "ruleset" : { Coding }, // Current specification followed "originalRuleset" : { Coding }, // Original specification followed "created" : "<dateTime>", // Creation date "billablePeriod" : { Period }, // Period for charge submission "disposition" : "<string>", // Disposition Message "provider" : { Reference(Practitioner) }, // Responsible provider for the claim "organization" : { Reference(Organization) }, // Responsible organization for the claim "facility" : { Reference(Location) }, // Servicing Facility "relatedClaim" : [{ Reference(Claim) }], // Related Claims "prescription" : { Reference(MedicationOrder|VisionPrescription) }, // Prescription "originalPrescription" : { Reference(MedicationOrder) }, // Original Prescription "payee" : { // Payee "type" : { Coding }, // Party to be paid any benefits payable "provider" : { Reference(Practitioner) }, // Provider who is the payee "organization" : { Reference(Organization) }, // Organization who is the payee "person" : { Reference(Patient) } // Other person who is the payee }, "referral" : { Reference(ReferralRequest) }, // Treatment Referral "diagnosis" : [{ // Diagnosis "sequence" : "<positiveInt>", // R! Sequence of diagnosis "diagnosis" : { Coding } // R! Patient's list of diagnosis }], "specialCondition" : [{ Coding }], // List of special Conditions "patient" : { Reference(Patient) }, // R! The subject of the Products and Services "precedence" : "<positiveInt>", // Precedence (primary, secondary, etc.) "coverage" : { // R! Insurance or medical plan "coverage" : { Reference(Coverage) }, // R! Insurance information "relationship" : { Coding }, // R! Patient relationship to subscriber "preAuthRef" : ["<string>"] // Pre-Authorization/Determination Reference }, "exception" : [{ Coding }], // Eligibility exceptions "school" : "<string>", // Name of School "accidentDate" : "<date>", // Accident Date "accidentType" : { Coding }, // Accident Type // accidentLocation[x]: Accident Place. One of these 3: "accidentLocationString" : "<string>", "accidentLocationAddress" : { Address }, "accidentLocationReference" : { Reference(Location) }, "interventionException" : [{ Coding }], // Intervention and exception code (Pharma) // onset[x]: Illness, injury or treatable condition date. One of these 2: "onsetDate" : "<date>", "onsetPeriod" : { Period }, "employmentImpacted" : { Period }, // Period unable to work "hospitalization" : { Period }, // Period in hospital "item" : [{ // Goods and Services "sequence" : "<positiveInt>", // R! Service instance "type" : { Coding }, // R! Group or type of product or service "provider" : { Reference(Practitioner) }, // Responsible practitioner "diagnosisLinkId" : ["<positiveInt>"], // Diagnosis Link "service" : { Coding }, // R! Item Code // serviced[x]: Date or dates of Service. One of these 2: "servicedDate" : "<date>", "servicedPeriod" : { Period }, "place" : { Coding }, // Place of service "quantity" : { Quantity(SimpleQuantity) }, // Count of Products or Services "unitPrice" : { Quantity(Money) }, // Fee, charge or cost per point "factor" : <decimal>, // Price scaling factor "points" : <decimal>, // Difficulty scaling factor "net" : { Quantity(Money) }, // Total item cost "udi" : { Coding }, // Unique Device Identifier "bodySite" : { Coding }, // Service Location "subSite" : [{ Coding }], // Service Sub-location "modifier" : [{ Coding }], // Service/Product billing modifiers "noteNumber" : ["<positiveInt>"], // List of note numbers which apply "adjudication" : [{ // Adjudication details "category" : { Coding }, // R! Adjudication category such as co-pay, eligible, benefit, etc. "reason" : { Coding }, // Adjudication reason "amount" : { Quantity(Money) }, // Monetary amount "value" : <decimal> // Non-monitory value }], "detail" : [{ // Additional items "sequence" : "<positiveInt>", // R! Service instance "type" : { Coding }, // R! Group or type of product or service "service" : { Coding }, // R! Additional item codes "quantity" : { Quantity(SimpleQuantity) }, // Count of Products or Services "unitPrice" : { Quantity(Money) }, // Fee, charge or cost per point "factor" : <decimal>, // Price scaling factor "points" : <decimal>, // Difficulty scaling factor "net" : { Quantity(Money) }, // Total additional item cost "udi" : { Coding }, // Unique Device Identifier "adjudication" : [{ // Detail adjudication "code" : { Coding }, // R! Adjudication category such as co-pay, eligible, benefit, etc. "reason" : { Coding }, // Adjudication reason "amount" : { Quantity(Money) }, // Monetary amount "value" : <decimal> // Non-monitory value }], "subDetail" : [{ // Additional items "sequence" : "<positiveInt>", // R! Service instance "type" : { Coding }, // R! Type of product or service "service" : { Coding }, // R! Additional item codes "quantity" : { Quantity(SimpleQuantity) }, // Count of Products or Services "unitPrice" : { Quantity(Money) }, // Fee, charge or cost per point "factor" : <decimal>, // Price scaling factor "points" : <decimal>, // Difficulty scaling factor "net" : { Quantity(Money) }, // Net additional item cost "udi" : { Coding }, // Unique Device Identifier "adjudication" : [{ // SubDetail adjudication "code" : { Coding }, // R! Adjudication category such as co-pay, eligible, benefit, etc. "reason" : { Coding }, // Adjudication reason "amount" : { Quantity(Money) }, // Monetary amount "value" : <decimal> // Non-monitory value }] }] }], "prosthesis" : { // Prosthetic details "initial" : <boolean>, // Is this the initial service "priorDate" : "<date>", // Initial service Date "priorMaterial" : { Coding } // Prosthetic Material } }], "addItem" : [{ // Insurer added line items "sequenceLinkId" : ["<positiveInt>"], // Service instances "service" : { Coding }, // R! Group, Service or Product "fee" : { Quantity(Money) }, // Professional fee or Product charge "noteNumberLinkId" : ["<positiveInt>"], // List of note numbers which apply "adjudication" : [{ // Added items adjudication "code" : { Coding }, // R! Adjudication category such as co-pay, eligible, benefit, etc. "amount" : { Quantity(Money) }, // Monetary amount "value" : <decimal> // Non-monitory value }], "detail" : [{ // Added items details "service" : { Coding }, // R! Service or Product "fee" : { Quantity(Money) }, // Professional fee or Product charge "adjudication" : [{ // Added items detail adjudication "code" : { Coding }, // R! Adjudication category such as co-pay, eligible, benefit, etc. "amount" : { Quantity(Money) }, // Monetary amount "value" : <decimal> // Non-monitory value }] }] }], "claimTotal" : { Quantity(Money) }, // Total claim cost "missingTeeth" : [{ // Only if type = oral "tooth" : { Coding }, // R! Tooth Code "reason" : { Coding }, // Reason for missing "extractionDate" : "<date>" // Date of Extraction }], "unallocDeductable" : { Quantity(Money) }, // Unallocated deductable "totalBenefit" : { Quantity(Money) }, // Total benefit payable for the Claim "paymentAdjustment" : { Quantity(Money) }, // Payment adjustment for non-Claim issues "paymentAdjustmentReason" : { Coding }, // Reason for Payment adjustment "paymentDate" : "<date>", // Expected data of Payment "paymentAmount" : { Quantity(Money) }, // Payment amount "paymentRef" : { Identifier }, // Payment identifier "reserved" : { Coding }, // Funds reserved status "form" : { Coding }, // Printed Form Identifier "note" : [{ // Processing notes "number" : "<positiveInt>", // Note Number for this note "type" : { Coding }, // display | print | printoper "text" : "<string>" // Note explanitory text }], "benefitBalance" : [{ // Balance by Benefit Category "category" : { Coding }, // R! Benefit Category "subCategory" : { Coding }, // Benefit SubCategory "network" : { Coding }, // In or out of network "unit" : { Coding }, // Individual or family "term" : { Coding }, // Annual or lifetime "financial" : [{ // Benefit Summary "type" : { Coding }, // R! Deductable, visits, benefit amount // benefit[x]: Benefits allowed. One of these 2: "benefitUnsignedInt" : "<unsignedInt>", "benefitQuantity" : { Quantity(Money) }, // benefitUsed[x]: Benefits used. One of these 2: "benefitUsedUnsignedInt" : "<unsignedInt>" "benefitUsedQuantity" : { Quantity(Money) } }] }] }
Alternate definitions: Schema/Schematron, Resource Profile (XML, JSON), Questionnaire
Path | Definition | Type | Reference |
---|---|---|---|
ExplanationOfBenefit.ruleset ExplanationOfBenefit.originalRuleset | The static and dynamic model to which contents conform, which may be business version or standard/version. | Example | Ruleset Codes |
ExplanationOfBenefit.payee.type | A code for the party to be reimbursed. | Example | Payee Type Codes |
ExplanationOfBenefit.diagnosis.diagnosis | ICD10 Diagnostic codes | Example | ICD-10 Codes |
ExplanationOfBenefit.specialCondition | List of special conditions relating to the setting, treatment or patient for which care is sought which may influence the adjudication. | Example | Conditions Codes |
ExplanationOfBenefit.coverage.relationship | The code for the relationship of the patient to the subscriber. | Example | Surface Codes |
ExplanationOfBenefit.exception | Factors which may influence the applicability of coverage. | Example | Exception Codes |
ExplanationOfBenefit.accidentType | Type of accident: work place, auto, etc. | Required | ActIncidentCode |
ExplanationOfBenefit.interventionException | Intervention and exception codes (Pharm) | Example | Intervention Codes |
ExplanationOfBenefit.item.type ExplanationOfBenefit.item.detail.type ExplanationOfBenefit.item.detail.subDetail.type | Service, Product, Rx Dispense, Rx Compound etc. | Required | ActInvoiceGroupCode |
ExplanationOfBenefit.item.service ExplanationOfBenefit.item.detail.service ExplanationOfBenefit.item.detail.subDetail.service ExplanationOfBenefit.addItem.service ExplanationOfBenefit.addItem.detail.service | Allowable service and product codes | Example | USCLS Codes |
ExplanationOfBenefit.item.place | Place where the service is rendered | Example | Example Service Place Codes |
ExplanationOfBenefit.item.udi ExplanationOfBenefit.item.detail.udi ExplanationOfBenefit.item.detail.subDetail.udi | The GUDID (FDA), or other, UDI repository. | Example | UDI Codes |
ExplanationOfBenefit.item.bodySite | The code for the teeth, quadrant, sextant and arch | Example | Surface Codes |
ExplanationOfBenefit.item.subSite | The code for the tooth surface and surface combinations | Example | Surface Codes |
ExplanationOfBenefit.item.modifier | Item type or modifiers codes, eg for Oral whether the treatment is cosmetic or associated with TMJ, or an appliance was lost or stolen. | Example | Modifier type Codes |
ExplanationOfBenefit.item.adjudication.category ExplanationOfBenefit.item.detail.adjudication.code ExplanationOfBenefit.item.detail.subDetail.adjudication.code ExplanationOfBenefit.addItem.adjudication.code ExplanationOfBenefit.addItem.detail.adjudication.code | The adjudication codes. | Extensible | Adjudication Codes |
ExplanationOfBenefit.item.adjudication.reason ExplanationOfBenefit.item.detail.adjudication.reason ExplanationOfBenefit.item.detail.subDetail.adjudication.reason | Adjudication reason codes. | Extensible | Adjudication Reason Codes |
ExplanationOfBenefit.item.prosthesis.priorMaterial | Material of the prior denture or bridge prosthesis. (Oral) | Example | Oral Prostho Material type Codes |
ExplanationOfBenefit.missingTeeth.tooth | The codes for the teeth, subset of OralSites | Example | Teeth Codes |
ExplanationOfBenefit.missingTeeth.reason | Reason codes for the missing teeth | Example | Missing Tooth Reason Codes |
ExplanationOfBenefit.paymentAdjustmentReason | Payment Adjustment reason codes. | Extensible | Payment Adjustment Reason Codes |
ExplanationOfBenefit.reserved | For whom funds are to be reserved: (Patient, Provider, None). | Example | Funds Reservation Codes |
ExplanationOfBenefit.form | The forms codes. | Required | Form Codes |
ExplanationOfBenefit.note.type | The presentation types of notes. | Required | NoteType |
ExplanationOfBenefit.benefitBalance.category | Benefit categories such as: oral, medical, vision etc. | Example | Benefit Category Codes |
ExplanationOfBenefit.benefitBalance.subCategory | Benefit subcategories such as: oral-basic, major, glasses | Example | Benefit SubCategory Codes |
ExplanationOfBenefit.benefitBalance.network | Code to classify in or out of network services | Example | Network Type Codes |
ExplanationOfBenefit.benefitBalance.unit | Unit covered/serviced - individual or family | Example | Unit Type Codes |
ExplanationOfBenefit.benefitBalance.term | Coverage unit - annual, lifetime | Example | Benefit Term Codes |
ExplanationOfBenefit.benefitBalance.financial.type | Deductable, visits, co-pay, etc. | Example | Benefit Type Codes |
Search parameters for this resource. The common parameters also apply. See Searching for more information about searching in REST, messaging, and services.
Name | Type | Description | Paths |
claim | reference | The reference to the claim | ExplanationOfBenefit.claim (Claim) |
created | date | The creation date for the EOB | ExplanationOfBenefit.created |
disposition | string | The contents of the disposition message | ExplanationOfBenefit.disposition |
facility | reference | Facility responsible for the goods and services | ExplanationOfBenefit.facility (Location) |
identifier | token | The business identifier of the Explanation of Benefit | ExplanationOfBenefit.identifier |
organization | reference | The reference to the providing organization | ExplanationOfBenefit.organization (Organization) |
patient | reference | The reference to the patient | ExplanationOfBenefit.patient (Patient) |
provider | reference | The reference to the provider | ExplanationOfBenefit.provider (Practitioner) |