Da Vinci - Member Attribution (ATR) List
2.0.0 - STU 2.0.0 United States of America flag

Da Vinci - Member Attribution (ATR) List, published by HL7 International / Financial Management. This guide is not an authorized publication; it is the continuous build for version 2.0.0 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/HL7/davinci-atr/ and changes regularly. See the Directory of published versions

Resource Profile: ATRCoverage

Official URL: http://hl7.org/fhir/us/davinci-atr/StructureDefinition/atr-coverage Version: 2.0.0
Active as of 2019-09-01 Computable Name: ATRCoverage

This is the Coverage Resource profile for the IG.

Introduction

This profile is used to associate a specific coverage instance to a specific member who is on the Member Attribution List. Since patients can have multiple coverages, it is important to identify the specific coverage instance that led to the patient being on the Member Attribution List. The Coverage instance will contain the member information, payer information and the plan information.

Implementation Requirements

Implementers are advised to read Data Model Requirements to implement the Coverage profile.

APIs : Retrieval of Coverage Resource Instance:

The Coverage instance is retrieved as part of the Bulk API request on the Group resource representing the Member Attribution List.

Usage:

Formal Views of Profile Content

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

This structure is derived from Coverage

NameFlagsCard.TypeDescription & Constraintsdoco
.. Coverage 0..*CoverageDavinci ATR Coverage
... insuranceProductType S0..1CodeableConceptIndicates the Insurance Product Type related to the Coverage.
URL: http://hl7.org/fhir/us/davinci-atr/StructureDefinition/ext-insuranceProductType
Binding: Insurance Product Type VS (extensible)
... Slices for identifier S0..*IdentifierBusiness Identifier for the coverage
Slice: Unordered, Open by value:type.coding.system, value:type.coding.code
.... identifier:MemberIdentifier S0..1IdentifierBusiness Identifier for the coverage
..... type S1..1CodeableConceptDescription of identifier
...... coding S1..1CodingCode defined by a terminology system
....... system S1..1uriIdentity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0203
....... code S1..1codeSymbol in syntax defined by the system
Fixed Value: MB
..... system S1..1uriThe namespace for the identifier value
..... value S1..1stringThe value that is unique
... status S1..1codeactive | cancelled | draft | entered-in-error
Fixed Value: active
... subscriber S0..1Reference(Davinci ATR Patient | Davinci ATR RelatedPerson)Subscriber to the policy
... subscriberId S1..1stringID assigned to the subscriber
... beneficiary S1..1Reference(Davinci ATR Patient)Plan beneficiary
... dependent S0..1stringDependent number
... relationship S0..1CodeableConceptBeneficiary relationship to the subscriber
... period S1..1PeriodCoverage start and end dates
... payor S1..1Reference(Davinci ATR Patient | Davinci ATR RelatedPerson | Davinci ATR Organization)Issuer of the policy
... Slices for class S0..*BackboneElementAdditional coverage classifications
Slice: Unordered, Open by value:type.coding.system, value:type.coding.code
.... class:PlanIdentifier S0..1BackboneElementAdditional coverage classifications
..... type S1..1CodeableConceptType of class such as 'group' or 'plan'
...... coding S1..1CodingCode defined by a terminology system
....... system S1..1uriIdentity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/coverage-class
....... code S1..1codeSymbol in syntax defined by the system
Fixed Value: plan
..... value S1..1stringValue associated with the type

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. Coverage 0..*CoverageDavinci ATR Coverage
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... insuranceProductType S0..1CodeableConceptIndicates the Insurance Product Type related to the Coverage.
URL: http://hl7.org/fhir/us/davinci-atr/StructureDefinition/ext-insuranceProductType
Binding: Insurance Product Type VS (extensible)
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
.... identifier:MemberIdentifier SΣ0..1IdentifierBusiness Identifier for the coverage
..... use ?!Σ0..1codeusual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .

..... type SΣ1..1CodeableConceptDescription of identifier
Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.

...... coding SΣ1..1CodingCode defined by a terminology system
....... system SΣ1..1uriIdentity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0203
....... code SΣ1..1codeSymbol in syntax defined by the system
Fixed Value: MB
..... system SΣ1..1uriThe namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
..... value SΣ1..1stringThe value that is unique
Example General: 123456
... status ?!SΣ1..1codeactive | cancelled | draft | entered-in-error
Binding: FinancialResourceStatusCodes (required): A code specifying the state of the resource instance.


