CARIN Consumer Directed Payer Data Exchange (CARIN IG for Blue Button®)
1.1.0 - STU1 Update

This page is part of the CARIN Blue Button Implementation Guide (v1.1.0: STU 1) based on FHIR R4. The current version which supercedes this version is 2.0.0. For a full list of available versions, see the Directory of published versions

Resource Profile: C4BBExplanationOfBenefitOutpatientInstitutional - Detailed Descriptions

Definitions for the C4BB-ExplanationOfBenefit-Outpatient-Institutional resource profile.

1. 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.

Control0..*
Alternate NamesEOB
InvariantsDefined on this element
EOB-inst-pointoforigin: Where Admission Type and Point of Origin slices exist, if Type of Admission code is Newborn, Point of Origin must be from Point of Origin - Newborn CodeSystem or Type of Admission is not Newborn and Point of Origin must be from Point of Origin Nonnewborn CodeSystem. (: (supportingInfo.where(code.coding.system = 'https://www.nubc.org/CodeSystem/PriorityTypeOfAdmitOrVisit' and code.coding.code = '4').exists() and supportingInfo.where(code.coding.system='AHANUBCPointOfOriginForAdmissionOrVisitNonnewborn').exists()).not() and (supportingInfo.where(code.coding.system = 'https://www.nubc.org/CodeSystem/PriorityTypeOfAdmitOrVisit' and code.coding.code != '4').exists() and supportingInfo.where(code.coding.system = 'https://www.nubc.org/CodeSystem/PointOfOriginNewborn').exists() ).not())
EOB-institutional-item-or-header-adjudication: Institutional EOB: Should have adjudication at the item or header level, but not both (: (adjudication.exists() != item.adjudication.exists()))
dom-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.

Control0..1
Typestring
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.

3. 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.

Control1..1
TypeMeta
Must Supporttrue
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
4. ExplanationOfBenefit.meta.id
Definition

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

Control0..1
Typestring
5. ExplanationOfBenefit.meta.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.

Control0..*
TypeExtension
Alternate Namesextensions, user content
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.

InvariantsDefined on this element
ele-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.meta.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
6. ExplanationOfBenefit.meta.versionId
Definition

The version specific identifier, as it appears in the version portion of the URL. This value changes when the resource is created, updated, or deleted.

Control0..1
Typeid
Comments

The server assigns this value, and ignores what the client specifies, except in the case that the server is imposing version integrity on updates/deletes.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
7. ExplanationOfBenefit.meta.lastUpdated
Definition

When the resource last changed - e.g. when the version changed.

Control1..1
Typeinstant
Must Supporttrue
Comments

Defines the date the Resource was created or updated, whichever comes last (163). Payers SHALL provide the last time the data was updated or the date of creation in the payer’s system of record, whichever comes last

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
8. ExplanationOfBenefit.meta.source
Definition

A uri that identifies the source system of the resource. This provides a minimal amount of Provenance information that can be used to track or differentiate the source of information in the resource. The source may identify another FHIR server, document, message, database, etc.

Control0..1
Typeuri
Comments

In the provenance resource, this corresponds to Provenance.entity.what[x]. The exact use of the source (and the implied Provenance.entity.role) is left to implementer discretion. Only one nominated source is allowed; for additional provenance details, a full Provenance resource should be used.

This element can be used to indicate where the current master source of a resource that has a canonical URL if the resource is no longer hosted at the canonical URL.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
9. ExplanationOfBenefit.meta.profile
Definition

A list of profiles (references to StructureDefinition resources) that this resource claims to conform to. The URL is a reference to StructureDefinition.url.

Control1..*
Typecanonical(StructureDefinition)
Comments

meta.profile is required as a matter of convenience of receiving systems. The meta.profile should be used by the Server to hint/assert/declare that this instance conforms to one (or more) stated profiles (with business versions). meta.profile does not capture any business logic, processing directives, or semantics (for example, inpatient or outpatient). Clients should not assume that the Server will exhaustively indicate all profiles with all versions that this instance conforms to. Clients can (and should) perform their own validation of conformance to the indicated profile(s) and to any other profiles of interest. CPCDS data element (190)

InvariantsDefined on this element
ele-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.meta.profile. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • pattern @ $this
10. ExplanationOfBenefit.meta.profile:supportedProfile
SliceNamesupportedProfile
Definition

A list of profiles (references to StructureDefinition resources) that this resource claims to conform to. The URL is a reference to StructureDefinition.url.

Control1..1
Typecanonical(StructureDefinition)
Comments

It is up to the server and/or other infrastructure of policy to determine whether/how these claims are verified and/or updated over time. The list of profile URLs is a set.

Pattern Valuehttp://hl7.org/fhir/us/carin-bb/StructureDefinition/C4BB-ExplanationOfBenefit-Outpatient-Institutional|1.1.0
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
11. ExplanationOfBenefit.meta.security
Definition

Security labels applied to this resource. These tags connect specific resources to the overall security policy and infrastructure.

Control0..*
BindingThe codes SHALL be taken from All Security Labels; other codes may be used where these codes are not suitable Security Labels from the Healthcare Privacy and Security Classification System.

TypeCoding
Comments

The security labels can be updated without changing the stated version of the resource. The list of security labels is a set. Uniqueness is based the system/code, and version and display are ignored.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
12. ExplanationOfBenefit.meta.tag
Definition

Tags applied to this resource. Tags are intended to be used to identify and relate resources to process and workflow, and applications are not required to consider the tags when interpreting the meaning of a resource.

Control0..*
BindingFor example codes, see CommonTags Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones".

TypeCoding
Comments

The tags can be updated without changing the stated version of the resource. The list of tags is a set. Uniqueness is based the system/code, and version and display are ignored.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
13. 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.

Control0..1
Typeuri
Is Modifiertrue
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.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
14. ExplanationOfBenefit.language
Definition

The base language in which the resource is written.

Control0..1
BindingThe codes SHOULD be taken from CommonLanguages
Max Binding: AllLanguages A human language.

Typecode
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).

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
15. 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.

Control0..1
TypeNarrative
Alternate Namesnarrative, html, xhtml, display
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.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
16. 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.

Control0..*
TypeResource
Alternate Namesinline resources, anonymous resources, contained 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.

17. ExplanationOfBenefit.extension
Definition

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.

Control0..*
TypeExtension
Alternate Namesextensions, user content
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.

InvariantsDefined on this element
ele-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.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).

Control0..*
TypeExtension
Is Modifiertrue
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
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.

InvariantsDefined on this element
ele-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())
19. ExplanationOfBenefit.identifier
Definition

A unique identifier assigned to this explanation of benefit.

NoteThis is a business identifier, not a resource identifier (see discussion)
Control1..*
TypeIdentifier
Must Supporttrue
Requirements

Allows EOBs to be distinguished and referenced.

Comments

Identifier assigned by a payer for a claim received from a provider or subscriber. It is not the same identifier as that assigned by a provider. (35)

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
20. ExplanationOfBenefit.identifier.id
Definition

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

Control0..1
Typestring
21. ExplanationOfBenefit.identifier.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.

Control0..*
TypeExtension
Alternate Namesextensions, user content
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.

InvariantsDefined on this element
ele-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.identifier.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
22. ExplanationOfBenefit.identifier.use
Definition

The purpose of this identifier.

Control0..1
BindingThe codes SHALL be taken from IdentifierUse Identifies the purpose for this identifier, if known .

Typecode
Is Modifiertrue
Requirements

Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers.

Comments

Applications can assume that an identifier is permanent unless it explicitly says that it is temporary.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
23. ExplanationOfBenefit.identifier.type
Definition

A coded type for the identifier that can be used to determine which identifier to use for a specific purpose.

Control1..1
BindingThe codes SHALL be taken from C4BB Claim Identifier Type; other codes may be used where these codes are not suitable
TypeCodeableConcept
Must Supporttrue
Requirements

Allows users to make use of identifiers when the identifier system is not known.

Comments

Indicates that the claim identifier is that assigned by a payer for a claim received from a provider or subscriber. (183)

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
24. ExplanationOfBenefit.identifier.system
Definition

Establishes the namespace for the value - that is, a URL that describes a set values that are unique.

Control0..1
Typeuri
Requirements

There are many sets of identifiers. To perform matching of two identifiers, we need to know what set we're dealing with. The system identifies a particular set of unique identifiers.

Comments

Identifier.system is always case sensitive.

Example
General:http://www.acme.com/identifiers/patient
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
25. ExplanationOfBenefit.identifier.value
Definition

The portion of the identifier typically relevant to the user and which is unique within the context of the system.

Control0..1
Typestring
Comments

If the value is a full URI, then the system SHALL be urn:ietf:rfc:3986. The value's primary purpose is computational mapping. As a result, it may be normalized for comparison purposes (e.g. removing non-significant whitespace, dashes, etc.) A value formatted for human display can be conveyed using the Rendered Value extension. Identifier.value is to be treated as case sensitive unless knowledge of the Identifier.system allows the processer to be confident that non-case-sensitive processing is safe.

Example
General:123456
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
26. ExplanationOfBenefit.identifier.period
Definition

Time period during which identifier is/was valid for use.

Control0..1
TypePeriod
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
27. ExplanationOfBenefit.identifier.assigner
Definition

Organization that issued/manages the identifier.

Control0..1
TypeReference(Organization)
Comments

The Identifier.assigner may omit the .reference element and only contain a .display element reflecting the name or other textual information about the assigning organization.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
28. ExplanationOfBenefit.status
Definition

The status of the resource instance.

Control1..1
BindingThe codes SHALL be taken from ExplanationOfBenefitStatus A code specifying the state of the resource instance.

Typecode
Is Modifiertrue
Must Supporttrue
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'.

Comments

Claim processing status code (140). Expected values are active or cancelled. To comply with the CMS rule, draft EOBs are not required

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
29. ExplanationOfBenefit.type
Definition

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

Control1..1
BindingThe codes SHALL be taken from ClaimTypeCodes
TypeCodeableConcept
Must Supporttrue
Requirements

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

Comments

Specifies the type of claim. (e.g., inpatient insitutional, outpatient institutional, physician, etc.) (16). Defines the Claims profiles. Values from Claim Type Codes are required; a data absent reason is not allowed

Pattern Value<valueCodeableConcept xmlns="http://hl7.org/fhir">
  <coding>
    <system value="http://terminology.hl7.org/CodeSystem/claim-type"/>
    <code value="institutional"/>
  </coding>
</valueCodeableConcept>
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
30. 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.

Control1..1
BindingThe codes SHALL be taken from C4BB Institutional Claim SubType
TypeCodeableConcept
Must Supporttrue
Requirements

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

Comments

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

Pattern Value<valueCodeableConcept xmlns="http://hl7.org/fhir">
  <coding>
    <system value="http://hl7.org/fhir/us/carin-bb/CodeSystem/C4BBInstitutionalClaimSubType"/>
    <code value="outpatient"/>
  </coding>
</valueCodeableConcept>
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
31. 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.

Control1..1
BindingThe codes SHALL be taken from Use Complete, proposed, exploratory, other.

Typecode
Must Supporttrue
Requirements

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

Comments

Expected value is claim. The CMS rule applies to adjudicated claims; it does not require preauthorizations or predeterminations

Pattern Valueclaim
InvariantsDefined on this element
ele-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.

Control1..1
TypeReference(C4BBPatient)
Must Supporttrue
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.

Comments

Identifier for a member assigned by the Payer. If members receive ID cards, that is the identifier that should be provided. (1). 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. Additional required path:EOB.insurance.coverage(Coverage).beneficiary(Patient).identifier

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
33. ExplanationOfBenefit.billablePeriod
Definition

The period for which charges are being submitted.

Control0..1
TypePeriod
Must Supporttrue
Requirements

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

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.

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

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

Control0..1
Typestring
35. ExplanationOfBenefit.billablePeriod.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.

Control0..*
TypeExtension
Alternate Namesextensions, user content
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.

InvariantsDefined on this element
ele-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.billablePeriod.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
36. ExplanationOfBenefit.billablePeriod.start
Definition

The start of the period. The boundary is inclusive.

Control0..1 This element is affected by the following invariants: per-1
TypedateTime
Comments

The first day on the billing statement covering services rendered to the beneficiary (i.e. 'Statement Covers From Date’). (177)

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
37. ExplanationOfBenefit.billablePeriod.end
Definition

The end of the period. If the end of the period is missing, it means no end was known or planned at the time the instance was created. The start may be in the past, and the end date in the future, which means that period is expected/planned to end at that time.

Control0..1 This element is affected by the following invariants: per-1
TypedateTime
Comments

The last day on the billing statement covering services rendered to the beneficiary (i.e. 'Statement Covers Thru Date’). (178)

Meaning if MissingIf the end of the period is missing, it means that the period is ongoing
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
38. ExplanationOfBenefit.created
Definition

The date this resource was created.

Control1..1
TypedateTime
Must Supporttrue
Requirements

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

Comments

Date the claim was adjudicated (179)

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
39. ExplanationOfBenefit.enterer
Definition

Individual who created the claim, predetermination or preauthorization.

Control0..1
TypeReference(Practitioner | PractitionerRole)
Requirements

Some jurisdictions require the contact information for personnel completing claims.

InvariantsDefined on this element
ele-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.

Control1..1
TypeReference(C4BBOrganization)
Must Supporttrue
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.

Comments

Code of the payer responsible for the claim (2, 5). Same as insurance.coverage.organization. Party responsible for reimbursing the provider

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
41. ExplanationOfBenefit.provider
Definition

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

Control1..1
TypeReference(C4BBOrganization)
Must Supporttrue
Comments

The identifier assigned to the Billing Provider. (94)

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
42. ExplanationOfBenefit.priority
Definition

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

Control0..1
BindingThe codes SHALL be taken from ProcessPriorityCodes
TypeCodeableConcept
Requirements

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

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.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
43. ExplanationOfBenefit.fundsReserveRequested
Definition

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

Control0..1
BindingFor example codes, see Funds Reservation Codes For whom funds are to be reserved: (Patient, Provider, None).

TypeCodeableConcept
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
Comments

This field is only used for preauthorizations.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
44. 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.

Control0..1
BindingFor example codes, see Funds Reservation Codes For whom funds are to be reserved: (Patient, Provider, None).

TypeCodeableConcept
Requirements

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

Comments

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

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
45. 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.

Control0..*
TypeBackboneElement
Must Supporttrue
Requirements

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

Comments

If the current claim represents a claim that has been adjusted and was given a prior claim number, this field represents the prior claim number. If the current claim has been adjusted; i.e., replaced by or merged to another claim number, this data element represents that new number.(111, 112)

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
46. 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.

Control0..1
Typestring
47. 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.

Control0..*
TypeExtension
Alternate Namesextensions, user content
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.

InvariantsDefined on this element
ele-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())
48. 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).

Control0..*
TypeExtension
Is Modifiertrue
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
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.

InvariantsDefined on this element
ele-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())
49. ExplanationOfBenefit.related.claim
Definition

Reference to a related claim.

Control0..1
TypeReference(Claim)
Requirements

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

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
50. ExplanationOfBenefit.related.relationship
Definition

A code to convey how the claims are related.

