Patient Cost Transparency Implementation Guide
2.0.2 - STU 2 United States of America flag

Patient Cost Transparency Implementation Guide, published by HL7 International / Financial Management. This guide is not an authorized publication; it is the continuous build for version 2.0.2 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/HL7/davinci-pct/ and changes regularly. See the Directory of published versions

Resource Profile: PCT Advanced EOB Summary - Detailed Descriptions

Page standards status: Trial-use Maturity Level: 1

Definitions for the davinci-pct-aeob-summary resource profile

See the documentation on how to interpret the contents of this table

0. ExplanationOfBenefit
Definition

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.

ShortExplanation of Benefit resource
Control0..*
Is Modifierfalse
Summaryfalse
Alternate NamesEOB
Invariantsdom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources (contained.contained.empty())
dom-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource (contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty())
dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated (contained.meta.versionId.empty() and contained.meta.lastUpdated.empty())
dom-5: If a resource is contained in another resource, it SHALL NOT have a security label (contained.meta.security.empty())
dom-6: A resource should have narrative for robust management (text.`div`.exists())
2. ExplanationOfBenefit.implicitRules
Definition

A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.

ShortA set of rules under which this content was created
Comments

Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of it's narrative along with other profiles, value sets, etc.

Control0..1
Typeuri
Is Modifiertrue because This element is labeled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies it's meaning or interpretation
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
4. ExplanationOfBenefit.extension
Definition

An Extension


May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

ShortExtensionAdditional content defined by implementations
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

Control0..*
TypeExtension
Is Modifierfalse
Summaryfalse
Alternate Namesextensions, user content
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
SlicingThis element introduces a set of slices on ExplanationOfBenefit.extension. The slices are Unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
6. ExplanationOfBenefit.extension:serviceDescription
Slice NameserviceDescription
Definition

This extension is used to communicate a plain language description of the procedure, product, or service.

ShortService Description
Control0..1
This element is affected by the following invariants: ele-1
TypeExtension(Service Description) (Extension Type: string)
Is Modifierfalse
Must Supporttrue
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
8. ExplanationOfBenefit.extension:outOfNetworkProviderInfo
Slice NameoutOfNetworkProviderInfo
Definition

This extension provides a payer link to information enabling the patient to find providers that are in network for the requested services.

ShortIn Network Provider Options Link
Control0..1
This element is affected by the following invariants: ele-1
TypeExtension(In Network Provider Options Link) (Extension Type: url)
Is Modifierfalse
Must Supporttrue
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
10. ExplanationOfBenefit.modifierExtension
Definition

May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

ShortExtensions that cannot be ignored
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

Control0..*
TypeExtension
Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the resource that contains them
Summaryfalse
Requirements

Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

Alternate Namesextensions, user content
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
12. ExplanationOfBenefit.status
Definition

The status of the resource instance.

Shortactive | cancelled | draft | entered-in-error
Comments

This element is labeled as a modifier because the status contains codes that mark the resource as not currently valid.

