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
Detailed Descriptions for the elements in the ClaimResponse resource.
| 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. |
| Control | 0..* |
| Type | Identifier |
| ClaimResponse.request | |
| Definition | Original request resource referrence. |
| Control | 0..1 |
| Type | Reference(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. |
| Control | 0..1 |
| Binding | Ruleset: 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.) |
| Type | Coding |
| ClaimResponse.originalRuleset | |
| Definition | The style (standard) and version of the original material which was converted into this resource. |
| Control | 0..1 |
| Binding | Ruleset: 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.) |
| 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. |
| ClaimResponse.created | |
| Definition | The date when the enclosed suite of services were performed or completed. |
| Control | 0..1 |
| Type | dateTime |
| ClaimResponse.organization | |
| 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.outcome | |
| Definition | Transaction status: error, complete. |
| Control | 0..1 |
| Binding | RemittanceOutcome: Required: http://hl7.org/fhir/RS-link (The outcome of the processing.) |
| Type | code |
| 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 |
| Binding | PayeeType: Example: See http://hl7.org/fhir/vs/payeetype (A code for the party to be reimbursed.) |
| Type | Coding |
| 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 | integer |
| ClaimResponse.item.noteNumber | |
| Definition | A list of note references to the notes provided below. |
| Control | 0..* |
| Type | integer |
| ClaimResponse.item.adjudication | |
| Definition | The adjudications results. |
| Control | 0..* |
| ClaimResponse.item.adjudication.code | |
| Definition | Code indicating: Co-Pay, deductable, elegible, benefit, tax, etc. |
| Control | 1..1 |
| Binding | Adjudication: Preferred: See http://hl7.org/fhir/vs/adjudication (The adjudication codes) |
| Type | Coding |
| ClaimResponse.item.adjudication.amount | |
| Definition | Monitory amount associated with the code. |
| Control | 0..1 |
| Type | Money |
| ClaimResponse.item.adjudication.value | |
| Definition | A non-monitary 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 | integer |
| ClaimResponse.item.detail.adjudication | |
| Definition | The adjudications results. |
| Control | 0..* |
| ClaimResponse.item.detail.adjudication.code | |
| Definition | Code indicating: Co-Pay, deductable, elegible, benefit, tax, etc. |
| Control | 1..1 |
| Binding | Adjudication: Preferred: See http://hl7.org/fhir/vs/adjudication (The adjudication codes) |
| Type | Coding |
| ClaimResponse.item.detail.adjudication.amount | |
| Definition | Monitory amount associated with the code. |
| Control | 0..1 |
| Type | Money |
| ClaimResponse.item.detail.adjudication.value | |
| Definition | A non-monitary value for example a percentage. Mutually exclusive to the amount element above. |
| Control | 0..1 |
| Type | decimal |
| ClaimResponse.item.detail.subdetail | |
| Definition | The third tier service adjudications for submitted services. |
| Control | 0..* |
| ClaimResponse.item.detail.subdetail.sequenceLinkId | |
| Definition | A service line number. |
| Control | 1..1 |
| Type | integer |
| ClaimResponse.item.detail.subdetail.adjudication | |
| Definition | The adjudications results. |
| Control | 0..* |
| ClaimResponse.item.detail.subdetail.adjudication.code | |
| Definition | Code indicating: Co-Pay, deductable, elegible, benefit, tax, etc. |
| Control | 1..1 |
| Binding | Adjudication: Preferred: See http://hl7.org/fhir/vs/adjudication (The adjudication codes) |
| Type | Coding |
| ClaimResponse.item.detail.subdetail.adjudication.amount | |
| Definition | Monitory amount associated with the code. |
| Control | 0..1 |
| Type | Money |
| ClaimResponse.item.detail.subdetail.adjudication.value | |
| Definition | A non-monitary value for example a percentage. Mutually exclusive to the amount element above. |
| Control | 0..1 |
| Type | decimal |
| ClaimResponse.additem | |
| Definition | The first tier service adjudications for payor added services. |
| Control | 0..* |
| ClaimResponse.additem.sequenceLinkId | |
| Definition | List of input service items which this service line is intended to replace. |
| Control | 0..* |
| Type | integer |
| ClaimResponse.additem.service | |
| Definition | A code to indicate the Professional Service or Product supplied. |
| Control | 1..1 |
| Binding | ServiceProduct: Example: See http://hl7.org/fhir/vs/service-uscls (Allowable service and product codes) |
| Type | Coding |
| ClaimResponse.additem.fee | |
| Definition | The fee charged for the professional service or product.. |
| Control | 0..1 |
| Type | Money |
| ClaimResponse.additem.noteNumberLinkId | |
| Definition | A list of note references to the notes provided below. |
| Control | 0..* |
| Type | integer |
| ClaimResponse.additem.adjudication | |
| Definition | The adjudications results. |
| Control | 0..* |
| ClaimResponse.additem.adjudication.code | |
| Definition | Code indicating: Co-Pay, deductable, elegible, benefit, tax, etc. |
| Control | 1..1 |
| Binding | Adjudication: Preferred: See http://hl7.org/fhir/vs/adjudication (The adjudication codes) |
| Type | Coding |
| ClaimResponse.additem.adjudication.amount | |
| Definition | Monitory amount associated with the code. |
| Control | 0..1 |
| Type | Money |
| ClaimResponse.additem.adjudication.value | |
| Definition | A non-monitary value for example a percentage. Mutually exclusive to the amount element above. |
| Control | 0..1 |
| Type | decimal |
| ClaimResponse.additem.detail | |
| Definition | The second tier service adjudications for payor added services. |
| Control | 0..* |
| ClaimResponse.additem.detail.service | |
| Definition | A code to indicate the Professional Service or Product supplied. |
| Control | 1..1 |
| Binding | ServiceProduct: Example: See http://hl7.org/fhir/vs/service-uscls (Allowable service and product codes) |
| Type | Coding |
| ClaimResponse.additem.detail.fee | |
| Definition | The fee charged for the professional service or product.. |
| Control | 0..1 |
| Type | Money |
| ClaimResponse.additem.detail.adjudication | |
| Definition | The adjudications results. |
| Control | 0..* |
| ClaimResponse.additem.detail.adjudication.code | |
| Definition | Code indicating: Co-Pay, deductable, elegible, benefit, tax, etc. |
| Control | 1..1 |
| Binding | Adjudication: Preferred: See http://hl7.org/fhir/vs/adjudication (The adjudication codes) |
| Type | Coding |
| ClaimResponse.additem.detail.adjudication.amount | |
| Definition | Monitory amount associated with the code. |
| Control | 0..1 |
| Type | Money |
| ClaimResponse.additem.detail.adjudication.value | |
| Definition | A non-monitary value for example a percentage. Mutually exclusive to the amount element above. |
| Control | 0..1 |
| Type | decimal |
| 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 ommitted when the error is elsewhere. |
| Control | 0..1 |
| Type | integer |
| 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. |
| Control | 0..1 |
| Type | integer |
| 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. |
| Control | 0..1 |
| Type | integer |
| ClaimResponse.error.code | |
| Definition | An error code,froma specified code system, which details why the claim could not be adjudicated. |
| Control | 1..1 |
| Binding | AdjudicationError: Preferred: See http://hl7.org/fhir/vs/adjudication-error (The error codes for adjudication processing) |
| Type | Coding |
| 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 deductable 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 Deductable). |
| Control | 0..1 |
| Type | Money |
| ClaimResponse.paymentAdjustment | |
| Definition | Adjustment to the payment of this transaction which is not related to adjudication of this transaction. |
| Control | 0..1 |
| Type | Money |
| ClaimResponse.paymentAdjustmentReason | |
| Definition | Reason for the payment adjustment. |
| Control | 0..1 |
| Binding | AdjustmentReason: Preferred: See http://hl7.org/fhir/vs/adjustment-reason (Adjustment reason codes) |
| Type | Coding |
| ClaimResponse.paymentDate | |
| Definition | Estimated payment data. |
| Control | 0..1 |
| Type | date |
| ClaimResponse.paymentAmount | |
| Definition | Payable less any payment adjustment. |
| Control | 0..1 |
| Type | Money |
| ClaimResponse.paymentRef | |
| Definition | Payment identifer. |
| Control | 0..1 |
| Type | Identifier |
| ClaimResponse.reserved | |
| Definition | Status of funds reservation (For provider, for Patient, None). |
| Control | 0..1 |
| Binding | FundsReserve: Example: See http://hl7.org/fhir/vs/fundsreserve (For whom funds are to be reserved: (Patient, Provider, None)) |
| Type | Coding |
| ClaimResponse.form | |
| Definition | The form to be used for printing the content. |
| Control | 0..1 |
| Binding | Forms: Preferred: See http://hl7.org/fhir/vs/forms (The forms codes) |
| Type | Coding |
| ClaimResponse.note | |
| Definition | Note text. |
| Control | 0..* |
| ClaimResponse.note.number | |
| Definition | An integer associated with each note which may be referred to from each service line item. |
| Control | 0..1 |
| Type | integer |
| ClaimResponse.note.type | |
| Definition | The note purpose: Print/Display. |
| Control | 0..1 |
| Binding | NoteType: Preferred: http://hl7.org/fhir/NT-link (The presentation types of notes) |
| Type | Coding |
| ClaimResponse.note.text | |
| Definition | The note text. |
| Control | 0..1 |
| Type | string |