DaVinci Payer Data Exchange (PDex) US Drug Formulary
3.0.0-ballot - STU 3 ballot United States of America flag

DaVinci Payer Data Exchange (PDex) US Drug Formulary, published by HL7 International / Pharmacy. This guide is not an authorized publication; it is the continuous build for version 3.0.0-ballot built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/HL7/davinci-pdex-formulary/ and changes regularly. See the Directory of published versions

Resource Profile: Formulary

Official URL: http://hl7.org/fhir/us/davinci-drug-formulary/StructureDefinition/usdf-Formulary Version: 3.0.0-ballot
Standards status: Trial-use Maturity Level: 2 Computable Name: Formulary
Other Identifiers: OID:2.25.74595174031514506193398850787025340071.42.6

The Formulary provides general information about a formulary and acts as an organizing construct that associated FormularyItem resources point to. The Formulary combined with its associated FormularyItem and FormularyDrug resources represent a formulary list that includes the set of drugs covered and the requirements and limitations of the coverage.

Usages:

You can also check for usages in the FHIR IG Statistics

Formal Views of Profile Content

Description Differentials, Snapshots, and other representations.

NameFlagsCard.TypeDescription & Constraints    Filter: doco
InsurancePlan C 0..* InsurancePlan Details of a Health Insurance product/plan provided by an organization
Constraints: ipn-1
InsurancePlan.implicitRules This element is a modifier element. This element is included in summaries. 0..1 uri A set of rules under which this content was created
InsurancePlan.modifierExtension This element is a modifier element. 0..* Extension Extensions that cannot be ignored
InsurancePlan.identifier This element must be supported. This element is included in summaries. C 1..* Identifier Business Identifier for Product
InsurancePlan.status This element is a modifier element. This element must be supported. This element is included in summaries. 1..1 code draft | active | retired | unknown
Binding: PublicationStatus (required): The lifecycle status of an artifact.
InsurancePlan.type This element must be supported. This element is included in summaries. 1..1 CodeableConcept Plan type
Binding: InsurancePlanType (example): Used to categorize the product/plan.

Required Pattern:
{
  "coding" : [
    {
      "system" : "http://terminology.hl7.org/CodeSystem/v3-ActCode",
      "code" : "DRUGPOL"
    }
  ]
}
InsurancePlan.name This element must be supported. This element is included in summaries. C 0..1 string Official name
InsurancePlan.period This element must be supported. 0..1 Period When the product is available
InsurancePlan.plan 0..1 BackboneElement Optional non-cost related plan information indicating pharmacy benefit types and drug tiers available in the formulary
InsurancePlan.plan.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
InsurancePlan.plan.type 1..1 CodeableConcept Type of plan
Required Pattern:
{
  "coding" : [
    {
      "system" : "http://terminology.hl7.org/CodeSystem/insurance-plan-type",
      "code" : "drug",
      "display" : "Drug"
    }
  ]
}
InsurancePlan.plan.specificCost 0..* BackboneElement Pharmacy benefit type specific cost
InsurancePlan.plan.specificCost.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
InsurancePlan.plan.specificCost.category 1..1 CodeableConcept General category of benefit
Binding: Pharmacy benefit types (extensible)
InsurancePlan.plan.specificCost.benefit 0..* BackboneElement Drug tier benefit
InsurancePlan.plan.specificCost.benefit.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
InsurancePlan.plan.specificCost.benefit.type 1..1 CodeableConcept Type of specific benefit
Binding: Drug tier of medication in health plan (extensible)

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
InsurancePlan.status Base required PublicationStatus 📍4.0.1 FHIR Std.
InsurancePlan.type Base example Insurance plan type 📍4.0.1 FHIR Std.
InsurancePlan.plan.specificCost.​category Base extensible Pharmacy benefit types 📦3.0.0-ballot This IG
InsurancePlan.plan.specificCost.​benefit.type Base extensible Drug tier of medication in health plan 📦3.0.0-ballot This IG

Constraints

Id Grade Path(s) Description Expression

This structure is derived from InsurancePlan

