QI-Core Implementation Guide
7.0.0 - STU7 United States of America flag

QI-Core Implementation Guide, published by HL7 International / Clinical Quality Information. This guide is not an authorized publication; it is the continuous build for version 7.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-qi-core/ and changes regularly. See the Directory of published versions

Resource Profile: QICore Coverage

Official URL: http://hl7.org/fhir/us/qicore/StructureDefinition/qicore-coverage Version: 7.0.0
Active as of 2018-08-22 Computable Name: QICoreCoverage

Profile of Coverage for decision support/quality metrics. Defines the core set of elements and extensions for quality rule and measure authors.

Must Have:
  • identifier.type: Member Number identifier type
  • status: active | cancelled | draft | entered-in-error
  • beneficiary: (QI) Plan beneficiary
  • relationship: Beneficiary relationship to the subscriber
  • payor: (QI) Issuer of the policy
  • class.value: Group Number
  • class.value: Plan Number
QI Elements:
  • type: (QI) Coverage category such as medical or accident
  • policyHolder: Owner of the policy
  • subscriberId: (QI) ID assigned to the subscriber
  • period: (QI) Coverage start and end dates
Primary code path: type
(PCPath) This element is the primary code path for this resource CQL Retrieve


NOTE TO BALLOT REVIEWERS:
  • US Core 7.0, and thus QI-Core 7.0, has a new approach to USCDI requirements.
    • As noted in the US Core 7.0 Must Support section, US Core 7.0 no longer highlights mandatory (cardinality 1..* or 1..1) and Must Support elements with a (USCDI) indicator as such items must be supported for interoperability.
    • Those USCDI elements that are not mandatory or Must Support now include an indicator (ADDITIONAL USCDI) in US Core. QI-Core 7.0 does not reference USCDI elements; rather, users should access US Core 7.0 to understand its implementation of USCDI version 4.
  • We invite comments about the approach and suggestions for other options that would also avoid unnecessary noise or reading load to the QI-Core profile representation.
  • Further, QI-Core 7.0 does not discuss USCDI+Quality because at the time of ballot preparation, no published version of USCDI+Quality is available. We seek reviewer advice regarding how QI-Core might address future USCDI+Quality.

Usage

See the patterns page for implementation and usage patterns. 

define "SDE Payer":
  [Coverage: type in "Payer"] Payer
    return {
      code: Payer.type,
      period: Payer.period
    }

Examples

General Person Primary Coverage Example
General Subscriber ID Coverage Example

Usage:

Formal Views of Profile Content

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

This structure is derived from USCoreCoverageProfile

NameFlagsCard.TypeDescription & Constraintsdoco
.. Coverage 0..* USCoreCoverageProfile Insurance or medical plan or a payment agreement
... type 0..1 CodeableConcept (QI) Coverage category such as medical or accident
Binding: Payer Type . (extensible): Categories of types of health care payor entities as defined by the US Public Health Data Consortium SOP code system

