DSTU2 STU 3 Candidate
This page is part of the FHIR Specification (v1.0.2: DSTU 2). The current version which supercedes this version is

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

7.2.5 Resource ClaimResponse - Detailed Descriptions Resource ClaimResponse - Detailed Descriptions Detailed Descriptions for the elements in the ClaimResponse resource.

Detailed Descriptions for the elements in the ClaimResponse resource.

Requirements Need to identify the issuer to target for processing and for coordination of benefit processing. Requirements To determine the relationship between the patient and the subscriber. 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 © HL7.org 2011+. FHIR DSTU2 (v1.0.2-7202) generated on Sat, Oct 24, 2015 07:43+1100. Links: Search
ClaimResponse
Definition

This resource provides the adjudication details from the processing of a Claim resource. This resource provides the adjudication details from the processing of a Claim resource.

Control 1..1
Alternate Names Alternate Names Remittance Advice Remittance Advice
Summary true
ClaimResponse.identifier
Definition

The Response business identifier. The Response business identifier.

Note This is a business identifer, not a resource identifier (see This is a business identifer, not a resource identifier (see discussion )
Control 0..*
Type Identifier
Summary true
ClaimResponse.request ClaimResponse.request[x]
Definition

Original request resource referrence. 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]
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. 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. ( 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
Summary true
ClaimResponse.originalRuleset
Definition

The style (standard) and version of the original material which was converted into this resource. 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. ( 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. 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
Summary true
ClaimResponse.created
Definition

The date when the enclosed suite of services were performed or completed. The date when the enclosed suite of services were performed or completed.

Control 0..1
Type dateTime
Summary true
ClaimResponse.organization ClaimResponse.organization[x]
Definition

The Insurer who produced this adjudicated response. 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]
Summary true
ClaimResponse.requestProvider ClaimResponse.requestProvider[x]
Definition

The practitioner who is responsible for the services rendered to the patient. 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]
Summary true
ClaimResponse.requestOrganization ClaimResponse.requestOrganization[x]
Definition

The organization which is responsible for the services rendered to the patient. 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]
Summary true
ClaimResponse.outcome
Definition

Transaction status: error, complete. Transaction status: error, complete.