NameFlagsCard.TypeDescription & Constraints    Filter: doco
InsurancePlan 0..* InsurancePlan Details of a Health Insurance product/plan provided by an organization
InsurancePlan.identifier This element must be supported. 1..* Identifier Business Identifier for Product
InsurancePlan.status This element must be supported. 1..1 code draft | active | retired | unknown
InsurancePlan.type This element must be supported. 1..1 CodeableConcept Plan type
Required Pattern:
{
  "coding" : [
    {
      "system" : "http://terminology.hl7.org/CodeSystem/v3-ActCode",
      "code" : "DRUGPOL"
    }
  ]
}
InsurancePlan.period This element must be supported. 0..1 Period When the product is available
InsurancePlan.plan 0..1 BackboneElement Optional non-cost related plan information indicating pharmacy benefit types and drug tiers available in the formulary
InsurancePlan.plan.type 1..1 CodeableConcept Type of plan
Required Pattern:
{
  "coding" : [
    {
      "system" : "http://terminology.hl7.org/CodeSystem/insurance-plan-type",
      "code" : "drug",
      "display" : "Drug"
    }
  ]
}
InsurancePlan.plan.specificCost 0..* BackboneElement Pharmacy benefit type specific cost
InsurancePlan.plan.specificCost.category 1..1 CodeableConcept General category of benefit
Binding: Pharmacy benefit types (extensible)
InsurancePlan.plan.specificCost.benefit 0..* BackboneElement Drug tier benefit
InsurancePlan.plan.specificCost.benefit.type 1..1 CodeableConcept Type of specific benefit
Binding: Drug tier of medication in health plan (extensible)

doco Documentation for this format

Terminology Bindings (Differential)

Path Status Usage ValueSet Version Source
InsurancePlan.plan.specificCost.​category Base extensible Pharmacy benefit types 📦3.0.0-ballot This IG
InsurancePlan.plan.specificCost.​benefit.type Base extensible Drug tier of medication in health plan 📦3.0.0-ballot This IG
NameFlagsCard.TypeDescription & Constraints    Filter: doco
InsurancePlan C 0..* InsurancePlan Details of a Health Insurance product/plan provided by an organization
Constraints: ipn-1
InsurancePlan.id This element is included in summaries. 0..1 id Logical id of this artifact
InsurancePlan.meta This element is included in summaries. 0..1 Meta Metadata about the resource
InsurancePlan.implicitRules This element is a modifier element. This element is included in summaries. 0..1 uri A set of rules under which this content was created
InsurancePlan.language 0..1 code Language of the resource content
Binding: CommonLanguages (preferred): A human language.
Additional BindingsPurpose
AllLanguages Max Binding
InsurancePlan.text 0..1 Narrative Text summary of the resource, for human interpretation
This profile does not constrain the narrative in regard to content, language, or traceability to data elements
InsurancePlan.contained 0..* Resource Contained, inline Resources
InsurancePlan.extension 0..* Extension Additional content defined by implementations
InsurancePlan.modifierExtension This element is a modifier element. 0..* Extension Extensions that cannot be ignored
InsurancePlan.identifier This element must be supported. This element is included in summaries. C 1..* Identifier Business Identifier for Product
InsurancePlan.status This element is a modifier element. This element must be supported. This element is included in summaries. 1..1 code draft | active | retired | unknown
Binding: PublicationStatus (required): The lifecycle status of an artifact.
InsurancePlan.type This element must be supported. This element is included in summaries. 1..1 CodeableConcept Plan type
Binding: InsurancePlanType (example): Used to categorize the product/plan.

