Da Vinci PDex Plan Net
1.2.0 - STU1.2 United States of America flag

Da Vinci PDex Plan Net, published by HL7 International / Financial Management. This guide is not an authorized publication; it is the continuous build for version 1.2.0 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/HL7/davinci-pdex-plan-net/ and changes regularly. See the Directory of published versions

Resource Profile: Plan-Net InsurancePlan

Official URL: http://hl7.org/fhir/us/davinci-pdex-plan-net/StructureDefinition/plannet-InsurancePlan Version: 1.2.0
Standards status: Trial-use Computable Name: PlannetInsurancePlan

An InsurancePlan is a discrete package of health insurance coverage benefits that are offered under a particular network type. A given payer’s products typically differ by network type and/or covered benefits. A plan pairs a product’s covered benefits with the particular cost sharing structure offered to a consumer. A given product may comprise multiple plans (i.e. each plan offers different cost sharing requirements for the same set of covered benefits).

InsurancePlan describes a health insurance offering comprised of a list of covered benefits (i.e. the product), costs associated with those benefits (i.e. the plan), and additional information about the offering, such as who it is owned and administered by, a coverage area, contact information, etc.

Usages:

You can also check for usages in the FHIR IG Statistics

Formal Views of Profile Content

Description Differentials, Snapshots, and other representations.

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. InsurancePlan C 0..* InsurancePlan Details of a Health Insurance product/plan provided by an organization
Constraints: ipn-1, network-or-plan-Network, plan-type-is-distinct
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... Slices for identifier ΣC 0..* Identifier Business Identifier for Product
Slice: Unordered, Open by value:$this
.... identifier:All Slices Content/Rules for all slices
..... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
..... type SΣ 0..1 CodeableConcept Description of identifier
Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
..... value SΣ 0..1 string The value that is unique
Example General: 123456
..... assigner SΣ 0..1 Reference(Organization) Organization that issued id (may be just text)
.... identifier:MA-PLAN-ID SΣC 0..1 Identifier Business Identifier for Product
..... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
..... type SΣ 0..1 CodeableConcept Description of identifier
Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
..... system SΣ 1..1 uri The namespace for the identifier value
Required Pattern: http://cms.gov/medicare/ma-plan-id
..... value SΣ 1..1 string The value that is unique
Example General: 123456
..... assigner SΣ 0..1 Reference(Organization) Organization that issued id (may be just text)
... type SΣ 1..1 CodeableConcept Product Type
Binding: Insurance Product Type VS (extensible)
... name SΣC 0..1 string Official name
... alias S 0..* string Alternate names
... period S 0..1 Period When the product is available
... ownedBy SΣ 1..1 Reference(Plan-Net Organization) Plan issuer
... administeredBy SΣ 1..1 Reference(Plan-Net Organization) Product administrator
... coverageArea SΣ 0..* Reference(Plan-Net Location) Where product applies
... contact S 0..* BackboneElement Contact for the product
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... name S 0..1 HumanName A name associated with the contact
..... use ?!Σ 0..1 code usual | official | temp | nickname | anonymous | old | maiden
Binding: NameUse (required): The use of a human name.
..... text SΣ 0..1 string Text representation of the full name
.... telecom S 0..* ContactPoint Contact details (telephone, email, etc.) for a contact
..... system SΣC 0..1 code phone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required): Telecommunications form for contact point.
..... value SΣ 0..1 string The actual contact point details
..... use ?!Σ 0..1 code home | work | temp | old | mobile - purpose of this contact point
Binding: ContactPointUse (required): Use of contact point.
... endpoint S 0..* Reference(Plan-Net Endpoint) Technical endpoint
... network S 0..* Reference(Plan-Net Network) What networks are Included
... plan 0..* BackboneElement Cost sharing details for the plan
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... type S 0..1 CodeableConcept Categorization of the cost sharing for the plan
Binding: Insurance Plan TypeVS (extensible)
.... coverageArea SΣ 0..* Reference(Plan-Net Location) Where product applies
.... network 0..* Reference(Plan-Net Network) What networks provide coverage

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
InsurancePlan.identifier.​use Base required IdentifierUse 📍4.0.1 FHIR Std.
InsurancePlan.identifier.​type Base extensible IdentifierType 📍4.0.1 FHIR Std.
InsurancePlan.identifier:MA-PLAN-ID.​use Base required IdentifierUse 📍4.0.1 FHIR Std.
InsurancePlan.identifier:MA-PLAN-ID.​type Base extensible IdentifierType 📍4.0.1 FHIR Std.
InsurancePlan.status Base required PublicationStatus 📍4.0.1 FHIR Std.
InsurancePlan.type Base extensible Insurance Product Type VS 📦1.2.0 This IG
InsurancePlan.contact.​name.use Base required NameUse 📍4.0.1 FHIR Std.
InsurancePlan.contact.​telecom.system Base required ContactPointSystem 📍4.0.1 FHIR Std.
InsurancePlan.contact.​telecom.use Base required ContactPointUse 📍4.0.1 FHIR Std.
InsurancePlan.plan.type Base extensible Insurance Plan TypeVS 📦1.2.0 This IG

