STU 3 Ballot

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

13.2.5 Resource ClaimResponse - Detailed Descriptions

Detailed Descriptions for the elements in the ClaimResponse resource.

ClaimResponse
Definition

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

Control1..1
Alternate NamesRemittance Advice
ClaimResponse.identifier
Definition

The Response business identifier.

NoteThis is a business identifer, not a resource identifier (see discussion)
Control0..*
TypeIdentifier
ClaimResponse.status
Definition

The status of the resource instance.

Control1..1
BindingClaimResponseStatus: A code specifying the state of the resource instance. (Required)
Typecode
Is Modifiertrue
Summarytrue
ClaimResponse.request[x]
Definition

Original request resource referrence.

Control0..1
TypeIdentifier|Reference(Claim)
[x] NoteSee 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.

Control0..1
BindingRuleset Codes: The static and dynamic model to which contents conform, which may be business version or standard/version. (Example)
TypeCoding
Alternate NamesBusinessVersion
ClaimResponse.originalRuleset
Definition

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

Control0..1
BindingRuleset Codes: The static and dynamic model to which contents conform, which may be business version or standard/version. (Example)
TypeCoding
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 NamesOriginalBusinessVersion
ClaimResponse.created
Definition

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

Control0..1
TypedateTime
ClaimResponse.organization[x]
Definition

The Insurer who produced this adjudicated response.

Control0..1
TypeIdentifier|Reference(Organization)
[x] NoteSee 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.

Control0..1
TypeIdentifier|Reference(Practitioner)
[x] NoteSee 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.

Control0..1
TypeIdentifier|Reference(Organization)
[x] NoteSee Choice of Data Types for further information about how to use [x]
ClaimResponse.outcome
Definition

Processing outcome errror, partial or complete processing.

Control0..1
BindingClaim Processing Codes: The result of the claim processing (Example)
TypeCoding
ClaimResponse.disposition
Definition

A description of the status of the adjudication.

Control0..1
Typestring
ClaimResponse.payeeType
Definition

Party to be reimbursed: Subscriber, provider, other.

Control0..1
BindingPayee Type Codes: A code for the party to be reimbursed. (Example)
TypeCoding
ClaimResponse.item
Definition

The first tier service adjudications for submitted services.

Control0..*
ClaimResponse.item.sequenceLinkId
Definition

A service line number.

Control1..1
TypepositiveInt
ClaimResponse.item.noteNumber
Definition

A list of note references to the notes provided below.

Control0..*
TypepositiveInt
ClaimResponse.item.adjudication
Definition

The adjudications results.

Control0..*
ClaimResponse.item.adjudication.category
Definition

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

Control1..1
BindingAdjudication Codes: The adjudication codes. (Extensible)
TypeCoding
ClaimResponse.item.adjudication.reason
Definition

Adjudication reason such as limit reached.

Control0..1
BindingAdjudication Reason Codes: The adjudication reason codes. (Extensible)
TypeCoding
ClaimResponse.item.adjudication.amount
Definition

Monetary amount associated with the code.

Control0..1
TypeMoney
ClaimResponse.item.adjudication.value
Definition

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

Control0..1
Typedecimal
ClaimResponse.item.detail
Definition

The second tier service adjudications for submitted services.

Control0..*
ClaimResponse.item.detail.sequenceLinkId
Definition

A service line number.

Control1..1
TypepositiveInt
ClaimResponse.item.detail.noteNumber
Definition

A list of note references to the notes provided below.

Control0..*
TypepositiveInt
ClaimResponse.item.detail.adjudication
Definition

The adjudications results.

Control0..*
TypeSee ClaimResponse.item.adjudication
ClaimResponse.item.detail.subDetail
Definition

The third tier service adjudications for submitted services.

Control0..*
ClaimResponse.item.detail.subDetail.sequenceLinkId
Definition

A service line number.

Control1..1
TypepositiveInt
ClaimResponse.item.detail.subDetail.noteNumber
Definition

A list of note references to the notes provided below.

Control0..*
TypepositiveInt
ClaimResponse.item.detail.subDetail.adjudication
Definition

The adjudications results.

Control0..*
TypeSee ClaimResponse.item.adjudication
ClaimResponse.addItem
Definition

The first tier service adjudications for payor added services.

Control0..*
ClaimResponse.addItem.sequenceLinkId
Definition

List of input service items which this service line is intended to replace.

Control0..*
TypepositiveInt
ClaimResponse.addItem.revenue
Definition

The type of reveneu or cost center providing the product and/or service.

Control0..1
BindingExample Revenue Center Codes: Codes for the revenue or cost centers supplying the service and/or products. (Example)
TypeCoding
ClaimResponse.addItem.category
Definition

Health Care Service Type Codes to identify the classification of service or benefits.

Control0..1
BindingBenefit SubCategory Codes: Benefit subcategories such as: oral-basic, major, glasses (Example)
TypeCoding
ClaimResponse.addItem.service
Definition

A code to indicate the Professional Service or Product supplied.

Control0..1
BindingUSCLS Codes: Allowable service and product codes. (Example)
TypeCoding
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.

Control0..*
BindingModifier 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)
TypeCoding
Requirements

May impact on adjudication.

ClaimResponse.addItem.fee
Definition

The fee charged for the professional service or product..

Control0..1
TypeMoney
ClaimResponse.addItem.noteNumber
Definition

A list of note references to the notes provided below.

Control0..*
TypepositiveInt
ClaimResponse.addItem.adjudication
Definition

The adjudications results.

Control0..*
TypeSee ClaimResponse.item.adjudication
ClaimResponse.addItem.detail
Definition

The second tier service adjudications for payor added services.

Control0..*
ClaimResponse.addItem.detail.revenue
Definition

The type of reveneu or cost center providing the product and/or service.

Control0..1
BindingExample Revenue Center Codes: Codes for the revenue or cost centers supplying the service and/or products. (Example)
TypeCoding
ClaimResponse.addItem.detail.category
Definition

Health Care Service Type Codes to identify the classification of service or benefits.

Control0..1
BindingBenefit SubCategory Codes: Benefit subcategories such as: oral-basic, major, glasses (Example)
TypeCoding
ClaimResponse.addItem.detail.service
Definition

A code to indicate the Professional Service or Product supplied.

Control0..1
BindingUSCLS Codes: Allowable service and product codes. (Example)
TypeCoding
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.

Control0..*
BindingModifier 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)
TypeCoding
Requirements

May impact on adjudication.

ClaimResponse.addItem.detail.fee
Definition

The fee charged for the professional service or product..

Control0..1
TypeMoney
ClaimResponse.addItem.detail.noteNumber
Definition

A list of note references to the notes provided below.

Control0..*
TypepositiveInt
ClaimResponse.addItem.detail.adjudication
Definition

The adjudications results.

Control0..*
TypeSee ClaimResponse.item.adjudication
ClaimResponse.error
Definition

Mutually exclusive with Services Provided (Item).

Control0..*
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.

Control0..1
TypepositiveInt
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.

Control0..1
TypepositiveInt
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.

Control0..1
TypepositiveInt
ClaimResponse.error.code
Definition

An error code,from a specified code system, which details why the claim could not be adjudicated.

Control1..1
BindingAdjudication Error Codes: The adjudication error codes. (Extensible)
TypeCoding
ClaimResponse.totalCost
Definition

The total cost of the services reported.

Control0..1
TypeMoney
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.

Control0..1
TypeMoney
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).

Control0..1
TypeMoney
ClaimResponse.payment
Definition

Payment details for the claim if the claim has been paid.

Control0..1
ClaimResponse.payment.type
Definition

Whether this represents partial or complete payment of the claim.

Control0..1
BindingExample Payment Type Codes: The type (partial, complete) of the payment (Example)
TypeCoding
ClaimResponse.payment.adjustment
Definition

Adjustment to the payment of this transaction which is not related to adjudication of this transaction.

Control0..1
TypeMoney
ClaimResponse.payment.adjustmentReason
Definition

Reason for the payment adjustment.

Control0..1
BindingPayment Adjustment Reason Codes: Payment Adjustment reason codes. (Extensible)
TypeCoding
ClaimResponse.payment.date
Definition

Estimated payment data.

Control0..1
Typedate
ClaimResponse.payment.amount
Definition

Payable less any payment adjustment.

Control0..1
TypeMoney
ClaimResponse.payment.identifier
Definition

Payment identifier.

NoteThis is a business identifer, not a resource identifier (see discussion)
Control0..1
TypeIdentifier
ClaimResponse.reserved
Definition

Status of funds reservation (For provider, for Patient, None).

Control0..1
BindingFunds Reservation Codes: For whom funds are to be reserved: (Patient, Provider, None). (Example)
TypeCoding
ClaimResponse.form
Definition

The form to be used for printing the content.

Control0..1
BindingForm Codes: The forms codes. (Required)
TypeCoding
ClaimResponse.note
Definition

Note text.

Control0..*
ClaimResponse.note.number
Definition

An integer associated with each note which may be referred to from each service line item.

Control0..1
TypepositiveInt
ClaimResponse.note.type
Definition

The note purpose: Print/Display.

Control0..1
BindingNoteType: The presentation types of notes. (Required)
TypeCoding
ClaimResponse.note.text
Definition

The note text.

Control0..1
Typestring
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.

Control0..1
BindingCommon Languages: A human language. (Extensible but limited to ??)
TypeCoding
ClaimResponse.coverage
Definition

Financial instrument by which payment information for health care.

Control0..*
Requirements

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

ClaimResponse.coverage.sequence
Definition

A service line item.

Control1..1
TypepositiveInt
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.

Control1..1
Typeboolean
Requirements

To identify which coverage is being adjudicated.

ClaimResponse.coverage.coverage[x]
Definition

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

Control1..1
TypeIdentifier|Reference(Coverage)
[x] NoteSee 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.

Control0..1
Typestring
ClaimResponse.coverage.preAuthRef
Definition

A list of references from the Insurer to which these services pertain.

Control0..*
Typestring
Requirements

To provide any pre-determination or prior authorization reference.

ClaimResponse.coverage.claimResponse
Definition

The Coverages adjudication details.

Control0..1
TypeReference(ClaimResponse)
Requirements

Used by downstream payers to determine what balance remains and the net payable.