Required Pattern:
{
  "coding" : [
    {
      "system" : "http://terminology.hl7.org/CodeSystem/v3-ActCode",
      "code" : "DRUGPOL"
    }
  ]
}
InsurancePlan.name This element must be supported. This element is included in summaries. C 0..1 string Official name
InsurancePlan.alias 0..* string Alternate names
InsurancePlan.period This element must be supported. 0..1 Period When the product is available
InsurancePlan.ownedBy This element is included in summaries. 0..1 Reference(Organization) Plan issuer
InsurancePlan.administeredBy This element is included in summaries. 0..1 Reference(Organization) Product administrator
InsurancePlan.coverageArea This element is included in summaries. 0..* Reference(Location) Where product applies
InsurancePlan.contact 0..* BackboneElement Contact for the product
InsurancePlan.contact.id 0..1 string Unique id for inter-element referencing
InsurancePlan.contact.extension 0..* Extension Additional content defined by implementations
InsurancePlan.contact.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
InsurancePlan.contact.purpose 0..1 CodeableConcept The type of contact
Binding: ContactEntityType (extensible): The purpose for which you would contact a contact party.
InsurancePlan.contact.name 0..1 HumanName A name associated with the contact
InsurancePlan.contact.telecom 0..* ContactPoint Contact details (telephone, email, etc.) for a contact
InsurancePlan.contact.address 0..1 Address Visiting or postal addresses for the contact
InsurancePlan.endpoint 0..* Reference(Endpoint) Technical endpoint
InsurancePlan.network 0..* Reference(Organization) What networks are Included
InsurancePlan.coverage 0..* BackboneElement Coverage details
InsurancePlan.coverage.id 0..1 string Unique id for inter-element referencing
InsurancePlan.coverage.extension 0..* Extension Additional content defined by implementations
InsurancePlan.coverage.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
InsurancePlan.coverage.type 1..1 CodeableConcept Type of coverage
InsurancePlan.coverage.network 0..* Reference(Organization) What networks provide coverage
InsurancePlan.coverage.benefit 1..* BackboneElement List of benefits
InsurancePlan.coverage.benefit.id 0..1 string Unique id for inter-element referencing
InsurancePlan.coverage.benefit.extension 0..* Extension Additional content defined by implementations
InsurancePlan.coverage.benefit.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
InsurancePlan.coverage.benefit.type 1..1 CodeableConcept Type of benefit
InsurancePlan.coverage.benefit.requirement 0..1 string Referral requirements
InsurancePlan.coverage.benefit.limit 0..* BackboneElement Benefit limits
InsurancePlan.coverage.benefit.limit.id 0..1 string Unique id for inter-element referencing
InsurancePlan.coverage.benefit.limit.extension 0..* Extension Additional content defined by implementations
InsurancePlan.coverage.benefit.limit.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
InsurancePlan.coverage.benefit.limit.value 0..1 Quantity Maximum value allowed
InsurancePlan.coverage.benefit.limit.code 0..1 CodeableConcept Benefit limit details
InsurancePlan.plan 0..1 BackboneElement Optional non-cost related plan information indicating pharmacy benefit types and drug tiers available in the formulary
InsurancePlan.plan.id 0..1 string Unique id for inter-element referencing
InsurancePlan.plan.extension 0..* Extension Additional content defined by implementations
InsurancePlan.plan.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
InsurancePlan.plan.identifier This element is included in summaries. 0..* Identifier Business Identifier for Product
InsurancePlan.plan.type 1..1 CodeableConcept Type of plan
Required Pattern:
{
  "coding" : [
    {
      "system" : "http://terminology.hl7.org/CodeSystem/insurance-plan-type",
      "code" : "drug",
      "display" : "Drug"
    }
  ]
}
InsurancePlan.plan.coverageArea This element is included in summaries. 0..* Reference(Location) Where product applies
InsurancePlan.plan.network 0..* Reference(Organization) What networks provide coverage
InsurancePlan.plan.generalCost 0..* BackboneElement Overall costs
InsurancePlan.plan.generalCost.id 0..1 string Unique id for inter-element referencing
InsurancePlan.plan.generalCost.extension 0..* Extension Additional content defined by implementations
InsurancePlan.plan.generalCost.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
InsurancePlan.plan.generalCost.type 0..1 CodeableConcept Type of cost
InsurancePlan.plan.generalCost.groupSize 0..1 positiveInt Number of enrollees
InsurancePlan.plan.generalCost.cost 0..1 Money Cost value
InsurancePlan.plan.generalCost.comment 0..1 string Additional cost information
InsurancePlan.plan.specificCost 0..* BackboneElement Pharmacy benefit type specific cost
InsurancePlan.plan.specificCost.id 0..1 string Unique id for inter-element referencing
InsurancePlan.plan.specificCost.extension 0..* Extension Additional content defined by implementations
InsurancePlan.plan.specificCost.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
InsurancePlan.plan.specificCost.category 1..1 CodeableConcept General category of benefit
Binding: Pharmacy benefit types (extensible)
InsurancePlan.plan.specificCost.benefit 0..* BackboneElement Drug tier benefit
InsurancePlan.plan.specificCost.benefit.id 0..1 string Unique id for inter-element referencing
InsurancePlan.plan.specificCost.benefit.extension 0..* Extension Additional content defined by implementations
InsurancePlan.plan.specificCost.benefit.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
InsurancePlan.plan.specificCost.benefit.type 1..1 CodeableConcept Type of specific benefit
Binding: Drug tier of medication in health plan (extensible)
InsurancePlan.plan.specificCost.benefit.cost 0..* BackboneElement List of the costs
InsurancePlan.plan.specificCost.benefit.cost.id 0..1 string Unique id for inter-element referencing
InsurancePlan.plan.specificCost.benefit.cost.extension 0..* Extension Additional content defined by implementations
InsurancePlan.plan.specificCost.benefit.cost.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
InsurancePlan.plan.specificCost.benefit.cost.type 1..1 CodeableConcept Type of cost
InsurancePlan.plan.specificCost.benefit.cost.applicability 0..1 CodeableConcept in-network | out-of-network | other
Binding: BenefitCostApplicability (required): Whether the cost applies to in-network or out-of-network providers.
InsurancePlan.plan.specificCost.benefit.cost.qualifiers 0..* CodeableConcept Additional information about the cost
InsurancePlan.plan.specificCost.benefit.cost.value 0..1 Quantity The actual cost value

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
InsurancePlan.language Base preferred Common Languages 📍4.0.1 FHIR Std.
InsurancePlan.status Base required PublicationStatus 📍4.0.1 FHIR Std.
InsurancePlan.type Base example Insurance plan type 📍4.0.1 FHIR Std.
InsurancePlan.contact.​purpose Base extensible Contact entity type 📍4.0.1 FHIR Std.
InsurancePlan.plan.specificCost.​category Base extensible Pharmacy benefit types 📦3.0.0-ballot This IG
InsurancePlan.plan.specificCost.​benefit.type Base extensible Drug tier of medication in health plan 📦3.0.0-ballot This IG
InsurancePlan.plan.specificCost.​benefit.cost.applicability Base required Benefit cost applicability 📍4.0.1 FHIR Std.