Constraints

Id Grade Path(s) Description Expression
dom-2 error InsurancePlan If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error InsurancePlan If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4 error InsurancePlan If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5 error InsurancePlan If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice InsurancePlan A resource should have narrative for robust management text.`div`.exists()
ele-1 error **ALL** elements All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error **ALL** extensions Must have either extensions or value[x], not both extension.exists() != value.exists()
ipn-1 error InsurancePlan The organization SHALL at least have a name or an idendtifier, and possibly more than one (identifier.count() + name.count()) > 0
network-or-plan-Network error InsurancePlan If an insuranceplan does not define a network, then each plan must define one network.exists() or plan.network.exists()
plan-type-is-distinct error InsurancePlan Each InsurancePlan.plan should have a distinct plan.type. plan.type.coding.code.isDistinct()

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. InsurancePlan C 0..* InsurancePlan Details of a Health Insurance product/plan provided by an organization
Constraints: network-or-plan-Network, plan-type-is-distinct
... Slices for identifier 0..* Identifier Business Identifier for Product
Slice: Unordered, Open by value:$this
.... identifier:All Slices Content/Rules for all slices
..... type S 0..1 CodeableConcept Description of identifier
..... value S 0..1 string The value that is unique
..... assigner S 0..1 Reference(Organization) Organization that issued id (may be just text)
.... identifier:MA-PLAN-ID S 0..1 Identifier Business Identifier for Product
..... system S 1..1 uri The namespace for the identifier value
Required Pattern: http://cms.gov/medicare/ma-plan-id
..... value 1..1 string The value that is unique
... status S 1..1 code draft | active | retired | unknown
Fixed Value: active
... type S 1..1 CodeableConcept Product Type
Binding: Insurance Product Type VS (extensible)
... alias S 0..* string Alternate names
... period S 0..1 Period When the product is available
... ownedBy S 1..1 Reference(Plan-Net Organization) Plan issuer
... administeredBy S 1..1 Reference(Plan-Net Organization) Product administrator
... coverageArea S 0..* Reference(Plan-Net Location) Where product applies
... contact S 0..* BackboneElement Contact for the product
.... name S 0..1 HumanName A name associated with the contact
..... text S 0..1 string Text representation of the full name
.... telecom S 0..* ContactPoint Contact details (telephone, email, etc.) for a contact
..... system S 0..1 code phone | fax | email | pager | url | sms | other
..... value S 0..1 string The actual contact point details
... endpoint S 0..* Reference(Plan-Net Endpoint) Technical endpoint
... network S 0..* Reference(Plan-Net Network) What networks are Included
... plan 0..* BackboneElement Cost sharing details for the plan
.... type S 0..1 CodeableConcept Categorization of the cost sharing for the plan
Binding: Insurance Plan TypeVS (extensible)
.... coverageArea S 0..* Reference(Plan-Net Location) Where product applies
.... network 0..* Reference(Plan-Net Network) What networks provide coverage

doco Documentation for this format

Terminology Bindings (Differential)