Fixed Value: active
... policyHolder SΣ0..1Reference(Davinci ATR Patient | Davinci ATR RelatedPerson | Davinci ATR Organization)Owner of the policy
... subscriber SΣ0..1Reference(Davinci ATR Patient | Davinci ATR RelatedPerson)Subscriber to the policy
... subscriberId SΣ1..1stringID assigned to the subscriber
... beneficiary SΣ1..1Reference(Davinci ATR Patient)Plan beneficiary
... dependent SΣ0..1stringDependent number
... relationship S0..1CodeableConceptBeneficiary relationship to the subscriber
Binding: SubscriberRelationshipCodes (extensible): The relationship between the Subscriber and the Beneficiary (insured/covered party/patient).

... period SΣ1..1PeriodCoverage start and end dates
... payor SΣ1..1Reference(Davinci ATR Patient | Davinci ATR RelatedPerson | Davinci ATR Organization)Issuer of the policy
... Slices for class S0..*BackboneElementAdditional coverage classifications
Slice: Unordered, Open by value:type.coding.system, value:type.coding.code
.... class:All Slices Content/Rules for all slices
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... type Σ1..1CodeableConceptType of class such as 'group' or 'plan'
Binding: CoverageClassCodes (extensible): The policy classifications, eg. Group, Plan, Class, etc.

..... value Σ1..1stringValue associated with the type
.... class:PlanIdentifier S0..1BackboneElementAdditional coverage classifications
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... type SΣ1..1CodeableConceptType of class such as 'group' or 'plan'
Binding: CoverageClassCodes (extensible): The policy classifications, eg. Group, Plan, Class, etc.

...... coding SΣ1..1CodingCode defined by a terminology system
....... system SΣ1..1uriIdentity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/coverage-class
....... code SΣ1..1codeSymbol in syntax defined by the system
Fixed Value: plan
..... value SΣ1..1stringValue associated with the type

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / Code
Coverage.identifier:MemberIdentifier.userequiredIdentifierUse
Coverage.identifier:MemberIdentifier.typeextensibleIdentifier Type Codes
Coverage.statusrequiredFixed Value: active
Coverage.relationshipextensibleSubscriberRelationshipCodes
Coverage.class.typeextensibleCoverageClassCodes
Coverage.class:PlanIdentifier.typeextensibleCoverageClassCodes

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()
NameFlagsCard.TypeDescription & Constraintsdoco
.. Coverage 0..*CoverageDavinci ATR Coverage
... id Σ0..1idLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... text 0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
... insuranceProductType S0..1CodeableConceptIndicates the Insurance Product Type related to the Coverage.
URL: http://hl7.org/fhir/us/davinci-atr/StructureDefinition/ext-insuranceProductType
Binding: Insurance Product Type VS (extensible)
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... Slices for identifier SΣ0..*IdentifierBusiness Identifier for the coverage
Slice: Unordered, Open by value:type.coding.system, value:type.coding.code
.... identifier:MemberIdentifier SΣ0..1IdentifierBusiness Identifier for the coverage
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... use ?!Σ0..1codeusual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .

..... type SΣ1..1CodeableConceptDescription of identifier
Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.

...... id 0..1stringUnique id for inter-element referencing
...... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
...... coding SΣ1..1CodingCode defined by a terminology system
....... id 0..1stringUnique id for inter-element referencing
....... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
....... system SΣ1..1uriIdentity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0203
....... version Σ0..1stringVersion of the system - if relevant
....... code SΣ1..1codeSymbol in syntax defined by the system
Fixed Value: MB
....... display Σ0..1stringRepresentation defined by the system
....... userSelected Σ0..1booleanIf this coding was chosen directly by the user
...... text Σ0..1stringPlain text representation of the concept
..... system SΣ1..1uriThe namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
..... value SΣ1..1stringThe value that is unique
Example General: 123456
..... period Σ0..1PeriodTime period when id is/was valid for use
..... assigner Σ0..1Reference(Organization)Organization that issued id (may be just text)
... status ?!SΣ1..1codeactive | cancelled | draft | entered-in-error
Binding: FinancialResourceStatusCodes (required): A code specifying the state of the resource instance.