Control1..1
BindingThe codes SHALL be taken from C4BB Related Claim Relationship Codes
TypeCodeableConcept
Must Supporttrue
Requirements

Some insurers need a declaration of the type of relationship.

Comments

For example, prior claim or umbrella.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
51. ExplanationOfBenefit.related.reference
Definition

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

Control1..1
TypeIdentifier
Must Supporttrue
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.

Comments

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

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
52. ExplanationOfBenefit.prescription
Definition

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

Control0..1
TypeReference(MedicationRequest | VisionPrescription)
Requirements

Required to authorize the dispensing of controlled substances and devices.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
53. ExplanationOfBenefit.originalPrescription
Definition

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

Control0..1
TypeReference(MedicationRequest)
Requirements

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

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'.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
54. ExplanationOfBenefit.payee
Definition

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

Control0..1
TypeBackboneElement
Must Supporttrue
Requirements

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

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.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
55. ExplanationOfBenefit.payee.id
Definition

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

Control0..1
Typestring
56. ExplanationOfBenefit.payee.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.

Control0..*
TypeExtension
Alternate Namesextensions, user content
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.

InvariantsDefined on this element
ele-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())
57. ExplanationOfBenefit.payee.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).

Control0..*
TypeExtension
Is Modifiertrue
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
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.

InvariantsDefined on this element
ele-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())
58. ExplanationOfBenefit.payee.type
Definition

Type of Party to be reimbursed: Subscriber, provider, other.

Control1..1
BindingThe codes SHALL be taken from C4BB Payee Type
TypeCodeableConcept
Must Supporttrue
Requirements

Need to know who should receive payment with the most common situations being the Provider (assignment of benefits) or the Subscriber.

Comments

Identifies the type of recipient of the adjudication amount; i.e., provider, subscriber, beneficiary or another recipient. (120)

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
59. ExplanationOfBenefit.payee.party
Definition

Reference to the individual or organization to whom any payment will be made.

Control1..1
TypeReference(C4BBOrganization | C4BBPatient | C4BBPractitioner)
Must Supporttrue
Must Support TypesNo must-support rules about the choice of types/profiles
Requirements

Need to provide demographics if the payee is not 'subscriber' nor 'provider'.

Comments

Recipient reference (121)

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
60. ExplanationOfBenefit.referral
Definition

A reference to a referral resource.

Control0..1
TypeReference(ServiceRequest)
Requirements

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

Comments

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

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
61. ExplanationOfBenefit.facility
Definition

Facility where the services were provided.

Control0..1
TypeReference(Location)
Requirements

Insurance adjudication can be dependant on where services were delivered.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
62. ExplanationOfBenefit.claim
Definition

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

Control0..1
TypeReference(Claim)
Requirements

To provide a link to the original adjudication request.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
63. ExplanationOfBenefit.claimResponse
Definition

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

Control0..1
TypeReference(ClaimResponse)
Requirements

To provide a link to the original adjudication response.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
64. ExplanationOfBenefit.outcome
Definition

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

Control1..1
BindingThe codes SHALL be taken from ClaimProcessingCodes The result of the claim processing.

Typecode
Must Supporttrue
Requirements

To advise the requestor of an overall processing outcome.

Comments

Expected value is complete

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
65. ExplanationOfBenefit.disposition
Definition

A human readable description of the status of the adjudication.

Control0..1
Typestring
Requirements

Provided for user display.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
66. ExplanationOfBenefit.preAuthRef
Definition

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

Control0..*
Typestring
Requirements

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

Comments

This value is only present on preauthorization adjudications.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
67. ExplanationOfBenefit.preAuthRefPeriod
Definition

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

Control0..*
TypePeriod
Requirements

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

Comments

This value is only present on preauthorization adjudications.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
68. ExplanationOfBenefit.careTeam
Definition

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

Control0..*
TypeBackboneElement
Must Supporttrue
Requirements

Common to identify the responsible and supporting practitioners.

InvariantsDefined on this element
EOB-careteam-qualification: Care Team Performing physician's qualifications are from US-Core-Provider-Specialty Value Set (: ( role.where(coding.where(code in ('performing' )).exists()).exists() implies role.where(coding.where(code in ('performing' )).exists()).exists().qualification.memberOf('http://hl7.org/fhir/us/core/ValueSet/us-core-provider-specialty') ))
EOB-inst-careTeam-organization: Institutional EOB: Careteam roles refer to an organization (: ( role.where(coding.where(code in ('performing' )).exists()).exists() implies role.where(coding.where(code in ('performing' )).exists()).exists().provider.all(resolve() is Organization) ))
EOB-inst-careTeam-practitioner: Institutional EOB: Careteam roles refer to a practitioner (: ( role.where(coding.where(code in ('attending' | 'primary' | 'referring' | 'supervising')).exists()).exists() implies role.where(coding.where(code in ('attending' | 'primary' | 'referring' | 'supervising')).exists()).exists().provider.all(resolve() is Practitioner) ))
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
69. 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.

Control0..1
Typestring
70. 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.

Control0..*
TypeExtension
Alternate Namesextensions, user content
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.

InvariantsDefined on this element
ele-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())
71. 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).

Control0..*
TypeExtension
Is Modifiertrue
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
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.

InvariantsDefined on this element
ele-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())
72. ExplanationOfBenefit.careTeam.sequence
Definition

A number to uniquely identify care team entries.

Control1..1
TypepositiveInt
Requirements

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

Comments

careTeam.sequence values uniquely identify careTeam members. They do not necessarily indiate any order in which the patient was seen by the careTeam or identify any level of significance of the careTeam to the patient, etc. Client app implementations should not assign any significance to the sequence values

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
73. ExplanationOfBenefit.careTeam.provider
Definition

Member of the team who provided the product or service.

Control1..1
TypeReference(C4BBOrganization | C4BBPractitioner)
Must Supporttrue
Must Support TypesNo must-support rules about the choice of types/profiles
Requirements

Often a regulatory requirement to specify the responsible provider.

Comments

The identifier assigned to the care team. (varies depending on the profile)

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
74. ExplanationOfBenefit.careTeam.responsible
Definition

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

Control0..1
Typeboolean
Requirements

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

Comments

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

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
75. ExplanationOfBenefit.careTeam.role
Definition

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

Control1..1
BindingThe codes SHALL be taken from C4BB Claim Institutional Care Team Role
TypeCodeableConcept
Must Supporttrue
Requirements

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

Comments

The functional role of a provider on a claim. (165)

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
76. ExplanationOfBenefit.careTeam.qualification
Definition

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

Control0..1
BindingThe codes SHALL be taken from US Core Provider Speciality (NUCC)
TypeCodeableConcept
Requirements

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

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
77. ExplanationOfBenefit.supportingInfo
Definition

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

Control0..*
TypeBackboneElement
Must Supporttrue
Requirements

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

Comments

Defines data elements not available in the base EOB resource

InvariantsDefined on this element
ele-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.supportingInfo. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • pattern @ category
78. ExplanationOfBenefit.supportingInfo.id
Definition

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

Control0..1
Typestring
79. ExplanationOfBenefit.supportingInfo.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.

Control0..*
TypeExtension
Alternate Namesextensions, user content
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.

InvariantsDefined on this element
ele-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.supportingInfo.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).

Control0..*
TypeExtension
Is Modifiertrue
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
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.

InvariantsDefined on this element
ele-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())
81. ExplanationOfBenefit.supportingInfo.sequence
Definition

A number to uniquely identify supporting information entries.

Control1..1
TypepositiveInt
Requirements

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

Comments

Client app implementations should look-up supportingInfo elements based on category values instead of sequence values

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
82. ExplanationOfBenefit.supportingInfo.category
Definition

The general class of the information supplied: information; exception; accident, employment; onset, etc.

Control1..1
BindingThe codes SHALL be taken from C4BB SupportingInfo Type; other codes may be used where these codes are not suitable
TypeCodeableConcept
Requirements

Required to group or associate information items with common characteristics. For example: admission information or prior treatments.

Comments

This may contain a category for the local bill type codes.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
83. ExplanationOfBenefit.supportingInfo.code
Definition

System and code pertaining to the specific information regarding special conditions relating to the setting, treatment or patient for which care is sought.

Control0..1
BindingFor example codes, see ExceptionCodes The valuset used for additional information codes.

TypeCodeableConcept
Requirements

Required to identify the kind of additional information.

Comments

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

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
84. ExplanationOfBenefit.supportingInfo.timing[x]
Definition

The date when or period to which this information refers.

Control0..1
TypeChoice of: date, Period
[x] NoteSee Choice of Data Types for further information about how to use [x]
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
85. ExplanationOfBenefit.supportingInfo.value[x]
Definition

Additional data or information such as resources, documents, images etc. including references to the data or the actual inclusion of the data.

Control0..1
TypeChoice of: boolean, string, Quantity, Attachment, Reference(Resource)
[x] NoteSee Choice of Data Types for further information about how to use [x]
Requirements

To convey the data content to be provided when the information is more than a simple code or period.

Comments

Could be used to provide references to other resources, document. For example, could contain a PDF in an Attachment of the Police Report for an Accident.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
86. ExplanationOfBenefit.supportingInfo.reason
Definition

Provides the reason in the situation where a reason code is required in addition to the content.

Control0..1
BindingFor example codes, see MissingToothReasonCodes Reason codes for the missing teeth.

TypeCoding
Requirements

Needed when the supporting information has both a date and amount/value and requires explanation.

Comments

For example: the reason for the additional stay, or why a tooth is missing.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
87. ExplanationOfBenefit.supportingInfo:billingnetworkcontractingstatus
SliceNamebillingnetworkcontractingstatus
Definition

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

Control0..1
TypeBackboneElement
Must Supporttrue
Requirements

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

Comments

Indicates that the Billing Provider has a contract with the Plan (regardless of the network) as of the effective date of service or admission. (101)

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
88. ExplanationOfBenefit.supportingInfo:billingnetworkcontractingstatus.id
Definition

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

Control0..1
Typestring
89. ExplanationOfBenefit.supportingInfo:billingnetworkcontractingstatus.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.

Control0..*
TypeExtension
Alternate Namesextensions, user content
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.

InvariantsDefined on this element
ele-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())
90. ExplanationOfBenefit.supportingInfo:billingnetworkcontractingstatus.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).

Control0..*
TypeExtension
Is Modifiertrue
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
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.

InvariantsDefined on this element
ele-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())
91. ExplanationOfBenefit.supportingInfo:billingnetworkcontractingstatus.sequence
Definition

A number to uniquely identify supporting information entries.

Control1..1
TypepositiveInt
Requirements

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

Comments

Client app implementations should look-up supportingInfo elements based on category values instead of sequence values

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
92. ExplanationOfBenefit.supportingInfo:billingnetworkcontractingstatus.category
Definition

The general class of the information supplied: information; exception; accident, employment; onset, etc.

Control1..1
BindingThe codes SHALL be taken from C4BB SupportingInfo Type; other codes may be used where these codes are not suitable
TypeCodeableConcept
Must Supporttrue
Requirements

Required to group or associate information items with common characteristics. For example: admission information or prior treatments.

Comments

This may contain a category for the local bill type codes.

Pattern Value<valueCodeableConcept xmlns="http://hl7.org/fhir">
  <coding>
    <system value="http://hl7.org/fhir/us/carin-bb/CodeSystem/C4BBSupportingInfoType"/>
    <code value="billingnetworkcontractingstatus"/>
  </coding>
</valueCodeableConcept>
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
93. ExplanationOfBenefit.supportingInfo:billingnetworkcontractingstatus.code
Definition

System and code pertaining to the specific information regarding special conditions relating to the setting, treatment or patient for which care is sought.

Control1..1
BindingThe codes SHALL be taken from C4BB Payer Provider Contracting Status
TypeCodeableConcept
Must Supporttrue
Requirements

Required to identify the kind of additional information.

Comments

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

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
94. ExplanationOfBenefit.supportingInfo:billingnetworkcontractingstatus.timing[x]
Definition

The date when or period to which this information refers.

Control0..1
TypeChoice of: date, Period
[x] NoteSee Choice of Data Types for further information about how to use [x]
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
95. ExplanationOfBenefit.supportingInfo:billingnetworkcontractingstatus.value[x]
Definition

Additional data or information such as resources, documents, images etc. including references to the data or the actual inclusion of the data.

Control0..1
TypeChoice of: boolean, string, Quantity, Attachment, Reference(Resource)
[x] NoteSee Choice of Data Types for further information about how to use [x]
Requirements

To convey the data content to be provided when the information is more than a simple code or period.

Comments

Could be used to provide references to other resources, document. For example, could contain a PDF in an Attachment of the Police Report for an Accident.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
96. ExplanationOfBenefit.supportingInfo:billingnetworkcontractingstatus.reason
Definition

Provides the reason in the situation where a reason code is required in addition to the content.

Control0..1
BindingFor example codes, see MissingToothReasonCodes Reason codes for the missing teeth.

TypeCoding
Requirements

Needed when the supporting information has both a date and amount/value and requires explanation.

Comments

For example: the reason for the additional stay, or why a tooth is missing.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
97. ExplanationOfBenefit.supportingInfo:clmrecvddate
SliceNameclmrecvddate
Definition

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

Control0..1
TypeBackboneElement
Must Supporttrue
Requirements

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

Comments

The date the claim was received by the payer (88)

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
98. ExplanationOfBenefit.supportingInfo:clmrecvddate.id
Definition

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

Control0..1
Typestring
99. ExplanationOfBenefit.supportingInfo:clmrecvddate.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.

Control0..*
TypeExtension
Alternate Namesextensions, user content
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.

InvariantsDefined on this element
ele-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())
100. ExplanationOfBenefit.supportingInfo:clmrecvddate.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).

Control0..*
TypeExtension
Is Modifiertrue
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
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.

InvariantsDefined on this element
ele-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())
101. ExplanationOfBenefit.supportingInfo:clmrecvddate.sequence
Definition

A number to uniquely identify supporting information entries.

Control1..1
TypepositiveInt
Requirements

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

Comments

Client app implementations should look-up supportingInfo elements based on category values instead of sequence values

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
102. ExplanationOfBenefit.supportingInfo:clmrecvddate.category
Definition

The general class of the information supplied: information; exception; accident, employment; onset, etc.

Control1..1
BindingThe codes SHALL be taken from C4BB SupportingInfo Type; other codes may be used where these codes are not suitable
TypeCodeableConcept
Must Supporttrue
Requirements

Required to group or associate information items with common characteristics. For example: admission information or prior treatments.

Comments

This may contain a category for the local bill type codes.

Pattern Value<valueCodeableConcept xmlns="http://hl7.org/fhir">
  <coding>
    <system value="http://hl7.org/fhir/us/carin-bb/CodeSystem/C4BBSupportingInfoType"/>
    <code value="clmrecvddate"/>
  </coding>
</valueCodeableConcept>
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
103. ExplanationOfBenefit.supportingInfo:clmrecvddate.code
Definition

System and code pertaining to the specific information regarding special conditions relating to the setting, treatment or patient for which care is sought.

Control0..1
BindingFor example codes, see ExceptionCodes The valuset used for additional information codes.

TypeCodeableConcept
Requirements

Required to identify the kind of additional information.

