My Health Record FHIR IG
1.2.0 - active

My Health Record FHIR IG - Local Development build (v1.2.0) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions

## Resource Profile: ADHAExplanationofBenefitPBS - Detailed Descriptions

Active as of 2024-09-19

Definitions for the dh-explanationofbenefit-medicare-pbs-1 resource profile.

- Differential Elements Table
- Key Elements Table
- Snapshot Elements Table

Guidance on how to interpret the contents of this table can be found here

0. ExplanationOfBenefit
Definition | A record of the claim of an item claimed against the Pharmaceutical Benefits Scheme (PBS) or Repatriation Pharmaceutical Benefits Scheme (RPBS). Claim items include information about pharmaceutical items prescribed and dispensed to an individual that were partially or fully funded under the PBS or RPBS.
Short | Record of Claim against PBS or RPBS
2. ExplanationOfBenefit.identifier
Note | This is a business identifier, not a resource identifier (see discussion)
Control | 1..?
Must Support | true
4. ExplanationOfBenefit.status
Must Support | true
Fixed Value | `active`
6. ExplanationOfBenefit.type
Must Support | true
Pattern Value | `{ "coding" : [{ "system" : "http://terminology.hl7.org/CodeSystem/claim-type", "code" : "pharmacy" }] }`
8. ExplanationOfBenefit.subType
Control | 1..?
Binding | The codes SHALL be taken from Australian Medicare Benefit and Claim Category (required to `https://healthterminologies.gov.au/fhir/ValueSet/australian-medicare-benefit-claim-category-1` )
Must Support | true
10. ExplanationOfBenefit.use
Must Support | true
Fixed Value | `claim`
12. ExplanationOfBenefit.patient
Type | Reference(ADHA Core Patient)
Must Support | true
Invariants | inv-dh-eob-01: At least reference or a valid identifier shall be present (`reference.exists() or identifier.where(system.count() + value.count() >1).exists()`)
14. ExplanationOfBenefit.created
Must Support | true
Invariants | inv-dh-eob-03: Date shall be at least to day (`toString().length() >= 10`)
16. ExplanationOfBenefit.insurer
Short | Australian Government department that subsidises the benefits scheme
Comments | In the context of a claim against the Pharmaceutical Benefits Scheme (PBS) or Repatriation Pharmaceutical Benefits Scheme (RPBS), the insurer is the Australian Government Department of Health.
Type | Reference(ADHA Core Organization)
Must Support | true
Invariants | inv-dh-eob-02: At least reference or a valid identifier shall be present (`reference.exists() or identifier.where(system.count() + value.count() >1).exists()`)
18. ExplanationOfBenefit.provider
Type | Reference(ADHA Core PractitionerRole)
Must Support | true
20. ExplanationOfBenefit.priority
Binding | For example codes, see ProcessPriorityCodes (example to `http://hl7.org/fhir/ValueSet/process-priority` )
22. ExplanationOfBenefit.prescription
Control | 1..?
Type | Reference(ADHA PBS Claim Item)
Must Support | true
24. ExplanationOfBenefit.prescription.reference
Control | 1..?
26. ExplanationOfBenefit.outcome
Must Support | true
Fixed Value | `complete`
28. ExplanationOfBenefit.insurance
Control | 0..1
Must Support | true
30. ExplanationOfBenefit.insurance.focal
Must Support | true
Fixed Value | `true`
32. ExplanationOfBenefit.insurance.coverage
Short | Medicare or Veteran card information
Comments | Medicare or veteran card information may not be available in some records, for example if this resource describes claim information that was originally in another format.
Must Support | true
34. ExplanationOfBenefit.item
Control | 1..1
Must Support | true
36. ExplanationOfBenefit.item.sequence
Must Support | true
Fixed Value | `1`
38. ExplanationOfBenefit.item.category
Control | 1..?
Binding | Unless not suitable, these codes SHALL be taken from Australian Medicare Benefit and Claim Category (extensible to `https://healthterminologies.gov.au/fhir/ValueSet/australian-medicare-benefit-claim-category-1` )
Must Support | true
40. ExplanationOfBenefit.item.productOrService
Definition | The billing code the service was claimed with against the Australian Department of Health Modified PBS Schedule Item.
Short | PBS Billing code
Comments | The code as instantiated may be padded with leading zeros when compared with the original (as published by the Department of Health).
Binding | Unless not suitable, these codes SHALL be taken from PBS Item Codes (extensible to `http://terminology.hl7.org.au/ValueSet/pbs-item` )
Must Support | true
42. ExplanationOfBenefit.item.serviced[x]
Control | 1..?
[x] Note | SeeChoice of Data Typesfor further information about how to use [x]
Must Support | true
44. ExplanationOfBenefit.item.quantity
Must Support | true

Guidance on how to interpret the contents of this table can be found here

0. ExplanationOfBenefit
Definition | A record of the claim of an item claimed against the Pharmaceutical Benefits Scheme (PBS) or Repatriation Pharmaceutical Benefits Scheme (RPBS). Claim items include information about pharmaceutical items prescribed and dispensed to an individual that were partially or fully funded under the PBS or RPBS. 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.
Short | Record of Claim against PBS or RPBSExplanation of Benefit resource
Control | 0..*
Is Modifier | false
Summary | false
Alternate Names | EOB
Invariants | 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.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.
Short | A set of rules under which this content was created
Comments | Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of it's narrative along with other profiles, value sets, etc.
Control | 0..1
Type | uri
Is Modifier | true because This element is labeled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies it's meaning or interpretation
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | true
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
4. 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).
Short | Extensions that cannot be ignored
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
Control | 0..*
Type | Extension
Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the resource that contains them
Summary | false
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 Names | extensions, user content
Invariants | 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())
6. ExplanationOfBenefit.identifier
Definition | A unique identifier assigned to this explanation of benefit.
Short | Business Identifier for the resource
Note | This is a business identifier, not a resource identifier (see discussion)
Control | 10..*
Type | Identifier
Is Modifier | false
Must Support | true
Summary | false
Requirements | Allows EOBs to be distinguished and referenced.
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
8. ExplanationOfBenefit.status
Definition | The status of the resource instance.
Short | active | cancelled | draft | entered-in-error
Comments | This element is labeled as a modifier because the status contains codes that mark the resource as not currently valid.
Control | 1..1
Binding | The codes SHALL be taken from ExplanationOfBenefitStatus http://hl7.org/fhir/ValueSet/explanationofbenefit-status|4.0.1 (required to `http://hl7.org/fhir/ValueSet/explanationofbenefit-status|4.0.1` ) A code specifying the state of the resource instance.
Type | code
Is Modifier | true because This element is labeled as a modifier because it is a status element that contains status entered-in-error which means that the resource should not be treated as valid
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Must Support | true
Summary | true
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'.
Fixed Value | `active`
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
10. ExplanationOfBenefit.type
Definition | The category of claim, e.g. oral, pharmacy, vision, institutional, professional.
Short | Category or discipline
Comments | The majority of jurisdictions use: oral, pharmacy, vision, professional and institutional, or variants on those terms, as the general styles of claims. The valueset is extensible to accommodate other jurisdictional requirements.
Control | 1..1
Binding | Unless not suitable, these codes SHALL be taken from ClaimTypeCodes http://hl7.org/fhir/ValueSet/claim-type (extensible to `http://hl7.org/fhir/ValueSet/claim-type` ) The type or discipline-style of the claim.
Type | CodeableConcept
Is Modifier | false
Must Support | true
Summary | true
Requirements | Claim type determine the general sets of business rules applied for information requirements and adjudication.
Pattern Value | `{ "coding" : [{ "system" : "http://terminology.hl7.org/CodeSystem/claim-type", "code" : "pharmacy" }] }`
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
12. 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.
Short | More granular claim type
Comments | This may contain the local bill type codes such as the US UB-04 bill type code.
Control | 10..1
Binding | The codes SHALL be taken from For example codes, see Australian Medicare Benefit and Claim Category http://hl7.org/fhir/ValueSet/claim-subtype (required to `https://healthterminologies.gov.au/fhir/ValueSet/australian-medicare-benefit-claim-category-1` )
Type | CodeableConcept
Is Modifier | false
Must Support | true
Summary | false
Requirements | Some jurisdictions need a finer grained claim type for routing and adjudication.
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
14. 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.
Short | claim | preauthorization | predetermination
Control | 1..1
Binding | The codes SHALL be taken from Use http://hl7.org/fhir/ValueSet/claim-use|4.0.1 (required to `http://hl7.org/fhir/ValueSet/claim-use|4.0.1` ) Complete, proposed, exploratory, other.
Type | code
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Must Support | true
Summary | true
Requirements | This element is required to understand the nature of the request for adjudication.
Fixed Value | `claim`
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
16. 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.
Short | The recipient of the products and services
Control | 1..1 This element is affected by the following invariants: inv-dh-eob-01
Type | Reference(ADHA Core Patient, Patient)
Is Modifier | false
Must Support | true
Summary | true
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.
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) inv-dh-eob-01: At least reference or a valid identifier shall be present (`reference.exists() or identifier.where(system.count() + value.count() >1).exists()`)
18. ExplanationOfBenefit.created
Definition | The date this resource was created.
Short | Response creation date
Comments | This field is independent of the date of creation of the resource as it may reflect the creation date of a source document prior to digitization. Typically for claims all services must be completed as of this date.
Control | 1..1 This element is affected by the following invariants: inv-dh-eob-03
Type | dateTime
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Must Support | true
Summary | true
Requirements | Need to record a timestamp for use by both the recipient and the issuer.
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) inv-dh-eob-03: Date shall be at least to day (`toString().length() >= 10`)
20. ExplanationOfBenefit.insurer
Definition | The party responsible for authorization, adjudication and reimbursement.
Short | Australian Government department that subsidises the benefits schemeParty responsible for reimbursement
Comments | In the context of a claim against the Pharmaceutical Benefits Scheme (PBS) or Repatriation Pharmaceutical Benefits Scheme (RPBS), the insurer is the Australian Government Department of Health.
Control | 1..1 This element is affected by the following invariants: inv-dh-eob-02
Type | Reference(ADHA Core Organization, Organization)
Is Modifier | false
Must Support | true
Summary | true
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.
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) inv-dh-eob-02: At least reference or a valid identifier shall be present (`reference.exists() or identifier.where(system.count() + value.count() >1).exists()`)
22. ExplanationOfBenefit.provider
Definition | The provider which is responsible for the claim, predetermination or preauthorization.
Short | Party responsible for the claim
Comments | Typically this field would be 1..1 where this party is responsible for the claim but not necessarily professionally responsible for the provision of the individual products and services listed below.
Control | 1..1
Type | Reference(ADHA Core PractitionerRole, Practitioner, PractitionerRole, Organization)
Is Modifier | false
Must Support | true
Summary | true
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
24. ExplanationOfBenefit.priority
Definition | The provider-required urgency of processing the request. Typical values include: stat, routine deferred.
Short | Desired processing urgency
Comments | If a claim processor is unable to complete the processing as per the priority then they should generate and error and not process the request.
Control | 0..1
Binding | For example codes, see ProcessPriorityCodes http://hl7.org/fhir/ValueSet/process-priority (example to `http://hl7.org/fhir/ValueSet/process-priority` )
Type | CodeableConcept
Is Modifier | false
Summary | false
Requirements | The provider may need to indicate their processing requirements so that the processor can indicate if they are unable to comply.
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
26. ExplanationOfBenefit.prescription
Definition | Prescription to support the dispensing of pharmacy, device or vision products.
Short | Prescription authorizing services or products
Control | 10..1
Type | Reference(ADHA PBS Claim Item, MedicationRequest, VisionPrescription)
Is Modifier | false
Must Support | true
Summary | false
Requirements | Required to authorize the dispensing of controlled substances and devices.
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
28. ExplanationOfBenefit.prescription.reference
Definition | A reference to a location at which the other resource is found. The reference may be a relative reference, in which case it is relative to the service base URL, or an absolute URL that resolves to the location where the resource is found. The reference may be version specific or not. If the reference is not to a FHIR RESTful server, then it should be assumed to be version specific. Internal fragment references (start with '#') refer to contained resources.
Short | Literal reference, Relative, internal or absolute URL
Comments | Using absolute URLs provides a stable scalable approach suitable for a cloud/web context, while using relative/logical references provides a flexible approach suitable for use when trading across closed eco-system boundaries. Absolute URLs do not need to point to a FHIR RESTful server, though this is the preferred approach. If the URL conforms to the structure "/[type]/[id]" then it should be assumed that the reference is to a FHIR RESTful server.
Control | 10..1 This element is affected by the following invariants: ref-1
Type | string
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | true
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
30. ExplanationOfBenefit.outcome
Definition | The outcome of the claim, predetermination, or preauthorization processing.
Short | queued | complete | error | partial
Comments | The resource may be used to indicate that: the request has been held (queued) for processing; that it has been processed and errors found (error); that no errors were found and that some of the adjudication has been undertaken (partial) or that all of the adjudication has been undertaken (complete).
Control | 1..1
Binding | The codes SHALL be taken from ClaimProcessingCodes http://hl7.org/fhir/ValueSet/remittance-outcome|4.0.1 (required to `http://hl7.org/fhir/ValueSet/remittance-outcome|4.0.1` ) The result of the claim processing.
Type | code
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Must Support | true
Summary | true
Requirements | To advise the requestor of an overall processing outcome.
Fixed Value | `complete`
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
32. ExplanationOfBenefit.insurance
Definition | Financial instruments for reimbursement for the health care products and services specified on the claim.
Short | Patient insurance information
Comments | All insurance coverages for the patient which may be applicable for reimbursement, of the products and services listed in the claim, are typically provided in the claim to allow insurers to confirm the ordering of the insurance coverages relative to local 'coordination of benefit' rules. One coverage (and only one) with 'focal=true' is to be used in the adjudication of this claim. Coverages appearing before the focal Coverage in the list, and where 'Coverage.subrogation=false', should provide a reference to the ClaimResponse containing the adjudication results of the prior claim.
Control | 1..1*
Type | BackboneElement
Is Modifier | false
Must Support | true
Summary | true
Requirements | At least one insurer is required for a claim to be a claim.
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
34. 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).
Short | Extensions that cannot be ignored even if unrecognized
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
Control | 0..*
Type | Extension
Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
Summary | true
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 Names | extensions, user content, modifiers
Invariants | 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())
36. ExplanationOfBenefit.insurance.focal
Definition | A flag to indicate that this Coverage is to be used for adjudication of this claim when set to true.
Short | Coverage to be used for adjudication
Comments | A patient may (will) have multiple insurance policies which provide reimbursement for healthcare services and products. For example, a person may also be covered by their spouse's policy and both appear in the list (and may be from the same insurer). This flag will be set to true for only one of the listed policies and that policy will be used for adjudicating this claim. Other claims would be created to request adjudication against the other listed policies.
Control | 1..1
Type | boolean
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Must Support | true
Summary | true
Requirements | To identify which coverage in the list is being used to adjudicate this claim.
Fixed Value | `true`
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
38. 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.
Short | Medicare or Veteran card informationInsurance information
Comments | Medicare or veteran card information may not be available in some records, for example if this resource describes claim information that was originally in another format.
Control | 1..1
Type | Reference(Coverage)
Is Modifier | false
Must Support | true
Summary | true
Requirements | Required to allow the adjudicator to locate the correct policy and history within their information system.
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
40. 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.
Short | Product or service provided
Control | 10..1*
Type | BackboneElement
Is Modifier | false
Must Support | true
Summary | false
Requirements | The items to be processed for adjudication.
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
42. 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).
Short | Extensions that cannot be ignored even if unrecognized
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
Control | 0..*
Type | Extension
Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
Summary | true
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 Names | extensions, user content, modifiers
Invariants | 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())
44. ExplanationOfBenefit.item.sequence
Definition | A number to uniquely identify item entries.
Short | Item instance identifier
Control | 1..1
Type | positiveInt
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Must Support | true
Summary | false
Requirements | Necessary to provide a mechanism to link to items from within the claim and within the adjudication details of the ClaimResponse.
Fixed Value | `1`
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
46. ExplanationOfBenefit.item.category
Definition | Code to identify the general type of benefits under which products and services are provided.
Short | Benefit classification
Comments | Examples include Medical Care, Periodontics, Renal Dialysis, Vision Coverage.
Control | 10..1
Binding | Unless not suitable, these codes SHALL be taken from For example codes, see Australian Medicare Benefit and Claim Category http://hl7.org/fhir/ValueSet/ex-benefitcategory (extensible to `https://healthterminologies.gov.au/fhir/ValueSet/australian-medicare-benefit-claim-category-1` )
Type | CodeableConcept
Is Modifier | false
Must Support | true
Summary | false
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.
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
48. ExplanationOfBenefit.item.productOrService
Definition | The billing code the service was claimed with against the Australian Department of Health Modified PBS Schedule Item. 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.
Short | PBS Billing codeBilling, service, product, or drug code
Comments | The code as instantiated may be padded with leading zeros when compared with the original (as published by the Department of Health). 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'.
Control | 1..1
Binding | Unless not suitable, these codes SHALL be taken from For example codes, see PBS Item Codes http://hl7.org/fhir/ValueSet/service-uscls (extensible to `http://terminology.hl7.org.au/ValueSet/pbs-item` )
Type | CodeableConcept
Is Modifier | false
Must Support | true
Summary | false
Requirements | Necessary to state what was provided or done.
Alternate Names | Drug Code, Bill Code, Service Code
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
50. ExplanationOfBenefit.item.serviced[x]
Definition | The date or dates when the service or product was supplied, performed or completed.
Short | Date or dates of service or product delivery
Control | 10..1
Type | Choice of: date, Period
[x] Note | SeeChoice of Data Typesfor further information about how to use [x]
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Must Support | true
Must Support Types | No must-support rules about the choice of types/profiles
Summary | false
Requirements | Needed to determine whether the service or product was provided during the term of the insurance coverage.
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
52. ExplanationOfBenefit.item.quantity
Definition | The number of repetitions of a service or product.
Short | Count of products or services
Control | 0..1
Type | Quantity(SimpleQuantity)
Is Modifier | false
Must Support | true
Summary | false
Requirements | Required when the product or service code does not convey the quantity provided.
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

