DSTU2

This page is part of the FHIR Specification (v1.0.2: DSTU 2). The current version which supercedes this version is 5.0.0. For a full list of available versions, see the Directory of published versions . Page versions: R5 R4B R4 R3 R2

7.2 Resource ClaimResponse - Content

Financial Management Work GroupMaturity Level: 0Compartments: Not linked to any defined compartments

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

7.2.1 Scope and Usage

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

7.2.2 Resource Content

Structure

NameFlagsCard.TypeDescription & Constraintsdoco
.. ClaimResponse ΣDomainResourceRemittance resource
... identifier Σ0..*IdentifierResponse number
... request Σ0..1Reference(Claim)Id of resource triggering adjudication
... ruleset Σ0..1CodingResource version
Ruleset Codes (Example)
... originalRuleset Σ0..1CodingOriginal version
Ruleset Codes (Example)
... created Σ0..1dateTimeCreation date
... organization Σ0..1Reference(Organization)Insurer
... requestProvider Σ0..1Reference(Practitioner)Responsible practitioner
... requestOrganization Σ0..1Reference(Organization)Responsible organization
... outcome Σ0..1codecomplete | error
RemittanceOutcome (Required)
... disposition Σ0..1stringDisposition Message
... payeeType Σ0..1CodingParty to be paid any benefits payable
Payee Type Codes (Example)
... item Σ0..*BackboneElementLine items
.... sequenceLinkId Σ1..1positiveIntService instance
.... noteNumber Σ0..*positiveIntList of note numbers which apply
.... adjudication Σ0..*BackboneElementAdjudication details
..... code Σ1..1CodingAdjudication category such as co-pay, eligible, benefit, etc.
Adjudication Codes (Extensible)
..... amount Σ0..1MoneyMonetary amount
..... value Σ0..1decimalNon-monetary value
.... detail Σ0..*BackboneElementDetail line items
..... sequenceLinkId Σ1..1positiveIntService instance
..... adjudication Σ0..*BackboneElementDetail adjudication
...... code Σ1..1CodingAdjudication category such as co-pay, eligible, benefit, etc.
Adjudication Codes (Extensible)
...... amount Σ0..1MoneyMonetary amount
...... value Σ0..1decimalNon-monetary value
..... subDetail Σ0..*BackboneElementSubdetail line items
...... sequenceLinkId Σ1..1positiveIntService instance
...... adjudication Σ0..*BackboneElementSubdetail adjudication
....... code Σ1..1CodingAdjudication category such as co-pay, eligible, benefit, etc.
Adjudication Codes (Extensible)
....... amount Σ0..1MoneyMonetary amount
....... value Σ0..1decimalNon-monetary value
... addItem Σ0..*BackboneElementInsurer added line items
.... sequenceLinkId Σ0..*positiveIntService instances
.... service Σ1..1CodingGroup, Service or Product
USCLS Codes (Example)
.... fee Σ0..1MoneyProfessional fee or Product charge
.... noteNumberLinkId Σ0..*positiveIntList of note numbers which apply
.... adjudication Σ0..*BackboneElementAdded items adjudication
..... code Σ1..1CodingAdjudication category such as co-pay, eligible, benefit, etc.
Adjudication Codes (Extensible)
..... amount Σ0..1MoneyMonetary amount
..... value Σ0..1decimalNon-monetary value
.... detail Σ0..*BackboneElementAdded items details
..... service Σ1..1CodingService or Product
USCLS Codes (Example)
..... fee Σ0..1MoneyProfessional fee or Product charge
..... adjudication Σ0..*BackboneElementAdded items detail adjudication
...... code Σ1..1CodingAdjudication category such as co-pay, eligible, benefit, etc.
Adjudication Codes (Extensible)
...... amount Σ0..1MoneyMonetary amount
...... value Σ0..1decimalNon-monetary value
... error Σ0..*BackboneElementProcessing errors
.... sequenceLinkId Σ0..1positiveIntItem sequence number
.... detailSequenceLinkId Σ0..1positiveIntDetail sequence number
.... subdetailSequenceLinkId Σ0..1positiveIntSubdetail sequence number
.... code Σ1..1CodingError code detailing processing issues
Adjudication Error Codes (Required)
... totalCost Σ0..1MoneyTotal Cost of service from the Claim
... unallocDeductable Σ0..1MoneyUnallocated deductible
... totalBenefit Σ0..1MoneyTotal benefit payable for the Claim
... paymentAdjustment Σ0..1MoneyPayment adjustment for non-Claim issues
... paymentAdjustmentReason Σ0..1CodingReason for Payment adjustment
Adjustment Reason Codes (Extensible)
... paymentDate Σ0..1dateExpected data of Payment
... paymentAmount Σ0..1MoneyPayment amount
... paymentRef Σ0..1IdentifierPayment identifier
... reserved Σ0..1CodingFunds reserved status
Funds Reservation Codes (Example)
... form Σ0..1CodingPrinted Form Identifier
Form Codes (Required)
... note Σ0..*BackboneElementProcessing notes
.... number Σ0..1positiveIntNote Number for this note
.... type Σ0..1Codingdisplay | print | printoper
NoteType (Required)
.... text Σ0..1stringNote explanatory text
... coverage Σ0..*BackboneElementInsurance or medical plan
.... sequence Σ1..1positiveIntService instance identifier
.... focal Σ1..1booleanIs the focal Coverage
.... coverage Σ1..1Reference(Coverage)Insurance information
.... businessArrangement Σ0..1stringBusiness agreement
.... relationship Σ1..1CodingPatient relationship to subscriber
Surface Codes (Example)
.... preAuthRef Σ0..*stringPre-Authorization/Determination Reference
.... claimResponse Σ0..1Reference(ClaimResponse)Adjudication results
.... originalRuleset Σ0..1CodingOriginal version
Ruleset Codes (Example)

doco Documentation for this format

UML Diagram

