Implementation Guide
27.0.0 - R4 APIs

Publish Box goes here

Resource Profile: Profile - Athena PAS Coverage

Official URL: https://docs.mydata.athenahealth.com/fhir-r4/StructureDefinition-athena-pas-coverage-profile.html Version: 27.0.0
Active as of 2026-05-06 Computable Name: PasCoverage

This profile is used to represent the insurance coverage details associated with an individual's healthcare services under a specific insurance plan. This profile is required as part of the PAS Claim Bundle and is referenced in the PAS Claim resource.

Goal: Retrieve the PAS Coverage resource by ID for inclusion in the Claim Bundle.

Reference: PAS Coverage is referenced in the PAS Claim resource as part of the required Claim Bundle structure.

Required for Claim Bundle. Reference to PAS Coverage in PAS Claim resource.

This profile captures key insurance coverage information such as coverage kind, identifiers (member number, payor IDs), coverage period, policy holder, subscriber, beneficiary references, and payor organization details necessary for claims processing and adjudication.

Usages:

You can also check for usages in the FHIR IG Statistics

Formal Views of Profile Content

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

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Coverage 0..* Coverage Insurance or medical plan or a payment agreement
... 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Σ 1..* Identifier Member ID and other identifiers
Slice: Unordered, Open by pattern:type
.... identifier:memberid SΣ 1..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.
...... coding Σ 1..* Coding Code defined by a terminology system
....... system Σ 1..1 uri Identity of the terminology system
Required Pattern: http://terminology.hl7.org/CodeSystem/v2-0203
....... code Σ 1..1 code Symbol in syntax defined by the system
Required Pattern: MB
.... identifier:NIIP SΣ 0..* Identifier National Insurance Payor Identifier (Payor)
..... 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 Fixed Value: NIIP (National Insurance Payor 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 Σ 1..* Coding Code defined by a terminology system
....... system Σ 1..1 uri Identity of the terminology system
Required Pattern: http://terminology.hl7.org/CodeSystem/v2-0203
....... code Σ 1..1 code Symbol in syntax defined by the system
Required Pattern: NIIP
..... value SΣ 1..1 string NIIP value
Example General: 123456
... type SΣ 0..1 CodeableConcept Coverage category such as medical or accident
Binding: PayerType (20221118) . (extensible): US Public Health Data Consortium Source of Payment Codes
... subscriber SΣ 0..1 Reference(PAS Subscriber Patient) Subscriber to the policy
... subscriberId SΣ 0..1 string ID assigned to the subscriber
... beneficiary SΣ 1..1 Reference(PAS Beneficiary Patient) Plan beneficiary
... relationship S 1..1 CodeableConcept Beneficiary relationship to the subscriber
Binding: SubscriberRelationshipCodes (extensible): SubscriberRelationshipCodes
.... Slices for coding Σ 0..* Coding Code defined by a terminology system
Slice: Unordered, Open by pattern:$this
..... coding:X12Code SΣ 0..1 Coding Code defined by a terminology system
Binding: https://valueset.x12.org/x217/005010/request/2000D/INS/1/02/00/1069 (required): Codes indicating the relationship between two individuals or entities. These codes are listed within an X12 implementation guide (TR3) and maintained by X12. All X12 work products are copyrighted. See their website for licensing terms and conditions.
... period SΣ 0..1 Period Coverage start and end dates
... payor SΣ 1..1 Reference(PAS Insurer Organization) 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.
...... coding Σ 1..* Coding Code defined by a terminology system
....... system Σ 1..1 uri Identity of the terminology system
Required Pattern: http://terminology.hl7.org/CodeSystem/coverage-class
....... code Σ 1..1 code Symbol in syntax defined by the system
Required Pattern: 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.
...... coding Σ 1..* Coding Code defined by a terminology system
....... system Σ 1..1 uri Identity of the terminology system
Required Pattern: http://terminology.hl7.org/CodeSystem/coverage-class
....... code Σ 1..1 code Symbol in syntax defined by the system
Required Pattern: 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.typeextensibleIdentifier Type Codes
http://hl7.org/fhir/ValueSet/identifier-type
From the FHIR Standard
Coverage.identifier:NIIP.userequiredIdentifierUse
http://hl7.org/fhir/ValueSet/identifier-use|4.0.1
From the FHIR Standard
Coverage.identifier:NIIP.typeextensibleIdentifier Type Codes
http://hl7.org/fhir/ValueSet/identifier-type
From the FHIR Standard
Coverage.statusrequiredPattern Value: active
http://hl7.org/fhir/ValueSet/fm-status
From the FHIR Standard
Coverage.typeextensiblePayerType .
http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.114222.4.11.3591|20221118
Coverage.relationshipextensibleSubscriberRelationshipCodes
http://hl7.org/fhir/ValueSet/subscriber-relationship
From the FHIR Standard
Coverage.relationship.coding:X12Coderequiredhttps://valueset.x12.org/x217/005010/request/2000D/INS/1/02/00/1069
https://valueset.x12.org/x217/005010/request/2000D/INS/1/02/00/1069
Coverage.class.typeextensibleCoverageClassCodes
http://hl7.org/fhir/ValueSet/coverage-class
From the FHIR Standard
Coverage.class:group.typeextensibleCoverageClassCodes
http://hl7.org/fhir/ValueSet/coverage-class
From the FHIR Standard
Coverage.class:plan.typeextensibleCoverageClassCodes
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()

This structure is derived from Coverage

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Coverage 0..* Coverage Insurance or medical plan or a payment agreement
... Slices for identifier S 1..* Identifier Member ID and other identifiers
Slice: Unordered, Open by pattern:type
.... identifier:memberid S 1..1 Identifier Member ID
..... 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.
...... coding 1..* Coding Code defined by a terminology system
....... system 1..1 uri Identity of the terminology system
Required Pattern: http://terminology.hl7.org/CodeSystem/v2-0203
....... code 1..1 code Symbol in syntax defined by the system
Required Pattern: MB
.... identifier:NIIP S 0..* Identifier National Insurance Payor Identifier (Payor)
..... type S 1..1 CodeableConcept Fixed Value: NIIP (National Insurance Payor Identifier)
...... coding 1..* Coding Code defined by a terminology system
....... system 1..1 uri Identity of the terminology system
Required Pattern: http://terminology.hl7.org/CodeSystem/v2-0203
....... code 1..1 code Symbol in syntax defined by the system
Required Pattern: NIIP
..... value S 1..1 string NIIP value
... status S 1..1 code active | cancelled | draft | entered-in-error
Binding: FinancialResourceStatusCodes (required): A code specifying the state of the resource instance.
Required Pattern: active
... type S 0..1 CodeableConcept Coverage category such as medical or accident
Binding: PayerType (20221118) . (extensible): US Public Health Data Consortium Source of Payment Codes
... subscriberId S 0..1 string ID assigned to the subscriber
... beneficiary S 1..1 Reference(PAS Beneficiary Patient) Plan beneficiary
... relationship S 1..1 CodeableConcept Beneficiary relationship to the subscriber
Binding: SubscriberRelationshipCodes (extensible): SubscriberRelationshipCodes
.... Slices for coding 0..* Coding Code defined by a terminology system
Slice: Unordered, Open by pattern:$this
..... coding:X12Code S 0..1 Coding Code defined by a terminology system
Binding: https://valueset.x12.org/x217/005010/request/2000D/INS/1/02/00/1069 (required): Codes indicating the relationship between two individuals or entities. These codes are listed within an X12 implementation guide (TR3) and maintained by X12. All X12 work products are copyrighted. See their website for licensing terms and conditions.
... period S 0..1 Period Coverage start and end dates
... payor S 1..1 Reference(PAS Insurer Organization) Issuer of the policy
... Slices for class S 0..* BackboneElement Additional coverage classifications
Slice: Unordered, Open by pattern:type
.... class:group S 0..1 BackboneElement Group
..... type 1..1 CodeableConcept Type of class such as 'group' or 'plan'
Binding: CoverageClassCodes (extensible): The policy classifications, eg. Group, Plan, Class, etc.
...... coding 1..* Coding Code defined by a terminology system
....... system 1..1 uri Identity of the terminology system
Required Pattern: http://terminology.hl7.org/CodeSystem/coverage-class
....... code 1..1 code Symbol in syntax defined by the system
Required Pattern: group
..... value S 1..1 string Group Number
..... name S 0..1 string Group Name
.... class:plan S 0..1 BackboneElement Plan
..... type 1..1 CodeableConcept Type of class such as 'group' or 'plan'
Binding: CoverageClassCodes (extensible): The policy classifications, eg. Group, Plan, Class, etc.
...... coding 1..* Coding Code defined by a terminology system
....... system 1..1 uri Identity of the terminology system
Required Pattern: http://terminology.hl7.org/CodeSystem/coverage-class
....... code 1..1 code Symbol in syntax defined by the system
Required Pattern: plan
..... value S 1..1 string Plan Number
..... name S 0..1 string Plan Name

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSet / CodeURI
Coverage.identifier:memberid.typeextensibleIdentifier Type Codes
http://hl7.org/fhir/ValueSet/identifier-type
From the FHIR Standard
Coverage.statusrequiredPattern Value: active
http://hl7.org/fhir/ValueSet/fm-status
From the FHIR Standard
Coverage.typeextensiblePayerType .
http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.114222.4.11.3591|20221118
Coverage.relationshipextensibleSubscriberRelationshipCodes
http://hl7.org/fhir/ValueSet/subscriber-relationship
From the FHIR Standard
Coverage.relationship.coding:X12Coderequiredhttps://valueset.x12.org/x217/005010/request/2000D/INS/1/02/00/1069
https://valueset.x12.org/x217/005010/request/2000D/INS/1/02/00/1069
Coverage.class:group.typeextensibleCoverageClassCodes
http://hl7.org/fhir/ValueSet/coverage-class
From the FHIR Standard
Coverage.class:plan.typeextensibleCoverageClassCodes
http://hl7.org/fhir/ValueSet/coverage-class
From the FHIR Standard
NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Coverage 0..* Coverage Insurance or medical plan or a payment agreement
... 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
This profile does not constrain the narrative in regard to content, language, or traceability to data elements
... 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Σ 1..* Identifier Member ID and other identifiers
Slice: Unordered, Open by pattern:type
.... identifier:memberid SΣ 1..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.
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
...... coding Σ 1..* Coding Code defined by a terminology system
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
....... system Σ 1..1 uri Identity of the terminology system
Required Pattern: 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
Required Pattern: 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)
.... identifier:NIIP SΣ 0..* Identifier National Insurance Payor Identifier (Payor)
..... 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 Fixed Value: NIIP (National Insurance Payor 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..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
...... coding Σ 1..* Coding Code defined by a terminology system
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
....... system Σ 1..1 uri Identity of the terminology system
Required Pattern: 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
Required Pattern: NIIP
....... 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 SΣ 1..1 string NIIP value
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.
Required Pattern: active
... type SΣ 0..1 CodeableConcept Coverage category such as medical or accident
Binding: PayerType (20221118) . (extensible): US Public Health Data Consortium Source of Payment Codes
... policyHolder Σ 0..1 Reference(Patient | RelatedPerson | Organization) Owner of the policy
... subscriber SΣ 0..1 Reference(PAS Subscriber Patient) Subscriber to the policy
... subscriberId SΣ 0..1 string ID assigned to the subscriber
... beneficiary SΣ 1..1 Reference(PAS Beneficiary Patient) Plan beneficiary
... dependent Σ 0..1 string Dependent number
... relationship S 1..1 CodeableConcept Beneficiary relationship to the subscriber
Binding: SubscriberRelationshipCodes (extensible): SubscriberRelationshipCodes
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... Slices for coding Σ 0..* Coding Code defined by a terminology system
Slice: Unordered, Open by pattern:$this
..... coding:X12Code SΣ 0..1 Coding Code defined by a terminology system
Binding: https://valueset.x12.org/x217/005010/request/2000D/INS/1/02/00/1069 (required): Codes indicating the relationship between two individuals or entities. These codes are listed within an X12 implementation guide (TR3) and maintained by X12. All X12 work products are copyrighted. See their website for licensing terms and conditions.
.... text Σ 0..1 string Plain text representation of the concept
... period SΣ 0..1 Period Coverage start and end dates
... payor SΣ 1..1 Reference(PAS Insurer Organization) 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.
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
...... coding Σ 1..* Coding Code defined by a terminology system
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
....... system Σ 1..1 uri Identity of the terminology system
Required Pattern: 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
Required Pattern: 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.
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
...... coding Σ 1..* Coding Code defined by a terminology system
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
....... system Σ 1..1 uri Identity of the terminology system
Required Pattern: 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
Required Pattern: 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
http://hl7.org/fhir/ValueSet/languages
From the FHIR Standard
Additional Bindings Purpose
AllLanguages Max Binding
Coverage.identifier:memberid.userequiredIdentifierUse
http://hl7.org/fhir/ValueSet/identifier-use|4.0.1
From the FHIR Standard
Coverage.identifier:memberid.typeextensibleIdentifier Type Codes
http://hl7.org/fhir/ValueSet/identifier-type
From the FHIR Standard
Coverage.identifier:NIIP.userequiredIdentifierUse
http://hl7.org/fhir/ValueSet/identifier-use|4.0.1
From the FHIR Standard
Coverage.identifier:NIIP.typeextensibleIdentifier Type Codes
http://hl7.org/fhir/ValueSet/identifier-type
From the FHIR Standard
Coverage.statusrequiredPattern Value: active
http://hl7.org/fhir/ValueSet/fm-status
From the FHIR Standard
Coverage.typeextensiblePayerType .
http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.114222.4.11.3591|20221118
Coverage.relationshipextensibleSubscriberRelationshipCodes
http://hl7.org/fhir/ValueSet/subscriber-relationship
From the FHIR Standard
Coverage.relationship.coding:X12Coderequiredhttps://valueset.x12.org/x217/005010/request/2000D/INS/1/02/00/1069
https://valueset.x12.org/x217/005010/request/2000D/INS/1/02/00/1069
Coverage.class.typeextensibleCoverageClassCodes
http://hl7.org/fhir/ValueSet/coverage-class
From the FHIR Standard
Coverage.class:group.typeextensibleCoverageClassCodes
http://hl7.org/fhir/ValueSet/coverage-class
From the FHIR Standard
Coverage.class:plan.typeextensibleCoverageClassCodes
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()

This structure is derived from Coverage

Summary

Mandatory: 7 elements(11 nested mandatory elements)
Must-Support: 22 elements

Structures

This structure refers to these other structures:

Slices

This structure defines the following Slices:

  • The element 1 is sliced based on the value of Coverage.identifier
  • The element 1 is sliced based on the value of Coverage.relationship.coding
  • The element 1 is sliced based on the value of Coverage.class

Key Elements View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Coverage 0..* Coverage Insurance or medical plan or a payment agreement
... 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Σ 1..* Identifier Member ID and other identifiers
Slice: Unordered, Open by pattern:type
.... identifier:memberid SΣ 1..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.
...... coding Σ 1..* Coding Code defined by a terminology system
....... system Σ 1..1 uri Identity of the terminology system
Required Pattern: http://terminology.hl7.org/CodeSystem/v2-0203
....... code Σ 1..1 code Symbol in syntax defined by the system
Required Pattern: MB
.... identifier:NIIP SΣ 0..* Identifier National Insurance Payor Identifier (Payor)
..... 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 Fixed Value: NIIP (National Insurance Payor 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 Σ 1..* Coding Code defined by a terminology system
....... system Σ 1..1 uri Identity of the terminology system
Required Pattern: http://terminology.hl7.org/CodeSystem/v2-0203
....... code Σ 1..1 code Symbol in syntax defined by the system
Required Pattern: NIIP
..... value SΣ 1..1 string NIIP value
Example General: 123456
... type SΣ 0..1 CodeableConcept Coverage category such as medical or accident
Binding: PayerType (20221118) . (extensible): US Public Health Data Consortium Source of Payment Codes
... subscriber SΣ 0..1 Reference(PAS Subscriber Patient) Subscriber to the policy
... subscriberId SΣ 0..1 string ID assigned to the subscriber
... beneficiary SΣ 1..1 Reference(PAS Beneficiary Patient) Plan beneficiary
... relationship S 1..1 CodeableConcept Beneficiary relationship to the subscriber
Binding: SubscriberRelationshipCodes (extensible): SubscriberRelationshipCodes
.... Slices for coding Σ 0..* Coding Code defined by a terminology system
Slice: Unordered, Open by pattern:$this
..... coding:X12Code SΣ 0..1 Coding Code defined by a terminology system
Binding: https://valueset.x12.org/x217/005010/request/2000D/INS/1/02/00/1069 (required): Codes indicating the relationship between two individuals or entities. These codes are listed within an X12 implementation guide (TR3) and maintained by X12. All X12 work products are copyrighted. See their website for licensing terms and conditions.
... period SΣ 0..1 Period Coverage start and end dates
... payor SΣ 1..1 Reference(PAS Insurer Organization) 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.
...... coding Σ 1..* Coding Code defined by a terminology system
....... system Σ 1..1 uri Identity of the terminology system
Required Pattern: http://terminology.hl7.org/CodeSystem/coverage-class
....... code Σ 1..1 code Symbol in syntax defined by the system
Required Pattern: 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.
...... coding Σ 1..* Coding Code defined by a terminology system
....... system Σ 1..1 uri Identity of the terminology system
Required Pattern: http://terminology.hl7.org/CodeSystem/coverage-class
....... code Σ 1..1 code Symbol in syntax defined by the system
Required Pattern: 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.typeextensibleIdentifier Type Codes
http://hl7.org/fhir/ValueSet/identifier-type
From the FHIR Standard
Coverage.identifier:NIIP.userequiredIdentifierUse
http://hl7.org/fhir/ValueSet/identifier-use|4.0.1
From the FHIR Standard
Coverage.identifier:NIIP.typeextensibleIdentifier Type Codes
http://hl7.org/fhir/ValueSet/identifier-type
From the FHIR Standard
Coverage.statusrequiredPattern Value: active
http://hl7.org/fhir/ValueSet/fm-status
From the FHIR Standard
Coverage.typeextensiblePayerType .
http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.114222.4.11.3591|20221118
Coverage.relationshipextensibleSubscriberRelationshipCodes
http://hl7.org/fhir/ValueSet/subscriber-relationship
From the FHIR Standard
Coverage.relationship.coding:X12Coderequiredhttps://valueset.x12.org/x217/005010/request/2000D/INS/1/02/00/1069
https://valueset.x12.org/x217/005010/request/2000D/INS/1/02/00/1069
Coverage.class.typeextensibleCoverageClassCodes
http://hl7.org/fhir/ValueSet/coverage-class
From the FHIR Standard
Coverage.class:group.typeextensibleCoverageClassCodes
http://hl7.org/fhir/ValueSet/coverage-class
From the FHIR Standard
Coverage.class:plan.typeextensibleCoverageClassCodes
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()

Differential View

This structure is derived from Coverage

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Coverage 0..* Coverage Insurance or medical plan or a payment agreement
... Slices for identifier S 1..* Identifier Member ID and other identifiers
Slice: Unordered, Open by pattern:type
.... identifier:memberid S 1..1 Identifier Member ID
..... 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.
...... coding 1..* Coding Code defined by a terminology system
....... system 1..1 uri Identity of the terminology system
Required Pattern: http://terminology.hl7.org/CodeSystem/v2-0203
....... code 1..1 code Symbol in syntax defined by the system
Required Pattern: MB
.... identifier:NIIP S 0..* Identifier National Insurance Payor Identifier (Payor)
..... type S 1..1 CodeableConcept Fixed Value: NIIP (National Insurance Payor Identifier)
...... coding 1..* Coding Code defined by a terminology system
....... system 1..1 uri Identity of the terminology system
Required Pattern: http://terminology.hl7.org/CodeSystem/v2-0203
....... code 1..1 code Symbol in syntax defined by the system
Required Pattern: NIIP
..... value S 1..1 string NIIP value
... status S 1..1 code active | cancelled | draft | entered-in-error
Binding: FinancialResourceStatusCodes (required): A code specifying the state of the resource instance.
Required Pattern: active
... type S 0..1 CodeableConcept Coverage category such as medical or accident
Binding: PayerType (20221118) . (extensible): US Public Health Data Consortium Source of Payment Codes
... subscriberId S 0..1 string ID assigned to the subscriber
... beneficiary S 1..1 Reference(PAS Beneficiary Patient) Plan beneficiary
... relationship S 1..1 CodeableConcept Beneficiary relationship to the subscriber
Binding: SubscriberRelationshipCodes (extensible): SubscriberRelationshipCodes
.... Slices for coding 0..* Coding Code defined by a terminology system
Slice: Unordered, Open by pattern:$this
..... coding:X12Code S 0..1 Coding Code defined by a terminology system
Binding: https://valueset.x12.org/x217/005010/request/2000D/INS/1/02/00/1069 (required): Codes indicating the relationship between two individuals or entities. These codes are listed within an X12 implementation guide (TR3) and maintained by X12. All X12 work products are copyrighted. See their website for licensing terms and conditions.
... period S 0..1 Period Coverage start and end dates
... payor S 1..1 Reference(PAS Insurer Organization) Issuer of the policy
... Slices for class S 0..* BackboneElement Additional coverage classifications
Slice: Unordered, Open by pattern:type
.... class:group S 0..1 BackboneElement Group
..... type 1..1 CodeableConcept Type of class such as 'group' or 'plan'
Binding: CoverageClassCodes (extensible): The policy classifications, eg. Group, Plan, Class, etc.
...... coding 1..* Coding Code defined by a terminology system
....... system 1..1 uri Identity of the terminology system
Required Pattern: http://terminology.hl7.org/CodeSystem/coverage-class
....... code 1..1 code Symbol in syntax defined by the system
Required Pattern: group
..... value S 1..1 string Group Number
..... name S 0..1 string Group Name
.... class:plan S 0..1 BackboneElement Plan
..... type 1..1 CodeableConcept Type of class such as 'group' or 'plan'
Binding: CoverageClassCodes (extensible): The policy classifications, eg. Group, Plan, Class, etc.
...... coding 1..* Coding Code defined by a terminology system
....... system 1..1 uri Identity of the terminology system
Required Pattern: http://terminology.hl7.org/CodeSystem/coverage-class
....... code 1..1 code Symbol in syntax defined by the system
Required Pattern: plan
..... value S 1..1 string Plan Number
..... name S 0..1 string Plan Name

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSet / CodeURI
Coverage.identifier:memberid.typeextensibleIdentifier Type Codes
http://hl7.org/fhir/ValueSet/identifier-type
From the FHIR Standard
Coverage.statusrequiredPattern Value: active
http://hl7.org/fhir/ValueSet/fm-status
From the FHIR Standard
Coverage.typeextensiblePayerType .
http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.114222.4.11.3591|20221118
Coverage.relationshipextensibleSubscriberRelationshipCodes
http://hl7.org/fhir/ValueSet/subscriber-relationship
From the FHIR Standard
Coverage.relationship.coding:X12Coderequiredhttps://valueset.x12.org/x217/005010/request/2000D/INS/1/02/00/1069
https://valueset.x12.org/x217/005010/request/2000D/INS/1/02/00/1069
Coverage.class:group.typeextensibleCoverageClassCodes
http://hl7.org/fhir/ValueSet/coverage-class
From the FHIR Standard
Coverage.class:plan.typeextensibleCoverageClassCodes
http://hl7.org/fhir/ValueSet/coverage-class
From the FHIR Standard

Snapshot View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Coverage 0..* Coverage Insurance or medical plan or a payment agreement
... 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
This profile does not constrain the narrative in regard to content, language, or traceability to data elements
... 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Σ 1..* Identifier Member ID and other identifiers
Slice: Unordered, Open by pattern:type
.... identifier:memberid SΣ 1..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.
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
...... coding Σ 1..* Coding Code defined by a terminology system
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
....... system Σ 1..1 uri Identity of the terminology system
Required Pattern: 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
Required Pattern: 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)
.... identifier:NIIP SΣ 0..* Identifier National Insurance Payor Identifier (Payor)
..... 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 Fixed Value: NIIP (National Insurance Payor 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..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
...... coding Σ 1..* Coding Code defined by a terminology system
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
....... system Σ 1..1 uri Identity of the terminology system
Required Pattern: 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
Required Pattern: NIIP
....... 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 SΣ 1..1 string NIIP value
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.
Required Pattern: active
... type SΣ 0..1 CodeableConcept Coverage category such as medical or accident
Binding: PayerType (20221118) . (extensible): US Public Health Data Consortium Source of Payment Codes
... policyHolder Σ 0..1 Reference(Patient | RelatedPerson | Organization) Owner of the policy
... subscriber SΣ 0..1 Reference(PAS Subscriber Patient) Subscriber to the policy
... subscriberId SΣ 0..1 string ID assigned to the subscriber
... beneficiary SΣ 1..1 Reference(PAS Beneficiary Patient) Plan beneficiary
... dependent Σ 0..1 string Dependent number
... relationship S 1..1 CodeableConcept Beneficiary relationship to the subscriber
Binding: SubscriberRelationshipCodes (extensible): SubscriberRelationshipCodes
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... Slices for coding Σ 0..* Coding Code defined by a terminology system
Slice: Unordered, Open by pattern:$this
..... coding:X12Code SΣ 0..1 Coding Code defined by a terminology system
Binding: https://valueset.x12.org/x217/005010/request/2000D/INS/1/02/00/1069 (required): Codes indicating the relationship between two individuals or entities. These codes are listed within an X12 implementation guide (TR3) and maintained by X12. All X12 work products are copyrighted. See their website for licensing terms and conditions.
.... text Σ 0..1 string Plain text representation of the concept
... period SΣ 0..1 Period Coverage start and end dates
... payor SΣ 1..1 Reference(PAS Insurer Organization) 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.
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
...... coding Σ 1..* Coding Code defined by a terminology system
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
....... system Σ 1..1 uri Identity of the terminology system
Required Pattern: 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
Required Pattern: 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.
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
...... coding Σ 1..* Coding Code defined by a terminology system
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
....... system Σ 1..1 uri Identity of the terminology system
Required Pattern: 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
Required Pattern: 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
http://hl7.org/fhir/ValueSet/languages
From the FHIR Standard
Additional Bindings Purpose
AllLanguages Max Binding
Coverage.identifier:memberid.userequiredIdentifierUse
http://hl7.org/fhir/ValueSet/identifier-use|4.0.1
From the FHIR Standard
Coverage.identifier:memberid.typeextensibleIdentifier Type Codes
http://hl7.org/fhir/ValueSet/identifier-type
From the FHIR Standard
Coverage.identifier:NIIP.userequiredIdentifierUse
http://hl7.org/fhir/ValueSet/identifier-use|4.0.1
From the FHIR Standard
Coverage.identifier:NIIP.typeextensibleIdentifier Type Codes
http://hl7.org/fhir/ValueSet/identifier-type
From the FHIR Standard
Coverage.statusrequiredPattern Value: active
http://hl7.org/fhir/ValueSet/fm-status
From the FHIR Standard
Coverage.typeextensiblePayerType .
http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.114222.4.11.3591|20221118
Coverage.relationshipextensibleSubscriberRelationshipCodes
http://hl7.org/fhir/ValueSet/subscriber-relationship
From the FHIR Standard
Coverage.relationship.coding:X12Coderequiredhttps://valueset.x12.org/x217/005010/request/2000D/INS/1/02/00/1069
https://valueset.x12.org/x217/005010/request/2000D/INS/1/02/00/1069
Coverage.class.typeextensibleCoverageClassCodes
http://hl7.org/fhir/ValueSet/coverage-class
From the FHIR Standard
Coverage.class:group.typeextensibleCoverageClassCodes
http://hl7.org/fhir/ValueSet/coverage-class
From the FHIR Standard
Coverage.class:plan.typeextensibleCoverageClassCodes
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()

This structure is derived from Coverage

Summary

Mandatory: 7 elements(11 nested mandatory elements)
Must-Support: 22 elements

Structures

This structure refers to these other structures:

Slices

This structure defines the following Slices:

  • The element 1 is sliced based on the value of Coverage.identifier
  • The element 1 is sliced based on the value of Coverage.relationship.coding
  • The element 1 is sliced based on the value of Coverage.class

 

Other representations of profile: CSV, Excel, Schematron

Notes:

Supported Interactions

The Interactions supported by this resource are listed below.