Fixed Value: active
... type Σ0..1CodeableConceptCoverage category such as medical or accident
Binding: CoverageTypeAndSelf-PayCodes (preferred): The type of insurance: public health, worker compensation; private accident, auto, private health, etc.) or a direct payment by an individual or organization.

... policyHolder SΣ0..1Reference(Davinci ATR Patient | Davinci ATR RelatedPerson | Davinci ATR Organization)Owner of the policy
... subscriber SΣ0..1Reference(Davinci ATR Patient | Davinci ATR RelatedPerson)Subscriber to the policy
... subscriberId SΣ1..1stringID assigned to the subscriber
... beneficiary SΣ1..1Reference(Davinci ATR Patient)Plan beneficiary
... dependent SΣ0..1stringDependent number
... relationship S0..1CodeableConceptBeneficiary relationship to the subscriber
Binding: SubscriberRelationshipCodes (extensible): The relationship between the Subscriber and the Beneficiary (insured/covered party/patient).

... period SΣ1..1PeriodCoverage start and end dates
... payor SΣ1..1Reference(Davinci ATR Patient | Davinci ATR RelatedPerson | Davinci ATR Organization)Issuer of the policy
... Slices for class S0..*BackboneElementAdditional coverage classifications
Slice: Unordered, Open by value:type.coding.system, value:type.coding.code
.... class:All Slices Content/Rules for all slices
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... type Σ1..1CodeableConceptType of class such as 'group' or 'plan'
Binding: CoverageClassCodes (extensible): The policy classifications, eg. Group, Plan, Class, etc.

..... value Σ1..1stringValue associated with the type
..... name Σ0..1stringHuman readable description of the type and value
.... class:PlanIdentifier S0..1BackboneElementAdditional coverage classifications
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... type SΣ1..1CodeableConceptType of class such as 'group' or 'plan'
Binding: CoverageClassCodes (extensible): The policy classifications, eg. Group, Plan, Class, etc.

...... id 0..1stringUnique id for inter-element referencing
...... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
...... coding SΣ1..1CodingCode defined by a terminology system
....... id 0..1stringUnique id for inter-element referencing
....... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
....... system SΣ1..1uriIdentity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/coverage-class
....... version Σ0..1stringVersion of the system - if relevant
....... code SΣ1..1codeSymbol in syntax defined by the system
Fixed Value: plan
....... display Σ0..1stringRepresentation defined by the system
....... userSelected Σ0..1booleanIf this coding was chosen directly by the user
...... text Σ0..1stringPlain text representation of the concept
..... value SΣ1..1stringValue associated with the type
..... name Σ0..1stringHuman readable description of the type and value
... order Σ0..1positiveIntRelative order of the coverage
... network Σ0..1stringInsurer network
... costToBeneficiary 0..*BackboneElementPatient payments for services/products
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... type Σ0..1CodeableConceptCost category
Binding: CoverageCopayTypeCodes (extensible): The types of services to which patient copayments are specified.

.... value[x] Σ1..1The amount or percentage due from the beneficiary
..... valueQuantityQuantity(SimpleQuantity)
..... valueMoneyMoney
.... exception 0..*BackboneElementExceptions for patient payments
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... type Σ1..1CodeableConceptException category
Binding: ExampleCoverageFinancialExceptionCodes (example): The types of exceptions from the part or full value of financial obligations such as copays.

..... period Σ0..1PeriodThe effective period of the exception
... subrogation 0..1booleanReimbursement to insurer
... contract 0..*Reference(Contract)Contract details

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / Code
Coverage.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
Coverage.identifier:MemberIdentifier.userequiredIdentifierUse
Coverage.identifier:MemberIdentifier.typeextensibleIdentifier Type Codes
Coverage.statusrequiredFixed Value: active
Coverage.typepreferredCoverageTypeAndSelf-PayCodes
Coverage.relationshipextensibleSubscriberRelationshipCodes
Coverage.class.typeextensibleCoverageClassCodes
Coverage.class:PlanIdentifier.typeextensibleCoverageClassCodes
Coverage.costToBeneficiary.typeextensibleCoverageCopayTypeCodes
Coverage.costToBeneficiary.exception.typeexampleExampleCoverageFinancialExceptionCodes

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()