Guidance on how to interpret the contents of this table can be found here

0. ExplanationOfBenefit
Definition | A record of the claim of an item claimed against the Pharmaceutical Benefits Scheme (PBS) or Repatriation Pharmaceutical Benefits Scheme (RPBS). Claim items include information about pharmaceutical items prescribed and dispensed to an individual that were partially or fully funded under the PBS or RPBS.
Short | Record of Claim against PBS or RPBS
Control | 0..*
Is Modifier | false
Summary | false
Alternate Names | EOB
Invariants | 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.
Short | Logical id of this artifact
Comments | The only time that a resource does not have an id is when it is being submitted to the server using a create operation.
Control | 0..1
Type | id
Is Modifier | false
Summary | true
4. ExplanationOfBenefit.meta
Definition | The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.
Short | Metadata about the resource
Control | 0..1
Type | Meta
Is Modifier | false
Summary | true
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
6. ExplanationOfBenefit.implicitRules
Definition | A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.
Short | A set of rules under which this content was created
Comments | Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of it's narrative along with other profiles, value sets, etc.
Control | 0..1
Type | uri
Is Modifier | true because This element is labeled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies it's meaning or interpretation
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | true
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
8. ExplanationOfBenefit.language
Definition | The base language in which the resource is written.
Short | Language of the resource content
Comments | Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute).
Control | 0..1
Binding | The codes SHOULD be taken from CommonLanguages (preferred to `http://hl7.org/fhir/ValueSet/languages` ) A human language.
Additional Bindings | Purpose
AllLanguages | Max Binding
Type | code
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
10. ExplanationOfBenefit.text
Definition | A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.
Short | Text summary of the resource, for human interpretation
Comments | Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a "text blob" or where text is additionally entered raw or narrated and encoded information is added later.
Control | 0..1
Type | Narrative
Is Modifier | false
Summary | false
Alternate Names | narrative, html, xhtml, display
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
12. ExplanationOfBenefit.contained
Definition | These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.
Short | Contained, inline Resources
Comments | This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags In their meta elements, but SHALL NOT have security labels.
Control | 0..*
Type | Resource
Is Modifier | false
Summary | false
Alternate Names | inline resources, anonymous resources, contained resources
14. 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.
Short | Additional content defined by implementations
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
Control | 0..*
Type | Extension
Is Modifier | false
Summary | false
Alternate Names | extensions, user content
Invariants | 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()`)
16. 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).
Short | Extensions that cannot be ignored
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
Control | 0..*
Type | Extension
Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the resource that contains them
Summary | false
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 Names | extensions, user content
Invariants | 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.identifier
Definition | A unique identifier assigned to this explanation of benefit.
Short | Business Identifier for the resource
Note | This is a business identifier, not a resource identifier (see discussion)
Control | 1..*
Type | Identifier
Is Modifier | false
Must Support | true
Summary | false
Requirements | Allows EOBs to be distinguished and referenced.
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
20. ExplanationOfBenefit.status
Definition | The status of the resource instance.
Short | active | cancelled | draft | entered-in-error
Comments | This element is labeled as a modifier because the status contains codes that mark the resource as not currently valid.
Control | 1..1
Binding | The codes SHALL be taken from ExplanationOfBenefitStatus (required to `http://hl7.org/fhir/ValueSet/explanationofbenefit-status|4.0.1` ) A code specifying the state of the resource instance.
Type | code
Is Modifier | true because This element is labeled as a modifier because it is a status element that contains status entered-in-error which means that the resource should not be treated as valid
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Must Support | true
Summary | true
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'.
Fixed Value | `active`
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
22. ExplanationOfBenefit.type
Definition | The category of claim, e.g. oral, pharmacy, vision, institutional, professional.
Short | Category or discipline
Comments | The majority of jurisdictions use: oral, pharmacy, vision, professional and institutional, or variants on those terms, as the general styles of claims. The valueset is extensible to accommodate other jurisdictional requirements.
Control | 1..1
Binding | Unless not suitable, these codes SHALL be taken from ClaimTypeCodes (extensible to `http://hl7.org/fhir/ValueSet/claim-type` ) The type or discipline-style of the claim.
Type | CodeableConcept
Is Modifier | false
Must Support | true
Summary | true
Requirements | Claim type determine the general sets of business rules applied for information requirements and adjudication.
Pattern Value | `{ "coding" : [{ "system" : "http://terminology.hl7.org/CodeSystem/claim-type", "code" : "pharmacy" }] }`
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
24. 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.
Short | More granular claim type
Comments | This may contain the local bill type codes such as the US UB-04 bill type code.
Control | 1..1
Binding | The codes SHALL be taken from Australian Medicare Benefit and Claim Category (required to `https://healthterminologies.gov.au/fhir/ValueSet/australian-medicare-benefit-claim-category-1` )
Type | CodeableConcept
Is Modifier | false
Must Support | true
Summary | false
Requirements | Some jurisdictions need a finer grained claim type for routing and adjudication.
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
26. 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.
Short | claim | preauthorization | predetermination
Control | 1..1
Binding | The codes SHALL be taken from Use (required to `http://hl7.org/fhir/ValueSet/claim-use|4.0.1` ) Complete, proposed, exploratory, other.
Type | code
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Must Support | true
Summary | true
Requirements | This element is required to understand the nature of the request for adjudication.
Fixed Value | `claim`
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
28. 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.
Short | The recipient of the products and services
Control | 1..1 This element is affected by the following invariants: inv-dh-eob-01
Type | Reference(ADHA Core Patient)
Is Modifier | false
Must Support | true
Summary | true
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.
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`) inv-dh-eob-01: At least reference or a valid identifier shall be present (`reference.exists() or identifier.where(system.count() + value.count() >1).exists()`)
30. ExplanationOfBenefit.billablePeriod
Definition | The period for which charges are being submitted.
Short | Relevant time frame for the claim
Comments | Typically this would be today or in the past for a claim, and today or in the future for preauthorizations and prodeterminations. Typically line item dates of service should fall within the billing period if one is specified.
Control | 0..1
Type | Period
Is Modifier | false
Summary | true
Requirements | A number jurisdictions required the submission of the billing period when submitting claims for example for hospital stays or long-term care.
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
32. ExplanationOfBenefit.created
Definition | The date this resource was created.
Short | Response creation date
Comments | This field is independent of the date of creation of the resource as it may reflect the creation date of a source document prior to digitization. Typically for claims all services must be completed as of this date.
Control | 1..1 This element is affected by the following invariants: inv-dh-eob-03
Type | dateTime
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Must Support | true
Summary | true
Requirements | Need to record a timestamp for use by both the recipient and the issuer.
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`) inv-dh-eob-03: Date shall be at least to day (`toString().length() >= 10`)
34. ExplanationOfBenefit.enterer
Definition | Individual who created the claim, predetermination or preauthorization.
Short | Author of the claim
Control | 0..1
Type | Reference(Practitioner, PractitionerRole)
Is Modifier | false
Summary | false
Requirements | Some jurisdictions require the contact information for personnel completing claims.
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
36. ExplanationOfBenefit.insurer
Definition | The party responsible for authorization, adjudication and reimbursement.
Short | Australian Government department that subsidises the benefits scheme
Comments | In the context of a claim against the Pharmaceutical Benefits Scheme (PBS) or Repatriation Pharmaceutical Benefits Scheme (RPBS), the insurer is the Australian Government Department of Health.
Control | 1..1 This element is affected by the following invariants: inv-dh-eob-02
Type | Reference(ADHA Core Organization)
Is Modifier | false
Must Support | true
Summary | true
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.
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`) inv-dh-eob-02: At least reference or a valid identifier shall be present (`reference.exists() or identifier.where(system.count() + value.count() >1).exists()`)
38. ExplanationOfBenefit.provider
Definition | The provider which is responsible for the claim, predetermination or preauthorization.
Short | Party responsible for the claim
Comments | Typically this field would be 1..1 where this party is responsible for the claim but not necessarily professionally responsible for the provision of the individual products and services listed below.
Control | 1..1
Type | Reference(ADHA Core PractitionerRole)
Is Modifier | false
Must Support | true
Summary | true
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
40. ExplanationOfBenefit.priority
Definition | The provider-required urgency of processing the request. Typical values include: stat, routine deferred.
Short | Desired processing urgency
Comments | If a claim processor is unable to complete the processing as per the priority then they should generate and error and not process the request.
Control | 0..1
Binding | For example codes, see ProcessPriorityCodes (example to `http://hl7.org/fhir/ValueSet/process-priority` )
Type | CodeableConcept
Is Modifier | false
Summary | false
Requirements | The provider may need to indicate their processing requirements so that the processor can indicate if they are unable to comply.
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
42. ExplanationOfBenefit.fundsReserveRequested
Definition | A code to indicate whether and for whom funds are to be reserved for future claims.
Short | For whom to reserve funds
Comments | This field is only used for preauthorizations.
Control | 0..1
Binding | For example codes, see Funds Reservation Codes (example to `http://hl7.org/fhir/ValueSet/fundsreserve` ) For whom funds are to be reserved: (Patient, Provider, None).
Type | CodeableConcept
Is Modifier | false
Summary | false
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 Names | Fund pre-allocation
Invariants | 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.
Short | Funds reserved status
Comments | Fund would be release by a future claim quoting the preAuthRef of this response. Examples of values include: provider, patient, none.
Control | 0..1
Binding | For example codes, see Funds Reservation Codes (example to `http://hl7.org/fhir/ValueSet/fundsreserve` ) For whom funds are to be reserved: (Patient, Provider, None).
Type | CodeableConcept
Is Modifier | false
Summary | false
Requirements | Needed to advise the submitting provider on whether the rquest for reservation of funds has been honored.
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
46. 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.
Short | Prior or corollary claims
Comments | For example, for the original treatment and follow-up exams.
Control | 0..*
Type | BackboneElement
Is Modifier | false
Summary | false
Requirements | For workplace or other accidents it is common to relate separate claims arising from the same event.
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
48. 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.
Short | Unique id for inter-element referencing
Control | 0..1
Type | string
Is Modifier | false
XML Format | In the XML format, this property is represented as an attribute.
Summary | false
50. 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.
Short | Additional content defined by implementations
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
Control | 0..*
Type | Extension
Is Modifier | false
Summary | false
Alternate Names | extensions, user content
Invariants | 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()`)
52. 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).
Short | Extensions that cannot be ignored even if unrecognized
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
Control | 0..*
Type | Extension
Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
Summary | true
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 Names | extensions, user content, modifiers
Invariants | 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()`)
54. ExplanationOfBenefit.related.claim
Definition | Reference to a related claim.
Short | Reference to the related claim
Control | 0..1
Type | Reference(Claim)
Is Modifier | false
Summary | false
Requirements | For workplace or other accidents it is common to relate separate claims arising from the same event.
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
56. ExplanationOfBenefit.related.relationship
Definition | A code to convey how the claims are related.
Short | How the reference claim is related
Comments | For example, prior claim or umbrella.
Control | 0..1
Binding | For example codes, see ExampleRelatedClaimRelationshipCodes (example to `http://hl7.org/fhir/ValueSet/related-claim-relationship` ) Relationship of this claim to a related Claim.
Type | CodeableConcept
Is Modifier | false
Summary | false
Requirements | Some insurers need a declaration of the type of relationship.
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
58. ExplanationOfBenefit.related.reference
Definition | An alternate organizational reference to the case or file to which this particular claim pertains.
Short | File or case reference
Comments | For example, Property/Casualty insurer claim number or Workers Compensation case number.
Control | 0..1
Type | Identifier
Is Modifier | false
Summary | false
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.
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
60. ExplanationOfBenefit.prescription
Definition | Prescription to support the dispensing of pharmacy, device or vision products.
Short | Prescription authorizing services or products
Control | 1..1
Type | Reference(ADHA PBS Claim Item)
Is Modifier | false
Must Support | true
Summary | false
Requirements | Required to authorize the dispensing of controlled substances and devices.
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
62. ExplanationOfBenefit.prescription.id
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Short | Unique id for inter-element referencing
Control | 0..1
Type | string
Is Modifier | false
XML Format | In the XML format, this property is represented as an attribute.
Summary | false
64. ExplanationOfBenefit.prescription.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.
Short | Additional content defined by implementations
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
Control | 0..*
Type | Extension
Is Modifier | false
Summary | false
Alternate Names | extensions, user content
Invariants | 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()`)
Slicing | This element introduces a set of slices on `ExplanationOfBenefit.prescription.extension`. The slices areUnordered and Open, and can be differentiated using the following discriminators: value @ url
66. ExplanationOfBenefit.prescription.reference
Definition | A reference to a location at which the other resource is found. The reference may be a relative reference, in which case it is relative to the service base URL, or an absolute URL that resolves to the location where the resource is found. The reference may be version specific or not. If the reference is not to a FHIR RESTful server, then it should be assumed to be version specific. Internal fragment references (start with '#') refer to contained resources.
Short | Literal reference, Relative, internal or absolute URL
Comments | Using absolute URLs provides a stable scalable approach suitable for a cloud/web context, while using relative/logical references provides a flexible approach suitable for use when trading across closed eco-system boundaries. Absolute URLs do not need to point to a FHIR RESTful server, though this is the preferred approach. If the URL conforms to the structure "/[type]/[id]" then it should be assumed that the reference is to a FHIR RESTful server.
Control | 1..1 This element is affected by the following invariants: ref-1
Type | string
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | true
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
68. ExplanationOfBenefit.prescription.type
Definition | The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent. The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources).
Short | Type the reference refers to (e.g. "Patient")
Comments | This element is used to indicate the type of the target of the reference. This may be used which ever of the other elements are populated (or not). In some cases, the type of the target may be determined by inspection of the reference (e.g. a RESTful URL) or by resolving the target of the reference; if both the type and a reference is provided, the reference SHALL resolve to a resource of the same type as that specified.
Control | 0..1
Binding | Unless not suitable, these codes SHALL be taken from ResourceType (extensible to `http://hl7.org/fhir/ValueSet/resource-types` ) Aa resource (or, for logical models, the URI of the logical model).
Type | uri
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | true
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
70. ExplanationOfBenefit.prescription.identifier
Definition | An identifier for the target resource. This is used when there is no way to reference the other resource directly, either because the entity it represents is not available through a FHIR server, or because there is no way for the author of the resource to convert a known identifier to an actual location. There is no requirement that a Reference.identifier point to something that is actually exposed as a FHIR instance, but it SHALL point to a business concept that would be expected to be exposed as a FHIR instance, and that instance would need to be of a FHIR resource type allowed by the reference.
Short | Logical reference, when literal reference is not known
Comments | When an identifier is provided in place of a reference, any system processing the reference will only be able to resolve the identifier to a reference if it understands the business context in which the identifier is used. Sometimes this is global (e.g. a national identifier) but often it is not. For this reason, none of the useful mechanisms described for working with references (e.g. chaining, includes) are possible, nor should servers be expected to be able resolve the reference. Servers may accept an identifier based reference untouched, resolve it, and/or reject it - see CapabilityStatement.rest.resource.referencePolicy. When both an identifier and a literal reference are provided, the literal reference is preferred. Applications processing the resource are allowed - but not required - to check that the identifier matches the literal reference Applications converting a logical reference to a literal reference may choose to leave the logical reference present, or remove it. Reference is intended to point to a structure that can potentially be expressed as a FHIR resource, though there is no need for it to exist as an actual FHIR resource instance - except in as much as an application wishes to actual find the target of the reference. The content referred to be the identifier must meet the logical constraints implied by any limitations on what resource types are permitted for the reference. For example, it would not be legitimate to send the identifier for a drug prescription if the type were Reference(Observation|DiagnosticReport). One of the use-cases for Reference.identifier is the situation where no FHIR representation exists (where the type is Reference (Any).
Note | This is a business identifier, not a resource identifier (see discussion)
Control | 0..1
Type | Identifier
Is Modifier | false
Summary | true
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
72. ExplanationOfBenefit.prescription.display
Definition | Plain text narrative that identifies the resource in addition to the resource reference.
Short | Text alternative for the resource
Comments | This is generally not the same as the Resource.text of the referenced resource. The purpose is to identify what's being referenced, not to fully describe it.
Control | 0..1
Type | string
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | true
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
74. ExplanationOfBenefit.originalPrescription
Definition | Original prescription which has been superseded by this prescription to support the dispensing of pharmacy services, medications or products.
Short | Original prescription if superceded by fulfiller
Comments | For example, a physician may prescribe a medication which the pharmacy determines is contraindicated, or for which the patient has an intolerance, and therefor issues a new prescription for an alternate medication which has the same therapeutic intent. The prescription from the pharmacy becomes the 'prescription' and that from the physician becomes the 'original prescription'.
Control | 0..1
Type | Reference(MedicationRequest)
Is Modifier | false
Summary | false
Requirements | Often required when a fulfiller varies what is fulfilled from that authorized on the original prescription.
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
76. ExplanationOfBenefit.payee
Definition | The party to be reimbursed for cost of the products and services according to the terms of the policy.
Short | Recipient of benefits payable
Comments | Often providers agree to receive the benefits payable to reduce the near-term costs to the patient. The insurer may decline to pay the provider and may choose to pay the subscriber instead.
Control | 0..1
Type | BackboneElement
Is Modifier | false
Summary | false
Requirements | The provider needs to specify who they wish to be reimbursed and the claims processor needs express who they will reimburse.
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
78. 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.
Short | Unique id for inter-element referencing
Control | 0..1
Type | string
Is Modifier | false
XML Format | In the XML format, this property is represented as an attribute.
Summary | false
80. 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.
Short | Additional content defined by implementations
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
Control | 0..*
Type | Extension
Is Modifier | false
Summary | false
Alternate Names | extensions, user content
Invariants | 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()`)
82. 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).
Short | Extensions that cannot be ignored even if unrecognized
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
Control | 0..*
Type | Extension
Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
Summary | true
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 Names | extensions, user content, modifiers
Invariants | 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()`)
84. ExplanationOfBenefit.payee.type
Definition | Type of Party to be reimbursed: Subscriber, provider, other.
Short | Category of recipient
Control | 0..1
Binding | For example codes, see Claim Payee Type Codes (example to `http://hl7.org/fhir/ValueSet/payeetype` ) A code for the party to be reimbursed.
Type | CodeableConcept
Is Modifier | false
Summary | false
Requirements | Need to know who should receive payment with the most common situations being the Provider (assignment of benefits) or the Subscriber.
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
86. ExplanationOfBenefit.payee.party
Definition | Reference to the individual or organization to whom any payment will be made.
Short | Recipient reference
Comments | Not required if the payee is 'subscriber' or 'provider'.
Control | 0..1
Type | Reference(Practitioner, PractitionerRole, Organization, Patient, RelatedPerson)
Is Modifier | false
Summary | false
Requirements | Need to provide demographics if the payee is not 'subscriber' nor 'provider'.
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
88. ExplanationOfBenefit.referral
Definition | A reference to a referral resource.
Short | Treatment Referral
Comments | The referral resource which lists the date, practitioner, reason and other supporting information.
Control | 0..1
Type | Reference(ServiceRequest)
Is Modifier | false
Summary | false
Requirements | Some insurers require proof of referral to pay for services or to pay specialist rates for services.
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
90. ExplanationOfBenefit.facility
Definition | Facility where the services were provided.
Short | Servicing Facility
Control | 0..1
Type | Reference(Location)
Is Modifier | false
Summary | false
Requirements | Insurance adjudication can be dependant on where services were delivered.
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
92. ExplanationOfBenefit.claim
Definition | The business identifier for the instance of the adjudication request: claim predetermination or preauthorization.
Short | Claim reference
Control | 0..1
Type | Reference(Claim)
Is Modifier | false
Summary | false
Requirements | To provide a link to the original adjudication request.
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
94. ExplanationOfBenefit.claimResponse
Definition | The business identifier for the instance of the adjudication response: claim, predetermination or preauthorization response.
Short | Claim response reference
Control | 0..1
Type | Reference(ClaimResponse)
Is Modifier | false
Summary | false
Requirements | To provide a link to the original adjudication response.
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
96. ExplanationOfBenefit.outcome
Definition | The outcome of the claim, predetermination, or preauthorization processing.
Short | queued | complete | error | partial
Comments | The resource may be used to indicate that: the request has been held (queued) for processing; that it has been processed and errors found (error); that no errors were found and that some of the adjudication has been undertaken (partial) or that all of the adjudication has been undertaken (complete).
Control | 1..1
Binding | The codes SHALL be taken from ClaimProcessingCodes (required to `http://hl7.org/fhir/ValueSet/remittance-outcome|4.0.1` ) The result of the claim processing.
Type | code
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Must Support | true
Summary | true
Requirements | To advise the requestor of an overall processing outcome.
Fixed Value | `complete`
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
98. ExplanationOfBenefit.disposition
Definition | A human readable description of the status of the adjudication.
Short | Disposition Message
Control | 0..1
Type | string
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | false
Requirements | Provided for user display.
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
100. ExplanationOfBenefit.preAuthRef
Definition | Reference from the Insurer which is used in later communications which refers to this adjudication.
Short | Preauthorization reference
Comments | This value is only present on preauthorization adjudications.
Control | 0..*
Type | string
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | false
Requirements | On subsequent claims, the insurer may require the provider to quote this value.
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
102. ExplanationOfBenefit.preAuthRefPeriod
Definition | The timeframe during which the supplied preauthorization reference may be quoted on claims to obtain the adjudication as provided.
Short | Preauthorization in-effect period
Comments | This value is only present on preauthorization adjudications.
Control | 0..*
Type | Period
Is Modifier | false
Summary | false
Requirements | On subsequent claims, the insurer may require the provider to quote this value.
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
104. ExplanationOfBenefit.careTeam
Definition | The members of the team who provided the products and services.
Short | Care Team members
Control | 0..*
Type | BackboneElement
Is Modifier | false
Summary | false
Requirements | Common to identify the responsible and supporting practitioners.
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
106. 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.
Short | Unique id for inter-element referencing
Control | 0..1
Type | string
Is Modifier | false
XML Format | In the XML format, this property is represented as an attribute.
Summary | false
108. 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.
Short | Additional content defined by implementations
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
Control | 0..*
Type | Extension
Is Modifier | false
Summary | false
Alternate Names | extensions, user content
Invariants | 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.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).
Short | Extensions that cannot be ignored even if unrecognized
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
Control | 0..*
Type | Extension
Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
Summary | true
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 Names | extensions, user content, modifiers
Invariants | 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()`)
112. ExplanationOfBenefit.careTeam.sequence
Definition | A number to uniquely identify care team entries.
Short | Order of care team
Control | 1..1
Type | positiveInt
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | false
Requirements | Necessary to maintain the order of the care team and provide a mechanism to link individuals to claim details.
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
114. ExplanationOfBenefit.careTeam.provider
Definition | Member of the team who provided the product or service.
Short | Practitioner or organization
Control | 1..1
Type | Reference(Practitioner, PractitionerRole, Organization)
Is Modifier | false
Summary | false
Requirements | Often a regulatory requirement to specify the responsible provider.
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
116. ExplanationOfBenefit.careTeam.responsible
Definition | The party who is billing and/or responsible for the claimed products or services.
Short | Indicator of the lead practitioner
Comments | Responsible might not be required when there is only a single provider listed.
Control | 0..1
Type | boolean
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | false
Requirements | When multiple parties are present it is required to distinguish the lead or responsible individual.
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
118. ExplanationOfBenefit.careTeam.role
Definition | The lead, assisting or supervising practitioner and their discipline if a multidisciplinary team.
Short | Function within the team
Comments | Role might not be required when there is only a single provider listed.
Control | 0..1
Binding | For example codes, see ClaimCareTeamRoleCodes (example to `http://hl7.org/fhir/ValueSet/claim-careteamrole` ) The role codes for the care team members.
Type | CodeableConcept
Is Modifier | false
Summary | false
Requirements | When multiple parties are present it is required to distinguish the roles performed by each member.
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
120. ExplanationOfBenefit.careTeam.qualification
Definition | The qualification of the practitioner which is applicable for this service.
Short | Practitioner credential or specialization
Control | 0..1
Binding | For example codes, see ExampleProviderQualificationCodes (example to `http://hl7.org/fhir/ValueSet/provider-qualification` ) Provider professional qualifications.
Type | CodeableConcept
Is Modifier | false
Summary | false
Requirements | Need to specify which qualification a provider is delivering the product or service under.
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
122. ExplanationOfBenefit.supportingInfo
Definition | Additional information codes regarding exceptions, special considerations, the condition, situation, prior or concurrent issues.
Short | Supporting information
Comments | Often there are multiple jurisdiction specific valuesets which are required.
Control | 0..*
Type | BackboneElement
Is Modifier | false
Summary | false
Requirements | Typically these information codes are required to support the services rendered or the adjudication of the services rendered.
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
124. 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.
Short | Unique id for inter-element referencing
Control | 0..1
Type | string
Is Modifier | false
XML Format | In the XML format, this property is represented as an attribute.
Summary | false
126. 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.
Short | Additional content defined by implementations
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
Control | 0..*
Type | Extension
Is Modifier | false
Summary | false
Alternate Names | extensions, user content
Invariants | 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()`)
128. 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).
Short | Extensions that cannot be ignored even if unrecognized
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
Control | 0..*
Type | Extension
Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
Summary | true
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 Names | extensions, user content, modifiers
Invariants | 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.sequence
Definition | A number to uniquely identify supporting information entries.
Short | Information instance identifier
Control | 1..1
Type | positiveInt
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | false
Requirements | Necessary to maintain the order of the supporting information items and provide a mechanism to link to claim details.
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
132. ExplanationOfBenefit.supportingInfo.category
Definition | The general class of the information supplied: information; exception; accident, employment; onset, etc.
Short | Classification of the supplied information
Comments | This may contain a category for the local bill type codes.
Control | 1..1
Binding | For example codes, see ClaimInformationCategoryCodes (example to `http://hl7.org/fhir/ValueSet/claim-informationcategory` ) The valuset used for additional information category codes.
Type | CodeableConcept
Is Modifier | false
Summary | false
Requirements | Required to group or associate information items with common characteristics. For example: admission information or prior treatments.
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
134. 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.
Short | Type of information
Comments | This may contain the local bill type codes such as the US UB-04 bill type code.
Control | 0..1
Binding | For example codes, see ExceptionCodes (example to `http://hl7.org/fhir/ValueSet/claim-exception` ) The valuset used for additional information codes.
Type | CodeableConcept
Is Modifier | false
Summary | false
Requirements | Required to identify the kind of additional information.
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
136. ExplanationOfBenefit.supportingInfo.timing[x]
Definition | The date when or period to which this information refers.
Short | When it occurred
Control | 0..1
Type | Choice of: date, Period
[x] Note | SeeChoice of Data Typesfor further information about how to use [x]
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
138. 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.
Short | Data to be provided
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.
Control | 0..1
Type | Choice of: boolean, string, Quantity, Attachment, Reference(Resource)
[x] Note | SeeChoice of Data Typesfor further information about how to use [x]
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | false
Requirements | To convey the data content to be provided when the information is more than a simple code or period.
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
140. ExplanationOfBenefit.supportingInfo.reason
Definition | Provides the reason in the situation where a reason code is required in addition to the content.
Short | Explanation for the information
Comments | For example: the reason for the additional stay, or why a tooth is missing.
Control | 0..1
Binding | For example codes, see MissingToothReasonCodes (example to `http://hl7.org/fhir/ValueSet/missing-tooth-reason` ) Reason codes for the missing teeth.
Type | Coding
Is Modifier | false
Summary | false
Requirements | Needed when the supporting information has both a date and amount/value and requires explanation.
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
142. ExplanationOfBenefit.diagnosis
Definition | Information about diagnoses relevant to the claim items.
Short | Pertinent diagnosis information
Control | 0..*
Type | BackboneElement
Is Modifier | false
Summary | false
Requirements | Required for the adjudication by provided context for the services and product listed.
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
144. ExplanationOfBenefit.diagnosis.id
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Short | Unique id for inter-element referencing
Control | 0..1
Type | string
Is Modifier | false
XML Format | In the XML format, this property is represented as an attribute.
Summary | false
146. ExplanationOfBenefit.diagnosis.extension
Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
Short | Additional content defined by implementations
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
Control | 0..*
Type | Extension
Is Modifier | false
Summary | false
Alternate Names | extensions, user content
Invariants | 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()`)
148. ExplanationOfBenefit.diagnosis.modifierExtension
Definition | May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
Short | Extensions that cannot be ignored even if unrecognized
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
Control | 0..*
Type | Extension
Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
Summary | true
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 Names | extensions, user content, modifiers
Invariants | 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.diagnosis.sequence
Definition | A number to uniquely identify diagnosis entries.
Short | Diagnosis instance identifier
Comments | Diagnosis are presented in list order to their expected importance: primary, secondary, etc.
Control | 1..1
Type | positiveInt
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | false
Requirements | Necessary to maintain the order of the diagnosis items and provide a mechanism to link to claim details.
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
152. ExplanationOfBenefit.diagnosis.diagnosis[x]
Definition | The nature of illness or problem in a coded form or as a reference to an external defined Condition.
Short | Nature of illness or problem
Control | 1..1
Binding | For example codes, see ICD-10Codes (example to `http://hl7.org/fhir/ValueSet/icd-10` ) ICD10 Diagnostic codes.
Type | Choice of: CodeableConcept, Reference(Condition)
[x] Note | SeeChoice of Data Typesfor further information about how to use [x]
Is Modifier | false
Summary | false
Requirements | Provides health context for the evaluation of the products and/or services.
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
154. ExplanationOfBenefit.diagnosis.type
Definition | When the condition was observed or the relative ranking.
Short | Timing or nature of the diagnosis
Comments | For example: admitting, primary, secondary, discharge.
Control | 0..*
Binding | For example codes, see ExampleDiagnosisTypeCodes (example to `http://hl7.org/fhir/ValueSet/ex-diagnosistype` ) The type of the diagnosis: admitting, principal, discharge.
Type | CodeableConcept
Is Modifier | false
Summary | false
Requirements | Often required to capture a particular diagnosis, for example: primary or discharge.
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
156. ExplanationOfBenefit.diagnosis.onAdmission
Definition | Indication of whether the diagnosis was present on admission to a facility.
Short | Present on admission
Control | 0..1
Binding | For example codes, see ExampleDiagnosisOnAdmissionCodes (example to `http://hl7.org/fhir/ValueSet/ex-diagnosis-on-admission` ) Present on admission.
Type | CodeableConcept
Is Modifier | false
Summary | false
Requirements | Many systems need to understand for adjudication if the diagnosis was present a time of admission.
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
158. ExplanationOfBenefit.diagnosis.packageCode
Definition | A package billing code or bundle code used to group products and services to a particular health condition (such as heart attack) which is based on a predetermined grouping code system.
Short | Package billing code
Comments | For example, DRG (Diagnosis Related Group) or a bundled billing code. A patient may have a diagnosis of a Myocardio-infarction and a DRG for HeartAttack would assigned. The Claim item (and possible subsequent claims) would refer to the DRG for those line items that were for services related to the heart attack event.
Control | 0..1
Binding | For example codes, see ExampleDiagnosisRelatedGroupCodes (example to `http://hl7.org/fhir/ValueSet/ex-diagnosisrelatedgroup` ) The DRG codes associated with the diagnosis.
Type | CodeableConcept
Is Modifier | false
Summary | false
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.
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
160. ExplanationOfBenefit.procedure
Definition | Procedures performed on the patient relevant to the billing items with the claim.
Short | Clinical procedures performed
Control | 0..*
Type | BackboneElement
Is Modifier | false
Summary | false
Requirements | The specific clinical invention are sometimes required to be provided to justify billing a greater than customary amount for a service.
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
162. ExplanationOfBenefit.procedure.id
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Short | Unique id for inter-element referencing
Control | 0..1
Type | string
Is Modifier | false
XML Format | In the XML format, this property is represented as an attribute.
Summary | false
164. ExplanationOfBenefit.procedure.extension
Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
Short | Additional content defined by implementations
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
Control | 0..*
Type | Extension
Is Modifier | false
Summary | false
Alternate Names | extensions, user content
Invariants | 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()`)
166. ExplanationOfBenefit.procedure.modifierExtension
Definition | May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
Short | Extensions that cannot be ignored even if unrecognized
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
Control | 0..*
Type | Extension
Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
Summary | true
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 Names | extensions, user content, modifiers
Invariants | 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()`)
168. ExplanationOfBenefit.procedure.sequence
Definition | A number to uniquely identify procedure entries.
Short | Procedure instance identifier
Control | 1..1
Type | positiveInt
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | false
Requirements | Necessary to provide a mechanism to link to claim details.
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
170. ExplanationOfBenefit.procedure.type
Definition | When the condition was observed or the relative ranking.
Short | Category of Procedure
Control | 0..*
Binding | For example codes, see ExampleProcedureTypeCodes (example to `http://hl7.org/fhir/ValueSet/ex-procedure-type` ) Example procedure type codes.
Type | CodeableConcept
Is Modifier | false
Summary | false
Requirements | Often required to capture a particular diagnosis, for example: primary or discharge.
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
172. ExplanationOfBenefit.procedure.date
Definition | Date and optionally time the procedure was performed.
Short | When the procedure was performed
Control | 0..1
Type | dateTime
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | false
Requirements | Required for auditing purposes.
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
174. ExplanationOfBenefit.procedure.procedure[x]
Definition | The code or reference to a Procedure resource which identifies the clinical intervention performed.
Short | Specific clinical procedure
Control | 1..1
Binding | For example codes, see ICD-10ProcedureCodes (example to `http://hl7.org/fhir/ValueSet/icd-10-procedures` ) ICD10 Procedure codes.
Type | Choice of: CodeableConcept, Reference(Procedure)
[x] Note | SeeChoice of Data Typesfor further information about how to use [x]
Is Modifier | false
Summary | false
Requirements | This identifies the actual clinical procedure.
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
176. ExplanationOfBenefit.procedure.udi
Definition | Unique Device Identifiers associated with this line item.
Short | Unique device identifier
Control | 0..*
Type | Reference(Device)
Is Modifier | false
Summary | false
Requirements | The UDI code allows the insurer to obtain device level information on the product supplied.
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
178. ExplanationOfBenefit.precedence
Definition | This indicates the relative order of a series of EOBs related to different coverages for the same suite of services.
Short | Precedence (primary, secondary, etc.)
Control | 0..1
Type | positiveInt
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | false
Requirements | Needed to coordinate between multiple EOBs for the same suite of services.
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
180. ExplanationOfBenefit.insurance
Definition | Financial instruments for reimbursement for the health care products and services specified on the claim.
Short | Patient insurance information
Comments | All insurance coverages for the patient which may be applicable for reimbursement, of the products and services listed in the claim, are typically provided in the claim to allow insurers to confirm the ordering of the insurance coverages relative to local 'coordination of benefit' rules. One coverage (and only one) with 'focal=true' is to be used in the adjudication of this claim. Coverages appearing before the focal Coverage in the list, and where 'Coverage.subrogation=false', should provide a reference to the ClaimResponse containing the adjudication results of the prior claim.
Control | 1..1
Type | BackboneElement
Is Modifier | false
Must Support | true
Summary | true
Requirements | At least one insurer is required for a claim to be a claim.
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
182. ExplanationOfBenefit.insurance.id
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Short | Unique id for inter-element referencing
Control | 0..1
Type | string
Is Modifier | false
XML Format | In the XML format, this property is represented as an attribute.
Summary | false
184. ExplanationOfBenefit.insurance.extension
Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
Short | Additional content defined by implementations
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
Control | 0..*
Type | Extension
Is Modifier | false
Summary | false
Alternate Names | extensions, user content
Invariants | 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()`)
186. ExplanationOfBenefit.insurance.modifierExtension
Definition | May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
Short | Extensions that cannot be ignored even if unrecognized
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
Control | 0..*
Type | Extension
Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
Summary | true
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 Names | extensions, user content, modifiers
Invariants | 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()`)
188. ExplanationOfBenefit.insurance.focal
Definition | A flag to indicate that this Coverage is to be used for adjudication of this claim when set to true.
Short | Coverage to be used for adjudication
Comments | A patient may (will) have multiple insurance policies which provide reimbursement for healthcare services and products. For example, a person may also be covered by their spouse's policy and both appear in the list (and may be from the same insurer). This flag will be set to true for only one of the listed policies and that policy will be used for adjudicating this claim. Other claims would be created to request adjudication against the other listed policies.
Control | 1..1
Type | boolean
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Must Support | true
Summary | true
Requirements | To identify which coverage in the list is being used to adjudicate this claim.
Fixed Value | `true`
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
190. ExplanationOfBenefit.insurance.coverage
Definition | Reference to the insurance card level information contained in the Coverage resource. The coverage issuing insurer will use these details to locate the patient's actual coverage within the insurer's information system.
Short | Medicare or Veteran card information
Comments | Medicare or veteran card information may not be available in some records, for example if this resource describes claim information that was originally in another format.
Control | 1..1
Type | Reference(Coverage)
Is Modifier | false
Must Support | true
Summary | true
Requirements | Required to allow the adjudicator to locate the correct policy and history within their information system.
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
192. ExplanationOfBenefit.insurance.preAuthRef
Definition | Reference numbers previously provided by the insurer to the provider to be quoted on subsequent claims containing services or products related to the prior authorization.
Short | Prior authorization reference number
Comments | This value is an alphanumeric string that may be provided over the phone, via text, via paper, or within a ClaimResponse resource and is not a FHIR Identifier.
Control | 0..*
Type | string
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | false
Requirements | Providers must quote previously issued authorization reference numbers in order to obtain adjudication as previously advised on the Preauthorization.
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
194. ExplanationOfBenefit.accident
Definition | Details of a accident which resulted in injuries which required the products and services listed in the claim.
Short | Details of the event
Control | 0..1
Type | BackboneElement
Is Modifier | false
Summary | false
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.
Invariants | 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.
Short | Unique id for inter-element referencing
Control | 0..1
Type | string
Is Modifier | false
XML Format | In the XML format, this property is represented as an attribute.
Summary | false
198. ExplanationOfBenefit.accident.extension
Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
Short | Additional content defined by implementations
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
Control | 0..*
Type | Extension
Is Modifier | false
Summary | false
Alternate Names | extensions, user content
Invariants | 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()`)
200. ExplanationOfBenefit.accident.modifierExtension
Definition | May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
Short | Extensions that cannot be ignored even if unrecognized
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
Control | 0..*
Type | Extension
Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
Summary | true
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 Names | extensions, user content, modifiers
Invariants | 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()`)
202. ExplanationOfBenefit.accident.date
Definition | Date of an accident event related to the products and services contained in the claim.
Short | When the incident occurred
Comments | The date of the accident has to precede the dates of the products and services but within a reasonable timeframe.
Control | 0..1
Type | date
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | false
Requirements | Required for audit purposes and adjudication.
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
204. ExplanationOfBenefit.accident.type
Definition | The type or context of the accident event for the purposes of selection of potential insurance coverages and determination of coordination between insurers.
Short | The nature of the accident
Control | 0..1
Binding | Unless not suitable, these codes SHALL be taken from ActIncidentCode (extensible to `http://terminology.hl7.org/ValueSet/v3-ActIncidentCode` ) Type of accident: work place, auto, etc.
Type | CodeableConcept
Is Modifier | false
Summary | false
Requirements | Coverage may be dependant on the type of accident.
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
206. ExplanationOfBenefit.accident.location[x]
Definition | The physical location of the accident event.
Short | Where the event occurred
Control | 0..1
Type | Choice of: Address, Reference(Location)
[x] Note | SeeChoice of Data Typesfor further information about how to use [x]
Is Modifier | false
Summary | false
Requirements | Required for audit purposes and determination of applicable insurance liability.
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
208. ExplanationOfBenefit.item
Definition | A claim line. Either a simple (a product or service) or a 'group' of details which can also be a simple items or groups of sub-details.
Short | Product or service provided
Control | 1..1
Type | BackboneElement
Is Modifier | false
Must Support | true
Summary | false
Requirements | The items to be processed for adjudication.
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
210. 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.
Short | Unique id for inter-element referencing
Control | 0..1
Type | string
Is Modifier | false
XML Format | In the XML format, this property is represented as an attribute.
Summary | false
212. 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.
Short | Additional content defined by implementations
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
Control | 0..*
Type | Extension
Is Modifier | false
Summary | false
Alternate Names | extensions, user content
Invariants | 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()`)
214. 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).
Short | Extensions that cannot be ignored even if unrecognized
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
Control | 0..*
Type | Extension
Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
Summary | true
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 Names | extensions, user content, modifiers
Invariants | 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()`)
216. ExplanationOfBenefit.item.sequence
Definition | A number to uniquely identify item entries.
Short | Item instance identifier
Control | 1..1
Type | positiveInt
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Must Support | true
Summary | false
Requirements | Necessary to provide a mechanism to link to items from within the claim and within the adjudication details of the ClaimResponse.
Fixed Value | `1`
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
218. ExplanationOfBenefit.item.careTeamSequence
Definition | Care team members related to this service or product.
Short | Applicable care team members
Control | 0..*
Type | positiveInt
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | false
Requirements | Need to identify the individuals and their roles in the provision of the product or service.
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
220. ExplanationOfBenefit.item.diagnosisSequence
Definition | Diagnoses applicable for this service or product.
Short | Applicable diagnoses
Control | 0..*
Type | positiveInt
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | false
Requirements | Need to related the product or service to the associated diagnoses.
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
222. ExplanationOfBenefit.item.procedureSequence
Definition | Procedures applicable for this service or product.
Short | Applicable procedures
Control | 0..*
Type | positiveInt
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | false
Requirements | Need to provide any listed specific procedures to support the product or service being claimed.
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
224. ExplanationOfBenefit.item.informationSequence
Definition | Exceptions, special conditions and supporting information applicable for this service or product.
Short | Applicable exception and supporting information
Control | 0..*
Type | positiveInt
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | false
Requirements | Need to reference the supporting information items that relate directly to this product or service.
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
226. ExplanationOfBenefit.item.revenue
Definition | The type of revenue or cost center providing the product and/or service.
Short | Revenue or cost center code
Control | 0..1
Binding | For example codes, see ExampleRevenueCenterCodes (example to `http://hl7.org/fhir/ValueSet/ex-revenue-center` ) Codes for the revenue or cost centers supplying the service and/or products.
Type | CodeableConcept
Is Modifier | false
Summary | false
Requirements | Needed in the processing of institutional claims.
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
228. ExplanationOfBenefit.item.category
Definition | Code to identify the general type of benefits under which products and services are provided.
Short | Benefit classification
Comments | Examples include Medical Care, Periodontics, Renal Dialysis, Vision Coverage.
Control | 1..1
Binding | Unless not suitable, these codes SHALL be taken from Australian Medicare Benefit and Claim Category (extensible to `https://healthterminologies.gov.au/fhir/ValueSet/australian-medicare-benefit-claim-category-1` )
Type | CodeableConcept
Is Modifier | false
Must Support | true
Summary | false
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.
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
230. ExplanationOfBenefit.item.productOrService
Definition | The billing code the service was claimed with against the Australian Department of Health Modified PBS Schedule Item.
Short | PBS Billing code
Comments | The code as instantiated may be padded with leading zeros when compared with the original (as published by the Department of Health).
Control | 1..1
Binding | Unless not suitable, these codes SHALL be taken from PBS Item Codes (extensible to `http://terminology.hl7.org.au/ValueSet/pbs-item` )
Type | CodeableConcept
Is Modifier | false
Must Support | true
Summary | false
Requirements | Necessary to state what was provided or done.
Alternate Names | Drug Code, Bill Code, Service Code
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
232. ExplanationOfBenefit.item.modifier
Definition | Item typification or modifiers codes to convey additional context for the product or service.
Short | Product or service billing modifiers
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.
Control | 0..*
Binding | For example codes, see ModifierTypeCodes (example to `http://hl7.org/fhir/ValueSet/claim-modifiers` ) Item type or modifiers codes, eg for Oral whether the treatment is cosmetic or associated with TMJ, or an appliance was lost or stolen.
Type | CodeableConcept
Is Modifier | false
Summary | false
Requirements | To support inclusion of the item for adjudication or to charge an elevated fee.
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
234. ExplanationOfBenefit.item.programCode
Definition | Identifies the program under which this may be recovered.
Short | Program the product or service is provided under
Comments | For example: Neonatal program, child dental program or drug users recovery program.
Control | 0..*
Binding | For example codes, see ExampleProgramReasonCodes (example to `http://hl7.org/fhir/ValueSet/ex-program-code` ) Program specific reason codes.
Type | CodeableConcept
Is Modifier | false
Summary | false
Requirements | Commonly used in in the identification of publicly provided program focused on population segments or disease classifications.
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
236. ExplanationOfBenefit.item.serviced[x]
Definition | The date or dates when the service or product was supplied, performed or completed.
Short | Date or dates of service or product delivery
Control | 1..1
Type | Choice of: date, Period
[x] Note | SeeChoice of Data Typesfor further information about how to use [x]
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Must Support | true
Must Support Types | No must-support rules about the choice of types/profiles
Summary | false
Requirements | Needed to determine whether the service or product was provided during the term of the insurance coverage.
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
238. ExplanationOfBenefit.item.location[x]
Definition | Where the product or service was provided.
Short | Place of service or where product was supplied
Control | 0..1
Binding | For example codes, see ExampleServicePlaceCodes (example to `http://hl7.org/fhir/ValueSet/service-place` ) Place where the service is rendered.
Type | Choice of: CodeableConcept, Address, Reference(Location)
[x] Note | SeeChoice of Data Typesfor further information about how to use [x]
Is Modifier | false
Summary | false
Requirements | The location can alter whether the item was acceptable for insurance purposes or impact the determination of the benefit amount.
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
240. ExplanationOfBenefit.item.quantity
Definition | The number of repetitions of a service or product.
Short | Count of products or services
Control | 0..1
Type | Quantity(SimpleQuantity)
Is Modifier | false
Must Support | true
Summary | false
Requirements | Required when the product or service code does not convey the quantity provided.
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
242. 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.
Short | Fee, charge or cost per item
Control | 0..1
Type | Money
Is Modifier | false
Summary | false
Requirements | The amount charged to the patient by the provider for a single unit.
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
244. 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.
Short | Price scaling factor
Comments | To show a 10% senior's discount, the value entered is: 0.90 (1.00 - 0.10).
Control | 0..1
Type | decimal
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | false
Requirements | When discounts are provided to a patient (example: Senior's discount) then this must be documented for adjudication.
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
246. ExplanationOfBenefit.item.net
Definition | The quantity times the unit price for an additional service or product or charge.
Short | Total item cost
Comments | For example, the formula: quantity * unitPrice * factor = net. Quantity and factor are assumed to be 1 if not supplied.
Control | 0..1
Type | Money
Is Modifier | false
Summary | false
Requirements | Provides the total amount claimed for the group (if a grouper) or the line item.
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
248. ExplanationOfBenefit.item.udi
Definition | Unique Device Identifiers associated with this line item.
Short | Unique device identifier
Control | 0..*
Type | Reference(Device)
Is Modifier | false
Summary | false
Requirements | The UDI code allows the insurer to obtain device level information on the product supplied.
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
250. ExplanationOfBenefit.item.bodySite
Definition | Physical service site on the patient (limb, tooth, etc.).
Short | Anatomical location
Comments | For example: Providing a tooth code, allows an insurer to identify a provider performing a filling on a tooth that was previously removed.
Control | 0..1
Binding | For example codes, see OralSiteCodes (example to `http://hl7.org/fhir/ValueSet/tooth` ) The code for the teeth, quadrant, sextant and arch.
Type | CodeableConcept
Is Modifier | false
Summary | false
Requirements | Allows insurer to validate specific procedures.
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
252. ExplanationOfBenefit.item.subSite
Definition | A region or surface of the bodySite, e.g. limb region or tooth surface(s).
Short | Anatomical sub-location
Control | 0..*
Binding | For example codes, see SurfaceCodes (example to `http://hl7.org/fhir/ValueSet/surface` ) The code for the tooth surface and surface combinations.
Type | CodeableConcept
Is Modifier | false
Summary | false
Requirements | Allows insurer to validate specific procedures.
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
254. ExplanationOfBenefit.item.encounter
Definition | A billed item may include goods or services provided in multiple encounters.
Short | Encounters related to this billed item
Control | 0..*
Type | Reference(Encounter)
Is Modifier | false
Summary | false
Requirements | Used in some jurisdictions to link clinical events to claim items.
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
256. ExplanationOfBenefit.item.noteNumber
Definition | The numbers associated with notes below which apply to the adjudication of this item.
Short | Applicable note numbers
Control | 0..*
Type | positiveInt
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | false
Requirements | Provides a condensed manner for associating human readable descriptive explanations for adjudications on the line item.
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
258. 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.
Short | Adjudication details
Control | 0..*
Type | BackboneElement
Is Modifier | false
Summary | false
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.
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
260. 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.
Short | Unique id for inter-element referencing
Control | 0..1
Type | string
Is Modifier | false
XML Format | In the XML format, this property is represented as an attribute.
Summary | false
262. 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.
Short | Additional content defined by implementations
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
Control | 0..*
Type | Extension
Is Modifier | false
Summary | false
Alternate Names | extensions, user content
Invariants | 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.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).
Short | Extensions that cannot be ignored even if unrecognized
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
Control | 0..*
Type | Extension
Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
Summary | true
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 Names | extensions, user content, modifiers
Invariants | 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()`)
266. 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.
Short | Type of adjudication information
Comments | For example, codes indicating: Co-Pay, deductible, eligible, benefit, tax, etc.
Control | 1..1
Binding | For example codes, see AdjudicationValueCodes (example to `http://hl7.org/fhir/ValueSet/adjudication` ) The adjudication codes.
Type | CodeableConcept
Is Modifier | false
Summary | false
Requirements | Needed to enable understanding of the context of the other information in the adjudication.
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
268. ExplanationOfBenefit.item.adjudication.reason
Definition | A code supporting the understanding of the adjudication result and explaining variance from expected amount.
Short | Explanation of adjudication outcome
Comments | For example, may indicate that the funds for this benefit type have been exhausted.
Control | 0..1
Binding | For example codes, see AdjudicationReasonCodes (example to `http://hl7.org/fhir/ValueSet/adjudication-reason` ) Adjudication reason codes.
Type | CodeableConcept
Is Modifier | false
Summary | false
Requirements | To support understanding of variance from adjudication expectations.
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
270. ExplanationOfBenefit.item.adjudication.amount
Definition | Monetary amount associated with the category.
Short | Monetary amount
Comments | For example, amount submitted, eligible amount, co-payment, and benefit payable.
Control | 0..1
Type | Money
Is Modifier | false
Summary | false
Requirements | Most adjuciation categories convey a monetary amount.
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
272. ExplanationOfBenefit.item.adjudication.value
Definition | A non-monetary value associated with the category. Mutually exclusive to the amount element above.
Short | Non-monitary value
Comments | For example: eligible percentage or co-payment percentage.
Control | 0..1
Type | decimal
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | false
Requirements | Some adjudication categories convey a percentage or a fixed value.
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
274. ExplanationOfBenefit.item.detail
Definition | Second-tier of goods and services.
Short | Additional items
Control | 0..*
Type | BackboneElement
Is Modifier | false
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
276. 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.
Short | Unique id for inter-element referencing
Control | 0..1
Type | string
Is Modifier | false
XML Format | In the XML format, this property is represented as an attribute.
Summary | false
278. 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.
Short | Additional content defined by implementations
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
Control | 0..*
Type | Extension
Is Modifier | false
Summary | false
Alternate Names | extensions, user content
Invariants | 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.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).
Short | Extensions that cannot be ignored even if unrecognized
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
Control | 0..*
Type | Extension
Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
Summary | true
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 Names | extensions, user content, modifiers
Invariants | 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()`)
282. 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.
Short | Product or service provided
Control | 1..1
Type | positiveInt
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | false
Requirements | The items to be processed for adjudication.
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
284. ExplanationOfBenefit.item.detail.revenue
Definition | The type of revenue or cost center providing the product and/or service.
Short | Revenue or cost center code
Control | 0..1
Binding | For example codes, see ExampleRevenueCenterCodes (example to `http://hl7.org/fhir/ValueSet/ex-revenue-center` ) Codes for the revenue or cost centers supplying the service and/or products.
Type | CodeableConcept
Is Modifier | false
Summary | false
Requirements | Needed in the processing of institutional claims.
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
286. ExplanationOfBenefit.item.detail.category
Definition | Code to identify the general type of benefits under which products and services are provided.
Short | Benefit classification
Comments | Examples include: Medical Care, Periodontics, Renal Dialysis, Vision Coverage.
Control | 0..1
Binding | For example codes, see BenefitCategoryCodes (example to `http://hl7.org/fhir/ValueSet/ex-benefitcategory` ) Benefit categories such as: oral, medical, vision, oral-basic etc.
Type | CodeableConcept
Is Modifier | false
Summary | false
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.
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
288. 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.
Short | Billing, service, product, or drug 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'.
Control | 1..1
Binding | For example codes, see USCLSCodes (example to `http://hl7.org/fhir/ValueSet/service-uscls` ) Allowable service and product codes.
Type | CodeableConcept
Is Modifier | false
Summary | false
Requirements | Necessary to state what was provided or done.
Alternate Names | Drug Code, Bill Code, Service Code
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
290. ExplanationOfBenefit.item.detail.modifier
Definition | Item typification or modifiers codes to convey additional context for the product or service.
Short | Service/Product billing modifiers
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.
Control | 0..*
Binding | For example codes, see ModifierTypeCodes (example to `http://hl7.org/fhir/ValueSet/claim-modifiers` ) Item type or modifiers codes, eg for Oral whether the treatment is cosmetic or associated with TMJ, or an appliance was lost or stolen.
Type | CodeableConcept
Is Modifier | false
Summary | false
Requirements | To support inclusion of the item for adjudication or to charge an elevated fee.
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
292. ExplanationOfBenefit.item.detail.programCode
Definition | Identifies the program under which this may be recovered.
Short | Program the product or service is provided under
Comments | For example: Neonatal program, child dental program or drug users recovery program.
Control | 0..*
Binding | For example codes, see ExampleProgramReasonCodes (example to `http://hl7.org/fhir/ValueSet/ex-program-code` ) Program specific reason codes.
Type | CodeableConcept
Is Modifier | false
Summary | false
Requirements | Commonly used in in the identification of publicly provided program focused on population segments or disease classifications.
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
294. ExplanationOfBenefit.item.detail.quantity
Definition | The number of repetitions of a service or product.
Short | Count of products or services
Control | 0..1
Type | Quantity(SimpleQuantity)
Is Modifier | false
Summary | false
Requirements | Required when the product or service code does not convey the quantity provided.
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
296. 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.
Short | Fee, charge or cost per item
Control | 0..1
Type | Money
Is Modifier | false
Summary | false
Requirements | The amount charged to the patient by the provider for a single unit.
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
298. 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.
Short | Price scaling factor
Comments | To show a 10% senior's discount, the value entered is: 0.90 (1.00 - 0.10).
Control | 0..1
Type | decimal
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | false
Requirements | When discounts are provided to a patient (example: Senior's discount) then this must be documented for adjudication.
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
300. ExplanationOfBenefit.item.detail.net
Definition | The quantity times the unit price for an additional service or product or charge.
Short | Total item cost
Comments | For example, the formula: quantity * unitPrice * factor = net. Quantity and factor are assumed to be 1 if not supplied.
Control | 0..1
Type | Money
Is Modifier | false
Summary | false
Requirements | Provides the total amount claimed for the group (if a grouper) or the line item.
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
302. ExplanationOfBenefit.item.detail.udi
Definition | Unique Device Identifiers associated with this line item.
Short | Unique device identifier
Control | 0..*
Type | Reference(Device)
Is Modifier | false
Summary | false
Requirements | The UDI code allows the insurer to obtain device level information on the product supplied.
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
304. ExplanationOfBenefit.item.detail.noteNumber
Definition | The numbers associated with notes below which apply to the adjudication of this item.
Short | Applicable note numbers
Control | 0..*
Type | positiveInt
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | false
Requirements | Provides a condensed manner for associating human readable descriptive explanations for adjudications on the line item.
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
306. ExplanationOfBenefit.item.detail.adjudication
Definition | The adjudication results.
Short | Detail level adjudication details
Control | 0..*
Type | Seettp://hl7.org/fhir/StructureDefinition/ExplanationOfBenefit#ExplanationOfBenefit.item.adjudication
Is Modifier | false
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
308. ExplanationOfBenefit.item.detail.subDetail
Definition | Third-tier of goods and services.
Short | Additional items
Control | 0..*
Type | BackboneElement
Is Modifier | false
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
310. 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.
Short | Unique id for inter-element referencing
Control | 0..1
Type | string
Is Modifier | false
XML Format | In the XML format, this property is represented as an attribute.
Summary | false
312. 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.
Short | Additional content defined by implementations
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
Control | 0..*
Type | Extension
Is Modifier | false
Summary | false
Alternate Names | extensions, user content
Invariants | 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()`)
314. 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).
Short | Extensions that cannot be ignored even if unrecognized
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
Control | 0..*
Type | Extension
Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
Summary | true
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 Names | extensions, user content, modifiers
Invariants | 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()`)
316. 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.
Short | Product or service provided
Control | 1..1
Type | positiveInt
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | false
Requirements | The items to be processed for adjudication.
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
318. ExplanationOfBenefit.item.detail.subDetail.revenue
Definition | The type of revenue or cost center providing the product and/or service.
Short | Revenue or cost center code
Control | 0..1
Binding | For example codes, see ExampleRevenueCenterCodes (example to `http://hl7.org/fhir/ValueSet/ex-revenue-center` ) Codes for the revenue or cost centers supplying the service and/or products.
Type | CodeableConcept
Is Modifier | false
Summary | false
Requirements | Needed in the processing of institutional claims.
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
320. ExplanationOfBenefit.item.detail.subDetail.category
Definition | Code to identify the general type of benefits under which products and services are provided.
Short | Benefit classification
Comments | Examples include Medical Care, Periodontics, Renal Dialysis, Vision Coverage.
Control | 0..1
Binding | For example codes, see BenefitCategoryCodes (example to `http://hl7.org/fhir/ValueSet/ex-benefitcategory` ) Benefit categories such as: oral, medical, vision, oral-basic etc.
Type | CodeableConcept
Is Modifier | false
Summary | false
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.
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
322. 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.
Short | Billing, service, product, or drug 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'.
Control | 1..1
Binding | For example codes, see USCLSCodes (example to `http://hl7.org/fhir/ValueSet/service-uscls` ) Allowable service and product codes.
Type | CodeableConcept
Is Modifier | false
Summary | false
Requirements | Necessary to state what was provided or done.
Alternate Names | Drug Code, Bill Code, Service Code
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
324. ExplanationOfBenefit.item.detail.subDetail.modifier
Definition | Item typification or modifiers codes to convey additional context for the product or service.
Short | Service/Product billing modifiers
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.
Control | 0..*
Binding | For example codes, see ModifierTypeCodes (example to `http://hl7.org/fhir/ValueSet/claim-modifiers` ) Item type or modifiers codes, eg for Oral whether the treatment is cosmetic or associated with TMJ, or an appliance was lost or stolen.
Type | CodeableConcept
Is Modifier | false
Summary | false
Requirements | To support inclusion of the item for adjudication or to charge an elevated fee.
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
326. ExplanationOfBenefit.item.detail.subDetail.programCode
Definition | Identifies the program under which this may be recovered.
Short | Program the product or service is provided under
Comments | For example: Neonatal program, child dental program or drug users recovery program.
Control | 0..*
Binding | For example codes, see ExampleProgramReasonCodes (example to `http://hl7.org/fhir/ValueSet/ex-program-code` ) Program specific reason codes.
Type | CodeableConcept
Is Modifier | false
Summary | false
Requirements | Commonly used in in the identification of publicly provided program focused on population segments or disease classifications.
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
328. ExplanationOfBenefit.item.detail.subDetail.quantity
Definition | The number of repetitions of a service or product.
Short | Count of products or services
Control | 0..1
Type | Quantity(SimpleQuantity)
Is Modifier | false
Summary | false
Requirements | Required when the product or service code does not convey the quantity provided.
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
330. 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.
Short | Fee, charge or cost per item
Control | 0..1
Type | Money
Is Modifier | false
Summary | false
Requirements | The amount charged to the patient by the provider for a single unit.
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
332. 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.
Short | Price scaling factor
Comments | To show a 10% senior's discount, the value entered is: 0.90 (1.00 - 0.10).
Control | 0..1
Type | decimal
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | false
Requirements | When discounts are provided to a patient (example: Senior's discount) then this must be documented for adjudication.
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
334. ExplanationOfBenefit.item.detail.subDetail.net
Definition | The quantity times the unit price for an additional service or product or charge.
Short | Total item cost
Comments | For example, the formula: quantity * unitPrice * factor = net. Quantity and factor are assumed to be 1 if not supplied.
Control | 0..1
Type | Money
Is Modifier | false
Summary | false
Requirements | Provides the total amount claimed for the group (if a grouper) or the line item.
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
336. ExplanationOfBenefit.item.detail.subDetail.udi
Definition | Unique Device Identifiers associated with this line item.
Short | Unique device identifier
Control | 0..*
Type | Reference(Device)
Is Modifier | false
Summary | false
Requirements | The UDI code allows the insurer to obtain device level information on the product supplied.
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
338. ExplanationOfBenefit.item.detail.subDetail.noteNumber
Definition | The numbers associated with notes below which apply to the adjudication of this item.
Short | Applicable note numbers
Control | 0..*
Type | positiveInt
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | false
Requirements | Provides a condensed manner for associating human readable descriptive explanations for adjudications on the line item.
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
340. ExplanationOfBenefit.item.detail.subDetail.adjudication
Definition | The adjudication results.
Short | Subdetail level adjudication details
Control | 0..*
Type | Seettp://hl7.org/fhir/StructureDefinition/ExplanationOfBenefit#ExplanationOfBenefit.item.adjudication
Is Modifier | false
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
342. ExplanationOfBenefit.addItem
Definition | The first-tier service adjudications for payor added product or service lines.
Short | Insurer added line items
Control | 0..*
Type | BackboneElement
Is Modifier | false
Summary | false
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.
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
344. 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.
Short | Unique id for inter-element referencing
Control | 0..1
Type | string
Is Modifier | false
XML Format | In the XML format, this property is represented as an attribute.
Summary | false
346. 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.
Short | Additional content defined by implementations
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
Control | 0..*
Type | Extension
Is Modifier | false
Summary | false
Alternate Names | extensions, user content
Invariants | 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()`)
348. 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).
Short | Extensions that cannot be ignored even if unrecognized
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
Control | 0..*
Type | Extension
Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
Summary | true
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 Names | extensions, user content, modifiers
Invariants | 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.addItem.itemSequence
Definition | Claim items which this service line is intended to replace.
Short | Item sequence number
Control | 0..*
Type | positiveInt
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | false
Requirements | Provides references to the claim items.
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
352. ExplanationOfBenefit.addItem.detailSequence
Definition | The sequence number of the details within the claim item which this line is intended to replace.
Short | Detail sequence number
Control | 0..*
Type | positiveInt
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | false
Requirements | Provides references to the claim details within the claim item.
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
354. 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.
Short | Subdetail sequence number
Control | 0..*
Type | positiveInt
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | false
Requirements | Provides references to the claim sub-details within the claim detail.
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
356. ExplanationOfBenefit.addItem.provider
Definition | The providers who are authorized for the services rendered to the patient.
Short | Authorized providers
Control | 0..*
Type | Reference(Practitioner, PractitionerRole, Organization)
Is Modifier | false
Summary | false
Requirements | Insurer may provide authorization specifically to a restricted set of providers rather than an open authorization.
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
358. 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.
Short | Billing, service, product, or drug 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'.
Control | 1..1
Binding | For example codes, see USCLSCodes (example to `http://hl7.org/fhir/ValueSet/service-uscls` ) Allowable service and product codes.
Type | CodeableConcept
Is Modifier | false
Summary | false
Requirements | Necessary to state what was provided or done.
Alternate Names | Drug Code, Bill Code, Service Code
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
360. ExplanationOfBenefit.addItem.modifier
Definition | Item typification or modifiers codes to convey additional context for the product or service.
Short | Service/Product billing modifiers
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.
Control | 0..*
Binding | For example codes, see ModifierTypeCodes (example to `http://hl7.org/fhir/ValueSet/claim-modifiers` ) Item type or modifiers codes, eg for Oral whether the treatment is cosmetic or associated with TMJ, or an appliance was lost or stolen.
Type | CodeableConcept
Is Modifier | false
Summary | false
Requirements | To support inclusion of the item for adjudication or to charge an elevated fee.
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
362. ExplanationOfBenefit.addItem.programCode
Definition | Identifies the program under which this may be recovered.
Short | Program the product or service is provided under
Comments | For example: Neonatal program, child dental program or drug users recovery program.
Control | 0..*
Binding | For example codes, see ExampleProgramReasonCodes (example to `http://hl7.org/fhir/ValueSet/ex-program-code` ) Program specific reason codes.
Type | CodeableConcept
Is Modifier | false
Summary | false
Requirements | Commonly used in in the identification of publicly provided program focused on population segments or disease classifications.
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
364. ExplanationOfBenefit.addItem.serviced[x]
Definition | The date or dates when the service or product was supplied, performed or completed.
Short | Date or dates of service or product delivery
Control | 0..1
Type | Choice of: date, Period
[x] Note | SeeChoice of Data Typesfor further information about how to use [x]
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | false
Requirements | Needed to determine whether the service or product was provided during the term of the insurance coverage.
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
366. ExplanationOfBenefit.addItem.location[x]
Definition | Where the product or service was provided.
Short | Place of service or where product was supplied
Control | 0..1
Binding | For example codes, see ExampleServicePlaceCodes (example to `http://hl7.org/fhir/ValueSet/service-place` ) Place where the service is rendered.
Type | Choice of: CodeableConcept, Address, Reference(Location)
[x] Note | SeeChoice of Data Typesfor further information about how to use [x]
Is Modifier | false
Summary | false
Requirements | The location can alter whether the item was acceptable for insurance purposes or impact the determination of the benefit amount.
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
368. ExplanationOfBenefit.addItem.quantity
Definition | The number of repetitions of a service or product.
Short | Count of products or services
Control | 0..1
Type | Quantity(SimpleQuantity)
Is Modifier | false
Summary | false
Requirements | Required when the product or service code does not convey the quantity provided.
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
370. 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.
Short | Fee, charge or cost per item
Control | 0..1
Type | Money
Is Modifier | false
Summary | false
Requirements | The amount charged to the patient by the provider for a single unit.
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
372. 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.
Short | Price scaling factor
Comments | To show a 10% senior's discount, the value entered is: 0.90 (1.00 - 0.10).
Control | 0..1
Type | decimal
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | false
Requirements | When discounts are provided to a patient (example: Senior's discount) then this must be documented for adjudication.
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
374. ExplanationOfBenefit.addItem.net
Definition | The quantity times the unit price for an additional service or product or charge.
Short | Total item cost
Comments | For example, the formula: quantity * unitPrice * factor = net. Quantity and factor are assumed to be 1 if not supplied.
Control | 0..1
Type | Money
Is Modifier | false
Summary | false
Requirements | Provides the total amount claimed for the group (if a grouper) or the line item.
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
376. ExplanationOfBenefit.addItem.bodySite
Definition | Physical service site on the patient (limb, tooth, etc.).
Short | Anatomical location
Comments | For example, providing a tooth code allows an insurer to identify a provider performing a filling on a tooth that was previously removed.
Control | 0..1
Binding | For example codes, see OralSiteCodes (example to `http://hl7.org/fhir/ValueSet/tooth` ) The code for the teeth, quadrant, sextant and arch.
Type | CodeableConcept
Is Modifier | false
Summary | false
Requirements | Allows insurer to validate specific procedures.
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
378. ExplanationOfBenefit.addItem.subSite
Definition | A region or surface of the bodySite, e.g. limb region or tooth surface(s).
Short | Anatomical sub-location
Control | 0..*
Binding | For example codes, see SurfaceCodes (example to `http://hl7.org/fhir/ValueSet/surface` ) The code for the tooth surface and surface combinations.
Type | CodeableConcept
Is Modifier | false
Summary | false
Requirements | Allows insurer to validate specific procedures.
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
380. ExplanationOfBenefit.addItem.noteNumber
Definition | The numbers associated with notes below which apply to the adjudication of this item.
Short | Applicable note numbers
Control | 0..*
Type | positiveInt
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | false
Requirements | Provides a condensed manner for associating human readable descriptive explanations for adjudications on the line item.
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
382. ExplanationOfBenefit.addItem.adjudication
Definition | The adjudication results.
Short | Added items adjudication
Control | 0..*
Type | Seettp://hl7.org/fhir/StructureDefinition/ExplanationOfBenefit#ExplanationOfBenefit.item.adjudication
Is Modifier | false
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
384. ExplanationOfBenefit.addItem.detail
Definition | The second-tier service adjudications for payor added services.
Short | Insurer added line items
Control | 0..*
Type | BackboneElement
Is Modifier | false
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
386. 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.
Short | Unique id for inter-element referencing
Control | 0..1
Type | string
Is Modifier | false
XML Format | In the XML format, this property is represented as an attribute.
Summary | false
388. 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.
Short | Additional content defined by implementations
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
Control | 0..*
Type | Extension
Is Modifier | false
Summary | false
Alternate Names | extensions, user content
Invariants | 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()`)
390. 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).
Short | Extensions that cannot be ignored even if unrecognized
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
Control | 0..*
Type | Extension
Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
Summary | true
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 Names | extensions, user content, modifiers
Invariants | 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()`)
392. 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.
Short | Billing, service, product, or drug 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'.
Control | 1..1
Binding | For example codes, see USCLSCodes (example to `http://hl7.org/fhir/ValueSet/service-uscls` ) Allowable service and product codes.
Type | CodeableConcept
Is Modifier | false
Summary | false
Requirements | Necessary to state what was provided or done.
Alternate Names | Drug Code, Bill Code, Service Code
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
394. ExplanationOfBenefit.addItem.detail.modifier
Definition | Item typification or modifiers codes to convey additional context for the product or service.
Short | Service/Product billing modifiers
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.
Control | 0..*
Binding | For example codes, see ModifierTypeCodes (example to `http://hl7.org/fhir/ValueSet/claim-modifiers` ) Item type or modifiers codes, eg for Oral whether the treatment is cosmetic or associated with TMJ, or an appliance was lost or stolen.
Type | CodeableConcept
Is Modifier | false
Summary | false
Requirements | To support inclusion of the item for adjudication or to charge an elevated fee.
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
396. ExplanationOfBenefit.addItem.detail.quantity
Definition | The number of repetitions of a service or product.
Short | Count of products or services
Control | 0..1
Type | Quantity(SimpleQuantity)
Is Modifier | false
Summary | false
Requirements | Required when the product or service code does not convey the quantity provided.
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
398. 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.
Short | Fee, charge or cost per item
Control | 0..1
Type | Money
Is Modifier | false
Summary | false
Requirements | The amount charged to the patient by the provider for a single unit.
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
400. 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.
Short | Price scaling factor
Comments | To show a 10% senior's discount, the value entered is: 0.90 (1.00 - 0.10).
Control | 0..1
Type | decimal
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | false
Requirements | When discounts are provided to a patient (example: Senior's discount) then this must be documented for adjudication.
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
402. ExplanationOfBenefit.addItem.detail.net
Definition | The quantity times the unit price for an additional service or product or charge.
Short | Total item cost
Comments | For example, the formula: quantity * unitPrice * factor = net. Quantity and factor are assumed to be 1 if not supplied.
Control | 0..1
Type | Money
Is Modifier | false
Summary | false
Requirements | Provides the total amount claimed for the group (if a grouper) or the line item.
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
404. ExplanationOfBenefit.addItem.detail.noteNumber
Definition | The numbers associated with notes below which apply to the adjudication of this item.
Short | Applicable note numbers
Control | 0..*
Type | positiveInt
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | false
Requirements | Provides a condensed manner for associating human readable descriptive explanations for adjudications on the line item.
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
406. ExplanationOfBenefit.addItem.detail.adjudication
Definition | The adjudication results.
Short | Added items adjudication
Control | 0..*
Type | Seettp://hl7.org/fhir/StructureDefinition/ExplanationOfBenefit#ExplanationOfBenefit.item.adjudication
Is Modifier | false
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
408. ExplanationOfBenefit.addItem.detail.subDetail
Definition | The third-tier service adjudications for payor added services.
Short | Insurer added line items
Control | 0..*
Type | BackboneElement
Is Modifier | false
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
410. 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.
Short | Unique id for inter-element referencing
Control | 0..1
Type | string
Is Modifier | false
XML Format | In the XML format, this property is represented as an attribute.
Summary | false
412. 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.
Short | Additional content defined by implementations
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
Control | 0..*
Type | Extension
Is Modifier | false
Summary | false
Alternate Names | extensions, user content
Invariants | 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()`)
414. 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).
Short | Extensions that cannot be ignored even if unrecognized
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
Control | 0..*
Type | Extension
Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
Summary | true
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 Names | extensions, user content, modifiers
Invariants | 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.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.
Short | Billing, service, product, or drug 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'.
Control | 1..1
Binding | For example codes, see USCLSCodes (example to `http://hl7.org/fhir/ValueSet/service-uscls` ) Allowable service and product codes.
Type | CodeableConcept
Is Modifier | false
Summary | false
Requirements | Necessary to state what was provided or done.
Alternate Names | Drug Code, Bill Code, Service Code
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
418. ExplanationOfBenefit.addItem.detail.subDetail.modifier
Definition | Item typification or modifiers codes to convey additional context for the product or service.
Short | Service/Product billing modifiers
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.
Control | 0..*
Binding | For example codes, see ModifierTypeCodes (example to `http://hl7.org/fhir/ValueSet/claim-modifiers` ) Item type or modifiers codes, eg for Oral whether the treatment is cosmetic or associated with TMJ, or an appliance was lost or stolen.
Type | CodeableConcept
Is Modifier | false
Summary | false
Requirements | To support inclusion of the item for adjudication or to charge an elevated fee.
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
420. ExplanationOfBenefit.addItem.detail.subDetail.quantity
Definition | The number of repetitions of a service or product.
Short | Count of products or services
Control | 0..1
Type | Quantity(SimpleQuantity)
Is Modifier | false
Summary | false
Requirements | Required when the product or service code does not convey the quantity provided.
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
422. 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.
Short | Fee, charge or cost per item
Control | 0..1
Type | Money
Is Modifier | false
Summary | false
Requirements | The amount charged to the patient by the provider for a single unit.
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
424. 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.
Short | Price scaling factor
Comments | To show a 10% senior's discount, the value entered is: 0.90 (1.00 - 0.10).
Control | 0..1
Type | decimal
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | false
Requirements | When discounts are provided to a patient (example: Senior's discount) then this must be documented for adjudication.
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
426. ExplanationOfBenefit.addItem.detail.subDetail.net
Definition | The quantity times the unit price for an additional service or product or charge.
Short | Total item cost
Comments | For example, the formula: quantity * unitPrice * factor = net. Quantity and factor are assumed to be 1 if not supplied.
Control | 0..1
Type | Money
Is Modifier | false
Summary | false
Requirements | Provides the total amount claimed for the group (if a grouper) or the line item.
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
428. ExplanationOfBenefit.addItem.detail.subDetail.noteNumber
Definition | The numbers associated with notes below which apply to the adjudication of this item.
Short | Applicable note numbers
Control | 0..*
Type | positiveInt
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | false
Requirements | Provides a condensed manner for associating human readable descriptive explanations for adjudications on the line item.
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
430. ExplanationOfBenefit.addItem.detail.subDetail.adjudication
Definition | The adjudication results.
Short | Added items adjudication
Control | 0..*
Type | Seettp://hl7.org/fhir/StructureDefinition/ExplanationOfBenefit#ExplanationOfBenefit.item.adjudication
Is Modifier | false
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
432. ExplanationOfBenefit.adjudication
Definition | The adjudication results which are presented at the header level rather than at the line-item or add-item levels.
Short | Header-level adjudication
Control | 0..*
Type | Seettp://hl7.org/fhir/StructureDefinition/ExplanationOfBenefit#ExplanationOfBenefit.item.adjudication
Is Modifier | false
Summary | false
Requirements | Some insurers will receive line-items but provide the adjudication only at a summary or header-level.
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
434. ExplanationOfBenefit.total
Definition | Categorized monetary totals for the adjudication.
Short | Adjudication totals
Comments | Totals for amounts submitted, co-pays, benefits payable etc.
Control | 0..*
Type | BackboneElement
Is Modifier | false
Summary | true
Requirements | To provide the requestor with financial totals by category for the adjudication.
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
436. 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.
Short | Unique id for inter-element referencing
Control | 0..1
Type | string
Is Modifier | false
XML Format | In the XML format, this property is represented as an attribute.
Summary | false
438. 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.
Short | Additional content defined by implementations
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
Control | 0..*
Type | Extension
Is Modifier | false
Summary | false
Alternate Names | extensions, user content
Invariants | 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()`)
440. 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).
Short | Extensions that cannot be ignored even if unrecognized
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
Control | 0..*
Type | Extension
Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
Summary | true
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 Names | extensions, user content, modifiers
Invariants | 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()`)
442. 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.
Short | Type of adjudication information
Comments | For example, codes indicating: Co-Pay, deductible, eligible, benefit, tax, etc.
Control | 1..1
Binding | For example codes, see AdjudicationValueCodes (example to `http://hl7.org/fhir/ValueSet/adjudication` ) The adjudication codes.
Type | CodeableConcept
Is Modifier | false
Summary | true
Requirements | Needed to convey the type of total provided.
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
444. ExplanationOfBenefit.total.amount
Definition | Monetary total amount associated with the category.
Short | Financial total for the category
Control | 1..1
Type | Money
Is Modifier | false
Summary | true
Requirements | Needed to convey the total monetary amount.
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
446. ExplanationOfBenefit.payment
Definition | Payment details for the adjudication of the claim.
Short | Payment Details
Control | 0..1
Type | BackboneElement
Is Modifier | false
Summary | false
Requirements | Needed to convey references to the financial instrument that has been used if payment has been made.
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
448. 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.
Short | Unique id for inter-element referencing
Control | 0..1
Type | string
Is Modifier | false
XML Format | In the XML format, this property is represented as an attribute.
Summary | false
450. 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.
Short | Additional content defined by implementations
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
Control | 0..*
Type | Extension
Is Modifier | false
Summary | false
Alternate Names | extensions, user content
Invariants | 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()`)
452. 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).
Short | Extensions that cannot be ignored even if unrecognized
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
Control | 0..*
Type | Extension
Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
Summary | true
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 Names | extensions, user content, modifiers
Invariants | 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()`)
454. ExplanationOfBenefit.payment.type
Definition | Whether this represents partial or complete payment of the benefits payable.
Short | Partial or complete payment
Control | 0..1
Binding | For example codes, see ExamplePaymentTypeCodes (example to `http://hl7.org/fhir/ValueSet/ex-paymenttype` ) The type (partial, complete) of the payment.
Type | CodeableConcept
Is Modifier | false
Summary | false
Requirements | To advise the requestor when the insurer believes all payments to have been completed.
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
456. 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.
Short | Payment adjustment for non-claim issues
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.
Control | 0..1
Type | Money
Is Modifier | false
Summary | false
Requirements | To advise the requestor of adjustments applied to the payment.
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
458. ExplanationOfBenefit.payment.adjustmentReason
Definition | Reason for the payment adjustment.
Short | Explanation for the variance
Control | 0..1
Binding | For example codes, see PaymentAdjustmentReasonCodes (example to `http://hl7.org/fhir/ValueSet/payment-adjustment-reason` ) Payment Adjustment reason codes.
Type | CodeableConcept
Is Modifier | false
Summary | false
Requirements | Needed to clarify the monetary adjustment.
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
460. ExplanationOfBenefit.payment.date
Definition | Estimated date the payment will be issued or the actual issue date of payment.
Short | Expected date of payment
Control | 0..1
Type | date
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | false
Requirements | To advise the payee when payment can be expected.
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
462. ExplanationOfBenefit.payment.amount
Definition | Benefits payable less any payment adjustment.
Short | Payable amount after adjustment
Control | 0..1
Type | Money
Is Modifier | false
Summary | false
Requirements | Needed to provide the actual payment amount.
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
464. ExplanationOfBenefit.payment.identifier
Definition | Issuer's unique identifier for the payment instrument.
Short | Business identifier for the payment
Comments | For example: EFT number or check number.
Note | This is a business identifier, not a resource identifier (see discussion)
Control | 0..1
Type | Identifier
Is Modifier | false
Summary | false
Requirements | Enable the receiver to reconcile when payment received.
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
466. ExplanationOfBenefit.formCode
Definition | A code for the form to be used for printing the content.
Short | Printed form identifier
Comments | May be needed to identify specific jurisdictional forms.
Control | 0..1
Binding | For example codes, see Form Codes (example to `http://hl7.org/fhir/ValueSet/forms` ) The forms codes.
Type | CodeableConcept
Is Modifier | false
Summary | false
Requirements | Needed to specify the specific form used for producing output for this response.
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
468. ExplanationOfBenefit.form
Definition | The actual form, by reference or inclusion, for printing the content or an EOB.
Short | Printed reference or actual form
Comments | Needed to permit insurers to include the actual form.
Control | 0..1
Type | Attachment
Is Modifier | false
Summary | false
Requirements | Needed to include the specific form used for producing output for this response.
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
470. ExplanationOfBenefit.processNote
Definition | A note that describes or explains adjudication results in a human readable form.
Short | Note concerning adjudication
Control | 0..*
Type | BackboneElement
Is Modifier | false
Summary | false
Requirements | Provides the insurer specific textual explanations associated with the processing.
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
472. 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.
Short | Unique id for inter-element referencing
Control | 0..1
Type | string
Is Modifier | false
XML Format | In the XML format, this property is represented as an attribute.
Summary | false
474. 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.
Short | Additional content defined by implementations
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
Control | 0..*
Type | Extension
Is Modifier | false
Summary | false
Alternate Names | extensions, user content
Invariants | 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()`)
476. 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).
Short | Extensions that cannot be ignored even if unrecognized
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
Control | 0..*
Type | Extension
Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
Summary | true
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 Names | extensions, user content, modifiers
Invariants | 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()`)
478. ExplanationOfBenefit.processNote.number
Definition | A number to uniquely identify a note entry.
Short | Note instance identifier
Control | 0..1
Type | positiveInt
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | false
Requirements | Necessary to provide a mechanism to link from adjudications.
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
480. ExplanationOfBenefit.processNote.type
Definition | The business purpose of the note text.
Short | display | print | printoper
Control | 0..1
Binding | The codes SHALL be taken from NoteType (required to `http://hl7.org/fhir/ValueSet/note-type|4.0.1` ) The presentation types of notes.
Type | code
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | false
Requirements | To convey the expectation for when the text is used.
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
482. ExplanationOfBenefit.processNote.text
Definition | The explanation or description associated with the processing.
Short | Note explanatory text
Control | 0..1
Type | string
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | false
Requirements | Required to provide human readable explanation.
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
484. ExplanationOfBenefit.processNote.language
Definition | A code to define the language used in the text of the note.
Short | Language of the text
Comments | Only required if the language is different from the resource language.
Control | 0..1
Binding | The codes SHOULD be taken from CommonLanguages (preferred to `http://hl7.org/fhir/ValueSet/languages` ) A human language.
Additional Bindings | Purpose
AllLanguages | Max Binding
Type | CodeableConcept
Is Modifier | false
Summary | false
Requirements | Note text may vary from the resource defined language.
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
486. ExplanationOfBenefit.benefitPeriod
Definition | The term of the benefits documented in this response.
Short | When the benefits are applicable
Comments | Not applicable when use=claim.
Control | 0..1
Type | Period
Is Modifier | false
Summary | false
Requirements | Needed as coverages may be multi-year while benefits tend to be annual therefore a separate expression of the benefit period is needed.
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
488. ExplanationOfBenefit.benefitBalance
Definition | Balance by Benefit Category.
Short | Balance by Benefit Category
Control | 0..*
Type | BackboneElement
Is Modifier | false
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
490. 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.
Short | Unique id for inter-element referencing
Control | 0..1
Type | string
Is Modifier | false
XML Format | In the XML format, this property is represented as an attribute.
Summary | false
492. 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.
Short | Additional content defined by implementations
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
Control | 0..*
Type | Extension
Is Modifier | false
Summary | false
Alternate Names | extensions, user content
Invariants | 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()`)
494. 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).
Short | Extensions that cannot be ignored even if unrecognized
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
Control | 0..*
Type | Extension
Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
Summary | true
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 Names | extensions, user content, modifiers
Invariants | 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()`)
496. ExplanationOfBenefit.benefitBalance.category
Definition | Code to identify the general type of benefits under which products and services are provided.
Short | Benefit classification
Comments | Examples include Medical Care, Periodontics, Renal Dialysis, Vision Coverage.
Control | 1..1
Binding | For example codes, see BenefitCategoryCodes (example to `http://hl7.org/fhir/ValueSet/ex-benefitcategory` ) Benefit categories such as: oral, medical, vision, oral-basic etc.
Type | CodeableConcept
Is Modifier | false
Summary | false
Requirements | Needed to convey the category of service or product for which eligibility is sought.
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
498. 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.
Short | Excluded from the plan
Control | 0..1
Type | boolean
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | false
Requirements | Needed to identify items that are specifically excluded from the coverage.
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
500. ExplanationOfBenefit.benefitBalance.name
Definition | A short name or tag for the benefit.
Short | Short name for the benefit
Comments | For example: MED01, or DENT2.
Control | 0..1
Type | string
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | false
Requirements | Required to align with other plan names.
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
502. ExplanationOfBenefit.benefitBalance.description
Definition | A richer description of the benefit or services covered.
Short | Description of the benefit or services covered
Comments | For example, 'DENT2 covers 100% of basic, 50% of major but excludes Ortho, Implants and Cosmetic services'.
Control | 0..1
Type | string
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | false
Requirements | Needed for human readable reference.
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
504. ExplanationOfBenefit.benefitBalance.network
Definition | Is a flag to indicate whether the benefits refer to in-network providers or out-of-network providers.
Short | In or out of network
Control | 0..1
Binding | For example codes, see NetworkTypeCodes (example to `http://hl7.org/fhir/ValueSet/benefit-network` ) Code to classify in or out of network services.
Type | CodeableConcept
Is Modifier | false
Summary | false
Requirements | Needed as in or out of network providers are treated differently under the coverage.
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
506. ExplanationOfBenefit.benefitBalance.unit
Definition | Indicates if the benefits apply to an individual or to the family.
Short | Individual or family
Control | 0..1
Binding | For example codes, see UnitTypeCodes (example to `http://hl7.org/fhir/ValueSet/benefit-unit` ) Unit covered/serviced - individual or family.
Type | CodeableConcept
Is Modifier | false
Summary | false
Requirements | Needed for the understanding of the benefits.
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
508. ExplanationOfBenefit.benefitBalance.term
Definition | The term or period of the values such as 'maximum lifetime benefit' or 'maximum annual visits'.
Short | Annual or lifetime
Control | 0..1
Binding | For example codes, see BenefitTermCodes (example to `http://hl7.org/fhir/ValueSet/benefit-term` ) Coverage unit - annual, lifetime.
Type | CodeableConcept
Is Modifier | false
Summary | false
Requirements | Needed for the understanding of the benefits.
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
510. ExplanationOfBenefit.benefitBalance.financial
Definition | Benefits Used to date.
Short | Benefit Summary
Control | 0..*
Type | BackboneElement
Is Modifier | false
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
512. 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.
Short | Unique id for inter-element referencing
Control | 0..1
Type | string
Is Modifier | false
XML Format | In the XML format, this property is represented as an attribute.
Summary | false
514. 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.
Short | Additional content defined by implementations
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
Control | 0..*
Type | Extension
Is Modifier | false
Summary | false
Alternate Names | extensions, user content
Invariants | 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()`)
516. 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).
Short | Extensions that cannot be ignored even if unrecognized
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
Control | 0..*
Type | Extension
Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
Summary | true
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 Names | extensions, user content, modifiers
Invariants | 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()`)
518. ExplanationOfBenefit.benefitBalance.financial.type
Definition | Classification of benefit being provided.
Short | Benefit classification
Comments | For example: deductible, visits, benefit amount.
Control | 1..1
Binding | For example codes, see BenefitTypeCodes (example to `http://hl7.org/fhir/ValueSet/benefit-type` ) Deductable, visits, co-pay, etc.
Type | CodeableConcept
Is Modifier | false
Summary | false
Requirements | Needed to convey the nature of the benefit.
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
520. ExplanationOfBenefit.benefitBalance.financial.allowed[x]
Definition | The quantity of the benefit which is permitted under the coverage.
Short | Benefits allowed
Control | 0..1
Type | Choice of: unsignedInt, string, Money
[x] Note | SeeChoice of Data Typesfor further information about how to use [x]
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | false
Requirements | Needed to convey the benefits offered under the coverage.
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
522. ExplanationOfBenefit.benefitBalance.financial.used[x]
Definition | The quantity of the benefit which have been consumed to date.
Short | Benefits used
Control | 0..1
Type | Choice of: unsignedInt, Money
[x] Note | SeeChoice of Data Typesfor further information about how to use [x]
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | false
Requirements | Needed to convey the benefits consumed to date.
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)