This page is part of the National Directory of Healthcare Providers and Services (NDH) Implementation Guide (v1.0.0-ballot: STU1 Ballot 1) based on FHIR R4. . For a full list of available versions, see the Directory of published versions
Official URL: http://hl7.org/fhir/us/ndh/StructureDefinition/ndhEx-InsurancePlan | Version: 1.0.0-ballot | |||
Active as of 2023-07-30 | Computable Name: NdhExInsurancePlan |
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.
Usage:
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from NdhInsurancePlan
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
InsurancePlan | C | 0..* | NdhInsurancePlan | Details of a Health Insurance product/plan provided by an organization plan-type-is-distinct: Each InsurancePlan.plan should have a distinct plan.type. |
meta | ||||
profile | 1..1 | canonical(StructureDefinition) | Profiles this resource claims to conform to | |
extension | 1..* | Extension | Extension | |
extension:verification-status | S | 1..1 | VerificationStatus | NDH Verification Status |
identifier | ||||
extension | 1..* | Extension | Extension | |
extension:identifier-status | S | 1..1 | IdentifierStatus | NDH Identifier Status |
use | S | 0..1 | code | usual | official | temp | secondary | old (If known) |
type | S | 0..1 | CodeableConcept | Description of identifier |
system | S | 0..1 | uri | The namespace for the identifier value |
value | S | 0..1 | string | The value that is unique |
assigner | S | 0..1 | Reference(NDH Exchange Organization Profile) | Organization that issued id (may be just text) |
alias | S | 0..* | string | Alternate names |
period | S | 0..1 | Period | When the product is available |
ownedBy | 1..1 | Reference(NDH Exchange Organization Profile) | Plan issuer | |
administeredBy | 1..1 | Reference(NDH Exchange Organization Profile) | Product administrator | |
coverageArea | 0..* | Reference(NDH Exchange Location Profile) | Where product applies | |
contact | S | 0..* | BackboneElement | Contact for the product |
purpose | S | 0..1 | CodeableConcept | The type of contact |
name | S | 0..1 | HumanName | A name associated with the contact |
use | S | 0..1 | code | usual | official | temp | nickname | anonymous | old | maiden |
text | S | 0..1 | string | Text representation of the full name |
family | S | 0..1 | string | Family name (often called 'Surname') |
given | S | 0..* | string | Given names (not always 'first'). Includes middle names |
prefix | S | 0..* | string | Parts that come before the name |
suffix | S | 0..* | string | Parts that come after the name |
period | S | 0..1 | Period | Time period when name was/is in use |
telecom | S | 0..* | ContactPoint | Contact details (telephone, email, etc.) for a contact |
extension:contactpoint-availabletime | S | 0..* | ContactPointAvailableTime | NDH Contactpoint Availabletime |
extension:via-intermediary | S | 0..1 | ViaIntermediary | NDH Via Intermediary |
system | S | 0..1 | code | phone | fax | email | pager | url | sms | other |
value | S | 0..1 | string | The actual contact point details |
use | S | 0..1 | code | home | work | temp | old | mobile - purpose of this contact point |
rank | S | 0..1 | positiveInt | Specify preferred order of use (1 = highest) |
endpoint | S | 0..* | Reference(NDH Exchange Endpoint Profile) | Technical endpoint |
network | 0..* | Reference(NDH Exchange Network Profile) | What networks are Included | |
coverage | S | 0..* | BackboneElement | Coverage details |
type | S | 1..1 | CodeableConcept | Type of coverage |
network | 0..* | Reference(NDH Exchange Network Profile) | What networks provide coverage | |
benefit | S | 1..* | BackboneElement | List of benefits |
type | S | 1..1 | CodeableConcept | Type of benefit |
requirement | S | 0..1 | string | Referral requirements |
limit | S | 0..* | BackboneElement | Benefit limits |
value | S | 0..1 | Quantity | Maximum value allowed |
code | S | 0..1 | CodeableConcept | Benefit limit details |
plan | S | 0..* | BackboneElement | Cost sharing details for the plan |
identifier | S | 0..* | Identifier | Business Identifier for Product |
extension:identifier-status | S | 0..1 | IdentifierStatus | NDH Identifier Status |
use | S | 0..1 | code | usual | official | temp | secondary | old (If known) |
type | S | 0..1 | CodeableConcept | Description of identifier |
system | S | 0..1 | uri | The namespace for the identifier value |
value | S | 0..1 | string | The value that is unique |
period | S | 0..1 | Period | Time period when id is/was valid for use |
assigner | S | 0..1 | Reference(NDH Exchange Organization Profile) | Organization that issued id (may be just text) |
type | S | 0..1 | CodeableConcept | Categorization of the cost sharing for the plan |
coverageArea | S | 0..* | Reference(NDH Exchange Location Profile) | Where product applies |
network | S | 0..* | Reference(NDH Exchange Network Profile) | What networks provide coverage |
generalCost | S | 0..* | BackboneElement | Overall costs |
type | S | 0..1 | CodeableConcept | Type of cost |
groupSize | S | 0..1 | positiveInt | Number of enrollees |
cost | S | 0..1 | Money | Cost value |
comment | S | 0..1 | string | Additional cost information |
specificCost | S | 0..* | BackboneElement | Specific costs |
category | S | 1..1 | CodeableConcept | General category of benefit |
benefit | S | 0..* | BackboneElement | Benefits list |
type | S | 1..1 | CodeableConcept | Type of specific benefit |
cost | S | 0..* | BackboneElement | List of the costs |
type | S | 1..1 | CodeableConcept | Type of cost |
applicability | S | 0..1 | CodeableConcept | in-network | out-of-network | other |
qualifiers | S | 0..* | CodeableConcept | Additional information about the cost |
value | S | 0..1 | Quantity | The actual cost value |
Documentation for this format |
Id | Grade | Path(s) | Details | Requirements |
plan-type-is-distinct | error | InsurancePlan | Each InsurancePlan.plan should have a distinct plan.type. : plan.type.coding.code.isDistinct() |
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
InsurancePlan | C | 0..* | NdhInsurancePlan | Details of a Health Insurance product/plan provided by an organization |
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created |
Slices for extension | 1..* | Extension | Extension Slice: Unordered, Open by value:url | |
usage-restriction | 0..* | Reference(NDH Base Restriction) {c} | Usage Restriction URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-usage-restriction | |
verification-status | S | 1..1 | CodeableConcept | NDH Verification Status URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-verification-status Binding: NDH Verification Status Value Set (extensible) |
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
identifier | SΣC | 0..* | Identifier | Business Identifier for Product |
Slices for extension | 1..* | Extension | Extension Slice: Unordered, Open by value:url | |
identifier-status | S | 1..1 | code | NDH Identifier Status URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-identifier-status Binding: Identifier Status Value Set (required) |
use | ?!SΣ | 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Σ | 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 |
assigner | SΣ | 0..1 | Reference(NDH Exchange Organization Profile) | 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 Value Set (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(NDH Exchange Organization Profile) | Plan issuer |
administeredBy | SΣ | 1..1 | Reference(NDH Exchange Organization Profile) | Product administrator |
coverageArea | SΣ | 0..* | Reference(NDH Exchange Location Profile) | Where product applies |
contact | S | 0..* | BackboneElement | Contact for the product |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
purpose | S | 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 |
use | ?!SΣ | 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 | SΣ | 0..1 | string | Family name (often called 'Surname') |
given | SΣ | 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 | SΣ | 0..* | string | Parts that come before the name This repeating element order: Prefixes appear in the correct order for presenting the name |
suffix | SΣ | 0..* | string | Parts that come after the name This repeating element order: Suffixes appear in the correct order for presenting the name |
period | SΣ | 0..1 | Period | Time period when name was/is in use |
telecom | S | 0..* | ContactPoint | Contact details (telephone, email, etc.) for a contact |
contactpoint-availabletime | S | 0..* | (Complex) | NDH Contactpoint Availabletime URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-contactpoint-availabletime |
via-intermediary | S | 0..1 | Reference(NDH Base PractitionerRole | NDH Base OrganizationAffiliation Profile | NDH Base Location Profile | NDH Base Organization Profile) | NDH Via Intermediary URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-via-intermediary |
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 | ?!SΣ | 0..1 | code | home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required): Use of contact point. |
rank | SΣ | 0..1 | positiveInt | Specify preferred order of use (1 = highest) |
endpoint | S | 0..* | Reference(NDH Exchange Endpoint Profile) | Technical endpoint |
network | S | 0..* | Reference(NDH Exchange Network Profile) | What networks are Included |
coverage | S | 0..* | BackboneElement | Coverage details |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
type | S | 1..1 | CodeableConcept | Type of coverage Binding: NDH Insurance Coverage Type Value Set (extensible) |
network | S | 0..* | Reference(NDH Exchange Network Profile) | What networks provide coverage |
benefit | S | 1..* | BackboneElement | List of benefits |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
type | S | 1..1 | CodeableConcept | Type of benefit Binding: NDH Benefit Type Value Set (extensible) |
requirement | S | 0..1 | string | Referral requirements |
limit | S | 0..* | BackboneElement | Benefit limits |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
value | S | 0..1 | Quantity | Maximum value allowed |
code | S | 0..1 | CodeableConcept | Benefit limit details |
plan | S | 0..* | BackboneElement | Cost sharing details for the plan |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
identifier | SΣ | 0..* | Identifier | Business Identifier for Product |
identifier-status | S | 0..1 | code | NDH Identifier Status URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-identifier-status Binding: Identifier Status Value Set (required) |
use | ?!SΣ | 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Σ | 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 | SΣ | 0..1 | Period | Time period when id is/was valid for use |
assigner | SΣ | 0..1 | Reference(NDH Exchange Organization Profile) | Organization that issued id (may be just text) |
type | S | 0..1 | CodeableConcept | Categorization of the cost sharing for the plan Binding: Insurance Plan Type Value Set (extensible) |
coverageArea | SΣ | 0..* | Reference(NDH Exchange Location Profile) | Where product applies |
network | S | 0..* | Reference(NDH Exchange Network Profile) | What networks provide coverage |
generalCost | S | 0..* | BackboneElement | Overall costs |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
type | S | 0..1 | CodeableConcept | Type of cost |
groupSize | S | 0..1 | positiveInt | Number of enrollees |
cost | S | 0..1 | Money | Cost value |
comment | S | 0..1 | string | Additional cost information |
specificCost | S | 0..* | BackboneElement | Specific costs |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
category | S | 1..1 | CodeableConcept | General category of benefit |
benefit | S | 0..* | BackboneElement | Benefits list |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
type | S | 1..1 | CodeableConcept | Type of specific benefit |
cost | S | 0..* | BackboneElement | List of the costs |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
type | S | 1..1 | CodeableConcept | Type of cost |
applicability | S | 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 | S | 0..* | CodeableConcept | Additional information about the cost |
value | S | 0..1 | Quantity | The actual cost value |
Documentation for this format |
Path | Conformance | ValueSet / Code |
InsurancePlan.identifier.use | required | IdentifierUse |
InsurancePlan.identifier.type | extensible | Identifier Type Codes |
InsurancePlan.status | required | Fixed Value: active |
InsurancePlan.type | extensible | InsuranceProductTypeVS (a valid code from Insurance Product Type Code System) |
InsurancePlan.contact.purpose | extensible | ContactEntityType |
InsurancePlan.contact.name.use | required | NameUse |
InsurancePlan.contact.telecom.system | required | ContactPointSystem |
InsurancePlan.contact.telecom.use | required | ContactPointUse |
InsurancePlan.coverage.type | extensible | NdhCoverageTypeVS |
InsurancePlan.coverage.benefit.type | extensible | NdhBenefitTypeVS |
InsurancePlan.plan.identifier.use | required | IdentifierUse |
InsurancePlan.plan.identifier.type | extensible | Identifier Type Codes |
InsurancePlan.plan.type | extensible | InsurancePlanTypeVS (a valid code from Insurance Plan Type Code System) |
InsurancePlan.plan.specificCost.benefit.cost.applicability | required | BenefitCostApplicability |
Name | Flags | Card. | Type | Description & Constraints | ||||
---|---|---|---|---|---|---|---|---|
InsurancePlan | C | 0..* | NdhInsurancePlan | Details of a Health Insurance product/plan provided by an organization | ||||
id | Σ | 0..1 | id | Logical id of this artifact | ||||
meta | Σ | 0..1 | Meta | Metadata about the resource | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
versionId | Σ | 0..1 | id | Version specific identifier | ||||
lastUpdated | Σ | 1..1 | instant | When the resource version last changed | ||||
source | Σ | 0..1 | uri | Identifies where the resource comes from | ||||
profile | Σ | 1..1 | canonical(StructureDefinition) | Profiles this resource claims to conform to | ||||
security | Σ | 0..* | Coding | Security Labels applied to this resource Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System. | ||||
tag | Σ | 0..* | Coding | Tags applied to this resource Binding: CommonTags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones". | ||||
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
language | 0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||
text | 0..1 | Narrative | Text summary of the resource, for human interpretation | |||||
contained | 0..* | Resource | Contained, inline Resources | |||||
Slices for extension | 1..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
usage-restriction | 0..* | Reference(NDH Base Restriction) {c} | Usage Restriction URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-usage-restriction | |||||
verification-status | S | 1..1 | CodeableConcept | NDH Verification Status URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-verification-status Binding: NDH Verification Status Value Set (extensible) | ||||
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored | ||||
identifier | SΣC | 0..* | Identifier | Business Identifier for Product | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
Slices for extension | 1..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
identifier-status | S | 1..1 | code | NDH Identifier Status URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-identifier-status Binding: Identifier Status Value Set (required) | ||||
use | ?!SΣ | 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Σ | 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(NDH Exchange Organization Profile) | 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 Value Set (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(NDH Exchange Organization Profile) | Plan issuer | ||||
administeredBy | SΣ | 1..1 | Reference(NDH Exchange Organization Profile) | Product administrator | ||||
coverageArea | SΣ | 0..* | Reference(NDH Exchange Location Profile) | 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 | S | 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 | ?!SΣ | 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 | SΣ | 0..1 | string | Family name (often called 'Surname') | ||||
given | SΣ | 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 | SΣ | 0..* | string | Parts that come before the name This repeating element order: Prefixes appear in the correct order for presenting the name | ||||
suffix | SΣ | 0..* | string | Parts that come after the name This repeating element order: Suffixes appear in the correct order for presenting the name | ||||
period | SΣ | 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 | |||||
Slices for extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
contactpoint-availabletime | S | 0..* | (Complex) | NDH Contactpoint Availabletime URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-contactpoint-availabletime | ||||
via-intermediary | S | 0..1 | Reference(NDH Base PractitionerRole | NDH Base OrganizationAffiliation Profile | NDH Base Location Profile | NDH Base Organization Profile) | NDH Via Intermediary URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-via-intermediary | ||||
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 | ?!SΣ | 0..1 | code | home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required): Use of contact point. | ||||
rank | SΣ | 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(NDH Exchange Endpoint Profile) | Technical endpoint | ||||
network | S | 0..* | Reference(NDH Exchange Network Profile) | What networks are Included | ||||
coverage | S | 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 | S | 1..1 | CodeableConcept | Type of coverage Binding: NDH Insurance Coverage Type Value Set (extensible) | ||||
network | S | 0..* | Reference(NDH Exchange Network Profile) | What networks provide coverage | ||||
benefit | S | 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 | S | 1..1 | CodeableConcept | Type of benefit Binding: NDH Benefit Type Value Set (extensible) | ||||
requirement | S | 0..1 | string | Referral requirements | ||||
limit | S | 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 | S | 0..1 | Quantity | Maximum value allowed | ||||
code | S | 0..1 | CodeableConcept | Benefit limit details | ||||
plan | S | 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 | SΣ | 0..* | Identifier | Business Identifier for Product | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
Slices for extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
identifier-status | S | 0..1 | code | NDH Identifier Status URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-identifier-status Binding: Identifier Status Value Set (required) | ||||
use | ?!SΣ | 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Σ | 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 | SΣ | 0..1 | Period | Time period when id is/was valid for use | ||||
assigner | SΣ | 0..1 | Reference(NDH Exchange Organization Profile) | Organization that issued id (may be just text) | ||||
type | S | 0..1 | CodeableConcept | Categorization of the cost sharing for the plan Binding: Insurance Plan Type Value Set (extensible) | ||||
coverageArea | SΣ | 0..* | Reference(NDH Exchange Location Profile) | Where product applies | ||||
network | S | 0..* | Reference(NDH Exchange Network Profile) | What networks provide coverage | ||||
generalCost | S | 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 | S | 0..1 | CodeableConcept | Type of cost | ||||
groupSize | S | 0..1 | positiveInt | Number of enrollees | ||||
cost | S | 0..1 | Money | Cost value | ||||
comment | S | 0..1 | string | Additional cost information | ||||
specificCost | S | 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 | S | 1..1 | CodeableConcept | General category of benefit | ||||
benefit | S | 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 | S | 1..1 | CodeableConcept | Type of specific benefit | ||||
cost | S | 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 | S | 1..1 | CodeableConcept | Type of cost | ||||
applicability | S | 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 | S | 0..* | CodeableConcept | Additional information about the cost | ||||
value | S | 0..1 | Quantity | The actual cost value | ||||
Documentation for this format |
Path | Conformance | ValueSet / Code | ||||
InsurancePlan.meta.security | extensible | All Security Labels | ||||
InsurancePlan.meta.tag | example | CommonTags | ||||
InsurancePlan.language | preferred | CommonLanguages
| ||||
InsurancePlan.identifier.use | required | IdentifierUse | ||||
InsurancePlan.identifier.type | extensible | Identifier Type Codes | ||||
InsurancePlan.status | required | Fixed Value: active | ||||
InsurancePlan.type | extensible | InsuranceProductTypeVS (a valid code from Insurance Product Type Code System) | ||||
InsurancePlan.contact.purpose | extensible | ContactEntityType | ||||
InsurancePlan.contact.name.use | required | NameUse | ||||
InsurancePlan.contact.telecom.system | required | ContactPointSystem | ||||
InsurancePlan.contact.telecom.use | required | ContactPointUse | ||||
InsurancePlan.coverage.type | extensible | NdhCoverageTypeVS | ||||
InsurancePlan.coverage.benefit.type | extensible | NdhBenefitTypeVS | ||||
InsurancePlan.plan.identifier.use | required | IdentifierUse | ||||
InsurancePlan.plan.identifier.type | extensible | Identifier Type Codes | ||||
InsurancePlan.plan.type | extensible | InsurancePlanTypeVS (a valid code from Insurance Plan Type Code System) | ||||
InsurancePlan.plan.specificCost.benefit.cost.applicability | required | BenefitCostApplicability |
This structure is derived from NdhInsurancePlan
Summary
Mandatory: 2 elements (3 nested mandatory elements)
Must-Support: 61 elements
Structures
This structure refers to these other structures:
Differential View
This structure is derived from NdhInsurancePlan
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
InsurancePlan | C | 0..* | NdhInsurancePlan | Details of a Health Insurance product/plan provided by an organization plan-type-is-distinct: Each InsurancePlan.plan should have a distinct plan.type. |
meta | ||||
profile | 1..1 | canonical(StructureDefinition) | Profiles this resource claims to conform to | |
extension | 1..* | Extension | Extension | |
extension:verification-status | S | 1..1 | VerificationStatus | NDH Verification Status |
identifier | ||||
extension | 1..* | Extension | Extension | |
extension:identifier-status | S | 1..1 | IdentifierStatus | NDH Identifier Status |
use | S | 0..1 | code | usual | official | temp | secondary | old (If known) |
type | S | 0..1 | CodeableConcept | Description of identifier |
system | S | 0..1 | uri | The namespace for the identifier value |
value | S | 0..1 | string | The value that is unique |
assigner | S | 0..1 | Reference(NDH Exchange Organization Profile) | Organization that issued id (may be just text) |
alias | S | 0..* | string | Alternate names |
period | S | 0..1 | Period | When the product is available |
ownedBy | 1..1 | Reference(NDH Exchange Organization Profile) | Plan issuer | |
administeredBy | 1..1 | Reference(NDH Exchange Organization Profile) | Product administrator | |
coverageArea | 0..* | Reference(NDH Exchange Location Profile) | Where product applies | |
contact | S | 0..* | BackboneElement | Contact for the product |
purpose | S | 0..1 | CodeableConcept | The type of contact |
name | S | 0..1 | HumanName | A name associated with the contact |
use | S | 0..1 | code | usual | official | temp | nickname | anonymous | old | maiden |
text | S | 0..1 | string | Text representation of the full name |
family | S | 0..1 | string | Family name (often called 'Surname') |
given | S | 0..* | string | Given names (not always 'first'). Includes middle names |
prefix | S | 0..* | string | Parts that come before the name |
suffix | S | 0..* | string | Parts that come after the name |
period | S | 0..1 | Period | Time period when name was/is in use |
telecom | S | 0..* | ContactPoint | Contact details (telephone, email, etc.) for a contact |
extension:contactpoint-availabletime | S | 0..* | ContactPointAvailableTime | NDH Contactpoint Availabletime |
extension:via-intermediary | S | 0..1 | ViaIntermediary | NDH Via Intermediary |
system | S | 0..1 | code | phone | fax | email | pager | url | sms | other |
value | S | 0..1 | string | The actual contact point details |
use | S | 0..1 | code | home | work | temp | old | mobile - purpose of this contact point |
rank | S | 0..1 | positiveInt | Specify preferred order of use (1 = highest) |
endpoint | S | 0..* | Reference(NDH Exchange Endpoint Profile) | Technical endpoint |
network | 0..* | Reference(NDH Exchange Network Profile) | What networks are Included | |
coverage | S | 0..* | BackboneElement | Coverage details |
type | S | 1..1 | CodeableConcept | Type of coverage |
network | 0..* | Reference(NDH Exchange Network Profile) | What networks provide coverage | |
benefit | S | 1..* | BackboneElement | List of benefits |
type | S | 1..1 | CodeableConcept | Type of benefit |
requirement | S | 0..1 | string | Referral requirements |
limit | S | 0..* | BackboneElement | Benefit limits |
value | S | 0..1 | Quantity | Maximum value allowed |
code | S | 0..1 | CodeableConcept | Benefit limit details |
plan | S | 0..* | BackboneElement | Cost sharing details for the plan |
identifier | S | 0..* | Identifier | Business Identifier for Product |
extension:identifier-status | S | 0..1 | IdentifierStatus | NDH Identifier Status |
use | S | 0..1 | code | usual | official | temp | secondary | old (If known) |
type | S | 0..1 | CodeableConcept | Description of identifier |
system | S | 0..1 | uri | The namespace for the identifier value |
value | S | 0..1 | string | The value that is unique |
period | S | 0..1 | Period | Time period when id is/was valid for use |
assigner | S | 0..1 | Reference(NDH Exchange Organization Profile) | Organization that issued id (may be just text) |
type | S | 0..1 | CodeableConcept | Categorization of the cost sharing for the plan |
coverageArea | S | 0..* | Reference(NDH Exchange Location Profile) | Where product applies |
network | S | 0..* | Reference(NDH Exchange Network Profile) | What networks provide coverage |
generalCost | S | 0..* | BackboneElement | Overall costs |
type | S | 0..1 | CodeableConcept | Type of cost |
groupSize | S | 0..1 | positiveInt | Number of enrollees |
cost | S | 0..1 | Money | Cost value |
comment | S | 0..1 | string | Additional cost information |
specificCost | S | 0..* | BackboneElement | Specific costs |
category | S | 1..1 | CodeableConcept | General category of benefit |
benefit | S | 0..* | BackboneElement | Benefits list |
type | S | 1..1 | CodeableConcept | Type of specific benefit |
cost | S | 0..* | BackboneElement | List of the costs |
type | S | 1..1 | CodeableConcept | Type of cost |
applicability | S | 0..1 | CodeableConcept | in-network | out-of-network | other |
qualifiers | S | 0..* | CodeableConcept | Additional information about the cost |
value | S | 0..1 | Quantity | The actual cost value |
Documentation for this format |
Id | Grade | Path(s) | Details | Requirements |
plan-type-is-distinct | error | InsurancePlan | Each InsurancePlan.plan should have a distinct plan.type. : plan.type.coding.code.isDistinct() |
Key Elements View
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
InsurancePlan | C | 0..* | NdhInsurancePlan | Details of a Health Insurance product/plan provided by an organization |
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created |
Slices for extension | 1..* | Extension | Extension Slice: Unordered, Open by value:url | |
usage-restriction | 0..* | Reference(NDH Base Restriction) {c} | Usage Restriction URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-usage-restriction | |
verification-status | S | 1..1 | CodeableConcept | NDH Verification Status URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-verification-status Binding: NDH Verification Status Value Set (extensible) |
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
identifier | SΣC | 0..* | Identifier | Business Identifier for Product |
Slices for extension | 1..* | Extension | Extension Slice: Unordered, Open by value:url | |
identifier-status | S | 1..1 | code | NDH Identifier Status URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-identifier-status Binding: Identifier Status Value Set (required) |
use | ?!SΣ | 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Σ | 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 |
assigner | SΣ | 0..1 | Reference(NDH Exchange Organization Profile) | 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 Value Set (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(NDH Exchange Organization Profile) | Plan issuer |
administeredBy | SΣ | 1..1 | Reference(NDH Exchange Organization Profile) | Product administrator |
coverageArea | SΣ | 0..* | Reference(NDH Exchange Location Profile) | Where product applies |
contact | S | 0..* | BackboneElement | Contact for the product |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
purpose | S | 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 |
use | ?!SΣ | 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 | SΣ | 0..1 | string | Family name (often called 'Surname') |
given | SΣ | 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 | SΣ | 0..* | string | Parts that come before the name This repeating element order: Prefixes appear in the correct order for presenting the name |
suffix | SΣ | 0..* | string | Parts that come after the name This repeating element order: Suffixes appear in the correct order for presenting the name |
period | SΣ | 0..1 | Period | Time period when name was/is in use |
telecom | S | 0..* | ContactPoint | Contact details (telephone, email, etc.) for a contact |
contactpoint-availabletime | S | 0..* | (Complex) | NDH Contactpoint Availabletime URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-contactpoint-availabletime |
via-intermediary | S | 0..1 | Reference(NDH Base PractitionerRole | NDH Base OrganizationAffiliation Profile | NDH Base Location Profile | NDH Base Organization Profile) | NDH Via Intermediary URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-via-intermediary |
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 | ?!SΣ | 0..1 | code | home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required): Use of contact point. |
rank | SΣ | 0..1 | positiveInt | Specify preferred order of use (1 = highest) |
endpoint | S | 0..* | Reference(NDH Exchange Endpoint Profile) | Technical endpoint |
network | S | 0..* | Reference(NDH Exchange Network Profile) | What networks are Included |
coverage | S | 0..* | BackboneElement | Coverage details |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
type | S | 1..1 | CodeableConcept | Type of coverage Binding: NDH Insurance Coverage Type Value Set (extensible) |
network | S | 0..* | Reference(NDH Exchange Network Profile) | What networks provide coverage |
benefit | S | 1..* | BackboneElement | List of benefits |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
type | S | 1..1 | CodeableConcept | Type of benefit Binding: NDH Benefit Type Value Set (extensible) |
requirement | S | 0..1 | string | Referral requirements |
limit | S | 0..* | BackboneElement | Benefit limits |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
value | S | 0..1 | Quantity | Maximum value allowed |
code | S | 0..1 | CodeableConcept | Benefit limit details |
plan | S | 0..* | BackboneElement | Cost sharing details for the plan |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
identifier | SΣ | 0..* | Identifier | Business Identifier for Product |
identifier-status | S | 0..1 | code | NDH Identifier Status URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-identifier-status Binding: Identifier Status Value Set (required) |
use | ?!SΣ | 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Σ | 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 | SΣ | 0..1 | Period | Time period when id is/was valid for use |
assigner | SΣ | 0..1 | Reference(NDH Exchange Organization Profile) | Organization that issued id (may be just text) |
type | S | 0..1 | CodeableConcept | Categorization of the cost sharing for the plan Binding: Insurance Plan Type Value Set (extensible) |
coverageArea | SΣ | 0..* | Reference(NDH Exchange Location Profile) | Where product applies |
network | S | 0..* | Reference(NDH Exchange Network Profile) | What networks provide coverage |
generalCost | S | 0..* | BackboneElement | Overall costs |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
type | S | 0..1 | CodeableConcept | Type of cost |
groupSize | S | 0..1 | positiveInt | Number of enrollees |
cost | S | 0..1 | Money | Cost value |
comment | S | 0..1 | string | Additional cost information |
specificCost | S | 0..* | BackboneElement | Specific costs |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
category | S | 1..1 | CodeableConcept | General category of benefit |
benefit | S | 0..* | BackboneElement | Benefits list |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
type | S | 1..1 | CodeableConcept | Type of specific benefit |
cost | S | 0..* | BackboneElement | List of the costs |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
type | S | 1..1 | CodeableConcept | Type of cost |
applicability | S | 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 | S | 0..* | CodeableConcept | Additional information about the cost |
value | S | 0..1 | Quantity | The actual cost value |
Documentation for this format |
Path | Conformance | ValueSet / Code |
InsurancePlan.identifier.use | required | IdentifierUse |
InsurancePlan.identifier.type | extensible | Identifier Type Codes |
InsurancePlan.status | required | Fixed Value: active |
InsurancePlan.type | extensible | InsuranceProductTypeVS (a valid code from Insurance Product Type Code System) |
InsurancePlan.contact.purpose | extensible | ContactEntityType |
InsurancePlan.contact.name.use | required | NameUse |
InsurancePlan.contact.telecom.system | required | ContactPointSystem |
InsurancePlan.contact.telecom.use | required | ContactPointUse |
InsurancePlan.coverage.type | extensible | NdhCoverageTypeVS |
InsurancePlan.coverage.benefit.type | extensible | NdhBenefitTypeVS |
InsurancePlan.plan.identifier.use | required | IdentifierUse |
InsurancePlan.plan.identifier.type | extensible | Identifier Type Codes |
InsurancePlan.plan.type | extensible | InsurancePlanTypeVS (a valid code from Insurance Plan Type Code System) |
InsurancePlan.plan.specificCost.benefit.cost.applicability | required | BenefitCostApplicability |
Snapshot View
Name | Flags | Card. | Type | Description & Constraints | ||||
---|---|---|---|---|---|---|---|---|
InsurancePlan | C | 0..* | NdhInsurancePlan | Details of a Health Insurance product/plan provided by an organization | ||||
id | Σ | 0..1 | id | Logical id of this artifact | ||||
meta | Σ | 0..1 | Meta | Metadata about the resource | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
versionId | Σ | 0..1 | id | Version specific identifier | ||||
lastUpdated | Σ | 1..1 | instant | When the resource version last changed | ||||
source | Σ | 0..1 | uri | Identifies where the resource comes from | ||||
profile | Σ | 1..1 | canonical(StructureDefinition) | Profiles this resource claims to conform to | ||||
security | Σ | 0..* | Coding | Security Labels applied to this resource Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System. | ||||
tag | Σ | 0..* | Coding | Tags applied to this resource Binding: CommonTags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones". | ||||
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
language | 0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||
text | 0..1 | Narrative | Text summary of the resource, for human interpretation | |||||
contained | 0..* | Resource | Contained, inline Resources | |||||
Slices for extension | 1..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
usage-restriction | 0..* | Reference(NDH Base Restriction) {c} | Usage Restriction URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-usage-restriction | |||||
verification-status | S | 1..1 | CodeableConcept | NDH Verification Status URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-verification-status Binding: NDH Verification Status Value Set (extensible) | ||||
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored | ||||
identifier | SΣC | 0..* | Identifier | Business Identifier for Product | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
Slices for extension | 1..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
identifier-status | S | 1..1 | code | NDH Identifier Status URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-identifier-status Binding: Identifier Status Value Set (required) | ||||
use | ?!SΣ | 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Σ | 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(NDH Exchange Organization Profile) | 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 Value Set (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(NDH Exchange Organization Profile) | Plan issuer | ||||
administeredBy | SΣ | 1..1 | Reference(NDH Exchange Organization Profile) | Product administrator | ||||
coverageArea | SΣ | 0..* | Reference(NDH Exchange Location Profile) | 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 | S | 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 | ?!SΣ | 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 | SΣ | 0..1 | string | Family name (often called 'Surname') | ||||
given | SΣ | 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 | SΣ | 0..* | string | Parts that come before the name This repeating element order: Prefixes appear in the correct order for presenting the name | ||||
suffix | SΣ | 0..* | string | Parts that come after the name This repeating element order: Suffixes appear in the correct order for presenting the name | ||||
period | SΣ | 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 | |||||
Slices for extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
contactpoint-availabletime | S | 0..* | (Complex) | NDH Contactpoint Availabletime URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-contactpoint-availabletime | ||||
via-intermediary | S | 0..1 | Reference(NDH Base PractitionerRole | NDH Base OrganizationAffiliation Profile | NDH Base Location Profile | NDH Base Organization Profile) | NDH Via Intermediary URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-via-intermediary | ||||
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 | ?!SΣ | 0..1 | code | home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required): Use of contact point. | ||||
rank | SΣ | 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(NDH Exchange Endpoint Profile) | Technical endpoint | ||||
network | S | 0..* | Reference(NDH Exchange Network Profile) | What networks are Included | ||||
coverage | S | 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 | S | 1..1 | CodeableConcept | Type of coverage Binding: NDH Insurance Coverage Type Value Set (extensible) | ||||
network | S | 0..* | Reference(NDH Exchange Network Profile) | What networks provide coverage | ||||
benefit | S | 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 | S | 1..1 | CodeableConcept | Type of benefit Binding: NDH Benefit Type Value Set (extensible) | ||||
requirement | S | 0..1 | string | Referral requirements | ||||
limit | S | 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 | S | 0..1 | Quantity | Maximum value allowed | ||||
code | S | 0..1 | CodeableConcept | Benefit limit details | ||||
plan | S | 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 | SΣ | 0..* | Identifier | Business Identifier for Product | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
Slices for extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
identifier-status | S | 0..1 | code | NDH Identifier Status URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-identifier-status Binding: Identifier Status Value Set (required) | ||||
use | ?!SΣ | 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Σ | 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 | SΣ | 0..1 | Period | Time period when id is/was valid for use | ||||
assigner | SΣ | 0..1 | Reference(NDH Exchange Organization Profile) | Organization that issued id (may be just text) | ||||
type | S | 0..1 | CodeableConcept | Categorization of the cost sharing for the plan Binding: Insurance Plan Type Value Set (extensible) | ||||
coverageArea | SΣ | 0..* | Reference(NDH Exchange Location Profile) | Where product applies | ||||
network | S | 0..* | Reference(NDH Exchange Network Profile) | What networks provide coverage | ||||
generalCost | S | 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 | S | 0..1 | CodeableConcept | Type of cost | ||||
groupSize | S | 0..1 | positiveInt | Number of enrollees | ||||
cost | S | 0..1 | Money | Cost value | ||||
comment | S | 0..1 | string | Additional cost information | ||||
specificCost | S | 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 | S | 1..1 | CodeableConcept | General category of benefit | ||||
benefit | S | 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 | S | 1..1 | CodeableConcept | Type of specific benefit | ||||
cost | S | 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 | S | 1..1 | CodeableConcept | Type of cost | ||||
applicability | S | 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 | S | 0..* | CodeableConcept | Additional information about the cost | ||||
value | S | 0..1 | Quantity | The actual cost value | ||||
Documentation for this format |
Path | Conformance | ValueSet / Code | ||||
InsurancePlan.meta.security | extensible | All Security Labels | ||||
InsurancePlan.meta.tag | example | CommonTags | ||||
InsurancePlan.language | preferred | CommonLanguages
| ||||
InsurancePlan.identifier.use | required | IdentifierUse | ||||
InsurancePlan.identifier.type | extensible | Identifier Type Codes | ||||
InsurancePlan.status | required | Fixed Value: active | ||||
InsurancePlan.type | extensible | InsuranceProductTypeVS (a valid code from Insurance Product Type Code System) | ||||
InsurancePlan.contact.purpose | extensible | ContactEntityType | ||||
InsurancePlan.contact.name.use | required | NameUse | ||||
InsurancePlan.contact.telecom.system | required | ContactPointSystem | ||||
InsurancePlan.contact.telecom.use | required | ContactPointUse | ||||
InsurancePlan.coverage.type | extensible | NdhCoverageTypeVS | ||||
InsurancePlan.coverage.benefit.type | extensible | NdhBenefitTypeVS | ||||
InsurancePlan.plan.identifier.use | required | IdentifierUse | ||||
InsurancePlan.plan.identifier.type | extensible | Identifier Type Codes | ||||
InsurancePlan.plan.type | extensible | InsurancePlanTypeVS (a valid code from Insurance Plan Type Code System) | ||||
InsurancePlan.plan.specificCost.benefit.cost.applicability | required | BenefitCostApplicability |
This structure is derived from NdhInsurancePlan
Summary
Mandatory: 2 elements (3 nested mandatory elements)
Must-Support: 61 elements
Structures
This structure refers to these other structures:
Other representations of profile: CSV, Excel, Schematron