This structure is derived from Coverage

Summary

Mandatory: 5 elements (11 nested mandatory elements)
Must-Support: 25 elements
Fixed Value: 5 elements

Structures

This structure refers to these other structures:

Extensions

This structure refers to these extensions:

Slices

This structure defines the following Slices:

  • The element Coverage.identifier is sliced based on the values of value:type.coding.system, value:type.coding.code
  • The element Coverage.class is sliced based on the values of value:type.coding.system, value:type.coding.code

Differential View

This structure is derived from Coverage

NameFlagsCard.TypeDescription & Constraintsdoco
.. Coverage 0..*CoverageDavinci ATR Coverage
... insuranceProductType S0..1CodeableConceptIndicates the Insurance Product Type related to the Coverage.
URL: http://hl7.org/fhir/us/davinci-atr/StructureDefinition/ext-insuranceProductType
Binding: Insurance Product Type VS (extensible)
... Slices for identifier S0..*IdentifierBusiness Identifier for the coverage
Slice: Unordered, Open by value:type.coding.system, value:type.coding.code
.... identifier:MemberIdentifier S0..1IdentifierBusiness Identifier for the coverage
..... type S1..1CodeableConceptDescription of identifier
...... coding S1..1CodingCode defined by a terminology system
....... system S1..1uriIdentity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0203
....... code S1..1codeSymbol in syntax defined by the system
Fixed Value: MB
..... system S1..1uriThe namespace for the identifier value
..... value S1..1stringThe value that is unique
... status S1..1codeactive | cancelled | draft | entered-in-error
Fixed Value: active
... subscriber S0..1Reference(Davinci ATR Patient | Davinci ATR RelatedPerson)Subscriber to the policy
... subscriberId S1..1stringID assigned to the subscriber
... beneficiary S1..1Reference(Davinci ATR Patient)Plan beneficiary
... dependent S0..1stringDependent number
... relationship S0..1CodeableConceptBeneficiary relationship to the subscriber
... period S1..1PeriodCoverage start and end dates
... payor S1..1Reference(Davinci ATR Patient | Davinci ATR RelatedPerson | Davinci ATR Organization)Issuer of the policy
... Slices for class S0..*BackboneElementAdditional coverage classifications
Slice: Unordered, Open by value:type.coding.system, value:type.coding.code
.... class:PlanIdentifier S0..1BackboneElementAdditional coverage classifications
..... type S1..1CodeableConceptType of class such as 'group' or 'plan'
...... coding S1..1CodingCode defined by a terminology system
....... system S1..1uriIdentity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/coverage-class
....... code S1..1codeSymbol in syntax defined by the system
Fixed Value: plan
..... value S1..1stringValue associated with the type

doco Documentation for this format

Key Elements View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Coverage 0..*CoverageDavinci ATR Coverage
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... insuranceProductType S0..1CodeableConceptIndicates the Insurance Product Type related to the Coverage.
URL: http://hl7.org/fhir/us/davinci-atr/StructureDefinition/ext-insuranceProductType
Binding: Insurance Product Type VS (extensible)
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
.... identifier:MemberIdentifier SΣ0..1IdentifierBusiness Identifier for the coverage
..... use ?!Σ0..1codeusual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .

..... type SΣ1..1CodeableConceptDescription of identifier
Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.

...... coding SΣ1..1CodingCode defined by a terminology system
....... system SΣ1..1uriIdentity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0203
....... code SΣ1..1codeSymbol in syntax defined by the system
Fixed Value: MB
..... system SΣ1..1uriThe namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
..... value SΣ1..1stringThe value that is unique
Example General: 123456
... status ?!SΣ1..1codeactive | cancelled | draft | entered-in-error
Binding: FinancialResourceStatusCodes (required): A code specifying the state of the resource instance.


Fixed Value: active
... policyHolder SΣ0..1Reference(Davinci ATR Patient | Davinci ATR RelatedPerson | Davinci ATR Organization)Owner of the policy
... subscriber SΣ0..1Reference(Davinci ATR Patient | Davinci ATR RelatedPerson)Subscriber to the policy
... subscriberId SΣ1..1stringID assigned to the subscriber
... beneficiary SΣ1..1Reference(Davinci ATR Patient)Plan beneficiary
... dependent SΣ0..1stringDependent number
... relationship S0..1CodeableConceptBeneficiary relationship to the subscriber
Binding: SubscriberRelationshipCodes (extensible): The relationship between the Subscriber and the Beneficiary (insured/covered party/patient).

