DSTU2 STU 3 Ballot
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.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 . 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 13.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.

Summary Summary Summary true true Summary true Summary true Summary true Summary true Summary true Summary true Summary true true true Summary true Binding Adjudication Codes: The adjudication codes. ( Extensible ) true true true Summary true Summary true Coding true Summary true Summary true Summary true true true Summary true true Requirements This is a check value that the receiver calculates and returns. Summary true Type Money Summary true Summary true Summary true Summary true Summary true Summary true Summary true Summary true Summary true Summary true Summary true Summary true true Requirements To provide any pre-determination or prior authorization reference. Summary true Binding Ruleset Codes: The static and dynamic model to which contents conform, which may be business version or standard/version. ( Example ) | Version History | Table of Contents | Compare to DSTU1
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 Remittance Advice Summary Alternate Names true Remittance Advice
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
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 ClaimResponse.request[x]
Definition

Original request resource referrence. Original request resource referrence.

Control 0..1
Type Identifier | Reference ( Claim )
Summary [x] Note true 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. 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 true BusinessVersion
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 true OriginalBusinessVersion
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
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 )
Summary [x] Note true See Choice of Data Types for further information about how to use [x]
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 )
Summary [x] Note true See Choice of Data Types for further information about how to use [x]
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 )
Summary [x] Note true See Choice of Data Types for further information about how to use [x]
ClaimResponse.outcome
Definition

Transaction status: error, complete. Processing outcome errror, partial or complete processing.