Comments

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

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
104. ExplanationOfBenefit.supportingInfo:clmrecvddate.timing[x]
Definition

The date when or period to which this information refers.

Control1..1
Typedate
[x] NoteSee Choice of Data Types for further information about how to use [x]
Must Supporttrue
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
105. ExplanationOfBenefit.supportingInfo:clmrecvddate.value[x]
Definition

Additional data or information such as resources, documents, images etc. including references to the data or the actual inclusion of the data.

Control0..1
TypeChoice of: boolean, string, Quantity, Attachment, Reference(Resource)
[x] NoteSee Choice of Data Types for further information about how to use [x]
Requirements

To convey the data content to be provided when the information is more than a simple code or period.

Comments

Could be used to provide references to other resources, document. For example, could contain a PDF in an Attachment of the Police Report for an Accident.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
106. ExplanationOfBenefit.supportingInfo:clmrecvddate.reason
Definition

Provides the reason in the situation where a reason code is required in addition to the content.

Control0..1
BindingFor example codes, see MissingToothReasonCodes Reason codes for the missing teeth.

TypeCoding
Requirements

Needed when the supporting information has both a date and amount/value and requires explanation.

Comments

For example: the reason for the additional stay, or why a tooth is missing.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
107. ExplanationOfBenefit.supportingInfo:typeofbill
SliceNametypeofbill
Definition

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

Control0..1
TypeBackboneElement
Must Supporttrue
Requirements

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

Comments

UB04 (Form Locator 4) type of bill code provides specific information for payer purposes. The first digit of the three-digit number denotes the type of institution, the second digit classifies the type of care being billed, and the third digit identifies the frequency of the bill for a specific course of treatment or inpatient confinement. (17)

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
108. ExplanationOfBenefit.supportingInfo:typeofbill.id
Definition

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

Control0..1
Typestring
109. ExplanationOfBenefit.supportingInfo:typeofbill.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.

Control0..*
TypeExtension
Alternate Namesextensions, user content
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.

InvariantsDefined on this element
ele-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())
110. ExplanationOfBenefit.supportingInfo:typeofbill.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).

Control0..*
TypeExtension
Is Modifiertrue
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
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.

InvariantsDefined on this element
ele-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())
111. ExplanationOfBenefit.supportingInfo:typeofbill.sequence
Definition

A number to uniquely identify supporting information entries.

Control1..1
TypepositiveInt
Requirements

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

Comments

Client app implementations should look-up supportingInfo elements based on category values instead of sequence values

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
112. ExplanationOfBenefit.supportingInfo:typeofbill.category
Definition

The general class of the information supplied: information; exception; accident, employment; onset, etc.

Control1..1
BindingThe codes SHALL be taken from C4BB SupportingInfo Type; other codes may be used where these codes are not suitable
TypeCodeableConcept
Must Supporttrue
Requirements

Required to group or associate information items with common characteristics. For example: admission information or prior treatments.

Comments

This may contain a category for the local bill type codes.

Pattern Value<valueCodeableConcept xmlns="http://hl7.org/fhir">
  <coding>
    <system value="http://hl7.org/fhir/us/carin-bb/CodeSystem/C4BBSupportingInfoType"/>
    <code value="typeofbill"/>
  </coding>
</valueCodeableConcept>
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
113. ExplanationOfBenefit.supportingInfo:typeofbill.code
Definition

System and code pertaining to the specific information regarding special conditions relating to the setting, treatment or patient for which care is sought.

Control1..1
BindingThe codes SHALL be taken from NUBC Type of Bill Codes
TypeCodeableConcept
Must Supporttrue
Requirements

Required to identify the kind of additional information.

Comments

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

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
114. ExplanationOfBenefit.supportingInfo:typeofbill.timing[x]
Definition

The date when or period to which this information refers.

Control0..1
TypeChoice of: date, Period
[x] NoteSee Choice of Data Types for further information about how to use [x]
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
115. ExplanationOfBenefit.supportingInfo:typeofbill.value[x]
Definition

Additional data or information such as resources, documents, images etc. including references to the data or the actual inclusion of the data.

Control0..1
TypeChoice of: boolean, string, Quantity, Attachment, Reference(Resource)
[x] NoteSee Choice of Data Types for further information about how to use [x]
Requirements

To convey the data content to be provided when the information is more than a simple code or period.

Comments

Could be used to provide references to other resources, document. For example, could contain a PDF in an Attachment of the Police Report for an Accident.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
116. ExplanationOfBenefit.supportingInfo:typeofbill.reason
Definition

Provides the reason in the situation where a reason code is required in addition to the content.

Control0..1
BindingFor example codes, see MissingToothReasonCodes Reason codes for the missing teeth.

TypeCoding
Requirements

Needed when the supporting information has both a date and amount/value and requires explanation.

Comments

For example: the reason for the additional stay, or why a tooth is missing.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
117. ExplanationOfBenefit.supportingInfo:pointoforigin
SliceNamepointoforigin
Definition

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

Control0..1
TypeBackboneElement
Must Supporttrue
Requirements

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

Comments

Identifies the place where the patient was identified as needing admission to an institution. This is a two position code mapped from the standard values for the UB-04 Source of Admission code (FL-15). (13)

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
118. ExplanationOfBenefit.supportingInfo:pointoforigin.id
Definition

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

Control0..1
Typestring
119. ExplanationOfBenefit.supportingInfo:pointoforigin.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.

Control0..*
TypeExtension
Alternate Namesextensions, user content
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.

InvariantsDefined on this element
ele-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())
120. ExplanationOfBenefit.supportingInfo:pointoforigin.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).

Control0..*
TypeExtension
Is Modifiertrue
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
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.

InvariantsDefined on this element
ele-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.supportingInfo:pointoforigin.sequence
Definition

A number to uniquely identify supporting information entries.

Control1..1
TypepositiveInt
Requirements

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

Comments

Client app implementations should look-up supportingInfo elements based on category values instead of sequence values

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
122. ExplanationOfBenefit.supportingInfo:pointoforigin.category
Definition

The general class of the information supplied: information; exception; accident, employment; onset, etc.

Control1..1
BindingThe codes SHALL be taken from C4BB SupportingInfo Type; other codes may be used where these codes are not suitable
TypeCodeableConcept
Must Supporttrue
Requirements

Required to group or associate information items with common characteristics. For example: admission information or prior treatments.

Comments

This may contain a category for the local bill type codes.

Pattern Value<valueCodeableConcept xmlns="http://hl7.org/fhir">
  <coding>
    <system value="http://hl7.org/fhir/us/carin-bb/CodeSystem/C4BBSupportingInfoType"/>
    <code value="pointoforigin"/>
  </coding>
</valueCodeableConcept>
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
123. ExplanationOfBenefit.supportingInfo:pointoforigin.code
Definition

System and code pertaining to the specific information regarding special conditions relating to the setting, treatment or patient for which care is sought.

Control1..1
BindingThe codes SHALL be taken from NUBC Point Of Origin
TypeCodeableConcept
Must Supporttrue
Requirements

Required to identify the kind of additional information.

Comments

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

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
124. ExplanationOfBenefit.supportingInfo:pointoforigin.timing[x]
Definition

The date when or period to which this information refers.

Control0..1
TypeChoice of: date, Period
[x] NoteSee Choice of Data Types for further information about how to use [x]
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
125. ExplanationOfBenefit.supportingInfo:pointoforigin.value[x]
Definition

Additional data or information such as resources, documents, images etc. including references to the data or the actual inclusion of the data.

Control0..1
TypeChoice of: boolean, string, Quantity, Attachment, Reference(Resource)
[x] NoteSee Choice of Data Types for further information about how to use [x]
Requirements

To convey the data content to be provided when the information is more than a simple code or period.

Comments

Could be used to provide references to other resources, document. For example, could contain a PDF in an Attachment of the Police Report for an Accident.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
126. ExplanationOfBenefit.supportingInfo:pointoforigin.reason
Definition

Provides the reason in the situation where a reason code is required in addition to the content.

Control0..1
BindingFor example codes, see MissingToothReasonCodes Reason codes for the missing teeth.

TypeCoding
Requirements

Needed when the supporting information has both a date and amount/value and requires explanation.

Comments

For example: the reason for the additional stay, or why a tooth is missing.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
127. ExplanationOfBenefit.supportingInfo:admtype
SliceNameadmtype
Definition

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

Control0..1
TypeBackboneElement
Must Supporttrue
Requirements

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

Comments

Priority of the admission. Information located on (UB04 Form Locator 14). For example, an admission type of elective indicates that the patient's condition permitted time for medical services to be scheduled. (14)

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
128. ExplanationOfBenefit.supportingInfo:admtype.id
Definition

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

Control0..1
Typestring
129. ExplanationOfBenefit.supportingInfo:admtype.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.

Control0..*
TypeExtension
Alternate Namesextensions, user content
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.

InvariantsDefined on this element
ele-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())
130. ExplanationOfBenefit.supportingInfo:admtype.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).

Control0..*
TypeExtension
Is Modifiertrue
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
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.

InvariantsDefined on this element
ele-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())
131. ExplanationOfBenefit.supportingInfo:admtype.sequence
Definition

A number to uniquely identify supporting information entries.

Control1..1
TypepositiveInt
Requirements

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

Comments

Client app implementations should look-up supportingInfo elements based on category values instead of sequence values

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
132. ExplanationOfBenefit.supportingInfo:admtype.category
Definition

The general class of the information supplied: information; exception; accident, employment; onset, etc.

Control1..1
BindingThe codes SHALL be taken from C4BB SupportingInfo Type; other codes may be used where these codes are not suitable
TypeCodeableConcept
Must Supporttrue
Requirements

Required to group or associate information items with common characteristics. For example: admission information or prior treatments.

Comments

This may contain a category for the local bill type codes.

Pattern Value<valueCodeableConcept xmlns="http://hl7.org/fhir">
  <coding>
    <system value="http://hl7.org/fhir/us/carin-bb/CodeSystem/C4BBSupportingInfoType"/>
    <code value="admtype"/>
  </coding>
</valueCodeableConcept>
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
133. ExplanationOfBenefit.supportingInfo:admtype.code
Definition

System and code pertaining to the specific information regarding special conditions relating to the setting, treatment or patient for which care is sought.

Control1..1
BindingThe codes SHALL be taken from NUBC Priority (Type) of Admission or Visit
TypeCodeableConcept
Must Supporttrue
Requirements

Required to identify the kind of additional information.

Comments

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

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
134. ExplanationOfBenefit.supportingInfo:admtype.timing[x]
Definition

The date when or period to which this information refers.

Control0..1
TypeChoice of: date, Period
[x] NoteSee Choice of Data Types for further information about how to use [x]
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
135. ExplanationOfBenefit.supportingInfo:admtype.value[x]
Definition

Additional data or information such as resources, documents, images etc. including references to the data or the actual inclusion of the data.

Control0..1
TypeChoice of: boolean, string, Quantity, Attachment, Reference(Resource)
[x] NoteSee Choice of Data Types for further information about how to use [x]
Requirements

To convey the data content to be provided when the information is more than a simple code or period.

Comments

Could be used to provide references to other resources, document. For example, could contain a PDF in an Attachment of the Police Report for an Accident.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
136. ExplanationOfBenefit.supportingInfo:admtype.reason
Definition

Provides the reason in the situation where a reason code is required in addition to the content.

Control0..1
BindingFor example codes, see MissingToothReasonCodes Reason codes for the missing teeth.

TypeCoding
Requirements

Needed when the supporting information has both a date and amount/value and requires explanation.

Comments

For example: the reason for the additional stay, or why a tooth is missing.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
137. ExplanationOfBenefit.supportingInfo:discharge-status
SliceNamedischarge-status
Definition

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

Control0..1
TypeBackboneElement
Must Supporttrue
Requirements

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

Comments

Patient’s status as of the discharge date for a facility stay. Information located on UB04. (Form Locator 17). (117)

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
138. ExplanationOfBenefit.supportingInfo:discharge-status.id
Definition

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

Control0..1
Typestring
139. ExplanationOfBenefit.supportingInfo:discharge-status.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.

Control0..*
TypeExtension
Alternate Namesextensions, user content
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.

InvariantsDefined on this element
ele-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())
140. ExplanationOfBenefit.supportingInfo:discharge-status.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).

Control0..*
TypeExtension
Is Modifiertrue
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
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.

InvariantsDefined on this element
ele-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())
141. ExplanationOfBenefit.supportingInfo:discharge-status.sequence
Definition

A number to uniquely identify supporting information entries.

Control1..1
TypepositiveInt
Requirements

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

Comments

Client app implementations should look-up supportingInfo elements based on category values instead of sequence values

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
142. ExplanationOfBenefit.supportingInfo:discharge-status.category
Definition

The general class of the information supplied: information; exception; accident, employment; onset, etc.

Control1..1
BindingThe codes SHALL be taken from C4BB SupportingInfo Type; other codes may be used where these codes are not suitable
TypeCodeableConcept
Must Supporttrue
Requirements

Required to group or associate information items with common characteristics. For example: admission information or prior treatments.

Comments

This may contain a category for the local bill type codes.

Pattern Value<valueCodeableConcept xmlns="http://hl7.org/fhir">
  <coding>
    <system value="http://hl7.org/fhir/us/carin-bb/CodeSystem/C4BBSupportingInfoType"/>
    <code value="discharge-status"/>
  </coding>
</valueCodeableConcept>
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
143. ExplanationOfBenefit.supportingInfo:discharge-status.code
Definition

System and code pertaining to the specific information regarding special conditions relating to the setting, treatment or patient for which care is sought.

Control1..1
BindingThe codes SHALL be taken from NUBC Patient Discharge Status Codes
TypeCodeableConcept
Must Supporttrue
Requirements

Required to identify the kind of additional information.

Comments

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

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
144. ExplanationOfBenefit.supportingInfo:discharge-status.timing[x]
Definition

The date when or period to which this information refers.

Control0..1
TypeChoice of: date, Period
[x] NoteSee Choice of Data Types for further information about how to use [x]
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
145. ExplanationOfBenefit.supportingInfo:discharge-status.value[x]
Definition

Additional data or information such as resources, documents, images etc. including references to the data or the actual inclusion of the data.

Control0..1
TypeChoice of: boolean, string, Quantity, Attachment, Reference(Resource)
[x] NoteSee Choice of Data Types for further information about how to use [x]
Requirements

To convey the data content to be provided when the information is more than a simple code or period.

Comments

Could be used to provide references to other resources, document. For example, could contain a PDF in an Attachment of the Police Report for an Accident.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
146. ExplanationOfBenefit.supportingInfo:discharge-status.reason
Definition

Provides the reason in the situation where a reason code is required in addition to the content.

Control0..1
BindingFor example codes, see MissingToothReasonCodes Reason codes for the missing teeth.

TypeCoding
Requirements

Needed when the supporting information has both a date and amount/value and requires explanation.

Comments

For example: the reason for the additional stay, or why a tooth is missing.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
147. ExplanationOfBenefit.supportingInfo:medicalrecordnumber
SliceNamemedicalrecordnumber
Definition

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

Control0..1
TypeBackboneElement
Must Supporttrue
Requirements

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

Comments

