This page is part of the FHIR Specification (v1.6.0: STU 3 Ballot 4). 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: 1 | Compartments: Not linked to any defined compartments |
This resource provides: the claim details; adjudication details from the processing of a Claim; and optionally account balance information, for informing the subscriber of the benefits provided.
Notice to ballotors: The name of this resource is referred to in regulations in some jurisdictions and therefor to reduce confusion or issues it may be appropriate to rename this resource, for example to ClaimSummary. Please advise the Financial Managemet Work Group if this is the case for your jurisdaiction and provide a new name recommendation.
The ExplanationOfBenefit resource combines key information from a Claim, a ClaimResponse and optional Account information to inform a patient of the goods and services rendered by a provider and the settlement made under the patients coverage in respect of that Claim.
This is the logical combination of the Claim, Claim Response and some Coverage accounting information in respect of a single payor prepared for consumption by the subscriber and/or patient. It is not simply a series of pointers to referred-to content models, is a physical subset scoped to the adjudication by a single payor which details the services rendered, the amounts to be settled and to whom, and optionally the coverage used and/or remaining.
Todo
Structure
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
ExplanationOfBenefit | DomainResource | Explanation of Benefit resource | ||
identifier | 0..* | Identifier | Business Identifier | |
status | ?!Σ | 1..1 | code | active | cancelled | draft | entered-in-error ExplanationOfBenefitStatus (Required) |
author[x] | 0..1 | Insurer | ||
authorIdentifier | Identifier | |||
authorReference | Reference(Organization) | |||
claim[x] | 0..1 | Claim reference | ||
claimIdentifier | Identifier | |||
claimReference | Reference(Claim) | |||
claimResponse[x] | 0..1 | Claim response reference | ||
claimResponseIdentifier | Identifier | |||
claimResponseReference | Reference(ClaimResponse) | |||
type | 1..1 | Coding | Type or discipline Example Claim Type Codes (Required) | |
subType | 0..* | Coding | Finer grained claim type information Example Claim SubType Codes (Example) | |
ruleset | 0..1 | Coding | Current specification followed Ruleset Codes (Example) | |
originalRuleset | 0..1 | Coding | Original specification followed Ruleset Codes (Example) | |
created | 0..1 | dateTime | Creation date | |
billablePeriod | 0..1 | Period | Period for charge submission | |
outcome | 0..1 | Coding | complete | error | partial Claim Processing Codes (Example) | |
disposition | 0..1 | string | Disposition Message | |
provider[x] | 0..1 | Responsible provider for the claim | ||
providerIdentifier | Identifier | |||
providerReference | Reference(Practitioner) | |||
organization[x] | 0..1 | Responsible organization for the claim | ||
organizationIdentifier | Identifier | |||
organizationReference | Reference(Organization) | |||
facility[x] | 0..1 | Servicing Facility | ||
facilityIdentifier | Identifier | |||
facilityReference | Reference(Location) | |||
related | 0..* | BackboneElement | Related Claims which may be revelant to processing this claimn | |
claim[x] | 0..1 | Reference to the related claim | ||
claimIdentifier | Identifier | |||
claimReference | Reference(Claim) | |||
relationship | 0..1 | Coding | How the reference claim is related Example Related Claim Relationship Codes (Example) | |
reference | 0..1 | Identifier | Related file or case reference | |
prescription[x] | 0..1 | Prescription | ||
prescriptionIdentifier | Identifier | |||
prescriptionReference | Reference(MedicationOrder | VisionPrescription) | |||
originalPrescription[x] | 0..1 | Original Prescription | ||
originalPrescriptionIdentifier | Identifier | |||
originalPrescriptionReference | Reference(MedicationOrder) | |||
payee | 0..1 | BackboneElement | Payee | |
type | 0..1 | Coding | Type of party: Subscriber, Provider, other Payee Type Codes (Example) | |
resourceType | 0..1 | Coding | organization | patient | practitioner | relatedperson PayeeResourceType (Required) | |
party[x] | 0..1 | Party to receive the payable | ||
partyIdentifier | Identifier | |||
partyReference | Reference(Practitioner | Organization | Patient | RelatedPerson) | |||
referral[x] | 0..1 | Treatment Referral | ||
referralIdentifier | Identifier | |||
referralReference | Reference(ReferralRequest) | |||
information | 0..* | BackboneElement | ||
category | 1..1 | Coding | Category of information Claim Information Category Codes (Example) | |
code | 0..1 | Coding | Type of information Exception Codes (Example) | |
timing[x] | 0..1 | When it occurred | ||
timingDate | date | |||
timingPeriod | Period | |||
value[x] | 0..1 | Additional Data | ||
valueString | string | |||
valueQuantity | Quantity | |||
diagnosis | 0..* | BackboneElement | Diagnosis | |
sequence | 1..1 | positiveInt | Number to covey order of diagnosis | |
diagnosis | 1..1 | Coding | Patient's list of diagnosis ICD-10 Codes (Example) | |
type | 0..* | Coding | Type of Diagnosis Example Diagnosis Type Codes (Example) | |
drg | 0..1 | Coding | Diagnosis Related Group 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) | ||
procedureCoding | Coding | |||
procedureReference | Reference(Procedure) | |||
patient[x] | 1..1 | The subject of the Products and Services | ||
patientIdentifier | Identifier | |||
patientReference | Reference(Patient) | |||
precedence | 0..1 | positiveInt | Precedence (primary, secondary, etc.) | |
coverage | 1..1 | BackboneElement | Insurance or medical plan | |
coverage[x] | 0..1 | Insurance information | ||
coverageIdentifier | Identifier | |||
coverageReference | Reference(Coverage) | |||
preAuthRef | 0..* | string | Pre-Authorization/Determination Reference | |
accident | 0..1 | BackboneElement | ||
date | 0..1 | date | When the accident occurred | |
type | 0..1 | Coding | The nature of the accident ActIncidentCode (Required) | |
location[x] | 0..1 | Accident Place | ||
locationAddress | Address | |||
locationReference | Reference(Location) | |||
employmentImpacted | 0..1 | Period | Period unable to work | |
hospitalization | 0..1 | Period | Period in hospital | |
item | 0..* | BackboneElement | Goods and Services | |
sequence | 1..1 | positiveInt | Service instance | |
careTeam | 0..* | BackboneElement | ||
provider[x] | 1..1 | |||
providerIdentifier | Identifier | |||
providerReference | Reference(Practitioner | Organization) | |||
responsible | 0..1 | boolean | Billing practitioner | |
role | 0..1 | Coding | Role on the team Claim Care Team Role Codes (Example) | |
qualification | 0..1 | Coding | Type, classification or Specialization Example Provider Qualification Codes (Example) | |
diagnosisLinkId | 0..* | positiveInt | Applicable diagnoses | |
revenue | 0..1 | Coding | Revenue or cost center code Example Revenue Center Codes (Example) | |
category | 0..1 | Coding | Type of service or product Benefit SubCategory Codes (Example) | |
service | 0..1 | Coding | Billing Code USCLS Codes (Example) | |
modifier | 0..* | Coding | Service/Product billing modifiers Modifier type Codes (Example) | |
programCode | 0..* | Coding | 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) | ||
locationCoding | Coding | |||
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 | |
points | 0..1 | decimal | Difficulty scaling factor | |
net | 0..1 | Money | Total item cost | |
udi | 0..* | Reference(Device) | Unique Device Identifier | |
bodySite | 0..1 | Coding | Service Location Oral Site Codes (Example) | |
subSite | 0..* | Coding | Service Sub-location Surface Codes (Example) | |
noteNumber | 0..* | positiveInt | List of note numbers which apply | |
adjudication | 0..* | BackboneElement | Adjudication details | |
category | 1..1 | Coding | Adjudication category such as co-pay, eligible, benefit, etc. Adjudication Codes (Extensible) | |
reason | 0..1 | Coding | Adjudication reason Adjudication Reason Codes (Extensible) | |
amount | 0..1 | Money | Monetary amount | |
value | 0..1 | decimal | Non-monitory value | |
detail | 0..* | BackboneElement | Additional items | |
sequence | 1..1 | positiveInt | Service instance | |
type | 1..1 | Coding | Group or type of product or service ActInvoiceGroupCode (Required) | |
revenue | 0..1 | Coding | Revenue or cost center code Example Revenue Center Codes (Example) | |
category | 0..1 | Coding | Type of service or product Benefit SubCategory Codes (Example) | |
service | 0..1 | Coding | Billing Code USCLS Codes (Example) | |
modifier | 0..* | Coding | Service/Product billing modifiers Modifier type Codes (Example) | |
programCode | 0..* | Coding | 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 | |
points | 0..1 | decimal | Difficulty 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 adjudication | |
subDetail | 0..* | BackboneElement | Additional items | |
sequence | 1..1 | positiveInt | Service instance | |
type | 1..1 | Coding | Type of product or service ActInvoiceGroupCode (Required) | |
revenue | 0..1 | Coding | Revenue or cost center code Example Revenue Center Codes (Example) | |
category | 0..1 | Coding | Type of service or product Benefit SubCategory Codes (Example) | |
service | 0..1 | Coding | Billing Code USCLS Codes (Example) | |
modifier | 0..* | Coding | Service/Product billing modifiers Modifier type Codes (Example) | |
programCode | 0..* | Coding | 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 | |
points | 0..1 | decimal | Difficulty 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 | SubDetail adjudication | |
prosthesis | 0..1 | BackboneElement | Prosthetic details | |
initial | 0..1 | boolean | Is this the initial service | |
priorDate | 0..1 | date | Initial service Date | |
priorMaterial | 0..1 | Coding | Prosthetic Material Oral Prostho Material type Codes (Example) | |
addItem | 0..* | BackboneElement | Insurer added line items | |
sequenceLinkId | 0..* | positiveInt | Service instances | |
revenue | 0..1 | Coding | Revenue or cost center code Example Revenue Center Codes (Example) | |
category | 0..1 | Coding | Type of service or product Benefit SubCategory Codes (Example) | |
service | 0..1 | Coding | Billing Code USCLS Codes (Example) | |
modifier | 0..* | Coding | 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 | |
detail | 0..* | BackboneElement | Added items details | |
revenue | 0..1 | Coding | Revenue or cost center code Example Revenue Center Codes (Example) | |
category | 0..1 | Coding | Type of service or product Benefit SubCategory Codes (Example) | |
service | 0..1 | Coding | Billing Code USCLS Codes (Example) | |
modifier | 0..* | Coding | 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 detail adjudication | |
missingTeeth | 0..* | BackboneElement | Only if type = oral | |
tooth | 1..1 | Coding | Tooth Code Teeth Codes (Example) | |
reason | 0..1 | Coding | Reason for missing Missing Tooth Reason Codes (Example) | |
extractionDate | 0..1 | date | Date of Extraction | |
totalCost | 0..1 | Money | Total Cost of service from the Claim | |
unallocDeductable | 0..1 | Money | Unallocated deductable | |
totalBenefit | 0..1 | Money | Total benefit payable for the Claim | |
payment | 0..1 | BackboneElement | ||
type | 0..1 | Coding | Partial or Complete Example Payment Type Codes (Example) | |
adjustment | 0..1 | Money | Payment adjustment for non-Claim issues | |
adjustmentReason | 0..1 | Coding | Reason for Payment adjustment Payment Adjustment Reason Codes (Extensible) | |
date | 0..1 | date | Expected date of Payment | |
amount | 0..1 | Money | Payment amount | |
identifier | 0..1 | Identifier | Payment identifier | |
form | 0..1 | Coding | Printed Form Identifier Form Codes (Required) | |
note | 0..* | BackboneElement | Processing notes | |
number | 0..1 | positiveInt | Note Number for this note | |
type | 0..1 | Coding | display | print | printoper NoteType (Required) | |
text | 0..1 | string | Note explanitory text | |
language | 0..1 | Coding | Language Common Languages (Extensible but limited to All Languages) | |
benefitBalance | 0..* | BackboneElement | Balance by Benefit Category | |
category | 1..1 | Coding | Benefit Category Benefit Category Codes (Example) | |
subCategory | 0..1 | Coding | Benefit SubCategory Benefit SubCategory Codes (Example) | |
name | 0..1 | string | Short name for the benefit | |
description | 0..1 | string | Description of the benefit | |
network | 0..1 | Coding | In or out of network Network Type Codes (Example) | |
unit | 0..1 | Coding | Individual or family Unit Type Codes (Example) | |
term | 0..1 | Coding | Annual or lifetime Benefit Term Codes (Example) | |
financial | 0..* | BackboneElement | Benefit Summary | |
type | 1..1 | Coding | Deductable, visits, benefit amount Benefit Type Codes (Example) | |
benefit[x] | 0..1 | Benefits allowed | ||
benefitUnsignedInt | unsignedInt | |||
benefitString | string | |||
benefitMoney | Money | |||
benefitUsed[x] | 0..1 | Benefits used | ||
benefitUsedUnsignedInt | unsignedInt | |||
benefitUsedMoney | 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]"/><!-- 1..1 active | cancelled | draft | entered-in-error --> <author[x]><!-- 0..1 Identifier|Reference(Organization) Insurer --></author[x]> <claim[x]><!-- 0..1 Identifier|Reference(Claim) Claim reference --></claim[x]> <claimResponse[x]><!-- 0..1 Identifier|Reference(ClaimResponse) Claim response reference --></claimResponse[x]> <type><!-- 1..1 Coding Type or discipline --></type> <subType><!-- 0..* Coding Finer grained claim type information --></subType> <ruleset><!-- 0..1 Coding Current specification followed --></ruleset> <originalRuleset><!-- 0..1 Coding Original specification followed --></originalRuleset> <created value="[dateTime]"/><!-- 0..1 Creation date --> <billablePeriod><!-- 0..1 Period Period for charge submission --></billablePeriod> <outcome><!-- 0..1 Coding complete | error | partial --></outcome> <disposition value="[string]"/><!-- 0..1 Disposition Message --> <provider[x]><!-- 0..1 Identifier|Reference(Practitioner) Responsible provider for the claim --></provider[x]> <organization[x]><!-- 0..1 Identifier|Reference(Organization) Responsible organization for the claim --></organization[x]> <facility[x]><!-- 0..1 Identifier|Reference(Location) Servicing Facility --></facility[x]> <related> <!-- 0..* Related Claims which may be revelant to processing this claimn --> <claim[x]><!-- 0..1 Identifier|Reference(Claim) Reference to the related claim --></claim[x]> <relationship><!-- 0..1 Coding How the reference claim is related --></relationship> <reference><!-- 0..1 Identifier Related file or case reference --></reference> </related> <prescription[x]><!-- 0..1 Identifier|Reference(MedicationOrder| VisionPrescription) Prescription --></prescription[x]> <originalPrescription[x]><!-- 0..1 Identifier|Reference(MedicationOrder) Original Prescription --></originalPrescription[x]> <payee> <!-- 0..1 Payee --> <type><!-- 0..1 Coding Type of party: Subscriber, Provider, other --></type> <resourceType><!-- 0..1 Coding organization | patient | practitioner | relatedperson --></resourceType> <party[x]><!-- 0..1 Identifier|Reference(Practitioner|Organization|Patient| RelatedPerson) Party to receive the payable --></party[x]> </payee> <referral[x]><!-- 0..1 Identifier|Reference(ReferralRequest) Treatment Referral --></referral[x]> <information> <!-- 0..* --> <category><!-- 1..1 Coding Category of information --></category> <code><!-- 0..1 Coding Type of information --></code> <timing[x]><!-- 0..1 date|Period When it occurred --></timing[x]> <value[x]><!-- 0..1 string|Quantity Additional Data --></value[x]> </information> <diagnosis> <!-- 0..* Diagnosis --> <sequence value="[positiveInt]"/><!-- 1..1 Number to covey order of diagnosis --> <diagnosis><!-- 1..1 Coding Patient's list of diagnosis --></diagnosis> <type><!-- 0..* Coding Type of Diagnosis --></type> <drg><!-- 0..1 Coding Diagnosis Related Group --></drg> </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 Coding|Reference(Procedure) Patient's list of procedures performed --></procedure[x]> </procedure> <patient[x]><!-- 1..1 Identifier|Reference(Patient) The subject of the Products and Services --></patient[x]> <precedence value="[positiveInt]"/><!-- 0..1 Precedence (primary, secondary, etc.) --> <coverage> <!-- 1..1 Insurance or medical plan --> <coverage[x]><!-- 0..1 Identifier|Reference(Coverage) Insurance information --></coverage[x]> <preAuthRef value="[string]"/><!-- 0..* Pre-Authorization/Determination Reference --> </coverage> <accident> <date value="[date]"/><!-- 0..1 When the accident occurred --> <type><!-- 0..1 Coding The nature of the accident --></type> <location[x]><!-- 0..1 Address|Reference(Location) Accident Place --></location[x]> </accident> <employmentImpacted><!-- 0..1 Period Period unable to work --></employmentImpacted> <hospitalization><!-- 0..1 Period Period in hospital --></hospitalization> <item> <!-- 0..* Goods and Services --> <sequence value="[positiveInt]"/><!-- 1..1 Service instance --> <careTeam> <!-- 0..* --> <provider[x]><!-- 1..1 Identifier|Reference(Practitioner|Organization) --></provider[x]> <responsible value="[boolean]"/><!-- 0..1 Billing practitioner --> <role><!-- 0..1 Coding Role on the team --></role> <qualification><!-- 0..1 Coding Type, classification or Specialization --></qualification> </careTeam> <diagnosisLinkId value="[positiveInt]"/><!-- 0..* Applicable diagnoses --> <revenue><!-- 0..1 Coding Revenue or cost center code --></revenue> <category><!-- 0..1 Coding Type of service or product --></category> <service><!-- 0..1 Coding Billing Code --></service> <modifier><!-- 0..* Coding Service/Product billing modifiers --></modifier> <programCode><!-- 0..* Coding Program specific reason for item inclusion --></programCode> <serviced[x]><!-- 0..1 date|Period Date or dates of Service --></serviced[x]> <location[x]><!-- 0..1 Coding|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 --> <points value="[decimal]"/><!-- 0..1 Difficulty scaling factor --> <net><!-- 0..1 Money Total item cost --></net> <udi><!-- 0..* Reference(Device) Unique Device Identifier --></udi> <bodySite><!-- 0..1 Coding Service Location --></bodySite> <subSite><!-- 0..* Coding Service Sub-location --></subSite> <noteNumber value="[positiveInt]"/><!-- 0..* List of note numbers which apply --> <adjudication> <!-- 0..* Adjudication details --> <category><!-- 1..1 Coding Adjudication category such as co-pay, eligible, benefit, etc. --></category> <reason><!-- 0..1 Coding Adjudication reason --></reason> <amount><!-- 0..1 Money Monetary amount --></amount> <value value="[decimal]"/><!-- 0..1 Non-monitory value --> </adjudication> <detail> <!-- 0..* Additional items --> <sequence value="[positiveInt]"/><!-- 1..1 Service instance --> <type><!-- 1..1 Coding Group or type of product or service --></type> <revenue><!-- 0..1 Coding Revenue or cost center code --></revenue> <category><!-- 0..1 Coding Type of service or product --></category> <service><!-- 0..1 Coding Billing Code --></service> <modifier><!-- 0..* Coding Service/Product billing modifiers --></modifier> <programCode><!-- 0..* Coding 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 --> <points value="[decimal]"/><!-- 0..1 Difficulty 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 adjudication --></adjudication> <subDetail> <!-- 0..* Additional items --> <sequence value="[positiveInt]"/><!-- 1..1 Service instance --> <type><!-- 1..1 Coding Type of product or service --></type> <revenue><!-- 0..1 Coding Revenue or cost center code --></revenue> <category><!-- 0..1 Coding Type of service or product --></category> <service><!-- 0..1 Coding Billing Code --></service> <modifier><!-- 0..* Coding Service/Product billing modifiers --></modifier> <programCode><!-- 0..* Coding 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 --> <points value="[decimal]"/><!-- 0..1 Difficulty 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 SubDetail adjudication --></adjudication> </subDetail> </detail> <prosthesis> <!-- 0..1 Prosthetic details --> <initial value="[boolean]"/><!-- 0..1 Is this the initial service --> <priorDate value="[date]"/><!-- 0..1 Initial service Date --> <priorMaterial><!-- 0..1 Coding Prosthetic Material --></priorMaterial> </prosthesis> </item> <addItem> <!-- 0..* Insurer added line items --> <sequenceLinkId value="[positiveInt]"/><!-- 0..* Service instances --> <revenue><!-- 0..1 Coding Revenue or cost center code --></revenue> <category><!-- 0..1 Coding Type of service or product --></category> <service><!-- 0..1 Coding Billing Code --></service> <modifier><!-- 0..* Coding 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> <detail> <!-- 0..* Added items details --> <revenue><!-- 0..1 Coding Revenue or cost center code --></revenue> <category><!-- 0..1 Coding Type of service or product --></category> <service><!-- 0..1 Coding Billing Code --></service> <modifier><!-- 0..* Coding 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 detail adjudication --></adjudication> </detail> </addItem> <missingTeeth> <!-- 0..* Only if type = oral --> <tooth><!-- 1..1 Coding Tooth Code --></tooth> <reason><!-- 0..1 Coding Reason for missing --></reason> <extractionDate value="[date]"/><!-- 0..1 Date of Extraction --> </missingTeeth> <totalCost><!-- 0..1 Money Total Cost of service from the Claim --></totalCost> <unallocDeductable><!-- 0..1 Money Unallocated deductable --></unallocDeductable> <totalBenefit><!-- 0..1 Money Total benefit payable for the Claim --></totalBenefit> <payment> <type><!-- 0..1 Coding Partial or Complete --></type> <adjustment><!-- 0..1 Money Payment adjustment for non-Claim issues --></adjustment> <adjustmentReason><!-- 0..1 Coding Reason for Payment adjustment --></adjustmentReason> <date value="[date]"/><!-- 0..1 Expected date of Payment --> <amount><!-- 0..1 Money Payment amount --></amount> <identifier><!-- 0..1 Identifier Payment identifier --></identifier> </payment> <form><!-- 0..1 Coding Printed Form Identifier --></form> <note> <!-- 0..* Processing notes --> <number value="[positiveInt]"/><!-- 0..1 Note Number for this note --> <type><!-- 0..1 Coding display | print | printoper --></type> <text value="[string]"/><!-- 0..1 Note explanitory text --> <language><!-- 0..1 Coding Language --></language> </note> <benefitBalance> <!-- 0..* Balance by Benefit Category --> <category><!-- 1..1 Coding Benefit Category --></category> <subCategory><!-- 0..1 Coding Benefit SubCategory --></subCategory> <name value="[string]"/><!-- 0..1 Short name for the benefit --> <description value="[string]"/><!-- 0..1 Description of the benefit --> <network><!-- 0..1 Coding In or out of network --></network> <unit><!-- 0..1 Coding Individual or family --></unit> <term><!-- 0..1 Coding Annual or lifetime --></term> <financial> <!-- 0..* Benefit Summary --> <type><!-- 1..1 Coding Deductable, visits, benefit amount --></type> <benefit[x]><!-- 0..1 unsignedInt|string|Money Benefits allowed --></benefit[x]> <benefitUsed[x]><!-- 0..1 unsignedInt|Money Benefits used --></benefitUsed[x]> </financial> </benefitBalance> </ExplanationOfBenefit>
JSON Template
{ "resourceType" : "ExplanationOfBenefit", // from Resource: id, meta, implicitRules, and language // from DomainResource: text, contained, extension, and modifierExtension "identifier" : [{ Identifier }], // Business Identifier "status" : "<code>", // R! active | cancelled | draft | entered-in-error // author[x]: Insurer. One of these 2: "authorIdentifier" : { Identifier }, "authorReference" : { Reference(Organization) }, // claim[x]: Claim reference. One of these 2: "claimIdentifier" : { Identifier }, "claimReference" : { Reference(Claim) }, // claimResponse[x]: Claim response reference. One of these 2: "claimResponseIdentifier" : { Identifier }, "claimResponseReference" : { Reference(ClaimResponse) }, "type" : { Coding }, // R! Type or discipline "subType" : [{ Coding }], // Finer grained claim type information "ruleset" : { Coding }, // Current specification followed "originalRuleset" : { Coding }, // Original specification followed "created" : "<dateTime>", // Creation date "billablePeriod" : { Period }, // Period for charge submission "outcome" : { Coding }, // complete | error | partial "disposition" : "<string>", // Disposition Message // provider[x]: Responsible provider for the claim. One of these 2: "providerIdentifier" : { Identifier }, "providerReference" : { Reference(Practitioner) }, // organization[x]: Responsible organization for the claim. One of these 2: "organizationIdentifier" : { Identifier }, "organizationReference" : { Reference(Organization) }, // facility[x]: Servicing Facility. One of these 2: "facilityIdentifier" : { Identifier }, "facilityReference" : { Reference(Location) }, "related" : [{ // Related Claims which may be revelant to processing this claimn // claim[x]: Reference to the related claim. One of these 2: "claimIdentifier" : { Identifier }, "claimReference" : { Reference(Claim) }, "relationship" : { Coding }, // How the reference claim is related "reference" : { Identifier } // Related file or case reference }], // prescription[x]: Prescription. One of these 2: "prescriptionIdentifier" : { Identifier }, "prescriptionReference" : { Reference(MedicationOrder|VisionPrescription) }, // originalPrescription[x]: Original Prescription. One of these 2: "originalPrescriptionIdentifier" : { Identifier }, "originalPrescriptionReference" : { Reference(MedicationOrder) }, "payee" : { // Payee "type" : { Coding }, // Type of party: Subscriber, Provider, other "resourceType" : { Coding }, // organization | patient | practitioner | relatedperson // party[x]: Party to receive the payable. One of these 2: "partyIdentifier" : { Identifier } "partyReference" : { Reference(Practitioner|Organization|Patient|RelatedPerson) } }, // referral[x]: Treatment Referral. One of these 2: "referralIdentifier" : { Identifier }, "referralReference" : { Reference(ReferralRequest) }, "information" : [{ // "category" : { Coding }, // R! Category of information "code" : { Coding }, // Type of information // timing[x]: When it occurred. One of these 2: "timingDate" : "<date>", "timingPeriod" : { Period }, // value[x]: Additional Data. One of these 2: "valueString" : "<string>" "valueQuantity" : { Quantity } }], "diagnosis" : [{ // Diagnosis "sequence" : "<positiveInt>", // R! Number to covey order of diagnosis "diagnosis" : { Coding }, // R! Patient's list of diagnosis "type" : [{ Coding }], // Type of Diagnosis "drg" : { Coding } // Diagnosis Related Group }], "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: "procedureCoding" : { Coding } "procedureReference" : { Reference(Procedure) } }], // patient[x]: The subject of the Products and Services. One of these 2: "patientIdentifier" : { Identifier }, "patientReference" : { Reference(Patient) }, "precedence" : "<positiveInt>", // Precedence (primary, secondary, etc.) "coverage" : { // R! Insurance or medical plan // coverage[x]: Insurance information. One of these 2: "coverageIdentifier" : { Identifier }, "coverageReference" : { Reference(Coverage) }, "preAuthRef" : ["<string>"] // Pre-Authorization/Determination Reference }, "accident" : { // "date" : "<date>", // When the accident occurred "type" : { Coding }, // The nature of the accident // location[x]: Accident Place. One of these 2: "locationAddress" : { Address } "locationReference" : { Reference(Location) } }, "employmentImpacted" : { Period }, // Period unable to work "hospitalization" : { Period }, // Period in hospital "item" : [{ // Goods and Services "sequence" : "<positiveInt>", // R! Service instance "careTeam" : [{ // // provider[x]: . One of these 2: "providerIdentifier" : { Identifier }, "providerReference" : { Reference(Practitioner|Organization) }, "responsible" : <boolean>, // Billing practitioner "role" : { Coding }, // Role on the team "qualification" : { Coding } // Type, classification or Specialization }], "diagnosisLinkId" : ["<positiveInt>"], // Applicable diagnoses "revenue" : { Coding }, // Revenue or cost center code "category" : { Coding }, // Type of service or product "service" : { Coding }, // Billing Code "modifier" : [{ Coding }], // Service/Product billing modifiers "programCode" : [{ Coding }], // 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: "locationCoding" : { Coding }, "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 "points" : <decimal>, // Difficulty scaling factor "net" : { Money }, // Total item cost "udi" : [{ Reference(Device) }], // Unique Device Identifier "bodySite" : { Coding }, // Service Location "subSite" : [{ Coding }], // Service Sub-location "noteNumber" : ["<positiveInt>"], // List of note numbers which apply "adjudication" : [{ // Adjudication details "category" : { Coding }, // R! Adjudication category such as co-pay, eligible, benefit, etc. "reason" : { Coding }, // Adjudication reason "amount" : { Money }, // Monetary amount "value" : <decimal> // Non-monitory value }], "detail" : [{ // Additional items "sequence" : "<positiveInt>", // R! Service instance "type" : { Coding }, // R! Group or type of product or service "revenue" : { Coding }, // Revenue or cost center code "category" : { Coding }, // Type of service or product "service" : { Coding }, // Billing Code "modifier" : [{ Coding }], // Service/Product billing modifiers "programCode" : [{ Coding }], // 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 "points" : <decimal>, // Difficulty 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 adjudication "subDetail" : [{ // Additional items "sequence" : "<positiveInt>", // R! Service instance "type" : { Coding }, // R! Type of product or service "revenue" : { Coding }, // Revenue or cost center code "category" : { Coding }, // Type of service or product "service" : { Coding }, // Billing Code "modifier" : [{ Coding }], // Service/Product billing modifiers "programCode" : [{ Coding }], // 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 "points" : <decimal>, // Difficulty 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 }] // SubDetail adjudication }] }], "prosthesis" : { // Prosthetic details "initial" : <boolean>, // Is this the initial service "priorDate" : "<date>", // Initial service Date "priorMaterial" : { Coding } // Prosthetic Material } }], "addItem" : [{ // Insurer added line items "sequenceLinkId" : ["<positiveInt>"], // Service instances "revenue" : { Coding }, // Revenue or cost center code "category" : { Coding }, // Type of service or product "service" : { Coding }, // Billing Code "modifier" : [{ Coding }], // 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 "detail" : [{ // Added items details "revenue" : { Coding }, // Revenue or cost center code "category" : { Coding }, // Type of service or product "service" : { Coding }, // Billing Code "modifier" : [{ Coding }], // 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 detail adjudication }] }], "missingTeeth" : [{ // Only if type = oral "tooth" : { Coding }, // R! Tooth Code "reason" : { Coding }, // Reason for missing "extractionDate" : "<date>" // Date of Extraction }], "totalCost" : { Money }, // Total Cost of service from the Claim "unallocDeductable" : { Money }, // Unallocated deductable "totalBenefit" : { Money }, // Total benefit payable for the Claim "payment" : { // "type" : { Coding }, // Partial or Complete "adjustment" : { Money }, // Payment adjustment for non-Claim issues "adjustmentReason" : { Coding }, // Reason for Payment adjustment "date" : "<date>", // Expected date of Payment "amount" : { Money }, // Payment amount "identifier" : { Identifier } // Payment identifier }, "form" : { Coding }, // Printed Form Identifier "note" : [{ // Processing notes "number" : "<positiveInt>", // Note Number for this note "type" : { Coding }, // display | print | printoper "text" : "<string>", // Note explanitory text "language" : { Coding } // Language }], "benefitBalance" : [{ // Balance by Benefit Category "category" : { Coding }, // R! Benefit Category "subCategory" : { Coding }, // Benefit SubCategory "name" : "<string>", // Short name for the benefit "description" : "<string>", // Description of the benefit "network" : { Coding }, // In or out of network "unit" : { Coding }, // Individual or family "term" : { Coding }, // Annual or lifetime "financial" : [{ // Benefit Summary "type" : { Coding }, // R! Deductable, visits, benefit amount // benefit[x]: Benefits allowed. One of these 3: "benefitUnsignedInt" : "<unsignedInt>", "benefitString" : "<string>", "benefitMoney" : { Money }, // benefitUsed[x]: Benefits used. One of these 2: "benefitUsedUnsignedInt" : "<unsignedInt>" "benefitUsedMoney" : { 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 ]; # 1..1 active | cancelled | draft | entered-in-error # ExplanationOfBenefit.author[x] : 0..1 Insurer. One of these 2 fhir:ExplanationOfBenefit.authorIdentifier [ Identifier ] fhir:ExplanationOfBenefit.authorReference [ Reference(Organization) ] # ExplanationOfBenefit.claim[x] : 0..1 Claim reference. One of these 2 fhir:ExplanationOfBenefit.claimIdentifier [ Identifier ] fhir:ExplanationOfBenefit.claimReference [ Reference(Claim) ] # ExplanationOfBenefit.claimResponse[x] : 0..1 Claim response reference. One of these 2 fhir:ExplanationOfBenefit.claimResponseIdentifier [ Identifier ] fhir:ExplanationOfBenefit.claimResponseReference [ Reference(ClaimResponse) ] fhir:ExplanationOfBenefit.type [ Coding ]; # 1..1 Type or discipline fhir:ExplanationOfBenefit.subType [ Coding ], ... ; # 0..* Finer grained claim type information fhir:ExplanationOfBenefit.ruleset [ Coding ]; # 0..1 Current specification followed fhir:ExplanationOfBenefit.originalRuleset [ Coding ]; # 0..1 Original specification followed fhir:ExplanationOfBenefit.created [ dateTime ]; # 0..1 Creation date fhir:ExplanationOfBenefit.billablePeriod [ Period ]; # 0..1 Period for charge submission fhir:ExplanationOfBenefit.outcome [ Coding ]; # 0..1 complete | error | partial fhir:ExplanationOfBenefit.disposition [ string ]; # 0..1 Disposition Message # ExplanationOfBenefit.provider[x] : 0..1 Responsible provider for the claim. One of these 2 fhir:ExplanationOfBenefit.providerIdentifier [ Identifier ] fhir:ExplanationOfBenefit.providerReference [ Reference(Practitioner) ] # ExplanationOfBenefit.organization[x] : 0..1 Responsible organization for the claim. One of these 2 fhir:ExplanationOfBenefit.organizationIdentifier [ Identifier ] fhir:ExplanationOfBenefit.organizationReference [ Reference(Organization) ] # ExplanationOfBenefit.facility[x] : 0..1 Servicing Facility. One of these 2 fhir:ExplanationOfBenefit.facilityIdentifier [ Identifier ] fhir:ExplanationOfBenefit.facilityReference [ Reference(Location) ] fhir:ExplanationOfBenefit.related [ # 0..* Related Claims which may be revelant to processing this claimn # ExplanationOfBenefit.related.claim[x] : 0..1 Reference to the related claim. One of these 2 fhir:ExplanationOfBenefit.related.claimIdentifier [ Identifier ] fhir:ExplanationOfBenefit.related.claimReference [ Reference(Claim) ] fhir:ExplanationOfBenefit.related.relationship [ Coding ]; # 0..1 How the reference claim is related fhir:ExplanationOfBenefit.related.reference [ Identifier ]; # 0..1 Related file or case reference ], ...; # ExplanationOfBenefit.prescription[x] : 0..1 Prescription. One of these 2 fhir:ExplanationOfBenefit.prescriptionIdentifier [ Identifier ] fhir:ExplanationOfBenefit.prescriptionReference [ Reference(MedicationOrder|VisionPrescription) ] # ExplanationOfBenefit.originalPrescription[x] : 0..1 Original Prescription. One of these 2 fhir:ExplanationOfBenefit.originalPrescriptionIdentifier [ Identifier ] fhir:ExplanationOfBenefit.originalPrescriptionReference [ Reference(MedicationOrder) ] fhir:ExplanationOfBenefit.payee [ # 0..1 Payee fhir:ExplanationOfBenefit.payee.type [ Coding ]; # 0..1 Type of party: Subscriber, Provider, other fhir:ExplanationOfBenefit.payee.resourceType [ Coding ]; # 0..1 organization | patient | practitioner | relatedperson # ExplanationOfBenefit.payee.party[x] : 0..1 Party to receive the payable. One of these 2 fhir:ExplanationOfBenefit.payee.partyIdentifier [ Identifier ] fhir:ExplanationOfBenefit.payee.partyReference [ Reference(Practitioner|Organization|Patient|RelatedPerson) ] ]; # ExplanationOfBenefit.referral[x] : 0..1 Treatment Referral. One of these 2 fhir:ExplanationOfBenefit.referralIdentifier [ Identifier ] fhir:ExplanationOfBenefit.referralReference [ Reference(ReferralRequest) ] fhir:ExplanationOfBenefit.information [ # 0..* fhir:ExplanationOfBenefit.information.category [ Coding ]; # 1..1 Category of information fhir:ExplanationOfBenefit.information.code [ Coding ]; # 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. One of these 2 fhir:ExplanationOfBenefit.information.valueString [ string ] fhir:ExplanationOfBenefit.information.valueQuantity [ Quantity ] ], ...; fhir:ExplanationOfBenefit.diagnosis [ # 0..* Diagnosis fhir:ExplanationOfBenefit.diagnosis.sequence [ positiveInt ]; # 1..1 Number to covey order of diagnosis fhir:ExplanationOfBenefit.diagnosis.diagnosis [ Coding ]; # 1..1 Patient's list of diagnosis fhir:ExplanationOfBenefit.diagnosis.type [ Coding ], ... ; # 0..* Type of Diagnosis fhir:ExplanationOfBenefit.diagnosis.drg [ Coding ]; # 0..1 Diagnosis Related Group ], ...; 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.procedureCoding [ Coding ] fhir:ExplanationOfBenefit.procedure.procedureReference [ Reference(Procedure) ] ], ...; # ExplanationOfBenefit.patient[x] : 1..1 The subject of the Products and Services. One of these 2 fhir:ExplanationOfBenefit.patientIdentifier [ Identifier ] fhir:ExplanationOfBenefit.patientReference [ Reference(Patient) ] fhir:ExplanationOfBenefit.precedence [ positiveInt ]; # 0..1 Precedence (primary, secondary, etc.) fhir:ExplanationOfBenefit.coverage [ # 1..1 Insurance or medical plan # ExplanationOfBenefit.coverage.coverage[x] : 0..1 Insurance information. One of these 2 fhir:ExplanationOfBenefit.coverage.coverageIdentifier [ Identifier ] fhir:ExplanationOfBenefit.coverage.coverageReference [ Reference(Coverage) ] fhir:ExplanationOfBenefit.coverage.preAuthRef [ string ], ... ; # 0..* Pre-Authorization/Determination Reference ]; fhir:ExplanationOfBenefit.accident [ # 0..1 fhir:ExplanationOfBenefit.accident.date [ date ]; # 0..1 When the accident occurred fhir:ExplanationOfBenefit.accident.type [ Coding ]; # 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.employmentImpacted [ Period ]; # 0..1 Period unable to work fhir:ExplanationOfBenefit.hospitalization [ Period ]; # 0..1 Period in hospital fhir:ExplanationOfBenefit.item [ # 0..* Goods and Services fhir:ExplanationOfBenefit.item.sequence [ positiveInt ]; # 1..1 Service instance fhir:ExplanationOfBenefit.item.careTeam [ # 0..* # ExplanationOfBenefit.item.careTeam.provider[x] : 1..1 . One of these 2 fhir:ExplanationOfBenefit.item.careTeam.providerIdentifier [ Identifier ] fhir:ExplanationOfBenefit.item.careTeam.providerReference [ Reference(Practitioner|Organization) ] fhir:ExplanationOfBenefit.item.careTeam.responsible [ boolean ]; # 0..1 Billing practitioner fhir:ExplanationOfBenefit.item.careTeam.role [ Coding ]; # 0..1 Role on the team fhir:ExplanationOfBenefit.item.careTeam.qualification [ Coding ]; # 0..1 Type, classification or Specialization ], ...; fhir:ExplanationOfBenefit.item.diagnosisLinkId [ positiveInt ], ... ; # 0..* Applicable diagnoses fhir:ExplanationOfBenefit.item.revenue [ Coding ]; # 0..1 Revenue or cost center code fhir:ExplanationOfBenefit.item.category [ Coding ]; # 0..1 Type of service or product fhir:ExplanationOfBenefit.item.service [ Coding ]; # 0..1 Billing Code fhir:ExplanationOfBenefit.item.modifier [ Coding ], ... ; # 0..* Service/Product billing modifiers fhir:ExplanationOfBenefit.item.programCode [ Coding ], ... ; # 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.locationCoding [ Coding ] 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.points [ decimal ]; # 0..1 Difficulty 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 [ Coding ]; # 0..1 Service Location fhir:ExplanationOfBenefit.item.subSite [ Coding ], ... ; # 0..* Service Sub-location fhir:ExplanationOfBenefit.item.noteNumber [ positiveInt ], ... ; # 0..* List of note numbers which apply fhir:ExplanationOfBenefit.item.adjudication [ # 0..* Adjudication details fhir:ExplanationOfBenefit.item.adjudication.category [ Coding ]; # 1..1 Adjudication category such as co-pay, eligible, benefit, etc. fhir:ExplanationOfBenefit.item.adjudication.reason [ Coding ]; # 0..1 Adjudication reason 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.type [ Coding ]; # 1..1 Group or type of product or service fhir:ExplanationOfBenefit.item.detail.revenue [ Coding ]; # 0..1 Revenue or cost center code fhir:ExplanationOfBenefit.item.detail.category [ Coding ]; # 0..1 Type of service or product fhir:ExplanationOfBenefit.item.detail.service [ Coding ]; # 0..1 Billing Code fhir:ExplanationOfBenefit.item.detail.modifier [ Coding ], ... ; # 0..* Service/Product billing modifiers fhir:ExplanationOfBenefit.item.detail.programCode [ Coding ], ... ; # 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.points [ decimal ]; # 0..1 Difficulty 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 adjudication fhir:ExplanationOfBenefit.item.detail.subDetail [ # 0..* Additional items fhir:ExplanationOfBenefit.item.detail.subDetail.sequence [ positiveInt ]; # 1..1 Service instance fhir:ExplanationOfBenefit.item.detail.subDetail.type [ Coding ]; # 1..1 Type of product or service fhir:ExplanationOfBenefit.item.detail.subDetail.revenue [ Coding ]; # 0..1 Revenue or cost center code fhir:ExplanationOfBenefit.item.detail.subDetail.category [ Coding ]; # 0..1 Type of service or product fhir:ExplanationOfBenefit.item.detail.subDetail.service [ Coding ]; # 0..1 Billing Code fhir:ExplanationOfBenefit.item.detail.subDetail.modifier [ Coding ], ... ; # 0..* Service/Product billing modifiers fhir:ExplanationOfBenefit.item.detail.subDetail.programCode [ Coding ], ... ; # 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.points [ decimal ]; # 0..1 Difficulty 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..* SubDetail adjudication ], ...; ], ...; fhir:ExplanationOfBenefit.item.prosthesis [ # 0..1 Prosthetic details fhir:ExplanationOfBenefit.item.prosthesis.initial [ boolean ]; # 0..1 Is this the initial service fhir:ExplanationOfBenefit.item.prosthesis.priorDate [ date ]; # 0..1 Initial service Date fhir:ExplanationOfBenefit.item.prosthesis.priorMaterial [ Coding ]; # 0..1 Prosthetic Material ]; ], ...; fhir:ExplanationOfBenefit.addItem [ # 0..* Insurer added line items fhir:ExplanationOfBenefit.addItem.sequenceLinkId [ positiveInt ], ... ; # 0..* Service instances fhir:ExplanationOfBenefit.addItem.revenue [ Coding ]; # 0..1 Revenue or cost center code fhir:ExplanationOfBenefit.addItem.category [ Coding ]; # 0..1 Type of service or product fhir:ExplanationOfBenefit.addItem.service [ Coding ]; # 0..1 Billing Code fhir:ExplanationOfBenefit.addItem.modifier [ Coding ], ... ; # 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.addItem.detail [ # 0..* Added items details fhir:ExplanationOfBenefit.addItem.detail.revenue [ Coding ]; # 0..1 Revenue or cost center code fhir:ExplanationOfBenefit.addItem.detail.category [ Coding ]; # 0..1 Type of service or product fhir:ExplanationOfBenefit.addItem.detail.service [ Coding ]; # 0..1 Billing Code fhir:ExplanationOfBenefit.addItem.detail.modifier [ Coding ], ... ; # 0..* Service/Product billing modifiers fhir:ExplanationOfBenefit.addItem.detail.fee [ Money ]; # 0..1 Professional fee or Product charge fhir:ExplanationOfBenefit.addItem.detail.noteNumber [ positiveInt ], ... ; # 0..* List of note numbers which apply fhir:ExplanationOfBenefit.addItem.detail.adjudication [ See ExplanationOfBenefit.item.adjudication ], ... ; # 0..* Added items detail adjudication ], ...; ], ...; fhir:ExplanationOfBenefit.missingTeeth [ # 0..* Only if type = oral fhir:ExplanationOfBenefit.missingTeeth.tooth [ Coding ]; # 1..1 Tooth Code fhir:ExplanationOfBenefit.missingTeeth.reason [ Coding ]; # 0..1 Reason for missing fhir:ExplanationOfBenefit.missingTeeth.extractionDate [ date ]; # 0..1 Date of Extraction ], ...; fhir:ExplanationOfBenefit.totalCost [ Money ]; # 0..1 Total Cost of service from the Claim fhir:ExplanationOfBenefit.unallocDeductable [ Money ]; # 0..1 Unallocated deductable fhir:ExplanationOfBenefit.totalBenefit [ Money ]; # 0..1 Total benefit payable for the Claim fhir:ExplanationOfBenefit.payment [ # 0..1 fhir:ExplanationOfBenefit.payment.type [ Coding ]; # 0..1 Partial or Complete fhir:ExplanationOfBenefit.payment.adjustment [ Money ]; # 0..1 Payment adjustment for non-Claim issues fhir:ExplanationOfBenefit.payment.adjustmentReason [ Coding ]; # 0..1 Reason for Payment adjustment fhir:ExplanationOfBenefit.payment.date [ date ]; # 0..1 Expected date of Payment fhir:ExplanationOfBenefit.payment.amount [ Money ]; # 0..1 Payment amount fhir:ExplanationOfBenefit.payment.identifier [ Identifier ]; # 0..1 Payment identifier ]; fhir:ExplanationOfBenefit.form [ Coding ]; # 0..1 Printed Form Identifier fhir:ExplanationOfBenefit.note [ # 0..* Processing notes fhir:ExplanationOfBenefit.note.number [ positiveInt ]; # 0..1 Note Number for this note fhir:ExplanationOfBenefit.note.type [ Coding ]; # 0..1 display | print | printoper fhir:ExplanationOfBenefit.note.text [ string ]; # 0..1 Note explanitory text fhir:ExplanationOfBenefit.note.language [ Coding ]; # 0..1 Language ], ...; fhir:ExplanationOfBenefit.benefitBalance [ # 0..* Balance by Benefit Category fhir:ExplanationOfBenefit.benefitBalance.category [ Coding ]; # 1..1 Benefit Category fhir:ExplanationOfBenefit.benefitBalance.subCategory [ Coding ]; # 0..1 Benefit SubCategory fhir:ExplanationOfBenefit.benefitBalance.name [ string ]; # 0..1 Short name for the benefit fhir:ExplanationOfBenefit.benefitBalance.description [ string ]; # 0..1 Description of the benefit fhir:ExplanationOfBenefit.benefitBalance.network [ Coding ]; # 0..1 In or out of network fhir:ExplanationOfBenefit.benefitBalance.unit [ Coding ]; # 0..1 Individual or family fhir:ExplanationOfBenefit.benefitBalance.term [ Coding ]; # 0..1 Annual or lifetime fhir:ExplanationOfBenefit.benefitBalance.financial [ # 0..* Benefit Summary fhir:ExplanationOfBenefit.benefitBalance.financial.type [ Coding ]; # 1..1 Deductable, visits, benefit amount # ExplanationOfBenefit.benefitBalance.financial.benefit[x] : 0..1 Benefits allowed. One of these 3 fhir:ExplanationOfBenefit.benefitBalance.financial.benefitUnsignedInt [ unsignedInt ] fhir:ExplanationOfBenefit.benefitBalance.financial.benefitString [ string ] fhir:ExplanationOfBenefit.benefitBalance.financial.benefitMoney [ Money ] # ExplanationOfBenefit.benefitBalance.financial.benefitUsed[x] : 0..1 Benefits used. One of these 2 fhir:ExplanationOfBenefit.benefitBalance.financial.benefitUsedUnsignedInt [ unsignedInt ] fhir:ExplanationOfBenefit.benefitBalance.financial.benefitUsedMoney [ Money ] ], ...; ], ...; ]
Changes since DSTU2
ExplanationOfBenefit | |
ExplanationOfBenefit.status | added |
ExplanationOfBenefit.author[x] | added |
ExplanationOfBenefit.claim[x] | added |
ExplanationOfBenefit.claimResponse[x] | added |
ExplanationOfBenefit.type | added |
ExplanationOfBenefit.subType | added |
ExplanationOfBenefit.billablePeriod | added |
ExplanationOfBenefit.outcome |
Type changed from code to Coding Remove Binding http://hl7.org/fhir/ValueSet/remittance-outcome (required) |
ExplanationOfBenefit.provider[x] | added |
ExplanationOfBenefit.organization[x] |
Renamed from organization to organization[x] Add Identifier |
ExplanationOfBenefit.facility[x] | added |
ExplanationOfBenefit.related | added |
ExplanationOfBenefit.related.claim[x] | added |
ExplanationOfBenefit.related.relationship | added |
ExplanationOfBenefit.related.reference | added |
ExplanationOfBenefit.prescription[x] | added |
ExplanationOfBenefit.originalPrescription[x] | added |
ExplanationOfBenefit.payee | added |
ExplanationOfBenefit.payee.type | added |
ExplanationOfBenefit.payee.resourceType | added |
ExplanationOfBenefit.payee.party[x] | added |
ExplanationOfBenefit.referral[x] | added |
ExplanationOfBenefit.information | added |
ExplanationOfBenefit.information.category | added |
ExplanationOfBenefit.information.code | added |
ExplanationOfBenefit.information.timing[x] | added |
ExplanationOfBenefit.information.value[x] | added |
ExplanationOfBenefit.diagnosis | added |
ExplanationOfBenefit.diagnosis.sequence | added |
ExplanationOfBenefit.diagnosis.diagnosis | added |
ExplanationOfBenefit.diagnosis.type | added |
ExplanationOfBenefit.diagnosis.drg | added |
ExplanationOfBenefit.procedure | added |
ExplanationOfBenefit.procedure.sequence | added |
ExplanationOfBenefit.procedure.date | added |
ExplanationOfBenefit.procedure.procedure[x] | added |
ExplanationOfBenefit.patient[x] | added |
ExplanationOfBenefit.precedence | added |
ExplanationOfBenefit.coverage | added |
ExplanationOfBenefit.coverage.coverage[x] | added |
ExplanationOfBenefit.coverage.preAuthRef | added |
ExplanationOfBenefit.accident | added |
ExplanationOfBenefit.accident.date | added |
ExplanationOfBenefit.accident.type | added |
ExplanationOfBenefit.accident.location[x] | added |
ExplanationOfBenefit.employmentImpacted | added |
ExplanationOfBenefit.hospitalization | added |
ExplanationOfBenefit.item | added |
ExplanationOfBenefit.item.sequence | added |
ExplanationOfBenefit.item.careTeam | added |
ExplanationOfBenefit.item.careTeam.provider[x] | added |
ExplanationOfBenefit.item.careTeam.responsible | added |
ExplanationOfBenefit.item.careTeam.role | added |
ExplanationOfBenefit.item.careTeam.qualification | added |
ExplanationOfBenefit.item.diagnosisLinkId | added |
ExplanationOfBenefit.item.revenue | added |
ExplanationOfBenefit.item.category | added |
ExplanationOfBenefit.item.service | added |
ExplanationOfBenefit.item.modifier | added |
ExplanationOfBenefit.item.programCode | added |
ExplanationOfBenefit.item.serviced[x] | added |
ExplanationOfBenefit.item.location[x] | added |
ExplanationOfBenefit.item.quantity | added |
ExplanationOfBenefit.item.unitPrice | added |
ExplanationOfBenefit.item.factor | added |
ExplanationOfBenefit.item.points | added |
ExplanationOfBenefit.item.net | added |
ExplanationOfBenefit.item.udi | added |
ExplanationOfBenefit.item.bodySite | added |
ExplanationOfBenefit.item.subSite | added |
ExplanationOfBenefit.item.noteNumber | added |
ExplanationOfBenefit.item.adjudication | added |
ExplanationOfBenefit.item.adjudication.category | added |
ExplanationOfBenefit.item.adjudication.reason | added |
ExplanationOfBenefit.item.adjudication.amount | added |
ExplanationOfBenefit.item.adjudication.value | added |
ExplanationOfBenefit.item.detail | added |
ExplanationOfBenefit.item.detail.sequence | added |
ExplanationOfBenefit.item.detail.type | added |
ExplanationOfBenefit.item.detail.revenue | added |
ExplanationOfBenefit.item.detail.category | added |
ExplanationOfBenefit.item.detail.service | added |
ExplanationOfBenefit.item.detail.modifier | added |
ExplanationOfBenefit.item.detail.programCode | added |
ExplanationOfBenefit.item.detail.quantity | added |
ExplanationOfBenefit.item.detail.unitPrice | added |
ExplanationOfBenefit.item.detail.factor | added |
ExplanationOfBenefit.item.detail.points | added |
ExplanationOfBenefit.item.detail.net | added |
ExplanationOfBenefit.item.detail.udi | added |
ExplanationOfBenefit.item.detail.noteNumber | added |
ExplanationOfBenefit.item.detail.adjudication | added |
ExplanationOfBenefit.item.detail.subDetail | added |
ExplanationOfBenefit.item.detail.subDetail.sequence | added |
ExplanationOfBenefit.item.detail.subDetail.type | added |
ExplanationOfBenefit.item.detail.subDetail.revenue | added |
ExplanationOfBenefit.item.detail.subDetail.category | added |
ExplanationOfBenefit.item.detail.subDetail.service | added |
ExplanationOfBenefit.item.detail.subDetail.modifier | added |
ExplanationOfBenefit.item.detail.subDetail.programCode | added |
ExplanationOfBenefit.item.detail.subDetail.quantity | added |
ExplanationOfBenefit.item.detail.subDetail.unitPrice | added |
ExplanationOfBenefit.item.detail.subDetail.factor | added |
ExplanationOfBenefit.item.detail.subDetail.points | added |
ExplanationOfBenefit.item.detail.subDetail.net | added |
ExplanationOfBenefit.item.detail.subDetail.udi | added |
ExplanationOfBenefit.item.detail.subDetail.noteNumber | added |
ExplanationOfBenefit.item.detail.subDetail.adjudication | added |
ExplanationOfBenefit.item.prosthesis | added |
ExplanationOfBenefit.item.prosthesis.initial | added |
ExplanationOfBenefit.item.prosthesis.priorDate | added |
ExplanationOfBenefit.item.prosthesis.priorMaterial | added |
ExplanationOfBenefit.addItem | added |
ExplanationOfBenefit.addItem.sequenceLinkId | added |
ExplanationOfBenefit.addItem.revenue | added |
ExplanationOfBenefit.addItem.category | added |
ExplanationOfBenefit.addItem.service | added |
ExplanationOfBenefit.addItem.modifier | added |
ExplanationOfBenefit.addItem.fee | added |
ExplanationOfBenefit.addItem.noteNumber | added |
ExplanationOfBenefit.addItem.adjudication | added |
ExplanationOfBenefit.addItem.detail | added |
ExplanationOfBenefit.addItem.detail.revenue | added |
ExplanationOfBenefit.addItem.detail.category | added |
ExplanationOfBenefit.addItem.detail.service | added |
ExplanationOfBenefit.addItem.detail.modifier | added |
ExplanationOfBenefit.addItem.detail.fee | added |
ExplanationOfBenefit.addItem.detail.noteNumber | added |
ExplanationOfBenefit.addItem.detail.adjudication | added |
ExplanationOfBenefit.missingTeeth | added |
ExplanationOfBenefit.missingTeeth.tooth | added |
ExplanationOfBenefit.missingTeeth.reason | added |
ExplanationOfBenefit.missingTeeth.extractionDate | added |
ExplanationOfBenefit.totalCost | added |
ExplanationOfBenefit.unallocDeductable | added |
ExplanationOfBenefit.totalBenefit | added |
ExplanationOfBenefit.payment | added |
ExplanationOfBenefit.payment.type | added |
ExplanationOfBenefit.payment.adjustment | added |
ExplanationOfBenefit.payment.adjustmentReason | added |
ExplanationOfBenefit.payment.date | added |
ExplanationOfBenefit.payment.amount | added |
ExplanationOfBenefit.payment.identifier | added |
ExplanationOfBenefit.form | added |
ExplanationOfBenefit.note | added |
ExplanationOfBenefit.note.number | added |
ExplanationOfBenefit.note.type | added |
ExplanationOfBenefit.note.text | added |
ExplanationOfBenefit.note.language | added |
ExplanationOfBenefit.benefitBalance | added |
ExplanationOfBenefit.benefitBalance.category | added |
ExplanationOfBenefit.benefitBalance.subCategory | added |
ExplanationOfBenefit.benefitBalance.name | added |
ExplanationOfBenefit.benefitBalance.description | added |
ExplanationOfBenefit.benefitBalance.network | added |
ExplanationOfBenefit.benefitBalance.unit | added |
ExplanationOfBenefit.benefitBalance.term | added |
ExplanationOfBenefit.benefitBalance.financial | added |
ExplanationOfBenefit.benefitBalance.financial.type | added |
ExplanationOfBenefit.benefitBalance.financial.benefit[x] | added |
ExplanationOfBenefit.benefitBalance.financial.benefitUsed[x] | added |
ExplanationOfBenefit.request | deleted |
ExplanationOfBenefit.requestProvider | deleted |
ExplanationOfBenefit.requestOrganization | deleted |
See the Full Difference for further information
Structure
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
ExplanationOfBenefit | DomainResource | Explanation of Benefit resource | ||
identifier | 0..* | Identifier | Business Identifier | |
status | ?!Σ | 1..1 | code | active | cancelled | draft | entered-in-error ExplanationOfBenefitStatus (Required) |
author[x] | 0..1 | Insurer | ||
authorIdentifier | Identifier | |||
authorReference | Reference(Organization) | |||
claim[x] | 0..1 | Claim reference | ||
claimIdentifier | Identifier | |||
claimReference | Reference(Claim) | |||
claimResponse[x] | 0..1 | Claim response reference | ||
claimResponseIdentifier | Identifier | |||
claimResponseReference | Reference(ClaimResponse) | |||
type | 1..1 | Coding | Type or discipline Example Claim Type Codes (Required) | |
subType | 0..* | Coding | Finer grained claim type information Example Claim SubType Codes (Example) | |
ruleset | 0..1 | Coding | Current specification followed Ruleset Codes (Example) | |
originalRuleset | 0..1 | Coding | Original specification followed Ruleset Codes (Example) | |
created | 0..1 | dateTime | Creation date | |
billablePeriod | 0..1 | Period | Period for charge submission | |
outcome | 0..1 | Coding | complete | error | partial Claim Processing Codes (Example) | |
disposition | 0..1 | string | Disposition Message | |
provider[x] | 0..1 | Responsible provider for the claim | ||
providerIdentifier | Identifier | |||
providerReference | Reference(Practitioner) | |||
organization[x] | 0..1 | Responsible organization for the claim | ||
organizationIdentifier | Identifier | |||
organizationReference | Reference(Organization) | |||
facility[x] | 0..1 | Servicing Facility | ||
facilityIdentifier | Identifier | |||
facilityReference | Reference(Location) | |||
related | 0..* | BackboneElement | Related Claims which may be revelant to processing this claimn | |
claim[x] | 0..1 | Reference to the related claim | ||
claimIdentifier | Identifier | |||
claimReference | Reference(Claim) | |||
relationship | 0..1 | Coding | How the reference claim is related Example Related Claim Relationship Codes (Example) | |
reference | 0..1 | Identifier | Related file or case reference | |
prescription[x] | 0..1 | Prescription | ||
prescriptionIdentifier | Identifier | |||
prescriptionReference | Reference(MedicationOrder | VisionPrescription) | |||
originalPrescription[x] | 0..1 | Original Prescription | ||
originalPrescriptionIdentifier | Identifier | |||
originalPrescriptionReference | Reference(MedicationOrder) | |||
payee | 0..1 | BackboneElement | Payee | |
type | 0..1 | Coding | Type of party: Subscriber, Provider, other Payee Type Codes (Example) | |
resourceType | 0..1 | Coding | organization | patient | practitioner | relatedperson PayeeResourceType (Required) | |
party[x] | 0..1 | Party to receive the payable | ||
partyIdentifier | Identifier | |||
partyReference | Reference(Practitioner | Organization | Patient | RelatedPerson) | |||
referral[x] | 0..1 | Treatment Referral | ||
referralIdentifier | Identifier | |||
referralReference | Reference(ReferralRequest) | |||
information | 0..* | BackboneElement | ||
category | 1..1 | Coding | Category of information Claim Information Category Codes (Example) | |
code | 0..1 | Coding | Type of information Exception Codes (Example) | |
timing[x] | 0..1 | When it occurred | ||
timingDate | date | |||
timingPeriod | Period | |||
value[x] | 0..1 | Additional Data | ||
valueString | string | |||
valueQuantity | Quantity | |||
diagnosis | 0..* | BackboneElement | Diagnosis | |
sequence | 1..1 | positiveInt | Number to covey order of diagnosis | |
diagnosis | 1..1 | Coding | Patient's list of diagnosis ICD-10 Codes (Example) | |
type | 0..* | Coding | Type of Diagnosis Example Diagnosis Type Codes (Example) | |
drg | 0..1 | Coding | Diagnosis Related Group 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) | ||
procedureCoding | Coding | |||
procedureReference | Reference(Procedure) | |||
patient[x] | 1..1 | The subject of the Products and Services | ||
patientIdentifier | Identifier | |||
patientReference | Reference(Patient) | |||
precedence | 0..1 | positiveInt | Precedence (primary, secondary, etc.) | |
coverage | 1..1 | BackboneElement | Insurance or medical plan | |
coverage[x] | 0..1 | Insurance information | ||
coverageIdentifier | Identifier | |||
coverageReference | Reference(Coverage) | |||
preAuthRef | 0..* | string | Pre-Authorization/Determination Reference | |
accident | 0..1 | BackboneElement | ||
date | 0..1 | date | When the accident occurred | |
type | 0..1 | Coding | The nature of the accident ActIncidentCode (Required) | |
location[x] | 0..1 | Accident Place | ||
locationAddress | Address | |||
locationReference | Reference(Location) | |||
employmentImpacted | 0..1 | Period | Period unable to work | |
hospitalization | 0..1 | Period | Period in hospital | |
item | 0..* | BackboneElement | Goods and Services | |
sequence | 1..1 | positiveInt | Service instance | |
careTeam | 0..* | BackboneElement | ||
provider[x] | 1..1 | |||
providerIdentifier | Identifier | |||
providerReference | Reference(Practitioner | Organization) | |||
responsible | 0..1 | boolean | Billing practitioner | |
role | 0..1 | Coding | Role on the team Claim Care Team Role Codes (Example) | |
qualification | 0..1 | Coding | Type, classification or Specialization Example Provider Qualification Codes (Example) | |
diagnosisLinkId | 0..* | positiveInt | Applicable diagnoses | |
revenue | 0..1 | Coding | Revenue or cost center code Example Revenue Center Codes (Example) | |
category | 0..1 | Coding | Type of service or product Benefit SubCategory Codes (Example) | |
service | 0..1 | Coding | Billing Code USCLS Codes (Example) | |
modifier | 0..* | Coding | Service/Product billing modifiers Modifier type Codes (Example) | |
programCode | 0..* | Coding | 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) | ||
locationCoding | Coding | |||
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 | |
points | 0..1 | decimal | Difficulty scaling factor | |
net | 0..1 | Money | Total item cost | |
udi | 0..* | Reference(Device) | Unique Device Identifier | |
bodySite | 0..1 | Coding | Service Location Oral Site Codes (Example) | |
subSite | 0..* | Coding | Service Sub-location Surface Codes (Example) | |
noteNumber | 0..* | positiveInt | List of note numbers which apply | |
adjudication | 0..* | BackboneElement | Adjudication details | |
category | 1..1 | Coding | Adjudication category such as co-pay, eligible, benefit, etc. Adjudication Codes (Extensible) | |
reason | 0..1 | Coding | Adjudication reason Adjudication Reason Codes (Extensible) | |
amount | 0..1 | Money | Monetary amount | |
value | 0..1 | decimal | Non-monitory value | |
detail | 0..* | BackboneElement | Additional items | |
sequence | 1..1 | positiveInt | Service instance | |
type | 1..1 | Coding | Group or type of product or service ActInvoiceGroupCode (Required) | |
revenue | 0..1 | Coding | Revenue or cost center code Example Revenue Center Codes (Example) | |
category | 0..1 | Coding | Type of service or product Benefit SubCategory Codes (Example) | |
service | 0..1 | Coding | Billing Code USCLS Codes (Example) | |
modifier | 0..* | Coding | Service/Product billing modifiers Modifier type Codes (Example) | |
programCode | 0..* | Coding | 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 | |
points | 0..1 | decimal | Difficulty 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 adjudication | |
subDetail | 0..* | BackboneElement | Additional items | |
sequence | 1..1 | positiveInt | Service instance | |
type | 1..1 | Coding | Type of product or service ActInvoiceGroupCode (Required) | |
revenue | 0..1 | Coding | Revenue or cost center code Example Revenue Center Codes (Example) | |
category | 0..1 | Coding | Type of service or product Benefit SubCategory Codes (Example) | |
service | 0..1 | Coding | Billing Code USCLS Codes (Example) | |
modifier | 0..* | Coding | Service/Product billing modifiers Modifier type Codes (Example) | |
programCode | 0..* | Coding | 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 | |
points | 0..1 | decimal | Difficulty 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 | SubDetail adjudication | |
prosthesis | 0..1 | BackboneElement | Prosthetic details | |
initial | 0..1 | boolean | Is this the initial service | |
priorDate | 0..1 | date | Initial service Date | |
priorMaterial | 0..1 | Coding | Prosthetic Material Oral Prostho Material type Codes (Example) | |
addItem | 0..* | BackboneElement | Insurer added line items | |
sequenceLinkId | 0..* | positiveInt | Service instances | |
revenue | 0..1 | Coding | Revenue or cost center code Example Revenue Center Codes (Example) | |
category | 0..1 | Coding | Type of service or product Benefit SubCategory Codes (Example) | |
service | 0..1 | Coding | Billing Code USCLS Codes (Example) | |
modifier | 0..* | Coding | 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 | |
detail | 0..* | BackboneElement | Added items details | |
revenue | 0..1 | Coding | Revenue or cost center code Example Revenue Center Codes (Example) | |
category | 0..1 | Coding | Type of service or product Benefit SubCategory Codes (Example) | |
service | 0..1 | Coding | Billing Code USCLS Codes (Example) | |
modifier | 0..* | Coding | 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 detail adjudication | |
missingTeeth | 0..* | BackboneElement | Only if type = oral | |
tooth | 1..1 | Coding | Tooth Code Teeth Codes (Example) | |
reason | 0..1 | Coding | Reason for missing Missing Tooth Reason Codes (Example) | |
extractionDate | 0..1 | date | Date of Extraction | |
totalCost | 0..1 | Money | Total Cost of service from the Claim | |
unallocDeductable | 0..1 | Money | Unallocated deductable | |
totalBenefit | 0..1 | Money | Total benefit payable for the Claim | |
payment | 0..1 | BackboneElement | ||
type | 0..1 | Coding | Partial or Complete Example Payment Type Codes (Example) | |
adjustment | 0..1 | Money | Payment adjustment for non-Claim issues | |
adjustmentReason | 0..1 | Coding | Reason for Payment adjustment Payment Adjustment Reason Codes (Extensible) | |
date | 0..1 | date | Expected date of Payment | |
amount | 0..1 | Money | Payment amount | |
identifier | 0..1 | Identifier | Payment identifier | |
form | 0..1 | Coding | Printed Form Identifier Form Codes (Required) | |
note | 0..* | BackboneElement | Processing notes | |
number | 0..1 | positiveInt | Note Number for this note | |
type | 0..1 | Coding | display | print | printoper NoteType (Required) | |
text | 0..1 | string | Note explanitory text | |
language | 0..1 | Coding | Language Common Languages (Extensible but limited to All Languages) | |
benefitBalance | 0..* | BackboneElement | Balance by Benefit Category | |
category | 1..1 | Coding | Benefit Category Benefit Category Codes (Example) | |
subCategory | 0..1 | Coding | Benefit SubCategory Benefit SubCategory Codes (Example) | |
name | 0..1 | string | Short name for the benefit | |
description | 0..1 | string | Description of the benefit | |
network | 0..1 | Coding | In or out of network Network Type Codes (Example) | |
unit | 0..1 | Coding | Individual or family Unit Type Codes (Example) | |
term | 0..1 | Coding | Annual or lifetime Benefit Term Codes (Example) | |
financial | 0..* | BackboneElement | Benefit Summary | |
type | 1..1 | Coding | Deductable, visits, benefit amount Benefit Type Codes (Example) | |
benefit[x] | 0..1 | Benefits allowed | ||
benefitUnsignedInt | unsignedInt | |||
benefitString | string | |||
benefitMoney | Money | |||
benefitUsed[x] | 0..1 | Benefits used | ||
benefitUsedUnsignedInt | unsignedInt | |||
benefitUsedMoney | 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]"/><!-- 1..1 active | cancelled | draft | entered-in-error --> <author[x]><!-- 0..1 Identifier|Reference(Organization) Insurer --></author[x]> <claim[x]><!-- 0..1 Identifier|Reference(Claim) Claim reference --></claim[x]> <claimResponse[x]><!-- 0..1 Identifier|Reference(ClaimResponse) Claim response reference --></claimResponse[x]> <type><!-- 1..1 Coding Type or discipline --></type> <subType><!-- 0..* Coding Finer grained claim type information --></subType> <ruleset><!-- 0..1 Coding Current specification followed --></ruleset> <originalRuleset><!-- 0..1 Coding Original specification followed --></originalRuleset> <created value="[dateTime]"/><!-- 0..1 Creation date --> <billablePeriod><!-- 0..1 Period Period for charge submission --></billablePeriod> <outcome><!-- 0..1 Coding complete | error | partial --></outcome> <disposition value="[string]"/><!-- 0..1 Disposition Message --> <provider[x]><!-- 0..1 Identifier|Reference(Practitioner) Responsible provider for the claim --></provider[x]> <organization[x]><!-- 0..1 Identifier|Reference(Organization) Responsible organization for the claim --></organization[x]> <facility[x]><!-- 0..1 Identifier|Reference(Location) Servicing Facility --></facility[x]> <related> <!-- 0..* Related Claims which may be revelant to processing this claimn --> <claim[x]><!-- 0..1 Identifier|Reference(Claim) Reference to the related claim --></claim[x]> <relationship><!-- 0..1 Coding How the reference claim is related --></relationship> <reference><!-- 0..1 Identifier Related file or case reference --></reference> </related> <prescription[x]><!-- 0..1 Identifier|Reference(MedicationOrder| VisionPrescription) Prescription --></prescription[x]> <originalPrescription[x]><!-- 0..1 Identifier|Reference(MedicationOrder) Original Prescription --></originalPrescription[x]> <payee> <!-- 0..1 Payee --> <type><!-- 0..1 Coding Type of party: Subscriber, Provider, other --></type> <resourceType><!-- 0..1 Coding organization | patient | practitioner | relatedperson --></resourceType> <party[x]><!-- 0..1 Identifier|Reference(Practitioner|Organization|Patient| RelatedPerson) Party to receive the payable --></party[x]> </payee> <referral[x]><!-- 0..1 Identifier|Reference(ReferralRequest) Treatment Referral --></referral[x]> <information> <!-- 0..* --> <category><!-- 1..1 Coding Category of information --></category> <code><!-- 0..1 Coding Type of information --></code> <timing[x]><!-- 0..1 date|Period When it occurred --></timing[x]> <value[x]><!-- 0..1 string|Quantity Additional Data --></value[x]> </information> <diagnosis> <!-- 0..* Diagnosis --> <sequence value="[positiveInt]"/><!-- 1..1 Number to covey order of diagnosis --> <diagnosis><!-- 1..1 Coding Patient's list of diagnosis --></diagnosis> <type><!-- 0..* Coding Type of Diagnosis --></type> <drg><!-- 0..1 Coding Diagnosis Related Group --></drg> </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 Coding|Reference(Procedure) Patient's list of procedures performed --></procedure[x]> </procedure> <patient[x]><!-- 1..1 Identifier|Reference(Patient) The subject of the Products and Services --></patient[x]> <precedence value="[positiveInt]"/><!-- 0..1 Precedence (primary, secondary, etc.) --> <coverage> <!-- 1..1 Insurance or medical plan --> <coverage[x]><!-- 0..1 Identifier|Reference(Coverage) Insurance information --></coverage[x]> <preAuthRef value="[string]"/><!-- 0..* Pre-Authorization/Determination Reference --> </coverage> <accident> <date value="[date]"/><!-- 0..1 When the accident occurred --> <type><!-- 0..1 Coding The nature of the accident --></type> <location[x]><!-- 0..1 Address|Reference(Location) Accident Place --></location[x]> </accident> <employmentImpacted><!-- 0..1 Period Period unable to work --></employmentImpacted> <hospitalization><!-- 0..1 Period Period in hospital --></hospitalization> <item> <!-- 0..* Goods and Services --> <sequence value="[positiveInt]"/><!-- 1..1 Service instance --> <careTeam> <!-- 0..* --> <provider[x]><!-- 1..1 Identifier|Reference(Practitioner|Organization) --></provider[x]> <responsible value="[boolean]"/><!-- 0..1 Billing practitioner --> <role><!-- 0..1 Coding Role on the team --></role> <qualification><!-- 0..1 Coding Type, classification or Specialization --></qualification> </careTeam> <diagnosisLinkId value="[positiveInt]"/><!-- 0..* Applicable diagnoses --> <revenue><!-- 0..1 Coding Revenue or cost center code --></revenue> <category><!-- 0..1 Coding Type of service or product --></category> <service><!-- 0..1 Coding Billing Code --></service> <modifier><!-- 0..* Coding Service/Product billing modifiers --></modifier> <programCode><!-- 0..* Coding Program specific reason for item inclusion --></programCode> <serviced[x]><!-- 0..1 date|Period Date or dates of Service --></serviced[x]> <location[x]><!-- 0..1 Coding|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 --> <points value="[decimal]"/><!-- 0..1 Difficulty scaling factor --> <net><!-- 0..1 Money Total item cost --></net> <udi><!-- 0..* Reference(Device) Unique Device Identifier --></udi> <bodySite><!-- 0..1 Coding Service Location --></bodySite> <subSite><!-- 0..* Coding Service Sub-location --></subSite> <noteNumber value="[positiveInt]"/><!-- 0..* List of note numbers which apply --> <adjudication> <!-- 0..* Adjudication details --> <category><!-- 1..1 Coding Adjudication category such as co-pay, eligible, benefit, etc. --></category> <reason><!-- 0..1 Coding Adjudication reason --></reason> <amount><!-- 0..1 Money Monetary amount --></amount> <value value="[decimal]"/><!-- 0..1 Non-monitory value --> </adjudication> <detail> <!-- 0..* Additional items --> <sequence value="[positiveInt]"/><!-- 1..1 Service instance --> <type><!-- 1..1 Coding Group or type of product or service --></type> <revenue><!-- 0..1 Coding Revenue or cost center code --></revenue> <category><!-- 0..1 Coding Type of service or product --></category> <service><!-- 0..1 Coding Billing Code --></service> <modifier><!-- 0..* Coding Service/Product billing modifiers --></modifier> <programCode><!-- 0..* Coding 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 --> <points value="[decimal]"/><!-- 0..1 Difficulty 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 adjudication --></adjudication> <subDetail> <!-- 0..* Additional items --> <sequence value="[positiveInt]"/><!-- 1..1 Service instance --> <type><!-- 1..1 Coding Type of product or service --></type> <revenue><!-- 0..1 Coding Revenue or cost center code --></revenue> <category><!-- 0..1 Coding Type of service or product --></category> <service><!-- 0..1 Coding Billing Code --></service> <modifier><!-- 0..* Coding Service/Product billing modifiers --></modifier> <programCode><!-- 0..* Coding 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 --> <points value="[decimal]"/><!-- 0..1 Difficulty 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 SubDetail adjudication --></adjudication> </subDetail> </detail> <prosthesis> <!-- 0..1 Prosthetic details --> <initial value="[boolean]"/><!-- 0..1 Is this the initial service --> <priorDate value="[date]"/><!-- 0..1 Initial service Date --> <priorMaterial><!-- 0..1 Coding Prosthetic Material --></priorMaterial> </prosthesis> </item> <addItem> <!-- 0..* Insurer added line items --> <sequenceLinkId value="[positiveInt]"/><!-- 0..* Service instances --> <revenue><!-- 0..1 Coding Revenue or cost center code --></revenue> <category><!-- 0..1 Coding Type of service or product --></category> <service><!-- 0..1 Coding Billing Code --></service> <modifier><!-- 0..* Coding 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> <detail> <!-- 0..* Added items details --> <revenue><!-- 0..1 Coding Revenue or cost center code --></revenue> <category><!-- 0..1 Coding Type of service or product --></category> <service><!-- 0..1 Coding Billing Code --></service> <modifier><!-- 0..* Coding 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 detail adjudication --></adjudication> </detail> </addItem> <missingTeeth> <!-- 0..* Only if type = oral --> <tooth><!-- 1..1 Coding Tooth Code --></tooth> <reason><!-- 0..1 Coding Reason for missing --></reason> <extractionDate value="[date]"/><!-- 0..1 Date of Extraction --> </missingTeeth> <totalCost><!-- 0..1 Money Total Cost of service from the Claim --></totalCost> <unallocDeductable><!-- 0..1 Money Unallocated deductable --></unallocDeductable> <totalBenefit><!-- 0..1 Money Total benefit payable for the Claim --></totalBenefit> <payment> <type><!-- 0..1 Coding Partial or Complete --></type> <adjustment><!-- 0..1 Money Payment adjustment for non-Claim issues --></adjustment> <adjustmentReason><!-- 0..1 Coding Reason for Payment adjustment --></adjustmentReason> <date value="[date]"/><!-- 0..1 Expected date of Payment --> <amount><!-- 0..1 Money Payment amount --></amount> <identifier><!-- 0..1 Identifier Payment identifier --></identifier> </payment> <form><!-- 0..1 Coding Printed Form Identifier --></form> <note> <!-- 0..* Processing notes --> <number value="[positiveInt]"/><!-- 0..1 Note Number for this note --> <type><!-- 0..1 Coding display | print | printoper --></type> <text value="[string]"/><!-- 0..1 Note explanitory text --> <language><!-- 0..1 Coding Language --></language> </note> <benefitBalance> <!-- 0..* Balance by Benefit Category --> <category><!-- 1..1 Coding Benefit Category --></category> <subCategory><!-- 0..1 Coding Benefit SubCategory --></subCategory> <name value="[string]"/><!-- 0..1 Short name for the benefit --> <description value="[string]"/><!-- 0..1 Description of the benefit --> <network><!-- 0..1 Coding In or out of network --></network> <unit><!-- 0..1 Coding Individual or family --></unit> <term><!-- 0..1 Coding Annual or lifetime --></term> <financial> <!-- 0..* Benefit Summary --> <type><!-- 1..1 Coding Deductable, visits, benefit amount --></type> <benefit[x]><!-- 0..1 unsignedInt|string|Money Benefits allowed --></benefit[x]> <benefitUsed[x]><!-- 0..1 unsignedInt|Money Benefits used --></benefitUsed[x]> </financial> </benefitBalance> </ExplanationOfBenefit>
JSON Template
{ "resourceType" : "ExplanationOfBenefit", // from Resource: id, meta, implicitRules, and language // from DomainResource: text, contained, extension, and modifierExtension "identifier" : [{ Identifier }], // Business Identifier "status" : "<code>", // R! active | cancelled | draft | entered-in-error // author[x]: Insurer. One of these 2: "authorIdentifier" : { Identifier }, "authorReference" : { Reference(Organization) }, // claim[x]: Claim reference. One of these 2: "claimIdentifier" : { Identifier }, "claimReference" : { Reference(Claim) }, // claimResponse[x]: Claim response reference. One of these 2: "claimResponseIdentifier" : { Identifier }, "claimResponseReference" : { Reference(ClaimResponse) }, "type" : { Coding }, // R! Type or discipline "subType" : [{ Coding }], // Finer grained claim type information "ruleset" : { Coding }, // Current specification followed "originalRuleset" : { Coding }, // Original specification followed "created" : "<dateTime>", // Creation date "billablePeriod" : { Period }, // Period for charge submission "outcome" : { Coding }, // complete | error | partial "disposition" : "<string>", // Disposition Message // provider[x]: Responsible provider for the claim. One of these 2: "providerIdentifier" : { Identifier }, "providerReference" : { Reference(Practitioner) }, // organization[x]: Responsible organization for the claim. One of these 2: "organizationIdentifier" : { Identifier }, "organizationReference" : { Reference(Organization) }, // facility[x]: Servicing Facility. One of these 2: "facilityIdentifier" : { Identifier }, "facilityReference" : { Reference(Location) }, "related" : [{ // Related Claims which may be revelant to processing this claimn // claim[x]: Reference to the related claim. One of these 2: "claimIdentifier" : { Identifier }, "claimReference" : { Reference(Claim) }, "relationship" : { Coding }, // How the reference claim is related "reference" : { Identifier } // Related file or case reference }], // prescription[x]: Prescription. One of these 2: "prescriptionIdentifier" : { Identifier }, "prescriptionReference" : { Reference(MedicationOrder|VisionPrescription) }, // originalPrescription[x]: Original Prescription. One of these 2: "originalPrescriptionIdentifier" : { Identifier }, "originalPrescriptionReference" : { Reference(MedicationOrder) }, "payee" : { // Payee "type" : { Coding }, // Type of party: Subscriber, Provider, other "resourceType" : { Coding }, // organization | patient | practitioner | relatedperson // party[x]: Party to receive the payable. One of these 2: "partyIdentifier" : { Identifier } "partyReference" : { Reference(Practitioner|Organization|Patient|RelatedPerson) } }, // referral[x]: Treatment Referral. One of these 2: "referralIdentifier" : { Identifier }, "referralReference" : { Reference(ReferralRequest) }, "information" : [{ // "category" : { Coding }, // R! Category of information "code" : { Coding }, // Type of information // timing[x]: When it occurred. One of these 2: "timingDate" : "<date>", "timingPeriod" : { Period }, // value[x]: Additional Data. One of these 2: "valueString" : "<string>" "valueQuantity" : { Quantity } }], "diagnosis" : [{ // Diagnosis "sequence" : "<positiveInt>", // R! Number to covey order of diagnosis "diagnosis" : { Coding }, // R! Patient's list of diagnosis "type" : [{ Coding }], // Type of Diagnosis "drg" : { Coding } // Diagnosis Related Group }], "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: "procedureCoding" : { Coding } "procedureReference" : { Reference(Procedure) } }], // patient[x]: The subject of the Products and Services. One of these 2: "patientIdentifier" : { Identifier }, "patientReference" : { Reference(Patient) }, "precedence" : "<positiveInt>", // Precedence (primary, secondary, etc.) "coverage" : { // R! Insurance or medical plan // coverage[x]: Insurance information. One of these 2: "coverageIdentifier" : { Identifier }, "coverageReference" : { Reference(Coverage) }, "preAuthRef" : ["<string>"] // Pre-Authorization/Determination Reference }, "accident" : { // "date" : "<date>", // When the accident occurred "type" : { Coding }, // The nature of the accident // location[x]: Accident Place. One of these 2: "locationAddress" : { Address } "locationReference" : { Reference(Location) } }, "employmentImpacted" : { Period }, // Period unable to work "hospitalization" : { Period }, // Period in hospital "item" : [{ // Goods and Services "sequence" : "<positiveInt>", // R! Service instance "careTeam" : [{ // // provider[x]: . One of these 2: "providerIdentifier" : { Identifier }, "providerReference" : { Reference(Practitioner|Organization) }, "responsible" : <boolean>, // Billing practitioner "role" : { Coding }, // Role on the team "qualification" : { Coding } // Type, classification or Specialization }], "diagnosisLinkId" : ["<positiveInt>"], // Applicable diagnoses "revenue" : { Coding }, // Revenue or cost center code "category" : { Coding }, // Type of service or product "service" : { Coding }, // Billing Code "modifier" : [{ Coding }], // Service/Product billing modifiers "programCode" : [{ Coding }], // 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: "locationCoding" : { Coding }, "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 "points" : <decimal>, // Difficulty scaling factor "net" : { Money }, // Total item cost "udi" : [{ Reference(Device) }], // Unique Device Identifier "bodySite" : { Coding }, // Service Location "subSite" : [{ Coding }], // Service Sub-location "noteNumber" : ["<positiveInt>"], // List of note numbers which apply "adjudication" : [{ // Adjudication details "category" : { Coding }, // R! Adjudication category such as co-pay, eligible, benefit, etc. "reason" : { Coding }, // Adjudication reason "amount" : { Money }, // Monetary amount "value" : <decimal> // Non-monitory value }], "detail" : [{ // Additional items "sequence" : "<positiveInt>", // R! Service instance "type" : { Coding }, // R! Group or type of product or service "revenue" : { Coding }, // Revenue or cost center code "category" : { Coding }, // Type of service or product "service" : { Coding }, // Billing Code "modifier" : [{ Coding }], // Service/Product billing modifiers "programCode" : [{ Coding }], // 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 "points" : <decimal>, // Difficulty 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 adjudication "subDetail" : [{ // Additional items "sequence" : "<positiveInt>", // R! Service instance "type" : { Coding }, // R! Type of product or service "revenue" : { Coding }, // Revenue or cost center code "category" : { Coding }, // Type of service or product "service" : { Coding }, // Billing Code "modifier" : [{ Coding }], // Service/Product billing modifiers "programCode" : [{ Coding }], // 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 "points" : <decimal>, // Difficulty 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 }] // SubDetail adjudication }] }], "prosthesis" : { // Prosthetic details "initial" : <boolean>, // Is this the initial service "priorDate" : "<date>", // Initial service Date "priorMaterial" : { Coding } // Prosthetic Material } }], "addItem" : [{ // Insurer added line items "sequenceLinkId" : ["<positiveInt>"], // Service instances "revenue" : { Coding }, // Revenue or cost center code "category" : { Coding }, // Type of service or product "service" : { Coding }, // Billing Code "modifier" : [{ Coding }], // 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 "detail" : [{ // Added items details "revenue" : { Coding }, // Revenue or cost center code "category" : { Coding }, // Type of service or product "service" : { Coding }, // Billing Code "modifier" : [{ Coding }], // 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 detail adjudication }] }], "missingTeeth" : [{ // Only if type = oral "tooth" : { Coding }, // R! Tooth Code "reason" : { Coding }, // Reason for missing "extractionDate" : "<date>" // Date of Extraction }], "totalCost" : { Money }, // Total Cost of service from the Claim "unallocDeductable" : { Money }, // Unallocated deductable "totalBenefit" : { Money }, // Total benefit payable for the Claim "payment" : { // "type" : { Coding }, // Partial or Complete "adjustment" : { Money }, // Payment adjustment for non-Claim issues "adjustmentReason" : { Coding }, // Reason for Payment adjustment "date" : "<date>", // Expected date of Payment "amount" : { Money }, // Payment amount "identifier" : { Identifier } // Payment identifier }, "form" : { Coding }, // Printed Form Identifier "note" : [{ // Processing notes "number" : "<positiveInt>", // Note Number for this note "type" : { Coding }, // display | print | printoper "text" : "<string>", // Note explanitory text "language" : { Coding } // Language }], "benefitBalance" : [{ // Balance by Benefit Category "category" : { Coding }, // R! Benefit Category "subCategory" : { Coding }, // Benefit SubCategory "name" : "<string>", // Short name for the benefit "description" : "<string>", // Description of the benefit "network" : { Coding }, // In or out of network "unit" : { Coding }, // Individual or family "term" : { Coding }, // Annual or lifetime "financial" : [{ // Benefit Summary "type" : { Coding }, // R! Deductable, visits, benefit amount // benefit[x]: Benefits allowed. One of these 3: "benefitUnsignedInt" : "<unsignedInt>", "benefitString" : "<string>", "benefitMoney" : { Money }, // benefitUsed[x]: Benefits used. One of these 2: "benefitUsedUnsignedInt" : "<unsignedInt>" "benefitUsedMoney" : { 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 ]; # 1..1 active | cancelled | draft | entered-in-error # ExplanationOfBenefit.author[x] : 0..1 Insurer. One of these 2 fhir:ExplanationOfBenefit.authorIdentifier [ Identifier ] fhir:ExplanationOfBenefit.authorReference [ Reference(Organization) ] # ExplanationOfBenefit.claim[x] : 0..1 Claim reference. One of these 2 fhir:ExplanationOfBenefit.claimIdentifier [ Identifier ] fhir:ExplanationOfBenefit.claimReference [ Reference(Claim) ] # ExplanationOfBenefit.claimResponse[x] : 0..1 Claim response reference. One of these 2 fhir:ExplanationOfBenefit.claimResponseIdentifier [ Identifier ] fhir:ExplanationOfBenefit.claimResponseReference [ Reference(ClaimResponse) ] fhir:ExplanationOfBenefit.type [ Coding ]; # 1..1 Type or discipline fhir:ExplanationOfBenefit.subType [ Coding ], ... ; # 0..* Finer grained claim type information fhir:ExplanationOfBenefit.ruleset [ Coding ]; # 0..1 Current specification followed fhir:ExplanationOfBenefit.originalRuleset [ Coding ]; # 0..1 Original specification followed fhir:ExplanationOfBenefit.created [ dateTime ]; # 0..1 Creation date fhir:ExplanationOfBenefit.billablePeriod [ Period ]; # 0..1 Period for charge submission fhir:ExplanationOfBenefit.outcome [ Coding ]; # 0..1 complete | error | partial fhir:ExplanationOfBenefit.disposition [ string ]; # 0..1 Disposition Message # ExplanationOfBenefit.provider[x] : 0..1 Responsible provider for the claim. One of these 2 fhir:ExplanationOfBenefit.providerIdentifier [ Identifier ] fhir:ExplanationOfBenefit.providerReference [ Reference(Practitioner) ] # ExplanationOfBenefit.organization[x] : 0..1 Responsible organization for the claim. One of these 2 fhir:ExplanationOfBenefit.organizationIdentifier [ Identifier ] fhir:ExplanationOfBenefit.organizationReference [ Reference(Organization) ] # ExplanationOfBenefit.facility[x] : 0..1 Servicing Facility. One of these 2 fhir:ExplanationOfBenefit.facilityIdentifier [ Identifier ] fhir:ExplanationOfBenefit.facilityReference [ Reference(Location) ] fhir:ExplanationOfBenefit.related [ # 0..* Related Claims which may be revelant to processing this claimn # ExplanationOfBenefit.related.claim[x] : 0..1 Reference to the related claim. One of these 2 fhir:ExplanationOfBenefit.related.claimIdentifier [ Identifier ] fhir:ExplanationOfBenefit.related.claimReference [ Reference(Claim) ] fhir:ExplanationOfBenefit.related.relationship [ Coding ]; # 0..1 How the reference claim is related fhir:ExplanationOfBenefit.related.reference [ Identifier ]; # 0..1 Related file or case reference ], ...; # ExplanationOfBenefit.prescription[x] : 0..1 Prescription. One of these 2 fhir:ExplanationOfBenefit.prescriptionIdentifier [ Identifier ] fhir:ExplanationOfBenefit.prescriptionReference [ Reference(MedicationOrder|VisionPrescription) ] # ExplanationOfBenefit.originalPrescription[x] : 0..1 Original Prescription. One of these 2 fhir:ExplanationOfBenefit.originalPrescriptionIdentifier [ Identifier ] fhir:ExplanationOfBenefit.originalPrescriptionReference [ Reference(MedicationOrder) ] fhir:ExplanationOfBenefit.payee [ # 0..1 Payee fhir:ExplanationOfBenefit.payee.type [ Coding ]; # 0..1 Type of party: Subscriber, Provider, other fhir:ExplanationOfBenefit.payee.resourceType [ Coding ]; # 0..1 organization | patient | practitioner | relatedperson # ExplanationOfBenefit.payee.party[x] : 0..1 Party to receive the payable. One of these 2 fhir:ExplanationOfBenefit.payee.partyIdentifier [ Identifier ] fhir:ExplanationOfBenefit.payee.partyReference [ Reference(Practitioner|Organization|Patient|RelatedPerson) ] ]; # ExplanationOfBenefit.referral[x] : 0..1 Treatment Referral. One of these 2 fhir:ExplanationOfBenefit.referralIdentifier [ Identifier ] fhir:ExplanationOfBenefit.referralReference [ Reference(ReferralRequest) ] fhir:ExplanationOfBenefit.information [ # 0..* fhir:ExplanationOfBenefit.information.category [ Coding ]; # 1..1 Category of information fhir:ExplanationOfBenefit.information.code [ Coding ]; # 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. One of these 2 fhir:ExplanationOfBenefit.information.valueString [ string ] fhir:ExplanationOfBenefit.information.valueQuantity [ Quantity ] ], ...; fhir:ExplanationOfBenefit.diagnosis [ # 0..* Diagnosis fhir:ExplanationOfBenefit.diagnosis.sequence [ positiveInt ]; # 1..1 Number to covey order of diagnosis fhir:ExplanationOfBenefit.diagnosis.diagnosis [ Coding ]; # 1..1 Patient's list of diagnosis fhir:ExplanationOfBenefit.diagnosis.type [ Coding ], ... ; # 0..* Type of Diagnosis fhir:ExplanationOfBenefit.diagnosis.drg [ Coding ]; # 0..1 Diagnosis Related Group ], ...; 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.procedureCoding [ Coding ] fhir:ExplanationOfBenefit.procedure.procedureReference [ Reference(Procedure) ] ], ...; # ExplanationOfBenefit.patient[x] : 1..1 The subject of the Products and Services. One of these 2 fhir:ExplanationOfBenefit.patientIdentifier [ Identifier ] fhir:ExplanationOfBenefit.patientReference [ Reference(Patient) ] fhir:ExplanationOfBenefit.precedence [ positiveInt ]; # 0..1 Precedence (primary, secondary, etc.) fhir:ExplanationOfBenefit.coverage [ # 1..1 Insurance or medical plan # ExplanationOfBenefit.coverage.coverage[x] : 0..1 Insurance information. One of these 2 fhir:ExplanationOfBenefit.coverage.coverageIdentifier [ Identifier ] fhir:ExplanationOfBenefit.coverage.coverageReference [ Reference(Coverage) ] fhir:ExplanationOfBenefit.coverage.preAuthRef [ string ], ... ; # 0..* Pre-Authorization/Determination Reference ]; fhir:ExplanationOfBenefit.accident [ # 0..1 fhir:ExplanationOfBenefit.accident.date [ date ]; # 0..1 When the accident occurred fhir:ExplanationOfBenefit.accident.type [ Coding ]; # 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.employmentImpacted [ Period ]; # 0..1 Period unable to work fhir:ExplanationOfBenefit.hospitalization [ Period ]; # 0..1 Period in hospital fhir:ExplanationOfBenefit.item [ # 0..* Goods and Services fhir:ExplanationOfBenefit.item.sequence [ positiveInt ]; # 1..1 Service instance fhir:ExplanationOfBenefit.item.careTeam [ # 0..* # ExplanationOfBenefit.item.careTeam.provider[x] : 1..1 . One of these 2 fhir:ExplanationOfBenefit.item.careTeam.providerIdentifier [ Identifier ] fhir:ExplanationOfBenefit.item.careTeam.providerReference [ Reference(Practitioner|Organization) ] fhir:ExplanationOfBenefit.item.careTeam.responsible [ boolean ]; # 0..1 Billing practitioner fhir:ExplanationOfBenefit.item.careTeam.role [ Coding ]; # 0..1 Role on the team fhir:ExplanationOfBenefit.item.careTeam.qualification [ Coding ]; # 0..1 Type, classification or Specialization ], ...; fhir:ExplanationOfBenefit.item.diagnosisLinkId [ positiveInt ], ... ; # 0..* Applicable diagnoses fhir:ExplanationOfBenefit.item.revenue [ Coding ]; # 0..1 Revenue or cost center code fhir:ExplanationOfBenefit.item.category [ Coding ]; # 0..1 Type of service or product fhir:ExplanationOfBenefit.item.service [ Coding ]; # 0..1 Billing Code fhir:ExplanationOfBenefit.item.modifier [ Coding ], ... ; # 0..* Service/Product billing modifiers fhir:ExplanationOfBenefit.item.programCode [ Coding ], ... ; # 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.locationCoding [ Coding ] 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.points [ decimal ]; # 0..1 Difficulty 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 [ Coding ]; # 0..1 Service Location fhir:ExplanationOfBenefit.item.subSite [ Coding ], ... ; # 0..* Service Sub-location fhir:ExplanationOfBenefit.item.noteNumber [ positiveInt ], ... ; # 0..* List of note numbers which apply fhir:ExplanationOfBenefit.item.adjudication [ # 0..* Adjudication details fhir:ExplanationOfBenefit.item.adjudication.category [ Coding ]; # 1..1 Adjudication category such as co-pay, eligible, benefit, etc. fhir:ExplanationOfBenefit.item.adjudication.reason [ Coding ]; # 0..1 Adjudication reason 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.type [ Coding ]; # 1..1 Group or type of product or service fhir:ExplanationOfBenefit.item.detail.revenue [ Coding ]; # 0..1 Revenue or cost center code fhir:ExplanationOfBenefit.item.detail.category [ Coding ]; # 0..1 Type of service or product fhir:ExplanationOfBenefit.item.detail.service [ Coding ]; # 0..1 Billing Code fhir:ExplanationOfBenefit.item.detail.modifier [ Coding ], ... ; # 0..* Service/Product billing modifiers fhir:ExplanationOfBenefit.item.detail.programCode [ Coding ], ... ; # 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.points [ decimal ]; # 0..1 Difficulty 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 adjudication fhir:ExplanationOfBenefit.item.detail.subDetail [ # 0..* Additional items fhir:ExplanationOfBenefit.item.detail.subDetail.sequence [ positiveInt ]; # 1..1 Service instance fhir:ExplanationOfBenefit.item.detail.subDetail.type [ Coding ]; # 1..1 Type of product or service fhir:ExplanationOfBenefit.item.detail.subDetail.revenue [ Coding ]; # 0..1 Revenue or cost center code fhir:ExplanationOfBenefit.item.detail.subDetail.category [ Coding ]; # 0..1 Type of service or product fhir:ExplanationOfBenefit.item.detail.subDetail.service [ Coding ]; # 0..1 Billing Code fhir:ExplanationOfBenefit.item.detail.subDetail.modifier [ Coding ], ... ; # 0..* Service/Product billing modifiers fhir:ExplanationOfBenefit.item.detail.subDetail.programCode [ Coding ], ... ; # 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.points [ decimal ]; # 0..1 Difficulty 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..* SubDetail adjudication ], ...; ], ...; fhir:ExplanationOfBenefit.item.prosthesis [ # 0..1 Prosthetic details fhir:ExplanationOfBenefit.item.prosthesis.initial [ boolean ]; # 0..1 Is this the initial service fhir:ExplanationOfBenefit.item.prosthesis.priorDate [ date ]; # 0..1 Initial service Date fhir:ExplanationOfBenefit.item.prosthesis.priorMaterial [ Coding ]; # 0..1 Prosthetic Material ]; ], ...; fhir:ExplanationOfBenefit.addItem [ # 0..* Insurer added line items fhir:ExplanationOfBenefit.addItem.sequenceLinkId [ positiveInt ], ... ; # 0..* Service instances fhir:ExplanationOfBenefit.addItem.revenue [ Coding ]; # 0..1 Revenue or cost center code fhir:ExplanationOfBenefit.addItem.category [ Coding ]; # 0..1 Type of service or product fhir:ExplanationOfBenefit.addItem.service [ Coding ]; # 0..1 Billing Code fhir:ExplanationOfBenefit.addItem.modifier [ Coding ], ... ; # 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.addItem.detail [ # 0..* Added items details fhir:ExplanationOfBenefit.addItem.detail.revenue [ Coding ]; # 0..1 Revenue or cost center code fhir:ExplanationOfBenefit.addItem.detail.category [ Coding ]; # 0..1 Type of service or product fhir:ExplanationOfBenefit.addItem.detail.service [ Coding ]; # 0..1 Billing Code fhir:ExplanationOfBenefit.addItem.detail.modifier [ Coding ], ... ; # 0..* Service/Product billing modifiers fhir:ExplanationOfBenefit.addItem.detail.fee [ Money ]; # 0..1 Professional fee or Product charge fhir:ExplanationOfBenefit.addItem.detail.noteNumber [ positiveInt ], ... ; # 0..* List of note numbers which apply fhir:ExplanationOfBenefit.addItem.detail.adjudication [ See ExplanationOfBenefit.item.adjudication ], ... ; # 0..* Added items detail adjudication ], ...; ], ...; fhir:ExplanationOfBenefit.missingTeeth [ # 0..* Only if type = oral fhir:ExplanationOfBenefit.missingTeeth.tooth [ Coding ]; # 1..1 Tooth Code fhir:ExplanationOfBenefit.missingTeeth.reason [ Coding ]; # 0..1 Reason for missing fhir:ExplanationOfBenefit.missingTeeth.extractionDate [ date ]; # 0..1 Date of Extraction ], ...; fhir:ExplanationOfBenefit.totalCost [ Money ]; # 0..1 Total Cost of service from the Claim fhir:ExplanationOfBenefit.unallocDeductable [ Money ]; # 0..1 Unallocated deductable fhir:ExplanationOfBenefit.totalBenefit [ Money ]; # 0..1 Total benefit payable for the Claim fhir:ExplanationOfBenefit.payment [ # 0..1 fhir:ExplanationOfBenefit.payment.type [ Coding ]; # 0..1 Partial or Complete fhir:ExplanationOfBenefit.payment.adjustment [ Money ]; # 0..1 Payment adjustment for non-Claim issues fhir:ExplanationOfBenefit.payment.adjustmentReason [ Coding ]; # 0..1 Reason for Payment adjustment fhir:ExplanationOfBenefit.payment.date [ date ]; # 0..1 Expected date of Payment fhir:ExplanationOfBenefit.payment.amount [ Money ]; # 0..1 Payment amount fhir:ExplanationOfBenefit.payment.identifier [ Identifier ]; # 0..1 Payment identifier ]; fhir:ExplanationOfBenefit.form [ Coding ]; # 0..1 Printed Form Identifier fhir:ExplanationOfBenefit.note [ # 0..* Processing notes fhir:ExplanationOfBenefit.note.number [ positiveInt ]; # 0..1 Note Number for this note fhir:ExplanationOfBenefit.note.type [ Coding ]; # 0..1 display | print | printoper fhir:ExplanationOfBenefit.note.text [ string ]; # 0..1 Note explanitory text fhir:ExplanationOfBenefit.note.language [ Coding ]; # 0..1 Language ], ...; fhir:ExplanationOfBenefit.benefitBalance [ # 0..* Balance by Benefit Category fhir:ExplanationOfBenefit.benefitBalance.category [ Coding ]; # 1..1 Benefit Category fhir:ExplanationOfBenefit.benefitBalance.subCategory [ Coding ]; # 0..1 Benefit SubCategory fhir:ExplanationOfBenefit.benefitBalance.name [ string ]; # 0..1 Short name for the benefit fhir:ExplanationOfBenefit.benefitBalance.description [ string ]; # 0..1 Description of the benefit fhir:ExplanationOfBenefit.benefitBalance.network [ Coding ]; # 0..1 In or out of network fhir:ExplanationOfBenefit.benefitBalance.unit [ Coding ]; # 0..1 Individual or family fhir:ExplanationOfBenefit.benefitBalance.term [ Coding ]; # 0..1 Annual or lifetime fhir:ExplanationOfBenefit.benefitBalance.financial [ # 0..* Benefit Summary fhir:ExplanationOfBenefit.benefitBalance.financial.type [ Coding ]; # 1..1 Deductable, visits, benefit amount # ExplanationOfBenefit.benefitBalance.financial.benefit[x] : 0..1 Benefits allowed. One of these 3 fhir:ExplanationOfBenefit.benefitBalance.financial.benefitUnsignedInt [ unsignedInt ] fhir:ExplanationOfBenefit.benefitBalance.financial.benefitString [ string ] fhir:ExplanationOfBenefit.benefitBalance.financial.benefitMoney [ Money ] # ExplanationOfBenefit.benefitBalance.financial.benefitUsed[x] : 0..1 Benefits used. One of these 2 fhir:ExplanationOfBenefit.benefitBalance.financial.benefitUsedUnsignedInt [ unsignedInt ] fhir:ExplanationOfBenefit.benefitBalance.financial.benefitUsedMoney [ Money ] ], ...; ], ...; ]
Changes since DSTU2
ExplanationOfBenefit | |
ExplanationOfBenefit.status | added |
ExplanationOfBenefit.author[x] | added |
ExplanationOfBenefit.claim[x] | added |
ExplanationOfBenefit.claimResponse[x] | added |
ExplanationOfBenefit.type | added |
ExplanationOfBenefit.subType | added |
ExplanationOfBenefit.billablePeriod | added |
ExplanationOfBenefit.outcome |
Type changed from code to Coding Remove Binding http://hl7.org/fhir/ValueSet/remittance-outcome (required) |
ExplanationOfBenefit.provider[x] | added |
ExplanationOfBenefit.organization[x] |
Renamed from organization to organization[x] Add Identifier |
ExplanationOfBenefit.facility[x] | added |
ExplanationOfBenefit.related | added |
ExplanationOfBenefit.related.claim[x] | added |
ExplanationOfBenefit.related.relationship | added |
ExplanationOfBenefit.related.reference | added |
ExplanationOfBenefit.prescription[x] | added |
ExplanationOfBenefit.originalPrescription[x] | added |
ExplanationOfBenefit.payee | added |
ExplanationOfBenefit.payee.type | added |
ExplanationOfBenefit.payee.resourceType | added |
ExplanationOfBenefit.payee.party[x] | added |
ExplanationOfBenefit.referral[x] | added |
ExplanationOfBenefit.information | added |
ExplanationOfBenefit.information.category | added |
ExplanationOfBenefit.information.code | added |
ExplanationOfBenefit.information.timing[x] | added |
ExplanationOfBenefit.information.value[x] | added |
ExplanationOfBenefit.diagnosis | added |
ExplanationOfBenefit.diagnosis.sequence | added |
ExplanationOfBenefit.diagnosis.diagnosis | added |
ExplanationOfBenefit.diagnosis.type | added |
ExplanationOfBenefit.diagnosis.drg | added |
ExplanationOfBenefit.procedure | added |
ExplanationOfBenefit.procedure.sequence | added |
ExplanationOfBenefit.procedure.date | added |
ExplanationOfBenefit.procedure.procedure[x] | added |
ExplanationOfBenefit.patient[x] | added |
ExplanationOfBenefit.precedence | added |
ExplanationOfBenefit.coverage | added |
ExplanationOfBenefit.coverage.coverage[x] | added |
ExplanationOfBenefit.coverage.preAuthRef | added |
ExplanationOfBenefit.accident | added |
ExplanationOfBenefit.accident.date | added |
ExplanationOfBenefit.accident.type | added |
ExplanationOfBenefit.accident.location[x] | added |
ExplanationOfBenefit.employmentImpacted | added |
ExplanationOfBenefit.hospitalization | added |
ExplanationOfBenefit.item | added |
ExplanationOfBenefit.item.sequence | added |
ExplanationOfBenefit.item.careTeam | added |
ExplanationOfBenefit.item.careTeam.provider[x] | added |
ExplanationOfBenefit.item.careTeam.responsible | added |
ExplanationOfBenefit.item.careTeam.role | added |
ExplanationOfBenefit.item.careTeam.qualification | added |
ExplanationOfBenefit.item.diagnosisLinkId | added |
ExplanationOfBenefit.item.revenue | added |
ExplanationOfBenefit.item.category | added |
ExplanationOfBenefit.item.service | added |
ExplanationOfBenefit.item.modifier | added |
ExplanationOfBenefit.item.programCode | added |
ExplanationOfBenefit.item.serviced[x] | added |
ExplanationOfBenefit.item.location[x] | added |
ExplanationOfBenefit.item.quantity | added |
ExplanationOfBenefit.item.unitPrice | added |
ExplanationOfBenefit.item.factor | added |
ExplanationOfBenefit.item.points | added |
ExplanationOfBenefit.item.net | added |
ExplanationOfBenefit.item.udi | added |
ExplanationOfBenefit.item.bodySite | added |
ExplanationOfBenefit.item.subSite | added |
ExplanationOfBenefit.item.noteNumber | added |
ExplanationOfBenefit.item.adjudication | added |
ExplanationOfBenefit.item.adjudication.category | added |
ExplanationOfBenefit.item.adjudication.reason | added |
ExplanationOfBenefit.item.adjudication.amount | added |
ExplanationOfBenefit.item.adjudication.value | added |
ExplanationOfBenefit.item.detail | added |
ExplanationOfBenefit.item.detail.sequence | added |
ExplanationOfBenefit.item.detail.type | added |
ExplanationOfBenefit.item.detail.revenue | added |
ExplanationOfBenefit.item.detail.category | added |
ExplanationOfBenefit.item.detail.service | added |
ExplanationOfBenefit.item.detail.modifier | added |
ExplanationOfBenefit.item.detail.programCode | added |
ExplanationOfBenefit.item.detail.quantity | added |
ExplanationOfBenefit.item.detail.unitPrice | added |
ExplanationOfBenefit.item.detail.factor | added |
ExplanationOfBenefit.item.detail.points | added |
ExplanationOfBenefit.item.detail.net | added |
ExplanationOfBenefit.item.detail.udi | added |
ExplanationOfBenefit.item.detail.noteNumber | added |
ExplanationOfBenefit.item.detail.adjudication | added |
ExplanationOfBenefit.item.detail.subDetail | added |
ExplanationOfBenefit.item.detail.subDetail.sequence | added |
ExplanationOfBenefit.item.detail.subDetail.type | added |
ExplanationOfBenefit.item.detail.subDetail.revenue | added |
ExplanationOfBenefit.item.detail.subDetail.category | added |
ExplanationOfBenefit.item.detail.subDetail.service | added |
ExplanationOfBenefit.item.detail.subDetail.modifier | added |
ExplanationOfBenefit.item.detail.subDetail.programCode | added |
ExplanationOfBenefit.item.detail.subDetail.quantity | added |
ExplanationOfBenefit.item.detail.subDetail.unitPrice | added |
ExplanationOfBenefit.item.detail.subDetail.factor | added |
ExplanationOfBenefit.item.detail.subDetail.points | added |
ExplanationOfBenefit.item.detail.subDetail.net | added |
ExplanationOfBenefit.item.detail.subDetail.udi | added |
ExplanationOfBenefit.item.detail.subDetail.noteNumber | added |
ExplanationOfBenefit.item.detail.subDetail.adjudication | added |
ExplanationOfBenefit.item.prosthesis | added |
ExplanationOfBenefit.item.prosthesis.initial | added |
ExplanationOfBenefit.item.prosthesis.priorDate | added |
ExplanationOfBenefit.item.prosthesis.priorMaterial | added |
ExplanationOfBenefit.addItem | added |
ExplanationOfBenefit.addItem.sequenceLinkId | added |
ExplanationOfBenefit.addItem.revenue | added |
ExplanationOfBenefit.addItem.category | added |
ExplanationOfBenefit.addItem.service | added |
ExplanationOfBenefit.addItem.modifier | added |
ExplanationOfBenefit.addItem.fee | added |
ExplanationOfBenefit.addItem.noteNumber | added |
ExplanationOfBenefit.addItem.adjudication | added |
ExplanationOfBenefit.addItem.detail | added |
ExplanationOfBenefit.addItem.detail.revenue | added |
ExplanationOfBenefit.addItem.detail.category | added |
ExplanationOfBenefit.addItem.detail.service | added |
ExplanationOfBenefit.addItem.detail.modifier | added |
ExplanationOfBenefit.addItem.detail.fee | added |
ExplanationOfBenefit.addItem.detail.noteNumber | added |
ExplanationOfBenefit.addItem.detail.adjudication | added |
ExplanationOfBenefit.missingTeeth | added |
ExplanationOfBenefit.missingTeeth.tooth | added |
ExplanationOfBenefit.missingTeeth.reason | added |
ExplanationOfBenefit.missingTeeth.extractionDate | added |
ExplanationOfBenefit.totalCost | added |
ExplanationOfBenefit.unallocDeductable | added |
ExplanationOfBenefit.totalBenefit | added |
ExplanationOfBenefit.payment | added |
ExplanationOfBenefit.payment.type | added |
ExplanationOfBenefit.payment.adjustment | added |
ExplanationOfBenefit.payment.adjustmentReason | added |
ExplanationOfBenefit.payment.date | added |
ExplanationOfBenefit.payment.amount | added |
ExplanationOfBenefit.payment.identifier | added |
ExplanationOfBenefit.form | added |
ExplanationOfBenefit.note | added |
ExplanationOfBenefit.note.number | added |
ExplanationOfBenefit.note.type | added |
ExplanationOfBenefit.note.text | added |
ExplanationOfBenefit.note.language | added |
ExplanationOfBenefit.benefitBalance | added |
ExplanationOfBenefit.benefitBalance.category | added |
ExplanationOfBenefit.benefitBalance.subCategory | added |
ExplanationOfBenefit.benefitBalance.name | added |
ExplanationOfBenefit.benefitBalance.description | added |
ExplanationOfBenefit.benefitBalance.network | added |
ExplanationOfBenefit.benefitBalance.unit | added |
ExplanationOfBenefit.benefitBalance.term | added |
ExplanationOfBenefit.benefitBalance.financial | added |
ExplanationOfBenefit.benefitBalance.financial.type | added |
ExplanationOfBenefit.benefitBalance.financial.benefit[x] | added |
ExplanationOfBenefit.benefitBalance.financial.benefitUsed[x] | added |
ExplanationOfBenefit.request | deleted |
ExplanationOfBenefit.requestProvider | deleted |
ExplanationOfBenefit.requestOrganization | deleted |
See the Full Difference for further information
Alternate definitions: Master Definition (XML, JSON), XML Schema/Schematron (for ) + JSON Schema, ShEx (for Turtle)
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 | Required | Example Claim Type Codes |
ExplanationOfBenefit.subType | A more granulat claim typecode | Example | Example Claim SubType Codes |
ExplanationOfBenefit.ruleset ExplanationOfBenefit.originalRuleset | The static and dynamic model to which contents conform, which may be business version or standard/version. | Example | Ruleset Codes |
ExplanationOfBenefit.outcome | The result of the claim processing | Example | 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 | Payee Type Codes |
ExplanationOfBenefit.payee.resourceType | The type of payee Resource | Required | 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.diagnosis.diagnosis | 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.drg | 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. | Required | ActIncidentCode |
ExplanationOfBenefit.item.careTeam.role | The role codes for the care team members. | Example | Claim Care Team Role Codes |
ExplanationOfBenefit.item.careTeam.qualification | Provider professional qualifications | Example | Example Provider Qualification Codes |
ExplanationOfBenefit.item.revenue ExplanationOfBenefit.item.detail.revenue ExplanationOfBenefit.item.detail.subDetail.revenue ExplanationOfBenefit.addItem.revenue ExplanationOfBenefit.addItem.detail.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.addItem.category ExplanationOfBenefit.addItem.detail.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 ExplanationOfBenefit.addItem.detail.service | Allowable service and product codes | Example | USCLS Codes |
ExplanationOfBenefit.item.modifier ExplanationOfBenefit.item.detail.modifier ExplanationOfBenefit.item.detail.subDetail.modifier ExplanationOfBenefit.addItem.modifier ExplanationOfBenefit.addItem.detail.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 | The adjudication codes. | Extensible | Adjudication Codes |
ExplanationOfBenefit.item.adjudication.reason | Adjudication reason codes. | Extensible | Adjudication Reason Codes |
ExplanationOfBenefit.item.detail.type ExplanationOfBenefit.item.detail.subDetail.type | Service, Product, Rx Dispense, Rx Compound etc. | Required | ActInvoiceGroupCode |
ExplanationOfBenefit.item.prosthesis.priorMaterial | Material of the prior denture or bridge prosthesis. (Oral) | Example | Oral Prostho Material type Codes |
ExplanationOfBenefit.missingTeeth.tooth | The codes for the teeth, subset of OralSites | Example | Teeth Codes |
ExplanationOfBenefit.missingTeeth.reason | Reason codes for the missing teeth | Example | Missing Tooth Reason Codes |
ExplanationOfBenefit.payment.type | The type (partial, complete) of the payment | Example | Example Payment Type Codes |
ExplanationOfBenefit.payment.adjustmentReason | Payment Adjustment reason codes. | Extensible | Payment Adjustment Reason Codes |
ExplanationOfBenefit.form | The forms codes. | Required | Form Codes |
ExplanationOfBenefit.note.type | The presentation types of notes. | Required | NoteType |
ExplanationOfBenefit.note.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 | Paths |
claimidentifier | token | The reference to the claim | ExplanationOfBenefit.claimIdentifier |
claimreference | reference | The reference to the claim | ExplanationOfBenefit.claimReference (Claim) |
created | date | The creation date for the EOB | ExplanationOfBenefit.created |
disposition | string | The contents of the disposition message | ExplanationOfBenefit.disposition |
facilityidentifier | token | Facility responsible for the goods and services | ExplanationOfBenefit.facilityIdentifier |
facilityreference | reference | Facility responsible for the goods and services | ExplanationOfBenefit.facilityReference (Location) |
identifier | token | The business identifier of the Explanation of Benefit | ExplanationOfBenefit.identifier |
organizationidentifier | token | The reference to the providing organization | ExplanationOfBenefit.organizationIdentifier |
organizationreference | reference | The reference to the providing organization | ExplanationOfBenefit.organizationReference (Organization) |
patientidentifier | token | The reference to the patient | ExplanationOfBenefit.patientIdentifier |
patientreference | reference | The reference to the patient | ExplanationOfBenefit.patientReference (Patient) |
provideridentifier | token | The reference to the provider | ExplanationOfBenefit.providerIdentifier |
providerreference | reference | The reference to the provider | ExplanationOfBenefit.providerReference (Practitioner) |