Constraints

Id Grade Path(s) Description Expression

This structure is derived from InsurancePlan

Summary

Mandatory: 3 elements(1 nested mandatory element)
Must-Support: 5 elements

Maturity: 2

Key Elements View

NameFlagsCard.TypeDescription & Constraints    Filter: doco
InsurancePlan C 0..* InsurancePlan Details of a Health Insurance product/plan provided by an organization
Constraints: ipn-1
InsurancePlan.implicitRules This element is a modifier element. This element is included in summaries. 0..1 uri A set of rules under which this content was created
InsurancePlan.modifierExtension This element is a modifier element. 0..* Extension Extensions that cannot be ignored
InsurancePlan.identifier This element must be supported. This element is included in summaries. C 1..* Identifier Business Identifier for Product
InsurancePlan.status This element is a modifier element. This element must be supported. This element is included in summaries. 1..1 code draft | active | retired | unknown
Binding: PublicationStatus (required): The lifecycle status of an artifact.
InsurancePlan.type This element must be supported. This element is included in summaries. 1..1 CodeableConcept Plan type
Binding: InsurancePlanType (example): Used to categorize the product/plan.

Required Pattern:
{
  "coding" : [
    {
      "system" : "http://terminology.hl7.org/CodeSystem/v3-ActCode",
      "code" : "DRUGPOL"
    }
  ]
}
InsurancePlan.name This element must be supported. This element is included in summaries. C 0..1 string Official name
InsurancePlan.period This element must be supported. 0..1 Period When the product is available
InsurancePlan.plan 0..1 BackboneElement Optional non-cost related plan information indicating pharmacy benefit types and drug tiers available in the formulary
InsurancePlan.plan.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
InsurancePlan.plan.type 1..1 CodeableConcept Type of plan
Required Pattern:
{
  "coding" : [
    {
      "system" : "http://terminology.hl7.org/CodeSystem/insurance-plan-type",
      "code" : "drug",
      "display" : "Drug"
    }
  ]
}
InsurancePlan.plan.specificCost 0..* BackboneElement Pharmacy benefit type specific cost
InsurancePlan.plan.specificCost.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
InsurancePlan.plan.specificCost.category 1..1 CodeableConcept General category of benefit
Binding: Pharmacy benefit types (extensible)
InsurancePlan.plan.specificCost.benefit 0..* BackboneElement Drug tier benefit
InsurancePlan.plan.specificCost.benefit.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
InsurancePlan.plan.specificCost.benefit.type 1..1 CodeableConcept Type of specific benefit
Binding: Drug tier of medication in health plan (extensible)

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
InsurancePlan.status Base required PublicationStatus 📍4.0.1 FHIR Std.
InsurancePlan.type Base example Insurance plan type 📍4.0.1 FHIR Std.
InsurancePlan.plan.specificCost.​category Base extensible Pharmacy benefit types 📦3.0.0-ballot This IG
InsurancePlan.plan.specificCost.​benefit.type Base extensible Drug tier of medication in health plan 📦3.0.0-ballot This IG