Provider submitted medical record number that can be included on the claim. (109)

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
148. ExplanationOfBenefit.supportingInfo:medicalrecordnumber.id
Definition

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

Control0..1
Typestring
149. ExplanationOfBenefit.supportingInfo:medicalrecordnumber.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.

Control0..*
TypeExtension
Alternate Namesextensions, user content
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.

InvariantsDefined on this element
ele-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.supportingInfo:medicalrecordnumber.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).

Control0..*
TypeExtension
Is Modifiertrue
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
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.

InvariantsDefined on this element
ele-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())
151. ExplanationOfBenefit.supportingInfo:medicalrecordnumber.sequence
Definition

A number to uniquely identify supporting information entries.

Control1..1
TypepositiveInt
Requirements

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

Comments

Client app implementations should look-up supportingInfo elements based on category values instead of sequence values

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
152. ExplanationOfBenefit.supportingInfo:medicalrecordnumber.category
Definition

The general class of the information supplied: information; exception; accident, employment; onset, etc.

Control1..1
BindingThe codes SHALL be taken from C4BB SupportingInfo Type; other codes may be used where these codes are not suitable
TypeCodeableConcept
Requirements

Required to group or associate information items with common characteristics. For example: admission information or prior treatments.

Comments

This may contain a category for the local bill type codes.

Pattern Value<valueCodeableConcept xmlns="http://hl7.org/fhir">
  <coding>
    <system value="http://hl7.org/fhir/us/carin-bb/CodeSystem/C4BBSupportingInfoType"/>
    <code value="medicalrecordnumber"/>
  </coding>
</valueCodeableConcept>
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
153. ExplanationOfBenefit.supportingInfo:medicalrecordnumber.code
Definition

System and code pertaining to the specific information regarding special conditions relating to the setting, treatment or patient for which care is sought.

Control0..1
BindingFor example codes, see ExceptionCodes The valuset used for additional information codes.

TypeCodeableConcept
Requirements

Required to identify the kind of additional information.

Comments

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

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
154. ExplanationOfBenefit.supportingInfo:medicalrecordnumber.timing[x]
Definition

The date when or period to which this information refers.

Control0..1
TypeChoice of: date, Period
[x] NoteSee Choice of Data Types for further information about how to use [x]
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
155. ExplanationOfBenefit.supportingInfo:medicalrecordnumber.value[x]
Definition

Additional data or information such as resources, documents, images etc. including references to the data or the actual inclusion of the data.

Control1..1
Typestring
[x] NoteSee Choice of Data Types for further information about how to use [x]
Requirements

To convey the data content to be provided when the information is more than a simple code or period.

Comments

Could be used to provide references to other resources, document. For example, could contain a PDF in an Attachment of the Police Report for an Accident.

InvariantsDefined on this element
ele-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.supportingInfo.value[x]. The slices are unordered and Closed, and can be differentiated using the following discriminators:
  • type @ $this
156. ExplanationOfBenefit.supportingInfo:medicalrecordnumber.value[x]:valueString
SliceNamevalueString
Definition

Additional data or information such as resources, documents, images etc. including references to the data or the actual inclusion of the data.

Control1..1
Typestring
[x] NoteSee Choice of Data Types for further information about how to use [x]
Must Supporttrue
Requirements

To convey the data content to be provided when the information is more than a simple code or period.

Comments

Could be used to provide references to other resources, document. For example, could contain a PDF in an Attachment of the Police Report for an Accident.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
157. ExplanationOfBenefit.supportingInfo:medicalrecordnumber.reason
Definition

Provides the reason in the situation where a reason code is required in addition to the content.

Control0..1
BindingFor example codes, see MissingToothReasonCodes Reason codes for the missing teeth.

TypeCoding
Requirements

Needed when the supporting information has both a date and amount/value and requires explanation.

Comments

For example: the reason for the additional stay, or why a tooth is missing.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
158. ExplanationOfBenefit.supportingInfo:patientaccountnumber
SliceNamepatientaccountnumber
Definition

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

Control0..1
TypeBackboneElement
Must Supporttrue
Requirements

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

Comments

Provider assigned patient account number that can be included on the claim. (109)

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
159. ExplanationOfBenefit.supportingInfo:patientaccountnumber.id
Definition

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

Control0..1
Typestring
160. ExplanationOfBenefit.supportingInfo:patientaccountnumber.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.

Control0..*
TypeExtension
Alternate Namesextensions, user content
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.

InvariantsDefined on this element
ele-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.supportingInfo:patientaccountnumber.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).

Control0..*
TypeExtension
Is Modifiertrue
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
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.

InvariantsDefined on this element
ele-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())
162. ExplanationOfBenefit.supportingInfo:patientaccountnumber.sequence
Definition

A number to uniquely identify supporting information entries.

Control1..1
TypepositiveInt
Requirements

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

Comments

Client app implementations should look-up supportingInfo elements based on category values instead of sequence values

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
163. ExplanationOfBenefit.supportingInfo:patientaccountnumber.category
Definition

The general class of the information supplied: information; exception; accident, employment; onset, etc.

Control1..1
BindingThe codes SHALL be taken from C4BB SupportingInfo Type; other codes may be used where these codes are not suitable
TypeCodeableConcept
Requirements

Required to group or associate information items with common characteristics. For example: admission information or prior treatments.

Comments

This may contain a category for the local bill type codes.

Pattern Value<valueCodeableConcept xmlns="http://hl7.org/fhir">
  <coding>
    <system value="http://hl7.org/fhir/us/carin-bb/CodeSystem/C4BBSupportingInfoType"/>
    <code value="patientaccountnumber"/>
  </coding>
</valueCodeableConcept>
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
164. ExplanationOfBenefit.supportingInfo:patientaccountnumber.code
Definition

System and code pertaining to the specific information regarding special conditions relating to the setting, treatment or patient for which care is sought.

Control0..1
BindingFor example codes, see ExceptionCodes The valuset used for additional information codes.

TypeCodeableConcept
Requirements

Required to identify the kind of additional information.

Comments

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

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
165. ExplanationOfBenefit.supportingInfo:patientaccountnumber.timing[x]
Definition

The date when or period to which this information refers.

Control0..1
TypeChoice of: date, Period
[x] NoteSee Choice of Data Types for further information about how to use [x]
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
166. ExplanationOfBenefit.supportingInfo:patientaccountnumber.value[x]
Definition

Additional data or information such as resources, documents, images etc. including references to the data or the actual inclusion of the data.

Control1..1
Typestring
[x] NoteSee Choice of Data Types for further information about how to use [x]
Requirements

To convey the data content to be provided when the information is more than a simple code or period.

Comments

Could be used to provide references to other resources, document. For example, could contain a PDF in an Attachment of the Police Report for an Accident.

InvariantsDefined on this element
ele-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.supportingInfo.value[x]. The slices are unordered and Closed, and can be differentiated using the following discriminators:
  • type @ $this
167. ExplanationOfBenefit.supportingInfo:patientaccountnumber.value[x]:valueString
SliceNamevalueString
Definition

Additional data or information such as resources, documents, images etc. including references to the data or the actual inclusion of the data.

Control1..1
Typestring
[x] NoteSee Choice of Data Types for further information about how to use [x]
Must Supporttrue
Requirements

To convey the data content to be provided when the information is more than a simple code or period.

Comments

Could be used to provide references to other resources, document. For example, could contain a PDF in an Attachment of the Police Report for an Accident.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
168. ExplanationOfBenefit.supportingInfo:patientaccountnumber.reason
Definition

Provides the reason in the situation where a reason code is required in addition to the content.

Control0..1
BindingFor example codes, see MissingToothReasonCodes Reason codes for the missing teeth.

TypeCoding
Requirements

Needed when the supporting information has both a date and amount/value and requires explanation.

Comments

For example: the reason for the additional stay, or why a tooth is missing.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
169. ExplanationOfBenefit.diagnosis
Definition

Information about diagnoses relevant to the claim items.

Control1..*
TypeBackboneElement
Requirements

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

Comments

Diagnosis codes describe an individual's disease or medical condition. (6, 7, 8, 21, 22, 23, 30)

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
170. 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.

Control0..1
Typestring
171. 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.

Control0..*
TypeExtension
Alternate Namesextensions, user content
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.

InvariantsDefined on this element
ele-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())
172. 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).

Control0..*
TypeExtension
Is Modifiertrue
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
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.

InvariantsDefined on this element
ele-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())
173. ExplanationOfBenefit.diagnosis.sequence
Definition

A number to uniquely identify diagnosis entries.

Control1..1
TypepositiveInt
Requirements

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

Comments

Diagnosis.sequence values do not necessarily indiate any order in which the diagnosis was reported or identified. client app implementations should not assign any significance to the sequence values. client app implementations should use the values of diagnosis.type to identify primary, secondary, etc.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
174. ExplanationOfBenefit.diagnosis.diagnosis[x]
Definition

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

Control1..1
BindingThe codes SHALL be taken from Diagnosis Codes - International Classification of Diseases, Clinical Modification (ICD-9-CM, ICD-10-CM)
TypeCodeableConcept
[x] NoteSee Choice of Data Types for further information about how to use [x]
Must Supporttrue
Requirements

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

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
175. ExplanationOfBenefit.diagnosis.type
Definition

When the condition was observed or the relative ranking.

Control1..1
BindingThe codes SHALL be taken from C4BB Claim Outpatient Institutional Diagnosis Type
TypeCodeableConcept
Must Supporttrue
Requirements

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

Comments

Indicates if the outpatient institutional diagnosis is principal, other, an external cause of injury or a patient reason for visit. (21, 22, 23)

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
176. ExplanationOfBenefit.diagnosis.onAdmission
Definition

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

Control0..1
BindingFor example codes, see ExampleDiagnosisOnAdmissionCodes Present on admission.

TypeCodeableConcept
Requirements

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

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
177. 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.

Control0..1
BindingFor example codes, see ExampleDiagnosisRelatedGroupCodes The DRG codes associated with the diagnosis.

TypeCodeableConcept
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.

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.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
178. ExplanationOfBenefit.procedure
Definition

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

Control0..*
TypeBackboneElement
Requirements

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

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
179. 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.

Control0..1
Typestring
180. 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.

Control0..*
TypeExtension
Alternate Namesextensions, user content
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.

InvariantsDefined on this element
ele-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())
181. 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).

Control0..*
TypeExtension
Is Modifiertrue
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
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.

InvariantsDefined on this element
ele-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())
182. ExplanationOfBenefit.procedure.sequence
Definition

A number to uniquely identify procedure entries.

Control1..1
TypepositiveInt
Requirements

Necessary to provide a mechanism to link to claim details.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
183. ExplanationOfBenefit.procedure.type
Definition

When the condition was observed or the relative ranking.

Control0..*
BindingFor example codes, see ExampleProcedureTypeCodes Example procedure type codes.

TypeCodeableConcept
Requirements

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

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
184. ExplanationOfBenefit.procedure.date
Definition

Date and optionally time the procedure was performed.

Control0..1
TypedateTime
Requirements

Required for auditing purposes.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
185. ExplanationOfBenefit.procedure.procedure[x]
Definition

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

Control1..1
BindingFor example codes, see ICD-10ProcedureCodes ICD10 Procedure codes.

TypeChoice of: CodeableConcept, Reference(Procedure)
[x] NoteSee Choice of Data Types for further information about how to use [x]
Requirements

This identifies the actual clinical procedure.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
186. ExplanationOfBenefit.procedure.udi
Definition

Unique Device Identifiers associated with this line item.

Control0..*
TypeReference(Device)
Requirements

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

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
187. ExplanationOfBenefit.precedence
Definition

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

Control0..1
TypepositiveInt
Requirements

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

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
188. ExplanationOfBenefit.insurance
Definition

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

Control1..*
TypeBackboneElement
Must Supporttrue
Requirements

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

Comments

Identity of the payers responsible for the claim. (2, 141). 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. An invariant is defined to enforce the following rule: Will have multiple occurrences on secondary / tertiary, etc. claims. Up to one occurrence, that of the ExplanationOfBenefit.insurer, will have a boolean value = 'True'

InvariantsDefined on this element
EOB-insurance-focal: EOB.insurance: at most one with focal = true (: insurance.select (focal = true).count() < 2)
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
189. 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.

Control0..1
Typestring
190. 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.

Control0..*
TypeExtension
Alternate Namesextensions, user content
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.

InvariantsDefined on this element
ele-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())
191. 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).

Control0..*
TypeExtension
Is Modifiertrue
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
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.

InvariantsDefined on this element
ele-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())
192. ExplanationOfBenefit.insurance.focal
Definition

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

Control1..1
Typeboolean
Must Supporttrue
Requirements

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

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. An invariant is defined to enforce the following rule: Will have multiple occurrences on secondary / tertiary, etc. claims. Up to one occurrence, that of the ExplanationOfBenefit.insurer, will have a boolean value = 'True'

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
193. 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.

Control1..1
TypeReference(C4BBCoverage)
Must Supporttrue
Requirements

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

Comments

Same as insurance.coverage.organization. Party responsible for reimbursing the provider. When focal = true, Coverage.payer--> Organization.identifier. When focal = false, EOB.insurance.coverage.display = [name of other carrier]

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
194. 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.

Control0..*
Typestring
Requirements

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

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.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
195. ExplanationOfBenefit.accident
Definition

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

Control0..1
TypeBackboneElement
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.

InvariantsDefined on this element
ele-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.

Control0..1
Typestring
197. 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.

Control0..*
TypeExtension
Alternate Namesextensions, user content
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.

InvariantsDefined on this element
ele-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())
198. 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).

Control0..*
TypeExtension
Is Modifiertrue
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
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.

InvariantsDefined on this element
ele-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())
199. ExplanationOfBenefit.accident.date
Definition

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

Control0..1
Typedate
Requirements

Required for audit purposes and adjudication.

Comments

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

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
200. 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.

Control0..1
BindingThe codes SHALL be taken from ActIncidentCode; other codes may be used where these codes are not suitable Type of accident: work place, auto, etc.

TypeCodeableConcept
Requirements

Coverage may be dependant on the type of accident.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
201. ExplanationOfBenefit.accident.location[x]
Definition

The physical location of the accident event.

Control0..1
TypeChoice of: Address, Reference(Location)
[x] NoteSee Choice of Data Types for further information about how to use [x]
Requirements

Required for audit purposes and determination of applicable insurance liability.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
202. 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.

Control0..*
TypeBackboneElement
Must Supporttrue
Requirements

The items to be processed for adjudication.

Comments

Put the comment here for item

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
203. ExplanationOfBenefit.item.id
Definition

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

Control0..1
Typestring
204. ExplanationOfBenefit.item.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.

Control0..*
TypeExtension
Alternate Namesextensions, user content
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.

InvariantsDefined on this element
ele-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())
205. ExplanationOfBenefit.item.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).

Control0..*
TypeExtension
Is Modifiertrue
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
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.

InvariantsDefined on this element
ele-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.item.sequence
Definition

A number to uniquely identify item entries.

Control1..1
TypepositiveInt
Must Supporttrue
Requirements

Necessary to provide a mechanism to link to items from within the claim and within the adjudication details of the ClaimResponse.

Comments

