FHIR CI-Build

This is the Continuous Integration Build of FHIR (will be incorrect/inconsistent at times).
See the Directory of published versions icon

Financial Management icon Work GroupMaturity Level: 2 Trial UseSecurity Category: Patient Compartments: Patient, Practitioner

Detailed Descriptions for the elements in the ClaimResponse resource.

ClaimResponse
Element IdClaimResponse
Definition

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

Short DisplayResponse to a claim predetermination or preauthorization
Cardinality0..*
TypeDomainResource
Alternate NamesRemittance Advice
Summaryfalse
ClaimResponse.identifier
Element IdClaimResponse.identifier
Definition

A unique identifier assigned to this claim response.

Short DisplayBusiness Identifier for a claim response
NoteThis is a business identifier, not a resource identifier (see discussion)
Cardinality0..*
TypeIdentifier
Requirements

Allows claim responses to be distinguished and referenced.

Summaryfalse
ClaimResponse.traceNumber
Element IdClaimResponse.traceNumber
Definition

Trace number for tracking purposes. May be defined at the jurisdiction level or between trading partners.

Short DisplayNumber for tracking
Cardinality0..*
TypeIdentifier
Requirements

Allows partners to uniquely identify components for tracking.

Summaryfalse
ClaimResponse.status
Element IdClaimResponse.status
Definition

The status of the resource instance.

Short Displayactive | cancelled | draft | entered-in-error
Cardinality1..1
Terminology BindingFinancial Resource Status Codes (Required)
Typecode
Is Modifiertrue (Reason: This element is 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)
Requirements

Need to track the status of the resource as 'draft' resources may undergo further edits while 'active' resources are immutable and may only have their status changed to 'cancelled'.

Summarytrue
Comments

This element is labeled as a modifier because the status contains codes that mark the resource as not currently valid.

ClaimResponse.type
Element IdClaimResponse.type
Definition

A finer grained suite of claim type codes which may convey additional information such as Inpatient vs Outpatient and/or a specialty service.

Short DisplayMore granular claim type
Cardinality1..1
Terminology BindingClaim Type Codes (Extensible)
TypeCodeableConcept
Requirements

Some jurisdictions need a finer grained claim type for routing and adjudication.

Summarytrue
Comments

This may contain the local bill type codes, for example the US UB-04 bill type code or the CMS bill type.

ClaimResponse.subType
Element IdClaimResponse.subType
Definition

A finer grained suite of claim type codes which may convey additional information such as Inpatient vs Outpatient and/or a specialty service.

Short DisplayMore granular claim type
Cardinality0..1
Terminology BindingExample Claim SubType Codes (Example)
TypeCodeableConcept
Requirements

Some jurisdictions need a finer grained claim type for routing and adjudication.

Summaryfalse
Comments

This may contain the local bill type codes, for example the US UB-04 bill type code or the CMS bill type.

ClaimResponse.use
Element IdClaimResponse.use
Definition

A code to indicate whether the nature of the request is: Claim - A request to an Insurer to adjudicate the supplied charges for health care goods and services under the identified policy and to pay the determined Benefit amount, if any; Preauthorization - A request to an Insurer to adjudicate the supplied proposed future charges for health care goods and services under the identified policy and to approve the services and provide the expected benefit amounts and potentially to reserve funds to pay the benefits when Claims for the indicated services are later submitted; or, Pre-determination - A request to an Insurer to adjudicate the supplied 'what if' charges for health care goods and services under the identified policy and report back what the Benefit payable would be had the services actually been provided.

Short Displayclaim | preauthorization | predetermination
Cardinality1..1
Terminology BindingUse (Required)
Typecode
Requirements

This element is required to understand the nature of the request for adjudication.

Summarytrue
ClaimResponse.patient
Element IdClaimResponse.patient
Definition

The party to whom the professional services and/or products have been supplied or are being considered and for whom actual for facast reimbursement is sought.

Short DisplayThe recipient of the products and services
Cardinality1..1
TypeReference(Patient)
Requirements

The patient must be supplied to the insurer so that confirmation of coverage and service hstory may be considered as part of the authorization and/or adjudiction.

Summarytrue
ClaimResponse.created
Element IdClaimResponse.created
Definition

The date this resource was created.

Short DisplayResponse creation date
Cardinality1..1
TypedateTime
Requirements

Need to record a timestamp for use by both the recipient and the issuer.

Summarytrue
ClaimResponse.insurer
Element IdClaimResponse.insurer
Definition

The party responsible for authorization, adjudication and reimbursement.

Short DisplayParty responsible for reimbursement
Cardinality0..1
TypeReference(Organization)
Requirements

To be a valid claim, preauthorization or predetermination there must be a party who is responsible for adjudicating the contents against a policy which provides benefits for the patient.

Summarytrue
ClaimResponse.requestor
Element IdClaimResponse.requestor
Definition

The provider which is responsible for the claim, predetermination or preauthorization.

Short DisplayParty responsible for the claim
Cardinality0..1
TypeReference(Practitioner | PractitionerRole | Organization)
Summaryfalse
Comments

Typically this field would be 1..1 where this party is accountable for the data content within the claim but is not necessarily the facility, provider group or practitioner who provided the products and services listed within this claim resource. This field is the Billing Provider, for example, a facility, provider group, lab or practitioner..

ClaimResponse.request
Element IdClaimResponse.request
Definition

Original request resource reference.

Short DisplayId of resource triggering adjudication
Cardinality0..1
TypeReference(Claim)
Summarytrue
ClaimResponse.outcome
Element IdClaimResponse.outcome
Definition

The outcome of the claim, predetermination, or preauthorization processing.

Short Displayqueued | complete | error | partial
Cardinality1..1
Terminology BindingClaim Processing Codes (Required)
Typecode
Requirements

To advise the requestor of an overall processing outcome.

Summarytrue
Comments

The resource may be used to indicate that the Claim/Preauthorization/Pre-determination has been received but processing has not begun (queued); that it has been processed and one or more errors have been detected (error); no errors were detected and some of the adjudication processing has been performed (partial); or all of the adjudication processing has completed without errors (complete).

ClaimResponse.decision
Element IdClaimResponse.decision
Definition

The result of the claim, predetermination, or preauthorization adjudication.

Short DisplayResult of the adjudication
Cardinality0..1
Terminology BindingClaim Adjudication Decision Codes (Example)
TypeCodeableConcept
Requirements

To advise the requestor of the result of the adjudication process.

Summarytrue
Comments

The element is used to indicate the current state of the adjudication overall for the claim resource, for example: the request has been held (pended) for adjudication processing, for manual review or other reasons; that it has been processed and will be paid, or the outstanding paid, as submitted (approved); that no amount will be paid (denied); or that some amount between zero and the submitted amount will be paid (partial).