Constraints

Id Grade Path(s) Description Expression

Differential View

This structure is derived from InsurancePlan

NameFlagsCard.TypeDescription & Constraints    Filter: doco
InsurancePlan 0..* InsurancePlan Details of a Health Insurance product/plan provided by an organization
InsurancePlan.identifier This element must be supported. 1..* Identifier Business Identifier for Product
InsurancePlan.status This element must be supported. 1..1 code draft | active | retired | unknown
InsurancePlan.type This element must be supported. 1..1 CodeableConcept Plan type
Required Pattern:
{
  "coding" : [
    {
      "system" : "http://terminology.hl7.org/CodeSystem/v3-ActCode",
      "code" : "DRUGPOL"
    }
  ]
}
InsurancePlan.name This element must be supported. 0..1 string Official name
InsurancePlan.period This element must be supported. 0..1 Period When the product is available
InsurancePlan.plan 0..1 BackboneElement Optional non-cost related plan information indicating pharmacy benefit types and drug tiers available in the formulary
InsurancePlan.plan.type 1..1 CodeableConcept Type of plan
Required Pattern:
{
  "coding" : [
    {
      "system" : "http://terminology.hl7.org/CodeSystem/insurance-plan-type",
      "code" : "drug",
      "display" : "Drug"
    }
  ]
}
InsurancePlan.plan.specificCost 0..* BackboneElement Pharmacy benefit type specific cost
InsurancePlan.plan.specificCost.category 1..1 CodeableConcept General category of benefit
Binding: Pharmacy benefit types (extensible)
InsurancePlan.plan.specificCost.benefit 0..* BackboneElement Drug tier benefit
InsurancePlan.plan.specificCost.benefit.type 1..1 CodeableConcept Type of specific benefit
Binding: Drug tier of medication in health plan (extensible)

doco Documentation for this format

Terminology Bindings (Differential)

Path Status Usage ValueSet Version Source
InsurancePlan.plan.specificCost.​category Base extensible Pharmacy benefit types 📦3.0.0-ballot This IG
InsurancePlan.plan.specificCost.​benefit.type Base extensible Drug tier of medication in health plan 📦3.0.0-ballot This IG

Snapshot ViewView

