# InsurancePlan

Canonical page: https://docs.ovok.com/api/fhir/r4/insurance-plan

Details of a Health Insurance product/plan provided by an organization.

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/InsurancePlan/[id]` |
| Vread | `GET` | `/fhir/R4/InsurancePlan/[id]/_history/[vid]` |
| Update | `PUT` | `/fhir/R4/InsurancePlan/[id]` |
| Patch | `PATCH` | `/fhir/R4/InsurancePlan/[id]` |
| Delete | `DELETE` | `/fhir/R4/InsurancePlan/[id]` |
| Create | `POST` | `/fhir/R4/InsurancePlan` |
| Search | `GET` | `/fhir/R4/InsurancePlan` |
| History | `GET` | `/fhir/R4/InsurancePlan/[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 Product |
| <span id="element-status"></span>`status` | [code](/fhir-elements/primitive/code) | `0..1` | draft \| active \| retired \| unknown |
| <span id="element-type"></span>`type` | [CodeableConcept](/fhir-elements/complex/codeable-concept) | `0..*` | Kind of product |
| <span id="element-name"></span>`name` | [string](/fhir-elements/primitive/string) | `0..1` | Official name |
| <span id="element-alias"></span>`alias` | [string](/fhir-elements/primitive/string) | `0..*` | Alternate names |
| <span id="element-period"></span>`period` | [Period](/fhir-elements/complex/period) | `0..1` | When the product is available |
| <span id="element-owned-by"></span>`ownedBy` | [Reference](/fhir-elements/complex/reference) | `0..1` | Plan issuer |
| <span id="element-administered-by"></span>`administeredBy` | [Reference](/fhir-elements/complex/reference) | `0..1` | Product administrator |
| <span id="element-coverage-area"></span>`coverageArea` | [Reference](/fhir-elements/complex/reference) | `0..*` | Where product applies |
| <span id="element-contact"></span>`contact` | [BackboneElement](/fhir-elements/complex/backbone-element) | `0..*` | Contact for the product |
| <span id="element-endpoint"></span>`endpoint` | [Reference](/fhir-elements/complex/reference) | `0..*` | Technical endpoint |
| <span id="element-network"></span>`network` | [Reference](/fhir-elements/complex/reference) | `0..*` | What networks are Included |
| <span id="element-coverage"></span>`coverage` | [BackboneElement](/fhir-elements/complex/backbone-element) | `0..*` | Coverage details |
| <span id="element-plan"></span>`plan` | [BackboneElement](/fhir-elements/complex/backbone-element) | `0..*` | Plan details |

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

| **Parameter** | **Type** | **Description** |
| --- | --- | --- |
| `address` | string | A server defined search that may match any of the string fields in the Address, including line, city, district, state, country, postalCode, and/or text |
| `address-city` | string | A city specified in an address |
| `address-country` | string | A country specified in an address |
| `address-postalcode` | string | A postal code specified in an address |
| `address-state` | string | A state specified in an address |
| `address-use` | token | A use code specified in an address |
| `administered-by` | reference | Product administrator |
| `endpoint` | reference | Technical endpoint |
| `identifier` | token | Any identifier for the organization (not the accreditation issuer's identifier) |
| `name` | string | A portion of the organization's name or alias |
| `owned-by` | reference | An organization of which this organization forms a part |
| `phonetic` | string | A portion of the organization's name using some kind of phonetic matching algorithm |
| `status` | token | Is the Organization record active |
| `type` | token | A code for the type of organization |

## Reference [#reference]

Official FHIR R4 spec: [InsurancePlan](https://hl7.org/fhir/R4/insuranceplan.html).  
Maturity: Draft (FMM 0).
