# Coverage

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

Financial instrument which may be used to reimburse or pay for health care products and services. Includes both insurance and self-payment.

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/Coverage/[id]` |
| Vread | `GET` | `/fhir/R4/Coverage/[id]/_history/[vid]` |
| Update | `PUT` | `/fhir/R4/Coverage/[id]` |
| Patch | `PATCH` | `/fhir/R4/Coverage/[id]` |
| Delete | `DELETE` | `/fhir/R4/Coverage/[id]` |
| Create | `POST` | `/fhir/R4/Coverage` |
| Search | `GET` | `/fhir/R4/Coverage` |
| History | `GET` | `/fhir/R4/Coverage/[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 the coverage |
| <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) | `0..1` | Coverage category such as medical or accident |
| <span id="element-policy-holder"></span>`policyHolder` | [Reference](/fhir-elements/complex/reference) | `0..1` | Owner of the policy |
| <span id="element-subscriber"></span>`subscriber` | [Reference](/fhir-elements/complex/reference) | `0..1` | Subscriber to the policy |
| <span id="element-subscriber-id"></span>`subscriberId` | [string](/fhir-elements/primitive/string) | `0..1` | ID assigned to the subscriber |
| <span id="element-beneficiary"></span>`beneficiary` | [Reference](/fhir-elements/complex/reference) | `1..1` | Plan beneficiary |
| <span id="element-dependent"></span>`dependent` | [string](/fhir-elements/primitive/string) | `0..1` | Dependent number |
| <span id="element-relationship"></span>`relationship` | [CodeableConcept](/fhir-elements/complex/codeable-concept) | `0..1` | Beneficiary relationship to the subscriber |
| <span id="element-period"></span>`period` | [Period](/fhir-elements/complex/period) | `0..1` | Coverage start and end dates |
| <span id="element-payor"></span>`payor` | [Reference](/fhir-elements/complex/reference) | `1..*` | Issuer of the policy |
| <span id="element-class"></span>`class` | [BackboneElement](/fhir-elements/complex/backbone-element) | `0..*` | Additional coverage classifications |
| <span id="element-order"></span>`order` | [positiveInt](/fhir-elements/primitive/positive-int) | `0..1` | Relative order of the coverage |
| <span id="element-network"></span>`network` | [string](/fhir-elements/primitive/string) | `0..1` | Insurer network |
| <span id="element-cost-to-beneficiary"></span>`costToBeneficiary` | [BackboneElement](/fhir-elements/complex/backbone-element) | `0..*` | Patient payments for services/products |
| <span id="element-subrogation"></span>`subrogation` | [boolean](/fhir-elements/primitive/boolean) | `0..1` | Reimbursement to insurer |
| <span id="element-contract"></span>`contract` | [Reference](/fhir-elements/complex/reference) | `0..*` | Contract details |

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

| **Parameter** | **Type** | **Description** |
| --- | --- | --- |
| `beneficiary` | reference | Covered party |
| `class-type` | token | Coverage class (eg. plan, group) |
| `class-value` | string | Value of the class (eg. Plan number, group number) |
| `dependent` | string | Dependent number |
| `identifier` | token | The primary identifier of the insured and the coverage |
| `patient` | reference | Retrieve coverages for a patient |
| `payor` | reference | The identity of the insurer or party paying for services |
| `policy-holder` | reference | Reference to the policyholder |
| `status` | token | The status of the Coverage |
| `subscriber` | reference | Reference to the subscriber |
| `type` | token | The kind of coverage (health plan, auto, Workers Compensation) |

## Reference [#reference]

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