Control 0..1
Binding RemittanceOutcome: The outcome of the processing. ( RemittanceOutcome: The outcome of the processing. ( Required )
Type code
Summary true
ClaimResponse.disposition
Definition

A description of the status of the adjudication. 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. Party to be reimbursed: Subscriber, provider, other.

Control 0..1
Binding Payee Type Codes: A code for the party to be reimbursed. ( 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. The first tier service adjudications for submitted services.

Control 0..*
Summary true
ClaimResponse.item.sequenceLinkId
Definition

A service line number. 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. A list of note references to the notes provided below.

Control 0..*
Type positiveInt
Summary true
ClaimResponse.item.adjudication
Definition

The adjudications results. The adjudications results.

Control 0..*
Summary true
ClaimResponse.item.adjudication.code ClaimResponse.item.adjudication.category
Definition

Code indicating: Co-Pay, deductible, eligible, benefit, tax, etc. Code indicating: Co-Pay, deductible, eligible, benefit, tax, etc.

Control 1..1
Binding Adjudication Codes: The adjudication codes. ( Adjudication Codes: The adjudication codes. ( Extensible )
Type Coding
Summary true
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
Summary true
ClaimResponse.item.adjudication.amount
Definition

Monetary amount associated with the code. 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. 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. The second tier service adjudications for submitted services.

Control 0..*
Summary true
ClaimResponse.item.detail.sequenceLinkId
Definition

A service line number. A service line number.

Control 1..1
Type positiveInt
Summary true
ClaimResponse.item.detail.adjudication
Definition

The adjudications results. The adjudications results.

Control 0..*
Summary true
ClaimResponse.item.detail.adjudication.code ClaimResponse.item.detail.adjudication.category
Definition

Code indicating: Co-Pay, deductible, eligible, benefit, tax, etc. Code indicating: Co-Pay, deductible, eligible, benefit, tax, etc.

Control 1..1
Binding Adjudication Codes: The adjudication codes. ( Adjudication Codes: The adjudication codes. ( Extensible )
Type Coding
Summary true
ClaimResponse.item.detail.adjudication.reason
Definition

Adjudication reason such as limit reached.

Control 0..1
Binding Adjudication Reason Codes: The adjudication reason codes. ( Extensible )
Type Coding
Summary true
ClaimResponse.item.detail.adjudication.amount
Definition

Monetary amount associated with the code. 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. 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. The third tier service adjudications for submitted services.

Control 0..*
Summary true
ClaimResponse.item.detail.subDetail.sequenceLinkId
Definition

A service line number. A service line number.

Control 1..1
Type positiveInt
Summary true
ClaimResponse.item.detail.subDetail.adjudication
Definition

The adjudications results. The adjudications results.

Control 0..*
Summary true
ClaimResponse.item.detail.subDetail.adjudication.code ClaimResponse.item.detail.subDetail.adjudication.category
Definition

Code indicating: Co-Pay, deductible, eligible, benefit, tax, etc. Code indicating: Co-Pay, deductible, eligible, benefit, tax, etc.

Control 1..1
Binding Adjudication Codes: The adjudication codes. ( Adjudication Codes: The adjudication codes. ( Extensible )
Type Coding
Summary true
ClaimResponse.item.detail.subDetail.adjudication.reason
Definition

Adjudication reason such as limit reached.

Control 0..1
Binding Adjudication Reason Codes: The adjudication reason codes. ( Extensible )
Type Coding
Summary true
ClaimResponse.item.detail.subDetail.adjudication.amount
Definition

Monetary amount associated with the code. 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. 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. 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. 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. A code to indicate the Professional Service or Product supplied.

Control 1..1
Binding USCLS Codes: Allowable service and product codes. ( 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.. 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. A list of note references to the notes provided below.

Control 0..*
Type positiveInt
Summary true
ClaimResponse.addItem.adjudication
Definition

The adjudications results. The adjudications results.

Control 0..*
Summary true
ClaimResponse.addItem.adjudication.code ClaimResponse.addItem.adjudication.category
Definition

Code indicating: Co-Pay, deductible, eligible, benefit, tax, etc. Code indicating: Co-Pay, deductible, eligible, benefit, tax, etc.

Control 1..1
Binding Adjudication Codes: The adjudication codes. ( Adjudication Codes: The adjudication codes. ( Extensible )
Type Coding
Summary true
ClaimResponse.addItem.adjudication.reason
Definition

Adjudication reason such as limit reached.

Control 0..1
Binding Adjudication Reason Codes: The adjudication reason codes. ( Extensible )
Type Coding
Summary true
ClaimResponse.addItem.adjudication.amount
Definition

Monetary amount associated with the code. 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. 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. 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. A code to indicate the Professional Service or Product supplied.

Control 1..1
Binding USCLS Codes: Allowable service and product codes. ( 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.. The fee charged for the professional service or product..

Control 0..1
Type Money
Summary true
ClaimResponse.addItem.detail.adjudication
Definition

The adjudications results. The adjudications results.

Control 0..*
Summary true
ClaimResponse.addItem.detail.adjudication.code ClaimResponse.addItem.detail.adjudication.category
Definition

Code indicating: Co-Pay, deductible, eligible, benefit, tax, etc. Code indicating: Co-Pay, deductible, eligible, benefit, tax, etc.

Control 1..1
Binding Adjudication Codes: The adjudication codes. ( Adjudication Codes: The adjudication codes. ( Extensible )
Type Coding
Summary true
ClaimResponse.addItem.detail.adjudication.reason
Definition

Adjudication reason such as limit reached.

Control 0..1
Binding Adjudication Reason Codes: The adjudication reason codes. ( Extensible )
Type Coding
Summary true
ClaimResponse.addItem.detail.adjudication.amount
Definition

Monetary amount associated with the code. 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. 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). 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. 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. 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. 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. 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 error codes for adjudication processing. ( Required Adjudication Error Codes: The adjudication error codes. ( Extensible )
Type Coding
Summary true
ClaimResponse.totalCost
Definition

The total cost of the services reported. The total cost of the services reported.

Control 0..1
Type Money
Requirements

This is a check value that the receiver calculates and returns. 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. 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). 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. 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. Reason for the payment adjustment.

Control 0..1
Binding Adjustment Reason Codes: Adjustment reason codes. ( Payment Adjustment Reason Codes: Payment Adjustment reason codes. ( Extensible )
Type Coding
Summary true
ClaimResponse.paymentDate
Definition

Estimated payment data. Estimated payment data.

Control 0..1
Type date
Summary true
ClaimResponse.paymentAmount
Definition

Payable less any payment adjustment. Payable less any payment adjustment.

Control 0..1
Type Money
Summary true
ClaimResponse.paymentRef
Definition

Payment identifier. Payment identifier.

Control 0..1
Type Identifier
Summary true
ClaimResponse.reserved
Definition

Status of funds reservation (For provider, for Patient, None). 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). ( 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. The form to be used for printing the content.

Control 0..1
Binding Form Codes: The forms codes. ( Form Codes: The forms codes. ( Required )
Type Coding
Summary true
ClaimResponse.note
Definition

Note text. 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. 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. The note purpose: Print/Display.

Control 0..1
Binding NoteType: The presentation types of notes. ( NoteType: The presentation types of notes. ( Required )
Type Coding
Summary true
ClaimResponse.note.text
Definition

The note text. The note text.

Control 0..1
Type string
Summary true
ClaimResponse.coverage
Definition

Financial instrument by which payment information for health care. Financial instrument by which payment information for health care.

Control 0..*
Requirements

Health care programs and insurers are significant payors of health service costs. Health care programs and insurers are significant payors of health service costs.

Summary true
ClaimResponse.coverage.sequence
Definition

A service line item. A service line item.

Control 1..1
Type positiveInt
Requirements

To maintain order of the coverages. 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. 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. To identify which coverage is being adjudicated.

Summary true
ClaimResponse.coverage.coverage ClaimResponse.coverage.coverage[x]
Definition

Reference to the program or plan identification, underwriter or payor. Reference to the program or plan identification, underwriter or payor.

Control 1..1
Type Identifier | Reference ( Coverage )
Summary [x] Note true ClaimResponse.coverage.businessArrangement See Choice of Data Types for further information about how to use [x]
Definition Requirements

The contract number of a business agreement which describes the terms and conditions. Control 0..1 Type string Need to identify the issuer to target for processing and for coordination of benefit processing.

Summary true
ClaimResponse.coverage.relationship ClaimResponse.coverage.businessArrangement
Definition

The relationship of the patient to the subscriber. The contract number of a business agreement which describes the terms and conditions.

Control 1..1 Binding Surface Codes: The code for the relationship of the patient to the subscriber. ( Example ) 0..1
Type Coding string
Summary true
ClaimResponse.coverage.preAuthRef
Definition

A list of references from the Insurer to which these services pertain. 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. To provide any pre-determination or prior authorization reference.

Summary true
ClaimResponse.coverage.claimResponse
Definition

The Coverages adjudication details. The Coverages adjudication details.

Control 0..1
Type Reference ( ClaimResponse )
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. Used by downstream payers to determine what balance remains and the net payable.

Summary true