NameFlagsCard.TypeDescription & Constraints    Filter: doco
InsurancePlan C 0..* InsurancePlan Details of a Health Insurance product/plan provided by an organization
Constraints: ipn-1
InsurancePlan.id This element is included in summaries. 0..1 id Logical id of this artifact
InsurancePlan.meta This element is included in summaries. 0..1 Meta Metadata about the resource
InsurancePlan.implicitRules This element is a modifier element. This element is included in summaries. 0..1 uri A set of rules under which this content was created
InsurancePlan.language 0..1 code Language of the resource content
Binding: CommonLanguages (preferred): A human language.
Additional BindingsPurpose
AllLanguages Max Binding
InsurancePlan.text 0..1 Narrative Text summary of the resource, for human interpretation
This profile does not constrain the narrative in regard to content, language, or traceability to data elements
InsurancePlan.contained 0..* Resource Contained, inline Resources
InsurancePlan.extension 0..* Extension Additional content defined by implementations
InsurancePlan.modifierExtension This element is a modifier element. 0..* Extension Extensions that cannot be ignored
InsurancePlan.identifier This element must be supported. This element is included in summaries. C 1..* Identifier Business Identifier for Product
InsurancePlan.status This element is a modifier element. This element must be supported. This element is included in summaries. 1..1 code draft | active | retired | unknown
Binding: PublicationStatus (required): The lifecycle status of an artifact.
InsurancePlan.type This element must be supported. This element is included in summaries. 1..1 CodeableConcept Plan type
Binding: InsurancePlanType (example): Used to categorize the product/plan.

