This page is part of the CARIN Blue Button Implementation Guide (v2.0.0: STU 2) based on FHIR R4. This is the current published version in its permanent home (it will always be available at this URL). For a full list of available versions, see the Directory of published versions
Official URL: http://hl7.org/fhir/us/carin-bb/StructureDefinition/C4BB-Coverage | Version: 2.0.0 | |||
Active as of 2022-11-28 | Computable Name: C4BBCoverage |
Data that reflect a payer’s coverage that was effective as of the date of service or the date of admission of the claim.
Usage:
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from Coverage
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Coverage | C | 0..* | Coverage | Insurance or medical plan or a payment agreement coverage-meta-profile-version: Coverage: meta.profile with canonical and major.minor. version required. |
meta | S | 1..1 | Meta | Metadata about the resource |
lastUpdated | S | 1..1 | instant | When the resource version last changed |
profile | 1..* | canonical(StructureDefinition) | Profiles this resource claims to conform to | |
identifier | S | 0..* | Identifier | Member ID and other identifiers |
status | S | 1..1 | code | active | cancelled | draft | entered-in-error |
type | 0..1 | CodeableConcept | Coverage category such as medical or accident | |
subscriberId | S | 1..1 | string | ID assigned to the subscriber |
beneficiary | S | 1..1 | Reference(C4BB Patient) | Plan beneficiary |
relationship | S | 1..1 | CodeableConcept | Beneficiary relationship to the subscriber Binding: SubscriberRelationshipCodes (required) |
period | S | 0..1 | Period | Coverage start and end dates |
payor | S | 1..1 | Reference(C4BB 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' Required Pattern: At least the following | |
coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
system | 1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/coverage-class | |
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: group | |
value | S | 1..1 | string | Group Number |
name | S | 0..1 | string | Group Name |
class:plan | S | 0..1 | BackboneElement | Plan |
type | 1..1 | CodeableConcept | Type of class such as 'group' or 'plan' Required Pattern: At least the following | |
coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
system | 1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/coverage-class | |
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: plan | |
value | S | 1..1 | string | Plan Number |
name | S | 0..1 | string | Plan Name |
Documentation for this format |
Path | Conformance | ValueSet |
Coverage.relationship | required | SubscriberRelationshipCodes |
Id | Grade | Path(s) | Details | Requirements |
coverage-meta-profile-version | error | Coverage | Coverage: meta.profile with canonical and major.minor. version required. : meta.profile.exists($this.startsWith('http://hl7.org/fhir/us/carin-bb/StructureDefinition/C4BB-Coverage|2.0.')) |
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Coverage | C | 0..* | Coverage | Insurance or medical plan or a payment agreement coverage-meta-profile-version: Coverage: meta.profile with canonical and major.minor. version required. |
meta | SΣ | 1..1 | Meta | Metadata about the resource |
lastUpdated | SΣ | 1..1 | instant | When the resource version last changed |
profile | Σ | 1..* | canonical(StructureDefinition) | Profiles this resource claims to conform to |
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created |
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
identifier | SΣ | 0..* | Identifier | Member ID and other identifiers |
status | ?!SΣ | 1..1 | code | active | cancelled | draft | entered-in-error Binding: FinancialResourceStatusCodes (required): A code specifying the state of the resource instance. |
type | Σ | 0..1 | CodeableConcept | Coverage 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. |
subscriberId | SΣ | 1..1 | string | ID assigned to the subscriber |
beneficiary | SΣ | 1..1 | Reference(C4BB Patient) | Plan beneficiary |
relationship | S | 1..1 | CodeableConcept | Beneficiary relationship to the subscriber Binding: SubscriberRelationshipCodes (required) |
period | SΣ | 0..1 | Period | Coverage start and end dates |
payor | SΣ | 1..1 | Reference(C4BB 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. Required Pattern: At least the following |
coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
system | 1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/coverage-class | |
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: group | |
value | SΣ | 1..1 | string | Group Number |
name | SΣ | 0..1 | string | Group Name |
class:plan | S | 0..1 | BackboneElement | Plan |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
type | Σ | 1..1 | CodeableConcept | Type of class such as 'group' or 'plan' Binding: CoverageClassCodes (extensible): The policy classifications, eg. Group, Plan, Class, etc. Required Pattern: At least the following |
coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
system | 1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/coverage-class | |
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: plan | |
value | SΣ | 1..1 | string | Plan Number |
name | SΣ | 0..1 | string | Plan Name |
Documentation for this format |
Path | Conformance | ValueSet / Code |
Coverage.status | required | FinancialResourceStatusCodes |
Coverage.type | preferred | CoverageTypeAndSelf-PayCodes |
Coverage.relationship | required | SubscriberRelationshipCodes |
Coverage.class.type | extensible | CoverageClassCodes |
Coverage.class:group.type | extensible | Pattern: group |
Coverage.class:plan.type | extensible | Pattern: plan |
Id | Grade | Path(s) | Details | Requirements |
coverage-meta-profile-version | error | Coverage | Coverage: meta.profile with canonical and major.minor. version required. : meta.profile.exists($this.startsWith('http://hl7.org/fhir/us/carin-bb/StructureDefinition/C4BB-Coverage|2.0.')) |
Name | Flags | Card. | Type | Description & Constraints | ||||
---|---|---|---|---|---|---|---|---|
Coverage | C | 0..* | Coverage | Insurance or medical plan or a payment agreement coverage-meta-profile-version: Coverage: meta.profile with canonical and major.minor. version required. | ||||
id | Σ | 0..1 | id | Logical id of this artifact | ||||
meta | SΣ | 1..1 | Meta | Metadata about the resource | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
versionId | Σ | 0..1 | id | Version specific identifier | ||||
lastUpdated | SΣ | 1..1 | instant | When the resource version last changed | ||||
source | Σ | 0..1 | uri | Identifies where the resource comes from | ||||
profile | Σ | 1..* | canonical(StructureDefinition) | Profiles this resource claims to conform to | ||||
security | Σ | 0..* | Coding | Security Labels applied to this resource Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System. | ||||
tag | Σ | 0..* | Coding | Tags applied to this resource Binding: CommonTags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones". | ||||
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
language | 0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||
text | 0..1 | Narrative | Text summary of the resource, for human interpretation | |||||
contained | 0..* | Resource | Contained, inline Resources | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored | ||||
identifier | SΣ | 0..* | Identifier | Member ID and other identifiers | ||||
status | ?!SΣ | 1..1 | code | active | cancelled | draft | entered-in-error Binding: FinancialResourceStatusCodes (required): A code specifying the state of the resource instance. | ||||
type | Σ | 0..1 | CodeableConcept | Coverage 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 | Σ | 0..1 | Reference(Patient | RelatedPerson | Organization) | Owner of the policy | ||||
subscriber | Σ | 0..1 | Reference(Patient | RelatedPerson) | Subscriber to the policy | ||||
subscriberId | SΣ | 1..1 | string | ID assigned to the subscriber | ||||
beneficiary | SΣ | 1..1 | Reference(C4BB Patient) | Plan beneficiary | ||||
dependent | Σ | 0..1 | string | Dependent number | ||||
relationship | S | 1..1 | CodeableConcept | Beneficiary relationship to the subscriber Binding: SubscriberRelationshipCodes (required) | ||||
period | SΣ | 0..1 | Period | Coverage start and end dates | ||||
payor | SΣ | 1..1 | Reference(C4BB 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. Required Pattern: At least the following | ||||
id | 0..1 | id | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |||||
id | 0..1 | id | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
system | 1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/coverage-class | |||||
version | 0..1 | string | Version of the system - if relevant | |||||
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: group | |||||
display | 0..1 | string | Representation defined by the system | |||||
userSelected | 0..1 | boolean | If this coding was chosen directly by the user | |||||
text | 0..1 | string | Plain text representation of the concept | |||||
value | SΣ | 1..1 | string | Group Number | ||||
name | SΣ | 0..1 | string | Group Name | ||||
class:plan | S | 0..1 | BackboneElement | Plan | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
type | Σ | 1..1 | CodeableConcept | Type of class such as 'group' or 'plan' Binding: CoverageClassCodes (extensible): The policy classifications, eg. Group, Plan, Class, etc. Required Pattern: At least the following | ||||
id | 0..1 | id | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |||||
id | 0..1 | id | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
system | 1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/coverage-class | |||||
version | 0..1 | string | Version of the system - if relevant | |||||
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: plan | |||||
display | 0..1 | string | Representation defined by the system | |||||
userSelected | 0..1 | boolean | If this coding was chosen directly by the user | |||||
text | 0..1 | string | Plain text representation of the concept | |||||
value | SΣ | 1..1 | string | Plan Number | ||||
name | SΣ | 0..1 | string | Plan Name | ||||
order | Σ | 0..1 | positiveInt | Relative order of the coverage | ||||
network | Σ | 0..1 | string | Insurer network | ||||
costToBeneficiary | 0..* | BackboneElement | Patient payments for services/products | |||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
type | Σ | 0..1 | CodeableConcept | Cost category Binding: CoverageCopayTypeCodes (extensible): The types of services to which patient copayments are specified. | ||||
value[x] | Σ | 1..1 | The amount or percentage due from the beneficiary | |||||
valueQuantity | Quantity(SimpleQuantity) | |||||||
valueMoney | Money | |||||||
exception | 0..* | BackboneElement | Exceptions for patient payments | |||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
type | Σ | 1..1 | CodeableConcept | Exception category Binding: ExampleCoverageFinancialExceptionCodes (example): The types of exceptions from the part or full value of financial obligations such as copays. | ||||
period | Σ | 0..1 | Period | The effective period of the exception | ||||
subrogation | 0..1 | boolean | Reimbursement to insurer | |||||
contract | 0..* | Reference(Contract) | Contract details | |||||
Documentation for this format |
Path | Conformance | ValueSet / Code | ||||
Coverage.meta.security | extensible | All Security Labels | ||||
Coverage.meta.tag | example | CommonTags | ||||
Coverage.language | preferred | CommonLanguages
| ||||
Coverage.status | required | FinancialResourceStatusCodes | ||||
Coverage.type | preferred | CoverageTypeAndSelf-PayCodes | ||||
Coverage.relationship | required | SubscriberRelationshipCodes | ||||
Coverage.class.type | extensible | CoverageClassCodes | ||||
Coverage.class:group.type | extensible | Pattern: group | ||||
Coverage.class:plan.type | extensible | Pattern: plan | ||||
Coverage.costToBeneficiary.type | extensible | CoverageCopayTypeCodes | ||||
Coverage.costToBeneficiary.exception.type | example | ExampleCoverageFinancialExceptionCodes |
This structure is derived from Coverage
Summary
Mandatory: 5 elements
Must-Support: 16 elements
Structures
This structure refers to these other structures:
Slices
This structure defines the following Slices:
Differential View
This structure is derived from Coverage
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Coverage | C | 0..* | Coverage | Insurance or medical plan or a payment agreement coverage-meta-profile-version: Coverage: meta.profile with canonical and major.minor. version required. |
meta | S | 1..1 | Meta | Metadata about the resource |
lastUpdated | S | 1..1 | instant | When the resource version last changed |
profile | 1..* | canonical(StructureDefinition) | Profiles this resource claims to conform to | |
identifier | S | 0..* | Identifier | Member ID and other identifiers |
status | S | 1..1 | code | active | cancelled | draft | entered-in-error |
type | 0..1 | CodeableConcept | Coverage category such as medical or accident | |
subscriberId | S | 1..1 | string | ID assigned to the subscriber |
beneficiary | S | 1..1 | Reference(C4BB Patient) | Plan beneficiary |
relationship | S | 1..1 | CodeableConcept | Beneficiary relationship to the subscriber Binding: SubscriberRelationshipCodes (required) |
period | S | 0..1 | Period | Coverage start and end dates |
payor | S | 1..1 | Reference(C4BB 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' Required Pattern: At least the following | |
coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
system | 1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/coverage-class | |
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: group | |
value | S | 1..1 | string | Group Number |
name | S | 0..1 | string | Group Name |
class:plan | S | 0..1 | BackboneElement | Plan |
type | 1..1 | CodeableConcept | Type of class such as 'group' or 'plan' Required Pattern: At least the following | |
coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
system | 1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/coverage-class | |
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: plan | |
value | S | 1..1 | string | Plan Number |
name | S | 0..1 | string | Plan Name |
Documentation for this format |
Path | Conformance | ValueSet |
Coverage.relationship | required | SubscriberRelationshipCodes |
Id | Grade | Path(s) | Details | Requirements |
coverage-meta-profile-version | error | Coverage | Coverage: meta.profile with canonical and major.minor. version required. : meta.profile.exists($this.startsWith('http://hl7.org/fhir/us/carin-bb/StructureDefinition/C4BB-Coverage|2.0.')) |
Key Elements View
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Coverage | C | 0..* | Coverage | Insurance or medical plan or a payment agreement coverage-meta-profile-version: Coverage: meta.profile with canonical and major.minor. version required. |
meta | SΣ | 1..1 | Meta | Metadata about the resource |
lastUpdated | SΣ | 1..1 | instant | When the resource version last changed |
profile | Σ | 1..* | canonical(StructureDefinition) | Profiles this resource claims to conform to |
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created |
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
identifier | SΣ | 0..* | Identifier | Member ID and other identifiers |
status | ?!SΣ | 1..1 | code | active | cancelled | draft | entered-in-error Binding: FinancialResourceStatusCodes (required): A code specifying the state of the resource instance. |
type | Σ | 0..1 | CodeableConcept | Coverage 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. |
subscriberId | SΣ | 1..1 | string | ID assigned to the subscriber |
beneficiary | SΣ | 1..1 | Reference(C4BB Patient) | Plan beneficiary |
relationship | S | 1..1 | CodeableConcept | Beneficiary relationship to the subscriber Binding: SubscriberRelationshipCodes (required) |
period | SΣ | 0..1 | Period | Coverage start and end dates |
payor | SΣ | 1..1 | Reference(C4BB 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. Required Pattern: At least the following |
coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
system | 1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/coverage-class | |
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: group | |
value | SΣ | 1..1 | string | Group Number |
name | SΣ | 0..1 | string | Group Name |
class:plan | S | 0..1 | BackboneElement | Plan |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
type | Σ | 1..1 | CodeableConcept | Type of class such as 'group' or 'plan' Binding: CoverageClassCodes (extensible): The policy classifications, eg. Group, Plan, Class, etc. Required Pattern: At least the following |
coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
system | 1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/coverage-class | |
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: plan | |
value | SΣ | 1..1 | string | Plan Number |
name | SΣ | 0..1 | string | Plan Name |
Documentation for this format |
Path | Conformance | ValueSet / Code |
Coverage.status | required | FinancialResourceStatusCodes |
Coverage.type | preferred | CoverageTypeAndSelf-PayCodes |
Coverage.relationship | required | SubscriberRelationshipCodes |
Coverage.class.type | extensible | CoverageClassCodes |
Coverage.class:group.type | extensible | Pattern: group |
Coverage.class:plan.type | extensible | Pattern: plan |
Id | Grade | Path(s) | Details | Requirements |
coverage-meta-profile-version | error | Coverage | Coverage: meta.profile with canonical and major.minor. version required. : meta.profile.exists($this.startsWith('http://hl7.org/fhir/us/carin-bb/StructureDefinition/C4BB-Coverage|2.0.')) |
Snapshot View
Name | Flags | Card. | Type | Description & Constraints | ||||
---|---|---|---|---|---|---|---|---|
Coverage | C | 0..* | Coverage | Insurance or medical plan or a payment agreement coverage-meta-profile-version: Coverage: meta.profile with canonical and major.minor. version required. | ||||
id | Σ | 0..1 | id | Logical id of this artifact | ||||
meta | SΣ | 1..1 | Meta | Metadata about the resource | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
versionId | Σ | 0..1 | id | Version specific identifier | ||||
lastUpdated | SΣ | 1..1 | instant | When the resource version last changed | ||||
source | Σ | 0..1 | uri | Identifies where the resource comes from | ||||
profile | Σ | 1..* | canonical(StructureDefinition) | Profiles this resource claims to conform to | ||||
security | Σ | 0..* | Coding | Security Labels applied to this resource Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System. | ||||
tag | Σ | 0..* | Coding | Tags applied to this resource Binding: CommonTags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones". | ||||
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
language | 0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||
text | 0..1 | Narrative | Text summary of the resource, for human interpretation | |||||
contained | 0..* | Resource | Contained, inline Resources | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored | ||||
identifier | SΣ | 0..* | Identifier | Member ID and other identifiers | ||||
status | ?!SΣ | 1..1 | code | active | cancelled | draft | entered-in-error Binding: FinancialResourceStatusCodes (required): A code specifying the state of the resource instance. | ||||
type | Σ | 0..1 | CodeableConcept | Coverage 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 | Σ | 0..1 | Reference(Patient | RelatedPerson | Organization) | Owner of the policy | ||||
subscriber | Σ | 0..1 | Reference(Patient | RelatedPerson) | Subscriber to the policy | ||||
subscriberId | SΣ | 1..1 | string | ID assigned to the subscriber | ||||
beneficiary | SΣ | 1..1 | Reference(C4BB Patient) | Plan beneficiary | ||||
dependent | Σ | 0..1 | string | Dependent number | ||||
relationship | S | 1..1 | CodeableConcept | Beneficiary relationship to the subscriber Binding: SubscriberRelationshipCodes (required) | ||||
period | SΣ | 0..1 | Period | Coverage start and end dates | ||||
payor | SΣ | 1..1 | Reference(C4BB 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. Required Pattern: At least the following | ||||
id | 0..1 | id | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |||||
id | 0..1 | id | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
system | 1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/coverage-class | |||||
version | 0..1 | string | Version of the system - if relevant | |||||
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: group | |||||
display | 0..1 | string | Representation defined by the system | |||||
userSelected | 0..1 | boolean | If this coding was chosen directly by the user | |||||
text | 0..1 | string | Plain text representation of the concept | |||||
value | SΣ | 1..1 | string | Group Number | ||||
name | SΣ | 0..1 | string | Group Name | ||||
class:plan | S | 0..1 | BackboneElement | Plan | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
type | Σ | 1..1 | CodeableConcept | Type of class such as 'group' or 'plan' Binding: CoverageClassCodes (extensible): The policy classifications, eg. Group, Plan, Class, etc. Required Pattern: At least the following | ||||
id | 0..1 | id | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |||||
id | 0..1 | id | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
system | 1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/coverage-class | |||||
version | 0..1 | string | Version of the system - if relevant | |||||
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: plan | |||||
display | 0..1 | string | Representation defined by the system | |||||
userSelected | 0..1 | boolean | If this coding was chosen directly by the user | |||||
text | 0..1 | string | Plain text representation of the concept | |||||
value | SΣ | 1..1 | string | Plan Number | ||||
name | SΣ | 0..1 | string | Plan Name | ||||
order | Σ | 0..1 | positiveInt | Relative order of the coverage | ||||
network | Σ | 0..1 | string | Insurer network | ||||
costToBeneficiary | 0..* | BackboneElement | Patient payments for services/products | |||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
type | Σ | 0..1 | CodeableConcept | Cost category Binding: CoverageCopayTypeCodes (extensible): The types of services to which patient copayments are specified. | ||||
value[x] | Σ | 1..1 | The amount or percentage due from the beneficiary | |||||
valueQuantity | Quantity(SimpleQuantity) | |||||||
valueMoney | Money | |||||||
exception | 0..* | BackboneElement | Exceptions for patient payments | |||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
type | Σ | 1..1 | CodeableConcept | Exception category Binding: ExampleCoverageFinancialExceptionCodes (example): The types of exceptions from the part or full value of financial obligations such as copays. | ||||
period | Σ | 0..1 | Period | The effective period of the exception | ||||
subrogation | 0..1 | boolean | Reimbursement to insurer | |||||
contract | 0..* | Reference(Contract) | Contract details | |||||
Documentation for this format |
Path | Conformance | ValueSet / Code | ||||
Coverage.meta.security | extensible | All Security Labels | ||||
Coverage.meta.tag | example | CommonTags | ||||
Coverage.language | preferred | CommonLanguages
| ||||
Coverage.status | required | FinancialResourceStatusCodes | ||||
Coverage.type | preferred | CoverageTypeAndSelf-PayCodes | ||||
Coverage.relationship | required | SubscriberRelationshipCodes | ||||
Coverage.class.type | extensible | CoverageClassCodes | ||||
Coverage.class:group.type | extensible | Pattern: group | ||||
Coverage.class:plan.type | extensible | Pattern: plan | ||||
Coverage.costToBeneficiary.type | extensible | CoverageCopayTypeCodes | ||||
Coverage.costToBeneficiary.exception.type | example | ExampleCoverageFinancialExceptionCodes |
This structure is derived from Coverage
Summary
Mandatory: 5 elements
Must-Support: 16 elements
Structures
This structure refers to these other structures:
Slices
This structure defines the following Slices:
Other representations of profile: CSV, Excel, Schematron