This page is part of the FHIR Specification (v3.3.0: R4 Ballot 2). 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
Financial Management Work Group | Maturity Level: 2 | Trial Use | Compartments: Encounter, Patient, Practitioner, RelatedPerson |
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.
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 patient's coverage in respect of that Claim.
This is the logical combination of the Claim, ClaimResponse 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.
Structure
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
ExplanationOfBenefit | TU | DomainResource | Explanation of Benefit resource Elements defined in Ancestors: id, meta, implicitRules, language, text, contained, extension, modifierExtension | |
identifier | 0..* | Identifier | Business Identifier | |
status | ?!Σ | 0..1 | code | active | cancelled | draft | entered-in-error ExplanationOfBenefitStatus (Required) |
type | 0..1 | CodeableConcept | Type or discipline Claim Type Codes (Extensible) | |
subType | 0..* | CodeableConcept | Finer grained claim type information Example Claim SubType Codes (Example) | |
use | 0..1 | code | complete | proposed | exploratory | other Use (Required) | |
patient | 0..1 | Reference(Patient) | The subject of the Products and Services | |
billablePeriod | 0..1 | Period | Period for charge submission | |
created | 0..1 | dateTime | Creation date | |
enterer | 0..1 | Reference(Practitioner | PractitionerRole) | Author | |
insurer | 0..1 | Reference(Organization) | Insurer responsible for the EOB | |
provider | 0..1 | Reference(Practitioner | PractitionerRole | Organization) | Responsible provider for the claim | |
referral | 0..1 | Reference(ServiceRequest) | Treatment Referral | |
facility | 0..1 | Reference(Location) | Servicing Facility | |
claim | 0..1 | Reference(Claim) | Claim reference | |
claimResponse | 0..1 | Reference(ClaimResponse) | Claim response reference | |
outcome | 0..1 | code | queued | complete | error | partial Claim Processing Codes (Required) | |
disposition | 0..1 | string | Disposition Message | |
related | 0..* | BackboneElement | Related Claims which may be revelant to processing this claim | |
claim | 0..1 | Reference(Claim) | Reference to the related claim | |
relationship | 0..1 | CodeableConcept | How the reference claim is related Example Related Claim Relationship Codes (Example) | |
reference | 0..1 | Identifier | Related file or case reference | |
prescription | 0..1 | Reference(MedicationRequest | VisionPrescription) | Prescription authorizing services or products | |
originalPrescription | 0..1 | Reference(MedicationRequest) | Original prescription if superceded by fulfiller | |
payee | 0..1 | BackboneElement | Party to be paid any benefits payable | |
type | 0..1 | CodeableConcept | Type of party: Subscriber, Provider, other Claim Payee Type Codes (Example) | |
resource | 0..1 | Coding | organization | patient | practitioner | relatedperson PayeeResourceType (Extensible) | |
party | 0..1 | Reference(Practitioner | PractitionerRole | Organization | Patient | RelatedPerson) | Party to receive the payable | |
information | 0..* | BackboneElement | Exceptions, special considerations, the condition, situation, prior or concurrent issues | |
sequence | 1..1 | positiveInt | Information instance identifier | |
category | 1..1 | CodeableConcept | General class of information Claim Information Category Codes (Example) | |
code | 0..1 | CodeableConcept | Type of information Exception Codes (Example) | |
timing[x] | 0..1 | When it occurred | ||
timingDate | date | |||
timingPeriod | Period | |||
value[x] | 0..1 | Additional Data or supporting information | ||
valueBoolean | boolean | |||
valueString | string | |||
valueQuantity | Quantity | |||
valueAttachment | Attachment | |||
valueReference | Reference(Any) | |||
reason | 0..1 | Coding | Reason associated with the information Missing Tooth Reason Codes (Example) | |
careTeam | 0..* | BackboneElement | Care Team members | |
sequence | 1..1 | positiveInt | Number to convey order of careteam | |
provider | 1..1 | Reference(Practitioner | PractitionerRole | Organization) | Member of the Care Team | |
responsible | 0..1 | boolean | Billing practitioner | |
role | 0..1 | CodeableConcept | Role on the team Claim Care Team Role Codes (Example) | |
qualification | 0..1 | CodeableConcept | Type, classification or Specialization Example Provider Qualification Codes (Example) | |
diagnosis | 0..* | BackboneElement | List of Diagnosis | |
sequence | 1..1 | positiveInt | Number to convey order of diagnosis | |
diagnosis[x] | 1..1 | Patient's diagnosis ICD-10 Codes (Example) | ||
diagnosisCodeableConcept | CodeableConcept | |||
diagnosisReference | Reference(Condition) | |||
type | 0..* | CodeableConcept | Timing or nature of the diagnosis Example Diagnosis Type Codes (Example) | |
packageCode | 0..1 | CodeableConcept | Package billing code Example Diagnosis Related Group Codes (Example) | |
procedure | 0..* | BackboneElement | Procedures performed | |
sequence | 1..1 | positiveInt | Procedure sequence for reference | |
date | 0..1 | dateTime | When the procedure was performed | |
procedure[x] | 1..1 | Patient's list of procedures performed ICD-10 Procedure Codes (Example) | ||
procedureCodeableConcept | CodeableConcept | |||
procedureReference | Reference(Procedure) | |||
precedence | 0..1 | positiveInt | Precedence (primary, secondary, etc.) | |
insurance | 0..1 | BackboneElement | Insurance or medical plan | |
coverage | 0..1 | Reference(Coverage) | Insurance information | |
preAuthRef | 0..* | string | Pre-Authorization/Determination Reference | |
accident | 0..1 | BackboneElement | Details of an accident | |
date | 0..1 | date | When the accident occurred | |
type | 0..1 | CodeableConcept | The nature of the accident ActIncidentCode (Extensible) | |
location[x] | 0..1 | Accident Place | ||
locationAddress | Address | |||
locationReference | Reference(Location) | |||
item | 0..* | BackboneElement | Goods and Services | |
sequence | 1..1 | positiveInt | Service instance | |
careTeamSequence | 0..* | positiveInt | Applicable careteam members | |
diagnosisSequence | 0..* | positiveInt | Applicable diagnoses | |
procedureSequence | 0..* | positiveInt | Applicable procedures | |
informationSequence | 0..* | positiveInt | Applicable exception and supporting information | |
revenue | 0..1 | CodeableConcept | Revenue or cost center code Example Revenue Center Codes (Example) | |
category | 0..1 | CodeableConcept | Type of service or product Benefit SubCategory Codes (Example) | |
service | 0..1 | CodeableConcept | Billing Code USCLS Codes (Example) | |
modifier | 0..* | CodeableConcept | Service/Product billing modifiers Modifier type Codes (Example) | |
programCode | 0..* | CodeableConcept | Program specific reason for item inclusion Example Program Reason Codes (Example) | |
serviced[x] | 0..1 | Date or dates of Service | ||
servicedDate | date | |||
servicedPeriod | Period | |||
location[x] | 0..1 | Place of service Example Service Place Codes (Example) | ||
locationCodeableConcept | CodeableConcept | |||
locationAddress | Address | |||
locationReference | Reference(Location) | |||
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 | |
net | 0..1 | Money | Total item cost | |
udi | 0..* | Reference(Device) | Unique Device Identifier | |
bodySite | 0..1 | CodeableConcept | Service Location Oral Site Codes (Example) | |
subSite | 0..* | CodeableConcept | Service Sub-location Surface Codes (Example) | |
encounter | 0..* | Reference(Encounter) | Encounters related to this billed item | |
noteNumber | 0..* | positiveInt | List of note numbers which apply | |
adjudication | 0..* | BackboneElement | Adjudication details | |
category | 1..1 | CodeableConcept | Adjudication category such as co-pay, eligible, benefit, etc. Adjudication Value Codes (Example) | |
reason | 0..1 | CodeableConcept | Explanation of Adjudication outcome Adjudication Reason Codes (Example) | |
amount | 0..1 | Money | Monetary amount | |
value | 0..1 | decimal | Non-monitory value | |
detail | 0..* | BackboneElement | Additional items | |
sequence | 1..1 | positiveInt | Service instance | |
revenue | 0..1 | CodeableConcept | Revenue or cost center code Example Revenue Center Codes (Example) | |
category | 0..1 | CodeableConcept | Type of service or product Benefit SubCategory Codes (Example) | |
service | 0..1 | CodeableConcept | Billing Code USCLS Codes (Example) | |
modifier | 0..* | CodeableConcept | Service/Product billing modifiers Modifier type Codes (Example) | |
programCode | 0..* | CodeableConcept | Program specific reason for item inclusion Example Program Reason 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 | |
net | 0..1 | Money | Total additional item cost | |
udi | 0..* | Reference(Device) | Unique Device Identifier | |
noteNumber | 0..* | positiveInt | List of note numbers which apply | |
adjudication | 0..* | see adjudication | Detail level adjudication details | |
subDetail | 0..* | BackboneElement | Additional items | |
sequence | 1..1 | positiveInt | Service instance | |
revenue | 0..1 | CodeableConcept | Revenue or cost center code Example Revenue Center Codes (Example) | |
category | 0..1 | CodeableConcept | Type of service or product Benefit SubCategory Codes (Example) | |
service | 0..1 | CodeableConcept | Billing Code USCLS Codes (Example) | |
modifier | 0..* | CodeableConcept | Service/Product billing modifiers Modifier type Codes (Example) | |
programCode | 0..* | CodeableConcept | Program specific reason for item inclusion Example Program Reason 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 | |
net | 0..1 | Money | Net additional item cost | |
udi | 0..* | Reference(Device) | Unique Device Identifier | |
noteNumber | 0..* | positiveInt | List of note numbers which apply | |
adjudication | 0..* | see adjudication | Language if different from the resource | |
addItem | 0..* | BackboneElement | Insurer added line items | |
itemSequence | 0..* | positiveInt | Service instances | |
detailSequence | 0..* | positiveInt | Detail sequence number | |
subDetailSequence | 0..* | positiveInt | Subdetail sequence number | |
service | 0..1 | CodeableConcept | Billing Code USCLS Codes (Example) | |
modifier | 0..* | CodeableConcept | Service/Product billing modifiers Modifier type Codes (Example) | |
fee | 0..1 | Money | Professional fee or Product charge | |
noteNumber | 0..* | positiveInt | List of note numbers which apply | |
adjudication | 0..* | see adjudication | Added items adjudication | |
total | 0..* | BackboneElement | Adjudication totals | |
category | 1..1 | CodeableConcept | Adjudication category such as submitted, co-pay, eligible, benefit, etc. Adjudication Value Codes (Example) | |
amount | 1..1 | Money | Monetary amount | |
payment | 0..1 | BackboneElement | Payment (if paid) | |
type | 0..1 | CodeableConcept | Partial or Complete Example Payment Type Codes (Example) | |
adjustment | 0..1 | Money | Payment adjustment for non-Claim issues | |
adjustmentReason | 0..1 | CodeableConcept | Explanation for the non-claim adjustment Payment Adjustment Reason Codes (Example) | |
date | 0..1 | date | Expected date of Payment | |
amount | 0..1 | Money | Payable amount after adjustment | |
identifier | 0..1 | Identifier | Identifier of the payment instrument | |
form | 0..1 | CodeableConcept | Printed Form Identifier Form Codes (Example) | |
processNote | 0..* | BackboneElement | Processing notes | |
number | 0..1 | positiveInt | Sequence number for this note | |
type | 0..1 | code | display | print | printoper NoteType (Required) | |
text | 0..1 | string | Note explanitory text | |
language | 0..1 | CodeableConcept | Language if different from the resource Common Languages (Extensible but limited to All Languages) | |
benefitBalance | 0..* | BackboneElement | Balance by Benefit Category | |
category | 1..1 | CodeableConcept | Type of services covered Benefit Category Codes (Example) | |
subCategory | 0..1 | CodeableConcept | Detailed services covered within the type Benefit SubCategory Codes (Example) | |
excluded | 0..1 | boolean | Excluded from the plan | |
name | 0..1 | string | Short name for the benefit | |
description | 0..1 | string | Description of the benefit or services covered | |
network | 0..1 | CodeableConcept | In or out of network Network Type Codes (Example) | |
unit | 0..1 | CodeableConcept | Individual or family Unit Type Codes (Example) | |
term | 0..1 | CodeableConcept | Annual or lifetime Benefit Term Codes (Example) | |
financial | 0..* | BackboneElement | Benefit Summary | |
type | 1..1 | CodeableConcept | Deductable, visits, benefit amount Benefit Type Codes (Example) | |
allowed[x] | 0..1 | Benefits allowed | ||
allowedUnsignedInt | unsignedInt | |||
allowedString | string | |||
allowedMoney | Money | |||
used[x] | 0..1 | Benefits used | ||
usedUnsignedInt | unsignedInt | |||
usedMoney | Money | |||
Documentation for this format |
UML Diagram (Legend)
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> <status value="[code]"/><!-- 0..1 active | cancelled | draft | entered-in-error --> <type><!-- 0..1 CodeableConcept Type or discipline --></type> <subType><!-- 0..* CodeableConcept Finer grained claim type information --></subType> <use value="[code]"/><!-- 0..1 complete | proposed | exploratory | other --> <patient><!-- 0..1 Reference(Patient) The subject of the Products and Services --></patient> <billablePeriod><!-- 0..1 Period Period for charge submission --></billablePeriod> <created value="[dateTime]"/><!-- 0..1 Creation date --> <enterer><!-- 0..1 Reference(Practitioner|PractitionerRole) Author --></enterer> <insurer><!-- 0..1 Reference(Organization) Insurer responsible for the EOB --></insurer> <provider><!-- 0..1 Reference(Practitioner|PractitionerRole|Organization) Responsible provider for the claim --></provider> <referral><!-- 0..1 Reference(ServiceRequest) Treatment Referral --></referral> <facility><!-- 0..1 Reference(Location) Servicing Facility --></facility> <claim><!-- 0..1 Reference(Claim) Claim reference --></claim> <claimResponse><!-- 0..1 Reference(ClaimResponse) Claim response reference --></claimResponse> <outcome value="[code]"/><!-- 0..1 queued | complete | error | partial --> <disposition value="[string]"/><!-- 0..1 Disposition Message --> <related> <!-- 0..* Related Claims which may be revelant to processing this claim --> <claim><!-- 0..1 Reference(Claim) Reference to the related claim --></claim> <relationship><!-- 0..1 CodeableConcept How the reference claim is related --></relationship> <reference><!-- 0..1 Identifier Related file or case reference --></reference> </related> <prescription><!-- 0..1 Reference(MedicationRequest|VisionPrescription) Prescription authorizing services or products --></prescription> <originalPrescription><!-- 0..1 Reference(MedicationRequest) Original prescription if superceded by fulfiller --></originalPrescription> <payee> <!-- 0..1 Party to be paid any benefits payable --> <type><!-- 0..1 CodeableConcept Type of party: Subscriber, Provider, other --></type> <resource><!-- 0..1 Coding organization | patient | practitioner | relatedperson --></resource> <party><!-- 0..1 Reference(Practitioner|PractitionerRole|Organization|Patient| RelatedPerson) Party to receive the payable --></party> </payee> <information> <!-- 0..* Exceptions, special considerations, the condition, situation, prior or concurrent issues --> <sequence value="[positiveInt]"/><!-- 1..1 Information instance identifier --> <category><!-- 1..1 CodeableConcept General class of information --></category> <code><!-- 0..1 CodeableConcept Type of information --></code> <timing[x]><!-- 0..1 date|Period When it occurred --></timing[x]> <value[x]><!-- 0..1 boolean|string|Quantity|Attachment|Reference(Any) Additional Data or supporting information --></value[x]> <reason><!-- 0..1 Coding Reason associated with the information --></reason> </information> <careTeam> <!-- 0..* Care Team members --> <sequence value="[positiveInt]"/><!-- 1..1 Number to convey order of careteam --> <provider><!-- 1..1 Reference(Practitioner|PractitionerRole|Organization) Member of the Care Team --></provider> <responsible value="[boolean]"/><!-- 0..1 Billing practitioner --> <role><!-- 0..1 CodeableConcept Role on the team --></role> <qualification><!-- 0..1 CodeableConcept Type, classification or Specialization --></qualification> </careTeam> <diagnosis> <!-- 0..* List of Diagnosis --> <sequence value="[positiveInt]"/><!-- 1..1 Number to convey order of diagnosis --> <diagnosis[x]><!-- 1..1 CodeableConcept|Reference(Condition) Patient's diagnosis --></diagnosis[x]> <type><!-- 0..* CodeableConcept Timing or nature of the diagnosis --></type> <packageCode><!-- 0..1 CodeableConcept Package billing code --></packageCode> </diagnosis> <procedure> <!-- 0..* Procedures performed --> <sequence value="[positiveInt]"/><!-- 1..1 Procedure sequence for reference --> <date value="[dateTime]"/><!-- 0..1 When the procedure was performed --> <procedure[x]><!-- 1..1 CodeableConcept|Reference(Procedure) Patient's list of procedures performed --></procedure[x]> </procedure> <precedence value="[positiveInt]"/><!-- 0..1 Precedence (primary, secondary, etc.) --> <insurance> <!-- 0..1 Insurance or medical plan --> <coverage><!-- 0..1 Reference(Coverage) Insurance information --></coverage> <preAuthRef value="[string]"/><!-- 0..* Pre-Authorization/Determination Reference --> </insurance> <accident> <!-- 0..1 Details of an accident --> <date value="[date]"/><!-- 0..1 When the accident occurred --> <type><!-- 0..1 CodeableConcept The nature of the accident --></type> <location[x]><!-- 0..1 Address|Reference(Location) Accident Place --></location[x]> </accident> <item> <!-- 0..* Goods and Services --> <sequence value="[positiveInt]"/><!-- 1..1 Service instance --> <careTeamSequence value="[positiveInt]"/><!-- 0..* Applicable careteam members --> <diagnosisSequence value="[positiveInt]"/><!-- 0..* Applicable diagnoses --> <procedureSequence value="[positiveInt]"/><!-- 0..* Applicable procedures --> <informationSequence value="[positiveInt]"/><!-- 0..* Applicable exception and supporting information --> <revenue><!-- 0..1 CodeableConcept Revenue or cost center code --></revenue> <category><!-- 0..1 CodeableConcept Type of service or product --></category> <service><!-- 0..1 CodeableConcept Billing Code --></service> <modifier><!-- 0..* CodeableConcept Service/Product billing modifiers --></modifier> <programCode><!-- 0..* CodeableConcept Program specific reason for item inclusion --></programCode> <serviced[x]><!-- 0..1 date|Period Date or dates of Service --></serviced[x]> <location[x]><!-- 0..1 CodeableConcept|Address|Reference(Location) Place of service --></location[x]> <quantity><!-- 0..1 Quantity(SimpleQuantity) Count of Products or Services --></quantity> <unitPrice><!-- 0..1 Money Fee, charge or cost per point --></unitPrice> <factor value="[decimal]"/><!-- 0..1 Price scaling factor --> <net><!-- 0..1 Money Total item cost --></net> <udi><!-- 0..* Reference(Device) Unique Device Identifier --></udi> <bodySite><!-- 0..1 CodeableConcept Service Location --></bodySite> <subSite><!-- 0..* CodeableConcept Service Sub-location --></subSite> <encounter><!-- 0..* Reference(Encounter) Encounters related to this billed item --></encounter> <noteNumber value="[positiveInt]"/><!-- 0..* List of note numbers which apply --> <adjudication> <!-- 0..* Adjudication details --> <category><!-- 1..1 CodeableConcept Adjudication category such as co-pay, eligible, benefit, etc. --></category> <reason><!-- 0..1 CodeableConcept Explanation of Adjudication outcome --></reason> <amount><!-- 0..1 Money Monetary amount --></amount> <value value="[decimal]"/><!-- 0..1 Non-monitory value --> </adjudication> <detail> <!-- 0..* Additional items --> <sequence value="[positiveInt]"/><!-- 1..1 Service instance --> <revenue><!-- 0..1 CodeableConcept Revenue or cost center code --></revenue> <category><!-- 0..1 CodeableConcept Type of service or product --></category> <service><!-- 0..1 CodeableConcept Billing Code --></service> <modifier><!-- 0..* CodeableConcept Service/Product billing modifiers --></modifier> <programCode><!-- 0..* CodeableConcept Program specific reason for item inclusion --></programCode> <quantity><!-- 0..1 Quantity(SimpleQuantity) Count of Products or Services --></quantity> <unitPrice><!-- 0..1 Money Fee, charge or cost per point --></unitPrice> <factor value="[decimal]"/><!-- 0..1 Price scaling factor --> <net><!-- 0..1 Money Total additional item cost --></net> <udi><!-- 0..* Reference(Device) Unique Device Identifier --></udi> <noteNumber value="[positiveInt]"/><!-- 0..* List of note numbers which apply --> <adjudication><!-- 0..* Content as for ExplanationOfBenefit.item.adjudication Detail level adjudication details --></adjudication> <subDetail> <!-- 0..* Additional items --> <sequence value="[positiveInt]"/><!-- 1..1 Service instance --> <revenue><!-- 0..1 CodeableConcept Revenue or cost center code --></revenue> <category><!-- 0..1 CodeableConcept Type of service or product --></category> <service><!-- 0..1 CodeableConcept Billing Code --></service> <modifier><!-- 0..* CodeableConcept Service/Product billing modifiers --></modifier> <programCode><!-- 0..* CodeableConcept Program specific reason for item inclusion --></programCode> <quantity><!-- 0..1 Quantity(SimpleQuantity) Count of Products or Services --></quantity> <unitPrice><!-- 0..1 Money Fee, charge or cost per point --></unitPrice> <factor value="[decimal]"/><!-- 0..1 Price scaling factor --> <net><!-- 0..1 Money Net additional item cost --></net> <udi><!-- 0..* Reference(Device) Unique Device Identifier --></udi> <noteNumber value="[positiveInt]"/><!-- 0..* List of note numbers which apply --> <adjudication><!-- 0..* Content as for ExplanationOfBenefit.item.adjudication Language if different from the resource --></adjudication> </subDetail> </detail> </item> <addItem> <!-- 0..* Insurer added line items --> <itemSequence value="[positiveInt]"/><!-- 0..* Service instances --> <detailSequence value="[positiveInt]"/><!-- 0..* Detail sequence number --> <subDetailSequence value="[positiveInt]"/><!-- 0..* Subdetail sequence number --> <service><!-- 0..1 CodeableConcept Billing Code --></service> <modifier><!-- 0..* CodeableConcept Service/Product billing modifiers --></modifier> <fee><!-- 0..1 Money Professional fee or Product charge --></fee> <noteNumber value="[positiveInt]"/><!-- 0..* List of note numbers which apply --> <adjudication><!-- 0..* Content as for ExplanationOfBenefit.item.adjudication Added items adjudication --></adjudication> </addItem> <total> <!-- 0..* Adjudication totals --> <category><!-- 1..1 CodeableConcept Adjudication category such as submitted, co-pay, eligible, benefit, etc. --></category> <amount><!-- 1..1 Money Monetary amount --></amount> </total> <payment> <!-- 0..1 Payment (if paid) --> <type><!-- 0..1 CodeableConcept Partial or Complete --></type> <adjustment><!-- 0..1 Money Payment adjustment for non-Claim issues --></adjustment> <adjustmentReason><!-- 0..1 CodeableConcept Explanation for the non-claim adjustment --></adjustmentReason> <date value="[date]"/><!-- 0..1 Expected date of Payment --> <amount><!-- 0..1 Money Payable amount after adjustment --></amount> <identifier><!-- 0..1 Identifier Identifier of the payment instrument --></identifier> </payment> <form><!-- 0..1 CodeableConcept Printed Form Identifier --></form> <processNote> <!-- 0..* Processing notes --> <number value="[positiveInt]"/><!-- 0..1 Sequence number for this note --> <type value="[code]"/><!-- 0..1 display | print | printoper --> <text value="[string]"/><!-- 0..1 Note explanitory text --> <language><!-- 0..1 CodeableConcept Language if different from the resource --></language> </processNote> <benefitBalance> <!-- 0..* Balance by Benefit Category --> <category><!-- 1..1 CodeableConcept Type of services covered --></category> <subCategory><!-- 0..1 CodeableConcept Detailed services covered within the type --></subCategory> <excluded value="[boolean]"/><!-- 0..1 Excluded from the plan --> <name value="[string]"/><!-- 0..1 Short name for the benefit --> <description value="[string]"/><!-- 0..1 Description of the benefit or services covered --> <network><!-- 0..1 CodeableConcept In or out of network --></network> <unit><!-- 0..1 CodeableConcept Individual or family --></unit> <term><!-- 0..1 CodeableConcept Annual or lifetime --></term> <financial> <!-- 0..* Benefit Summary --> <type><!-- 1..1 CodeableConcept Deductable, visits, benefit amount --></type> <allowed[x]><!-- 0..1 unsignedInt|string|Money Benefits allowed --></allowed[x]> <used[x]><!-- 0..1 unsignedInt|Money Benefits used --></used[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 "status" : "<code>", // active | cancelled | draft | entered-in-error "type" : { CodeableConcept }, // Type or discipline "subType" : [{ CodeableConcept }], // Finer grained claim type information "use" : "<code>", // complete | proposed | exploratory | other "patient" : { Reference(Patient) }, // The subject of the Products and Services "billablePeriod" : { Period }, // Period for charge submission "created" : "<dateTime>", // Creation date "enterer" : { Reference(Practitioner|PractitionerRole) }, // Author "insurer" : { Reference(Organization) }, // Insurer responsible for the EOB "provider" : { Reference(Practitioner|PractitionerRole|Organization) }, // Responsible provider for the claim "referral" : { Reference(ServiceRequest) }, // Treatment Referral "facility" : { Reference(Location) }, // Servicing Facility "claim" : { Reference(Claim) }, // Claim reference "claimResponse" : { Reference(ClaimResponse) }, // Claim response reference "outcome" : "<code>", // queued | complete | error | partial "disposition" : "<string>", // Disposition Message "related" : [{ // Related Claims which may be revelant to processing this claim "claim" : { Reference(Claim) }, // Reference to the related claim "relationship" : { CodeableConcept }, // How the reference claim is related "reference" : { Identifier } // Related file or case reference }], "prescription" : { Reference(MedicationRequest|VisionPrescription) }, // Prescription authorizing services or products "originalPrescription" : { Reference(MedicationRequest) }, // Original prescription if superceded by fulfiller "payee" : { // Party to be paid any benefits payable "type" : { CodeableConcept }, // Type of party: Subscriber, Provider, other "resource" : { Coding }, // organization | patient | practitioner | relatedperson "party" : { Reference(Practitioner|PractitionerRole|Organization|Patient| RelatedPerson) } // Party to receive the payable }, "information" : [{ // Exceptions, special considerations, the condition, situation, prior or concurrent issues "sequence" : "<positiveInt>", // R! Information instance identifier "category" : { CodeableConcept }, // R! General class of information "code" : { CodeableConcept }, // Type of information // timing[x]: When it occurred. One of these 2: "timingDate" : "<date>", "timingPeriod" : { Period }, // value[x]: Additional Data or supporting information. One of these 5: "valueBoolean" : <boolean>, "valueString" : "<string>", "valueQuantity" : { Quantity }, "valueAttachment" : { Attachment }, "valueReference" : { Reference(Any) }, "reason" : { Coding } // Reason associated with the information }], "careTeam" : [{ // Care Team members "sequence" : "<positiveInt>", // R! Number to convey order of careteam "provider" : { Reference(Practitioner|PractitionerRole|Organization) }, // R! Member of the Care Team "responsible" : <boolean>, // Billing practitioner "role" : { CodeableConcept }, // Role on the team "qualification" : { CodeableConcept } // Type, classification or Specialization }], "diagnosis" : [{ // List of Diagnosis "sequence" : "<positiveInt>", // R! Number to convey order of diagnosis // diagnosis[x]: Patient's diagnosis. One of these 2: "diagnosisCodeableConcept" : { CodeableConcept }, "diagnosisReference" : { Reference(Condition) }, "type" : [{ CodeableConcept }], // Timing or nature of the diagnosis "packageCode" : { CodeableConcept } // Package billing code }], "procedure" : [{ // Procedures performed "sequence" : "<positiveInt>", // R! Procedure sequence for reference "date" : "<dateTime>", // When the procedure was performed // procedure[x]: Patient's list of procedures performed. One of these 2: "procedureCodeableConcept" : { CodeableConcept } "procedureReference" : { Reference(Procedure) } }], "precedence" : "<positiveInt>", // Precedence (primary, secondary, etc.) "insurance" : { // Insurance or medical plan "coverage" : { Reference(Coverage) }, // Insurance information "preAuthRef" : ["<string>"] // Pre-Authorization/Determination Reference }, "accident" : { // Details of an accident "date" : "<date>", // When the accident occurred "type" : { CodeableConcept }, // The nature of the accident // location[x]: Accident Place. One of these 2: "locationAddress" : { Address } "locationReference" : { Reference(Location) } }, "item" : [{ // Goods and Services "sequence" : "<positiveInt>", // R! Service instance "careTeamSequence" : ["<positiveInt>"], // Applicable careteam members "diagnosisSequence" : ["<positiveInt>"], // Applicable diagnoses "procedureSequence" : ["<positiveInt>"], // Applicable procedures "informationSequence" : ["<positiveInt>"], // Applicable exception and supporting information "revenue" : { CodeableConcept }, // Revenue or cost center code "category" : { CodeableConcept }, // Type of service or product "service" : { CodeableConcept }, // Billing Code "modifier" : [{ CodeableConcept }], // Service/Product billing modifiers "programCode" : [{ CodeableConcept }], // Program specific reason for item inclusion // serviced[x]: Date or dates of Service. One of these 2: "servicedDate" : "<date>", "servicedPeriod" : { Period }, // location[x]: Place of service. One of these 3: "locationCodeableConcept" : { CodeableConcept }, "locationAddress" : { Address }, "locationReference" : { Reference(Location) }, "quantity" : { Quantity(SimpleQuantity) }, // Count of Products or Services "unitPrice" : { Money }, // Fee, charge or cost per point "factor" : <decimal>, // Price scaling factor "net" : { Money }, // Total item cost "udi" : [{ Reference(Device) }], // Unique Device Identifier "bodySite" : { CodeableConcept }, // Service Location "subSite" : [{ CodeableConcept }], // Service Sub-location "encounter" : [{ Reference(Encounter) }], // Encounters related to this billed item "noteNumber" : ["<positiveInt>"], // List of note numbers which apply "adjudication" : [{ // Adjudication details "category" : { CodeableConcept }, // R! Adjudication category such as co-pay, eligible, benefit, etc. "reason" : { CodeableConcept }, // Explanation of Adjudication outcome "amount" : { Money }, // Monetary amount "value" : <decimal> // Non-monitory value }], "detail" : [{ // Additional items "sequence" : "<positiveInt>", // R! Service instance "revenue" : { CodeableConcept }, // Revenue or cost center code "category" : { CodeableConcept }, // Type of service or product "service" : { CodeableConcept }, // Billing Code "modifier" : [{ CodeableConcept }], // Service/Product billing modifiers "programCode" : [{ CodeableConcept }], // Program specific reason for item inclusion "quantity" : { Quantity(SimpleQuantity) }, // Count of Products or Services "unitPrice" : { Money }, // Fee, charge or cost per point "factor" : <decimal>, // Price scaling factor "net" : { Money }, // Total additional item cost "udi" : [{ Reference(Device) }], // Unique Device Identifier "noteNumber" : ["<positiveInt>"], // List of note numbers which apply "adjudication" : [{ Content as for ExplanationOfBenefit.item.adjudication }], // Detail level adjudication details "subDetail" : [{ // Additional items "sequence" : "<positiveInt>", // R! Service instance "revenue" : { CodeableConcept }, // Revenue or cost center code "category" : { CodeableConcept }, // Type of service or product "service" : { CodeableConcept }, // Billing Code "modifier" : [{ CodeableConcept }], // Service/Product billing modifiers "programCode" : [{ CodeableConcept }], // Program specific reason for item inclusion "quantity" : { Quantity(SimpleQuantity) }, // Count of Products or Services "unitPrice" : { Money }, // Fee, charge or cost per point "factor" : <decimal>, // Price scaling factor "net" : { Money }, // Net additional item cost "udi" : [{ Reference(Device) }], // Unique Device Identifier "noteNumber" : ["<positiveInt>"], // List of note numbers which apply "adjudication" : [{ Content as for ExplanationOfBenefit.item.adjudication }] // Language if different from the resource }] }] }], "addItem" : [{ // Insurer added line items "itemSequence" : ["<positiveInt>"], // Service instances "detailSequence" : ["<positiveInt>"], // Detail sequence number "subDetailSequence" : ["<positiveInt>"], // Subdetail sequence number "service" : { CodeableConcept }, // Billing Code "modifier" : [{ CodeableConcept }], // Service/Product billing modifiers "fee" : { Money }, // Professional fee or Product charge "noteNumber" : ["<positiveInt>"], // List of note numbers which apply "adjudication" : [{ Content as for ExplanationOfBenefit.item.adjudication }] // Added items adjudication }], "total" : [{ // Adjudication totals "category" : { CodeableConcept }, // R! Adjudication category such as submitted, co-pay, eligible, benefit, etc. "amount" : { Money } // R! Monetary amount }], "payment" : { // Payment (if paid) "type" : { CodeableConcept }, // Partial or Complete "adjustment" : { Money }, // Payment adjustment for non-Claim issues "adjustmentReason" : { CodeableConcept }, // Explanation for the non-claim adjustment "date" : "<date>", // Expected date of Payment "amount" : { Money }, // Payable amount after adjustment "identifier" : { Identifier } // Identifier of the payment instrument }, "form" : { CodeableConcept }, // Printed Form Identifier "processNote" : [{ // Processing notes "number" : "<positiveInt>", // Sequence number for this note "type" : "<code>", // display | print | printoper "text" : "<string>", // Note explanitory text "language" : { CodeableConcept } // Language if different from the resource }], "benefitBalance" : [{ // Balance by Benefit Category "category" : { CodeableConcept }, // R! Type of services covered "subCategory" : { CodeableConcept }, // Detailed services covered within the type "excluded" : <boolean>, // Excluded from the plan "name" : "<string>", // Short name for the benefit "description" : "<string>", // Description of the benefit or services covered "network" : { CodeableConcept }, // In or out of network "unit" : { CodeableConcept }, // Individual or family "term" : { CodeableConcept }, // Annual or lifetime "financial" : [{ // Benefit Summary "type" : { CodeableConcept }, // R! Deductable, visits, benefit amount // allowed[x]: Benefits allowed. One of these 3: "allowedUnsignedInt" : "<unsignedInt>", "allowedString" : "<string>", "allowedMoney" : { Money }, // used[x]: Benefits used. One of these 2: "usedUnsignedInt" : "<unsignedInt>" "usedMoney" : { Money } }] }] }
Turtle Template
@prefix fhir: <http://hl7.org/fhir/> . [ a fhir:ExplanationOfBenefit; fhir:nodeRole fhir:treeRoot; # if this is the parser root # from Resource: .id, .meta, .implicitRules, and .language # from DomainResource: .text, .contained, .extension, and .modifierExtension fhir:ExplanationOfBenefit.identifier [ Identifier ], ... ; # 0..* Business Identifier fhir:ExplanationOfBenefit.status [ code ]; # 0..1 active | cancelled | draft | entered-in-error fhir:ExplanationOfBenefit.type [ CodeableConcept ]; # 0..1 Type or discipline fhir:ExplanationOfBenefit.subType [ CodeableConcept ], ... ; # 0..* Finer grained claim type information fhir:ExplanationOfBenefit.use [ code ]; # 0..1 complete | proposed | exploratory | other fhir:ExplanationOfBenefit.patient [ Reference(Patient) ]; # 0..1 The subject of the Products and Services fhir:ExplanationOfBenefit.billablePeriod [ Period ]; # 0..1 Period for charge submission fhir:ExplanationOfBenefit.created [ dateTime ]; # 0..1 Creation date fhir:ExplanationOfBenefit.enterer [ Reference(Practitioner|PractitionerRole) ]; # 0..1 Author fhir:ExplanationOfBenefit.insurer [ Reference(Organization) ]; # 0..1 Insurer responsible for the EOB fhir:ExplanationOfBenefit.provider [ Reference(Practitioner|PractitionerRole|Organization) ]; # 0..1 Responsible provider for the claim fhir:ExplanationOfBenefit.referral [ Reference(ServiceRequest) ]; # 0..1 Treatment Referral fhir:ExplanationOfBenefit.facility [ Reference(Location) ]; # 0..1 Servicing Facility fhir:ExplanationOfBenefit.claim [ Reference(Claim) ]; # 0..1 Claim reference fhir:ExplanationOfBenefit.claimResponse [ Reference(ClaimResponse) ]; # 0..1 Claim response reference fhir:ExplanationOfBenefit.outcome [ code ]; # 0..1 queued | complete | error | partial fhir:ExplanationOfBenefit.disposition [ string ]; # 0..1 Disposition Message fhir:ExplanationOfBenefit.related [ # 0..* Related Claims which may be revelant to processing this claim fhir:ExplanationOfBenefit.related.claim [ Reference(Claim) ]; # 0..1 Reference to the related claim fhir:ExplanationOfBenefit.related.relationship [ CodeableConcept ]; # 0..1 How the reference claim is related fhir:ExplanationOfBenefit.related.reference [ Identifier ]; # 0..1 Related file or case reference ], ...; fhir:ExplanationOfBenefit.prescription [ Reference(MedicationRequest|VisionPrescription) ]; # 0..1 Prescription authorizing services or products fhir:ExplanationOfBenefit.originalPrescription [ Reference(MedicationRequest) ]; # 0..1 Original prescription if superceded by fulfiller fhir:ExplanationOfBenefit.payee [ # 0..1 Party to be paid any benefits payable fhir:ExplanationOfBenefit.payee.type [ CodeableConcept ]; # 0..1 Type of party: Subscriber, Provider, other fhir:ExplanationOfBenefit.payee.resource [ Coding ]; # 0..1 organization | patient | practitioner | relatedperson fhir:ExplanationOfBenefit.payee.party [ Reference(Practitioner|PractitionerRole|Organization|Patient|RelatedPerson) ]; # 0..1 Party to receive the payable ]; fhir:ExplanationOfBenefit.information [ # 0..* Exceptions, special considerations, the condition, situation, prior or concurrent issues fhir:ExplanationOfBenefit.information.sequence [ positiveInt ]; # 1..1 Information instance identifier fhir:ExplanationOfBenefit.information.category [ CodeableConcept ]; # 1..1 General class of information fhir:ExplanationOfBenefit.information.code [ CodeableConcept ]; # 0..1 Type of information # ExplanationOfBenefit.information.timing[x] : 0..1 When it occurred. One of these 2 fhir:ExplanationOfBenefit.information.timingDate [ date ] fhir:ExplanationOfBenefit.information.timingPeriod [ Period ] # ExplanationOfBenefit.information.value[x] : 0..1 Additional Data or supporting information. One of these 5 fhir:ExplanationOfBenefit.information.valueBoolean [ boolean ] fhir:ExplanationOfBenefit.information.valueString [ string ] fhir:ExplanationOfBenefit.information.valueQuantity [ Quantity ] fhir:ExplanationOfBenefit.information.valueAttachment [ Attachment ] fhir:ExplanationOfBenefit.information.valueReference [ Reference(Any) ] fhir:ExplanationOfBenefit.information.reason [ Coding ]; # 0..1 Reason associated with the information ], ...; fhir:ExplanationOfBenefit.careTeam [ # 0..* Care Team members fhir:ExplanationOfBenefit.careTeam.sequence [ positiveInt ]; # 1..1 Number to convey order of careteam fhir:ExplanationOfBenefit.careTeam.provider [ Reference(Practitioner|PractitionerRole|Organization) ]; # 1..1 Member of the Care Team fhir:ExplanationOfBenefit.careTeam.responsible [ boolean ]; # 0..1 Billing practitioner fhir:ExplanationOfBenefit.careTeam.role [ CodeableConcept ]; # 0..1 Role on the team fhir:ExplanationOfBenefit.careTeam.qualification [ CodeableConcept ]; # 0..1 Type, classification or Specialization ], ...; fhir:ExplanationOfBenefit.diagnosis [ # 0..* List of Diagnosis fhir:ExplanationOfBenefit.diagnosis.sequence [ positiveInt ]; # 1..1 Number to convey order of diagnosis # ExplanationOfBenefit.diagnosis.diagnosis[x] : 1..1 Patient's diagnosis. One of these 2 fhir:ExplanationOfBenefit.diagnosis.diagnosisCodeableConcept [ CodeableConcept ] fhir:ExplanationOfBenefit.diagnosis.diagnosisReference [ Reference(Condition) ] fhir:ExplanationOfBenefit.diagnosis.type [ CodeableConcept ], ... ; # 0..* Timing or nature of the diagnosis fhir:ExplanationOfBenefit.diagnosis.packageCode [ CodeableConcept ]; # 0..1 Package billing code ], ...; fhir:ExplanationOfBenefit.procedure [ # 0..* Procedures performed fhir:ExplanationOfBenefit.procedure.sequence [ positiveInt ]; # 1..1 Procedure sequence for reference fhir:ExplanationOfBenefit.procedure.date [ dateTime ]; # 0..1 When the procedure was performed # ExplanationOfBenefit.procedure.procedure[x] : 1..1 Patient's list of procedures performed. One of these 2 fhir:ExplanationOfBenefit.procedure.procedureCodeableConcept [ CodeableConcept ] fhir:ExplanationOfBenefit.procedure.procedureReference [ Reference(Procedure) ] ], ...; fhir:ExplanationOfBenefit.precedence [ positiveInt ]; # 0..1 Precedence (primary, secondary, etc.) fhir:ExplanationOfBenefit.insurance [ # 0..1 Insurance or medical plan fhir:ExplanationOfBenefit.insurance.coverage [ Reference(Coverage) ]; # 0..1 Insurance information fhir:ExplanationOfBenefit.insurance.preAuthRef [ string ], ... ; # 0..* Pre-Authorization/Determination Reference ]; fhir:ExplanationOfBenefit.accident [ # 0..1 Details of an accident fhir:ExplanationOfBenefit.accident.date [ date ]; # 0..1 When the accident occurred fhir:ExplanationOfBenefit.accident.type [ CodeableConcept ]; # 0..1 The nature of the accident # ExplanationOfBenefit.accident.location[x] : 0..1 Accident Place. One of these 2 fhir:ExplanationOfBenefit.accident.locationAddress [ Address ] fhir:ExplanationOfBenefit.accident.locationReference [ Reference(Location) ] ]; fhir:ExplanationOfBenefit.item [ # 0..* Goods and Services fhir:ExplanationOfBenefit.item.sequence [ positiveInt ]; # 1..1 Service instance fhir:ExplanationOfBenefit.item.careTeamSequence [ positiveInt ], ... ; # 0..* Applicable careteam members fhir:ExplanationOfBenefit.item.diagnosisSequence [ positiveInt ], ... ; # 0..* Applicable diagnoses fhir:ExplanationOfBenefit.item.procedureSequence [ positiveInt ], ... ; # 0..* Applicable procedures fhir:ExplanationOfBenefit.item.informationSequence [ positiveInt ], ... ; # 0..* Applicable exception and supporting information fhir:ExplanationOfBenefit.item.revenue [ CodeableConcept ]; # 0..1 Revenue or cost center code fhir:ExplanationOfBenefit.item.category [ CodeableConcept ]; # 0..1 Type of service or product fhir:ExplanationOfBenefit.item.service [ CodeableConcept ]; # 0..1 Billing Code fhir:ExplanationOfBenefit.item.modifier [ CodeableConcept ], ... ; # 0..* Service/Product billing modifiers fhir:ExplanationOfBenefit.item.programCode [ CodeableConcept ], ... ; # 0..* Program specific reason for item inclusion # ExplanationOfBenefit.item.serviced[x] : 0..1 Date or dates of Service. One of these 2 fhir:ExplanationOfBenefit.item.servicedDate [ date ] fhir:ExplanationOfBenefit.item.servicedPeriod [ Period ] # ExplanationOfBenefit.item.location[x] : 0..1 Place of service. One of these 3 fhir:ExplanationOfBenefit.item.locationCodeableConcept [ CodeableConcept ] fhir:ExplanationOfBenefit.item.locationAddress [ Address ] fhir:ExplanationOfBenefit.item.locationReference [ Reference(Location) ] fhir:ExplanationOfBenefit.item.quantity [ Quantity(SimpleQuantity) ]; # 0..1 Count of Products or Services fhir:ExplanationOfBenefit.item.unitPrice [ Money ]; # 0..1 Fee, charge or cost per point fhir:ExplanationOfBenefit.item.factor [ decimal ]; # 0..1 Price scaling factor fhir:ExplanationOfBenefit.item.net [ Money ]; # 0..1 Total item cost fhir:ExplanationOfBenefit.item.udi [ Reference(Device) ], ... ; # 0..* Unique Device Identifier fhir:ExplanationOfBenefit.item.bodySite [ CodeableConcept ]; # 0..1 Service Location fhir:ExplanationOfBenefit.item.subSite [ CodeableConcept ], ... ; # 0..* Service Sub-location fhir:ExplanationOfBenefit.item.encounter [ Reference(Encounter) ], ... ; # 0..* Encounters related to this billed item fhir:ExplanationOfBenefit.item.noteNumber [ positiveInt ], ... ; # 0..* List of note numbers which apply fhir:ExplanationOfBenefit.item.adjudication [ # 0..* Adjudication details fhir:ExplanationOfBenefit.item.adjudication.category [ CodeableConcept ]; # 1..1 Adjudication category such as co-pay, eligible, benefit, etc. fhir:ExplanationOfBenefit.item.adjudication.reason [ CodeableConcept ]; # 0..1 Explanation of Adjudication outcome fhir:ExplanationOfBenefit.item.adjudication.amount [ Money ]; # 0..1 Monetary amount fhir:ExplanationOfBenefit.item.adjudication.value [ decimal ]; # 0..1 Non-monitory value ], ...; fhir:ExplanationOfBenefit.item.detail [ # 0..* Additional items fhir:ExplanationOfBenefit.item.detail.sequence [ positiveInt ]; # 1..1 Service instance fhir:ExplanationOfBenefit.item.detail.revenue [ CodeableConcept ]; # 0..1 Revenue or cost center code fhir:ExplanationOfBenefit.item.detail.category [ CodeableConcept ]; # 0..1 Type of service or product fhir:ExplanationOfBenefit.item.detail.service [ CodeableConcept ]; # 0..1 Billing Code fhir:ExplanationOfBenefit.item.detail.modifier [ CodeableConcept ], ... ; # 0..* Service/Product billing modifiers fhir:ExplanationOfBenefit.item.detail.programCode [ CodeableConcept ], ... ; # 0..* Program specific reason for item inclusion fhir:ExplanationOfBenefit.item.detail.quantity [ Quantity(SimpleQuantity) ]; # 0..1 Count of Products or Services fhir:ExplanationOfBenefit.item.detail.unitPrice [ Money ]; # 0..1 Fee, charge or cost per point fhir:ExplanationOfBenefit.item.detail.factor [ decimal ]; # 0..1 Price scaling factor fhir:ExplanationOfBenefit.item.detail.net [ Money ]; # 0..1 Total additional item cost fhir:ExplanationOfBenefit.item.detail.udi [ Reference(Device) ], ... ; # 0..* Unique Device Identifier fhir:ExplanationOfBenefit.item.detail.noteNumber [ positiveInt ], ... ; # 0..* List of note numbers which apply fhir:ExplanationOfBenefit.item.detail.adjudication [ See ExplanationOfBenefit.item.adjudication ], ... ; # 0..* Detail level adjudication details fhir:ExplanationOfBenefit.item.detail.subDetail [ # 0..* Additional items fhir:ExplanationOfBenefit.item.detail.subDetail.sequence [ positiveInt ]; # 1..1 Service instance fhir:ExplanationOfBenefit.item.detail.subDetail.revenue [ CodeableConcept ]; # 0..1 Revenue or cost center code fhir:ExplanationOfBenefit.item.detail.subDetail.category [ CodeableConcept ]; # 0..1 Type of service or product fhir:ExplanationOfBenefit.item.detail.subDetail.service [ CodeableConcept ]; # 0..1 Billing Code fhir:ExplanationOfBenefit.item.detail.subDetail.modifier [ CodeableConcept ], ... ; # 0..* Service/Product billing modifiers fhir:ExplanationOfBenefit.item.detail.subDetail.programCode [ CodeableConcept ], ... ; # 0..* Program specific reason for item inclusion fhir:ExplanationOfBenefit.item.detail.subDetail.quantity [ Quantity(SimpleQuantity) ]; # 0..1 Count of Products or Services fhir:ExplanationOfBenefit.item.detail.subDetail.unitPrice [ Money ]; # 0..1 Fee, charge or cost per point fhir:ExplanationOfBenefit.item.detail.subDetail.factor [ decimal ]; # 0..1 Price scaling factor fhir:ExplanationOfBenefit.item.detail.subDetail.net [ Money ]; # 0..1 Net additional item cost fhir:ExplanationOfBenefit.item.detail.subDetail.udi [ Reference(Device) ], ... ; # 0..* Unique Device Identifier fhir:ExplanationOfBenefit.item.detail.subDetail.noteNumber [ positiveInt ], ... ; # 0..* List of note numbers which apply fhir:ExplanationOfBenefit.item.detail.subDetail.adjudication [ See ExplanationOfBenefit.item.adjudication ], ... ; # 0..* Language if different from the resource ], ...; ], ...; ], ...; fhir:ExplanationOfBenefit.addItem [ # 0..* Insurer added line items fhir:ExplanationOfBenefit.addItem.itemSequence [ positiveInt ], ... ; # 0..* Service instances fhir:ExplanationOfBenefit.addItem.detailSequence [ positiveInt ], ... ; # 0..* Detail sequence number fhir:ExplanationOfBenefit.addItem.subDetailSequence [ positiveInt ], ... ; # 0..* Subdetail sequence number fhir:ExplanationOfBenefit.addItem.service [ CodeableConcept ]; # 0..1 Billing Code fhir:ExplanationOfBenefit.addItem.modifier [ CodeableConcept ], ... ; # 0..* Service/Product billing modifiers fhir:ExplanationOfBenefit.addItem.fee [ Money ]; # 0..1 Professional fee or Product charge fhir:ExplanationOfBenefit.addItem.noteNumber [ positiveInt ], ... ; # 0..* List of note numbers which apply fhir:ExplanationOfBenefit.addItem.adjudication [ See ExplanationOfBenefit.item.adjudication ], ... ; # 0..* Added items adjudication ], ...; fhir:ExplanationOfBenefit.total [ # 0..* Adjudication totals fhir:ExplanationOfBenefit.total.category [ CodeableConcept ]; # 1..1 Adjudication category such as submitted, co-pay, eligible, benefit, etc. fhir:ExplanationOfBenefit.total.amount [ Money ]; # 1..1 Monetary amount ], ...; fhir:ExplanationOfBenefit.payment [ # 0..1 Payment (if paid) fhir:ExplanationOfBenefit.payment.type [ CodeableConcept ]; # 0..1 Partial or Complete fhir:ExplanationOfBenefit.payment.adjustment [ Money ]; # 0..1 Payment adjustment for non-Claim issues fhir:ExplanationOfBenefit.payment.adjustmentReason [ CodeableConcept ]; # 0..1 Explanation for the non-claim adjustment fhir:ExplanationOfBenefit.payment.date [ date ]; # 0..1 Expected date of Payment fhir:ExplanationOfBenefit.payment.amount [ Money ]; # 0..1 Payable amount after adjustment fhir:ExplanationOfBenefit.payment.identifier [ Identifier ]; # 0..1 Identifier of the payment instrument ]; fhir:ExplanationOfBenefit.form [ CodeableConcept ]; # 0..1 Printed Form Identifier fhir:ExplanationOfBenefit.processNote [ # 0..* Processing notes fhir:ExplanationOfBenefit.processNote.number [ positiveInt ]; # 0..1 Sequence number for this note fhir:ExplanationOfBenefit.processNote.type [ code ]; # 0..1 display | print | printoper fhir:ExplanationOfBenefit.processNote.text [ string ]; # 0..1 Note explanitory text fhir:ExplanationOfBenefit.processNote.language [ CodeableConcept ]; # 0..1 Language if different from the resource ], ...; fhir:ExplanationOfBenefit.benefitBalance [ # 0..* Balance by Benefit Category fhir:ExplanationOfBenefit.benefitBalance.category [ CodeableConcept ]; # 1..1 Type of services covered fhir:ExplanationOfBenefit.benefitBalance.subCategory [ CodeableConcept ]; # 0..1 Detailed services covered within the type fhir:ExplanationOfBenefit.benefitBalance.excluded [ boolean ]; # 0..1 Excluded from the plan fhir:ExplanationOfBenefit.benefitBalance.name [ string ]; # 0..1 Short name for the benefit fhir:ExplanationOfBenefit.benefitBalance.description [ string ]; # 0..1 Description of the benefit or services covered fhir:ExplanationOfBenefit.benefitBalance.network [ CodeableConcept ]; # 0..1 In or out of network fhir:ExplanationOfBenefit.benefitBalance.unit [ CodeableConcept ]; # 0..1 Individual or family fhir:ExplanationOfBenefit.benefitBalance.term [ CodeableConcept ]; # 0..1 Annual or lifetime fhir:ExplanationOfBenefit.benefitBalance.financial [ # 0..* Benefit Summary fhir:ExplanationOfBenefit.benefitBalance.financial.type [ CodeableConcept ]; # 1..1 Deductable, visits, benefit amount # ExplanationOfBenefit.benefitBalance.financial.allowed[x] : 0..1 Benefits allowed. One of these 3 fhir:ExplanationOfBenefit.benefitBalance.financial.allowedUnsignedInt [ unsignedInt ] fhir:ExplanationOfBenefit.benefitBalance.financial.allowedString [ string ] fhir:ExplanationOfBenefit.benefitBalance.financial.allowedMoney [ Money ] # ExplanationOfBenefit.benefitBalance.financial.used[x] : 0..1 Benefits used. One of these 2 fhir:ExplanationOfBenefit.benefitBalance.financial.usedUnsignedInt [ unsignedInt ] fhir:ExplanationOfBenefit.benefitBalance.financial.usedMoney [ Money ] ], ...; ], ...; ]
Changes since R3
ExplanationOfBenefit | |
ExplanationOfBenefit.type |
|
ExplanationOfBenefit.use |
|
ExplanationOfBenefit.enterer |
|
ExplanationOfBenefit.provider |
|
ExplanationOfBenefit.referral |
|
ExplanationOfBenefit.outcome |
|
ExplanationOfBenefit.payee.resource |
|
ExplanationOfBenefit.payee.party |
|
ExplanationOfBenefit.information.value[x] |
|
ExplanationOfBenefit.careTeam.provider |
|
ExplanationOfBenefit.diagnosis.diagnosis[x] |
|
ExplanationOfBenefit.procedure.procedure[x] |
|
ExplanationOfBenefit.accident.type |
|
ExplanationOfBenefit.accident.location[x] |
|
ExplanationOfBenefit.item.careTeamSequence |
|
ExplanationOfBenefit.item.diagnosisSequence |
|
ExplanationOfBenefit.item.procedureSequence |
|
ExplanationOfBenefit.item.informationSequence |
|
ExplanationOfBenefit.item.location[x] |
|
ExplanationOfBenefit.addItem.itemSequence |
|
ExplanationOfBenefit.addItem.detailSequence |
|
ExplanationOfBenefit.addItem.subDetailSequence |
|
ExplanationOfBenefit.total |
|
ExplanationOfBenefit.total.category |
|
ExplanationOfBenefit.total.amount |
|
ExplanationOfBenefit.processNote.type |
|
ExplanationOfBenefit.organization |
|
ExplanationOfBenefit.payee.resourceType |
|
ExplanationOfBenefit.employmentImpacted |
|
ExplanationOfBenefit.hospitalization |
|
ExplanationOfBenefit.item.careTeamLinkId |
|
ExplanationOfBenefit.item.diagnosisLinkId |
|
ExplanationOfBenefit.item.procedureLinkId |
|
ExplanationOfBenefit.item.informationLinkId |
|
ExplanationOfBenefit.item.detail.type |
|
ExplanationOfBenefit.item.detail.subDetail.type |
|
ExplanationOfBenefit.addItem.sequenceLinkId |
|
ExplanationOfBenefit.addItem.revenue |
|
ExplanationOfBenefit.addItem.category |
|
ExplanationOfBenefit.addItem.detail |
|
ExplanationOfBenefit.totalCost |
|
ExplanationOfBenefit.unallocDeductable |
|
ExplanationOfBenefit.totalBenefit |
|
See the Full Difference for further information
Structure
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
ExplanationOfBenefit | TU | DomainResource | Explanation of Benefit resource Elements defined in Ancestors: id, meta, implicitRules, language, text, contained, extension, modifierExtension | |
identifier | 0..* | Identifier | Business Identifier | |
status | ?!Σ | 0..1 | code | active | cancelled | draft | entered-in-error ExplanationOfBenefitStatus (Required) |
type | 0..1 | CodeableConcept | Type or discipline Claim Type Codes (Extensible) | |
subType | 0..* | CodeableConcept | Finer grained claim type information Example Claim SubType Codes (Example) | |
use | 0..1 | code | complete | proposed | exploratory | other Use (Required) | |
patient | 0..1 | Reference(Patient) | The subject of the Products and Services | |
billablePeriod | 0..1 | Period | Period for charge submission | |
created | 0..1 | dateTime | Creation date | |
enterer | 0..1 | Reference(Practitioner | PractitionerRole) | Author | |
insurer | 0..1 | Reference(Organization) | Insurer responsible for the EOB | |
provider | 0..1 | Reference(Practitioner | PractitionerRole | Organization) | Responsible provider for the claim | |
referral | 0..1 | Reference(ServiceRequest) | Treatment Referral | |
facility | 0..1 | Reference(Location) | Servicing Facility | |
claim | 0..1 | Reference(Claim) | Claim reference | |
claimResponse | 0..1 | Reference(ClaimResponse) | Claim response reference | |
outcome | 0..1 | code | queued | complete | error | partial Claim Processing Codes (Required) | |
disposition | 0..1 | string | Disposition Message | |
related | 0..* | BackboneElement | Related Claims which may be revelant to processing this claim | |
claim | 0..1 | Reference(Claim) | Reference to the related claim | |
relationship | 0..1 | CodeableConcept | How the reference claim is related Example Related Claim Relationship Codes (Example) | |
reference | 0..1 | Identifier | Related file or case reference | |
prescription | 0..1 | Reference(MedicationRequest | VisionPrescription) | Prescription authorizing services or products | |
originalPrescription | 0..1 | Reference(MedicationRequest) | Original prescription if superceded by fulfiller | |
payee | 0..1 | BackboneElement | Party to be paid any benefits payable | |
type | 0..1 | CodeableConcept | Type of party: Subscriber, Provider, other Claim Payee Type Codes (Example) | |
resource | 0..1 | Coding | organization | patient | practitioner | relatedperson PayeeResourceType (Extensible) | |
party | 0..1 | Reference(Practitioner | PractitionerRole | Organization | Patient | RelatedPerson) | Party to receive the payable | |
information | 0..* | BackboneElement | Exceptions, special considerations, the condition, situation, prior or concurrent issues | |
sequence | 1..1 | positiveInt | Information instance identifier | |
category | 1..1 | CodeableConcept | General class of information Claim Information Category Codes (Example) | |
code | 0..1 | CodeableConcept | Type of information Exception Codes (Example) | |
timing[x] | 0..1 | When it occurred | ||
timingDate | date | |||
timingPeriod | Period | |||
value[x] | 0..1 | Additional Data or supporting information | ||
valueBoolean | boolean | |||
valueString | string | |||
valueQuantity | Quantity | |||
valueAttachment | Attachment | |||
valueReference | Reference(Any) | |||
reason | 0..1 | Coding | Reason associated with the information Missing Tooth Reason Codes (Example) | |
careTeam | 0..* | BackboneElement | Care Team members | |
sequence | 1..1 | positiveInt | Number to convey order of careteam | |
provider | 1..1 | Reference(Practitioner | PractitionerRole | Organization) | Member of the Care Team | |
responsible | 0..1 | boolean | Billing practitioner | |
role | 0..1 | CodeableConcept | Role on the team Claim Care Team Role Codes (Example) | |
qualification | 0..1 | CodeableConcept | Type, classification or Specialization Example Provider Qualification Codes (Example) | |
diagnosis | 0..* | BackboneElement | List of Diagnosis | |
sequence | 1..1 | positiveInt | Number to convey order of diagnosis | |
diagnosis[x] | 1..1 | Patient's diagnosis ICD-10 Codes (Example) | ||
diagnosisCodeableConcept | CodeableConcept | |||
diagnosisReference | Reference(Condition) | |||
type | 0..* | CodeableConcept | Timing or nature of the diagnosis Example Diagnosis Type Codes (Example) | |
packageCode | 0..1 | CodeableConcept | Package billing code Example Diagnosis Related Group Codes (Example) | |
procedure | 0..* | BackboneElement | Procedures performed | |
sequence | 1..1 | positiveInt | Procedure sequence for reference | |
date | 0..1 | dateTime | When the procedure was performed | |
procedure[x] | 1..1 | Patient's list of procedures performed ICD-10 Procedure Codes (Example) | ||
procedureCodeableConcept | CodeableConcept | |||
procedureReference | Reference(Procedure) | |||
precedence | 0..1 | positiveInt | Precedence (primary, secondary, etc.) | |
insurance | 0..1 | BackboneElement | Insurance or medical plan | |
coverage | 0..1 | Reference(Coverage) | Insurance information | |
preAuthRef | 0..* | string | Pre-Authorization/Determination Reference | |
accident | 0..1 | BackboneElement | Details of an accident | |
date | 0..1 | date | When the accident occurred | |
type | 0..1 | CodeableConcept | The nature of the accident ActIncidentCode (Extensible) | |
location[x] | 0..1 | Accident Place | ||
locationAddress | Address | |||
locationReference | Reference(Location) | |||
item | 0..* | BackboneElement | Goods and Services | |
sequence | 1..1 | positiveInt | Service instance | |
careTeamSequence | 0..* | positiveInt | Applicable careteam members | |
diagnosisSequence | 0..* | positiveInt | Applicable diagnoses | |
procedureSequence | 0..* | positiveInt | Applicable procedures | |
informationSequence | 0..* | positiveInt | Applicable exception and supporting information | |
revenue | 0..1 | CodeableConcept | Revenue or cost center code Example Revenue Center Codes (Example) | |
category | 0..1 | CodeableConcept | Type of service or product Benefit SubCategory Codes (Example) | |
service | 0..1 | CodeableConcept | Billing Code USCLS Codes (Example) | |
modifier | 0..* | CodeableConcept | Service/Product billing modifiers Modifier type Codes (Example) | |
programCode | 0..* | CodeableConcept | Program specific reason for item inclusion Example Program Reason Codes (Example) | |
serviced[x] | 0..1 | Date or dates of Service | ||
servicedDate | date | |||
servicedPeriod | Period | |||
location[x] | 0..1 | Place of service Example Service Place Codes (Example) | ||
locationCodeableConcept | CodeableConcept | |||
locationAddress | Address | |||
locationReference | Reference(Location) | |||
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 | |
net | 0..1 | Money | Total item cost | |
udi | 0..* | Reference(Device) | Unique Device Identifier | |
bodySite | 0..1 | CodeableConcept | Service Location Oral Site Codes (Example) | |
subSite | 0..* | CodeableConcept | Service Sub-location Surface Codes (Example) | |
encounter | 0..* | Reference(Encounter) | Encounters related to this billed item | |
noteNumber | 0..* | positiveInt | List of note numbers which apply | |
adjudication | 0..* | BackboneElement | Adjudication details | |
category | 1..1 | CodeableConcept | Adjudication category such as co-pay, eligible, benefit, etc. Adjudication Value Codes (Example) | |
reason | 0..1 | CodeableConcept | Explanation of Adjudication outcome Adjudication Reason Codes (Example) | |
amount | 0..1 | Money | Monetary amount | |
value | 0..1 | decimal | Non-monitory value | |
detail | 0..* | BackboneElement | Additional items | |
sequence | 1..1 | positiveInt | Service instance | |
revenue | 0..1 | CodeableConcept | Revenue or cost center code Example Revenue Center Codes (Example) | |
category | 0..1 | CodeableConcept | Type of service or product Benefit SubCategory Codes (Example) | |
service | 0..1 | CodeableConcept | Billing Code USCLS Codes (Example) | |
modifier | 0..* | CodeableConcept | Service/Product billing modifiers Modifier type Codes (Example) | |
programCode | 0..* | CodeableConcept | Program specific reason for item inclusion Example Program Reason 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 | |
net | 0..1 | Money | Total additional item cost | |
udi | 0..* | Reference(Device) | Unique Device Identifier | |
noteNumber | 0..* | positiveInt | List of note numbers which apply | |
adjudication | 0..* | see adjudication | Detail level adjudication details | |
subDetail | 0..* | BackboneElement | Additional items | |
sequence | 1..1 | positiveInt | Service instance | |
revenue | 0..1 | CodeableConcept | Revenue or cost center code Example Revenue Center Codes (Example) | |
category | 0..1 | CodeableConcept | Type of service or product Benefit SubCategory Codes (Example) | |
service | 0..1 | CodeableConcept | Billing Code USCLS Codes (Example) | |
modifier | 0..* | CodeableConcept | Service/Product billing modifiers Modifier type Codes (Example) | |
programCode | 0..* | CodeableConcept | Program specific reason for item inclusion Example Program Reason 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 | |
net | 0..1 | Money | Net additional item cost | |
udi | 0..* | Reference(Device) | Unique Device Identifier | |
noteNumber | 0..* | positiveInt | List of note numbers which apply | |
adjudication | 0..* | see adjudication | Language if different from the resource | |
addItem | 0..* | BackboneElement | Insurer added line items | |
itemSequence | 0..* | positiveInt | Service instances | |
detailSequence | 0..* | positiveInt | Detail sequence number | |
subDetailSequence | 0..* | positiveInt | Subdetail sequence number | |
service | 0..1 | CodeableConcept | Billing Code USCLS Codes (Example) | |
modifier | 0..* | CodeableConcept | Service/Product billing modifiers Modifier type Codes (Example) | |
fee | 0..1 | Money | Professional fee or Product charge | |
noteNumber | 0..* | positiveInt | List of note numbers which apply | |
adjudication | 0..* | see adjudication | Added items adjudication | |
total | 0..* | BackboneElement | Adjudication totals | |
category | 1..1 | CodeableConcept | Adjudication category such as submitted, co-pay, eligible, benefit, etc. Adjudication Value Codes (Example) | |
amount | 1..1 | Money | Monetary amount | |
payment | 0..1 | BackboneElement | Payment (if paid) | |
type | 0..1 | CodeableConcept | Partial or Complete Example Payment Type Codes (Example) | |
adjustment | 0..1 | Money | Payment adjustment for non-Claim issues | |
adjustmentReason | 0..1 | CodeableConcept | Explanation for the non-claim adjustment Payment Adjustment Reason Codes (Example) | |
date | 0..1 | date | Expected date of Payment | |
amount | 0..1 | Money | Payable amount after adjustment | |
identifier | 0..1 | Identifier | Identifier of the payment instrument | |
form | 0..1 | CodeableConcept | Printed Form Identifier Form Codes (Example) | |
processNote | 0..* | BackboneElement | Processing notes | |
number | 0..1 | positiveInt | Sequence number for this note | |
type | 0..1 | code | display | print | printoper NoteType (Required) | |
text | 0..1 | string | Note explanitory text | |
language | 0..1 | CodeableConcept | Language if different from the resource Common Languages (Extensible but limited to All Languages) | |
benefitBalance | 0..* | BackboneElement | Balance by Benefit Category | |
category | 1..1 | CodeableConcept | Type of services covered Benefit Category Codes (Example) | |
subCategory | 0..1 | CodeableConcept | Detailed services covered within the type Benefit SubCategory Codes (Example) | |
excluded | 0..1 | boolean | Excluded from the plan | |
name | 0..1 | string | Short name for the benefit | |
description | 0..1 | string | Description of the benefit or services covered | |
network | 0..1 | CodeableConcept | In or out of network Network Type Codes (Example) | |
unit | 0..1 | CodeableConcept | Individual or family Unit Type Codes (Example) | |
term | 0..1 | CodeableConcept | Annual or lifetime Benefit Term Codes (Example) | |
financial | 0..* | BackboneElement | Benefit Summary | |
type | 1..1 | CodeableConcept | Deductable, visits, benefit amount Benefit Type Codes (Example) | |
allowed[x] | 0..1 | Benefits allowed | ||
allowedUnsignedInt | unsignedInt | |||
allowedString | string | |||
allowedMoney | Money | |||
used[x] | 0..1 | Benefits used | ||
usedUnsignedInt | unsignedInt | |||
usedMoney | 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> <status value="[code]"/><!-- 0..1 active | cancelled | draft | entered-in-error --> <type><!-- 0..1 CodeableConcept Type or discipline --></type> <subType><!-- 0..* CodeableConcept Finer grained claim type information --></subType> <use value="[code]"/><!-- 0..1 complete | proposed | exploratory | other --> <patient><!-- 0..1 Reference(Patient) The subject of the Products and Services --></patient> <billablePeriod><!-- 0..1 Period Period for charge submission --></billablePeriod> <created value="[dateTime]"/><!-- 0..1 Creation date --> <enterer><!-- 0..1 Reference(Practitioner|PractitionerRole) Author --></enterer> <insurer><!-- 0..1 Reference(Organization) Insurer responsible for the EOB --></insurer> <provider><!-- 0..1 Reference(Practitioner|PractitionerRole|Organization) Responsible provider for the claim --></provider> <referral><!-- 0..1 Reference(ServiceRequest) Treatment Referral --></referral> <facility><!-- 0..1 Reference(Location) Servicing Facility --></facility> <claim><!-- 0..1 Reference(Claim) Claim reference --></claim> <claimResponse><!-- 0..1 Reference(ClaimResponse) Claim response reference --></claimResponse> <outcome value="[code]"/><!-- 0..1 queued | complete | error | partial --> <disposition value="[string]"/><!-- 0..1 Disposition Message --> <related> <!-- 0..* Related Claims which may be revelant to processing this claim --> <claim><!-- 0..1 Reference(Claim) Reference to the related claim --></claim> <relationship><!-- 0..1 CodeableConcept How the reference claim is related --></relationship> <reference><!-- 0..1 Identifier Related file or case reference --></reference> </related> <prescription><!-- 0..1 Reference(MedicationRequest|VisionPrescription) Prescription authorizing services or products --></prescription> <originalPrescription><!-- 0..1 Reference(MedicationRequest) Original prescription if superceded by fulfiller --></originalPrescription> <payee> <!-- 0..1 Party to be paid any benefits payable --> <type><!-- 0..1 CodeableConcept Type of party: Subscriber, Provider, other --></type> <resource><!-- 0..1 Coding organization | patient | practitioner | relatedperson --></resource> <party><!-- 0..1 Reference(Practitioner|PractitionerRole|Organization|Patient| RelatedPerson) Party to receive the payable --></party> </payee> <information> <!-- 0..* Exceptions, special considerations, the condition, situation, prior or concurrent issues --> <sequence value="[positiveInt]"/><!-- 1..1 Information instance identifier --> <category><!-- 1..1 CodeableConcept General class of information --></category> <code><!-- 0..1 CodeableConcept Type of information --></code> <timing[x]><!-- 0..1 date|Period When it occurred --></timing[x]> <value[x]><!-- 0..1 boolean|string|Quantity|Attachment|Reference(Any) Additional Data or supporting information --></value[x]> <reason><!-- 0..1 Coding Reason associated with the information --></reason> </information> <careTeam> <!-- 0..* Care Team members --> <sequence value="[positiveInt]"/><!-- 1..1 Number to convey order of careteam --> <provider><!-- 1..1 Reference(Practitioner|PractitionerRole|Organization) Member of the Care Team --></provider> <responsible value="[boolean]"/><!-- 0..1 Billing practitioner --> <role><!-- 0..1 CodeableConcept Role on the team --></role> <qualification><!-- 0..1 CodeableConcept Type, classification or Specialization --></qualification> </careTeam> <diagnosis> <!-- 0..* List of Diagnosis --> <sequence value="[positiveInt]"/><!-- 1..1 Number to convey order of diagnosis --> <diagnosis[x]><!-- 1..1 CodeableConcept|Reference(Condition) Patient's diagnosis --></diagnosis[x]> <type><!-- 0..* CodeableConcept Timing or nature of the diagnosis --></type> <packageCode><!-- 0..1 CodeableConcept Package billing code --></packageCode> </diagnosis> <procedure> <!-- 0..* Procedures performed --> <sequence value="[positiveInt]"/><!-- 1..1 Procedure sequence for reference --> <date value="[dateTime]"/><!-- 0..1 When the procedure was performed --> <procedure[x]><!-- 1..1 CodeableConcept|Reference(Procedure) Patient's list of procedures performed --></procedure[x]> </procedure> <precedence value="[positiveInt]"/><!-- 0..1 Precedence (primary, secondary, etc.) --> <insurance> <!-- 0..1 Insurance or medical plan --> <coverage><!-- 0..1 Reference(Coverage) Insurance information --></coverage> <preAuthRef value="[string]"/><!-- 0..* Pre-Authorization/Determination Reference --> </insurance> <accident> <!-- 0..1 Details of an accident --> <date value="[date]"/><!-- 0..1 When the accident occurred --> <type><!-- 0..1 CodeableConcept The nature of the accident --></type> <location[x]><!-- 0..1 Address|Reference(Location) Accident Place --></location[x]> </accident> <item> <!-- 0..* Goods and Services --> <sequence value="[positiveInt]"/><!-- 1..1 Service instance --> <careTeamSequence value="[positiveInt]"/><!-- 0..* Applicable careteam members --> <diagnosisSequence value="[positiveInt]"/><!-- 0..* Applicable diagnoses --> <procedureSequence value="[positiveInt]"/><!-- 0..* Applicable procedures --> <informationSequence value="[positiveInt]"/><!-- 0..* Applicable exception and supporting information --> <revenue><!-- 0..1 CodeableConcept Revenue or cost center code --></revenue> <category><!-- 0..1 CodeableConcept Type of service or product --></category> <service><!-- 0..1 CodeableConcept Billing Code --></service> <modifier><!-- 0..* CodeableConcept Service/Product billing modifiers --></modifier> <programCode><!-- 0..* CodeableConcept Program specific reason for item inclusion --></programCode> <serviced[x]><!-- 0..1 date|Period Date or dates of Service --></serviced[x]> <location[x]><!-- 0..1 CodeableConcept|Address|Reference(Location) Place of service --></location[x]> <quantity><!-- 0..1 Quantity(SimpleQuantity) Count of Products or Services --></quantity> <unitPrice><!-- 0..1 Money Fee, charge or cost per point --></unitPrice> <factor value="[decimal]"/><!-- 0..1 Price scaling factor --> <net><!-- 0..1 Money Total item cost --></net> <udi><!-- 0..* Reference(Device) Unique Device Identifier --></udi> <bodySite><!-- 0..1 CodeableConcept Service Location --></bodySite> <subSite><!-- 0..* CodeableConcept Service Sub-location --></subSite> <encounter><!-- 0..* Reference(Encounter) Encounters related to this billed item --></encounter> <noteNumber value="[positiveInt]"/><!-- 0..* List of note numbers which apply --> <adjudication> <!-- 0..* Adjudication details --> <category><!-- 1..1 CodeableConcept Adjudication category such as co-pay, eligible, benefit, etc. --></category> <reason><!-- 0..1 CodeableConcept Explanation of Adjudication outcome --></reason> <amount><!-- 0..1 Money Monetary amount --></amount> <value value="[decimal]"/><!-- 0..1 Non-monitory value --> </adjudication> <detail> <!-- 0..* Additional items --> <sequence value="[positiveInt]"/><!-- 1..1 Service instance --> <revenue><!-- 0..1 CodeableConcept Revenue or cost center code --></revenue> <category><!-- 0..1 CodeableConcept Type of service or product --></category> <service><!-- 0..1 CodeableConcept Billing Code --></service> <modifier><!-- 0..* CodeableConcept Service/Product billing modifiers --></modifier> <programCode><!-- 0..* CodeableConcept Program specific reason for item inclusion --></programCode> <quantity><!-- 0..1 Quantity(SimpleQuantity) Count of Products or Services --></quantity> <unitPrice><!-- 0..1 Money Fee, charge or cost per point --></unitPrice> <factor value="[decimal]"/><!-- 0..1 Price scaling factor --> <net><!-- 0..1 Money Total additional item cost --></net> <udi><!-- 0..* Reference(Device) Unique Device Identifier --></udi> <noteNumber value="[positiveInt]"/><!-- 0..* List of note numbers which apply --> <adjudication><!-- 0..* Content as for ExplanationOfBenefit.item.adjudication Detail level adjudication details --></adjudication> <subDetail> <!-- 0..* Additional items --> <sequence value="[positiveInt]"/><!-- 1..1 Service instance --> <revenue><!-- 0..1 CodeableConcept Revenue or cost center code --></revenue> <category><!-- 0..1 CodeableConcept Type of service or product --></category> <service><!-- 0..1 CodeableConcept Billing Code --></service> <modifier><!-- 0..* CodeableConcept Service/Product billing modifiers --></modifier> <programCode><!-- 0..* CodeableConcept Program specific reason for item inclusion --></programCode> <quantity><!-- 0..1 Quantity(SimpleQuantity) Count of Products or Services --></quantity> <unitPrice><!-- 0..1 Money Fee, charge or cost per point --></unitPrice> <factor value="[decimal]"/><!-- 0..1 Price scaling factor --> <net><!-- 0..1 Money Net additional item cost --></net> <udi><!-- 0..* Reference(Device) Unique Device Identifier --></udi> <noteNumber value="[positiveInt]"/><!-- 0..* List of note numbers which apply --> <adjudication><!-- 0..* Content as for ExplanationOfBenefit.item.adjudication Language if different from the resource --></adjudication> </subDetail> </detail> </item> <addItem> <!-- 0..* Insurer added line items --> <itemSequence value="[positiveInt]"/><!-- 0..* Service instances --> <detailSequence value="[positiveInt]"/><!-- 0..* Detail sequence number --> <subDetailSequence value="[positiveInt]"/><!-- 0..* Subdetail sequence number --> <service><!-- 0..1 CodeableConcept Billing Code --></service> <modifier><!-- 0..* CodeableConcept Service/Product billing modifiers --></modifier> <fee><!-- 0..1 Money Professional fee or Product charge --></fee> <noteNumber value="[positiveInt]"/><!-- 0..* List of note numbers which apply --> <adjudication><!-- 0..* Content as for ExplanationOfBenefit.item.adjudication Added items adjudication --></adjudication> </addItem> <total> <!-- 0..* Adjudication totals --> <category><!-- 1..1 CodeableConcept Adjudication category such as submitted, co-pay, eligible, benefit, etc. --></category> <amount><!-- 1..1 Money Monetary amount --></amount> </total> <payment> <!-- 0..1 Payment (if paid) --> <type><!-- 0..1 CodeableConcept Partial or Complete --></type> <adjustment><!-- 0..1 Money Payment adjustment for non-Claim issues --></adjustment> <adjustmentReason><!-- 0..1 CodeableConcept Explanation for the non-claim adjustment --></adjustmentReason> <date value="[date]"/><!-- 0..1 Expected date of Payment --> <amount><!-- 0..1 Money Payable amount after adjustment --></amount> <identifier><!-- 0..1 Identifier Identifier of the payment instrument --></identifier> </payment> <form><!-- 0..1 CodeableConcept Printed Form Identifier --></form> <processNote> <!-- 0..* Processing notes --> <number value="[positiveInt]"/><!-- 0..1 Sequence number for this note --> <type value="[code]"/><!-- 0..1 display | print | printoper --> <text value="[string]"/><!-- 0..1 Note explanitory text --> <language><!-- 0..1 CodeableConcept Language if different from the resource --></language> </processNote> <benefitBalance> <!-- 0..* Balance by Benefit Category --> <category><!-- 1..1 CodeableConcept Type of services covered --></category> <subCategory><!-- 0..1 CodeableConcept Detailed services covered within the type --></subCategory> <excluded value="[boolean]"/><!-- 0..1 Excluded from the plan --> <name value="[string]"/><!-- 0..1 Short name for the benefit --> <description value="[string]"/><!-- 0..1 Description of the benefit or services covered --> <network><!-- 0..1 CodeableConcept In or out of network --></network> <unit><!-- 0..1 CodeableConcept Individual or family --></unit> <term><!-- 0..1 CodeableConcept Annual or lifetime --></term> <financial> <!-- 0..* Benefit Summary --> <type><!-- 1..1 CodeableConcept Deductable, visits, benefit amount --></type> <allowed[x]><!-- 0..1 unsignedInt|string|Money Benefits allowed --></allowed[x]> <used[x]><!-- 0..1 unsignedInt|Money Benefits used --></used[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 "status" : "<code>", // active | cancelled | draft | entered-in-error "type" : { CodeableConcept }, // Type or discipline "subType" : [{ CodeableConcept }], // Finer grained claim type information "use" : "<code>", // complete | proposed | exploratory | other "patient" : { Reference(Patient) }, // The subject of the Products and Services "billablePeriod" : { Period }, // Period for charge submission "created" : "<dateTime>", // Creation date "enterer" : { Reference(Practitioner|PractitionerRole) }, // Author "insurer" : { Reference(Organization) }, // Insurer responsible for the EOB "provider" : { Reference(Practitioner|PractitionerRole|Organization) }, // Responsible provider for the claim "referral" : { Reference(ServiceRequest) }, // Treatment Referral "facility" : { Reference(Location) }, // Servicing Facility "claim" : { Reference(Claim) }, // Claim reference "claimResponse" : { Reference(ClaimResponse) }, // Claim response reference "outcome" : "<code>", // queued | complete | error | partial "disposition" : "<string>", // Disposition Message "related" : [{ // Related Claims which may be revelant to processing this claim "claim" : { Reference(Claim) }, // Reference to the related claim "relationship" : { CodeableConcept }, // How the reference claim is related "reference" : { Identifier } // Related file or case reference }], "prescription" : { Reference(MedicationRequest|VisionPrescription) }, // Prescription authorizing services or products "originalPrescription" : { Reference(MedicationRequest) }, // Original prescription if superceded by fulfiller "payee" : { // Party to be paid any benefits payable "type" : { CodeableConcept }, // Type of party: Subscriber, Provider, other "resource" : { Coding }, // organization | patient | practitioner | relatedperson "party" : { Reference(Practitioner|PractitionerRole|Organization|Patient| RelatedPerson) } // Party to receive the payable }, "information" : [{ // Exceptions, special considerations, the condition, situation, prior or concurrent issues "sequence" : "<positiveInt>", // R! Information instance identifier "category" : { CodeableConcept }, // R! General class of information "code" : { CodeableConcept }, // Type of information // timing[x]: When it occurred. One of these 2: "timingDate" : "<date>", "timingPeriod" : { Period }, // value[x]: Additional Data or supporting information. One of these 5: "valueBoolean" : <boolean>, "valueString" : "<string>", "valueQuantity" : { Quantity }, "valueAttachment" : { Attachment }, "valueReference" : { Reference(Any) }, "reason" : { Coding } // Reason associated with the information }], "careTeam" : [{ // Care Team members "sequence" : "<positiveInt>", // R! Number to convey order of careteam "provider" : { Reference(Practitioner|PractitionerRole|Organization) }, // R! Member of the Care Team "responsible" : <boolean>, // Billing practitioner "role" : { CodeableConcept }, // Role on the team "qualification" : { CodeableConcept } // Type, classification or Specialization }], "diagnosis" : [{ // List of Diagnosis "sequence" : "<positiveInt>", // R! Number to convey order of diagnosis // diagnosis[x]: Patient's diagnosis. One of these 2: "diagnosisCodeableConcept" : { CodeableConcept }, "diagnosisReference" : { Reference(Condition) }, "type" : [{ CodeableConcept }], // Timing or nature of the diagnosis "packageCode" : { CodeableConcept } // Package billing code }], "procedure" : [{ // Procedures performed "sequence" : "<positiveInt>", // R! Procedure sequence for reference "date" : "<dateTime>", // When the procedure was performed // procedure[x]: Patient's list of procedures performed. One of these 2: "procedureCodeableConcept" : { CodeableConcept } "procedureReference" : { Reference(Procedure) } }], "precedence" : "<positiveInt>", // Precedence (primary, secondary, etc.) "insurance" : { // Insurance or medical plan "coverage" : { Reference(Coverage) }, // Insurance information "preAuthRef" : ["<string>"] // Pre-Authorization/Determination Reference }, "accident" : { // Details of an accident "date" : "<date>", // When the accident occurred "type" : { CodeableConcept }, // The nature of the accident // location[x]: Accident Place. One of these 2: "locationAddress" : { Address } "locationReference" : { Reference(Location) } }, "item" : [{ // Goods and Services "sequence" : "<positiveInt>", // R! Service instance "careTeamSequence" : ["<positiveInt>"], // Applicable careteam members "diagnosisSequence" : ["<positiveInt>"], // Applicable diagnoses "procedureSequence" : ["<positiveInt>"], // Applicable procedures "informationSequence" : ["<positiveInt>"], // Applicable exception and supporting information "revenue" : { CodeableConcept }, // Revenue or cost center code "category" : { CodeableConcept }, // Type of service or product "service" : { CodeableConcept }, // Billing Code "modifier" : [{ CodeableConcept }], // Service/Product billing modifiers "programCode" : [{ CodeableConcept }], // Program specific reason for item inclusion // serviced[x]: Date or dates of Service. One of these 2: "servicedDate" : "<date>", "servicedPeriod" : { Period }, // location[x]: Place of service. One of these 3: "locationCodeableConcept" : { CodeableConcept }, "locationAddress" : { Address }, "locationReference" : { Reference(Location) }, "quantity" : { Quantity(SimpleQuantity) }, // Count of Products or Services "unitPrice" : { Money }, // Fee, charge or cost per point "factor" : <decimal>, // Price scaling factor "net" : { Money }, // Total item cost "udi" : [{ Reference(Device) }], // Unique Device Identifier "bodySite" : { CodeableConcept }, // Service Location "subSite" : [{ CodeableConcept }], // Service Sub-location "encounter" : [{ Reference(Encounter) }], // Encounters related to this billed item "noteNumber" : ["<positiveInt>"], // List of note numbers which apply "adjudication" : [{ // Adjudication details "category" : { CodeableConcept }, // R! Adjudication category such as co-pay, eligible, benefit, etc. "reason" : { CodeableConcept }, // Explanation of Adjudication outcome "amount" : { Money }, // Monetary amount "value" : <decimal> // Non-monitory value }], "detail" : [{ // Additional items "sequence" : "<positiveInt>", // R! Service instance "revenue" : { CodeableConcept }, // Revenue or cost center code "category" : { CodeableConcept }, // Type of service or product "service" : { CodeableConcept }, // Billing Code "modifier" : [{ CodeableConcept }], // Service/Product billing modifiers "programCode" : [{ CodeableConcept }], // Program specific reason for item inclusion "quantity" : { Quantity(SimpleQuantity) }, // Count of Products or Services "unitPrice" : { Money }, // Fee, charge or cost per point "factor" : <decimal>, // Price scaling factor "net" : { Money }, // Total additional item cost "udi" : [{ Reference(Device) }], // Unique Device Identifier "noteNumber" : ["<positiveInt>"], // List of note numbers which apply "adjudication" : [{ Content as for ExplanationOfBenefit.item.adjudication }], // Detail level adjudication details "subDetail" : [{ // Additional items "sequence" : "<positiveInt>", // R! Service instance "revenue" : { CodeableConcept }, // Revenue or cost center code "category" : { CodeableConcept }, // Type of service or product "service" : { CodeableConcept }, // Billing Code "modifier" : [{ CodeableConcept }], // Service/Product billing modifiers "programCode" : [{ CodeableConcept }], // Program specific reason for item inclusion "quantity" : { Quantity(SimpleQuantity) }, // Count of Products or Services "unitPrice" : { Money }, // Fee, charge or cost per point "factor" : <decimal>, // Price scaling factor "net" : { Money }, // Net additional item cost "udi" : [{ Reference(Device) }], // Unique Device Identifier "noteNumber" : ["<positiveInt>"], // List of note numbers which apply "adjudication" : [{ Content as for ExplanationOfBenefit.item.adjudication }] // Language if different from the resource }] }] }], "addItem" : [{ // Insurer added line items "itemSequence" : ["<positiveInt>"], // Service instances "detailSequence" : ["<positiveInt>"], // Detail sequence number "subDetailSequence" : ["<positiveInt>"], // Subdetail sequence number "service" : { CodeableConcept }, // Billing Code "modifier" : [{ CodeableConcept }], // Service/Product billing modifiers "fee" : { Money }, // Professional fee or Product charge "noteNumber" : ["<positiveInt>"], // List of note numbers which apply "adjudication" : [{ Content as for ExplanationOfBenefit.item.adjudication }] // Added items adjudication }], "total" : [{ // Adjudication totals "category" : { CodeableConcept }, // R! Adjudication category such as submitted, co-pay, eligible, benefit, etc. "amount" : { Money } // R! Monetary amount }], "payment" : { // Payment (if paid) "type" : { CodeableConcept }, // Partial or Complete "adjustment" : { Money }, // Payment adjustment for non-Claim issues "adjustmentReason" : { CodeableConcept }, // Explanation for the non-claim adjustment "date" : "<date>", // Expected date of Payment "amount" : { Money }, // Payable amount after adjustment "identifier" : { Identifier } // Identifier of the payment instrument }, "form" : { CodeableConcept }, // Printed Form Identifier "processNote" : [{ // Processing notes "number" : "<positiveInt>", // Sequence number for this note "type" : "<code>", // display | print | printoper "text" : "<string>", // Note explanitory text "language" : { CodeableConcept } // Language if different from the resource }], "benefitBalance" : [{ // Balance by Benefit Category "category" : { CodeableConcept }, // R! Type of services covered "subCategory" : { CodeableConcept }, // Detailed services covered within the type "excluded" : <boolean>, // Excluded from the plan "name" : "<string>", // Short name for the benefit "description" : "<string>", // Description of the benefit or services covered "network" : { CodeableConcept }, // In or out of network "unit" : { CodeableConcept }, // Individual or family "term" : { CodeableConcept }, // Annual or lifetime "financial" : [{ // Benefit Summary "type" : { CodeableConcept }, // R! Deductable, visits, benefit amount // allowed[x]: Benefits allowed. One of these 3: "allowedUnsignedInt" : "<unsignedInt>", "allowedString" : "<string>", "allowedMoney" : { Money }, // used[x]: Benefits used. One of these 2: "usedUnsignedInt" : "<unsignedInt>" "usedMoney" : { Money } }] }] }
Turtle Template
@prefix fhir: <http://hl7.org/fhir/> . [ a fhir:ExplanationOfBenefit; fhir:nodeRole fhir:treeRoot; # if this is the parser root # from Resource: .id, .meta, .implicitRules, and .language # from DomainResource: .text, .contained, .extension, and .modifierExtension fhir:ExplanationOfBenefit.identifier [ Identifier ], ... ; # 0..* Business Identifier fhir:ExplanationOfBenefit.status [ code ]; # 0..1 active | cancelled | draft | entered-in-error fhir:ExplanationOfBenefit.type [ CodeableConcept ]; # 0..1 Type or discipline fhir:ExplanationOfBenefit.subType [ CodeableConcept ], ... ; # 0..* Finer grained claim type information fhir:ExplanationOfBenefit.use [ code ]; # 0..1 complete | proposed | exploratory | other fhir:ExplanationOfBenefit.patient [ Reference(Patient) ]; # 0..1 The subject of the Products and Services fhir:ExplanationOfBenefit.billablePeriod [ Period ]; # 0..1 Period for charge submission fhir:ExplanationOfBenefit.created [ dateTime ]; # 0..1 Creation date fhir:ExplanationOfBenefit.enterer [ Reference(Practitioner|PractitionerRole) ]; # 0..1 Author fhir:ExplanationOfBenefit.insurer [ Reference(Organization) ]; # 0..1 Insurer responsible for the EOB fhir:ExplanationOfBenefit.provider [ Reference(Practitioner|PractitionerRole|Organization) ]; # 0..1 Responsible provider for the claim fhir:ExplanationOfBenefit.referral [ Reference(ServiceRequest) ]; # 0..1 Treatment Referral fhir:ExplanationOfBenefit.facility [ Reference(Location) ]; # 0..1 Servicing Facility fhir:ExplanationOfBenefit.claim [ Reference(Claim) ]; # 0..1 Claim reference fhir:ExplanationOfBenefit.claimResponse [ Reference(ClaimResponse) ]; # 0..1 Claim response reference fhir:ExplanationOfBenefit.outcome [ code ]; # 0..1 queued | complete | error | partial fhir:ExplanationOfBenefit.disposition [ string ]; # 0..1 Disposition Message fhir:ExplanationOfBenefit.related [ # 0..* Related Claims which may be revelant to processing this claim fhir:ExplanationOfBenefit.related.claim [ Reference(Claim) ]; # 0..1 Reference to the related claim fhir:ExplanationOfBenefit.related.relationship [ CodeableConcept ]; # 0..1 How the reference claim is related fhir:ExplanationOfBenefit.related.reference [ Identifier ]; # 0..1 Related file or case reference ], ...; fhir:ExplanationOfBenefit.prescription [ Reference(MedicationRequest|VisionPrescription) ]; # 0..1 Prescription authorizing services or products fhir:ExplanationOfBenefit.originalPrescription [ Reference(MedicationRequest) ]; # 0..1 Original prescription if superceded by fulfiller fhir:ExplanationOfBenefit.payee [ # 0..1 Party to be paid any benefits payable fhir:ExplanationOfBenefit.payee.type [ CodeableConcept ]; # 0..1 Type of party: Subscriber, Provider, other fhir:ExplanationOfBenefit.payee.resource [ Coding ]; # 0..1 organization | patient | practitioner | relatedperson fhir:ExplanationOfBenefit.payee.party [ Reference(Practitioner|PractitionerRole|Organization|Patient|RelatedPerson) ]; # 0..1 Party to receive the payable ]; fhir:ExplanationOfBenefit.information [ # 0..* Exceptions, special considerations, the condition, situation, prior or concurrent issues fhir:ExplanationOfBenefit.information.sequence [ positiveInt ]; # 1..1 Information instance identifier fhir:ExplanationOfBenefit.information.category [ CodeableConcept ]; # 1..1 General class of information fhir:ExplanationOfBenefit.information.code [ CodeableConcept ]; # 0..1 Type of information # ExplanationOfBenefit.information.timing[x] : 0..1 When it occurred. One of these 2 fhir:ExplanationOfBenefit.information.timingDate [ date ] fhir:ExplanationOfBenefit.information.timingPeriod [ Period ] # ExplanationOfBenefit.information.value[x] : 0..1 Additional Data or supporting information. One of these 5 fhir:ExplanationOfBenefit.information.valueBoolean [ boolean ] fhir:ExplanationOfBenefit.information.valueString [ string ] fhir:ExplanationOfBenefit.information.valueQuantity [ Quantity ] fhir:ExplanationOfBenefit.information.valueAttachment [ Attachment ] fhir:ExplanationOfBenefit.information.valueReference [ Reference(Any) ] fhir:ExplanationOfBenefit.information.reason [ Coding ]; # 0..1 Reason associated with the information ], ...; fhir:ExplanationOfBenefit.careTeam [ # 0..* Care Team members fhir:ExplanationOfBenefit.careTeam.sequence [ positiveInt ]; # 1..1 Number to convey order of careteam fhir:ExplanationOfBenefit.careTeam.provider [ Reference(Practitioner|PractitionerRole|Organization) ]; # 1..1 Member of the Care Team fhir:ExplanationOfBenefit.careTeam.responsible [ boolean ]; # 0..1 Billing practitioner fhir:ExplanationOfBenefit.careTeam.role [ CodeableConcept ]; # 0..1 Role on the team fhir:ExplanationOfBenefit.careTeam.qualification [ CodeableConcept ]; # 0..1 Type, classification or Specialization ], ...; fhir:ExplanationOfBenefit.diagnosis [ # 0..* List of Diagnosis fhir:ExplanationOfBenefit.diagnosis.sequence [ positiveInt ]; # 1..1 Number to convey order of diagnosis # ExplanationOfBenefit.diagnosis.diagnosis[x] : 1..1 Patient's diagnosis. One of these 2 fhir:ExplanationOfBenefit.diagnosis.diagnosisCodeableConcept [ CodeableConcept ] fhir:ExplanationOfBenefit.diagnosis.diagnosisReference [ Reference(Condition) ] fhir:ExplanationOfBenefit.diagnosis.type [ CodeableConcept ], ... ; # 0..* Timing or nature of the diagnosis fhir:ExplanationOfBenefit.diagnosis.packageCode [ CodeableConcept ]; # 0..1 Package billing code ], ...; fhir:ExplanationOfBenefit.procedure [ # 0..* Procedures performed fhir:ExplanationOfBenefit.procedure.sequence [ positiveInt ]; # 1..1 Procedure sequence for reference fhir:ExplanationOfBenefit.procedure.date [ dateTime ]; # 0..1 When the procedure was performed # ExplanationOfBenefit.procedure.procedure[x] : 1..1 Patient's list of procedures performed. One of these 2 fhir:ExplanationOfBenefit.procedure.procedureCodeableConcept [ CodeableConcept ] fhir:ExplanationOfBenefit.procedure.procedureReference [ Reference(Procedure) ] ], ...; fhir:ExplanationOfBenefit.precedence [ positiveInt ]; # 0..1 Precedence (primary, secondary, etc.) fhir:ExplanationOfBenefit.insurance [ # 0..1 Insurance or medical plan fhir:ExplanationOfBenefit.insurance.coverage [ Reference(Coverage) ]; # 0..1 Insurance information fhir:ExplanationOfBenefit.insurance.preAuthRef [ string ], ... ; # 0..* Pre-Authorization/Determination Reference ]; fhir:ExplanationOfBenefit.accident [ # 0..1 Details of an accident fhir:ExplanationOfBenefit.accident.date [ date ]; # 0..1 When the accident occurred fhir:ExplanationOfBenefit.accident.type [ CodeableConcept ]; # 0..1 The nature of the accident # ExplanationOfBenefit.accident.location[x] : 0..1 Accident Place. One of these 2 fhir:ExplanationOfBenefit.accident.locationAddress [ Address ] fhir:ExplanationOfBenefit.accident.locationReference [ Reference(Location) ] ]; fhir:ExplanationOfBenefit.item [ # 0..* Goods and Services fhir:ExplanationOfBenefit.item.sequence [ positiveInt ]; # 1..1 Service instance fhir:ExplanationOfBenefit.item.careTeamSequence [ positiveInt ], ... ; # 0..* Applicable careteam members fhir:ExplanationOfBenefit.item.diagnosisSequence [ positiveInt ], ... ; # 0..* Applicable diagnoses fhir:ExplanationOfBenefit.item.procedureSequence [ positiveInt ], ... ; # 0..* Applicable procedures fhir:ExplanationOfBenefit.item.informationSequence [ positiveInt ], ... ; # 0..* Applicable exception and supporting information fhir:ExplanationOfBenefit.item.revenue [ CodeableConcept ]; # 0..1 Revenue or cost center code fhir:ExplanationOfBenefit.item.category [ CodeableConcept ]; # 0..1 Type of service or product fhir:ExplanationOfBenefit.item.service [ CodeableConcept ]; # 0..1 Billing Code fhir:ExplanationOfBenefit.item.modifier [ CodeableConcept ], ... ; # 0..* Service/Product billing modifiers fhir:ExplanationOfBenefit.item.programCode [ CodeableConcept ], ... ; # 0..* Program specific reason for item inclusion # ExplanationOfBenefit.item.serviced[x] : 0..1 Date or dates of Service. One of these 2 fhir:ExplanationOfBenefit.item.servicedDate [ date ] fhir:ExplanationOfBenefit.item.servicedPeriod [ Period ] # ExplanationOfBenefit.item.location[x] : 0..1 Place of service. One of these 3 fhir:ExplanationOfBenefit.item.locationCodeableConcept [ CodeableConcept ] fhir:ExplanationOfBenefit.item.locationAddress [ Address ] fhir:ExplanationOfBenefit.item.locationReference [ Reference(Location) ] fhir:ExplanationOfBenefit.item.quantity [ Quantity(SimpleQuantity) ]; # 0..1 Count of Products or Services fhir:ExplanationOfBenefit.item.unitPrice [ Money ]; # 0..1 Fee, charge or cost per point fhir:ExplanationOfBenefit.item.factor [ decimal ]; # 0..1 Price scaling factor fhir:ExplanationOfBenefit.item.net [ Money ]; # 0..1 Total item cost fhir:ExplanationOfBenefit.item.udi [ Reference(Device) ], ... ; # 0..* Unique Device Identifier fhir:ExplanationOfBenefit.item.bodySite [ CodeableConcept ]; # 0..1 Service Location fhir:ExplanationOfBenefit.item.subSite [ CodeableConcept ], ... ; # 0..* Service Sub-location fhir:ExplanationOfBenefit.item.encounter [ Reference(Encounter) ], ... ; # 0..* Encounters related to this billed item fhir:ExplanationOfBenefit.item.noteNumber [ positiveInt ], ... ; # 0..* List of note numbers which apply fhir:ExplanationOfBenefit.item.adjudication [ # 0..* Adjudication details fhir:ExplanationOfBenefit.item.adjudication.category [ CodeableConcept ]; # 1..1 Adjudication category such as co-pay, eligible, benefit, etc. fhir:ExplanationOfBenefit.item.adjudication.reason [ CodeableConcept ]; # 0..1 Explanation of Adjudication outcome fhir:ExplanationOfBenefit.item.adjudication.amount [ Money ]; # 0..1 Monetary amount fhir:ExplanationOfBenefit.item.adjudication.value [ decimal ]; # 0..1 Non-monitory value ], ...; fhir:ExplanationOfBenefit.item.detail [ # 0..* Additional items fhir:ExplanationOfBenefit.item.detail.sequence [ positiveInt ]; # 1..1 Service instance fhir:ExplanationOfBenefit.item.detail.revenue [ CodeableConcept ]; # 0..1 Revenue or cost center code fhir:ExplanationOfBenefit.item.detail.category [ CodeableConcept ]; # 0..1 Type of service or product fhir:ExplanationOfBenefit.item.detail.service [ CodeableConcept ]; # 0..1 Billing Code fhir:ExplanationOfBenefit.item.detail.modifier [ CodeableConcept ], ... ; # 0..* Service/Product billing modifiers fhir:ExplanationOfBenefit.item.detail.programCode [ CodeableConcept ], ... ; # 0..* Program specific reason for item inclusion fhir:ExplanationOfBenefit.item.detail.quantity [ Quantity(SimpleQuantity) ]; # 0..1 Count of Products or Services fhir:ExplanationOfBenefit.item.detail.unitPrice [ Money ]; # 0..1 Fee, charge or cost per point fhir:ExplanationOfBenefit.item.detail.factor [ decimal ]; # 0..1 Price scaling factor fhir:ExplanationOfBenefit.item.detail.net [ Money ]; # 0..1 Total additional item cost fhir:ExplanationOfBenefit.item.detail.udi [ Reference(Device) ], ... ; # 0..* Unique Device Identifier fhir:ExplanationOfBenefit.item.detail.noteNumber [ positiveInt ], ... ; # 0..* List of note numbers which apply fhir:ExplanationOfBenefit.item.detail.adjudication [ See ExplanationOfBenefit.item.adjudication ], ... ; # 0..* Detail level adjudication details fhir:ExplanationOfBenefit.item.detail.subDetail [ # 0..* Additional items fhir:ExplanationOfBenefit.item.detail.subDetail.sequence [ positiveInt ]; # 1..1 Service instance fhir:ExplanationOfBenefit.item.detail.subDetail.revenue [ CodeableConcept ]; # 0..1 Revenue or cost center code fhir:ExplanationOfBenefit.item.detail.subDetail.category [ CodeableConcept ]; # 0..1 Type of service or product fhir:ExplanationOfBenefit.item.detail.subDetail.service [ CodeableConcept ]; # 0..1 Billing Code fhir:ExplanationOfBenefit.item.detail.subDetail.modifier [ CodeableConcept ], ... ; # 0..* Service/Product billing modifiers fhir:ExplanationOfBenefit.item.detail.subDetail.programCode [ CodeableConcept ], ... ; # 0..* Program specific reason for item inclusion fhir:ExplanationOfBenefit.item.detail.subDetail.quantity [ Quantity(SimpleQuantity) ]; # 0..1 Count of Products or Services fhir:ExplanationOfBenefit.item.detail.subDetail.unitPrice [ Money ]; # 0..1 Fee, charge or cost per point fhir:ExplanationOfBenefit.item.detail.subDetail.factor [ decimal ]; # 0..1 Price scaling factor fhir:ExplanationOfBenefit.item.detail.subDetail.net [ Money ]; # 0..1 Net additional item cost fhir:ExplanationOfBenefit.item.detail.subDetail.udi [ Reference(Device) ], ... ; # 0..* Unique Device Identifier fhir:ExplanationOfBenefit.item.detail.subDetail.noteNumber [ positiveInt ], ... ; # 0..* List of note numbers which apply fhir:ExplanationOfBenefit.item.detail.subDetail.adjudication [ See ExplanationOfBenefit.item.adjudication ], ... ; # 0..* Language if different from the resource ], ...; ], ...; ], ...; fhir:ExplanationOfBenefit.addItem [ # 0..* Insurer added line items fhir:ExplanationOfBenefit.addItem.itemSequence [ positiveInt ], ... ; # 0..* Service instances fhir:ExplanationOfBenefit.addItem.detailSequence [ positiveInt ], ... ; # 0..* Detail sequence number fhir:ExplanationOfBenefit.addItem.subDetailSequence [ positiveInt ], ... ; # 0..* Subdetail sequence number fhir:ExplanationOfBenefit.addItem.service [ CodeableConcept ]; # 0..1 Billing Code fhir:ExplanationOfBenefit.addItem.modifier [ CodeableConcept ], ... ; # 0..* Service/Product billing modifiers fhir:ExplanationOfBenefit.addItem.fee [ Money ]; # 0..1 Professional fee or Product charge fhir:ExplanationOfBenefit.addItem.noteNumber [ positiveInt ], ... ; # 0..* List of note numbers which apply fhir:ExplanationOfBenefit.addItem.adjudication [ See ExplanationOfBenefit.item.adjudication ], ... ; # 0..* Added items adjudication ], ...; fhir:ExplanationOfBenefit.total [ # 0..* Adjudication totals fhir:ExplanationOfBenefit.total.category [ CodeableConcept ]; # 1..1 Adjudication category such as submitted, co-pay, eligible, benefit, etc. fhir:ExplanationOfBenefit.total.amount [ Money ]; # 1..1 Monetary amount ], ...; fhir:ExplanationOfBenefit.payment [ # 0..1 Payment (if paid) fhir:ExplanationOfBenefit.payment.type [ CodeableConcept ]; # 0..1 Partial or Complete fhir:ExplanationOfBenefit.payment.adjustment [ Money ]; # 0..1 Payment adjustment for non-Claim issues fhir:ExplanationOfBenefit.payment.adjustmentReason [ CodeableConcept ]; # 0..1 Explanation for the non-claim adjustment fhir:ExplanationOfBenefit.payment.date [ date ]; # 0..1 Expected date of Payment fhir:ExplanationOfBenefit.payment.amount [ Money ]; # 0..1 Payable amount after adjustment fhir:ExplanationOfBenefit.payment.identifier [ Identifier ]; # 0..1 Identifier of the payment instrument ]; fhir:ExplanationOfBenefit.form [ CodeableConcept ]; # 0..1 Printed Form Identifier fhir:ExplanationOfBenefit.processNote [ # 0..* Processing notes fhir:ExplanationOfBenefit.processNote.number [ positiveInt ]; # 0..1 Sequence number for this note fhir:ExplanationOfBenefit.processNote.type [ code ]; # 0..1 display | print | printoper fhir:ExplanationOfBenefit.processNote.text [ string ]; # 0..1 Note explanitory text fhir:ExplanationOfBenefit.processNote.language [ CodeableConcept ]; # 0..1 Language if different from the resource ], ...; fhir:ExplanationOfBenefit.benefitBalance [ # 0..* Balance by Benefit Category fhir:ExplanationOfBenefit.benefitBalance.category [ CodeableConcept ]; # 1..1 Type of services covered fhir:ExplanationOfBenefit.benefitBalance.subCategory [ CodeableConcept ]; # 0..1 Detailed services covered within the type fhir:ExplanationOfBenefit.benefitBalance.excluded [ boolean ]; # 0..1 Excluded from the plan fhir:ExplanationOfBenefit.benefitBalance.name [ string ]; # 0..1 Short name for the benefit fhir:ExplanationOfBenefit.benefitBalance.description [ string ]; # 0..1 Description of the benefit or services covered fhir:ExplanationOfBenefit.benefitBalance.network [ CodeableConcept ]; # 0..1 In or out of network fhir:ExplanationOfBenefit.benefitBalance.unit [ CodeableConcept ]; # 0..1 Individual or family fhir:ExplanationOfBenefit.benefitBalance.term [ CodeableConcept ]; # 0..1 Annual or lifetime fhir:ExplanationOfBenefit.benefitBalance.financial [ # 0..* Benefit Summary fhir:ExplanationOfBenefit.benefitBalance.financial.type [ CodeableConcept ]; # 1..1 Deductable, visits, benefit amount # ExplanationOfBenefit.benefitBalance.financial.allowed[x] : 0..1 Benefits allowed. One of these 3 fhir:ExplanationOfBenefit.benefitBalance.financial.allowedUnsignedInt [ unsignedInt ] fhir:ExplanationOfBenefit.benefitBalance.financial.allowedString [ string ] fhir:ExplanationOfBenefit.benefitBalance.financial.allowedMoney [ Money ] # ExplanationOfBenefit.benefitBalance.financial.used[x] : 0..1 Benefits used. One of these 2 fhir:ExplanationOfBenefit.benefitBalance.financial.usedUnsignedInt [ unsignedInt ] fhir:ExplanationOfBenefit.benefitBalance.financial.usedMoney [ Money ] ], ...; ], ...; ]
Changes since DSTU2
ExplanationOfBenefit | |
ExplanationOfBenefit.type |
|
ExplanationOfBenefit.use |
|
ExplanationOfBenefit.enterer |
|
ExplanationOfBenefit.provider |
|
ExplanationOfBenefit.referral |
|
ExplanationOfBenefit.outcome |
|
ExplanationOfBenefit.payee.resource |
|
ExplanationOfBenefit.payee.party |
|
ExplanationOfBenefit.information.value[x] |
|
ExplanationOfBenefit.careTeam.provider |
|
ExplanationOfBenefit.diagnosis.diagnosis[x] |
|
ExplanationOfBenefit.procedure.procedure[x] |
|
ExplanationOfBenefit.accident.type |
|
ExplanationOfBenefit.accident.location[x] |
|
ExplanationOfBenefit.item.careTeamSequence |
|
ExplanationOfBenefit.item.diagnosisSequence |
|
ExplanationOfBenefit.item.procedureSequence |
|
ExplanationOfBenefit.item.informationSequence |
|
ExplanationOfBenefit.item.location[x] |
|
ExplanationOfBenefit.addItem.itemSequence |
|
ExplanationOfBenefit.addItem.detailSequence |
|
ExplanationOfBenefit.addItem.subDetailSequence |
|
ExplanationOfBenefit.total |
|
ExplanationOfBenefit.total.category |
|
ExplanationOfBenefit.total.amount |
|
ExplanationOfBenefit.processNote.type |
|
ExplanationOfBenefit.organization |
|
ExplanationOfBenefit.payee.resourceType |
|
ExplanationOfBenefit.employmentImpacted |
|
ExplanationOfBenefit.hospitalization |
|
ExplanationOfBenefit.item.careTeamLinkId |
|
ExplanationOfBenefit.item.diagnosisLinkId |
|
ExplanationOfBenefit.item.procedureLinkId |
|
ExplanationOfBenefit.item.informationLinkId |
|
ExplanationOfBenefit.item.detail.type |
|
ExplanationOfBenefit.item.detail.subDetail.type |
|
ExplanationOfBenefit.addItem.sequenceLinkId |
|
ExplanationOfBenefit.addItem.revenue |
|
ExplanationOfBenefit.addItem.category |
|
ExplanationOfBenefit.addItem.detail |
|
ExplanationOfBenefit.totalCost |
|
ExplanationOfBenefit.unallocDeductable |
|
ExplanationOfBenefit.totalBenefit |
|
See the Full Difference for further information
Alternate definitions: Master Definition XML + JSON, XML Schema/Schematron + JSON Schema, ShEx (for Turtle) + see the extensions & the dependency analysis
Path | Definition | Type | Reference |
---|---|---|---|
ExplanationOfBenefit.status | A code specifying the state of the resource instance. | Required | ExplanationOfBenefitStatus |
ExplanationOfBenefit.type | The type or discipline-style of the claim | Extensible | Claim Type Codes |
ExplanationOfBenefit.subType | A more granulat claim typecode | Example | Example Claim SubType Codes |
ExplanationOfBenefit.use | Complete, proposed, exploratory, other | Required | Use |
ExplanationOfBenefit.outcome | The result of the claim processing | Required | Claim Processing Codes |
ExplanationOfBenefit.related.relationship | Relationship of this claim to a related Claim | Example | Example Related Claim Relationship Codes |
ExplanationOfBenefit.payee.type | A code for the party to be reimbursed. | Example | Claim Payee Type Codes |
ExplanationOfBenefit.payee.resource | The type of payee Resource | Extensible | PayeeResourceType |
ExplanationOfBenefit.information.category | The valuset used for additional information category codes. | Example | Claim Information Category Codes |
ExplanationOfBenefit.information.code | The valuset used for additional information codes. | Example | Exception Codes |
ExplanationOfBenefit.information.reason | Reason codes for the missing teeth | Example | Missing Tooth Reason Codes |
ExplanationOfBenefit.careTeam.role | The role codes for the care team members. | Example | Claim Care Team Role Codes |
ExplanationOfBenefit.careTeam.qualification | Provider professional qualifications | Example | Example Provider Qualification Codes |
ExplanationOfBenefit.diagnosis.diagnosis[x] | ICD10 Diagnostic codes | Example | ICD-10 Codes |
ExplanationOfBenefit.diagnosis.type | The type of the diagnosis: admitting, principal, discharge | Example | Example Diagnosis Type Codes |
ExplanationOfBenefit.diagnosis.packageCode | The DRG codes associated with the diagnosis | Example | Example Diagnosis Related Group Codes |
ExplanationOfBenefit.procedure.procedure[x] | ICD10 Procedure codes | Example | ICD-10 Procedure Codes |
ExplanationOfBenefit.accident.type | Type of accident: work place, auto, etc. | Extensible | ActIncidentCode |
ExplanationOfBenefit.item.revenue ExplanationOfBenefit.item.detail.revenue ExplanationOfBenefit.item.detail.subDetail.revenue | Codes for the revenue or cost centers supplying the service and/or products. | Example | Example Revenue Center Codes |
ExplanationOfBenefit.item.category ExplanationOfBenefit.item.detail.category ExplanationOfBenefit.item.detail.subDetail.category ExplanationOfBenefit.benefitBalance.subCategory | Benefit subcategories such as: oral-basic, major, glasses | Example | Benefit SubCategory Codes |
ExplanationOfBenefit.item.service ExplanationOfBenefit.item.detail.service ExplanationOfBenefit.item.detail.subDetail.service ExplanationOfBenefit.addItem.service | Allowable service and product codes | Example | USCLS Codes |
ExplanationOfBenefit.item.modifier ExplanationOfBenefit.item.detail.modifier ExplanationOfBenefit.item.detail.subDetail.modifier ExplanationOfBenefit.addItem.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.programCode ExplanationOfBenefit.item.detail.programCode ExplanationOfBenefit.item.detail.subDetail.programCode | Program specific reason codes | Example | Example Program Reason Codes |
ExplanationOfBenefit.item.location[x] | Place where the service is rendered | Example | Example Service Place Codes |
ExplanationOfBenefit.item.bodySite | The code for the teeth, quadrant, sextant and arch | Example | Oral Site Codes |
ExplanationOfBenefit.item.subSite | The code for the tooth surface and surface combinations | Example | Surface Codes |
ExplanationOfBenefit.item.adjudication.category ExplanationOfBenefit.total.category | The adjudication codes. | Example | Adjudication Value Codes |
ExplanationOfBenefit.item.adjudication.reason | Adjudication reason codes. | Example | Adjudication Reason Codes |
ExplanationOfBenefit.payment.type | The type (partial, complete) of the payment | Example | Example Payment Type Codes |
ExplanationOfBenefit.payment.adjustmentReason | Payment Adjustment reason codes. | Example | Payment Adjustment Reason Codes |
ExplanationOfBenefit.form | The forms codes. | Example | Form Codes |
ExplanationOfBenefit.processNote.type | The presentation types of notes. | Required | NoteType |
ExplanationOfBenefit.processNote.language | A human language. | Extensible, but limited to All Languages | Common Languages |
ExplanationOfBenefit.benefitBalance.category | Benefit categories such as: oral, medical, vision etc. | Example | Benefit Category 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 | Expression | In Common |
care-team | reference | Member of the CareTeam | ExplanationOfBenefit.careTeam.provider (Practitioner, Organization, PractitionerRole) | |
claim | reference | The reference to the claim | ExplanationOfBenefit.claim (Claim) | |
coverage | reference | The plan under which the claim was adjudicated | ExplanationOfBenefit.insurance.coverage (Coverage) | |
created | date | The creation date for the EOB | ExplanationOfBenefit.created | |
disposition | string | The contents of the disposition message | ExplanationOfBenefit.disposition | |
encounter | reference | Encounters associated with a billed line item | ExplanationOfBenefit.item.encounter (Encounter) | |
enterer | reference | The party responsible for the entry of the Claim | ExplanationOfBenefit.enterer (Practitioner, PractitionerRole) | |
facility | reference | Facility responsible for the goods and services | ExplanationOfBenefit.facility (Location) | |
identifier | token | The business identifier of the Explanation of Benefit | ExplanationOfBenefit.identifier | |
patient | reference | The reference to the patient | ExplanationOfBenefit.patient (Patient) | |
payee | reference | The party receiving any payment for the Claim | ExplanationOfBenefit.payee.party (Practitioner, Organization, Patient, PractitionerRole, RelatedPerson) | |
provider | reference | The reference to the provider | ExplanationOfBenefit.provider (Practitioner, Organization, PractitionerRole) | |
status | token | Status of the instance | ExplanationOfBenefit.status |