National Directory of Healthcare Providers & Services (NDH) Implementation Guide
1.0.0 - STU1 United States of America flag

National Directory of Healthcare Providers & Services (NDH) Implementation Guide, 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/fhir-us-ndh/ and changes regularly. See the Directory of published versions

Resource Profile: Payer Provider Network Query InsurancePlan Profile

Official URL: http://hl7.org/fhir/us/ndh/StructureDefinition/ndhPn-ldapi-InsurancePlan Version: 1.0.0
Standards status: Trial-use Computable Name: NdhPnLdApiInsurancePlan

An InsurancePlan is a discrete package of health insurance coverage benefits that are offered under a particular network type. A given payer’s products typically differ by network type and/or covered benefits. A plan pairs a product’s covered benefits with the particular cost sharing structure offered to a consumer. A given product may comprise multiple plans (i.e. each plan offers different cost sharing requirements for the same set of covered benefits). InsurancePlan describes a health insurance offering comprised of a list of covered benefits (i.e. the product), costs associated with those benefits (i.e. the plan), and additional information about the offering, such as who it is owned and administered by, a coverage area, contact information, etc.

Usage:

Formal Views of Profile Content

Description of Profiles, Differentials, Snapshots and how the different presentations work.

NameFlagsCard.TypeDescription & Constraintsdoco
.. InsurancePlan C 0..* NdhInsurancePlan 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
network-or-NatlDirwork: If an insuranceplan does not define a network, then each plan must define one
plan-type-is-distinct: Each InsurancePlan.plan should have a distinct plan.type.
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
ele-1: All FHIR elements must have a @value or children
... Slices for extension Content/Rules for all slices
.... extension:usage-restriction 0..* Reference(NDH Base Restriction) {c} Usage Restriction
URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-usage-restriction
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
.... extension:verification-status 0..1 CodeableConcept NDH Verification Status
URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-verification-status
Binding: NDH Verification Status Value Set (extensible)
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
... modifierExtension ?! 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
.... Slices for extension Content/Rules for all slices
..... extension:identifier-status 0..1 code NDH Identifier Status
URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-identifier-status
Binding: 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
.... use ?!Σ 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
.... type SΣ 0..1 CodeableConcept Description of identifier
Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.