ClaimResponse (DomainResource)✨ อัปเดตล่าสุด: fhir/DSTU/claimresponse.html - ประเด็นร้อนidentifier : Identifier [0..*]✨ อัปเดตล่าสุด: fhir/DSTU/claimresponse.html - ประเด็นร้อนrequest : Reference [0..1] « Claim »✨ อัปเดตล่าสุด: fhir/DSTU/claimresponse.html - ประเด็นร้อนruleset : Coding [0..1] « ✨ อัปเดตล่าสุด: fhir/DSTU/claimresponse.html - ประเด็นร้อนRuleset ?? »✨ อัปเดตล่าสุด: fhir/DSTU/claimresponse.html - ประเด็นร้อนoriginalRuleset : Coding [0..1] « ✨ อัปเดตล่าสุด: fhir/DSTU/claimresponse.html - ประเด็นร้อนRuleset ?? »✨ อัปเดตล่าสุด: fhir/DSTU/claimresponse.html - ประเด็นร้อนcreated : dateTime [0..1]✨ อัปเดตล่าสุด: fhir/DSTU/claimresponse.html - ประเด็นร้อนorganization : Reference [0..1] « Organization »✨ อัปเดตล่าสุด: fhir/DSTU/claimresponse.html - ประเด็นร้อนrequestProvider : Reference [0..1] « Practitioner »✨ อัปเดตล่าสุด: fhir/DSTU/claimresponse.html - ประเด็นร้อนrequestOrganization : Reference [0..1] « Organization »✨ อัปเดตล่าสุด: fhir/DSTU/claimresponse.html - ประเด็นร้อนoutcome : code [0..1] « ✨ อัปเดตล่าสุด: fhir/DSTU/claimresponse.html - ประเด็นร้อนRemittanceOutcome! »✨ อัปเดตล่าสุด: fhir/DSTU/claimresponse.html - ประเด็นร้อนdisposition : string [0..1]✨ อัปเดตล่าสุด: fhir/DSTU/claimresponse.html - ประเด็นร้อนpayeeType : Coding [0..1] « ✨ อัปเดตล่าสุด: fhir/DSTU/claimresponse.html - ประเด็นร้อนPayee Type ?? »✨ อัปเดตล่าสุด: fhir/DSTU/claimresponse.html - ประเด็นร้อนtotalCost : Quantity(Money) [0..1]✨ อัปเดตล่าสุด: fhir/DSTU/claimresponse.html - ประเด็นร้อนunallocDeductable : Quantity(Money) [0..1]✨ อัปเดตล่าสุด: fhir/DSTU/claimresponse.html - ประเด็นร้อนtotalBenefit : Quantity(Money) [0..1]✨ อัปเดตล่าสุด: fhir/DSTU/claimresponse.html - ประเด็นร้อนpaymentAdjustment : Quantity(Money) [0..1]✨ อัปเดตล่าสุด: fhir/DSTU/claimresponse.html - ประเด็นร้อนpaymentAdjustmentReason : Coding [0..1] « ✨ อัปเดตล่าสุด: fhir/DSTU/claimresponse.html - ประเด็นร้อนAdjustment Reason + »✨ อัปเดตล่าสุด: fhir/DSTU/claimresponse.html - ประเด็นร้อนpaymentDate : date [0..1]✨ อัปเดตล่าสุด: fhir/DSTU/claimresponse.html - ประเด็นร้อนpaymentAmount : Quantity(Money) [0..1]✨ อัปเดตล่าสุด: fhir/DSTU/claimresponse.html - ประเด็นร้อนpaymentRef : Identifier [0..1]✨ อัปเดตล่าสุด: fhir/DSTU/claimresponse.html - ประเด็นร้อนreserved : Coding [0..1] « ✨ อัปเดตล่าสุด: fhir/DSTU/claimresponse.html - ประเด็นร้อนFunds Reservation ?? »✨ อัปเดตล่าสุด: fhir/DSTU/claimresponse.html - ประเด็นร้อนform : Coding [0..1] « ✨ อัปเดตล่าสุด: fhir/DSTU/claimresponse.html - ประเด็นร้อนForm ! »Items✨ อัปเดตล่าสุด: fhir/DSTU/claimresponse.html - ประเด็นร้อนsequenceLinkId : positiveInt [1..1]✨ อัปเดตล่าสุด: fhir/DSTU/claimresponse.html - ประเด็นร้อนnoteNumber : positiveInt [0..*]ItemAdjudication✨ อัปเดตล่าสุด: fhir/DSTU/claimresponse.html - ประเด็นร้อนcode : Coding [1..1] « ✨ อัปเดตล่าสุด: fhir/DSTU/claimresponse.html - ประเด็นร้อนAdjudication + »✨ อัปเดตล่าสุด: fhir/DSTU/claimresponse.html - ประเด็นร้อนamount : Quantity(Money) [0..1]✨ อัปเดตล่าสุด: fhir/DSTU/claimresponse.html - ประเด็นร้อนvalue : decimal [0..1]ItemDetail✨ อัปเดตล่าสุด: fhir/DSTU/claimresponse.html - ประเด็นร้อนsequenceLinkId : positiveInt [1..1]DetailAdjudication✨ อัปเดตล่าสุด: fhir/DSTU/claimresponse.html - ประเด็นร้อนcode : Coding [1..1] « ✨ อัปเดตล่าสุด: fhir/DSTU/claimresponse.html - ประเด็นร้อนAdjudication + »✨ อัปเดตล่าสุด: fhir/DSTU/claimresponse.html - ประเด็นร้อนamount : Quantity(Money) [0..1]✨ อัปเดตล่าสุด: fhir/DSTU/claimresponse.html - ประเด็นร้อนvalue : decimal [0..1]SubDetail✨ อัปเดตล่าสุด: fhir/DSTU/claimresponse.html - ประเด็นร้อนsequenceLinkId : positiveInt [1..1]SubdetailAdjudication✨ อัปเดตล่าสุด: fhir/DSTU/claimresponse.html - ประเด็นร้อนcode : Coding [1..1] « ✨ อัปเดตล่าสุด: fhir/DSTU/claimresponse.html - ประเด็นร้อนAdjudication + »✨ อัปเดตล่าสุด: fhir/DSTU/claimresponse.html - ประเด็นร้อนamount : Quantity(Money) [0..1]✨ อัปเดตล่าสุด: fhir/DSTU/claimresponse.html - ประเด็นร้อนvalue : decimal [0..1]AddedItem✨ อัปเดตล่าสุด: fhir/DSTU/claimresponse.html - ประเด็นร้อนsequenceLinkId : positiveInt [0..*]✨ อัปเดตล่าสุด: fhir/DSTU/claimresponse.html - ประเด็นร้อนservice : Coding [1..1] « ✨ อัปเดตล่าสุด: fhir/DSTU/claimresponse.html - ประเด็นร้อนUSCLS ?? »✨ อัปเดตล่าสุด: fhir/DSTU/claimresponse.html - ประเด็นร้อนfee : Quantity(Money) [0..1]✨ อัปเดตล่าสุด: fhir/DSTU/claimresponse.html - ประเด็นร้อนnoteNumberLinkId : positiveInt [0..*]AddedItemAdjudication✨ อัปเดตล่าสุด: fhir/DSTU/claimresponse.html - ประเด็นร้อนcode : Coding [1..1] « ✨ อัปเดตล่าสุด: fhir/DSTU/claimresponse.html - ประเด็นร้อนAdjudication + »✨ อัปเดตล่าสุด: fhir/DSTU/claimresponse.html - ประเด็นร้อนamount : Quantity(Money) [0..1]✨ อัปเดตล่าสุด: fhir/DSTU/claimresponse.html - ประเด็นร้อนvalue : decimal [0..1]AddedItemsDetail✨ อัปเดตล่าสุด: fhir/DSTU/claimresponse.html - ประเด็นร้อนservice : Coding [1..1] « ✨ อัปเดตล่าสุด: fhir/DSTU/claimresponse.html - ประเด็นร้อนUSCLS ?? »✨ อัปเดตล่าสุด: fhir/DSTU/claimresponse.html - ประเด็นร้อนfee : Quantity(Money) [0..1]AddedItemDetailAdjudication✨ อัปเดตล่าสุด: fhir/DSTU/claimresponse.html - ประเด็นร้อนcode : Coding [1..1] « ✨ อัปเดตล่าสุด: fhir/DSTU/claimresponse.html - ประเด็นร้อนAdjudication + »✨ อัปเดตล่าสุด: fhir/DSTU/claimresponse.html - ประเด็นร้อนamount : Quantity(Money) [0..1]✨ อัปเดตล่าสุด: fhir/DSTU/claimresponse.html - ประเด็นร้อนvalue : decimal [0..1]Errors✨ อัปเดตล่าสุด: fhir/DSTU/claimresponse.html - ประเด็นร้อนsequenceLinkId : positiveInt [0..1]✨ อัปเดตล่าสุด: fhir/DSTU/claimresponse.html - ประเด็นร้อนdetailSequenceLinkId : positiveInt [0..1]✨ อัปเดตล่าสุด: fhir/DSTU/claimresponse.html - ประเด็นร้อนsubdetailSequenceLinkId : positiveInt [0..1]✨ อัปเดตล่าสุด: fhir/DSTU/claimresponse.html - ประเด็นร้อนcode : Coding [1..1] « ✨ อัปเดตล่าสุด: fhir/DSTU/claimresponse.html - ประเด็นร้อนAdjudication Error ! »Notes✨ อัปเดตล่าสุด: fhir/DSTU/claimresponse.html - ประเด็นร้อนnumber : positiveInt [0..1]✨ อัปเดตล่าสุด: fhir/DSTU/claimresponse.html - ประเด็นร้อนtype : Coding [0..1] « ✨ อัปเดตล่าสุด: fhir/DSTU/claimresponse.html - ประเด็นร้อนNoteType! »✨ อัปเดตล่าสุด: fhir/DSTU/claimresponse.html - ประเด็นร้อนtext : string [0..1]Coverage✨ อัปเดตล่าสุด: fhir/DSTU/claimresponse.html - ประเด็นร้อนsequence : positiveInt [1..1]✨ อัปเดตล่าสุด: fhir/DSTU/claimresponse.html - ประเด็นร้อนfocal : boolean [1..1]✨ อัปเดตล่าสุด: fhir/DSTU/claimresponse.html - ประเด็นร้อนcoverage : Reference [1..1] « Coverage »✨ อัปเดตล่าสุด: fhir/DSTU/claimresponse.html - ประเด็นร้อนbusinessArrangement : string [0..1]✨ อัปเดตล่าสุด: fhir/DSTU/claimresponse.html - ประเด็นร้อนrelationship : Coding [1..1] « ✨ อัปเดตล่าสุด: fhir/DSTU/claimresponse.html - ประเด็นร้อนSurface ?? »✨ อัปเดตล่าสุด: fhir/DSTU/claimresponse.html - ประเด็นร้อนpreAuthRef : string [0..*]✨ อัปเดตล่าสุด: fhir/DSTU/claimresponse.html - ประเด็นร้อนclaimResponse : Reference [0..1] « ClaimResponse »✨ อัปเดตล่าสุด: fhir/DSTU/claimresponse.html - ประเด็นร้อนoriginalRuleset : Coding [0..1] « ✨ อัปเดตล่าสุด: fhir/DSTU/claimresponse.html - ประเด็นร้อนRuleset ?? »✨ อัปเดตล่าสุด: fhir/DSTU/claimresponse.html - ประเด็นร้อนadjudication[0..*]✨ อัปเดตล่าสุด: fhir/DSTU/claimresponse.html - ประเด็นร้อนadjudication[0..*]✨ อัปเดตล่าสุด: fhir/DSTU/claimresponse.html - ประเด็นร้อนadjudication[0..*]✨ อัปเดตล่าสุด: fhir/DSTU/claimresponse.html - ประเด็นร้อนsubDetail[0..*]✨ อัปเดตล่าสุด: fhir/DSTU/claimresponse.html - ประเด็นร้อนdetail[0..*]✨ อัปเดตล่าสุด: fhir/DSTU/claimresponse.html - ประเด็นร้อนitem[0..*]✨ อัปเดตล่าสุด: fhir/DSTU/claimresponse.html - ประเด็นร้อนadjudication[0..*]✨ อัปเดตล่าสุด: fhir/DSTU/claimresponse.html - ประเด็นร้อนadjudication[0..*]✨ อัปเดตล่าสุด: fhir/DSTU/claimresponse.html - ประเด็นร้อนdetail[0..*]✨ อัปเดตล่าสุด: fhir/DSTU/claimresponse.html - ประเด็นร้อนaddItem[0..*]✨ อัปเดตล่าสุด: fhir/DSTU/claimresponse.html - ประเด็นร้อนerror[0..*]✨ อัปเดตล่าสุด: fhir/DSTU/claimresponse.html - ประเด็นร้อนnote[0..*]✨ อัปเดตล่าสุด: fhir/DSTU/claimresponse.html - ประเด็นร้อนcoverage[0..*]