Line identification number that represents the number assigned in a source system for identification and processing. (36)

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
207. ExplanationOfBenefit.item.careTeamSequence
Definition

Care team members related to this service or product.

Control0..*
TypepositiveInt
Requirements

Need to identify the individuals and their roles in the provision of the product or service.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
208. ExplanationOfBenefit.item.diagnosisSequence
Definition

Diagnoses applicable for this service or product.

Control0..*
TypepositiveInt
Requirements

Need to related the product or service to the associated diagnoses.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
209. ExplanationOfBenefit.item.procedureSequence
Definition

Procedures applicable for this service or product.

Control0..*
TypepositiveInt
Requirements

Need to provide any listed specific procedures to support the product or service being claimed.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
210. ExplanationOfBenefit.item.informationSequence
Definition

Exceptions, special conditions and supporting information applicable for this service or product.

Control0..*
TypepositiveInt
Requirements

Need to reference the supporting information items that relate directly to this product or service.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
211. ExplanationOfBenefit.item.revenue
Definition

The type of revenue or cost center providing the product and/or service.

Control0..1
BindingThe codes SHALL be taken from NUBC Revenue Codes
TypeCodeableConcept
Must Supporttrue
Requirements

Needed in the processing of institutional claims.

Comments

Code used on the UB-04 (Form Locator 42) to identify a specific accommodation, ancillary service, or billing calculation related to the service being billed (86)

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
212. ExplanationOfBenefit.item.category
Definition

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

Control0..1
BindingFor example codes, see BenefitCategoryCodes Benefit categories such as: oral, medical, vision, oral-basic etc.

TypeCodeableConcept
Requirements

Needed in the processing of institutional claims as this allows the insurer to determine whether a facial X-Ray is for dental, orthopedic, or facial surgery purposes.

Comments

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

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
213. ExplanationOfBenefit.item.productOrService
Definition

When the value is a group code then this item collects a set of related claim details, otherwise this contains the product, service, drug or other billing code for the item.

Control1..1
BindingThe codes SHALL be taken from Procedure Codes - AMA CPT - CMS HCPCS - CMS HIPPS
TypeCodeableConcept
Must Supporttrue
Requirements

Necessary to state what was provided or done.

Alternate NamesDrug Code, Bill Code, Service Code
Comments

Medical procedure a patient received from a health care provider. Current coding methods include: CPT-4 and HCFA Common Procedure Coding System Level II - (HCPCSII). (40)

InvariantsDefined on this element
EOB-out-inst-item-productorservice: Outpatient Institutional EOB: Item productOrService required. Data absent reason of Not Applicable is not allowed. (: coding.where(code = 'not-applicable' and system = 'http://terminology.hl7.org/CodeSystem/data-absent-reason').exists().not())
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
214. ExplanationOfBenefit.item.modifier
Definition

Item typification or modifiers codes to convey additional context for the product or service.

Control0..*
BindingThe codes SHALL be taken from Procedure Modifier Codes - AMA CPT - CMS HCPCS
TypeCodeableConcept
Must Supporttrue
Requirements

To support inclusion of the item for adjudication or to charge an elevated fee.

Comments

Modifier(s) for the procedure represented on this line. Identifies special circumstances related to the performance of the service. (41)

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
215. ExplanationOfBenefit.item.programCode
Definition

Identifies the program under which this may be recovered.

Control0..*
BindingFor example codes, see ExampleProgramReasonCodes Program specific reason codes.

TypeCodeableConcept
Requirements

Commonly used in in the identification of publicly provided program focused on population segments or disease classifications.

Comments

For example: Neonatal program, child dental program or drug users recovery program.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
216. ExplanationOfBenefit.item.serviced[x]
Definition

The date or dates when the service or product was supplied, performed or completed.

Control0..1
Typedate
[x] NoteSee Choice of Data Types for further information about how to use [x]
Requirements

Needed to determine whether the service or product was provided during the term of the insurance coverage.

InvariantsDefined on this element
ele-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.item.serviced[x]. The slices are unordered and Closed, and can be differentiated using the following discriminators:
  • type @ $this
217. ExplanationOfBenefit.item.serviced[x]:servicedDate
SliceNameservicedDate
Definition

The date or dates when the service or product was supplied, performed or completed.

Control0..1
Typedate
[x] NoteSee Choice of Data Types for further information about how to use [x]
Must Supporttrue
Requirements

Needed to determine whether the service or product was provided during the term of the insurance coverage.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
218. ExplanationOfBenefit.item.location[x]
Definition

Where the product or service was provided.

Control0..1
BindingFor example codes, see ExampleServicePlaceCodes Place where the service is rendered.

TypeChoice of: CodeableConcept, Address, Reference(Location)
[x] NoteSee Choice of Data Types for further information about how to use [x]
Requirements

The location can alter whether the item was acceptable for insurance purposes or impact the determination of the benefit amount.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
219. ExplanationOfBenefit.item.quantity
Definition

The number of repetitions of a service or product.

Control0..1
TypeQuantity(SimpleQuantity)
Must Supporttrue
Requirements

Required when the product or service code does not convey the quantity provided.

Comments

The quantity of units, times, days, visits, services, or treatments for the service described by the HCPCS code, revenue code or procedure code, submitted by the provider. (42)

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
220. ExplanationOfBenefit.item.unitPrice
Definition

If the item is not a group then this is the fee for the product or service, otherwise this is the total of the fees for the details of the group.

Control0..1
TypeMoney
Requirements

The amount charged to the patient by the provider for a single unit.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
221. ExplanationOfBenefit.item.factor
Definition

A real number that represents a multiplier used in determining the overall value of services delivered and/or goods received. The concept of a Factor allows for a discount or surcharge multiplier to be applied to a monetary amount.

Control0..1
Typedecimal
Requirements

When discounts are provided to a patient (example: Senior's discount) then this must be documented for adjudication.

Comments

To show a 10% senior's discount, the value entered is: 0.90 (1.00 - 0.10).

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
222. ExplanationOfBenefit.item.net
Definition

The quantity times the unit price for an additional service or product or charge.

Control0..1
TypeMoney
Requirements

Provides the total amount claimed for the group (if a grouper) or the line item.

Comments

For example, the formula: quantity * unitPrice * factor = net. Quantity and factor are assumed to be 1 if not supplied.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
223. ExplanationOfBenefit.item.udi
Definition

Unique Device Identifiers associated with this line item.

Control0..*
TypeReference(Device)
Requirements

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

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
224. ExplanationOfBenefit.item.bodySite
Definition

Physical service site on the patient (limb, tooth, etc.).

Control0..1
BindingFor example codes, see OralSiteCodes The code for the teeth, quadrant, sextant and arch.

TypeCodeableConcept
Requirements

Allows insurer to validate specific procedures.

Comments

For example: Providing a tooth code, allows an insurer to identify a provider performing a filling on a tooth that was previously removed.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
225. ExplanationOfBenefit.item.subSite
Definition

A region or surface of the bodySite, e.g. limb region or tooth surface(s).

Control0..*
BindingFor example codes, see SurfaceCodes The code for the tooth surface and surface combinations.

TypeCodeableConcept
Requirements

Allows insurer to validate specific procedures.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
226. ExplanationOfBenefit.item.encounter
Definition

A billed item may include goods or services provided in multiple encounters.

Control0..*
TypeReference(Encounter)
Requirements

Used in some jurisdictions to link clinical events to claim items.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
227. ExplanationOfBenefit.item.noteNumber
Definition

The numbers associated with notes below which apply to the adjudication of this item.

Control0..*
TypepositiveInt
Must Supporttrue
Requirements

Provides a condensed manner for associating human readable descriptive explanations for adjudications on the line item.

Comments

References number of the associated processNote entered

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
228. ExplanationOfBenefit.item.adjudication
Definition

If this item is a group then the values here are a summary of the adjudication of the detail items. If this item is a simple product or service then this is the result of the adjudication of this item.

Control0..*
TypeBackboneElement
Must Supporttrue
Requirements

The adjudication results conveys the insurer's assessment of the item provided in the claim under the terms of the patient's insurance coverage.

InvariantsDefined on this element
adjudication-has-amount-type-slice: If Adjudication is present, it must have at least one adjudicationamounttype slice (: (exists() implies where(category.memberOf('http://hl7.org/fhir/us/carin-bb/ValueSet/C4BBAdjudication')).exists()))
ele-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.item.adjudication. The slices are unordered and Closed, and can be differentiated using the following discriminators:
  • pattern @ category
229. ExplanationOfBenefit.item.adjudication.id
Definition

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

Control0..1
Typestring
230. ExplanationOfBenefit.item.adjudication.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.

Control0..*
TypeExtension
Alternate Namesextensions, user content
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.

InvariantsDefined on this element
ele-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())
231. ExplanationOfBenefit.item.adjudication.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).

Control0..*
TypeExtension
Is Modifiertrue
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
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.

InvariantsDefined on this element
ele-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())
232. ExplanationOfBenefit.item.adjudication.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.

Control1..1
BindingThe codes SHALL be taken from C4BB Adjudication Category Discriminator
TypeCodeableConcept
Must Supporttrue
Requirements

Needed to enable understanding of the context of the other information in the adjudication.

Comments

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

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
233. ExplanationOfBenefit.item.adjudication.reason
Definition

A code supporting the understanding of the adjudication result and explaining variance from expected amount.

Control0..1
BindingFor example codes, see AdjudicationReasonCodes Adjudication reason codes.

TypeCodeableConcept
Requirements

To support understanding of variance from adjudication expectations.

Comments

For example, may indicate that the funds for this benefit type have been exhausted.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
234. ExplanationOfBenefit.item.adjudication.amount
Definition

Monetary amount associated with the category.

Control0..1
TypeMoney
Requirements

Most adjuciation categories convey a monetary amount.

Comments

For example, amount submitted, eligible amount, co-payment, and benefit payable.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
235. ExplanationOfBenefit.item.adjudication.value
Definition

A non-monetary value associated with the category. Mutually exclusive to the amount element above.

Control0..1
Typedecimal
Requirements

Some adjudication categories convey a percentage or a fixed value.

Comments

For example: eligible percentage or co-payment percentage.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
236. ExplanationOfBenefit.item.adjudication:adjudicationamounttype
SliceNameadjudicationamounttype
Definition

If this item is a group then the values here are a summary of the adjudication of the detail items. If this item is a simple product or service then this is the result of the adjudication of this item.

Control0..*
TypeBackboneElement
Must Supporttrue
Requirements

The adjudication results conveys the insurer's assessment of the item provided in the claim under the terms of the patient's insurance coverage.

Comments

Describes the various amount fields used when payers receive and adjudicate a claim. (187)

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
237. ExplanationOfBenefit.item.adjudication:adjudicationamounttype.id
Definition

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

Control0..1
Typestring
238. ExplanationOfBenefit.item.adjudication:adjudicationamounttype.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.

Control0..*
TypeExtension
Alternate Namesextensions, user content
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.

InvariantsDefined on this element
ele-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())
239. ExplanationOfBenefit.item.adjudication:adjudicationamounttype.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).

Control0..*
TypeExtension
Is Modifiertrue
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
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.

InvariantsDefined on this element
ele-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())
240. ExplanationOfBenefit.item.adjudication:adjudicationamounttype.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.

Control1..1
BindingThe codes SHALL be taken from C4BB Adjudication
TypeCodeableConcept
Must Supporttrue
Requirements

Needed to enable understanding of the context of the other information in the adjudication.

Comments

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

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
241. ExplanationOfBenefit.item.adjudication:adjudicationamounttype.reason
Definition

A code supporting the understanding of the adjudication result and explaining variance from expected amount.

Control0..1
BindingFor example codes, see AdjudicationReasonCodes Adjudication reason codes.

TypeCodeableConcept
Requirements

To support understanding of variance from adjudication expectations.

Comments

For example, may indicate that the funds for this benefit type have been exhausted.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
242. ExplanationOfBenefit.item.adjudication:adjudicationamounttype.amount
Definition

Monetary amount associated with the category.

Control1..1
TypeMoney
Must Supporttrue
Requirements

Most adjuciation categories convey a monetary amount.

Comments

For example, amount submitted, eligible amount, co-payment, and benefit payable.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
243. ExplanationOfBenefit.item.adjudication:adjudicationamounttype.value
Definition

A non-monetary value associated with the category. Mutually exclusive to the amount element above.

Control0..1
Typedecimal
Requirements

Some adjudication categories convey a percentage or a fixed value.

Comments

For example: eligible percentage or co-payment percentage.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
244. ExplanationOfBenefit.item.adjudication:denialreason
SliceNamedenialreason
Definition

If this item is a group then the values here are a summary of the adjudication of the detail items. If this item is a simple product or service then this is the result of the adjudication of this item.

Control0..*
TypeBackboneElement
Must Supporttrue
Requirements

The adjudication results conveys the insurer's assessment of the item provided in the claim under the terms of the patient's insurance coverage.

Comments

Reason codes used to interpret the Non-Covered Amount that are provided to the Provider. (92)

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
245. ExplanationOfBenefit.item.adjudication:denialreason.id
Definition

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

Control0..1
Typestring
246. ExplanationOfBenefit.item.adjudication:denialreason.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.

Control0..*
TypeExtension
Alternate Namesextensions, user content
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.

InvariantsDefined on this element
ele-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())
247. ExplanationOfBenefit.item.adjudication:denialreason.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).

Control0..*
TypeExtension
Is Modifiertrue
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
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.

InvariantsDefined on this element
ele-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())
248. ExplanationOfBenefit.item.adjudication:denialreason.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.

Control1..1
BindingFor example codes, see AdjudicationValueCodes The adjudication codes.

TypeCodeableConcept
Must Supporttrue
Requirements

Needed to enable understanding of the context of the other information in the adjudication.

Comments

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

Pattern Value<valueCodeableConcept xmlns="http://hl7.org/fhir">
  <coding>
    <system value="http://hl7.org/fhir/us/carin-bb/CodeSystem/C4BBAdjudicationDiscriminator"/>
    <code value="denialreason"/>
  </coding>
</valueCodeableConcept>
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
249. ExplanationOfBenefit.item.adjudication:denialreason.reason
Definition

A code supporting the understanding of the adjudication result and explaining variance from expected amount.

Control1..1
BindingThe codes SHALL be taken from X12 Claim Adjustment Reason Codes - Remittance Advice Remark Codes
TypeCodeableConcept
Must Supporttrue
Requirements

To support understanding of variance from adjudication expectations.

Comments

For example, may indicate that the funds for this benefit type have been exhausted.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
250. ExplanationOfBenefit.item.adjudication:denialreason.amount
Definition

Monetary amount associated with the category.

Control0..1
TypeMoney
Requirements

Most adjuciation categories convey a monetary amount.

Comments

For example, amount submitted, eligible amount, co-payment, and benefit payable.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
251. ExplanationOfBenefit.item.adjudication:denialreason.value
Definition

A non-monetary value associated with the category. Mutually exclusive to the amount element above.

Control0..1
Typedecimal
Requirements

Some adjudication categories convey a percentage or a fixed value.

Comments

For example: eligible percentage or co-payment percentage.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
252. ExplanationOfBenefit.item.adjudication:allowedunits
SliceNameallowedunits
Definition