... period SΣ1..1PeriodCoverage start and end dates
... payor SΣ1..1Reference(Davinci ATR Patient | Davinci ATR RelatedPerson | Davinci ATR Organization)Issuer of the policy
... Slices for class S0..*BackboneElementAdditional coverage classifications
Slice: Unordered, Open by value:type.coding.system, value:type.coding.code
.... class:All Slices Content/Rules for all slices
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... type Σ1..1CodeableConceptType of class such as 'group' or 'plan'
Binding: CoverageClassCodes (extensible): The policy classifications, eg. Group, Plan, Class, etc.

..... value Σ1..1stringValue associated with the type
.... class:PlanIdentifier S0..1BackboneElementAdditional coverage classifications
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... type SΣ1..1CodeableConceptType of class such as 'group' or 'plan'
Binding: CoverageClassCodes (extensible): The policy classifications, eg. Group, Plan, Class, etc.

...... coding SΣ1..1CodingCode defined by a terminology system
....... system SΣ1..1uriIdentity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/coverage-class
....... code SΣ1..1codeSymbol in syntax defined by the system
Fixed Value: plan
..... value SΣ1..1stringValue associated with the type

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / Code
Coverage.identifier:MemberIdentifier.userequiredIdentifierUse
Coverage.identifier:MemberIdentifier.typeextensibleIdentifier Type Codes
Coverage.statusrequiredFixed Value: active
Coverage.relationshipextensibleSubscriberRelationshipCodes
Coverage.class.typeextensibleCoverageClassCodes
Coverage.class:PlanIdentifier.typeextensibleCoverageClassCodes

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()

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Coverage 0..*CoverageDavinci ATR Coverage
... id Σ0..1idLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... text 0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
... insuranceProductType S0..1CodeableConceptIndicates the Insurance Product Type related to the Coverage.
URL: http://hl7.org/fhir/us/davinci-atr/StructureDefinition/ext-insuranceProductType
Binding: Insurance Product Type VS (extensible)
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... Slices for identifier SΣ0..*IdentifierBusiness Identifier for the coverage
Slice: Unordered, Open by value:type.coding.system, value:type.coding.code
.... identifier:MemberIdentifier SΣ0..1IdentifierBusiness Identifier for the coverage
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... use ?!Σ0..1codeusual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .

..... type SΣ1..1CodeableConceptDescription of identifier
Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.

...... id 0..1stringUnique id for inter-element referencing
...... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
...... coding SΣ1..1CodingCode defined by a terminology system
....... id 0..1stringUnique id for inter-element referencing
....... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
....... system SΣ1..1uriIdentity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0203
....... version Σ0..1stringVersion of the system - if relevant
....... code SΣ1..1codeSymbol in syntax defined by the system
Fixed Value: MB
....... display Σ0..1stringRepresentation defined by the system
....... userSelected Σ0..1booleanIf this coding was chosen directly by the user
...... text Σ0..1stringPlain text representation of the concept
..... system SΣ1..1uriThe namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
..... value SΣ1..1stringThe value that is unique
Example General: 123456
..... period Σ0..1PeriodTime period when id is/was valid for use
..... assigner Σ0..1Reference(Organization)Organization that issued id (may be just text)
... status ?!SΣ1..1codeactive | cancelled | draft | entered-in-error
Binding: FinancialResourceStatusCodes (required): A code specifying the state of the resource instance.


Fixed Value: active
... type Σ0..1CodeableConceptCoverage category such as medical or accident
Binding: CoverageTypeAndSelf-PayCodes (preferred): The type of insurance: public health, worker compensation; private accident, auto, private health, etc.) or a direct payment by an individual or organization.

