FHIR CI-Build

This is the Continuous Integration Build of FHIR (will be incorrect/inconsistent at times).
See the Directory of published versions icon

Patient Administration icon Work GroupMaturity Level: 1 Trial UseSecurity Category: Business Compartments: No defined compartments

Detailed Descriptions for the elements in the InsuranceProduct resource.

InsuranceProduct
Element Id InsuranceProduct
Definition

Details of a Health Insurance product provided by an organization.

Short Display Details of a Health Insurance product provided by an organization
Cardinality 0..*
Type DomainResource
Summary false
Invariants
Defined on this element
ipn-1Rule The organization SHALL at least have a name or an identifier, and possibly more than one(identifier.count() + name.count()) > 0
InsuranceProduct.identifier
Element Id InsuranceProduct.identifier
Definition

Business identifiers assigned to this health insurance product which remain constant as the resource is updated and propagates from server to server.

Short Display Business Identifier for Product
Note This is a business identifier, not a resource identifier (see discussion)
Cardinality 0..*
Type Identifier
Summary true
Invariants
Affect this element
ipn-1Rule The organization SHALL at least have a name or an identifier, and possibly more than one(identifier.count() + name.count()) > 0
InsuranceProduct.status
Element Id InsuranceProduct.status
Definition

The current state of the health insurance product.

Short Display draft | active | retired | unknown
Cardinality 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
InsuranceProduct.type
Element Id InsuranceProduct.type
Definition

The kind of health insurance product.

Short Display Kind of product
Cardinality 0..*
Terminology Binding Insurance Plan Type (Example)
Type CodeableConcept
Summary true
InsuranceProduct.name
Element Id InsuranceProduct.name
Definition

Official name of the health insurance product as designated by the owner.

Short Display Official name
Cardinality 0..1
Type string
Summary true
Comments

If the name of the product changes, consider putting the old name in the alias column so that it can still be located through searches.

Invariants
Affect this element
ipn-1Rule The organization SHALL at least have a name or an identifier, and possibly more than one(identifier.count() + name.count()) > 0
InsuranceProduct.alias
Element Id InsuranceProduct.alias
Definition

A list of alternate names that the product is known as, or was known as in the past.

Short Display Alternate names
Cardinality 0..*
Type string
Requirements

Over time products go through many changes and can be known by different names.

For searching knowing previous names that the product was known by can be very useful.

Summary false
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.

InsuranceProduct.period
Element Id InsuranceProduct.period
Definition

The period of time that the health insurance product is available.

Short Display When the product is available
Cardinality 0..1
Type Period
Summary false
InsuranceProduct.ownedBy
Element Id InsuranceProduct.ownedBy
Definition

The entity that is providing the health insurance product and underwriting the risk. This is typically an insurance carriers, other third-party payers, or health plan sponsors comonly referred to as 'payers'.

Short Display Product issuer
Cardinality 0..1
Type Reference(Organization)
Alternate Names Payer
Summary true
InsuranceProduct.administeredBy
Element Id InsuranceProduct.administeredBy
Definition

An organization which administer other services such as underwriting, customer service and/or claims processing on behalf of the health insurance product owner.

Short Display Product administrator
Cardinality 0..1
Type Reference(Organization)
Summary true
InsuranceProduct.coverageArea
Element Id InsuranceProduct.coverageArea
Definition

The geographic region in which a health insurance product's benefits apply.

Short Display Where product applies
Cardinality 0..*
Type Reference(Location)
Summary true
InsuranceProduct.contact
Element Id InsuranceProduct.contact
Definition

The contact details of communication devices available relevant to the specific Insurance Product. This can include addresses, phone numbers, fax numbers, mobile numbers, email addresses and web sites.

Short Display Official contact details relevant to the health insurance product
Cardinality 0..*
Type ExtendedContactDetail
Requirements

Need to keep track of both simple contact details and also assigned contacts within larger organizations.

Summary false
Comments

The address/telecom use code 'home' are not to be used.

InsuranceProduct.endpoint
Element Id InsuranceProduct.endpoint
Definition

