This page is part of the FHIR Specification (v1.0.2: DSTU 2). The current version which supercedes this version is 5.0.0. For a full list of available versions, see the Directory of published versions
. Page versions: R5 R4B R4 R3 R2

Detailed Descriptions for the elements in the ClaimResponse resource.
| ClaimResponse | |
| Definition | This resource provides the adjudication details from the processing of a Claim resource. |
| Control | 1..1 |
| Alternate Names | Remittance Advice |
| Summary | true |
| ClaimResponse.identifier | |
| Definition | The Response business identifier. |
| Note | This is a business identifer, not a resource identifier (see discussion) |
| Control | 0..* |
| Type | Identifier |
| Summary | true |
| ClaimResponse.request | |
| Definition | Original request resource referrence. |
| Control | 0..1 |
| Type | Reference(Claim) |
| Summary | true |
| ClaimResponse.ruleset | |
| Definition | The version of the style of resource contents. This should be mapped to the allowable profiles for this and supporting resources. |
| Control | 0..1 |
| Binding | Ruleset Codes: The static and dynamic model to which contents conform, which may be business version or standard/version. (Example) |
| Type | Coding |
| Summary | true |
| ClaimResponse.originalRuleset | |
| Definition | The style (standard) and version of the original material which was converted into this resource. |
| Control | 0..1 |
| Binding | Ruleset Codes: The static and dynamic model to which contents conform, which may be business version or standard/version. (Example) |
| Type | Coding |
| Requirements | Knowledge of the original version can inform the processing of this instance so that information which is processable by the originating system may be generated. |
| Summary | true |
| ClaimResponse.created | |
| Definition | The date when the enclosed suite of services were performed or completed. |
| Control | 0..1 |
| Type | dateTime |
| Summary | true |
| ClaimResponse.organization | |
| Definition | The Insurer who produced this adjudicated response. |
| Control | 0..1 |
| Type | Reference(Organization) |
| Summary | true |
| ClaimResponse.requestProvider | |
| Definition | The practitioner who is responsible for the services rendered to the patient. |
| Control | 0..1 |
| Type | Reference(Practitioner) |
| Summary | true |
| ClaimResponse.requestOrganization | |
| Definition | The organization which is responsible for the services rendered to the patient. |
| Control | 0..1 |
| Type | Reference(Organization) |
| Summary | true |
| ClaimResponse.outcome | |
| Definition | Transaction status: error, complete. |
| Control | 0..1 |
| Binding | RemittanceOutcome: The outcome of the processing. (Required) |
| Type | code |
| Summary | true |
| ClaimResponse.disposition | |
| Definition | A description of the status of the adjudication. |
| Control | 0..1 |
| Type | string |
| Summary | true |
| ClaimResponse.payeeType | |
| Definition | Party to be reimbursed: Subscriber, provider, other. |
| Control | 0..1 |
| Binding | Payee Type Codes: A code for the party to be reimbursed. (Example) |
| Type | Coding |
| Summary | true |
| ClaimResponse.item | |
| Definition | The first tier service adjudications for submitted services. |
| Control | 0..* |
| Summary | true |
| ClaimResponse.item.sequenceLinkId | |
| Definition | A service line number. |
| Control | 1..1 |
| Type | positiveInt |
| Summary | true |
| ClaimResponse.item.noteNumber | |
| Definition | A list of note references to the notes provided below. |
| Control | 0..* |
| Type | positiveInt |
| Summary | true |
| ClaimResponse.item.adjudication | |
| Definition | The adjudications results. |
| Control | 0..* |
| Summary | true |
| ClaimResponse.item.adjudication.code | |
| Definition | Code indicating: Co-Pay, deductible, eligible, benefit, tax, etc. |
| Control | 1..1 |
| Binding | Adjudication Codes: The adjudication codes. (Extensible) |
| Type | Coding |
| Summary | true |
| ClaimResponse.item.adjudication.amount | |
| Definition | Monetary amount associated with the code. |
| Control | 0..1 |
| Type | Money |
| Summary | true |
| ClaimResponse.item.adjudication.value | |
| Definition | A non-monetary value for example a percentage. Mutually exclusive to the amount element above. |
| Control | 0..1 |
| Type | decimal |
| Summary | true |
| ClaimResponse.item.detail | |
| Definition | The second tier service adjudications for submitted services. |
| Control | 0..* |
| Summary | true |
| ClaimResponse.item.detail.sequenceLinkId | |
| Definition | A service line number. |
| Control | 1..1 |
| Type | positiveInt |
| Summary | true |
| ClaimResponse.item.detail.adjudication | |
| Definition | The adjudications results. |
| Control | 0..* |
| Summary | true |
| ClaimResponse.item.detail.adjudication.code | |
| Definition | Code indicating: Co-Pay, deductible, eligible, benefit, tax, etc. |
| Control | 1..1 |
| Binding | Adjudication Codes: The adjudication codes. (Extensible) |
| Type | Coding |
| Summary | true |
| ClaimResponse.item.detail.adjudication.amount | |
| Definition | Monetary amount associated with the code. |
| Control | 0..1 |
| Type | Money |
| Summary | true |
| ClaimResponse.item.detail.adjudication.value | |
| Definition | A non-monetary value for example a percentage. Mutually exclusive to the amount element above. |
| Control | 0..1 |
| Type | decimal |
| Summary | true |
| ClaimResponse.item.detail.subDetail | |
| Definition | The third tier service adjudications for submitted services. |
| Control | 0..* |
| Summary | true |
| ClaimResponse.item.detail.subDetail.sequenceLinkId | |
| Definition | A service line number. |
| Control | 1..1 |
| Type | positiveInt |
| Summary | true |
| ClaimResponse.item.detail.subDetail.adjudication | |
| Definition | The adjudications results. |
| Control | 0..* |
| Summary | true |
| ClaimResponse.item.detail.subDetail.adjudication.code | |
| Definition | Code indicating: Co-Pay, deductible, eligible, benefit, tax, etc. |
| Control | 1..1 |
| Binding | Adjudication Codes: The adjudication codes. (Extensible) |
| Type | Coding |
| Summary | true |
| ClaimResponse.item.detail.subDetail.adjudication.amount | |
| Definition | Monetary amount associated with the code. |
| Control | 0..1 |
| Type | Money |
| Summary | true |
| ClaimResponse.item.detail.subDetail.adjudication.value | |
| Definition | A non-monetary value for example a percentage. Mutually exclusive to the amount element above. |
| Control | 0..1 |
| Type | decimal |
| Summary | true |
| ClaimResponse.addItem | |
| Definition | The first tier service adjudications for payor added services. |
| Control | 0..* |
| Summary | true |
| ClaimResponse.addItem.sequenceLinkId | |
| Definition | List of input service items which this service line is intended to replace. |
| Control | 0..* |
| Type | positiveInt |
| Summary | true |
| ClaimResponse.addItem.service | |
| Definition | A code to indicate the Professional Service or Product supplied. |
| Control | 1..1 |
| Binding | USCLS Codes: Allowable service and product codes. (Example) |
| Type | Coding |
| Summary | true |
| ClaimResponse.addItem.fee | |
| Definition | The fee charged for the professional service or product.. |
| Control | 0..1 |
| Type | Money |
| Summary | true |
| ClaimResponse.addItem.noteNumberLinkId | |
| Definition | A list of note references to the notes provided below. |
| Control | 0..* |
| Type | positiveInt |
| Summary | true |
| ClaimResponse.addItem.adjudication | |
| Definition | The adjudications results. |
| Control | 0..* |
| Summary | true |
| ClaimResponse.addItem.adjudication.code | |
| Definition | Code indicating: Co-Pay, deductible, eligible, benefit, tax, etc. |
| Control | 1..1 |
| Binding | Adjudication Codes: The adjudication codes. (Extensible) |
| Type | Coding |
| Summary | true |
| ClaimResponse.addItem.adjudication.amount | |
| Definition | Monetary amount associated with the code. |
| Control | 0..1 |
| Type | Money |
| Summary | true |
| ClaimResponse.addItem.adjudication.value | |
| Definition | A non-monetary value for example a percentage. Mutually exclusive to the amount element above. |
| Control | 0..1 |
| Type | decimal |
| Summary | true |
| ClaimResponse.addItem.detail | |
| Definition | The second tier service adjudications for payor added services. |
| Control | 0..* |
| Summary | true |
| ClaimResponse.addItem.detail.service | |
| Definition | A code to indicate the Professional Service or Product supplied. |
| Control | 1..1 |
| Binding | USCLS Codes: Allowable service and product codes. (Example) |
| Type | Coding |
| Summary | true |
| ClaimResponse.addItem.detail.fee | |
| Definition | The fee charged for the professional service or product.. |
| Control | 0..1 |
| Type | Money |
| Summary | true |
| ClaimResponse.addItem.detail.adjudication | |
| Definition | The adjudications results. |
| Control | 0..* |
| Summary | true |
| ClaimResponse.addItem.detail.adjudication.code | |
| Definition | Code indicating: Co-Pay, deductible, eligible, benefit, tax, etc. |
| Control | 1..1 |
| Binding | Adjudication Codes: The adjudication codes. (Extensible) |
| Type | Coding |
| Summary | true |
| ClaimResponse.addItem.detail.adjudication.amount | |
| Definition | Monetary amount associated with the code. |
| Control | 0..1 |
| Type | Money |
| Summary | true |
| ClaimResponse.addItem.detail.adjudication.value | |
| Definition | A non-monetary value for example a percentage. Mutually exclusive to the amount element above. |
| Control | 0..1 |
| Type | decimal |
| Summary | true |
| ClaimResponse.error | |
| Definition | Mutually exclusive with Services Provided (Item). |
| Control | 0..* |
| Summary | true |
| ClaimResponse.error.sequenceLinkId | |
| Definition | The sequence number of the line item submitted which contains the error. This value is omitted when the error is elsewhere. |
| Control | 0..1 |
| Type | positiveInt |
| Summary | true |
| ClaimResponse.error.detailSequenceLinkId | |
| Definition | The sequence number of the addition within the line item submitted which contains the error. This value is omitted when the error is not related to an Addition. |
| Control | 0..1 |
| Type | positiveInt |
| Summary | true |
| ClaimResponse.error.subdetailSequenceLinkId | |
| Definition | The sequence number of the addition within the line item submitted which contains the error. This value is omitted when the error is not related to an Addition. |
| Control | 0..1 |
| Type | positiveInt |
| Summary | true |
| ClaimResponse.error.code | |
| Definition | An error code,froma specified code system, which details why the claim could not be adjudicated. |
| Control | 1..1 |
| Binding | Adjudication Error Codes: The error codes for adjudication processing. (Required) |
| Type | Coding |
| Summary | true |
| ClaimResponse.totalCost | |
| Definition | The total cost of the services reported. |
| Control | 0..1 |
| Type | Money |
| Requirements | This is a check value that the receiver calculates and returns. |
| Summary | true |
| ClaimResponse.unallocDeductable | |
| Definition | The amount of deductible applied which was not allocated to any particular service line. |
| Control | 0..1 |
| Type | Money |
| Summary | true |
| ClaimResponse.totalBenefit | |
| Definition | Total amount of benefit payable (Equal to sum of the Benefit amounts from all detail lines and additions less the Unallocated Deductible). |
| Control | 0..1 |
| Type | Money |
| Summary | true |
| ClaimResponse.paymentAdjustment | |
| Definition | Adjustment to the payment of this transaction which is not related to adjudication of this transaction. |
| Control | 0..1 |
| Type | Money |
| Summary | true |
| ClaimResponse.paymentAdjustmentReason | |
| Definition | Reason for the payment adjustment. |
| Control | 0..1 |
| Binding | Adjustment Reason Codes: Adjustment reason codes. (Extensible) |
| Type | Coding |
| Summary | true |
| ClaimResponse.paymentDate | |
| Definition | Estimated payment data. |
| Control | 0..1 |
| Type | date |
| Summary | true |
| ClaimResponse.paymentAmount | |
| Definition | Payable less any payment adjustment. |
| Control | 0..1 |
| Type | Money |
| Summary | true |
| ClaimResponse.paymentRef | |
| Definition | Payment identifier. |
| Control | 0..1 |
| Type | Identifier |
| Summary | true |
| ClaimResponse.reserved | |
| Definition | Status of funds reservation (For provider, for Patient, None). |
| Control | 0..1 |
| Binding | Funds Reservation Codes: For whom funds are to be reserved: (Patient, Provider, None). (Example) |
| Type | Coding |
| Summary | true |
| ClaimResponse.form | |
| Definition | The form to be used for printing the content. |
| Control | 0..1 |
| Binding | Form Codes: The forms codes. (Required) |
| Type | Coding |
| Summary | true |
| ClaimResponse.note | |
| Definition | Note text. |
| Control | 0..* |
| Summary | true |
| ClaimResponse.note.number | |
| Definition | An integer associated with each note which may be referred to from each service line item. |
| Control | 0..1 |
| Type | positiveInt |
| Summary | true |
| ClaimResponse.note.type | |
| Definition | The note purpose: Print/Display. |
| Control | 0..1 |
| Binding | NoteType: The presentation types of notes. (Required) |
| Type | Coding |
| Summary | true |
| ClaimResponse.note.text | |
| Definition | The note text. |
| Control | 0..1 |
| Type | string |
| Summary | true |
| ClaimResponse.coverage | |
| Definition | Financial instrument by which payment information for health care. |
| Control | 0..* |
| Requirements | Health care programs and insurers are significant payors of health service costs. |
| Summary | true |
| ClaimResponse.coverage.sequence | |
| Definition | A service line item. |
| Control | 1..1 |
| Type | positiveInt |
| Requirements | To maintain order of the coverages. |
| Summary | true |
| ClaimResponse.coverage.focal | |
| Definition | The instance number of the Coverage which is the focus for adjudication. The Coverage against which the claim is to be adjudicated. |
| Control | 1..1 |
| Type | boolean |
| Requirements | To identify which coverage is being adjudicated. |
| Summary | true |
| ClaimResponse.coverage.coverage | |
| Definition | Reference to the program or plan identification, underwriter or payor. |
| Control | 1..1 |
| Type | Reference(Coverage) |
| Requirements | Need to identify the issuer to target for processing and for coordination of benefit processing. |
| Summary | true |
| ClaimResponse.coverage.businessArrangement | |
| Definition | The contract number of a business agreement which describes the terms and conditions. |
| Control | 0..1 |
| Type | string |
| Summary | true |
| ClaimResponse.coverage.relationship | |
| Definition | The relationship of the patient to the subscriber. |
| Control | 1..1 |
| Binding | Surface Codes: The code for the relationship of the patient to the subscriber. (Example) |
| Type | Coding |
| Requirements | To determine the relationship between the patient and the subscriber. |
| Summary | true |
| ClaimResponse.coverage.preAuthRef | |
| Definition | A list of references from the Insurer to which these services pertain. |
| Control | 0..* |
| Type | string |
| Requirements | To provide any pre-determination or prior authorization reference. |
| Summary | true |
| ClaimResponse.coverage.claimResponse | |
| Definition | The Coverages adjudication details. |
| Control | 0..1 |
| Type | Reference(ClaimResponse) |
| Requirements | Used by downstream payers to determine what balance remains and the net payable. |
| Summary | true |
| ClaimResponse.coverage.originalRuleset | |
| Definition | The style (standard) and version of the original material which was converted into this resource. |
| Control | 0..1 |
| Binding | Ruleset Codes: The static and dynamic model to which contents conform, which may be business version or standard/version. (Example) |
| Type | Coding |
| Requirements | Knowledge of the original version can inform the processing of this instance so that information which is processable by the originating system may be generated. |
| Summary | true |