Control1..1
BindingThe codes SHALL be taken from ExplanationOfBenefitStatushttp://hl7.org/fhir/ValueSet/explanationofbenefit-status|4.0.1
(required to http://hl7.org/fhir/ValueSet/explanationofbenefit-status|4.0.1)

A code specifying the state of the resource instance.

Typecode
Is Modifiertrue because This element is labeled as a modifier because it is a status element that contains status entered-in-error which means that the resource should not be treated as valid
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Requirements

Need to track the status of the resource as 'draft' resources may undergo further edits while 'active' resources are immutable and may only have their status changed to 'cancelled'.

Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
14. ExplanationOfBenefit.type
Definition

The category of claim, e.g. oral, pharmacy, vision, institutional, professional.

ShortCategory or discipline
Comments

The majority of jurisdictions use: oral, pharmacy, vision, professional and institutional, or variants on those terms, as the general styles of claims. The valueset is extensible to accommodate other jurisdictional requirements.

Control1..1
BindingUnless not suitable, these codes SHALL be taken from ClaimTypeCodeshttp://hl7.org/fhir/ValueSet/claim-type|4.0.1
(extensible to http://hl7.org/fhir/ValueSet/claim-type|4.0.1)

The type or discipline-style of the claim.

TypeCodeableConcept
Is Modifierfalse
Summarytrue
Requirements

Claim type determine the general sets of business rules applied for information requirements and adjudication.

Pattern Value
{
  "coding" : [
    {
      "system" : "http://hl7.org/fhir/us/davinci-pct/CodeSystem/PCTEstimateTypeSummaryCSTemporaryTrialUse",
      "code" : "estimate-summary"
    }
  ]
}
<type>
  <coding>
    <system value="http://hl7.org/fhir/us/davinci-pct/CodeSystem/PCTEstimateTypeSummaryCSTemporaryTrialUse"/>
    <code value="estimate-summary"/>
  </coding>
</type>
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
16. ExplanationOfBenefit.subType
Definition

A finer grained suite of claim type codes which may convey additional information such as Inpatient vs Outpatient and/or a specialty service.

ShortMore granular claim type
Comments

This may contain the local bill type codes such as the US UB-04 bill type code.

Control0..01
BindingFor example codes, see ExampleClaimSubTypeCodeshttp://hl7.org/fhir/ValueSet/claim-subtype|4.0.1
(example to http://hl7.org/fhir/ValueSet/claim-subtype|4.0.1)

A more granular claim typecode.

TypeCodeableConcept
Is Modifierfalse
Summaryfalse
Requirements

Some jurisdictions need a finer grained claim type for routing and adjudication.

Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
18. ExplanationOfBenefit.use
Definition

A code to indicate whether the nature of the request is: to request adjudication of products and services previously rendered; or requesting authorization and adjudication for provision in the future; or requesting the non-binding adjudication of the listed products and services which could be provided in the future.

Shortclaim | preauthorization | predetermination
Control1..1
BindingThe codes SHALL be taken from Usehttp://hl7.org/fhir/ValueSet/claim-use|4.0.1
(required to http://hl7.org/fhir/ValueSet/claim-use|4.0.1)

Complete, proposed, exploratory, other.

Typecode
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Requirements

This element is required to understand the nature of the request for adjudication.

Pattern Value
{
  "use" : "predetermination"
}
<use value="predetermination"/>
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
20. ExplanationOfBenefit.patient
Definition

The party to whom the professional services and/or products have been supplied or are being considered and for whom actual for forecast reimbursement is sought.

ShortThe recipient of the products and services
Control1..1
TypeReference(US Core Patient Profile, Patient)
Is Modifierfalse
Summarytrue
Requirements

The patient must be supplied to the insurer so that confirmation of coverage and service history may be considered as part of the authorization and/or adjudiction.

Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
22. ExplanationOfBenefit.billablePeriod
Definition

The period for which charges are being submitted.

ShortThe full Period of Care for all services or products included in the estimate from the first event to the last event.Relevant time frame for the claim
Comments

Typically this would be today or in the past for a claim, and today or in the future for preauthorizations and prodeterminations. Typically line item dates of service should fall within the billing period if one is specified.

Control10..1
TypePeriod
Is Modifierfalse
Summarytrue
Requirements

A number jurisdictions required the submission of the billing period when submitting claims for example for hospital stays or long-term care.

Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
24. ExplanationOfBenefit.created
Definition

The date this resource was created.

ShortThe date and time this summary was generated.Response creation date
Comments

The date and time this summary was generated based on what was known at that point in time.


This field is independent of the date of creation of the resource as it may reflect the creation date of a source document prior to digitization. Typically for claims all services must be completed as of this date.

Control1..1
TypedateTime
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Requirements

Need to record a timestamp for use by both the recipient and the issuer.

Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
26. ExplanationOfBenefit.enterer
Definition

Individual who created the claim, predetermination or preauthorization.

ShortAuthor of the claim
Control0..01
TypeReference(Practitioner, PractitionerRole)
Is Modifierfalse
Summaryfalse
Requirements

Some jurisdictions require the contact information for personnel completing claims.

Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
28. ExplanationOfBenefit.insurer
Definition

The party responsible for authorization, adjudication and reimbursement.

ShortParty responsible for reimbursement
Control1..1
TypeReference(PCT Organization, Organization)
Is Modifierfalse
Summarytrue
Requirements

To be a valid claim, preauthorization or predetermination there must be a party who is responsible for adjudicating the contents against a policy which provides benefits for the patient.

Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
30. ExplanationOfBenefit.provider
Definition

The provider which is responsible for the claim, predetermination or preauthorization.

ShortParty responsible for the claim
Comments

Typically this field would be 1..1 where this party is responsible for the claim but not necessarily professionally responsible for the provision of the individual products and services listed below.

Control1..1
TypeReference(Practitioner, PractitionerRole, Organization)
Is Modifierfalse
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
32. ExplanationOfBenefit.provider.extension
Definition

An Extension


May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

ShortExtensionAdditional content defined by implementations
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

Control10..*
TypeExtension
Is Modifierfalse
Summaryfalse
Alternate Namesextensions, user content
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
SlicingThis element introduces a set of slices on ExplanationOfBenefit.provider.extension. The slices are Unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
34. ExplanationOfBenefit.provider.extension:dataAbsentReason
Slice NamedataAbsentReason
Definition

Provides a reason why the expected value or elements in the element that is extended are missing.

Shortunknown | asked | temp | notasked | masked | unsupported | astext | error
Control1..1
TypeExtension(Data Absent Reason) (Extension Type: code)
Is Modifierfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
36. ExplanationOfBenefit.provider.extension:dataAbsentReason.extension
Definition

An Extension


May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

ShortExtensionAdditional content defined by implementations
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

Control0..0*
TypeExtension
Is Modifierfalse
Summaryfalse
Alternate Namesextensions, user content
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
SlicingThis element introduces a set of slices on ExplanationOfBenefit.provider.extension.extension. The slices are Unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
38. ExplanationOfBenefit.provider.extension:dataAbsentReason.url
Definition

Source of the definition for the extension code - a logical name or a URL.

Shortidentifies the meaning of the extension
Comments

The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension.

Control1..1
Typeuri
Is Modifierfalse
XML FormatIn the XML format, this property is represented as an attribute.
Summaryfalse
Fixed Value
{
  "url" : "http://hl7.org/fhir/StructureDefinition/data-absent-reason"
}
<url value="http://hl7.org/fhir/StructureDefinition/data-absent-reason"/>
40. ExplanationOfBenefit.provider.extension:dataAbsentReason.value[x]
Definition

Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).

ShortValue of extension
Control10..1
BindingThe codes SHALL be taken from For codes, see DataAbsentReason
(required to http://hl7.org/fhir/ValueSet/data-absent-reason)
Typecode, date, Meta, Address, Attachment, integer, Count, DataRequirement, Dosage, uuid, Identifier, Coding, SampledData, id, positiveInt, Distance, Period, Duration, canonical, Range, RelatedArtifact, base64Binary, UsageContext, Timing, decimal, CodeableConcept, ParameterDefinition, dateTime, string, Contributor, oid, instant, ContactPoint, HumanName, Money, markdown, Ratio, Age, Reference, TriggerDefinition, Quantity, uri, url, Annotation, ContactDetail, boolean, Expression, Signature, unsignedInt, time
[x] NoteSeeChoice of Data Typesfor further information about how to use [x]
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summaryfalse
Pattern Value
{
  "valueCode" : "not-applicable"
}
<valueCode value="not-applicable"/>
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
42. ExplanationOfBenefit.provider.reference
Definition

A reference to a location at which the other resource is found. The reference may be a relative reference, in which case it is relative to the service base URL, or an absolute URL that resolves to the location where the resource is found. The reference may be version specific or not. If the reference is not to a FHIR RESTful server, then it should be assumed to be version specific. Internal fragment references (start with '#') refer to contained resources.

ShortLiteral reference, Relative, internal or absolute URL
Comments

Using absolute URLs provides a stable scalable approach suitable for a cloud/web context, while using relative/logical references provides a flexible approach suitable for use when trading across closed eco-system boundaries. Absolute URLs do not need to point to a FHIR RESTful server, though this is the preferred approach. If the URL conforms to the structure "/[type]/[id]" then it should be assumed that the reference is to a FHIR RESTful server.

Control0..01
This element is affected by the following invariants: ref-1
Typestring
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
44. ExplanationOfBenefit.provider.type
Definition

The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent.

The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources).

ShortType the reference refers to (e.g. "Patient")
Comments

This element is used to indicate the type of the target of the reference. This may be used which ever of the other elements are populated (or not). In some cases, the type of the target may be determined by inspection of the reference (e.g. a RESTful URL) or by resolving the target of the reference; if both the type and a reference is provided, the reference SHALL resolve to a resource of the same type as that specified.

Control0..01
BindingUnless not suitable, these codes SHALL be taken from ResourceTypehttp://hl7.org/fhir/ValueSet/resource-types|4.0.1
(extensible to http://hl7.org/fhir/ValueSet/resource-types|4.0.1)

Aa resource (or, for logical models, the URI of the logical model).

Typeuri
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
46. ExplanationOfBenefit.provider.identifier
Definition

An identifier for the target resource. This is used when there is no way to reference the other resource directly, either because the entity it represents is not available through a FHIR server, or because there is no way for the author of the resource to convert a known identifier to an actual location. There is no requirement that a Reference.identifier point to something that is actually exposed as a FHIR instance, but it SHALL point to a business concept that would be expected to be exposed as a FHIR instance, and that instance would need to be of a FHIR resource type allowed by the reference.

ShortLogical reference, when literal reference is not known
Comments

When an identifier is provided in place of a reference, any system processing the reference will only be able to resolve the identifier to a reference if it understands the business context in which the identifier is used. Sometimes this is global (e.g. a national identifier) but often it is not. For this reason, none of the useful mechanisms described for working with references (e.g. chaining, includes) are possible, nor should servers be expected to be able resolve the reference. Servers may accept an identifier based reference untouched, resolve it, and/or reject it - see CapabilityStatement.rest.resource.referencePolicy.

When both an identifier and a literal reference are provided, the literal reference is preferred. Applications processing the resource are allowed - but not required - to check that the identifier matches the literal reference

Applications converting a logical reference to a literal reference may choose to leave the logical reference present, or remove it.

Reference is intended to point to a structure that can potentially be expressed as a FHIR resource, though there is no need for it to exist as an actual FHIR resource instance - except in as much as an application wishes to actual find the target of the reference. The content referred to be the identifier must meet the logical constraints implied by any limitations on what resource types are permitted for the reference. For example, it would not be legitimate to send the identifier for a drug prescription if the type were Reference(Observation|DiagnosticReport). One of the use-cases for Reference.identifier is the situation where no FHIR representation exists (where the type is Reference (Any).

NoteThis is a business identifier, not a resource identifier (see discussion)
Control0..01
TypeIdentifier
Is Modifierfalse
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
48. ExplanationOfBenefit.provider.display
Definition

Plain text narrative that identifies the resource in addition to the resource reference.

ShortText alternative for the resource
Comments

This is generally not the same as the Resource.text of the referenced resource. The purpose is to identify what's being referenced, not to fully describe it.

Control0..01
Typestring
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
50. ExplanationOfBenefit.priority
Definition

The provider-required urgency of processing the request. Typical values include: stat, routine deferred.

ShortDesired processing urgency
Comments

If a claim processor is unable to complete the processing as per the priority then they should generate and error and not process the request.

Control0..1
BindingThe codes SHALL be taken from For example codes, see ProcessPriorityCodeshttp://hl7.org/fhir/ValueSet/process-priority|4.0.1
(required to http://hl7.org/fhir/ValueSet/process-priority)
TypeCodeableConcept
Is Modifierfalse
Summaryfalse
Requirements

The provider may need to indicate their processing requirements so that the processor can indicate if they are unable to comply.

Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
52. ExplanationOfBenefit.fundsReserveRequested
Definition

A code to indicate whether and for whom funds are to be reserved for future claims.

ShortFor whom to reserve funds
Comments

This field is only used for preauthorizations.

Control0..01
BindingFor example codes, see Funds Reservation Codeshttp://hl7.org/fhir/ValueSet/fundsreserve|4.0.1
(example to http://hl7.org/fhir/ValueSet/fundsreserve|4.0.1)

For whom funds are to be reserved: (Patient, Provider, None).

TypeCodeableConcept
Is Modifierfalse
Summaryfalse
Requirements

In the case of a Pre-Determination/Pre-Authorization the provider may request that funds in the amount of the expected Benefit be reserved ('Patient' or 'Provider') to pay for the Benefits determined on the subsequent claim(s). 'None' explicitly indicates no funds reserving is requested.

Alternate NamesFund pre-allocation
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
54. ExplanationOfBenefit.fundsReserve
Definition

A code, used only on a response to a preauthorization, to indicate whether the benefits payable have been reserved and for whom.

ShortFunds reserved status
Comments

Fund would be release by a future claim quoting the preAuthRef of this response. Examples of values include: provider, patient, none.

Control0..01
BindingFor example codes, see Funds Reservation Codeshttp://hl7.org/fhir/ValueSet/fundsreserve|4.0.1
(example to http://hl7.org/fhir/ValueSet/fundsreserve|4.0.1)

For whom funds are to be reserved: (Patient, Provider, None).

TypeCodeableConcept
Is Modifierfalse
Summaryfalse
Requirements

Needed to advise the submitting provider on whether the rquest for reservation of funds has been honored.

Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
56. ExplanationOfBenefit.prescription
Definition

Prescription to support the dispensing of pharmacy, device or vision products.

ShortPrescription authorizing services or products
Control0..01
TypeReference(MedicationRequest, VisionPrescription)
Is Modifierfalse
Summaryfalse
Requirements

Required to authorize the dispensing of controlled substances and devices.

Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
58. ExplanationOfBenefit.originalPrescription
Definition

Original prescription which has been superseded by this prescription to support the dispensing of pharmacy services, medications or products.

ShortOriginal prescription if superceded by fulfiller
Comments

For example, a physician may prescribe a medication which the pharmacy determines is contraindicated, or for which the patient has an intolerance, and therefor issues a new prescription for an alternate medication which has the same therapeutic intent. The prescription from the pharmacy becomes the 'prescription' and that from the physician becomes the 'original prescription'.

Control0..01
TypeReference(MedicationRequest)
Is Modifierfalse
Summaryfalse
Requirements

Often required when a fulfiller varies what is fulfilled from that authorized on the original prescription.

Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
60. ExplanationOfBenefit.payee
Definition

The party to be reimbursed for cost of the products and services according to the terms of the policy.

ShortRecipient of benefits payable
Comments

Often providers agree to receive the benefits payable to reduce the near-term costs to the patient. The insurer may decline to pay the provider and may choose to pay the subscriber instead.

Control0..01
TypeBackboneElement
Is Modifierfalse
Summaryfalse
Requirements

The provider needs to specify who they wish to be reimbursed and the claims processor needs express who they will reimburse.

Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
63. ExplanationOfBenefit.referral
Definition

A reference to a referral resource.

ShortTreatment Referral
Comments

The referral resource which lists the date, practitioner, reason and other supporting information.

Control0..01
TypeReference(ServiceRequest)
Is Modifierfalse
Summaryfalse
Requirements

Some insurers require proof of referral to pay for services or to pay specialist rates for services.

Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
65. ExplanationOfBenefit.facility
Definition

Facility where the services were provided.

ShortServicing Facility
Control0..01
TypeReference(Location)
Is Modifierfalse
Summaryfalse
Requirements

Insurance adjudication can be dependant on where services were delivered.

Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
67. ExplanationOfBenefit.claim
Definition

The business identifier for the instance of the adjudication request: claim predetermination or preauthorization.

ShortClaim reference
Control0..01
TypeReference(Claim)
Is Modifierfalse
Summaryfalse
Requirements

To provide a link to the original adjudication request.

Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
69. ExplanationOfBenefit.outcome
Definition

The outcome of the claim, predetermination, or preauthorization processing.

Shortqueued | complete | error | partial
Comments

The resource may be used to indicate that: the request has been held (queued) for processing; that it has been processed and errors found (error); that no errors were found and that some of the adjudication has been undertaken (partial) or that all of the adjudication has been undertaken (complete).

Control1..1
BindingThe codes SHALL be taken from ClaimProcessingCodeshttp://hl7.org/fhir/ValueSet/remittance-outcome|4.0.1
(required to http://hl7.org/fhir/ValueSet/remittance-outcome|4.0.1)

The result of the claim processing.

Typecode
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Requirements

To advise the requestor of an overall processing outcome.

Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
71. ExplanationOfBenefit.preAuthRef
Definition

Reference from the Insurer which is used in later communications which refers to this adjudication.

ShortPreauthorization reference
Comments

This value is only present on preauthorization adjudications.

Control0..0*
Typestring
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summaryfalse
Requirements

On subsequent claims, the insurer may require the provider to quote this value.

Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
73. ExplanationOfBenefit.preAuthRefPeriod
Definition

The timeframe during which the supplied preauthorization reference may be quoted on claims to obtain the adjudication as provided.

ShortPreauthorization in-effect period
Comments

This value is only present on preauthorization adjudications.

Control0..0*
TypePeriod
Is Modifierfalse
Summaryfalse
Requirements

On subsequent claims, the insurer may require the provider to quote this value.

Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
75. ExplanationOfBenefit.supportingInfo
Definition

Additional information codes regarding exceptions, special considerations, the condition, situation, prior or concurrent issues.

ShortSupporting information
Comments

Often there are multiple jurisdiction specific valuesets which are required.

Control0..0*
TypeBackboneElement
Is Modifierfalse
Summaryfalse
Requirements

Typically these information codes are required to support the services rendered or the adjudication of the services rendered.

Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
80. ExplanationOfBenefit.precedence
Definition

This indicates the relative order of a series of EOBs related to different coverages for the same suite of services.

ShortPrecedence (primary, secondary, etc.)
Control0..01
TypepositiveInt
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summaryfalse
Requirements

Needed to coordinate between multiple EOBs for the same suite of services.

Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
82. ExplanationOfBenefit.insurance
Definition

Financial instruments for reimbursement for the health care products and services specified on the claim.

ShortPatient insurance information
Comments

All insurance coverages for the patient which may be applicable for reimbursement, of the products and services listed in the claim, are typically provided in the claim to allow insurers to confirm the ordering of the insurance coverages relative to local 'coordination of benefit' rules. One coverage (and only one) with 'focal=true' is to be used in the adjudication of this claim. Coverages appearing before the focal Coverage in the list, and where 'Coverage.subrogation=false', should provide a reference to the ClaimResponse containing the adjudication results of the prior claim.

Control1..*
TypeBackboneElement
Is Modifierfalse
Summarytrue
Requirements

At least one insurer is required for a claim to be a claim.

Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
84. ExplanationOfBenefit.insurance.modifierExtension
Definition

May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

ShortExtensions that cannot be ignored even if unrecognized
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

Control0..*
TypeExtension
Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
Summarytrue
Requirements

Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

Alternate Namesextensions, user content, modifiers
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
86. ExplanationOfBenefit.insurance.focal
Definition

A flag to indicate that this Coverage is to be used for adjudication of this claim when set to true.

ShortCoverage to be used for adjudication
Comments

A patient may (will) have multiple insurance policies which provide reimbursement for healthcare services and products. For example, a person may also be covered by their spouse's policy and both appear in the list (and may be from the same insurer). This flag will be set to true for only one of the listed policies and that policy will be used for adjudicating this claim. Other claims would be created to request adjudication against the other listed policies.

Control1..1
Typeboolean
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Requirements

To identify which coverage in the list is being used to adjudicate this claim.

Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
88. ExplanationOfBenefit.insurance.coverage
Definition

Reference to the insurance card level information contained in the Coverage resource. The coverage issuing insurer will use these details to locate the patient's actual coverage within the insurer's information system.

ShortInsurance information
Control1..1
TypeReference(PCT Coverage, Coverage)
Is Modifierfalse
Summarytrue
Requirements

Required to allow the adjudicator to locate the correct policy and history within their information system.

Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
90. ExplanationOfBenefit.item
Definition

A claim line. Either a simple (a product or service) or a 'group' of details which can also be a simple items or groups of sub-details.

ShortProduct or service provided
Control0..0*
TypeBackboneElement
Is Modifierfalse
Summaryfalse
Requirements

The items to be processed for adjudication.

Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
95. ExplanationOfBenefit.addItem
Definition

The first-tier service adjudications for payor added product or service lines.

ShortInsurer added line items
Control0..0*
TypeBackboneElement
Is Modifierfalse
Summaryfalse
Requirements

Insurers may redefine the provided product or service or may package and/or decompose groups of products and services. The addItems allows the insurer to provide their line item list with linkage to the submitted items/details/sub-details. In a preauthorization the insurer may use the addItem structure to provide additional information on authorized products and services.

Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
99. ExplanationOfBenefit.adjudication
Definition

The adjudication results which are presented at the header level rather than at the line-item or add-item levels.

ShortHeader-level adjudication
Control0..0*
TypeSeettp://hl7.org/fhir/StructureDefinition/ExplanationOfBenefit#ExplanationOfBenefit.item.adjudication
Is Modifierfalse
Summaryfalse
Requirements

Some insurers will receive line-items but provide the adjudication only at a summary or header-level.

Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
101. ExplanationOfBenefit.total
Definition

Categorized monetary totals for the adjudication.

ShortAdjudication totals
Comments

Totals for amounts submitted, co-pays, benefits payable etc.

Control30..*
TypeBackboneElement
Is Modifierfalse
Summarytrue
Requirements

To provide the requestor with financial totals by category for the adjudication.

Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
SlicingThis element introduces a set of slices on ExplanationOfBenefit.total. The slices are Unordered and Open, and can be differentiated using the following discriminators:
  • value @ category

Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them

103. ExplanationOfBenefit.total.modifierExtension
Definition

May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

ShortExtensions that cannot be ignored even if unrecognized
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

Control0..*
TypeExtension
Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
Summarytrue
Requirements

Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

Alternate Namesextensions, user content, modifiers
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
105. ExplanationOfBenefit.total.category
Definition

A code to indicate the information type of this adjudication record. Information types may include: the value submitted, maximum values or percentages allowed or payable under the plan, amounts that the patient is responsible for in aggregate or pertaining to this item, amounts paid by other coverages, and the benefit payable for this item.

ShortType of adjudication information
Comments

For example, codes indicating: Co-Pay, deductible, eligible, benefit, tax, etc.

Control1..1
BindingUnless not suitable, these codes SHALL be taken from For example codes, see PCT Total Value Sethttp://hl7.org/fhir/ValueSet/adjudication|4.0.1
(extensible to http://hl7.org/fhir/us/davinci-pct/ValueSet/PCTTotal)
TypeCodeableConcept
Is Modifierfalse
Must Supporttrue
Summarytrue
Requirements

Needed to convey the type of total provided.

Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
107. ExplanationOfBenefit.total.amount
Definition

Monetary total amount associated with the category.

ShortFinancial total for the category
Control1..1
TypeMoney
Is Modifierfalse
Summarytrue
Requirements

Needed to convey the total monetary amount.

Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
109. ExplanationOfBenefit.total:submitted
Slice Namesubmitted
Definition

Categorized monetary totals for the adjudication.

ShortTotal provider submitted amountAdjudication totals
Comments

Totals for amounts submitted, co-pays, benefits payable etc.

Control10..1*
TypeBackboneElement
Is Modifierfalse
Must Supporttrue
Summarytrue
Requirements

To provide the requestor with financial totals by category for the adjudication.

Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
111. ExplanationOfBenefit.total:submitted.modifierExtension
Definition

May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

ShortExtensions that cannot be ignored even if unrecognized
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

Control0..*
TypeExtension
Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
Summarytrue
Requirements

Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

Alternate Namesextensions, user content, modifiers
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
113. ExplanationOfBenefit.total:submitted.category
Definition

A code to indicate the information type of this adjudication record. Information types may include: the value submitted, maximum values or percentages allowed or payable under the plan, amounts that the patient is responsible for in aggregate or pertaining to this item, amounts paid by other coverages, and the benefit payable for this item.

ShortType of adjudication information
Comments

For example, codes indicating: Co-Pay, deductible, eligible, benefit, tax, etc.

Control1..1
BindingFor example codes, see AdjudicationValueCodeshttp://hl7.org/fhir/ValueSet/adjudication|4.0.1
(example to http://hl7.org/fhir/ValueSet/adjudication|4.0.1)

The adjudication codes.

TypeCodeableConcept
Is Modifierfalse
Summarytrue
Requirements

Needed to convey the type of total provided.

Pattern Value
{
  "coding" : [
    {
      "system" : "http://terminology.hl7.org/CodeSystem/adjudication",
      "code" : "submitted"
    }
  ]
}
<category>
  <coding>
    <system value="http://terminology.hl7.org/CodeSystem/adjudication"/>
    <code value="submitted"/>
  </coding>
</category>
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
115. ExplanationOfBenefit.total:submitted.amount
Definition

Monetary total amount associated with the category.

ShortFinancial total for the category
Control1..1
TypeMoney
Is Modifierfalse
Summarytrue
Requirements

Needed to convey the total monetary amount.

Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
117. ExplanationOfBenefit.total:memberliability
Slice Namememberliability
Definition

Categorized monetary totals for the adjudication.

ShortTotal member liabilityAdjudication totals
Comments

Totals for amounts submitted, co-pays, benefits payable etc.

Control10..1*
TypeBackboneElement
Is Modifierfalse
Must Supporttrue
Summarytrue
Requirements

To provide the requestor with financial totals by category for the adjudication.

Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
119. ExplanationOfBenefit.total:memberliability.modifierExtension
Definition

May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

ShortExtensions that cannot be ignored even if unrecognized
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

Control0..*
TypeExtension
Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
Summarytrue
Requirements

Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

Alternate Namesextensions, user content, modifiers
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
121. ExplanationOfBenefit.total:memberliability.category
Definition

A code to indicate the information type of this adjudication record. Information types may include: the value submitted, maximum values or percentages allowed or payable under the plan, amounts that the patient is responsible for in aggregate or pertaining to this item, amounts paid by other coverages, and the benefit payable for this item.

ShortType of adjudication information
Comments

For example, codes indicating: Co-Pay, deductible, eligible, benefit, tax, etc.

Control1..1
BindingFor example codes, see AdjudicationValueCodeshttp://hl7.org/fhir/ValueSet/adjudication|4.0.1
(example to http://hl7.org/fhir/ValueSet/adjudication|4.0.1)

The adjudication codes.

TypeCodeableConcept
Is Modifierfalse
Summarytrue
Requirements

Needed to convey the type of total provided.

Pattern Value
{
  "coding" : [
    {
      "system" : "http://hl7.org/fhir/us/davinci-pct/CodeSystem/PCTAdjudicationCategoryCS",
      "code" : "memberliability"
    }
  ]
}
<category>
  <coding>
    <system value="http://hl7.org/fhir/us/davinci-pct/CodeSystem/PCTAdjudicationCategoryCS"/>
    <code value="memberliability"/>
  </coding>
</category>
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
123. ExplanationOfBenefit.total:memberliability.amount
Definition

Monetary total amount associated with the category.

ShortFinancial total for the category
Control1..1
TypeMoney
Is Modifierfalse
Summarytrue
Requirements

Needed to convey the total monetary amount.

Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
125. ExplanationOfBenefit.total:eligible
Slice Nameeligible
Definition

Categorized monetary totals for the adjudication.

ShortTotal eligible amountAdjudication totals
Comments

Eligible is similar to allowed amount. Eligible amount and Benefit amount may be different or the same, but if they are different the payer can supply both for the full picture of the estimate.


Totals for amounts submitted, co-pays, benefits payable etc.

Control10..1*
TypeBackboneElement
Is Modifierfalse
Must Supporttrue
Summarytrue
Requirements

To provide the requestor with financial totals by category for the adjudication.

Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
127. ExplanationOfBenefit.total:eligible.modifierExtension
Definition

May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

ShortExtensions that cannot be ignored even if unrecognized
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

Control0..*
TypeExtension
Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
Summarytrue
Requirements

Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

Alternate Namesextensions, user content, modifiers
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
129. ExplanationOfBenefit.total:eligible.category
Definition

A code to indicate the information type of this adjudication record. Information types may include: the value submitted, maximum values or percentages allowed or payable under the plan, amounts that the patient is responsible for in aggregate or pertaining to this item, amounts paid by other coverages, and the benefit payable for this item.

ShortType of adjudication information
Comments

For example, codes indicating: Co-Pay, deductible, eligible, benefit, tax, etc.

Control1..1
BindingFor example codes, see AdjudicationValueCodeshttp://hl7.org/fhir/ValueSet/adjudication|4.0.1
(example to http://hl7.org/fhir/ValueSet/adjudication|4.0.1)

The adjudication codes.

TypeCodeableConcept
Is Modifierfalse
Summarytrue
Requirements

Needed to convey the type of total provided.

Pattern Value
{
  "coding" : [
    {
      "system" : "http://terminology.hl7.org/CodeSystem/adjudication",
      "code" : "eligible"
    }
  ]
}
<category>
  <coding>
    <system value="http://terminology.hl7.org/CodeSystem/adjudication"/>
    <code value="eligible"/>
  </coding>
</category>
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
131. ExplanationOfBenefit.total:eligible.amount
Definition

Monetary total amount associated with the category.

ShortFinancial total for the category
Control1..1
TypeMoney
Is Modifierfalse
Summarytrue
Requirements

Needed to convey the total monetary amount.

Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
133. ExplanationOfBenefit.total:innetwork
Slice Nameinnetwork
Definition

Categorized monetary totals for the adjudication.

ShortTotal in network amount - only include when total type is applicableAdjudication totals
Comments

Totals for amounts submitted, co-pays, benefits payable etc.

Control0..1*
TypeBackboneElement
Is Modifierfalse
Must Supporttrue
Summarytrue
Requirements

To provide the requestor with financial totals by category for the adjudication.

Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
135. ExplanationOfBenefit.total:innetwork.modifierExtension
Definition

May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

ShortExtensions that cannot be ignored even if unrecognized
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

Control0..*
TypeExtension
Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
Summarytrue
Requirements

Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

Alternate Namesextensions, user content, modifiers
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
137. ExplanationOfBenefit.total:innetwork.category
Definition

A code to indicate the information type of this adjudication record. Information types may include: the value submitted, maximum values or percentages allowed or payable under the plan, amounts that the patient is responsible for in aggregate or pertaining to this item, amounts paid by other coverages, and the benefit payable for this item.

ShortType of adjudication information
Comments

For example, codes indicating: Co-Pay, deductible, eligible, benefit, tax, etc.

Control1..1
BindingFor example codes, see AdjudicationValueCodeshttp://hl7.org/fhir/ValueSet/adjudication|4.0.1
(example to http://hl7.org/fhir/ValueSet/adjudication|4.0.1)

The adjudication codes.

TypeCodeableConcept
Is Modifierfalse
Summarytrue
Requirements

Needed to convey the type of total provided.

Pattern Value
{
  "coding" : [
    {
      "system" : "http://hl7.org/fhir/us/davinci-pct/CodeSystem/PCTNetworkStatusCS",
      "code" : "innetwork"
    }
  ]
}
<category>
  <coding>
    <system value="http://hl7.org/fhir/us/davinci-pct/CodeSystem/PCTNetworkStatusCS"/>
    <code value="innetwork"/>
  </coding>
</category>
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
139. ExplanationOfBenefit.total:innetwork.amount
Definition

Monetary total amount associated with the category.

ShortFinancial total for the category
Control1..1
TypeMoney
Is Modifierfalse
Summarytrue
Requirements

Needed to convey the total monetary amount.

Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
141. ExplanationOfBenefit.total:outofnetwork
Slice Nameoutofnetwork
Definition

Categorized monetary totals for the adjudication.

ShortTotal out of network amount - only include when total type is applicableAdjudication totals
Comments

Totals for amounts submitted, co-pays, benefits payable etc.

Control0..1*
TypeBackboneElement
Is Modifierfalse
Must Supporttrue
Summarytrue
Requirements

To provide the requestor with financial totals by category for the adjudication.

Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
143. ExplanationOfBenefit.total:outofnetwork.modifierExtension
Definition

May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

ShortExtensions that cannot be ignored even if unrecognized
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

Control0..*
TypeExtension
Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
Summarytrue
Requirements

Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

Alternate Namesextensions, user content, modifiers
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
145. ExplanationOfBenefit.total:outofnetwork.category
Definition

A code to indicate the information type of this adjudication record. Information types may include: the value submitted, maximum values or percentages allowed or payable under the plan, amounts that the patient is responsible for in aggregate or pertaining to this item, amounts paid by other coverages, and the benefit payable for this item.

ShortType of adjudication information
Comments

For example, codes indicating: Co-Pay, deductible, eligible, benefit, tax, etc.

Control1..1
BindingFor example codes, see AdjudicationValueCodeshttp://hl7.org/fhir/ValueSet/adjudication|4.0.1
(example to http://hl7.org/fhir/ValueSet/adjudication|4.0.1)

The adjudication codes.

TypeCodeableConcept
Is Modifierfalse
Summarytrue
Requirements

Needed to convey the type of total provided.

Pattern Value
{
  "coding" : [
    {
      "system" : "http://hl7.org/fhir/us/davinci-pct/CodeSystem/PCTNetworkStatusCS",
      "code" : "outofnetwork"
    }
  ]
}
<category>
  <coding>
    <system value="http://hl7.org/fhir/us/davinci-pct/CodeSystem/PCTNetworkStatusCS"/>
    <code value="outofnetwork"/>
  </coding>
</category>
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
147. ExplanationOfBenefit.total:outofnetwork.amount
Definition

Monetary total amount associated with the category.

ShortFinancial total for the category
Control1..1
TypeMoney
Is Modifierfalse
Summarytrue
Requirements

Needed to convey the total monetary amount.

Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
149. ExplanationOfBenefit.total:noncovered
Slice Namenoncovered
Definition

Categorized monetary totals for the adjudication.

ShortTotal noncovered amount - only include when total type is applicableAdjudication totals
Comments

Totals for amounts submitted, co-pays, benefits payable etc.

Control0..1*
TypeBackboneElement
Is Modifierfalse
Must Supporttrue
Summarytrue
Requirements

To provide the requestor with financial totals by category for the adjudication.

Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
151. ExplanationOfBenefit.total:noncovered.modifierExtension
Definition

May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

ShortExtensions that cannot be ignored even if unrecognized
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

Control0..*
TypeExtension
Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
Summarytrue
Requirements

Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

Alternate Namesextensions, user content, modifiers
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
153. ExplanationOfBenefit.total:noncovered.category
Definition

A code to indicate the information type of this adjudication record. Information types may include: the value submitted, maximum values or percentages allowed or payable under the plan, amounts that the patient is responsible for in aggregate or pertaining to this item, amounts paid by other coverages, and the benefit payable for this item.

ShortType of adjudication information
Comments

For example, codes indicating: Co-Pay, deductible, eligible, benefit, tax, etc.

Control1..1
BindingFor example codes, see AdjudicationValueCodeshttp://hl7.org/fhir/ValueSet/adjudication|4.0.1
(example to http://hl7.org/fhir/ValueSet/adjudication|4.0.1)

The adjudication codes.

TypeCodeableConcept
Is Modifierfalse
Summarytrue
Requirements

Needed to convey the type of total provided.

Pattern Value
{
  "coding" : [
    {
      "system" : "http://hl7.org/fhir/us/davinci-pct/CodeSystem/PCTAdjudication",
      "code" : "noncovered"
    }
  ]
}
<category>
  <coding>
    <system value="http://hl7.org/fhir/us/davinci-pct/CodeSystem/PCTAdjudication"/>
    <code value="noncovered"/>
  </coding>
</category>
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
155. ExplanationOfBenefit.total:noncovered.amount
Definition

Monetary total amount associated with the category.

ShortFinancial total for the category
Control1..1
TypeMoney
Is Modifierfalse
Summarytrue
Requirements

Needed to convey the total monetary amount.

Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
157. ExplanationOfBenefit.total:negotiated
Slice Namenegotiated
Definition

Categorized monetary totals for the adjudication.

ShortTotal negotiated amount - Total for special negotiated status for a service or product in relation to a patient's coverage that is established outside of a formal network contractAdjudication totals
Comments

Totals for amounts submitted, co-pays, benefits payable etc.

Control0..1*
TypeBackboneElement
Is Modifierfalse
Must Supporttrue
Summarytrue
Requirements

To provide the requestor with financial totals by category for the adjudication.

Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
159. ExplanationOfBenefit.total:negotiated.modifierExtension
Definition

May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

ShortExtensions that cannot be ignored even if unrecognized
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

Control0..*
TypeExtension
Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
Summarytrue
Requirements

Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

Alternate Namesextensions, user content, modifiers
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
161. ExplanationOfBenefit.total:negotiated.category
Definition

A code to indicate the information type of this adjudication record. Information types may include: the value submitted, maximum values or percentages allowed or payable under the plan, amounts that the patient is responsible for in aggregate or pertaining to this item, amounts paid by other coverages, and the benefit payable for this item.

ShortType of adjudication information
Comments

For example, codes indicating: Co-Pay, deductible, eligible, benefit, tax, etc.

Control1..1
BindingFor example codes, see AdjudicationValueCodeshttp://hl7.org/fhir/ValueSet/adjudication|4.0.1
(example to http://hl7.org/fhir/ValueSet/adjudication|4.0.1)

The adjudication codes.

TypeCodeableConcept
Is Modifierfalse
Summarytrue
Requirements

Needed to convey the type of total provided.

Pattern Value
{
  "coding" : [
    {
      "system" : "http://hl7.org/fhir/us/davinci-pct/CodeSystem/PCTNetworkStatusCS",
      "code" : "negotiated"
    }
  ]
}
<category>
  <coding>
    <system value="http://hl7.org/fhir/us/davinci-pct/CodeSystem/PCTNetworkStatusCS"/>
    <code value="negotiated"/>
  </coding>
</category>
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
163. ExplanationOfBenefit.total:negotiated.amount
Definition

Monetary total amount associated with the category.

ShortFinancial total for the category
Control1..1
TypeMoney
Is Modifierfalse
Summarytrue
Requirements

Needed to convey the total monetary amount.

Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
165. ExplanationOfBenefit.total:benefit
Slice Namebenefit
Definition

Categorized monetary totals for the adjudication.

ShortTotal benefit amount - only include when total type is applicableAdjudication totals
Comments

Benefit is similar to allowed amount. Eligible amount and Benefit amount may be different or the same, but if they are different the payer can supply both for the full picture of the estimate.


Totals for amounts submitted, co-pays, benefits payable etc.

Control0..1*
TypeBackboneElement
Is Modifierfalse
Must Supporttrue
Summarytrue
Requirements

To provide the requestor with financial totals by category for the adjudication.

Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
167. ExplanationOfBenefit.total:benefit.modifierExtension
Definition

May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

ShortExtensions that cannot be ignored even if unrecognized
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

Control0..*
TypeExtension
Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
Summarytrue
Requirements

Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

Alternate Namesextensions, user content, modifiers
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
169. ExplanationOfBenefit.total:benefit.category
Definition

A code to indicate the information type of this adjudication record. Information types may include: the value submitted, maximum values or percentages allowed or payable under the plan, amounts that the patient is responsible for in aggregate or pertaining to this item, amounts paid by other coverages, and the benefit payable for this item.

ShortType of adjudication information
Comments

For example, codes indicating: Co-Pay, deductible, eligible, benefit, tax, etc.

Control1..1
BindingFor example codes, see AdjudicationValueCodeshttp://hl7.org/fhir/ValueSet/adjudication|4.0.1
(example to http://hl7.org/fhir/ValueSet/adjudication|4.0.1)

The adjudication codes.

TypeCodeableConcept
Is Modifierfalse
Summarytrue
Requirements

Needed to convey the type of total provided.

Pattern Value
{
  "coding" : [
    {
      "system" : "http://terminology.hl7.org/CodeSystem/adjudication",
      "code" : "benefit"
    }
  ]
}
<category>
  <coding>
    <system value="http://terminology.hl7.org/CodeSystem/adjudication"/>
    <code value="benefit"/>
  </coding>
</category>
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
171. ExplanationOfBenefit.total:benefit.amount
Definition

Monetary total amount associated with the category.

ShortFinancial total for the category
Control1..1
TypeMoney
Is Modifierfalse
Summarytrue
Requirements

Needed to convey the total monetary amount.

Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
173. ExplanationOfBenefit.payment
Definition

Payment details for the adjudication of the claim.

ShortPayment Details
Control0..01
TypeBackboneElement
Is Modifierfalse
Summaryfalse
Requirements

Needed to convey references to the financial instrument that has been used if payment has been made.

Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
176. ExplanationOfBenefit.processNote
Definition

A note that describes or explains adjudication results in a human readable form.

ShortDisclaimers go here. Notes should be clear and as specific to the situation at hand as possible including any additional assumptions and requirements. This may include notes about prior authorization, out of network providers, benefit period, and other legal or otherwise required disclaimers.Note concerning adjudication
Comments

These disclaimers may include, but are not limited to things such as: notes on prior authorization or other medical management requirements, provider discounts, limitations, preconditions, assumptions, information known to be missing in the estimate, conditions that may affect the estimate, or anything that may affect the interpretation of the estimate.

Control10..*
TypeBackboneElement
Is Modifierfalse
Summaryfalse
Requirements

Provides the insurer specific textual explanations associated with the processing.

Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
178. ExplanationOfBenefit.processNote.extension
Definition

An Extension


May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

ShortExtensionAdditional content defined by implementations
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

Control0..*
TypeExtension
Is Modifierfalse
Summaryfalse
Alternate Namesextensions, user content
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
SlicingThis element introduces a set of slices on ExplanationOfBenefit.processNote.extension. The slices are Unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
180. ExplanationOfBenefit.processNote.extension:processNoteClass
Slice NameprocessNoteClass
Definition

This extension is used to indicate a the class of AEOB Claim process notes

ShortProcessNote Class
Control0..1
This element is affected by the following invariants: ele-1
TypeExtension(ProcessNote Class) (Extension Type: CodeableConcept)
Is Modifierfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
182. ExplanationOfBenefit.processNote.modifierExtension
Definition

May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

ShortExtensions that cannot be ignored even if unrecognized
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

Control0..*
TypeExtension
Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
Summarytrue
Requirements

Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

Alternate Namesextensions, user content, modifiers
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
184. ExplanationOfBenefit.benefitPeriod
Definition

The term of the benefits documented in this response.

ShortWhen the benefits are applicable
Comments

Not applicable when use=claim.

Control10..1
TypePeriod
Is Modifierfalse
Summaryfalse
Requirements

Needed as coverages may be multi-year while benefits tend to be annual therefore a separate expression of the benefit period is needed.

Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
186. ExplanationOfBenefit.benefitBalance
Definition

Estimated Balance by Benefit Category as if the expected item(s) or service(s) included in this estimate were applied. Note: The available balance is based on known claims and does not account for other Good Faith Estimates (GFEs). Benefit balances will remain unchanged until the claim adjudication process applies benefits. Consequently, if multiple estimates pertain to the same benefit, the benefit balance will not consider other estimates.


Balance by Benefit Category.

ShortEstimated Balance by Benefit Category as if the expected item(s) or service(s) included in this estimate were applied.Balance by Benefit Category
Control10..*
TypeBackboneElement
Is Modifierfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
188. ExplanationOfBenefit.benefitBalance.modifierExtension
Definition

May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

ShortExtensions that cannot be ignored even if unrecognized
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

Control0..*
TypeExtension
Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
Summarytrue
Requirements

Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

Alternate Namesextensions, user content, modifiers
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
190. ExplanationOfBenefit.benefitBalance.category
Definition

Code to identify the general type of benefits under which products and services are provided.

ShortBenefit classification
Comments

Examples include Medical Care, Periodontics, Renal Dialysis, Vision Coverage.

Control1..1
BindingThe codes SHALL be taken from For example codes, see PCT benefitBalance.category codeshttp://hl7.org/fhir/ValueSet/ex-benefitcategory|4.0.1
(required to http://hl7.org/fhir/us/davinci-pct/ValueSet/PCTBenefitBalanceCategoryVS)
TypeCodeableConcept
Is Modifierfalse
Summaryfalse
Requirements

Needed to convey the category of service or product for which eligibility is sought.

Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
192. ExplanationOfBenefit.benefitBalance.category.text
Definition

A human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user.

ShortPlain text representation of the concept
Comments

Very often the text is the same as a displayName of one of the codings.

Control10..1
Typestring
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Must Supporttrue
Summarytrue
Requirements

The codes from the terminologies do not always capture the correct meaning with all the nuances of the human using them, or sometimes there is no appropriate code at all. In these cases, the text is used to capture the full meaning of the source.

Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
194. ExplanationOfBenefit.benefitBalance.unit
Definition

Indicates if the benefits apply to an individual or to the family.

ShortIndividual or family
Control10..1
BindingThe codes SHALL be taken from For example codes, see UnitTypeCodeshttp://hl7.org/fhir/ValueSet/benefit-unit|4.0.1
(required to http://hl7.org/fhir/ValueSet/benefit-unit)
TypeCodeableConcept
Is Modifierfalse
Summaryfalse
Requirements

Needed for the understanding of the benefits.

Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
196. ExplanationOfBenefit.benefitBalance.term
Definition

The term or period of the values such as 'maximum lifetime benefit' or 'maximum annual visits'.

ShortAnnual or lifetime
Control10..1
BindingThe codes SHALL be taken from For example codes, see BenefitTermCodeshttp://hl7.org/fhir/ValueSet/benefit-term|4.0.1
(required to http://hl7.org/fhir/ValueSet/benefit-term)
TypeCodeableConcept
Is Modifierfalse
Summaryfalse
Requirements

Needed for the understanding of the benefits.

Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
198. ExplanationOfBenefit.benefitBalance.financial
Definition

Benefits Used to date.

ShortBenefit Summary
Control10..*
TypeBackboneElement
Is Modifierfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
200. ExplanationOfBenefit.benefitBalance.financial.extension
Definition

An Extension


May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

ShortExtensionAdditional content defined by implementations
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

Control0..*
TypeExtension
Is Modifierfalse
Summaryfalse
Alternate Namesextensions, user content
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
SlicingThis element introduces a set of slices on ExplanationOfBenefit.benefitBalance.financial.extension. The slices are Unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
202. ExplanationOfBenefit.benefitBalance.financial.extension:remaining
Slice Nameremaining
Definition

The quantity of the benefit remaining to date.

ShortBenefit Remaining
Control0..1
This element is affected by the following invariants: ele-1
TypeExtension(Benefit Remaining) (Extension Type: Choice of: unsignedInt, Money)
Is Modifierfalse
Must Supporttrue
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
204. ExplanationOfBenefit.benefitBalance.financial.modifierExtension
Definition

May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

ShortExtensions that cannot be ignored even if unrecognized
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

Control0..*
TypeExtension
Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
Summarytrue
Requirements

Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

Alternate Namesextensions, user content, modifiers
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
206. ExplanationOfBenefit.benefitBalance.financial.type
Definition

Classification of benefit being provided.

ShortBenefit classification
Comments

For example: deductible, visits, benefit amount.

Control1..1
BindingThe codes SHALL be taken from For example codes, see PCT Financial Type Value Sethttp://hl7.org/fhir/ValueSet/benefit-type|4.0.1
(required to http://hl7.org/fhir/us/davinci-pct/ValueSet/PCTFinancialTypeVS)
TypeCodeableConcept
Is Modifierfalse
Summaryfalse
Requirements

Needed to convey the nature of the benefit.

Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
208. ExplanationOfBenefit.benefitBalance.financial.allowed[x]
Definition

The quantity of the benefit which is permitted under the coverage.

ShortBenefits allowed
Control10..1
TypeMoney, string, unsignedInt
[x] NoteSeeChoice of Data Typesfor further information about how to use [x]
Is Modifierfalse
Summaryfalse
Requirements

Needed to convey the benefits offered under the coverage.

Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
SlicingThis element introduces a set of slices on ExplanationOfBenefit.benefitBalance.financial.allowed[x]. The slices are Unordered and Closed, and can be differentiated using the following discriminators:
  • type @ $this
210. ExplanationOfBenefit.benefitBalance.financial.allowed[x]:allowedMoney
Slice NameallowedMoney
Definition

The quantity of the benefit which is permitted under the coverage.

ShortBenefits allowed
Control10..1
TypeMoney, string, unsignedInt
[x] NoteSeeChoice of Data Typesfor further information about how to use [x]
Is Modifierfalse
Summaryfalse
Requirements

Needed to convey the benefits offered under the coverage.

Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
212. ExplanationOfBenefit.benefitBalance.financial.used[x]
Definition

The quantity of the benefit which have been consumed to date.

ShortBenefits used
Control10..1
TypeMoney, unsignedInt
[x] NoteSeeChoice of Data Typesfor further information about how to use [x]
Is Modifierfalse
Summaryfalse
Requirements

Needed to convey the benefits consumed to date.

Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
SlicingThis element introduces a set of slices on ExplanationOfBenefit.benefitBalance.financial.used[x]. The slices are Unordered and Closed, and can be differentiated using the following discriminators:
  • type @ $this
214. ExplanationOfBenefit.benefitBalance.financial.used[x]:usedMoney
Slice NameusedMoney
Definition

The quantity of the benefit which have been consumed to date.

ShortBenefits used
Control10..1
TypeMoney, unsignedInt
[x] NoteSeeChoice of Data Typesfor further information about how to use [x]
Is Modifierfalse
Summaryfalse
Requirements

Needed to convey the benefits consumed to date.

Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

See the documentation on how to interpret the contents of this table

0. ExplanationOfBenefit
2. ExplanationOfBenefit.extension
SlicingThis element introduces a set of slices on ExplanationOfBenefit.extension. The slices are Unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
4. ExplanationOfBenefit.extension:serviceDescription
Slice NameserviceDescription
Control0..1
TypeExtension(Service Description) (Extension Type: string)
Must Supporttrue
6. ExplanationOfBenefit.extension:outOfNetworkProviderInfo
Slice NameoutOfNetworkProviderInfo
Control0..1
TypeExtension(In Network Provider Options Link) (Extension Type: url)
Must Supporttrue
8. ExplanationOfBenefit.type
Pattern Value
{
  "coding" : [
    {
      "system" : "http://hl7.org/fhir/us/davinci-pct/CodeSystem/PCTEstimateTypeSummaryCSTemporaryTrialUse",
      "code" : "estimate-summary"
    }
  ]
}
<type>
  <coding>
    <system value="http://hl7.org/fhir/us/davinci-pct/CodeSystem/PCTEstimateTypeSummaryCSTemporaryTrialUse"/>
    <code value="estimate-summary"/>
  </coding>
</type>
10. ExplanationOfBenefit.subType
Control0..0
12. ExplanationOfBenefit.use
Pattern Value
{
  "use" : "predetermination"
}
<use value="predetermination"/>
14. ExplanationOfBenefit.patient
TypeReference(US Core Patient Profile)
16. ExplanationOfBenefit.billablePeriod
ShortThe full Period of Care for all services or products included in the estimate from the first event to the last event.
Control1..?
18. ExplanationOfBenefit.created
ShortThe date and time this summary was generated.
Comments

The date and time this summary was generated based on what was known at that point in time.

20. ExplanationOfBenefit.enterer
Control0..0
22. ExplanationOfBenefit.insurer
TypeReference(PCT Organization)
24. ExplanationOfBenefit.provider
26. ExplanationOfBenefit.provider.extension
Control1..?
28. ExplanationOfBenefit.provider.extension:dataAbsentReason
Slice NamedataAbsentReason
Control1..1
TypeExtension(Data Absent Reason) (Extension Type: code)
30. ExplanationOfBenefit.provider.extension:dataAbsentReason.value[x]
[x] NoteSeeChoice of Data Typesfor further information about how to use [x]
Pattern Value
{
  "valueCode" : "not-applicable"
}
<valueCode value="not-applicable"/>
32. ExplanationOfBenefit.provider.reference
Control0..0
34. ExplanationOfBenefit.provider.type
Control0..0
36. ExplanationOfBenefit.provider.identifier
NoteThis is a business identifier, not a resource identifier (see discussion)
Control0..0
38. ExplanationOfBenefit.provider.display
Control0..0
40. ExplanationOfBenefit.priority
BindingThe codes SHALL be taken from ProcessPriorityCodes
(required to http://hl7.org/fhir/ValueSet/process-priority)
42. ExplanationOfBenefit.fundsReserveRequested
Control0..0
44. ExplanationOfBenefit.fundsReserve
Control0..0
46. ExplanationOfBenefit.prescription
Control0..0
48. ExplanationOfBenefit.originalPrescription
Control0..0
50. ExplanationOfBenefit.payee
Control0..0
52. ExplanationOfBenefit.referral
Control0..0
54. ExplanationOfBenefit.facility
Control0..0
56. ExplanationOfBenefit.claim
Control0..0
58. ExplanationOfBenefit.preAuthRef
Control0..0
60. ExplanationOfBenefit.preAuthRefPeriod
Control0..0
62. ExplanationOfBenefit.supportingInfo
Control0..0
64. ExplanationOfBenefit.precedence
Control0..0
66. ExplanationOfBenefit.insurance
68. ExplanationOfBenefit.insurance.coverage
TypeReference(PCT Coverage)
70. ExplanationOfBenefit.item
Control0..0
72. ExplanationOfBenefit.addItem
Control0..0
74. ExplanationOfBenefit.adjudication
Control0..0
76. ExplanationOfBenefit.total
Control3..?
SlicingThis element introduces a set of slices on ExplanationOfBenefit.total. The slices are Unordered and Open, and can be differentiated using the following discriminators:
  • value @ category

Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them

78. ExplanationOfBenefit.total.category
BindingUnless not suitable, these codes SHALL be taken from PCT Total Value Set
(extensible to http://hl7.org/fhir/us/davinci-pct/ValueSet/PCTTotal)
Must Supporttrue
80. ExplanationOfBenefit.total:submitted
Slice Namesubmitted
ShortTotal provider submitted amount
Control1..1
Must Supporttrue
82. ExplanationOfBenefit.total:submitted.category
Pattern Value
{
  "coding" : [
    {
      "system" : "http://terminology.hl7.org/CodeSystem/adjudication",
      "code" : "submitted"
    }
  ]
}
<category>
  <coding>
    <system value="http://terminology.hl7.org/CodeSystem/adjudication"/>
    <code value="submitted"/>
  </coding>
</category>
84. ExplanationOfBenefit.total:memberliability
Slice Namememberliability
ShortTotal member liability
Control1..1
Must Supporttrue
86. ExplanationOfBenefit.total:memberliability.category
Pattern Value
{
  "coding" : [
    {
      "system" : "http://hl7.org/fhir/us/davinci-pct/CodeSystem/PCTAdjudicationCategoryCS",
      "code" : "memberliability"
    }
  ]
}
<category>
  <coding>
    <system value="http://hl7.org/fhir/us/davinci-pct/CodeSystem/PCTAdjudicationCategoryCS"/>
    <code value="memberliability"/>
  </coding>
</category>
88. ExplanationOfBenefit.total:eligible
Slice Nameeligible
ShortTotal eligible amount
Comments

Eligible is similar to allowed amount. Eligible amount and Benefit amount may be different or the same, but if they are different the payer can supply both for the full picture of the estimate.

Control1..1
Must Supporttrue
90. ExplanationOfBenefit.total:eligible.category
Pattern Value
{
  "coding" : [
    {
      "system" : "http://terminology.hl7.org/CodeSystem/adjudication",
      "code" : "eligible"
    }
  ]
}
<category>
  <coding>
    <system value="http://terminology.hl7.org/CodeSystem/adjudication"/>
    <code value="eligible"/>
  </coding>
</category>
92. ExplanationOfBenefit.total:innetwork
Slice Nameinnetwork
ShortTotal in network amount - only include when total type is applicable
Control0..1
Must Supporttrue
94. ExplanationOfBenefit.total:innetwork.category
Pattern Value
{
  "coding" : [
    {
      "system" : "http://hl7.org/fhir/us/davinci-pct/CodeSystem/PCTNetworkStatusCS",
      "code" : "innetwork"
    }
  ]
}
<category>
  <coding>
    <system value="http://hl7.org/fhir/us/davinci-pct/CodeSystem/PCTNetworkStatusCS"/>
    <code value="innetwork"/>
  </coding>
</category>
96. ExplanationOfBenefit.total:outofnetwork
Slice Nameoutofnetwork
ShortTotal out of network amount - only include when total type is applicable
Control0..1
Must Supporttrue
98. ExplanationOfBenefit.total:outofnetwork.category
Pattern Value
{
  "coding" : [
    {
      "system" : "http://hl7.org/fhir/us/davinci-pct/CodeSystem/PCTNetworkStatusCS",
      "code" : "outofnetwork"
    }
  ]
}
<category>
  <coding>
    <system value="http://hl7.org/fhir/us/davinci-pct/CodeSystem/PCTNetworkStatusCS"/>
    <code value="outofnetwork"/>
  </coding>
</category>
100. ExplanationOfBenefit.total:noncovered
Slice Namenoncovered
ShortTotal noncovered amount - only include when total type is applicable
Control0..1
Must Supporttrue
102. ExplanationOfBenefit.total:noncovered.category
Pattern Value
{
  "coding" : [
    {
      "system" : "http://hl7.org/fhir/us/davinci-pct/CodeSystem/PCTAdjudication",
      "code" : "noncovered"
    }
  ]
}
<category>
  <coding>
    <system value="http://hl7.org/fhir/us/davinci-pct/CodeSystem/PCTAdjudication"/>
    <code value="noncovered"/>
  </coding>
</category>
104. ExplanationOfBenefit.total:negotiated
Slice Namenegotiated
ShortTotal negotiated amount - Total for special negotiated status for a service or product in relation to a patient's coverage that is established outside of a formal network contract
Control0..1
Must Supporttrue
106. ExplanationOfBenefit.total:negotiated.category
Pattern Value
{
  "coding" : [
    {
      "system" : "http://hl7.org/fhir/us/davinci-pct/CodeSystem/PCTNetworkStatusCS",
      "code" : "negotiated"
    }
  ]
}
<category>
  <coding>
    <system value="http://hl7.org/fhir/us/davinci-pct/CodeSystem/PCTNetworkStatusCS"/>
    <code value="negotiated"/>
  </coding>
</category>
108. ExplanationOfBenefit.total:benefit
Slice Namebenefit
ShortTotal benefit amount - only include when total type is applicable
Comments

Benefit is similar to allowed amount. Eligible amount and Benefit amount may be different or the same, but if they are different the payer can supply both for the full picture of the estimate.

Control0..1
Must Supporttrue
110. ExplanationOfBenefit.total:benefit.category
Pattern Value
{
  "coding" : [
    {
      "system" : "http://terminology.hl7.org/CodeSystem/adjudication",
      "code" : "benefit"
    }
  ]
}
<category>
  <coding>
    <system value="http://terminology.hl7.org/CodeSystem/adjudication"/>
    <code value="benefit"/>
  </coding>
</category>
112. ExplanationOfBenefit.payment
Control0..0
114. ExplanationOfBenefit.processNote
ShortDisclaimers go here. Notes should be clear and as specific to the situation at hand as possible including any additional assumptions and requirements. This may include notes about prior authorization, out of network providers, benefit period, and other legal or otherwise required disclaimers.
Comments

These disclaimers may include, but are not limited to things such as: notes on prior authorization or other medical management requirements, provider discounts, limitations, preconditions, assumptions, information known to be missing in the estimate, conditions that may affect the estimate, or anything that may affect the interpretation of the estimate.

Control1..?
116. ExplanationOfBenefit.processNote.extension
SlicingThis element introduces a set of slices on ExplanationOfBenefit.processNote.extension. The slices are Unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
118. ExplanationOfBenefit.processNote.extension:processNoteClass
Slice NameprocessNoteClass
Control0..1
TypeExtension(ProcessNote Class) (Extension Type: CodeableConcept)
120. ExplanationOfBenefit.benefitPeriod
Control1..?
122. ExplanationOfBenefit.benefitBalance
Definition

Estimated Balance by Benefit Category as if the expected item(s) or service(s) included in this estimate were applied. Note: The available balance is based on known claims and does not account for other Good Faith Estimates (GFEs). Benefit balances will remain unchanged until the claim adjudication process applies benefits. Consequently, if multiple estimates pertain to the same benefit, the benefit balance will not consider other estimates.

ShortEstimated Balance by Benefit Category as if the expected item(s) or service(s) included in this estimate were applied.
Control1..?
124. ExplanationOfBenefit.benefitBalance.category
BindingThe codes SHALL be taken from PCT benefitBalance.category codes
(required to http://hl7.org/fhir/us/davinci-pct/ValueSet/PCTBenefitBalanceCategoryVS)
126. ExplanationOfBenefit.benefitBalance.category.text
Control1..?
Must Supporttrue
128. ExplanationOfBenefit.benefitBalance.unit
Control1..?
BindingThe codes SHALL be taken from UnitTypeCodes
(required to http://hl7.org/fhir/ValueSet/benefit-unit)
130. ExplanationOfBenefit.benefitBalance.term
Control1..?
BindingThe codes SHALL be taken from BenefitTermCodes
(required to http://hl7.org/fhir/ValueSet/benefit-term)
132. ExplanationOfBenefit.benefitBalance.financial
Control1..?
134. ExplanationOfBenefit.benefitBalance.financial.extension
SlicingThis element introduces a set of slices on ExplanationOfBenefit.benefitBalance.financial.extension. The slices are Unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
136. ExplanationOfBenefit.benefitBalance.financial.extension:remaining
Slice Nameremaining
Control0..1
TypeExtension(Benefit Remaining) (Extension Type: Choice of: unsignedInt, Money)
Must Supporttrue
138. ExplanationOfBenefit.benefitBalance.financial.type
BindingThe codes SHALL be taken from PCT Financial Type Value Set
(required to http://hl7.org/fhir/us/davinci-pct/ValueSet/PCTFinancialTypeVS)
140. ExplanationOfBenefit.benefitBalance.financial.allowed[x]
Control1..?
[x] NoteSeeChoice of Data Typesfor further information about how to use [x]
SlicingThis element introduces a set of slices on ExplanationOfBenefit.benefitBalance.financial.allowed[x]. The slices are Unordered and Open, and can be differentiated using the following discriminators:
  • type @ $this
142. ExplanationOfBenefit.benefitBalance.financial.allowed[x]:allowedMoney
Slice NameallowedMoney
Control1..1
TypeMoney
[x] NoteSeeChoice of Data Typesfor further information about how to use [x]
144. ExplanationOfBenefit.benefitBalance.financial.used[x]
Control1..?
[x] NoteSeeChoice of Data Typesfor further information about how to use [x]
SlicingThis element introduces a set of slices on ExplanationOfBenefit.benefitBalance.financial.used[x]. The slices are Unordered and Open, and can be differentiated using the following discriminators:
  • type @ $this
146. ExplanationOfBenefit.benefitBalance.financial.used[x]:usedMoney
Slice NameusedMoney
Control1..1
TypeMoney
[x] NoteSeeChoice of Data Typesfor further information about how to use [x]

See the documentation on how to interpret the contents of this table

0. ExplanationOfBenefit
Definition

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.

ShortExplanation of Benefit resource
Control0..*
Is Modifierfalse
Summaryfalse
Alternate NamesEOB
Invariantsdom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources (contained.contained.empty())
dom-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource (contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty())
dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated (contained.meta.versionId.empty() and contained.meta.lastUpdated.empty())
dom-5: If a resource is contained in another resource, it SHALL NOT have a security label (contained.meta.security.empty())
dom-6: A resource should have narrative for robust management (text.`div`.exists())
2. ExplanationOfBenefit.id
Definition

The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.

ShortLogical id of this artifact
Comments

The only time that a resource does not have an id is when it is being submitted to the server using a create operation.

Control0..1
Typeid
Is Modifierfalse
Summarytrue
4. ExplanationOfBenefit.meta
Definition

The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.

ShortMetadata about the resource
Control0..1
TypeMeta
Is Modifierfalse
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
6. ExplanationOfBenefit.implicitRules
Definition

A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.

ShortA set of rules under which this content was created
Comments

Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of it's narrative along with other profiles, value sets, etc.

Control0..1
Typeuri
Is Modifiertrue because This element is labeled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies it's meaning or interpretation
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
8. ExplanationOfBenefit.language
Definition

The base language in which the resource is written.

ShortLanguage of the resource content
Comments

Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute).

Control0..1
BindingThe codes SHOULD be taken from CommonLanguages
(preferred to http://hl7.org/fhir/ValueSet/languages|4.0.1)

A human language.

Additional BindingsPurpose
AllLanguagesMax Binding
Typecode
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
10. ExplanationOfBenefit.text
Definition

A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.

ShortText summary of the resource, for human interpretation
Comments

Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a "text blob" or where text is additionally entered raw or narrated and encoded information is added later.

Control0..1
TypeNarrative
Is Modifierfalse
Summaryfalse
Alternate Namesnarrative, html, xhtml, display
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
12. ExplanationOfBenefit.contained
Definition

These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.

ShortContained, inline Resources
Comments

This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags In their meta elements, but SHALL NOT have security labels.

Control0..*
TypeResource
Is Modifierfalse
Summaryfalse
Alternate Namesinline resources, anonymous resources, contained resources
14. ExplanationOfBenefit.extension
Definition

An Extension

ShortExtension
Control0..*
TypeExtension
Is Modifierfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
SlicingThis element introduces a set of slices on ExplanationOfBenefit.extension. The slices are Unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
16. ExplanationOfBenefit.extension:serviceDescription
Slice NameserviceDescription
Definition

This extension is used to communicate a plain language description of the procedure, product, or service.

ShortService Description
Control0..1
This element is affected by the following invariants: ele-1
TypeExtension(Service Description) (Extension Type: string)
Is Modifierfalse
Must Supporttrue
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
18. ExplanationOfBenefit.extension:outOfNetworkProviderInfo
Slice NameoutOfNetworkProviderInfo
Definition

This extension provides a payer link to information enabling the patient to find providers that are in network for the requested services.

ShortIn Network Provider Options Link
Control0..1
This element is affected by the following invariants: ele-1
TypeExtension(In Network Provider Options Link) (Extension Type: url)
Is Modifierfalse
Must Supporttrue
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
20. ExplanationOfBenefit.modifierExtension
Definition

May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

ShortExtensions that cannot be ignored
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

Control0..*
TypeExtension
Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the resource that contains them
Summaryfalse
Requirements

Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

Alternate Namesextensions, user content
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
22. ExplanationOfBenefit.identifier
Definition

A unique identifier assigned to this explanation of benefit.

ShortBusiness Identifier for the resource
NoteThis is a business identifier, not a resource identifier (see discussion)
Control0..*
TypeIdentifier
Is Modifierfalse
Summaryfalse
Requirements

Allows EOBs to be distinguished and referenced.

Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
24. ExplanationOfBenefit.status
Definition

The status of the resource instance.

Shortactive | cancelled | draft | entered-in-error
Comments

This element is labeled as a modifier because the status contains codes that mark the resource as not currently valid.

Control1..1
BindingThe codes SHALL be taken from ExplanationOfBenefitStatus
(required to http://hl7.org/fhir/ValueSet/explanationofbenefit-status|4.0.1)

A code specifying the state of the resource instance.

Typecode
Is Modifiertrue because This element is labeled as a modifier because it is a status element that contains status entered-in-error which means that the resource should not be treated as valid
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Requirements

Need to track the status of the resource as 'draft' resources may undergo further edits while 'active' resources are immutable and may only have their status changed to 'cancelled'.

Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
26. ExplanationOfBenefit.type
Definition

The category of claim, e.g. oral, pharmacy, vision, institutional, professional.

ShortCategory or discipline
Comments

The majority of jurisdictions use: oral, pharmacy, vision, professional and institutional, or variants on those terms, as the general styles of claims. The valueset is extensible to accommodate other jurisdictional requirements.

Control1..1
BindingUnless not suitable, these codes SHALL be taken from ClaimTypeCodes
(extensible to http://hl7.org/fhir/ValueSet/claim-type|4.0.1)

The type or discipline-style of the claim.

TypeCodeableConcept
Is Modifierfalse
Summarytrue
Requirements

Claim type determine the general sets of business rules applied for information requirements and adjudication.

Pattern Value
{
  "coding" : [
    {
      "system" : "http://hl7.org/fhir/us/davinci-pct/CodeSystem/PCTEstimateTypeSummaryCSTemporaryTrialUse",
      "code" : "estimate-summary"
    }
  ]
}
<type>
  <coding>
    <system value="http://hl7.org/fhir/us/davinci-pct/CodeSystem/PCTEstimateTypeSummaryCSTemporaryTrialUse"/>
    <code value="estimate-summary"/>
  </coding>
</type>
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
28. ExplanationOfBenefit.subType
Definition

A finer grained suite of claim type codes which may convey additional information such as Inpatient vs Outpatient and/or a specialty service.

ShortMore granular claim type
Comments

This may contain the local bill type codes such as the US UB-04 bill type code.

Control0..0
BindingFor example codes, see ExampleClaimSubTypeCodes
(example to http://hl7.org/fhir/ValueSet/claim-subtype|4.0.1)

A more granular claim typecode.

TypeCodeableConcept
Is Modifierfalse
Summaryfalse
Requirements

Some jurisdictions need a finer grained claim type for routing and adjudication.

Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
30. ExplanationOfBenefit.use
Definition

A code to indicate whether the nature of the request is: to request adjudication of products and services previously rendered; or requesting authorization and adjudication for provision in the future; or requesting the non-binding adjudication of the listed products and services which could be provided in the future.

Shortclaim | preauthorization | predetermination
Control1..1
BindingThe codes SHALL be taken from Use
(required to http://hl7.org/fhir/ValueSet/claim-use|4.0.1)

Complete, proposed, exploratory, other.

Typecode
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Requirements

This element is required to understand the nature of the request for adjudication.

Pattern Value
{
  "use" : "predetermination"
}
<use value="predetermination"/>
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
32. ExplanationOfBenefit.patient
Definition

The party to whom the professional services and/or products have been supplied or are being considered and for whom actual for forecast reimbursement is sought.

ShortThe recipient of the products and services
Control1..1
TypeReference(US Core Patient Profile)
Is Modifierfalse
Summarytrue
Requirements

The patient must be supplied to the insurer so that confirmation of coverage and service history may be considered as part of the authorization and/or adjudiction.

Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
34. ExplanationOfBenefit.billablePeriod
Definition

The period for which charges are being submitted.

ShortThe full Period of Care for all services or products included in the estimate from the first event to the last event.
Comments

Typically this would be today or in the past for a claim, and today or in the future for preauthorizations and prodeterminations. Typically line item dates of service should fall within the billing period if one is specified.

Control1..1
TypePeriod
Is Modifierfalse
Summarytrue
Requirements

A number jurisdictions required the submission of the billing period when submitting claims for example for hospital stays or long-term care.

Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
36. ExplanationOfBenefit.created
Definition

The date this resource was created.

ShortThe date and time this summary was generated.
Comments

The date and time this summary was generated based on what was known at that point in time.

Control1..1
TypedateTime
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Requirements

Need to record a timestamp for use by both the recipient and the issuer.

Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
38. ExplanationOfBenefit.enterer
Definition

Individual who created the claim, predetermination or preauthorization.

ShortAuthor of the claim
Control0..0
TypeReference(Practitioner, PractitionerRole)
Is Modifierfalse
Summaryfalse
Requirements

Some jurisdictions require the contact information for personnel completing claims.

Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
40. ExplanationOfBenefit.insurer
Definition

The party responsible for authorization, adjudication and reimbursement.

ShortParty responsible for reimbursement
Control1..1
TypeReference(PCT Organization)
Is Modifierfalse
Summarytrue
Requirements

To be a valid claim, preauthorization or predetermination there must be a party who is responsible for adjudicating the contents against a policy which provides benefits for the patient.

Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
42. ExplanationOfBenefit.provider
Definition

The provider which is responsible for the claim, predetermination or preauthorization.

ShortParty responsible for the claim
Comments

Typically this field would be 1..1 where this party is responsible for the claim but not necessarily professionally responsible for the provision of the individual products and services listed below.

Control1..1
TypeReference(Practitioner, PractitionerRole, Organization)
Is Modifierfalse
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
44. ExplanationOfBenefit.provider.id
Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

ShortUnique id for inter-element referencing
Control0..1
Typestring
Is Modifierfalse
XML FormatIn the XML format, this property is represented as an attribute.
Summaryfalse
46. ExplanationOfBenefit.provider.extension
Definition

An Extension

ShortExtension
Control1..*
TypeExtension
Is Modifierfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
SlicingThis element introduces a set of slices on ExplanationOfBenefit.provider.extension. The slices are Unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
48. ExplanationOfBenefit.provider.extension:dataAbsentReason
Slice NamedataAbsentReason
Definition

Provides a reason why the expected value or elements in the element that is extended are missing.

Shortunknown | asked | temp | notasked | masked | unsupported | astext | error
Control1..1
TypeExtension(Data Absent Reason) (Extension Type: code)
Is Modifierfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
50. ExplanationOfBenefit.provider.extension:dataAbsentReason.id
Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

ShortUnique id for inter-element referencing
Control0..1
Typestring
Is Modifierfalse
XML FormatIn the XML format, this property is represented as an attribute.
Summaryfalse
52. ExplanationOfBenefit.provider.extension:dataAbsentReason.extension
Definition

An Extension

ShortExtension
Control0..0
TypeExtension
Is Modifierfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
SlicingThis element introduces a set of slices on ExplanationOfBenefit.provider.extension.extension. The slices are Unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
54. ExplanationOfBenefit.provider.extension:dataAbsentReason.url
Definition

Source of the definition for the extension code - a logical name or a URL.

Shortidentifies the meaning of the extension
Comments

The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension.

Control1..1
Typeuri
Is Modifierfalse
XML FormatIn the XML format, this property is represented as an attribute.
Summaryfalse
Fixed Value
{
  "url" : "http://hl7.org/fhir/StructureDefinition/data-absent-reason"
}
<url value="http://hl7.org/fhir/StructureDefinition/data-absent-reason"/>
56. ExplanationOfBenefit.provider.extension:dataAbsentReason.value[x]
Definition

Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).

ShortValue of extension
Control1..1
BindingThe codes SHALL be taken from DataAbsentReason
(required to http://hl7.org/fhir/ValueSet/data-absent-reason)
Typecode
[x] NoteSeeChoice of Data Typesfor further information about how to use [x]
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summaryfalse
Pattern Value
{
  "valueCode" : "not-applicable"
}
<valueCode value="not-applicable"/>
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
58. ExplanationOfBenefit.provider.reference
Definition

A reference to a location at which the other resource is found. The reference may be a relative reference, in which case it is relative to the service base URL, or an absolute URL that resolves to the location where the resource is found. The reference may be version specific or not. If the reference is not to a FHIR RESTful server, then it should be assumed to be version specific. Internal fragment references (start with '#') refer to contained resources.

ShortLiteral reference, Relative, internal or absolute URL
Comments

Using absolute URLs provides a stable scalable approach suitable for a cloud/web context, while using relative/logical references provides a flexible approach suitable for use when trading across closed eco-system boundaries. Absolute URLs do not need to point to a FHIR RESTful server, though this is the preferred approach. If the URL conforms to the structure "/[type]/[id]" then it should be assumed that the reference is to a FHIR RESTful server.

Control0..0
This element is affected by the following invariants: ref-1
Typestring
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
60. ExplanationOfBenefit.provider.type
Definition

The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent.

The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources).

ShortType the reference refers to (e.g. "Patient")
Comments

This element is used to indicate the type of the target of the reference. This may be used which ever of the other elements are populated (or not). In some cases, the type of the target may be determined by inspection of the reference (e.g. a RESTful URL) or by resolving the target of the reference; if both the type and a reference is provided, the reference SHALL resolve to a resource of the same type as that specified.

Control0..0
BindingUnless not suitable, these codes SHALL be taken from ResourceType
(extensible to http://hl7.org/fhir/ValueSet/resource-types|4.0.1)

Aa resource (or, for logical models, the URI of the logical model).

Typeuri
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
62. ExplanationOfBenefit.provider.identifier
Definition

An identifier for the target resource. This is used when there is no way to reference the other resource directly, either because the entity it represents is not available through a FHIR server, or because there is no way for the author of the resource to convert a known identifier to an actual location. There is no requirement that a Reference.identifier point to something that is actually exposed as a FHIR instance, but it SHALL point to a business concept that would be expected to be exposed as a FHIR instance, and that instance would need to be of a FHIR resource type allowed by the reference.

ShortLogical reference, when literal reference is not known
Comments

When an identifier is provided in place of a reference, any system processing the reference will only be able to resolve the identifier to a reference if it understands the business context in which the identifier is used. Sometimes this is global (e.g. a national identifier) but often it is not. For this reason, none of the useful mechanisms described for working with references (e.g. chaining, includes) are possible, nor should servers be expected to be able resolve the reference. Servers may accept an identifier based reference untouched, resolve it, and/or reject it - see CapabilityStatement.rest.resource.referencePolicy.

When both an identifier and a literal reference are provided, the literal reference is preferred. Applications processing the resource are allowed - but not required - to check that the identifier matches the literal reference

Applications converting a logical reference to a literal reference may choose to leave the logical reference present, or remove it.

Reference is intended to point to a structure that can potentially be expressed as a FHIR resource, though there is no need for it to exist as an actual FHIR resource instance - except in as much as an application wishes to actual find the target of the reference. The content referred to be the identifier must meet the logical constraints implied by any limitations on what resource types are permitted for the reference. For example, it would not be legitimate to send the identifier for a drug prescription if the type were Reference(Observation|DiagnosticReport). One of the use-cases for Reference.identifier is the situation where no FHIR representation exists (where the type is Reference (Any).

NoteThis is a business identifier, not a resource identifier (see discussion)
Control0..0
TypeIdentifier
Is Modifierfalse
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
64. ExplanationOfBenefit.provider.display
Definition

Plain text narrative that identifies the resource in addition to the resource reference.

ShortText alternative for the resource
Comments

This is generally not the same as the Resource.text of the referenced resource. The purpose is to identify what's being referenced, not to fully describe it.

Control0..0
Typestring
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
66. ExplanationOfBenefit.priority
Definition

The provider-required urgency of processing the request. Typical values include: stat, routine deferred.

ShortDesired processing urgency
Comments

If a claim processor is unable to complete the processing as per the priority then they should generate and error and not process the request.

Control0..1
BindingThe codes SHALL be taken from ProcessPriorityCodes
(required to http://hl7.org/fhir/ValueSet/process-priority)
TypeCodeableConcept
Is Modifierfalse
Summaryfalse
Requirements

The provider may need to indicate their processing requirements so that the processor can indicate if they are unable to comply.

Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
68. ExplanationOfBenefit.fundsReserveRequested
Definition

A code to indicate whether and for whom funds are to be reserved for future claims.

ShortFor whom to reserve funds
Comments

This field is only used for preauthorizations.

Control0..0
BindingFor example codes, see Funds Reservation Codes
(example to http://hl7.org/fhir/ValueSet/fundsreserve|4.0.1)

For whom funds are to be reserved: (Patient, Provider, None).

TypeCodeableConcept
Is Modifierfalse
Summaryfalse
Requirements

In the case of a Pre-Determination/Pre-Authorization the provider may request that funds in the amount of the expected Benefit be reserved ('Patient' or 'Provider') to pay for the Benefits determined on the subsequent claim(s). 'None' explicitly indicates no funds reserving is requested.

Alternate NamesFund pre-allocation
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
70. ExplanationOfBenefit.fundsReserve
Definition

A code, used only on a response to a preauthorization, to indicate whether the benefits payable have been reserved and for whom.

ShortFunds reserved status
Comments

Fund would be release by a future claim quoting the preAuthRef of this response. Examples of values include: provider, patient, none.

Control0..0
BindingFor example codes, see Funds Reservation Codes
(example to http://hl7.org/fhir/ValueSet/fundsreserve|4.0.1)

For whom funds are to be reserved: (Patient, Provider, None).

TypeCodeableConcept
Is Modifierfalse
Summaryfalse
Requirements

Needed to advise the submitting provider on whether the rquest for reservation of funds has been honored.

Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
72. ExplanationOfBenefit.related
Definition

Other claims which are related to this claim such as prior submissions or claims for related services or for the same event.

ShortPrior or corollary claims
Comments

For example, for the original treatment and follow-up exams.

Control0..*
TypeBackboneElement
Is Modifierfalse
Summaryfalse
Requirements

For workplace or other accidents it is common to relate separate claims arising from the same event.

Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
74. ExplanationOfBenefit.related.id
Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

ShortUnique id for inter-element referencing
Control0..1
Typestring
Is Modifierfalse
XML FormatIn the XML format, this property is represented as an attribute.
Summaryfalse
76. ExplanationOfBenefit.related.extension
Definition

May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

ShortAdditional content defined by implementations
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

Control0..*
TypeExtension
Is Modifierfalse
Summaryfalse
Alternate Namesextensions, user content
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
78. ExplanationOfBenefit.related.modifierExtension
Definition

May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

ShortExtensions that cannot be ignored even if unrecognized
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

Control0..*
TypeExtension
Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
Summarytrue
Requirements

Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

Alternate Namesextensions, user content, modifiers
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
80. ExplanationOfBenefit.related.claim
Definition

Reference to a related claim.

ShortReference to the related claim
Control0..1
TypeReference(Claim)
Is Modifierfalse
Summaryfalse
Requirements

For workplace or other accidents it is common to relate separate claims arising from the same event.

Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
82. ExplanationOfBenefit.related.relationship
Definition

A code to convey how the claims are related.

ShortHow the reference claim is related
Comments

For example, prior claim or umbrella.

Control0..1
BindingFor example codes, see ExampleRelatedClaimRelationshipCodes
(example to http://hl7.org/fhir/ValueSet/related-claim-relationship|4.0.1)

Relationship of this claim to a related Claim.

TypeCodeableConcept
Is Modifierfalse
Summaryfalse
Requirements

Some insurers need a declaration of the type of relationship.

Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
84. ExplanationOfBenefit.related.reference
Definition

An alternate organizational reference to the case or file to which this particular claim pertains.

ShortFile or case reference
Comments

For example, Property/Casualty insurer claim number or Workers Compensation case number.

Control0..1
TypeIdentifier
Is Modifierfalse
Summaryfalse
Requirements

In cases where an event-triggered claim is being submitted to an insurer which requires a reference number to be specified on all exchanges.

Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
86. ExplanationOfBenefit.prescription
Definition

Prescription to support the dispensing of pharmacy, device or vision products.

ShortPrescription authorizing services or products
Control0..0
TypeReference(MedicationRequest, VisionPrescription)
Is Modifierfalse
Summaryfalse
Requirements

Required to authorize the dispensing of controlled substances and devices.

Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
88. ExplanationOfBenefit.originalPrescription
Definition

Original prescription which has been superseded by this prescription to support the dispensing of pharmacy services, medications or products.

ShortOriginal prescription if superceded by fulfiller
Comments

For example, a physician may prescribe a medication which the pharmacy determines is contraindicated, or for which the patient has an intolerance, and therefor issues a new prescription for an alternate medication which has the same therapeutic intent. The prescription from the pharmacy becomes the 'prescription' and that from the physician becomes the 'original prescription'.

Control0..0
TypeReference(MedicationRequest)
Is Modifierfalse
Summaryfalse
Requirements

Often required when a fulfiller varies what is fulfilled from that authorized on the original prescription.

Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
90. ExplanationOfBenefit.payee
Definition

The party to be reimbursed for cost of the products and services according to the terms of the policy.

ShortRecipient of benefits payable
Comments

Often providers agree to receive the benefits payable to reduce the near-term costs to the patient. The insurer may decline to pay the provider and may choose to pay the subscriber instead.

Control0..0
TypeBackboneElement
Is Modifierfalse
Summaryfalse
Requirements

The provider needs to specify who they wish to be reimbursed and the claims processor needs express who they will reimburse.

Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
97. ExplanationOfBenefit.referral
Definition

A reference to a referral resource.

ShortTreatment Referral
Comments

The referral resource which lists the date, practitioner, reason and other supporting information.

Control0..0
TypeReference(ServiceRequest)
Is Modifierfalse
Summaryfalse
Requirements

Some insurers require proof of referral to pay for services or to pay specialist rates for services.

Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
99. ExplanationOfBenefit.facility
Definition

Facility where the services were provided.

ShortServicing Facility
Control0..0
TypeReference(Location)
Is Modifierfalse
Summaryfalse
Requirements

Insurance adjudication can be dependant on where services were delivered.

Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
101. ExplanationOfBenefit.claim
Definition

The business identifier for the instance of the adjudication request: claim predetermination or preauthorization.

ShortClaim reference
Control0..0
TypeReference(Claim)
Is Modifierfalse
Summaryfalse
Requirements

To provide a link to the original adjudication request.

Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
103. ExplanationOfBenefit.claimResponse
Definition

The business identifier for the instance of the adjudication response: claim, predetermination or preauthorization response.

ShortClaim response reference
Control0..1
TypeReference(ClaimResponse)
Is Modifierfalse
Summaryfalse
Requirements

To provide a link to the original adjudication response.

Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
105. ExplanationOfBenefit.outcome
Definition

The outcome of the claim, predetermination, or preauthorization processing.

Shortqueued | complete | error | partial
Comments

The resource may be used to indicate that: the request has been held (queued) for processing; that it has been processed and errors found (error); that no errors were found and that some of the adjudication has been undertaken (partial) or that all of the adjudication has been undertaken (complete).

Control1..1
BindingThe codes SHALL be taken from ClaimProcessingCodes
(required to http://hl7.org/fhir/ValueSet/remittance-outcome|4.0.1)

The result of the claim processing.

Typecode
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Requirements

To advise the requestor of an overall processing outcome.

Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
107. ExplanationOfBenefit.disposition
Definition

A human readable description of the status of the adjudication.

ShortDisposition Message
Control0..1
Typestring
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summaryfalse
Requirements

Provided for user display.

Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
109. ExplanationOfBenefit.preAuthRef
Definition

Reference from the Insurer which is used in later communications which refers to this adjudication.

ShortPreauthorization reference
Comments

This value is only present on preauthorization adjudications.

Control0..0
Typestring
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summaryfalse
Requirements

On subsequent claims, the insurer may require the provider to quote this value.

Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
111. ExplanationOfBenefit.preAuthRefPeriod
Definition

The timeframe during which the supplied preauthorization reference may be quoted on claims to obtain the adjudication as provided.

ShortPreauthorization in-effect period
Comments

This value is only present on preauthorization adjudications.

Control0..0
TypePeriod
Is Modifierfalse
Summaryfalse
Requirements

On subsequent claims, the insurer may require the provider to quote this value.

Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
113. ExplanationOfBenefit.careTeam
Definition

The members of the team who provided the products and services.

ShortCare Team members
Control0..*
TypeBackboneElement
Is Modifierfalse
Summaryfalse
Requirements

Common to identify the responsible and supporting practitioners.

Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
115. ExplanationOfBenefit.careTeam.id
Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

ShortUnique id for inter-element referencing
Control0..1
Typestring
Is Modifierfalse
XML FormatIn the XML format, this property is represented as an attribute.
Summaryfalse
117. ExplanationOfBenefit.careTeam.extension
Definition

May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

ShortAdditional content defined by implementations
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

Control0..*
TypeExtension
Is Modifierfalse
Summaryfalse
Alternate Namesextensions, user content
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
119. ExplanationOfBenefit.careTeam.modifierExtension
Definition

May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

ShortExtensions that cannot be ignored even if unrecognized
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

Control0..*
TypeExtension
Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
Summarytrue
Requirements

Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

Alternate Namesextensions, user content, modifiers
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
121. ExplanationOfBenefit.careTeam.sequence
Definition

A number to uniquely identify care team entries.

ShortOrder of care team
Control1..1
TypepositiveInt
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summaryfalse
Requirements

Necessary to maintain the order of the care team and provide a mechanism to link individuals to claim details.

Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
123. ExplanationOfBenefit.careTeam.provider
Definition

Member of the team who provided the product or service.

ShortPractitioner or organization
Control1..1
TypeReference(Practitioner, PractitionerRole, Organization)
Is Modifierfalse
Summaryfalse
Requirements

Often a regulatory requirement to specify the responsible provider.

Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
125. ExplanationOfBenefit.careTeam.responsible
Definition

The party who is billing and/or responsible for the claimed products or services.

ShortIndicator of the lead practitioner
Comments

Responsible might not be required when there is only a single provider listed.

Control0..1
Typeboolean
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summaryfalse
Requirements

When multiple parties are present it is required to distinguish the lead or responsible individual.

Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
127. ExplanationOfBenefit.careTeam.role
Definition

The lead, assisting or supervising practitioner and their discipline if a multidisciplinary team.

ShortFunction within the team
Comments

Role might not be required when there is only a single provider listed.

Control0..1
BindingFor example codes, see ClaimCareTeamRoleCodes
(example to http://hl7.org/fhir/ValueSet/claim-careteamrole|4.0.1)

The role codes for the care team members.

TypeCodeableConcept
Is Modifierfalse
Summaryfalse
Requirements

When multiple parties are present it is required to distinguish the roles performed by each member.

Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
129. ExplanationOfBenefit.careTeam.qualification
Definition

The qualification of the practitioner which is applicable for this service.

ShortPractitioner credential or specialization
Control0..1
BindingFor example codes, see ExampleProviderQualificationCodes
(example to http://hl7.org/fhir/ValueSet/provider-qualification|4.0.1)

Provider professional qualifications.

TypeCodeableConcept
Is Modifierfalse
Summaryfalse
Requirements

Need to specify which qualification a provider is delivering the product or service under.

Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
131. ExplanationOfBenefit.supportingInfo
Definition

Additional information codes regarding exceptions, special considerations, the condition, situation, prior or concurrent issues.

ShortSupporting information
Comments

Often there are multiple jurisdiction specific valuesets which are required.

Control0..0
TypeBackboneElement
Is Modifierfalse
Summaryfalse
Requirements

Typically these information codes are required to support the services rendered or the adjudication of the services rendered.

Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
142. ExplanationOfBenefit.diagnosis
Definition

Information about diagnoses relevant to the claim items.

ShortPertinent diagnosis information
Control0..*
TypeBackboneElement
Is Modifierfalse
Summaryfalse
Requirements

Required for the adjudication by provided context for the services and product listed.

Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
144. ExplanationOfBenefit.diagnosis.id
Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

ShortUnique id for inter-element referencing
Control0..1
Typestring
Is Modifierfalse
XML FormatIn the XML format, this property is represented as an attribute.
Summaryfalse
146. ExplanationOfBenefit.diagnosis.extension
Definition

May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

ShortAdditional content defined by implementations
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

Control0..*
TypeExtension
Is Modifierfalse
Summaryfalse
Alternate Namesextensions, user content
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
148. ExplanationOfBenefit.diagnosis.modifierExtension
Definition

May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

ShortExtensions that cannot be ignored even if unrecognized
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

Control0..*
TypeExtension
Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
Summarytrue
Requirements

Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

Alternate Namesextensions, user content, modifiers
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
150. ExplanationOfBenefit.diagnosis.sequence
Definition

A number to uniquely identify diagnosis entries.

ShortDiagnosis instance identifier
Comments

Diagnosis are presented in list order to their expected importance: primary, secondary, etc.

Control1..1
TypepositiveInt
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summaryfalse
Requirements

Necessary to maintain the order of the diagnosis items and provide a mechanism to link to claim details.

Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
152. ExplanationOfBenefit.diagnosis.diagnosis[x]
Definition

The nature of illness or problem in a coded form or as a reference to an external defined Condition.

ShortNature of illness or problem
Control1..1
BindingFor example codes, see ICD-10Codes
(example to http://hl7.org/fhir/ValueSet/icd-10|4.0.1)

ICD10 Diagnostic codes.

TypeChoice of: CodeableConcept, Reference(Condition)
[x] NoteSeeChoice of Data Typesfor further information about how to use [x]
Is Modifierfalse
Summaryfalse
Requirements

Provides health context for the evaluation of the products and/or services.

Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
154. ExplanationOfBenefit.diagnosis.type
Definition

When the condition was observed or the relative ranking.

ShortTiming or nature of the diagnosis
Comments

For example: admitting, primary, secondary, discharge.

Control0..*
BindingFor example codes, see ExampleDiagnosisTypeCodes
(example to http://hl7.org/fhir/ValueSet/ex-diagnosistype|4.0.1)

The type of the diagnosis: admitting, principal, discharge.

TypeCodeableConcept
Is Modifierfalse
Summaryfalse
Requirements

Often required to capture a particular diagnosis, for example: primary or discharge.

Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
156. ExplanationOfBenefit.diagnosis.onAdmission
Definition

Indication of whether the diagnosis was present on admission to a facility.

ShortPresent on admission
Control0..1
BindingFor example codes, see ExampleDiagnosisOnAdmissionCodes
(example to http://hl7.org/fhir/ValueSet/ex-diagnosis-on-admission|4.0.1)

Present on admission.

TypeCodeableConcept
Is Modifierfalse
Summaryfalse
Requirements

Many systems need to understand for adjudication if the diagnosis was present a time of admission.

Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
158. ExplanationOfBenefit.diagnosis.packageCode
Definition

A package billing code or bundle code used to group products and services to a particular health condition (such as heart attack) which is based on a predetermined grouping code system.

ShortPackage billing code
Comments

For example, DRG (Diagnosis Related Group) or a bundled billing code. A patient may have a diagnosis of a Myocardio-infarction and a DRG for HeartAttack would assigned. The Claim item (and possible subsequent claims) would refer to the DRG for those line items that were for services related to the heart attack event.

Control0..1
BindingFor example codes, see ExampleDiagnosisRelatedGroupCodes
(example to http://hl7.org/fhir/ValueSet/ex-diagnosisrelatedgroup|4.0.1)

The DRG codes associated with the diagnosis.

TypeCodeableConcept
Is Modifierfalse
Summaryfalse
Requirements

Required to relate the current diagnosis to a package billing code that is then referenced on the individual claim items which are specific to the health condition covered by the package code.

Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
160. ExplanationOfBenefit.procedure
Definition

Procedures performed on the patient relevant to the billing items with the claim.

ShortClinical procedures performed
Control0..*
TypeBackboneElement
Is Modifierfalse
Summaryfalse
Requirements

The specific clinical invention are sometimes required to be provided to justify billing a greater than customary amount for a service.

Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
162. ExplanationOfBenefit.procedure.id
Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

ShortUnique id for inter-element referencing
Control0..1
Typestring
Is Modifierfalse
XML FormatIn the XML format, this property is represented as an attribute.
Summaryfalse
164. ExplanationOfBenefit.procedure.extension
Definition

May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

ShortAdditional content defined by implementations
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

Control0..*
TypeExtension
Is Modifierfalse
Summaryfalse
Alternate Namesextensions, user content
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
166. ExplanationOfBenefit.procedure.modifierExtension
Definition

May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

ShortExtensions that cannot be ignored even if unrecognized
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

Control0..*
TypeExtension
Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
Summarytrue
Requirements

Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

Alternate Namesextensions, user content, modifiers
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
168. ExplanationOfBenefit.procedure.sequence
Definition

A number to uniquely identify procedure entries.

ShortProcedure instance identifier
Control1..1
TypepositiveInt
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summaryfalse
Requirements

Necessary to provide a mechanism to link to claim details.

Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
170. ExplanationOfBenefit.procedure.type
Definition

When the condition was observed or the relative ranking.

ShortCategory of Procedure
Control0..*
BindingFor example codes, see ExampleProcedureTypeCodes
(example to http://hl7.org/fhir/ValueSet/ex-procedure-type|4.0.1)

Example procedure type codes.

TypeCodeableConcept
Is Modifierfalse
Summaryfalse
Requirements

Often required to capture a particular diagnosis, for example: primary or discharge.

Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
172. ExplanationOfBenefit.procedure.date
Definition

Date and optionally time the procedure was performed.

ShortWhen the procedure was performed
Control0..1
TypedateTime
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summaryfalse
Requirements

Required for auditing purposes.

Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
174. ExplanationOfBenefit.procedure.procedure[x]
Definition

The code or reference to a Procedure resource which identifies the clinical intervention performed.

ShortSpecific clinical procedure
Control1..1
BindingFor example codes, see ICD-10ProcedureCodes
(example to http://hl7.org/fhir/ValueSet/icd-10-procedures|4.0.1)

ICD10 Procedure codes.

TypeChoice of: CodeableConcept, Reference(Procedure)
[x] NoteSeeChoice of Data Typesfor further information about how to use [x]
Is Modifierfalse
Summaryfalse
Requirements

This identifies the actual clinical procedure.

Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
176. ExplanationOfBenefit.procedure.udi
Definition

Unique Device Identifiers associated with this line item.

ShortUnique device identifier
Control0..*
TypeReference(Device)
Is Modifierfalse
Summaryfalse
Requirements

The UDI code allows the insurer to obtain device level information on the product supplied.

Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
178. ExplanationOfBenefit.precedence
Definition

This indicates the relative order of a series of EOBs related to different coverages for the same suite of services.

ShortPrecedence (primary, secondary, etc.)
Control0..0
TypepositiveInt
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summaryfalse
Requirements

Needed to coordinate between multiple EOBs for the same suite of services.

Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
180. ExplanationOfBenefit.insurance
Definition

Financial instruments for reimbursement for the health care products and services specified on the claim.

ShortPatient insurance information
Comments

All insurance coverages for the patient which may be applicable for reimbursement, of the products and services listed in the claim, are typically provided in the claim to allow insurers to confirm the ordering of the insurance coverages relative to local 'coordination of benefit' rules. One coverage (and only one) with 'focal=true' is to be used in the adjudication of this claim. Coverages appearing before the focal Coverage in the list, and where 'Coverage.subrogation=false', should provide a reference to the ClaimResponse containing the adjudication results of the prior claim.

Control1..*
TypeBackboneElement
Is Modifierfalse
Summarytrue
Requirements

At least one insurer is required for a claim to be a claim.

Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
182. ExplanationOfBenefit.insurance.id
Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

ShortUnique id for inter-element referencing
Control0..1
Typestring
Is Modifierfalse
XML FormatIn the XML format, this property is represented as an attribute.
Summaryfalse
184. ExplanationOfBenefit.insurance.extension
Definition

May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

ShortAdditional content defined by implementations
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

Control0..*
TypeExtension
Is Modifierfalse
Summaryfalse
Alternate Namesextensions, user content
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
186. ExplanationOfBenefit.insurance.modifierExtension
Definition

May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

ShortExtensions that cannot be ignored even if unrecognized
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

Control0..*
TypeExtension
Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
Summarytrue
Requirements

Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

Alternate Namesextensions, user content, modifiers
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
188. ExplanationOfBenefit.insurance.focal
Definition

A flag to indicate that this Coverage is to be used for adjudication of this claim when set to true.

ShortCoverage to be used for adjudication
Comments

A patient may (will) have multiple insurance policies which provide reimbursement for healthcare services and products. For example, a person may also be covered by their spouse's policy and both appear in the list (and may be from the same insurer). This flag will be set to true for only one of the listed policies and that policy will be used for adjudicating this claim. Other claims would be created to request adjudication against the other listed policies.

Control1..1
Typeboolean
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Requirements

To identify which coverage in the list is being used to adjudicate this claim.

Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
190. ExplanationOfBenefit.insurance.coverage
Definition

Reference to the insurance card level information contained in the Coverage resource. The coverage issuing insurer will use these details to locate the patient's actual coverage within the insurer's information system.

ShortInsurance information
Control1..1
TypeReference(PCT Coverage)
Is Modifierfalse
Summarytrue
Requirements

Required to allow the adjudicator to locate the correct policy and history within their information system.

Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
192. ExplanationOfBenefit.insurance.preAuthRef
Definition

Reference numbers previously provided by the insurer to the provider to be quoted on subsequent claims containing services or products related to the prior authorization.

ShortPrior authorization reference number
Comments

This value is an alphanumeric string that may be provided over the phone, via text, via paper, or within a ClaimResponse resource and is not a FHIR Identifier.

Control0..*
Typestring
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summaryfalse
Requirements

Providers must quote previously issued authorization reference numbers in order to obtain adjudication as previously advised on the Preauthorization.

Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
194. ExplanationOfBenefit.accident
Definition

Details of a accident which resulted in injuries which required the products and services listed in the claim.

ShortDetails of the event
Control0..1
TypeBackboneElement
Is Modifierfalse
Summaryfalse
Requirements

When healthcare products and services are accident related, benefits may be payable under accident provisions of policies, such as automotive, etc before they are payable under normal health insurance.

Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
196. ExplanationOfBenefit.accident.id
Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

ShortUnique id for inter-element referencing
Control0..1
Typestring
Is Modifierfalse
XML FormatIn the XML format, this property is represented as an attribute.
Summaryfalse
198. ExplanationOfBenefit.accident.extension
Definition

May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

ShortAdditional content defined by implementations
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

Control0..*
TypeExtension
Is Modifierfalse
Summaryfalse
Alternate Namesextensions, user content
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
200. ExplanationOfBenefit.accident.modifierExtension
Definition

May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

ShortExtensions that cannot be ignored even if unrecognized
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

Control0..*
TypeExtension
Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
Summarytrue
Requirements

Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

Alternate Namesextensions, user content, modifiers
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
202. ExplanationOfBenefit.accident.date
Definition

Date of an accident event related to the products and services contained in the claim.

ShortWhen the incident occurred
Comments

The date of the accident has to precede the dates of the products and services but within a reasonable timeframe.

Control0..1
Typedate
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summaryfalse
Requirements

Required for audit purposes and adjudication.

Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
204. ExplanationOfBenefit.accident.type
Definition

The type or context of the accident event for the purposes of selection of potential insurance coverages and determination of coordination between insurers.

ShortThe nature of the accident
Control0..1
BindingUnless not suitable, these codes SHALL be taken from ActIncidentCode (3.0.0)
(extensible to http://terminology.hl7.org/ValueSet/v3-ActIncidentCode|3.0.0)

Type of accident: work place, auto, etc.

TypeCodeableConcept
Is Modifierfalse
Summaryfalse
Requirements

Coverage may be dependant on the type of accident.

Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
206. ExplanationOfBenefit.accident.location[x]
Definition

The physical location of the accident event.

ShortWhere the event occurred
Control0..1
TypeChoice of: Address, Reference(Location)
[x] NoteSeeChoice of Data Typesfor further information about how to use [x]
Is Modifierfalse
Summaryfalse
Requirements

Required for audit purposes and determination of applicable insurance liability.

Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
208. ExplanationOfBenefit.item
Definition

A claim line. Either a simple (a product or service) or a 'group' of details which can also be a simple items or groups of sub-details.

ShortProduct or service provided
Control0..0
TypeBackboneElement
Is Modifierfalse
Summaryfalse
Requirements

The items to be processed for adjudication.

Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
276. ExplanationOfBenefit.addItem
Definition

The first-tier service adjudications for payor added product or service lines.

ShortInsurer added line items
Control0..0
TypeBackboneElement
Is Modifierfalse
Summaryfalse
Requirements

Insurers may redefine the provided product or service or may package and/or decompose groups of products and services. The addItems allows the insurer to provide their line item list with linkage to the submitted items/details/sub-details. In a preauthorization the insurer may use the addItem structure to provide additional information on authorized products and services.

Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
322. ExplanationOfBenefit.adjudication
Definition

The adjudication results which are presented at the header level rather than at the line-item or add-item levels.

ShortHeader-level adjudication
Control0..0
TypeSeettp://hl7.org/fhir/StructureDefinition/ExplanationOfBenefit#ExplanationOfBenefit.item.adjudication
Is Modifierfalse
Summaryfalse
Requirements

Some insurers will receive line-items but provide the adjudication only at a summary or header-level.

Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
324. ExplanationOfBenefit.total
Definition

Categorized monetary totals for the adjudication.

ShortAdjudication totals
Comments

Totals for amounts submitted, co-pays, benefits payable etc.

Control3..*
TypeBackboneElement
Is Modifierfalse
Summarytrue
Requirements

To provide the requestor with financial totals by category for the adjudication.

Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
SlicingThis element introduces a set of slices on ExplanationOfBenefit.total. The slices are Unordered and Open, and can be differentiated using the following discriminators:
  • value @ category

Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them

326. ExplanationOfBenefit.total.id
Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

ShortUnique id for inter-element referencing
Control0..1
Typestring
Is Modifierfalse
XML FormatIn the XML format, this property is represented as an attribute.
Summaryfalse
328. ExplanationOfBenefit.total.extension
Definition

May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

ShortAdditional content defined by implementations
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

Control0..*
TypeExtension
Is Modifierfalse
Summaryfalse
Alternate Namesextensions, user content
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
330. ExplanationOfBenefit.total.modifierExtension
Definition

May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

ShortExtensions that cannot be ignored even if unrecognized
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

Control0..*
TypeExtension
Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
Summarytrue
Requirements

Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

Alternate Namesextensions, user content, modifiers
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
332. ExplanationOfBenefit.total.category
Definition

A code to indicate the information type of this adjudication record. Information types may include: the value submitted, maximum values or percentages allowed or payable under the plan, amounts that the patient is responsible for in aggregate or pertaining to this item, amounts paid by other coverages, and the benefit payable for this item.

ShortType of adjudication information
Comments

For example, codes indicating: Co-Pay, deductible, eligible, benefit, tax, etc.

Control1..1
BindingUnless not suitable, these codes SHALL be taken from PCT Total Value Set
(extensible to http://hl7.org/fhir/us/davinci-pct/ValueSet/PCTTotal)
TypeCodeableConcept
Is Modifierfalse
Must Supporttrue
Summarytrue
Requirements

Needed to convey the type of total provided.

Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
334. ExplanationOfBenefit.total.amount
Definition

Monetary total amount associated with the category.

ShortFinancial total for the category
Control1..1
TypeMoney
Is Modifierfalse
Summarytrue
Requirements

Needed to convey the total monetary amount.

Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
336. ExplanationOfBenefit.total:submitted
Slice Namesubmitted
Definition

Categorized monetary totals for the adjudication.

ShortTotal provider submitted amount
Comments

Totals for amounts submitted, co-pays, benefits payable etc.

Control1..1
TypeBackboneElement
Is Modifierfalse
Must Supporttrue
Summarytrue
Requirements

To provide the requestor with financial totals by category for the adjudication.

Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
338. ExplanationOfBenefit.total:submitted.id
Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

ShortUnique id for inter-element referencing
Control0..1
Typestring
Is Modifierfalse
XML FormatIn the XML format, this property is represented as an attribute.
Summaryfalse
340. ExplanationOfBenefit.total:submitted.extension
Definition

May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

ShortAdditional content defined by implementations
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

Control0..*
TypeExtension
Is Modifierfalse
Summaryfalse
Alternate Namesextensions, user content
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
342. ExplanationOfBenefit.total:submitted.modifierExtension
Definition

May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

ShortExtensions that cannot be ignored even if unrecognized
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

Control0..*
TypeExtension
Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
Summarytrue
Requirements

Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

Alternate Namesextensions, user content, modifiers
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
344. ExplanationOfBenefit.total:submitted.category
Definition

A code to indicate the information type of this adjudication record. Information types may include: the value submitted, maximum values or percentages allowed or payable under the plan, amounts that the patient is responsible for in aggregate or pertaining to this item, amounts paid by other coverages, and the benefit payable for this item.

ShortType of adjudication information
Comments

For example, codes indicating: Co-Pay, deductible, eligible, benefit, tax, etc.

Control1..1
BindingFor example codes, see AdjudicationValueCodes
(example to http://hl7.org/fhir/ValueSet/adjudication|4.0.1)

The adjudication codes.

TypeCodeableConcept
Is Modifierfalse
Summarytrue
Requirements

Needed to convey the type of total provided.

Pattern Value
{
  "coding" : [
    {
      "system" : "http://terminology.hl7.org/CodeSystem/adjudication",
      "code" : "submitted"
    }
  ]
}
<category>
  <coding>
    <system value="http://terminology.hl7.org/CodeSystem/adjudication"/>
    <code value="submitted"/>
  </coding>
</category>
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
346. ExplanationOfBenefit.total:submitted.amount
Definition

Monetary total amount associated with the category.

ShortFinancial total for the category
Control1..1
TypeMoney
Is Modifierfalse
Summarytrue
Requirements

Needed to convey the total monetary amount.

Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
348. ExplanationOfBenefit.total:memberliability
Slice Namememberliability
Definition

Categorized monetary totals for the adjudication.

ShortTotal member liability
Comments

Totals for amounts submitted, co-pays, benefits payable etc.

Control1..1
TypeBackboneElement
Is Modifierfalse
Must Supporttrue
Summarytrue
Requirements

To provide the requestor with financial totals by category for the adjudication.

Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
350. ExplanationOfBenefit.total:memberliability.id
Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

ShortUnique id for inter-element referencing
Control0..1
Typestring
Is Modifierfalse
XML FormatIn the XML format, this property is represented as an attribute.
Summaryfalse
352. ExplanationOfBenefit.total:memberliability.extension
Definition

May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

ShortAdditional content defined by implementations
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

Control0..*
TypeExtension
Is Modifierfalse
Summaryfalse
Alternate Namesextensions, user content
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
354. ExplanationOfBenefit.total:memberliability.modifierExtension
Definition

May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

ShortExtensions that cannot be ignored even if unrecognized
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

Control0..*
TypeExtension
Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
Summarytrue
Requirements

Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

Alternate Namesextensions, user content, modifiers
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
356. ExplanationOfBenefit.total:memberliability.category
Definition

A code to indicate the information type of this adjudication record. Information types may include: the value submitted, maximum values or percentages allowed or payable under the plan, amounts that the patient is responsible for in aggregate or pertaining to this item, amounts paid by other coverages, and the benefit payable for this item.

ShortType of adjudication information
Comments

For example, codes indicating: Co-Pay, deductible, eligible, benefit, tax, etc.

Control1..1
BindingFor example codes, see AdjudicationValueCodes
(example to http://hl7.org/fhir/ValueSet/adjudication|4.0.1)

The adjudication codes.

TypeCodeableConcept
Is Modifierfalse
Summarytrue
Requirements

Needed to convey the type of total provided.

Pattern Value
{
  "coding" : [
    {
      "system" : "http://hl7.org/fhir/us/davinci-pct/CodeSystem/PCTAdjudicationCategoryCS",
      "code" : "memberliability"
    }
  ]
}
<category>
  <coding>
    <system value="http://hl7.org/fhir/us/davinci-pct/CodeSystem/PCTAdjudicationCategoryCS"/>
    <code value="memberliability"/>
  </coding>
</category>
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
358. ExplanationOfBenefit.total:memberliability.amount
Definition

Monetary total amount associated with the category.

ShortFinancial total for the category
Control1..1
TypeMoney
Is Modifierfalse
Summarytrue
Requirements

Needed to convey the total monetary amount.

Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
360. ExplanationOfBenefit.total:eligible
Slice Nameeligible
Definition

Categorized monetary totals for the adjudication.

ShortTotal eligible amount
Comments

Eligible is similar to allowed amount. Eligible amount and Benefit amount may be different or the same, but if they are different the payer can supply both for the full picture of the estimate.

Control1..1
TypeBackboneElement
Is Modifierfalse
Must Supporttrue
Summarytrue
Requirements

To provide the requestor with financial totals by category for the adjudication.

Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
362. ExplanationOfBenefit.total:eligible.id
Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

ShortUnique id for inter-element referencing
Control0..1
Typestring
Is Modifierfalse
XML FormatIn the XML format, this property is represented as an attribute.
Summaryfalse
364. ExplanationOfBenefit.total:eligible.extension
Definition

May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

ShortAdditional content defined by implementations
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

Control0..*
TypeExtension
Is Modifierfalse
Summaryfalse
Alternate Namesextensions, user content
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
366. ExplanationOfBenefit.total:eligible.modifierExtension
Definition

May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

ShortExtensions that cannot be ignored even if unrecognized
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

Control0..*
TypeExtension
Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
Summarytrue
Requirements

Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

Alternate Namesextensions, user content, modifiers
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
368. ExplanationOfBenefit.total:eligible.category
Definition

A code to indicate the information type of this adjudication record. Information types may include: the value submitted, maximum values or percentages allowed or payable under the plan, amounts that the patient is responsible for in aggregate or pertaining to this item, amounts paid by other coverages, and the benefit payable for this item.

ShortType of adjudication information
Comments

For example, codes indicating: Co-Pay, deductible, eligible, benefit, tax, etc.

Control1..1
BindingFor example codes, see AdjudicationValueCodes
(example to http://hl7.org/fhir/ValueSet/adjudication|4.0.1)

The adjudication codes.

TypeCodeableConcept
Is Modifierfalse
Summarytrue
Requirements

Needed to convey the type of total provided.

Pattern Value
{
  "coding" : [
    {
      "system" : "http://terminology.hl7.org/CodeSystem/adjudication",
      "code" : "eligible"
    }
  ]
}
<category>
  <coding>
    <system value="http://terminology.hl7.org/CodeSystem/adjudication"/>
    <code value="eligible"/>
  </coding>
</category>
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
370. ExplanationOfBenefit.total:eligible.amount
Definition

Monetary total amount associated with the category.

ShortFinancial total for the category
Control1..1
TypeMoney
Is Modifierfalse
Summarytrue
Requirements

Needed to convey the total monetary amount.

Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
372. ExplanationOfBenefit.total:innetwork
Slice Nameinnetwork
Definition

Categorized monetary totals for the adjudication.

ShortTotal in network amount - only include when total type is applicable
Comments

Totals for amounts submitted, co-pays, benefits payable etc.

Control0..1
TypeBackboneElement
Is Modifierfalse
Must Supporttrue
Summarytrue
Requirements

To provide the requestor with financial totals by category for the adjudication.

Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
374. ExplanationOfBenefit.total:innetwork.id
Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

ShortUnique id for inter-element referencing
Control0..1
Typestring
Is Modifierfalse
XML FormatIn the XML format, this property is represented as an attribute.
Summaryfalse
376. ExplanationOfBenefit.total:innetwork.extension
Definition

May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

ShortAdditional content defined by implementations
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

Control0..*
TypeExtension
Is Modifierfalse
Summaryfalse
Alternate Namesextensions, user content
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
378. ExplanationOfBenefit.total:innetwork.modifierExtension
Definition

May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

ShortExtensions that cannot be ignored even if unrecognized
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

Control0..*
TypeExtension
Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
Summarytrue
Requirements

Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

Alternate Namesextensions, user content, modifiers
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
380. ExplanationOfBenefit.total:innetwork.category
Definition

A code to indicate the information type of this adjudication record. Information types may include: the value submitted, maximum values or percentages allowed or payable under the plan, amounts that the patient is responsible for in aggregate or pertaining to this item, amounts paid by other coverages, and the benefit payable for this item.

ShortType of adjudication information
Comments

For example, codes indicating: Co-Pay, deductible, eligible, benefit, tax, etc.

Control1..1
BindingFor example codes, see AdjudicationValueCodes
(example to http://hl7.org/fhir/ValueSet/adjudication|4.0.1)

The adjudication codes.

TypeCodeableConcept
Is Modifierfalse
Summarytrue
Requirements

Needed to convey the type of total provided.

Pattern Value
{
  "coding" : [
    {
      "system" : "http://hl7.org/fhir/us/davinci-pct/CodeSystem/PCTNetworkStatusCS",
      "code" : "innetwork"
    }
  ]
}
<category>
  <coding>
    <system value="http://hl7.org/fhir/us/davinci-pct/CodeSystem/PCTNetworkStatusCS"/>
    <code value="innetwork"/>
  </coding>
</category>
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
382. ExplanationOfBenefit.total:innetwork.amount
Definition

Monetary total amount associated with the category.

ShortFinancial total for the category
Control1..1
TypeMoney
Is Modifierfalse
Summarytrue
Requirements

Needed to convey the total monetary amount.

Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
384. ExplanationOfBenefit.total:outofnetwork
Slice Nameoutofnetwork
Definition

Categorized monetary totals for the adjudication.

ShortTotal out of network amount - only include when total type is applicable
Comments

Totals for amounts submitted, co-pays, benefits payable etc.

Control0..1
TypeBackboneElement
Is Modifierfalse
Must Supporttrue
Summarytrue
Requirements

To provide the requestor with financial totals by category for the adjudication.

Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
386. ExplanationOfBenefit.total:outofnetwork.id
Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

ShortUnique id for inter-element referencing
Control0..1
Typestring
Is Modifierfalse
XML FormatIn the XML format, this property is represented as an attribute.
Summaryfalse
388. ExplanationOfBenefit.total:outofnetwork.extension
Definition

May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

ShortAdditional content defined by implementations
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

Control0..*
TypeExtension
Is Modifierfalse
Summaryfalse
Alternate Namesextensions, user content
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
390. ExplanationOfBenefit.total:outofnetwork.modifierExtension
Definition

May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

ShortExtensions that cannot be ignored even if unrecognized
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

Control0..*
TypeExtension
Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
Summarytrue
Requirements

Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

Alternate Namesextensions, user content, modifiers
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
392. ExplanationOfBenefit.total:outofnetwork.category
Definition

A code to indicate the information type of this adjudication record. Information types may include: the value submitted, maximum values or percentages allowed or payable under the plan, amounts that the patient is responsible for in aggregate or pertaining to this item, amounts paid by other coverages, and the benefit payable for this item.

ShortType of adjudication information
Comments

For example, codes indicating: Co-Pay, deductible, eligible, benefit, tax, etc.

Control1..1
BindingFor example codes, see AdjudicationValueCodes
(example to http://hl7.org/fhir/ValueSet/adjudication|4.0.1)

The adjudication codes.

TypeCodeableConcept
Is Modifierfalse
Summarytrue
Requirements

Needed to convey the type of total provided.

Pattern Value
{
  "coding" : [
    {
      "system" : "http://hl7.org/fhir/us/davinci-pct/CodeSystem/PCTNetworkStatusCS",
      "code" : "outofnetwork"
    }
  ]
}
<category>
  <coding>
    <system value="http://hl7.org/fhir/us/davinci-pct/CodeSystem/PCTNetworkStatusCS"/>
    <code value="outofnetwork"/>
  </coding>
</category>
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
394. ExplanationOfBenefit.total:outofnetwork.amount
Definition

Monetary total amount associated with the category.

ShortFinancial total for the category
Control1..1
TypeMoney
Is Modifierfalse
Summarytrue
Requirements

Needed to convey the total monetary amount.

Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
396. ExplanationOfBenefit.total:noncovered
Slice Namenoncovered
Definition

Categorized monetary totals for the adjudication.

ShortTotal noncovered amount - only include when total type is applicable
Comments

Totals for amounts submitted, co-pays, benefits payable etc.

Control0..1
TypeBackboneElement
Is Modifierfalse
Must Supporttrue
Summarytrue
Requirements

To provide the requestor with financial totals by category for the adjudication.

Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
398. ExplanationOfBenefit.total:noncovered.id
Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

ShortUnique id for inter-element referencing
Control0..1
Typestring
Is Modifierfalse
XML FormatIn the XML format, this property is represented as an attribute.
Summaryfalse
400. ExplanationOfBenefit.total:noncovered.extension
Definition

May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

ShortAdditional content defined by implementations
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

Control0..*
TypeExtension
Is Modifierfalse
Summaryfalse
Alternate Namesextensions, user content
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
402. ExplanationOfBenefit.total:noncovered.modifierExtension
Definition

May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

ShortExtensions that cannot be ignored even if unrecognized
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

Control0..*
TypeExtension
Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
Summarytrue
Requirements

Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

Alternate Namesextensions, user content, modifiers
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
404. ExplanationOfBenefit.total:noncovered.category
Definition

A code to indicate the information type of this adjudication record. Information types may include: the value submitted, maximum values or percentages allowed or payable under the plan, amounts that the patient is responsible for in aggregate or pertaining to this item, amounts paid by other coverages, and the benefit payable for this item.

ShortType of adjudication information
Comments

For example, codes indicating: Co-Pay, deductible, eligible, benefit, tax, etc.

Control1..1
BindingFor example codes, see AdjudicationValueCodes
(example to http://hl7.org/fhir/ValueSet/adjudication|4.0.1)

The adjudication codes.

TypeCodeableConcept
Is Modifierfalse
Summarytrue
Requirements

Needed to convey the type of total provided.

Pattern Value
{
  "coding" : [
    {
      "system" : "http://hl7.org/fhir/us/davinci-pct/CodeSystem/PCTAdjudication",
      "code" : "noncovered"
    }
  ]
}
<category>
  <coding>
    <system value="http://hl7.org/fhir/us/davinci-pct/CodeSystem/PCTAdjudication"/>
    <code value="noncovered"/>
  </coding>
</category>
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
406. ExplanationOfBenefit.total:noncovered.amount
Definition

Monetary total amount associated with the category.

ShortFinancial total for the category
Control1..1
TypeMoney
Is Modifierfalse
Summarytrue
Requirements

Needed to convey the total monetary amount.

Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
408. ExplanationOfBenefit.total:negotiated
Slice Namenegotiated
Definition

Categorized monetary totals for the adjudication.

ShortTotal negotiated amount - Total for special negotiated status for a service or product in relation to a patient's coverage that is established outside of a formal network contract
Comments

Totals for amounts submitted, co-pays, benefits payable etc.

Control0..1
TypeBackboneElement
Is Modifierfalse
Must Supporttrue
Summarytrue
Requirements

To provide the requestor with financial totals by category for the adjudication.

Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
410. ExplanationOfBenefit.total:negotiated.id
Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

ShortUnique id for inter-element referencing
Control0..1
Typestring
Is Modifierfalse
XML FormatIn the XML format, this property is represented as an attribute.
Summaryfalse
412. ExplanationOfBenefit.total:negotiated.extension
Definition

May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

ShortAdditional content defined by implementations
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

Control0..*
TypeExtension
Is Modifierfalse
Summaryfalse
Alternate Namesextensions, user content
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
414. ExplanationOfBenefit.total:negotiated.modifierExtension
Definition

May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

ShortExtensions that cannot be ignored even if unrecognized
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

Control0..*
TypeExtension
Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
Summarytrue
Requirements

Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

Alternate Namesextensions, user content, modifiers
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
416. ExplanationOfBenefit.total:negotiated.category
Definition

A code to indicate the information type of this adjudication record. Information types may include: the value submitted, maximum values or percentages allowed or payable under the plan, amounts that the patient is responsible for in aggregate or pertaining to this item, amounts paid by other coverages, and the benefit payable for this item.

ShortType of adjudication information
Comments

For example, codes indicating: Co-Pay, deductible, eligible, benefit, tax, etc.

Control1..1
BindingFor example codes, see AdjudicationValueCodes
(example to http://hl7.org/fhir/ValueSet/adjudication|4.0.1)

The adjudication codes.

TypeCodeableConcept
Is Modifierfalse
Summarytrue
Requirements

Needed to convey the type of total provided.

Pattern Value
{
  "coding" : [
    {
      "system" : "http://hl7.org/fhir/us/davinci-pct/CodeSystem/PCTNetworkStatusCS",
      "code" : "negotiated"
    }
  ]
}
<category>
  <coding>
    <system value="http://hl7.org/fhir/us/davinci-pct/CodeSystem/PCTNetworkStatusCS"/>
    <code value="negotiated"/>
  </coding>
</category>
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
418. ExplanationOfBenefit.total:negotiated.amount
Definition

Monetary total amount associated with the category.

ShortFinancial total for the category
Control1..1
TypeMoney
Is Modifierfalse
Summarytrue
Requirements

Needed to convey the total monetary amount.

Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
420. ExplanationOfBenefit.total:benefit
Slice Namebenefit
Definition

Categorized monetary totals for the adjudication.

ShortTotal benefit amount - only include when total type is applicable
Comments

Benefit is similar to allowed amount. Eligible amount and Benefit amount may be different or the same, but if they are different the payer can supply both for the full picture of the estimate.

Control0..1
TypeBackboneElement
Is Modifierfalse
Must Supporttrue
Summarytrue
Requirements

To provide the requestor with financial totals by category for the adjudication.

Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
422. ExplanationOfBenefit.total:benefit.id
Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

ShortUnique id for inter-element referencing
Control0..1
Typestring
Is Modifierfalse
XML FormatIn the XML format, this property is represented as an attribute.
Summaryfalse
424. ExplanationOfBenefit.total:benefit.extension
Definition

May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

ShortAdditional content defined by implementations
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

Control0..*
TypeExtension
Is Modifierfalse
Summaryfalse
Alternate Namesextensions, user content
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
426. ExplanationOfBenefit.total:benefit.modifierExtension
Definition

May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

ShortExtensions that cannot be ignored even if unrecognized
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

Control0..*
TypeExtension
Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
Summarytrue
Requirements

Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

Alternate Namesextensions, user content, modifiers
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
428. ExplanationOfBenefit.total:benefit.category
Definition

A code to indicate the information type of this adjudication record. Information types may include: the value submitted, maximum values or percentages allowed or payable under the plan, amounts that the patient is responsible for in aggregate or pertaining to this item, amounts paid by other coverages, and the benefit payable for this item.

ShortType of adjudication information
Comments

For example, codes indicating: Co-Pay, deductible, eligible, benefit, tax, etc.

Control1..1
BindingFor example codes, see AdjudicationValueCodes
(example to http://hl7.org/fhir/ValueSet/adjudication|4.0.1)

The adjudication codes.

TypeCodeableConcept
Is Modifierfalse
Summarytrue
Requirements

Needed to convey the type of total provided.

Pattern Value
{
  "coding" : [
    {
      "system" : "http://terminology.hl7.org/CodeSystem/adjudication",
      "code" : "benefit"
    }
  ]
}
<category>
  <coding>
    <system value="http://terminology.hl7.org/CodeSystem/adjudication"/>
    <code value="benefit"/>
  </coding>
</category>
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
430. ExplanationOfBenefit.total:benefit.amount
Definition

Monetary total amount associated with the category.

ShortFinancial total for the category
Control1..1
TypeMoney
Is Modifierfalse
Summarytrue
Requirements

Needed to convey the total monetary amount.

Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
432. ExplanationOfBenefit.payment
Definition

Payment details for the adjudication of the claim.

ShortPayment Details
Control0..0
TypeBackboneElement
Is Modifierfalse
Summaryfalse
Requirements

Needed to convey references to the financial instrument that has been used if payment has been made.

Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
443. ExplanationOfBenefit.formCode
Definition

A code for the form to be used for printing the content.

ShortPrinted form identifier
Comments

May be needed to identify specific jurisdictional forms.

Control0..1
BindingFor example codes, see Form Codes
(example to http://hl7.org/fhir/ValueSet/forms|4.0.1)

The forms codes.

TypeCodeableConcept
Is Modifierfalse
Summaryfalse
Requirements

Needed to specify the specific form used for producing output for this response.

Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
445. ExplanationOfBenefit.form
Definition

The actual form, by reference or inclusion, for printing the content or an EOB.

ShortPrinted reference or actual form
Comments

Needed to permit insurers to include the actual form.

Control0..1
TypeAttachment
Is Modifierfalse
Summaryfalse
Requirements

Needed to include the specific form used for producing output for this response.

Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
447. ExplanationOfBenefit.processNote
Definition

A note that describes or explains adjudication results in a human readable form.

ShortDisclaimers go here. Notes should be clear and as specific to the situation at hand as possible including any additional assumptions and requirements. This may include notes about prior authorization, out of network providers, benefit period, and other legal or otherwise required disclaimers.
Comments

These disclaimers may include, but are not limited to things such as: notes on prior authorization or other medical management requirements, provider discounts, limitations, preconditions, assumptions, information known to be missing in the estimate, conditions that may affect the estimate, or anything that may affect the interpretation of the estimate.

Control1..*
TypeBackboneElement
Is Modifierfalse
Summaryfalse
Requirements

Provides the insurer specific textual explanations associated with the processing.

Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
449. ExplanationOfBenefit.processNote.id
Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

ShortUnique id for inter-element referencing
Control0..1
Typestring
Is Modifierfalse
XML FormatIn the XML format, this property is represented as an attribute.
Summaryfalse
451. ExplanationOfBenefit.processNote.extension
Definition

An Extension

ShortExtension
Control0..*
TypeExtension
Is Modifierfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
SlicingThis element introduces a set of slices on ExplanationOfBenefit.processNote.extension. The slices are Unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
453. ExplanationOfBenefit.processNote.extension:processNoteClass
Slice NameprocessNoteClass
Definition

This extension is used to indicate a the class of AEOB Claim process notes

ShortProcessNote Class
Control0..1
This element is affected by the following invariants: ele-1
TypeExtension(ProcessNote Class) (Extension Type: CodeableConcept)
Is Modifierfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
455. ExplanationOfBenefit.processNote.modifierExtension
Definition

May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

ShortExtensions that cannot be ignored even if unrecognized
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

Control0..*
TypeExtension
Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
Summarytrue
Requirements

Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

Alternate Namesextensions, user content, modifiers
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
457. ExplanationOfBenefit.processNote.number
Definition

A number to uniquely identify a note entry.

ShortNote instance identifier
Control0..1
TypepositiveInt
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summaryfalse
Requirements

Necessary to provide a mechanism to link from adjudications.

Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
459. ExplanationOfBenefit.processNote.type
Definition

The business purpose of the note text.

Shortdisplay | print | printoper
Control0..1
BindingThe codes SHALL be taken from NoteType
(required to http://hl7.org/fhir/ValueSet/note-type|4.0.1)

The presentation types of notes.

Typecode
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summaryfalse
Requirements

To convey the expectation for when the text is used.

Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
461. ExplanationOfBenefit.processNote.text
Definition

The explanation or description associated with the processing.

ShortNote explanatory text
Control0..1
Typestring
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summaryfalse
Requirements

Required to provide human readable explanation.

Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
463. ExplanationOfBenefit.processNote.language
Definition

A code to define the language used in the text of the note.

ShortLanguage of the text
Comments

Only required if the language is different from the resource language.

Control0..1
BindingThe codes SHOULD be taken from CommonLanguages
(preferred to http://hl7.org/fhir/ValueSet/languages|4.0.1)

A human language.

Additional BindingsPurpose
AllLanguagesMax Binding
TypeCodeableConcept
Is Modifierfalse
Summaryfalse
Requirements

Note text may vary from the resource defined language.

Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
465. ExplanationOfBenefit.benefitPeriod
Definition

The term of the benefits documented in this response.

ShortWhen the benefits are applicable
Comments

Not applicable when use=claim.

Control1..1
TypePeriod
Is Modifierfalse
Summaryfalse
Requirements

Needed as coverages may be multi-year while benefits tend to be annual therefore a separate expression of the benefit period is needed.

Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
467. ExplanationOfBenefit.benefitBalance
Definition

Estimated Balance by Benefit Category as if the expected item(s) or service(s) included in this estimate were applied. Note: The available balance is based on known claims and does not account for other Good Faith Estimates (GFEs). Benefit balances will remain unchanged until the claim adjudication process applies benefits. Consequently, if multiple estimates pertain to the same benefit, the benefit balance will not consider other estimates.

ShortEstimated Balance by Benefit Category as if the expected item(s) or service(s) included in this estimate were applied.
Control1..*
TypeBackboneElement
Is Modifierfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
469. ExplanationOfBenefit.benefitBalance.id
Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

ShortUnique id for inter-element referencing
Control0..1
Typestring
Is Modifierfalse
XML FormatIn the XML format, this property is represented as an attribute.
Summaryfalse
471. ExplanationOfBenefit.benefitBalance.extension
Definition

May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

ShortAdditional content defined by implementations
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

Control0..*
TypeExtension
Is Modifierfalse
Summaryfalse
Alternate Namesextensions, user content
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
473. ExplanationOfBenefit.benefitBalance.modifierExtension
Definition

May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

ShortExtensions that cannot be ignored even if unrecognized
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

Control0..*
TypeExtension
Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
Summarytrue
Requirements

Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

Alternate Namesextensions, user content, modifiers
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
475. ExplanationOfBenefit.benefitBalance.category
Definition

Code to identify the general type of benefits under which products and services are provided.

ShortBenefit classification
Comments

Examples include Medical Care, Periodontics, Renal Dialysis, Vision Coverage.

Control1..1
BindingThe codes SHALL be taken from PCT benefitBalance.category codes
(required to http://hl7.org/fhir/us/davinci-pct/ValueSet/PCTBenefitBalanceCategoryVS)
TypeCodeableConcept
Is Modifierfalse
Summaryfalse
Requirements

Needed to convey the category of service or product for which eligibility is sought.

Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
477. ExplanationOfBenefit.benefitBalance.category.id
Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

ShortUnique id for inter-element referencing
Control0..1
Typestring
Is Modifierfalse
XML FormatIn the XML format, this property is represented as an attribute.
Summaryfalse
479. ExplanationOfBenefit.benefitBalance.category.extension
Definition

May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

ShortAdditional content defined by implementations
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

Control0..*
TypeExtension
Is Modifierfalse
Summaryfalse
Alternate Namesextensions, user content
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
SlicingThis element introduces a set of slices on ExplanationOfBenefit.benefitBalance.category.extension. The slices are Unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
481. ExplanationOfBenefit.benefitBalance.category.coding
Definition

A reference to a code defined by a terminology system.

ShortCode defined by a terminology system
Comments

Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true.

Control0..*
TypeCoding
Is Modifierfalse
Summarytrue
Requirements

Allows for alternative encodings within a code system, and translations to other code systems.

Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
483. ExplanationOfBenefit.benefitBalance.category.text
Definition

A human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user.

ShortPlain text representation of the concept
Comments

Very often the text is the same as a displayName of one of the codings.

Control1..1
Typestring
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Must Supporttrue
Summarytrue
Requirements

The codes from the terminologies do not always capture the correct meaning with all the nuances of the human using them, or sometimes there is no appropriate code at all. In these cases, the text is used to capture the full meaning of the source.

Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
485. ExplanationOfBenefit.benefitBalance.excluded
Definition

True if the indicated class of service is excluded from the plan, missing or False indicates the product or service is included in the coverage.

ShortExcluded from the plan
Control0..1
Typeboolean
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summaryfalse
Requirements

Needed to identify items that are specifically excluded from the coverage.

Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
487. ExplanationOfBenefit.benefitBalance.name
Definition

A short name or tag for the benefit.

ShortShort name for the benefit
Comments

For example: MED01, or DENT2.

Control0..1
Typestring
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summaryfalse
Requirements

Required to align with other plan names.

Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
489. ExplanationOfBenefit.benefitBalance.description
Definition

A richer description of the benefit or services covered.

ShortDescription of the benefit or services covered
Comments

For example, 'DENT2 covers 100% of basic, 50% of major but excludes Ortho, Implants and Cosmetic services'.

Control0..1
Typestring
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summaryfalse
Requirements

Needed for human readable reference.

Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
491. ExplanationOfBenefit.benefitBalance.network
Definition

Is a flag to indicate whether the benefits refer to in-network providers or out-of-network providers.

ShortIn or out of network
Control0..1
BindingFor example codes, see NetworkTypeCodes
(example to http://hl7.org/fhir/ValueSet/benefit-network|4.0.1)

Code to classify in or out of network services.

TypeCodeableConcept
Is Modifierfalse
Summaryfalse
Requirements

Needed as in or out of network providers are treated differently under the coverage.

Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
493. ExplanationOfBenefit.benefitBalance.unit
Definition

Indicates if the benefits apply to an individual or to the family.

ShortIndividual or family
Control1..1
BindingThe codes SHALL be taken from UnitTypeCodes
(required to http://hl7.org/fhir/ValueSet/benefit-unit)
TypeCodeableConcept
Is Modifierfalse
Summaryfalse
Requirements

Needed for the understanding of the benefits.

Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
495. ExplanationOfBenefit.benefitBalance.term
Definition

The term or period of the values such as 'maximum lifetime benefit' or 'maximum annual visits'.

ShortAnnual or lifetime
Control1..1
BindingThe codes SHALL be taken from BenefitTermCodes
(required to http://hl7.org/fhir/ValueSet/benefit-term)
TypeCodeableConcept
Is Modifierfalse
Summaryfalse
Requirements

Needed for the understanding of the benefits.

Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
497. ExplanationOfBenefit.benefitBalance.financial
Definition

Benefits Used to date.

ShortBenefit Summary
Control1..*
TypeBackboneElement
Is Modifierfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
499. ExplanationOfBenefit.benefitBalance.financial.id
Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

ShortUnique id for inter-element referencing
Control0..1
Typestring
Is Modifierfalse
XML FormatIn the XML format, this property is represented as an attribute.
Summaryfalse
501. ExplanationOfBenefit.benefitBalance.financial.extension
Definition

An Extension

ShortExtension
Control0..*
TypeExtension
Is Modifierfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
SlicingThis element introduces a set of slices on ExplanationOfBenefit.benefitBalance.financial.extension. The slices are Unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
503. ExplanationOfBenefit.benefitBalance.financial.extension:remaining
Slice Nameremaining
Definition

The quantity of the benefit remaining to date.

ShortBenefit Remaining
Control0..1
This element is affected by the following invariants: ele-1
TypeExtension(Benefit Remaining) (Extension Type: Choice of: unsignedInt, Money)
Is Modifierfalse
Must Supporttrue
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
505. ExplanationOfBenefit.benefitBalance.financial.modifierExtension
Definition

May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

ShortExtensions that cannot be ignored even if unrecognized
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

Control0..*
TypeExtension
Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
Summarytrue
Requirements

Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

Alternate Namesextensions, user content, modifiers
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
507. ExplanationOfBenefit.benefitBalance.financial.type
Definition

Classification of benefit being provided.

ShortBenefit classification
Comments

For example: deductible, visits, benefit amount.

Control1..1
BindingThe codes SHALL be taken from PCT Financial Type Value Set
(required to http://hl7.org/fhir/us/davinci-pct/ValueSet/PCTFinancialTypeVS)
TypeCodeableConcept
Is Modifierfalse
Summaryfalse
Requirements

Needed to convey the nature of the benefit.

Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
509. ExplanationOfBenefit.benefitBalance.financial.allowed[x]
Definition

The quantity of the benefit which is permitted under the coverage.

ShortBenefits allowed
Control1..1
TypeMoney
[x] NoteSeeChoice of Data Typesfor further information about how to use [x]
Is Modifierfalse
Summaryfalse
Requirements

Needed to convey the benefits offered under the coverage.

Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
SlicingThis element introduces a set of slices on ExplanationOfBenefit.benefitBalance.financial.allowed[x]. The slices are Unordered and Closed, and can be differentiated using the following discriminators:
  • type @ $this
511. ExplanationOfBenefit.benefitBalance.financial.allowed[x]:allowedMoney
Slice NameallowedMoney
Definition

The quantity of the benefit which is permitted under the coverage.

ShortBenefits allowed
Control1..1
TypeMoney
[x] NoteSeeChoice of Data Typesfor further information about how to use [x]
Is Modifierfalse
Summaryfalse
Requirements

Needed to convey the benefits offered under the coverage.

Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
513. ExplanationOfBenefit.benefitBalance.financial.used[x]
Definition

The quantity of the benefit which have been consumed to date.

ShortBenefits used
Control1..1
TypeMoney
[x] NoteSeeChoice of Data Typesfor further information about how to use [x]
Is Modifierfalse
Summaryfalse
Requirements

Needed to convey the benefits consumed to date.

Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
SlicingThis element introduces a set of slices on ExplanationOfBenefit.benefitBalance.financial.used[x]. The slices are Unordered and Closed, and can be differentiated using the following discriminators:
  • type @ $this
515. ExplanationOfBenefit.benefitBalance.financial.used[x]:usedMoney
Slice NameusedMoney
Definition

The quantity of the benefit which have been consumed to date.

ShortBenefits used
Control1..1
TypeMoney
[x] NoteSeeChoice of Data Typesfor further information about how to use [x]
Is Modifierfalse
Summaryfalse
Requirements

Needed to convey the benefits consumed to date.

Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))