... policyHolder SΣ0..1Reference(Davinci ATR Patient | Davinci ATR RelatedPerson | Davinci ATR Organization)Owner of the policy
... subscriber SΣ0..1Reference(Davinci ATR Patient | Davinci ATR RelatedPerson)Subscriber to the policy
... subscriberId SΣ1..1stringID assigned to the subscriber
... beneficiary SΣ1..1Reference(Davinci ATR Patient)Plan beneficiary
... dependent SΣ0..1stringDependent number
... relationship S0..1CodeableConceptBeneficiary relationship to the subscriber
Binding: SubscriberRelationshipCodes (extensible): The relationship between the Subscriber and the Beneficiary (insured/covered party/patient).

... period SΣ1..1PeriodCoverage start and end dates
... payor SΣ1..1Reference(Davinci ATR Patient | Davinci ATR RelatedPerson | Davinci ATR Organization)Issuer of the policy
... Slices for class S0..*BackboneElementAdditional coverage classifications
Slice: Unordered, Open by value:type.coding.system, value:type.coding.code
.... class:All Slices Content/Rules for all slices
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... type Σ1..1CodeableConceptType of class such as 'group' or 'plan'
Binding: CoverageClassCodes (extensible): The policy classifications, eg. Group, Plan, Class, etc.

..... value Σ1..1stringValue associated with the type
..... name Σ0..1stringHuman readable description of the type and value
.... class:PlanIdentifier S0..1BackboneElementAdditional coverage classifications
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... type SΣ1..1CodeableConceptType of class such as 'group' or 'plan'
Binding: CoverageClassCodes (extensible): The policy classifications, eg. Group, Plan, Class, etc.

...... id 0..1stringUnique id for inter-element referencing
...... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
...... coding SΣ1..1CodingCode defined by a terminology system
....... id 0..1stringUnique id for inter-element referencing
....... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
....... system SΣ1..1uriIdentity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/coverage-class
....... version Σ0..1stringVersion of the system - if relevant
....... code SΣ1..1codeSymbol in syntax defined by the system
Fixed Value: plan
....... display Σ0..1stringRepresentation defined by the system
....... userSelected Σ0..1booleanIf this coding was chosen directly by the user
...... text Σ0..1stringPlain text representation of the concept
..... value SΣ1..1stringValue associated with the type
..... name Σ0..1stringHuman readable description of the type and value
... order Σ0..1positiveIntRelative order of the coverage
... network Σ0..1stringInsurer network
... costToBeneficiary 0..*BackboneElementPatient payments for services/products
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... type Σ0..1CodeableConceptCost category
Binding: CoverageCopayTypeCodes (extensible): The types of services to which patient copayments are specified.

.... value[x] Σ1..1The amount or percentage due from the beneficiary
..... valueQuantityQuantity(SimpleQuantity)
..... valueMoneyMoney
.... exception 0..*BackboneElementExceptions for patient payments
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... type Σ1..1CodeableConceptException category
Binding: ExampleCoverageFinancialExceptionCodes (example): The types of exceptions from the part or full value of financial obligations such as copays.

..... period Σ0..1PeriodThe effective period of the exception
... subrogation 0..1booleanReimbursement to insurer
... contract 0..*Reference(Contract)Contract details

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / Code
Coverage.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
Coverage.identifier:MemberIdentifier.userequiredIdentifierUse
Coverage.identifier:MemberIdentifier.typeextensibleIdentifier Type Codes
Coverage.statusrequiredFixed Value: active
Coverage.typepreferredCoverageTypeAndSelf-PayCodes
Coverage.relationshipextensibleSubscriberRelationshipCodes
Coverage.class.typeextensibleCoverageClassCodes
Coverage.class:PlanIdentifier.typeextensibleCoverageClassCodes
Coverage.costToBeneficiary.typeextensibleCoverageCopayTypeCodes
Coverage.costToBeneficiary.exception.typeexampleExampleCoverageFinancialExceptionCodes

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()

This structure is derived from Coverage

Summary

Mandatory: 5 elements (11 nested mandatory elements)
Must-Support: 25 elements
Fixed Value: 5 elements

Structures

This structure refers to these other structures:

Extensions

This structure refers to these extensions:

Slices

This structure defines the following Slices:

  • The element Coverage.identifier is sliced based on the values of value:type.coding.system, value:type.coding.code
  • The element Coverage.class is sliced based on the values of value:type.coding.system, value:type.coding.code

 

Other representations of profile: CSV, Excel, Schematron