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: Insurance Plan Coverage

Official URL: http://hl7.org/fhir/us/davinci-drug-formulary/StructureDefinition/insurance-plan-coverage Version: 3.0.0-ballot
Standards status: Trial-use Maturity Level: 2 Computable Name: InsurancePlanCoverage
Other Identifiers: OID:2.25.74595174031514506193398850787025340071.42.1

Coverage for an insurance plan

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
Coverage C 0..* USCoreCoverageProfile(7.0.0) Insurance or medical plan or a payment agreement
Constraints: us-core-15
Coverage.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
Coverage.Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Coverage.Slices for extension.extension:insurancePlan This element must be supported. 0..1 Reference(Cross-version Profile for R5.InsurancePlan for use in FHIR R4(0.1.0) | InsurancePlan) Insurance plan details, pre-adopted from FHIR R5
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Coverage.insurancePlan
Constraints: ext-1
Coverage.modifierExtension This element is a modifier element. 0..* Extension Extensions that cannot be ignored
Coverage.Slices for identifier This element must be supported. This element is included in summaries. 0..* Identifier Member ID and other identifiers
Slice: Unordered, Open by pattern:type

Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
Coverage.Slices for identifier.identifier:memberid This element must be supported. This element is included in summaries. C 0..1 Identifier Member ID
Coverage.Slices for identifier.identifier:memberid.use This element is a modifier element. This element is included in summaries. 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
Coverage.Slices for identifier.identifier:memberid.type This element must be supported. This element is included in summaries. 1..1 CodeableConcept Member Number identifier type
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.
Required Pattern:
{
  "coding" : [
    {
      "system" : "http://terminology.hl7.org/CodeSystem/v2-0203",
      "code" : "MB"
    }
  ]
}
Coverage.status This element is a modifier element. This element must be supported. This element is included in summaries. 1..1 code active | cancelled | draft | entered-in-error
Binding: FinancialResourceStatusCodes (required): A code specifying the state of the resource instance.
Coverage.type This element must be supported. This element is included in summaries. 0..1 CodeableConcept Coverage category such as medical or accident
Binding: Payer Type (extensible): US Public Health Data Consortium Source of Payment Codes
Coverage.subscriberId This element must be supported. This element is included in summaries. C 0..1 string ID assigned to the subscriber
Coverage.beneficiary This element must be supported. This element is included in summaries. 1..1 Reference(US Core Patient Profile(7.0.0)) Plan beneficiary
Coverage.relationship This element must be supported. 1..1 CodeableConcept Beneficiary relationship to the subscriber
Binding: SubscriberRelationshipCodes (extensible)
Coverage.period This element must be supported. This element is included in summaries. 0..1 Period Coverage start and end dates
Coverage.payor This element must be supported. This element is included in summaries. 1..1 Reference(US Core Organization Profile(7.0.0) This type must be supported. | US Core Patient Profile(7.0.0) | US Core RelatedPerson Profile(7.0.0)) Issuer of the policy
Coverage.Slices for class This element must be supported. 0..* BackboneElement Additional coverage classifications
Slice: Unordered, Open by pattern:type

Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
Coverage.Slices for class.class:All Slices Content/Rules for all slices
Coverage.Slices for class.class:All Slices.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
Coverage.Slices for class.class:All Slices.type This element is included in summaries. 1..1 CodeableConcept Type of class such as 'group' or 'plan'
Binding: CoverageClassCodes (extensible): The policy classifications, eg. Group, Plan, Class, etc.
Coverage.Slices for class.class:All Slices.value This element is included in summaries. 1..1 string Value associated with the type
Coverage.Slices for class.class:group This element must be supported. 0..1 BackboneElement Group
Coverage.Slices for class.class:group.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
Coverage.Slices for class.class:group.type This element is included in summaries. 1..1 CodeableConcept Type of class such as 'group' or 'plan'
Binding: CoverageClassCodes (extensible): The policy classifications, eg. Group, Plan, Class, etc.
Required Pattern:
{
  "coding" : [
    {
      "system" : "http://terminology.hl7.org/CodeSystem/coverage-class",
      "code" : "group"
    }
  ]
}
Coverage.Slices for class.class:group.value This element must be supported. This element is included in summaries. 1..1 string Group Number
Coverage.Slices for class.class:group.name This element must be supported. This element is included in summaries. 0..1 string Group Name
Coverage.Slices for class.class:plan This element must be supported. 0..1 BackboneElement Plan
Coverage.Slices for class.class:plan.Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Coverage.Slices for class.class:plan.Slices for extension Content/Rules for all slices
Coverage.Slices for class.class:plan.Slices for extension.extension:valueIdentifier This element must be supported. 0..1 Identifier Value associated with the type, pre-adopted from FHIR R5 since it is just a string in R4
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Coverage.class.value
Constraints: ext-1
Coverage.Slices for class.class:plan.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
Coverage.Slices for class.class:plan.type This element is included in summaries. 1..1 CodeableConcept Type of class such as 'group' or 'plan'
Binding: CoverageClassCodes (extensible): The policy classifications, eg. Group, Plan, Class, etc.
Required Pattern:
{
  "coding" : [
    {
      "system" : "http://terminology.hl7.org/CodeSystem/coverage-class",
      "code" : "plan"
    }
  ]
}
Coverage.Slices for class.class:plan.value This element must be supported. This element is included in summaries. 1..1 string Plan Number
Coverage.Slices for class.class:plan.name This element must be supported. This element is included in summaries. 0..1 string Plan Name

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Coverage.identifier:memberid.​use Base required IdentifierUse 📍4.0.1 FHIR Std.
Coverage.identifier:memberid.​type Base extensible IdentifierType 📦4.0.1 FHIR Std.
Coverage.status Base required Financial Resource Status Codes 📍4.0.1 FHIR Std.
Coverage.type Base extensible Payer Type 📦20221118 VSAC v0.19
Coverage.relationship Base extensible SubscriberPolicyholder Relationship Codes 📦4.0.1 FHIR Std.
Coverage.class.type Base extensible Coverage Class Codes 📦4.0.1 FHIR Std.
Coverage.class:group.​type Base extensible Coverage Class Codes 📦4.0.1 FHIR Std.
Coverage.class:plan.​type Base extensible Coverage Class Codes 📦4.0.1 FHIR Std.