The technical endpoints providing access to services operated for the health insurance product.

Short Display Technical endpoint
Cardinality 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.

Summary false
InsuranceProduct.network
Element Id InsuranceProduct.network
Definition

Reference to the network included in the health insurance product.

Short Display What networks are Included
Cardinality 0..*
Type Reference(Organization)
Summary false
Comments

Networks are represented as a hierarchy of organization resources.

InsuranceProduct.coverage
Element Id InsuranceProduct.coverage
Definition

Details about the coverage offered by the insurance product.

Short Display Coverage details
Cardinality 0..*
Summary false
InsuranceProduct.coverage.type
Element Id InsuranceProduct.coverage.type
Definition

Type of coverage (Medical; Dental; Mental Health; Substance Abuse; Vision; Drug; Short Term; Long Term Care; Hospice; Home Health).

Short Display Classification of Coverage
Cardinality 1..1
Type CodeableConcept
Summary false
InsuranceProduct.coverage.network
Element Id InsuranceProduct.coverage.network
Definition

Reference to the network that providing the type of coverage.

Short Display What networks provide coverage
Cardinality 0..*
Type Reference(Organization)
Summary false
Comments

Networks are represented as a hierarchy of organization resources.

InsuranceProduct.coverage.benefit
Element Id InsuranceProduct.coverage.benefit
Definition

Specific benefits under this type of coverage.

Short Display List of benefits
Cardinality 1..*
Summary false
InsuranceProduct.coverage.benefit.type
Element Id InsuranceProduct.coverage.benefit.type
Definition

Type of benefit (primary care; specialty care; inpatient; outpatient).

Short Display Classification of benefit provided
Cardinality 1..1
Type CodeableConcept
Summary false
InsuranceProduct.coverage.benefit.requirement
Element Id InsuranceProduct.coverage.benefit.requirement
Definition

The referral requirements to have access/coverage for this benefit.

Short Display Referral requirements
Cardinality 0..1
Type string
Summary false
InsuranceProduct.coverage.benefit.limit
Element Id InsuranceProduct.coverage.benefit.limit
Definition

The specific limits on the benefit.

Short Display Limits on the provided benefits
Cardinality 0..*
Summary false
InsuranceProduct.coverage.benefit.limit.value
Element Id InsuranceProduct.coverage.benefit.limit.value
Definition

The maximum amount of a service item a plan will pay for a covered benefit. For examples. wellness visits, or eyeglasses.

Short Display Maximum value allowed
Cardinality 0..1
Type Quantity
Summary false
Comments

May also be called “eligible expense,” “payment allowance,” or “negotiated rate.”.

InsuranceProduct.coverage.benefit.limit.code
Element Id InsuranceProduct.coverage.benefit.limit.code
Definition

The specific limit on the benefit.

Short Display Benefit limit details
Cardinality 0..1
Type CodeableConcept
Summary false
Comments

Use CodeableConcept.text element if the data is free (uncoded) text.

InsuranceProduct.related
Element Id InsuranceProduct.related
Definition

Another product that is related to this product. Often used to create relationships to parents or families of products.

Short Display Associated insurance product
Cardinality 0..*
Summary false
InsuranceProduct.related.product
Element Id InsuranceProduct.related.product
Definition

The Related Product reference.

Short Display Related Product reference
Cardinality 0..1
Type Reference(InsuranceProduct)
Summary false
InsuranceProduct.related.relationship
Element Id InsuranceProduct.related.relationship
Definition

The relationship of this product to the related product. an example would be 'sub-plan' where this product is a sub-plan of the related.product.

Short Display Relationship of this product to the related product
Cardinality 0..1
Type CodeableConcept
Summary false
Comments

Use CodeableConcept.text element if the data is free (uncoded) text.

InsuranceProduct.related.period
Element Id InsuranceProduct.related.period
Definition

Period of time that the product relationship is valid. The start and/or end dates can be empty if this is an open ended relationship.

Short Display Period that this Relationship is valid
Cardinality 0..1
Type Period
Summary false