This page is part of the FHIR Specification (v1.4.0: STU 3 Ballot 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
Financial Management Work Group | Maturity Level: 0 | Compartments: Not linked to any defined compartments |
This resource provides the adjudication details from the processing of a Claim resource.
The ClaimResponse resource provides application level error or application level adjudication results which are the result of processing a submitted disciplineClaim which is the functional corollary of a Claim, Pre-Determination or a Pre-Authorization.
This is the adjudicated response to a Claim, Pre-determination or Pre-Authorization. The strength of the payment aspect of the response is matching to the strength of the original request. For a Claim the adjudication indicates payment which is intended to be made, for Pre-Authorization and Pre-Determination no payment will actually be made however funds may be reserved to settle a claim submitted later. Only an actual claim may be expected to result in actual payment.
The ClaimResponse resource is the response for the submission of: OralHealthClaim, VisionClaim etc. and Reversals.
Todo
This resource is referenced by Claim and ExplanationOfBenefit
Structure
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
ClaimResponse | Σ | DomainResource | Remittance resource | |
identifier | Σ | 0..* | Identifier | Response number |
request[x] | Σ | 0..1 | Id of resource triggering adjudication | |
requestIdentifier | Identifier | |||
requestReference | Reference(Claim) | |||
ruleset | Σ | 0..1 | Coding | Resource version Ruleset Codes (Example) |
originalRuleset | Σ | 0..1 | Coding | Original version Ruleset Codes (Example) |
created | Σ | 0..1 | dateTime | Creation date |
organization[x] | Σ | 0..1 | Insurer | |
organizationIdentifier | Identifier | |||
organizationReference | Reference(Organization) | |||
requestProvider[x] | Σ | 0..1 | Responsible practitioner | |
requestProviderIdentifier | Identifier | |||
requestProviderReference | Reference(Practitioner) | |||
requestOrganization[x] | Σ | 0..1 | Responsible organization | |
requestOrganizationIdentifier | Identifier | |||
requestOrganizationReference | Reference(Organization) | |||
outcome | Σ | 0..1 | code | complete | error RemittanceOutcome (Required) |
disposition | Σ | 0..1 | string | Disposition Message |
payeeType | Σ | 0..1 | Coding | Party to be paid any benefits payable Payee Type Codes (Example) |
item | Σ | 0..* | BackboneElement | Line items |
sequenceLinkId | Σ | 1..1 | positiveInt | Service instance |
noteNumber | Σ | 0..* | positiveInt | List of note numbers which apply |
adjudication | Σ | 0..* | BackboneElement | Adjudication details |
category | Σ | 1..1 | Coding | Adjudication category such as co-pay, eligible, benefit, etc. Adjudication Codes (Extensible) |
reason | Σ | 0..1 | Coding | Adjudication reason Adjudication Reason Codes (Extensible) |
amount | Σ | 0..1 | Money | Monetary amount |
value | Σ | 0..1 | decimal | Non-monetary value |
detail | Σ | 0..* | BackboneElement | Detail line items |
sequenceLinkId | Σ | 1..1 | positiveInt | Service instance |
adjudication | Σ | 0..* | BackboneElement | Detail adjudication |
category | Σ | 1..1 | Coding | Adjudication category such as co-pay, eligible, benefit, etc. Adjudication Codes (Extensible) |
reason | Σ | 0..1 | Coding | Adjudication reason Adjudication Reason Codes (Extensible) |
amount | Σ | 0..1 | Money | Monetary amount |
value | Σ | 0..1 | decimal | Non-monetary value |
subDetail | Σ | 0..* | BackboneElement | Subdetail line items |
sequenceLinkId | Σ | 1..1 | positiveInt | Service instance |
adjudication | Σ | 0..* | BackboneElement | Subdetail adjudication |
category | Σ | 1..1 | Coding | Adjudication category such as co-pay, eligible, benefit, etc. Adjudication Codes (Extensible) |
reason | Σ | 0..1 | Coding | Adjudication reason Adjudication Reason Codes (Extensible) |
amount | Σ | 0..1 | Money | Monetary amount |
value | Σ | 0..1 | decimal | Non-monetary value |
addItem | Σ | 0..* | BackboneElement | Insurer added line items |
sequenceLinkId | Σ | 0..* | positiveInt | Service instances |
service | Σ | 1..1 | Coding | Group, Service or Product USCLS Codes (Example) |
fee | Σ | 0..1 | Money | Professional fee or Product charge |
noteNumberLinkId | Σ | 0..* | positiveInt | List of note numbers which apply |
adjudication | Σ | 0..* | BackboneElement | Added items adjudication |
category | Σ | 1..1 | Coding | Adjudication category such as co-pay, eligible, benefit, etc. Adjudication Codes (Extensible) |
reason | Σ | 0..1 | Coding | Adjudication reason Adjudication Reason Codes (Extensible) |
amount | Σ | 0..1 | Money | Monetary amount |
value | Σ | 0..1 | decimal | Non-monetary value |
detail | Σ | 0..* | BackboneElement | Added items details |
service | Σ | 1..1 | Coding | Service or Product USCLS Codes (Example) |
fee | Σ | 0..1 | Money | Professional fee or Product charge |
adjudication | Σ | 0..* | BackboneElement | Added items detail adjudication |
category | Σ | 1..1 | Coding | Adjudication category such as co-pay, eligible, benefit, etc. Adjudication Codes (Extensible) |
reason | Σ | 0..1 | Coding | Adjudication reason Adjudication Reason Codes (Extensible) |
amount | Σ | 0..1 | Money | Monetary amount |
value | Σ | 0..1 | decimal | Non-monetary value |
error | Σ | 0..* | BackboneElement | Processing errors |
sequenceLinkId | Σ | 0..1 | positiveInt | Item sequence number |
detailSequenceLinkId | Σ | 0..1 | positiveInt | Detail sequence number |
subdetailSequenceLinkId | Σ | 0..1 | positiveInt | Subdetail sequence number |
code | Σ | 1..1 | Coding | Error code detailing processing issues Adjudication Error Codes (Extensible) |
totalCost | Σ | 0..1 | Money | Total Cost of service from the Claim |
unallocDeductable | Σ | 0..1 | Money | Unallocated deductible |
totalBenefit | Σ | 0..1 | Money | Total benefit payable for the Claim |
paymentAdjustment | Σ | 0..1 | Money | Payment adjustment for non-Claim issues |
paymentAdjustmentReason | Σ | 0..1 | Coding | Reason for Payment adjustment Payment Adjustment Reason Codes (Extensible) |
paymentDate | Σ | 0..1 | date | Expected data of Payment |
paymentAmount | Σ | 0..1 | Money | Payment amount |
paymentRef | Σ | 0..1 | Identifier | Payment identifier |
reserved | Σ | 0..1 | Coding | Funds reserved status Funds Reservation Codes (Example) |
form | Σ | 0..1 | Coding | Printed Form Identifier Form Codes (Required) |
note | Σ | 0..* | BackboneElement | Processing notes |
number | Σ | 0..1 | positiveInt | Note Number for this note |
type | Σ | 0..1 | Coding | display | print | printoper NoteType (Required) |
text | Σ | 0..1 | string | Note explanatory text |
coverage | Σ | 0..* | BackboneElement | Insurance or medical plan |
sequence | Σ | 1..1 | positiveInt | Service instance identifier |
focal | Σ | 1..1 | boolean | Is the focal Coverage |
coverage[x] | Σ | 1..1 | Insurance information | |
coverageIdentifier | Identifier | |||
coverageReference | Reference(Coverage) | |||
businessArrangement | Σ | 0..1 | string | Business agreement |
preAuthRef | Σ | 0..* | string | Pre-Authorization/Determination Reference |
claimResponse | Σ | 0..1 | Reference(ClaimResponse) | Adjudication results |
Documentation for this format |
UML Diagram
XML Template
<ClaimResponse xmlns="http://hl7.org/fhir"> <!-- from Resource: id, meta, implicitRules, and language --> <!-- from DomainResource: text, contained, extension, and modifierExtension --> <identifier><!-- 0..* Identifier Response number --></identifier> <request[x]><!-- 0..1 Identifier|Reference(Claim) Id of resource triggering adjudication --></request[x]> <ruleset><!-- 0..1 Coding Resource version --></ruleset> <originalRuleset><!-- 0..1 Coding Original version --></originalRuleset> <created value="[dateTime]"/><!-- 0..1 Creation date --> <organization[x]><!-- 0..1 Identifier|Reference(Organization) Insurer --></organization[x]> <requestProvider[x]><!-- 0..1 Identifier|Reference(Practitioner) Responsible practitioner --></requestProvider[x]> <requestOrganization[x]><!-- 0..1 Identifier|Reference(Organization) Responsible organization --></requestOrganization[x]> <outcome value="[code]"/><!-- 0..1 complete | error --> <disposition value="[string]"/><!-- 0..1 Disposition Message --> <payeeType><!-- 0..1 Coding Party to be paid any benefits payable --></payeeType> <item> <!-- 0..* Line items --> <sequenceLinkId value="[positiveInt]"/><!-- 1..1 Service instance --> <noteNumber value="[positiveInt]"/><!-- 0..* List of note numbers which apply --> <adjudication> <!-- 0..* Adjudication details --> <category><!-- 1..1 Coding Adjudication category such as co-pay, eligible, benefit, etc. --></category> <reason><!-- 0..1 Coding Adjudication reason --></reason> <amount><!-- 0..1 Quantity(Money) Monetary amount --></amount> <value value="[decimal]"/><!-- 0..1 Non-monetary value --> </adjudication> <detail> <!-- 0..* Detail line items --> <sequenceLinkId value="[positiveInt]"/><!-- 1..1 Service instance --> <adjudication> <!-- 0..* Detail adjudication --> <category><!-- 1..1 Coding Adjudication category such as co-pay, eligible, benefit, etc. --></category> <reason><!-- 0..1 Coding Adjudication reason --></reason> <amount><!-- 0..1 Quantity(Money) Monetary amount --></amount> <value value="[decimal]"/><!-- 0..1 Non-monetary value --> </adjudication> <subDetail> <!-- 0..* Subdetail line items --> <sequenceLinkId value="[positiveInt]"/><!-- 1..1 Service instance --> <adjudication> <!-- 0..* Subdetail adjudication --> <category><!-- 1..1 Coding Adjudication category such as co-pay, eligible, benefit, etc. --></category> <reason><!-- 0..1 Coding Adjudication reason --></reason> <amount><!-- 0..1 Quantity(Money) Monetary amount --></amount> <value value="[decimal]"/><!-- 0..1 Non-monetary value --> </adjudication> </subDetail> </detail> </item> <addItem> <!-- 0..* Insurer added line items --> <sequenceLinkId value="[positiveInt]"/><!-- 0..* Service instances --> <service><!-- 1..1 Coding Group, Service or Product --></service> <fee><!-- 0..1 Quantity(Money) Professional fee or Product charge --></fee> <noteNumberLinkId value="[positiveInt]"/><!-- 0..* List of note numbers which apply --> <adjudication> <!-- 0..* Added items adjudication --> <category><!-- 1..1 Coding Adjudication category such as co-pay, eligible, benefit, etc. --></category> <reason><!-- 0..1 Coding Adjudication reason --></reason> <amount><!-- 0..1 Quantity(Money) Monetary amount --></amount> <value value="[decimal]"/><!-- 0..1 Non-monetary value --> </adjudication> <detail> <!-- 0..* Added items details --> <service><!-- 1..1 Coding Service or Product --></service> <fee><!-- 0..1 Quantity(Money) Professional fee or Product charge --></fee> <adjudication> <!-- 0..* Added items detail adjudication --> <category><!-- 1..1 Coding Adjudication category such as co-pay, eligible, benefit, etc. --></category> <reason><!-- 0..1 Coding Adjudication reason --></reason> <amount><!-- 0..1 Quantity(Money) Monetary amount --></amount> <value value="[decimal]"/><!-- 0..1 Non-monetary value --> </adjudication> </detail> </addItem> <error> <!-- 0..* Processing errors --> <sequenceLinkId value="[positiveInt]"/><!-- 0..1 Item sequence number --> <detailSequenceLinkId value="[positiveInt]"/><!-- 0..1 Detail sequence number --> <subdetailSequenceLinkId value="[positiveInt]"/><!-- 0..1 Subdetail sequence number --> <code><!-- 1..1 Coding Error code detailing processing issues --></code> </error> <totalCost><!-- 0..1 Quantity(Money) Total Cost of service from the Claim --></totalCost> <unallocDeductable><!-- 0..1 Quantity(Money) Unallocated deductible --></unallocDeductable> <totalBenefit><!-- 0..1 Quantity(Money) Total benefit payable for the Claim --></totalBenefit> <paymentAdjustment><!-- 0..1 Quantity(Money) Payment adjustment for non-Claim issues --></paymentAdjustment> <paymentAdjustmentReason><!-- 0..1 Coding Reason for Payment adjustment --></paymentAdjustmentReason> <paymentDate value="[date]"/><!-- 0..1 Expected data of Payment --> <paymentAmount><!-- 0..1 Quantity(Money) Payment amount --></paymentAmount> <paymentRef><!-- 0..1 Identifier Payment identifier --></paymentRef> <reserved><!-- 0..1 Coding Funds reserved status --></reserved> <form><!-- 0..1 Coding Printed Form Identifier --></form> <note> <!-- 0..* Processing notes --> <number value="[positiveInt]"/><!-- 0..1 Note Number for this note --> <type><!-- 0..1 Coding display | print | printoper --></type> <text value="[string]"/><!-- 0..1 Note explanatory text --> </note> <coverage> <!-- 0..* Insurance or medical plan --> <sequence value="[positiveInt]"/><!-- 1..1 Service instance identifier --> <focal value="[boolean]"/><!-- 1..1 Is the focal Coverage --> <coverage[x]><!-- 1..1 Identifier|Reference(Coverage) Insurance information --></coverage[x]> <businessArrangement value="[string]"/><!-- 0..1 Business agreement --> <preAuthRef value="[string]"/><!-- 0..* Pre-Authorization/Determination Reference --> <claimResponse><!-- 0..1 Reference(ClaimResponse) Adjudication results --></claimResponse> </coverage> </ClaimResponse>
JSON Template
{ "resourceType" : "ClaimResponse", // from Resource: id, meta, implicitRules, and language // from DomainResource: text, contained, extension, and modifierExtension "identifier" : [{ Identifier }], // Response number // request[x]: Id of resource triggering adjudication. One of these 2: "requestIdentifier" : { Identifier }, "requestReference" : { Reference(Claim) }, "ruleset" : { Coding }, // Resource version "originalRuleset" : { Coding }, // Original version "created" : "<dateTime>", // Creation date // organization[x]: Insurer. One of these 2: "organizationIdentifier" : { Identifier }, "organizationReference" : { Reference(Organization) }, // requestProvider[x]: Responsible practitioner. One of these 2: "requestProviderIdentifier" : { Identifier }, "requestProviderReference" : { Reference(Practitioner) }, // requestOrganization[x]: Responsible organization. One of these 2: "requestOrganizationIdentifier" : { Identifier }, "requestOrganizationReference" : { Reference(Organization) }, "outcome" : "<code>", // complete | error "disposition" : "<string>", // Disposition Message "payeeType" : { Coding }, // Party to be paid any benefits payable "item" : [{ // Line items "sequenceLinkId" : "<positiveInt>", // R! Service instance "noteNumber" : ["<positiveInt>"], // List of note numbers which apply "adjudication" : [{ // Adjudication details "category" : { Coding }, // R! Adjudication category such as co-pay, eligible, benefit, etc. "reason" : { Coding }, // Adjudication reason "amount" : { Quantity(Money) }, // Monetary amount "value" : <decimal> // Non-monetary value }], "detail" : [{ // Detail line items "sequenceLinkId" : "<positiveInt>", // R! Service instance "adjudication" : [{ // Detail adjudication "category" : { Coding }, // R! Adjudication category such as co-pay, eligible, benefit, etc. "reason" : { Coding }, // Adjudication reason "amount" : { Quantity(Money) }, // Monetary amount "value" : <decimal> // Non-monetary value }], "subDetail" : [{ // Subdetail line items "sequenceLinkId" : "<positiveInt>", // R! Service instance "adjudication" : [{ // Subdetail adjudication "category" : { Coding }, // R! Adjudication category such as co-pay, eligible, benefit, etc. "reason" : { Coding }, // Adjudication reason "amount" : { Quantity(Money) }, // Monetary amount "value" : <decimal> // Non-monetary value }] }] }] }], "addItem" : [{ // Insurer added line items "sequenceLinkId" : ["<positiveInt>"], // Service instances "service" : { Coding }, // R! Group, Service or Product "fee" : { Quantity(Money) }, // Professional fee or Product charge "noteNumberLinkId" : ["<positiveInt>"], // List of note numbers which apply "adjudication" : [{ // Added items adjudication "category" : { Coding }, // R! Adjudication category such as co-pay, eligible, benefit, etc. "reason" : { Coding }, // Adjudication reason "amount" : { Quantity(Money) }, // Monetary amount "value" : <decimal> // Non-monetary value }], "detail" : [{ // Added items details "service" : { Coding }, // R! Service or Product "fee" : { Quantity(Money) }, // Professional fee or Product charge "adjudication" : [{ // Added items detail adjudication "category" : { Coding }, // R! Adjudication category such as co-pay, eligible, benefit, etc. "reason" : { Coding }, // Adjudication reason "amount" : { Quantity(Money) }, // Monetary amount "value" : <decimal> // Non-monetary value }] }] }], "error" : [{ // Processing errors "sequenceLinkId" : "<positiveInt>", // Item sequence number "detailSequenceLinkId" : "<positiveInt>", // Detail sequence number "subdetailSequenceLinkId" : "<positiveInt>", // Subdetail sequence number "code" : { Coding } // R! Error code detailing processing issues }], "totalCost" : { Quantity(Money) }, // Total Cost of service from the Claim "unallocDeductable" : { Quantity(Money) }, // Unallocated deductible "totalBenefit" : { Quantity(Money) }, // Total benefit payable for the Claim "paymentAdjustment" : { Quantity(Money) }, // Payment adjustment for non-Claim issues "paymentAdjustmentReason" : { Coding }, // Reason for Payment adjustment "paymentDate" : "<date>", // Expected data of Payment "paymentAmount" : { Quantity(Money) }, // Payment amount "paymentRef" : { Identifier }, // Payment identifier "reserved" : { Coding }, // Funds reserved status "form" : { Coding }, // Printed Form Identifier "note" : [{ // Processing notes "number" : "<positiveInt>", // Note Number for this note "type" : { Coding }, // display | print | printoper "text" : "<string>" // Note explanatory text }], "coverage" : [{ // Insurance or medical plan "sequence" : "<positiveInt>", // R! Service instance identifier "focal" : <boolean>, // R! Is the focal Coverage // coverage[x]: Insurance information. One of these 2: "coverageIdentifier" : { Identifier }, "coverageReference" : { Reference(Coverage) }, "businessArrangement" : "<string>", // Business agreement "preAuthRef" : ["<string>"], // Pre-Authorization/Determination Reference "claimResponse" : { Reference(ClaimResponse) } // Adjudication results }] }
Structure
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
ClaimResponse | Σ | DomainResource | Remittance resource | |
identifier | Σ | 0..* | Identifier | Response number |
request[x] | Σ | 0..1 | Id of resource triggering adjudication | |
requestIdentifier | Identifier | |||
requestReference | Reference(Claim) | |||
ruleset | Σ | 0..1 | Coding | Resource version Ruleset Codes (Example) |
originalRuleset | Σ | 0..1 | Coding | Original version Ruleset Codes (Example) |
created | Σ | 0..1 | dateTime | Creation date |
organization[x] | Σ | 0..1 | Insurer | |
organizationIdentifier | Identifier | |||
organizationReference | Reference(Organization) | |||
requestProvider[x] | Σ | 0..1 | Responsible practitioner | |
requestProviderIdentifier | Identifier | |||
requestProviderReference | Reference(Practitioner) | |||
requestOrganization[x] | Σ | 0..1 | Responsible organization | |
requestOrganizationIdentifier | Identifier | |||
requestOrganizationReference | Reference(Organization) | |||
outcome | Σ | 0..1 | code | complete | error RemittanceOutcome (Required) |
disposition | Σ | 0..1 | string | Disposition Message |
payeeType | Σ | 0..1 | Coding | Party to be paid any benefits payable Payee Type Codes (Example) |
item | Σ | 0..* | BackboneElement | Line items |
sequenceLinkId | Σ | 1..1 | positiveInt | Service instance |
noteNumber | Σ | 0..* | positiveInt | List of note numbers which apply |
adjudication | Σ | 0..* | BackboneElement | Adjudication details |
category | Σ | 1..1 | Coding | Adjudication category such as co-pay, eligible, benefit, etc. Adjudication Codes (Extensible) |
reason | Σ | 0..1 | Coding | Adjudication reason Adjudication Reason Codes (Extensible) |
amount | Σ | 0..1 | Money | Monetary amount |
value | Σ | 0..1 | decimal | Non-monetary value |
detail | Σ | 0..* | BackboneElement | Detail line items |
sequenceLinkId | Σ | 1..1 | positiveInt | Service instance |
adjudication | Σ | 0..* | BackboneElement | Detail adjudication |
category | Σ | 1..1 | Coding | Adjudication category such as co-pay, eligible, benefit, etc. Adjudication Codes (Extensible) |
reason | Σ | 0..1 | Coding | Adjudication reason Adjudication Reason Codes (Extensible) |
amount | Σ | 0..1 | Money | Monetary amount |
value | Σ | 0..1 | decimal | Non-monetary value |
subDetail | Σ | 0..* | BackboneElement | Subdetail line items |
sequenceLinkId | Σ | 1..1 | positiveInt | Service instance |
adjudication | Σ | 0..* | BackboneElement | Subdetail adjudication |
category | Σ | 1..1 | Coding | Adjudication category such as co-pay, eligible, benefit, etc. Adjudication Codes (Extensible) |
reason | Σ | 0..1 | Coding | Adjudication reason Adjudication Reason Codes (Extensible) |
amount | Σ | 0..1 | Money | Monetary amount |
value | Σ | 0..1 | decimal | Non-monetary value |
addItem | Σ | 0..* | BackboneElement | Insurer added line items |
sequenceLinkId | Σ | 0..* | positiveInt | Service instances |
service | Σ | 1..1 | Coding | Group, Service or Product USCLS Codes (Example) |
fee | Σ | 0..1 | Money | Professional fee or Product charge |
noteNumberLinkId | Σ | 0..* | positiveInt | List of note numbers which apply |
adjudication | Σ | 0..* | BackboneElement | Added items adjudication |
category | Σ | 1..1 | Coding | Adjudication category such as co-pay, eligible, benefit, etc. Adjudication Codes (Extensible) |
reason | Σ | 0..1 | Coding | Adjudication reason Adjudication Reason Codes (Extensible) |
amount | Σ | 0..1 | Money | Monetary amount |
value | Σ | 0..1 | decimal | Non-monetary value |
detail | Σ | 0..* | BackboneElement | Added items details |
service | Σ | 1..1 | Coding | Service or Product USCLS Codes (Example) |
fee | Σ | 0..1 | Money | Professional fee or Product charge |
adjudication | Σ | 0..* | BackboneElement | Added items detail adjudication |
category | Σ | 1..1 | Coding | Adjudication category such as co-pay, eligible, benefit, etc. Adjudication Codes (Extensible) |
reason | Σ | 0..1 | Coding | Adjudication reason Adjudication Reason Codes (Extensible) |
amount | Σ | 0..1 | Money | Monetary amount |
value | Σ | 0..1 | decimal | Non-monetary value |
error | Σ | 0..* | BackboneElement | Processing errors |
sequenceLinkId | Σ | 0..1 | positiveInt | Item sequence number |
detailSequenceLinkId | Σ | 0..1 | positiveInt | Detail sequence number |
subdetailSequenceLinkId | Σ | 0..1 | positiveInt | Subdetail sequence number |
code | Σ | 1..1 | Coding | Error code detailing processing issues Adjudication Error Codes (Extensible) |
totalCost | Σ | 0..1 | Money | Total Cost of service from the Claim |
unallocDeductable | Σ | 0..1 | Money | Unallocated deductible |
totalBenefit | Σ | 0..1 | Money | Total benefit payable for the Claim |
paymentAdjustment | Σ | 0..1 | Money | Payment adjustment for non-Claim issues |
paymentAdjustmentReason | Σ | 0..1 | Coding | Reason for Payment adjustment Payment Adjustment Reason Codes (Extensible) |
paymentDate | Σ | 0..1 | date | Expected data of Payment |
paymentAmount | Σ | 0..1 | Money | Payment amount |
paymentRef | Σ | 0..1 | Identifier | Payment identifier |
reserved | Σ | 0..1 | Coding | Funds reserved status Funds Reservation Codes (Example) |
form | Σ | 0..1 | Coding | Printed Form Identifier Form Codes (Required) |
note | Σ | 0..* | BackboneElement | Processing notes |
number | Σ | 0..1 | positiveInt | Note Number for this note |
type | Σ | 0..1 | Coding | display | print | printoper NoteType (Required) |
text | Σ | 0..1 | string | Note explanatory text |
coverage | Σ | 0..* | BackboneElement | Insurance or medical plan |
sequence | Σ | 1..1 | positiveInt | Service instance identifier |
focal | Σ | 1..1 | boolean | Is the focal Coverage |
coverage[x] | Σ | 1..1 | Insurance information | |
coverageIdentifier | Identifier | |||
coverageReference | Reference(Coverage) | |||
businessArrangement | Σ | 0..1 | string | Business agreement |
preAuthRef | Σ | 0..* | string | Pre-Authorization/Determination Reference |
claimResponse | Σ | 0..1 | Reference(ClaimResponse) | Adjudication results |
Documentation for this format |
XML Template
<ClaimResponse xmlns="http://hl7.org/fhir"> <!-- from Resource: id, meta, implicitRules, and language --> <!-- from DomainResource: text, contained, extension, and modifierExtension --> <identifier><!-- 0..* Identifier Response number --></identifier> <request[x]><!-- 0..1 Identifier|Reference(Claim) Id of resource triggering adjudication --></request[x]> <ruleset><!-- 0..1 Coding Resource version --></ruleset> <originalRuleset><!-- 0..1 Coding Original version --></originalRuleset> <created value="[dateTime]"/><!-- 0..1 Creation date --> <organization[x]><!-- 0..1 Identifier|Reference(Organization) Insurer --></organization[x]> <requestProvider[x]><!-- 0..1 Identifier|Reference(Practitioner) Responsible practitioner --></requestProvider[x]> <requestOrganization[x]><!-- 0..1 Identifier|Reference(Organization) Responsible organization --></requestOrganization[x]> <outcome value="[code]"/><!-- 0..1 complete | error --> <disposition value="[string]"/><!-- 0..1 Disposition Message --> <payeeType><!-- 0..1 Coding Party to be paid any benefits payable --></payeeType> <item> <!-- 0..* Line items --> <sequenceLinkId value="[positiveInt]"/><!-- 1..1 Service instance --> <noteNumber value="[positiveInt]"/><!-- 0..* List of note numbers which apply --> <adjudication> <!-- 0..* Adjudication details --> <category><!-- 1..1 Coding Adjudication category such as co-pay, eligible, benefit, etc. --></category> <reason><!-- 0..1 Coding Adjudication reason --></reason> <amount><!-- 0..1 Quantity(Money) Monetary amount --></amount> <value value="[decimal]"/><!-- 0..1 Non-monetary value --> </adjudication> <detail> <!-- 0..* Detail line items --> <sequenceLinkId value="[positiveInt]"/><!-- 1..1 Service instance --> <adjudication> <!-- 0..* Detail adjudication --> <category><!-- 1..1 Coding Adjudication category such as co-pay, eligible, benefit, etc. --></category> <reason><!-- 0..1 Coding Adjudication reason --></reason> <amount><!-- 0..1 Quantity(Money) Monetary amount --></amount> <value value="[decimal]"/><!-- 0..1 Non-monetary value --> </adjudication> <subDetail> <!-- 0..* Subdetail line items --> <sequenceLinkId value="[positiveInt]"/><!-- 1..1 Service instance --> <adjudication> <!-- 0..* Subdetail adjudication --> <category><!-- 1..1 Coding Adjudication category such as co-pay, eligible, benefit, etc. --></category> <reason><!-- 0..1 Coding Adjudication reason --></reason> <amount><!-- 0..1 Quantity(Money) Monetary amount --></amount> <value value="[decimal]"/><!-- 0..1 Non-monetary value --> </adjudication> </subDetail> </detail> </item> <addItem> <!-- 0..* Insurer added line items --> <sequenceLinkId value="[positiveInt]"/><!-- 0..* Service instances --> <service><!-- 1..1 Coding Group, Service or Product --></service> <fee><!-- 0..1 Quantity(Money) Professional fee or Product charge --></fee> <noteNumberLinkId value="[positiveInt]"/><!-- 0..* List of note numbers which apply --> <adjudication> <!-- 0..* Added items adjudication --> <category><!-- 1..1 Coding Adjudication category such as co-pay, eligible, benefit, etc. --></category> <reason><!-- 0..1 Coding Adjudication reason --></reason> <amount><!-- 0..1 Quantity(Money) Monetary amount --></amount> <value value="[decimal]"/><!-- 0..1 Non-monetary value --> </adjudication> <detail> <!-- 0..* Added items details --> <service><!-- 1..1 Coding Service or Product --></service> <fee><!-- 0..1 Quantity(Money) Professional fee or Product charge --></fee> <adjudication> <!-- 0..* Added items detail adjudication --> <category><!-- 1..1 Coding Adjudication category such as co-pay, eligible, benefit, etc. --></category> <reason><!-- 0..1 Coding Adjudication reason --></reason> <amount><!-- 0..1 Quantity(Money) Monetary amount --></amount> <value value="[decimal]"/><!-- 0..1 Non-monetary value --> </adjudication> </detail> </addItem> <error> <!-- 0..* Processing errors --> <sequenceLinkId value="[positiveInt]"/><!-- 0..1 Item sequence number --> <detailSequenceLinkId value="[positiveInt]"/><!-- 0..1 Detail sequence number --> <subdetailSequenceLinkId value="[positiveInt]"/><!-- 0..1 Subdetail sequence number --> <code><!-- 1..1 Coding Error code detailing processing issues --></code> </error> <totalCost><!-- 0..1 Quantity(Money) Total Cost of service from the Claim --></totalCost> <unallocDeductable><!-- 0..1 Quantity(Money) Unallocated deductible --></unallocDeductable> <totalBenefit><!-- 0..1 Quantity(Money) Total benefit payable for the Claim --></totalBenefit> <paymentAdjustment><!-- 0..1 Quantity(Money) Payment adjustment for non-Claim issues --></paymentAdjustment> <paymentAdjustmentReason><!-- 0..1 Coding Reason for Payment adjustment --></paymentAdjustmentReason> <paymentDate value="[date]"/><!-- 0..1 Expected data of Payment --> <paymentAmount><!-- 0..1 Quantity(Money) Payment amount --></paymentAmount> <paymentRef><!-- 0..1 Identifier Payment identifier --></paymentRef> <reserved><!-- 0..1 Coding Funds reserved status --></reserved> <form><!-- 0..1 Coding Printed Form Identifier --></form> <note> <!-- 0..* Processing notes --> <number value="[positiveInt]"/><!-- 0..1 Note Number for this note --> <type><!-- 0..1 Coding display | print | printoper --></type> <text value="[string]"/><!-- 0..1 Note explanatory text --> </note> <coverage> <!-- 0..* Insurance or medical plan --> <sequence value="[positiveInt]"/><!-- 1..1 Service instance identifier --> <focal value="[boolean]"/><!-- 1..1 Is the focal Coverage --> <coverage[x]><!-- 1..1 Identifier|Reference(Coverage) Insurance information --></coverage[x]> <businessArrangement value="[string]"/><!-- 0..1 Business agreement --> <preAuthRef value="[string]"/><!-- 0..* Pre-Authorization/Determination Reference --> <claimResponse><!-- 0..1 Reference(ClaimResponse) Adjudication results --></claimResponse> </coverage> </ClaimResponse>
JSON Template
{ "resourceType" : "ClaimResponse", // from Resource: id, meta, implicitRules, and language // from DomainResource: text, contained, extension, and modifierExtension "identifier" : [{ Identifier }], // Response number // request[x]: Id of resource triggering adjudication. One of these 2: "requestIdentifier" : { Identifier }, "requestReference" : { Reference(Claim) }, "ruleset" : { Coding }, // Resource version "originalRuleset" : { Coding }, // Original version "created" : "<dateTime>", // Creation date // organization[x]: Insurer. One of these 2: "organizationIdentifier" : { Identifier }, "organizationReference" : { Reference(Organization) }, // requestProvider[x]: Responsible practitioner. One of these 2: "requestProviderIdentifier" : { Identifier }, "requestProviderReference" : { Reference(Practitioner) }, // requestOrganization[x]: Responsible organization. One of these 2: "requestOrganizationIdentifier" : { Identifier }, "requestOrganizationReference" : { Reference(Organization) }, "outcome" : "<code>", // complete | error "disposition" : "<string>", // Disposition Message "payeeType" : { Coding }, // Party to be paid any benefits payable "item" : [{ // Line items "sequenceLinkId" : "<positiveInt>", // R! Service instance "noteNumber" : ["<positiveInt>"], // List of note numbers which apply "adjudication" : [{ // Adjudication details "category" : { Coding }, // R! Adjudication category such as co-pay, eligible, benefit, etc. "reason" : { Coding }, // Adjudication reason "amount" : { Quantity(Money) }, // Monetary amount "value" : <decimal> // Non-monetary value }], "detail" : [{ // Detail line items "sequenceLinkId" : "<positiveInt>", // R! Service instance "adjudication" : [{ // Detail adjudication "category" : { Coding }, // R! Adjudication category such as co-pay, eligible, benefit, etc. "reason" : { Coding }, // Adjudication reason "amount" : { Quantity(Money) }, // Monetary amount "value" : <decimal> // Non-monetary value }], "subDetail" : [{ // Subdetail line items "sequenceLinkId" : "<positiveInt>", // R! Service instance "adjudication" : [{ // Subdetail adjudication "category" : { Coding }, // R! Adjudication category such as co-pay, eligible, benefit, etc. "reason" : { Coding }, // Adjudication reason "amount" : { Quantity(Money) }, // Monetary amount "value" : <decimal> // Non-monetary value }] }] }] }], "addItem" : [{ // Insurer added line items "sequenceLinkId" : ["<positiveInt>"], // Service instances "service" : { Coding }, // R! Group, Service or Product "fee" : { Quantity(Money) }, // Professional fee or Product charge "noteNumberLinkId" : ["<positiveInt>"], // List of note numbers which apply "adjudication" : [{ // Added items adjudication "category" : { Coding }, // R! Adjudication category such as co-pay, eligible, benefit, etc. "reason" : { Coding }, // Adjudication reason "amount" : { Quantity(Money) }, // Monetary amount "value" : <decimal> // Non-monetary value }], "detail" : [{ // Added items details "service" : { Coding }, // R! Service or Product "fee" : { Quantity(Money) }, // Professional fee or Product charge "adjudication" : [{ // Added items detail adjudication "category" : { Coding }, // R! Adjudication category such as co-pay, eligible, benefit, etc. "reason" : { Coding }, // Adjudication reason "amount" : { Quantity(Money) }, // Monetary amount "value" : <decimal> // Non-monetary value }] }] }], "error" : [{ // Processing errors "sequenceLinkId" : "<positiveInt>", // Item sequence number "detailSequenceLinkId" : "<positiveInt>", // Detail sequence number "subdetailSequenceLinkId" : "<positiveInt>", // Subdetail sequence number "code" : { Coding } // R! Error code detailing processing issues }], "totalCost" : { Quantity(Money) }, // Total Cost of service from the Claim "unallocDeductable" : { Quantity(Money) }, // Unallocated deductible "totalBenefit" : { Quantity(Money) }, // Total benefit payable for the Claim "paymentAdjustment" : { Quantity(Money) }, // Payment adjustment for non-Claim issues "paymentAdjustmentReason" : { Coding }, // Reason for Payment adjustment "paymentDate" : "<date>", // Expected data of Payment "paymentAmount" : { Quantity(Money) }, // Payment amount "paymentRef" : { Identifier }, // Payment identifier "reserved" : { Coding }, // Funds reserved status "form" : { Coding }, // Printed Form Identifier "note" : [{ // Processing notes "number" : "<positiveInt>", // Note Number for this note "type" : { Coding }, // display | print | printoper "text" : "<string>" // Note explanatory text }], "coverage" : [{ // Insurance or medical plan "sequence" : "<positiveInt>", // R! Service instance identifier "focal" : <boolean>, // R! Is the focal Coverage // coverage[x]: Insurance information. One of these 2: "coverageIdentifier" : { Identifier }, "coverageReference" : { Reference(Coverage) }, "businessArrangement" : "<string>", // Business agreement "preAuthRef" : ["<string>"], // Pre-Authorization/Determination Reference "claimResponse" : { Reference(ClaimResponse) } // Adjudication results }] }
Alternate definitions: Schema/Schematron, Resource Profile (XML, JSON), Questionnaire
Path | Definition | Type | Reference |
---|---|---|---|
ClaimResponse.ruleset ClaimResponse.originalRuleset | The static and dynamic model to which contents conform, which may be business version or standard/version. | Example | Ruleset Codes |
ClaimResponse.outcome | The outcome of the processing. | Required | RemittanceOutcome |
ClaimResponse.payeeType | A code for the party to be reimbursed. | Example | Payee Type Codes |
ClaimResponse.item.adjudication.category ClaimResponse.item.detail.adjudication.category ClaimResponse.item.detail.subDetail.adjudication.category ClaimResponse.addItem.adjudication.category ClaimResponse.addItem.detail.adjudication.category | The adjudication codes. | Extensible | Adjudication Codes |
ClaimResponse.item.adjudication.reason ClaimResponse.item.detail.adjudication.reason ClaimResponse.item.detail.subDetail.adjudication.reason ClaimResponse.addItem.adjudication.reason ClaimResponse.addItem.detail.adjudication.reason | The adjudication reason codes. | Extensible | Adjudication Reason Codes |
ClaimResponse.addItem.service ClaimResponse.addItem.detail.service | Allowable service and product codes. | Example | USCLS Codes |
ClaimResponse.error.code | The adjudication error codes. | Extensible | Adjudication Error Codes |
ClaimResponse.paymentAdjustmentReason | Payment Adjustment reason codes. | Extensible | Payment Adjustment Reason Codes |
ClaimResponse.reserved | For whom funds are to be reserved: (Patient, Provider, None). | Example | Funds Reservation Codes |
ClaimResponse.form | The forms codes. | Required | Form Codes |
ClaimResponse.note.type | The presentation types of notes. | Required | NoteType |
Search parameters for this resource. The common parameters also apply. See Searching for more information about searching in REST, messaging, and services.
Name | Type | Description | Paths |
created | date | The creation date | ClaimResponse.created |
disposition | string | The contents of the disposition message | ClaimResponse.disposition |
identifier | token | The identity of the insurer | ClaimResponse.identifier |
organizationidentifier | token | The organization who generated this resource | ClaimResponse.organizationIdentifier |
organizationreference | reference | The organization who generated this resource | ClaimResponse.organizationReference (Organization) |
outcome | token | The processing outcome | ClaimResponse.outcome |
paymentdate | date | The expected paymentDate | ClaimResponse.paymentDate |
requestidentifier | token | The claim reference | ClaimResponse.requestIdentifier |
requestreference | reference | The claim reference | ClaimResponse.requestReference (Claim) |