Control 0..1
Binding RemittanceOutcome: The outcome of the processing. ( Required Claim Processing Codes: The result of the claim processing ( Example )
Type code Summary Coding
ClaimResponse.disposition
Definition

A description of the status of the adjudication. A description of the status of the adjudication.

Control 0..1
Type string
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
ClaimResponse.item
Definition

The first tier service adjudications for submitted services. The first tier service adjudications for submitted services.

Control 0..*
ClaimResponse.item.sequenceLinkId
Definition

A service line number. A service line number.

Control 1..1
Type positiveInt
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
ClaimResponse.item.adjudication
Definition

The adjudications results. The adjudications results.

Control 0..*
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
ClaimResponse.item.adjudication.amount ClaimResponse.item.adjudication.reason
Definition

Monetary amount associated with the code. Adjudication reason such as limit reached.

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

A non-monetary value for example a percentage. Mutually exclusive to the amount element above. Monetary amount associated with the code.

Control 0..1
Type decimal Summary true ClaimResponse.item.detail Definition The second tier service adjudications for submitted services. Control 0..* Summary Money
ClaimResponse.item.detail.sequenceLinkId ClaimResponse.item.adjudication.value
Definition

A service line number. A non-monetary value for example a percentage. Mutually exclusive to the amount element above.

Control 1..1 0..1
Type positiveInt Summary decimal
ClaimResponse.item.detail.adjudication ClaimResponse.item.detail
Definition

The adjudications results. The second tier service adjudications for submitted services.

Control 0..*
ClaimResponse.item.detail.adjudication.code ClaimResponse.item.detail.sequenceLinkId
Definition

Code indicating: Co-Pay, deductible, eligible, benefit, tax, etc. A service line number.

Control 1..1
Type Coding Summary positiveInt
ClaimResponse.item.detail.adjudication.amount ClaimResponse.item.detail.noteNumber
Definition

Monetary amount associated with the code. A list of note references to the notes provided below.

Control 0..1 0..*
Type Money Summary positiveInt
ClaimResponse.item.detail.adjudication.value ClaimResponse.item.detail.adjudication
Definition

A non-monetary value for example a percentage. Mutually exclusive to the amount element above. The adjudications results.

Control 0..1 0..*
Type decimal Summary See ClaimResponse.item.adjudication
ClaimResponse.item.detail.subDetail
Definition

The third tier service adjudications for submitted services. The third tier service adjudications for submitted services.

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

A service line number. A service line number.

Control 1..1
Type positiveInt
ClaimResponse.item.detail.subDetail.adjudication ClaimResponse.item.detail.subDetail.noteNumber
Definition

The adjudications results. A list of note references to the notes provided below.

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

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

Control 1..1 0..*
Binding Type Adjudication Codes: The adjudication codes. ( Extensible See ClaimResponse.item.adjudication )
Type ClaimResponse.addItem
Definition

The first tier service adjudications for payor added services.

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

Monetary amount associated with the code. List of input service items which this service line is intended to replace.

Control 0..1 0..*
Type Money Summary positiveInt
ClaimResponse.item.detail.subDetail.adjudication.value ClaimResponse.addItem.revenue
Definition

A non-monetary value for example a percentage. Mutually exclusive to the amount element above. The type of reveneu or cost center providing the product and/or service.

Control 0..1
Type Binding decimal Example Revenue Center Codes: Codes for the revenue or cost centers supplying the service and/or products. ( Example )
Summary Type true Coding
ClaimResponse.addItem ClaimResponse.addItem.category
Definition

The first tier service adjudications for payor added services. Health Care Service Type Codes to identify the classification of service or benefits.

Control 0..* 0..1
Summary Binding true Benefit SubCategory Codes: Benefit subcategories such as: oral-basic, major, glasses ( Example )
Type Coding
ClaimResponse.addItem.sequenceLinkId ClaimResponse.addItem.service
Definition

List of input service items which this service line is intended to replace. A code to indicate the Professional Service or Product supplied.

Control 0..* 0..1
Type Binding positiveInt USCLS Codes: Allowable service and product codes. ( Example )
Summary Type true Coding
ClaimResponse.addItem.service ClaimResponse.addItem.modifier
Definition

A code to indicate the Professional Service or Product supplied. 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 1..1 0..*
Binding USCLS Codes: Allowable service and product codes. ( 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
Summary Requirements true

May impact on adjudication.

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
ClaimResponse.addItem.noteNumberLinkId ClaimResponse.addItem.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
ClaimResponse.addItem.adjudication
Definition

The adjudications results. The adjudications results.

Control 0..*
Summary Type true See ClaimResponse.item.adjudication
ClaimResponse.addItem.adjudication.code ClaimResponse.addItem.detail
Definition

Code indicating: Co-Pay, deductible, eligible, benefit, tax, etc. The second tier service adjudications for payor added services.

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

Monetary amount associated with the code. The type of reveneu or cost center providing the product and/or service.

Control 0..1
Type Binding Money Example Revenue Center Codes: Codes for the revenue or cost centers supplying the service and/or products. ( Example )
Summary Type true Coding
ClaimResponse.addItem.adjudication.value ClaimResponse.addItem.detail.category
Definition

A non-monetary value for example a percentage. Mutually exclusive to the amount element above. Health Care Service Type Codes to identify the classification of service or benefits.

Control 0..1
Type Binding decimal Benefit SubCategory Codes: Benefit subcategories such as: oral-basic, major, glasses ( Example )
Summary Type true Coding
ClaimResponse.addItem.detail ClaimResponse.addItem.detail.service
Definition

The second tier service adjudications for payor added services. A code to indicate the Professional Service or Product supplied.

Control 0..* 0..1
Summary Binding true USCLS Codes: Allowable service and product codes. ( Example )
Type Coding
ClaimResponse.addItem.detail.service ClaimResponse.addItem.detail.modifier
Definition

A code to indicate the Professional Service or Product supplied. 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 1..1 0..*
Binding USCLS Codes: Allowable service and product codes. ( 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
Summary Requirements true

May impact on adjudication.

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
ClaimResponse.addItem.detail.adjudication ClaimResponse.addItem.detail.noteNumber
Definition

The adjudications results. A list of note references to the notes provided below.

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

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

Control 1..1 Binding Adjudication Codes: The adjudication codes. ( Extensible ) 0..*
Type Coding Summary See ClaimResponse.item.adjudication
ClaimResponse.addItem.detail.adjudication.amount ClaimResponse.error
Definition

Monetary amount associated with the code. Mutually exclusive with Services Provided (Item).

Control 0..1 Type Money Summary true 0..*
ClaimResponse.addItem.detail.adjudication.value ClaimResponse.error.sequenceLinkId
Definition

A non-monetary value for example a percentage. Mutually exclusive to the amount element above. 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 decimal Summary positiveInt
ClaimResponse.error ClaimResponse.error.detailSequenceLinkId
Definition

Mutually exclusive with Services Provided (Item). 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..* 0..1
Summary Type true positiveInt
ClaimResponse.error.sequenceLinkId ClaimResponse.error.subdetailSequenceLinkId
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 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.detailSequenceLinkId ClaimResponse.error.code
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. An error code,from a specified code system, which details why the claim could not be adjudicated.

Control 0..1 1..1
Type Binding positiveInt Adjudication Error Codes: The adjudication error codes. ( Extensible )
Summary Type true Coding
ClaimResponse.error.subdetailSequenceLinkId ClaimResponse.totalCost
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 total cost of the services reported.

Control 0..1
Type positiveInt Money
Summary Requirements true

This is a check value that the receiver calculates and returns.

ClaimResponse.error.code ClaimResponse.unallocDeductable
Definition

An error code,froma specified code system, which details why the claim could not be adjudicated. The amount of deductible applied which was not allocated to any particular service line.

Control 1..1 Binding Adjudication Error Codes: The error codes for adjudication processing. ( Required ) 0..1
Type Coding Summary Money
ClaimResponse.totalCost ClaimResponse.totalBenefit
Definition

The total cost of the services reported. 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.unallocDeductable ClaimResponse.payment
Definition

The amount of deductible applied which was not allocated to any particular service line. Payment details for the claim if the claim has been paid.

Control 0..1
ClaimResponse.totalBenefit ClaimResponse.payment.type
Definition

Total amount of benefit payable (Equal to sum of the Benefit amounts from all detail lines and additions less the Unallocated Deductible). Whether this represents partial or complete payment of the claim.

Control 0..1
Type Binding Money Example Payment Type Codes: The type (partial, complete) of the payment ( Example )
Summary Type true Coding
ClaimResponse.paymentAdjustment ClaimResponse.payment.adjustment
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
ClaimResponse.paymentAdjustmentReason ClaimResponse.payment.adjustmentReason
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
ClaimResponse.paymentDate ClaimResponse.payment.date
Definition

Estimated payment data. Estimated payment data.

Control 0..1
Type date
ClaimResponse.paymentAmount ClaimResponse.payment.amount
Definition

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

Control 0..1
Type Money
ClaimResponse.paymentRef ClaimResponse.payment.identifier
Definition

Payment identifier. 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). 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
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
ClaimResponse.note
Definition

Note text. Note text.

Control 0..*
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
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
ClaimResponse.note.text
Definition

The note text. The note text.

Control 0..1
Type string
ClaimResponse.coverage ClaimResponse.note.language
Definition

Financial instrument by which payment information for health care. 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..* Requirements Health care programs and insurers are significant payors of health service costs. Summary true ClaimResponse.coverage.sequence Definition A service line item. 0..1
Control Binding 1..1 Common Languages: A human language. ( Extensible but limited to ??)
Type positiveInt Requirements To maintain order of the coverages. Summary Coding
ClaimResponse.coverage.focal ClaimResponse.coverage
Definition

The instance number of the Coverage which is the focus for adjudication. The Coverage against which the claim is to be adjudicated. Financial instrument by which payment information for health care.

Control 1..1 Type boolean 0..*
Requirements

To identify which coverage is being adjudicated. Summary true Health care programs and insurers are significant payors of health service costs.

ClaimResponse.coverage.coverage ClaimResponse.coverage.sequence
Definition

Reference to the program or plan identification, underwriter or payor. A service line item.

Control 1..1
Type Reference ( Coverage positiveInt )
Requirements

Need to identify the issuer to target for processing and for coordination of benefit processing. Summary true To maintain order of the coverages.

ClaimResponse.coverage.businessArrangement ClaimResponse.coverage.focal
Definition

The contract number of a business agreement which describes the terms and conditions. The instance number of the Coverage which is the focus for adjudication. The Coverage against which the claim is to be adjudicated.

Control 0..1 1..1
Type string boolean
Summary Requirements true

To identify which coverage is being adjudicated.

ClaimResponse.coverage.relationship ClaimResponse.coverage.coverage[x]
Definition

The relationship of the patient to the subscriber. Reference to the program or plan identification, underwriter or payor.

Control 1..1
Binding Type Surface Codes: The code for the relationship of the patient to the subscriber. Identifier | Reference ( Example Coverage )
Type [x] Note Coding See Choice of Data Types for further information about how to use [x]
Requirements

To determine the relationship between the patient and the subscriber. Summary true Need to identify the issuer to target for processing and for coordination of benefit processing.

ClaimResponse.coverage.preAuthRef ClaimResponse.coverage.businessArrangement
Definition

A list of references from the Insurer to which these services pertain. The contract number of a business agreement which describes the terms and conditions.

Control 0..* 0..1
Type string
ClaimResponse.coverage.claimResponse ClaimResponse.coverage.preAuthRef
Definition

The Coverages adjudication details. A list of references from the Insurer to which these services pertain.

Control 0..1 0..*
Type Reference ( ClaimResponse string )
Requirements

Used by downstream payers to determine what balance remains and the net payable. Summary true To provide any pre-determination or prior authorization reference.

ClaimResponse.coverage.originalRuleset ClaimResponse.coverage.claimResponse
Definition

The style (standard) and version of the original material which was converted into this resource. The Coverages adjudication details.

Control 0..1
Type Coding 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. Summary true © HL7.org 2011+. FHIR DSTU2 (v1.0.2-7202) generated on Sat, Oct 24, 2015 07:43+1100. Links: Search Used by downstream payers to determine what balance remains and the net payable.