This page is part of the CARIN Blue Button Implementation Guide (v2.0.0: STU 2) based on FHIR R4. This is the current published version in its permanent home (it will always be available at this URL). For a full list of available versions, see the Directory of published versions
Active as of 2022-11-28 |
Definitions for the C4BB-ExplanationOfBenefit-Pharmacy resource profile.
1. ExplanationOfBenefit | |
Invariants | Defined on this element EOB-pharmacy-meta-profile-version: Pharmacy EOB: meta.profile with canonical and major.minor. version required. (: meta.profile.exists($this.startsWith('http://hl7.org/fhir/us/carin-bb/StructureDefinition/C4BB-ExplanationOfBenefit-Pharmacy|2.0.'))) |
2. ExplanationOfBenefit.identifier | |
Note | This is a business identifier, not a resource identifier (see discussion) |
Must Support | true |
3. ExplanationOfBenefit.type | |
Pattern Value | <valueCodeableConcept xmlns="http://hl7.org/fhir"> <coding> <system value="http://terminology.hl7.org/CodeSystem/claim-type"/> <code value="pharmacy"/> </coding> </valueCodeableConcept> |
4. ExplanationOfBenefit.created | |
Must Support | true |
5. ExplanationOfBenefit.careTeam | |
Invariants | Defined on this element EOB-pharm-careTeam-organization: Pharmacy EOB: Careteam roles refer to an organization (: ( role.where(coding.where(code in ('rendering' )).exists()).exists() implies role.where(coding.where(code in ('rendering' )).exists()).exists().provider.all(resolve() is Organization) )) EOB-pharm-careTeam-practitioner: Pharmacy EOB: Careteam roles refer to a practitioner (: ( role.where(coding.where(code in ('primary' | 'prescribing' )).exists()).exists() implies role.where(coding.where(code in ('primary' | 'prescribing' )).exists()).exists().provider.all(resolve() is Organization) )) |
6. ExplanationOfBenefit.careTeam.role | |
Control | 10..1 |
Binding | The codes SHALL be taken from C4BB Claim Pharmacy CareTeam Role Value SetFor example codes, see ClaimCareTeamRoleCodes |
7. ExplanationOfBenefit.supportingInfo | |
Control | 40..* |
Slicing | This element introduces a set of slices on ExplanationOfBenefit.supportingInfo. The slices are unordered and Open, and can be differentiated using the following discriminators:
|
8. ExplanationOfBenefit.supportingInfo:dayssupply | |
SliceName | dayssupply |
Control | 1..1 |
Must Support | true |
Comments | Number of days supply of medication dispensed by the pharmacy (77) |
9. ExplanationOfBenefit.supportingInfo:dayssupply.category | |
Control | 0..? |
Must Support | true |
Pattern Value | <valueCodeableConcept xmlns="http://hl7.org/fhir"> <coding> <system value="http://hl7.org/fhir/us/carin-bb/CodeSystem/C4BBSupportingInfoType"/> <code value="dayssupply"/> </coding> </valueCodeableConcept> |
10. ExplanationOfBenefit.supportingInfo:dayssupply.value[x] | |
Control | 1..? |
Type | Quantity |
[x] Note | See Choice of Data Types for further information about how to use [x] |
Must Support | true |
11. ExplanationOfBenefit.supportingInfo:dawcode | |
SliceName | dawcode |
Control | 1..1 |
Must Support | true |
Comments | Prescriber's instruction regarding substitution of generic equivalents or order to dispense the specific prescribed medication (79) |
12. ExplanationOfBenefit.supportingInfo:dawcode.category | |
Control | 0..? |
Must Support | true |
Pattern Value | <valueCodeableConcept xmlns="http://hl7.org/fhir"> <coding> <system value="http://hl7.org/fhir/us/carin-bb/CodeSystem/C4BBSupportingInfoType"/> <code value="dawcode"/> </coding> </valueCodeableConcept> |
13. ExplanationOfBenefit.supportingInfo:dawcode.code | |
Control | 1..? |
Binding | The codes SHALL be taken from NCPDP Dispense As Written (DAW)/Product Selection Code Value Set |
Must Support | true |
14. ExplanationOfBenefit.supportingInfo:refillNum | |
SliceName | refillNum |
Control | 1..1 |
Must Support | true |
Comments | The number fill of the current dispensed supply (0, 1, 2, etc.) (137) |
15. ExplanationOfBenefit.supportingInfo:refillNum.category | |
Control | 0..? |
Must Support | true |
Pattern Value | <valueCodeableConcept xmlns="http://hl7.org/fhir"> <coding> <system value="http://hl7.org/fhir/us/carin-bb/CodeSystem/C4BBSupportingInfoType"/> <code value="refillnum"/> </coding> </valueCodeableConcept> |
16. ExplanationOfBenefit.supportingInfo:refillNum.value[x] | |
Control | 1..? |
Type | Quantity |
[x] Note | See Choice of Data Types for further information about how to use [x] |
Must Support | true |
17. ExplanationOfBenefit.supportingInfo:refillsAuthorized | |
SliceName | refillsAuthorized |
Control | 1..1 |
18. ExplanationOfBenefit.supportingInfo:refillsAuthorized.category | |
Control | 0..? |
Must Support | true |
Pattern Value | <valueCodeableConcept xmlns="http://hl7.org/fhir"> <coding> <system value="http://hl7.org/fhir/us/carin-bb/CodeSystem/C4BBSupportingInfoType"/> <code value="refillsauthorized"/> </coding> </valueCodeableConcept> |
19. ExplanationOfBenefit.supportingInfo:refillsAuthorized.value[x] | |
Control | 1..? |
Type | Quantity |
[x] Note | See Choice of Data Types for further information about how to use [x] |
Must Support | true |
20. ExplanationOfBenefit.supportingInfo:brandgenericindicator | |
SliceName | brandgenericindicator |
Control | 0..1 |
Must Support | true |
Comments | Whether the plan adjudicated the claim as a brand or generic drug (144) |
21. ExplanationOfBenefit.supportingInfo:brandgenericindicator.category | |
Control | 0..? |
Must Support | true |
Pattern Value | <valueCodeableConcept xmlns="http://hl7.org/fhir"> <coding> <system value="http://hl7.org/fhir/us/carin-bb/CodeSystem/C4BBSupportingInfoType"/> <code value="brandgenericindicator"/> </coding> </valueCodeableConcept> |
22. ExplanationOfBenefit.supportingInfo:brandgenericindicator.code | |
Control | 1..? |
Binding | The codes SHALL be taken from NCPDP Brand Generic Indicator Value Set |
Must Support | true |
23. ExplanationOfBenefit.supportingInfo:rxoriginCode | |
SliceName | rxoriginCode |
Control | 0..1 |
Must Support | true |
Comments | Whether the prescription was transmitted as an electronic prescription, by phone, by fax, or as a written paper copy (143) |
24. ExplanationOfBenefit.supportingInfo:rxoriginCode.category | |
Control | 0..? |
Must Support | true |
Pattern Value | <valueCodeableConcept xmlns="http://hl7.org/fhir"> <coding> <system value="http://hl7.org/fhir/us/carin-bb/CodeSystem/C4BBSupportingInfoType"/> <code value="rxorigincode"/> </coding> </valueCodeableConcept> |
25. ExplanationOfBenefit.supportingInfo:rxoriginCode.code | |
Control | 1..? |
Binding | The codes SHALL be taken from NCPDP Prescription Origin Code Value Set |
Must Support | true |
26. ExplanationOfBenefit.supportingInfo:clmrecvddate | |
SliceName | clmrecvddate |
Control | 0..1 |
Must Support | true |
Comments | The date the claim was received by the payer (88) |
27. ExplanationOfBenefit.supportingInfo:clmrecvddate.category | |
Control | 0..? |
Must Support | true |
Pattern Value | <valueCodeableConcept xmlns="http://hl7.org/fhir"> <coding> <system value="http://hl7.org/fhir/us/carin-bb/CodeSystem/C4BBSupportingInfoType"/> <code value="clmrecvddate"/> </coding> </valueCodeableConcept> |
28. ExplanationOfBenefit.supportingInfo:clmrecvddate.timing[x] | |
Control | 1..? |
Type | date |
[x] Note | See Choice of Data Types for further information about how to use [x] |
Must Support | true |
29. ExplanationOfBenefit.supportingInfo:compoundcode | |
SliceName | compoundcode |
Control | 0..1 |
Must Support | true |
Comments | The code indicating whether or not the prescription is a compound. NCPDP field # 406-D6 (78) |
30. ExplanationOfBenefit.supportingInfo:compoundcode.category | |
Control | 0..? |
Must Support | true |
Pattern Value | <valueCodeableConcept xmlns="http://hl7.org/fhir"> <coding> <system value="http://hl7.org/fhir/us/carin-bb/CodeSystem/C4BBSupportingInfoType"/> <code value="compoundcode"/> </coding> </valueCodeableConcept> |
31. ExplanationOfBenefit.supportingInfo:compoundcode.code | |
Control | 1..? |
Binding | The codes SHALL be taken from NCPDP Compound Code Value Set |
Must Support | true |
32. ExplanationOfBenefit.item | |
Control | 0..? |
33. ExplanationOfBenefit.item.productOrService | |
Binding | The codes SHALL be taken from NDC or Compound Value SetFor example codes, see USCLSCodes |
Must Support | true |
Comments | Values are NDC Codes (38) when Compound Code (78) = 0 or 1. When the Compound Code = 2, productOrService = 'compound' and map the ingredient to ExplanationOfBenefit.item.detail.productOrService 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'. |
34. ExplanationOfBenefit.item.serviced[x] | |
Control | 10..1 |
Type | Choice of: , Period |
[x] Note | See Choice of Data Types for further information about how to use [x] |
Comments | Identifies date the prescription was filled or professional service rendered (90) |
Slicing | This element introduces a set of slices on ExplanationOfBenefit.item.serviced[x]. The slices are unordered and Open, and can be differentiated using the following discriminators:
|
35. ExplanationOfBenefit.item.servicedDate | |
Control | 1..1 |
Must Support | true |
36. ExplanationOfBenefit.item.quantity | |
Must Support | true |
Comments | Quantity dispensed for the drug (39) / The unit of measurement for the drug. (gram, ml, etc.) (151). Populate for all Compound Code values. When the Compound Code = 2, if available, map the ingredient to ExplanationOfBenefit.item.detail.quantity |
37. ExplanationOfBenefit.item.adjudication | |
Control | 10..* |
Must Support | true |
Slicing | This element introduces a set of slices on ExplanationOfBenefit.item.adjudication. The slices are unordered and Open, and can be differentiated using the following discriminators:
|
38. ExplanationOfBenefit.item.adjudication.category | |
Binding | The codes SHALL be taken from C4BB Adjudication Category Discriminator Value Set; other codes may be used where these codes are not suitableFor example codes, see AdjudicationValueCodes |
39. ExplanationOfBenefit.item.adjudication:adjudicationamounttype | |
SliceName | adjudicationamounttype |
Control | 1..* |
Must Support | true |
Comments | Describes the various amount fields used when payers receive and adjudicate a claim. (187) |
40. ExplanationOfBenefit.item.adjudication:adjudicationamounttype.category | |
Control | 0..? |
Binding | The codes SHALL be taken from C4BB Adjudication Value Set |
41. ExplanationOfBenefit.item.adjudication:adjudicationamounttype.amount | |
Control | 1..? |
Must Support | true |
42. ExplanationOfBenefit.item.adjudication:rejectreason | |
SliceName | rejectreason |
Control | 0..1 |
Must Support | true |
Comments | Reason codes used to interpret the Non-Covered Amount (92) |
43. ExplanationOfBenefit.item.adjudication:rejectreason.category | |
Control | 0..? |
Pattern Value | <valueCodeableConcept xmlns="http://hl7.org/fhir"> <coding> <system value="http://hl7.org/fhir/us/carin-bb/CodeSystem/C4BBAdjudicationDiscriminator"/> <code value="rejectreason"/> </coding> </valueCodeableConcept> |
44. ExplanationOfBenefit.item.adjudication:rejectreason.reason | |
Control | 1..? |
Binding | The codes SHALL be taken from NCPDP Reject Code Value Set |
Must Support | true |
45. ExplanationOfBenefit.item.detail | |
Must Support | true |
46. ExplanationOfBenefit.item.detail.productOrService | |
Binding | The codes SHALL be taken from National Drug Code (NDC) Value SetFor example codes, see USCLSCodes |
Must Support | true |
Comments | Values are NDC Codes (38) when Compound Code (78) = 2 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'. |
47. ExplanationOfBenefit.item.detail.quantity | |
Must Support | true |
48. ExplanationOfBenefit.adjudication | |
Control | 10..* |
Type | BackboneElement |
Must Support | true |
Slicing | This element introduces a set of slices on ExplanationOfBenefit.adjudication. The slices are unordered and Open, and can be differentiated using the following discriminators:
|
49. ExplanationOfBenefit.adjudication.category | |
Control | 0..? |
Binding | The codes SHALL be taken from C4BB Adjudication Category Discriminator Value Set; other codes may be used where these codes are not suitable |
Must Support | true |
50. ExplanationOfBenefit.adjudication:billingnetworkstatus | |
SliceName | billingnetworkstatus |
Control | 0..1 |
Must Support | true |
Comments | Indicates that the Billing Provider has a contract with the Plan (regardless of the network) that is effective on the date of service. (101) |
51. ExplanationOfBenefit.adjudication:billingnetworkstatus.category | |
Control | 0..? |
Pattern Value | <valueCodeableConcept xmlns="http://hl7.org/fhir"> <coding> <system value="http://hl7.org/fhir/us/carin-bb/CodeSystem/C4BBAdjudicationDiscriminator"/> <code value="billingnetworkstatus"/> </coding> </valueCodeableConcept> |
52. ExplanationOfBenefit.adjudication:billingnetworkstatus.reason | |
Control | 1..? |
Binding | The codes SHALL be taken from C4BB Payer Provider Network Status Value Set |
Must Support | true |
53. ExplanationOfBenefit.adjudication:benefitpaymentstatus | |
SliceName | benefitpaymentstatus |
Control | 1..1 |
Must Support | true |
Comments | Indicates the in network or out of network payment status of the claim. (142) |
54. ExplanationOfBenefit.adjudication:benefitpaymentstatus.category | |
Control | 0..? |
Pattern Value | <valueCodeableConcept xmlns="http://hl7.org/fhir"> <coding> <system value="http://hl7.org/fhir/us/carin-bb/CodeSystem/C4BBAdjudicationDiscriminator"/> <code value="benefitpaymentstatus"/> </coding> </valueCodeableConcept> |
55. ExplanationOfBenefit.adjudication:benefitpaymentstatus.reason | |
Control | 1..? |
Binding | The codes SHALL be taken from C4BB Payer Benefit Payment Status Value Set |
Must Support | true |
56. ExplanationOfBenefit.total | |
Slicing | This element introduces a set of slices on ExplanationOfBenefit.total. The slices are unordered and Open, and can be differentiated using the following discriminators:
|
57. ExplanationOfBenefit.total.category | |
Binding | The codes SHALL be taken from C4BB Total Category Discriminator Value Set; other codes may be used where these codes are not suitableFor example codes, see AdjudicationValueCodes |
Must Support | true |
58. ExplanationOfBenefit.total.amount | |
Must Support | true |
Comments | Total amount for each category (i.e., submitted, allowed, etc.) (148) |
59. ExplanationOfBenefit.total:adjudicationamounttype | |
SliceName | adjudicationamounttype |
Control | 1..* |
Must Support | true |
Comments | Describes the various amount fields used when payers receive and adjudicate a claim. (187) |
60. ExplanationOfBenefit.total:adjudicationamounttype.category | |
Control | 0..? |
Binding | The codes SHALL be taken from C4BB Adjudication Value Set |
61. ExplanationOfBenefit.total:adjudicationamounttype.amount | |
Control | 0..? |
Must Support | true |
62. ExplanationOfBenefit.payment | |
Control | 0..? |
63. ExplanationOfBenefit.payment.date | |
Must Support | true |
64. ExplanationOfBenefit.processNote | |
Control | 0..? |
65. ExplanationOfBenefit.processNote.text | |
Must Support | true |
1. ExplanationOfBenefit | |
Definition | This resource provides: the claim details; adjudication details from the processing of a Claim; and optionally account balance information, for informing the subscriber of the benefits provided. |
Control | 0..* |
Alternate Names | EOB |
Invariants | Defined on this element EOB-pharmacy-meta-profile-version: Pharmacy EOB: meta.profile with canonical and major.minor. version required. (: meta.profile.exists($this.startsWith('http://hl7.org/fhir/us/carin-bb/StructureDefinition/C4BB-ExplanationOfBenefit-Pharmacy|2.0.'))) 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.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. |
Control | 10..1 |
Type | Meta |
Must Support | true |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
3. ExplanationOfBenefit.meta.lastUpdated | |
Definition | When the resource last changed - e.g. when the version changed. |
Control | 10..1 |
Type | instant |
Must Support | true |
Comments | Defines the date the Resource was created or updated, whichever comes last (163). Payers SHALL provide the last time the data was updated or the date of creation in the payerās system of record, whichever comes last This value is always populated except when the resource is first being created. The server / resource manager sets this value; what a client provides is irrelevant. This is equivalent to the HTTP Last-Modified and SHOULD have the same value on a read interaction. |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
4. ExplanationOfBenefit.meta.profile | |
Definition | A list of profiles (references to StructureDefinition resources) that this resource claims to conform to. The URL is a reference to StructureDefinition.url. |
Control | 10..* |
Type | canonical(StructureDefinition)) |
Comments | meta.profile is required as a matter of convenience of receiving systems. The meta.profile should be used by the Server to hint/assert/declare that this instance conforms to one (or more) stated profiles (with business versions). meta.profile does not capture any business logic, processing directives, or semantics (for example, inpatient or outpatient). Clients should not assume that the Server will exhaustively indicate all profiles with all versions that this instance conforms to. Clients can (and should) perform their own validation of conformance to the indicated profile(s) and to any other profiles of interest. CPCDS data element (190) It is up to the server and/or other infrastructure of policy to determine whether/how these claims are verified and/or updated over time. The list of profile URLs is a set. |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
5. 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. |
Control | 0..1 |
Type | uri |
Is Modifier | true |
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. |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
6. 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). |
Control | 0..* |
Type | Extension |
Is Modifier | 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 |
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. |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists()) |
7. ExplanationOfBenefit.identifier | |
Definition | A unique identifier assigned to this explanation of benefit. |
Note | This is a business identifier, not a resource identifier (see discussion) |
Control | 10..* |
Type | Identifier |
Must Support | true |
Requirements | Allows EOBs to be distinguished and referenced. |
Comments | Identifier assigned by a payer for a claim received from a provider or subscriber. It is not the same identifier as that assigned by a provider. (35) |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
Slicing | This element introduces a set of slices on ExplanationOfBenefit.identifier. The slices are unordered and Open, and can be differentiated using the following discriminators:
|
8. ExplanationOfBenefit.identifier:uniqueclaimid | |
SliceName | uniqueclaimid |
Definition | A unique identifier assigned to this explanation of benefit. |
Note | This is a business identifier, not a resource identifier (see discussion) |
Control | 10..1* |
Type | Identifier |
Must Support | true |
Requirements | Allows EOBs to be distinguished and referenced. |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
9. ExplanationOfBenefit.identifier:uniqueclaimid.use | |
Definition | The purpose of this identifier. |
Control | 0..1 |
Binding | The codes SHALL be taken from IdentifierUse Identifies the purpose for this identifier, if known . |
Type | code |
Is Modifier | true |
Requirements | Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers. |
Comments | Applications can assume that an identifier is permanent unless it explicitly says that it is temporary. |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
10. ExplanationOfBenefit.identifier:uniqueclaimid.type | |
Definition | A coded type for the identifier that can be used to determine which identifier to use for a specific purpose. |
Control | 10..1 |
Binding | The codes SHALL be taken from Identifier Type Codes; other codes may be used where these codes are not suitable A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. |
Type | CodeableConcept |
Requirements | Allows users to make use of identifiers when the identifier system is not known. |
Comments | This element deals only with general categories of identifiers. It SHOULD not be used for codes that correspond 1..1 with the Identifier.system. Some identifiers may fall into multiple categories due to common usage. Where the system is known, a type is unnecessary because the type is always part of the system definition. However systems often need to handle identifiers where the system is not known. There is not a 1:1 relationship between type and system, since many different systems have the same type. |
Pattern Value | <valueCodeableConcept xmlns="http://hl7.org/fhir"> <coding> <system value="http://hl7.org/fhir/us/carin-bb/CodeSystem/C4BBIdentifierType"/> <code value="uc"/> </coding> </valueCodeableConcept> |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
11. ExplanationOfBenefit.identifier:uniqueclaimid.value | |
Definition | The portion of the identifier typically relevant to the user and which is unique within the context of the system. |
Control | 10..1 |
Type | string |
Must Support | true |
Comments | If the value is a full URI, then the system SHALL be urn:ietf:rfc:3986. The value's primary purpose is computational mapping. As a result, it may be normalized for comparison purposes (e.g. removing non-significant whitespace, dashes, etc.) A value formatted for human display can be conveyed using the Rendered Value extension. Identifier.value is to be treated as case sensitive unless knowledge of the Identifier.system allows the processer to be confident that non-case-sensitive processing is safe. |
Example | General:123456 |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
12. ExplanationOfBenefit.status | |
Definition | The status of the resource instance. |
Control | 1..1 |
Binding | The codes SHALL be taken from ExplanationOfBenefitStatus A code specifying the state of the resource instance. |
Type | code |
Is Modifier | true |
Must Support | 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'. |
Comments | Claim processing status code (140). Expected values are active or cancelled. To comply with the CMS rule, draft EOBs are not required This element is labeled as a modifier because the status contains codes that mark the resource as not currently valid. |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
13. ExplanationOfBenefit.type | |
Definition | The category of claim, e.g. oral, pharmacy, vision, institutional, professional. |
Control | 1..1 |
Binding | The codes SHALL be taken from ClaimTypeCodesThe codes SHALL be taken from ClaimTypeCodes; other codes may be used where these codes are not suitable |
Type | CodeableConcept |
Must Support | true |
Requirements | Claim type determine the general sets of business rules applied for information requirements and adjudication. |
Comments | Specifies the type of claim. (e.g., inpatient institutional, outpatient institutional, physician, etc.) (16). Defines the Claims profiles. Values from Claim Type Codes are required; a data absent reason is not allowed 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. |
Pattern Value | <valueCodeableConcept xmlns="http://hl7.org/fhir"> <coding> <system value="http://terminology.hl7.org/CodeSystem/claim-type"/> <code value="pharmacy"/> </coding> </valueCodeableConcept> |
Invariants | Defined on this element 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. |
Control | 1..1 |
Binding | The codes SHALL be taken from Use Complete, proposed, exploratory, other. |
Type | code |
Must Support | true |
Requirements | This element is required to understand the nature of the request for adjudication. |
Comments | Expected value is claim. The CMS rule applies to adjudicated claims; it does not require preauthorizations or predeterminations |
Pattern Value | claim |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
15. 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. |
Control | 1..1 |
Type | Reference(C4BBPatient|Patient)) |
Must Support | 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. |
Comments | Identifier for a member assigned by the Payer. If members receive ID cards, that is the identifier that should be provided. (1). The patient must be supplied to the insurer so that confirmation of coverage and service history may be considered as part of the authorization and/or adjudication. Additional required path:EOB.insurance.coverage(Coverage).beneficiary(Patient).identifier |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
16. ExplanationOfBenefit.billablePeriod | |
Definition | The period for which charges are being submitted. |
Control | 10..1 |
Type | Period |
Must Support | true |
Requirements | A number jurisdictions required the submission of the billing period when submitting claims for example for hospital stays or long-term care. |
Comments | Typically this would be today or in the past for a claim, and today or in the future for preauthorizations and prodeterminations. Typically line item dates of service should fall within the billing period if one is specified. |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
17. ExplanationOfBenefit.billablePeriod.start | |
Definition | The start of the period. The boundary is inclusive. |
Control | 10..1 This element is affected by the following invariants: per-1 |
Type | dateTime |
Must Support | true |
Comments | The first day on the billing statement covering services rendered to the beneficiary (i.e. 'Statement Covers From Dateā). (177) If the low element is missing, the meaning is that the low boundary is not known. |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
18. ExplanationOfBenefit.created | |
Definition | The date this resource was created. |
Control | 1..1 |
Type | dateTime |
Must Support | true |
Requirements | Need to record a timestamp for use by both the recipient and the issuer. |
Comments | Date the claim was adjudicated (179) 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. |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
19. ExplanationOfBenefit.insurer | |
Definition | The party responsible for authorization, adjudication and reimbursement. |
Control | 1..1 |
Type | Reference(C4BBOrganization|Organization)) |
Must Support | 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. |
Comments | Code of the payer responsible for the claim (2, 5). Same as insurance.coverage.organization. Party responsible for reimbursing the provider |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
20. ExplanationOfBenefit.provider | |
Definition | The provider which is responsible for the claim, predetermination or preauthorization. |
Control | 1..1 |
Type | Reference(C4BBOrganization|C4BBPractitioner|Practitioner|PractitionerRole|Organization)) |
Must Support | true |
Must Support Types | No must-support rules about the choice of types/profiles |
Comments | The identifier assigned to the Billing Provider. (94) 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. |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
21. 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. |
Control | 0..* |
Type | BackboneElement |
Must Support | true |
Requirements | For workplace or other accidents it is common to relate separate claims arising from the same event. |
Comments | If the current claim represents a claim that has been adjusted and was given a prior claim number, this field represents the prior claim number. If the current claim has been adjusted; i.e., replaced by or merged to another claim number, this data element represents that new number.(111, 112) For example, for the original treatment and follow-up exams. |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
22. 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). |
Control | 0..* |
Type | Extension |
Is Modifier | 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 |
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. |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists()) |
23. ExplanationOfBenefit.related.relationship | |
Definition | A code to convey how the claims are related. |
Control | 10..1 |
Binding | The codes SHALL be taken from C4BB Related Claim Relationship Codes Value SetFor example codes, see ExampleRelatedClaimRelationshipCodes |
Type | CodeableConcept |
Must Support | true |
Requirements | Some insurers need a declaration of the type of relationship. |
Comments | For example, prior claim or umbrella. |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
24. ExplanationOfBenefit.related.reference | |
Definition | An alternate organizational reference to the case or file to which this particular claim pertains. |
Control | 10..1 |
Type | Identifier |
Must Support | true |
Requirements | In cases where an event-triggered claim is being submitted to an insurer which requires a reference number to be specified on all exchanges. |
Comments | For example, Property/Casualty insurer claim number or Workers Compensation case number. |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
25. ExplanationOfBenefit.payee | |
Definition | The party to be reimbursed for cost of the products and services according to the terms of the policy. |
Control | 0..1 |
Type | BackboneElement |
Must Support | true |
Requirements | The provider needs to specify who they wish to be reimbursed and the claims processor needs express who they will reimburse. |
Comments | Often providers agree to receive the benefits payable to reduce the near-term costs to the patient. The insurer may decline to pay the provider and may choose to pay the subscriber instead. |
Invariants | Defined on this element EOB-payee-other-type-requires-party: Base EOB: if payee type is other, payee party is required (: type.coding.where(code = 'other' and system = 'http://terminology.hl7.org/CodeSystem/payeetype').exists() implies party.exists()) ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
26. 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). |
Control | 0..* |
Type | Extension |
Is Modifier | 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 |
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. |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists()) |
27. ExplanationOfBenefit.payee.type | |
Definition | Type of Party to be reimbursed: Subscriber, provider, other. |
Control | 10..1 |
Binding | The codes SHALL be taken from C4BB Payee Type Value SetFor example codes, see Claim Payee Type Codes |
Type | CodeableConcept |
Must Support | true |
Requirements | Need to know who should receive payment with the most common situations being the Provider (assignment of benefits) or the Subscriber. |
Comments | Identifies the type of recipient of the adjudication amount; i.e., provider, subscriber, beneficiary or another recipient. (120) |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
28. ExplanationOfBenefit.payee.party | |
Definition | Reference to the individual or organization to whom any payment will be made. |
Control | 0..1 |
Type | Reference(C4BBOrganization|C4BBPatient|C4BBPractitioner|C4BBRelatedPerson|Practitioner|PractitionerRole|Organization|Patient|RelatedPerson)) |
Must Support | true |
Must Support Types | No must-support rules about the choice of types/profiles |
Requirements | Need to provide demographics if the payee is not 'subscriber' nor 'provider'. |
Comments | Recipient reference (121) Not required if the payee is 'subscriber' or 'provider'. |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
29. ExplanationOfBenefit.outcome | |
Definition | The outcome of the claim, predetermination, or preauthorization processing. |
Control | 1..1 |
Binding | The codes SHALL be taken from ClaimProcessingCodes The result of the claim processing. |
Type | code |
Must Support | true |
Requirements | To advise the requestor of an overall processing outcome. |
Comments | Expected value is complete 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). |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
30. ExplanationOfBenefit.careTeam | |
Definition | The members of the team who provided the products and services. |
Control | 0..* |
Type | BackboneElement |
Must Support | true |
Requirements | Common to identify the responsible and supporting practitioners. |
Invariants | Defined on this element EOB-pharm-careTeam-organization: Pharmacy EOB: Careteam roles refer to an organization (: ( role.where(coding.where(code in ('rendering' )).exists()).exists() implies role.where(coding.where(code in ('rendering' )).exists()).exists().provider.all(resolve() is Organization) )) EOB-pharm-careTeam-practitioner: Pharmacy EOB: Careteam roles refer to a practitioner (: ( role.where(coding.where(code in ('primary' | 'prescribing' )).exists()).exists() implies role.where(coding.where(code in ('primary' | 'prescribing' )).exists()).exists().provider.all(resolve() is Organization) )) ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
31. 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). |
Control | 0..* |
Type | Extension |
Is Modifier | 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 |
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. |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists()) |
32. ExplanationOfBenefit.careTeam.sequence | |
Definition | A number to uniquely identify care team entries. |
Control | 1..1 |
Type | positiveInt |
Requirements | Necessary to maintain the order of the care team and provide a mechanism to link individuals to claim details. |
Comments | careTeam.sequence values uniquely identify careTeam members. They do not necessarily indicate any order in which the patient was seen by the careTeam or identify any level of significance of the careTeam to the patient, etc. Client app implementations should not assign any significance to the sequence values |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
33. ExplanationOfBenefit.careTeam.provider | |
Definition | Member of the team who provided the product or service. |
Control | 1..1 |
Type | Reference(C4BBOrganization|C4BBPractitioner|Practitioner|PractitionerRole|Organization)) |
Must Support | true |
Must Support Types | No must-support rules about the choice of types/profiles |
Requirements | Often a regulatory requirement to specify the responsible provider. |
Comments | The identifier assigned to the care team. (varies depending on the profile) |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
34. ExplanationOfBenefit.careTeam.role | |
Definition | The lead, assisting or supervising practitioner and their discipline if a multidisciplinary team. |
Control | 10..1 |
Binding | The codes SHALL be taken from C4BB Claim Pharmacy CareTeam Role Value SetFor example codes, see ClaimCareTeamRoleCodes |
Type | CodeableConcept |
Must Support | true |
Requirements | When multiple parties are present it is required to distinguish the roles performed by each member. |
Comments | The functional role of a provider on a claim. (165) Role might not be required when there is only a single provider listed. |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
35. ExplanationOfBenefit.supportingInfo | |
Definition | Additional information codes regarding exceptions, special considerations, the condition, situation, prior or concurrent issues. |
Control | 40..* |
Type | BackboneElement |
Must Support | true |
Requirements | Typically these information codes are required to support the services rendered or the adjudication of the services rendered. |
Comments | Defines data elements not available in the base EOB resource Often there are multiple jurisdiction specific valuesets which are required. |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
Slicing | This element introduces a set of slices on ExplanationOfBenefit.supportingInfo. The slices are unordered and Open, and can be differentiated using the following discriminators:
|
36. 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). |
Control | 0..* |
Type | Extension |
Is Modifier | 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 |
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. |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists()) |
37. ExplanationOfBenefit.supportingInfo.sequence | |
Definition | A number to uniquely identify supporting information entries. |
Control | 1..1 |
Type | positiveInt |
Requirements | Necessary to maintain the order of the supporting information items and provide a mechanism to link to claim details. |
Comments | Client app implementations should look-up supportingInfo elements based on category values instead of sequence values |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
38. ExplanationOfBenefit.supportingInfo.category | |
Definition | The general class of the information supplied: information; exception; accident, employment; onset, etc. |
Control | 1..1 |
Binding | The codes SHALL be taken from C4BB SupportingInfo Type Value Set; other codes may be used where these codes are not suitableFor example codes, see ClaimInformationCategoryCodes |
Type | CodeableConcept |
Requirements | Required to group or associate information items with common characteristics. For example: admission information or prior treatments. |
Comments | This may contain a category for the local bill type codes. |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
39. ExplanationOfBenefit.supportingInfo:dayssupply | |
SliceName | dayssupply |
Definition | Additional information codes regarding exceptions, special considerations, the condition, situation, prior or concurrent issues. |
Control | 10..1* |
Type | BackboneElement |
Must Support | true |
Requirements | Typically these information codes are required to support the services rendered or the adjudication of the services rendered. |
Comments | Number of days supply of medication dispensed by the pharmacy (77) Often there are multiple jurisdiction specific valuesets which are required. |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
40. ExplanationOfBenefit.supportingInfo:dayssupply.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). |
Control | 0..* |
Type | Extension |
Is Modifier | 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 |
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. |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists()) |
41. ExplanationOfBenefit.supportingInfo:dayssupply.sequence | |
Definition | A number to uniquely identify supporting information entries. |
Control | 1..1 |
Type | positiveInt |
Requirements | Necessary to maintain the order of the supporting information items and provide a mechanism to link to claim details. |
Comments | Client app implementations should look-up supportingInfo elements based on category values instead of sequence values |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
42. ExplanationOfBenefit.supportingInfo:dayssupply.category | |
Definition | The general class of the information supplied: information; exception; accident, employment; onset, etc. |
Control | 1..1 |
Binding | The codes SHALL be taken from C4BB SupportingInfo Type Value Set; other codes may be used where these codes are not suitableFor example codes, see ClaimInformationCategoryCodes |
Type | CodeableConcept |
Must Support | true |
Requirements | Required to group or associate information items with common characteristics. For example: admission information or prior treatments. |
Comments | This may contain a category for the local bill type codes. |
Pattern Value | <valueCodeableConcept xmlns="http://hl7.org/fhir"> <coding> <system value="http://hl7.org/fhir/us/carin-bb/CodeSystem/C4BBSupportingInfoType"/> <code value="dayssupply"/> </coding> </valueCodeableConcept> |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
43. ExplanationOfBenefit.supportingInfo:dayssupply.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. |
Control | 10..1 |
Type | Choice of: Quantity, boolean, string, Reference(Resource)), Attachment |
[x] Note | See Choice of Data Types for further information about how to use [x] |
Must Support | true |
Requirements | To convey the data content to be provided when the information is more than a simple code or period. |
Comments | Could be used to provide references to other resources, document. For example, could contain a PDF in an Attachment of the Police Report for an Accident. |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
44. ExplanationOfBenefit.supportingInfo:dawcode | |
SliceName | dawcode |
Definition | Additional information codes regarding exceptions, special considerations, the condition, situation, prior or concurrent issues. |
Control | 10..1* |
Type | BackboneElement |
Must Support | true |
Requirements | Typically these information codes are required to support the services rendered or the adjudication of the services rendered. |
Comments | Prescriber's instruction regarding substitution of generic equivalents or order to dispense the specific prescribed medication (79) Often there are multiple jurisdiction specific valuesets which are required. |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
45. ExplanationOfBenefit.supportingInfo:dawcode.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). |
Control | 0..* |
Type | Extension |
Is Modifier | 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 |
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. |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists()) |
46. ExplanationOfBenefit.supportingInfo:dawcode.sequence | |
Definition | A number to uniquely identify supporting information entries. |
Control | 1..1 |
Type | positiveInt |
Requirements | Necessary to maintain the order of the supporting information items and provide a mechanism to link to claim details. |
Comments | Client app implementations should look-up supportingInfo elements based on category values instead of sequence values |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
47. ExplanationOfBenefit.supportingInfo:dawcode.category | |
Definition | The general class of the information supplied: information; exception; accident, employment; onset, etc. |
Control | 1..1 |
Binding | The codes SHALL be taken from C4BB SupportingInfo Type Value Set; other codes may be used where these codes are not suitableFor example codes, see ClaimInformationCategoryCodes |
Type | CodeableConcept |
Must Support | true |
Requirements | Required to group or associate information items with common characteristics. For example: admission information or prior treatments. |
Comments | This may contain a category for the local bill type codes. |
Pattern Value | <valueCodeableConcept xmlns="http://hl7.org/fhir"> <coding> <system value="http://hl7.org/fhir/us/carin-bb/CodeSystem/C4BBSupportingInfoType"/> <code value="dawcode"/> </coding> </valueCodeableConcept> |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
48. ExplanationOfBenefit.supportingInfo:dawcode.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. |
Control | 10..1 |
Binding | The codes SHALL be taken from NCPDP Dispense As Written (DAW)/Product Selection Code Value SetFor example codes, see ExceptionCodes |
Type | CodeableConcept |
Must Support | true |
Requirements | Required to identify the kind of additional information. |
Comments | This may contain the local bill type codes such as the US UB-04 bill type code. |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
49. ExplanationOfBenefit.supportingInfo:refillNum | |
SliceName | refillNum |
Definition | Additional information codes regarding exceptions, special considerations, the condition, situation, prior or concurrent issues. |
Control | 10..1* |
Type | BackboneElement |
Must Support | true |
Requirements | Typically these information codes are required to support the services rendered or the adjudication of the services rendered. |
Comments | The number fill of the current dispensed supply (0, 1, 2, etc.) (137) Often there are multiple jurisdiction specific valuesets which are required. |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
50. ExplanationOfBenefit.supportingInfo:refillNum.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). |
Control | 0..* |
Type | Extension |
Is Modifier | 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 |
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. |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists()) |
51. ExplanationOfBenefit.supportingInfo:refillNum.sequence | |
Definition | A number to uniquely identify supporting information entries. |
Control | 1..1 |
Type | positiveInt |
Requirements | Necessary to maintain the order of the supporting information items and provide a mechanism to link to claim details. |
Comments | Client app implementations should look-up supportingInfo elements based on category values instead of sequence values |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
52. ExplanationOfBenefit.supportingInfo:refillNum.category | |
Definition | The general class of the information supplied: information; exception; accident, employment; onset, etc. |
Control | 1..1 |
Binding | The codes SHALL be taken from C4BB SupportingInfo Type Value Set; other codes may be used where these codes are not suitableFor example codes, see ClaimInformationCategoryCodes |
Type | CodeableConcept |
Must Support | true |
Requirements | Required to group or associate information items with common characteristics. For example: admission information or prior treatments. |
Comments | This may contain a category for the local bill type codes. |
Pattern Value | <valueCodeableConcept xmlns="http://hl7.org/fhir"> <coding> <system value="http://hl7.org/fhir/us/carin-bb/CodeSystem/C4BBSupportingInfoType"/> <code value="refillnum"/> </coding> </valueCodeableConcept> |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
53. ExplanationOfBenefit.supportingInfo:refillNum.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. |
Control | 10..1 |
Type | Choice of: Quantity, boolean, string, Reference(Resource)), Attachment |
[x] Note | See Choice of Data Types for further information about how to use [x] |
Must Support | true |
Requirements | To convey the data content to be provided when the information is more than a simple code or period. |
Comments | Could be used to provide references to other resources, document. For example, could contain a PDF in an Attachment of the Police Report for an Accident. |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
54. ExplanationOfBenefit.supportingInfo:refillsAuthorized | |
SliceName | refillsAuthorized |
Definition | Additional information codes regarding exceptions, special considerations, the condition, situation, prior or concurrent issues. |
Control | 10..1* |
Type | BackboneElement |
Must Support | true |
Requirements | Typically these information codes are required to support the services rendered or the adjudication of the services rendered. |
Comments | Defines data elements not available in the base EOB resource Often there are multiple jurisdiction specific valuesets which are required. |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
55. ExplanationOfBenefit.supportingInfo:refillsAuthorized.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). |
Control | 0..* |
Type | Extension |
Is Modifier | 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 |
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. |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists()) |
56. ExplanationOfBenefit.supportingInfo:refillsAuthorized.sequence | |
Definition | A number to uniquely identify supporting information entries. |
Control | 1..1 |
Type | positiveInt |
Requirements | Necessary to maintain the order of the supporting information items and provide a mechanism to link to claim details. |
Comments | Client app implementations should look-up supportingInfo elements based on category values instead of sequence values |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
57. ExplanationOfBenefit.supportingInfo:refillsAuthorized.category | |
Definition | The general class of the information supplied: information; exception; accident, employment; onset, etc. |
Control | 1..1 |
Binding | The codes SHALL be taken from C4BB SupportingInfo Type Value Set; other codes may be used where these codes are not suitableFor example codes, see ClaimInformationCategoryCodes |
Type | CodeableConcept |
Must Support | true |
Requirements | Required to group or associate information items with common characteristics. For example: admission information or prior treatments. |
Comments | This may contain a category for the local bill type codes. |
Pattern Value | <valueCodeableConcept xmlns="http://hl7.org/fhir"> <coding> <system value="http://hl7.org/fhir/us/carin-bb/CodeSystem/C4BBSupportingInfoType"/> <code value="refillsauthorized"/> </coding> </valueCodeableConcept> |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
58. ExplanationOfBenefit.supportingInfo:refillsAuthorized.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. |
Control | 10..1 |
Type | Choice of: Quantity, boolean, string, Reference(Resource)), Attachment |
[x] Note | See Choice of Data Types for further information about how to use [x] |
Must Support | true |
Requirements | To convey the data content to be provided when the information is more than a simple code or period. |
Comments | Could be used to provide references to other resources, document. For example, could contain a PDF in an Attachment of the Police Report for an Accident. |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
59. ExplanationOfBenefit.supportingInfo:brandgenericindicator | |
SliceName | brandgenericindicator |
Definition | Additional information codes regarding exceptions, special considerations, the condition, situation, prior or concurrent issues. |
Control | 0..1* |
Type | BackboneElement |
Must Support | true |
Requirements | Typically these information codes are required to support the services rendered or the adjudication of the services rendered. |
Comments | Whether the plan adjudicated the claim as a brand or generic drug (144) Often there are multiple jurisdiction specific valuesets which are required. |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
60. ExplanationOfBenefit.supportingInfo:brandgenericindicator.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). |
Control | 0..* |
Type | Extension |
Is Modifier | 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 |
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. |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists()) |
61. ExplanationOfBenefit.supportingInfo:brandgenericindicator.sequence | |
Definition | A number to uniquely identify supporting information entries. |
Control | 1..1 |
Type | positiveInt |
Requirements | Necessary to maintain the order of the supporting information items and provide a mechanism to link to claim details. |
Comments | Client app implementations should look-up supportingInfo elements based on category values instead of sequence values |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
62. ExplanationOfBenefit.supportingInfo:brandgenericindicator.category | |
Definition | The general class of the information supplied: information; exception; accident, employment; onset, etc. |
Control | 1..1 |
Binding | The codes SHALL be taken from C4BB SupportingInfo Type Value Set; other codes may be used where these codes are not suitableFor example codes, see ClaimInformationCategoryCodes |
Type | CodeableConcept |
Must Support | true |
Requirements | Required to group or associate information items with common characteristics. For example: admission information or prior treatments. |
Comments | This may contain a category for the local bill type codes. |
Pattern Value | <valueCodeableConcept xmlns="http://hl7.org/fhir"> <coding> <system value="http://hl7.org/fhir/us/carin-bb/CodeSystem/C4BBSupportingInfoType"/> <code value="brandgenericindicator"/> </coding> </valueCodeableConcept> |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
63. ExplanationOfBenefit.supportingInfo:brandgenericindicator.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. |
Control | 10..1 |
Binding | The codes SHALL be taken from NCPDP Brand Generic Indicator Value SetFor example codes, see ExceptionCodes |
Type | CodeableConcept |
Must Support | true |
Requirements | Required to identify the kind of additional information. |
Comments | This may contain the local bill type codes such as the US UB-04 bill type code. |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
64. ExplanationOfBenefit.supportingInfo:rxoriginCode | |
SliceName | rxoriginCode |
Definition | Additional information codes regarding exceptions, special considerations, the condition, situation, prior or concurrent issues. |
Control | 0..1* |
Type | BackboneElement |
Must Support | true |
Requirements | Typically these information codes are required to support the services rendered or the adjudication of the services rendered. |
Comments | Whether the prescription was transmitted as an electronic prescription, by phone, by fax, or as a written paper copy (143) Often there are multiple jurisdiction specific valuesets which are required. |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
65. ExplanationOfBenefit.supportingInfo:rxoriginCode.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). |
Control | 0..* |
Type | Extension |
Is Modifier | 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 |
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. |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists()) |
66. ExplanationOfBenefit.supportingInfo:rxoriginCode.sequence | |
Definition | A number to uniquely identify supporting information entries. |
Control | 1..1 |
Type | positiveInt |
Requirements | Necessary to maintain the order of the supporting information items and provide a mechanism to link to claim details. |
Comments | Client app implementations should look-up supportingInfo elements based on category values instead of sequence values |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
67. ExplanationOfBenefit.supportingInfo:rxoriginCode.category | |
Definition | The general class of the information supplied: information; exception; accident, employment; onset, etc. |
Control | 1..1 |
Binding | The codes SHALL be taken from C4BB SupportingInfo Type Value Set; other codes may be used where these codes are not suitableFor example codes, see ClaimInformationCategoryCodes |
Type | CodeableConcept |
Must Support | true |
Requirements | Required to group or associate information items with common characteristics. For example: admission information or prior treatments. |
Comments | This may contain a category for the local bill type codes. |
Pattern Value | <valueCodeableConcept xmlns="http://hl7.org/fhir"> <coding> <system value="http://hl7.org/fhir/us/carin-bb/CodeSystem/C4BBSupportingInfoType"/> <code value="rxorigincode"/> </coding> </valueCodeableConcept> |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
68. ExplanationOfBenefit.supportingInfo:rxoriginCode.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. |
Control | 10..1 |
Binding | The codes SHALL be taken from NCPDP Prescription Origin Code Value SetFor example codes, see ExceptionCodes |
Type | CodeableConcept |
Must Support | true |
Requirements | Required to identify the kind of additional information. |
Comments | This may contain the local bill type codes such as the US UB-04 bill type code. |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
69. ExplanationOfBenefit.supportingInfo:clmrecvddate | |
SliceName | clmrecvddate |
Definition | Additional information codes regarding exceptions, special considerations, the condition, situation, prior or concurrent issues. |
Control | 0..1* |
Type | BackboneElement |
Must Support | true |
Requirements | Typically these information codes are required to support the services rendered or the adjudication of the services rendered. |
Comments | The date the claim was received by the payer (88) Often there are multiple jurisdiction specific valuesets which are required. |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
70. ExplanationOfBenefit.supportingInfo:clmrecvddate.modifierExtension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). |
Control | 0..* |
Type | Extension |
Is Modifier | 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 |
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. |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists()) |
71. ExplanationOfBenefit.supportingInfo:clmrecvddate.sequence | |
Definition | A number to uniquely identify supporting information entries. |
Control | 1..1 |
Type | positiveInt |
Requirements | Necessary to maintain the order of the supporting information items and provide a mechanism to link to claim details. |
Comments | Client app implementations should look-up supportingInfo elements based on category values instead of sequence values |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
72. ExplanationOfBenefit.supportingInfo:clmrecvddate.category | |
Definition | The general class of the information supplied: information; exception; accident, employment; onset, etc. |
Control | 1..1 |
Binding | The codes SHALL be taken from C4BB SupportingInfo Type Value Set; other codes may be used where these codes are not suitableFor example codes, see ClaimInformationCategoryCodes |
Type | CodeableConcept |
Must Support | true |
Requirements | Required to group or associate information items with common characteristics. For example: admission information or prior treatments. |
Comments | This may contain a category for the local bill type codes. |
Pattern Value | <valueCodeableConcept xmlns="http://hl7.org/fhir"> <coding> <system value="http://hl7.org/fhir/us/carin-bb/CodeSystem/C4BBSupportingInfoType"/> <code value="clmrecvddate"/> </coding> </valueCodeableConcept> |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
73. ExplanationOfBenefit.supportingInfo:clmrecvddate.timing[x] | |
Definition | The date when or period to which this information refers. |
Control | 10..1 |
Type | Choice of: date, Period |
[x] Note | See Choice of Data Types for further information about how to use [x] |
Must Support | true |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
74. ExplanationOfBenefit.supportingInfo:compoundcode | |
SliceName | compoundcode |
Definition | Additional information codes regarding exceptions, special considerations, the condition, situation, prior or concurrent issues. |
Control | 0..1* |
Type | BackboneElement |
Must Support | true |
Requirements | Typically these information codes are required to support the services rendered or the adjudication of the services rendered. |
Comments | The code indicating whether or not the prescription is a compound. NCPDP field # 406-D6 (78) Often there are multiple jurisdiction specific valuesets which are required. |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
75. ExplanationOfBenefit.supportingInfo:compoundcode.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). |
Control | 0..* |
Type | Extension |
Is Modifier | 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 |
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. |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists()) |
76. ExplanationOfBenefit.supportingInfo:compoundcode.sequence | |
Definition | A number to uniquely identify supporting information entries. |
Control | 1..1 |
Type | positiveInt |
Requirements | Necessary to maintain the order of the supporting information items and provide a mechanism to link to claim details. |
Comments | Client app implementations should look-up supportingInfo elements based on category values instead of sequence values |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
77. ExplanationOfBenefit.supportingInfo:compoundcode.category | |
Definition | The general class of the information supplied: information; exception; accident, employment; onset, etc. |
Control | 1..1 |
Binding | The codes SHALL be taken from C4BB SupportingInfo Type Value Set; other codes may be used where these codes are not suitableFor example codes, see ClaimInformationCategoryCodes |
Type | CodeableConcept |
Must Support | true |
Requirements | Required to group or associate information items with common characteristics. For example: admission information or prior treatments. |
Comments | This may contain a category for the local bill type codes. |
Pattern Value | <valueCodeableConcept xmlns="http://hl7.org/fhir"> <coding> <system value="http://hl7.org/fhir/us/carin-bb/CodeSystem/C4BBSupportingInfoType"/> <code value="compoundcode"/> </coding> </valueCodeableConcept> |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
78. ExplanationOfBenefit.supportingInfo:compoundcode.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. |
Control | 10..1 |
Binding | The codes SHALL be taken from NCPDP Compound Code Value SetFor example codes, see ExceptionCodes |
Type | CodeableConcept |
Must Support | true |
Requirements | Required to identify the kind of additional information. |
Comments | This may contain the local bill type codes such as the US UB-04 bill type code. |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
79. ExplanationOfBenefit.insurance | |
Definition | Financial instruments for reimbursement for the health care products and services specified on the claim. |
Control | 1..* |
Type | BackboneElement |
Must Support | true |
Requirements | At least one insurer is required for a claim to be a claim. |
Comments | Identity of the payers responsible for the claim. (2, 141). All insurance coverages for the patient which may be applicable for reimbursement, of the products and services listed in the claim, are typically provided in the claim to allow insurers to confirm the ordering of the insurance coverages relative to local 'coordination of benefit' rules. One coverage (and only one) with 'focal=true' is to be used in the adjudication of this claim. An invariant is defined to enforce the following rule: Will have multiple occurrences on secondary / tertiary, etc. claims. Up to one occurrence, that of the ExplanationOfBenefit.insurer, will have a boolean value = 'True' 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. |
Invariants | Defined on this element EOB-insurance-focal: EOB.insurance: at most one with focal = true (: insurance.select (focal = true).count() < 2) ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
80. 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). |
Control | 0..* |
Type | Extension |
Is Modifier | 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 |
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. |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists()) |
81. ExplanationOfBenefit.insurance.focal | |
Definition | A flag to indicate that this Coverage is to be used for adjudication of this claim when set to true. |
Control | 1..1 |
Type | boolean |
Must Support | true |
Requirements | To identify which coverage in the list is being used to adjudicate this claim. |
Comments | A patient may (will) have multiple insurance policies which provide reimbursement for healthcare services and products. For example, a person may also be covered by their spouse's policy and both appear in the list (and may be from the same insurer). This flag will be set to true for only one of the listed policies and that policy will be used for adjudicating this claim. Other claims would be created to request adjudication against the other listed policies. An invariant is defined to enforce the following rule: Will have multiple occurrences on secondary / tertiary, etc. claims. Up to one occurrence, that of the ExplanationOfBenefit.insurer, will have a boolean value = 'True' 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. |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
82. 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. |
Control | 1..1 |
Type | Reference(C4BBCoverage|Coverage)) |
Must Support | true |
Requirements | Required to allow the adjudicator to locate the correct policy and history within their information system. |
Comments | Same as insurance.coverage.organization. Party responsible for reimbursing the provider. When focal = true, Coverage.payer--> Organization.identifier. When focal = false, EOB.insurance.coverage.display = [name of other carrier] |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
83. 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. |
Control | 10..* |
Type | BackboneElement |
Must Support | true |
Requirements | The items to be processed for adjudication. |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
84. 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). |
Control | 0..* |
Type | Extension |
Is Modifier | 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 |
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. |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists()) |
85. ExplanationOfBenefit.item.sequence | |
Definition | A number to uniquely identify item entries. |
Control | 1..1 |
Type | positiveInt |
Must Support | true |
Requirements | Necessary to provide a mechanism to link to items from within the claim and within the adjudication details of the ClaimResponse. |
Comments | Line identification number that represents the number assigned in a source system for identification and processing. (36) |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
86. ExplanationOfBenefit.item.productOrService | |
Definition | When the value is a group code then this item collects a set of related claim details, otherwise this contains the product, service, drug or other billing code for the item. |
Control | 1..1 |
Binding | The codes SHALL be taken from NDC or Compound Value SetFor example codes, see USCLSCodes |
Type | CodeableConcept |
Must Support | true |
Requirements | Necessary to state what was provided or done. |
Alternate Names | Drug Code, Bill Code, Service Code |
Comments | Values are NDC Codes (38) when Compound Code (78) = 0 or 1. When the Compound Code = 2, productOrService = 'compound' and map the ingredient to ExplanationOfBenefit.item.detail.productOrService 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'. |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
87. ExplanationOfBenefit.item.serviced[x] | |
Definition | The date or dates when the service or product was supplied, performed or completed. |
Control | 10..1 |
Type | Choice of: date, Period |
[x] Note | See Choice of Data Types for further information about how to use [x] |
Requirements | Needed to determine whether the service or product was provided during the term of the insurance coverage. |
Comments | Identifies date the prescription was filled or professional service rendered (90) |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
Slicing | This element introduces a set of slices on ExplanationOfBenefit.item.serviced[x]. The slices are unordered and Closed, and can be differentiated using the following discriminators:
|
88. ExplanationOfBenefit.item.serviced[x]:servicedDate | |
SliceName | servicedDate |
Definition | The date or dates when the service or product was supplied, performed or completed. |
Control | 10..1 |
Type | Choice of: date, Period |
[x] Note | See Choice of Data Types for further information about how to use [x] |
Must Support | true |
Requirements | Needed to determine whether the service or product was provided during the term of the insurance coverage. |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
89. ExplanationOfBenefit.item.quantity | |
Definition | The number of repetitions of a service or product. |
Control | 0..1 |
Type | Quantity(SimpleQuantity) |
Must Support | true |
Requirements | Required when the product or service code does not convey the quantity provided. |
Comments | Quantity dispensed for the drug (39) / The unit of measurement for the drug. (gram, ml, etc.) (151). Populate for all Compound Code values. When the Compound Code = 2, if available, map the ingredient to ExplanationOfBenefit.item.detail.quantity |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
90. ExplanationOfBenefit.item.noteNumber | |
Definition | The numbers associated with notes below which apply to the adjudication of this item. |
Control | 0..* |
Type | positiveInt |
Must Support | true |
Requirements | Provides a condensed manner for associating human readable descriptive explanations for adjudications on the line item. |
Comments | References number of the associated processNote entered |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
91. 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. |
Control | 10..* |
Type | BackboneElement |
Must Support | true |
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 | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
Slicing | This element introduces a set of slices on ExplanationOfBenefit.item.adjudication. The slices are unordered and Open, and can be differentiated using the following discriminators:
|
92. 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). |
Control | 0..* |
Type | Extension |
Is Modifier | 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 |
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. |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists()) |
93. 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. |
Control | 1..1 |
Binding | The codes SHALL be taken from C4BB Adjudication Category Discriminator Value Set; other codes may be used where these codes are not suitableFor example codes, see AdjudicationValueCodes |
Type | CodeableConcept |
Must Support | true |
Requirements | Needed to enable understanding of the context of the other information in the adjudication. |
Comments | For example, codes indicating: Co-Pay, deductible, eligible, benefit, tax, etc. |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
94. ExplanationOfBenefit.item.adjudication:adjudicationamounttype | |
SliceName | adjudicationamounttype |
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. |
Control | 10..* |
Type | BackboneElement |
Must Support | true |
Requirements | The adjudication results conveys the insurer's assessment of the item provided in the claim under the terms of the patient's insurance coverage. |
Comments | Describes the various amount fields used when payers receive and adjudicate a claim. (187) |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
95. ExplanationOfBenefit.item.adjudication:adjudicationamounttype.modifierExtension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). |
Control | 0..* |
Type | Extension |
Is Modifier | 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 |
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. |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists()) |
96. ExplanationOfBenefit.item.adjudication:adjudicationamounttype.category | |
Definition | A code to indicate the information type of this adjudication record. Information types may include: the value submitted, maximum values or percentages allowed or payable under the plan, amounts that the patient is responsible for in-aggregate or pertaining to this item, amounts paid by other coverages, and the benefit payable for this item. |
Control | 1..1 |
Binding | The codes SHALL be taken from C4BB Adjudication Value SetFor example codes, see AdjudicationValueCodes |
Type | CodeableConcept |
Must Support | true |
Requirements | Needed to enable understanding of the context of the other information in the adjudication. |
Comments | For example, codes indicating: Co-Pay, deductible, eligible, benefit, tax, etc. |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
97. ExplanationOfBenefit.item.adjudication:adjudicationamounttype.amount | |
Definition | Monetary amount associated with the category. |
Control | 10..1 |
Type | Money |
Must Support | true |
Requirements | Most adjuciation categories convey a monetary amount. |
Comments | For example, amount submitted, eligible amount, co-payment, and benefit payable. |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
98. ExplanationOfBenefit.item.adjudication:rejectreason | |
SliceName | rejectreason |
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. |
Control | 0..1* |
Type | BackboneElement |
Must Support | true |
Requirements | The adjudication results conveys the insurer's assessment of the item provided in the claim under the terms of the patient's insurance coverage. |
Comments | Reason codes used to interpret the Non-Covered Amount (92) |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
99. ExplanationOfBenefit.item.adjudication:rejectreason.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). |
Control | 0..* |
Type | Extension |
Is Modifier | 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 |
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. |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists()) |
100. ExplanationOfBenefit.item.adjudication:rejectreason.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. |
Control | 1..1 |
Binding | For example codes, see AdjudicationValueCodes The adjudication codes. |
Type | CodeableConcept |
Must Support | true |
Requirements | Needed to enable understanding of the context of the other information in the adjudication. |
Comments | For example, codes indicating: Co-Pay, deductible, eligible, benefit, tax, etc. |
Pattern Value | <valueCodeableConcept xmlns="http://hl7.org/fhir"> <coding> <system value="http://hl7.org/fhir/us/carin-bb/CodeSystem/C4BBAdjudicationDiscriminator"/> <code value="rejectreason"/> </coding> </valueCodeableConcept> |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
101. ExplanationOfBenefit.item.adjudication:rejectreason.reason | |
Definition | A code supporting the understanding of the adjudication result and explaining variance from expected amount. |
Control | 10..1 |
Binding | The codes SHALL be taken from NCPDP Reject Code Value SetFor example codes, see AdjudicationReasonCodes |
Type | CodeableConcept |
Must Support | true |
Requirements | To support understanding of variance from adjudication expectations. |
Comments | For example, may indicate that the funds for this benefit type have been exhausted. |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
102. ExplanationOfBenefit.item.detail | |
Definition | Second-tier of goods and services. |
Control | 0..* |
Type | BackboneElement |
Must Support | true |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
103. 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). |
Control | 0..* |
Type | Extension |
Is Modifier | 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 |
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. |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists()) |
104. 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. |
Control | 1..1 |
Type | positiveInt |
Requirements | The items to be processed for adjudication. |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
105. 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. |
Control | 1..1 |
Binding | The codes SHALL be taken from National Drug Code (NDC) Value SetFor example codes, see USCLSCodes |
Type | CodeableConcept |
Must Support | true |
Requirements | Necessary to state what was provided or done. |
Alternate Names | Drug Code, Bill Code, Service Code |
Comments | Values are NDC Codes (38) when Compound Code (78) = 2 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'. |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
106. ExplanationOfBenefit.item.detail.quantity | |
Definition | The number of repetitions of a service or product. |
Control | 0..1 |
Type | Quantity(SimpleQuantity) |
Must Support | true |
Requirements | Required when the product or service code does not convey the quantity provided. |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
107. ExplanationOfBenefit.adjudication | |
Definition | The adjudication results which are presented at the header level rather than at the line-item or add-item levels. |
Control | 10..* |
Type | BackboneElement |
Must Support | true |
Requirements | Some insurers will receive line-items but provide the adjudication only at a summary or header-level. |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
Slicing | This element introduces a set of slices on ExplanationOfBenefit.adjudication. The slices are unordered and Open, and can be differentiated using the following discriminators:
|
108. ExplanationOfBenefit.adjudication.modifierExtension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). |
Control | 0..* |
Type | Extension |
Is Modifier | 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 |
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. |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists()) |
109. ExplanationOfBenefit.adjudication.category | |
Definition | A code to indicate the information type of this adjudication record. Information types may include: the value submitted, maximum values or percentages allowed or payable under the plan, amounts that the patient is responsible for in-aggregate or pertaining to this item, amounts paid by other coverages, and the benefit payable for this item. |
Control | 1..1 |
Binding | The codes SHALL be taken from C4BB Adjudication Category Discriminator Value Set; other codes may be used where these codes are not suitableFor example codes, see AdjudicationValueCodes |
Type | CodeableConcept |
Must Support | true |
Requirements | Needed to enable understanding of the context of the other information in the adjudication. |
Comments | For example, codes indicating: Co-Pay, deductible, eligible, benefit, tax, etc. |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
110. ExplanationOfBenefit.adjudication:billingnetworkstatus | |
SliceName | billingnetworkstatus |
Definition | The adjudication results which are presented at the header level rather than at the line-item or add-item levels. |
Control | 0..1* |
Type | BackboneElement |
Must Support | true |
Requirements | Some insurers will receive line-items but provide the adjudication only at a summary or header-level. |
Comments | Indicates that the Billing Provider has a contract with the Plan (regardless of the network) that is effective on the date of service. (101) |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
111. ExplanationOfBenefit.adjudication:billingnetworkstatus.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). |
Control | 0..* |
Type | Extension |
Is Modifier | 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 |
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. |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists()) |
112. ExplanationOfBenefit.adjudication:billingnetworkstatus.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. |
Control | 1..1 |
Binding | For example codes, see AdjudicationValueCodes The adjudication codes. |
Type | CodeableConcept |
Requirements | Needed to enable understanding of the context of the other information in the adjudication. |
Comments | For example, codes indicating: Co-Pay, deductible, eligible, benefit, tax, etc. |
Pattern Value | <valueCodeableConcept xmlns="http://hl7.org/fhir"> <coding> <system value="http://hl7.org/fhir/us/carin-bb/CodeSystem/C4BBAdjudicationDiscriminator"/> <code value="billingnetworkstatus"/> </coding> </valueCodeableConcept> |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
113. ExplanationOfBenefit.adjudication:billingnetworkstatus.reason | |
Definition | A code supporting the understanding of the adjudication result and explaining variance from expected amount. |
Control | 10..1 |
Binding | The codes SHALL be taken from C4BB Payer Provider Network Status Value SetFor example codes, see AdjudicationReasonCodes |
Type | CodeableConcept |
Must Support | true |
Requirements | To support understanding of variance from adjudication expectations. |
Comments | For example, may indicate that the funds for this benefit type have been exhausted. |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
114. ExplanationOfBenefit.adjudication:benefitpaymentstatus | |
SliceName | benefitpaymentstatus |
Definition | The adjudication results which are presented at the header level rather than at the line-item or add-item levels. |
Control | 10..1* |
Type | BackboneElement |
Must Support | true |
Requirements | Some insurers will receive line-items but provide the adjudication only at a summary or header-level. |
Comments | Indicates the in network or out of network payment status of the claim. (142) |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
115. ExplanationOfBenefit.adjudication:benefitpaymentstatus.modifierExtension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). |
Control | 0..* |
Type | Extension |
Is Modifier | 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 |
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. |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists()) |
116. ExplanationOfBenefit.adjudication:benefitpaymentstatus.category | |
Definition | A code to indicate the information type of this adjudication record. Information types may include: the value submitted, maximum values or percentages allowed or payable under the plan, amounts that the patient is responsible for in-aggregate or pertaining to this item, amounts paid by other coverages, and the benefit payable for this item. |
Control | 1..1 |
Binding | For example codes, see AdjudicationValueCodes The adjudication codes. |
Type | CodeableConcept |
Requirements | Needed to enable understanding of the context of the other information in the adjudication. |
Comments | For example, codes indicating: Co-Pay, deductible, eligible, benefit, tax, etc. |
Pattern Value | <valueCodeableConcept xmlns="http://hl7.org/fhir"> <coding> <system value="http://hl7.org/fhir/us/carin-bb/CodeSystem/C4BBAdjudicationDiscriminator"/> <code value="benefitpaymentstatus"/> </coding> </valueCodeableConcept> |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
117. ExplanationOfBenefit.adjudication:benefitpaymentstatus.reason | |
Definition | A code supporting the understanding of the adjudication result and explaining variance from expected amount. |
Control | 10..1 |
Binding | The codes SHALL be taken from C4BB Payer Benefit Payment Status Value SetFor example codes, see AdjudicationReasonCodes |
Type | CodeableConcept |
Must Support | true |
Requirements | To support understanding of variance from adjudication expectations. |
Comments | For example, may indicate that the funds for this benefit type have been exhausted. |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
118. ExplanationOfBenefit.total | |
Definition | Categorized monetary totals for the adjudication. |
Control | 10..* |
Type | BackboneElement |
Must Support | true |
Requirements | To provide the requestor with financial totals by category for the adjudication. |
Comments | Totals for amounts submitted, co-pays, benefits payable etc. |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
Slicing | This element introduces a set of slices on ExplanationOfBenefit.total. The slices are unordered and Open, and can be differentiated using the following discriminators:
|
119. 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). |
Control | 0..* |
Type | Extension |
Is Modifier | 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 |
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. |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists()) |
120. ExplanationOfBenefit.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. |
Control | 1..1 |
Binding | The codes SHALL be taken from C4BB Total Category Discriminator Value Set; other codes may be used where these codes are not suitableFor example codes, see AdjudicationValueCodes |
Type | CodeableConcept |
Must Support | true |
Requirements | Needed to convey the type of total provided. |
Comments | For example, codes indicating: Co-Pay, deductible, eligible, benefit, tax, etc. |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
121. ExplanationOfBenefit.total.amount | |
Definition | Monetary total amount associated with the category. |
Control | 1..1 |
Type | Money |
Must Support | true |
Requirements | Needed to convey the total monetary amount. |
Comments | Total amount for each category (i.e., submitted, allowed, etc.) (148) |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
122. ExplanationOfBenefit.total:adjudicationamounttype | |
SliceName | adjudicationamounttype |
Definition | Categorized monetary totals for the adjudication. |
Control | 10..* |
Type | BackboneElement |
Must Support | true |
Requirements | To provide the requestor with financial totals by category for the adjudication. |
Comments | Describes the various amount fields used when payers receive and adjudicate a claim. (187) Totals for amounts submitted, co-pays, benefits payable etc. |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
123. ExplanationOfBenefit.total:adjudicationamounttype.modifierExtension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). |
Control | 0..* |
Type | Extension |
Is Modifier | 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 |
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. |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists()) |
124. ExplanationOfBenefit.total:adjudicationamounttype.category | |
Definition | A code to indicate the information type of this adjudication record. Information types may include: the value submitted, maximum values or percentages allowed or payable under the plan, amounts that the patient is responsible for in aggregate or pertaining to this item, amounts paid by other coverages, and the benefit payable for this item. |
Control | 1..1 |
Binding | The codes SHALL be taken from C4BB Adjudication Value SetFor example codes, see AdjudicationValueCodes |
Type | CodeableConcept |
Requirements | Needed to convey the type of total provided. |
Comments | For example, codes indicating: Co-Pay, deductible, eligible, benefit, tax, etc. |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
125. ExplanationOfBenefit.total:adjudicationamounttype.amount | |
Definition | Monetary total amount associated with the category. |
Control | 1..1 |
Type | Money |
Must Support | true |
Requirements | Needed to convey the total monetary amount. |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
126. ExplanationOfBenefit.payment | |
Definition | Payment details for the adjudication of the claim. |
Control | 0..1 |
Type | BackboneElement |
Must Support | true |
Requirements | Needed to convey references to the financial instrument that has been used if payment has been made. |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
127. 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). |
Control | 0..* |
Type | Extension |
Is Modifier | 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 |
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. |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists()) |
128. ExplanationOfBenefit.payment.type | |
Definition | Whether this represents partial or complete payment of the benefits payable. |
Control | 0..1 |
Binding | The codes SHALL be taken from C4BB Payer Claim Payment Status Code Value SetFor example codes, see ExamplePaymentTypeCodes |
Type | CodeableConcept |
Must Support | true |
Requirements | To advise the requestor when the insurer believes all payments to have been completed. |
Comments | Indicates whether the claim was paid or denied. (91) |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
129. ExplanationOfBenefit.payment.date | |
Definition | Estimated date the payment will be issued or the actual issue date of payment. |
Control | 0..1 |
Type | date |
Must Support | true |
Requirements | To advise the payee when payment can be expected. |
Comments | The date the claim was paid. (107) |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
130. ExplanationOfBenefit.processNote | |
Definition | A note that describes or explains adjudication results in a human readable form. |
Control | 0..* |
Type | BackboneElement |
Must Support | true |
Requirements | Provides the insurer specific textual explanations associated with the processing. |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
131. 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). |
Control | 0..* |
Type | Extension |
Is Modifier | 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 |
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. |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists()) |
132. ExplanationOfBenefit.processNote.text | |
Definition | The explanation or description associated with the processing. |
Control | 0..1 |
Type | string |
Must Support | true |
Requirements | Required to provide human readable explanation. |
Comments | Payment denial explanation to a member, typically goes on the EOB when the payment is denied or disallowed (181) |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
1. ExplanationOfBenefit | |||||
Definition | This resource provides: the claim details; adjudication details from the processing of a Claim; and optionally account balance information, for informing the subscriber of the benefits provided. | ||||
Control | 0..* | ||||
Alternate Names | EOB | ||||
2. ExplanationOfBenefit.id | |||||
Definition | The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. | ||||
Control | 0..1 | ||||
Type | id | ||||
Comments | The only time that a resource does not have an id is when it is being submitted to the server using a create operation. | ||||
3. ExplanationOfBenefit.meta | |||||
Definition | The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource. | ||||
Control | 1..1 | ||||
Type | Meta | ||||
Must Support | true | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
4. ExplanationOfBenefit.meta.id | |||||
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||||
Control | 0..1 | ||||
Type | string | ||||
XML Representation | In the XML format, this property is represented as an attribute. | ||||
5. ExplanationOfBenefit.meta.extension | |||||
Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | ||||
Control | 0..* | ||||
Type | Extension | ||||
Alternate Names | extensionsuser content | ||||
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists()) | ||||
Slicing | This element introduces a set of slices on ExplanationOfBenefit.meta.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
| ||||
6. ExplanationOfBenefit.meta.versionId | |||||
Definition | The version specific identifier, as it appears in the version portion of the URL. This value changes when the resource is created, updated, or deleted. | ||||
Control | 0..1 | ||||
Type | id | ||||
Comments | The server assigns this value, and ignores what the client specifies, except in the case that the server is imposing version integrity on updates/deletes. | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
7. ExplanationOfBenefit.meta.lastUpdated | |||||
Definition | When the resource last changed - e.g. when the version changed. | ||||
Control | 1..1 | ||||
Type | instant | ||||
Must Support | true | ||||
Comments | Defines the date the Resource was created or updated, whichever comes last (163). Payers SHALL provide the last time the data was updated or the date of creation in the payerās system of record, whichever comes last | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
8. ExplanationOfBenefit.meta.source | |||||
Definition | A uri that identifies the source system of the resource. This provides a minimal amount of Provenance information that can be used to track or differentiate the source of information in the resource. The source may identify another FHIR server, document, message, database, etc. | ||||
Control | 0..1 | ||||
Type | uri | ||||
Comments | In the provenance resource, this corresponds to Provenance.entity.what[x]. The exact use of the source (and the implied Provenance.entity.role) is left to implementer discretion. Only one nominated source is allowed; for additional provenance details, a full Provenance resource should be used. This element can be used to indicate where the current master source of a resource that has a canonical URL if the resource is no longer hosted at the canonical URL. | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
9. ExplanationOfBenefit.meta.profile | |||||
Definition | A list of profiles (references to StructureDefinition resources) that this resource claims to conform to. The URL is a reference to StructureDefinition.url. | ||||
Control | 1..* | ||||
Type | canonical(StructureDefinition)) | ||||
Comments | meta.profile is required as a matter of convenience of receiving systems. The meta.profile should be used by the Server to hint/assert/declare that this instance conforms to one (or more) stated profiles (with business versions). meta.profile does not capture any business logic, processing directives, or semantics (for example, inpatient or outpatient). Clients should not assume that the Server will exhaustively indicate all profiles with all versions that this instance conforms to. Clients can (and should) perform their own validation of conformance to the indicated profile(s) and to any other profiles of interest. CPCDS data element (190) | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
10. ExplanationOfBenefit.meta.security | |||||
Definition | Security labels applied to this resource. These tags connect specific resources to the overall security policy and infrastructure. | ||||
Control | 0..* | ||||
Binding | The codes SHALL be taken from All Security Labels; other codes may be used where these codes are not suitable Security Labels from the Healthcare Privacy and Security Classification System | ||||
Type | Coding | ||||
Comments | The security labels can be updated without changing the stated version of the resource. The list of security labels is a set. Uniqueness is based the system/code, and version and display are ignored. | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
11. ExplanationOfBenefit.meta.tag | |||||
Definition | Tags applied to this resource. Tags are intended to be used to identify and relate resources to process and workflow, and applications are not required to consider the tags when interpreting the meaning of a resource. | ||||
Control | 0..* | ||||
Binding | For example codes, see CommonTags Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones" | ||||
Type | Coding | ||||
Comments | The tags can be updated without changing the stated version of the resource. The list of tags is a set. Uniqueness is based the system/code, and version and display are ignored. | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
12. 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. | ||||
Control | 0..1 | ||||
Type | uri | ||||
Is Modifier | true | ||||
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. | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
13. ExplanationOfBenefit.language | |||||
Definition | The base language in which the resource is written. | ||||
Control | 0..1 | ||||
Binding | The codes SHOULD be taken from CommonLanguages
A human language
| ||||
Type | code | ||||
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). | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
14. 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. | ||||
Control | 0..1 | ||||
Type | Narrative | ||||
Alternate Names | narrativehtmlxhtmldisplay | ||||
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. | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
15. 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. | ||||
Control | 0..* | ||||
Type | Resource | ||||
Alternate Names | inline resourcesanonymous resourcescontained 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. | ||||
16. 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. | ||||
Control | 0..* | ||||
Type | Extension | ||||
Alternate Names | extensionsuser content | ||||
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists()) | ||||
17. 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). | ||||
Control | 0..* | ||||
Type | Extension | ||||
Is Modifier | 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 | extensionsuser content | ||||
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists()) | ||||
18. ExplanationOfBenefit.identifier | |||||
Definition | A unique identifier assigned to this explanation of benefit. | ||||
Note | This is a business identifier, not a resource identifier (see discussion) | ||||
Control | 1..* | ||||
Type | Identifier | ||||
Must Support | true | ||||
Requirements | Allows EOBs to be distinguished and referenced. | ||||
Comments | Identifier assigned by a payer for a claim received from a provider or subscriber. It is not the same identifier as that assigned by a provider. (35) | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
Slicing | This element introduces a set of slices on ExplanationOfBenefit.identifier. The slices are unordered and Open, and can be differentiated using the following discriminators:
| ||||
19. ExplanationOfBenefit.identifier:uniqueclaimid | |||||
SliceName | uniqueclaimid | ||||
Definition | A unique identifier assigned to this explanation of benefit. | ||||
Note | This is a business identifier, not a resource identifier (see discussion) | ||||
Control | 1..1 | ||||
Type | Identifier | ||||
Must Support | true | ||||
Requirements | Allows EOBs to be distinguished and referenced. | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
20. ExplanationOfBenefit.identifier:uniqueclaimid.id | |||||
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||||
Control | 0..1 | ||||
Type | string | ||||
XML Representation | In the XML format, this property is represented as an attribute. | ||||
21. ExplanationOfBenefit.identifier:uniqueclaimid.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. | ||||
Control | 0..* | ||||
Type | Extension | ||||
Alternate Names | extensionsuser content | ||||
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists()) | ||||
Slicing | This element introduces a set of slices on ExplanationOfBenefit.identifier.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
| ||||
22. ExplanationOfBenefit.identifier:uniqueclaimid.use | |||||
Definition | The purpose of this identifier. | ||||
Control | 0..1 | ||||
Binding | The codes SHALL be taken from IdentifierUse Identifies the purpose for this identifier, if known | ||||
Type | code | ||||
Is Modifier | true | ||||
Requirements | Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers. | ||||
Comments | Applications can assume that an identifier is permanent unless it explicitly says that it is temporary. | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
23. ExplanationOfBenefit.identifier:uniqueclaimid.type | |||||
Definition | A coded type for the identifier that can be used to determine which identifier to use for a specific purpose. | ||||
Control | 1..1 | ||||
Binding | The codes SHALL be taken from Identifier Type Codes; other codes may be used where these codes are not suitable A coded type for an identifier that can be used to determine which identifier to use for a specific purpose | ||||
Type | CodeableConcept | ||||
Requirements | Allows users to make use of identifiers when the identifier system is not known. | ||||
Comments | This element deals only with general categories of identifiers. It SHOULD not be used for codes that correspond 1..1 with the Identifier.system. Some identifiers may fall into multiple categories due to common usage. Where the system is known, a type is unnecessary because the type is always part of the system definition. However systems often need to handle identifiers where the system is not known. There is not a 1:1 relationship between type and system, since many different systems have the same type. | ||||
Pattern Value | <valueCodeableConcept xmlns="http://hl7.org/fhir"> <coding> <system value="http://hl7.org/fhir/us/carin-bb/CodeSystem/C4BBIdentifierType"/> <code value="uc"/> </coding> </valueCodeableConcept> | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
24. ExplanationOfBenefit.identifier:uniqueclaimid.system | |||||
Definition | Establishes the namespace for the value - that is, a URL that describes a set values that are unique. | ||||
Control | 0..1 | ||||
Type | uri | ||||
Requirements | There are many sets of identifiers. To perform matching of two identifiers, we need to know what set we're dealing with. The system identifies a particular set of unique identifiers. | ||||
Comments | Identifier.system is always case sensitive. | ||||
Example | General:http://www.acme.com/identifiers/patient | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
25. ExplanationOfBenefit.identifier:uniqueclaimid.value | |||||
Definition | The portion of the identifier typically relevant to the user and which is unique within the context of the system. | ||||
Control | 1..1 | ||||
Type | string | ||||
Must Support | true | ||||
Comments | If the value is a full URI, then the system SHALL be urn:ietf:rfc:3986. The value's primary purpose is computational mapping. As a result, it may be normalized for comparison purposes (e.g. removing non-significant whitespace, dashes, etc.) A value formatted for human display can be conveyed using the Rendered Value extension. Identifier.value is to be treated as case sensitive unless knowledge of the Identifier.system allows the processer to be confident that non-case-sensitive processing is safe. | ||||
Example | General:123456 | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
26. ExplanationOfBenefit.identifier:uniqueclaimid.period | |||||
Definition | Time period during which identifier is/was valid for use. | ||||
Control | 0..1 | ||||
Type | Period | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
27. ExplanationOfBenefit.identifier:uniqueclaimid.assigner | |||||
Definition | Organization that issued/manages the identifier. | ||||
Control | 0..1 | ||||
Type | Reference(Organization)) | ||||
Comments | The Identifier.assigner may omit the .reference element and only contain a .display element reflecting the name or other textual information about the assigning organization. | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
28. ExplanationOfBenefit.status | |||||
Definition | The status of the resource instance. | ||||
Control | 1..1 | ||||
Binding | The codes SHALL be taken from ExplanationOfBenefitStatus A code specifying the state of the resource instance | ||||
Type | code | ||||
Is Modifier | true | ||||
Must Support | 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'. | ||||
Comments | Claim processing status code (140). Expected values are active or cancelled. To comply with the CMS rule, draft EOBs are not required | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
29. ExplanationOfBenefit.type | |||||
Definition | The category of claim, e.g. oral, pharmacy, vision, institutional, professional. | ||||
Control | 1..1 | ||||
Binding | The codes SHALL be taken from ClaimTypeCodes | ||||
Type | CodeableConcept | ||||
Must Support | true | ||||
Requirements | Claim type determine the general sets of business rules applied for information requirements and adjudication. | ||||
Comments | Specifies the type of claim. (e.g., inpatient institutional, outpatient institutional, physician, etc.) (16). Defines the Claims profiles. Values from Claim Type Codes are required; a data absent reason is not allowed | ||||
Pattern Value | <valueCodeableConcept xmlns="http://hl7.org/fhir"> <coding> <system value="http://terminology.hl7.org/CodeSystem/claim-type"/> <code value="pharmacy"/> </coding> </valueCodeableConcept> | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
30. ExplanationOfBenefit.subType | |||||
Definition | A finer grained suite of claim type codes which may convey additional information such as Inpatient vs Outpatient and/or a specialty service. | ||||
Control | 0..1 | ||||
Binding | For example codes, see ExampleClaimSubTypeCodes A more granular claim typecode | ||||
Type | CodeableConcept | ||||
Requirements | Some jurisdictions need a finer grained claim type for routing and adjudication. | ||||
Comments | This may contain the local bill type codes such as the US UB-04 bill type code. | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
31. ExplanationOfBenefit.use | |||||
Definition | A code to indicate whether the nature of the request is: to request adjudication of products and services previously rendered; or requesting authorization and adjudication for provision in the future; or requesting the non-binding adjudication of the listed products and services which could be provided in the future. | ||||
Control | 1..1 | ||||
Binding | The codes SHALL be taken from Use Complete, proposed, exploratory, other | ||||
Type | code | ||||
Must Support | true | ||||
Requirements | This element is required to understand the nature of the request for adjudication. | ||||
Comments | Expected value is claim. The CMS rule applies to adjudicated claims; it does not require preauthorizations or predeterminations | ||||
Pattern Value | claim | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
32. ExplanationOfBenefit.patient | |||||
Definition | The party to whom the professional services and/or products have been supplied or are being considered and for whom actual for forecast reimbursement is sought. | ||||
Control | 1..1 | ||||
Type | Reference(C4BBPatient)) | ||||
Must Support | 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. | ||||
Comments | Identifier for a member assigned by the Payer. If members receive ID cards, that is the identifier that should be provided. (1). The patient must be supplied to the insurer so that confirmation of coverage and service history may be considered as part of the authorization and/or adjudication. Additional required path:EOB.insurance.coverage(Coverage).beneficiary(Patient).identifier | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
33. ExplanationOfBenefit.billablePeriod | |||||
Definition | The period for which charges are being submitted. | ||||
Control | 1..1 | ||||
Type | Period | ||||
Must Support | true | ||||
Requirements | A number jurisdictions required the submission of the billing period when submitting claims for example for hospital stays or long-term care. | ||||
Comments | Typically this would be today or in the past for a claim, and today or in the future for preauthorizations and prodeterminations. Typically line item dates of service should fall within the billing period if one is specified. | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
34. ExplanationOfBenefit.billablePeriod.id | |||||
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||||
Control | 0..1 | ||||
Type | string | ||||
XML Representation | In the XML format, this property is represented as an attribute. | ||||
35. ExplanationOfBenefit.billablePeriod.extension | |||||
Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | ||||
Control | 0..* | ||||
Type | Extension | ||||
Alternate Names | extensionsuser content | ||||
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists()) | ||||
Slicing | This element introduces a set of slices on ExplanationOfBenefit.billablePeriod.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
| ||||
36. ExplanationOfBenefit.billablePeriod.start | |||||
Definition | The start of the period. The boundary is inclusive. | ||||
Control | 1..1 This element is affected by the following invariants: per-1 | ||||
Type | dateTime | ||||
Must Support | true | ||||
Comments | The first day on the billing statement covering services rendered to the beneficiary (i.e. 'Statement Covers From Dateā). (177) | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
37. ExplanationOfBenefit.billablePeriod.end | |||||
Definition | The end of the period. If the end of the period is missing, it means no end was known or planned at the time the instance was created. The start may be in the past, and the end date in the future, which means that period is expected/planned to end at that time. | ||||
Control | 0..1 This element is affected by the following invariants: per-1 | ||||
Type | dateTime | ||||
Comments | The last day on the billing statement covering services rendered to the beneficiary (i.e. 'Statement Covers Thru Dateā). (178) | ||||
Meaning if Missing | If the end of the period is missing, it means that the period is ongoing | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
38. ExplanationOfBenefit.created | |||||
Definition | The date this resource was created. | ||||
Control | 1..1 | ||||
Type | dateTime | ||||
Must Support | true | ||||
Requirements | Need to record a timestamp for use by both the recipient and the issuer. | ||||
Comments | Date the claim was adjudicated (179) | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
39. ExplanationOfBenefit.enterer | |||||
Definition | Individual who created the claim, predetermination or preauthorization. | ||||
Control | 0..1 | ||||
Type | Reference(PractitionerPractitionerRole)) | ||||
Requirements | Some jurisdictions require the contact information for personnel completing claims. | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
40. ExplanationOfBenefit.insurer | |||||
Definition | The party responsible for authorization, adjudication and reimbursement. | ||||
Control | 1..1 | ||||
Type | Reference(C4BBOrganization)) | ||||
Must Support | 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. | ||||
Comments | Code of the payer responsible for the claim (2, 5). Same as insurance.coverage.organization. Party responsible for reimbursing the provider | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
41. ExplanationOfBenefit.provider | |||||
Definition | The provider which is responsible for the claim, predetermination or preauthorization. | ||||
Control | 1..1 | ||||
Type | Reference(C4BBOrganizationC4BBPractitioner)) | ||||
Must Support | true | ||||
Must Support Types | No must-support rules about the choice of types/profiles | ||||
Comments | The identifier assigned to the Billing Provider. (94) | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
42. ExplanationOfBenefit.priority | |||||
Definition | The provider-required urgency of processing the request. Typical values include: stat, routine deferred. | ||||
Control | 0..1 | ||||
Binding | The codes SHALL be taken from ProcessPriorityCodes | ||||
Type | CodeableConcept | ||||
Requirements | The provider may need to indicate their processing requirements so that the processor can indicate if they are unable to comply. | ||||
Comments | If a claim processor is unable to complete the processing as per the priority then they should generate and error and not process the request. | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
43. ExplanationOfBenefit.fundsReserveRequested | |||||
Definition | A code to indicate whether and for whom funds are to be reserved for future claims. | ||||
Control | 0..1 | ||||
Binding | For example codes, see Funds Reservation Codes For whom funds are to be reserved: (Patient, Provider, None) | ||||
Type | CodeableConcept | ||||
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 | ||||
Comments | This field is only used for preauthorizations. | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
44. ExplanationOfBenefit.fundsReserve | |||||
Definition | A code, used only on a response to a preauthorization, to indicate whether the benefits payable have been reserved and for whom. | ||||
Control | 0..1 | ||||
Binding | For example codes, see Funds Reservation Codes For whom funds are to be reserved: (Patient, Provider, None) | ||||
Type | CodeableConcept | ||||
Requirements | Needed to advise the submitting provider on whether the rquest for reservation of funds has been honored. | ||||
Comments | Fund would be release by a future claim quoting the preAuthRef of this response. Examples of values include: provider, patient, none. | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
45. ExplanationOfBenefit.related | |||||
Definition | Other claims which are related to this claim such as prior submissions or claims for related services or for the same event. | ||||
Control | 0..* | ||||
Type | BackboneElement | ||||
Must Support | true | ||||
Requirements | For workplace or other accidents it is common to relate separate claims arising from the same event. | ||||
Comments | If the current claim represents a claim that has been adjusted and was given a prior claim number, this field represents the prior claim number. If the current claim has been adjusted; i.e., replaced by or merged to another claim number, this data element represents that new number.(111, 112) | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
46. ExplanationOfBenefit.related.id | |||||
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||||
Control | 0..1 | ||||
Type | string | ||||
XML Representation | In the XML format, this property is represented as an attribute. | ||||
47. ExplanationOfBenefit.related.extension | |||||
Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | ||||
Control | 0..* | ||||
Type | Extension | ||||
Alternate Names | extensionsuser content | ||||
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists()) | ||||
48. ExplanationOfBenefit.related.modifierExtension | |||||
Definition | May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). | ||||
Control | 0..* | ||||
Type | Extension | ||||
Is Modifier | 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 | extensionsuser contentmodifiers | ||||
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. | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists()) | ||||
49. ExplanationOfBenefit.related.claim | |||||
Definition | Reference to a related claim. | ||||
Control | 0..1 | ||||
Type | Reference(Claim)) | ||||
Requirements | For workplace or other accidents it is common to relate separate claims arising from the same event. | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
50. ExplanationOfBenefit.related.relationship | |||||
Definition | A code to convey how the claims are related. | ||||
Control | 1..1 | ||||
Binding | The codes SHALL be taken from C4BB Related Claim Relationship Codes Value Set | ||||
Type | CodeableConcept | ||||
Must Support | true | ||||
Requirements | Some insurers need a declaration of the type of relationship. | ||||
Comments | For example, prior claim or umbrella. | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
51. ExplanationOfBenefit.related.reference | |||||
Definition | An alternate organizational reference to the case or file to which this particular claim pertains. | ||||
Control | 1..1 | ||||
Type | Identifier | ||||
Must Support | true | ||||
Requirements | In cases where an event-triggered claim is being submitted to an insurer which requires a reference number to be specified on all exchanges. | ||||
Comments | For example, Property/Casualty insurer claim number or Workers Compensation case number. | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
52. ExplanationOfBenefit.prescription | |||||
Definition | Prescription to support the dispensing of pharmacy, device or vision products. | ||||
Control | 0..1 | ||||
Type | Reference(MedicationRequestVisionPrescription)) | ||||
Requirements | Required to authorize the dispensing of controlled substances and devices. | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
53. ExplanationOfBenefit.originalPrescription | |||||
Definition | Original prescription which has been superseded by this prescription to support the dispensing of pharmacy services, medications or products. | ||||
Control | 0..1 | ||||
Type | Reference(MedicationRequest)) | ||||
Requirements | Often required when a fulfiller varies what is fulfilled from that authorized on the original prescription. | ||||
Comments | For example, a physician may prescribe a medication which the pharmacy determines is contraindicated, or for which the patient has an intolerance, and therefor issues a new prescription for an alternate medication which has the same therapeutic intent. The prescription from the pharmacy becomes the 'prescription' and that from the physician becomes the 'original prescription'. | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
54. ExplanationOfBenefit.payee | |||||
Definition | The party to be reimbursed for cost of the products and services according to the terms of the policy. | ||||
Control | 0..1 | ||||
Type | BackboneElement | ||||
Must Support | true | ||||
Requirements | The provider needs to specify who they wish to be reimbursed and the claims processor needs express who they will reimburse. | ||||
Comments | Often providers agree to receive the benefits payable to reduce the near-term costs to the patient. The insurer may decline to pay the provider and may choose to pay the subscriber instead. | ||||
Invariants | Defined on this element EOB-payee-other-type-requires-party: Base EOB: if payee type is other, payee party is required (: type.coding.where(code = 'other' and system = 'http://terminology.hl7.org/CodeSystem/payeetype').exists() implies party.exists()) ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
55. ExplanationOfBenefit.payee.id | |||||
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||||
Control | 0..1 | ||||
Type | string | ||||
XML Representation | In the XML format, this property is represented as an attribute. | ||||
56. ExplanationOfBenefit.payee.extension | |||||
Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | ||||
Control | 0..* | ||||
Type | Extension | ||||
Alternate Names | extensionsuser content | ||||
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists()) | ||||
57. ExplanationOfBenefit.payee.modifierExtension | |||||
Definition | May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). | ||||
Control | 0..* | ||||
Type | Extension | ||||
Is Modifier | 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 | extensionsuser contentmodifiers | ||||
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. | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists()) | ||||
58. ExplanationOfBenefit.payee.type | |||||
Definition | Type of Party to be reimbursed: Subscriber, provider, other. | ||||
Control | 1..1 | ||||
Binding | The codes SHALL be taken from C4BB Payee Type Value Set | ||||
Type | CodeableConcept | ||||
Must Support | true | ||||
Requirements | Need to know who should receive payment with the most common situations being the Provider (assignment of benefits) or the Subscriber. | ||||
Comments | Identifies the type of recipient of the adjudication amount; i.e., provider, subscriber, beneficiary or another recipient. (120) | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
59. ExplanationOfBenefit.payee.party | |||||
Definition | Reference to the individual or organization to whom any payment will be made. | ||||
Control | 0..1 | ||||
Type | Reference(C4BBOrganizationC4BBPatientC4BBPractitionerC4BBRelatedPerson)) | ||||
Must Support | true | ||||
Must Support Types | No must-support rules about the choice of types/profiles | ||||
Requirements | Need to provide demographics if the payee is not 'subscriber' nor 'provider'. | ||||
Comments | Recipient reference (121) | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
60. ExplanationOfBenefit.referral | |||||
Definition | A reference to a referral resource. | ||||
Control | 0..1 | ||||
Type | Reference(ServiceRequest)) | ||||
Requirements | Some insurers require proof of referral to pay for services or to pay specialist rates for services. | ||||
Comments | The referral resource which lists the date, practitioner, reason and other supporting information. | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
61. ExplanationOfBenefit.facility | |||||
Definition | Facility where the services were provided. | ||||
Control | 0..1 | ||||
Type | Reference(Location)) | ||||
Requirements | Insurance adjudication can be dependant on where services were delivered. | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
62. ExplanationOfBenefit.claim | |||||
Definition | The business identifier for the instance of the adjudication request: claim predetermination or preauthorization. | ||||
Control | 0..1 | ||||
Type | Reference(Claim)) | ||||
Requirements | To provide a link to the original adjudication request. | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
63. ExplanationOfBenefit.claimResponse | |||||
Definition | The business identifier for the instance of the adjudication response: claim, predetermination or preauthorization response. | ||||
Control | 0..1 | ||||
Type | Reference(ClaimResponse)) | ||||
Requirements | To provide a link to the original adjudication response. | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
64. ExplanationOfBenefit.outcome | |||||
Definition | The outcome of the claim, predetermination, or preauthorization processing. | ||||
Control | 1..1 | ||||
Binding | The codes SHALL be taken from ClaimProcessingCodes The result of the claim processing | ||||
Type | code | ||||
Must Support | true | ||||
Requirements | To advise the requestor of an overall processing outcome. | ||||
Comments | Expected value is complete | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
65. ExplanationOfBenefit.disposition | |||||
Definition | A human readable description of the status of the adjudication. | ||||
Control | 0..1 | ||||
Type | string | ||||
Requirements | Provided for user display. | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
66. ExplanationOfBenefit.preAuthRef | |||||
Definition | Reference from the Insurer which is used in later communications which refers to this adjudication. | ||||
Control | 0..* | ||||
Type | string | ||||
Requirements | On subsequent claims, the insurer may require the provider to quote this value. | ||||
Comments | This value is only present on preauthorization adjudications. | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
67. ExplanationOfBenefit.preAuthRefPeriod | |||||
Definition | The timeframe during which the supplied preauthorization reference may be quoted on claims to obtain the adjudication as provided. | ||||
Control | 0..* | ||||
Type | Period | ||||
Requirements | On subsequent claims, the insurer may require the provider to quote this value. | ||||
Comments | This value is only present on preauthorization adjudications. | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
68. ExplanationOfBenefit.careTeam | |||||
Definition | The members of the team who provided the products and services. | ||||
Control | 0..* | ||||
Type | BackboneElement | ||||
Must Support | true | ||||
Requirements | Common to identify the responsible and supporting practitioners. | ||||
Invariants | Defined on this element EOB-pharm-careTeam-organization: Pharmacy EOB: Careteam roles refer to an organization (: ( role.where(coding.where(code in ('rendering' )).exists()).exists() implies role.where(coding.where(code in ('rendering' )).exists()).exists().provider.all(resolve() is Organization) )) EOB-pharm-careTeam-practitioner: Pharmacy EOB: Careteam roles refer to a practitioner (: ( role.where(coding.where(code in ('primary' | 'prescribing' )).exists()).exists() implies role.where(coding.where(code in ('primary' | 'prescribing' )).exists()).exists().provider.all(resolve() is Organization) )) ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
69. ExplanationOfBenefit.careTeam.id | |||||
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||||
Control | 0..1 | ||||
Type | string | ||||
XML Representation | In the XML format, this property is represented as an attribute. | ||||
70. ExplanationOfBenefit.careTeam.extension | |||||
Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | ||||
Control | 0..* | ||||
Type | Extension | ||||
Alternate Names | extensionsuser content | ||||
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists()) | ||||
71. ExplanationOfBenefit.careTeam.modifierExtension | |||||
Definition | May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). | ||||
Control | 0..* | ||||
Type | Extension | ||||
Is Modifier | 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 | extensionsuser contentmodifiers | ||||
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. | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists()) | ||||
72. ExplanationOfBenefit.careTeam.sequence | |||||
Definition | A number to uniquely identify care team entries. | ||||
Control | 1..1 | ||||
Type | positiveInt | ||||
Requirements | Necessary to maintain the order of the care team and provide a mechanism to link individuals to claim details. | ||||
Comments | careTeam.sequence values uniquely identify careTeam members. They do not necessarily indicate any order in which the patient was seen by the careTeam or identify any level of significance of the careTeam to the patient, etc. Client app implementations should not assign any significance to the sequence values | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
73. ExplanationOfBenefit.careTeam.provider | |||||
Definition | Member of the team who provided the product or service. | ||||
Control | 1..1 | ||||
Type | Reference(C4BBOrganizationC4BBPractitioner)) | ||||
Must Support | true | ||||
Must Support Types | No must-support rules about the choice of types/profiles | ||||
Requirements | Often a regulatory requirement to specify the responsible provider. | ||||
Comments | The identifier assigned to the care team. (varies depending on the profile) | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
74. ExplanationOfBenefit.careTeam.responsible | |||||
Definition | The party who is billing and/or responsible for the claimed products or services. | ||||
Control | 0..1 | ||||
Type | boolean | ||||
Requirements | When multiple parties are present it is required to distinguish the lead or responsible individual. | ||||
Comments | Responsible might not be required when there is only a single provider listed. | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
75. ExplanationOfBenefit.careTeam.role | |||||
Definition | The lead, assisting or supervising practitioner and their discipline if a multidisciplinary team. | ||||
Control | 1..1 | ||||
Binding | The codes SHALL be taken from C4BB Claim Pharmacy CareTeam Role Value Set | ||||
Type | CodeableConcept | ||||
Must Support | true | ||||
Requirements | When multiple parties are present it is required to distinguish the roles performed by each member. | ||||
Comments | The functional role of a provider on a claim. (165) | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
76. ExplanationOfBenefit.careTeam.qualification | |||||
Definition | The qualification of the practitioner which is applicable for this service. | ||||
Control | 0..1 | ||||
Binding | For example codes, see ExampleProviderQualificationCodes Provider professional qualifications | ||||
Type | CodeableConcept | ||||
Requirements | Need to specify which qualification a provider is delivering the product or service under. | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
77. ExplanationOfBenefit.supportingInfo | |||||
Definition | Additional information codes regarding exceptions, special considerations, the condition, situation, prior or concurrent issues. | ||||
Control | 4..* | ||||
Type | BackboneElement | ||||
Must Support | true | ||||
Requirements | Typically these information codes are required to support the services rendered or the adjudication of the services rendered. | ||||
Comments | Defines data elements not available in the base EOB resource | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
Slicing | This element introduces a set of slices on ExplanationOfBenefit.supportingInfo. The slices are unordered and Open, and can be differentiated using the following discriminators:
| ||||
78. ExplanationOfBenefit.supportingInfo.id | |||||
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||||
Control | 0..1 | ||||
Type | string | ||||
XML Representation | In the XML format, this property is represented as an attribute. | ||||
79. ExplanationOfBenefit.supportingInfo.extension | |||||
Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | ||||
Control | 0..* | ||||
Type | Extension | ||||
Alternate Names | extensionsuser content | ||||
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists()) | ||||
80. ExplanationOfBenefit.supportingInfo.modifierExtension | |||||
Definition | May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). | ||||
Control | 0..* | ||||
Type | Extension | ||||
Is Modifier | 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 | extensionsuser contentmodifiers | ||||
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. | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists()) | ||||
81. ExplanationOfBenefit.supportingInfo.sequence | |||||
Definition | A number to uniquely identify supporting information entries. | ||||
Control | 1..1 | ||||
Type | positiveInt | ||||
Requirements | Necessary to maintain the order of the supporting information items and provide a mechanism to link to claim details. | ||||
Comments | Client app implementations should look-up supportingInfo elements based on category values instead of sequence values | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
82. ExplanationOfBenefit.supportingInfo.category | |||||
Definition | The general class of the information supplied: information; exception; accident, employment; onset, etc. | ||||
Control | 1..1 | ||||
Binding | The codes SHALL be taken from C4BB SupportingInfo Type Value Set; other codes may be used where these codes are not suitable | ||||
Type | CodeableConcept | ||||
Requirements | Required to group or associate information items with common characteristics. For example: admission information or prior treatments. | ||||
Comments | This may contain a category for the local bill type codes. | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
83. ExplanationOfBenefit.supportingInfo.code | |||||
Definition | System and code pertaining to the specific information regarding special conditions relating to the setting, treatment or patient for which care is sought. | ||||
Control | 0..1 | ||||
Binding | For example codes, see ExceptionCodes The valuset used for additional information codes | ||||
Type | CodeableConcept | ||||
Requirements | Required to identify the kind of additional information. | ||||
Comments | This may contain the local bill type codes such as the US UB-04 bill type code. | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
84. ExplanationOfBenefit.supportingInfo.timing[x] | |||||
Definition | The date when or period to which this information refers. | ||||
Control | 0..1 | ||||
Type | Choice of: date, Period | ||||
[x] Note | See Choice of Data Types for further information about how to use [x] | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
85. ExplanationOfBenefit.supportingInfo.value[x] | |||||
Definition | Additional data or information such as resources, documents, images etc. including references to the data or the actual inclusion of the data. | ||||
Control | 0..1 | ||||
Type | Choice of: boolean, string, Quantity, Attachment, Reference(Resource)) | ||||
[x] Note | See Choice of Data Types for further information about how to use [x] | ||||
Requirements | To convey the data content to be provided when the information is more than a simple code or period. | ||||
Comments | Could be used to provide references to other resources, document. For example, could contain a PDF in an Attachment of the Police Report for an Accident. | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
86. ExplanationOfBenefit.supportingInfo.reason | |||||
Definition | Provides the reason in the situation where a reason code is required in addition to the content. | ||||
Control | 0..1 | ||||
Binding | For example codes, see MissingToothReasonCodes Reason codes for the missing teeth | ||||
Type | Coding | ||||
Requirements | Needed when the supporting information has both a date and amount/value and requires explanation. | ||||
Comments | For example: the reason for the additional stay, or why a tooth is missing. | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
87. ExplanationOfBenefit.supportingInfo:dayssupply | |||||
SliceName | dayssupply | ||||
Definition | Additional information codes regarding exceptions, special considerations, the condition, situation, prior or concurrent issues. | ||||
Control | 1..1 | ||||
Type | BackboneElement | ||||
Must Support | true | ||||
Requirements | Typically these information codes are required to support the services rendered or the adjudication of the services rendered. | ||||
Comments | Number of days supply of medication dispensed by the pharmacy (77) | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
88. ExplanationOfBenefit.supportingInfo:dayssupply.id | |||||
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||||
Control | 0..1 | ||||
Type | string | ||||
XML Representation | In the XML format, this property is represented as an attribute. | ||||
89. ExplanationOfBenefit.supportingInfo:dayssupply.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. | ||||
Control | 0..* | ||||
Type | Extension | ||||
Alternate Names | extensionsuser content | ||||
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists()) | ||||
90. ExplanationOfBenefit.supportingInfo:dayssupply.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). | ||||
Control | 0..* | ||||
Type | Extension | ||||
Is Modifier | 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 | extensionsuser contentmodifiers | ||||
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. | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists()) | ||||
91. ExplanationOfBenefit.supportingInfo:dayssupply.sequence | |||||
Definition | A number to uniquely identify supporting information entries. | ||||
Control | 1..1 | ||||
Type | positiveInt | ||||
Requirements | Necessary to maintain the order of the supporting information items and provide a mechanism to link to claim details. | ||||
Comments | Client app implementations should look-up supportingInfo elements based on category values instead of sequence values | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
92. ExplanationOfBenefit.supportingInfo:dayssupply.category | |||||
Definition | The general class of the information supplied: information; exception; accident, employment; onset, etc. | ||||
Control | 1..1 | ||||
Binding | The codes SHALL be taken from C4BB SupportingInfo Type Value Set; other codes may be used where these codes are not suitable | ||||
Type | CodeableConcept | ||||
Must Support | true | ||||
Requirements | Required to group or associate information items with common characteristics. For example: admission information or prior treatments. | ||||
Comments | This may contain a category for the local bill type codes. | ||||
Pattern Value | <valueCodeableConcept xmlns="http://hl7.org/fhir"> <coding> <system value="http://hl7.org/fhir/us/carin-bb/CodeSystem/C4BBSupportingInfoType"/> <code value="dayssupply"/> </coding> </valueCodeableConcept> | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
93. ExplanationOfBenefit.supportingInfo:dayssupply.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. | ||||
Control | 0..1 | ||||
Binding | For example codes, see ExceptionCodes The valuset used for additional information codes | ||||
Type | CodeableConcept | ||||
Requirements | Required to identify the kind of additional information. | ||||
Comments | This may contain the local bill type codes such as the US UB-04 bill type code. | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
94. ExplanationOfBenefit.supportingInfo:dayssupply.timing[x] | |||||
Definition | The date when or period to which this information refers. | ||||
Control | 0..1 | ||||
Type | Choice of: date, Period | ||||
[x] Note | See Choice of Data Types for further information about how to use [x] | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
95. ExplanationOfBenefit.supportingInfo:dayssupply.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. | ||||
Control | 1..1 | ||||
Type | Quantity | ||||
[x] Note | See Choice of Data Types for further information about how to use [x] | ||||
Must Support | true | ||||
Requirements | To convey the data content to be provided when the information is more than a simple code or period. | ||||
Comments | Could be used to provide references to other resources, document. For example, could contain a PDF in an Attachment of the Police Report for an Accident. | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
96. ExplanationOfBenefit.supportingInfo:dayssupply.reason | |||||
Definition | Provides the reason in the situation where a reason code is required in addition to the content. | ||||
Control | 0..1 | ||||
Binding | For example codes, see MissingToothReasonCodes Reason codes for the missing teeth | ||||
Type | Coding | ||||
Requirements | Needed when the supporting information has both a date and amount/value and requires explanation. | ||||
Comments | For example: the reason for the additional stay, or why a tooth is missing. | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
97. ExplanationOfBenefit.supportingInfo:dawcode | |||||
SliceName | dawcode | ||||
Definition | Additional information codes regarding exceptions, special considerations, the condition, situation, prior or concurrent issues. | ||||
Control | 1..1 | ||||
Type | BackboneElement | ||||
Must Support | true | ||||
Requirements | Typically these information codes are required to support the services rendered or the adjudication of the services rendered. | ||||
Comments | Prescriber's instruction regarding substitution of generic equivalents or order to dispense the specific prescribed medication (79) | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
98. ExplanationOfBenefit.supportingInfo:dawcode.id | |||||
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||||
Control | 0..1 | ||||
Type | string | ||||
XML Representation | In the XML format, this property is represented as an attribute. | ||||
99. ExplanationOfBenefit.supportingInfo:dawcode.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. | ||||
Control | 0..* | ||||
Type | Extension | ||||
Alternate Names | extensionsuser content | ||||
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists()) | ||||
100. ExplanationOfBenefit.supportingInfo:dawcode.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). | ||||
Control | 0..* | ||||
Type | Extension | ||||
Is Modifier | 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 | extensionsuser contentmodifiers | ||||
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. | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists()) | ||||
101. ExplanationOfBenefit.supportingInfo:dawcode.sequence | |||||
Definition | A number to uniquely identify supporting information entries. | ||||
Control | 1..1 | ||||
Type | positiveInt | ||||
Requirements | Necessary to maintain the order of the supporting information items and provide a mechanism to link to claim details. | ||||
Comments | Client app implementations should look-up supportingInfo elements based on category values instead of sequence values | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
102. ExplanationOfBenefit.supportingInfo:dawcode.category | |||||
Definition | The general class of the information supplied: information; exception; accident, employment; onset, etc. | ||||
Control | 1..1 | ||||
Binding | The codes SHALL be taken from C4BB SupportingInfo Type Value Set; other codes may be used where these codes are not suitable | ||||
Type | CodeableConcept | ||||
Must Support | true | ||||
Requirements | Required to group or associate information items with common characteristics. For example: admission information or prior treatments. | ||||
Comments | This may contain a category for the local bill type codes. | ||||
Pattern Value | <valueCodeableConcept xmlns="http://hl7.org/fhir"> <coding> <system value="http://hl7.org/fhir/us/carin-bb/CodeSystem/C4BBSupportingInfoType"/> <code value="dawcode"/> </coding> </valueCodeableConcept> | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
103. ExplanationOfBenefit.supportingInfo:dawcode.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. | ||||
Control | 1..1 | ||||
Binding | The codes SHALL be taken from NCPDP Dispense As Written (DAW)/Product Selection Code Value Set | ||||
Type | CodeableConcept | ||||
Must Support | true | ||||
Requirements | Required to identify the kind of additional information. | ||||
Comments | This may contain the local bill type codes such as the US UB-04 bill type code. | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
104. ExplanationOfBenefit.supportingInfo:dawcode.timing[x] | |||||
Definition | The date when or period to which this information refers. | ||||
Control | 0..1 | ||||
Type | Choice of: date, Period | ||||
[x] Note | See Choice of Data Types for further information about how to use [x] | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
105. ExplanationOfBenefit.supportingInfo:dawcode.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. | ||||
Control | 0..1 | ||||
Type | Choice of: boolean, string, Quantity, Attachment, Reference(Resource)) | ||||
[x] Note | See Choice of Data Types for further information about how to use [x] | ||||
Requirements | To convey the data content to be provided when the information is more than a simple code or period. | ||||
Comments | Could be used to provide references to other resources, document. For example, could contain a PDF in an Attachment of the Police Report for an Accident. | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
106. ExplanationOfBenefit.supportingInfo:dawcode.reason | |||||
Definition | Provides the reason in the situation where a reason code is required in addition to the content. | ||||
Control | 0..1 | ||||
Binding | For example codes, see MissingToothReasonCodes Reason codes for the missing teeth | ||||
Type | Coding | ||||
Requirements | Needed when the supporting information has both a date and amount/value and requires explanation. | ||||
Comments | For example: the reason for the additional stay, or why a tooth is missing. | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
107. ExplanationOfBenefit.supportingInfo:refillNum | |||||
SliceName | refillNum | ||||
Definition | Additional information codes regarding exceptions, special considerations, the condition, situation, prior or concurrent issues. | ||||
Control | 1..1 | ||||
Type | BackboneElement | ||||
Must Support | true | ||||
Requirements | Typically these information codes are required to support the services rendered or the adjudication of the services rendered. | ||||
Comments | The number fill of the current dispensed supply (0, 1, 2, etc.) (137) | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
108. ExplanationOfBenefit.supportingInfo:refillNum.id | |||||
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||||
Control | 0..1 | ||||
Type | string | ||||
XML Representation | In the XML format, this property is represented as an attribute. | ||||
109. ExplanationOfBenefit.supportingInfo:refillNum.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. | ||||
Control | 0..* | ||||
Type | Extension | ||||
Alternate Names | extensionsuser content | ||||
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists()) | ||||
110. ExplanationOfBenefit.supportingInfo:refillNum.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). | ||||
Control | 0..* | ||||
Type | Extension | ||||
Is Modifier | 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 | extensionsuser contentmodifiers | ||||
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. | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists()) | ||||
111. ExplanationOfBenefit.supportingInfo:refillNum.sequence | |||||
Definition | A number to uniquely identify supporting information entries. | ||||
Control | 1..1 | ||||
Type | positiveInt | ||||
Requirements | Necessary to maintain the order of the supporting information items and provide a mechanism to link to claim details. | ||||
Comments | Client app implementations should look-up supportingInfo elements based on category values instead of sequence values | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
112. ExplanationOfBenefit.supportingInfo:refillNum.category | |||||
Definition | The general class of the information supplied: information; exception; accident, employment; onset, etc. | ||||
Control | 1..1 | ||||
Binding | The codes SHALL be taken from C4BB SupportingInfo Type Value Set; other codes may be used where these codes are not suitable | ||||
Type | CodeableConcept | ||||
Must Support | true | ||||
Requirements | Required to group or associate information items with common characteristics. For example: admission information or prior treatments. | ||||
Comments | This may contain a category for the local bill type codes. | ||||
Pattern Value | <valueCodeableConcept xmlns="http://hl7.org/fhir"> <coding> <system value="http://hl7.org/fhir/us/carin-bb/CodeSystem/C4BBSupportingInfoType"/> <code value="refillnum"/> </coding> </valueCodeableConcept> | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
113. ExplanationOfBenefit.supportingInfo:refillNum.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. | ||||
Control | 0..1 | ||||
Binding | For example codes, see ExceptionCodes The valuset used for additional information codes | ||||
Type | CodeableConcept | ||||
Requirements | Required to identify the kind of additional information. | ||||
Comments | This may contain the local bill type codes such as the US UB-04 bill type code. | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
114. ExplanationOfBenefit.supportingInfo:refillNum.timing[x] | |||||
Definition | The date when or period to which this information refers. | ||||
Control | 0..1 | ||||
Type | Choice of: date, Period | ||||
[x] Note | See Choice of Data Types for further information about how to use [x] | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
115. ExplanationOfBenefit.supportingInfo:refillNum.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. | ||||
Control | 1..1 | ||||
Type | Quantity | ||||
[x] Note | See Choice of Data Types for further information about how to use [x] | ||||
Must Support | true | ||||
Requirements | To convey the data content to be provided when the information is more than a simple code or period. | ||||
Comments | Could be used to provide references to other resources, document. For example, could contain a PDF in an Attachment of the Police Report for an Accident. | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
116. ExplanationOfBenefit.supportingInfo:refillNum.reason | |||||
Definition | Provides the reason in the situation where a reason code is required in addition to the content. | ||||
Control | 0..1 | ||||
Binding | For example codes, see MissingToothReasonCodes Reason codes for the missing teeth | ||||
Type | Coding | ||||
Requirements | Needed when the supporting information has both a date and amount/value and requires explanation. | ||||
Comments | For example: the reason for the additional stay, or why a tooth is missing. | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
117. ExplanationOfBenefit.supportingInfo:refillsAuthorized | |||||
SliceName | refillsAuthorized | ||||
Definition | Additional information codes regarding exceptions, special considerations, the condition, situation, prior or concurrent issues. | ||||
Control | 1..1 | ||||
Type | BackboneElement | ||||
Must Support | true | ||||
Requirements | Typically these information codes are required to support the services rendered or the adjudication of the services rendered. | ||||
Comments | Defines data elements not available in the base EOB resource | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
118. ExplanationOfBenefit.supportingInfo:refillsAuthorized.id | |||||
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||||
Control | 0..1 | ||||
Type | string | ||||
XML Representation | In the XML format, this property is represented as an attribute. | ||||
119. ExplanationOfBenefit.supportingInfo:refillsAuthorized.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. | ||||
Control | 0..* | ||||
Type | Extension | ||||
Alternate Names | extensionsuser content | ||||
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists()) | ||||
120. ExplanationOfBenefit.supportingInfo:refillsAuthorized.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). | ||||
Control | 0..* | ||||
Type | Extension | ||||
Is Modifier | 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 | extensionsuser contentmodifiers | ||||
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. | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists()) | ||||
121. ExplanationOfBenefit.supportingInfo:refillsAuthorized.sequence | |||||
Definition | A number to uniquely identify supporting information entries. | ||||
Control | 1..1 | ||||
Type | positiveInt | ||||
Requirements | Necessary to maintain the order of the supporting information items and provide a mechanism to link to claim details. | ||||
Comments | Client app implementations should look-up supportingInfo elements based on category values instead of sequence values | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
122. ExplanationOfBenefit.supportingInfo:refillsAuthorized.category | |||||
Definition | The general class of the information supplied: information; exception; accident, employment; onset, etc. | ||||
Control | 1..1 | ||||
Binding | The codes SHALL be taken from C4BB SupportingInfo Type Value Set; other codes may be used where these codes are not suitable | ||||
Type | CodeableConcept | ||||
Must Support | true | ||||
Requirements | Required to group or associate information items with common characteristics. For example: admission information or prior treatments. | ||||
Comments | This may contain a category for the local bill type codes. | ||||
Pattern Value | <valueCodeableConcept xmlns="http://hl7.org/fhir"> <coding> <system value="http://hl7.org/fhir/us/carin-bb/CodeSystem/C4BBSupportingInfoType"/> <code value="refillsauthorized"/> </coding> </valueCodeableConcept> | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
123. ExplanationOfBenefit.supportingInfo:refillsAuthorized.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. | ||||
Control | 0..1 | ||||
Binding | For example codes, see ExceptionCodes The valuset used for additional information codes | ||||
Type | CodeableConcept | ||||
Requirements | Required to identify the kind of additional information. | ||||
Comments | This may contain the local bill type codes such as the US UB-04 bill type code. | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
124. ExplanationOfBenefit.supportingInfo:refillsAuthorized.timing[x] | |||||
Definition | The date when or period to which this information refers. | ||||
Control | 0..1 | ||||
Type | Choice of: date, Period | ||||
[x] Note | See Choice of Data Types for further information about how to use [x] | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
125. ExplanationOfBenefit.supportingInfo:refillsAuthorized.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. | ||||
Control | 1..1 | ||||
Type | Quantity | ||||
[x] Note | See Choice of Data Types for further information about how to use [x] | ||||
Must Support | true | ||||
Requirements | To convey the data content to be provided when the information is more than a simple code or period. | ||||
Comments | Could be used to provide references to other resources, document. For example, could contain a PDF in an Attachment of the Police Report for an Accident. | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
126. ExplanationOfBenefit.supportingInfo:refillsAuthorized.reason | |||||
Definition | Provides the reason in the situation where a reason code is required in addition to the content. | ||||
Control | 0..1 | ||||
Binding | For example codes, see MissingToothReasonCodes Reason codes for the missing teeth | ||||
Type | Coding | ||||
Requirements | Needed when the supporting information has both a date and amount/value and requires explanation. | ||||
Comments | For example: the reason for the additional stay, or why a tooth is missing. | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
127. ExplanationOfBenefit.supportingInfo:brandgenericindicator | |||||
SliceName | brandgenericindicator | ||||
Definition | Additional information codes regarding exceptions, special considerations, the condition, situation, prior or concurrent issues. | ||||
Control | 0..1 | ||||
Type | BackboneElement | ||||
Must Support | true | ||||
Requirements | Typically these information codes are required to support the services rendered or the adjudication of the services rendered. | ||||
Comments | Whether the plan adjudicated the claim as a brand or generic drug (144) | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
128. ExplanationOfBenefit.supportingInfo:brandgenericindicator.id | |||||
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||||
Control | 0..1 | ||||
Type | string | ||||
XML Representation | In the XML format, this property is represented as an attribute. | ||||
129. ExplanationOfBenefit.supportingInfo:brandgenericindicator.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. | ||||
Control | 0..* | ||||
Type | Extension | ||||
Alternate Names | extensionsuser content | ||||
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists()) | ||||
130. ExplanationOfBenefit.supportingInfo:brandgenericindicator.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). | ||||
Control | 0..* | ||||
Type | Extension | ||||
Is Modifier | 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 | extensionsuser contentmodifiers | ||||
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. | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists()) | ||||
131. ExplanationOfBenefit.supportingInfo:brandgenericindicator.sequence | |||||
Definition | A number to uniquely identify supporting information entries. | ||||
Control | 1..1 | ||||
Type | positiveInt | ||||
Requirements | Necessary to maintain the order of the supporting information items and provide a mechanism to link to claim details. | ||||
Comments | Client app implementations should look-up supportingInfo elements based on category values instead of sequence values | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
132. ExplanationOfBenefit.supportingInfo:brandgenericindicator.category | |||||
Definition | The general class of the information supplied: information; exception; accident, employment; onset, etc. | ||||
Control | 1..1 | ||||
Binding | The codes SHALL be taken from C4BB SupportingInfo Type Value Set; other codes may be used where these codes are not suitable | ||||
Type | CodeableConcept | ||||
Must Support | true | ||||
Requirements | Required to group or associate information items with common characteristics. For example: admission information or prior treatments. | ||||
Comments | This may contain a category for the local bill type codes. | ||||
Pattern Value | <valueCodeableConcept xmlns="http://hl7.org/fhir"> <coding> <system value="http://hl7.org/fhir/us/carin-bb/CodeSystem/C4BBSupportingInfoType"/> <code value="brandgenericindicator"/> </coding> </valueCodeableConcept> | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
133. ExplanationOfBenefit.supportingInfo:brandgenericindicator.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. | ||||
Control | 1..1 | ||||
Binding | The codes SHALL be taken from NCPDP Brand Generic Indicator Value Set | ||||
Type | CodeableConcept | ||||
Must Support | true | ||||
Requirements | Required to identify the kind of additional information. | ||||
Comments | This may contain the local bill type codes such as the US UB-04 bill type code. | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
134. ExplanationOfBenefit.supportingInfo:brandgenericindicator.timing[x] | |||||
Definition | The date when or period to which this information refers. | ||||
Control | 0..1 | ||||
Type | Choice of: date, Period | ||||
[x] Note | See Choice of Data Types for further information about how to use [x] | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
135. ExplanationOfBenefit.supportingInfo:brandgenericindicator.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. | ||||
Control | 0..1 | ||||
Type | Choice of: boolean, string, Quantity, Attachment, Reference(Resource)) | ||||
[x] Note | See Choice of Data Types for further information about how to use [x] | ||||
Requirements | To convey the data content to be provided when the information is more than a simple code or period. | ||||
Comments | Could be used to provide references to other resources, document. For example, could contain a PDF in an Attachment of the Police Report for an Accident. | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
136. ExplanationOfBenefit.supportingInfo:brandgenericindicator.reason | |||||
Definition | Provides the reason in the situation where a reason code is required in addition to the content. | ||||
Control | 0..1 | ||||
Binding | For example codes, see MissingToothReasonCodes Reason codes for the missing teeth | ||||
Type | Coding | ||||
Requirements | Needed when the supporting information has both a date and amount/value and requires explanation. | ||||
Comments | For example: the reason for the additional stay, or why a tooth is missing. | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
137. ExplanationOfBenefit.supportingInfo:rxoriginCode | |||||
SliceName | rxoriginCode | ||||
Definition | Additional information codes regarding exceptions, special considerations, the condition, situation, prior or concurrent issues. | ||||
Control | 0..1 | ||||
Type | BackboneElement | ||||
Must Support | true | ||||
Requirements | Typically these information codes are required to support the services rendered or the adjudication of the services rendered. | ||||
Comments | Whether the prescription was transmitted as an electronic prescription, by phone, by fax, or as a written paper copy (143) | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
138. ExplanationOfBenefit.supportingInfo:rxoriginCode.id | |||||
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||||
Control | 0..1 | ||||
Type | string | ||||
XML Representation | In the XML format, this property is represented as an attribute. | ||||
139. ExplanationOfBenefit.supportingInfo:rxoriginCode.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. | ||||
Control | 0..* | ||||
Type | Extension | ||||
Alternate Names | extensionsuser content | ||||
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists()) | ||||
140. ExplanationOfBenefit.supportingInfo:rxoriginCode.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). | ||||
Control | 0..* | ||||
Type | Extension | ||||
Is Modifier | 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 | extensionsuser contentmodifiers | ||||
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. | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists()) | ||||
141. ExplanationOfBenefit.supportingInfo:rxoriginCode.sequence | |||||
Definition | A number to uniquely identify supporting information entries. | ||||
Control | 1..1 | ||||
Type | positiveInt | ||||
Requirements | Necessary to maintain the order of the supporting information items and provide a mechanism to link to claim details. | ||||
Comments | Client app implementations should look-up supportingInfo elements based on category values instead of sequence values | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
142. ExplanationOfBenefit.supportingInfo:rxoriginCode.category | |||||
Definition | The general class of the information supplied: information; exception; accident, employment; onset, etc. | ||||
Control | 1..1 | ||||
Binding | The codes SHALL be taken from C4BB SupportingInfo Type Value Set; other codes may be used where these codes are not suitable | ||||
Type | CodeableConcept | ||||
Must Support | true | ||||
Requirements | Required to group or associate information items with common characteristics. For example: admission information or prior treatments. | ||||
Comments | This may contain a category for the local bill type codes. | ||||
Pattern Value | <valueCodeableConcept xmlns="http://hl7.org/fhir"> <coding> <system value="http://hl7.org/fhir/us/carin-bb/CodeSystem/C4BBSupportingInfoType"/> <code value="rxorigincode"/> </coding> </valueCodeableConcept> | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
143. ExplanationOfBenefit.supportingInfo:rxoriginCode.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. | ||||
Control | 1..1 | ||||
Binding | The codes SHALL be taken from NCPDP Prescription Origin Code Value Set | ||||
Type | CodeableConcept | ||||
Must Support | true | ||||
Requirements | Required to identify the kind of additional information. | ||||
Comments | This may contain the local bill type codes such as the US UB-04 bill type code. | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
144. ExplanationOfBenefit.supportingInfo:rxoriginCode.timing[x] | |||||
Definition | The date when or period to which this information refers. | ||||
Control | 0..1 | ||||
Type | Choice of: date, Period | ||||
[x] Note | See Choice of Data Types for further information about how to use [x] | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
145. ExplanationOfBenefit.supportingInfo:rxoriginCode.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. | ||||
Control | 0..1 | ||||
Type | Choice of: boolean, string, Quantity, Attachment, Reference(Resource)) | ||||
[x] Note | See Choice of Data Types for further information about how to use [x] | ||||
Requirements | To convey the data content to be provided when the information is more than a simple code or period. | ||||
Comments | Could be used to provide references to other resources, document. For example, could contain a PDF in an Attachment of the Police Report for an Accident. | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
146. ExplanationOfBenefit.supportingInfo:rxoriginCode.reason | |||||
Definition | Provides the reason in the situation where a reason code is required in addition to the content. | ||||
Control | 0..1 | ||||
Binding | For example codes, see MissingToothReasonCodes Reason codes for the missing teeth | ||||
Type | Coding | ||||
Requirements | Needed when the supporting information has both a date and amount/value and requires explanation. | ||||
Comments | For example: the reason for the additional stay, or why a tooth is missing. | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
147. ExplanationOfBenefit.supportingInfo:clmrecvddate | |||||
SliceName | clmrecvddate | ||||
Definition | Additional information codes regarding exceptions, special considerations, the condition, situation, prior or concurrent issues. | ||||
Control | 0..1 | ||||
Type | BackboneElement | ||||
Must Support | true | ||||
Requirements | Typically these information codes are required to support the services rendered or the adjudication of the services rendered. | ||||
Comments | The date the claim was received by the payer (88) | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
148. ExplanationOfBenefit.supportingInfo:clmrecvddate.id | |||||
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||||
Control | 0..1 | ||||
Type | string | ||||
XML Representation | In the XML format, this property is represented as an attribute. | ||||
149. ExplanationOfBenefit.supportingInfo:clmrecvddate.extension | |||||
Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | ||||
Control | 0..* | ||||
Type | Extension | ||||
Alternate Names | extensionsuser content | ||||
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists()) | ||||
150. ExplanationOfBenefit.supportingInfo:clmrecvddate.modifierExtension | |||||
Definition | May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). | ||||
Control | 0..* | ||||
Type | Extension | ||||
Is Modifier | 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 | extensionsuser contentmodifiers | ||||
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. | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists()) | ||||
151. ExplanationOfBenefit.supportingInfo:clmrecvddate.sequence | |||||
Definition | A number to uniquely identify supporting information entries. | ||||
Control | 1..1 | ||||
Type | positiveInt | ||||
Requirements | Necessary to maintain the order of the supporting information items and provide a mechanism to link to claim details. | ||||
Comments | Client app implementations should look-up supportingInfo elements based on category values instead of sequence values | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
152. ExplanationOfBenefit.supportingInfo:clmrecvddate.category | |||||
Definition | The general class of the information supplied: information; exception; accident, employment; onset, etc. | ||||
Control | 1..1 | ||||
Binding | The codes SHALL be taken from C4BB SupportingInfo Type Value Set; other codes may be used where these codes are not suitable | ||||
Type | CodeableConcept | ||||
Must Support | true | ||||
Requirements | Required to group or associate information items with common characteristics. For example: admission information or prior treatments. | ||||
Comments | This may contain a category for the local bill type codes. | ||||
Pattern Value | <valueCodeableConcept xmlns="http://hl7.org/fhir"> <coding> <system value="http://hl7.org/fhir/us/carin-bb/CodeSystem/C4BBSupportingInfoType"/> <code value="clmrecvddate"/> </coding> </valueCodeableConcept> | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
153. ExplanationOfBenefit.supportingInfo:clmrecvddate.code | |||||
Definition | System and code pertaining to the specific information regarding special conditions relating to the setting, treatment or patient for which care is sought. | ||||
Control | 0..1 | ||||
Binding | For example codes, see ExceptionCodes The valuset used for additional information codes | ||||
Type | CodeableConcept | ||||
Requirements | Required to identify the kind of additional information. | ||||
Comments | This may contain the local bill type codes such as the US UB-04 bill type code. | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
154. ExplanationOfBenefit.supportingInfo:clmrecvddate.timing[x] | |||||
Definition | The date when or period to which this information refers. | ||||
Control | 1..1 | ||||
Type | date | ||||
[x] Note | See Choice of Data Types for further information about how to use [x] | ||||
Must Support | true | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
155. ExplanationOfBenefit.supportingInfo:clmrecvddate.value[x] | |||||
Definition | Additional data or information such as resources, documents, images etc. including references to the data or the actual inclusion of the data. | ||||
Control | 0..1 | ||||
Type | Choice of: boolean, string, Quantity, Attachment, Reference(Resource)) | ||||
[x] Note | See Choice of Data Types for further information about how to use [x] | ||||
Requirements | To convey the data content to be provided when the information is more than a simple code or period. | ||||
Comments | Could be used to provide references to other resources, document. For example, could contain a PDF in an Attachment of the Police Report for an Accident. | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
156. ExplanationOfBenefit.supportingInfo:clmrecvddate.reason | |||||
Definition | Provides the reason in the situation where a reason code is required in addition to the content. | ||||
Control | 0..1 | ||||
Binding | For example codes, see MissingToothReasonCodes Reason codes for the missing teeth | ||||
Type | Coding | ||||
Requirements | Needed when the supporting information has both a date and amount/value and requires explanation. | ||||
Comments | For example: the reason for the additional stay, or why a tooth is missing. | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
157. ExplanationOfBenefit.supportingInfo:compoundcode | |||||
SliceName | compoundcode | ||||
Definition | Additional information codes regarding exceptions, special considerations, the condition, situation, prior or concurrent issues. | ||||
Control | 0..1 | ||||
Type | BackboneElement | ||||
Must Support | true | ||||
Requirements | Typically these information codes are required to support the services rendered or the adjudication of the services rendered. | ||||
Comments | The code indicating whether or not the prescription is a compound. NCPDP field # 406-D6 (78) | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
158. ExplanationOfBenefit.supportingInfo:compoundcode.id | |||||
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||||
Control | 0..1 | ||||
Type | string | ||||
XML Representation | In the XML format, this property is represented as an attribute. | ||||
159. ExplanationOfBenefit.supportingInfo:compoundcode.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. | ||||
Control | 0..* | ||||
Type | Extension | ||||
Alternate Names | extensionsuser content | ||||
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists()) | ||||
160. ExplanationOfBenefit.supportingInfo:compoundcode.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). | ||||
Control | 0..* | ||||
Type | Extension | ||||
Is Modifier | 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 | extensionsuser contentmodifiers | ||||
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. | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists()) | ||||
161. ExplanationOfBenefit.supportingInfo:compoundcode.sequence | |||||
Definition | A number to uniquely identify supporting information entries. | ||||
Control | 1..1 | ||||
Type | positiveInt | ||||
Requirements | Necessary to maintain the order of the supporting information items and provide a mechanism to link to claim details. | ||||
Comments | Client app implementations should look-up supportingInfo elements based on category values instead of sequence values | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
162. ExplanationOfBenefit.supportingInfo:compoundcode.category | |||||
Definition | The general class of the information supplied: information; exception; accident, employment; onset, etc. | ||||
Control | 1..1 | ||||
Binding | The codes SHALL be taken from C4BB SupportingInfo Type Value Set; other codes may be used where these codes are not suitable | ||||
Type | CodeableConcept | ||||
Must Support | true | ||||
Requirements | Required to group or associate information items with common characteristics. For example: admission information or prior treatments. | ||||
Comments | This may contain a category for the local bill type codes. | ||||
Pattern Value | <valueCodeableConcept xmlns="http://hl7.org/fhir"> <coding> <system value="http://hl7.org/fhir/us/carin-bb/CodeSystem/C4BBSupportingInfoType"/> <code value="compoundcode"/> </coding> </valueCodeableConcept> | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
163. ExplanationOfBenefit.supportingInfo:compoundcode.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. | ||||
Control | 1..1 | ||||
Binding | The codes SHALL be taken from NCPDP Compound Code Value Set | ||||
Type | CodeableConcept | ||||
Must Support | true | ||||
Requirements | Required to identify the kind of additional information. | ||||
Comments | This may contain the local bill type codes such as the US UB-04 bill type code. | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
164. ExplanationOfBenefit.supportingInfo:compoundcode.timing[x] | |||||
Definition | The date when or period to which this information refers. | ||||
Control | 0..1 | ||||
Type | Choice of: date, Period | ||||
[x] Note | See Choice of Data Types for further information about how to use [x] | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
165. ExplanationOfBenefit.supportingInfo:compoundcode.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. | ||||
Control | 0..1 | ||||
Type | Choice of: boolean, string, Quantity, Attachment, Reference(Resource)) | ||||
[x] Note | See Choice of Data Types for further information about how to use [x] | ||||
Requirements | To convey the data content to be provided when the information is more than a simple code or period. | ||||
Comments | Could be used to provide references to other resources, document. For example, could contain a PDF in an Attachment of the Police Report for an Accident. | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
166. ExplanationOfBenefit.supportingInfo:compoundcode.reason | |||||
Definition | Provides the reason in the situation where a reason code is required in addition to the content. | ||||
Control | 0..1 | ||||
Binding | For example codes, see MissingToothReasonCodes Reason codes for the missing teeth | ||||
Type | Coding | ||||
Requirements | Needed when the supporting information has both a date and amount/value and requires explanation. | ||||
Comments | For example: the reason for the additional stay, or why a tooth is missing. | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
167. ExplanationOfBenefit.diagnosis | |||||
Definition | Information about diagnoses relevant to the claim items. | ||||
Control | 0..* | ||||
Type | BackboneElement | ||||
Requirements | Required for the adjudication by provided context for the services and product listed. | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
168. 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. | ||||
Control | 0..1 | ||||
Type | string | ||||
XML Representation | In the XML format, this property is represented as an attribute. | ||||
169. 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. | ||||
Control | 0..* | ||||
Type | Extension | ||||
Alternate Names | extensionsuser content | ||||
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists()) | ||||
170. 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). | ||||
Control | 0..* | ||||
Type | Extension | ||||
Is Modifier | 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 | extensionsuser contentmodifiers | ||||
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. | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists()) | ||||
171. ExplanationOfBenefit.diagnosis.sequence | |||||
Definition | A number to uniquely identify diagnosis entries. | ||||
Control | 1..1 | ||||
Type | positiveInt | ||||
Requirements | Necessary to maintain the order of the diagnosis items and provide a mechanism to link to claim details. | ||||
Comments | Diagnosis are presented in list order to their expected importance: primary, secondary, etc. | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
172. ExplanationOfBenefit.diagnosis.diagnosis[x] | |||||
Definition | The nature of illness or problem in a coded form or as a reference to an external defined Condition. | ||||
Control | 1..1 | ||||
Binding | For example codes, see ICD-10Codes ICD10 Diagnostic codes | ||||
Type | Choice of: CodeableConcept, Reference(Condition)) | ||||
[x] Note | See Choice of Data Types for further information about how to use [x] | ||||
Requirements | Provides health context for the evaluation of the products and/or services. | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
173. ExplanationOfBenefit.diagnosis.type | |||||
Definition | When the condition was observed or the relative ranking. | ||||
Control | 0..* | ||||
Binding | For example codes, see ExampleDiagnosisTypeCodes The type of the diagnosis: admitting, principal, discharge | ||||
Type | CodeableConcept | ||||
Requirements | Often required to capture a particular diagnosis, for example: primary or discharge. | ||||
Comments | For example: admitting, primary, secondary, discharge. | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
174. ExplanationOfBenefit.diagnosis.onAdmission | |||||
Definition | Indication of whether the diagnosis was present on admission to a facility. | ||||
Control | 0..1 | ||||
Binding | For example codes, see ExampleDiagnosisOnAdmissionCodes Present on admission | ||||
Type | CodeableConcept | ||||
Requirements | Many systems need to understand for adjudication if the diagnosis was present a time of admission. | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
175. 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. | ||||
Control | 0..1 | ||||
Binding | For example codes, see ExampleDiagnosisRelatedGroupCodes The DRG codes associated with the diagnosis | ||||
Type | CodeableConcept | ||||
Requirements | Required to relate the current diagnosis to a package billing code that is then referenced on the individual claim items which are specific to the health condition covered by the package code. | ||||
Comments | For example, DRG (Diagnosis Related Group) or a bundled billing code. A patient may have a diagnosis of a Myocardio-infarction and a DRG for HeartAttack would assigned. The Claim item (and possible subsequent claims) would refer to the DRG for those line items that were for services related to the heart attack event. | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
176. ExplanationOfBenefit.procedure | |||||
Definition | Procedures performed on the patient relevant to the billing items with the claim. | ||||
Control | 0..* | ||||
Type | BackboneElement | ||||
Requirements | The specific clinical invention are sometimes required to be provided to justify billing a greater than customary amount for a service. | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
177. 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. | ||||
Control | 0..1 | ||||
Type | string | ||||
XML Representation | In the XML format, this property is represented as an attribute. | ||||
178. 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. | ||||
Control | 0..* | ||||
Type | Extension | ||||
Alternate Names | extensionsuser content | ||||
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists()) | ||||
179. 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). | ||||
Control | 0..* | ||||
Type | Extension | ||||
Is Modifier | 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 | extensionsuser contentmodifiers | ||||
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. | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists()) | ||||
180. ExplanationOfBenefit.procedure.sequence | |||||
Definition | A number to uniquely identify procedure entries. | ||||
Control | 1..1 | ||||
Type | positiveInt | ||||
Requirements | Necessary to provide a mechanism to link to claim details. | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
181. ExplanationOfBenefit.procedure.type | |||||
Definition | When the condition was observed or the relative ranking. | ||||
Control | 0..* | ||||
Binding | For example codes, see ExampleProcedureTypeCodes Example procedure type codes | ||||
Type | CodeableConcept | ||||
Requirements | Often required to capture a particular diagnosis, for example: primary or discharge. | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
182. ExplanationOfBenefit.procedure.date | |||||
Definition | Date and optionally time the procedure was performed. | ||||
Control | 0..1 | ||||
Type | dateTime | ||||
Requirements | Required for auditing purposes. | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
183. ExplanationOfBenefit.procedure.procedure[x] | |||||
Definition | The code or reference to a Procedure resource which identifies the clinical intervention performed. | ||||
Control | 1..1 | ||||
Binding | For example codes, see ICD-10ProcedureCodes ICD10 Procedure codes | ||||
Type | Choice of: CodeableConcept, Reference(Procedure)) | ||||
[x] Note | See Choice of Data Types for further information about how to use [x] | ||||
Requirements | This identifies the actual clinical procedure. | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
184. ExplanationOfBenefit.procedure.udi | |||||
Definition | Unique Device Identifiers associated with this line item. | ||||
Control | 0..* | ||||
Type | Reference(Device)) | ||||
Requirements | The UDI code allows the insurer to obtain device level information on the product supplied. | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
185. ExplanationOfBenefit.precedence | |||||
Definition | This indicates the relative order of a series of EOBs related to different coverages for the same suite of services. | ||||
Control | 0..1 | ||||
Type | positiveInt | ||||
Requirements | Needed to coordinate between multiple EOBs for the same suite of services. | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
186. ExplanationOfBenefit.insurance | |||||
Definition | Financial instruments for reimbursement for the health care products and services specified on the claim. | ||||
Control | 1..* | ||||
Type | BackboneElement | ||||
Must Support | true | ||||
Requirements | At least one insurer is required for a claim to be a claim. | ||||
Comments | Identity of the payers responsible for the claim. (2, 141). All insurance coverages for the patient which may be applicable for reimbursement, of the products and services listed in the claim, are typically provided in the claim to allow insurers to confirm the ordering of the insurance coverages relative to local 'coordination of benefit' rules. One coverage (and only one) with 'focal=true' is to be used in the adjudication of this claim. An invariant is defined to enforce the following rule: Will have multiple occurrences on secondary / tertiary, etc. claims. Up to one occurrence, that of the ExplanationOfBenefit.insurer, will have a boolean value = 'True' | ||||
Invariants | Defined on this element EOB-insurance-focal: EOB.insurance: at most one with focal = true (: insurance.select (focal = true).count() < 2) ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
187. 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. | ||||
Control | 0..1 | ||||
Type | string | ||||
XML Representation | In the XML format, this property is represented as an attribute. | ||||
188. 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. | ||||
Control | 0..* | ||||
Type | Extension | ||||
Alternate Names | extensionsuser content | ||||
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists()) | ||||
189. 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). | ||||
Control | 0..* | ||||
Type | Extension | ||||
Is Modifier | 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 | extensionsuser contentmodifiers | ||||
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. | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists()) | ||||
190. ExplanationOfBenefit.insurance.focal | |||||
Definition | A flag to indicate that this Coverage is to be used for adjudication of this claim when set to true. | ||||
Control | 1..1 | ||||
Type | boolean | ||||
Must Support | true | ||||
Requirements | To identify which coverage in the list is being used to adjudicate this claim. | ||||
Comments | A patient may (will) have multiple insurance policies which provide reimbursement for healthcare services and products. For example, a person may also be covered by their spouse's policy and both appear in the list (and may be from the same insurer). This flag will be set to true for only one of the listed policies and that policy will be used for adjudicating this claim. Other claims would be created to request adjudication against the other listed policies. An invariant is defined to enforce the following rule: Will have multiple occurrences on secondary / tertiary, etc. claims. Up to one occurrence, that of the ExplanationOfBenefit.insurer, will have a boolean value = 'True' | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
191. 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. | ||||
Control | 1..1 | ||||
Type | Reference(C4BBCoverage)) | ||||
Must Support | true | ||||
Requirements | Required to allow the adjudicator to locate the correct policy and history within their information system. | ||||
Comments | Same as insurance.coverage.organization. Party responsible for reimbursing the provider. When focal = true, Coverage.payer--> Organization.identifier. When focal = false, EOB.insurance.coverage.display = [name of other carrier] | ||||
Invariants | Defined on this element 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. | ||||
Control | 0..* | ||||
Type | string | ||||
Requirements | Providers must quote previously issued authorization reference numbers in order to obtain adjudication as previously advised on the Preauthorization. | ||||
Comments | This value is an alphanumeric string that may be provided over the phone, via text, via paper, or within a ClaimResponse resource and is not a FHIR Identifier. | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
193. ExplanationOfBenefit.accident | |||||
Definition | Details of a accident which resulted in injuries which required the products and services listed in the claim. | ||||
Control | 0..1 | ||||
Type | BackboneElement | ||||
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 | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
194. 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. | ||||
Control | 0..1 | ||||
Type | string | ||||
XML Representation | In the XML format, this property is represented as an attribute. | ||||
195. 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. | ||||
Control | 0..* | ||||
Type | Extension | ||||
Alternate Names | extensionsuser content | ||||
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists()) | ||||
196. 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). | ||||
Control | 0..* | ||||
Type | Extension | ||||
Is Modifier | 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 | extensionsuser contentmodifiers | ||||
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. | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists()) | ||||
197. ExplanationOfBenefit.accident.date | |||||
Definition | Date of an accident event related to the products and services contained in the claim. | ||||
Control | 0..1 | ||||
Type | date | ||||
Requirements | Required for audit purposes and adjudication. | ||||
Comments | The date of the accident has to precede the dates of the products and services but within a reasonable timeframe. | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
198. 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. | ||||
Control | 0..1 | ||||
Binding | The codes SHALL be taken from ActIncidentCode; other codes may be used where these codes are not suitable Type of accident: work place, auto, etc | ||||
Type | CodeableConcept | ||||
Requirements | Coverage may be dependant on the type of accident. | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
199. ExplanationOfBenefit.accident.location[x] | |||||
Definition | The physical location of the accident event. | ||||
Control | 0..1 | ||||
Type | Choice of: Address, Reference(Location)) | ||||
[x] Note | See Choice of Data Types for further information about how to use [x] | ||||
Requirements | Required for audit purposes and determination of applicable insurance liability. | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
200. 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. | ||||
Control | 1..* | ||||
Type | BackboneElement | ||||
Must Support | true | ||||
Requirements | The items to be processed for adjudication. | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
201. 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. | ||||
Control | 0..1 | ||||
Type | string | ||||
XML Representation | In the XML format, this property is represented as an attribute. | ||||
202. 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. | ||||
Control | 0..* | ||||
Type | Extension | ||||
Alternate Names | extensionsuser content | ||||
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists()) | ||||
203. 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). | ||||
Control | 0..* | ||||
Type | Extension | ||||
Is Modifier | 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 | extensionsuser contentmodifiers | ||||
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. | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists()) | ||||
204. ExplanationOfBenefit.item.sequence | |||||
Definition | A number to uniquely identify item entries. | ||||
Control | 1..1 | ||||
Type | positiveInt | ||||
Must Support | true | ||||
Requirements | Necessary to provide a mechanism to link to items from within the claim and within the adjudication details of the ClaimResponse. | ||||
Comments | Line identification number that represents the number assigned in a source system for identification and processing. (36) | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
205. ExplanationOfBenefit.item.careTeamSequence | |||||
Definition | Care team members related to this service or product. | ||||
Control | 0..* | ||||
Type | positiveInt | ||||
Requirements | Need to identify the individuals and their roles in the provision of the product or service. | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
206. ExplanationOfBenefit.item.diagnosisSequence | |||||
Definition | Diagnoses applicable for this service or product. | ||||
Control | 0..* | ||||
Type | positiveInt | ||||
Requirements | Need to related the product or service to the associated diagnoses. | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
207. ExplanationOfBenefit.item.procedureSequence | |||||
Definition | Procedures applicable for this service or product. | ||||
Control | 0..* | ||||
Type | positiveInt | ||||
Requirements | Need to provide any listed specific procedures to support the product or service being claimed. | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
208. ExplanationOfBenefit.item.informationSequence | |||||
Definition | Exceptions, special conditions and supporting information applicable for this service or product. | ||||
Control | 0..* | ||||
Type | positiveInt | ||||
Requirements | Need to reference the supporting information items that relate directly to this product or service. | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
209. ExplanationOfBenefit.item.revenue | |||||
Definition | The type of revenue or cost center providing the product and/or service. | ||||
Control | 0..1 | ||||
Binding | For example codes, see ExampleRevenueCenterCodes Codes for the revenue or cost centers supplying the service and/or products | ||||
Type | CodeableConcept | ||||
Requirements | Needed in the processing of institutional claims. | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
210. ExplanationOfBenefit.item.category | |||||
Definition | Code to identify the general type of benefits under which products and services are provided. | ||||
Control | 0..1 | ||||
Binding | For example codes, see BenefitCategoryCodes Benefit categories such as: oral, medical, vision, oral-basic etc | ||||
Type | CodeableConcept | ||||
Requirements | Needed in the processing of institutional claims as this allows the insurer to determine whether a facial X-Ray is for dental, orthopedic, or facial surgery purposes. | ||||
Comments | Examples include Medical Care, Periodontics, Renal Dialysis, Vision Coverage. | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
211. ExplanationOfBenefit.item.productOrService | |||||
Definition | When the value is a group code then this item collects a set of related claim details, otherwise this contains the product, service, drug or other billing code for the item. | ||||
Control | 1..1 | ||||
Binding | The codes SHALL be taken from NDC or Compound Value Set | ||||
Type | CodeableConcept | ||||
Must Support | true | ||||
Requirements | Necessary to state what was provided or done. | ||||
Alternate Names | Drug CodeBill CodeService Code | ||||
Comments | Values are NDC Codes (38) when Compound Code (78) = 0 or 1. When the Compound Code = 2, productOrService = 'compound' and map the ingredient to ExplanationOfBenefit.item.detail.productOrService | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
212. ExplanationOfBenefit.item.modifier | |||||
Definition | Item typification or modifiers codes to convey additional context for the product or service. | ||||
Control | 0..* | ||||
Binding | For example codes, see ModifierTypeCodes Item type or modifiers codes, eg for Oral whether the treatment is cosmetic or associated with TMJ, or an appliance was lost or stolen | ||||
Type | CodeableConcept | ||||
Requirements | To support inclusion of the item for adjudication or to charge an elevated fee. | ||||
Comments | For example, in Oral whether the treatment is cosmetic or associated with TMJ, or for Medical whether the treatment was outside the clinic or out of office hours. | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
213. ExplanationOfBenefit.item.programCode | |||||
Definition | Identifies the program under which this may be recovered. | ||||
Control | 0..* | ||||
Binding | For example codes, see ExampleProgramReasonCodes Program specific reason codes | ||||
Type | CodeableConcept | ||||
Requirements | Commonly used in in the identification of publicly provided program focused on population segments or disease classifications. | ||||
Comments | For example: Neonatal program, child dental program or drug users recovery program. | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
214. ExplanationOfBenefit.item.serviced[x] | |||||
Definition | The date or dates when the service or product was supplied, performed or completed. | ||||
Control | 1..1 | ||||
Type | date | ||||
[x] Note | See Choice of Data Types for further information about how to use [x] | ||||
Requirements | Needed to determine whether the service or product was provided during the term of the insurance coverage. | ||||
Comments | Identifies date the prescription was filled or professional service rendered (90) | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
Slicing | This element introduces a set of slices on ExplanationOfBenefit.item.serviced[x]. The slices are unordered and Closed, and can be differentiated using the following discriminators:
| ||||
215. ExplanationOfBenefit.item.serviced[x]:servicedDate | |||||
SliceName | servicedDate | ||||
Definition | The date or dates when the service or product was supplied, performed or completed. | ||||
Control | 1..1 | ||||
Type | date | ||||
[x] Note | See Choice of Data Types for further information about how to use [x] | ||||
Must Support | true | ||||
Requirements | Needed to determine whether the service or product was provided during the term of the insurance coverage. | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
216. ExplanationOfBenefit.item.location[x] | |||||
Definition | Where the product or service was provided. | ||||
Control | 0..1 | ||||
Binding | For example codes, see ExampleServicePlaceCodes Place where the service is rendered | ||||
Type | Choice of: CodeableConcept, Address, Reference(Location)) | ||||
[x] Note | See Choice of Data Types for further information about how to use [x] | ||||
Requirements | The location can alter whether the item was acceptable for insurance purposes or impact the determination of the benefit amount. | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
217. ExplanationOfBenefit.item.quantity | |||||
Definition | The number of repetitions of a service or product. | ||||
Control | 0..1 | ||||
Type | Quantity(SimpleQuantity) | ||||
Must Support | true | ||||
Requirements | Required when the product or service code does not convey the quantity provided. | ||||
Comments | Quantity dispensed for the drug (39) / The unit of measurement for the drug. (gram, ml, etc.) (151). Populate for all Compound Code values. When the Compound Code = 2, if available, map the ingredient to ExplanationOfBenefit.item.detail.quantity | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
218. 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. | ||||
Control | 0..1 | ||||
Type | Money | ||||
Requirements | The amount charged to the patient by the provider for a single unit. | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
219. 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. | ||||
Control | 0..1 | ||||
Type | decimal | ||||
Requirements | When discounts are provided to a patient (example: Senior's discount) then this must be documented for adjudication. | ||||
Comments | To show a 10% senior's discount, the value entered is: 0.90 (1.00 - 0.10). | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
220. ExplanationOfBenefit.item.net | |||||
Definition | The quantity times the unit price for an additional service or product or charge. | ||||
Control | 0..1 | ||||
Type | Money | ||||
Requirements | Provides the total amount claimed for the group (if a grouper) or the line item. | ||||
Comments | For example, the formula: quantity * unitPrice * factor = net. Quantity and factor are assumed to be 1 if not supplied. | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
221. ExplanationOfBenefit.item.udi | |||||
Definition | Unique Device Identifiers associated with this line item. | ||||
Control | 0..* | ||||
Type | Reference(Device)) | ||||
Requirements | The UDI code allows the insurer to obtain device level information on the product supplied. | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
222. ExplanationOfBenefit.item.bodySite | |||||
Definition | Physical service site on the patient (limb, tooth, etc.). | ||||
Control | 0..1 | ||||
Binding | For example codes, see OralSiteCodes The code for the teeth, quadrant, sextant and arch | ||||
Type | CodeableConcept | ||||
Requirements | Allows insurer to validate specific procedures. | ||||
Comments | For example: Providing a tooth code, allows an insurer to identify a provider performing a filling on a tooth that was previously removed. | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
223. ExplanationOfBenefit.item.subSite | |||||
Definition | A region or surface of the bodySite, e.g. limb region or tooth surface(s). | ||||
Control | 0..* | ||||
Binding | For example codes, see SurfaceCodes The code for the tooth surface and surface combinations | ||||
Type | CodeableConcept | ||||
Requirements | Allows insurer to validate specific procedures. | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
224. ExplanationOfBenefit.item.encounter | |||||
Definition | A billed item may include goods or services provided in multiple encounters. | ||||
Control | 0..* | ||||
Type | Reference(Encounter)) | ||||
Requirements | Used in some jurisdictions to link clinical events to claim items. | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
225. ExplanationOfBenefit.item.noteNumber | |||||
Definition | The numbers associated with notes below which apply to the adjudication of this item. | ||||
Control | 0..* | ||||
Type | positiveInt | ||||
Must Support | true | ||||
Requirements | Provides a condensed manner for associating human readable descriptive explanations for adjudications on the line item. | ||||
Comments | References number of the associated processNote entered | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
226. 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. | ||||
Control | 1..* | ||||
Type | BackboneElement | ||||
Must Support | true | ||||
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 | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
Slicing | This element introduces a set of slices on ExplanationOfBenefit.item.adjudication. The slices are unordered and Open, and can be differentiated using the following discriminators:
| ||||
227. 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. | ||||
Control | 0..1 | ||||
Type | string | ||||
XML Representation | In the XML format, this property is represented as an attribute. | ||||
228. 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. | ||||
Control | 0..* | ||||
Type | Extension | ||||
Alternate Names | extensionsuser content | ||||
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists()) | ||||
229. 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). | ||||
Control | 0..* | ||||
Type | Extension | ||||
Is Modifier | 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 | extensionsuser contentmodifiers | ||||
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. | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists()) | ||||
230. 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. | ||||
Control | 1..1 | ||||
Binding | The codes SHALL be taken from C4BB Adjudication Category Discriminator Value Set; other codes may be used where these codes are not suitable | ||||
Type | CodeableConcept | ||||
Must Support | true | ||||
Requirements | Needed to enable understanding of the context of the other information in the adjudication. | ||||
Comments | For example, codes indicating: Co-Pay, deductible, eligible, benefit, tax, etc. | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
231. ExplanationOfBenefit.item.adjudication.reason | |||||
Definition | A code supporting the understanding of the adjudication result and explaining variance from expected amount. | ||||
Control | 0..1 | ||||
Binding | For example codes, see AdjudicationReasonCodes Adjudication reason codes | ||||
Type | CodeableConcept | ||||
Requirements | To support understanding of variance from adjudication expectations. | ||||
Comments | For example, may indicate that the funds for this benefit type have been exhausted. | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
232. ExplanationOfBenefit.item.adjudication.amount | |||||
Definition | Monetary amount associated with the category. | ||||
Control | 0..1 | ||||
Type | Money | ||||
Requirements | Most adjuciation categories convey a monetary amount. | ||||
Comments | For example, amount submitted, eligible amount, co-payment, and benefit payable. | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
233. ExplanationOfBenefit.item.adjudication.value | |||||
Definition | A non-monetary value associated with the category. Mutually exclusive to the amount element above. | ||||
Control | 0..1 | ||||
Type | decimal | ||||
Requirements | Some adjudication categories convey a percentage or a fixed value. | ||||
Comments | For example: eligible percentage or co-payment percentage. | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
234. ExplanationOfBenefit.item.adjudication:adjudicationamounttype | |||||
SliceName | adjudicationamounttype | ||||
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. | ||||
Control | 1..* | ||||
Type | BackboneElement | ||||
Must Support | true | ||||
Requirements | The adjudication results conveys the insurer's assessment of the item provided in the claim under the terms of the patient's insurance coverage. | ||||
Comments | Describes the various amount fields used when payers receive and adjudicate a claim. (187) | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
235. ExplanationOfBenefit.item.adjudication:adjudicationamounttype.id | |||||
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||||
Control | 0..1 | ||||
Type | string | ||||
XML Representation | In the XML format, this property is represented as an attribute. | ||||
236. ExplanationOfBenefit.item.adjudication:adjudicationamounttype.extension | |||||
Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | ||||
Control | 0..* | ||||
Type | Extension | ||||
Alternate Names | extensionsuser content | ||||
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists()) | ||||
237. ExplanationOfBenefit.item.adjudication:adjudicationamounttype.modifierExtension | |||||
Definition | May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). | ||||
Control | 0..* | ||||
Type | Extension | ||||
Is Modifier | 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 | extensionsuser contentmodifiers | ||||
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. | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists()) | ||||
238. ExplanationOfBenefit.item.adjudication:adjudicationamounttype.category | |||||
Definition | A code to indicate the information type of this adjudication record. Information types may include: the value submitted, maximum values or percentages allowed or payable under the plan, amounts that the patient is responsible for in-aggregate or pertaining to this item, amounts paid by other coverages, and the benefit payable for this item. | ||||
Control | 1..1 | ||||
Binding | The codes SHALL be taken from C4BB Adjudication Value Set | ||||
Type | CodeableConcept | ||||
Must Support | true | ||||
Requirements | Needed to enable understanding of the context of the other information in the adjudication. | ||||
Comments | For example, codes indicating: Co-Pay, deductible, eligible, benefit, tax, etc. | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
239. ExplanationOfBenefit.item.adjudication:adjudicationamounttype.reason | |||||
Definition | A code supporting the understanding of the adjudication result and explaining variance from expected amount. | ||||
Control | 0..1 | ||||
Binding | For example codes, see AdjudicationReasonCodes Adjudication reason codes | ||||
Type | CodeableConcept | ||||
Requirements | To support understanding of variance from adjudication expectations. | ||||
Comments | For example, may indicate that the funds for this benefit type have been exhausted. | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
240. ExplanationOfBenefit.item.adjudication:adjudicationamounttype.amount | |||||
Definition | Monetary amount associated with the category. | ||||
Control | 1..1 | ||||
Type | Money | ||||
Must Support | true | ||||
Requirements | Most adjuciation categories convey a monetary amount. | ||||
Comments | For example, amount submitted, eligible amount, co-payment, and benefit payable. | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
241. ExplanationOfBenefit.item.adjudication:adjudicationamounttype.value | |||||
Definition | A non-monetary value associated with the category. Mutually exclusive to the amount element above. | ||||
Control | 0..1 | ||||
Type | decimal | ||||
Requirements | Some adjudication categories convey a percentage or a fixed value. | ||||
Comments | For example: eligible percentage or co-payment percentage. | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
242. ExplanationOfBenefit.item.adjudication:rejectreason | |||||
SliceName | rejectreason | ||||
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. | ||||
Control | 0..1 | ||||
Type | BackboneElement | ||||
Must Support | true | ||||
Requirements | The adjudication results conveys the insurer's assessment of the item provided in the claim under the terms of the patient's insurance coverage. | ||||
Comments | Reason codes used to interpret the Non-Covered Amount (92) | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
243. ExplanationOfBenefit.item.adjudication:rejectreason.id | |||||
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||||
Control | 0..1 | ||||
Type | string | ||||
XML Representation | In the XML format, this property is represented as an attribute. | ||||
244. ExplanationOfBenefit.item.adjudication:rejectreason.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. | ||||
Control | 0..* | ||||
Type | Extension | ||||
Alternate Names | extensionsuser content | ||||
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists()) | ||||
245. ExplanationOfBenefit.item.adjudication:rejectreason.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). | ||||
Control | 0..* | ||||
Type | Extension | ||||
Is Modifier | 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 | extensionsuser contentmodifiers | ||||
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. | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists()) | ||||
246. ExplanationOfBenefit.item.adjudication:rejectreason.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. | ||||
Control | 1..1 | ||||
Binding | For example codes, see AdjudicationValueCodes The adjudication codes | ||||
Type | CodeableConcept | ||||
Must Support | true | ||||
Requirements | Needed to enable understanding of the context of the other information in the adjudication. | ||||
Comments | For example, codes indicating: Co-Pay, deductible, eligible, benefit, tax, etc. | ||||
Pattern Value | <valueCodeableConcept xmlns="http://hl7.org/fhir"> <coding> <system value="http://hl7.org/fhir/us/carin-bb/CodeSystem/C4BBAdjudicationDiscriminator"/> <code value="rejectreason"/> </coding> </valueCodeableConcept> | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
247. ExplanationOfBenefit.item.adjudication:rejectreason.reason | |||||
Definition | A code supporting the understanding of the adjudication result and explaining variance from expected amount. | ||||
Control | 1..1 | ||||
Binding | The codes SHALL be taken from NCPDP Reject Code Value Set | ||||
Type | CodeableConcept | ||||
Must Support | true | ||||
Requirements | To support understanding of variance from adjudication expectations. | ||||
Comments | For example, may indicate that the funds for this benefit type have been exhausted. | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
248. ExplanationOfBenefit.item.adjudication:rejectreason.amount | |||||
Definition | Monetary amount associated with the category. | ||||
Control | 0..1 | ||||
Type | Money | ||||
Requirements | Most adjuciation categories convey a monetary amount. | ||||
Comments | For example, amount submitted, eligible amount, co-payment, and benefit payable. | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
249. ExplanationOfBenefit.item.adjudication:rejectreason.value | |||||
Definition | A non-monetary value associated with the category. Mutually exclusive to the amount element above. | ||||
Control | 0..1 | ||||
Type | decimal | ||||
Requirements | Some adjudication categories convey a percentage or a fixed value. | ||||
Comments | For example: eligible percentage or co-payment percentage. | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
250. ExplanationOfBenefit.item.detail | |||||
Definition | Second-tier of goods and services. | ||||
Control | 0..* | ||||
Type | BackboneElement | ||||
Must Support | true | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
251. 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. | ||||
Control | 0..1 | ||||
Type | string | ||||
XML Representation | In the XML format, this property is represented as an attribute. | ||||
252. 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. | ||||
Control | 0..* | ||||
Type | Extension | ||||
Alternate Names | extensionsuser content | ||||
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists()) | ||||
253. 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). | ||||
Control | 0..* | ||||
Type | Extension | ||||
Is Modifier | 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 | extensionsuser contentmodifiers | ||||
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. | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists()) | ||||
254. 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. | ||||
Control | 1..1 | ||||
Type | positiveInt | ||||
Requirements | The items to be processed for adjudication. | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
255. ExplanationOfBenefit.item.detail.revenue | |||||
Definition | The type of revenue or cost center providing the product and/or service. | ||||
Control | 0..1 | ||||
Binding | For example codes, see ExampleRevenueCenterCodes Codes for the revenue or cost centers supplying the service and/or products | ||||
Type | CodeableConcept | ||||
Requirements | Needed in the processing of institutional claims. | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
256. ExplanationOfBenefit.item.detail.category | |||||
Definition | Code to identify the general type of benefits under which products and services are provided. | ||||
Control | 0..1 | ||||
Binding | For example codes, see BenefitCategoryCodes Benefit categories such as: oral, medical, vision, oral-basic etc | ||||
Type | CodeableConcept | ||||
Requirements | Needed in the processing of institutional claims as this allows the insurer to determine whether a facial X-Ray is for dental, orthopedic, or facial surgery purposes. | ||||
Comments | Examples include: Medical Care, Periodontics, Renal Dialysis, Vision Coverage. | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
257. 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. | ||||
Control | 1..1 | ||||
Binding | The codes SHALL be taken from National Drug Code (NDC) Value Set | ||||
Type | CodeableConcept | ||||
Must Support | true | ||||
Requirements | Necessary to state what was provided or done. | ||||
Alternate Names | Drug CodeBill CodeService Code | ||||
Comments | Values are NDC Codes (38) when Compound Code (78) = 2 | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
258. ExplanationOfBenefit.item.detail.modifier | |||||
Definition | Item typification or modifiers codes to convey additional context for the product or service. | ||||
Control | 0..* | ||||
Binding | For example codes, see ModifierTypeCodes Item type or modifiers codes, eg for Oral whether the treatment is cosmetic or associated with TMJ, or an appliance was lost or stolen | ||||
Type | CodeableConcept | ||||
Requirements | To support inclusion of the item for adjudication or to charge an elevated fee. | ||||
Comments | For example, in Oral whether the treatment is cosmetic or associated with TMJ, or for Medical whether the treatment was outside the clinic or out of office hours. | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
259. ExplanationOfBenefit.item.detail.programCode | |||||
Definition | Identifies the program under which this may be recovered. | ||||
Control | 0..* | ||||
Binding | For example codes, see ExampleProgramReasonCodes Program specific reason codes | ||||
Type | CodeableConcept | ||||
Requirements | Commonly used in in the identification of publicly provided program focused on population segments or disease classifications. | ||||
Comments | For example: Neonatal program, child dental program or drug users recovery program. | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
260. ExplanationOfBenefit.item.detail.quantity | |||||
Definition | The number of repetitions of a service or product. | ||||
Control | 0..1 | ||||
Type | Quantity(SimpleQuantity) | ||||
Must Support | true | ||||
Requirements | Required when the product or service code does not convey the quantity provided. | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
261. 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. | ||||
Control | 0..1 | ||||
Type | Money | ||||
Requirements | The amount charged to the patient by the provider for a single unit. | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
262. 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. | ||||
Control | 0..1 | ||||
Type | decimal | ||||
Requirements | When discounts are provided to a patient (example: Senior's discount) then this must be documented for adjudication. | ||||
Comments | To show a 10% senior's discount, the value entered is: 0.90 (1.00 - 0.10). | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
263. ExplanationOfBenefit.item.detail.net | |||||
Definition | The quantity times the unit price for an additional service or product or charge. | ||||
Control | 0..1 | ||||
Type | Money | ||||
Requirements | Provides the total amount claimed for the group (if a grouper) or the line item. | ||||
Comments | For example, the formula: quantity * unitPrice * factor = net. Quantity and factor are assumed to be 1 if not supplied. | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
264. ExplanationOfBenefit.item.detail.udi | |||||
Definition | Unique Device Identifiers associated with this line item. | ||||
Control | 0..* | ||||
Type | Reference(Device)) | ||||
Requirements | The UDI code allows the insurer to obtain device level information on the product supplied. | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
265. ExplanationOfBenefit.item.detail.noteNumber | |||||
Definition | The numbers associated with notes below which apply to the adjudication of this item. | ||||
Control | 0..* | ||||
Type | positiveInt | ||||
Requirements | Provides a condensed manner for associating human readable descriptive explanations for adjudications on the line item. | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
266. ExplanationOfBenefit.item.detail.adjudication | |||||
Definition | The adjudication results. | ||||
Control | 0..* | ||||
Type | See ttp://hl7.org/fhir/StructureDefinition/ExplanationOfBenefit#ExplanationOfBenefit.item.adjudication | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
267. ExplanationOfBenefit.item.detail.subDetail | |||||
Definition | Third-tier of goods and services. | ||||
Control | 0..* | ||||
Type | BackboneElement | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
268. 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. | ||||
Control | 0..1 | ||||
Type | string | ||||
XML Representation | In the XML format, this property is represented as an attribute. | ||||
269. 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. | ||||
Control | 0..* | ||||
Type | Extension | ||||
Alternate Names | extensionsuser content | ||||
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists()) | ||||
270. 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). | ||||
Control | 0..* | ||||
Type | Extension | ||||
Is Modifier | 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 | extensionsuser contentmodifiers | ||||
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. | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists()) | ||||
271. 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. | ||||
Control | 1..1 | ||||
Type | positiveInt | ||||
Requirements | The items to be processed for adjudication. | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
272. ExplanationOfBenefit.item.detail.subDetail.revenue | |||||
Definition | The type of revenue or cost center providing the product and/or service. | ||||
Control | 0..1 | ||||
Binding | For example codes, see ExampleRevenueCenterCodes Codes for the revenue or cost centers supplying the service and/or products | ||||
Type | CodeableConcept | ||||
Requirements | Needed in the processing of institutional claims. | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
273. ExplanationOfBenefit.item.detail.subDetail.category | |||||
Definition | Code to identify the general type of benefits under which products and services are provided. | ||||
Control | 0..1 | ||||
Binding | For example codes, see BenefitCategoryCodes Benefit categories such as: oral, medical, vision, oral-basic etc | ||||
Type | CodeableConcept | ||||
Requirements | Needed in the processing of institutional claims as this allows the insurer to determine whether a facial X-Ray is for dental, orthopedic, or facial surgery purposes. | ||||
Comments | Examples include Medical Care, Periodontics, Renal Dialysis, Vision Coverage. | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
274. 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. | ||||
Control | 1..1 | ||||
Binding | For example codes, see USCLSCodes Allowable service and product codes | ||||
Type | CodeableConcept | ||||
Requirements | Necessary to state what was provided or done. | ||||
Alternate Names | Drug CodeBill CodeService 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'. | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
275. ExplanationOfBenefit.item.detail.subDetail.modifier | |||||
Definition | Item typification or modifiers codes to convey additional context for the product or service. | ||||
Control | 0..* | ||||
Binding | For example codes, see ModifierTypeCodes Item type or modifiers codes, eg for Oral whether the treatment is cosmetic or associated with TMJ, or an appliance was lost or stolen | ||||
Type | CodeableConcept | ||||
Requirements | To support inclusion of the item for adjudication or to charge an elevated fee. | ||||
Comments | For example, in Oral whether the treatment is cosmetic or associated with TMJ, or for Medical whether the treatment was outside the clinic or outside of office hours. | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
276. ExplanationOfBenefit.item.detail.subDetail.programCode | |||||
Definition | Identifies the program under which this may be recovered. | ||||
Control | 0..* | ||||
Binding | For example codes, see ExampleProgramReasonCodes Program specific reason codes | ||||
Type | CodeableConcept | ||||
Requirements | Commonly used in in the identification of publicly provided program focused on population segments or disease classifications. | ||||
Comments | For example: Neonatal program, child dental program or drug users recovery program. | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
277. ExplanationOfBenefit.item.detail.subDetail.quantity | |||||
Definition | The number of repetitions of a service or product. | ||||
Control | 0..1 | ||||
Type | Quantity(SimpleQuantity) | ||||
Requirements | Required when the product or service code does not convey the quantity provided. | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
278. ExplanationOfBenefit.item.detail.subDetail.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. | ||||
Control | 0..1 | ||||
Type | Money | ||||
Requirements | The amount charged to the patient by the provider for a single unit. | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
279. 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. | ||||
Control | 0..1 | ||||
Type | decimal | ||||
Requirements | When discounts are provided to a patient (example: Senior's discount) then this must be documented for adjudication. | ||||
Comments | To show a 10% senior's discount, the value entered is: 0.90 (1.00 - 0.10). | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
280. ExplanationOfBenefit.item.detail.subDetail.net | |||||
Definition | The quantity times the unit price for an additional service or product or charge. | ||||
Control | 0..1 | ||||
Type | Money | ||||
Requirements | Provides the total amount claimed for the group (if a grouper) or the line item. | ||||
Comments | For example, the formula: quantity * unitPrice * factor = net. Quantity and factor are assumed to be 1 if not supplied. | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
281. ExplanationOfBenefit.item.detail.subDetail.udi | |||||
Definition | Unique Device Identifiers associated with this line item. | ||||
Control | 0..* | ||||
Type | Reference(Device)) | ||||
Requirements | The UDI code allows the insurer to obtain device level information on the product supplied. | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
282. ExplanationOfBenefit.item.detail.subDetail.noteNumber | |||||
Definition | The numbers associated with notes below which apply to the adjudication of this item. | ||||
Control | 0..* | ||||
Type | positiveInt | ||||
Requirements | Provides a condensed manner for associating human readable descriptive explanations for adjudications on the line item. | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
283. ExplanationOfBenefit.item.detail.subDetail.adjudication | |||||
Definition | The adjudication results. | ||||
Control | 0..* | ||||
Type | See ttp://hl7.org/fhir/StructureDefinition/ExplanationOfBenefit#ExplanationOfBenefit.item.adjudication | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
284. ExplanationOfBenefit.addItem | |||||
Definition | The first-tier service adjudications for payor added product or service lines. | ||||
Control | 0..* | ||||
Type | BackboneElement | ||||
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 | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
285. 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. | ||||
Control | 0..1 | ||||
Type | string | ||||
XML Representation | In the XML format, this property is represented as an attribute. | ||||
286. 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. | ||||
Control | 0..* | ||||
Type | Extension | ||||
Alternate Names | extensionsuser content | ||||
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists()) | ||||
287. 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). | ||||
Control | 0..* | ||||
Type | Extension | ||||
Is Modifier | 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 | extensionsuser contentmodifiers | ||||
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. | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists()) | ||||
288. ExplanationOfBenefit.addItem.itemSequence | |||||
Definition | Claim items which this service line is intended to replace. | ||||
Control | 0..* | ||||
Type | positiveInt | ||||
Requirements | Provides references to the claim items. | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
289. ExplanationOfBenefit.addItem.detailSequence | |||||
Definition | The sequence number of the details within the claim item which this line is intended to replace. | ||||
Control | 0..* | ||||
Type | positiveInt | ||||
Requirements | Provides references to the claim details within the claim item. | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
290. 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. | ||||
Control | 0..* | ||||
Type | positiveInt | ||||
Requirements | Provides references to the claim sub-details within the claim detail. | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
291. ExplanationOfBenefit.addItem.provider | |||||
Definition | The providers who are authorized for the services rendered to the patient. | ||||
Control | 0..* | ||||
Type | Reference(PractitionerPractitionerRoleOrganization)) | ||||
Requirements | Insurer may provide authorization specifically to a restricted set of providers rather than an open authorization. | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
292. 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. | ||||
Control | 1..1 | ||||
Binding | For example codes, see USCLSCodes Allowable service and product codes | ||||
Type | CodeableConcept | ||||
Requirements | Necessary to state what was provided or done. | ||||
Alternate Names | Drug CodeBill CodeService 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'. | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
293. ExplanationOfBenefit.addItem.modifier | |||||
Definition | Item typification or modifiers codes to convey additional context for the product or service. | ||||
Control | 0..* | ||||
Binding | For example codes, see ModifierTypeCodes Item type or modifiers codes, eg for Oral whether the treatment is cosmetic or associated with TMJ, or an appliance was lost or stolen | ||||
Type | CodeableConcept | ||||
Requirements | To support inclusion of the item for adjudication or to charge an elevated fee. | ||||
Comments | For example, in Oral whether the treatment is cosmetic or associated with TMJ, or for Medical whether the treatment was outside the clinic or out of office hours. | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
294. ExplanationOfBenefit.addItem.programCode | |||||
Definition | Identifies the program under which this may be recovered. | ||||
Control | 0..* | ||||
Binding | For example codes, see ExampleProgramReasonCodes Program specific reason codes | ||||
Type | CodeableConcept | ||||
Requirements | Commonly used in in the identification of publicly provided program focused on population segments or disease classifications. | ||||
Comments | For example: Neonatal program, child dental program or drug users recovery program. | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
295. ExplanationOfBenefit.addItem.serviced[x] | |||||
Definition | The date or dates when the service or product was supplied, performed or completed. | ||||
Control | 0..1 | ||||
Type | Choice of: date, Period | ||||
[x] Note | See Choice of Data Types for further information about how to use [x] | ||||
Requirements | Needed to determine whether the service or product was provided during the term of the insurance coverage. | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
296. ExplanationOfBenefit.addItem.location[x] | |||||
Definition | Where the product or service was provided. | ||||
Control | 0..1 | ||||
Binding | For example codes, see ExampleServicePlaceCodes Place where the service is rendered | ||||
Type | Choice of: CodeableConcept, Address, Reference(Location)) | ||||
[x] Note | See Choice of Data Types for further information about how to use [x] | ||||
Requirements | The location can alter whether the item was acceptable for insurance purposes or impact the determination of the benefit amount. | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
297. ExplanationOfBenefit.addItem.quantity | |||||
Definition | The number of repetitions of a service or product. | ||||
Control | 0..1 | ||||
Type | Quantity(SimpleQuantity) | ||||
Requirements | Required when the product or service code does not convey the quantity provided. | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
298. 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. | ||||
Control | 0..1 | ||||
Type | Money | ||||
Requirements | The amount charged to the patient by the provider for a single unit. | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
299. 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. | ||||
Control | 0..1 | ||||
Type | decimal | ||||
Requirements | When discounts are provided to a patient (example: Senior's discount) then this must be documented for adjudication. | ||||
Comments | To show a 10% senior's discount, the value entered is: 0.90 (1.00 - 0.10). | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
300. ExplanationOfBenefit.addItem.net | |||||
Definition | The quantity times the unit price for an additional service or product or charge. | ||||
Control | 0..1 | ||||
Type | Money | ||||
Requirements | Provides the total amount claimed for the group (if a grouper) or the line item. | ||||
Comments | For example, the formula: quantity * unitPrice * factor = net. Quantity and factor are assumed to be 1 if not supplied. | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
301. ExplanationOfBenefit.addItem.bodySite | |||||
Definition | Physical service site on the patient (limb, tooth, etc.). | ||||
Control | 0..1 | ||||
Binding | For example codes, see OralSiteCodes The code for the teeth, quadrant, sextant and arch | ||||
Type | CodeableConcept | ||||
Requirements | Allows insurer to validate specific procedures. | ||||
Comments | For example, providing a tooth code allows an insurer to identify a provider performing a filling on a tooth that was previously removed. | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
302. ExplanationOfBenefit.addItem.subSite | |||||
Definition | A region or surface of the bodySite, e.g. limb region or tooth surface(s). | ||||
Control | 0..* | ||||
Binding | For example codes, see SurfaceCodes The code for the tooth surface and surface combinations | ||||
Type | CodeableConcept | ||||
Requirements | Allows insurer to validate specific procedures. | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
303. ExplanationOfBenefit.addItem.noteNumber | |||||
Definition | The numbers associated with notes below which apply to the adjudication of this item. | ||||
Control | 0..* | ||||
Type | positiveInt | ||||
Requirements | Provides a condensed manner for associating human readable descriptive explanations for adjudications on the line item. | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
304. ExplanationOfBenefit.addItem.adjudication | |||||
Definition | The adjudication results. | ||||
Control | 0..* | ||||
Type | See ttp://hl7.org/fhir/StructureDefinition/ExplanationOfBenefit#ExplanationOfBenefit.item.adjudication | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
305. ExplanationOfBenefit.addItem.detail | |||||
Definition | The second-tier service adjudications for payor added services. | ||||
Control | 0..* | ||||
Type | BackboneElement | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
306. 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. | ||||
Control | 0..1 | ||||
Type | string | ||||
XML Representation | In the XML format, this property is represented as an attribute. | ||||
307. 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. | ||||
Control | 0..* | ||||
Type | Extension | ||||
Alternate Names | extensionsuser content | ||||
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists()) | ||||
308. 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). | ||||
Control | 0..* | ||||
Type | Extension | ||||
Is Modifier | 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 | extensionsuser contentmodifiers | ||||
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. | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists()) | ||||
309. 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. | ||||
Control | 1..1 | ||||
Binding | For example codes, see USCLSCodes Allowable service and product codes | ||||
Type | CodeableConcept | ||||
Requirements | Necessary to state what was provided or done. | ||||
Alternate Names | Drug CodeBill CodeService 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'. | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
310. ExplanationOfBenefit.addItem.detail.modifier | |||||
Definition | Item typification or modifiers codes to convey additional context for the product or service. | ||||
Control | 0..* | ||||
Binding | For example codes, see ModifierTypeCodes Item type or modifiers codes, eg for Oral whether the treatment is cosmetic or associated with TMJ, or an appliance was lost or stolen | ||||
Type | CodeableConcept | ||||
Requirements | To support inclusion of the item for adjudication or to charge an elevated fee. | ||||
Comments | For example, in Oral whether the treatment is cosmetic or associated with TMJ, or for Medical whether the treatment was outside the clinic or out of office hours. | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
311. ExplanationOfBenefit.addItem.detail.quantity | |||||
Definition | The number of repetitions of a service or product. | ||||
Control | 0..1 | ||||
Type | Quantity(SimpleQuantity) | ||||
Requirements | Required when the product or service code does not convey the quantity provided. | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
312. 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. | ||||
Control | 0..1 | ||||
Type | Money | ||||
Requirements | The amount charged to the patient by the provider for a single unit. | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
313. 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. | ||||
Control | 0..1 | ||||
Type | decimal | ||||
Requirements | When discounts are provided to a patient (example: Senior's discount) then this must be documented for adjudication. | ||||
Comments | To show a 10% senior's discount, the value entered is: 0.90 (1.00 - 0.10). | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
314. ExplanationOfBenefit.addItem.detail.net | |||||
Definition | The quantity times the unit price for an additional service or product or charge. | ||||
Control | 0..1 | ||||
Type | Money | ||||
Requirements | Provides the total amount claimed for the group (if a grouper) or the line item. | ||||
Comments | For example, the formula: quantity * unitPrice * factor = net. Quantity and factor are assumed to be 1 if not supplied. | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
315. ExplanationOfBenefit.addItem.detail.noteNumber | |||||
Definition | The numbers associated with notes below which apply to the adjudication of this item. | ||||
Control | 0..* | ||||
Type | positiveInt | ||||
Requirements | Provides a condensed manner for associating human readable descriptive explanations for adjudications on the line item. | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
316. ExplanationOfBenefit.addItem.detail.adjudication | |||||
Definition | The adjudication results. | ||||
Control | 0..* | ||||
Type | See ttp://hl7.org/fhir/StructureDefinition/ExplanationOfBenefit#ExplanationOfBenefit.item.adjudication | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
317. ExplanationOfBenefit.addItem.detail.subDetail | |||||
Definition | The third-tier service adjudications for payor added services. | ||||
Control | 0..* | ||||
Type | BackboneElement | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
318. 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. | ||||
Control | 0..1 | ||||
Type | string | ||||
XML Representation | In the XML format, this property is represented as an attribute. | ||||
319. 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. | ||||
Control | 0..* | ||||
Type | Extension | ||||
Alternate Names | extensionsuser content | ||||
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists()) | ||||
320. 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). | ||||
Control | 0..* | ||||
Type | Extension | ||||
Is Modifier | 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 | extensionsuser contentmodifiers | ||||
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. | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists()) | ||||
321. 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. | ||||
Control | 1..1 | ||||
Binding | For example codes, see USCLSCodes Allowable service and product codes | ||||
Type | CodeableConcept | ||||
Requirements | Necessary to state what was provided or done. | ||||
Alternate Names | Drug CodeBill CodeService 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'. | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
322. ExplanationOfBenefit.addItem.detail.subDetail.modifier | |||||
Definition | Item typification or modifiers codes to convey additional context for the product or service. | ||||
Control | 0..* | ||||
Binding | For example codes, see ModifierTypeCodes Item type or modifiers codes, eg for Oral whether the treatment is cosmetic or associated with TMJ, or an appliance was lost or stolen | ||||
Type | CodeableConcept | ||||
Requirements | To support inclusion of the item for adjudication or to charge an elevated fee. | ||||
Comments | For example, in Oral whether the treatment is cosmetic or associated with TMJ, or for Medical whether the treatment was outside the clinic or out of office hours. | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
323. ExplanationOfBenefit.addItem.detail.subDetail.quantity | |||||
Definition | The number of repetitions of a service or product. | ||||
Control | 0..1 | ||||
Type | Quantity(SimpleQuantity) | ||||
Requirements | Required when the product or service code does not convey the quantity provided. | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
324. 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. | ||||
Control | 0..1 | ||||
Type | Money | ||||
Requirements | The amount charged to the patient by the provider for a single unit. | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
325. 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. | ||||
Control | 0..1 | ||||
Type | decimal | ||||
Requirements | When discounts are provided to a patient (example: Senior's discount) then this must be documented for adjudication. | ||||
Comments | To show a 10% senior's discount, the value entered is: 0.90 (1.00 - 0.10). | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
326. ExplanationOfBenefit.addItem.detail.subDetail.net | |||||
Definition | The quantity times the unit price for an additional service or product or charge. | ||||
Control | 0..1 | ||||
Type | Money | ||||
Requirements | Provides the total amount claimed for the group (if a grouper) or the line item. | ||||
Comments | For example, the formula: quantity * unitPrice * factor = net. Quantity and factor are assumed to be 1 if not supplied. | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
327. ExplanationOfBenefit.addItem.detail.subDetail.noteNumber | |||||
Definition | The numbers associated with notes below which apply to the adjudication of this item. | ||||
Control | 0..* | ||||
Type | positiveInt | ||||
Requirements | Provides a condensed manner for associating human readable descriptive explanations for adjudications on the line item. | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
328. ExplanationOfBenefit.addItem.detail.subDetail.adjudication | |||||
Definition | The adjudication results. | ||||
Control | 0..* | ||||
Type | See ttp://hl7.org/fhir/StructureDefinition/ExplanationOfBenefit#ExplanationOfBenefit.item.adjudication | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
329. ExplanationOfBenefit.adjudication | |||||
Definition | The adjudication results which are presented at the header level rather than at the line-item or add-item levels. | ||||
Control | 1..* | ||||
Type | BackboneElement | ||||
Must Support | true | ||||
Requirements | Some insurers will receive line-items but provide the adjudication only at a summary or header-level. | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
Slicing | This element introduces a set of slices on ExplanationOfBenefit.adjudication. The slices are unordered and Open, and can be differentiated using the following discriminators:
| ||||
330. ExplanationOfBenefit.adjudication.id | |||||
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||||
Control | 0..1 | ||||
Type | string | ||||
XML Representation | In the XML format, this property is represented as an attribute. | ||||
331. ExplanationOfBenefit.adjudication.extension | |||||
Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | ||||
Control | 0..* | ||||
Type | Extension | ||||
Alternate Names | extensionsuser content | ||||
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists()) | ||||
332. ExplanationOfBenefit.adjudication.modifierExtension | |||||
Definition | May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). | ||||
Control | 0..* | ||||
Type | Extension | ||||
Is Modifier | 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 | extensionsuser contentmodifiers | ||||
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. | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists()) | ||||
333. ExplanationOfBenefit.adjudication.category | |||||
Definition | A code to indicate the information type of this adjudication record. Information types may include: the value submitted, maximum values or percentages allowed or payable under the plan, amounts that the patient is responsible for in-aggregate or pertaining to this item, amounts paid by other coverages, and the benefit payable for this item. | ||||
Control | 1..1 | ||||
Binding | The codes SHALL be taken from C4BB Adjudication Category Discriminator Value Set; other codes may be used where these codes are not suitable | ||||
Type | CodeableConcept | ||||
Must Support | true | ||||
Requirements | Needed to enable understanding of the context of the other information in the adjudication. | ||||
Comments | For example, codes indicating: Co-Pay, deductible, eligible, benefit, tax, etc. | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
334. ExplanationOfBenefit.adjudication.reason | |||||
Definition | A code supporting the understanding of the adjudication result and explaining variance from expected amount. | ||||
Control | 0..1 | ||||
Binding | For example codes, see AdjudicationReasonCodes Adjudication reason codes | ||||
Type | CodeableConcept | ||||
Requirements | To support understanding of variance from adjudication expectations. | ||||
Comments | For example, may indicate that the funds for this benefit type have been exhausted. | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
335. ExplanationOfBenefit.adjudication.amount | |||||
Definition | Monetary amount associated with the category. | ||||
Control | 0..1 | ||||
Type | Money | ||||
Requirements | Most adjuciation categories convey a monetary amount. | ||||
Comments | For example, amount submitted, eligible amount, co-payment, and benefit payable. | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
336. ExplanationOfBenefit.adjudication.value | |||||
Definition | A non-monetary value associated with the category. Mutually exclusive to the amount element above. | ||||
Control | 0..1 | ||||
Type | decimal | ||||
Requirements | Some adjudication categories convey a percentage or a fixed value. | ||||
Comments | For example: eligible percentage or co-payment percentage. | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
337. ExplanationOfBenefit.adjudication:billingnetworkstatus | |||||
SliceName | billingnetworkstatus | ||||
Definition | The adjudication results which are presented at the header level rather than at the line-item or add-item levels. | ||||
Control | 0..1 | ||||
Type | BackboneElement | ||||
Must Support | true | ||||
Requirements | Some insurers will receive line-items but provide the adjudication only at a summary or header-level. | ||||
Comments | Indicates that the Billing Provider has a contract with the Plan (regardless of the network) that is effective on the date of service. (101) | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
338. ExplanationOfBenefit.adjudication:billingnetworkstatus.id | |||||
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||||
Control | 0..1 | ||||
Type | string | ||||
XML Representation | In the XML format, this property is represented as an attribute. | ||||
339. ExplanationOfBenefit.adjudication:billingnetworkstatus.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. | ||||
Control | 0..* | ||||
Type | Extension | ||||
Alternate Names | extensionsuser content | ||||
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists()) | ||||
340. ExplanationOfBenefit.adjudication:billingnetworkstatus.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). | ||||
Control | 0..* | ||||
Type | Extension | ||||
Is Modifier | 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 | extensionsuser contentmodifiers | ||||
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. | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists()) | ||||
341. ExplanationOfBenefit.adjudication:billingnetworkstatus.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. | ||||
Control | 1..1 | ||||
Binding | For example codes, see AdjudicationValueCodes The adjudication codes | ||||
Type | CodeableConcept | ||||
Requirements | Needed to enable understanding of the context of the other information in the adjudication. | ||||
Comments | For example, codes indicating: Co-Pay, deductible, eligible, benefit, tax, etc. | ||||
Pattern Value | <valueCodeableConcept xmlns="http://hl7.org/fhir"> <coding> <system value="http://hl7.org/fhir/us/carin-bb/CodeSystem/C4BBAdjudicationDiscriminator"/> <code value="billingnetworkstatus"/> </coding> </valueCodeableConcept> | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
342. ExplanationOfBenefit.adjudication:billingnetworkstatus.reason | |||||
Definition | A code supporting the understanding of the adjudication result and explaining variance from expected amount. | ||||
Control | 1..1 | ||||
Binding | The codes SHALL be taken from C4BB Payer Provider Network Status Value Set | ||||
Type | CodeableConcept | ||||
Must Support | true | ||||
Requirements | To support understanding of variance from adjudication expectations. | ||||
Comments | For example, may indicate that the funds for this benefit type have been exhausted. | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
343. ExplanationOfBenefit.adjudication:billingnetworkstatus.amount | |||||
Definition | Monetary amount associated with the category. | ||||
Control | 0..1 | ||||
Type | Money | ||||
Requirements | Most adjuciation categories convey a monetary amount. | ||||
Comments | For example, amount submitted, eligible amount, co-payment, and benefit payable. | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
344. ExplanationOfBenefit.adjudication:billingnetworkstatus.value | |||||
Definition | A non-monetary value associated with the category. Mutually exclusive to the amount element above. | ||||
Control | 0..1 | ||||
Type | decimal | ||||
Requirements | Some adjudication categories convey a percentage or a fixed value. | ||||
Comments | For example: eligible percentage or co-payment percentage. | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
345. ExplanationOfBenefit.adjudication:benefitpaymentstatus | |||||
SliceName | benefitpaymentstatus | ||||
Definition | The adjudication results which are presented at the header level rather than at the line-item or add-item levels. | ||||
Control | 1..1 | ||||
Type | BackboneElement | ||||
Must Support | true | ||||
Requirements | Some insurers will receive line-items but provide the adjudication only at a summary or header-level. | ||||
Comments | Indicates the in network or out of network payment status of the claim. (142) | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
346. ExplanationOfBenefit.adjudication:benefitpaymentstatus.id | |||||
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||||
Control | 0..1 | ||||
Type | string | ||||
XML Representation | In the XML format, this property is represented as an attribute. | ||||
347. ExplanationOfBenefit.adjudication:benefitpaymentstatus.extension | |||||
Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | ||||
Control | 0..* | ||||
Type | Extension | ||||
Alternate Names | extensionsuser content | ||||
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists()) | ||||
348. ExplanationOfBenefit.adjudication:benefitpaymentstatus.modifierExtension | |||||
Definition | May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). | ||||
Control | 0..* | ||||
Type | Extension | ||||
Is Modifier | 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 | extensionsuser contentmodifiers | ||||
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. | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists()) | ||||
349. ExplanationOfBenefit.adjudication:benefitpaymentstatus.category | |||||
Definition | A code to indicate the information type of this adjudication record. Information types may include: the value submitted, maximum values or percentages allowed or payable under the plan, amounts that the patient is responsible for in-aggregate or pertaining to this item, amounts paid by other coverages, and the benefit payable for this item. | ||||
Control | 1..1 | ||||
Binding | For example codes, see AdjudicationValueCodes The adjudication codes | ||||
Type | CodeableConcept | ||||
Requirements | Needed to enable understanding of the context of the other information in the adjudication. | ||||
Comments | For example, codes indicating: Co-Pay, deductible, eligible, benefit, tax, etc. | ||||
Pattern Value | <valueCodeableConcept xmlns="http://hl7.org/fhir"> <coding> <system value="http://hl7.org/fhir/us/carin-bb/CodeSystem/C4BBAdjudicationDiscriminator"/> <code value="benefitpaymentstatus"/> </coding> </valueCodeableConcept> | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
350. ExplanationOfBenefit.adjudication:benefitpaymentstatus.reason | |||||
Definition | A code supporting the understanding of the adjudication result and explaining variance from expected amount. | ||||
Control | 1..1 | ||||
Binding | The codes SHALL be taken from C4BB Payer Benefit Payment Status Value Set | ||||
Type | CodeableConcept | ||||
Must Support | true | ||||
Requirements | To support understanding of variance from adjudication expectations. | ||||
Comments | For example, may indicate that the funds for this benefit type have been exhausted. | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
351. ExplanationOfBenefit.adjudication:benefitpaymentstatus.amount | |||||
Definition | Monetary amount associated with the category. | ||||
Control | 0..1 | ||||
Type | Money | ||||
Requirements | Most adjuciation categories convey a monetary amount. | ||||
Comments | For example, amount submitted, eligible amount, co-payment, and benefit payable. | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
352. ExplanationOfBenefit.adjudication:benefitpaymentstatus.value | |||||
Definition | A non-monetary value associated with the category. Mutually exclusive to the amount element above. | ||||
Control | 0..1 | ||||
Type | decimal | ||||
Requirements | Some adjudication categories convey a percentage or a fixed value. | ||||
Comments | For example: eligible percentage or co-payment percentage. | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
353. ExplanationOfBenefit.total | |||||
Definition | Categorized monetary totals for the adjudication. | ||||
Control | 1..* | ||||
Type | BackboneElement | ||||
Must Support | true | ||||
Requirements | To provide the requestor with financial totals by category for the adjudication. | ||||
Comments | Totals for amounts submitted, co-pays, benefits payable etc. | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
Slicing | This element introduces a set of slices on ExplanationOfBenefit.total. The slices are unordered and Open, and can be differentiated using the following discriminators:
| ||||
354. 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. | ||||
Control | 0..1 | ||||
Type | string | ||||
XML Representation | In the XML format, this property is represented as an attribute. | ||||
355. 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. | ||||
Control | 0..* | ||||
Type | Extension | ||||
Alternate Names | extensionsuser content | ||||
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists()) | ||||
356. 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). | ||||
Control | 0..* | ||||
Type | Extension | ||||
Is Modifier | 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 | extensionsuser contentmodifiers | ||||
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. | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists()) | ||||
357. 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. | ||||
Control | 1..1 | ||||
Binding | The codes SHALL be taken from C4BB Total Category Discriminator Value Set; other codes may be used where these codes are not suitable | ||||
Type | CodeableConcept | ||||
Must Support | true | ||||
Requirements | Needed to convey the type of total provided. | ||||
Comments | For example, codes indicating: Co-Pay, deductible, eligible, benefit, tax, etc. | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
358. ExplanationOfBenefit.total.amount | |||||
Definition | Monetary total amount associated with the category. | ||||
Control | 1..1 | ||||
Type | Money | ||||
Must Support | true | ||||
Requirements | Needed to convey the total monetary amount. | ||||
Comments | Total amount for each category (i.e., submitted, allowed, etc.) (148) | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
359. ExplanationOfBenefit.total:adjudicationamounttype | |||||
SliceName | adjudicationamounttype | ||||
Definition | Categorized monetary totals for the adjudication. | ||||
Control | 1..* | ||||
Type | BackboneElement | ||||
Must Support | true | ||||
Requirements | To provide the requestor with financial totals by category for the adjudication. | ||||
Comments | Describes the various amount fields used when payers receive and adjudicate a claim. (187) | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
360. ExplanationOfBenefit.total:adjudicationamounttype.id | |||||
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||||
Control | 0..1 | ||||
Type | string | ||||
XML Representation | In the XML format, this property is represented as an attribute. | ||||
361. ExplanationOfBenefit.total:adjudicationamounttype.extension | |||||
Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | ||||
Control | 0..* | ||||
Type | Extension | ||||
Alternate Names | extensionsuser content | ||||
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists()) | ||||
362. ExplanationOfBenefit.total:adjudicationamounttype.modifierExtension | |||||
Definition | May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). | ||||
Control | 0..* | ||||
Type | Extension | ||||
Is Modifier | 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 | extensionsuser contentmodifiers | ||||
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. | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists()) | ||||
363. ExplanationOfBenefit.total:adjudicationamounttype.category | |||||
Definition | A code to indicate the information type of this adjudication record. Information types may include: the value submitted, maximum values or percentages allowed or payable under the plan, amounts that the patient is responsible for in aggregate or pertaining to this item, amounts paid by other coverages, and the benefit payable for this item. | ||||
Control | 1..1 | ||||
Binding | The codes SHALL be taken from C4BB Adjudication Value Set | ||||
Type | CodeableConcept | ||||
Requirements | Needed to convey the type of total provided. | ||||
Comments | For example, codes indicating: Co-Pay, deductible, eligible, benefit, tax, etc. | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
364. ExplanationOfBenefit.total:adjudicationamounttype.amount | |||||
Definition | Monetary total amount associated with the category. | ||||
Control | 1..1 | ||||
Type | Money | ||||
Must Support | true | ||||
Requirements | Needed to convey the total monetary amount. | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
365. ExplanationOfBenefit.payment | |||||
Definition | Payment details for the adjudication of the claim. | ||||
Control | 0..1 | ||||
Type | BackboneElement | ||||
Must Support | true | ||||
Requirements | Needed to convey references to the financial instrument that has been used if payment has been made. | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
366. 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. | ||||
Control | 0..1 | ||||
Type | string | ||||
XML Representation | In the XML format, this property is represented as an attribute. | ||||
367. 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. | ||||
Control | 0..* | ||||
Type | Extension | ||||
Alternate Names | extensionsuser content | ||||
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists()) | ||||
368. 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). | ||||
Control | 0..* | ||||
Type | Extension | ||||
Is Modifier | 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 | extensionsuser contentmodifiers | ||||
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. | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists()) | ||||
369. ExplanationOfBenefit.payment.type | |||||
Definition | Whether this represents partial or complete payment of the benefits payable. | ||||
Control | 0..1 | ||||
Binding | The codes SHALL be taken from C4BB Payer Claim Payment Status Code Value Set | ||||
Type | CodeableConcept | ||||
Must Support | true | ||||
Requirements | To advise the requestor when the insurer believes all payments to have been completed. | ||||
Comments | Indicates whether the claim was paid or denied. (91) | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
370. 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. | ||||
Control | 0..1 | ||||
Type | Money | ||||
Requirements | To advise the requestor of adjustments applied to the payment. | ||||
Comments | Insurers will deduct amounts owing from the provider (adjustment), such as a prior overpayment, from the amount owing to the provider (benefits payable) when payment is made to the provider. | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
371. ExplanationOfBenefit.payment.adjustmentReason | |||||
Definition | Reason for the payment adjustment. | ||||
Control | 0..1 | ||||
Binding | For example codes, see PaymentAdjustmentReasonCodes Payment Adjustment reason codes | ||||
Type | CodeableConcept | ||||
Requirements | Needed to clarify the monetary adjustment. | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
372. ExplanationOfBenefit.payment.date | |||||
Definition | Estimated date the payment will be issued or the actual issue date of payment. | ||||
Control | 0..1 | ||||
Type | date | ||||
Must Support | true | ||||
Requirements | To advise the payee when payment can be expected. | ||||
Comments | The date the claim was paid. (107) | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
373. ExplanationOfBenefit.payment.amount | |||||
Definition | Benefits payable less any payment adjustment. | ||||
Control | 0..1 | ||||
Type | Money | ||||
Requirements | Needed to provide the actual payment amount. | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
374. ExplanationOfBenefit.payment.identifier | |||||
Definition | Issuer's unique identifier for the payment instrument. | ||||
Note | This is a business identifier, not a resource identifier (see discussion) | ||||
Control | 0..1 | ||||
Type | Identifier | ||||
Requirements | Enable the receiver to reconcile when payment received. | ||||
Comments | For example: EFT number or check number. | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
375. ExplanationOfBenefit.formCode | |||||
Definition | A code for the form to be used for printing the content. | ||||
Control | 0..1 | ||||
Binding | For example codes, see Form Codes The forms codes | ||||
Type | CodeableConcept | ||||
Requirements | Needed to specify the specific form used for producing output for this response. | ||||
Comments | May be needed to identify specific jurisdictional forms. | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
376. ExplanationOfBenefit.form | |||||
Definition | The actual form, by reference or inclusion, for printing the content or an EOB. | ||||
Control | 0..1 | ||||
Type | Attachment | ||||
Requirements | Needed to include the specific form used for producing output for this response. | ||||
Comments | Needed to permit insurers to include the actual form. | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
377. ExplanationOfBenefit.processNote | |||||
Definition | A note that describes or explains adjudication results in a human readable form. | ||||
Control | 0..* | ||||
Type | BackboneElement | ||||
Must Support | true | ||||
Requirements | Provides the insurer specific textual explanations associated with the processing. | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
378. 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. | ||||
Control | 0..1 | ||||
Type | string | ||||
XML Representation | In the XML format, this property is represented as an attribute. | ||||
379. 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. | ||||
Control | 0..* | ||||
Type | Extension | ||||
Alternate Names | extensionsuser content | ||||
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists()) | ||||
380. 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). | ||||
Control | 0..* | ||||
Type | Extension | ||||
Is Modifier | 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 | extensionsuser contentmodifiers | ||||
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. | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists()) | ||||
381. ExplanationOfBenefit.processNote.number | |||||
Definition | A number to uniquely identify a note entry. | ||||
Control | 0..1 | ||||
Type | positiveInt | ||||
Requirements | Necessary to provide a mechanism to link from adjudications. | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
382. ExplanationOfBenefit.processNote.type | |||||
Definition | The business purpose of the note text. | ||||
Control | 0..1 | ||||
Binding | The codes SHALL be taken from NoteType The presentation types of notes | ||||
Type | code | ||||
Requirements | To convey the expectation for when the text is used. | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
383. ExplanationOfBenefit.processNote.text | |||||
Definition | The explanation or description associated with the processing. | ||||
Control | 0..1 | ||||
Type | string | ||||
Must Support | true | ||||
Requirements | Required to provide human readable explanation. | ||||
Comments | Payment denial explanation to a member, typically goes on the EOB when the payment is denied or disallowed (181) | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
384. ExplanationOfBenefit.processNote.language | |||||
Definition | A code to define the language used in the text of the note. | ||||
Control | 0..1 | ||||
Binding | The codes SHOULD be taken from CommonLanguages
A human language
| ||||
Type | CodeableConcept | ||||
Requirements | Note text may vary from the resource defined language. | ||||
Comments | Only required if the language is different from the resource language. | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
385. ExplanationOfBenefit.benefitPeriod | |||||
Definition | The term of the benefits documented in this response. | ||||
Control | 0..1 | ||||
Type | Period | ||||
Requirements | Needed as coverages may be multi-year while benefits tend to be annual therefore a separate expression of the benefit period is needed. | ||||
Comments | Not applicable when use=claim. | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
386. ExplanationOfBenefit.benefitBalance | |||||
Definition | Balance by Benefit Category. | ||||
Control | 0..* | ||||
Type | BackboneElement | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
387. 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. | ||||
Control | 0..1 | ||||
Type | string | ||||
XML Representation | In the XML format, this property is represented as an attribute. | ||||
388. 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. | ||||
Control | 0..* | ||||
Type | Extension | ||||
Alternate Names | extensionsuser content | ||||
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists()) | ||||
389. 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). | ||||
Control | 0..* | ||||
Type | Extension | ||||
Is Modifier | 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 | extensionsuser contentmodifiers | ||||
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. | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists()) | ||||
390. ExplanationOfBenefit.benefitBalance.category | |||||
Definition | Code to identify the general type of benefits under which products and services are provided. | ||||
Control | 1..1 | ||||
Binding | For example codes, see BenefitCategoryCodes Benefit categories such as: oral, medical, vision, oral-basic etc | ||||
Type | CodeableConcept | ||||
Requirements | Needed to convey the category of service or product for which eligibility is sought. | ||||
Comments | Examples include Medical Care, Periodontics, Renal Dialysis, Vision Coverage. | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
391. 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. | ||||
Control | 0..1 | ||||
Type | boolean | ||||
Requirements | Needed to identify items that are specifically excluded from the coverage. | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
392. ExplanationOfBenefit.benefitBalance.name | |||||
Definition | A short name or tag for the benefit. | ||||
Control | 0..1 | ||||
Type | string | ||||
Requirements | Required to align with other plan names. | ||||
Comments | For example: MED01, or DENT2. | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
393. ExplanationOfBenefit.benefitBalance.description | |||||
Definition | A richer description of the benefit or services covered. | ||||
Control | 0..1 | ||||
Type | string | ||||
Requirements | Needed for human readable reference. | ||||
Comments | For example, 'DENT2 covers 100% of basic, 50% of major but excludes Ortho, Implants and Cosmetic services'. | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
394. ExplanationOfBenefit.benefitBalance.network | |||||
Definition | Is a flag to indicate whether the benefits refer to in-network providers or out-of-network providers. | ||||
Control | 0..1 | ||||
Binding | For example codes, see NetworkTypeCodes Code to classify in or out of network services | ||||
Type | CodeableConcept | ||||
Requirements | Needed as in or out of network providers are treated differently under the coverage. | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
395. ExplanationOfBenefit.benefitBalance.unit | |||||
Definition | Indicates if the benefits apply to an individual or to the family. | ||||
Control | 0..1 | ||||
Binding | For example codes, see UnitTypeCodes Unit covered/serviced - individual or family | ||||
Type | CodeableConcept | ||||
Requirements | Needed for the understanding of the benefits. | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
396. ExplanationOfBenefit.benefitBalance.term | |||||
Definition | The term or period of the values such as 'maximum lifetime benefit' or 'maximum annual visits'. | ||||
Control | 0..1 | ||||
Binding | For example codes, see BenefitTermCodes Coverage unit - annual, lifetime | ||||
Type | CodeableConcept | ||||
Requirements | Needed for the understanding of the benefits. | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
397. ExplanationOfBenefit.benefitBalance.financial | |||||
Definition | Benefits Used to date. | ||||
Control | 0..* | ||||
Type | BackboneElement | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
398. 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. | ||||
Control | 0..1 | ||||
Type | string | ||||
XML Representation | In the XML format, this property is represented as an attribute. | ||||
399. 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. | ||||
Control | 0..* | ||||
Type | Extension | ||||
Alternate Names | extensionsuser content | ||||
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists()) | ||||
400. 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). | ||||
Control | 0..* | ||||
Type | Extension | ||||
Is Modifier | 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 | extensionsuser contentmodifiers | ||||
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. | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists()) | ||||
401. ExplanationOfBenefit.benefitBalance.financial.type | |||||
Definition | Classification of benefit being provided. | ||||
Control | 1..1 | ||||
Binding | For example codes, see BenefitTypeCodes Deductable, visits, co-pay, etc | ||||
Type | CodeableConcept | ||||
Requirements | Needed to convey the nature of the benefit. | ||||
Comments | For example: deductible, visits, benefit amount. | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
402. ExplanationOfBenefit.benefitBalance.financial.allowed[x] | |||||
Definition | The quantity of the benefit which is permitted under the coverage. | ||||
Control | 0..1 | ||||
Type | Choice of: unsignedInt, string, Money | ||||
[x] Note | See Choice of Data Types for further information about how to use [x] | ||||
Requirements | Needed to convey the benefits offered under the coverage. | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
403. ExplanationOfBenefit.benefitBalance.financial.used[x] | |||||
Definition | The quantity of the benefit which have been consumed to date. | ||||
Control | 0..1 | ||||
Type | Choice of: unsignedInt, Money | ||||
[x] Note | See Choice of Data Types for further information about how to use [x] | ||||
Requirements | Needed to convey the benefits consumed to date. | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |