R4 Ballot #1 #2 (Mixed Normative/Trial use)

This page is part of the FHIR Specification (v3.3.0: (v3.5.0: R4 Ballot 2). #2). 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
Element Id ClaimResponse
Definition

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

Control 1..1
Type DomainResource
Alternate Names Remittance Advice
ClaimResponse.identifier
Element Id ClaimResponse.identifier
Definition

The Response response business identifier.

Note This is a business identifer, not a resource identifier (see discussion )
Control 0..*
Type Identifier
ClaimResponse.status
Element Id ClaimResponse.status
Definition

The status of the resource instance.

Control 0..1
Terminology Binding Financial Resource Status Codes ( Required )
Type code
Is Modifier true (Reason: This element is labelled labeled as a modifier because it is a status element that contains status entered-in-error which means that the resource should not be treated as valid)
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.type
Element Id ClaimResponse.type
Definition

The category of claim, eg, e.g, oral, pharmacy, vision, insitutional, institutional, professional.

Control 0..1
Terminology Binding Claim Type Codes ( Extensible )
Type CodeableConcept
Comments

Affects which fields and value sets are used.

ClaimResponse.subType
Element Id ClaimResponse.subType
Definition

A finer grained suite of claim subtype codes which may convey Inpatient vs Outpatient and/or a specialty service. In the US the BillType. CMS Bill Type.

Control 0..* 0..1
Terminology Binding Example Claim SubType Codes ( Example )
Type CodeableConcept
Comments

This may contain the local bill type codes such as the US UB-04 bill type code.

ClaimResponse.use
Element Id ClaimResponse.use
Definition

Complete (Bill A claim, a list of completed goods and services; a preauthorization, a list or Claim), Proposed (Pre-Authorization), Exploratory (Pre-determination). proposed goods and services; or a predetermination, a set of goods and services being considered, for which insurer adjudication is sought.

Control 0..1
Terminology Binding Use ( Required )
Type code
Summary true
ClaimResponse.patient
Element Id ClaimResponse.patient
Definition

Patient Resource.

Control 0..1
Type Reference ( Patient )
ClaimResponse.created
Element Id ClaimResponse.created
Definition

The date when the enclosed suite of services were performed or completed. this resource was created.

Control 0..1
Type dateTime
ClaimResponse.insurer
Element Id ClaimResponse.insurer
Definition

The Insurer who produced this adjudicated response.

Control 0..1
Type Reference ( Organization )
ClaimResponse.requestProvider
Element Id ClaimResponse.requestProvider
Definition

The practitioner who is responsible for the services rendered to the patient.

Control 0..1
Type Reference ( Practitioner | PractitionerRole | Organization )
ClaimResponse.request
Element Id ClaimResponse.request
Definition

Original request resource referrence. reference.

Control 0..1
Type Reference ( Claim )
ClaimResponse.outcome
Element Id ClaimResponse.outcome
Definition

Transaction: error, complete, partial processing.

Control 0..1
Terminology Binding Claim Processing Codes ( Required )
Type code
ClaimResponse.disposition
Element Id ClaimResponse.disposition
Definition

A description of the status of the adjudication.

Control 0..1
Type string
ClaimResponse.preAuthRef
Element Id ClaimResponse.preAuthRef
Definition

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

Control 0..1
Type string
Requirements

To provide any pre-determination or prior authorization reference.

ClaimResponse.payeeType
Element Id ClaimResponse.payeeType
Definition

Party to be reimbursed: Subscriber, provider, other.

Control 0..1
Terminology Binding Claim Payee Type Codes PayeeType ( Example )
Type CodeableConcept
ClaimResponse.item
Element Id ClaimResponse.item
Definition

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

Control 0..*
ClaimResponse.item.itemSequence
Element Id ClaimResponse.item.itemSequence
Definition

A service line number.

Control 1..1
Type positiveInt
ClaimResponse.item.noteNumber
Element Id ClaimResponse.item.noteNumber
Definition

A list of note references to the notes provided below.

Control 0..*
Type positiveInt
ClaimResponse.item.adjudication
Element Id ClaimResponse.item.adjudication
Definition

The adjudication results.

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

Monetary amount associated with the code.

Control 0..1
Type Money
ClaimResponse.item.adjudication.value
Element Id 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
Element Id ClaimResponse.item.detail
Definition

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

Control 0..*
ClaimResponse.item.detail.detailSequence
Element Id ClaimResponse.item.detail.detailSequence
Definition

A service line number.

Control 1..1
Type positiveInt
ClaimResponse.item.detail.noteNumber
Element Id ClaimResponse.item.detail.noteNumber
Definition

A list of note references to the notes provided below.

Control 0..*
Type positiveInt
ClaimResponse.item.detail.adjudication
Element Id ClaimResponse.item.detail.adjudication
Definition

The adjudications adjudication results.

Control 0..*
Type See ClaimResponse.item.adjudication
ClaimResponse.item.detail.subDetail
Element Id ClaimResponse.item.detail.subDetail
Definition

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

Control 0..*
ClaimResponse.item.detail.subDetail.subDetailSequence
Element Id ClaimResponse.item.detail.subDetail.subDetailSequence
Definition

A service line number.

Control 1..1
Type positiveInt
ClaimResponse.item.detail.subDetail.noteNumber
Element Id 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
Element Id ClaimResponse.item.detail.subDetail.adjudication
Definition

The adjudications adjudication results.

Control 0..*
Type See ClaimResponse.item.adjudication
ClaimResponse.addItem
Element Id ClaimResponse.addItem
Definition

The first tier first-tier service adjudications for payor added services.

Control 0..*
ClaimResponse.addItem.itemSequence
Element Id ClaimResponse.addItem.itemSequence
Definition

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

Control 0..*
Type positiveInt
ClaimResponse.addItem.detailSequence
Element Id 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
Element Id 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 ClaimResponse.addItem.provider
Element Id ClaimResponse.addItem.service ClaimResponse.addItem.provider
Definition

The providers who are authorized for the services rendered to the patient.

Control 0..*
Type Reference ( Practitioner | PractitionerRole | Organization )
ClaimResponse.addItem.billcode
Element Id ClaimResponse.addItem.billcode
Definition

A code to indicate the Professional Service or Product supplied.

Control 0..1
Terminology Binding USCLS Codes ( Example )
Type CodeableConcept
ClaimResponse.addItem.modifier
Element Id ClaimResponse.addItem.modifier
Definition

Item typification or modifiers codes, eg e.g. 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 ClaimResponse.addItem.programCode
Element Id ClaimResponse.addItem.fee ClaimResponse.addItem.programCode
Definition

For programs which require reason codes for the inclusion or covering of this billed item under the program or sub-program.

Control 0..*
Terminology Binding Example Program Reason Codes ( Example )
Type CodeableConcept
ClaimResponse.addItem.serviced[x]
Element Id ClaimResponse.addItem.serviced[x]
Definition

The date or dates when the service or product was supplied, performed or completed.

Control 0..1
Type date | Period
[x] Note See Choice of Data Types for further information about how to use [x]
ClaimResponse.addItem.location[x]
Element Id ClaimResponse.addItem.location[x]
Definition

Where the service was provided.

Control 0..1
Terminology Binding Example Service Place Codes ( Example )
Type CodeableConcept | Address | Reference ( Location )
[x] Note See Choice of Data Types for further information about how to use [x]
ClaimResponse.addItem.quantity
Element Id ClaimResponse.addItem.quantity
Definition

The number of repetitions of a service or product.

Control 0..1
Type SimpleQuantity
ClaimResponse.addItem.unitPrice
Element Id ClaimResponse.addItem.unitPrice
Definition

If the item is a node then this is the fee charged for the professional product or service, otherwise this is the total of the fees for the children of the group.

Control 0..1
Type Money
ClaimResponse.addItem.factor
Element Id ClaimResponse.addItem.factor
Definition

A real number that represents a multiplier used in determining the overall value of services delivered and/or goods received. The concept of a Factor allows for a discount or surcharge multiplier to be applied to a monetary amount.

Control 0..1
Type decimal
Requirements

If a fee is present the associated product/service code must be present.

ClaimResponse.addItem.net
Element Id ClaimResponse.addItem.net
Definition

The quantity times the unit price for an additional service or product.. product or charge. For example, the formula: unit Quantity * unit Price (Cost per Point) * factor Number * points = net Amount. Quantity, factor and points are assumed to be 1 if not supplied.

Control 0..1
Type Money
Requirements

If a fee is present the associated product/service code must be present.

ClaimResponse.addItem.bodySite
Element Id ClaimResponse.addItem.bodySite
Definition

Physical service site on the patient (limb, tooth, etc.).

Control 0..1
Terminology Binding Oral Site Codes ( Example )
Type CodeableConcept
ClaimResponse.addItem.subSite
Element Id ClaimResponse.addItem.subSite
Definition

A region or surface of the site, e.g. limb region or tooth surface(s).

Control 0..*
Terminology Binding Surface Codes ( Example )
Type CodeableConcept
ClaimResponse.addItem.noteNumber
Element Id ClaimResponse.addItem.noteNumber
Definition

A list of note references to the notes provided below.

Control 0..*
Type positiveInt
ClaimResponse.addItem.adjudication
Element Id ClaimResponse.addItem.adjudication
Definition

The adjudication results.

Control 0..*
Type See ClaimResponse.item.adjudication
ClaimResponse.addItem.detail
Element Id ClaimResponse.addItem.detail
Definition

The second-tier service adjudications for payor added services.

Control 0..*
ClaimResponse.addItem.detail.billcode
Element Id ClaimResponse.addItem.detail.billcode
Definition

A code to indicate the Professional Service or Product supplied.

Control 0..1
Terminology Binding USCLS Codes ( Example )
Type CodeableConcept
ClaimResponse.addItem.detail.modifier
Element Id ClaimResponse.addItem.detail.modifier
Definition

Item typification or modifiers codes, e.g. 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.detail.quantity
Element Id ClaimResponse.addItem.detail.quantity
Definition

The number of repetitions of a service or product.

Control 0..1
Type SimpleQuantity
ClaimResponse.addItem.detail.unitPrice
Element Id ClaimResponse.addItem.detail.unitPrice
Definition

If the item is a node then this is the fee for the product or service, otherwise this is the total of the fees for the children of the group.

Control 0..1
Type Money
ClaimResponse.addItem.detail.factor
Element Id ClaimResponse.addItem.detail.factor
Definition

A real number that represents a multiplier used in determining the overall value of services delivered and/or goods received. The concept of a Factor allows for a discount or surcharge multiplier to be applied to a monetary amount.

Control 0..1
Type decimal
Requirements

If a fee is present the associated product/service code must be present.

ClaimResponse.addItem.detail.net
Element Id ClaimResponse.addItem.detail.net
Definition

The quantity times the unit price for an additional service or product or charge. For example, the formula: unit Quantity * unit Price (Cost per Point) * factor Number * points = net Amount. Quantity, factor and points are assumed to be 1 if not supplied.

Control 0..1
Type Money
Requirements

If a fee is present the associated product/service code must be present.

ClaimResponse.addItem.detail.noteNumber
Element Id ClaimResponse.addItem.detail.noteNumber
Definition

A list of note references to the notes provided below.

Control 0..*
Type positiveInt
ClaimResponse.addItem.detail.adjudication
Element Id ClaimResponse.addItem.detail.adjudication
Definition

The adjudication results.

Control 0..*
Type See ClaimResponse.item.adjudication
ClaimResponse.addItem.detail.subDetail
Element Id ClaimResponse.addItem.detail.subDetail
Definition

The third-tier service adjudications for payor added services.

Control 0..*
ClaimResponse.addItem.detail.subDetail.billcode
Element Id ClaimResponse.addItem.detail.subDetail.billcode
Definition

A code to indicate the Professional Service or Product supplied.

Control 0..1
Terminology Binding USCLS Codes ( Example )
Type CodeableConcept
ClaimResponse.addItem.detail.subDetail.modifier
Element Id ClaimResponse.addItem.detail.subDetail.modifier
Definition

Item typification or modifiers codes, e.g. 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.detail.subDetail.quantity
Element Id ClaimResponse.addItem.detail.subDetail.quantity
Definition

The number of repetitions of a service or product.

Control 0..1
Type SimpleQuantity
ClaimResponse.addItem.detail.subDetail.unitPrice
Element Id ClaimResponse.addItem.detail.subDetail.unitPrice
Definition

If the item is a node then this is the fee for the product or service, otherwise this is the total of the fees for the children of the group.

Control 0..1
Type Money
ClaimResponse.addItem.detail.subDetail.factor
Element Id ClaimResponse.addItem.detail.subDetail.factor
Definition

A real number that represents a multiplier used in determining the overall value of services delivered and/or goods received. The concept of a Factor allows for a discount or surcharge multiplier to be applied to a monetary amount.

Control 0..1
Type decimal
Requirements

If a fee is present the associated product/service code must be present.

ClaimResponse.addItem.detail.subDetail.net
Element Id ClaimResponse.addItem.detail.subDetail.net
Definition

The quantity times the unit price for an additional service or product or charge. For example, the formula: unit Quantity * unit Price (Cost per Point) * factor Number * points = net Amount. Quantity, factor and points are assumed to be 1 if not supplied.

Control 0..1
Type Money
Requirements

If a fee is present the associated product/service code must be present.

ClaimResponse.addItem.detail.subDetail.noteNumber
Element Id ClaimResponse.addItem.detail.subDetail.noteNumber
Definition

A list of note references to the notes provided below.

Control 0..*
Type positiveInt
ClaimResponse.addItem.detail.subDetail.adjudication
Element Id ClaimResponse.addItem.detail.subDetail.adjudication
Definition

The adjudication results.

Control 0..*
Type See ClaimResponse.item.adjudication
ClaimResponse.error
Element Id ClaimResponse.error
Definition

Mutually exclusive with Services Provided (Item).

Control 0..*
ClaimResponse.error.itemSequence
Element Id 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
Element Id 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
Element Id 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
Element Id ClaimResponse.error.code
Definition

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

Control 1..1
Terminology Binding Adjudication Error Codes AdjudicationError ( Example )
Type CodeableConcept
ClaimResponse.total
Element Id ClaimResponse.total
Definition

Totals for amounts submitted, co-pays, benefits payable etc.

Control 0..*
ClaimResponse.total.category
Element Id ClaimResponse.total.category
Definition

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

Control 1..1
Terminology Binding Adjudication Value Codes ( Example )
Type CodeableConcept
ClaimResponse.total.amount
Element Id ClaimResponse.total.amount
Definition

Monitory amount associated with the code.

Control 1..1
Type Money
ClaimResponse.payment
Element Id ClaimResponse.payment
Definition

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

Control 0..1
ClaimResponse.payment.type
Element Id 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
Element Id 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
Element Id ClaimResponse.payment.adjustmentReason
Definition

Reason for the payment adjustment.

Control 0..1
Terminology Binding Payment Adjustment Reason Codes ( Example )
Type CodeableConcept
ClaimResponse.payment.date
Element Id ClaimResponse.payment.date
Definition

Estimated payment data.

Control 0..1
Type date
ClaimResponse.payment.amount
Element Id ClaimResponse.payment.amount
Definition

Payable less any payment adjustment.

Control 0..1
Type Money
ClaimResponse.payment.identifier
Element Id 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
Element Id ClaimResponse.reserved
Definition

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

Control 0..1
Terminology Binding Funds Reservation Codes FundsReserve ( Example )
Type Coding
ClaimResponse.form
Element Id ClaimResponse.form
Definition

The form to be used for printing the content.

Control 0..1
Terminology Binding Form Codes Forms ( Example )
Type CodeableConcept
ClaimResponse.processNote
Element Id ClaimResponse.processNote
Definition

Note text.

Control 0..*
ClaimResponse.processNote.number
Element Id 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
Element Id ClaimResponse.processNote.type
Definition

The note purpose: Print/Display.

Control 0..1
Terminology Binding NoteType ( Required )
Type code
ClaimResponse.processNote.text
Element Id ClaimResponse.processNote.text
Definition

The note text.

Control 0..1
Type string
ClaimResponse.processNote.language
Element Id 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 Language ( Extensible Preferred but limited to ??) Language )
Type CodeableConcept
ClaimResponse.communicationRequest
Element Id ClaimResponse.communicationRequest
Definition

Request for additional supporting or authorizing information, such as: documents, images or resources.

Control 0..*
Type Reference ( CommunicationRequest )
ClaimResponse.insurance
Element Id 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
Element Id ClaimResponse.insurance.sequence
Definition

A service line item.

Control 1..1
Type positiveInt
Requirements

To maintain order of the coverages.

ClaimResponse.insurance.focal
Element Id 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
Element Id 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
Element Id 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 Element Id 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
Element Id 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.