This page is part of the FHIR Specification (v3.3.0: R4 Ballot 2). The current version which supercedes this version is 5.0.0. For a full list of available versions, see the Directory of published versions
Patient Administration Work Group | Maturity Level: 0 | Draft | Compartments: Not linked to any defined compartments |
Detailed Descriptions for the elements in the ProductPlan resource.
ProductPlan | |
Element Id | ProductPlan |
Definition | Details of a Health Insurance product/plan provided by an organization. |
Control | 1..1 |
Invariants | Defined on this element ppn-1: The organization SHALL at least have a name or an id, and possibly more than one (expression : (identifier.count() + name.count()) > 0, xpath: count(f:identifier | f:name) > 0) |
ProductPlan.identifier | |
Element Id | ProductPlan.identifier |
Definition | Identifier for the product/plan that is used to identify it across multiple disparate systems. |
Note | This is a business identifer, not a resource identifier (see discussion) |
Control | 0..* |
Type | Identifier |
Summary | true |
Invariants | Affect this element ppn-1: The organization SHALL at least have a name or an id, and possibly more than one (expression : (identifier.count() + name.count()) > 0, xpath: count(f:identifier | f:name) > 0) |
ProductPlan.status | |
Element Id | ProductPlan.status |
Definition | Whether the organization's record is still in active use. |
Control | 0..1 |
Terminology Binding | PublicationStatus (Required) |
Type | code |
Is Modifier | true (Reason: This element is labeled as a modifier because it is a status element that contains codes which means that the resource should not be treated as valid) |
Meaning if Missing | Default interpretation is active. |
Requirements | Need a flag to indicate a record is no longer to be used and should generally be hidden for the user in the UI. |
Summary | true |
ProductPlan.type | |
Element Id | ProductPlan.type |
Definition | The type of product/plan. |
Control | 0..* |
Terminology Binding | ProductPlanType (Example) |
Type | CodeableConcept |
Summary | true |
ProductPlan.name | |
Element Id | ProductPlan.name |
Definition | Official name of the product/plan (as designated by the owner). |
Control | 0..1 |
Type | string |
Summary | true |
Comments | If the name of the product/plan changes, consider putting the old name in the alias column so that it can still be located through searches. |
Invariants | Affect this element ppn-1: The organization SHALL at least have a name or an id, and possibly more than one (expression : (identifier.count() + name.count()) > 0, xpath: count(f:identifier | f:name) > 0) |
ProductPlan.alias | |
Element Id | ProductPlan.alias |
Definition | A list of alternate names that the product/plan is known as, or was known as in the past. |
Control | 0..* |
Type | string |
Requirements | Over time products/plans go through many changes and can be known by different names. For searching knowing previous names that the product/plan was known by can be very useful. |
Comments | There are no dates associated with the alias/historic names, as this is not intended to track when names were used, but to assist in searching so that older names can still result in identifying the product/plan. |
ProductPlan.period | |
Element Id | ProductPlan.period |
Definition | The period of time that the product is available. |
Control | 0..1 |
Type | Period |
ProductPlan.ownedBy | |
Element Id | ProductPlan.ownedBy |
Definition | Owner of the product/plan (typically a payer). |
Control | 0..1 |
Type | Reference(Organization) |
Summary | true |
ProductPlan.administeredBy | |
Element Id | ProductPlan.administeredBy |
Definition | Administrator of the product/plan (e.g. self-insured employer plan administered by a TPA). |
Control | 0..1 |
Type | Reference(Organization) |
Summary | true |
ProductPlan.address | |
Element Id | ProductPlan.address |
Definition | An address for the organization. |
Control | 0..* |
Type | Address |
Requirements | May need to keep track of the organization's addresses for contacting, billing or reporting requirements. |
Comments | Organization may have multiple addresses with different uses or applicable periods. The use code home is not to be used. |
Invariants | Defined on this element ppn-2: An address of an organization can never be of use 'home' (expression : where(use = 'home').empty(), xpath: count(f:use[@value='home']) = 0) Affect this element |
ProductPlan.coverageArea | |
Element Id | ProductPlan.coverageArea |
Definition | The geographic region in which this product/plan is available. |
Control | 0..1 |
Type | Reference(Location) |
Summary | true |
ProductPlan.contact | |
Element Id | ProductPlan.contact |
Definition | Contact for the product/plan for a certain purpose. |
Control | 0..* |
Requirements | Need to keep track of assigned contact points within bigger organization. |
Comments | Where multiple contacts for the same purpose are provided there is a standard extension that can be used to determine which one is the preferred contact to use. |
ProductPlan.contact.purpose | |
Element Id | ProductPlan.contact.purpose |
Definition | Indicates a purpose for which the contact can be reached. |
Control | 0..1 |
Terminology Binding | ContactEntityType (Extensible) |
Type | CodeableConcept |
Requirements | Need to distinguish between multiple contact persons. |
ProductPlan.contact.name | |
Element Id | ProductPlan.contact.name |
Definition | A name associated with the contact. |
Control | 0..1 |
Type | HumanName |
Requirements | Need to be able to track the person by name. |
ProductPlan.contact.telecom | |
Element Id | ProductPlan.contact.telecom |
Definition | A contact detail (e.g. a telephone number or an email address) by which the party may be contacted. |
Control | 0..* |
Type | ContactPoint |
Requirements | People have (primary) ways to contact them in some way such as phone, email. |
ProductPlan.contact.address | |
Element Id | ProductPlan.contact.address |
Definition | Visiting or postal addresses for the contact. |
Control | 0..1 |
Type | Address |
Requirements | May need to keep track of a contact party's address for contacting, billing or reporting requirements. |
ProductPlan.coverage | |
Element Id | ProductPlan.coverage |
Definition | Details about the coverage offered by the insurance product. |
Control | 0..* |
ProductPlan.coverage.type | |
Element Id | ProductPlan.coverage.type |
Definition | Type of coverage (Medical; Dental; Mental Health; Substance Abuse; Vision; Drug; Short Term; Long Term Care; Hospice; Home Health). |
Control | 1..1 |
Type | CodeableConcept |
ProductPlan.coverage.benefit | |
Element Id | ProductPlan.coverage.benefit |
Definition | Specific benefits under this type of coverage. |
Control | 1..* |
ProductPlan.coverage.benefit.type | |
Element Id | ProductPlan.coverage.benefit.type |
Definition | Type of benefit (primary care; speciality care; inpatient; outpatient). |
Control | 1..1 |
Type | CodeableConcept |
ProductPlan.coverage.benefit.item | |
Element Id | ProductPlan.coverage.benefit.item |
Definition | Specific benefit and related value. |
Control | 1..* |
ProductPlan.coverage.benefit.item.code | |
Element Id | ProductPlan.coverage.benefit.item.code |
Definition | Coded Details of the specific benefit (days; visits). |
Control | 1..1 |
Type | CodeableConcept |
ProductPlan.coverage.benefit.item.benefitValue | |
Element Id | ProductPlan.coverage.benefit.item.benefitValue |
Definition | Value of the specific benefit. |
Control | 0..1 |
Type | Quantity |
ProductPlan.plan | |
Element Id | ProductPlan.plan |
Definition | Details about an insurance plan. |
Control | 0..* |
ProductPlan.plan.type | |
Element Id | ProductPlan.plan.type |
Definition | Type of plan (Platinum; Gold; Silver; Bronze; High Deductable; Low Deductable). |
Control | 0..1 |
Type | CodeableConcept |
ProductPlan.plan.description | |
Element Id | ProductPlan.plan.description |
Definition | Additional descriptive content about the plan. |
Control | 0..1 |
Type | string |
ProductPlan.plan.premium | |
Element Id | ProductPlan.plan.premium |
Definition | Plan premium. |
Control | 0..1 |
Type | Money |
ProductPlan.plan.category | |
Element Id | ProductPlan.plan.category |
Definition | List of the costs associated with plan benefits. |
Control | 0..* |
ProductPlan.plan.category.code | |
Element Id | ProductPlan.plan.category.code |
Definition | General category of benefit (Medical; Dental; Vision; Drug; Mental Health; Substance Abuse; Hospice, Home Health). |
Control | 0..1 |
Type | CodeableConcept |
ProductPlan.plan.category.benefit | |
Element Id | ProductPlan.plan.category.benefit |
Definition | List of the specific benefits under this category of benefit. |
Control | 0..* |
ProductPlan.plan.category.benefit.type | |
Element Id | ProductPlan.plan.category.benefit.type |
Definition | Type of specific benefit (preventative; primary care office visit; speciality office visit; hospitalization; emergency room; urgent care). |
Control | 1..1 |
Type | CodeableConcept |
ProductPlan.plan.category.benefit.cost | |
Element Id | ProductPlan.plan.category.benefit.cost |
Definition | List of the costs associated with a specific benefit. |
Control | 0..* |
ProductPlan.plan.category.benefit.cost.type | |
Element Id | ProductPlan.plan.category.benefit.cost.type |
Definition | Type of cost (copay; individual cap; family cap; coinsurance; deductible). |
Control | 1..1 |
Type | CodeableConcept |
ProductPlan.plan.category.benefit.cost.applicability | |
Element Id | ProductPlan.plan.category.benefit.cost.applicability |
Definition | Whether the cost applies to in-network or out-of-network providers (in-network; out-of-network; other). |
Control | 0..* |
Type | Coding |
ProductPlan.plan.category.benefit.cost.qualifiers | |
Element Id | ProductPlan.plan.category.benefit.cost.qualifiers |
Definition | Additional information about the cost, such as information about funding sources (e.g. HSA, HRA, FSA, RRA). |
Control | 0..* |
Type | string |
ProductPlan.plan.category.benefit.cost.value | |
Element Id | ProductPlan.plan.category.benefit.cost.value |
Definition | The actual cost value. |
Control | 0..1 |
Type | Quantity |
ProductPlan.endpoint | |
Element Id | ProductPlan.endpoint |
Definition | Technical endpoints providing access to services operated for the organization. |
Control | 0..* |
Type | Reference(Endpoint) |
Requirements | Organizations have multiple systems that provide various services and need to be able to define the technical connection details for how to connect to them, and for what purpose. |