This page is part of the FHIR Specification (v1.6.0: STU 3 Ballot 4). 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 |
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 | 1..1 |
Binding | ClaimResponseStatus: A code specifying the state of the resource instance. (Required) |
Type | code |
Is Modifier | true |
Summary | true |
ClaimResponse.request[x] | |
Definition | Original request resource referrence. |
Control | 0..1 |
Type | Identifier|Reference(Claim) |
[x] Note | See Choice of Data Types for further information about how to use [x] |
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 |
Alternate Names | BusinessVersion |
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. |
Alternate Names | OriginalBusinessVersion |
ClaimResponse.created | |
Definition | The date when the enclosed suite of services were performed or completed. |
Control | 0..1 |
Type | dateTime |
ClaimResponse.organization[x] | |
Definition | The Insurer who produced this adjudicated response. |
Control | 0..1 |
Type | Identifier|Reference(Organization) |
[x] Note | See Choice of Data Types for further information about how to use [x] |
ClaimResponse.requestProvider[x] | |
Definition | The practitioner who is responsible for the services rendered to the patient. |
Control | 0..1 |
Type | Identifier|Reference(Practitioner) |
[x] Note | See Choice of Data Types for further information about how to use [x] |
ClaimResponse.requestOrganization[x] | |
Definition | The organization which is responsible for the services rendered to the patient. |
Control | 0..1 |
Type | Identifier|Reference(Organization) |
[x] Note | See Choice of Data Types for further information about how to use [x] |
ClaimResponse.outcome | |
Definition | Processing outcome errror, partial or complete processing. |
Control | 0..1 |
Binding | Claim Processing Codes: The result of the claim processing (Example) |
Type | Coding |
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 |
Binding | Payee Type Codes: A code for the party to be reimbursed. (Example) |
Type | Coding |
ClaimResponse.item | |
Definition | The first tier service adjudications for submitted services. |
Control | 0..* |
ClaimResponse.item.sequenceLinkId | |
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 adjudications results. |
Control | 0..* |
ClaimResponse.item.adjudication.category | |
Definition | Code indicating: Co-Pay, deductible, eligible, benefit, tax, etc. |
Control | 1..1 |
Binding | Adjudication Codes: The adjudication codes. (Extensible) |
Type | Coding |
ClaimResponse.item.adjudication.reason | |
Definition | Adjudication reason such as limit reached. |
Control | 0..1 |
Binding | Adjudication Reason Codes: The adjudication reason codes. (Extensible) |
Type | Coding |
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.sequenceLinkId | |
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.sequenceLinkId | |
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.sequenceLinkId | |
Definition | List of input service items which this service line is intended to replace. |
Control | 0..* |
Type | positiveInt |
ClaimResponse.addItem.revenue | |
Definition | The type of reveneu or cost center providing the product and/or service. |
Control | 0..1 |
Binding | Example Revenue Center Codes: Codes for the revenue or cost centers supplying the service and/or products. (Example) |
Type | Coding |
ClaimResponse.addItem.category | |
Definition | Health Care Service Type Codes to identify the classification of service or benefits. |
Control | 0..1 |
Binding | Benefit SubCategory Codes: Benefit subcategories such as: oral-basic, major, glasses (Example) |
Type | Coding |
ClaimResponse.addItem.service | |
Definition | A code to indicate the Professional Service or Product supplied. |
Control | 0..1 |
Binding | USCLS Codes: Allowable service and product codes. (Example) |
Type | Coding |
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..* |
Binding | Modifier type Codes: Item type or modifiers codes, eg for Oral whether the treatment is cosmetic or associated with TMJ, or an appliance was lost or stolen. (Example) |
Type | Coding |
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.addItem.detail | |
Definition | The second tier service adjudications for payor added services. |
Control | 0..* |
ClaimResponse.addItem.detail.revenue | |
Definition | The type of reveneu or cost center providing the product and/or service. |
Control | 0..1 |
Binding | Example Revenue Center Codes: Codes for the revenue or cost centers supplying the service and/or products. (Example) |
Type | Coding |
ClaimResponse.addItem.detail.category | |
Definition | Health Care Service Type Codes to identify the classification of service or benefits. |
Control | 0..1 |
Binding | Benefit SubCategory Codes: Benefit subcategories such as: oral-basic, major, glasses (Example) |
Type | Coding |
ClaimResponse.addItem.detail.service | |
Definition | A code to indicate the Professional Service or Product supplied. |
Control | 0..1 |
Binding | USCLS Codes: Allowable service and product codes. (Example) |
Type | Coding |
ClaimResponse.addItem.detail.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..* |
Binding | Modifier type Codes: Item type or modifiers codes, eg for Oral whether the treatment is cosmetic or associated with TMJ, or an appliance was lost or stolen. (Example) |
Type | Coding |
Requirements | May impact on adjudication. |
ClaimResponse.addItem.detail.fee | |
Definition | The fee charged for the professional service or product.. |
Control | 0..1 |
Type | Money |
ClaimResponse.addItem.detail.noteNumber | |
Definition | A list of note references to the notes provided below. |
Control | 0..* |
Type | positiveInt |
ClaimResponse.addItem.detail.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.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 |
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 |
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 |
ClaimResponse.error.code | |
Definition | An error code,from a specified code system, which details why the claim could not be adjudicated. |
Control | 1..1 |
Binding | Adjudication Error Codes: The adjudication error codes. (Extensible) |
Type | Coding |
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 |
Binding | Example Payment Type Codes: The type (partial, complete) of the payment (Example) |
Type | Coding |
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 |
Binding | Payment Adjustment Reason Codes: Payment Adjustment reason codes. (Extensible) |
Type | Coding |
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 |
Binding | Funds Reservation Codes: For whom funds are to be reserved: (Patient, Provider, None). (Example) |
Type | Coding |
ClaimResponse.form | |
Definition | The form to be used for printing the content. |
Control | 0..1 |
Binding | Form Codes: The forms codes. (Required) |
Type | Coding |
ClaimResponse.note | |
Definition | Note text. |
Control | 0..* |
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 |
ClaimResponse.note.type | |
Definition | The note purpose: Print/Display. |
Control | 0..1 |
Binding | NoteType: The presentation types of notes. (Required) |
Type | Coding |
ClaimResponse.note.text | |
Definition | The note text. |
Control | 0..1 |
Type | string |
ClaimResponse.note.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 |
Binding | Common Languages: A human language. (Extensible but limited to ??) |
Type | Coding |
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. |
ClaimResponse.coverage.sequence | |
Definition | A service line item. |
Control | 1..1 |
Type | positiveInt |
Requirements | To maintain order of the coverages. |
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. |
ClaimResponse.coverage.coverage[x] | |
Definition | Reference to the program or plan identification, underwriter or payor. |
Control | 1..1 |
Type | Identifier|Reference(Coverage) |
[x] Note | See Choice of Data Types for further information about how to use [x] |
Requirements | Need to identify the issuer to target for processing and for coordination of benefit processing. |
ClaimResponse.coverage.businessArrangement | |
Definition | The contract number of a business agreement which describes the terms and conditions. |
Control | 0..1 |
Type | string |
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. |
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. |