If this item is a group then the values here are a summary of the adjudication of the detail items. If this item is a simple product or service then this is the result of the adjudication of this item.

Control0..1
TypeBackboneElement
Must Supporttrue
Requirements

The adjudication results conveys the insurer's assessment of the item provided in the claim under the terms of the patient's insurance coverage.

Comments

The quantity of units, times, days, visits, services, or treatments allowed for the service described by the HCPCS code, revenue code or procedure code, submitted by the provider. (149)

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
253. ExplanationOfBenefit.item.adjudication:allowedunits.id
Definition

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

Control0..1
Typestring
254. ExplanationOfBenefit.item.adjudication:allowedunits.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.

Control0..*
TypeExtension
Alternate Namesextensions, user content
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.

InvariantsDefined on this element
ele-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())
255. ExplanationOfBenefit.item.adjudication:allowedunits.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).

Control0..*
TypeExtension
Is Modifiertrue
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
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.

InvariantsDefined on this element
ele-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())
256. ExplanationOfBenefit.item.adjudication:allowedunits.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.

Control1..1
BindingFor example codes, see AdjudicationValueCodes The adjudication codes.

TypeCodeableConcept
Must Supporttrue
Requirements

Needed to enable understanding of the context of the other information in the adjudication.

Comments

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

Pattern Value<valueCodeableConcept xmlns="http://hl7.org/fhir">
  <coding>
    <system value="http://hl7.org/fhir/us/carin-bb/CodeSystem/C4BBAdjudicationDiscriminator"/>
    <code value="allowedunits"/>
  </coding>
</valueCodeableConcept>
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
257. ExplanationOfBenefit.item.adjudication:allowedunits.reason
Definition

A code supporting the understanding of the adjudication result and explaining variance from expected amount.

Control0..1
BindingFor example codes, see AdjudicationReasonCodes Adjudication reason codes.

TypeCodeableConcept
Requirements

To support understanding of variance from adjudication expectations.

Comments

For example, may indicate that the funds for this benefit type have been exhausted.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
258. ExplanationOfBenefit.item.adjudication:allowedunits.amount
Definition

Monetary amount associated with the category.

Control0..1
TypeMoney
Requirements

Most adjuciation categories convey a monetary amount.

Comments

For example, amount submitted, eligible amount, co-payment, and benefit payable.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
259. ExplanationOfBenefit.item.adjudication:allowedunits.value
Definition

A non-monetary value associated with the category. Mutually exclusive to the amount element above.

Control1..1
Typedecimal
Must Supporttrue
Requirements

Some adjudication categories convey a percentage or a fixed value.

Comments

For example: eligible percentage or co-payment percentage.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
260. ExplanationOfBenefit.item.detail
Definition

Second-tier of goods and services.

Control0..*
TypeBackboneElement
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
261. ExplanationOfBenefit.item.detail.id
Definition

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

Control0..1
Typestring
262. ExplanationOfBenefit.item.detail.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.

Control0..*
TypeExtension
Alternate Namesextensions, user content
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.

InvariantsDefined on this element
ele-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())
263. ExplanationOfBenefit.item.detail.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).

Control0..*
TypeExtension
Is Modifiertrue
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
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.

InvariantsDefined on this element
ele-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())
264. ExplanationOfBenefit.item.detail.sequence
Definition

A claim detail line. Either a simple (a product or service) or a 'group' of sub-details which are simple items.

Control1..1
TypepositiveInt
Requirements

The items to be processed for adjudication.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
265. ExplanationOfBenefit.item.detail.revenue
Definition

The type of revenue or cost center providing the product and/or service.

Control0..1
BindingFor example codes, see ExampleRevenueCenterCodes Codes for the revenue or cost centers supplying the service and/or products.

TypeCodeableConcept
Requirements

Needed in the processing of institutional claims.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
266. ExplanationOfBenefit.item.detail.category
Definition

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

Control0..1
BindingFor example codes, see BenefitCategoryCodes Benefit categories such as: oral, medical, vision, oral-basic etc.

TypeCodeableConcept
Requirements

Needed in the processing of institutional claims as this allows the insurer to determine whether a facial X-Ray is for dental, orthopedic, or facial surgery purposes.

Comments

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

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
267. ExplanationOfBenefit.item.detail.productOrService
Definition

When the value is a group code then this item collects a set of related claim details, otherwise this contains the product, service, drug or other billing code for the item.

Control1..1
BindingFor example codes, see USCLSCodes Allowable service and product codes.

TypeCodeableConcept
Requirements

Necessary to state what was provided or done.

Alternate NamesDrug Code, Bill Code, Service Code
Comments

If this is an actual service or product line, i.e. not a Group, then use code to indicate the Professional Service or Product supplied (e.g. CTP, HCPCS, USCLS, ICD10, NCPDP, DIN, RxNorm, ACHI, CCI). If a grouping item then use a group code to indicate the type of thing being grouped e.g. 'glasses' or 'compound'.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
268. ExplanationOfBenefit.item.detail.modifier
Definition

Item typification or modifiers codes to convey additional context for the product or service.

Control0..*
BindingFor example codes, see ModifierTypeCodes Item type or modifiers codes, eg for Oral whether the treatment is cosmetic or associated with TMJ, or an appliance was lost or stolen.

TypeCodeableConcept
Requirements

To support inclusion of the item for adjudication or to charge an elevated fee.

Comments

For example, in Oral whether the treatment is cosmetic or associated with TMJ, or for Medical whether the treatment was outside the clinic or out of office hours.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
269. ExplanationOfBenefit.item.detail.programCode
Definition

Identifies the program under which this may be recovered.

Control0..*
BindingFor example codes, see ExampleProgramReasonCodes Program specific reason codes.

TypeCodeableConcept
Requirements

Commonly used in in the identification of publicly provided program focused on population segments or disease classifications.

Comments

For example: Neonatal program, child dental program or drug users recovery program.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
270. ExplanationOfBenefit.item.detail.quantity
Definition

The number of repetitions of a service or product.

Control0..1
TypeQuantity(SimpleQuantity)
Requirements

Required when the product or service code does not convey the quantity provided.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
271. ExplanationOfBenefit.item.detail.unitPrice
Definition

If the item is not a group then this is the fee for the product or service, otherwise this is the total of the fees for the details of the group.

Control0..1
TypeMoney
Requirements

The amount charged to the patient by the provider for a single unit.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
272. ExplanationOfBenefit.item.detail.factor
Definition

A real number that represents a multiplier used in determining the overall value of services delivered and/or goods received. The concept of a Factor allows for a discount or surcharge multiplier to be applied to a monetary amount.

Control0..1
Typedecimal
Requirements

When discounts are provided to a patient (example: Senior's discount) then this must be documented for adjudication.

Comments

To show a 10% senior's discount, the value entered is: 0.90 (1.00 - 0.10).

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
273. ExplanationOfBenefit.item.detail.net
Definition

The quantity times the unit price for an additional service or product or charge.

Control0..1
TypeMoney
Requirements

Provides the total amount claimed for the group (if a grouper) or the line item.

Comments

For example, the formula: quantity * unitPrice * factor = net. Quantity and factor are assumed to be 1 if not supplied.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
274. ExplanationOfBenefit.item.detail.udi
Definition

Unique Device Identifiers associated with this line item.

Control0..*
TypeReference(Device)
Requirements

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

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
275. ExplanationOfBenefit.item.detail.noteNumber
Definition

The numbers associated with notes below which apply to the adjudication of this item.

Control0..*
TypepositiveInt
Requirements

Provides a condensed manner for associating human readable descriptive explanations for adjudications on the line item.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
276. ExplanationOfBenefit.item.detail.adjudication
Definition

The adjudication results.

Control0..*
TypeSee ttp://hl7.org/fhir/StructureDefinition/ExplanationOfBenefit#ExplanationOfBenefit.item.adjudication
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
277. ExplanationOfBenefit.item.detail.subDetail
Definition

Third-tier of goods and services.

Control0..*
TypeBackboneElement
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
278. ExplanationOfBenefit.item.detail.subDetail.id
Definition

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

Control0..1
Typestring
279. ExplanationOfBenefit.item.detail.subDetail.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.

Control0..*
TypeExtension
Alternate Namesextensions, user content
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.

InvariantsDefined on this element
ele-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())
280. ExplanationOfBenefit.item.detail.subDetail.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).

Control0..*
TypeExtension
Is Modifiertrue
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
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.

InvariantsDefined on this element
ele-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())
281. ExplanationOfBenefit.item.detail.subDetail.sequence
Definition

A claim detail line. Either a simple (a product or service) or a 'group' of sub-details which are simple items.

Control1..1
TypepositiveInt
Requirements

The items to be processed for adjudication.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
282. ExplanationOfBenefit.item.detail.subDetail.revenue
Definition

The type of revenue or cost center providing the product and/or service.

Control0..1
BindingFor example codes, see ExampleRevenueCenterCodes Codes for the revenue or cost centers supplying the service and/or products.

TypeCodeableConcept
Requirements

Needed in the processing of institutional claims.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
283. ExplanationOfBenefit.item.detail.subDetail.category
Definition

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

Control0..1
BindingFor example codes, see BenefitCategoryCodes Benefit categories such as: oral, medical, vision, oral-basic etc.

TypeCodeableConcept
Requirements

Needed in the processing of institutional claims as this allows the insurer to determine whether a facial X-Ray is for dental, orthopedic, or facial surgery purposes.

Comments

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

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
284. ExplanationOfBenefit.item.detail.subDetail.productOrService
Definition

When the value is a group code then this item collects a set of related claim details, otherwise this contains the product, service, drug or other billing code for the item.

Control1..1
BindingFor example codes, see USCLSCodes Allowable service and product codes.

TypeCodeableConcept
Requirements

Necessary to state what was provided or done.

Alternate NamesDrug Code, Bill Code, Service Code
Comments

If this is an actual service or product line, i.e. not a Group, then use code to indicate the Professional Service or Product supplied (e.g. CTP, HCPCS, USCLS, ICD10, NCPDP, DIN, RxNorm, ACHI, CCI). If a grouping item then use a group code to indicate the type of thing being grouped e.g. 'glasses' or 'compound'.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
285. ExplanationOfBenefit.item.detail.subDetail.modifier
Definition

Item typification or modifiers codes to convey additional context for the product or service.

Control0..*
BindingFor example codes, see ModifierTypeCodes Item type or modifiers codes, eg for Oral whether the treatment is cosmetic or associated with TMJ, or an appliance was lost or stolen.

TypeCodeableConcept
Requirements

To support inclusion of the item for adjudication or to charge an elevated fee.

Comments

For example, in Oral whether the treatment is cosmetic or associated with TMJ, or for Medical whether the treatment was outside the clinic or outside of office hours.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
286. ExplanationOfBenefit.item.detail.subDetail.programCode
Definition

Identifies the program under which this may be recovered.

Control0..*
BindingFor example codes, see ExampleProgramReasonCodes Program specific reason codes.

TypeCodeableConcept
Requirements

Commonly used in in the identification of publicly provided program focused on population segments or disease classifications.

Comments

For example: Neonatal program, child dental program or drug users recovery program.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
287. ExplanationOfBenefit.item.detail.subDetail.quantity
Definition

The number of repetitions of a service or product.

Control0..1
TypeQuantity(SimpleQuantity)
Requirements

Required when the product or service code does not convey the quantity provided.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
288. ExplanationOfBenefit.item.detail.subDetail.unitPrice
Definition

If the item is not a group then this is the fee for the product or service, otherwise this is the total of the fees for the details of the group.

Control0..1
TypeMoney
Requirements

The amount charged to the patient by the provider for a single unit.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
289. ExplanationOfBenefit.item.detail.subDetail.factor
Definition

A real number that represents a multiplier used in determining the overall value of services delivered and/or goods received. The concept of a Factor allows for a discount or surcharge multiplier to be applied to a monetary amount.

Control0..1
Typedecimal
Requirements

When discounts are provided to a patient (example: Senior's discount) then this must be documented for adjudication.

Comments

To show a 10% senior's discount, the value entered is: 0.90 (1.00 - 0.10).

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
290. ExplanationOfBenefit.item.detail.subDetail.net
Definition

The quantity times the unit price for an additional service or product or charge.

Control0..1
TypeMoney
Requirements

Provides the total amount claimed for the group (if a grouper) or the line item.

Comments

For example, the formula: quantity * unitPrice * factor = net. Quantity and factor are assumed to be 1 if not supplied.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
291. ExplanationOfBenefit.item.detail.subDetail.udi
Definition

Unique Device Identifiers associated with this line item.

Control0..*
TypeReference(Device)
Requirements

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

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
292. ExplanationOfBenefit.item.detail.subDetail.noteNumber
Definition

The numbers associated with notes below which apply to the adjudication of this item.

Control0..*
TypepositiveInt
Requirements

Provides a condensed manner for associating human readable descriptive explanations for adjudications on the line item.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
293. ExplanationOfBenefit.item.detail.subDetail.adjudication
Definition

The adjudication results.

Control0..*
TypeSee ttp://hl7.org/fhir/StructureDefinition/ExplanationOfBenefit#ExplanationOfBenefit.item.adjudication
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
294. ExplanationOfBenefit.addItem
Definition

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

Control0..*
TypeBackboneElement
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.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
295. ExplanationOfBenefit.addItem.id
Definition

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

Control0..1
Typestring
296. ExplanationOfBenefit.addItem.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.

Control0..*
TypeExtension
Alternate Namesextensions, user content
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.

InvariantsDefined on this element
ele-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())
297. ExplanationOfBenefit.addItem.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).

Control0..*
TypeExtension
Is Modifiertrue
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
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.

InvariantsDefined on this element
ele-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())
298. ExplanationOfBenefit.addItem.itemSequence
Definition

Claim items which this service line is intended to replace.

Control0..*
TypepositiveInt
Requirements

Provides references to the claim items.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
299. ExplanationOfBenefit.addItem.detailSequence
Definition

The sequence number of the details within the claim item which this line is intended to replace.

Control0..*
TypepositiveInt
Requirements

Provides references to the claim details within the claim item.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
300. ExplanationOfBenefit.addItem.subDetailSequence
Definition

The sequence number of the sub-details woithin the details within the claim item which this line is intended to replace.

Control0..*
TypepositiveInt
Requirements

Provides references to the claim sub-details within the claim detail.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
301. ExplanationOfBenefit.addItem.provider
Definition

The providers who are authorized for the services rendered to the patient.

Control0..*
TypeReference(Practitioner | PractitionerRole | Organization)
Requirements

Insurer may provide authorization specifically to a restricted set of providers rather than an open authorization.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
302. ExplanationOfBenefit.addItem.productOrService
Definition

When the value is a group code then this item collects a set of related claim details, otherwise this contains the product, service, drug or other billing code for the item.

Control1..1
BindingFor example codes, see USCLSCodes Allowable service and product codes.

TypeCodeableConcept
Requirements

Necessary to state what was provided or done.

Alternate NamesDrug Code, Bill Code, Service Code
Comments

If this is an actual service or product line, i.e. not a Group, then use code to indicate the Professional Service or Product supplied (e.g. CTP, HCPCS, USCLS, ICD10, NCPDP, DIN, RxNorm, ACHI, CCI). If a grouping item then use a group code to indicate the type of thing being grouped e.g. 'glasses' or 'compound'.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
303. ExplanationOfBenefit.addItem.modifier
Definition