Constraints

Id Grade Path(s) Description Expression

This structure is derived from USCoreCoverageProfile

NameFlagsCard.TypeDescription & Constraints    Filter: doco
Coverage 0..* USCoreCoverageProfile(7.0.0) Insurance or medical plan or a payment agreement
Coverage.Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Coverage.Slices for extension.extension:insurancePlan This element must be supported. 0..1 Reference(Cross-version Profile for R5.InsurancePlan for use in FHIR R4(0.1.0) | InsurancePlan) Insurance plan details, pre-adopted from FHIR R5
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Coverage.insurancePlan
Coverage.Slices for class Content/Rules for all slices
Coverage.Slices for class.class:plan 0..1 BackboneElement Plan
Coverage.Slices for class.class:plan.Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Coverage.Slices for class.class:plan.Slices for extension Content/Rules for all slices
Coverage.Slices for class.class:plan.Slices for extension.extension:valueIdentifier This element must be supported. 0..1 Identifier Value associated with the type, pre-adopted from FHIR R5 since it is just a string in R4
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Coverage.class.value

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraints    Filter: doco
Coverage C 0..* USCoreCoverageProfile(7.0.0) Insurance or medical plan or a payment agreement
Constraints: us-core-15
Coverage.id This element is included in summaries. 0..1 id Logical id of this artifact
Coverage.meta This element is included in summaries. 0..1 Meta Metadata about the resource
Coverage.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
Coverage.language 0..1 code Language of the resource content
Binding: CommonLanguages (preferred): A human language.
Additional BindingsPurpose
AllLanguages Max Binding
Coverage.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
Coverage.contained 0..* Resource Contained, inline Resources
Coverage.Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Coverage.Slices for extension.extension:insurancePlan This element must be supported. 0..1 Reference(Cross-version Profile for R5.InsurancePlan for use in FHIR R4(0.1.0) | InsurancePlan) Insurance plan details, pre-adopted from FHIR R5
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Coverage.insurancePlan
Constraints: ext-1
Coverage.modifierExtension This element is a modifier element. 0..* Extension Extensions that cannot be ignored
Coverage.Slices for identifier This element must be supported. This element is included in summaries. 0..* Identifier Member ID and other identifiers
Slice: Unordered, Open by pattern:type

Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
Coverage.Slices for identifier.identifier:memberid This element must be supported. This element is included in summaries. C 0..1 Identifier Member ID
Coverage.Slices for identifier.identifier:memberid.id 0..1 string Unique id for inter-element referencing
Coverage.Slices for identifier.identifier:memberid.extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
Coverage.Slices for identifier.identifier:memberid.use This element is a modifier element. This element is included in summaries. 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
Coverage.Slices for identifier.identifier:memberid.type This element must be supported. This element is included in summaries. 1..1 CodeableConcept Member Number identifier type
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.
Required Pattern:
{
  "coding" : [
    {
      "system" : "http://terminology.hl7.org/CodeSystem/v2-0203",
      "code" : "MB"
    }
  ]
}
Coverage.Slices for identifier.identifier:memberid.system This element is included in summaries. 0..1 uri The namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
Coverage.Slices for identifier.identifier:memberid.value This element is included in summaries. 0..1 string The value that is unique
Example General: 123456
Coverage.Slices for identifier.identifier:memberid.period This element is included in summaries. 0..1 Period Time period when id is/was valid for use
Coverage.Slices for identifier.identifier:memberid.assigner This element is included in summaries. 0..1 Reference(Organization) Organization that issued id (may be just text)
Coverage.status This element is a modifier element. This element must be supported. This element is included in summaries. 1..1 code active | cancelled | draft | entered-in-error
Binding: FinancialResourceStatusCodes (required): A code specifying the state of the resource instance.
Coverage.type This element must be supported. This element is included in summaries. 0..1 CodeableConcept Coverage category such as medical or accident
Binding: Payer Type (extensible): US Public Health Data Consortium Source of Payment Codes
Coverage.policyHolder This element is included in summaries. 0..1 Reference(Patient | RelatedPerson | Organization) Owner of the policy
Coverage.subscriber This element is included in summaries. 0..1 Reference(Patient | RelatedPerson) Subscriber to the policy
Coverage.subscriberId This element must be supported. This element is included in summaries. C 0..1 string ID assigned to the subscriber
Coverage.beneficiary This element must be supported. This element is included in summaries. 1..1 Reference(US Core Patient Profile(7.0.0)) Plan beneficiary
Coverage.dependent This element is included in summaries. 0..1 string Dependent number
Coverage.relationship This element must be supported. 1..1 CodeableConcept Beneficiary relationship to the subscriber
Binding: SubscriberRelationshipCodes (extensible)
Coverage.period This element must be supported. This element is included in summaries. 0..1 Period Coverage start and end dates
Coverage.payor This element must be supported. This element is included in summaries. 1..1 Reference(US Core Organization Profile(7.0.0) This type must be supported. | US Core Patient Profile(7.0.0) | US Core RelatedPerson Profile(7.0.0)) Issuer of the policy
Coverage.Slices for class This element must be supported. 0..* BackboneElement Additional coverage classifications
Slice: Unordered, Open by pattern:type

Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
Coverage.Slices for class.class:All Slices Content/Rules for all slices
Coverage.Slices for class.class:All Slices.id 0..1 string Unique id for inter-element referencing
Coverage.Slices for class.class:All Slices.extension 0..* Extension Additional content defined by implementations
Coverage.Slices for class.class:All Slices.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
Coverage.Slices for class.class:All Slices.type This element is included in summaries. 1..1 CodeableConcept Type of class such as 'group' or 'plan'
Binding: CoverageClassCodes (extensible): The policy classifications, eg. Group, Plan, Class, etc.
Coverage.Slices for class.class:All Slices.value This element is included in summaries. 1..1 string Value associated with the type
Coverage.Slices for class.class:All Slices.name This element is included in summaries. 0..1 string Human readable description of the type and value
Coverage.Slices for class.class:group This element must be supported. 0..1 BackboneElement Group
Coverage.Slices for class.class:group.id 0..1 string Unique id for inter-element referencing
Coverage.Slices for class.class:group.extension 0..* Extension Additional content defined by implementations
Coverage.Slices for class.class:group.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
Coverage.Slices for class.class:group.type This element is included in summaries. 1..1 CodeableConcept Type of class such as 'group' or 'plan'
Binding: CoverageClassCodes (extensible): The policy classifications, eg. Group, Plan, Class, etc.
Required Pattern:
{
  "coding" : [
    {
      "system" : "http://terminology.hl7.org/CodeSystem/coverage-class",
      "code" : "group"
    }
  ]
}
Coverage.Slices for class.class:group.value This element must be supported. This element is included in summaries. 1..1 string Group Number
Coverage.Slices for class.class:group.name This element must be supported. This element is included in summaries. 0..1 string Group Name
Coverage.Slices for class.class:plan This element must be supported. 0..1 BackboneElement Plan
Coverage.Slices for class.class:plan.id 0..1 string Unique id for inter-element referencing
Coverage.Slices for class.class:plan.Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Coverage.Slices for class.class:plan.Slices for extension Content/Rules for all slices
Coverage.Slices for class.class:plan.Slices for extension.extension:valueIdentifier This element must be supported. 0..1 Identifier Value associated with the type, pre-adopted from FHIR R5 since it is just a string in R4
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Coverage.class.value
Constraints: ext-1
Coverage.Slices for class.class:plan.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
Coverage.Slices for class.class:plan.type This element is included in summaries. 1..1 CodeableConcept Type of class such as 'group' or 'plan'
Binding: CoverageClassCodes (extensible): The policy classifications, eg. Group, Plan, Class, etc.
Required Pattern:
{
  "coding" : [
    {
      "system" : "http://terminology.hl7.org/CodeSystem/coverage-class",
      "code" : "plan"
    }
  ]
}
Coverage.Slices for class.class:plan.value This element must be supported. This element is included in summaries. 1..1 string Plan Number
Coverage.Slices for class.class:plan.name This element must be supported. This element is included in summaries. 0..1 string Plan Name
Coverage.order This element is included in summaries. 0..1 positiveInt Relative order of the coverage
Coverage.network This element is included in summaries. 0..1 string Insurer network
Coverage.costToBeneficiary 0..* BackboneElement Patient payments for services/products
Coverage.costToBeneficiary.id 0..1 string Unique id for inter-element referencing
Coverage.costToBeneficiary.extension 0..* Extension Additional content defined by implementations
Coverage.costToBeneficiary.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
Coverage.costToBeneficiary.type This element is included in summaries. 0..1 CodeableConcept Cost category
Binding: CoverageCopayTypeCodes (extensible): The types of services to which patient copayments are specified.
Coverage.costToBeneficiary.value[x] This element is included in summaries. 1..1 The amount or percentage due from the beneficiary
Coverage.costToBeneficiary.value[x].valueQuantity Quantity(SimpleQuantity)
Coverage.costToBeneficiary.value[x].valueMoney Money
Coverage.costToBeneficiary.exception 0..* BackboneElement Exceptions for patient payments
Coverage.costToBeneficiary.exception.id 0..1 string Unique id for inter-element referencing
Coverage.costToBeneficiary.exception.extension 0..* Extension Additional content defined by implementations
Coverage.costToBeneficiary.exception.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
Coverage.costToBeneficiary.exception.type This element is included in summaries. 1..1 CodeableConcept Exception category
Binding: ExampleCoverageFinancialExceptionCodes (example): The types of exceptions from the part or full value of financial obligations such as copays.
Coverage.costToBeneficiary.exception.period This element is included in summaries. 0..1 Period The effective period of the exception
Coverage.subrogation 0..1 boolean Reimbursement to insurer
Coverage.contract 0..* Reference(Contract) Contract details

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Coverage.language Base preferred Common Languages 📦4.0.1 FHIR Std.
Coverage.identifier:memberid.​use Base required IdentifierUse 📍4.0.1 FHIR Std.
Coverage.identifier:memberid.​type Base extensible IdentifierType 📦4.0.1 FHIR Std.
Coverage.status Base required Financial Resource Status Codes 📍4.0.1 FHIR Std.
Coverage.type Base extensible Payer Type 📦20221118 VSAC v0.19
Coverage.relationship Base extensible SubscriberPolicyholder Relationship Codes 📦4.0.1 FHIR Std.
Coverage.class.type Base extensible Coverage Class Codes 📦4.0.1 FHIR Std.
Coverage.class:group.​type Base extensible Coverage Class Codes 📦4.0.1 FHIR Std.
Coverage.class:plan.​type Base extensible Coverage Class Codes 📦4.0.1 FHIR Std.
Coverage.costToBeneficiary.​type Base extensible Coverage Copay Type Codes 📦4.0.1 FHIR Std.
Coverage.costToBeneficiary.​exception.type Base example Example Coverage Financial Exception Codes 📦4.0.1 FHIR Std.

