Validated Healthcare Directory, published by HL7 International / Patient Administration. This guide is not an authorized publication; it is the continuous build for version 1.0.0 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/HL7/VhDir/ and changes regularly. See the Directory of published versions
| Official URL: http://hl7.org/fhir/uv/vhdir/StructureDefinition/vhdir-insuranceplan | Version: 1.0.0 | |||
| Standards status: Trial-use | Maturity Level: 2 | Computable Name: VhdirInsurancePlan | ||
Copyright/Legal: Used by permission of HL7 International all rights reserved Creative Commons License |
||||
The details of a health insurance product/plan
This profile sets minimum expectations for searching for and fetching information associated with a health insurance product/plan. It identifies which core elements, extensions, vocabularies and value sets SHALL be present in the InsurancePlan resource when using this profile.
Background & Scope
A product 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.
This profile modifies the base InsurancePlan resource in the following manner:
Constrains the cardinality of InsurancePlan.status (1..1), InsurancePlan.ownedBy (1..1), InsurancePlan.administeredBy (1..1), InsurancePlan.contact.name.family (1..1), InsurancePlan.contact.name.given (1..*), InsurancePlan.contact.telecom.system (1..1), and InsurancePlan.contact.telecom.value (1..1)
All references SHALL conform to the appropriate Validated Healthcare Directory Implementation Guide profile
Adds extensions:
Examples:
The following are example uses for the vhdir-insuranceplan profile:
Mandatory Data Elements
The following data-elements are mandatory (i.e data MUST be present). These are presented below in a simple human-readable explanation. The Formal Profile Definition below provides the formal summary, definitions, and terminology requirements.
Each insurancePlan resource must have:
InsurancePlan.statusInsurancePlan.ownedByInsurancePlan.administeredByInsurancePlan.coverage.typeInsurancePlan.coverage.benefit, including a coded type of benefit in InsurancePlan.coverage.benefit.typeInsurancePlan.plan.specificCost.categoryInsurancePlan.plan.specificCost.benefit.typeInsurancePlan.plan.specificCost.benefit.cost.typeUsage:
Description of Profiles, Differentials, Snapshots and how the different presentations work.
| Name | Flags | Card. | Type | Description & Constraints![]() |
|---|---|---|---|---|
![]() |
C | 0..* | InsurancePlan | Details of a Health Insurance product/plan provided by an organization dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources dom-3: 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 dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated dom-5: If a resource is contained in another resource, it SHALL NOT have a security label dom-6: A resource should have narrative for robust management ipn-1: The organization SHALL at least have a name or an idendtifier, and possibly more than one |
![]() ![]() |
?!Σ | 0..1 | uri | A set of rules under which this content was created ele-1: All FHIR elements must have a @value or children |
![]() ![]() |
0..* | Extension | Extension Slice: Unordered, Open by value:url ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | |
![]() ![]() ![]() |
S | 0..* | Reference(VhDir Restriction) | Restriction URL: http://hl7.org/fhir/uv/vhdir/StructureDefinition/usage-restriction ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
![]() ![]() |
?! | 0..* | Extension | Extensions that cannot be ignored ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
![]() ![]() |
SΣC | 0..* | Identifier | Business Identifier for Product ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() |
1..* | Extension | Extension Slice: Unordered, Open by value:url ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | |
![]() ![]() ![]() ![]() |
S | 1..1 | code | Status URL: http://hl7.org/fhir/uv/vhdir/StructureDefinition/identifier-status Binding: VhDir Identifier Status Value Set (required) ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
![]() ![]() ![]() |
?!SΣ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() |
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. ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() |
SΣ | 0..1 | uri | The namespace for the identifier value ele-1: All FHIR elements must have a @value or children Example General: http://www.acme.com/identifiers/patient |
![]() ![]() ![]() |
SΣ | 0..1 | string | The value that is unique ele-1: All FHIR elements must have a @value or children Example General: 123456 |
![]() ![]() ![]() |
SΣ | 0..1 | Period | Time period when id is/was valid for use ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() |
SΣ | 0..1 | Reference(VhDir Organization) | Organization that issued id (may be just text) ele-1: All FHIR elements must have a @value or children |
![]() ![]() |
?!SΣ | 1..1 | code | draft | active | retired | unknown Binding: PublicationStatus (required): The lifecycle status of an artifact. ele-1: All FHIR elements must have a @value or children |
![]() ![]() |
SΣ | 0..* | CodeableConcept | Kind of product Binding: InsurancePlanType (example): Used to categorize the product/plan. ele-1: All FHIR elements must have a @value or children |
![]() ![]() |
SΣC | 0..1 | string | Official name ele-1: All FHIR elements must have a @value or children |
![]() ![]() |
S | 0..* | string | Alternate names ele-1: All FHIR elements must have a @value or children |
![]() ![]() |
S | 0..1 | Period | When the product is available ele-1: All FHIR elements must have a @value or children |
![]() ![]() |
SΣ | 1..1 | Reference(VhDir Organization) | Plan issuer ele-1: All FHIR elements must have a @value or children |
![]() ![]() |
SΣ | 1..1 | Reference(VhDir Organization) | Product administrator ele-1: All FHIR elements must have a @value or children |
![]() ![]() |
SΣ | 0..* | Reference(VhDir Location) | Where product applies ele-1: All FHIR elements must have a @value or children |
![]() ![]() |
S | 0..* | BackboneElement | Contact for the product ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
![]() ![]() ![]() |
S | 0..1 | CodeableConcept | The type of contact Binding: ContactEntityType (extensible): The purpose for which you would contact a contact party. ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() |
S | 0..1 | HumanName | A name associated with the contact ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() ![]() |
?!SΣ | 0..1 | code | usual | official | temp | nickname | anonymous | old | maiden Binding: NameUse (required): The use of a human name. ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() ![]() |
SΣ | 0..1 | string | Text representation of the full name ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() ![]() |
SΣ | 1..1 | string | Family name (often called 'Surname') ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() ![]() |
SΣ | 1..* | string | Given names (not always 'first'). Includes middle names ele-1: All FHIR elements must have a @value or children This repeating element order: Given Names appear in the correct order for presenting the name |
![]() ![]() ![]() ![]() |
SΣ | 0..* | string | Parts that come before the name ele-1: All FHIR elements must have a @value or children This repeating element order: Prefixes appear in the correct order for presenting the name |
![]() ![]() ![]() ![]() |
SΣ | 0..* | string | Parts that come after the name ele-1: All FHIR elements must have a @value or children This repeating element order: Suffixes appear in the correct order for presenting the name |
![]() ![]() ![]() ![]() |
SΣ | 0..1 | Period | Time period when name was/is in use ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() |
S | 0..* | ContactPoint | Contact details (telephone, email, etc.) for a contact ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() ![]() |
0..* | Extension | Extension Slice: Unordered, Open by value:url ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | |
![]() ![]() ![]() ![]() ![]() |
S | 0..1 | Reference(VhDir Practitioner Role | VhDir Organization | VhDir Organization Affiliation | VhDir Location) | viaintermediary URL: http://hl7.org/fhir/uv/vhdir/StructureDefinition/contactpoint-viaintermediary ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
![]() ![]() ![]() ![]() ![]() |
S | 0..* | (Complex) | Available time URL: http://hl7.org/fhir/uv/vhdir/StructureDefinition/contactpoint-availabletime ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
![]() ![]() ![]() ![]() |
SΣC | 1..1 | code | phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point. ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() ![]() |
SΣ | 1..1 | string | The actual contact point details ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() ![]() |
?!SΣ | 0..1 | code | home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required): Use of contact point. ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() ![]() |
SΣ | 0..1 | positiveInt | Specify preferred order of use (1 = highest) ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() ![]() |
SΣ | 0..1 | Period | Time period when the contact point was/is in use ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() |
S | 0..1 | Address | Visiting or postal addresses for the contact ele-1: All FHIR elements must have a @value or children |
![]() ![]() |
S | 0..* | Reference(VhDir Endpoint) | Technical endpoint ele-1: All FHIR elements must have a @value or children |
![]() ![]() |
S | 0..* | Reference(VhDir Network) | What networks are Included ele-1: All FHIR elements must have a @value or children |
![]() ![]() |
S | 0..* | BackboneElement | Coverage details ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
![]() ![]() ![]() |
S | 1..1 | CodeableConcept | Type of coverage Binding: VhDir Coverage Type (example) ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() |
S | 0..* | Reference(VhDir Network) | What networks provide coverage ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() |
S | 1..* | BackboneElement | List of benefits ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
![]() ![]() ![]() ![]() |
S | 1..1 | CodeableConcept | Type of benefit Binding: VhDir Benefit Type (example) ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() ![]() |
S | 0..1 | string | Referral requirements ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() ![]() |
S | 0..* | BackboneElement | Benefit limits ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
![]() ![]() ![]() ![]() ![]() |
S | 0..1 | Quantity | Maximum value allowed ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() ![]() ![]() |
S | 0..1 | CodeableConcept | Benefit limit details Binding: VhDir Limit Unit (example) ele-1: All FHIR elements must have a @value or children |
![]() ![]() |
S | 0..* | BackboneElement | Plan details ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
![]() ![]() ![]() |
SΣ | 0..* | Identifier | Business identifier for plan ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() ![]() |
0..* | Extension | Extension Slice: Unordered, Open by value:url ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | |
![]() ![]() ![]() ![]() ![]() |
S | 0..1 | code | Status URL: http://hl7.org/fhir/uv/vhdir/StructureDefinition/identifier-status Binding: VhDir Identifier Status Value Set (required) ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
![]() ![]() ![]() ![]() |
?!SΣ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() ![]() |
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. ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() ![]() |
SΣ | 0..1 | uri | The namespace for the identifier value ele-1: All FHIR elements must have a @value or children Example General: http://www.acme.com/identifiers/patient |
![]() ![]() ![]() ![]() |
SΣ | 0..1 | string | The value that is unique ele-1: All FHIR elements must have a @value or children Example General: 123456 |
![]() ![]() ![]() ![]() |
SΣ | 0..1 | Period | Time period when id is/was valid for use ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() ![]() |
SΣ | 0..1 | Reference(VhDir Organization) | Organization that issued id (may be just text) ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() |
S | 0..1 | CodeableConcept | Type of plan Binding: VhDir Plan Type (example) ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() |
SΣ | 0..* | Reference(VhDir Location) | Where plan applies ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() |
S | 0..* | Reference(VhDir Network) | What networks provide coverage ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() |
S | 0..* | BackboneElement | Overall costs ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
![]() ![]() ![]() ![]() |
S | 0..1 | CodeableConcept | Type of cost Binding: VhDir Insurance Plan Cost Type (example) ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() ![]() |
S | 0..1 | positiveInt | Number of enrollees ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() ![]() |
S | 0..1 | Money | Cost value ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() ![]() |
S | 0..1 | string | Additional cost information ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() |
S | 0..* | BackboneElement | Specific costs ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
![]() ![]() ![]() ![]() |
S | 1..1 | CodeableConcept | General category of benefit Binding: VhDir Insurance Plan Cost Category (example) ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() ![]() |
S | 0..* | BackboneElement | Benefits list ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
![]() ![]() ![]() ![]() ![]() |
S | 1..1 | CodeableConcept | Type of specific benefit Binding: VhDir Insurance Plan Benefit Type (example) ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() ![]() ![]() |
S | 0..* | BackboneElement | List of the costs ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
![]() ![]() ![]() ![]() ![]() ![]() |
S | 1..1 | CodeableConcept | Type of cost Binding: VhDir Insurance Plan Benefit Cost Type (example) ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() ![]() ![]() ![]() |
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. ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() ![]() ![]() ![]() |
S | 0..* | CodeableConcept | Additional information about the cost Binding: VhDir Insurance Plan Cost Qualifier (example) ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() ![]() ![]() ![]() |
S | 0..1 | Quantity | The actual cost value ele-1: All FHIR elements must have a @value or children |
Documentation for this format | ||||
| Path | Conformance | ValueSet | URI |
| InsurancePlan.identifier.use | required | IdentifierUsehttp://hl7.org/fhir/ValueSet/identifier-use|4.0.1from the FHIR Standard | |
| InsurancePlan.identifier.type | extensible | Identifier Type Codeshttp://hl7.org/fhir/ValueSet/identifier-typefrom the FHIR Standard | |
| InsurancePlan.status | required | PublicationStatushttp://hl7.org/fhir/ValueSet/publication-status|4.0.1from the FHIR Standard | |
| InsurancePlan.type | example | InsurancePlanTypehttp://hl7.org/fhir/ValueSet/insuranceplan-typefrom the FHIR Standard | |
| InsurancePlan.contact.purpose | extensible | ContactEntityTypehttp://hl7.org/fhir/ValueSet/contactentity-typefrom the FHIR Standard | |
| InsurancePlan.contact.name.use | required | NameUsehttp://hl7.org/fhir/ValueSet/name-use|4.0.1from the FHIR Standard | |
| InsurancePlan.contact.telecom.system | required | ContactPointSystemhttp://hl7.org/fhir/ValueSet/contact-point-system|4.0.1from the FHIR Standard | |
| InsurancePlan.contact.telecom.use | required | ContactPointUsehttp://hl7.org/fhir/ValueSet/contact-point-use|4.0.1from the FHIR Standard | |
| InsurancePlan.coverage.type | example | VhDirCoverageTypehttp://hl7.org/fhir/uv/vhdir/ValueSet/coverage-typefrom this IG | |
| InsurancePlan.coverage.benefit.type | example | VhDirBenefitTypehttp://hl7.org/fhir/uv/vhdir/ValueSet/benefit-typefrom this IG | |
| InsurancePlan.coverage.benefit.limit.code | example | VhDirLimitUnithttp://hl7.org/fhir/uv/vhdir/ValueSet/limit-unitfrom this IG | |
| InsurancePlan.plan.identifier.use | required | IdentifierUsehttp://hl7.org/fhir/ValueSet/identifier-use|4.0.1from the FHIR Standard | |
| InsurancePlan.plan.identifier.type | extensible | Identifier Type Codeshttp://hl7.org/fhir/ValueSet/identifier-typefrom the FHIR Standard | |
| InsurancePlan.plan.type | example | VhDirPlanTypehttp://hl7.org/fhir/uv/vhdir/ValueSet/plan-typefrom this IG | |
| InsurancePlan.plan.generalCost.type | example | VhDirPlanTypehttp://hl7.org/fhir/uv/vhdir/ValueSet/insuranceplancosttypefrom this IG | |
| InsurancePlan.plan.specificCost.category | example | VhDirInsPlanCostCategoryhttp://hl7.org/fhir/uv/vhdir/ValueSet/insuranceplancostcategoryfrom this IG | |
| InsurancePlan.plan.specificCost.benefit.type | example | VhDirInsPlanBenefitTypehttp://hl7.org/fhir/uv/vhdir/ValueSet/insuranceplanbenefittypefrom this IG | |
| InsurancePlan.plan.specificCost.benefit.cost.type | example | VhDirInsPlanBenefitCostTypehttp://hl7.org/fhir/uv/vhdir/ValueSet/insuranceplanbenefitcosttypefrom this IG | |
| InsurancePlan.plan.specificCost.benefit.cost.applicability | required | BenefitCostApplicabilityhttp://hl7.org/fhir/ValueSet/insuranceplan-applicability|4.0.1from the FHIR Standard | |
| InsurancePlan.plan.specificCost.benefit.cost.qualifiers | example | VhDirInsPlanQualifierhttp://hl7.org/fhir/uv/vhdir/ValueSet/insuranceplancostqualifierfrom this IG |
This structure is derived from InsurancePlan
| Name | Flags | Card. | Type | Description & Constraints![]() |
|---|---|---|---|---|
![]() |
0..* | InsurancePlan | Details of a Health Insurance product/plan provided by an organization | |
![]() ![]() |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |
![]() ![]() ![]() |
S | 0..* | Reference(VhDir Restriction) | Restriction URL: http://hl7.org/fhir/uv/vhdir/StructureDefinition/usage-restriction |
![]() ![]() |
S | 0..* | Identifier | Business Identifier for Product |
![]() ![]() ![]() |
1..* | Extension | Extension Slice: Unordered, Open by value:url | |
![]() ![]() ![]() ![]() |
S | 1..1 | code | Status URL: http://hl7.org/fhir/uv/vhdir/StructureDefinition/identifier-status Binding: VhDir Identifier Status Value Set (required) |
![]() ![]() ![]() |
S | 0..1 | code | usual | official | temp | secondary | old (If known) |
![]() ![]() ![]() |
S | 0..1 | CodeableConcept | Description of identifier |
![]() ![]() ![]() |
S | 0..1 | uri | The namespace for the identifier value |
![]() ![]() ![]() |
S | 0..1 | string | The value that is unique |
![]() ![]() ![]() |
S | 0..1 | Period | Time period when id is/was valid for use |
![]() ![]() ![]() |
S | 0..1 | Reference(VhDir Organization) | Organization that issued id (may be just text) |
![]() ![]() |
S | 1..1 | code | draft | active | retired | unknown |
![]() ![]() |
S | 0..* | CodeableConcept | Kind of product |
![]() ![]() |
S | 0..1 | string | Official name |
![]() ![]() |
S | 0..* | string | Alternate names |
![]() ![]() |
S | 0..1 | Period | When the product is available |
![]() ![]() |
S | 1..1 | Reference(VhDir Organization) | Plan issuer |
![]() ![]() |
S | 1..1 | Reference(VhDir Organization) | Product administrator |
![]() ![]() |
S | 0..* | Reference(VhDir Location) | Where product applies |
![]() ![]() |
S | 0..* | BackboneElement | Contact for the product |
![]() ![]() ![]() |
S | 0..1 | CodeableConcept | The type of contact |
![]() ![]() ![]() |
S | 0..1 | HumanName | A name associated with the contact |
![]() ![]() ![]() ![]() |
S | 0..1 | code | usual | official | temp | nickname | anonymous | old | maiden |
![]() ![]() ![]() ![]() |
S | 0..1 | string | Text representation of the full name |
![]() ![]() ![]() ![]() |
S | 1..1 | string | Family name (often called 'Surname') |
![]() ![]() ![]() ![]() |
S | 1..* | string | Given names (not always 'first'). Includes middle names |
![]() ![]() ![]() ![]() |
S | 0..* | string | Parts that come before the name |
![]() ![]() ![]() ![]() |
S | 0..* | string | Parts that come after the name |
![]() ![]() ![]() ![]() |
S | 0..1 | Period | Time period when name was/is in use |
![]() ![]() ![]() |
S | 0..* | ContactPoint | Contact details (telephone, email, etc.) for a contact |
![]() ![]() ![]() ![]() |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |
![]() ![]() ![]() ![]() ![]() |
S | 0..1 | Reference(VhDir Practitioner Role | VhDir Organization | VhDir Organization Affiliation | VhDir Location) | viaintermediary URL: http://hl7.org/fhir/uv/vhdir/StructureDefinition/contactpoint-viaintermediary |
![]() ![]() ![]() ![]() ![]() |
S | 0..* | (Complex) | Available time URL: http://hl7.org/fhir/uv/vhdir/StructureDefinition/contactpoint-availabletime |
![]() ![]() ![]() ![]() |
S | 1..1 | code | phone | fax | email | pager | url | sms | other |
![]() ![]() ![]() ![]() |
S | 1..1 | string | The actual contact point details |
![]() ![]() ![]() ![]() |
S | 0..1 | code | home | work | temp | old | mobile - purpose of this contact point |
![]() ![]() ![]() ![]() |
S | 0..1 | positiveInt | Specify preferred order of use (1 = highest) |
![]() ![]() ![]() ![]() |
S | 0..1 | Period | Time period when the contact point was/is in use |
![]() ![]() ![]() |
S | 0..1 | Address | Visiting or postal addresses for the contact |
![]() ![]() |
S | 0..* | Reference(VhDir Endpoint) | Technical endpoint |
![]() ![]() |
S | 0..* | Reference(VhDir Network) | What networks are Included |
![]() ![]() |
S | 0..* | BackboneElement | Coverage details |
![]() ![]() ![]() |
S | 1..1 | CodeableConcept | Type of coverage Binding: VhDir Coverage Type (example) |
![]() ![]() ![]() |
S | 0..* | Reference(VhDir Network) | What networks provide coverage |
![]() ![]() ![]() |
S | 1..* | BackboneElement | List of benefits |
![]() ![]() ![]() ![]() |
S | 1..1 | CodeableConcept | Type of benefit Binding: VhDir Benefit Type (example) |
![]() ![]() ![]() ![]() |
S | 0..1 | string | Referral requirements |
![]() ![]() ![]() ![]() |
S | 0..* | BackboneElement | Benefit limits |
![]() ![]() ![]() ![]() ![]() |
S | 0..1 | Quantity | Maximum value allowed |
![]() ![]() ![]() ![]() ![]() |
S | 0..1 | CodeableConcept | Benefit limit details Binding: VhDir Limit Unit (example) |
![]() ![]() |
S | 0..* | BackboneElement | Plan details |
![]() ![]() ![]() |
S | 0..* | Identifier | Business identifier for plan |
![]() ![]() ![]() ![]() |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |
![]() ![]() ![]() ![]() ![]() |
S | 0..1 | code | Status URL: http://hl7.org/fhir/uv/vhdir/StructureDefinition/identifier-status Binding: VhDir Identifier Status Value Set (required) |
![]() ![]() ![]() ![]() |
S | 0..1 | code | usual | official | temp | secondary | old (If known) |
![]() ![]() ![]() ![]() |
S | 0..1 | CodeableConcept | Description of identifier |
![]() ![]() ![]() ![]() |
S | 0..1 | uri | The namespace for the identifier value |
![]() ![]() ![]() ![]() |
S | 0..1 | string | The value that is unique |
![]() ![]() ![]() ![]() |
S | 0..1 | Period | Time period when id is/was valid for use |
![]() ![]() ![]() ![]() |
S | 0..1 | Reference(VhDir Organization) | Organization that issued id (may be just text) |
![]() ![]() ![]() |
S | 0..1 | CodeableConcept | Type of plan Binding: VhDir Plan Type (example) |
![]() ![]() ![]() |
S | 0..* | Reference(VhDir Location) | Where plan applies |
![]() ![]() ![]() |
S | 0..* | Reference(VhDir Network) | What networks provide coverage |
![]() ![]() ![]() |
S | 0..* | BackboneElement | Overall costs |
![]() ![]() ![]() ![]() |
S | 0..1 | CodeableConcept | Type of cost Binding: VhDir Insurance Plan Cost Type (example) |
![]() ![]() ![]() ![]() |
S | 0..1 | positiveInt | Number of enrollees |
![]() ![]() ![]() ![]() |
S | 0..1 | Money | Cost value |
![]() ![]() ![]() ![]() |
S | 0..1 | string | Additional cost information |
![]() ![]() ![]() |
S | 0..* | BackboneElement | Specific costs |
![]() ![]() ![]() ![]() |
S | 1..1 | CodeableConcept | General category of benefit Binding: VhDir Insurance Plan Cost Category (example) |
![]() ![]() ![]() ![]() |
S | 0..* | BackboneElement | Benefits list |
![]() ![]() ![]() ![]() ![]() |
S | 1..1 | CodeableConcept | Type of specific benefit Binding: VhDir Insurance Plan Benefit Type (example) |
![]() ![]() ![]() ![]() ![]() |
S | 0..* | BackboneElement | List of the costs |
![]() ![]() ![]() ![]() ![]() ![]() |
S | 1..1 | CodeableConcept | Type of cost Binding: VhDir Insurance Plan Benefit Cost Type (example) |
![]() ![]() ![]() ![]() ![]() ![]() |
S | 0..1 | CodeableConcept | in-network | out-of-network | other |
![]() ![]() ![]() ![]() ![]() ![]() |
S | 0..* | CodeableConcept | Additional information about the cost Binding: VhDir Insurance Plan Cost Qualifier (example) |
![]() ![]() ![]() ![]() ![]() ![]() |
S | 0..1 | Quantity | The actual cost value |
Documentation for this format | ||||
| Path | Conformance | ValueSet | URI |
| InsurancePlan.coverage.type | example | VhDirCoverageTypehttp://hl7.org/fhir/uv/vhdir/ValueSet/coverage-typefrom this IG | |
| InsurancePlan.coverage.benefit.type | example | VhDirBenefitTypehttp://hl7.org/fhir/uv/vhdir/ValueSet/benefit-typefrom this IG | |
| InsurancePlan.coverage.benefit.limit.code | example | VhDirLimitUnithttp://hl7.org/fhir/uv/vhdir/ValueSet/limit-unitfrom this IG | |
| InsurancePlan.plan.type | example | VhDirPlanTypehttp://hl7.org/fhir/uv/vhdir/ValueSet/plan-typefrom this IG | |
| InsurancePlan.plan.generalCost.type | example | VhDirPlanTypehttp://hl7.org/fhir/uv/vhdir/ValueSet/insuranceplancosttypefrom this IG | |
| InsurancePlan.plan.specificCost.category | example | VhDirInsPlanCostCategoryhttp://hl7.org/fhir/uv/vhdir/ValueSet/insuranceplancostcategoryfrom this IG | |
| InsurancePlan.plan.specificCost.benefit.type | example | VhDirInsPlanBenefitTypehttp://hl7.org/fhir/uv/vhdir/ValueSet/insuranceplanbenefittypefrom this IG | |
| InsurancePlan.plan.specificCost.benefit.cost.type | example | VhDirInsPlanBenefitCostTypehttp://hl7.org/fhir/uv/vhdir/ValueSet/insuranceplanbenefitcosttypefrom this IG | |
| InsurancePlan.plan.specificCost.benefit.cost.qualifiers | example | VhDirInsPlanQualifierhttp://hl7.org/fhir/uv/vhdir/ValueSet/insuranceplancostqualifierfrom this IG |
| Name | Flags | Card. | Type | Description & Constraints![]() | ||||
|---|---|---|---|---|---|---|---|---|
![]() |
C | 0..* | InsurancePlan | Details of a Health Insurance product/plan provided by an organization ipn-1: The organization SHALL at least have a name or an idendtifier, and possibly more than one | ||||
![]() ![]() |
Σ | 0..1 | id | Logical id of this artifact | ||||
![]() ![]() |
Σ | 0..1 | Meta | Metadata about the resource | ||||
![]() ![]() |
?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
![]() ![]() |
0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||
![]() ![]() |
0..1 | Narrative | Text summary of the resource, for human interpretation | |||||
![]() ![]() |
0..* | Resource | Contained, inline Resources | |||||
![]() ![]() |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() |
S | 0..* | Reference(VhDir Restriction) | Restriction URL: http://hl7.org/fhir/uv/vhdir/StructureDefinition/usage-restriction | ||||
![]() ![]() |
?! | 0..* | Extension | Extensions that cannot be ignored | ||||
![]() ![]() |
SΣC | 0..* | Identifier | Business Identifier for Product | ||||
![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() |
1..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() |
S | 1..1 | code | Status URL: http://hl7.org/fhir/uv/vhdir/StructureDefinition/identifier-status Binding: VhDir Identifier Status Value Set (required) | ||||
![]() ![]() ![]() |
?!SΣ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . | ||||
![]() ![]() ![]() |
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. | ||||
![]() ![]() ![]() |
SΣ | 0..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient | ||||
![]() ![]() ![]() |
SΣ | 0..1 | string | The value that is unique Example General: 123456 | ||||
![]() ![]() ![]() |
SΣ | 0..1 | Period | Time period when id is/was valid for use | ||||
![]() ![]() ![]() |
SΣ | 0..1 | Reference(VhDir Organization) | Organization that issued id (may be just text) | ||||
![]() ![]() |
?!SΣ | 1..1 | code | draft | active | retired | unknown Binding: PublicationStatus (required): The lifecycle status of an artifact. | ||||
![]() ![]() |
SΣ | 0..* | CodeableConcept | Kind of product Binding: InsurancePlanType (example): Used to categorize the product/plan. | ||||
![]() ![]() |
SΣC | 0..1 | string | Official name | ||||
![]() ![]() |
S | 0..* | string | Alternate names | ||||
![]() ![]() |
S | 0..1 | Period | When the product is available | ||||
![]() ![]() |
SΣ | 1..1 | Reference(VhDir Organization) | Plan issuer | ||||
![]() ![]() |
SΣ | 1..1 | Reference(VhDir Organization) | Product administrator | ||||
![]() ![]() |
SΣ | 0..* | Reference(VhDir Location) | Where product applies | ||||
![]() ![]() |
S | 0..* | BackboneElement | Contact for the product | ||||
![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() |
S | 0..1 | CodeableConcept | The type of contact Binding: ContactEntityType (extensible): The purpose for which you would contact a contact party. | ||||
![]() ![]() ![]() |
S | 0..1 | HumanName | A name associated with the contact | ||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() |
?!SΣ | 0..1 | code | usual | official | temp | nickname | anonymous | old | maiden Binding: NameUse (required): The use of a human name. | ||||
![]() ![]() ![]() ![]() |
SΣ | 0..1 | string | Text representation of the full name | ||||
![]() ![]() ![]() ![]() |
SΣ | 1..1 | string | Family name (often called 'Surname') | ||||
![]() ![]() ![]() ![]() |
SΣ | 1..* | string | Given names (not always 'first'). Includes middle names This repeating element order: Given Names appear in the correct order for presenting the name | ||||
![]() ![]() ![]() ![]() |
SΣ | 0..* | string | Parts that come before the name This repeating element order: Prefixes appear in the correct order for presenting the name | ||||
![]() ![]() ![]() ![]() |
SΣ | 0..* | string | Parts that come after the name This repeating element order: Suffixes appear in the correct order for presenting the name | ||||
![]() ![]() ![]() ![]() |
SΣ | 0..1 | Period | Time period when name was/is in use | ||||
![]() ![]() ![]() |
S | 0..* | ContactPoint | Contact details (telephone, email, etc.) for a contact | ||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() ![]() |
S | 0..1 | Reference(VhDir Practitioner Role | VhDir Organization | VhDir Organization Affiliation | VhDir Location) | viaintermediary URL: http://hl7.org/fhir/uv/vhdir/StructureDefinition/contactpoint-viaintermediary | ||||
![]() ![]() ![]() ![]() ![]() |
S | 0..* | (Complex) | Available time URL: http://hl7.org/fhir/uv/vhdir/StructureDefinition/contactpoint-availabletime | ||||
![]() ![]() ![]() ![]() |
SΣC | 1..1 | code | phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point. | ||||
![]() ![]() ![]() ![]() |
SΣ | 1..1 | string | The actual contact point details | ||||
![]() ![]() ![]() ![]() |
?!SΣ | 0..1 | code | home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required): Use of contact point. | ||||
![]() ![]() ![]() ![]() |
SΣ | 0..1 | positiveInt | Specify preferred order of use (1 = highest) | ||||
![]() ![]() ![]() ![]() |
SΣ | 0..1 | Period | Time period when the contact point was/is in use | ||||
![]() ![]() ![]() |
S | 0..1 | Address | Visiting or postal addresses for the contact | ||||
![]() ![]() |
S | 0..* | Reference(VhDir Endpoint) | Technical endpoint | ||||
![]() ![]() |
S | 0..* | Reference(VhDir Network) | What networks are Included | ||||
![]() ![]() |
S | 0..* | BackboneElement | Coverage details | ||||
![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() |
S | 1..1 | CodeableConcept | Type of coverage Binding: VhDir Coverage Type (example) | ||||
![]() ![]() ![]() |
S | 0..* | Reference(VhDir Network) | What networks provide coverage | ||||
![]() ![]() ![]() |
S | 1..* | BackboneElement | List of benefits | ||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() ![]() |
S | 1..1 | CodeableConcept | Type of benefit Binding: VhDir Benefit Type (example) | ||||
![]() ![]() ![]() ![]() |
S | 0..1 | string | Referral requirements | ||||
![]() ![]() ![]() ![]() |
S | 0..* | BackboneElement | Benefit limits | ||||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() ![]() ![]() |
S | 0..1 | Quantity | Maximum value allowed | ||||
![]() ![]() ![]() ![]() ![]() |
S | 0..1 | CodeableConcept | Benefit limit details Binding: VhDir Limit Unit (example) | ||||
![]() ![]() |
S | 0..* | BackboneElement | Plan details | ||||
![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() |
SΣ | 0..* | Identifier | Business identifier for plan | ||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() ![]() |
S | 0..1 | code | Status URL: http://hl7.org/fhir/uv/vhdir/StructureDefinition/identifier-status Binding: VhDir Identifier Status Value Set (required) | ||||
![]() ![]() ![]() ![]() |
?!SΣ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . | ||||
![]() ![]() ![]() ![]() |
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. | ||||
![]() ![]() ![]() ![]() |
SΣ | 0..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient | ||||
![]() ![]() ![]() ![]() |
SΣ | 0..1 | string | The value that is unique Example General: 123456 | ||||
![]() ![]() ![]() ![]() |
SΣ | 0..1 | Period | Time period when id is/was valid for use | ||||
![]() ![]() ![]() ![]() |
SΣ | 0..1 | Reference(VhDir Organization) | Organization that issued id (may be just text) | ||||
![]() ![]() ![]() |
S | 0..1 | CodeableConcept | Type of plan Binding: VhDir Plan Type (example) | ||||
![]() ![]() ![]() |
SΣ | 0..* | Reference(VhDir Location) | Where plan applies | ||||
![]() ![]() ![]() |
S | 0..* | Reference(VhDir Network) | What networks provide coverage | ||||
![]() ![]() ![]() |
S | 0..* | BackboneElement | Overall costs | ||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() ![]() |
S | 0..1 | CodeableConcept | Type of cost Binding: VhDir Insurance Plan Cost Type (example) | ||||
![]() ![]() ![]() ![]() |
S | 0..1 | positiveInt | Number of enrollees | ||||
![]() ![]() ![]() ![]() |
S | 0..1 | Money | Cost value | ||||
![]() ![]() ![]() ![]() |
S | 0..1 | string | Additional cost information | ||||
![]() ![]() ![]() |
S | 0..* | BackboneElement | Specific costs | ||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() ![]() |
S | 1..1 | CodeableConcept | General category of benefit Binding: VhDir Insurance Plan Cost Category (example) | ||||
![]() ![]() ![]() ![]() |
S | 0..* | BackboneElement | Benefits list | ||||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() ![]() ![]() |
S | 1..1 | CodeableConcept | Type of specific benefit Binding: VhDir Insurance Plan Benefit Type (example) | ||||
![]() ![]() ![]() ![]() ![]() |
S | 0..* | BackboneElement | List of the costs | ||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() ![]() ![]() ![]() |
S | 1..1 | CodeableConcept | Type of cost Binding: VhDir Insurance Plan Benefit Cost Type (example) | ||||
![]() ![]() ![]() ![]() ![]() ![]() |
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. | ||||
![]() ![]() ![]() ![]() ![]() ![]() |
S | 0..* | CodeableConcept | Additional information about the cost Binding: VhDir Insurance Plan Cost Qualifier (example) | ||||
![]() ![]() ![]() ![]() ![]() ![]() |
S | 0..1 | Quantity | The actual cost value | ||||
Documentation for this format | ||||||||
| Path | Conformance | ValueSet | URI | |||
| InsurancePlan.language | preferred | CommonLanguageshttp://hl7.org/fhir/ValueSet/languagesfrom the FHIR Standard
| ||||
| InsurancePlan.identifier.use | required | IdentifierUsehttp://hl7.org/fhir/ValueSet/identifier-use|4.0.1from the FHIR Standard | ||||
| InsurancePlan.identifier.type | extensible | Identifier Type Codeshttp://hl7.org/fhir/ValueSet/identifier-typefrom the FHIR Standard | ||||
| InsurancePlan.status | required | PublicationStatushttp://hl7.org/fhir/ValueSet/publication-status|4.0.1from the FHIR Standard | ||||
| InsurancePlan.type | example | InsurancePlanTypehttp://hl7.org/fhir/ValueSet/insuranceplan-typefrom the FHIR Standard | ||||
| InsurancePlan.contact.purpose | extensible | ContactEntityTypehttp://hl7.org/fhir/ValueSet/contactentity-typefrom the FHIR Standard | ||||
| InsurancePlan.contact.name.use | required | NameUsehttp://hl7.org/fhir/ValueSet/name-use|4.0.1from the FHIR Standard | ||||
| InsurancePlan.contact.telecom.system | required | ContactPointSystemhttp://hl7.org/fhir/ValueSet/contact-point-system|4.0.1from the FHIR Standard | ||||
| InsurancePlan.contact.telecom.use | required | ContactPointUsehttp://hl7.org/fhir/ValueSet/contact-point-use|4.0.1from the FHIR Standard | ||||
| InsurancePlan.coverage.type | example | VhDirCoverageTypehttp://hl7.org/fhir/uv/vhdir/ValueSet/coverage-typefrom this IG | ||||
| InsurancePlan.coverage.benefit.type | example | VhDirBenefitTypehttp://hl7.org/fhir/uv/vhdir/ValueSet/benefit-typefrom this IG | ||||
| InsurancePlan.coverage.benefit.limit.code | example | VhDirLimitUnithttp://hl7.org/fhir/uv/vhdir/ValueSet/limit-unitfrom this IG | ||||
| InsurancePlan.plan.identifier.use | required | IdentifierUsehttp://hl7.org/fhir/ValueSet/identifier-use|4.0.1from the FHIR Standard | ||||
| InsurancePlan.plan.identifier.type | extensible | Identifier Type Codeshttp://hl7.org/fhir/ValueSet/identifier-typefrom the FHIR Standard | ||||
| InsurancePlan.plan.type | example | VhDirPlanTypehttp://hl7.org/fhir/uv/vhdir/ValueSet/plan-typefrom this IG | ||||
| InsurancePlan.plan.generalCost.type | example | VhDirPlanTypehttp://hl7.org/fhir/uv/vhdir/ValueSet/insuranceplancosttypefrom this IG | ||||
| InsurancePlan.plan.specificCost.category | example | VhDirInsPlanCostCategoryhttp://hl7.org/fhir/uv/vhdir/ValueSet/insuranceplancostcategoryfrom this IG | ||||
| InsurancePlan.plan.specificCost.benefit.type | example | VhDirInsPlanBenefitTypehttp://hl7.org/fhir/uv/vhdir/ValueSet/insuranceplanbenefittypefrom this IG | ||||
| InsurancePlan.plan.specificCost.benefit.cost.type | example | VhDirInsPlanBenefitCostTypehttp://hl7.org/fhir/uv/vhdir/ValueSet/insuranceplanbenefitcosttypefrom this IG | ||||
| InsurancePlan.plan.specificCost.benefit.cost.applicability | required | BenefitCostApplicabilityhttp://hl7.org/fhir/ValueSet/insuranceplan-applicability|4.0.1from the FHIR Standard | ||||
| InsurancePlan.plan.specificCost.benefit.cost.qualifiers | example | VhDirInsPlanQualifierhttp://hl7.org/fhir/uv/vhdir/ValueSet/insuranceplancostqualifierfrom this IG |
This structure is derived from InsurancePlan
Summary
Mandatory: 3 elements(6 nested mandatory elements)
Must-Support: 73 elements
Structures
This structure refers to these other structures:
Extensions
This structure refers to these extensions:
Maturity: 2
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints![]() |
|---|---|---|---|---|
![]() |
C | 0..* | InsurancePlan | Details of a Health Insurance product/plan provided by an organization dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources dom-3: 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 dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated dom-5: If a resource is contained in another resource, it SHALL NOT have a security label dom-6: A resource should have narrative for robust management ipn-1: The organization SHALL at least have a name or an idendtifier, and possibly more than one |
![]() ![]() |
?!Σ | 0..1 | uri | A set of rules under which this content was created ele-1: All FHIR elements must have a @value or children |
![]() ![]() |
0..* | Extension | Extension Slice: Unordered, Open by value:url ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | |
![]() ![]() ![]() |
S | 0..* | Reference(VhDir Restriction) | Restriction URL: http://hl7.org/fhir/uv/vhdir/StructureDefinition/usage-restriction ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
![]() ![]() |
?! | 0..* | Extension | Extensions that cannot be ignored ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
![]() ![]() |
SΣC | 0..* | Identifier | Business Identifier for Product ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() |
1..* | Extension | Extension Slice: Unordered, Open by value:url ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | |
![]() ![]() ![]() ![]() |
S | 1..1 | code | Status URL: http://hl7.org/fhir/uv/vhdir/StructureDefinition/identifier-status Binding: VhDir Identifier Status Value Set (required) ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
![]() ![]() ![]() |
?!SΣ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() |
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. ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() |
SΣ | 0..1 | uri | The namespace for the identifier value ele-1: All FHIR elements must have a @value or children Example General: http://www.acme.com/identifiers/patient |
![]() ![]() ![]() |
SΣ | 0..1 | string | The value that is unique ele-1: All FHIR elements must have a @value or children Example General: 123456 |
![]() ![]() ![]() |
SΣ | 0..1 | Period | Time period when id is/was valid for use ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() |
SΣ | 0..1 | Reference(VhDir Organization) | Organization that issued id (may be just text) ele-1: All FHIR elements must have a @value or children |
![]() ![]() |
?!SΣ | 1..1 | code | draft | active | retired | unknown Binding: PublicationStatus (required): The lifecycle status of an artifact. ele-1: All FHIR elements must have a @value or children |
![]() ![]() |
SΣ | 0..* | CodeableConcept | Kind of product Binding: InsurancePlanType (example): Used to categorize the product/plan. ele-1: All FHIR elements must have a @value or children |
![]() ![]() |
SΣC | 0..1 | string | Official name ele-1: All FHIR elements must have a @value or children |
![]() ![]() |
S | 0..* | string | Alternate names ele-1: All FHIR elements must have a @value or children |
![]() ![]() |
S | 0..1 | Period | When the product is available ele-1: All FHIR elements must have a @value or children |
![]() ![]() |
SΣ | 1..1 | Reference(VhDir Organization) | Plan issuer ele-1: All FHIR elements must have a @value or children |
![]() ![]() |
SΣ | 1..1 | Reference(VhDir Organization) | Product administrator ele-1: All FHIR elements must have a @value or children |
![]() ![]() |
SΣ | 0..* | Reference(VhDir Location) | Where product applies ele-1: All FHIR elements must have a @value or children |
![]() ![]() |
S | 0..* | BackboneElement | Contact for the product ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
![]() ![]() ![]() |
S | 0..1 | CodeableConcept | The type of contact Binding: ContactEntityType (extensible): The purpose for which you would contact a contact party. ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() |
S | 0..1 | HumanName | A name associated with the contact ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() ![]() |
?!SΣ | 0..1 | code | usual | official | temp | nickname | anonymous | old | maiden Binding: NameUse (required): The use of a human name. ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() ![]() |
SΣ | 0..1 | string | Text representation of the full name ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() ![]() |
SΣ | 1..1 | string | Family name (often called 'Surname') ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() ![]() |
SΣ | 1..* | string | Given names (not always 'first'). Includes middle names ele-1: All FHIR elements must have a @value or children This repeating element order: Given Names appear in the correct order for presenting the name |
![]() ![]() ![]() ![]() |
SΣ | 0..* | string | Parts that come before the name ele-1: All FHIR elements must have a @value or children This repeating element order: Prefixes appear in the correct order for presenting the name |
![]() ![]() ![]() ![]() |
SΣ | 0..* | string | Parts that come after the name ele-1: All FHIR elements must have a @value or children This repeating element order: Suffixes appear in the correct order for presenting the name |
![]() ![]() ![]() ![]() |
SΣ | 0..1 | Period | Time period when name was/is in use ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() |
S | 0..* | ContactPoint | Contact details (telephone, email, etc.) for a contact ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() ![]() |
0..* | Extension | Extension Slice: Unordered, Open by value:url ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | |
![]() ![]() ![]() ![]() ![]() |
S | 0..1 | Reference(VhDir Practitioner Role | VhDir Organization | VhDir Organization Affiliation | VhDir Location) | viaintermediary URL: http://hl7.org/fhir/uv/vhdir/StructureDefinition/contactpoint-viaintermediary ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
![]() ![]() ![]() ![]() ![]() |
S | 0..* | (Complex) | Available time URL: http://hl7.org/fhir/uv/vhdir/StructureDefinition/contactpoint-availabletime ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
![]() ![]() ![]() ![]() |
SΣC | 1..1 | code | phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point. ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() ![]() |
SΣ | 1..1 | string | The actual contact point details ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() ![]() |
?!SΣ | 0..1 | code | home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required): Use of contact point. ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() ![]() |
SΣ | 0..1 | positiveInt | Specify preferred order of use (1 = highest) ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() ![]() |
SΣ | 0..1 | Period | Time period when the contact point was/is in use ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() |
S | 0..1 | Address | Visiting or postal addresses for the contact ele-1: All FHIR elements must have a @value or children |
![]() ![]() |
S | 0..* | Reference(VhDir Endpoint) | Technical endpoint ele-1: All FHIR elements must have a @value or children |
![]() ![]() |
S | 0..* | Reference(VhDir Network) | What networks are Included ele-1: All FHIR elements must have a @value or children |
![]() ![]() |
S | 0..* | BackboneElement | Coverage details ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
![]() ![]() ![]() |
S | 1..1 | CodeableConcept | Type of coverage Binding: VhDir Coverage Type (example) ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() |
S | 0..* | Reference(VhDir Network) | What networks provide coverage ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() |
S | 1..* | BackboneElement | List of benefits ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
![]() ![]() ![]() ![]() |
S | 1..1 | CodeableConcept | Type of benefit Binding: VhDir Benefit Type (example) ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() ![]() |
S | 0..1 | string | Referral requirements ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() ![]() |
S | 0..* | BackboneElement | Benefit limits ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
![]() ![]() ![]() ![]() ![]() |
S | 0..1 | Quantity | Maximum value allowed ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() ![]() ![]() |
S | 0..1 | CodeableConcept | Benefit limit details Binding: VhDir Limit Unit (example) ele-1: All FHIR elements must have a @value or children |
![]() ![]() |
S | 0..* | BackboneElement | Plan details ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
![]() ![]() ![]() |
SΣ | 0..* | Identifier | Business identifier for plan ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() ![]() |
0..* | Extension | Extension Slice: Unordered, Open by value:url ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | |
![]() ![]() ![]() ![]() ![]() |
S | 0..1 | code | Status URL: http://hl7.org/fhir/uv/vhdir/StructureDefinition/identifier-status Binding: VhDir Identifier Status Value Set (required) ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
![]() ![]() ![]() ![]() |
?!SΣ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() ![]() |
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. ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() ![]() |
SΣ | 0..1 | uri | The namespace for the identifier value ele-1: All FHIR elements must have a @value or children Example General: http://www.acme.com/identifiers/patient |
![]() ![]() ![]() ![]() |
SΣ | 0..1 | string | The value that is unique ele-1: All FHIR elements must have a @value or children Example General: 123456 |
![]() ![]() ![]() ![]() |
SΣ | 0..1 | Period | Time period when id is/was valid for use ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() ![]() |
SΣ | 0..1 | Reference(VhDir Organization) | Organization that issued id (may be just text) ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() |
S | 0..1 | CodeableConcept | Type of plan Binding: VhDir Plan Type (example) ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() |
SΣ | 0..* | Reference(VhDir Location) | Where plan applies ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() |
S | 0..* | Reference(VhDir Network) | What networks provide coverage ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() |
S | 0..* | BackboneElement | Overall costs ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
![]() ![]() ![]() ![]() |
S | 0..1 | CodeableConcept | Type of cost Binding: VhDir Insurance Plan Cost Type (example) ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() ![]() |
S | 0..1 | positiveInt | Number of enrollees ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() ![]() |
S | 0..1 | Money | Cost value ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() ![]() |
S | 0..1 | string | Additional cost information ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() |
S | 0..* | BackboneElement | Specific costs ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
![]() ![]() ![]() ![]() |
S | 1..1 | CodeableConcept | General category of benefit Binding: VhDir Insurance Plan Cost Category (example) ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() ![]() |
S | 0..* | BackboneElement | Benefits list ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
![]() ![]() ![]() ![]() ![]() |
S | 1..1 | CodeableConcept | Type of specific benefit Binding: VhDir Insurance Plan Benefit Type (example) ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() ![]() ![]() |
S | 0..* | BackboneElement | List of the costs ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
![]() ![]() ![]() ![]() ![]() ![]() |
S | 1..1 | CodeableConcept | Type of cost Binding: VhDir Insurance Plan Benefit Cost Type (example) ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() ![]() ![]() ![]() |
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. ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() ![]() ![]() ![]() |
S | 0..* | CodeableConcept | Additional information about the cost Binding: VhDir Insurance Plan Cost Qualifier (example) ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() ![]() ![]() ![]() |
S | 0..1 | Quantity | The actual cost value ele-1: All FHIR elements must have a @value or children |
Documentation for this format | ||||
| Path | Conformance | ValueSet | URI |
| InsurancePlan.identifier.use | required | IdentifierUsehttp://hl7.org/fhir/ValueSet/identifier-use|4.0.1from the FHIR Standard | |
| InsurancePlan.identifier.type | extensible | Identifier Type Codeshttp://hl7.org/fhir/ValueSet/identifier-typefrom the FHIR Standard | |
| InsurancePlan.status | required | PublicationStatushttp://hl7.org/fhir/ValueSet/publication-status|4.0.1from the FHIR Standard | |
| InsurancePlan.type | example | InsurancePlanTypehttp://hl7.org/fhir/ValueSet/insuranceplan-typefrom the FHIR Standard | |
| InsurancePlan.contact.purpose | extensible | ContactEntityTypehttp://hl7.org/fhir/ValueSet/contactentity-typefrom the FHIR Standard | |
| InsurancePlan.contact.name.use | required | NameUsehttp://hl7.org/fhir/ValueSet/name-use|4.0.1from the FHIR Standard | |
| InsurancePlan.contact.telecom.system | required | ContactPointSystemhttp://hl7.org/fhir/ValueSet/contact-point-system|4.0.1from the FHIR Standard | |
| InsurancePlan.contact.telecom.use | required | ContactPointUsehttp://hl7.org/fhir/ValueSet/contact-point-use|4.0.1from the FHIR Standard | |
| InsurancePlan.coverage.type | example | VhDirCoverageTypehttp://hl7.org/fhir/uv/vhdir/ValueSet/coverage-typefrom this IG | |
| InsurancePlan.coverage.benefit.type | example | VhDirBenefitTypehttp://hl7.org/fhir/uv/vhdir/ValueSet/benefit-typefrom this IG | |
| InsurancePlan.coverage.benefit.limit.code | example | VhDirLimitUnithttp://hl7.org/fhir/uv/vhdir/ValueSet/limit-unitfrom this IG | |
| InsurancePlan.plan.identifier.use | required | IdentifierUsehttp://hl7.org/fhir/ValueSet/identifier-use|4.0.1from the FHIR Standard | |
| InsurancePlan.plan.identifier.type | extensible | Identifier Type Codeshttp://hl7.org/fhir/ValueSet/identifier-typefrom the FHIR Standard | |
| InsurancePlan.plan.type | example | VhDirPlanTypehttp://hl7.org/fhir/uv/vhdir/ValueSet/plan-typefrom this IG | |
| InsurancePlan.plan.generalCost.type | example | VhDirPlanTypehttp://hl7.org/fhir/uv/vhdir/ValueSet/insuranceplancosttypefrom this IG | |
| InsurancePlan.plan.specificCost.category | example | VhDirInsPlanCostCategoryhttp://hl7.org/fhir/uv/vhdir/ValueSet/insuranceplancostcategoryfrom this IG | |
| InsurancePlan.plan.specificCost.benefit.type | example | VhDirInsPlanBenefitTypehttp://hl7.org/fhir/uv/vhdir/ValueSet/insuranceplanbenefittypefrom this IG | |
| InsurancePlan.plan.specificCost.benefit.cost.type | example | VhDirInsPlanBenefitCostTypehttp://hl7.org/fhir/uv/vhdir/ValueSet/insuranceplanbenefitcosttypefrom this IG | |
| InsurancePlan.plan.specificCost.benefit.cost.applicability | required | BenefitCostApplicabilityhttp://hl7.org/fhir/ValueSet/insuranceplan-applicability|4.0.1from the FHIR Standard | |
| InsurancePlan.plan.specificCost.benefit.cost.qualifiers | example | VhDirInsPlanQualifierhttp://hl7.org/fhir/uv/vhdir/ValueSet/insuranceplancostqualifierfrom this IG |
Differential View
This structure is derived from InsurancePlan
| Name | Flags | Card. | Type | Description & Constraints![]() |
|---|---|---|---|---|
![]() |
0..* | InsurancePlan | Details of a Health Insurance product/plan provided by an organization | |
![]() ![]() |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |
![]() ![]() ![]() |
S | 0..* | Reference(VhDir Restriction) | Restriction URL: http://hl7.org/fhir/uv/vhdir/StructureDefinition/usage-restriction |
![]() ![]() |
S | 0..* | Identifier | Business Identifier for Product |
![]() ![]() ![]() |
1..* | Extension | Extension Slice: Unordered, Open by value:url | |
![]() ![]() ![]() ![]() |
S | 1..1 | code | Status URL: http://hl7.org/fhir/uv/vhdir/StructureDefinition/identifier-status Binding: VhDir Identifier Status Value Set (required) |
![]() ![]() ![]() |
S | 0..1 | code | usual | official | temp | secondary | old (If known) |
![]() ![]() ![]() |
S | 0..1 | CodeableConcept | Description of identifier |
![]() ![]() ![]() |
S | 0..1 | uri | The namespace for the identifier value |
![]() ![]() ![]() |
S | 0..1 | string | The value that is unique |
![]() ![]() ![]() |
S | 0..1 | Period | Time period when id is/was valid for use |
![]() ![]() ![]() |
S | 0..1 | Reference(VhDir Organization) | Organization that issued id (may be just text) |
![]() ![]() |
S | 1..1 | code | draft | active | retired | unknown |
![]() ![]() |
S | 0..* | CodeableConcept | Kind of product |
![]() ![]() |
S | 0..1 | string | Official name |
![]() ![]() |
S | 0..* | string | Alternate names |
![]() ![]() |
S | 0..1 | Period | When the product is available |
![]() ![]() |
S | 1..1 | Reference(VhDir Organization) | Plan issuer |
![]() ![]() |
S | 1..1 | Reference(VhDir Organization) | Product administrator |
![]() ![]() |
S | 0..* | Reference(VhDir Location) | Where product applies |
![]() ![]() |
S | 0..* | BackboneElement | Contact for the product |
![]() ![]() ![]() |
S | 0..1 | CodeableConcept | The type of contact |
![]() ![]() ![]() |
S | 0..1 | HumanName | A name associated with the contact |
![]() ![]() ![]() ![]() |
S | 0..1 | code | usual | official | temp | nickname | anonymous | old | maiden |
![]() ![]() ![]() ![]() |
S | 0..1 | string | Text representation of the full name |
![]() ![]() ![]() ![]() |
S | 1..1 | string | Family name (often called 'Surname') |
![]() ![]() ![]() ![]() |
S | 1..* | string | Given names (not always 'first'). Includes middle names |
![]() ![]() ![]() ![]() |
S | 0..* | string | Parts that come before the name |
![]() ![]() ![]() ![]() |
S | 0..* | string | Parts that come after the name |
![]() ![]() ![]() ![]() |
S | 0..1 | Period | Time period when name was/is in use |
![]() ![]() ![]() |
S | 0..* | ContactPoint | Contact details (telephone, email, etc.) for a contact |
![]() ![]() ![]() ![]() |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |
![]() ![]() ![]() ![]() ![]() |
S | 0..1 | Reference(VhDir Practitioner Role | VhDir Organization | VhDir Organization Affiliation | VhDir Location) | viaintermediary URL: http://hl7.org/fhir/uv/vhdir/StructureDefinition/contactpoint-viaintermediary |
![]() ![]() ![]() ![]() ![]() |
S | 0..* | (Complex) | Available time URL: http://hl7.org/fhir/uv/vhdir/StructureDefinition/contactpoint-availabletime |
![]() ![]() ![]() ![]() |
S | 1..1 | code | phone | fax | email | pager | url | sms | other |
![]() ![]() ![]() ![]() |
S | 1..1 | string | The actual contact point details |
![]() ![]() ![]() ![]() |
S | 0..1 | code | home | work | temp | old | mobile - purpose of this contact point |
![]() ![]() ![]() ![]() |
S | 0..1 | positiveInt | Specify preferred order of use (1 = highest) |
![]() ![]() ![]() ![]() |
S | 0..1 | Period | Time period when the contact point was/is in use |
![]() ![]() ![]() |
S | 0..1 | Address | Visiting or postal addresses for the contact |
![]() ![]() |
S | 0..* | Reference(VhDir Endpoint) | Technical endpoint |
![]() ![]() |
S | 0..* | Reference(VhDir Network) | What networks are Included |
![]() ![]() |
S | 0..* | BackboneElement | Coverage details |
![]() ![]() ![]() |
S | 1..1 | CodeableConcept | Type of coverage Binding: VhDir Coverage Type (example) |
![]() ![]() ![]() |
S | 0..* | Reference(VhDir Network) | What networks provide coverage |
![]() ![]() ![]() |
S | 1..* | BackboneElement | List of benefits |
![]() ![]() ![]() ![]() |
S | 1..1 | CodeableConcept | Type of benefit Binding: VhDir Benefit Type (example) |
![]() ![]() ![]() ![]() |
S | 0..1 | string | Referral requirements |
![]() ![]() ![]() ![]() |
S | 0..* | BackboneElement | Benefit limits |
![]() ![]() ![]() ![]() ![]() |
S | 0..1 | Quantity | Maximum value allowed |
![]() ![]() ![]() ![]() ![]() |
S | 0..1 | CodeableConcept | Benefit limit details Binding: VhDir Limit Unit (example) |
![]() ![]() |
S | 0..* | BackboneElement | Plan details |
![]() ![]() ![]() |
S | 0..* | Identifier | Business identifier for plan |
![]() ![]() ![]() ![]() |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |
![]() ![]() ![]() ![]() ![]() |
S | 0..1 | code | Status URL: http://hl7.org/fhir/uv/vhdir/StructureDefinition/identifier-status Binding: VhDir Identifier Status Value Set (required) |
![]() ![]() ![]() ![]() |
S | 0..1 | code | usual | official | temp | secondary | old (If known) |
![]() ![]() ![]() ![]() |
S | 0..1 | CodeableConcept | Description of identifier |
![]() ![]() ![]() ![]() |
S | 0..1 | uri | The namespace for the identifier value |
![]() ![]() ![]() ![]() |
S | 0..1 | string | The value that is unique |
![]() ![]() ![]() ![]() |
S | 0..1 | Period | Time period when id is/was valid for use |
![]() ![]() ![]() ![]() |
S | 0..1 | Reference(VhDir Organization) | Organization that issued id (may be just text) |
![]() ![]() ![]() |
S | 0..1 | CodeableConcept | Type of plan Binding: VhDir Plan Type (example) |
![]() ![]() ![]() |
S | 0..* | Reference(VhDir Location) | Where plan applies |
![]() ![]() ![]() |
S | 0..* | Reference(VhDir Network) | What networks provide coverage |
![]() ![]() ![]() |
S | 0..* | BackboneElement | Overall costs |
![]() ![]() ![]() ![]() |
S | 0..1 | CodeableConcept | Type of cost Binding: VhDir Insurance Plan Cost Type (example) |
![]() ![]() ![]() ![]() |
S | 0..1 | positiveInt | Number of enrollees |
![]() ![]() ![]() ![]() |
S | 0..1 | Money | Cost value |
![]() ![]() ![]() ![]() |
S | 0..1 | string | Additional cost information |
![]() ![]() ![]() |
S | 0..* | BackboneElement | Specific costs |
![]() ![]() ![]() ![]() |
S | 1..1 | CodeableConcept | General category of benefit Binding: VhDir Insurance Plan Cost Category (example) |
![]() ![]() ![]() ![]() |
S | 0..* | BackboneElement | Benefits list |
![]() ![]() ![]() ![]() ![]() |
S | 1..1 | CodeableConcept | Type of specific benefit Binding: VhDir Insurance Plan Benefit Type (example) |
![]() ![]() ![]() ![]() ![]() |
S | 0..* | BackboneElement | List of the costs |
![]() ![]() ![]() ![]() ![]() ![]() |
S | 1..1 | CodeableConcept | Type of cost Binding: VhDir Insurance Plan Benefit Cost Type (example) |
![]() ![]() ![]() ![]() ![]() ![]() |
S | 0..1 | CodeableConcept | in-network | out-of-network | other |
![]() ![]() ![]() ![]() ![]() ![]() |
S | 0..* | CodeableConcept | Additional information about the cost Binding: VhDir Insurance Plan Cost Qualifier (example) |
![]() ![]() ![]() ![]() ![]() ![]() |
S | 0..1 | Quantity | The actual cost value |
Documentation for this format | ||||
| Path | Conformance | ValueSet | URI |
| InsurancePlan.coverage.type | example | VhDirCoverageTypehttp://hl7.org/fhir/uv/vhdir/ValueSet/coverage-typefrom this IG | |
| InsurancePlan.coverage.benefit.type | example | VhDirBenefitTypehttp://hl7.org/fhir/uv/vhdir/ValueSet/benefit-typefrom this IG | |
| InsurancePlan.coverage.benefit.limit.code | example | VhDirLimitUnithttp://hl7.org/fhir/uv/vhdir/ValueSet/limit-unitfrom this IG | |
| InsurancePlan.plan.type | example | VhDirPlanTypehttp://hl7.org/fhir/uv/vhdir/ValueSet/plan-typefrom this IG | |
| InsurancePlan.plan.generalCost.type | example | VhDirPlanTypehttp://hl7.org/fhir/uv/vhdir/ValueSet/insuranceplancosttypefrom this IG | |
| InsurancePlan.plan.specificCost.category | example | VhDirInsPlanCostCategoryhttp://hl7.org/fhir/uv/vhdir/ValueSet/insuranceplancostcategoryfrom this IG | |
| InsurancePlan.plan.specificCost.benefit.type | example | VhDirInsPlanBenefitTypehttp://hl7.org/fhir/uv/vhdir/ValueSet/insuranceplanbenefittypefrom this IG | |
| InsurancePlan.plan.specificCost.benefit.cost.type | example | VhDirInsPlanBenefitCostTypehttp://hl7.org/fhir/uv/vhdir/ValueSet/insuranceplanbenefitcosttypefrom this IG | |
| InsurancePlan.plan.specificCost.benefit.cost.qualifiers | example | VhDirInsPlanQualifierhttp://hl7.org/fhir/uv/vhdir/ValueSet/insuranceplancostqualifierfrom this IG |
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints![]() | ||||
|---|---|---|---|---|---|---|---|---|
![]() |
C | 0..* | InsurancePlan | Details of a Health Insurance product/plan provided by an organization ipn-1: The organization SHALL at least have a name or an idendtifier, and possibly more than one | ||||
![]() ![]() |
Σ | 0..1 | id | Logical id of this artifact | ||||
![]() ![]() |
Σ | 0..1 | Meta | Metadata about the resource | ||||
![]() ![]() |
?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
![]() ![]() |
0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||
![]() ![]() |
0..1 | Narrative | Text summary of the resource, for human interpretation | |||||
![]() ![]() |
0..* | Resource | Contained, inline Resources | |||||
![]() ![]() |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() |
S | 0..* | Reference(VhDir Restriction) | Restriction URL: http://hl7.org/fhir/uv/vhdir/StructureDefinition/usage-restriction | ||||
![]() ![]() |
?! | 0..* | Extension | Extensions that cannot be ignored | ||||
![]() ![]() |
SΣC | 0..* | Identifier | Business Identifier for Product | ||||
![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() |
1..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() |
S | 1..1 | code | Status URL: http://hl7.org/fhir/uv/vhdir/StructureDefinition/identifier-status Binding: VhDir Identifier Status Value Set (required) | ||||
![]() ![]() ![]() |
?!SΣ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . | ||||
![]() ![]() ![]() |
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. | ||||
![]() ![]() ![]() |
SΣ | 0..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient | ||||
![]() ![]() ![]() |
SΣ | 0..1 | string | The value that is unique Example General: 123456 | ||||
![]() ![]() ![]() |
SΣ | 0..1 | Period | Time period when id is/was valid for use | ||||
![]() ![]() ![]() |
SΣ | 0..1 | Reference(VhDir Organization) | Organization that issued id (may be just text) | ||||
![]() ![]() |
?!SΣ | 1..1 | code | draft | active | retired | unknown Binding: PublicationStatus (required): The lifecycle status of an artifact. | ||||
![]() ![]() |
SΣ | 0..* | CodeableConcept | Kind of product Binding: InsurancePlanType (example): Used to categorize the product/plan. | ||||
![]() ![]() |
SΣC | 0..1 | string | Official name | ||||
![]() ![]() |
S | 0..* | string | Alternate names | ||||
![]() ![]() |
S | 0..1 | Period | When the product is available | ||||
![]() ![]() |
SΣ | 1..1 | Reference(VhDir Organization) | Plan issuer | ||||
![]() ![]() |
SΣ | 1..1 | Reference(VhDir Organization) | Product administrator | ||||
![]() ![]() |
SΣ | 0..* | Reference(VhDir Location) | Where product applies | ||||
![]() ![]() |
S | 0..* | BackboneElement | Contact for the product | ||||
![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() |
S | 0..1 | CodeableConcept | The type of contact Binding: ContactEntityType (extensible): The purpose for which you would contact a contact party. | ||||
![]() ![]() ![]() |
S | 0..1 | HumanName | A name associated with the contact | ||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() |
?!SΣ | 0..1 | code | usual | official | temp | nickname | anonymous | old | maiden Binding: NameUse (required): The use of a human name. | ||||
![]() ![]() ![]() ![]() |
SΣ | 0..1 | string | Text representation of the full name | ||||
![]() ![]() ![]() ![]() |
SΣ | 1..1 | string | Family name (often called 'Surname') | ||||
![]() ![]() ![]() ![]() |
SΣ | 1..* | string | Given names (not always 'first'). Includes middle names This repeating element order: Given Names appear in the correct order for presenting the name | ||||
![]() ![]() ![]() ![]() |
SΣ | 0..* | string | Parts that come before the name This repeating element order: Prefixes appear in the correct order for presenting the name | ||||
![]() ![]() ![]() ![]() |
SΣ | 0..* | string | Parts that come after the name This repeating element order: Suffixes appear in the correct order for presenting the name | ||||
![]() ![]() ![]() ![]() |
SΣ | 0..1 | Period | Time period when name was/is in use | ||||
![]() ![]() ![]() |
S | 0..* | ContactPoint | Contact details (telephone, email, etc.) for a contact | ||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() ![]() |
S | 0..1 | Reference(VhDir Practitioner Role | VhDir Organization | VhDir Organization Affiliation | VhDir Location) | viaintermediary URL: http://hl7.org/fhir/uv/vhdir/StructureDefinition/contactpoint-viaintermediary | ||||
![]() ![]() ![]() ![]() ![]() |
S | 0..* | (Complex) | Available time URL: http://hl7.org/fhir/uv/vhdir/StructureDefinition/contactpoint-availabletime | ||||
![]() ![]() ![]() ![]() |
SΣC | 1..1 | code | phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point. | ||||
![]() ![]() ![]() ![]() |
SΣ | 1..1 | string | The actual contact point details | ||||
![]() ![]() ![]() ![]() |
?!SΣ | 0..1 | code | home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required): Use of contact point. | ||||
![]() ![]() ![]() ![]() |
SΣ | 0..1 | positiveInt | Specify preferred order of use (1 = highest) | ||||
![]() ![]() ![]() ![]() |
SΣ | 0..1 | Period | Time period when the contact point was/is in use | ||||
![]() ![]() ![]() |
S | 0..1 | Address | Visiting or postal addresses for the contact | ||||
![]() ![]() |
S | 0..* | Reference(VhDir Endpoint) | Technical endpoint | ||||
![]() ![]() |
S | 0..* | Reference(VhDir Network) | What networks are Included | ||||
![]() ![]() |
S | 0..* | BackboneElement | Coverage details | ||||
![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() |
S | 1..1 | CodeableConcept | Type of coverage Binding: VhDir Coverage Type (example) | ||||
![]() ![]() ![]() |
S | 0..* | Reference(VhDir Network) | What networks provide coverage | ||||
![]() ![]() ![]() |
S | 1..* | BackboneElement | List of benefits | ||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() ![]() |
S | 1..1 | CodeableConcept | Type of benefit Binding: VhDir Benefit Type (example) | ||||
![]() ![]() ![]() ![]() |
S | 0..1 | string | Referral requirements | ||||
![]() ![]() ![]() ![]() |
S | 0..* | BackboneElement | Benefit limits | ||||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() ![]() ![]() |
S | 0..1 | Quantity | Maximum value allowed | ||||
![]() ![]() ![]() ![]() ![]() |
S | 0..1 | CodeableConcept | Benefit limit details Binding: VhDir Limit Unit (example) | ||||
![]() ![]() |
S | 0..* | BackboneElement | Plan details | ||||
![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() |
SΣ | 0..* | Identifier | Business identifier for plan | ||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() ![]() |
S | 0..1 | code | Status URL: http://hl7.org/fhir/uv/vhdir/StructureDefinition/identifier-status Binding: VhDir Identifier Status Value Set (required) | ||||
![]() ![]() ![]() ![]() |
?!SΣ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . | ||||
![]() ![]() ![]() ![]() |
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. | ||||
![]() ![]() ![]() ![]() |
SΣ | 0..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient | ||||
![]() ![]() ![]() ![]() |
SΣ | 0..1 | string | The value that is unique Example General: 123456 | ||||
![]() ![]() ![]() ![]() |
SΣ | 0..1 | Period | Time period when id is/was valid for use | ||||
![]() ![]() ![]() ![]() |
SΣ | 0..1 | Reference(VhDir Organization) | Organization that issued id (may be just text) | ||||
![]() ![]() ![]() |
S | 0..1 | CodeableConcept | Type of plan Binding: VhDir Plan Type (example) | ||||
![]() ![]() ![]() |
SΣ | 0..* | Reference(VhDir Location) | Where plan applies | ||||
![]() ![]() ![]() |
S | 0..* | Reference(VhDir Network) | What networks provide coverage | ||||
![]() ![]() ![]() |
S | 0..* | BackboneElement | Overall costs | ||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() ![]() |
S | 0..1 | CodeableConcept | Type of cost Binding: VhDir Insurance Plan Cost Type (example) | ||||
![]() ![]() ![]() ![]() |
S | 0..1 | positiveInt | Number of enrollees | ||||
![]() ![]() ![]() ![]() |
S | 0..1 | Money | Cost value | ||||
![]() ![]() ![]() ![]() |
S | 0..1 | string | Additional cost information | ||||
![]() ![]() ![]() |
S | 0..* | BackboneElement | Specific costs | ||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() ![]() |
S | 1..1 | CodeableConcept | General category of benefit Binding: VhDir Insurance Plan Cost Category (example) | ||||
![]() ![]() ![]() ![]() |
S | 0..* | BackboneElement | Benefits list | ||||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() ![]() ![]() |
S | 1..1 | CodeableConcept | Type of specific benefit Binding: VhDir Insurance Plan Benefit Type (example) | ||||
![]() ![]() ![]() ![]() ![]() |
S | 0..* | BackboneElement | List of the costs | ||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() ![]() ![]() ![]() |
S | 1..1 | CodeableConcept | Type of cost Binding: VhDir Insurance Plan Benefit Cost Type (example) | ||||
![]() ![]() ![]() ![]() ![]() ![]() |
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. | ||||
![]() ![]() ![]() ![]() ![]() ![]() |
S | 0..* | CodeableConcept | Additional information about the cost Binding: VhDir Insurance Plan Cost Qualifier (example) | ||||
![]() ![]() ![]() ![]() ![]() ![]() |
S | 0..1 | Quantity | The actual cost value | ||||
Documentation for this format | ||||||||
| Path | Conformance | ValueSet | URI | |||
| InsurancePlan.language | preferred | CommonLanguageshttp://hl7.org/fhir/ValueSet/languagesfrom the FHIR Standard
| ||||
| InsurancePlan.identifier.use | required | IdentifierUsehttp://hl7.org/fhir/ValueSet/identifier-use|4.0.1from the FHIR Standard | ||||
| InsurancePlan.identifier.type | extensible | Identifier Type Codeshttp://hl7.org/fhir/ValueSet/identifier-typefrom the FHIR Standard | ||||
| InsurancePlan.status | required | PublicationStatushttp://hl7.org/fhir/ValueSet/publication-status|4.0.1from the FHIR Standard | ||||
| InsurancePlan.type | example | InsurancePlanTypehttp://hl7.org/fhir/ValueSet/insuranceplan-typefrom the FHIR Standard | ||||
| InsurancePlan.contact.purpose | extensible | ContactEntityTypehttp://hl7.org/fhir/ValueSet/contactentity-typefrom the FHIR Standard | ||||
| InsurancePlan.contact.name.use | required | NameUsehttp://hl7.org/fhir/ValueSet/name-use|4.0.1from the FHIR Standard | ||||
| InsurancePlan.contact.telecom.system | required | ContactPointSystemhttp://hl7.org/fhir/ValueSet/contact-point-system|4.0.1from the FHIR Standard | ||||
| InsurancePlan.contact.telecom.use | required | ContactPointUsehttp://hl7.org/fhir/ValueSet/contact-point-use|4.0.1from the FHIR Standard | ||||
| InsurancePlan.coverage.type | example | VhDirCoverageTypehttp://hl7.org/fhir/uv/vhdir/ValueSet/coverage-typefrom this IG | ||||
| InsurancePlan.coverage.benefit.type | example | VhDirBenefitTypehttp://hl7.org/fhir/uv/vhdir/ValueSet/benefit-typefrom this IG | ||||
| InsurancePlan.coverage.benefit.limit.code | example | VhDirLimitUnithttp://hl7.org/fhir/uv/vhdir/ValueSet/limit-unitfrom this IG | ||||
| InsurancePlan.plan.identifier.use | required | IdentifierUsehttp://hl7.org/fhir/ValueSet/identifier-use|4.0.1from the FHIR Standard | ||||
| InsurancePlan.plan.identifier.type | extensible | Identifier Type Codeshttp://hl7.org/fhir/ValueSet/identifier-typefrom the FHIR Standard | ||||
| InsurancePlan.plan.type | example | VhDirPlanTypehttp://hl7.org/fhir/uv/vhdir/ValueSet/plan-typefrom this IG | ||||
| InsurancePlan.plan.generalCost.type | example | VhDirPlanTypehttp://hl7.org/fhir/uv/vhdir/ValueSet/insuranceplancosttypefrom this IG | ||||
| InsurancePlan.plan.specificCost.category | example | VhDirInsPlanCostCategoryhttp://hl7.org/fhir/uv/vhdir/ValueSet/insuranceplancostcategoryfrom this IG | ||||
| InsurancePlan.plan.specificCost.benefit.type | example | VhDirInsPlanBenefitTypehttp://hl7.org/fhir/uv/vhdir/ValueSet/insuranceplanbenefittypefrom this IG | ||||
| InsurancePlan.plan.specificCost.benefit.cost.type | example | VhDirInsPlanBenefitCostTypehttp://hl7.org/fhir/uv/vhdir/ValueSet/insuranceplanbenefitcosttypefrom this IG | ||||
| InsurancePlan.plan.specificCost.benefit.cost.applicability | required | BenefitCostApplicabilityhttp://hl7.org/fhir/ValueSet/insuranceplan-applicability|4.0.1from the FHIR Standard | ||||
| InsurancePlan.plan.specificCost.benefit.cost.qualifiers | example | VhDirInsPlanQualifierhttp://hl7.org/fhir/uv/vhdir/ValueSet/insuranceplancostqualifierfrom this IG |
This structure is derived from InsurancePlan
Summary
Mandatory: 3 elements(6 nested mandatory elements)
Must-Support: 73 elements
Structures
This structure refers to these other structures:
Extensions
This structure refers to these extensions:
Maturity: 2
Other representations of profile: CSV, Excel, Schematron
GET [base]/InsurancePlan?administered-by=[id]
Support: SHOULD support search by the administered-by parameter
Organizationabove, belowadministered-by.identifier, administered-by.name, administered-by.partofGET [base]/InsurancePlan?coverage-benefit-type=[code]
Support: SHALL support search by the coverage-benefit-type parameter
textGET [base]/InsurancePlan?coverage-limit-value=[prefix][number]|[system]|[code]
Support: MAY support search by the coverage-limit-value parameter
eq, gt, lt, ge, le, sa, ebGET [base]/InsurancePlan?coverage-network=[id]
Support: SHALL support search by the coverage-network parameter
Organizationcoverage-network.identifier, coverage-network.name, coverage-network.partofGET [base]/InsurancePlan?coverage-type=[code]
Support: SHALL support search by the coverage-type parameter
textGET [base]/InsurancePlan?endpoint=[id]
Support: SHOULD support search by the endpoint parameter
Endpointendpoint.identifier, endpoint.connection-type, endpoint.organizationGET [base]/InsurancePlan?general-cost-groupsize=[number]
Support: MAY support search by the general-cost-groupsize parameter
eq, gt, lt, ge, le, sa, ebGET [base]/InsurancePlan?general-cost-type=[code]
Support: MAY support search by the general-cost-type parameter
textGET [base]/InsurancePlan?general-cost-value=[prefix][number]|[system]|[code]
Support: MAY support search by the general-cost-value parameter
eq, gt, lt, ge, le, sa, ebGET [base]/InsurancePlan?name=[string]
Support: SHOULD support search by the name parameter
exact, containsGET [base]/InsurancePlan?owned-by=[id]
Support: SHALL support search by the owned-by parameter
Organizationabove, belowowned-by.identifier, owned-by.name, owned-by.partofGET [base]/InsurancePlan?plan-coverage-area=[id]
Support: SHOULD support search by the plan-coverage-area parameter
Locationplan-coverage-area.identifier, plan-coverage-area.containsGET [base]/InsurancePlan?plan-identifier=[code]
Support: SHALL support search by the plan-identifier parameter
text, ofTypeGET [base]/InsurancePlan?plan-network=[id]
Support: SHALL support search by the plan-network parameter
Organizationplan-network.identifier, plan-network.name, plan-network.partofGET [base]/InsurancePlan?plan-type=[code]
Support: SHALL support search by the plan-type parameter
textGET [base]/InsurancePlan?coverage-area=[id]
Support: SHOULD support search by the coverage-area parameter
Locationcoverage-area.identifier, coverage-area.contains`GET [base]/InsurancePlan?identifier=[code]
Support: SHALL support search by the identifier parameter
GET [base]/InsurancePlan?network=[id]
Support: SHALL support search by the network parameter
Organizationnetwork.identifier, network.name, network.partofGET [base]/InsurancePlan?type=[code]
Support: SHALL support search by the type parameter
textGET [base]/InsurancePlan?specific-cost-benefit-type=[code]
Support: SHOULD support search by the specific-cost-benefit-type parameter
textGET [base]/InsurancePlan?specific-cost-category=[code]
Support: SHOULD support search by the specific-cost-category parameter
textGET [base]/InsurancePlan?specific-cost-cost-type=[code]
Support: MAY support search by the specific-cost-cost-type parameter
textGET [base]/InsurancePlan?specific-cost-value=[prefix][number]|[system]|[code]
Support: MAY support search by the specific-cost-value parameter
eq, gt, lt, ge, le, sa, ebGET [base]/InsurancePlan?status=[code]
Support: SHALL support search by the status parameter