This page is part of the FHIR Specification (v3.2.0: R4 Ballot 1). 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
Financial Management Work Group | Maturity Level: 2 | Trial Use | Compartments: Patient, Practitioner |
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 |
ClaimResponse.identifier | |
Definition | The Response business identifier. |
Note | This is a business identifer, not a resource identifier (see discussion) |
Control | 0..* |
Type | Identifier |
ClaimResponse.status | |
Definition | The status of the resource instance. |
Control | 0..1 |
Terminology Binding | Financial Resource Status Codes (Required) |
Type | code |
Is Modifier | true |
Summary | true |
Comments | This element is labeled as a modifier because the status contains the code cancelled and entered-in-error that mark the response as not currently valid. |
ClaimResponse.patient | |
Definition | Patient Resource. |
Control | 0..1 |
Type | Reference(Patient) |
ClaimResponse.created | |
Definition | The date when the enclosed suite of services were performed or completed. |
Control | 0..1 |
Type | dateTime |
ClaimResponse.insurer | |
Definition | The Insurer who produced this adjudicated response. |
Control | 0..1 |
Type | Reference(Organization) |
ClaimResponse.requestProvider | |
Definition | The practitioner who is responsible for the services rendered to the patient. |
Control | 0..1 |
Type | Reference(Practitioner) |
ClaimResponse.requestOrganization | |
Definition | The organization which is responsible for the services rendered to the patient. |
Control | 0..1 |
Type | Reference(Organization) |
ClaimResponse.request | |
Definition | Original request resource referrence. |
Control | 0..1 |
Type | Reference(Claim) |
ClaimResponse.outcome | |
Definition | Transaction: error, complete, partial processing. |
Control | 0..1 |
Terminology Binding | Claim Processing Codes (Required) |
Type | code |
ClaimResponse.disposition | |
Definition | A description of the status of the adjudication. |
Control | 0..1 |
Type | string |
ClaimResponse.payeeType | |
Definition | Party to be reimbursed: Subscriber, provider, other. |
Control | 0..1 |
Terminology Binding | Claim Payee Type Codes (Example) |
Type | CodeableConcept |
ClaimResponse.item | |
Definition | The first tier service adjudications for submitted services. |
Control | 0..* |
ClaimResponse.item.itemSequence | |
Definition | A service line number. |
Control | 1..1 |
Type | positiveInt |
ClaimResponse.item.noteNumber | |
Definition | A list of note references to the notes provided below. |
Control | 0..* |
Type | positiveInt |
ClaimResponse.item.adjudication | |
Definition | The adjudication results. |
Control | 0..* |
ClaimResponse.item.adjudication.category | |
Definition | Code indicating: Co-Pay, deductible, eligible, benefit, tax, etc. |
Control | 1..1 |
Terminology Binding | Adjudication Value Codes (Example) |
Type | CodeableConcept |
ClaimResponse.item.adjudication.reason | |
Definition | Adjudication reason such as limit reached. |
Control | 0..1 |
Terminology Binding | Adjudication Reason Codes (Example) |
Type | CodeableConcept |
ClaimResponse.item.adjudication.amount | |
Definition | Monetary amount associated with the code. |
Control | 0..1 |
Type | Money |
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 |
ClaimResponse.item.detail | |
Definition | The second tier service adjudications for submitted services. |
Control | 0..* |
ClaimResponse.item.detail.detailSequence | |
Definition | A service line number. |
Control | 1..1 |
Type | positiveInt |
ClaimResponse.item.detail.noteNumber | |
Definition | A list of note references to the notes provided below. |
Control | 0..* |
Type | positiveInt |
ClaimResponse.item.detail.adjudication | |
Definition | The adjudications results. |
Control | 0..* |
Type | See ClaimResponse.item.adjudication |
ClaimResponse.item.detail.subDetail | |
Definition | The third tier service adjudications for submitted services. |
Control | 0..* |
ClaimResponse.item.detail.subDetail.subDetailSequence | |
Definition | A service line number. |
Control | 1..1 |
Type | positiveInt |
ClaimResponse.item.detail.subDetail.noteNumber | |
Definition | A list of note references to the notes provided below. |
Control | 0..* |
Type | positiveInt |
ClaimResponse.item.detail.subDetail.adjudication | |
Definition | The adjudications results. |
Control | 0..* |
Type | See ClaimResponse.item.adjudication |
ClaimResponse.addItem | |
Definition | The first tier service adjudications for payor added services. |
Control | 0..* |
ClaimResponse.addItem.itemSequence | |
Definition | List of input service items which this service line is intended to replace. |
Control | 0..* |
Type | positiveInt |
ClaimResponse.addItem.detailSequence | |
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..* |
Type | positiveInt |
ClaimResponse.addItem.subdetailSequence | |
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..* |
Type | positiveInt |
ClaimResponse.addItem.service | |
Definition | A code to indicate the Professional Service or Product supplied. |
Control | 0..1 |
Terminology Binding | USCLS Codes (Example) |
Type | CodeableConcept |
ClaimResponse.addItem.modifier | |
Definition | Item typification or modifiers codes, eg for Oral whether the treatment is cosmetic or associated with TMJ, or for medical whether the treatment was outside the clinic or out of office hours. |
Control | 0..* |
Terminology Binding | Modifier type Codes (Example) |
Type | CodeableConcept |
Requirements | May impact on adjudication. |
ClaimResponse.addItem.fee | |
Definition | The fee charged for the professional service or product.. |
Control | 0..1 |
Type | Money |
ClaimResponse.addItem.noteNumber | |
Definition | A list of note references to the notes provided below. |
Control | 0..* |
Type | positiveInt |
ClaimResponse.addItem.adjudication | |
Definition | The adjudications results. |
Control | 0..* |
Type | See ClaimResponse.item.adjudication |
ClaimResponse.error | |
Definition | Mutually exclusive with Services Provided (Item). |
Control | 0..* |
ClaimResponse.error.itemSequence | |
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 |
ClaimResponse.error.detailSequence | |
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 |
ClaimResponse.error.subDetailSequence | |
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 |
ClaimResponse.error.code | |
Definition | An error code,from a specified code system, which details why the claim could not be adjudicated. |
Control | 1..1 |
Terminology Binding | Adjudication Error Codes (Example) |
Type | CodeableConcept |
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. |
ClaimResponse.unallocDeductable | |
Definition | The amount of deductible applied which was not allocated to any particular service line. |
Control | 0..1 |
Type | Money |
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 |
ClaimResponse.payment | |
Definition | Payment details for the claim if the claim has been paid. |
Control | 0..1 |
ClaimResponse.payment.type | |
Definition | Whether this represents partial or complete payment of the claim. |
Control | 0..1 |
Terminology Binding | Example Payment Type Codes (Example) |
Type | CodeableConcept |
ClaimResponse.payment.adjustment | |
Definition | Adjustment to the payment of this transaction which is not related to adjudication of this transaction. |
Control | 0..1 |
Type | Money |
ClaimResponse.payment.adjustmentReason | |
Definition | Reason for the payment adjustment. |
Control | 0..1 |
Terminology Binding | Payment Adjustment Reason Codes (Example) |
Type | CodeableConcept |
ClaimResponse.payment.date | |
Definition | Estimated payment data. |
Control | 0..1 |
Type | date |
ClaimResponse.payment.amount | |
Definition | Payable less any payment adjustment. |
Control | 0..1 |
Type | Money |
ClaimResponse.payment.identifier | |
Definition | Payment identifier. |
Note | This is a business identifer, not a resource identifier (see discussion) |
Control | 0..1 |
Type | Identifier |
ClaimResponse.reserved | |
Definition | Status of funds reservation (For provider, for Patient, None). |
Control | 0..1 |
Terminology Binding | Funds Reservation Codes (Example) |
Type | Coding |
ClaimResponse.form | |
Definition | The form to be used for printing the content. |
Control | 0..1 |
Terminology Binding | Form Codes (Example) |
Type | CodeableConcept |
ClaimResponse.processNote | |
Definition | Note text. |
Control | 0..* |
ClaimResponse.processNote.number | |
Definition | An integer associated with each note which may be referred to from each service line item. |
Control | 0..1 |
Type | positiveInt |
ClaimResponse.processNote.type | |
Definition | The note purpose: Print/Display. |
Control | 0..1 |
Terminology Binding | NoteType (Required) |
Type | code |
ClaimResponse.processNote.text | |
Definition | The note text. |
Control | 0..1 |
Type | string |
ClaimResponse.processNote.language | |
Definition | The ISO-639-1 alpha 2 code in lower case for the language, optionally followed by a hyphen and the ISO-3166-1 alpha 2 code for the region in upper case; e.g. "en" for English, or "en-US" for American English versus "en-EN" for England English. |
Control | 0..1 |
Terminology Binding | Common Languages (Extensible but limited to ??) |
Type | CodeableConcept |
ClaimResponse.communicationRequest | |
Definition | Request for additional supporting or authorizing information, such as: documents, images or resources. |
Control | 0..* |
Type | Reference(CommunicationRequest) |
ClaimResponse.insurance | |
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. |
ClaimResponse.insurance.sequence | |
Definition | A service line item. |
Control | 1..1 |
Type | positiveInt |
Requirements | To maintain order of the coverages. |
ClaimResponse.insurance.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. |
ClaimResponse.insurance.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. |
ClaimResponse.insurance.businessArrangement | |
Definition | The contract number of a business agreement which describes the terms and conditions. |
Control | 0..1 |
Type | string |
ClaimResponse.insurance.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. |
ClaimResponse.insurance.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. |