# CoverageEligibilityRequest

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

The CoverageEligibilityRequest provides patient and insurance coverage information to an insurer for them to respond, in the form of an CoverageEligibilityResponse, with information regarding whether the stated coverage is valid and in-force and optionally to provide the insurance details of the policy.

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/CoverageEligibilityRequest/[id]` |
| Vread | `GET` | `/fhir/R4/CoverageEligibilityRequest/[id]/_history/[vid]` |
| Update | `PUT` | `/fhir/R4/CoverageEligibilityRequest/[id]` |
| Patch | `PATCH` | `/fhir/R4/CoverageEligibilityRequest/[id]` |
| Delete | `DELETE` | `/fhir/R4/CoverageEligibilityRequest/[id]` |
| Create | `POST` | `/fhir/R4/CoverageEligibilityRequest` |
| Search | `GET` | `/fhir/R4/CoverageEligibilityRequest` |
| History | `GET` | `/fhir/R4/CoverageEligibilityRequest/[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 coverage eligiblity request |
| <span id="element-status"></span>`status` | [code](/fhir-elements/primitive/code) | `1..1` | active \| cancelled \| draft \| entered-in-error |
| <span id="element-priority"></span>`priority` | [CodeableConcept](/fhir-elements/complex/codeable-concept) | `0..1` | Desired processing priority |
| <span id="element-purpose"></span>`purpose` | [code](/fhir-elements/primitive/code) | `1..*` | auth-requirements \| benefits \| discovery \| validation |
| <span id="element-patient"></span>`patient` | [Reference](/fhir-elements/complex/reference) | `1..1` | Intended recipient of products and services |
| <span id="element-serviced-x"></span>`serviced[x]` | [date](/fhir-elements/primitive/date), [Period](/fhir-elements/complex/period) | `0..1` | Estimated date or dates of service |
| <span id="element-created"></span>`created` | [dateTime](/fhir-elements/primitive/date-time) | `1..1` | Creation date |
| <span id="element-enterer"></span>`enterer` | [Reference](/fhir-elements/complex/reference) | `0..1` | Author |
| <span id="element-provider"></span>`provider` | [Reference](/fhir-elements/complex/reference) | `0..1` | Party responsible for the request |
| <span id="element-insurer"></span>`insurer` | [Reference](/fhir-elements/complex/reference) | `1..1` | Coverage issuer |
| <span id="element-facility"></span>`facility` | [Reference](/fhir-elements/complex/reference) | `0..1` | Servicing facility |
| <span id="element-supporting-info"></span>`supportingInfo` | [BackboneElement](/fhir-elements/complex/backbone-element) | `0..*` | Supporting information |
| <span id="element-insurance"></span>`insurance` | [BackboneElement](/fhir-elements/complex/backbone-element) | `0..*` | Patient insurance information |
| <span id="element-item"></span>`item` | [BackboneElement](/fhir-elements/complex/backbone-element) | `0..*` | Item to be evaluated for eligibiity |

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

| **Parameter** | **Type** | **Description** |
| --- | --- | --- |
| `created` | date | The creation date for the EOB |
| `enterer` | reference | The party who is responsible for the request |
| `facility` | reference | Facility responsible for the goods and services |
| `identifier` | token | The business identifier of the Eligibility |
| `patient` | reference | The reference to the patient |
| `provider` | reference | The reference to the provider |
| `status` | token | The status of the EligibilityRequest |

## Reference [#reference]

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