ele-1: All FHIR elements must have a @value or children
.... value SΣ 0..1 string The value that is unique
ele-1: All FHIR elements must have a @value or children
Example General: 123456
.... assigner SΣ 0..1 Reference(Payer Provider Network Query Organization Profile) Organization that issued id (may be just text)
ele-1: All FHIR elements must have a @value or children
... status ?!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
Fixed Value: active
... type SΣ 1..1 CodeableConcept Product Type
Binding: Insurance Product Type (extensible)
ele-1: All FHIR elements must have a @value or children
... name SΣC 0..1 string Official name
ele-1: All FHIR elements must have a @value or children
... alias S 0..* string Alternate names
ele-1: All FHIR elements must have a @value or children
... period S 0..1 Period When the product is available
ele-1: All FHIR elements must have a @value or children
... ownedBy SΣ 1..1 Reference(Payer Provider Network Query Organization Profile) Plan issuer
ele-1: All FHIR elements must have a @value or children
... administeredBy SΣ 1..1 Reference(Payer Provider Network Query Organization Profile) Product administrator
ele-1: All FHIR elements must have a @value or children
... coverageArea SΣ 0..* Reference(Payer Provider Network Query Location Profile) Where product applies
ele-1: All FHIR elements must have a @value or children
... contact S 0..* BackboneElement Contact for the product
ele-1: All FHIR elements must have a @value or children
.... modifierExtension ?!Σ 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
.... name S 0..1 HumanName A name associated with the contact
ele-1: All FHIR elements must have a @value or children
..... use ?!Σ 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
..... text SΣ 0..1 string Text representation of the full name
ele-1: All FHIR elements must have a @value or children
.... telecom S 0..* ContactPoint Contact details (telephone, email, etc.) for a contact
ele-1: All FHIR elements must have a @value or children
..... Slices for extension Content/Rules for all slices
...... extension:contactpoint-availabletime 0..* (Complex) NDH Contactpoint Availabletime
URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-contactpoint-availabletime
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
...... extension:via-intermediary 0..1 Reference(NDH Base PractitionerRole | NDH Base OrganizationAffiliation Profile | NDH Base Location Profile | NDH Base Organization Profile) Via Intermediary
URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-via-intermediary
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
..... system SΣC 0..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
..... value SΣ 0..1 string The actual contact point details
ele-1: All FHIR elements must have a @value or children
..... use ?!Σ 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
... endpoint S 0..* Reference(Payer Provider Network Local Directory API Endpoint Profile) Technical endpoint
ele-1: All FHIR elements must have a @value or children
... network S 0..* Reference(Payer Provider Network Query Network Profile) What networks are Included
ele-1: All FHIR elements must have a @value or children
... coverage 0..* BackboneElement Coverage details
ele-1: All FHIR elements must have a @value or children
.... modifierExtension ?!Σ 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
.... type 1..1 CodeableConcept Type of coverage
Binding: Insurance Coverage Type (extensible)
ele-1: All FHIR elements must have a @value or children
.... network S 0..* Reference(Payer Provider Network Query Network Profile) What networks provide coverage
ele-1: All FHIR elements must have a @value or children
.... benefit 1..* BackboneElement List of benefits
ele-1: All FHIR elements must have a @value or children
..... modifierExtension ?!Σ 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
..... type 1..1 CodeableConcept Type of benefit
Binding: Benefit Type Value Set (extensible)
ele-1: All FHIR elements must have a @value or children
... plan 0..* BackboneElement Cost sharing details for the plan
ele-1: All FHIR elements must have a @value or children
.... modifierExtension ?!Σ 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
.... type S 0..1 CodeableConcept Categorization of the cost sharing for the plan
Binding: Insuranceplan Plan Type (extensible)
ele-1: All FHIR elements must have a @value or children
.... coverageArea SΣ 0..* Reference(Payer Provider Network Query Location Profile) Where product applies
ele-1: All FHIR elements must have a @value or children
.... network 0..* Reference(Payer Provider Network Query Network Profile) What networks provide coverage
ele-1: All FHIR elements must have a @value or children

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
InsurancePlan.identifier.userequiredIdentifierUse
http://hl7.org/fhir/ValueSet/identifier-use|4.0.1
from the FHIR Standard
InsurancePlan.identifier.typeextensibleIdentifier Type Codes
http://hl7.org/fhir/ValueSet/identifier-type
from the FHIR Standard
InsurancePlan.statusrequiredFixed Value: active
http://hl7.org/fhir/ValueSet/publication-status|4.0.1
from the FHIR Standard
InsurancePlan.typeextensibleInsuranceProductType
http://terminology.hl7.org/ValueSet/insurance-product-type
InsurancePlan.contact.name.userequiredNameUse
http://hl7.org/fhir/ValueSet/name-use|4.0.1
from the FHIR Standard
InsurancePlan.contact.telecom.systemrequiredContactPointSystem
http://hl7.org/fhir/ValueSet/contact-point-system|4.0.1
from the FHIR Standard
InsurancePlan.contact.telecom.userequiredContactPointUse
http://hl7.org/fhir/ValueSet/contact-point-use|4.0.1
from the FHIR Standard
InsurancePlan.coverage.typeextensibleInsuranceCoverageType
http://terminology.hl7.org/ValueSet/insurance-coverage-type
InsurancePlan.coverage.benefit.typeextensibleBenefitTypeVS
http://hl7.org/fhir/us/ndh/ValueSet/BenefitTypeVS
from this IG
InsurancePlan.plan.typeextensibleInsuranceplanPlanType
http://terminology.hl7.org/ValueSet/insuranceplan-plan-type

 

Other representations of profile: CSV, Excel, Schematron