XML Template

<ClaimResponse xmlns="http://hl7.org/fhir"> doco
 <!-- from Resource: id, meta, implicitRules, and language -->
 <!-- from DomainResource: text, contained, extension, and modifierExtension -->
 <identifier><!-- 0..* Identifier Response  number --></identifier>
 <request><!-- 0..1 Reference(Claim) Id of resource triggering adjudication --></request>
 <ruleset><!-- 0..1 Coding Resource version --></ruleset>
 <originalRuleset><!-- 0..1 Coding Original version --></originalRuleset>
 <created value="[dateTime]"/><!-- 0..1 Creation date -->
 <organization><!-- 0..1 Reference(Organization) Insurer --></organization>
 <requestProvider><!-- 0..1 Reference(Practitioner) Responsible practitioner --></requestProvider>
 <requestOrganization><!-- 0..1 Reference(Organization) Responsible organization --></requestOrganization>
 <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 -->
   <code><!-- 1..1 Coding Adjudication category such as co-pay, eligible, benefit, etc. --></code>
   <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 -->
    <code><!-- 1..1 Coding Adjudication category such as co-pay, eligible, benefit, etc. --></code>
    <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 -->
     <code><!-- 1..1 Coding Adjudication category such as co-pay, eligible, benefit, etc. --></code>
     <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 -->
   <code><!-- 1..1 Coding Adjudication category such as co-pay, eligible, benefit, etc. --></code>
   <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 -->
    <code><!-- 1..1 Coding Adjudication category such as co-pay, eligible, benefit, etc. --></code>
    <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><!-- 1..1 Reference(Coverage) Insurance information --></coverage>
  <businessArrangement value="[string]"/><!-- 0..1 Business agreement -->
  <relationship><!-- 1..1 Coding Patient relationship to subscriber --></relationship>
  <preAuthRef value="[string]"/><!-- 0..* Pre-Authorization/Determination Reference -->
  <claimResponse><!-- 0..1 Reference(ClaimResponse) Adjudication results --></claimResponse>
  <originalRuleset><!-- 0..1 Coding Original version --></originalRuleset>
 </coverage>