ClaimResponse.disposition
Element IdClaimResponse.disposition
Definition

A human readable description of the status of the adjudication.

Short DisplayDisposition Message
Cardinality0..1
Typestring
Requirements

Provided for user display.

Summaryfalse
ClaimResponse.preAuthRef
Element IdClaimResponse.preAuthRef
Definition

Reference from the Insurer which is used in later communications which refers to this adjudication.

Short DisplayPreauthorization reference
Cardinality0..1
Typestring
Requirements

On subsequent claims, the insurer may require the provider to quote this value.

Summaryfalse
Comments

This value is only present on preauthorization adjudications.

ClaimResponse.preAuthPeriod
Element IdClaimResponse.preAuthPeriod
Definition

The time frame during which this authorization is effective.

Short DisplayPreauthorization reference effective period
Cardinality0..1
TypePeriod
Requirements

To convey to the provider when the authorized products and services must be supplied for the authorized adjudication to apply.

Summaryfalse
ClaimResponse.event
Element IdClaimResponse.event
Definition

Information code for an event with a corresponding date or period.

Short DisplayEvent information
Cardinality0..*
Summaryfalse
ClaimResponse.event.type
Element IdClaimResponse.event.type
Definition

A coded event such as when a service is expected or a card printed.

Short DisplaySpecific event
Cardinality1..1
Terminology BindingDates Type Codes (Example)
TypeCodeableConcept
Summaryfalse
ClaimResponse.event.when[x]
Element IdClaimResponse.event.when[x]
Definition

A date or period in the past or future indicating when the event occurred or is expectd to occur.

Short DisplayOccurance date or period
Cardinality1..1
TypedateTime|Period
[x] NoteSee Choice of Datatypes for further information about how to use [x]
Summaryfalse
ClaimResponse.payeeType
Element IdClaimResponse.payeeType
Definition

Type of Party to be reimbursed: subscriber, provider, other.

Short DisplayParty to be paid any benefits payable
Cardinality0..1
Terminology BindingClaim Payee Type Codes (Example)
TypeCodeableConcept
Requirements

Need to know who should receive payment with the most common situations being the Provider (assignment of benefits) or the Subscriber.

Summaryfalse
ClaimResponse.encounter
Element IdClaimResponse.encounter
Definition

Healthcare encounters related to this claim.

Short DisplayEncounters associated with the listed treatments
Cardinality0..*
TypeReference(Encounter)
Requirements

Used in some jurisdictions to link clinical events to claim items.

Summaryfalse
Comments

This will typically be the encounter the event occurred within, but some activities may be initiated prior to or after the official completion of an encounter but still be tied to the context of the encounter.

ClaimResponse.diagnosisRelatedGroup
Element IdClaimResponse.diagnosisRelatedGroup
Definition

A package billing code or bundle code used to group products and services to a particular health condition (such as heart attack) which is based on a predetermined grouping code system.

Short DisplayPackage billing code
Cardinality0..1
Terminology BindingExample Diagnosis Related Group Codes (Example)
TypeCodeableConcept
Requirements

Required to relate the current diagnosis to a package billing code that is then referenced on the individual claim items which are specific to the health condition covered by the package code.

Summaryfalse
Comments

For example DRG (Diagnosis Related Group) or a bundled billing code. A patient may have a diagnosis of a Myocardial Infarction and a DRG for HeartAttack would be assigned. The Claim item (and possible subsequent claims) would refer to the DRG for those line items that were for services related to the heart attack event.

ClaimResponse.item
Element IdClaimResponse.item
Definition

A claim line. Either a simple (a product or service) or a 'group' of details which can also be a simple items or groups of sub-details.

Short DisplayAdjudication for claim line items
Cardinality0..*
Requirements

The adjudication for items provided on the claim.

Summaryfalse
ClaimResponse.item.itemSequence
Element IdClaimResponse.item.itemSequence
Definition

A number to uniquely reference the claim item entries.

Short DisplayClaim item instance identifier
Cardinality1..1
TypepositiveInt
Requirements

Necessary to provide a mechanism to link the adjudication result to the submitted claim item.

Summaryfalse
ClaimResponse.item.traceNumber
Element IdClaimResponse.item.traceNumber
Definition

Trace number for tracking purposes. May be defined at the jurisdiction level or between trading partners.

Short DisplayNumber for tracking
Cardinality0..*
TypeIdentifier
Requirements

Allows partners to uniquely identify components for tracking.

Summaryfalse
ClaimResponse.item.noteNumber
Element IdClaimResponse.item.noteNumber
Definition

The numbers associated with notes below which apply to the adjudication of this item.

Short DisplayApplicable note numbers
Cardinality0..*
TypepositiveInt
Requirements

Provides a condensed manner for associating human readable descriptive explanations for adjudications on the line item.

Summaryfalse
ClaimResponse.item.reviewOutcome
Element IdClaimResponse.item.reviewOutcome
Definition

The high-level results of the adjudication if adjudication has been performed.

Short DisplayAdjudication results
Cardinality0..1
Summaryfalse
ClaimResponse.item.reviewOutcome.decision
Element IdClaimResponse.item.reviewOutcome.decision
Definition

The result of the claim, predetermination, or preauthorization adjudication.

Short DisplayResult of the adjudication
Cardinality0..1
Terminology BindingClaim Adjudication Decision Codes (Example)
TypeCodeableConcept
Requirements

To advise the requestor of the result of the adjudication process.

Summaryfalse
Comments

The element is used to indicate the current state of the adjudication overall for the claim resource, for example: the request has been held (pended) for adjudication processing, for manual review or other reasons; that it has been processed and will be paid, or the outstanding paid, as submitted (approved); that no amount will be paid (denied); or that some amount between zero and the submitted amount will be paid (partial).

ClaimResponse.item.reviewOutcome.reason
Element IdClaimResponse.item.reviewOutcome.reason
Definition

The reasons for the result of the claim, predetermination, or preauthorization adjudication.

Short DisplayReason for result of the adjudication
Cardinality0..*
Terminology BindingClaim Adjudication Decision Reason Codes (Example)
TypeCodeableConcept
Requirements

To advise the requestor of the contributors to the result of the adjudication process.

Summaryfalse
ClaimResponse.item.reviewOutcome.preAuthRef
Element IdClaimResponse.item.reviewOutcome.preAuthRef
Definition

Reference from the Insurer which is used in later communications which refers to this adjudication.

Short DisplayPreauthorization reference
Cardinality0..1
Typestring
Requirements

On subsequent claims, the insurer may require the provider to quote this value.

Summaryfalse
Comments

This value is only present on preauthorization adjudications.

ClaimResponse.item.reviewOutcome.preAuthPeriod
Element IdClaimResponse.item.reviewOutcome.preAuthPeriod
Definition

The time frame during which this authorization is effective.

