2nd DSTU Draft For Comment

This page is part of the FHIR Specification (v0.4.0: DSTU 2 Draft). 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

7.1.4 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.

Control0..*
TypeIdentifier
ClaimResponse.request
Definition

Original request resource referrence.

Control0..1
TypeReference(OralHealthClaim | PharmacyClaim | VisionClaim | ProfessionalClaim | InstitutionalClaim)
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: Example: See http://hl7.org/fhir/vs/ruleset (The static and dynamic model to which contents conform, may be business version or standard and version.)
TypeCoding
ClaimResponse.originalRuleset
Definition

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

Control0..1
BindingRuleset: Example: See http://hl7.org/fhir/vs/ruleset (The static and dynamic model to which contents conform, may be business version or standard and version.)
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.

ClaimResponse.created
Definition

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

Control0..1
TypedateTime
ClaimResponse.organization
Definition

The Insurer who produced this adjudicated response.

Control0..1
TypeReference(Organization)
ClaimResponse.requestProvider
Definition

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

Control0..1
TypeReference(Practitioner)
ClaimResponse.requestOrganization
Definition

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

Control0..1
TypeReference(Organization)
ClaimResponse.outcome
Definition

Transaction status: error, complete.

Control0..1
BindingRemittanceOutcome: Required: http://hl7.org/fhir/RS-link (The outcome of the processing.)
Typecode
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
BindingPayeeType: Example: See http://hl7.org/fhir/vs/payeetype (A code for the party to be reimbursed.)
TypeCoding
ClaimResponse.item
Definition

The first tier service adjudications for submitted services.

Control0..*
ClaimResponse.item.sequenceLinkId
Definition

A service line number.

Control1..1
Typeinteger
ClaimResponse.item.noteNumber
Definition

A list of note references to the notes provided below.

Control0..*
Typeinteger
ClaimResponse.item.adjudication
Definition

The adjudications results.

Control0..*
ClaimResponse.item.adjudication.code
Definition

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

Control1..1
BindingAdjudication: Preferred: See http://hl7.org/fhir/vs/adjudication (The adjudication codes)
TypeCoding
ClaimResponse.item.adjudication.amount
Definition

Monitory amount associated with the code.

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

A non-monitary 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
Typeinteger
ClaimResponse.item.detail.adjudication
Definition

The adjudications results.

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

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

Control1..1
BindingAdjudication: Preferred: See http://hl7.org/fhir/vs/adjudication (The adjudication codes)
TypeCoding
ClaimResponse.item.detail.adjudication.amount
Definition

Monitory amount associated with the code.

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

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

Control0..1
Typedecimal
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
Typeinteger
ClaimResponse.item.detail.subdetail.adjudication
Definition

The adjudications results.

Control0..*
ClaimResponse.item.detail.subdetail.adjudication.code
Definition

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

Control1..1
BindingAdjudication: Preferred: See http://hl7.org/fhir/vs/adjudication (The adjudication codes)
TypeCoding
ClaimResponse.item.detail.subdetail.adjudication.amount
Definition

Monitory amount associated with the code.

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

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

Control0..1
Typedecimal
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..*
Typeinteger
ClaimResponse.additem.service
Definition

A code to indicate the Professional Service or Product supplied.

Control1..1
BindingServiceProduct: Example: See http://hl7.org/fhir/vs/service-uscls (Allowable service and product codes)
TypeCoding
ClaimResponse.additem.fee
Definition

The fee charged for the professional service or product..

Control0..1
TypeMoney
ClaimResponse.additem.noteNumberLinkId
Definition

A list of note references to the notes provided below.

Control0..*
Typeinteger
ClaimResponse.additem.adjudication
Definition

The adjudications results.

Control0..*
ClaimResponse.additem.adjudication.code
Definition

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

Control1..1
BindingAdjudication: Preferred: See http://hl7.org/fhir/vs/adjudication (The adjudication codes)
TypeCoding
ClaimResponse.additem.adjudication.amount
Definition

Monitory amount associated with the code.

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

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

Control0..1
Typedecimal
ClaimResponse.additem.detail
Definition

The second tier service adjudications for payor added services.

Control0..*
ClaimResponse.additem.detail.service
Definition

A code to indicate the Professional Service or Product supplied.

Control1..1
BindingServiceProduct: Example: See http://hl7.org/fhir/vs/service-uscls (Allowable service and product codes)
TypeCoding
ClaimResponse.additem.detail.fee
Definition

The fee charged for the professional service or product..

Control0..1
TypeMoney
ClaimResponse.additem.detail.adjudication
Definition

The adjudications results.

Control0..*
ClaimResponse.additem.detail.adjudication.code
Definition

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

Control1..1
BindingAdjudication: Preferred: See http://hl7.org/fhir/vs/adjudication (The adjudication codes)
TypeCoding
ClaimResponse.additem.detail.adjudication.amount
Definition

Monitory amount associated with the code.

Control0..1
TypeMoney
ClaimResponse.additem.detail.adjudication.value
Definition

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

Control0..1
Typedecimal
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 ommitted when the error is elsewhere.

Control0..1
Typeinteger
ClaimResponse.error.detailSequenceLinkId
Definition

The sequence number of the addition within the line item submitted which contains the error. This value is ommitted when the error is not related to an Addition.

Control0..1
Typeinteger
ClaimResponse.error.subdetailSequenceLinkId
Definition

The sequence number of the addition within the line item submitted which contains the error. This value is ommitted when the error is not related to an Addition.

Control0..1
Typeinteger
ClaimResponse.error.code
Definition

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

Control1..1
BindingAdjudicationError: Preferred: See http://hl7.org/fhir/vs/adjudication-error (The error codes for adjudication processing)
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 deductable 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 Deductable).

Control0..1
TypeMoney
ClaimResponse.paymentAdjustment
Definition

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

Control0..1
TypeMoney
ClaimResponse.paymentAdjustmentReason
Definition

Reason for the payment adjustment.

Control0..1
BindingAdjustmentReason: Preferred: See http://hl7.org/fhir/vs/adjustment-reason (Adjustment reason codes)
TypeCoding
ClaimResponse.paymentDate
Definition

Estimated payment data.

Control0..1
Typedate
ClaimResponse.paymentAmount
Definition

Payable less any payment adjustment.

Control0..1
TypeMoney
ClaimResponse.paymentRef
Definition

Payment identifer.

Control0..1
TypeIdentifier
ClaimResponse.reserved
Definition

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

Control0..1
BindingFundsReserve: Example: See http://hl7.org/fhir/vs/fundsreserve (For whom funds are to be reserved: (Patient, Provider, None))
TypeCoding
ClaimResponse.form
Definition

The form to be used for printing the content.

Control0..1
BindingForms: Preferred: See http://hl7.org/fhir/vs/forms (The forms codes)
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
Typeinteger
ClaimResponse.note.type
Definition

The note purpose: Print/Display.

Control0..1
BindingNoteType: Preferred: http://hl7.org/fhir/NT-link (The presentation types of notes)
TypeCoding
ClaimResponse.note.text
Definition

The note text.

Control0..1
Typestring