Path Status Usage ValueSet Version Source
InsurancePlan.type Base extensible Insurance Product Type VS 📦1.2.0 This IG
InsurancePlan.plan.type Base extensible Insurance Plan TypeVS 📦1.2.0 This IG

Constraints

Id Grade Path(s) Description Expression
network-or-plan-Network error InsurancePlan If an insuranceplan does not define a network, then each plan must define one network.exists() or plan.network.exists()
plan-type-is-distinct error InsurancePlan Each InsurancePlan.plan should have a distinct plan.type. plan.type.coding.code.isDistinct()
NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. InsurancePlan C 0..* InsurancePlan Details of a Health Insurance product/plan provided by an organization
Constraints: ipn-1, network-or-plan-Network, plan-type-is-distinct
... id Σ 0..1 id Logical id of this artifact
... meta Σ 0..1 Meta Metadata about the resource
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... text 0..1 Narrative Text summary of the resource, for human interpretation
This profile does not constrain the narrative in regard to content, language, or traceability to data elements
... contained 0..* Resource Contained, inline Resources
... extension 0..* Extension Additional content defined by implementations
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... Slices for identifier ΣC 0..* Identifier Business Identifier for Product
Slice: Unordered, Open by value:$this
.... identifier:All Slices Content/Rules for all slices
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
..... type SΣ 0..1 CodeableConcept Description of identifier
Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
..... system Σ 0..1 uri The namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
..... value SΣ 0..1 string The value that is unique
Example General: 123456
..... period Σ 0..1 Period Time period when id is/was valid for use
..... assigner SΣ 0..1 Reference(Organization) Organization that issued id (may be just text)
.... identifier:MA-PLAN-ID SΣC 0..1 Identifier Business Identifier for Product
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
..... type SΣ 0..1 CodeableConcept Description of identifier
Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
..... system SΣ 1..1 uri The namespace for the identifier value
Required Pattern: http://cms.gov/medicare/ma-plan-id
..... value SΣ 1..1 string The value that is unique
Example General: 123456
..... period Σ 0..1 Period Time period when id is/was valid for use
..... assigner SΣ 0..1 Reference(Organization) Organization that issued id (may be just text)
... status ?!SΣ 1..1 code draft | active | retired | unknown
Binding: PublicationStatus (required): The lifecycle status of an artifact.
Fixed Value: active
... type SΣ 1..1 CodeableConcept Product Type
Binding: Insurance Product Type VS (extensible)
... name SΣC 0..1 string Official name
... alias S 0..* string Alternate names
... period S 0..1 Period When the product is available
... ownedBy SΣ 1..1 Reference(Plan-Net Organization) Plan issuer
... administeredBy SΣ 1..1 Reference(Plan-Net Organization) Product administrator
... coverageArea SΣ 0..* Reference(Plan-Net Location) Where product applies
... contact S 0..* BackboneElement Contact for the product
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... purpose 0..1 CodeableConcept The type of contact
Binding: ContactEntityType (extensible): The purpose for which you would contact a contact party.
.... name S 0..1 HumanName A name associated with the contact
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... use ?!Σ 0..1 code usual | official | temp | nickname | anonymous | old | maiden
Binding: NameUse (required): The use of a human name.
..... text SΣ 0..1 string Text representation of the full name
..... family Σ 0..1 string Family name (often called 'Surname')
..... given Σ 0..* string Given names (not always 'first'). Includes middle names
This repeating element order: Given Names appear in the correct order for presenting the name
..... prefix Σ 0..* string Parts that come before the name
This repeating element order: Prefixes appear in the correct order for presenting the name
..... suffix Σ 0..* string Parts that come after the name
This repeating element order: Suffixes appear in the correct order for presenting the name
..... period Σ 0..1 Period Time period when name was/is in use
.... telecom S 0..* ContactPoint Contact details (telephone, email, etc.) for a contact
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... system SΣC 0..1 code phone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required): Telecommunications form for contact point.
..... value SΣ 0..1 string The actual contact point details
..... use ?!Σ 0..1 code home | work | temp | old | mobile - purpose of this contact point
Binding: ContactPointUse (required): Use of contact point.
..... rank Σ 0..1 positiveInt Specify preferred order of use (1 = highest)
..... period Σ 0..1 Period Time period when the contact point was/is in use
.... address 0..1 Address Visiting or postal addresses for the contact
... endpoint S 0..* Reference(Plan-Net Endpoint) Technical endpoint
... network S 0..* Reference(Plan-Net Network) What networks are Included
... coverage 0..* BackboneElement Coverage details
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... type 1..1 CodeableConcept Type of coverage
.... network 0..* Reference(Organization) What networks provide coverage
.... benefit 1..* BackboneElement List of benefits
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... type 1..1 CodeableConcept Type of benefit
..... requirement 0..1 string Referral requirements
..... limit 0..* BackboneElement Benefit limits
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
...... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
...... value 0..1 Quantity Maximum value allowed
...... code 0..1 CodeableConcept Benefit limit details
... plan 0..* BackboneElement Cost sharing details for the plan
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... identifier Σ 0..* Identifier Business Identifier for Product
.... type S 0..1 CodeableConcept Categorization of the cost sharing for the plan
Binding: Insurance Plan TypeVS (extensible)
.... coverageArea SΣ 0..* Reference(Plan-Net Location) Where product applies
.... network 0..* Reference(Plan-Net Network) What networks provide coverage
.... generalCost 0..* BackboneElement Overall costs
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... type 0..1 CodeableConcept Type of cost
..... groupSize 0..1 positiveInt Number of enrollees
..... cost 0..1 Money Cost value
..... comment 0..1 string Additional cost information
.... specificCost 0..* BackboneElement Specific costs
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... category 1..1 CodeableConcept General category of benefit
..... benefit 0..* BackboneElement Benefits list
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
...... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
...... type 1..1 CodeableConcept Type of specific benefit
...... cost 0..* BackboneElement List of the costs
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..* Extension Additional content defined by implementations
....... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
....... type 1..1 CodeableConcept Type of cost
....... applicability 0..1 CodeableConcept in-network | out-of-network | other
Binding: BenefitCostApplicability (required): Whether the cost applies to in-network or out-of-network providers.
....... qualifiers 0..* CodeableConcept Additional information about the cost
....... value 0..1 Quantity The actual cost value

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
InsurancePlan.language Base preferred Common Languages 📍4.0.1 FHIR Std.
InsurancePlan.identifier.​use Base required IdentifierUse 📍4.0.1 FHIR Std.
InsurancePlan.identifier.​type Base extensible IdentifierType 📍4.0.1 FHIR Std.
InsurancePlan.identifier:MA-PLAN-ID.​use Base required IdentifierUse 📍4.0.1 FHIR Std.
InsurancePlan.identifier:MA-PLAN-ID.​type Base extensible IdentifierType 📍4.0.1 FHIR Std.
InsurancePlan.status Base required PublicationStatus 📍4.0.1 FHIR Std.
InsurancePlan.type Base extensible Insurance Product Type VS 📦1.2.0 This IG
InsurancePlan.contact.​purpose Base extensible Contact entity type 📍4.0.1 FHIR Std.
InsurancePlan.contact.​name.use Base required NameUse 📍4.0.1 FHIR Std.
InsurancePlan.contact.​telecom.system Base required ContactPointSystem 📍4.0.1 FHIR Std.
InsurancePlan.contact.​telecom.use Base required ContactPointUse 📍4.0.1 FHIR Std.
InsurancePlan.plan.type Base extensible Insurance Plan TypeVS 📦1.2.0 This IG
InsurancePlan.plan.specificCost.​benefit.cost.applicability Base required Benefit cost applicability 📍4.0.1 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
dom-2 error InsurancePlan If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error InsurancePlan If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4 error InsurancePlan If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5 error InsurancePlan If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice InsurancePlan A resource should have narrative for robust management text.`div`.exists()
ele-1 error **ALL** elements All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error **ALL** extensions Must have either extensions or value[x], not both extension.exists() != value.exists()
ipn-1 error InsurancePlan The organization SHALL at least have a name or an idendtifier, and possibly more than one (identifier.count() + name.count()) > 0
network-or-plan-Network error InsurancePlan If an insuranceplan does not define a network, then each plan must define one network.exists() or plan.network.exists()
plan-type-is-distinct error InsurancePlan Each InsurancePlan.plan should have a distinct plan.type. plan.type.coding.code.isDistinct()

