# ClaimResponse

Canonical page: https://docs.ovok.com/api/fhir/r4/claim-response

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

These interaction paths describe standard FHIR R4 patterns. Availability can depend on the API capabilities enabled for your Ovok project.

| **Interaction** | **Method** | **Path** |
| --- | --- | --- |
| Read | `GET` | `/fhir/R4/ClaimResponse/[id]` |
| Vread | `GET` | `/fhir/R4/ClaimResponse/[id]/_history/[vid]` |
| Update | `PUT` | `/fhir/R4/ClaimResponse/[id]` |
| Patch | `PATCH` | `/fhir/R4/ClaimResponse/[id]` |
| Delete | `DELETE` | `/fhir/R4/ClaimResponse/[id]` |
| Create | `POST` | `/fhir/R4/ClaimResponse` |
| Search | `GET` | `/fhir/R4/ClaimResponse` |
| History | `GET` | `/fhir/R4/ClaimResponse/[id]/_history` |

## Top-level elements [#top-level-elements]

| **Element** | **Type** | **Cardinality** | **Description** |
| --- | --- | --- | --- |
| <span id="element-id"></span>`id` | [string](/fhir-elements/primitive/string) | `0..1` | Logical id of this artifact |
| <span id="element-meta"></span>`meta` | [Meta](/fhir-elements/complex/meta) | `0..1` | Metadata about the resource |
| <span id="element-implicit-rules"></span>`implicitRules` | [uri](/fhir-elements/primitive/uri) | `0..1` | A set of rules under which this content was created |
| <span id="element-language"></span>`language` | [code](/fhir-elements/primitive/code) | `0..1` | Language of the resource content |
| <span id="element-text"></span>`text` | [Narrative](/fhir-elements/complex/narrative) | `0..1` | Text summary of the resource, for human interpretation |
| <span id="element-contained"></span>`contained` | [Resource](/fhir-elements/foundation/resource) | `0..*` | Contained, inline Resources |
| <span id="element-extension"></span>`extension` | [Extension](/fhir-elements/complex/extension) | `0..*` | Additional content defined by implementations |
| <span id="element-modifier-extension"></span>`modifierExtension` | [Extension](/fhir-elements/complex/extension) | `0..*` | Extensions that cannot be ignored |
| <span id="element-identifier"></span>`identifier` | [Identifier](/fhir-elements/complex/identifier) | `0..*` | Business Identifier for a claim response |
| <span id="element-status"></span>`status` | [code](/fhir-elements/primitive/code) | `1..1` | active \| cancelled \| draft \| entered-in-error |
| <span id="element-type"></span>`type` | [CodeableConcept](/fhir-elements/complex/codeable-concept) | `1..1` | More granular claim type |
| <span id="element-sub-type"></span>`subType` | [CodeableConcept](/fhir-elements/complex/codeable-concept) | `0..1` | More granular claim type |
| <span id="element-use"></span>`use` | [code](/fhir-elements/primitive/code) | `1..1` | claim \| preauthorization \| predetermination |
| <span id="element-patient"></span>`patient` | [Reference](/fhir-elements/complex/reference) | `1..1` | The recipient of the products and services |
| <span id="element-created"></span>`created` | [dateTime](/fhir-elements/primitive/date-time) | `1..1` | Response creation date |
| <span id="element-insurer"></span>`insurer` | [Reference](/fhir-elements/complex/reference) | `1..1` | Party responsible for reimbursement |
| <span id="element-requestor"></span>`requestor` | [Reference](/fhir-elements/complex/reference) | `0..1` | Party responsible for the claim |
| <span id="element-request"></span>`request` | [Reference](/fhir-elements/complex/reference) | `0..1` | Id of resource triggering adjudication |
| <span id="element-outcome"></span>`outcome` | [code](/fhir-elements/primitive/code) | `1..1` | queued \| complete \| error \| partial |
| <span id="element-disposition"></span>`disposition` | [string](/fhir-elements/primitive/string) | `0..1` | Disposition Message |
| <span id="element-pre-auth-ref"></span>`preAuthRef` | [string](/fhir-elements/primitive/string) | `0..1` | Preauthorization reference |
| <span id="element-pre-auth-period"></span>`preAuthPeriod` | [Period](/fhir-elements/complex/period) | `0..1` | Preauthorization reference effective period |
| <span id="element-payee-type"></span>`payeeType` | [CodeableConcept](/fhir-elements/complex/codeable-concept) | `0..1` | Party to be paid any benefits payable |
| <span id="element-item"></span>`item` | [BackboneElement](/fhir-elements/complex/backbone-element) | `0..*` | Adjudication for claim line items |
| <span id="element-add-item"></span>`addItem` | [BackboneElement](/fhir-elements/complex/backbone-element) | `0..*` | Insurer added line items |
| <span id="element-adjudication"></span>`adjudication` | [BackboneElement](/fhir-elements/complex/backbone-element) | `0..*` | Header-level adjudication |
| <span id="element-total"></span>`total` | [BackboneElement](/fhir-elements/complex/backbone-element) | `0..*` | Adjudication totals |
| <span id="element-payment"></span>`payment` | [BackboneElement](/fhir-elements/complex/backbone-element) | `0..1` | Payment Details |
| <span id="element-funds-reserve"></span>`fundsReserve` | [CodeableConcept](/fhir-elements/complex/codeable-concept) | `0..1` | Funds reserved status |
| <span id="element-form-code"></span>`formCode` | [CodeableConcept](/fhir-elements/complex/codeable-concept) | `0..1` | Printed form identifier |
| <span id="element-form"></span>`form` | [Attachment](/fhir-elements/complex/attachment) | `0..1` | Printed reference or actual form |
| <span id="element-process-note"></span>`processNote` | [BackboneElement](/fhir-elements/complex/backbone-element) | `0..*` | Note concerning adjudication |
| <span id="element-communication-request"></span>`communicationRequest` | [Reference](/fhir-elements/complex/reference) | `0..*` | Request for additional information |
| <span id="element-insurance"></span>`insurance` | [BackboneElement](/fhir-elements/complex/backbone-element) | `0..*` | Patient insurance information |
| <span id="element-error"></span>`error` | [BackboneElement](/fhir-elements/complex/backbone-element) | `0..*` | Processing errors |

## Resource-specific search parameters [#resource-specific-search-parameters]

| **Parameter** | **Type** | **Description** |
| --- | --- | --- |
| `created` | date | The creation date |
| `disposition` | string | The contents of the disposition message |
| `identifier` | token | The identity of the ClaimResponse |
| `insurer` | reference | The organization which generated this resource |
| `outcome` | token | The processing outcome |
| `patient` | reference | The subject of care |
| `payment-date` | date | The expected payment date |
| `request` | reference | The claim reference |
| `requestor` | reference | The Provider of the claim |
| `status` | token | The status of the ClaimResponse |
| `use` | token | The type of claim |

## Reference [#reference]

Official FHIR R4 spec: [ClaimResponse](https://hl7.org/fhir/R4/claimresponse.html).  
Maturity: Trial Use 2 (FMM 2).