Required Pattern:
{
  "coding" : [
    {
      "system" : "http://terminology.hl7.org/CodeSystem/v3-ActCode",
      "code" : "DRUGPOL"
    }
  ]
}
InsurancePlan.name This element must be supported. This element is included in summaries. C 0..1 string Official name
InsurancePlan.alias 0..* string Alternate names
InsurancePlan.period This element must be supported. 0..1 Period When the product is available
InsurancePlan.ownedBy This element is included in summaries. 0..1 Reference(Organization) Plan issuer
InsurancePlan.administeredBy This element is included in summaries. 0..1 Reference(Organization) Product administrator
InsurancePlan.coverageArea This element is included in summaries. 0..* Reference(Location) Where product applies
InsurancePlan.contact 0..* BackboneElement Contact for the product
InsurancePlan.contact.id 0..1 string Unique id for inter-element referencing
InsurancePlan.contact.extension 0..* Extension Additional content defined by implementations
InsurancePlan.contact.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
InsurancePlan.contact.purpose 0..1 CodeableConcept The type of contact
Binding: ContactEntityType (extensible): The purpose for which you would contact a contact party.
InsurancePlan.contact.name 0..1 HumanName A name associated with the contact
InsurancePlan.contact.telecom 0..* ContactPoint Contact details (telephone, email, etc.) for a contact
InsurancePlan.contact.address 0..1 Address Visiting or postal addresses for the contact
InsurancePlan.endpoint 0..* Reference(Endpoint) Technical endpoint
InsurancePlan.network 0..* Reference(Organization) What networks are Included
InsurancePlan.coverage 0..* BackboneElement Coverage details
InsurancePlan.coverage.id 0..1 string Unique id for inter-element referencing
InsurancePlan.coverage.extension 0..* Extension Additional content defined by implementations
InsurancePlan.coverage.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
InsurancePlan.coverage.type 1..1 CodeableConcept Type of coverage
InsurancePlan.coverage.network 0..* Reference(Organization) What networks provide coverage
InsurancePlan.coverage.benefit 1..* BackboneElement List of benefits
InsurancePlan.coverage.benefit.id 0..1 string Unique id for inter-element referencing
InsurancePlan.coverage.benefit.extension 0..* Extension Additional content defined by implementations
InsurancePlan.coverage.benefit.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
InsurancePlan.coverage.benefit.type 1..1 CodeableConcept Type of benefit
InsurancePlan.coverage.benefit.requirement 0..1 string Referral requirements
InsurancePlan.coverage.benefit.limit 0..* BackboneElement Benefit limits
InsurancePlan.coverage.benefit.limit.id 0..1 string Unique id for inter-element referencing
InsurancePlan.coverage.benefit.limit.extension 0..* Extension Additional content defined by implementations
InsurancePlan.coverage.benefit.limit.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
InsurancePlan.coverage.benefit.limit.value 0..1 Quantity Maximum value allowed
InsurancePlan.coverage.benefit.limit.code 0..1 CodeableConcept Benefit limit details
InsurancePlan.plan 0..1 BackboneElement Optional non-cost related plan information indicating pharmacy benefit types and drug tiers available in the formulary
InsurancePlan.plan.id 0..1 string Unique id for inter-element referencing
InsurancePlan.plan.extension 0..* Extension Additional content defined by implementations
InsurancePlan.plan.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
InsurancePlan.plan.identifier This element is included in summaries. 0..* Identifier Business Identifier for Product
InsurancePlan.plan.type 1..1 CodeableConcept Type of plan
Required Pattern:
{
  "coding" : [
    {
      "system" : "http://terminology.hl7.org/CodeSystem/insurance-plan-type",
      "code" : "drug",
      "display" : "Drug"
    }
  ]
}
InsurancePlan.plan.coverageArea This element is included in summaries. 0..* Reference(Location) Where product applies
InsurancePlan.plan.network 0..* Reference(Organization) What networks provide coverage
InsurancePlan.plan.generalCost 0..* BackboneElement Overall costs
InsurancePlan.plan.generalCost.id 0..1 string Unique id for inter-element referencing
InsurancePlan.plan.generalCost.extension 0..* Extension Additional content defined by implementations
InsurancePlan.plan.generalCost.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
InsurancePlan.plan.generalCost.type 0..1 CodeableConcept Type of cost
InsurancePlan.plan.generalCost.groupSize 0..1 positiveInt Number of enrollees
InsurancePlan.plan.generalCost.cost 0..1 Money Cost value
InsurancePlan.plan.generalCost.comment 0..1 string Additional cost information
InsurancePlan.plan.specificCost 0..* BackboneElement Pharmacy benefit type specific cost
InsurancePlan.plan.specificCost.id 0..1 string Unique id for inter-element referencing
InsurancePlan.plan.specificCost.extension 0..* Extension Additional content defined by implementations
InsurancePlan.plan.specificCost.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
InsurancePlan.plan.specificCost.category 1..1 CodeableConcept General category of benefit
Binding: Pharmacy benefit types (extensible)
InsurancePlan.plan.specificCost.benefit 0..* BackboneElement Drug tier benefit
InsurancePlan.plan.specificCost.benefit.id 0..1 string Unique id for inter-element referencing
InsurancePlan.plan.specificCost.benefit.extension 0..* Extension Additional content defined by implementations
InsurancePlan.plan.specificCost.benefit.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
InsurancePlan.plan.specificCost.benefit.type 1..1 CodeableConcept Type of specific benefit
Binding: Drug tier of medication in health plan (extensible)
InsurancePlan.plan.specificCost.benefit.cost 0..* BackboneElement List of the costs
InsurancePlan.plan.specificCost.benefit.cost.id 0..1 string Unique id for inter-element referencing
InsurancePlan.plan.specificCost.benefit.cost.extension 0..* Extension Additional content defined by implementations
InsurancePlan.plan.specificCost.benefit.cost.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
InsurancePlan.plan.specificCost.benefit.cost.type 1..1 CodeableConcept Type of cost
InsurancePlan.plan.specificCost.benefit.cost.applicability 0..1 CodeableConcept in-network | out-of-network | other
Binding: BenefitCostApplicability (required): Whether the cost applies to in-network or out-of-network providers.
InsurancePlan.plan.specificCost.benefit.cost.qualifiers 0..* CodeableConcept Additional information about the cost
InsurancePlan.plan.specificCost.benefit.cost.value 0..1 Quantity The actual cost value

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
InsurancePlan.language Base preferred Common Languages 📍4.0.1 FHIR Std.
InsurancePlan.status Base required PublicationStatus 📍4.0.1 FHIR Std.
InsurancePlan.type Base example Insurance plan type 📍4.0.1 FHIR Std.
InsurancePlan.contact.​purpose Base extensible Contact entity type 📍4.0.1 FHIR Std.
InsurancePlan.plan.specificCost.​category Base extensible Pharmacy benefit types 📦3.0.0-ballot This IG
InsurancePlan.plan.specificCost.​benefit.type Base extensible Drug tier of medication in health plan 📦3.0.0-ballot This IG
InsurancePlan.plan.specificCost.​benefit.cost.applicability Base required Benefit cost applicability 📍4.0.1 FHIR Std.

Constraints

Id Grade Path(s) Description Expression

This structure is derived from InsurancePlan

Summary

Mandatory: 3 elements(1 nested mandatory element)
Must-Support: 5 elements

Maturity: 2

 

Other representations of profile: CSV, Excel, Schematron