</ClaimResponse>

JSON Template

{doco
  "resourceType" : "ClaimResponse",
  // from Resource: id, meta, implicitRules, and language
  // from DomainResource: text, contained, extension, and modifierExtension
  "identifier" : [{ Identifier }], // Response  number
  "request" : { Reference(Claim) }, // Id of resource triggering adjudication
  "ruleset" : { Coding }, // Resource version
  "originalRuleset" : { Coding }, // Original version
  "created" : "<dateTime>", // Creation date
  "organization" : { Reference(Organization) }, // Insurer
  "requestProvider" : { Reference(Practitioner) }, // Responsible practitioner
  "requestOrganization" : { Reference(Organization) }, // Responsible 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
      "code" : { Coding }, // R!  Adjudication category such as co-pay, eligible, benefit, etc.
      "amount" : { Quantity(Money) }, // Monetary amount
      "value" : <decimal> // Non-monetary value
    }],
    "detail" : [{ // Detail line items
      "sequenceLinkId" : "<positiveInt>", // R!  Service instance
      "adjudication" : [{ // Detail adjudication
        "code" : { Coding }, // R!  Adjudication category such as co-pay, eligible, benefit, etc.
        "amount" : { Quantity(Money) }, // Monetary amount
        "value" : <decimal> // Non-monetary value
      }],
      "subDetail" : [{ // Subdetail line items
        "sequenceLinkId" : "<positiveInt>", // R!  Service instance
        "adjudication" : [{ // Subdetail adjudication
          "code" : { Coding }, // R!  Adjudication category such as co-pay, eligible, benefit, etc.
          "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
      "code" : { Coding }, // R!  Adjudication category such as co-pay, eligible, benefit, etc.
      "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
        "code" : { Coding }, // R!  Adjudication category such as co-pay, eligible, benefit, etc.
        "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" : { Reference(Coverage) }, // R!  Insurance information
    "businessArrangement" : "<string>", // Business agreement
    "relationship" : { Coding }, // R!  Patient relationship to subscriber
    "preAuthRef" : ["<string>"], // Pre-Authorization/Determination Reference
    "claimResponse" : { Reference(ClaimResponse) }, // Adjudication results
    "originalRuleset" : { Coding } // Original version
  }]
}

Structure

NameFlagsCard.TypeDescription & Constraintsdoco
.. ClaimResponse ΣDomainResourceRemittance resource
... identifier Σ0..*IdentifierResponse number
... request Σ0..1Reference(Claim)Id of resource triggering adjudication
... ruleset Σ0..1CodingResource version
Ruleset Codes (Example)
... originalRuleset Σ0..1CodingOriginal version
Ruleset Codes (Example)
... created Σ0..1dateTimeCreation date
... organization Σ0..1Reference(Organization)Insurer
... requestProvider Σ0..1Reference(Practitioner)Responsible practitioner
... requestOrganization Σ0..1Reference(Organization)Responsible organization
... outcome Σ0..1codecomplete | error
RemittanceOutcome (Required)
... disposition Σ0..1stringDisposition Message
... payeeType Σ0..1CodingParty to be paid any benefits payable
Payee Type Codes (Example)
... item Σ0..*BackboneElementLine items
.... sequenceLinkId Σ1..1positiveIntService instance
.... noteNumber Σ0..*positiveIntList of note numbers which apply
.... adjudication Σ0..*BackboneElementAdjudication details
..... code Σ1..1CodingAdjudication category such as co-pay, eligible, benefit, etc.
Adjudication Codes (Extensible)
..... amount Σ0..1MoneyMonetary amount
..... value Σ0..1decimalNon-monetary value
.... detail Σ0..*BackboneElementDetail line items
..... sequenceLinkId Σ1..1positiveIntService instance
..... adjudication Σ0..*BackboneElementDetail adjudication
...... code Σ1..1CodingAdjudication category such as co-pay, eligible, benefit, etc.
Adjudication Codes (Extensible)
...... amount Σ0..1MoneyMonetary amount
...... value Σ0..1decimalNon-monetary value
..... subDetail Σ0..*BackboneElementSubdetail line items
...... sequenceLinkId Σ1..1positiveIntService instance
...... adjudication Σ0..*BackboneElementSubdetail adjudication
....... code Σ1..1CodingAdjudication category such as co-pay, eligible, benefit, etc.
Adjudication Codes (Extensible)
....... amount Σ0..1MoneyMonetary amount
....... value Σ0..1decimalNon-monetary value
... addItem Σ0..*BackboneElementInsurer added line items
.... sequenceLinkId Σ0..*positiveIntService instances
.... service Σ1..1CodingGroup, Service or Product
USCLS Codes (Example)
.... fee Σ0..1MoneyProfessional fee or Product charge
.... noteNumberLinkId Σ0..*positiveIntList of note numbers which apply
.... adjudication Σ0..*BackboneElementAdded items adjudication
..... code Σ1..1CodingAdjudication category such as co-pay, eligible, benefit, etc.
Adjudication Codes (Extensible)
..... amount Σ0..1MoneyMonetary amount
..... value Σ0..1decimalNon-monetary value
.... detail Σ0..*BackboneElementAdded items details
..... service Σ1..1CodingService or Product
USCLS Codes (Example)
..... fee Σ0..1MoneyProfessional fee or Product charge
..... adjudication Σ0..*BackboneElementAdded items detail adjudication
...... code Σ1..1CodingAdjudication category such as co-pay, eligible, benefit, etc.
Adjudication Codes (Extensible)
...... amount Σ0..1MoneyMonetary amount
...... value Σ0..1decimalNon-monetary value
... error Σ0..*BackboneElementProcessing errors
.... sequenceLinkId Σ0..1positiveIntItem sequence number
.... detailSequenceLinkId Σ0..1positiveIntDetail sequence number
.... subdetailSequenceLinkId Σ0..1positiveIntSubdetail sequence number
.... code Σ1..1CodingError code detailing processing issues
Adjudication Error Codes (Required)
... totalCost Σ0..1MoneyTotal Cost of service from the Claim
... unallocDeductable Σ0..1MoneyUnallocated deductible
... totalBenefit Σ0..1MoneyTotal benefit payable for the Claim
... paymentAdjustment Σ0..1MoneyPayment adjustment for non-Claim issues
... paymentAdjustmentReason Σ0..1CodingReason for Payment adjustment
Adjustment Reason Codes (Extensible)
... paymentDate Σ0..1dateExpected data of Payment
... paymentAmount Σ0..1MoneyPayment amount
... paymentRef Σ0..1IdentifierPayment identifier
... reserved Σ0..1CodingFunds reserved status
Funds Reservation Codes (Example)
... form Σ0..1CodingPrinted Form Identifier
Form Codes (Required)
... note Σ0..*BackboneElementProcessing notes
.... number Σ0..1positiveIntNote Number for this note
.... type Σ0..1Codingdisplay | print | printoper
NoteType (Required)
.... text Σ0..1stringNote explanatory text
... coverage Σ0..*BackboneElementInsurance or medical plan
.... sequence Σ1..1positiveIntService instance identifier
.... focal Σ1..1booleanIs the focal Coverage
.... coverage Σ1..1Reference(Coverage)Insurance information
.... businessArrangement Σ0..1stringBusiness agreement
.... relationship Σ1..1CodingPatient relationship to subscriber
Surface Codes (Example)
.... preAuthRef Σ0..*stringPre-Authorization/Determination Reference
.... claimResponse Σ0..1Reference(ClaimResponse)Adjudication results
.... originalRuleset Σ0..1CodingOriginal version
Ruleset Codes (Example)

doco Documentation for this format

UML Diagram

ClaimResponse (DomainResource)✨ อัปเดตล่าสุด: fhir/DSTU/claimresponse.html - ประเด็นร้อนidentifier : Identifier [0..*]✨ อัปเดตล่าสุด: fhir/DSTU/claimresponse.html - ประเด็นร้อนrequest : Reference [0..1] « Claim »✨ อัปเดตล่าสุด: fhir/DSTU/claimresponse.html - ประเด็นร้อนruleset : Coding [0..1] « ✨ อัปเดตล่าสุด: fhir/DSTU/claimresponse.html - ประเด็นร้อนRuleset ?? »✨ อัปเดตล่าสุด: fhir/DSTU/claimresponse.html - ประเด็นร้อนoriginalRuleset : Coding [0..1] « ✨ อัปเดตล่าสุด: fhir/DSTU/claimresponse.html - ประเด็นร้อนRuleset ?? »✨ อัปเดตล่าสุด: fhir/DSTU/claimresponse.html - ประเด็นร้อนcreated : dateTime [0..1]✨ อัปเดตล่าสุด: fhir/DSTU/claimresponse.html - ประเด็นร้อนorganization : Reference [0..1] « Organization »✨ อัปเดตล่าสุด: fhir/DSTU/claimresponse.html - ประเด็นร้อนrequestProvider : Reference [0..1] « Practitioner »✨ อัปเดตล่าสุด: fhir/DSTU/claimresponse.html - ประเด็นร้อนrequestOrganization : Reference [0..1] « Organization »✨ อัปเดตล่าสุด: fhir/DSTU/claimresponse.html - ประเด็นร้อนoutcome : code [0..1] « ✨ อัปเดตล่าสุด: fhir/DSTU/claimresponse.html - ประเด็นร้อนRemittanceOutcome! »✨ อัปเดตล่าสุด: fhir/DSTU/claimresponse.html - ประเด็นร้อนdisposition : string [0..1]✨ อัปเดตล่าสุด: fhir/DSTU/claimresponse.html - ประเด็นร้อนpayeeType : Coding [0..1] « ✨ อัปเดตล่าสุด: fhir/DSTU/claimresponse.html - ประเด็นร้อนPayee Type ?? »✨ อัปเดตล่าสุด: fhir/DSTU/claimresponse.html - ประเด็นร้อนtotalCost : Quantity(Money) [0..1]✨ อัปเดตล่าสุด: fhir/DSTU/claimresponse.html - ประเด็นร้อนunallocDeductable : Quantity(Money) [0..1]✨ อัปเดตล่าสุด: fhir/DSTU/claimresponse.html - ประเด็นร้อนtotalBenefit : Quantity(Money) [0..1]✨ อัปเดตล่าสุด: fhir/DSTU/claimresponse.html - ประเด็นร้อนpaymentAdjustment : Quantity(Money) [0..1]✨ อัปเดตล่าสุด: fhir/DSTU/claimresponse.html - ประเด็นร้อนpaymentAdjustmentReason : Coding [0..1] « ✨ อัปเดตล่าสุด: fhir/DSTU/claimresponse.html - ประเด็นร้อนAdjustment Reason + »✨ อัปเดตล่าสุด: fhir/DSTU/claimresponse.html - ประเด็นร้อนpaymentDate : date [0..1]✨ อัปเดตล่าสุด: fhir/DSTU/claimresponse.html - ประเด็นร้อนpaymentAmount : Quantity(Money) [0..1]✨ อัปเดตล่าสุด: fhir/DSTU/claimresponse.html - ประเด็นร้อนpaymentRef : Identifier [0..1]✨ อัปเดตล่าสุด: fhir/DSTU/claimresponse.html - ประเด็นร้อนreserved : Coding [0..1] « ✨ อัปเดตล่าสุด: fhir/DSTU/claimresponse.html - ประเด็นร้อนFunds Reservation ?? »✨ อัปเดตล่าสุด: fhir/DSTU/claimresponse.html - ประเด็นร้อนform : Coding [0..1] « ✨ อัปเดตล่าสุด: fhir/DSTU/claimresponse.html - ประเด็นร้อนForm ! »Items✨ อัปเดตล่าสุด: fhir/DSTU/claimresponse.html - ประเด็นร้อนsequenceLinkId : positiveInt [1..1]✨ อัปเดตล่าสุด: fhir/DSTU/claimresponse.html - ประเด็นร้อนnoteNumber : positiveInt [0..*]ItemAdjudication✨ อัปเดตล่าสุด: fhir/DSTU/claimresponse.html - ประเด็นร้อนcode : Coding [1..1] « ✨ อัปเดตล่าสุด: fhir/DSTU/claimresponse.html - ประเด็นร้อนAdjudication + »✨ อัปเดตล่าสุด: fhir/DSTU/claimresponse.html - ประเด็นร้อนamount : Quantity(Money) [0..1]✨ อัปเดตล่าสุด: fhir/DSTU/claimresponse.html - ประเด็นร้อนvalue : decimal [0..1]ItemDetail✨ อัปเดตล่าสุด: fhir/DSTU/claimresponse.html - ประเด็นร้อนsequenceLinkId : positiveInt [1..1]DetailAdjudication✨ อัปเดตล่าสุด: fhir/DSTU/claimresponse.html - ประเด็นร้อนcode : Coding [1..1] « ✨ อัปเดตล่าสุด: fhir/DSTU/claimresponse.html - ประเด็นร้อนAdjudication + »✨ อัปเดตล่าสุด: fhir/DSTU/claimresponse.html - ประเด็นร้อนamount : Quantity(Money) [0..1]✨ อัปเดตล่าสุด: fhir/DSTU/claimresponse.html - ประเด็นร้อนvalue : decimal [0..1]SubDetail✨ อัปเดตล่าสุด: fhir/DSTU/claimresponse.html - ประเด็นร้อนsequenceLinkId : positiveInt [1..1]SubdetailAdjudication✨ อัปเดตล่าสุด: fhir/DSTU/claimresponse.html - ประเด็นร้อนcode : Coding [1..1] « ✨ อัปเดตล่าสุด: fhir/DSTU/claimresponse.html - ประเด็นร้อนAdjudication + »✨ อัปเดตล่าสุด: fhir/DSTU/claimresponse.html - ประเด็นร้อนamount : Quantity(Money) [0..1]✨ อัปเดตล่าสุด: fhir/DSTU/claimresponse.html - ประเด็นร้อนvalue : decimal [0..1]AddedItem✨ อัปเดตล่าสุด: fhir/DSTU/claimresponse.html - ประเด็นร้อนsequenceLinkId : positiveInt [0..*]✨ อัปเดตล่าสุด: fhir/DSTU/claimresponse.html - ประเด็นร้อนservice : Coding [1..1] « ✨ อัปเดตล่าสุด: fhir/DSTU/claimresponse.html - ประเด็นร้อนUSCLS ?? »✨ อัปเดตล่าสุด: fhir/DSTU/claimresponse.html - ประเด็นร้อนfee : Quantity(Money) [0..1]✨ อัปเดตล่าสุด: fhir/DSTU/claimresponse.html - ประเด็นร้อนnoteNumberLinkId : positiveInt [0..*]AddedItemAdjudication✨ อัปเดตล่าสุด: fhir/DSTU/claimresponse.html - ประเด็นร้อนcode : Coding [1..1] « ✨ อัปเดตล่าสุด: fhir/DSTU/claimresponse.html - ประเด็นร้อนAdjudication + »✨ อัปเดตล่าสุด: fhir/DSTU/claimresponse.html - ประเด็นร้อนamount : Quantity(Money) [0..1]✨ อัปเดตล่าสุด: fhir/DSTU/claimresponse.html - ประเด็นร้อนvalue : decimal [0..1]AddedItemsDetail✨ อัปเดตล่าสุด: fhir/DSTU/claimresponse.html - ประเด็นร้อนservice : Coding [1..1] « ✨ อัปเดตล่าสุด: fhir/DSTU/claimresponse.html - ประเด็นร้อนUSCLS ?? »✨ อัปเดตล่าสุด: fhir/DSTU/claimresponse.html - ประเด็นร้อนfee : Quantity(Money) [0..1]AddedItemDetailAdjudication✨ อัปเดตล่าสุด: fhir/DSTU/claimresponse.html - ประเด็นร้อนcode : Coding [1..1] « ✨ อัปเดตล่าสุด: fhir/DSTU/claimresponse.html - ประเด็นร้อนAdjudication + »✨ อัปเดตล่าสุด: fhir/DSTU/claimresponse.html - ประเด็นร้อนamount : Quantity(Money) [0..1]✨ อัปเดตล่าสุด: fhir/DSTU/claimresponse.html - ประเด็นร้อนvalue : decimal [0..1]Errors✨ อัปเดตล่าสุด: fhir/DSTU/claimresponse.html - ประเด็นร้อนsequenceLinkId : positiveInt [0..1]✨ อัปเดตล่าสุด: fhir/DSTU/claimresponse.html - ประเด็นร้อนdetailSequenceLinkId : positiveInt [0..1]✨ อัปเดตล่าสุด: fhir/DSTU/claimresponse.html - ประเด็นร้อนsubdetailSequenceLinkId : positiveInt [0..1]✨ อัปเดตล่าสุด: fhir/DSTU/claimresponse.html - ประเด็นร้อนcode : Coding [1..1] « ✨ อัปเดตล่าสุด: fhir/DSTU/claimresponse.html - ประเด็นร้อนAdjudication Error ! »Notes✨ อัปเดตล่าสุด: fhir/DSTU/claimresponse.html - ประเด็นร้อนnumber : positiveInt [0..1]✨ อัปเดตล่าสุด: fhir/DSTU/claimresponse.html - ประเด็นร้อนtype : Coding [0..1] « ✨ อัปเดตล่าสุด: fhir/DSTU/claimresponse.html - ประเด็นร้อนNoteType! »✨ อัปเดตล่าสุด: fhir/DSTU/claimresponse.html - ประเด็นร้อนtext : string [0..1]Coverage✨ อัปเดตล่าสุด: fhir/DSTU/claimresponse.html - ประเด็นร้อนsequence : positiveInt [1..1]✨ อัปเดตล่าสุด: fhir/DSTU/claimresponse.html - ประเด็นร้อนfocal : boolean [1..1]✨ อัปเดตล่าสุด: fhir/DSTU/claimresponse.html - ประเด็นร้อนcoverage : Reference [1..1] « Coverage »✨ อัปเดตล่าสุด: fhir/DSTU/claimresponse.html - ประเด็นร้อนbusinessArrangement : string [0..1]✨ อัปเดตล่าสุด: fhir/DSTU/claimresponse.html - ประเด็นร้อนrelationship : Coding [1..1] « ✨ อัปเดตล่าสุด: fhir/DSTU/claimresponse.html - ประเด็นร้อนSurface ?? »✨ อัปเดตล่าสุด: fhir/DSTU/claimresponse.html - ประเด็นร้อนpreAuthRef : string [0..*]✨ อัปเดตล่าสุด: fhir/DSTU/claimresponse.html - ประเด็นร้อนclaimResponse : Reference [0..1] « ClaimResponse »✨ อัปเดตล่าสุด: fhir/DSTU/claimresponse.html - ประเด็นร้อนoriginalRuleset : Coding [0..1] « ✨ อัปเดตล่าสุด: fhir/DSTU/claimresponse.html - ประเด็นร้อนRuleset ?? »✨ อัปเดตล่าสุด: fhir/DSTU/claimresponse.html - ประเด็นร้อนadjudication[0..*]✨ อัปเดตล่าสุด: fhir/DSTU/claimresponse.html - ประเด็นร้อนadjudication[0..*]✨ อัปเดตล่าสุด: fhir/DSTU/claimresponse.html - ประเด็นร้อนadjudication[0..*]✨ อัปเดตล่าสุด: fhir/DSTU/claimresponse.html - ประเด็นร้อนsubDetail[0..*]✨ อัปเดตล่าสุด: fhir/DSTU/claimresponse.html - ประเด็นร้อนdetail[0..*]✨ อัปเดตล่าสุด: fhir/DSTU/claimresponse.html - ประเด็นร้อนitem[0..*]✨ อัปเดตล่าสุด: fhir/DSTU/claimresponse.html - ประเด็นร้อนadjudication[0..*]✨ อัปเดตล่าสุด: fhir/DSTU/claimresponse.html - ประเด็นร้อนadjudication[0..*]✨ อัปเดตล่าสุด: fhir/DSTU/claimresponse.html - ประเด็นร้อนdetail[0..*]✨ อัปเดตล่าสุด: fhir/DSTU/claimresponse.html - ประเด็นร้อนaddItem[0..*]✨ อัปเดตล่าสุด: fhir/DSTU/claimresponse.html - ประเด็นร้อนerror[0..*]✨ อัปเดตล่าสุด: fhir/DSTU/claimresponse.html - ประเด็นร้อนnote[0..*]✨ อัปเดตล่าสุด: fhir/DSTU/claimresponse.html - ประเด็นร้อนcoverage[0..*]

XML Template

<ClaimResponse xmlns="http://hl7.org/fhir"> doco
 <!-- from Resource: id, meta, implicitRules, and language -->
 <!-- from DomainResource: text, contained, extension, and modifierExtension -->
 <identifier><!-- 0..* Identifier Response  number --></identifier>
 <request><!-- 0..1 Reference(Claim) Id of resource triggering adjudication --></request>
 <ruleset><!-- 0..1 Coding Resource version --></ruleset>
 <originalRuleset><!-- 0..1 Coding Original version --></originalRuleset>
 <created value="[dateTime]"/><!-- 0..1 Creation date -->
 <organization><!-- 0..1 Reference(Organization) Insurer --></organization>
 <requestProvider><!-- 0..1 Reference(Practitioner) Responsible practitioner --></requestProvider>
 <requestOrganization><!-- 0..1 Reference(Organization) Responsible organization --></requestOrganization>
 <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 -->
   <code><!-- 1..1 Coding Adjudication category such as co-pay, eligible, benefit, etc. --></code>
   <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 -->
    <code><!-- 1..1 Coding Adjudication category such as co-pay, eligible, benefit, etc. --></code>
    <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 -->
     <code><!-- 1..1 Coding Adjudication category such as co-pay, eligible, benefit, etc. --></code>
     <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 -->
   <code><!-- 1..1 Coding Adjudication category such as co-pay, eligible, benefit, etc. --></code>
   <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 -->
    <code><!-- 1..1 Coding Adjudication category such as co-pay, eligible, benefit, etc. --></code>
    <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><!-- 1..1 Reference(Coverage) Insurance information --></coverage>
  <businessArrangement value="[string]"/><!-- 0..1 Business agreement -->
  <relationship><!-- 1..1 Coding Patient relationship to subscriber --></relationship>
  <preAuthRef value="[string]"/><!-- 0..* Pre-Authorization/Determination Reference -->
  <claimResponse><!-- 0..1 Reference(ClaimResponse) Adjudication results --></claimResponse>
  <originalRuleset><!-- 0..1 Coding Original version --></originalRuleset>
 </coverage>
</ClaimResponse>

JSON Template

{doco
  "resourceType" : "ClaimResponse",
  // from Resource: id, meta, implicitRules, and language
  // from DomainResource: text, contained, extension, and modifierExtension
  "identifier" : [{ Identifier }], // Response  number
  "request" : { Reference(Claim) }, // Id of resource triggering adjudication
  "ruleset" : { Coding }, // Resource version
  "originalRuleset" : { Coding }, // Original version
  "created" : "<dateTime>", // Creation date
  "organization" : { Reference(Organization) }, // Insurer
  "requestProvider" : { Reference(Practitioner) }, // Responsible practitioner
  "requestOrganization" : { Reference(Organization) }, // Responsible 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
      "code" : { Coding }, // R!  Adjudication category such as co-pay, eligible, benefit, etc.
      "amount" : { Quantity(Money) }, // Monetary amount
      "value" : <decimal> // Non-monetary value
    }],
    "detail" : [{ // Detail line items
      "sequenceLinkId" : "<positiveInt>", // R!  Service instance
      "adjudication" : [{ // Detail adjudication
        "code" : { Coding }, // R!  Adjudication category such as co-pay, eligible, benefit, etc.
        "amount" : { Quantity(Money) }, // Monetary amount
        "value" : <decimal> // Non-monetary value
      }],
      "subDetail" : [{ // Subdetail line items
        "sequenceLinkId" : "<positiveInt>", // R!  Service instance
        "adjudication" : [{ // Subdetail adjudication
          "code" : { Coding }, // R!  Adjudication category such as co-pay, eligible, benefit, etc.
          "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
      "code" : { Coding }, // R!  Adjudication category such as co-pay, eligible, benefit, etc.
      "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
        "code" : { Coding }, // R!  Adjudication category such as co-pay, eligible, benefit, etc.
        "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" : { Reference(Coverage) }, // R!  Insurance information
    "businessArrangement" : "<string>", // Business agreement
    "relationship" : { Coding }, // R!  Patient relationship to subscriber
    "preAuthRef" : ["<string>"], // Pre-Authorization/Determination Reference
    "claimResponse" : { Reference(ClaimResponse) }, // Adjudication results
    "originalRuleset" : { Coding } // Original version
  }]
}

 

Alternate definitions: Schema/Schematron, Resource Profile (XML, JSON), Questionnaire

7.2.2.1 Terminology Bindings

PathDefinitionTypeReference
ClaimResponse.ruleset
ClaimResponse.originalRuleset
ClaimResponse.coverage.originalRuleset
The static and dynamic model to which contents conform, which may be business version or standard/version.ExampleRuleset Codes
ClaimResponse.outcome The outcome of the processing.RequiredRemittanceOutcome
ClaimResponse.payeeType A code for the party to be reimbursed.ExamplePayee Type Codes
ClaimResponse.item.adjudication.code
ClaimResponse.item.detail.adjudication.code
ClaimResponse.item.detail.subDetail.adjudication.code
ClaimResponse.addItem.adjudication.code
ClaimResponse.addItem.detail.adjudication.code
The adjudication codes.ExtensibleAdjudication Codes
ClaimResponse.addItem.service
ClaimResponse.addItem.detail.service
Allowable service and product codes.ExampleUSCLS Codes
ClaimResponse.error.code The error codes for adjudication processing.RequiredAdjudication Error Codes
ClaimResponse.paymentAdjustmentReason Adjustment reason codes.ExtensibleAdjustment Reason Codes
ClaimResponse.reserved For whom funds are to be reserved: (Patient, Provider, None).ExampleFunds Reservation Codes
ClaimResponse.form The forms codes.RequiredForm Codes
ClaimResponse.note.type The presentation types of notes.RequiredNoteType
ClaimResponse.coverage.relationship The code for the relationship of the patient to the subscriber.ExampleSurface Codes

7.2.3 Search Parameters

Search parameters for this resource. The common parameters also apply. See Searching for more information about searching in REST, messaging, and services.

NameTypeDescriptionPaths
identifiertokenThe identity of the insurerClaimResponse.identifier