Summary

Mandatory: 4 elements(2 nested mandatory elements)
Must-Support: 23 elements
Fixed: 1 element

Structures

This structure refers to these other structures:

Slices

This structure defines the following Slices:

  • The element 1 is sliced based on the value of InsurancePlan.identifier

Key Elements View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. InsurancePlan C 0..* InsurancePlan Details of a Health Insurance product/plan provided by an organization
Constraints: ipn-1, network-or-plan-Network, plan-type-is-distinct
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... Slices for identifier ΣC 0..* Identifier Business Identifier for Product
Slice: Unordered, Open by value:$this
.... identifier:All Slices Content/Rules for all slices
..... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
..... type SΣ 0..1 CodeableConcept Description of identifier
Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
..... value SΣ 0..1 string The value that is unique
Example General: 123456
..... assigner SΣ 0..1 Reference(Organization) Organization that issued id (may be just text)
.... identifier:MA-PLAN-ID SΣC 0..1 Identifier Business Identifier for Product
..... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
..... type SΣ 0..1 CodeableConcept Description of identifier
Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
..... system SΣ 1..1 uri The namespace for the identifier value
Required Pattern: http://cms.gov/medicare/ma-plan-id
..... value SΣ 1..1 string The value that is unique
Example General: 123456
..... assigner SΣ 0..1 Reference(Organization) Organization that issued id (may be just text)
... type SΣ 1..1 CodeableConcept Product Type
Binding: Insurance Product Type VS (extensible)
... name SΣC 0..1 string Official name
... alias S 0..* string Alternate names
... period S 0..1 Period When the product is available
... ownedBy SΣ 1..1 Reference(Plan-Net Organization) Plan issuer
... administeredBy SΣ 1..1 Reference(Plan-Net Organization) Product administrator
... coverageArea SΣ 0..* Reference(Plan-Net Location) Where product applies
... contact S 0..* BackboneElement Contact for the product
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... name S 0..1 HumanName A name associated with the contact
..... use ?!Σ 0..1 code usual | official | temp | nickname | anonymous | old | maiden
Binding: NameUse (required): The use of a human name.
..... text SΣ 0..1 string Text representation of the full name
.... telecom S 0..* ContactPoint Contact details (telephone, email, etc.) for a contact
..... system SΣC 0..1 code phone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required): Telecommunications form for contact point.
..... value SΣ 0..1 string The actual contact point details
..... use ?!Σ 0..1 code home | work | temp | old | mobile - purpose of this contact point
Binding: ContactPointUse (required): Use of contact point.
... endpoint S 0..* Reference(Plan-Net Endpoint) Technical endpoint
... network S 0..* Reference(Plan-Net Network) What networks are Included
... plan 0..* BackboneElement Cost sharing details for the plan
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... type S 0..1 CodeableConcept Categorization of the cost sharing for the plan
Binding: Insurance Plan TypeVS (extensible)
.... coverageArea SΣ 0..* Reference(Plan-Net Location) Where product applies
.... network 0..* Reference(Plan-Net Network) What networks provide coverage

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
InsurancePlan.identifier.​use Base required IdentifierUse 📍4.0.1 FHIR Std.
InsurancePlan.identifier.​type Base extensible IdentifierType 📍4.0.1 FHIR Std.
InsurancePlan.identifier:MA-PLAN-ID.​use Base required IdentifierUse 📍4.0.1 FHIR Std.
InsurancePlan.identifier:MA-PLAN-ID.​type Base extensible IdentifierType 📍4.0.1 FHIR Std.
InsurancePlan.status Base required PublicationStatus 📍4.0.1 FHIR Std.
InsurancePlan.type Base extensible Insurance Product Type VS 📦1.2.0 This IG
InsurancePlan.contact.​name.use Base required NameUse 📍4.0.1 FHIR Std.
InsurancePlan.contact.​telecom.system Base required ContactPointSystem 📍4.0.1 FHIR Std.
InsurancePlan.contact.​telecom.use Base required ContactPointUse 📍4.0.1 FHIR Std.
InsurancePlan.plan.type Base extensible Insurance Plan TypeVS 📦1.2.0 This IG