Constraints

Id Grade Path(s) Description Expression

This structure is derived from USCoreCoverageProfile

Key Elements View

NameFlagsCard.TypeDescription & Constraints    Filter: doco
Coverage C 0..* USCoreCoverageProfile(7.0.0) Insurance or medical plan or a payment agreement
Constraints: us-core-15
Coverage.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
Coverage.Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Coverage.Slices for extension.extension:insurancePlan This element must be supported. 0..1 Reference(Cross-version Profile for R5.InsurancePlan for use in FHIR R4(0.1.0) | InsurancePlan) Insurance plan details, pre-adopted from FHIR R5
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Coverage.insurancePlan
Constraints: ext-1
Coverage.modifierExtension This element is a modifier element. 0..* Extension Extensions that cannot be ignored
Coverage.Slices for identifier This element must be supported. This element is included in summaries. 0..* Identifier Member ID and other identifiers
Slice: Unordered, Open by pattern:type

Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
Coverage.Slices for identifier.identifier:memberid This element must be supported. This element is included in summaries. C 0..1 Identifier Member ID
Coverage.Slices for identifier.identifier:memberid.use This element is a modifier element. This element is included in summaries. 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
Coverage.Slices for identifier.identifier:memberid.type This element must be supported. This element is included in summaries. 1..1 CodeableConcept Member Number identifier type
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.
Required Pattern:
{
  "coding" : [
    {
      "system" : "http://terminology.hl7.org/CodeSystem/v2-0203",
      "code" : "MB"
    }
  ]
}
Coverage.status This element is a modifier element. This element must be supported. This element is included in summaries. 1..1 code active | cancelled | draft | entered-in-error
Binding: FinancialResourceStatusCodes (required): A code specifying the state of the resource instance.
Coverage.type This element must be supported. This element is included in summaries. 0..1 CodeableConcept Coverage category such as medical or accident
Binding: Payer Type (extensible): US Public Health Data Consortium Source of Payment Codes
Coverage.subscriberId This element must be supported. This element is included in summaries. C 0..1 string ID assigned to the subscriber
Coverage.beneficiary This element must be supported. This element is included in summaries. 1..1 Reference(US Core Patient Profile(7.0.0)) Plan beneficiary
Coverage.relationship This element must be supported. 1..1 CodeableConcept Beneficiary relationship to the subscriber
Binding: SubscriberRelationshipCodes (extensible)
Coverage.period This element must be supported. This element is included in summaries. 0..1 Period Coverage start and end dates
Coverage.payor This element must be supported. This element is included in summaries. 1..1 Reference(US Core Organization Profile(7.0.0) This type must be supported. | US Core Patient Profile(7.0.0) | US Core RelatedPerson Profile(7.0.0)) Issuer of the policy
Coverage.Slices for class This element must be supported. 0..* BackboneElement Additional coverage classifications
Slice: Unordered, Open by pattern:type

Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
Coverage.Slices for class.class:All Slices Content/Rules for all slices
Coverage.Slices for class.class:All Slices.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
Coverage.Slices for class.class:All Slices.type This element is included in summaries. 1..1 CodeableConcept Type of class such as 'group' or 'plan'
Binding: CoverageClassCodes (extensible): The policy classifications, eg. Group, Plan, Class, etc.
Coverage.Slices for class.class:All Slices.value This element is included in summaries. 1..1 string Value associated with the type
Coverage.Slices for class.class:group This element must be supported. 0..1 BackboneElement Group
Coverage.Slices for class.class:group.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
Coverage.Slices for class.class:group.type This element is included in summaries. 1..1 CodeableConcept Type of class such as 'group' or 'plan'
Binding: CoverageClassCodes (extensible): The policy classifications, eg. Group, Plan, Class, etc.
Required Pattern:
{
  "coding" : [
    {
      "system" : "http://terminology.hl7.org/CodeSystem/coverage-class",
      "code" : "group"
    }
  ]
}
Coverage.Slices for class.class:group.value This element must be supported. This element is included in summaries. 1..1 string Group Number
Coverage.Slices for class.class:group.name This element must be supported. This element is included in summaries. 0..1 string Group Name
Coverage.Slices for class.class:plan This element must be supported. 0..1 BackboneElement Plan
Coverage.Slices for class.class:plan.Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Coverage.Slices for class.class:plan.Slices for extension Content/Rules for all slices
Coverage.Slices for class.class:plan.Slices for extension.extension:valueIdentifier This element must be supported. 0..1 Identifier Value associated with the type, pre-adopted from FHIR R5 since it is just a string in R4
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Coverage.class.value
Constraints: ext-1
Coverage.Slices for class.class:plan.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
Coverage.Slices for class.class:plan.type This element is included in summaries. 1..1 CodeableConcept Type of class such as 'group' or 'plan'
Binding: CoverageClassCodes (extensible): The policy classifications, eg. Group, Plan, Class, etc.
Required Pattern:
{
  "coding" : [
    {
      "system" : "http://terminology.hl7.org/CodeSystem/coverage-class",
      "code" : "plan"
    }
  ]
}
Coverage.Slices for class.class:plan.value This element must be supported. This element is included in summaries. 1..1 string Plan Number
Coverage.Slices for class.class:plan.name This element must be supported. This element is included in summaries. 0..1 string Plan Name

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Coverage.identifier:memberid.​use Base required IdentifierUse 📍4.0.1 FHIR Std.
Coverage.identifier:memberid.​type Base extensible IdentifierType 📦4.0.1 FHIR Std.
Coverage.status Base required Financial Resource Status Codes 📍4.0.1 FHIR Std.
Coverage.type Base extensible Payer Type 📦20221118 VSAC v0.19
Coverage.relationship Base extensible SubscriberPolicyholder Relationship Codes 📦4.0.1 FHIR Std.
Coverage.class.type Base extensible Coverage Class Codes 📦4.0.1 FHIR Std.
Coverage.class:group.​type Base extensible Coverage Class Codes 📦4.0.1 FHIR Std.
Coverage.class:plan.​type Base extensible Coverage Class Codes 📦4.0.1 FHIR Std.

