This page is part of the Da Vinci Coverage Requirements Discovery (CRD) FHIR IG (v2.0.1: STU 2.0) based on FHIR (HL7® FHIR® Standard) 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/davinci-crd/StructureDefinition/profile-coverage | Version: 2.0.1 | |||
Standards status: Trial-use | Maturity Level: 2 | Computable Name: Coverage |
This profile specifies constraints on the Coverage resource to support coverage requirements discovery.
CRD Clients SHALL use this profile to resolve references to insurance Coverage resources passed to CRD Servers.
Information provided in Must Support elements will commonly be required for CRD Servers to perform coverage requirements discovery.
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 us-core-15: Member Id in Coverage.identifier or Coverage.subscriberId SHALL be present |
Slices for identifier | S | 0..* | Identifier | Business Identifier for the coverage Slice: Unordered, Open by pattern:type |
identifier:MBIdentifier | S | 0..1 | Identifier | EMR Identifier for MB |
type | S | 1..1 | CodeableConcept | Description of identifier Required Pattern: At least the following |
coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
system | 1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0203 | |
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: MB | |
status | S | 1..1 | code | active | cancelled | draft | entered-in-error |
type | S | 0..1 | CodeableConcept | Coverage category such as medical or accident Binding: Payer Type (extensible) |
policyHolder | S | 0..1 | Reference(CRD Patient | CRD Organization) | Owner of the policy |
subscriber | S | 0..1 | Reference(CRD Patient) | Subscriber to the policy |
subscriberId | S | 0..1 | string | ID assigned to the subscriber |
beneficiary | S | 1..1 | Reference(CRD Patient) | Plan beneficiary |
dependent | S | 0..1 | string | Dependent number |
relationship | S | 0..1 | CodeableConcept | Beneficiary relationship to the subscriber |
period | S | 0..1 | Period | Coverage start and end dates |
payor | S | 1..* | Reference(CRD Patient | CRD 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 | Additional coverage classifications |
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 | Additional coverage classifications |
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 |
order | S | 0..1 | positiveInt | Relative order of the coverage |
network | S | 0..1 | string | Insurer network |
costToBeneficiary | 0..0 | |||
Documentation for this format |
Path | Conformance | ValueSet |
Coverage.type | extensible | PayerType |
Id | Grade | Path(s) | Details | Requirements |
us-core-15 | error | Coverage | Member Id in Coverage.identifier or Coverage.subscriberId SHALL be present : identifier.type.coding.where(system='http://terminology.hl7.org/CodeSystem/v2-0203' and code='MB').exists() or subscriberId.exists() |
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Coverage | C | 0..* | Coverage | Insurance or medical plan or a payment agreement us-core-15: Member Id in Coverage.identifier or Coverage.subscriberId SHALL be present |
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created |
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
Slices for identifier | SΣ | 0..* | Identifier | Business Identifier for the coverage Slice: Unordered, Open by pattern:type |
identifier:MBIdentifier | SΣ | 0..1 | Identifier | EMR Identifier for MB |
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 | Description 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. Required Pattern: At least the following |
coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
system | 1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0203 | |
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: MB | |
status | ?!SΣ | 1..1 | code | active | cancelled | draft | entered-in-error Binding: FinancialResourceStatusCodes (required): A code specifying the state of the resource instance. |
type | SΣ | 0..1 | CodeableConcept | Coverage category such as medical or accident Binding: Payer Type (extensible) |
policyHolder | SΣ | 0..1 | Reference(CRD Patient | CRD Organization) | Owner of the policy |
subscriber | SΣ | 0..1 | Reference(CRD Patient) | Subscriber to the policy |
subscriberId | SΣ | 0..1 | string | ID assigned to the subscriber |
beneficiary | SΣ | 1..1 | Reference(CRD Patient) | Plan beneficiary |
dependent | SΣ | 0..1 | string | Dependent number |
relationship | S | 0..1 | CodeableConcept | Beneficiary relationship to the subscriber Binding: SubscriberRelationshipCodes (extensible): The relationship between the Subscriber and the Beneficiary (insured/covered party/patient). |
period | SΣ | 0..1 | Period | Coverage start and end dates |
payor | SΣ | 1..* | Reference(CRD Patient | CRD 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 | Additional coverage classifications |
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 | Additional coverage classifications |
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 |
order | SΣ | 0..1 | positiveInt | Relative order of the coverage |
network | SΣ | 0..1 | string | Insurer network |
Documentation for this format |
Path | Conformance | ValueSet / Code |
Coverage.identifier:MBIdentifier.use | required | IdentifierUse |
Coverage.identifier:MBIdentifier.type | extensible | Pattern: MB |
Coverage.status | required | FinancialResourceStatusCodes |
Coverage.type | extensible | PayerType |
Coverage.relationship | extensible | 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 |
dom-2 | error | Coverage | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
dom-3 | error | Coverage | If 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-4 | error | Coverage | If 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-5 | error | Coverage | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
dom-6 | best practice | Coverage | A resource should have narrative for robust management : text.`div`.exists() | |
ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
us-core-15 | error | Coverage | Member Id in Coverage.identifier or Coverage.subscriberId SHALL be present : identifier.type.coding.where(system='http://terminology.hl7.org/CodeSystem/v2-0203' and code='MB').exists() or subscriberId.exists() |
Name | Flags | Card. | Type | Description & Constraints | ||||
---|---|---|---|---|---|---|---|---|
Coverage | C | 0..* | Coverage | Insurance or medical plan or a payment agreement us-core-15: Member Id in Coverage.identifier or Coverage.subscriberId SHALL be present | ||||
id | Σ | 0..1 | id | Logical id of this artifact | ||||
meta | Σ | 0..1 | Meta | Metadata about the resource | ||||
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
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 | ||||
Slices for identifier | SΣ | 0..* | Identifier | Business Identifier for the coverage Slice: Unordered, Open by pattern:type | ||||
identifier:MBIdentifier | SΣ | 0..1 | Identifier | EMR Identifier for MB | ||||
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 | Description 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. Required Pattern: At least the following | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
system | 1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0203 | |||||
version | 0..1 | string | Version of the system - if relevant | |||||
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: MB | |||||
display | 0..1 | string | Representation defined by the system | |||||
userSelected | 0..1 | boolean | If this coding was chosen directly by the user | |||||
text | 0..1 | string | Plain text representation of the concept | |||||
system | Σ | 0..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient | ||||
value | Σ | 0..1 | string | The value that is unique Example General: 123456 | ||||
period | Σ | 0..1 | Period | Time period when id is/was valid for use | ||||
assigner | Σ | 0..1 | Reference(Organization) | Organization that issued id (may be just text) | ||||
status | ?!SΣ | 1..1 | code | active | cancelled | draft | entered-in-error Binding: FinancialResourceStatusCodes (required): A code specifying the state of the resource instance. | ||||
type | SΣ | 0..1 | CodeableConcept | Coverage category such as medical or accident Binding: Payer Type (extensible) | ||||
policyHolder | SΣ | 0..1 | Reference(CRD Patient | CRD Organization) | Owner of the policy | ||||
subscriber | SΣ | 0..1 | Reference(CRD Patient) | Subscriber to the policy | ||||
subscriberId | SΣ | 0..1 | string | ID assigned to the subscriber | ||||
beneficiary | SΣ | 1..1 | Reference(CRD Patient) | Plan beneficiary | ||||
dependent | SΣ | 0..1 | string | Dependent number | ||||
relationship | S | 0..1 | CodeableConcept | Beneficiary relationship to the subscriber Binding: SubscriberRelationshipCodes (extensible): The relationship between the Subscriber and the Beneficiary (insured/covered party/patient). | ||||
period | SΣ | 0..1 | Period | Coverage start and end dates | ||||
payor | SΣ | 1..* | Reference(CRD Patient | CRD 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 | Additional coverage classifications | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
type | Σ | 1..1 | CodeableConcept | Type of class such as 'group' or 'plan' Binding: CoverageClassCodes (extensible): The policy classifications, eg. Group, Plan, Class, etc. Required Pattern: At least the following | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
system | 1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/coverage-class | |||||
version | 0..1 | string | Version of the system - if relevant | |||||
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: group | |||||
display | 0..1 | string | Representation defined by the system | |||||
userSelected | 0..1 | boolean | If this coding was chosen directly by the user | |||||
text | 0..1 | string | Plain text representation of the concept | |||||
value | SΣ | 1..1 | string | Group Number | ||||
name | SΣ | 0..1 | string | Group Name | ||||
class:plan | S | 0..1 | BackboneElement | Additional coverage classifications | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
type | Σ | 1..1 | CodeableConcept | Type of class such as 'group' or 'plan' Binding: CoverageClassCodes (extensible): The policy classifications, eg. Group, Plan, Class, etc. Required Pattern: At least the following | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
system | 1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/coverage-class | |||||
version | 0..1 | string | Version of the system - if relevant | |||||
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: plan | |||||
display | 0..1 | string | Representation defined by the system | |||||
userSelected | 0..1 | boolean | If this coding was chosen directly by the user | |||||
text | 0..1 | string | Plain text representation of the concept | |||||
value | SΣ | 1..1 | string | Plan Number | ||||
name | SΣ | 0..1 | string | Plan Name | ||||
order | SΣ | 0..1 | positiveInt | Relative order of the coverage | ||||
network | SΣ | 0..1 | string | Insurer network | ||||
subrogation | 0..1 | boolean | Reimbursement to insurer | |||||
contract | 0..* | Reference(Contract) | Contract details | |||||
Documentation for this format |
Path | Conformance | ValueSet / Code | ||||
Coverage.language | preferred | CommonLanguages
| ||||
Coverage.identifier:MBIdentifier.use | required | IdentifierUse | ||||
Coverage.identifier:MBIdentifier.type | extensible | Pattern: MB | ||||
Coverage.status | required | FinancialResourceStatusCodes | ||||
Coverage.type | extensible | PayerType | ||||
Coverage.relationship | extensible | 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 |
Id | Grade | Path(s) | Details | Requirements |
dom-2 | error | Coverage | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
dom-3 | error | Coverage | If 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-4 | error | Coverage | If 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-5 | error | Coverage | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
dom-6 | best practice | Coverage | A resource should have narrative for robust management : text.`div`.exists() | |
ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
us-core-15 | error | Coverage | Member Id in Coverage.identifier or Coverage.subscriberId SHALL be present : identifier.type.coding.where(system='http://terminology.hl7.org/CodeSystem/v2-0203' and code='MB').exists() or subscriberId.exists() |
This structure is derived from Coverage
Summary
Mandatory: 0 element (1 nested mandatory element)
Must-Support: 22 elements
Prohibited: 1 element
Structures
This structure refers to these other structures:
Slices
This structure defines the following Slices:
Maturity: 2
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 us-core-15: Member Id in Coverage.identifier or Coverage.subscriberId SHALL be present |
Slices for identifier | S | 0..* | Identifier | Business Identifier for the coverage Slice: Unordered, Open by pattern:type |
identifier:MBIdentifier | S | 0..1 | Identifier | EMR Identifier for MB |
type | S | 1..1 | CodeableConcept | Description of identifier Required Pattern: At least the following |
coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
system | 1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0203 | |
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: MB | |
status | S | 1..1 | code | active | cancelled | draft | entered-in-error |
type | S | 0..1 | CodeableConcept | Coverage category such as medical or accident Binding: Payer Type (extensible) |
policyHolder | S | 0..1 | Reference(CRD Patient | CRD Organization) | Owner of the policy |
subscriber | S | 0..1 | Reference(CRD Patient) | Subscriber to the policy |
subscriberId | S | 0..1 | string | ID assigned to the subscriber |
beneficiary | S | 1..1 | Reference(CRD Patient) | Plan beneficiary |
dependent | S | 0..1 | string | Dependent number |
relationship | S | 0..1 | CodeableConcept | Beneficiary relationship to the subscriber |
period | S | 0..1 | Period | Coverage start and end dates |
payor | S | 1..* | Reference(CRD Patient | CRD 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 | Additional coverage classifications |
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 | Additional coverage classifications |
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 |
order | S | 0..1 | positiveInt | Relative order of the coverage |
network | S | 0..1 | string | Insurer network |
costToBeneficiary | 0..0 | |||
Documentation for this format |
Path | Conformance | ValueSet |
Coverage.type | extensible | PayerType |
Id | Grade | Path(s) | Details | Requirements |
us-core-15 | error | Coverage | Member Id in Coverage.identifier or Coverage.subscriberId SHALL be present : identifier.type.coding.where(system='http://terminology.hl7.org/CodeSystem/v2-0203' and code='MB').exists() or subscriberId.exists() |
Key Elements View
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Coverage | C | 0..* | Coverage | Insurance or medical plan or a payment agreement us-core-15: Member Id in Coverage.identifier or Coverage.subscriberId SHALL be present |
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created |
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
Slices for identifier | SΣ | 0..* | Identifier | Business Identifier for the coverage Slice: Unordered, Open by pattern:type |
identifier:MBIdentifier | SΣ | 0..1 | Identifier | EMR Identifier for MB |
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 | Description 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. Required Pattern: At least the following |
coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
system | 1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0203 | |
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: MB | |
status | ?!SΣ | 1..1 | code | active | cancelled | draft | entered-in-error Binding: FinancialResourceStatusCodes (required): A code specifying the state of the resource instance. |
type | SΣ | 0..1 | CodeableConcept | Coverage category such as medical or accident Binding: Payer Type (extensible) |
policyHolder | SΣ | 0..1 | Reference(CRD Patient | CRD Organization) | Owner of the policy |
subscriber | SΣ | 0..1 | Reference(CRD Patient) | Subscriber to the policy |
subscriberId | SΣ | 0..1 | string | ID assigned to the subscriber |
beneficiary | SΣ | 1..1 | Reference(CRD Patient) | Plan beneficiary |
dependent | SΣ | 0..1 | string | Dependent number |
relationship | S | 0..1 | CodeableConcept | Beneficiary relationship to the subscriber Binding: SubscriberRelationshipCodes (extensible): The relationship between the Subscriber and the Beneficiary (insured/covered party/patient). |
period | SΣ | 0..1 | Period | Coverage start and end dates |
payor | SΣ | 1..* | Reference(CRD Patient | CRD 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 | Additional coverage classifications |
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 | Additional coverage classifications |
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 |
order | SΣ | 0..1 | positiveInt | Relative order of the coverage |
network | SΣ | 0..1 | string | Insurer network |
Documentation for this format |
Path | Conformance | ValueSet / Code |
Coverage.identifier:MBIdentifier.use | required | IdentifierUse |
Coverage.identifier:MBIdentifier.type | extensible | Pattern: MB |
Coverage.status | required | FinancialResourceStatusCodes |
Coverage.type | extensible | PayerType |
Coverage.relationship | extensible | 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 |
dom-2 | error | Coverage | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
dom-3 | error | Coverage | If 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-4 | error | Coverage | If 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-5 | error | Coverage | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
dom-6 | best practice | Coverage | A resource should have narrative for robust management : text.`div`.exists() | |
ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
us-core-15 | error | Coverage | Member Id in Coverage.identifier or Coverage.subscriberId SHALL be present : identifier.type.coding.where(system='http://terminology.hl7.org/CodeSystem/v2-0203' and code='MB').exists() or subscriberId.exists() |
Snapshot View
Name | Flags | Card. | Type | Description & Constraints | ||||
---|---|---|---|---|---|---|---|---|
Coverage | C | 0..* | Coverage | Insurance or medical plan or a payment agreement us-core-15: Member Id in Coverage.identifier or Coverage.subscriberId SHALL be present | ||||
id | Σ | 0..1 | id | Logical id of this artifact | ||||
meta | Σ | 0..1 | Meta | Metadata about the resource | ||||
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
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 | ||||
Slices for identifier | SΣ | 0..* | Identifier | Business Identifier for the coverage Slice: Unordered, Open by pattern:type | ||||
identifier:MBIdentifier | SΣ | 0..1 | Identifier | EMR Identifier for MB | ||||
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 | Description 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. Required Pattern: At least the following | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
system | 1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0203 | |||||
version | 0..1 | string | Version of the system - if relevant | |||||
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: MB | |||||
display | 0..1 | string | Representation defined by the system | |||||
userSelected | 0..1 | boolean | If this coding was chosen directly by the user | |||||
text | 0..1 | string | Plain text representation of the concept | |||||
system | Σ | 0..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient | ||||
value | Σ | 0..1 | string | The value that is unique Example General: 123456 | ||||
period | Σ | 0..1 | Period | Time period when id is/was valid for use | ||||
assigner | Σ | 0..1 | Reference(Organization) | Organization that issued id (may be just text) | ||||
status | ?!SΣ | 1..1 | code | active | cancelled | draft | entered-in-error Binding: FinancialResourceStatusCodes (required): A code specifying the state of the resource instance. | ||||
type | SΣ | 0..1 | CodeableConcept | Coverage category such as medical or accident Binding: Payer Type (extensible) | ||||
policyHolder | SΣ | 0..1 | Reference(CRD Patient | CRD Organization) | Owner of the policy | ||||
subscriber | SΣ | 0..1 | Reference(CRD Patient) | Subscriber to the policy | ||||
subscriberId | SΣ | 0..1 | string | ID assigned to the subscriber | ||||
beneficiary | SΣ | 1..1 | Reference(CRD Patient) | Plan beneficiary | ||||
dependent | SΣ | 0..1 | string | Dependent number | ||||
relationship | S | 0..1 | CodeableConcept | Beneficiary relationship to the subscriber Binding: SubscriberRelationshipCodes (extensible): The relationship between the Subscriber and the Beneficiary (insured/covered party/patient). | ||||
period | SΣ | 0..1 | Period | Coverage start and end dates | ||||
payor | SΣ | 1..* | Reference(CRD Patient | CRD 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 | Additional coverage classifications | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
type | Σ | 1..1 | CodeableConcept | Type of class such as 'group' or 'plan' Binding: CoverageClassCodes (extensible): The policy classifications, eg. Group, Plan, Class, etc. Required Pattern: At least the following | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
system | 1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/coverage-class | |||||
version | 0..1 | string | Version of the system - if relevant | |||||
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: group | |||||
display | 0..1 | string | Representation defined by the system | |||||
userSelected | 0..1 | boolean | If this coding was chosen directly by the user | |||||
text | 0..1 | string | Plain text representation of the concept | |||||
value | SΣ | 1..1 | string | Group Number | ||||
name | SΣ | 0..1 | string | Group Name | ||||
class:plan | S | 0..1 | BackboneElement | Additional coverage classifications | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
type | Σ | 1..1 | CodeableConcept | Type of class such as 'group' or 'plan' Binding: CoverageClassCodes (extensible): The policy classifications, eg. Group, Plan, Class, etc. Required Pattern: At least the following | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
system | 1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/coverage-class | |||||
version | 0..1 | string | Version of the system - if relevant | |||||
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: plan | |||||
display | 0..1 | string | Representation defined by the system | |||||
userSelected | 0..1 | boolean | If this coding was chosen directly by the user | |||||
text | 0..1 | string | Plain text representation of the concept | |||||
value | SΣ | 1..1 | string | Plan Number | ||||
name | SΣ | 0..1 | string | Plan Name | ||||
order | SΣ | 0..1 | positiveInt | Relative order of the coverage | ||||
network | SΣ | 0..1 | string | Insurer network | ||||
subrogation | 0..1 | boolean | Reimbursement to insurer | |||||
contract | 0..* | Reference(Contract) | Contract details | |||||
Documentation for this format |
Path | Conformance | ValueSet / Code | ||||
Coverage.language | preferred | CommonLanguages
| ||||
Coverage.identifier:MBIdentifier.use | required | IdentifierUse | ||||
Coverage.identifier:MBIdentifier.type | extensible | Pattern: MB | ||||
Coverage.status | required | FinancialResourceStatusCodes | ||||
Coverage.type | extensible | PayerType | ||||
Coverage.relationship | extensible | 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 |
Id | Grade | Path(s) | Details | Requirements |
dom-2 | error | Coverage | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
dom-3 | error | Coverage | If 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-4 | error | Coverage | If 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-5 | error | Coverage | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
dom-6 | best practice | Coverage | A resource should have narrative for robust management : text.`div`.exists() | |
ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
us-core-15 | error | Coverage | Member Id in Coverage.identifier or Coverage.subscriberId SHALL be present : identifier.type.coding.where(system='http://terminology.hl7.org/CodeSystem/v2-0203' and code='MB').exists() or subscriberId.exists() |
This structure is derived from Coverage
Summary
Mandatory: 0 element (1 nested mandatory element)
Must-Support: 22 elements
Prohibited: 1 element
Structures
This structure refers to these other structures:
Slices
This structure defines the following Slices:
Maturity: 2
Other representations of profile: CSV, Excel, Schematron