Constraints

Id Grade Path(s) Description Expression
dom-2 error InsurancePlan If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error InsurancePlan If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4 error InsurancePlan If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5 error InsurancePlan If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice InsurancePlan A resource should have narrative for robust management text.`div`.exists()
ele-1 error **ALL** elements All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error **ALL** extensions Must have either extensions or value[x], not both extension.exists() != value.exists()
ipn-1 error InsurancePlan The organization SHALL at least have a name or an idendtifier, and possibly more than one (identifier.count() + name.count()) > 0
network-or-plan-Network error InsurancePlan If an insuranceplan does not define a network, then each plan must define one network.exists() or plan.network.exists()
plan-type-is-distinct error InsurancePlan Each InsurancePlan.plan should have a distinct plan.type. plan.type.coding.code.isDistinct()

Differential View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. InsurancePlan C 0..* InsurancePlan Details of a Health Insurance product/plan provided by an organization
Constraints: network-or-plan-Network, plan-type-is-distinct
... Slices for identifier 0..* Identifier Business Identifier for Product
Slice: Unordered, Open by value:$this
.... identifier:All Slices Content/Rules for all slices
..... type S 0..1 CodeableConcept Description of identifier
..... value S 0..1 string The value that is unique
..... assigner S 0..1 Reference(Organization) Organization that issued id (may be just text)
.... identifier:MA-PLAN-ID S 0..1 Identifier Business Identifier for Product
..... system S 1..1 uri The namespace for the identifier value
Required Pattern: http://cms.gov/medicare/ma-plan-id
..... value 1..1 string The value that is unique
... status S 1..1 code draft | active | retired | unknown
Fixed Value: active
... type S 1..1 CodeableConcept Product Type
Binding: Insurance Product Type VS (extensible)
... alias S 0..* string Alternate names
... period S 0..1 Period When the product is available
... ownedBy S 1..1 Reference(Plan-Net Organization) Plan issuer
... administeredBy S 1..1 Reference(Plan-Net Organization) Product administrator
... coverageArea S 0..* Reference(Plan-Net Location) Where product applies
... contact S 0..* BackboneElement Contact for the product
.... name S 0..1 HumanName A name associated with the contact
..... text S 0..1 string Text representation of the full name
.... telecom S 0..* ContactPoint Contact details (telephone, email, etc.) for a contact
..... system S 0..1 code phone | fax | email | pager | url | sms | other
..... value S 0..1 string The actual contact point details
... endpoint S 0..* Reference(Plan-Net Endpoint) Technical endpoint
... network S 0..* Reference(Plan-Net Network) What networks are Included
... plan 0..* BackboneElement Cost sharing details for the plan
.... type S 0..1 CodeableConcept Categorization of the cost sharing for the plan
Binding: Insurance Plan TypeVS (extensible)
.... coverageArea S 0..* Reference(Plan-Net Location) Where product applies
.... network 0..* Reference(Plan-Net Network) What networks provide coverage