Short DisplayPreauthorization reference effective period
Cardinality0..1
TypePeriod
Requirements

To convey to the provider when the authorized products and services must be supplied for the authorized adjudication to apply.

Summaryfalse
ClaimResponse.item.adjudication
Element IdClaimResponse.item.adjudication
Definition

If this item is a group then the values here are a summary of the adjudication of the detail items. If this item is a simple product or service then this is the result of the adjudication of this item.

Short DisplayAdjudication details
Cardinality0..*
Requirements

The adjudication results conveys the insurer's assessment of the item provided in the claim under the terms of the patient's insurance coverage.

Summaryfalse
ClaimResponse.item.adjudication.category
Element IdClaimResponse.item.adjudication.category
Definition

A code to indicate the information type of this adjudication record. Information types may include the value submitted, maximum values or percentages allowed or payable under the plan, amounts that: the patient is responsible for in aggregate or pertaining to this item; amounts paid by other coverages; and, the benefit payable for this item.

Short DisplayType of adjudication information
Cardinality1..1
Terminology BindingAdjudication Value Codes (Example)
TypeCodeableConcept
Requirements

Needed to enable understanding of the context of the other information in the adjudication.

Summaryfalse
Comments

For example codes indicating: Co-Pay, deductible, eligible, benefit, tax, etc.

ClaimResponse.item.adjudication.reason
Element IdClaimResponse.item.adjudication.reason
Definition

A code supporting the understanding of the adjudication result and explaining variance from expected amount.

Short DisplayExplanation of adjudication outcome
Cardinality0..1
Terminology BindingAdjudication Reason Codes (Example)
TypeCodeableConcept
Requirements

To support understanding of variance from adjudication expectations.

Summaryfalse
Comments

For example may indicate that the funds for this benefit type have been exhausted.

ClaimResponse.item.adjudication.amount
Element IdClaimResponse.item.adjudication.amount
Definition

Monetary amount associated with the category.

Short DisplayMonetary amount
Cardinality0..1
TypeMoney
Requirements

Most adjudication categories convey a monetary amount.

Summaryfalse
Comments

For example: amount submitted, eligible amount, co-payment, and benefit payable.

ClaimResponse.item.adjudication.quantity
Element IdClaimResponse.item.adjudication.quantity
Definition

A non-monetary value associated with the category. Mutually exclusive to the amount element above.

Short DisplayNon-monetary value
Cardinality0..1
TypeQuantity
Requirements

Some adjudication categories convey a percentage or a fixed value.

Summaryfalse
Comments

For example: eligible percentage or co-payment percentage.

ClaimResponse.item.detail
Element IdClaimResponse.item.detail
Definition

A claim detail. Either a simple (a product or service) or a 'group' of sub-details which are simple items.

Short DisplayAdjudication for claim details
Cardinality0..*
Requirements

The adjudication for details provided on the claim.

Summaryfalse
ClaimResponse.item.detail.detailSequence
Element IdClaimResponse.item.detail.detailSequence
Definition

A number to uniquely reference the claim detail entry.

Short DisplayClaim detail instance identifier
Cardinality1..1
TypepositiveInt
Requirements

Necessary to provide a mechanism to link the adjudication result to the submitted claim detail.

Summaryfalse
ClaimResponse.item.detail.traceNumber
Element IdClaimResponse.item.detail.traceNumber
Definition

Trace number for tracking purposes. May be defined at the jurisdiction level or between trading partners.

Short DisplayNumber for tracking
Cardinality0..*
TypeIdentifier
Requirements

Allows partners to uniquely identify components for tracking.

Summaryfalse
ClaimResponse.item.detail.noteNumber
Element IdClaimResponse.item.detail.noteNumber
Definition

The numbers associated with notes below which apply to the adjudication of this item.

Short DisplayApplicable note numbers
Cardinality0..*
TypepositiveInt
Requirements

Provides a condensed manner for associating human readable descriptive explanations for adjudications on the line item.

Summaryfalse
ClaimResponse.item.detail.reviewOutcome
Element IdClaimResponse.item.detail.reviewOutcome
Definition

The high-level results of the adjudication if adjudication has been performed.

Short DisplayDetail level adjudication results
Cardinality0..1
TypeSee ClaimResponse.item.reviewOutcome
Summaryfalse
ClaimResponse.item.detail.adjudication
Element IdClaimResponse.item.detail.adjudication
Definition

The adjudication results.

Short DisplayDetail level adjudication details
Cardinality0..*
TypeSee ClaimResponse.item.adjudication
Summaryfalse
ClaimResponse.item.detail.subDetail
Element IdClaimResponse.item.detail.subDetail
Definition

A sub-detail adjudication of a simple product or service.

Short DisplayAdjudication for claim sub-details
Cardinality0..*
Requirements

The adjudication for sub-details provided on the claim.

Summaryfalse
ClaimResponse.item.detail.subDetail.subDetailSequence
Element IdClaimResponse.item.detail.subDetail.subDetailSequence
Definition

A number to uniquely reference the claim sub-detail entry.

Short DisplayClaim sub-detail instance identifier
Cardinality1..1
TypepositiveInt
Requirements

Necessary to provide a mechanism to link the adjudication result to the submitted claim sub-detail.

Summaryfalse
ClaimResponse.item.detail.subDetail.traceNumber
Element IdClaimResponse.item.detail.subDetail.traceNumber
Definition

Trace number for tracking purposes. May be defined at the jurisdiction level or between trading partners.

Short DisplayNumber for tracking
Cardinality0..*
TypeIdentifier
Requirements

Allows partners to uniquely identify components for tracking.

Summaryfalse
ClaimResponse.item.detail.subDetail.noteNumber
Element IdClaimResponse.item.detail.subDetail.noteNumber
Definition

The numbers associated with notes below which apply to the adjudication of this item.

Short DisplayApplicable note numbers
Cardinality0..*
TypepositiveInt
Requirements

Provides a condensed manner for associating human readable descriptive explanations for adjudications on the line item.

Summaryfalse
ClaimResponse.item.detail.subDetail.reviewOutcome
Element IdClaimResponse.item.detail.subDetail.reviewOutcome
Definition

The high-level results of the adjudication if adjudication has been performed.

Short DisplaySubdetail level adjudication results
Cardinality0..1
TypeSee ClaimResponse.item.reviewOutcome
Summaryfalse
ClaimResponse.item.detail.subDetail.adjudication
Element IdClaimResponse.item.detail.subDetail.adjudication
Definition

The adjudication results.

Short DisplaySubdetail level adjudication details
Cardinality0..*
TypeSee ClaimResponse.item.adjudication
Summaryfalse
ClaimResponse.addItem
Element IdClaimResponse.addItem
Definition

The first-tier service adjudications for payor added product or service lines.

Short DisplayInsurer added line items
Cardinality0..*
Requirements