Item typification or modifiers codes to convey additional context for the product or service.

Control0..*
BindingFor example codes, see ModifierTypeCodes Item type or modifiers codes, eg for Oral whether the treatment is cosmetic or associated with TMJ, or an appliance was lost or stolen.

TypeCodeableConcept
Requirements

To support inclusion of the item for adjudication or to charge an elevated fee.

Comments

For example, in Oral whether the treatment is cosmetic or associated with TMJ, or for Medical whether the treatment was outside the clinic or out of office hours.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
304. ExplanationOfBenefit.addItem.programCode
Definition

Identifies the program under which this may be recovered.

Control0..*
BindingFor example codes, see ExampleProgramReasonCodes Program specific reason codes.

TypeCodeableConcept
Requirements

Commonly used in in the identification of publicly provided program focused on population segments or disease classifications.

Comments

For example: Neonatal program, child dental program or drug users recovery program.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
305. ExplanationOfBenefit.addItem.serviced[x]
Definition

The date or dates when the service or product was supplied, performed or completed.

Control0..1
TypeChoice of: date, Period
[x] NoteSee Choice of Data Types for further information about how to use [x]
Requirements

Needed to determine whether the service or product was provided during the term of the insurance coverage.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
306. ExplanationOfBenefit.addItem.location[x]
Definition

Where the product or service was provided.

Control0..1
BindingFor example codes, see ExampleServicePlaceCodes Place where the service is rendered.

TypeChoice of: CodeableConcept, Address, Reference(Location)
[x] NoteSee Choice of Data Types for further information about how to use [x]
Requirements

The location can alter whether the item was acceptable for insurance purposes or impact the determination of the benefit amount.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
307. ExplanationOfBenefit.addItem.quantity
Definition

The number of repetitions of a service or product.

Control0..1
TypeQuantity(SimpleQuantity)
Requirements

Required when the product or service code does not convey the quantity provided.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
308. ExplanationOfBenefit.addItem.unitPrice
Definition

If the item is not a group then this is the fee for the product or service, otherwise this is the total of the fees for the details of the group.

Control0..1
TypeMoney
Requirements

The amount charged to the patient by the provider for a single unit.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
309. ExplanationOfBenefit.addItem.factor
Definition

A real number that represents a multiplier used in determining the overall value of services delivered and/or goods received. The concept of a Factor allows for a discount or surcharge multiplier to be applied to a monetary amount.

Control0..1
Typedecimal
Requirements

When discounts are provided to a patient (example: Senior's discount) then this must be documented for adjudication.

Comments

To show a 10% senior's discount, the value entered is: 0.90 (1.00 - 0.10).

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
310. ExplanationOfBenefit.addItem.net
Definition

The quantity times the unit price for an additional service or product or charge.

Control0..1
TypeMoney
Requirements

Provides the total amount claimed for the group (if a grouper) or the line item.

Comments

For example, the formula: quantity * unitPrice * factor = net. Quantity and factor are assumed to be 1 if not supplied.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
311. ExplanationOfBenefit.addItem.bodySite
Definition

Physical service site on the patient (limb, tooth, etc.).

Control0..1
BindingFor example codes, see OralSiteCodes The code for the teeth, quadrant, sextant and arch.

TypeCodeableConcept
Requirements

Allows insurer to validate specific procedures.

Comments

For example, providing a tooth code allows an insurer to identify a provider performing a filling on a tooth that was previously removed.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
312. ExplanationOfBenefit.addItem.subSite
Definition

A region or surface of the bodySite, e.g. limb region or tooth surface(s).

Control0..*
BindingFor example codes, see SurfaceCodes The code for the tooth surface and surface combinations.

TypeCodeableConcept
Requirements

Allows insurer to validate specific procedures.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
313. ExplanationOfBenefit.addItem.noteNumber
Definition

The numbers associated with notes below which apply to the adjudication of this item.

Control0..*
TypepositiveInt
Requirements

Provides a condensed manner for associating human readable descriptive explanations for adjudications on the line item.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
314. ExplanationOfBenefit.addItem.adjudication
Definition

The adjudication results.

Control0..*
TypeSee ttp://hl7.org/fhir/StructureDefinition/ExplanationOfBenefit#ExplanationOfBenefit.item.adjudication
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
315. ExplanationOfBenefit.addItem.detail
Definition

The second-tier service adjudications for payor added services.

Control0..*
TypeBackboneElement
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
316. ExplanationOfBenefit.addItem.detail.id
Definition

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

Control0..1
Typestring
317. ExplanationOfBenefit.addItem.detail.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.

Control0..*
TypeExtension
Alternate Namesextensions, user content
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.

InvariantsDefined on this element
ele-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())
318. ExplanationOfBenefit.addItem.detail.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).

Control0..*
TypeExtension
Is Modifiertrue
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
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.

InvariantsDefined on this element
ele-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())
319. ExplanationOfBenefit.addItem.detail.productOrService
Definition

When the value is a group code then this item collects a set of related claim details, otherwise this contains the product, service, drug or other billing code for the item.

Control1..1
BindingFor example codes, see USCLSCodes Allowable service and product codes.

TypeCodeableConcept
Requirements

Necessary to state what was provided or done.

Alternate NamesDrug Code, Bill Code, Service Code
Comments

If this is an actual service or product line, i.e. not a Group, then use code to indicate the Professional Service or Product supplied (e.g. CTP, HCPCS, USCLS, ICD10, NCPDP, DIN, RxNorm, ACHI, CCI). If a grouping item then use a group code to indicate the type of thing being grouped e.g. 'glasses' or 'compound'.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
320. ExplanationOfBenefit.addItem.detail.modifier
Definition

Item typification or modifiers codes to convey additional context for the product or service.

Control0..*
BindingFor example codes, see ModifierTypeCodes Item type or modifiers codes, eg for Oral whether the treatment is cosmetic or associated with TMJ, or an appliance was lost or stolen.

TypeCodeableConcept
Requirements

To support inclusion of the item for adjudication or to charge an elevated fee.

Comments

For example, in Oral whether the treatment is cosmetic or associated with TMJ, or for Medical whether the treatment was outside the clinic or out of office hours.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
321. ExplanationOfBenefit.addItem.detail.quantity
Definition

The number of repetitions of a service or product.

Control0..1
TypeQuantity(SimpleQuantity)
Requirements

Required when the product or service code does not convey the quantity provided.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
322. ExplanationOfBenefit.addItem.detail.unitPrice
Definition

If the item is not a group then this is the fee for the product or service, otherwise this is the total of the fees for the details of the group.

Control0..1
TypeMoney
Requirements

The amount charged to the patient by the provider for a single unit.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
323. ExplanationOfBenefit.addItem.detail.factor
Definition

A real number that represents a multiplier used in determining the overall value of services delivered and/or goods received. The concept of a Factor allows for a discount or surcharge multiplier to be applied to a monetary amount.

Control0..1
Typedecimal
Requirements

When discounts are provided to a patient (example: Senior's discount) then this must be documented for adjudication.

Comments

To show a 10% senior's discount, the value entered is: 0.90 (1.00 - 0.10).

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
324. ExplanationOfBenefit.addItem.detail.net
Definition

The quantity times the unit price for an additional service or product or charge.

Control0..1
TypeMoney
Requirements

Provides the total amount claimed for the group (if a grouper) or the line item.

Comments

For example, the formula: quantity * unitPrice * factor = net. Quantity and factor are assumed to be 1 if not supplied.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
325. ExplanationOfBenefit.addItem.detail.noteNumber
Definition

The numbers associated with notes below which apply to the adjudication of this item.

Control0..*
TypepositiveInt
Requirements

Provides a condensed manner for associating human readable descriptive explanations for adjudications on the line item.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
326. ExplanationOfBenefit.addItem.detail.adjudication
Definition

The adjudication results.

Control0..*
TypeSee ttp://hl7.org/fhir/StructureDefinition/ExplanationOfBenefit#ExplanationOfBenefit.item.adjudication
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
327. ExplanationOfBenefit.addItem.detail.subDetail
Definition

The third-tier service adjudications for payor added services.

Control0..*
TypeBackboneElement
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
328. ExplanationOfBenefit.addItem.detail.subDetail.id
Definition

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

Control0..1
Typestring
329. ExplanationOfBenefit.addItem.detail.subDetail.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.

Control0..*
TypeExtension
Alternate Namesextensions, user content
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.

InvariantsDefined on this element
ele-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.addItem.detail.subDetail.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).

Control0..*
TypeExtension
Is Modifiertrue
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
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.

InvariantsDefined on this element
ele-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())
331. ExplanationOfBenefit.addItem.detail.subDetail.productOrService
Definition

When the value is a group code then this item collects a set of related claim details, otherwise this contains the product, service, drug or other billing code for the item.

Control1..1
BindingFor example codes, see USCLSCodes Allowable service and product codes.

TypeCodeableConcept
Requirements

Necessary to state what was provided or done.

Alternate NamesDrug Code, Bill Code, Service Code
Comments

If this is an actual service or product line, i.e. not a Group, then use code to indicate the Professional Service or Product supplied (e.g. CTP, HCPCS, USCLS, ICD10, NCPDP, DIN, RxNorm, ACHI, CCI). If a grouping item then use a group code to indicate the type of thing being grouped e.g. 'glasses' or 'compound'.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
332. ExplanationOfBenefit.addItem.detail.subDetail.modifier
Definition

Item typification or modifiers codes to convey additional context for the product or service.

Control0..*
BindingFor example codes, see ModifierTypeCodes Item type or modifiers codes, eg for Oral whether the treatment is cosmetic or associated with TMJ, or an appliance was lost or stolen.

TypeCodeableConcept
Requirements

To support inclusion of the item for adjudication or to charge an elevated fee.

Comments

For example, in Oral whether the treatment is cosmetic or associated with TMJ, or for Medical whether the treatment was outside the clinic or out of office hours.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
333. ExplanationOfBenefit.addItem.detail.subDetail.quantity
Definition

The number of repetitions of a service or product.

Control0..1
TypeQuantity(SimpleQuantity)
Requirements

Required when the product or service code does not convey the quantity provided.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
334. ExplanationOfBenefit.addItem.detail.subDetail.unitPrice
Definition

If the item is not a group then this is the fee for the product or service, otherwise this is the total of the fees for the details of the group.

Control0..1
TypeMoney
Requirements

The amount charged to the patient by the provider for a single unit.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
335. ExplanationOfBenefit.addItem.detail.subDetail.factor
Definition

A real number that represents a multiplier used in determining the overall value of services delivered and/or goods received. The concept of a Factor allows for a discount or surcharge multiplier to be applied to a monetary amount.

Control0..1
Typedecimal
Requirements

When discounts are provided to a patient (example: Senior's discount) then this must be documented for adjudication.

Comments

To show a 10% senior's discount, the value entered is: 0.90 (1.00 - 0.10).

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
336. ExplanationOfBenefit.addItem.detail.subDetail.net
Definition

The quantity times the unit price for an additional service or product or charge.

Control0..1
TypeMoney
Requirements

Provides the total amount claimed for the group (if a grouper) or the line item.

Comments

For example, the formula: quantity * unitPrice * factor = net. Quantity and factor are assumed to be 1 if not supplied.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
337. ExplanationOfBenefit.addItem.detail.subDetail.noteNumber
Definition

The numbers associated with notes below which apply to the adjudication of this item.

Control0..*
TypepositiveInt
Requirements

Provides a condensed manner for associating human readable descriptive explanations for adjudications on the line item.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
338. ExplanationOfBenefit.addItem.detail.subDetail.adjudication
Definition

The adjudication results.

Control0..*
TypeSee ttp://hl7.org/fhir/StructureDefinition/ExplanationOfBenefit#ExplanationOfBenefit.item.adjudication
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
339. ExplanationOfBenefit.adjudication
Definition

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

Control0..*
TypeBackboneElement
Must Supporttrue
Requirements

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

InvariantsDefined on this element
adjudication-has-amount-type-slice: If Adjudication is present, it must have at least one adjudicationamounttype slice (: (exists() implies where(category.memberOf('http://hl7.org/fhir/us/carin-bb/ValueSet/C4BBAdjudication')).exists()))
ele-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.adjudication. The slices are unordered and Closed, and can be differentiated using the following discriminators:
  • pattern @ category
340. ExplanationOfBenefit.adjudication.id
Definition

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

Control0..1
Typestring
341. ExplanationOfBenefit.adjudication.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.

Control0..*
TypeExtension
Alternate Namesextensions, user content
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.

InvariantsDefined on this element
ele-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.adjudication.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).

Control0..*
TypeExtension
Is Modifiertrue
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
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.

InvariantsDefined on this element
ele-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())
343. ExplanationOfBenefit.adjudication.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.

Control1..1
BindingThe codes SHALL be taken from C4BB Adjudication Category Discriminator
TypeCodeableConcept
Must Supporttrue
Requirements

Needed to enable understanding of the context of the other information in the adjudication.

Comments

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

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
344. ExplanationOfBenefit.adjudication.reason
Definition

A code supporting the understanding of the adjudication result and explaining variance from expected amount.

Control0..1
BindingFor example codes, see AdjudicationReasonCodes Adjudication reason codes.

TypeCodeableConcept
Requirements

To support understanding of variance from adjudication expectations.

Comments

For example, may indicate that the funds for this benefit type have been exhausted.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
345. ExplanationOfBenefit.adjudication.amount
Definition

Monetary amount associated with the category.

Control0..1
TypeMoney
Requirements

Most adjuciation categories convey a monetary amount.

Comments

For example, amount submitted, eligible amount, co-payment, and benefit payable.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
346. ExplanationOfBenefit.adjudication.value
Definition

A non-monetary value associated with the category. Mutually exclusive to the amount element above.

Control0..1
Typedecimal
Requirements

Some adjudication categories convey a percentage or a fixed value.

Comments

For example: eligible percentage or co-payment percentage.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
347. ExplanationOfBenefit.adjudication:adjudicationamounttype
SliceNameadjudicationamounttype
Definition

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

Control0..*
TypeBackboneElement
Must Supporttrue
Requirements

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

Comments

Describes the various amount fields used when payers receive and adjudicate a claim. (187)

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
348. ExplanationOfBenefit.adjudication:adjudicationamounttype.id
Definition

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

Control0..1
Typestring
349. ExplanationOfBenefit.adjudication:adjudicationamounttype.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.

Control0..*
TypeExtension
Alternate Namesextensions, user content
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.

InvariantsDefined on this element
ele-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())
350. ExplanationOfBenefit.adjudication:adjudicationamounttype.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).

Control0..*
TypeExtension
Is Modifiertrue
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
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.

InvariantsDefined on this element
ele-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())
351. ExplanationOfBenefit.adjudication:adjudicationamounttype.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.

Control1..1
BindingThe codes SHALL be taken from C4BB Adjudication
TypeCodeableConcept
Requirements

Needed to enable understanding of the context of the other information in the adjudication.

Comments

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

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
352. ExplanationOfBenefit.adjudication:adjudicationamounttype.reason
Definition