doco Documentation for this format

Terminology Bindings (Differential)

Path Status Usage ValueSet Version Source
InsurancePlan.type Base extensible Insurance Product Type VS 📦1.2.0 This IG
InsurancePlan.plan.type Base extensible Insurance Plan TypeVS 📦1.2.0 This IG

Constraints

Id Grade Path(s) Description Expression
network-or-plan-Network error InsurancePlan If an insuranceplan does not define a network, then each plan must define one network.exists() or plan.network.exists()
plan-type-is-distinct error InsurancePlan Each InsurancePlan.plan should have a distinct plan.type. plan.type.coding.code.isDistinct()

Snapshot ViewView

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. InsurancePlan C 0..* InsurancePlan Details of a Health Insurance product/plan provided by an organization
Constraints: ipn-1, network-or-plan-Network, plan-type-is-distinct
... id Σ 0..1 id Logical id of this artifact
... meta Σ 0..1 Meta Metadata about the resource
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... text 0..1 Narrative Text summary of the resource, for human interpretation
This profile does not constrain the narrative in regard to content, language, or traceability to data elements
... contained 0..* Resource Contained, inline Resources
... extension 0..* Extension Additional content defined by implementations
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... Slices for identifier ΣC 0..* Identifier Business Identifier for Product
Slice: Unordered, Open by value:$this
.... identifier:All Slices Content/Rules for all slices
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
..... type SΣ 0..1 CodeableConcept Description of identifier
Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
..... system Σ 0..1 uri The namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
..... value SΣ 0..1 string The value that is unique
Example General: 123456
..... period Σ 0..1 Period Time period when id is/was valid for use
..... assigner SΣ 0..1 Reference(Organization) Organization that issued id (may be just text)
.... identifier:MA-PLAN-ID SΣC 0..1 Identifier Business Identifier for Product
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
..... type SΣ 0..1 CodeableConcept Description of identifier
Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
..... system SΣ 1..1 uri The namespace for the identifier value
Required Pattern: http://cms.gov/medicare/ma-plan-id
..... value SΣ 1..1 string The value that is unique
Example General: 123456
..... period Σ 0..1 Period Time period when id is/was valid for use
..... assigner SΣ 0..1 Reference(Organization) Organization that issued id (may be just text)
... status ?!SΣ 1..1 code draft | active | retired | unknown
Binding: PublicationStatus (required): The lifecycle status of an artifact.
Fixed Value: active
... type SΣ 1..1 CodeableConcept Product Type
Binding: Insurance Product Type VS (extensible)
... name SΣC 0..1 string Official name
... alias S 0..* string Alternate names
... period S 0..1 Period When the product is available
... ownedBy SΣ 1..1 Reference(Plan-Net Organization) Plan issuer
... administeredBy SΣ 1..1 Reference(Plan-Net Organization) Product administrator
... coverageArea SΣ 0..* Reference(Plan-Net Location) Where product applies
... contact S 0..* BackboneElement Contact for the product
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... purpose 0..1 CodeableConcept The type of contact
Binding: ContactEntityType (extensible): The purpose for which you would contact a contact party.
.... name S 0..1 HumanName A name associated with the contact
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... use ?!Σ 0..1 code usual | official | temp | nickname | anonymous | old | maiden
Binding: NameUse (required): The use of a human name.
..... text SΣ 0..1 string Text representation of the full name
..... family Σ 0..1 string Family name (often called 'Surname')
..... given Σ 0..* string Given names (not always 'first'). Includes middle names
This repeating element order: Given Names appear in the correct order for presenting the name
..... prefix Σ 0..* string Parts that come before the name
This repeating element order: Prefixes appear in the correct order for presenting the name
..... suffix Σ 0..* string Parts that come after the name
This repeating element order: Suffixes appear in the correct order for presenting the name
..... period Σ 0..1 Period Time period when name was/is in use
.... telecom S 0..* ContactPoint Contact details (telephone, email, etc.) for a contact
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... system SΣC 0..1 code phone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required): Telecommunications form for contact point.
..... value SΣ 0..1 string The actual contact point details
..... use ?!Σ 0..1 code home | work | temp | old | mobile - purpose of this contact point
Binding: ContactPointUse (required): Use of contact point.
..... rank Σ 0..1 positiveInt Specify preferred order of use (1 = highest)
..... period Σ 0..1 Period Time period when the contact point was/is in use
.... address 0..1 Address Visiting or postal addresses for the contact
... endpoint S 0..* Reference(Plan-Net Endpoint) Technical endpoint
... network S 0..* Reference(Plan-Net Network) What networks are Included
... coverage 0..* BackboneElement Coverage details
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... type 1..1 CodeableConcept Type of coverage
.... network 0..* Reference(Organization) What networks provide coverage
.... benefit 1..* BackboneElement List of benefits
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... type 1..1 CodeableConcept Type of benefit
..... requirement 0..1 string Referral requirements
..... limit 0..* BackboneElement Benefit limits
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
...... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
...... value 0..1 Quantity Maximum value allowed
...... code 0..1 CodeableConcept Benefit limit details
... plan 0..* BackboneElement Cost sharing details for the plan
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... identifier Σ 0..* Identifier Business Identifier for Product
.... type S 0..1 CodeableConcept Categorization of the cost sharing for the plan
Binding: Insurance Plan TypeVS (extensible)
.... coverageArea SΣ 0..* Reference(Plan-Net Location) Where product applies
.... network 0..* Reference(Plan-Net Network) What networks provide coverage
.... generalCost 0..* BackboneElement Overall costs
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... type 0..1 CodeableConcept Type of cost
..... groupSize 0..1 positiveInt Number of enrollees
..... cost 0..1 Money Cost value
..... comment 0..1 string Additional cost information
.... specificCost 0..* BackboneElement Specific costs
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... category 1..1 CodeableConcept General category of benefit
..... benefit 0..* BackboneElement Benefits list
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
...... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
...... type 1..1 CodeableConcept Type of specific benefit
...... cost 0..* BackboneElement List of the costs
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..* Extension Additional content defined by implementations
....... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
....... type 1..1 CodeableConcept Type of cost
....... applicability 0..1 CodeableConcept in-network | out-of-network | other
Binding: BenefitCostApplicability (required): Whether the cost applies to in-network or out-of-network providers.
....... qualifiers 0..* CodeableConcept Additional information about the cost
....... value 0..1 Quantity The actual cost value

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
InsurancePlan.language Base preferred Common Languages 📍4.0.1 FHIR Std.
InsurancePlan.identifier.​use Base required IdentifierUse 📍4.0.1 FHIR Std.
InsurancePlan.identifier.​type Base extensible IdentifierType 📍4.0.1 FHIR Std.
InsurancePlan.identifier:MA-PLAN-ID.​use Base required IdentifierUse 📍4.0.1 FHIR Std.
InsurancePlan.identifier:MA-PLAN-ID.​type Base extensible IdentifierType 📍4.0.1 FHIR Std.
InsurancePlan.status Base required PublicationStatus 📍4.0.1 FHIR Std.
InsurancePlan.type Base extensible Insurance Product Type VS 📦1.2.0 This IG
InsurancePlan.contact.​purpose Base extensible Contact entity type 📍4.0.1 FHIR Std.
InsurancePlan.contact.​name.use Base required NameUse 📍4.0.1 FHIR Std.
InsurancePlan.contact.​telecom.system Base required ContactPointSystem 📍4.0.1 FHIR Std.
InsurancePlan.contact.​telecom.use Base required ContactPointUse 📍4.0.1 FHIR Std.
InsurancePlan.plan.type Base extensible Insurance Plan TypeVS 📦1.2.0 This IG
InsurancePlan.plan.specificCost.​benefit.cost.applicability Base required Benefit cost applicability 📍4.0.1 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
dom-2 error InsurancePlan If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error InsurancePlan If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4 error InsurancePlan If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5 error InsurancePlan If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice InsurancePlan A resource should have narrative for robust management text.`div`.exists()
ele-1 error **ALL** elements All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error **ALL** extensions Must have either extensions or value[x], not both extension.exists() != value.exists()
ipn-1 error InsurancePlan The organization SHALL at least have a name or an idendtifier, and possibly more than one (identifier.count() + name.count()) > 0
network-or-plan-Network error InsurancePlan If an insuranceplan does not define a network, then each plan must define one network.exists() or plan.network.exists()
plan-type-is-distinct error InsurancePlan Each InsurancePlan.plan should have a distinct plan.type. plan.type.coding.code.isDistinct()

Summary

Mandatory: 4 elements(2 nested mandatory elements)
Must-Support: 23 elements
Fixed: 1 element

Structures

This structure refers to these other structures:

Slices

This structure defines the following Slices:

  • The element 1 is sliced based on the value of InsurancePlan.identifier

 

Other representations of profile: CSV, Excel, Schematron