Insurers may redefine the provided product or service or may package and/or decompose groups of products and services. The addItems allows the insurer to provide their line item list with linkage to the submitted items/details/sub-details. In a preauthorization the insurer may use the addItem structure to provide additional information on authorized products and services.

Summaryfalse
ClaimResponse.addItem.itemSequence
Element IdClaimResponse.addItem.itemSequence
Definition

Claim items which this service line is intended to replace.

Short DisplayItem sequence number
Cardinality0..*
TypepositiveInt
Requirements

Provides references to the claim items.

Summaryfalse
ClaimResponse.addItem.detailSequence
Element IdClaimResponse.addItem.detailSequence
Definition

The sequence number of the details within the claim item which this line is intended to replace.

Short DisplayDetail sequence number
Cardinality0..*
TypepositiveInt
Requirements

Provides references to the claim details within the claim item.

Summaryfalse
ClaimResponse.addItem.subdetailSequence
Element IdClaimResponse.addItem.subdetailSequence
Definition

The sequence number of the sub-details within the details within the claim item which this line is intended to replace.

Short DisplaySubdetail sequence number
Cardinality0..*
TypepositiveInt
Requirements

Provides references to the claim sub-details within the claim detail.

Summaryfalse
ClaimResponse.addItem.traceNumber
Element IdClaimResponse.addItem.traceNumber
Definition

Trace number for tracking purposes. May be defined at the jurisdiction level or between trading partners.

Short DisplayNumber for tracking
Cardinality0..*
TypeIdentifier
Requirements

Allows partners to uniquely identify components for tracking.

Summaryfalse
ClaimResponse.addItem.provider
Element IdClaimResponse.addItem.provider
Definition

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

Short DisplayAuthorized providers
Cardinality0..*
TypeReference(Practitioner | PractitionerRole | Organization)
Requirements

Insurer may provide authorization specifically to a restricted set of providers rather than an open authorization.

Summaryfalse
ClaimResponse.addItem.revenue
Element IdClaimResponse.addItem.revenue
Definition

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

Short DisplayRevenue or cost center code
Cardinality0..1
Terminology BindingExample Revenue Center Codes (Example)
TypeCodeableConcept
Requirements

Needed in the processing of institutional claims.

Summaryfalse
ClaimResponse.addItem.productOrService
Element IdClaimResponse.addItem.productOrService
Definition

When the value is a group code then this item collects a set of related item details, otherwise this contains the product, service, drug or other billing code for the item. This element may be the start of a range of .productOrService codes used in conjunction with .productOrServiceEnd or it may be a solo element where .productOrServiceEnd is not used.

Short DisplayBilling, service, product, or drug code
Cardinality0..1
Terminology BindingUSCLS Codes (Example)
TypeCodeableConcept
Requirements

Necessary to state what was provided or done.

Summaryfalse
Comments

If this is an actual service or product line, i.e. not a Group, then use code to indicate the Professional Service or Product supplied (e.g. CTP, HCPCS, USCLS, ICD10, NCPDP, DIN, RxNorm, ACHI, CCI). If a grouping item then use a group code to indicate the type of thing being grouped e.g. 'glasses' or 'compound'.

ClaimResponse.addItem.productOrServiceEnd
Element IdClaimResponse.addItem.productOrServiceEnd
Definition

This contains the end of a range of product, service, drug or other billing codes for the item. This element is not used when the .productOrService is a group code. This value may only be present when a .productOfService code has been provided to convey the start of the range. Typically this value may be used only with preauthorizations and not with claims.

Short DisplayEnd of a range of codes
Cardinality0..1
Terminology BindingUSCLS Codes (Example)
TypeCodeableConcept
Alternate NamesEnd of a range of Drug Code; Bill Code; Service Cod
Summaryfalse
ClaimResponse.addItem.request
Element IdClaimResponse.addItem.request
Definition

Request or Referral for Goods or Service to be rendered.

Short DisplayRequest or Referral for Service
Cardinality0..*
TypeReference(DeviceRequest | MedicationRequest | NutritionOrder | ServiceRequest | SupplyRequest | VisionPrescription)
Requirements

May identify the service to be provided or provider authorization for the service.

Summaryfalse
ClaimResponse.addItem.modifier
Element IdClaimResponse.addItem.modifier
Definition

Item typification or modifiers codes to convey additional context for the product or service.

Short DisplayService/Product billing modifiers
Cardinality0..*
Terminology BindingModifier type Codes (Example)
TypeCodeableConcept
Requirements

To support inclusion of the item for adjudication or to charge an elevated fee.

Summaryfalse
Comments

For example in Oral whether the treatment is cosmetic or associated with TMJ, or for Medical whether the treatment was outside the clinic or outside of office hours.

ClaimResponse.addItem.programCode
Element IdClaimResponse.addItem.programCode
Definition

Identifies the program under which this may be recovered.

Short DisplayProgram the product or service is provided under
Cardinality0..*
Terminology BindingExample Program Reason Codes (Example)
TypeCodeableConcept
Requirements

Commonly used in in the identification of publicly provided program focused on population segments or disease classifications.

Summaryfalse
Comments

For example: Neonatal program, child dental program or drug users recovery program.

ClaimResponse.addItem.serviced[x]
Element IdClaimResponse.addItem.serviced[x]
Definition

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

Short DisplayDate or dates of service or product delivery
Cardinality0..1
Typedate|Period
[x] NoteSee Choice of Datatypes for further information about how to use [x]
Requirements

Needed to determine whether the service or product was provided during the term of the insurance coverage.

Summaryfalse
ClaimResponse.addItem.location[x]
Element IdClaimResponse.addItem.location[x]
Definition

Where the product or service was provided.

Short DisplayPlace of service or where product was supplied
Cardinality0..1
Terminology BindingExample Service Place Codes (Example)
TypeCodeableConcept|Address|Reference(Location)
[x] NoteSee Choice of Datatypes for further information about how to use [x]
Requirements

The location can alter whether the item was acceptable for insurance purposes or impact the determination of the benefit amount.

Summaryfalse
ClaimResponse.addItem.quantity
Element IdClaimResponse.addItem.quantity
Definition

The number of repetitions of a service or product.

Short DisplayCount of products or services
Cardinality0..1
TypeSimpleQuantity
Requirements

Required when the product or service code does not convey the quantity provided.

Summaryfalse
ClaimResponse.addItem.unitPrice
Element IdClaimResponse.addItem.unitPrice
Definition

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

Short DisplayFee, charge or cost per item
Cardinality0..1
TypeMoney
Requirements

The amount charged to the patient by the provider for a single unit.

Summaryfalse
ClaimResponse.addItem.factor
Element IdClaimResponse.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.

Short DisplayPrice scaling factor
Cardinality0..1
Typedecimal
Requirements