... policyHolder 0..1 Reference(QICore Patient | QICore Organization | QICore RelatedPerson) (QI) Owner of the policy
... subscriberId 0..1 string (QI) ID assigned to the subscriber
... period 0..1 Period (QI) Coverage start and end dates
... payor 1..1 Reference(QICore Patient | QICore Organization | QICore RelatedPerson) (QI) Issuer of the policy

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSetURI
Coverage.typeextensiblePayerType . (a valid code from Source of Payment Typology (https://nahdo.org/sopt)
http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.114222.4.11.3591
NameFlagsCard.TypeDescription & Constraintsdoco
.. Coverage C 0..* USCoreCoverageProfile Insurance or medical plan or a payment agreement
us-core-15: Member Id in Coverage.identifier or Coverage.subscriberId SHALL be present
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... Slices for identifier SΣ 0..* Identifier Member ID and other identifiers
Slice: Unordered, Open by pattern:type
.... identifier:memberid SΣC 0..1 Identifier Member ID
..... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .

..... type SΣ 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: At least the following
...... coding 1..* Coding Code defined by a terminology system
Fixed Value: (complex)
....... system 1..1 uri Identity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0203
....... code 1..1 code Symbol in syntax defined by the system
Fixed Value: MB
... type SΣ 0..1 CodeableConcept (QI) Coverage category such as medical or accident
Binding: Payer Type . (extensible): Categories of types of health care payor entities as defined by the US Public Health Data Consortium SOP code system

... policyHolder Σ 0..1 Reference(QICore Patient | QICore Organization | QICore RelatedPerson) (QI) Owner of the policy
... subscriberId SΣC 0..1 string (QI) ID assigned to the subscriber
... beneficiary SΣ 1..1 Reference(QICore Patient) (QI) Plan beneficiary
... relationship S 1..1 CodeableConcept Beneficiary relationship to the subscriber
Binding: SubscriberRelationshipCodes (extensible)
... period SΣ 0..1 Period (QI) Coverage start and end dates
... payor SΣ 1..1 Reference(QICore Patient | QICore Organization | QICore RelatedPerson) (QI) Issuer of the policy
... Slices for class S 0..* BackboneElement Additional coverage classifications
Slice: Unordered, Open by pattern:type
.... class:All Slices Content/Rules for all slices
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... type Σ 1..1 CodeableConcept Type of class such as 'group' or 'plan'
Binding: CoverageClassCodes (extensible): The policy classifications, eg. Group, Plan, Class, etc.

..... value Σ 1..1 string Value associated with the type
.... class:group S 0..1 BackboneElement Group
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... type Σ 1..1 CodeableConcept Type of class such as 'group' or 'plan'
Binding: CoverageClassCodes (extensible): The policy classifications, eg. Group, Plan, Class, etc.


Required Pattern: At least the following
...... coding 1..* Coding Code defined by a terminology system
Fixed Value: (complex)
....... system 1..1 uri Identity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/coverage-class
....... code 1..1 code Symbol in syntax defined by the system
Fixed Value: group
..... value SΣ 1..1 string Group Number
..... name SΣ 0..1 string Group Name
.... class:plan S 0..1 BackboneElement Plan
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... type Σ 1..1 CodeableConcept Type of class such as 'group' or 'plan'
Binding: CoverageClassCodes (extensible): The policy classifications, eg. Group, Plan, Class, etc.


Required Pattern: At least the following
...... coding 1..* Coding Code defined by a terminology system
Fixed Value: (complex)
....... system 1..1 uri Identity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/coverage-class
....... code 1..1 code Symbol in syntax defined by the system
Fixed Value: plan
..... value SΣ 1..1 string Plan Number
..... name SΣ 0..1 string Plan Name

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
Coverage.identifier:memberid.userequiredIdentifierUse
http://hl7.org/fhir/ValueSet/identifier-use|4.0.1
from the FHIR Standard
Coverage.identifier:memberid.typeextensiblePattern: MB
http://hl7.org/fhir/ValueSet/identifier-type
from the FHIR Standard
Coverage.statusrequiredFinancialResourceStatusCodes
http://hl7.org/fhir/ValueSet/fm-status|4.0.1
from the FHIR Standard
Coverage.typeextensiblePayerType . (a valid code from Source of Payment Typology (https://nahdo.org/sopt)
http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.114222.4.11.3591
Coverage.relationshipextensibleSubscriberRelationshipCodes
http://hl7.org/fhir/ValueSet/subscriber-relationship
from the FHIR Standard
Coverage.class.typeextensibleCoverageClassCodes
http://hl7.org/fhir/ValueSet/coverage-class
from the FHIR Standard
Coverage.class:group.typeextensiblePattern: group
http://hl7.org/fhir/ValueSet/coverage-class
from the FHIR Standard
Coverage.class:plan.typeextensiblePattern: plan
http://hl7.org/fhir/ValueSet/coverage-class
from the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
dom-2errorCoverageIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorCoverageIf the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource
: contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4errorCoverageIf a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated
: contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5errorCoverageIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceCoverageA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()
us-core-15errorCoverageMember Id in Coverage.identifier or Coverage.subscriberId SHALL be present
: identifier.type.coding.where(system='http://terminology.hl7.org/CodeSystem/v2-0203' and code='MB').exists() or subscriberId.exists()
NameFlagsCard.TypeDescription & Constraintsdoco
.. Coverage C 0..* USCoreCoverageProfile Insurance or medical plan or a payment agreement
us-core-15: Member Id in Coverage.identifier or Coverage.subscriberId SHALL be present
... id Σ 0..1 id Logical id of this artifact
... meta Σ 0..1 Meta Metadata about the resource
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... text 0..1 Narrative Text summary of the resource, for human interpretation
... contained 0..* Resource Contained, inline Resources
... extension 0..* Extension Additional content defined by implementations
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... Slices for identifier SΣ 0..* Identifier Member ID and other identifiers
Slice: Unordered, Open by pattern:type
.... identifier:memberid SΣC 0..1 Identifier Member ID
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .

..... type SΣ 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: At least the following
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
...... coding 1..* Coding Code defined by a terminology system
Fixed Value: (complex)
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..* Extension Additional content defined by implementations
....... system 1..1 uri Identity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0203
....... version 0..1 string Version of the system - if relevant
....... code 1..1 code Symbol in syntax defined by the system
Fixed Value: MB
....... display 0..1 string Representation defined by the system
....... userSelected 0..1 boolean If this coding was chosen directly by the user
...... text 0..1 string Plain text representation of the concept
..... system Σ 0..1 uri The namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
..... value Σ 0..1 string The value that is unique
Example General: 123456
..... period Σ 0..1 Period Time period when id is/was valid for use
..... assigner Σ 0..1 Reference(Organization) Organization that issued id (may be just text)
... status ?!SΣ 1..1 code active | cancelled | draft | entered-in-error
Binding: FinancialResourceStatusCodes (required): A code specifying the state of the resource instance.

... type SΣ 0..1 CodeableConcept (QI) Coverage category such as medical or accident
Binding: Payer Type . (extensible): Categories of types of health care payor entities as defined by the US Public Health Data Consortium SOP code system

... policyHolder Σ 0..1 Reference(QICore Patient | QICore Organization | QICore RelatedPerson) (QI) Owner of the policy
... subscriber Σ 0..1 Reference(Patient | RelatedPerson) Subscriber to the policy
... subscriberId SΣC 0..1 string (QI) ID assigned to the subscriber
... beneficiary SΣ 1..1 Reference(QICore Patient) (QI) Plan beneficiary
... dependent Σ 0..1 string Dependent number
... relationship S 1..1 CodeableConcept Beneficiary relationship to the subscriber
Binding: SubscriberRelationshipCodes (extensible)
... period SΣ 0..1 Period (QI) Coverage start and end dates
... payor SΣ 1..1 Reference(QICore Patient | QICore Organization | QICore RelatedPerson) (QI) Issuer of the policy
... Slices for class S 0..* BackboneElement Additional coverage classifications
Slice: Unordered, Open by pattern:type
.... class:All Slices Content/Rules for all slices
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... type Σ 1..1 CodeableConcept Type of class such as 'group' or 'plan'
Binding: CoverageClassCodes (extensible): The policy classifications, eg. Group, Plan, Class, etc.

..... value Σ 1..1 string Value associated with the type
..... name Σ 0..1 string Human readable description of the type and value
.... class:group S 0..1 BackboneElement Group
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... type Σ 1..1 CodeableConcept Type of class such as 'group' or 'plan'
Binding: CoverageClassCodes (extensible): The policy classifications, eg. Group, Plan, Class, etc.


Required Pattern: At least the following
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
...... coding 1..* Coding Code defined by a terminology system
Fixed Value: (complex)
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..* Extension Additional content defined by implementations
....... system 1..1 uri Identity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/coverage-class
....... version 0..1 string Version of the system - if relevant
....... code 1..1 code Symbol in syntax defined by the system
Fixed Value: group
....... display 0..1 string Representation defined by the system
....... userSelected 0..1 boolean If this coding was chosen directly by the user
...... text 0..1 string Plain text representation of the concept
..... value SΣ 1..1 string Group Number
..... name SΣ 0..1 string Group Name
.... class:plan S 0..1 BackboneElement Plan
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... type Σ 1..1 CodeableConcept Type of class such as 'group' or 'plan'
Binding: CoverageClassCodes (extensible): The policy classifications, eg. Group, Plan, Class, etc.


Required Pattern: At least the following
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
...... coding 1..* Coding Code defined by a terminology system
Fixed Value: (complex)
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..* Extension Additional content defined by implementations
....... system 1..1 uri Identity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/coverage-class
....... version 0..1 string Version of the system - if relevant
....... code 1..1 code Symbol in syntax defined by the system
Fixed Value: plan
....... display 0..1 string Representation defined by the system
....... userSelected 0..1 boolean If this coding was chosen directly by the user
...... text 0..1 string Plain text representation of the concept
..... value SΣ 1..1 string Plan Number
..... name SΣ 0..1 string Plan Name
... order Σ 0..1 positiveInt Relative order of the coverage
... network Σ 0..1 string Insurer network
... costToBeneficiary 0..* BackboneElement Patient payments for services/products
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... type Σ 0..1 CodeableConcept Cost category
Binding: CoverageCopayTypeCodes (extensible): The types of services to which patient copayments are specified.

.... value[x] Σ 1..1 The amount or percentage due from the beneficiary
..... valueQuantity Quantity(SimpleQuantity)
..... valueMoney Money
.... exception 0..* BackboneElement Exceptions for patient payments
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... type Σ 1..1 CodeableConcept Exception category
Binding: ExampleCoverageFinancialExceptionCodes (example): The types of exceptions from the part or full value of financial obligations such as copays.

..... period Σ 0..1 Period The effective period of the exception
... subrogation 0..1 boolean Reimbursement to insurer
... contract 0..* Reference(Contract) Contract details

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
Coverage.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
http://hl7.org/fhir/ValueSet/languages
from the FHIR Standard
Coverage.identifier:memberid.userequiredIdentifierUse
http://hl7.org/fhir/ValueSet/identifier-use|4.0.1
from the FHIR Standard
Coverage.identifier:memberid.typeextensiblePattern: MB
http://hl7.org/fhir/ValueSet/identifier-type
from the FHIR Standard
Coverage.statusrequiredFinancialResourceStatusCodes
http://hl7.org/fhir/ValueSet/fm-status|4.0.1
from the FHIR Standard
Coverage.typeextensiblePayerType . (a valid code from Source of Payment Typology (https://nahdo.org/sopt)
http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.114222.4.11.3591
Coverage.relationshipextensibleSubscriberRelationshipCodes
http://hl7.org/fhir/ValueSet/subscriber-relationship
from the FHIR Standard
Coverage.class.typeextensibleCoverageClassCodes
http://hl7.org/fhir/ValueSet/coverage-class
from the FHIR Standard
Coverage.class:group.typeextensiblePattern: group
http://hl7.org/fhir/ValueSet/coverage-class
from the FHIR Standard
Coverage.class:plan.typeextensiblePattern: plan
http://hl7.org/fhir/ValueSet/coverage-class
from the FHIR Standard
Coverage.costToBeneficiary.typeextensibleCoverageCopayTypeCodes
http://hl7.org/fhir/ValueSet/coverage-copay-type
from the FHIR Standard
Coverage.costToBeneficiary.exception.typeexampleExampleCoverageFinancialExceptionCodes
http://hl7.org/fhir/ValueSet/coverage-financial-exception
from the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
dom-2errorCoverageIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorCoverageIf the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource
: contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4errorCoverageIf a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated
: contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5errorCoverageIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceCoverageA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()
us-core-15errorCoverageMember Id in Coverage.identifier or Coverage.subscriberId SHALL be present
: identifier.type.coding.where(system='http://terminology.hl7.org/CodeSystem/v2-0203' and code='MB').exists() or subscriberId.exists()

Differential View

This structure is derived from USCoreCoverageProfile

NameFlagsCard.TypeDescription & Constraintsdoco
.. Coverage 0..* USCoreCoverageProfile Insurance or medical plan or a payment agreement
... type 0..1 CodeableConcept (QI) Coverage category such as medical or accident
Binding: Payer Type . (extensible): Categories of types of health care payor entities as defined by the US Public Health Data Consortium SOP code system

... policyHolder 0..1 Reference(QICore Patient | QICore Organization | QICore RelatedPerson) (QI) Owner of the policy
... subscriberId 0..1 string (QI) ID assigned to the subscriber
... period 0..1 Period (QI) Coverage start and end dates
... payor 1..1 Reference(QICore Patient | QICore Organization | QICore RelatedPerson) (QI) Issuer of the policy

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSetURI
Coverage.typeextensiblePayerType . (a valid code from Source of Payment Typology (https://nahdo.org/sopt)
http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.114222.4.11.3591

Key Elements View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Coverage C 0..* USCoreCoverageProfile Insurance or medical plan or a payment agreement
us-core-15: Member Id in Coverage.identifier or Coverage.subscriberId SHALL be present
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... Slices for identifier SΣ 0..* Identifier Member ID and other identifiers
Slice: Unordered, Open by pattern:type
.... identifier:memberid SΣC 0..1 Identifier Member ID
..... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .

..... type SΣ 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: At least the following
...... coding 1..* Coding Code defined by a terminology system
Fixed Value: (complex)
....... system 1..1 uri Identity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0203
....... code 1..1 code Symbol in syntax defined by the system
Fixed Value: MB
... type SΣ 0..1 CodeableConcept (QI) Coverage category such as medical or accident
Binding: Payer Type . (extensible): Categories of types of health care payor entities as defined by the US Public Health Data Consortium SOP code system

... policyHolder Σ 0..1 Reference(QICore Patient | QICore Organization | QICore RelatedPerson) (QI) Owner of the policy
... subscriberId SΣC 0..1 string (QI) ID assigned to the subscriber
... beneficiary SΣ 1..1 Reference(QICore Patient) (QI) Plan beneficiary
... relationship S 1..1 CodeableConcept Beneficiary relationship to the subscriber
Binding: SubscriberRelationshipCodes (extensible)
... period SΣ 0..1 Period (QI) Coverage start and end dates
... payor SΣ 1..1 Reference(QICore Patient | QICore Organization | QICore RelatedPerson) (QI) Issuer of the policy
... Slices for class S 0..* BackboneElement Additional coverage classifications
Slice: Unordered, Open by pattern:type
.... class:All Slices Content/Rules for all slices
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... type Σ 1..1 CodeableConcept Type of class such as 'group' or 'plan'
Binding: CoverageClassCodes (extensible): The policy classifications, eg. Group, Plan, Class, etc.

..... value Σ 1..1 string Value associated with the type
.... class:group S 0..1 BackboneElement Group
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... type Σ 1..1 CodeableConcept Type of class such as 'group' or 'plan'
Binding: CoverageClassCodes (extensible): The policy classifications, eg. Group, Plan, Class, etc.


Required Pattern: At least the following
...... coding 1..* Coding Code defined by a terminology system
Fixed Value: (complex)
....... system 1..1 uri Identity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/coverage-class
....... code 1..1 code Symbol in syntax defined by the system
Fixed Value: group
..... value SΣ 1..1 string Group Number
..... name SΣ 0..1 string Group Name
.... class:plan S 0..1 BackboneElement Plan
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... type Σ 1..1 CodeableConcept Type of class such as 'group' or 'plan'
Binding: CoverageClassCodes (extensible): The policy classifications, eg. Group, Plan, Class, etc.


Required Pattern: At least the following
...... coding 1..* Coding Code defined by a terminology system
Fixed Value: (complex)
....... system 1..1 uri Identity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/coverage-class
....... code 1..1 code Symbol in syntax defined by the system
Fixed Value: plan
..... value SΣ 1..1 string Plan Number
..... name SΣ 0..1 string Plan Name

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
Coverage.identifier:memberid.userequiredIdentifierUse
http://hl7.org/fhir/ValueSet/identifier-use|4.0.1
from the FHIR Standard
Coverage.identifier:memberid.typeextensiblePattern: MB
http://hl7.org/fhir/ValueSet/identifier-type
from the FHIR Standard
Coverage.statusrequiredFinancialResourceStatusCodes
http://hl7.org/fhir/ValueSet/fm-status|4.0.1
from the FHIR Standard
Coverage.typeextensiblePayerType . (a valid code from Source of Payment Typology (https://nahdo.org/sopt)
http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.114222.4.11.3591
Coverage.relationshipextensibleSubscriberRelationshipCodes
http://hl7.org/fhir/ValueSet/subscriber-relationship
from the FHIR Standard
Coverage.class.typeextensibleCoverageClassCodes
http://hl7.org/fhir/ValueSet/coverage-class
from the FHIR Standard
Coverage.class:group.typeextensiblePattern: group
http://hl7.org/fhir/ValueSet/coverage-class
from the FHIR Standard
Coverage.class:plan.typeextensiblePattern: plan
http://hl7.org/fhir/ValueSet/coverage-class
from the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
dom-2errorCoverageIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorCoverageIf the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource
: contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4errorCoverageIf a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated
: contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5errorCoverageIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceCoverageA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()
us-core-15errorCoverageMember Id in Coverage.identifier or Coverage.subscriberId SHALL be present
: identifier.type.coding.where(system='http://terminology.hl7.org/CodeSystem/v2-0203' and code='MB').exists() or subscriberId.exists()

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Coverage C 0..* USCoreCoverageProfile Insurance or medical plan or a payment agreement
us-core-15: Member Id in Coverage.identifier or Coverage.subscriberId SHALL be present
... id Σ 0..1 id Logical id of this artifact
... meta Σ 0..1 Meta Metadata about the resource
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... text 0..1 Narrative Text summary of the resource, for human interpretation
... contained 0..* Resource Contained, inline Resources
... extension 0..* Extension Additional content defined by implementations
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... Slices for identifier SΣ 0..* Identifier Member ID and other identifiers
Slice: Unordered, Open by pattern:type
.... identifier:memberid SΣC 0..1 Identifier Member ID
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .

..... type SΣ 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: At least the following
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
...... coding 1..* Coding Code defined by a terminology system
Fixed Value: (complex)
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..* Extension Additional content defined by implementations
....... system 1..1 uri Identity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0203
....... version 0..1 string Version of the system - if relevant
....... code 1..1 code Symbol in syntax defined by the system
Fixed Value: MB
....... display 0..1 string Representation defined by the system
....... userSelected 0..1 boolean If this coding was chosen directly by the user
...... text 0..1 string Plain text representation of the concept
..... system Σ 0..1 uri The namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
..... value Σ 0..1 string The value that is unique
Example General: 123456
..... period Σ 0..1 Period Time period when id is/was valid for use
..... assigner Σ 0..1 Reference(Organization) Organization that issued id (may be just text)
... status ?!SΣ 1..1 code active | cancelled | draft | entered-in-error
Binding: FinancialResourceStatusCodes (required): A code specifying the state of the resource instance.

... type SΣ 0..1 CodeableConcept (QI) Coverage category such as medical or accident
Binding: Payer Type . (extensible): Categories of types of health care payor entities as defined by the US Public Health Data Consortium SOP code system

... policyHolder Σ 0..1 Reference(QICore Patient | QICore Organization | QICore RelatedPerson) (QI) Owner of the policy
... subscriber Σ 0..1 Reference(Patient | RelatedPerson) Subscriber to the policy
... subscriberId SΣC 0..1 string (QI) ID assigned to the subscriber
... beneficiary SΣ 1..1 Reference(QICore Patient) (QI) Plan beneficiary
... dependent Σ 0..1 string Dependent number
... relationship S 1..1 CodeableConcept Beneficiary relationship to the subscriber
Binding: SubscriberRelationshipCodes (extensible)
... period SΣ 0..1 Period (QI) Coverage start and end dates
... payor SΣ 1..1 Reference(QICore Patient | QICore Organization | QICore RelatedPerson) (QI) Issuer of the policy
... Slices for class S 0..* BackboneElement Additional coverage classifications
Slice: Unordered, Open by pattern:type
.... class:All Slices Content/Rules for all slices
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... type Σ 1..1 CodeableConcept Type of class such as 'group' or 'plan'
Binding: CoverageClassCodes (extensible): The policy classifications, eg. Group, Plan, Class, etc.

..... value Σ 1..1 string Value associated with the type
..... name Σ 0..1 string Human readable description of the type and value
.... class:group S 0..1 BackboneElement Group
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... type Σ 1..1 CodeableConcept Type of class such as 'group' or 'plan'
Binding: CoverageClassCodes (extensible): The policy classifications, eg. Group, Plan, Class, etc.


Required Pattern: At least the following
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
...... coding 1..* Coding Code defined by a terminology system
Fixed Value: (complex)
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..* Extension Additional content defined by implementations
....... system 1..1 uri Identity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/coverage-class
....... version 0..1 string Version of the system - if relevant
....... code 1..1 code Symbol in syntax defined by the system
Fixed Value: group
....... display 0..1 string Representation defined by the system
....... userSelected 0..1 boolean If this coding was chosen directly by the user
...... text 0..1 string Plain text representation of the concept
..... value SΣ 1..1 string Group Number
..... name SΣ 0..1 string Group Name
.... class:plan S 0..1 BackboneElement Plan
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... type Σ 1..1 CodeableConcept Type of class such as 'group' or 'plan'
Binding: CoverageClassCodes (extensible): The policy classifications, eg. Group, Plan, Class, etc.


Required Pattern: At least the following
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
...... coding 1..* Coding Code defined by a terminology system
Fixed Value: (complex)
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..* Extension Additional content defined by implementations
....... system 1..1 uri Identity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/coverage-class
....... version 0..1 string Version of the system - if relevant
....... code 1..1 code Symbol in syntax defined by the system
Fixed Value: plan
....... display 0..1 string Representation defined by the system
....... userSelected 0..1 boolean If this coding was chosen directly by the user
...... text 0..1 string Plain text representation of the concept
..... value SΣ 1..1 string Plan Number
..... name SΣ 0..1 string Plan Name
... order Σ 0..1 positiveInt Relative order of the coverage
... network Σ 0..1 string Insurer network
... costToBeneficiary 0..* BackboneElement Patient payments for services/products
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... type Σ 0..1 CodeableConcept Cost category
Binding: CoverageCopayTypeCodes (extensible): The types of services to which patient copayments are specified.

.... value[x] Σ 1..1 The amount or percentage due from the beneficiary
..... valueQuantity Quantity(SimpleQuantity)
..... valueMoney Money
.... exception 0..* BackboneElement Exceptions for patient payments
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... type Σ 1..1 CodeableConcept Exception category
Binding: ExampleCoverageFinancialExceptionCodes (example): The types of exceptions from the part or full value of financial obligations such as copays.

..... period Σ 0..1 Period The effective period of the exception
... subrogation 0..1 boolean Reimbursement to insurer
... contract 0..* Reference(Contract) Contract details

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
Coverage.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
http://hl7.org/fhir/ValueSet/languages
from the FHIR Standard
Coverage.identifier:memberid.userequiredIdentifierUse
http://hl7.org/fhir/ValueSet/identifier-use|4.0.1
from the FHIR Standard
Coverage.identifier:memberid.typeextensiblePattern: MB
http://hl7.org/fhir/ValueSet/identifier-type
from the FHIR Standard
Coverage.statusrequiredFinancialResourceStatusCodes
http://hl7.org/fhir/ValueSet/fm-status|4.0.1
from the FHIR Standard
Coverage.typeextensiblePayerType . (a valid code from Source of Payment Typology (https://nahdo.org/sopt)
http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.114222.4.11.3591
Coverage.relationshipextensibleSubscriberRelationshipCodes
http://hl7.org/fhir/ValueSet/subscriber-relationship
from the FHIR Standard
Coverage.class.typeextensibleCoverageClassCodes
http://hl7.org/fhir/ValueSet/coverage-class
from the FHIR Standard
Coverage.class:group.typeextensiblePattern: group
http://hl7.org/fhir/ValueSet/coverage-class
from the FHIR Standard
Coverage.class:plan.typeextensiblePattern: plan
http://hl7.org/fhir/ValueSet/coverage-class
from the FHIR Standard
Coverage.costToBeneficiary.typeextensibleCoverageCopayTypeCodes
http://hl7.org/fhir/ValueSet/coverage-copay-type
from the FHIR Standard
Coverage.costToBeneficiary.exception.typeexampleExampleCoverageFinancialExceptionCodes
http://hl7.org/fhir/ValueSet/coverage-financial-exception
from the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
dom-2errorCoverageIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorCoverageIf the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource
: contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4errorCoverageIf a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated
: contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5errorCoverageIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceCoverageA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()
us-core-15errorCoverageMember Id in Coverage.identifier or Coverage.subscriberId SHALL be present
: identifier.type.coding.where(system='http://terminology.hl7.org/CodeSystem/v2-0203' and code='MB').exists() or subscriberId.exists()

 

Other representations of profile: CSV, Excel, Schematron