DSTU2 FHIR Release 3 (STU)

This page is part of the FHIR Specification (v1.0.2: DSTU (v3.0.2: STU 2). 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 . Page versions: R5 R4B R4 R3 R2 R3 R2

Financial Management Work Group Maturity Level : 2   Trial Use Compartments : Patient , Practitioner

Detailed Descriptions for the elements in the ClaimResponse resource.

Summary true Summary true Summary true Summary true Summary true Summary true Summary true true Summary true Summary true Summary true Summary true Summary Summary true Summary true Summary true Summary true true true true Summary true true true Summary true Summary true true true Control 0..* Summary true true true true Summary true Summary true Summary true Summary true true Summary true Summary true Summary Summary true true Summary true Summary true Summary true Summary true true Summary true Summary true Summary Summary Summary true Summary true Summary true Summary true Summary true ClaimResponse.coverage.relationship Definition The relationship of the patient to the subscriber. Control 1..1 Binding Surface Codes: The code for the relationship of the patient to the subscriber. ( Example ) Type Coding Requirements To determine the relationship between the patient and the subscriber. Summary true Summary true 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 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
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.request ClaimResponse.status
Definition

Original request The status of the resource referrence. instance.

Control 0..1
Type Terminology Binding Reference Financial Resource Status Codes ( Claim Required )
Summary Type true code 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 Is Modifier 0..1 true
Binding Summary Ruleset Codes: The static and dynamic model to which contents conform, which may be business version or standard/version. ( Example ) true
Type Coding Comments Summary true

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.originalRuleset ClaimResponse.patient
Definition

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

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

Control 0..1
Type dateTime
ClaimResponse.organization ClaimResponse.insurer
Definition

The Insurer who produced this adjudicated response.

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

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

Control 0..1
Type Reference ( Practitioner )
ClaimResponse.requestOrganization
Definition

The organization which is responsible for the services rendered to the patient.

Control 0..1
Type Reference ( Organization )
ClaimResponse.request
Definition

Original request resource referrence.

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

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

Control 0..1
Terminology Binding RemittanceOutcome: The outcome of the processing. Claim Processing Codes ( Required Example )
Type code Summary CodeableConcept
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
Terminology Binding Claim Payee Type Codes: A code for the party to be reimbursed. Codes ( Example )
Type Coding Summary CodeableConcept
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 adjudication results.

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

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

Control 1..1
Terminology Binding Adjudication Codes: The adjudication codes. Adjudication Value Codes ( Extensible Example )
Type Coding CodeableConcept
ClaimResponse.item.adjudication.reason
Definition

Adjudication reason such as limit reached.

Control true 0..1
Terminology Binding Adjudication Reason Codes ( Example )
Type CodeableConcept
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.adjudication ClaimResponse.item.detail.noteNumber
Definition

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

Control 0..*
Summary Type true positiveInt
ClaimResponse.item.detail.adjudication.code ClaimResponse.item.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.item.detail.adjudication.amount ClaimResponse.item.detail.subDetail
Definition

Monetary amount associated with the code. The third tier service adjudications for submitted services.

Control 0..1 Type Money Summary true 0..*
ClaimResponse.item.detail.adjudication.value ClaimResponse.item.detail.subDetail.sequenceLinkId
Definition

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

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

The third tier service adjudications for submitted services. A list of note references to the notes provided below.

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

A service line number. The adjudications results.

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

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

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

Code indicating: Co-Pay, deductible, eligible, benefit, tax, etc. List of input service items which this service line is intended to replace.

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

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

Control 0..1
Type Terminology Binding Money Example Revenue Center Codes ( Example )
Summary Type true CodeableConcept
ClaimResponse.item.detail.subDetail.adjudication.value ClaimResponse.addItem.category
Definition

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

Control 0..1
Type Terminology Binding decimal Benefit SubCategory Codes ( Example )
Summary Type true CodeableConcept
ClaimResponse.addItem ClaimResponse.addItem.service
Definition

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

Control 0..* 0..1
Summary Terminology Binding true USCLS Codes ClaimResponse.addItem.sequenceLinkId Definition List of input service items which this service line is intended to replace. Control ( Example 0..* )
Type positiveInt Summary CodeableConcept
ClaimResponse.addItem.service ClaimResponse.addItem.modifier
Definition

A code to indicate Item typification or modifiers codes, eg for Oral whether the Professional Service treatment is cosmetic or Product supplied. associated with TMJ, or for medical whether the treatment was outside the clinic or out of office hours.

Control 1..1 0..*
Terminology Binding USCLS Codes: Allowable service and product codes. Modifier type Codes ( Example )
Type Coding CodeableConcept
Summary Requirements true

May impact on adjudication.

ClaimResponse.addItem.fee
Definition

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.

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

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 type of reveneu or cost center providing the code. product and/or service.

Control 0..1
Type Terminology Binding Money Example Revenue Center Codes ( Example )
Summary Type true CodeableConcept
ClaimResponse.addItem.adjudication.value ClaimResponse.addItem.detail.category
Definition

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

Control 0..1
Type decimal Terminology Binding Summary Benefit SubCategory Codes true ( Example ClaimResponse.addItem.detail Definition The second tier service adjudications for payor added services. )
Control Type 0..* Summary CodeableConcept
ClaimResponse.addItem.detail.service
Definition

A code to indicate the Professional Service or Product supplied.

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

The fee charged Item typification or modifiers codes, eg for Oral whether the professional service treatment is cosmetic or product.. associated with TMJ, or for medical whether the treatment was outside the clinic or out of office hours.

Control 0..1 0..*
Type Terminology Binding Money Modifier type Codes ( Example )
Summary Type true CodeableConcept ClaimResponse.addItem.detail.adjudication
Definition Requirements

The adjudications results. May impact on adjudication.

ClaimResponse.addItem.detail.adjudication.code ClaimResponse.addItem.detail.fee
Definition

Code indicating: Co-Pay, deductible, eligible, benefit, tax, etc. The fee charged for the professional service or product..

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

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

Control 0..1 0..*
Type Money Summary positiveInt
ClaimResponse.addItem.detail.adjudication.value ClaimResponse.addItem.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.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,froma code,from a specified code system, which details why the claim could not be adjudicated.

Control 1..1
Terminology Binding Adjudication Error Codes: The error codes for adjudication processing. Codes ( Required Example )
Type Coding Summary CodeableConcept
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 true 0..1
ClaimResponse.paymentAdjustment 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
Definition

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.

Control 0..1
Terminology Binding Payment Adjustment Reason Codes: Adjustment reason codes. Codes ( Extensible Example )
Type Coding Summary CodeableConcept
ClaimResponse.paymentDate ClaimResponse.payment.date
Definition

Estimated payment data.

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

Payable less any payment adjustment.

Control 0..1
Type Money
ClaimResponse.paymentRef 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
Terminology Binding Funds Reservation Codes: For whom funds are to be reserved: (Patient, Provider, None). Codes ( Example )
Type Coding
ClaimResponse.form
Definition

The form to be used for printing the content.

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

Note text.

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

The note purpose: Print/Display.

Control 0..1
Terminology Binding NoteType: The presentation types of notes. NoteType ( Required )
Type Coding CodeableConcept
ClaimResponse.processNote.text
Definition

The note text.

Control true 0..1
Type string
ClaimResponse.note.text ClaimResponse.processNote.language
Definition

The note text. 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 ( Extensible but limited to ??)
Type string CodeableConcept
ClaimResponse.communicationRequest
Definition

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

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

A service line item.

Control 1..1
Type positiveInt
Requirements

To maintain order of the coverages.

ClaimResponse.coverage.focal 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.coverage.coverage 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.coverage.businessArrangement ClaimResponse.insurance.businessArrangement
Definition

The contract number of a business agreement which describes the terms and conditions.

Control 0..1
Type string
ClaimResponse.coverage.preAuthRef 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.coverage.claimResponse 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.