When discounts are provided to a patient (example: Senior's discount) then this must be documented for adjudication.

Summaryfalse
Comments

To show a 10% senior's discount, the value entered is: 0.90 (1.00 - 0.10).

ClaimResponse.addItem.tax
Element IdClaimResponse.addItem.tax
Definition

The total of taxes applicable for this product or service.

Short DisplayTotal tax
Cardinality0..1
TypeMoney
Requirements

Required when taxes are not embedded in the unit price or provided as a separate service.

Summaryfalse
ClaimResponse.addItem.net
Element IdClaimResponse.addItem.net
Definition

The total amount claimed for the group (if a grouper) or the addItem. Net = unit price * quantity * factor.

Short DisplayTotal item cost
Cardinality0..1
TypeMoney
Requirements

Provides the total amount claimed for the group (if a grouper) or the line item.

Summaryfalse
Comments

For example, the formula: quantity * unitPrice * factor = net. Quantity and factor are assumed to be 1 if not supplied.

ClaimResponse.addItem.bodySite
Element IdClaimResponse.addItem.bodySite
Definition

Physical location where the service is performed or applies.

Short DisplayAnatomical location
Cardinality0..*
Summaryfalse
ClaimResponse.addItem.bodySite.site
Element IdClaimResponse.addItem.bodySite.site
Definition

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

Short DisplayLocation
Cardinality1..*
Terminology BindingOral Site Codes (Example)
TypeCodeableReference(BodyStructure)
Requirements

Allows insurer to validate specific procedures.

Summaryfalse
Comments

For example: Providing a tooth code allows an insurer to identify a provider performing a filling on a tooth that was previously removed.

ClaimResponse.addItem.bodySite.subSite
Element IdClaimResponse.addItem.bodySite.subSite
Definition

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

Short DisplaySub-location
Cardinality0..*
Terminology BindingSurface Codes (Example)
TypeCodeableConcept
Requirements

Allows insurer to validate specific procedures.

Summaryfalse
ClaimResponse.addItem.noteNumber
Element IdClaimResponse.addItem.noteNumber
Definition

The numbers associated with notes below which apply to the adjudication of this item.

Short DisplayApplicable note numbers
Cardinality0..*
TypepositiveInt
Requirements

Provides a condensed manner for associating human readable descriptive explanations for adjudications on the line item.

Summaryfalse
ClaimResponse.addItem.reviewOutcome
Element IdClaimResponse.addItem.reviewOutcome
Definition

The high-level results of the adjudication if adjudication has been performed.

Short DisplayAdded items adjudication results
Cardinality0..1
TypeSee ClaimResponse.item.reviewOutcome
Summaryfalse
ClaimResponse.addItem.adjudication
Element IdClaimResponse.addItem.adjudication
Definition

The adjudication results.

Short DisplayAdded items adjudication
Cardinality0..*
TypeSee ClaimResponse.item.adjudication
Summaryfalse
ClaimResponse.addItem.detail
Element IdClaimResponse.addItem.detail
Definition

The second-tier service adjudications for payor added services.

Short DisplayInsurer added line details
Cardinality0..*
Summaryfalse
ClaimResponse.addItem.detail.traceNumber
Element IdClaimResponse.addItem.detail.traceNumber
Definition

Trace number for tracking purposes. May be defined at the jurisdiction level or between trading partners.

Short DisplayNumber for tracking
Cardinality0..*
TypeIdentifier
Requirements

Allows partners to uniquely identify components for tracking.

Summaryfalse
ClaimResponse.addItem.detail.revenue
Element IdClaimResponse.addItem.detail.revenue
Definition

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

Short DisplayRevenue or cost center code
Cardinality0..1
Terminology BindingExample Revenue Center Codes (Example)
TypeCodeableConcept
Requirements

Needed in the processing of institutional claims.

Summaryfalse
ClaimResponse.addItem.detail.productOrService
Element IdClaimResponse.addItem.detail.productOrService
Definition

When the value is a group code then this item collects a set of related item details, otherwise this contains the product, service, drug or other billing code for the item. This element may be the start of a range of .productOrService codes used in conjunction with .productOrServiceEnd or it may be a solo element where .productOrServiceEnd is not used.

Short DisplayBilling, service, product, or drug code
Cardinality0..1
Terminology BindingUSCLS Codes (Example)
TypeCodeableConcept
Requirements

Necessary to state what was provided or done.

Summaryfalse
Comments

If this is an actual service or product line, i.e. not a Group, then use code to indicate the Professional Service or Product supplied (e.g. CTP, HCPCS, USCLS, ICD10, NCPDP, DIN, RxNorm, ACHI, CCI). If a grouping item then use a group code to indicate the type of thing being grouped e.g. 'glasses' or 'compound'.

ClaimResponse.addItem.detail.productOrServiceEnd
Element IdClaimResponse.addItem.detail.productOrServiceEnd
Definition

This contains the end of a range of product, service, drug or other billing codes for the item. This element is not used when the .productOrService is a group code. This value may only be present when a .productOfService code has been provided to convey the start of the range. Typically this value may be used only with preauthorizations and not with claims.

Short DisplayEnd of a range of codes
Cardinality0..1
Terminology BindingUSCLS Codes (Example)
TypeCodeableConcept
Alternate NamesEnd of a range of Drug Code; Bill Code; Service Cod
Summaryfalse
ClaimResponse.addItem.detail.modifier
Element IdClaimResponse.addItem.detail.modifier
Definition

Item typification or modifiers codes to convey additional context for the product or service.

Short DisplayService/Product billing modifiers
Cardinality0..*
Terminology BindingModifier type Codes (Example)
TypeCodeableConcept
Requirements

To support inclusion of the item for adjudication or to charge an elevated fee.

Summaryfalse
Comments

For example in Oral whether the treatment is cosmetic or associated with TMJ, or for Medical whether the treatment was outside the clinic or outside of office hours.

ClaimResponse.addItem.detail.quantity
Element IdClaimResponse.addItem.detail.quantity
Definition

The number of repetitions of a service or product.

Short DisplayCount of products or services
Cardinality0..1
TypeSimpleQuantity
Requirements

Required when the product or service code does not convey the quantity provided.

Summaryfalse
ClaimResponse.addItem.detail.unitPrice
Element IdClaimResponse.addItem.detail.unitPrice
Definition

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

Short DisplayFee, charge or cost per item
Cardinality0..1
TypeMoney
Requirements

The amount charged to the patient by the provider for a single unit.

Summaryfalse
ClaimResponse.addItem.detail.factor
Element IdClaimResponse.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.

Short DisplayPrice scaling factor
Cardinality0..1
Typedecimal
Requirements

When discounts are provided to a patient (example: Senior's discount) then this must be documented for adjudication.

Summaryfalse
Comments

To show a 10% senior's discount, the value entered is: 0.90 (1.00 - 0.10).

ClaimResponse.addItem.detail.tax
Element IdClaimResponse.addItem.detail.tax
Definition

The total of taxes applicable for this product or service.

Short DisplayTotal tax
Cardinality0..1
TypeMoney
Requirements

Required when taxes are not embedded in the unit price or provided as a separate service.

Summaryfalse
ClaimResponse.addItem.detail.net
Element IdClaimResponse.addItem.detail.net
Definition

The total amount claimed for the group (if a grouper) or the addItem.detail. Net = unit price * quantity * factor.

Short DisplayTotal item cost
Cardinality0..1
TypeMoney
Requirements

Provides the total amount claimed for the group (if a grouper) or the line item.

Summaryfalse
Comments

For example, the formula: quantity * unitPrice * factor = net. Quantity and factor are assumed to be 1 if not supplied.

ClaimResponse.addItem.detail.noteNumber
Element IdClaimResponse.addItem.detail.noteNumber
Definition

The numbers associated with notes below which apply to the adjudication of this item.

Short DisplayApplicable note numbers
Cardinality0..*
TypepositiveInt
Requirements

Provides a condensed manner for associating human readable descriptive explanations for adjudications on the line item.

Summaryfalse
ClaimResponse.addItem.detail.reviewOutcome
Element IdClaimResponse.addItem.detail.reviewOutcome
Definition

The high-level results of the adjudication if adjudication has been performed.

Short DisplayAdded items detail level adjudication results
Cardinality0..1
TypeSee ClaimResponse.item.reviewOutcome
Summaryfalse
ClaimResponse.addItem.detail.adjudication
Element IdClaimResponse.addItem.detail.adjudication
Definition

The adjudication results.

Short DisplayAdded items detail adjudication
Cardinality0..*
TypeSee ClaimResponse.item.adjudication
Summaryfalse
ClaimResponse.addItem.detail.subDetail
Element IdClaimResponse.addItem.detail.subDetail
Definition

The third-tier service adjudications for payor added services.

Short DisplayInsurer added line items
Cardinality0..*
Summaryfalse
ClaimResponse.addItem.detail.subDetail.traceNumber
Element IdClaimResponse.addItem.detail.subDetail.traceNumber
Definition

Trace number for tracking purposes. May be defined at the jurisdiction level or between trading partners.

Short DisplayNumber for tracking
Cardinality0..*
TypeIdentifier
Requirements

Allows partners to uniquely identify components for tracking.

Summaryfalse
ClaimResponse.addItem.detail.subDetail.revenue
Element IdClaimResponse.addItem.detail.subDetail.revenue
Definition

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

Short DisplayRevenue or cost center code
Cardinality0..1
Terminology BindingExample Revenue Center Codes (Example)
TypeCodeableConcept
Requirements

Needed in the processing of institutional claims.

Summaryfalse
ClaimResponse.addItem.detail.subDetail.productOrService
Element IdClaimResponse.addItem.detail.subDetail.productOrService
Definition

When the value is a group code then this item collects a set of related item details, otherwise this contains the product, service, drug or other billing code for the item. This element may be the start of a range of .productOrService codes used in conjunction with .productOrServiceEnd or it may be a solo element where .productOrServiceEnd is not used.

Short DisplayBilling, service, product, or drug code
Cardinality0..1
Terminology BindingUSCLS Codes (Example)
TypeCodeableConcept
Requirements

Necessary to state what was provided or done.

Summaryfalse
Comments

If this is an actual service or product line, i.e. not a Group, then use code to indicate the Professional Service or Product supplied (e.g. CTP, HCPCS, USCLS, ICD10, NCPDP, DIN, RxNorm, ACHI, CCI). If a grouping item then use a group code to indicate the type of thing being grouped e.g. 'glasses' or 'compound'.

ClaimResponse.addItem.detail.subDetail.productOrServiceEnd
Element IdClaimResponse.addItem.detail.subDetail.productOrServiceEnd
Definition

This contains the end of a range of product, service, drug or other billing codes for the item. This element is not used when the .productOrService is a group code. This value may only be present when a .productOfService code has been provided to convey the start of the range. Typically this value may be used only with preauthorizations and not with claims.

Short DisplayEnd of a range of codes
Cardinality0..1
Terminology BindingUSCLS Codes (Example)
TypeCodeableConcept
Alternate NamesEnd of a range of Drug Code; Bill Code; Service Cod
Summaryfalse
ClaimResponse.addItem.detail.subDetail.modifier
Element IdClaimResponse.addItem.detail.subDetail.modifier
Definition

Item typification or modifiers codes to convey additional context for the product or service.

Short DisplayService/Product billing modifiers
Cardinality0..*
Terminology BindingModifier type Codes (Example)
TypeCodeableConcept
Requirements

To support inclusion of the item for adjudication or to charge an elevated fee.

Summaryfalse
Comments

For example in Oral whether the treatment is cosmetic or associated with TMJ, or for Medical whether the treatment was outside the clinic or outside of office hours.

ClaimResponse.addItem.detail.subDetail.quantity
Element IdClaimResponse.addItem.detail.subDetail.quantity
Definition

The number of repetitions of a service or product.

Short DisplayCount of products or services
Cardinality0..1
TypeSimpleQuantity
Requirements

Required when the product or service code does not convey the quantity provided.

Summaryfalse
ClaimResponse.addItem.detail.subDetail.unitPrice
Element IdClaimResponse.addItem.detail.subDetail.unitPrice
Definition

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

Short DisplayFee, charge or cost per item
Cardinality0..1
TypeMoney
Requirements

The amount charged to the patient by the provider for a single unit.

Summaryfalse
ClaimResponse.addItem.detail.subDetail.factor
Element IdClaimResponse.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.

Short DisplayPrice scaling factor
Cardinality0..1
Typedecimal
Requirements

When discounts are provided to a patient (example: Senior's discount) then this must be documented for adjudication.

Summaryfalse
Comments

To show a 10% senior's discount, the value entered is: 0.90 (1.00 - 0.10).

ClaimResponse.addItem.detail.subDetail.tax
Element IdClaimResponse.addItem.detail.subDetail.tax
Definition

The total of taxes applicable for this product or service.

Short DisplayTotal tax
Cardinality0..1
TypeMoney
Requirements

Required when taxes are not embedded in the unit price or provided as a separate service.

Summaryfalse
ClaimResponse.addItem.detail.subDetail.net
Element IdClaimResponse.addItem.detail.subDetail.net
Definition

The total amount claimed for the addItem.detail.subDetail. Net = unit price * quantity * factor.

Short DisplayTotal item cost
Cardinality0..1
TypeMoney
Requirements

Provides the total amount claimed for the group (if a grouper) or the line item.

Summaryfalse
Comments

For example, the formula: quantity * unitPrice * factor = net. Quantity and factor are assumed to be 1 if not supplied.

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

The numbers associated with notes below which apply to the adjudication of this item.

Short DisplayApplicable note numbers
Cardinality0..*
TypepositiveInt
Requirements

Provides a condensed manner for associating human readable descriptive explanations for adjudications on the line item.

Summaryfalse
ClaimResponse.addItem.detail.subDetail.reviewOutcome
Element IdClaimResponse.addItem.detail.subDetail.reviewOutcome
Definition

The high-level results of the adjudication if adjudication has been performed.

Short DisplayAdded items subdetail level adjudication results
Cardinality0..1
TypeSee ClaimResponse.item.reviewOutcome
Summaryfalse
ClaimResponse.addItem.detail.subDetail.adjudication
Element IdClaimResponse.addItem.detail.subDetail.adjudication
Definition

The adjudication results.

Short DisplayAdded items subdetail adjudication
Cardinality0..*
TypeSee ClaimResponse.item.adjudication
Summaryfalse
ClaimResponse.adjudication
Element IdClaimResponse.adjudication
Definition

The adjudication results which are presented at the header level rather than at the line-item or add-item levels.

Short DisplayHeader-level adjudication
Cardinality0..*
TypeSee ClaimResponse.item.adjudication
Requirements

Some insurers will receive line-items but provide the adjudication only at a summary or header-level.

Summaryfalse
ClaimResponse.total
Element IdClaimResponse.total
Definition

Categorized monetary totals for the adjudication.

Short DisplayAdjudication totals
Cardinality0..*
Requirements

To provide the requestor with financial totals by category for the adjudication.

Summarytrue
Comments

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

ClaimResponse.total.category
Element IdClaimResponse.total.category
Definition

A code to indicate the information type of this adjudication record. Information types may include: the value submitted, maximum values or percentages allowed or payable under the plan, amounts that the patient is responsible for in aggregate or pertaining to this item, amounts paid by other coverages, and the benefit payable for this item.

Short DisplayType of adjudication information
Cardinality1..1
Terminology BindingAdjudication Value Codes (Example)
TypeCodeableConcept
Requirements

Needed to convey the type of total provided.

Summarytrue
Comments

For example codes indicating: Co-Pay, deductible, eligible, benefit, tax, etc.

ClaimResponse.total.amount
Element IdClaimResponse.total.amount
Definition

Monetary total amount associated with the category.

Short DisplayFinancial total for the category
Cardinality1..1
TypeMoney
Requirements

Needed to convey the total monetary amount.

Summarytrue
ClaimResponse.payment
Element IdClaimResponse.payment
Definition

Payment details for the adjudication of the claim.

Short DisplayPayment Details
Cardinality0..1
Requirements

Needed to convey references to the financial instrument that has been used if payment has been made.

Summaryfalse
ClaimResponse.payment.type
Element IdClaimResponse.payment.type
Definition

Whether this represents partial or complete payment of the benefits payable.

Short DisplayPartial or complete payment
Cardinality1..1
Terminology BindingExample Payment Type Codes (Example)
TypeCodeableConcept
Requirements

To advise the requestor when the insurer believes all payments to have been completed.

Summaryfalse
ClaimResponse.payment.adjustment
Element IdClaimResponse.payment.adjustment
Definition

Total amount of all adjustments to this payment included in this transaction which are not related to this claim's adjudication.

Short DisplayPayment adjustment for non-claim issues
Cardinality0..1
TypeMoney
Requirements

To advise the requestor of adjustments applied to the payment.

Summaryfalse
Comments

Insurers will deduct amounts owing from the provider (adjustment), such as a prior overpayment, from the amount owing to the provider (benefits payable) when payment is made to the provider.

ClaimResponse.payment.adjustmentReason
Element IdClaimResponse.payment.adjustmentReason
Definition

Reason for the payment adjustment.

Short DisplayExplanation for the adjustment
Cardinality0..1
Terminology BindingPayment Adjustment Reason Codes (Example)
TypeCodeableConcept
Requirements

Needed to clarify the monetary adjustment.

Summaryfalse
ClaimResponse.payment.date
Element IdClaimResponse.payment.date
Definition

Estimated date the payment will be issued or the actual issue date of payment.

Short DisplayExpected date of payment
Cardinality0..1
Typedate
Requirements

To advise the payee when payment can be expected.

Summaryfalse
ClaimResponse.payment.amount
Element IdClaimResponse.payment.amount
Definition

Benefits payable less any payment adjustment.

Short DisplayPayable amount after adjustment
Cardinality1..1
TypeMoney
Requirements

Needed to provide the actual payment amount.

Summaryfalse
ClaimResponse.payment.identifier
Element IdClaimResponse.payment.identifier
Definition

Issuer's unique identifier for the payment instrument.

Short DisplayBusiness identifier for the payment
NoteThis is a business identifier, not a resource identifier (see discussion)
Cardinality0..1
TypeIdentifier
Requirements

Enable the receiver to reconcile when payment received.

Summaryfalse
Comments

For example: EFT number or check number.

ClaimResponse.fundsReserve
Element IdClaimResponse.fundsReserve
Definition

A code, used only on a response to a preauthorization, to indicate whether the benefits payable have been reserved and for whom.

Short DisplayFunds reserved status
Cardinality0..1
Terminology BindingFunds Reservation Codes (Example)
TypeCodeableConcept
Requirements

Needed to advise the submitting provider on whether the rquest for reservation of funds has been honored.

Summaryfalse
Comments

Fund would be release by a future claim quoting the preAuthRef of this response. Examples of values include: provider, patient, none.

ClaimResponse.formCode
Element IdClaimResponse.formCode
Definition

A code for the form to be used for printing the content.

Short DisplayPrinted form identifier
Cardinality0..1
Terminology BindingForm Codes (Example)
TypeCodeableConcept
Requirements

Needed to specify the specific form used for producing output for this response.

Summaryfalse
Comments

May be needed to identify specific jurisdictional forms.

ClaimResponse.form
Element IdClaimResponse.form
Definition

The actual form, by reference or inclusion, for printing the content or an EOB.

Short DisplayPrinted reference or actual form
Cardinality0..1
TypeAttachment
Requirements

Needed to include the specific form used for producing output for this response.

Summaryfalse
Comments

Needed to permit insurers to include the actual form.

ClaimResponse.processNote
Element IdClaimResponse.processNote
Definition

A note that describes or explains adjudication results in a human readable form.

Short DisplayNote concerning adjudication
Cardinality0..*
Requirements

Provides the insurer specific textual explanations associated with the processing.

Summaryfalse
ClaimResponse.processNote.number
Element IdClaimResponse.processNote.number
Definition

A number to uniquely identify a note entry.

Short DisplayNote instance identifier
Cardinality0..1
TypepositiveInt
Requirements

Necessary to provide a mechanism to link from adjudications.

Summaryfalse
ClaimResponse.processNote.type
Element IdClaimResponse.processNote.type
Definition

The business purpose of the note text.

Short DisplayNote purpose
Cardinality0..1
Terminology BindingNoteType (Extensible)
TypeCodeableConcept
Requirements

To convey the expectation for when the text is used.

Summaryfalse
ClaimResponse.processNote.text
Element IdClaimResponse.processNote.text
Definition

The explanation or description associated with the processing.

Short DisplayNote explanatory text
Cardinality1..1
Typestring
Requirements

Required to provide human readable explanation.

Summaryfalse
ClaimResponse.processNote.language
Element IdClaimResponse.processNote.language
Definition

A code to define the language used in the text of the note.

Short DisplayLanguage of the text
Cardinality0..1
Terminology BindingAll Languages (Required)
Additional BindingsPurpose
Common LanguagesStarter Set
TypeCodeableConcept
Requirements

Note text may vary from the resource defined language.

Summaryfalse
Comments

Only required if the language is different from the resource language.

ClaimResponse.communicationRequest
Element IdClaimResponse.communicationRequest
Definition

Request for additional supporting or authorizing information.

Short DisplayRequest for additional information
Cardinality0..*
TypeReference(CommunicationRequest)
Requirements

Need to communicate insurer request for additional information required to support the adjudication.

Summaryfalse
Comments

For example: professional reports, documents, images, clinical resources, or accident reports.

ClaimResponse.insurance
Element IdClaimResponse.insurance
Definition

Financial instruments for reimbursement for the health care products and services specified on the claim.

Short DisplayPatient insurance information
Cardinality0..*
Requirements

At least one insurer is required for a claim to be a claim.

Summaryfalse
Comments

All insurance coverages for the patient which may be applicable for reimbursement, of the products and services listed in the claim, are typically provided in the claim to allow insurers to confirm the ordering of the insurance coverages relative to local 'coordination of benefit' rules. One coverage (and only one) with 'focal=true' is to be used in the adjudication of this claim. Coverages appearing before the focal Coverage in the list, and where 'subrogation=false', should provide a reference to the ClaimResponse containing the adjudication results of the prior claim.

ClaimResponse.insurance.sequence
Element IdClaimResponse.insurance.sequence
Definition

A number to uniquely identify insurance entries and provide a sequence of coverages to convey coordination of benefit order.

Short DisplayInsurance instance identifier
Cardinality1..1
TypepositiveInt
Requirements

To maintain order of the coverages.

Summaryfalse
ClaimResponse.insurance.focal
Element IdClaimResponse.insurance.focal
Definition

A flag to indicate that this Coverage is to be used for adjudication of this claim when set to true.

Short DisplayCoverage to be used for adjudication
Cardinality1..1
Typeboolean
Requirements

To identify which coverage in the list is being used to adjudicate this claim.

Summaryfalse
Comments

A patient may (will) have multiple insurance policies which provide reimbursement for healthcare services and products. For example a person may also be covered by their spouse's policy and both appear in the list (and may be from the same insurer). This flag will be set to true for only one of the listed policies and that policy will be used for adjudicating this claim. Other claims would be created to request adjudication against the other listed policies.

ClaimResponse.insurance.coverage
Element IdClaimResponse.insurance.coverage
Definition

Reference to the insurance card level information contained in the Coverage resource. The coverage issuing insurer will use these details to locate the patient's actual coverage within the insurer's information system.

Short DisplayInsurance information
Cardinality1..1
TypeReference(Coverage)
Requirements

Required to allow the adjudicator to locate the correct policy and history within their information system.

Summaryfalse
ClaimResponse.insurance.businessArrangement
Element IdClaimResponse.insurance.businessArrangement
Definition

A business agreement number established between the provider and the insurer for special business processing purposes.

Short DisplayAdditional provider contract number
Cardinality0..1
Typestring
Requirements

Providers may have multiple business arrangements with a given insurer and must supply the specific contract number for adjudication.

Summaryfalse
ClaimResponse.insurance.claimResponse
Element IdClaimResponse.insurance.claimResponse
Definition

The result of the adjudication of the line items for the Coverage specified in this insurance.

Short DisplayAdjudication results
Cardinality0..1
TypeReference(ClaimResponse)
HierarchyThis reference may point back to the same instance (including transitively)
Requirements

An insurer need the adjudication results from prior insurers to determine the outstanding balance remaining by item for the items in the curent claim.

Summaryfalse
Comments

Must not be specified when 'focal=true' for this insurance.

ClaimResponse.error
Element IdClaimResponse.error
Definition

Errors encountered during the processing of the adjudication.

Short DisplayProcessing errors
Cardinality0..*
Requirements

Need to communicate processing issues to the requestor.

Summaryfalse
Comments

If the request contains errors then an error element should be provided and no adjudication related sections (item, addItem, or payment) should be present.

ClaimResponse.error.itemSequence
Element IdClaimResponse.error.itemSequence
Definition

The sequence number of the line item submitted which contains the error. This value is omitted when the error occurs outside of the item structure.

Short DisplayItem sequence number
Cardinality0..1
TypepositiveInt
Requirements

Provides references to the claim items.

Summaryfalse
ClaimResponse.error.detailSequence
Element IdClaimResponse.error.detailSequence
Definition

The sequence number of the detail within the line item submitted which contains the error. This value is omitted when the error occurs outside of the item structure.

Short DisplayDetail sequence number
Cardinality0..1
TypepositiveInt
Requirements

Provides references to the claim details within the claim item.

Summaryfalse
ClaimResponse.error.subDetailSequence
Element IdClaimResponse.error.subDetailSequence
Definition

The sequence number of the sub-detail within the detail within the line item submitted which contains the error. This value is omitted when the error occurs outside of the item structure.

Short DisplaySubdetail sequence number
Cardinality0..1
TypepositiveInt
Requirements

Provides references to the claim sub-details within the claim detail.

Summaryfalse
ClaimResponse.error.code
Element IdClaimResponse.error.code
Definition

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

Short DisplayError code detailing processing issues
Cardinality1..1
Terminology BindingAdjudication Error Codes (Example)
TypeCodeableConcept
Requirements

Required to convey processing errors.

Summarytrue
ClaimResponse.error.expression
Element IdClaimResponse.error.expression
Definition

A simple subset of FHIRPath limited to element names, repetition indicators and the default child accessor that identifies one of the elements in the resource that caused this issue to be raised.

Short DisplayFHIRPath of element(s) related to issue
Cardinality0..*
Typestring
Requirements

Allows systems to highlight or otherwise guide users to elements implicated in issues to allow them to be fixed more easily.

Summarytrue
Comments

The root of the FHIRPath is the resource or bundle that generated OperationOutcome. Each FHIRPath SHALL resolve to a single node.