This is the Continuous Integration Build of FHIR (will be incorrect/inconsistent at times).
See the Directory of published versions
Financial Management Work Group | Maturity Level: 2 | Trial Use | Security Category: Patient | Compartments: Patient, Practitioner |
Detailed Descriptions for the elements in the ClaimResponse resource.
ClaimResponse | |||||
Element Id | ClaimResponse | ||||
Definition | This resource provides the adjudication details from the processing of a Claim resource. | ||||
Short Display | Response to a claim predetermination or preauthorization | ||||
Cardinality | 0..* | ||||
Type | DomainResource | ||||
Alternate Names | Remittance Advice | ||||
Summary | false | ||||
ClaimResponse.identifier | |||||
Element Id | ClaimResponse.identifier | ||||
Definition | A unique identifier assigned to this claim response. | ||||
Short Display | Business Identifier for a claim response | ||||
Note | This is a business identifier, not a resource identifier (see discussion) | ||||
Cardinality | 0..* | ||||
Type | Identifier | ||||
Requirements | Allows claim responses to be distinguished and referenced. | ||||
Summary | false | ||||
ClaimResponse.traceNumber | |||||
Element Id | ClaimResponse.traceNumber | ||||
Definition | Trace number for tracking purposes. May be defined at the jurisdiction level or between trading partners. | ||||
Short Display | Number for tracking | ||||
Cardinality | 0..* | ||||
Type | Identifier | ||||
Requirements | Allows partners to uniquely identify components for tracking. | ||||
Summary | false | ||||
ClaimResponse.status | |||||
Element Id | ClaimResponse.status | ||||
Definition | The status of the resource instance. | ||||
Short Display | active | cancelled | draft | entered-in-error | ||||
Cardinality | 1..1 | ||||
Terminology Binding | Financial Resource Status Codes (Required) | ||||
Type | code | ||||
Is Modifier | true (Reason: This element is labeled as a modifier because it is a status element that contains status entered-in-error which means that the resource should not be treated as valid) | ||||
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'. | ||||
Summary | true | ||||
Comments | This element is labeled as a modifier because the status contains codes that mark the resource as not currently valid. | ||||
ClaimResponse.type | |||||
Element Id | ClaimResponse.type | ||||
Definition | A finer grained suite of claim type codes which may convey additional information such as Inpatient vs Outpatient and/or a specialty service. | ||||
Short Display | More granular claim type | ||||
Cardinality | 1..1 | ||||
Terminology Binding | Claim Type Codes (Extensible) | ||||
Type | CodeableConcept | ||||
Requirements | Some jurisdictions need a finer grained claim type for routing and adjudication. | ||||
Summary | true | ||||
Comments | This may contain the local bill type codes, for example the US UB-04 bill type code or the CMS bill type. | ||||
ClaimResponse.subType | |||||
Element Id | ClaimResponse.subType | ||||
Definition | A finer grained suite of claim type codes which may convey additional information such as Inpatient vs Outpatient and/or a specialty service. | ||||
Short Display | More granular claim type | ||||
Cardinality | 0..1 | ||||
Terminology Binding | Example Claim SubType Codes (Example) | ||||
Type | CodeableConcept | ||||
Requirements | Some jurisdictions need a finer grained claim type for routing and adjudication. | ||||
Summary | false | ||||
Comments | This may contain the local bill type codes, for example the US UB-04 bill type code or the CMS bill type. | ||||
ClaimResponse.use | |||||
Element Id | ClaimResponse.use | ||||
Definition | A code to indicate whether the nature of the request is: Claim - A request to an Insurer to adjudicate the supplied charges for health care goods and services under the identified policy and to pay the determined Benefit amount, if any; Preauthorization - A request to an Insurer to adjudicate the supplied proposed future charges for health care goods and services under the identified policy and to approve the services and provide the expected benefit amounts and potentially to reserve funds to pay the benefits when Claims for the indicated services are later submitted; or, Pre-determination - A request to an Insurer to adjudicate the supplied 'what if' charges for health care goods and services under the identified policy and report back what the Benefit payable would be had the services actually been provided. | ||||
Short Display | claim | preauthorization | predetermination | ||||
Cardinality | 1..1 | ||||
Terminology Binding | Use (Required) | ||||
Type | code | ||||
Requirements | This element is required to understand the nature of the request for adjudication. | ||||
Summary | true | ||||
ClaimResponse.patient | |||||
Element Id | ClaimResponse.patient | ||||
Definition | The party to whom the professional services and/or products have been supplied or are being considered and for whom actual for facast reimbursement is sought. | ||||
Short Display | The recipient of the products and services | ||||
Cardinality | 1..1 | ||||
Type | Reference(Patient) | ||||
Requirements | The patient must be supplied to the insurer so that confirmation of coverage and service hstory may be considered as part of the authorization and/or adjudiction. | ||||
Summary | true | ||||
ClaimResponse.created | |||||
Element Id | ClaimResponse.created | ||||
Definition | The date this resource was created. | ||||
Short Display | Response creation date | ||||
Cardinality | 1..1 | ||||
Type | dateTime | ||||
Requirements | Need to record a timestamp for use by both the recipient and the issuer. | ||||
Summary | true | ||||
ClaimResponse.insurer | |||||
Element Id | ClaimResponse.insurer | ||||
Definition | The party responsible for authorization, adjudication and reimbursement. | ||||
Short Display | Party responsible for reimbursement | ||||
Cardinality | 0..1 | ||||
Type | Reference(Organization) | ||||
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. | ||||
Summary | true | ||||
ClaimResponse.requestor | |||||
Element Id | ClaimResponse.requestor | ||||
Definition | The provider which is responsible for the claim, predetermination or preauthorization. | ||||
Short Display | Party responsible for the claim | ||||
Cardinality | 0..1 | ||||
Type | Reference(Practitioner | PractitionerRole | Organization) | ||||
Summary | false | ||||
Comments | Typically this field would be 1..1 where this party is accountable for the data content within the claim but is not necessarily the facility, provider group or practitioner who provided the products and services listed within this claim resource. This field is the Billing Provider, for example, a facility, provider group, lab or practitioner.. | ||||
ClaimResponse.request | |||||
Element Id | ClaimResponse.request | ||||
Definition | Original request resource reference. | ||||
Short Display | Id of resource triggering adjudication | ||||
Cardinality | 0..1 | ||||
Type | Reference(Claim) | ||||
Summary | true | ||||
ClaimResponse.outcome | |||||
Element Id | ClaimResponse.outcome | ||||
Definition | The outcome of the claim, predetermination, or preauthorization processing. | ||||
Short Display | queued | complete | error | partial | ||||
Cardinality | 1..1 | ||||
Terminology Binding | Claim Processing Codes (Required) | ||||
Type | code | ||||
Requirements | To advise the requestor of an overall processing outcome. | ||||
Summary | true | ||||
Comments | The resource may be used to indicate that the Claim/Preauthorization/Pre-determination has been received but processing has not begun (queued); that it has been processed and one or more errors have been detected (error); no errors were detected and some of the adjudication processing has been performed (partial); or all of the adjudication processing has completed without errors (complete). | ||||
ClaimResponse.decision | |||||
Element Id | ClaimResponse.decision | ||||
Definition | The result of the claim, predetermination, or preauthorization adjudication. | ||||
Short Display | Result of the adjudication | ||||
Cardinality | 0..1 | ||||
Terminology Binding | Claim Adjudication Decision Codes (Example) | ||||
Type | CodeableConcept | ||||
Requirements | To advise the requestor of the result of the adjudication process. | ||||
Summary | true | ||||
Comments | The element is used to indicate the current state of the adjudication overall for the claim resource, for example: the request has been held (pended) for adjudication processing, for manual review or other reasons; that it has been processed and will be paid, or the outstanding paid, as submitted (approved); that no amount will be paid (denied); or that some amount between zero and the submitted amount will be paid (partial). | ||||
ClaimResponse.disposition | |||||
Element Id | ClaimResponse.disposition | ||||
Definition | A human readable description of the status of the adjudication. | ||||
Short Display | Disposition Message | ||||
Cardinality | 0..1 | ||||
Type | string | ||||
Requirements | Provided for user display. | ||||
Summary | false | ||||
ClaimResponse.preAuthRef | |||||
Element Id | ClaimResponse.preAuthRef | ||||
Definition | Reference from the Insurer which is used in later communications which refers to this adjudication. | ||||
Short Display | Preauthorization reference | ||||
Cardinality | 0..1 | ||||
Type | string | ||||
Requirements | On subsequent claims, the insurer may require the provider to quote this value. | ||||
Summary | false | ||||
Comments | This value is only present on preauthorization adjudications. | ||||
ClaimResponse.preAuthPeriod | |||||
Element Id | ClaimResponse.preAuthPeriod | ||||
Definition | The time frame during which this authorization is effective. | ||||
Short Display | Preauthorization reference effective period | ||||
Cardinality | 0..1 | ||||
Type | Period | ||||
Requirements | To convey to the provider when the authorized products and services must be supplied for the authorized adjudication to apply. | ||||
Summary | false | ||||
ClaimResponse.event | |||||
Element Id | ClaimResponse.event | ||||
Definition | Information code for an event with a corresponding date or period. | ||||
Short Display | Event information | ||||
Cardinality | 0..* | ||||
Summary | false | ||||
ClaimResponse.event.type | |||||
Element Id | ClaimResponse.event.type | ||||
Definition | A coded event such as when a service is expected or a card printed. | ||||
Short Display | Specific event | ||||
Cardinality | 1..1 | ||||
Terminology Binding | Dates Type Codes (Example) | ||||
Type | CodeableConcept | ||||
Summary | false | ||||
ClaimResponse.event.when[x] | |||||
Element Id | ClaimResponse.event.when[x] | ||||
Definition | A date or period in the past or future indicating when the event occurred or is expectd to occur. | ||||
Short Display | Occurance date or period | ||||
Cardinality | 1..1 | ||||
Type | dateTime|Period | ||||
[x] Note | See Choice of Datatypes for further information about how to use [x] | ||||
Summary | false | ||||
ClaimResponse.payeeType | |||||
Element Id | ClaimResponse.payeeType | ||||
Definition | Type of Party to be reimbursed: subscriber, provider, other. | ||||
Short Display | Party to be paid any benefits payable | ||||
Cardinality | 0..1 | ||||
Terminology Binding | Claim Payee Type Codes (Example) | ||||
Type | CodeableConcept | ||||
Requirements | Need to know who should receive payment with the most common situations being the Provider (assignment of benefits) or the Subscriber. | ||||
Summary | false | ||||
ClaimResponse.encounter | |||||
Element Id | ClaimResponse.encounter | ||||
Definition | Healthcare encounters related to this claim. | ||||
Short Display | Encounters associated with the listed treatments | ||||
Cardinality | 0..* | ||||
Type | Reference(Encounter) | ||||
Requirements | Used in some jurisdictions to link clinical events to claim items. | ||||
Summary | false | ||||
Comments | This will typically be the encounter the event occurred within, but some activities may be initiated prior to or after the official completion of an encounter but still be tied to the context of the encounter. | ||||
ClaimResponse.diagnosisRelatedGroup | |||||
Element Id | ClaimResponse.diagnosisRelatedGroup | ||||
Definition | A package billing code or bundle code used to group products and services to a particular health condition (such as heart attack) which is based on a predetermined grouping code system. | ||||
Short Display | Package billing code | ||||
Cardinality | 0..1 | ||||
Terminology Binding | Example Diagnosis Related Group Codes (Example) | ||||
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. | ||||
Summary | false | ||||
Comments | For example DRG (Diagnosis Related Group) or a bundled billing code. A patient may have a diagnosis of a Myocardial Infarction and a DRG for HeartAttack would be 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. | ||||
ClaimResponse.item | |||||
Element Id | ClaimResponse.item | ||||
Definition | A claim line. Either a simple (a product or service) or a 'group' of details which can also be a simple items or groups of sub-details. | ||||
Short Display | Adjudication for claim line items | ||||
Cardinality | 0..* | ||||
Requirements | The adjudication for items provided on the claim. | ||||
Summary | false | ||||
ClaimResponse.item.itemSequence | |||||
Element Id | ClaimResponse.item.itemSequence | ||||
Definition | A number to uniquely reference the claim item entries. | ||||
Short Display | Claim item instance identifier | ||||
Cardinality | 1..1 | ||||
Type | positiveInt | ||||
Requirements | Necessary to provide a mechanism to link the adjudication result to the submitted claim item. | ||||
Summary | false | ||||
ClaimResponse.item.traceNumber | |||||
Element Id | ClaimResponse.item.traceNumber | ||||
Definition | Trace number for tracking purposes. May be defined at the jurisdiction level or between trading partners. | ||||
Short Display | Number for tracking | ||||
Cardinality | 0..* | ||||
Type | Identifier | ||||
Requirements | Allows partners to uniquely identify components for tracking. | ||||
Summary | false | ||||
ClaimResponse.item.noteNumber | |||||
Element Id | ClaimResponse.item.noteNumber | ||||
Definition | The numbers associated with notes below which apply to the adjudication of this item. | ||||
Short Display | Applicable note numbers | ||||
Cardinality | 0..* | ||||
Type | positiveInt | ||||
Requirements | Provides a condensed manner for associating human readable descriptive explanations for adjudications on the line item. | ||||
Summary | false | ||||
ClaimResponse.item.reviewOutcome | |||||
Element Id | ClaimResponse.item.reviewOutcome | ||||
Definition | The high-level results of the adjudication if adjudication has been performed. | ||||
Short Display | Adjudication results | ||||
Cardinality | 0..1 | ||||
Summary | false | ||||
ClaimResponse.item.reviewOutcome.decision | |||||
Element Id | ClaimResponse.item.reviewOutcome.decision | ||||
Definition | The result of the claim, predetermination, or preauthorization adjudication. | ||||
Short Display | Result of the adjudication | ||||
Cardinality | 0..1 | ||||
Terminology Binding | Claim Adjudication Decision Codes (Example) | ||||
Type | CodeableConcept | ||||
Requirements | To advise the requestor of the result of the adjudication process. | ||||
Summary | false | ||||
Comments | The element is used to indicate the current state of the adjudication overall for the claim resource, for example: the request has been held (pended) for adjudication processing, for manual review or other reasons; that it has been processed and will be paid, or the outstanding paid, as submitted (approved); that no amount will be paid (denied); or that some amount between zero and the submitted amount will be paid (partial). | ||||
ClaimResponse.item.reviewOutcome.reason | |||||
Element Id | ClaimResponse.item.reviewOutcome.reason | ||||
Definition | The reasons for the result of the claim, predetermination, or preauthorization adjudication. | ||||
Short Display | Reason for result of the adjudication | ||||
Cardinality | 0..* | ||||
Terminology Binding | Claim Adjudication Decision Reason Codes (Example) | ||||
Type | CodeableConcept | ||||
Requirements | To advise the requestor of the contributors to the result of the adjudication process. | ||||
Summary | false | ||||
ClaimResponse.item.reviewOutcome.preAuthRef | |||||
Element Id | ClaimResponse.item.reviewOutcome.preAuthRef | ||||
Definition | Reference from the Insurer which is used in later communications which refers to this adjudication. | ||||
Short Display | Preauthorization reference | ||||
Cardinality | 0..1 | ||||
Type | string | ||||
Requirements | On subsequent claims, the insurer may require the provider to quote this value. | ||||
Summary | false | ||||
Comments | This value is only present on preauthorization adjudications. | ||||
ClaimResponse.item.reviewOutcome.preAuthPeriod | |||||
Element Id | ClaimResponse.item.reviewOutcome.preAuthPeriod | ||||
Definition | The time frame during which this authorization is effective. | ||||
Short Display | Preauthorization reference effective period | ||||
Cardinality | 0..1 | ||||
Type | Period | ||||
Requirements | To convey to the provider when the authorized products and services must be supplied for the authorized adjudication to apply. | ||||
Summary | false | ||||
ClaimResponse.item.adjudication | |||||
Element Id | ClaimResponse.item.adjudication | ||||
Definition | If this item is a group then the values here are a summary of the adjudication of the detail items. If this item is a simple product or service then this is the result of the adjudication of this item. | ||||
Short Display | Adjudication details | ||||
Cardinality | 0..* | ||||
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. | ||||
Summary | false | ||||
ClaimResponse.item.adjudication.category | |||||
Element Id | ClaimResponse.item.adjudication.category | ||||
Definition | A code to indicate the information type of this adjudication record. Information types may include the value submitted, maximum values or percentages allowed or payable under the plan, amounts that: the patient is responsible for in aggregate or pertaining to this item; amounts paid by other coverages; and, the benefit payable for this item. | ||||
Short Display | Type of adjudication information | ||||
Cardinality | 1..1 | ||||
Terminology Binding | Adjudication Value Codes (Example) | ||||
Type | CodeableConcept | ||||
Requirements | Needed to enable understanding of the context of the other information in the adjudication. | ||||
Summary | false | ||||
Comments | For example codes indicating: Co-Pay, deductible, eligible, benefit, tax, etc. | ||||
ClaimResponse.item.adjudication.reason | |||||
Element Id | ClaimResponse.item.adjudication.reason | ||||
Definition | A code supporting the understanding of the adjudication result and explaining variance from expected amount. | ||||
Short Display | Explanation of adjudication outcome | ||||
Cardinality | 0..1 | ||||
Terminology Binding | Adjudication Reason Codes (Example) | ||||
Type | CodeableConcept | ||||
Requirements | To support understanding of variance from adjudication expectations. | ||||
Summary | false | ||||
Comments | For example may indicate that the funds for this benefit type have been exhausted. | ||||
ClaimResponse.item.adjudication.amount | |||||
Element Id | ClaimResponse.item.adjudication.amount | ||||
Definition | Monetary amount associated with the category. | ||||
Short Display | Monetary amount | ||||
Cardinality | 0..1 | ||||
Type | Money | ||||
Requirements | Most adjudication categories convey a monetary amount. | ||||
Summary | false | ||||
Comments | For example: amount submitted, eligible amount, co-payment, and benefit payable. | ||||
ClaimResponse.item.adjudication.quantity | |||||
Element Id | ClaimResponse.item.adjudication.quantity | ||||
Definition | A non-monetary value associated with the category. Mutually exclusive to the amount element above. | ||||
Short Display | Non-monetary value | ||||
Cardinality | 0..1 | ||||
Type | Quantity | ||||
Requirements | Some adjudication categories convey a percentage or a fixed value. | ||||
Summary | false | ||||
Comments | For example: eligible percentage or co-payment percentage. | ||||
ClaimResponse.item.detail | |||||
Element Id | ClaimResponse.item.detail | ||||
Definition | A claim detail. Either a simple (a product or service) or a 'group' of sub-details which are simple items. | ||||
Short Display | Adjudication for claim details | ||||
Cardinality | 0..* | ||||
Requirements | The adjudication for details provided on the claim. | ||||
Summary | false | ||||
ClaimResponse.item.detail.detailSequence | |||||
Element Id | ClaimResponse.item.detail.detailSequence | ||||
Definition | A number to uniquely reference the claim detail entry. | ||||
Short Display | Claim detail instance identifier | ||||
Cardinality | 1..1 | ||||
Type | positiveInt | ||||
Requirements | Necessary to provide a mechanism to link the adjudication result to the submitted claim detail. | ||||
Summary | false | ||||
ClaimResponse.item.detail.traceNumber | |||||
Element Id | ClaimResponse.item.detail.traceNumber | ||||
Definition | Trace number for tracking purposes. May be defined at the jurisdiction level or between trading partners. | ||||
Short Display | Number for tracking | ||||
Cardinality | 0..* | ||||
Type | Identifier | ||||
Requirements | Allows partners to uniquely identify components for tracking. | ||||
Summary | false | ||||
ClaimResponse.item.detail.noteNumber | |||||
Element Id | ClaimResponse.item.detail.noteNumber | ||||
Definition | The numbers associated with notes below which apply to the adjudication of this item. | ||||
Short Display | Applicable note numbers | ||||
Cardinality | 0..* | ||||
Type | positiveInt | ||||
Requirements | Provides a condensed manner for associating human readable descriptive explanations for adjudications on the line item. | ||||
Summary | false | ||||
ClaimResponse.item.detail.reviewOutcome | |||||
Element Id | ClaimResponse.item.detail.reviewOutcome | ||||
Definition | The high-level results of the adjudication if adjudication has been performed. | ||||
Short Display | Detail level adjudication results | ||||
Cardinality | 0..1 | ||||
Type | See ClaimResponse.item.reviewOutcome | ||||
Summary | false | ||||
ClaimResponse.item.detail.adjudication | |||||
Element Id | ClaimResponse.item.detail.adjudication | ||||
Definition | The adjudication results. | ||||
Short Display | Detail level adjudication details | ||||
Cardinality | 0..* | ||||
Type | See ClaimResponse.item.adjudication | ||||
Summary | false | ||||
ClaimResponse.item.detail.subDetail | |||||
Element Id | ClaimResponse.item.detail.subDetail | ||||
Definition | A sub-detail adjudication of a simple product or service. | ||||
Short Display | Adjudication for claim sub-details | ||||
Cardinality | 0..* | ||||
Requirements | The adjudication for sub-details provided on the claim. | ||||
Summary | false | ||||
ClaimResponse.item.detail.subDetail.subDetailSequence | |||||
Element Id | ClaimResponse.item.detail.subDetail.subDetailSequence | ||||
Definition | A number to uniquely reference the claim sub-detail entry. | ||||
Short Display | Claim sub-detail instance identifier | ||||
Cardinality | 1..1 | ||||
Type | positiveInt | ||||
Requirements | Necessary to provide a mechanism to link the adjudication result to the submitted claim sub-detail. | ||||
Summary | false | ||||
ClaimResponse.item.detail.subDetail.traceNumber | |||||
Element Id | ClaimResponse.item.detail.subDetail.traceNumber | ||||
Definition | Trace number for tracking purposes. May be defined at the jurisdiction level or between trading partners. | ||||
Short Display | Number for tracking | ||||
Cardinality | 0..* | ||||
Type | Identifier | ||||
Requirements | Allows partners to uniquely identify components for tracking. | ||||
Summary | false | ||||
ClaimResponse.item.detail.subDetail.noteNumber | |||||
Element Id | ClaimResponse.item.detail.subDetail.noteNumber | ||||
Definition | The numbers associated with notes below which apply to the adjudication of this item. | ||||
Short Display | Applicable note numbers | ||||
Cardinality | 0..* | ||||
Type | positiveInt | ||||
Requirements | Provides a condensed manner for associating human readable descriptive explanations for adjudications on the line item. | ||||
Summary | false | ||||
ClaimResponse.item.detail.subDetail.reviewOutcome | |||||
Element Id | ClaimResponse.item.detail.subDetail.reviewOutcome | ||||
Definition | The high-level results of the adjudication if adjudication has been performed. | ||||
Short Display | Subdetail level adjudication results | ||||
Cardinality | 0..1 | ||||
Type | See ClaimResponse.item.reviewOutcome | ||||
Summary | false | ||||
ClaimResponse.item.detail.subDetail.adjudication | |||||
Element Id | ClaimResponse.item.detail.subDetail.adjudication | ||||
Definition | The adjudication results. | ||||
Short Display | Subdetail level adjudication details | ||||
Cardinality | 0..* | ||||
Type | See ClaimResponse.item.adjudication | ||||
Summary | false | ||||
ClaimResponse.addItem | |||||
Element Id | ClaimResponse.addItem | ||||
Definition | The first-tier service adjudications for payor added product or service lines. | ||||
Short Display | Insurer added line items | ||||
Cardinality | 0..* | ||||
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. | ||||
Summary | false | ||||
ClaimResponse.addItem.itemSequence | |||||
Element Id | ClaimResponse.addItem.itemSequence | ||||
Definition | Claim items which this service line is intended to replace. | ||||
Short Display | Item sequence number | ||||
Cardinality | 0..* | ||||
Type | positiveInt | ||||
Requirements | Provides references to the claim items. | ||||
Summary | false | ||||
ClaimResponse.addItem.detailSequence | |||||
Element Id | ClaimResponse.addItem.detailSequence | ||||
Definition | The sequence number of the details within the claim item which this line is intended to replace. | ||||
Short Display | Detail sequence number | ||||
Cardinality | 0..* | ||||
Type | positiveInt | ||||
Requirements | Provides references to the claim details within the claim item. | ||||
Summary | false | ||||
ClaimResponse.addItem.subdetailSequence | |||||
Element Id | ClaimResponse.addItem.subdetailSequence | ||||
Definition | The sequence number of the sub-details within the details within the claim item which this line is intended to replace. | ||||
Short Display | Subdetail sequence number | ||||
Cardinality | 0..* | ||||
Type | positiveInt | ||||
Requirements | Provides references to the claim sub-details within the claim detail. | ||||
Summary | false | ||||
ClaimResponse.addItem.traceNumber | |||||
Element Id | ClaimResponse.addItem.traceNumber | ||||
Definition | Trace number for tracking purposes. May be defined at the jurisdiction level or between trading partners. | ||||
Short Display | Number for tracking | ||||
Cardinality | 0..* | ||||
Type | Identifier | ||||
Requirements | Allows partners to uniquely identify components for tracking. | ||||
Summary | false | ||||
ClaimResponse.addItem.provider | |||||
Element Id | ClaimResponse.addItem.provider | ||||
Definition | The providers who are authorized for the services rendered to the patient. | ||||
Short Display | Authorized providers | ||||
Cardinality | 0..* | ||||
Type | Reference(Practitioner | PractitionerRole | Organization) | ||||
Requirements | Insurer may provide authorization specifically to a restricted set of providers rather than an open authorization. | ||||
Summary | false | ||||
ClaimResponse.addItem.revenue | |||||
Element Id | ClaimResponse.addItem.revenue | ||||
Definition | The type of revenue or cost center providing the product and/or service. | ||||
Short Display | Revenue or cost center code | ||||
Cardinality | 0..1 | ||||
Terminology Binding | Example Revenue Center Codes (Example) | ||||
Type | CodeableConcept | ||||
Requirements | Needed in the processing of institutional claims. | ||||
Summary | false | ||||
ClaimResponse.addItem.productOrService | |||||
Element Id | ClaimResponse.addItem.productOrService | ||||
Definition | When the value is a group code then this item collects a set of related item details, otherwise this contains the product, service, drug or other billing code for the item. This element may be the start of a range of .productOrService codes used in conjunction with .productOrServiceEnd or it may be a solo element where .productOrServiceEnd is not used. | ||||
Short Display | Billing, service, product, or drug code | ||||
Cardinality | 0..1 | ||||
Terminology Binding | USCLS Codes (Example) | ||||
Type | CodeableConcept | ||||
Requirements | Necessary to state what was provided or done. | ||||
Summary | false | ||||
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'. | ||||
ClaimResponse.addItem.productOrServiceEnd | |||||
Element Id | ClaimResponse.addItem.productOrServiceEnd | ||||
Definition | This contains the end of a range of product, service, drug or other billing codes for the item. This element is not used when the .productOrService is a group code. This value may only be present when a .productOfService code has been provided to convey the start of the range. Typically this value may be used only with preauthorizations and not with claims. | ||||
Short Display | End of a range of codes | ||||
Cardinality | 0..1 | ||||
Terminology Binding | USCLS Codes (Example) | ||||
Type | CodeableConcept | ||||
Alternate Names | End of a range of Drug Code; Bill Code; Service Cod | ||||
Summary | false | ||||
ClaimResponse.addItem.request | |||||
Element Id | ClaimResponse.addItem.request | ||||
Definition | Request or Referral for Goods or Service to be rendered. | ||||
Short Display | Request or Referral for Service | ||||
Cardinality | 0..* | ||||
Type | Reference(DeviceRequest | MedicationRequest | NutritionOrder | ServiceRequest | SupplyRequest | VisionPrescription) | ||||
Requirements | May identify the service to be provided or provider authorization for the service. | ||||
Summary | false | ||||
ClaimResponse.addItem.modifier | |||||
Element Id | ClaimResponse.addItem.modifier | ||||
Definition | Item typification or modifiers codes to convey additional context for the product or service. | ||||
Short Display | Service/Product billing modifiers | ||||
Cardinality | 0..* | ||||
Terminology Binding | Modifier type Codes (Example) | ||||
Type | CodeableConcept | ||||
Requirements | To support inclusion of the item for adjudication or to charge an elevated fee. | ||||
Summary | false | ||||
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. | ||||
ClaimResponse.addItem.programCode | |||||
Element Id | ClaimResponse.addItem.programCode | ||||
Definition | Identifies the program under which this may be recovered. | ||||
Short Display | Program the product or service is provided under | ||||
Cardinality | 0..* | ||||
Terminology Binding | Example Program Reason Codes (Example) | ||||
Type | CodeableConcept | ||||
Requirements | Commonly used in in the identification of publicly provided program focused on population segments or disease classifications. | ||||
Summary | false | ||||
Comments | For example: Neonatal program, child dental program or drug users recovery program. | ||||
ClaimResponse.addItem.serviced[x] | |||||
Element Id | ClaimResponse.addItem.serviced[x] | ||||
Definition | The date or dates when the service or product was supplied, performed or completed. | ||||
Short Display | Date or dates of service or product delivery | ||||
Cardinality | 0..1 | ||||
Type | date|Period | ||||
[x] Note | See Choice of Datatypes 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. | ||||
Summary | false | ||||
ClaimResponse.addItem.location[x] | |||||
Element Id | ClaimResponse.addItem.location[x] | ||||
Definition | Where the product or service was provided. | ||||
Short Display | Place of service or where product was supplied | ||||
Cardinality | 0..1 | ||||
Terminology Binding | Example Service Place Codes (Example) | ||||
Type | CodeableConcept|Address|Reference(Location) | ||||
[x] Note | See Choice of Datatypes 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. | ||||
Summary | false | ||||
ClaimResponse.addItem.quantity | |||||
Element Id | ClaimResponse.addItem.quantity | ||||
Definition | The number of repetitions of a service or product. | ||||
Short Display | Count of products or services | ||||
Cardinality | 0..1 | ||||
Type | SimpleQuantity | ||||
Requirements | Required when the product or service code does not convey the quantity provided. | ||||
Summary | false | ||||
ClaimResponse.addItem.unitPrice | |||||
Element Id | ClaimResponse.addItem.unitPrice | ||||
Definition | If the item is not a group then this is the fee for the product or service, otherwise this is the total of the fees for the details of the group. | ||||
Short Display | Fee, charge or cost per item | ||||
Cardinality | 0..1 | ||||
Type | Money | ||||
Requirements | The amount charged to the patient by the provider for a single unit. | ||||
Summary | false | ||||
ClaimResponse.addItem.factor | |||||
Element Id | ClaimResponse.addItem.factor | ||||
Definition | A real number that represents a multiplier used in determining the overall value of services delivered and/or goods received. The concept of a Factor allows for a discount or surcharge multiplier to be applied to a monetary amount. | ||||
Short Display | Price scaling factor | ||||
Cardinality | 0..1 | ||||
Type | decimal | ||||
Requirements | When discounts are provided to a patient (example: Senior's discount) then this must be documented for adjudication. | ||||
Summary | false | ||||
Comments | To show a 10% senior's discount, the value entered is: 0.90 (1.00 - 0.10). | ||||
ClaimResponse.addItem.tax | |||||
Element Id | ClaimResponse.addItem.tax | ||||
Definition | The total of taxes applicable for this product or service. | ||||
Short Display | Total tax | ||||
Cardinality | 0..1 | ||||
Type | Money | ||||
Requirements | Required when taxes are not embedded in the unit price or provided as a separate service. | ||||
Summary | false | ||||
ClaimResponse.addItem.net | |||||
Element Id | ClaimResponse.addItem.net | ||||
Definition | The total amount claimed for the group (if a grouper) or the addItem. Net = unit price * quantity * factor. | ||||
Short Display | Total item cost | ||||
Cardinality | 0..1 | ||||
Type | Money | ||||
Requirements | Provides the total amount claimed for the group (if a grouper) or the line item. | ||||
Summary | false | ||||
Comments | For example, the formula: quantity * unitPrice * factor = net. Quantity and factor are assumed to be 1 if not supplied. | ||||
ClaimResponse.addItem.bodySite | |||||
Element Id | ClaimResponse.addItem.bodySite | ||||
Definition | Physical location where the service is performed or applies. | ||||
Short Display | Anatomical location | ||||
Cardinality | 0..* | ||||
Summary | false | ||||
ClaimResponse.addItem.bodySite.site | |||||
Element Id | ClaimResponse.addItem.bodySite.site | ||||
Definition | Physical service site on the patient (limb, tooth, etc.). | ||||
Short Display | Location | ||||
Cardinality | 1..* | ||||
Terminology Binding | Oral Site Codes (Example) | ||||
Type | CodeableReference(BodyStructure) | ||||
Requirements | Allows insurer to validate specific procedures. | ||||
Summary | false | ||||
Comments | For example: Providing a tooth code allows an insurer to identify a provider performing a filling on a tooth that was previously removed. | ||||
ClaimResponse.addItem.bodySite.subSite | |||||
Element Id | ClaimResponse.addItem.bodySite.subSite | ||||
Definition | A region or surface of the bodySite, e.g. limb region or tooth surface(s). | ||||
Short Display | Sub-location | ||||
Cardinality | 0..* | ||||
Terminology Binding | Surface Codes (Example) | ||||
Type | CodeableConcept | ||||
Requirements | Allows insurer to validate specific procedures. | ||||
Summary | false | ||||
ClaimResponse.addItem.noteNumber | |||||
Element Id | ClaimResponse.addItem.noteNumber | ||||
Definition | The numbers associated with notes below which apply to the adjudication of this item. | ||||
Short Display | Applicable note numbers | ||||
Cardinality | 0..* | ||||
Type | positiveInt | ||||
Requirements | Provides a condensed manner for associating human readable descriptive explanations for adjudications on the line item. | ||||
Summary | false | ||||
ClaimResponse.addItem.reviewOutcome | |||||
Element Id | ClaimResponse.addItem.reviewOutcome | ||||
Definition | The high-level results of the adjudication if adjudication has been performed. | ||||
Short Display | Added items adjudication results | ||||
Cardinality | 0..1 | ||||
Type | See ClaimResponse.item.reviewOutcome | ||||
Summary | false | ||||
ClaimResponse.addItem.adjudication | |||||
Element Id | ClaimResponse.addItem.adjudication | ||||
Definition | The adjudication results. | ||||
Short Display | Added items adjudication | ||||
Cardinality | 0..* | ||||
Type | See ClaimResponse.item.adjudication | ||||
Summary | false | ||||
ClaimResponse.addItem.detail | |||||
Element Id | ClaimResponse.addItem.detail | ||||
Definition | The second-tier service adjudications for payor added services. | ||||
Short Display | Insurer added line details | ||||
Cardinality | 0..* | ||||
Summary | false | ||||
ClaimResponse.addItem.detail.traceNumber | |||||
Element Id | ClaimResponse.addItem.detail.traceNumber | ||||
Definition | Trace number for tracking purposes. May be defined at the jurisdiction level or between trading partners. | ||||
Short Display | Number for tracking | ||||
Cardinality | 0..* | ||||
Type | Identifier | ||||
Requirements | Allows partners to uniquely identify components for tracking. | ||||
Summary | false | ||||
ClaimResponse.addItem.detail.revenue | |||||
Element Id | ClaimResponse.addItem.detail.revenue | ||||
Definition | The type of revenue or cost center providing the product and/or service. | ||||
Short Display | Revenue or cost center code | ||||
Cardinality | 0..1 | ||||
Terminology Binding | Example Revenue Center Codes (Example) | ||||
Type | CodeableConcept | ||||
Requirements | Needed in the processing of institutional claims. | ||||
Summary | false | ||||
ClaimResponse.addItem.detail.productOrService | |||||
Element Id | ClaimResponse.addItem.detail.productOrService | ||||
Definition | When the value is a group code then this item collects a set of related item details, otherwise this contains the product, service, drug or other billing code for the item. This element may be the start of a range of .productOrService codes used in conjunction with .productOrServiceEnd or it may be a solo element where .productOrServiceEnd is not used. | ||||
Short Display | Billing, service, product, or drug code | ||||
Cardinality | 0..1 | ||||
Terminology Binding | USCLS Codes (Example) | ||||
Type | CodeableConcept | ||||
Requirements | Necessary to state what was provided or done. | ||||
Summary | false | ||||
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'. | ||||
ClaimResponse.addItem.detail.productOrServiceEnd | |||||
Element Id | ClaimResponse.addItem.detail.productOrServiceEnd | ||||
Definition | This contains the end of a range of product, service, drug or other billing codes for the item. This element is not used when the .productOrService is a group code. This value may only be present when a .productOfService code has been provided to convey the start of the range. Typically this value may be used only with preauthorizations and not with claims. | ||||
Short Display | End of a range of codes | ||||
Cardinality | 0..1 | ||||
Terminology Binding | USCLS Codes (Example) | ||||
Type | CodeableConcept | ||||
Alternate Names | End of a range of Drug Code; Bill Code; Service Cod | ||||
Summary | false | ||||
ClaimResponse.addItem.detail.modifier | |||||
Element Id | ClaimResponse.addItem.detail.modifier | ||||
Definition | Item typification or modifiers codes to convey additional context for the product or service. | ||||
Short Display | Service/Product billing modifiers | ||||
Cardinality | 0..* | ||||
Terminology Binding | Modifier type Codes (Example) | ||||
Type | CodeableConcept | ||||
Requirements | To support inclusion of the item for adjudication or to charge an elevated fee. | ||||
Summary | false | ||||
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. | ||||
ClaimResponse.addItem.detail.quantity | |||||
Element Id | ClaimResponse.addItem.detail.quantity | ||||
Definition | The number of repetitions of a service or product. | ||||
Short Display | Count of products or services | ||||
Cardinality | 0..1 | ||||
Type | SimpleQuantity | ||||
Requirements | Required when the product or service code does not convey the quantity provided. | ||||
Summary | false | ||||
ClaimResponse.addItem.detail.unitPrice | |||||
Element Id | ClaimResponse.addItem.detail.unitPrice | ||||
Definition | If the item is not a group then this is the fee for the product or service, otherwise this is the total of the fees for the details of the group. | ||||
Short Display | Fee, charge or cost per item | ||||
Cardinality | 0..1 | ||||
Type | Money | ||||
Requirements | The amount charged to the patient by the provider for a single unit. | ||||
Summary | false | ||||
ClaimResponse.addItem.detail.factor | |||||
Element Id | ClaimResponse.addItem.detail.factor | ||||
Definition | A real number that represents a multiplier used in determining the overall value of services delivered and/or goods received. The concept of a Factor allows for a discount or surcharge multiplier to be applied to a monetary amount. | ||||
Short Display | Price scaling factor | ||||
Cardinality | 0..1 | ||||
Type | decimal | ||||
Requirements | When discounts are provided to a patient (example: Senior's discount) then this must be documented for adjudication. | ||||
Summary | false | ||||
Comments | To show a 10% senior's discount, the value entered is: 0.90 (1.00 - 0.10). | ||||
ClaimResponse.addItem.detail.tax | |||||
Element Id | ClaimResponse.addItem.detail.tax | ||||
Definition | The total of taxes applicable for this product or service. | ||||
Short Display | Total tax | ||||
Cardinality | 0..1 | ||||
Type | Money | ||||
Requirements | Required when taxes are not embedded in the unit price or provided as a separate service. | ||||
Summary | false | ||||
ClaimResponse.addItem.detail.net | |||||
Element Id | ClaimResponse.addItem.detail.net | ||||
Definition | The total amount claimed for the group (if a grouper) or the addItem.detail. Net = unit price * quantity * factor. | ||||
Short Display | Total item cost | ||||
Cardinality | 0..1 | ||||
Type | Money | ||||
Requirements | Provides the total amount claimed for the group (if a grouper) or the line item. | ||||
Summary | false | ||||
Comments | For example, the formula: quantity * unitPrice * factor = net. Quantity and factor are assumed to be 1 if not supplied. | ||||
ClaimResponse.addItem.detail.noteNumber | |||||
Element Id | ClaimResponse.addItem.detail.noteNumber | ||||
Definition | The numbers associated with notes below which apply to the adjudication of this item. | ||||
Short Display | Applicable note numbers | ||||
Cardinality | 0..* | ||||
Type | positiveInt | ||||
Requirements | Provides a condensed manner for associating human readable descriptive explanations for adjudications on the line item. | ||||
Summary | false | ||||
ClaimResponse.addItem.detail.reviewOutcome | |||||
Element Id | ClaimResponse.addItem.detail.reviewOutcome | ||||
Definition | The high-level results of the adjudication if adjudication has been performed. | ||||
Short Display | Added items detail level adjudication results | ||||
Cardinality | 0..1 | ||||
Type | See ClaimResponse.item.reviewOutcome | ||||
Summary | false | ||||
ClaimResponse.addItem.detail.adjudication | |||||
Element Id | ClaimResponse.addItem.detail.adjudication | ||||
Definition | The adjudication results. | ||||
Short Display | Added items detail adjudication | ||||
Cardinality | 0..* | ||||
Type | See ClaimResponse.item.adjudication | ||||
Summary | false | ||||
ClaimResponse.addItem.detail.subDetail | |||||
Element Id | ClaimResponse.addItem.detail.subDetail | ||||
Definition | The third-tier service adjudications for payor added services. | ||||
Short Display | Insurer added line items | ||||
Cardinality | 0..* | ||||
Summary | false | ||||
ClaimResponse.addItem.detail.subDetail.traceNumber | |||||
Element Id | ClaimResponse.addItem.detail.subDetail.traceNumber | ||||
Definition | Trace number for tracking purposes. May be defined at the jurisdiction level or between trading partners. | ||||
Short Display | Number for tracking | ||||
Cardinality | 0..* | ||||
Type | Identifier | ||||
Requirements | Allows partners to uniquely identify components for tracking. | ||||
Summary | false | ||||
ClaimResponse.addItem.detail.subDetail.revenue | |||||
Element Id | ClaimResponse.addItem.detail.subDetail.revenue | ||||
Definition | The type of revenue or cost center providing the product and/or service. | ||||
Short Display | Revenue or cost center code | ||||
Cardinality | 0..1 | ||||
Terminology Binding | Example Revenue Center Codes (Example) | ||||
Type | CodeableConcept | ||||
Requirements | Needed in the processing of institutional claims. | ||||
Summary | false | ||||
ClaimResponse.addItem.detail.subDetail.productOrService | |||||
Element Id | ClaimResponse.addItem.detail.subDetail.productOrService | ||||
Definition | When the value is a group code then this item collects a set of related item details, otherwise this contains the product, service, drug or other billing code for the item. This element may be the start of a range of .productOrService codes used in conjunction with .productOrServiceEnd or it may be a solo element where .productOrServiceEnd is not used. | ||||
Short Display | Billing, service, product, or drug code | ||||
Cardinality | 0..1 | ||||
Terminology Binding | USCLS Codes (Example) | ||||
Type | CodeableConcept | ||||
Requirements | Necessary to state what was provided or done. | ||||
Summary | false | ||||
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'. | ||||
ClaimResponse.addItem.detail.subDetail.productOrServiceEnd | |||||
Element Id | ClaimResponse.addItem.detail.subDetail.productOrServiceEnd | ||||
Definition | This contains the end of a range of product, service, drug or other billing codes for the item. This element is not used when the .productOrService is a group code. This value may only be present when a .productOfService code has been provided to convey the start of the range. Typically this value may be used only with preauthorizations and not with claims. | ||||
Short Display | End of a range of codes | ||||
Cardinality | 0..1 | ||||
Terminology Binding | USCLS Codes (Example) | ||||
Type | CodeableConcept | ||||
Alternate Names | End of a range of Drug Code; Bill Code; Service Cod | ||||
Summary | false | ||||
ClaimResponse.addItem.detail.subDetail.modifier | |||||
Element Id | ClaimResponse.addItem.detail.subDetail.modifier | ||||
Definition | Item typification or modifiers codes to convey additional context for the product or service. | ||||
Short Display | Service/Product billing modifiers | ||||
Cardinality | 0..* | ||||
Terminology Binding | Modifier type Codes (Example) | ||||
Type | CodeableConcept | ||||
Requirements | To support inclusion of the item for adjudication or to charge an elevated fee. | ||||
Summary | false | ||||
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. | ||||
ClaimResponse.addItem.detail.subDetail.quantity | |||||
Element Id | ClaimResponse.addItem.detail.subDetail.quantity | ||||
Definition | The number of repetitions of a service or product. | ||||
Short Display | Count of products or services | ||||
Cardinality | 0..1 | ||||
Type | SimpleQuantity | ||||
Requirements | Required when the product or service code does not convey the quantity provided. | ||||
Summary | false | ||||
ClaimResponse.addItem.detail.subDetail.unitPrice | |||||
Element Id | ClaimResponse.addItem.detail.subDetail.unitPrice | ||||
Definition | If the item is not a group then this is the fee for the product or service, otherwise this is the total of the fees for the details of the group. | ||||
Short Display | Fee, charge or cost per item | ||||
Cardinality | 0..1 | ||||
Type | Money | ||||
Requirements | The amount charged to the patient by the provider for a single unit. | ||||
Summary | false | ||||
ClaimResponse.addItem.detail.subDetail.factor | |||||
Element Id | ClaimResponse.addItem.detail.subDetail.factor | ||||
Definition | A real number that represents a multiplier used in determining the overall value of services delivered and/or goods received. The concept of a Factor allows for a discount or surcharge multiplier to be applied to a monetary amount. | ||||
Short Display | Price scaling factor | ||||
Cardinality | 0..1 | ||||
Type | decimal | ||||
Requirements | When discounts are provided to a patient (example: Senior's discount) then this must be documented for adjudication. | ||||
Summary | false | ||||
Comments | To show a 10% senior's discount, the value entered is: 0.90 (1.00 - 0.10). | ||||
ClaimResponse.addItem.detail.subDetail.tax | |||||
Element Id | ClaimResponse.addItem.detail.subDetail.tax | ||||
Definition | The total of taxes applicable for this product or service. | ||||
Short Display | Total tax | ||||
Cardinality | 0..1 | ||||
Type | Money | ||||
Requirements | Required when taxes are not embedded in the unit price or provided as a separate service. | ||||
Summary | false | ||||
ClaimResponse.addItem.detail.subDetail.net | |||||
Element Id | ClaimResponse.addItem.detail.subDetail.net | ||||
Definition | The total amount claimed for the addItem.detail.subDetail. Net = unit price * quantity * factor. | ||||
Short Display | Total item cost | ||||
Cardinality | 0..1 | ||||
Type | Money | ||||
Requirements | Provides the total amount claimed for the group (if a grouper) or the line item. | ||||
Summary | false | ||||
Comments | For example, the formula: quantity * unitPrice * factor = net. Quantity and factor are assumed to be 1 if not supplied. | ||||
ClaimResponse.addItem.detail.subDetail.noteNumber | |||||
Element Id | ClaimResponse.addItem.detail.subDetail.noteNumber | ||||
Definition | The numbers associated with notes below which apply to the adjudication of this item. | ||||
Short Display | Applicable note numbers | ||||
Cardinality | 0..* | ||||
Type | positiveInt | ||||
Requirements | Provides a condensed manner for associating human readable descriptive explanations for adjudications on the line item. | ||||
Summary | false | ||||
ClaimResponse.addItem.detail.subDetail.reviewOutcome | |||||
Element Id | ClaimResponse.addItem.detail.subDetail.reviewOutcome | ||||
Definition | The high-level results of the adjudication if adjudication has been performed. | ||||
Short Display | Added items subdetail level adjudication results | ||||
Cardinality | 0..1 | ||||
Type | See ClaimResponse.item.reviewOutcome | ||||
Summary | false | ||||
ClaimResponse.addItem.detail.subDetail.adjudication | |||||
Element Id | ClaimResponse.addItem.detail.subDetail.adjudication | ||||
Definition | The adjudication results. | ||||
Short Display | Added items subdetail adjudication | ||||
Cardinality | 0..* | ||||
Type | See ClaimResponse.item.adjudication | ||||
Summary | false | ||||
ClaimResponse.adjudication | |||||
Element Id | ClaimResponse.adjudication | ||||
Definition | The adjudication results which are presented at the header level rather than at the line-item or add-item levels. | ||||
Short Display | Header-level adjudication | ||||
Cardinality | 0..* | ||||
Type | See ClaimResponse.item.adjudication | ||||
Requirements | Some insurers will receive line-items but provide the adjudication only at a summary or header-level. | ||||
Summary | false | ||||
ClaimResponse.total | |||||
Element Id | ClaimResponse.total | ||||
Definition | Categorized monetary totals for the adjudication. | ||||
Short Display | Adjudication totals | ||||
Cardinality | 0..* | ||||
Requirements | To provide the requestor with financial totals by category for the adjudication. | ||||
Summary | true | ||||
Comments | Totals for amounts submitted, co-pays, benefits payable etc. | ||||
ClaimResponse.total.category | |||||
Element Id | ClaimResponse.total.category | ||||
Definition | A code to indicate the information type of this adjudication record. Information types may include: the value submitted, maximum values or percentages allowed or payable under the plan, amounts that the patient is responsible for in aggregate or pertaining to this item, amounts paid by other coverages, and the benefit payable for this item. | ||||
Short Display | Type of adjudication information | ||||
Cardinality | 1..1 | ||||
Terminology Binding | Adjudication Value Codes (Example) | ||||
Type | CodeableConcept | ||||
Requirements | Needed to convey the type of total provided. | ||||
Summary | true | ||||
Comments | For example codes indicating: Co-Pay, deductible, eligible, benefit, tax, etc. | ||||
ClaimResponse.total.amount | |||||
Element Id | ClaimResponse.total.amount | ||||
Definition | Monetary total amount associated with the category. | ||||
Short Display | Financial total for the category | ||||
Cardinality | 1..1 | ||||
Type | Money | ||||
Requirements | Needed to convey the total monetary amount. | ||||
Summary | true | ||||
ClaimResponse.payment | |||||
Element Id | ClaimResponse.payment | ||||
Definition | Payment details for the adjudication of the claim. | ||||
Short Display | Payment Details | ||||
Cardinality | 0..1 | ||||
Requirements | Needed to convey references to the financial instrument that has been used if payment has been made. | ||||
Summary | false | ||||
ClaimResponse.payment.type | |||||
Element Id | ClaimResponse.payment.type | ||||
Definition | Whether this represents partial or complete payment of the benefits payable. | ||||
Short Display | Partial or complete payment | ||||
Cardinality | 1..1 | ||||
Terminology Binding | Example Payment Type Codes (Example) | ||||
Type | CodeableConcept | ||||
Requirements | To advise the requestor when the insurer believes all payments to have been completed. | ||||
Summary | false | ||||
ClaimResponse.payment.adjustment | |||||
Element Id | ClaimResponse.payment.adjustment | ||||
Definition | Total amount of all adjustments to this payment included in this transaction which are not related to this claim's adjudication. | ||||
Short Display | Payment adjustment for non-claim issues | ||||
Cardinality | 0..1 | ||||
Type | Money | ||||
Requirements | To advise the requestor of adjustments applied to the payment. | ||||
Summary | false | ||||
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. | ||||
ClaimResponse.payment.adjustmentReason | |||||
Element Id | ClaimResponse.payment.adjustmentReason | ||||
Definition | Reason for the payment adjustment. | ||||
Short Display | Explanation for the adjustment | ||||
Cardinality | 0..1 | ||||
Terminology Binding | Payment Adjustment Reason Codes (Example) | ||||
Type | CodeableConcept | ||||
Requirements | Needed to clarify the monetary adjustment. | ||||
Summary | false | ||||
ClaimResponse.payment.date | |||||
Element Id | ClaimResponse.payment.date | ||||
Definition | Estimated date the payment will be issued or the actual issue date of payment. | ||||
Short Display | Expected date of payment | ||||
Cardinality | 0..1 | ||||
Type | date | ||||
Requirements | To advise the payee when payment can be expected. | ||||
Summary | false | ||||
ClaimResponse.payment.amount | |||||
Element Id | ClaimResponse.payment.amount | ||||
Definition | Benefits payable less any payment adjustment. | ||||
Short Display | Payable amount after adjustment | ||||
Cardinality | 1..1 | ||||
Type | Money | ||||
Requirements | Needed to provide the actual payment amount. | ||||
Summary | false | ||||
ClaimResponse.payment.identifier | |||||
Element Id | ClaimResponse.payment.identifier | ||||
Definition | Issuer's unique identifier for the payment instrument. | ||||
Short Display | Business identifier for the payment | ||||
Note | This is a business identifier, not a resource identifier (see discussion) | ||||
Cardinality | 0..1 | ||||
Type | Identifier | ||||
Requirements | Enable the receiver to reconcile when payment received. | ||||
Summary | false | ||||
Comments | For example: EFT number or check number. | ||||
ClaimResponse.fundsReserve | |||||
Element Id | ClaimResponse.fundsReserve | ||||
Definition | A code, used only on a response to a preauthorization, to indicate whether the benefits payable have been reserved and for whom. | ||||
Short Display | Funds reserved status | ||||
Cardinality | 0..1 | ||||
Terminology Binding | Funds Reservation Codes (Example) | ||||
Type | CodeableConcept | ||||
Requirements | Needed to advise the submitting provider on whether the rquest for reservation of funds has been honored. | ||||
Summary | false | ||||
Comments | Fund would be release by a future claim quoting the preAuthRef of this response. Examples of values include: provider, patient, none. | ||||
ClaimResponse.formCode | |||||
Element Id | ClaimResponse.formCode | ||||
Definition | A code for the form to be used for printing the content. | ||||
Short Display | Printed form identifier | ||||
Cardinality | 0..1 | ||||
Terminology Binding | Form Codes (Example) | ||||
Type | CodeableConcept | ||||
Requirements | Needed to specify the specific form used for producing output for this response. | ||||
Summary | false | ||||
Comments | May be needed to identify specific jurisdictional forms. | ||||
ClaimResponse.form | |||||
Element Id | ClaimResponse.form | ||||
Definition | The actual form, by reference or inclusion, for printing the content or an EOB. | ||||
Short Display | Printed reference or actual form | ||||
Cardinality | 0..1 | ||||
Type | Attachment | ||||
Requirements | Needed to include the specific form used for producing output for this response. | ||||
Summary | false | ||||
Comments | Needed to permit insurers to include the actual form. | ||||
ClaimResponse.processNote | |||||
Element Id | ClaimResponse.processNote | ||||
Definition | A note that describes or explains adjudication results in a human readable form. | ||||
Short Display | Note concerning adjudication | ||||
Cardinality | 0..* | ||||
Requirements | Provides the insurer specific textual explanations associated with the processing. | ||||
Summary | false | ||||
ClaimResponse.processNote.number | |||||
Element Id | ClaimResponse.processNote.number | ||||
Definition | A number to uniquely identify a note entry. | ||||
Short Display | Note instance identifier | ||||
Cardinality | 0..1 | ||||
Type | positiveInt | ||||
Requirements | Necessary to provide a mechanism to link from adjudications. | ||||
Summary | false | ||||
ClaimResponse.processNote.type | |||||
Element Id | ClaimResponse.processNote.type | ||||
Definition | The business purpose of the note text. | ||||
Short Display | Note purpose | ||||
Cardinality | 0..1 | ||||
Terminology Binding | NoteType (Extensible) | ||||
Type | CodeableConcept | ||||
Requirements | To convey the expectation for when the text is used. | ||||
Summary | false | ||||
ClaimResponse.processNote.text | |||||
Element Id | ClaimResponse.processNote.text | ||||
Definition | The explanation or description associated with the processing. | ||||
Short Display | Note explanatory text | ||||
Cardinality | 1..1 | ||||
Type | string | ||||
Requirements | Required to provide human readable explanation. | ||||
Summary | false | ||||
ClaimResponse.processNote.language | |||||
Element Id | ClaimResponse.processNote.language | ||||
Definition | A code to define the language used in the text of the note. | ||||
Short Display | Language of the text | ||||
Cardinality | 0..1 | ||||
Terminology Binding | All Languages (Required)
| ||||
Type | CodeableConcept | ||||
Requirements | Note text may vary from the resource defined language. | ||||
Summary | false | ||||
Comments | Only required if the language is different from the resource language. | ||||
ClaimResponse.communicationRequest | |||||
Element Id | ClaimResponse.communicationRequest | ||||
Definition | Request for additional supporting or authorizing information. | ||||
Short Display | Request for additional information | ||||
Cardinality | 0..* | ||||
Type | Reference(CommunicationRequest) | ||||
Requirements | Need to communicate insurer request for additional information required to support the adjudication. | ||||
Summary | false | ||||
Comments | For example: professional reports, documents, images, clinical resources, or accident reports. | ||||
ClaimResponse.insurance | |||||
Element Id | ClaimResponse.insurance | ||||
Definition | Financial instruments for reimbursement for the health care products and services specified on the claim. | ||||
Short Display | Patient insurance information | ||||
Cardinality | 0..* | ||||
Requirements | At least one insurer is required for a claim to be a claim. | ||||
Summary | false | ||||
Comments | All insurance coverages for the patient which may be applicable for reimbursement, of the products and services listed in the claim, are typically provided in the claim to allow insurers to confirm the ordering of the insurance coverages relative to local 'coordination of benefit' rules. One coverage (and only one) with 'focal=true' is to be used in the adjudication of this claim. Coverages appearing before the focal Coverage in the list, and where 'subrogation=false', should provide a reference to the ClaimResponse containing the adjudication results of the prior claim. | ||||
ClaimResponse.insurance.sequence | |||||
Element Id | ClaimResponse.insurance.sequence | ||||
Definition | A number to uniquely identify insurance entries and provide a sequence of coverages to convey coordination of benefit order. | ||||
Short Display | Insurance instance identifier | ||||
Cardinality | 1..1 | ||||
Type | positiveInt | ||||
Requirements | To maintain order of the coverages. | ||||
Summary | false | ||||
ClaimResponse.insurance.focal | |||||
Element Id | ClaimResponse.insurance.focal | ||||
Definition | A flag to indicate that this Coverage is to be used for adjudication of this claim when set to true. | ||||
Short Display | Coverage to be used for adjudication | ||||
Cardinality | 1..1 | ||||
Type | boolean | ||||
Requirements | To identify which coverage in the list is being used to adjudicate this claim. | ||||
Summary | false | ||||
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. | ||||
ClaimResponse.insurance.coverage | |||||
Element Id | ClaimResponse.insurance.coverage | ||||
Definition | Reference to the insurance card level information contained in the Coverage resource. The coverage issuing insurer will use these details to locate the patient's actual coverage within the insurer's information system. | ||||
Short Display | Insurance information | ||||
Cardinality | 1..1 | ||||
Type | Reference(Coverage) | ||||
Requirements | Required to allow the adjudicator to locate the correct policy and history within their information system. | ||||
Summary | false | ||||
ClaimResponse.insurance.businessArrangement | |||||
Element Id | ClaimResponse.insurance.businessArrangement | ||||
Definition | A business agreement number established between the provider and the insurer for special business processing purposes. | ||||
Short Display | Additional provider contract number | ||||
Cardinality | 0..1 | ||||
Type | string | ||||
Requirements | Providers may have multiple business arrangements with a given insurer and must supply the specific contract number for adjudication. | ||||
Summary | false | ||||
ClaimResponse.insurance.claimResponse | |||||
Element Id | ClaimResponse.insurance.claimResponse | ||||
Definition | The result of the adjudication of the line items for the Coverage specified in this insurance. | ||||
Short Display | Adjudication results | ||||
Cardinality | 0..1 | ||||
Type | Reference(ClaimResponse) | ||||
Hierarchy | This reference may point back to the same instance (including transitively) | ||||
Requirements | An insurer need the adjudication results from prior insurers to determine the outstanding balance remaining by item for the items in the curent claim. | ||||
Summary | false | ||||
Comments | Must not be specified when 'focal=true' for this insurance. | ||||
ClaimResponse.error | |||||
Element Id | ClaimResponse.error | ||||
Definition | Errors encountered during the processing of the adjudication. | ||||
Short Display | Processing errors | ||||
Cardinality | 0..* | ||||
Requirements | Need to communicate processing issues to the requestor. | ||||
Summary | false | ||||
Comments | If the request contains errors then an error element should be provided and no adjudication related sections (item, addItem, or payment) should be present. | ||||
ClaimResponse.error.itemSequence | |||||
Element Id | ClaimResponse.error.itemSequence | ||||
Definition | The sequence number of the line item submitted which contains the error. This value is omitted when the error occurs outside of the item structure. | ||||
Short Display | Item sequence number | ||||
Cardinality | 0..1 | ||||
Type | positiveInt | ||||
Requirements | Provides references to the claim items. | ||||
Summary | false | ||||
ClaimResponse.error.detailSequence | |||||
Element Id | ClaimResponse.error.detailSequence | ||||
Definition | The sequence number of the detail within the line item submitted which contains the error. This value is omitted when the error occurs outside of the item structure. | ||||
Short Display | Detail sequence number | ||||
Cardinality | 0..1 | ||||
Type | positiveInt | ||||
Requirements | Provides references to the claim details within the claim item. | ||||
Summary | false | ||||
ClaimResponse.error.subDetailSequence | |||||
Element Id | ClaimResponse.error.subDetailSequence | ||||
Definition | The sequence number of the sub-detail within the detail within the line item submitted which contains the error. This value is omitted when the error occurs outside of the item structure. | ||||
Short Display | Subdetail sequence number | ||||
Cardinality | 0..1 | ||||
Type | positiveInt | ||||
Requirements | Provides references to the claim sub-details within the claim detail. | ||||
Summary | false | ||||
ClaimResponse.error.code | |||||
Element Id | ClaimResponse.error.code | ||||
Definition | An error code, from a specified code system, which details why the claim could not be adjudicated. | ||||
Short Display | Error code detailing processing issues | ||||
Cardinality | 1..1 | ||||
Terminology Binding | Adjudication Error Codes (Example) | ||||
Type | CodeableConcept | ||||
Requirements | Required to convey processing errors. | ||||
Summary | true | ||||
ClaimResponse.error.expression | |||||
Element Id | ClaimResponse.error.expression | ||||
Definition | A simple subset of FHIRPath limited to element names, repetition indicators and the default child accessor that identifies one of the elements in the resource that caused this issue to be raised. | ||||
Short Display | FHIRPath of element(s) related to issue | ||||
Cardinality | 0..* | ||||
Type | string | ||||
Requirements | Allows systems to highlight or otherwise guide users to elements implicated in issues to allow them to be fixed more easily. | ||||
Summary | true | ||||
Comments | The root of the FHIRPath is the resource or bundle that generated OperationOutcome. Each FHIRPath SHALL resolve to a single node. |