Constraints

Id Grade Path(s) Description Expression

Differential View

This structure is derived from USCoreCoverageProfile

NameFlagsCard.TypeDescription & Constraints    Filter: doco
Coverage 0..* USCoreCoverageProfile(7.0.0) Insurance or medical plan or a payment agreement
Coverage.Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Coverage.Slices for extension.extension:insurancePlan This element must be supported. 0..1 Reference(Cross-version Profile for R5.InsurancePlan for use in FHIR R4(0.1.0) | InsurancePlan) Insurance plan details, pre-adopted from FHIR R5
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Coverage.insurancePlan
Coverage.Slices for class Content/Rules for all slices
Coverage.Slices for class.class:plan 0..1 BackboneElement Plan
Coverage.Slices for class.class:plan.Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Coverage.Slices for class.class:plan.Slices for extension Content/Rules for all slices
Coverage.Slices for class.class:plan.Slices for extension.extension:valueIdentifier This element must be supported. 0..1 Identifier Value associated with the type, pre-adopted from FHIR R5 since it is just a string in R4
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Coverage.class.value

doco Documentation for this format

Snapshot ViewView

NameFlagsCard.TypeDescription & Constraints    Filter: doco
Coverage C 0..* USCoreCoverageProfile(7.0.0) Insurance or medical plan or a payment agreement
Constraints: us-core-15
Coverage.id This element is included in summaries. 0..1 id Logical id of this artifact
Coverage.meta This element is included in summaries. 0..1 Meta Metadata about the resource
Coverage.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
Coverage.language 0..1 code Language of the resource content
Binding: CommonLanguages (preferred): A human language.
Additional BindingsPurpose
AllLanguages Max Binding
Coverage.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
Coverage.contained 0..* Resource Contained, inline Resources
Coverage.Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Coverage.Slices for extension.extension:insurancePlan This element must be supported. 0..1 Reference(Cross-version Profile for R5.InsurancePlan for use in FHIR R4(0.1.0) | InsurancePlan) Insurance plan details, pre-adopted from FHIR R5
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Coverage.insurancePlan
Constraints: ext-1
Coverage.modifierExtension This element is a modifier element. 0..* Extension Extensions that cannot be ignored
Coverage.Slices for identifier This element must be supported. This element is included in summaries. 0..* Identifier Member ID and other identifiers
Slice: Unordered, Open by pattern:type

Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
Coverage.Slices for identifier.identifier:memberid This element must be supported. This element is included in summaries. C 0..1 Identifier Member ID
Coverage.Slices for identifier.identifier:memberid.id 0..1 string Unique id for inter-element referencing
Coverage.Slices for identifier.identifier:memberid.extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
Coverage.Slices for identifier.identifier:memberid.use This element is a modifier element. This element is included in summaries. 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
Coverage.Slices for identifier.identifier:memberid.type This element must be supported. This element is included in summaries. 1..1 CodeableConcept Member Number identifier type
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.
Required Pattern:
{
  "coding" : [
    {
      "system" : "http://terminology.hl7.org/CodeSystem/v2-0203",
      "code" : "MB"
    }
  ]
}
Coverage.Slices for identifier.identifier:memberid.system This element is included in summaries. 0..1 uri The namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
Coverage.Slices for identifier.identifier:memberid.value This element is included in summaries. 0..1 string The value that is unique
Example General: 123456
Coverage.Slices for identifier.identifier:memberid.period This element is included in summaries. 0..1 Period Time period when id is/was valid for use
Coverage.Slices for identifier.identifier:memberid.assigner This element is included in summaries. 0..1 Reference(Organization) Organization that issued id (may be just text)
Coverage.status This element is a modifier element. This element must be supported. This element is included in summaries. 1..1 code active | cancelled | draft | entered-in-error
Binding: FinancialResourceStatusCodes (required): A code specifying the state of the resource instance.
Coverage.type This element must be supported. This element is included in summaries. 0..1 CodeableConcept Coverage category such as medical or accident
Binding: Payer Type (extensible): US Public Health Data Consortium Source of Payment Codes
Coverage.policyHolder This element is included in summaries. 0..1 Reference(Patient | RelatedPerson | Organization) Owner of the policy
Coverage.subscriber This element is included in summaries. 0..1 Reference(Patient | RelatedPerson) Subscriber to the policy
Coverage.subscriberId This element must be supported. This element is included in summaries. C 0..1 string ID assigned to the subscriber
Coverage.beneficiary This element must be supported. This element is included in summaries. 1..1 Reference(US Core Patient Profile(7.0.0)) Plan beneficiary
Coverage.dependent This element is included in summaries. 0..1 string Dependent number
Coverage.relationship This element must be supported. 1..1 CodeableConcept Beneficiary relationship to the subscriber
Binding: SubscriberRelationshipCodes (extensible)
Coverage.period This element must be supported. This element is included in summaries. 0..1 Period Coverage start and end dates
Coverage.payor This element must be supported. This element is included in summaries. 1..1 Reference(US Core Organization Profile(7.0.0) This type must be supported. | US Core Patient Profile(7.0.0) | US Core RelatedPerson Profile(7.0.0)) Issuer of the policy
Coverage.Slices for class This element must be supported. 0..* BackboneElement Additional coverage classifications
Slice: Unordered, Open by pattern:type

Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
Coverage.Slices for class.class:All Slices Content/Rules for all slices
Coverage.Slices for class.class:All Slices.id 0..1 string Unique id for inter-element referencing
Coverage.Slices for class.class:All Slices.extension 0..* Extension Additional content defined by implementations
Coverage.Slices for class.class:All Slices.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
Coverage.Slices for class.class:All Slices.type This element is included in summaries. 1..1 CodeableConcept Type of class such as 'group' or 'plan'
Binding: CoverageClassCodes (extensible): The policy classifications, eg. Group, Plan, Class, etc.
Coverage.Slices for class.class:All Slices.value This element is included in summaries. 1..1 string Value associated with the type
Coverage.Slices for class.class:All Slices.name This element is included in summaries. 0..1 string Human readable description of the type and value
Coverage.Slices for class.class:group This element must be supported. 0..1 BackboneElement Group
Coverage.Slices for class.class:group.id 0..1 string Unique id for inter-element referencing
Coverage.Slices for class.class:group.extension 0..* Extension Additional content defined by implementations
Coverage.Slices for class.class:group.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
Coverage.Slices for class.class:group.type This element is included in summaries. 1..1 CodeableConcept Type of class such as 'group' or 'plan'
Binding: CoverageClassCodes (extensible): The policy classifications, eg. Group, Plan, Class, etc.
Required Pattern:
{
  "coding" : [
    {
      "system" : "http://terminology.hl7.org/CodeSystem/coverage-class",
      "code" : "group"
    }
  ]
}
Coverage.Slices for class.class:group.value This element must be supported. This element is included in summaries. 1..1 string Group Number
Coverage.Slices for class.class:group.name This element must be supported. This element is included in summaries. 0..1 string Group Name
Coverage.Slices for class.class:plan This element must be supported. 0..1 BackboneElement Plan
Coverage.Slices for class.class:plan.id 0..1 string Unique id for inter-element referencing
Coverage.Slices for class.class:plan.Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Coverage.Slices for class.class:plan.Slices for extension Content/Rules for all slices
Coverage.Slices for class.class:plan.Slices for extension.extension:valueIdentifier This element must be supported. 0..1 Identifier Value associated with the type, pre-adopted from FHIR R5 since it is just a string in R4
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Coverage.class.value
Constraints: ext-1
Coverage.Slices for class.class:plan.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
Coverage.Slices for class.class:plan.type This element is included in summaries. 1..1 CodeableConcept Type of class such as 'group' or 'plan'
Binding: CoverageClassCodes (extensible): The policy classifications, eg. Group, Plan, Class, etc.
Required Pattern:
{
  "coding" : [
    {
      "system" : "http://terminology.hl7.org/CodeSystem/coverage-class",
      "code" : "plan"
    }
  ]
}
Coverage.Slices for class.class:plan.value This element must be supported. This element is included in summaries. 1..1 string Plan Number
Coverage.Slices for class.class:plan.name This element must be supported. This element is included in summaries. 0..1 string Plan Name
Coverage.order This element is included in summaries. 0..1 positiveInt Relative order of the coverage
Coverage.network This element is included in summaries. 0..1 string Insurer network
Coverage.costToBeneficiary 0..* BackboneElement Patient payments for services/products
Coverage.costToBeneficiary.id 0..1 string Unique id for inter-element referencing
Coverage.costToBeneficiary.extension 0..* Extension Additional content defined by implementations
Coverage.costToBeneficiary.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
Coverage.costToBeneficiary.type This element is included in summaries. 0..1 CodeableConcept Cost category
Binding: CoverageCopayTypeCodes (extensible): The types of services to which patient copayments are specified.
Coverage.costToBeneficiary.value[x] This element is included in summaries. 1..1 The amount or percentage due from the beneficiary
Coverage.costToBeneficiary.value[x].valueQuantity Quantity(SimpleQuantity)
Coverage.costToBeneficiary.value[x].valueMoney Money
Coverage.costToBeneficiary.exception 0..* BackboneElement Exceptions for patient payments
Coverage.costToBeneficiary.exception.id 0..1 string Unique id for inter-element referencing
Coverage.costToBeneficiary.exception.extension 0..* Extension Additional content defined by implementations
Coverage.costToBeneficiary.exception.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
Coverage.costToBeneficiary.exception.type This element is included in summaries. 1..1 CodeableConcept Exception category
Binding: ExampleCoverageFinancialExceptionCodes (example): The types of exceptions from the part or full value of financial obligations such as copays.
Coverage.costToBeneficiary.exception.period This element is included in summaries. 0..1 Period The effective period of the exception
Coverage.subrogation 0..1 boolean Reimbursement to insurer
Coverage.contract 0..* Reference(Contract) Contract details

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Coverage.language Base preferred Common Languages 📦4.0.1 FHIR Std.
Coverage.identifier:memberid.​use Base required IdentifierUse 📍4.0.1 FHIR Std.
Coverage.identifier:memberid.​type Base extensible IdentifierType 📦4.0.1 FHIR Std.
Coverage.status Base required Financial Resource Status Codes 📍4.0.1 FHIR Std.
Coverage.type Base extensible Payer Type 📦20221118 VSAC v0.19
Coverage.relationship Base extensible SubscriberPolicyholder Relationship Codes 📦4.0.1 FHIR Std.
Coverage.class.type Base extensible Coverage Class Codes 📦4.0.1 FHIR Std.
Coverage.class:group.​type Base extensible Coverage Class Codes 📦4.0.1 FHIR Std.
Coverage.class:plan.​type Base extensible Coverage Class Codes 📦4.0.1 FHIR Std.
Coverage.costToBeneficiary.​type Base extensible Coverage Copay Type Codes 📦4.0.1 FHIR Std.
Coverage.costToBeneficiary.​exception.type Base example Example Coverage Financial Exception Codes 📦4.0.1 FHIR Std.

Constraints

Id Grade Path(s) Description Expression

This structure is derived from USCoreCoverageProfile

 

Other representations of profile: CSV, Excel, Schematron