A code supporting the understanding of the adjudication result and explaining variance from expected amount.

Control0..1
BindingFor example codes, see AdjudicationReasonCodes Adjudication reason codes.

TypeCodeableConcept
Requirements

To support understanding of variance from adjudication expectations.

Comments

For example, may indicate that the funds for this benefit type have been exhausted.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
353. ExplanationOfBenefit.adjudication:adjudicationamounttype.amount
Definition

Monetary amount associated with the category.

Control1..1
TypeMoney
Must Supporttrue
Requirements

Most adjuciation categories convey a monetary amount.

Comments

For example, amount submitted, eligible amount, co-payment, and benefit payable.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
354. ExplanationOfBenefit.adjudication:adjudicationamounttype.value
Definition

A non-monetary value associated with the category. Mutually exclusive to the amount element above.

Control0..1
Typedecimal
Requirements

Some adjudication categories convey a percentage or a fixed value.

Comments

For example: eligible percentage or co-payment percentage.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
355. ExplanationOfBenefit.adjudication:denialreason
SliceNamedenialreason
Definition

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

Control0..*
TypeBackboneElement
Must Supporttrue
Requirements

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

Comments

Reason codes used to interpret the Non-Covered Amount that are provided to the Provider. (92)

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
356. ExplanationOfBenefit.adjudication:denialreason.id
Definition

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

Control0..1
Typestring
357. ExplanationOfBenefit.adjudication:denialreason.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.

Control0..*
TypeExtension
Alternate Namesextensions, user content
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.

InvariantsDefined on this element
ele-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())
358. ExplanationOfBenefit.adjudication:denialreason.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).

Control0..*
TypeExtension
Is Modifiertrue
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
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.

InvariantsDefined on this element
ele-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())
359. ExplanationOfBenefit.adjudication:denialreason.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.

Control1..1
BindingFor example codes, see AdjudicationValueCodes The adjudication codes.

TypeCodeableConcept
Requirements

Needed to enable understanding of the context of the other information in the adjudication.

Comments

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

Pattern Value<valueCodeableConcept xmlns="http://hl7.org/fhir">
  <coding>
    <system value="http://hl7.org/fhir/us/carin-bb/CodeSystem/C4BBAdjudicationDiscriminator"/>
    <code value="denialreason"/>
  </coding>
</valueCodeableConcept>
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
360. ExplanationOfBenefit.adjudication:denialreason.reason
Definition

A code supporting the understanding of the adjudication result and explaining variance from expected amount.

Control1..1
BindingThe codes SHALL be taken from X12 Claim Adjustment Reason Codes - Remittance Advice Remark Codes
TypeCodeableConcept
Must Supporttrue
Requirements

To support understanding of variance from adjudication expectations.

Comments

Reason codes used to interpret the Non-Covered Amount that are provided to the Provider. (92)

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
361. ExplanationOfBenefit.adjudication:denialreason.amount
Definition

Monetary amount associated with the category.

Control0..1
TypeMoney
Requirements

Most adjuciation categories convey a monetary amount.

Comments

For example, amount submitted, eligible amount, co-payment, and benefit payable.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
362. ExplanationOfBenefit.adjudication:denialreason.value
Definition

A non-monetary value associated with the category. Mutually exclusive to the amount element above.

Control0..1
Typedecimal
Requirements

Some adjudication categories convey a percentage or a fixed value.

Comments

For example: eligible percentage or co-payment percentage.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
363. ExplanationOfBenefit.total
Definition

Categorized monetary totals for the adjudication.

Control2..*
TypeBackboneElement
Must Supporttrue
Requirements

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

Comments

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

InvariantsDefined on this element
ele-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:
  • pattern @ category
364. 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.

Control0..1
Typestring
365. 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.

Control0..*
TypeExtension
Alternate Namesextensions, user content
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.

InvariantsDefined on this element
ele-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.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).

Control0..*
TypeExtension
Is Modifiertrue
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
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.

InvariantsDefined on this element
ele-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())
367. 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.

Control1..1
BindingThe codes SHALL be taken from C4BB Total Category Discriminator; other codes may be used where these codes are not suitable
TypeCodeableConcept
Must Supporttrue
Requirements

Needed to convey the type of total provided.

Comments

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

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
368. ExplanationOfBenefit.total.amount
Definition

Monetary total amount associated with the category.

Control1..1
TypeMoney
Requirements

Needed to convey the total monetary amount.

Comments

Total amount for each category (i.e., submitted, allowed, etc.) (148)

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
369. ExplanationOfBenefit.total:adjudicationamounttype
SliceNameadjudicationamounttype
Definition

Categorized monetary totals for the adjudication.

Control1..*
TypeBackboneElement
Must Supporttrue
Requirements

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

Comments

Describes the various amount fields used when payers receive and adjudicate a claim. (187)

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
370. ExplanationOfBenefit.total:adjudicationamounttype.id
Definition

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

Control0..1
Typestring
371. ExplanationOfBenefit.total:adjudicationamounttype.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.

Control0..*
TypeExtension
Alternate Namesextensions, user content
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.

InvariantsDefined on this element
ele-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())
372. ExplanationOfBenefit.total:adjudicationamounttype.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).

Control0..*
TypeExtension
Is Modifiertrue
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
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.

InvariantsDefined on this element
ele-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())
373. ExplanationOfBenefit.total:adjudicationamounttype.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.

Control1..1
BindingThe codes SHALL be taken from C4BB Adjudication
TypeCodeableConcept
Requirements

Needed to convey the type of total provided.

Comments

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

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
374. ExplanationOfBenefit.total:adjudicationamounttype.amount
Definition

Monetary total amount associated with the category.

Control1..1
TypeMoney
Must Supporttrue
Requirements

Needed to convey the total monetary amount.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
375. ExplanationOfBenefit.total:benefitpaymentstatus
SliceNamebenefitpaymentstatus
Definition

Categorized monetary totals for the adjudication.

Control1..1
TypeBackboneElement
Must Supporttrue
Requirements

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

Comments

Indicates the in network or out of network payment status of the claim. (142)

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
376. ExplanationOfBenefit.total:benefitpaymentstatus.id
Definition

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

Control0..1
Typestring
377. ExplanationOfBenefit.total:benefitpaymentstatus.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.

Control0..*
TypeExtension
Alternate Namesextensions, user content
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.

InvariantsDefined on this element
ele-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:benefitpaymentstatus.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).

Control0..*
TypeExtension
Is Modifiertrue
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
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.

InvariantsDefined on this element
ele-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())
379. ExplanationOfBenefit.total:benefitpaymentstatus.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.

Control1..1
BindingThe codes SHALL be taken from C4BB Payer Benefit Payment Status
TypeCodeableConcept
Requirements

Needed to convey the type of total provided.

Comments

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

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
380. ExplanationOfBenefit.total:benefitpaymentstatus.amount
Definition

Monetary total amount associated with the category.

Control1..1
TypeMoney
Requirements

Needed to convey the total monetary amount.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
381. ExplanationOfBenefit.payment
Definition

Payment details for the adjudication of the claim.

Control0..1
TypeBackboneElement
Must Supporttrue
Requirements

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

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
382. ExplanationOfBenefit.payment.id
Definition

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

Control0..1
Typestring
383. ExplanationOfBenefit.payment.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.

Control0..*
TypeExtension
Alternate Namesextensions, user content
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.

InvariantsDefined on this element
ele-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())
384. ExplanationOfBenefit.payment.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).

Control0..*
TypeExtension
Is Modifiertrue
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
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.

InvariantsDefined on this element
ele-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())
385. ExplanationOfBenefit.payment.type
Definition

Whether this represents partial or complete payment of the benefits payable.

Control0..1
BindingThe codes SHALL be taken from C4BB Payer Claim Payment Status Code
TypeCodeableConcept
Must Supporttrue
Requirements

To advise the requestor when the insurer believes all payments to have been completed.

Comments

Indicates whether the claim was paid or denied. (91)

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
386. ExplanationOfBenefit.payment.adjustment
Definition

Total amount of all adjustments to this payment included in this transaction which are not related to this claim's adjudication.

Control0..1
TypeMoney
Requirements

To advise the requestor of adjustments applied to the payment.

Comments

Insurers will deduct amounts owing from the provider (adjustment), such as a prior overpayment, from the amount owing to the provider (benefits payable) when payment is made to the provider.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
387. ExplanationOfBenefit.payment.adjustmentReason
Definition

Reason for the payment adjustment.

Control0..1
BindingFor example codes, see PaymentAdjustmentReasonCodes Payment Adjustment reason codes.

TypeCodeableConcept
Requirements

Needed to clarify the monetary adjustment.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
388. ExplanationOfBenefit.payment.date
Definition

Estimated date the payment will be issued or the actual issue date of payment.

Control0..1
Typedate
Must Supporttrue
Requirements

To advise the payee when payment can be expected.

Comments

The date the claim was paid. (107)

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
389. ExplanationOfBenefit.payment.amount
Definition

Benefits payable less any payment adjustment.

Control0..1
TypeMoney
Requirements

Needed to provide the actual payment amount.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
390. ExplanationOfBenefit.payment.identifier
Definition

Issuer's unique identifier for the payment instrument.

NoteThis is a business identifier, not a resource identifier (see discussion)
Control0..1
TypeIdentifier
Requirements

Enable the receiver to reconcile when payment received.

Comments

For example: EFT number or check number.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
391. ExplanationOfBenefit.formCode
Definition

A code for the form to be used for printing the content.

Control0..1
BindingFor example codes, see Form Codes The forms codes.

TypeCodeableConcept
Requirements

Needed to specify the specific form used for producing output for this response.

Comments

May be needed to identify specific jurisdictional forms.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
392. ExplanationOfBenefit.form
Definition

The actual form, by reference or inclusion, for printing the content or an EOB.

Control0..1
TypeAttachment
Requirements

Needed to include the specific form used for producing output for this response.

Comments

Needed to permit insurers to include the actual form.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
393. ExplanationOfBenefit.processNote
Definition

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

Control0..*
TypeBackboneElement
Must Supporttrue
Requirements

Provides the insurer specific textual explanations associated with the processing.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
394. 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.

Control0..1
Typestring
395. ExplanationOfBenefit.processNote.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.

Control0..*
TypeExtension
Alternate Namesextensions, user content
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.

InvariantsDefined on this element
ele-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())
396. 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).

Control0..*
TypeExtension
Is Modifiertrue
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
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.

InvariantsDefined on this element
ele-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())
397. ExplanationOfBenefit.processNote.number
Definition

A number to uniquely identify a note entry.

Control0..1
TypepositiveInt
Requirements

Necessary to provide a mechanism to link from adjudications.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
398. ExplanationOfBenefit.processNote.type
Definition

The business purpose of the note text.

Control0..1
BindingThe codes SHALL be taken from NoteType The presentation types of notes.

Typecode
Requirements

To convey the expectation for when the text is used.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
399. ExplanationOfBenefit.processNote.text
Definition

The explanation or description associated with the processing.

Control0..1
Typestring
Must Supporttrue
Requirements

Required to provide human readable explanation.

Comments

Payment denial explanation to a member, typically goes on the EOB when the payment is denied or disallowed (181)

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
400. ExplanationOfBenefit.processNote.language
Definition

A code to define the language used in the text of the note.

Control0..1
BindingThe codes SHOULD be taken from CommonLanguages
Max Binding: AllLanguages A human language.

TypeCodeableConcept
Requirements

Note text may vary from the resource defined language.

Comments

Only required if the language is different from the resource language.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
401. ExplanationOfBenefit.benefitPeriod
Definition

The term of the benefits documented in this response.

Control0..1
TypePeriod
Requirements

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

Comments

Not applicable when use=claim.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
402. ExplanationOfBenefit.benefitBalance
Definition

Balance by Benefit Category.

Control0..*
TypeBackboneElement
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
403. 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.

Control0..1
Typestring
404. 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.

Control0..*
TypeExtension
Alternate Namesextensions, user content
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.

InvariantsDefined on this element
ele-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())
405. 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).

Control0..*
TypeExtension
Is Modifiertrue
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
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.

InvariantsDefined on this element
ele-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())
406. ExplanationOfBenefit.benefitBalance.category
Definition

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

Control1..1
BindingFor example codes, see BenefitCategoryCodes Benefit categories such as: oral, medical, vision, oral-basic etc.

TypeCodeableConcept
Requirements

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

Comments

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

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
407. 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.

Control0..1
Typeboolean
Requirements

Needed to identify items that are specifically excluded from the coverage.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
408. ExplanationOfBenefit.benefitBalance.name
Definition

A short name or tag for the benefit.

Control0..1
Typestring
Requirements

Required to align with other plan names.

Comments

For example: MED01, or DENT2.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
409. ExplanationOfBenefit.benefitBalance.description
Definition

A richer description of the benefit or services covered.

Control0..1
Typestring
Requirements

Needed for human readable reference.

Comments

For example, 'DENT2 covers 100% of basic, 50% of major but excludes Ortho, Implants and Cosmetic services'.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
410. ExplanationOfBenefit.benefitBalance.network
Definition

Is a flag to indicate whether the benefits refer to in-network providers or out-of-network providers.

Control0..1
BindingFor example codes, see NetworkTypeCodes Code to classify in or out of network services.

TypeCodeableConcept
Requirements

Needed as in or out of network providers are treated differently under the coverage.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
411. ExplanationOfBenefit.benefitBalance.unit
Definition

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

Control0..1
BindingFor example codes, see UnitTypeCodes Unit covered/serviced - individual or family.

TypeCodeableConcept
Requirements

Needed for the understanding of the benefits.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
412. ExplanationOfBenefit.benefitBalance.term
Definition

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

Control0..1
BindingFor example codes, see BenefitTermCodes Coverage unit - annual, lifetime.

TypeCodeableConcept
Requirements

Needed for the understanding of the benefits.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
413. ExplanationOfBenefit.benefitBalance.financial
Definition

Benefits Used to date.

Control0..*
TypeBackboneElement
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
414. 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.

Control0..1
Typestring
415. ExplanationOfBenefit.benefitBalance.financial.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.

Control0..*
TypeExtension
Alternate Namesextensions, user content
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.

InvariantsDefined on this element
ele-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.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).

Control0..*
TypeExtension
Is Modifiertrue
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
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.

InvariantsDefined on this element
ele-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())
417. ExplanationOfBenefit.benefitBalance.financial.type
Definition

Classification of benefit being provided.

Control1..1
BindingFor example codes, see BenefitTypeCodes Deductable, visits, co-pay, etc.

TypeCodeableConcept
Requirements

Needed to convey the nature of the benefit.

Comments

For example: deductible, visits, benefit amount.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
418. ExplanationOfBenefit.benefitBalance.financial.allowed[x]
Definition

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

Control0..1
TypeChoice of: unsignedInt, string, Money
[x] NoteSee Choice of Data Types for further information about how to use [x]
Requirements

Needed to convey the benefits offered under the coverage.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
419. ExplanationOfBenefit.benefitBalance.financial.used[x]
Definition

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

Control0..1
TypeChoice of: unsignedInt, Money
[x] NoteSee Choice of Data Types for further information about how to use [x]
Requirements

Needed to convey the benefits consumed to date.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))