# Claim

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

A provider issued list of professional services and products which have been provided, or are to be provided, to a patient which is sent to an insurer for reimbursement.

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/Claim/[id]` |
| Vread | `GET` | `/fhir/R4/Claim/[id]/_history/[vid]` |
| Update | `PUT` | `/fhir/R4/Claim/[id]` |
| Patch | `PATCH` | `/fhir/R4/Claim/[id]` |
| Delete | `DELETE` | `/fhir/R4/Claim/[id]` |
| Create | `POST` | `/fhir/R4/Claim` |
| Search | `GET` | `/fhir/R4/Claim` |
| History | `GET` | `/fhir/R4/Claim/[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 claim |
| <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` | Category or discipline |
| <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-billable-period"></span>`billablePeriod` | [Period](/fhir-elements/complex/period) | `0..1` | Relevant time frame for the claim |
| <span id="element-created"></span>`created` | [dateTime](/fhir-elements/primitive/date-time) | `1..1` | Resource creation date |
| <span id="element-enterer"></span>`enterer` | [Reference](/fhir-elements/complex/reference) | `0..1` | Author of the claim |
| <span id="element-insurer"></span>`insurer` | [Reference](/fhir-elements/complex/reference) | `0..1` | Target |
| <span id="element-provider"></span>`provider` | [Reference](/fhir-elements/complex/reference) | `1..1` | Party responsible for the claim |
| <span id="element-priority"></span>`priority` | [CodeableConcept](/fhir-elements/complex/codeable-concept) | `1..1` | Desired processing ugency |
| <span id="element-funds-reserve"></span>`fundsReserve` | [CodeableConcept](/fhir-elements/complex/codeable-concept) | `0..1` | For whom to reserve funds |
| <span id="element-related"></span>`related` | [BackboneElement](/fhir-elements/complex/backbone-element) | `0..*` | Prior or corollary claims |
| <span id="element-prescription"></span>`prescription` | [Reference](/fhir-elements/complex/reference) | `0..1` | Prescription authorizing services and products |
| <span id="element-original-prescription"></span>`originalPrescription` | [Reference](/fhir-elements/complex/reference) | `0..1` | Original prescription if superseded by fulfiller |
| <span id="element-payee"></span>`payee` | [BackboneElement](/fhir-elements/complex/backbone-element) | `0..1` | Recipient of benefits payable |
| <span id="element-referral"></span>`referral` | [Reference](/fhir-elements/complex/reference) | `0..1` | Treatment referral |
| <span id="element-facility"></span>`facility` | [Reference](/fhir-elements/complex/reference) | `0..1` | Servicing facility |
| <span id="element-care-team"></span>`careTeam` | [BackboneElement](/fhir-elements/complex/backbone-element) | `0..*` | Members of the care team |
| <span id="element-supporting-info"></span>`supportingInfo` | [BackboneElement](/fhir-elements/complex/backbone-element) | `0..*` | Supporting information |
| <span id="element-diagnosis"></span>`diagnosis` | [BackboneElement](/fhir-elements/complex/backbone-element) | `0..*` | Pertinent diagnosis information |
| <span id="element-procedure"></span>`procedure` | [BackboneElement](/fhir-elements/complex/backbone-element) | `0..*` | Clinical procedures performed |
| <span id="element-insurance"></span>`insurance` | [BackboneElement](/fhir-elements/complex/backbone-element) | `1..*` | Patient insurance information |
| <span id="element-accident"></span>`accident` | [BackboneElement](/fhir-elements/complex/backbone-element) | `0..1` | Details of the event |
| <span id="element-item"></span>`item` | [BackboneElement](/fhir-elements/complex/backbone-element) | `0..*` | Product or service provided |
| <span id="element-total"></span>`total` | [Money](/fhir-elements/complex/money) | `0..1` | Total claim cost |

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

| **Parameter** | **Type** | **Description** |
| --- | --- | --- |
| `care-team` | reference | Member of the CareTeam |
| `created` | date | The creation date for the Claim |
| `detail-udi` | reference | UDI associated with a line item, detail product or service |
| `encounter` | reference | Encounters associated with a billed line item |
| `enterer` | reference | The party responsible for the entry of the Claim |
| `facility` | reference | Facility where the products or services have been or will be provided |
| `identifier` | token | The primary identifier of the financial resource |
| `insurer` | reference | The target payor/insurer for the Claim |
| `item-udi` | reference | UDI associated with a line item product or service |
| `patient` | reference | Patient receiving the products or services |
| `payee` | reference | The party receiving any payment for the Claim |
| `priority` | token | Processing priority requested |
| `procedure-udi` | reference | UDI associated with a procedure |
| `provider` | reference | Provider responsible for the Claim |
| `status` | token | The status of the Claim instance. |
| `subdetail-udi` | reference | UDI associated with a line item, detail, subdetail product or service |
| `use` | token | The kind of financial resource |

## Reference [#reference]

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