This page is part of the Da Vinci Payer Data Exchange (v1.0.0: STU1) 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
Defining URL: | http://hl7.org/fhir/us/davinci-pdex/StructureDefinition/hrex-coverage |
Version: | 1.0.0 |
Name: | HrexCoverage |
Title: | HRex Coverage Profile |
Status: | Draft as of 2020-12-22T14:17:18+00:00 |
Definition: | The HRex Coverage Profile defines the constraints for representing a member's healthcare insurance information to the Payer. Coverage instances complying with this profile, sometimes together with the Patient which this profile references via |
Publisher: | HL7 International |
Source Resource: | XML / JSON / Turtle |
The official URL for this profile is:
http://hl7.org/fhir/us/davinci-pdex/StructureDefinition/hrex-coverage
Coverage is a resource that is used by a number of use cases and Implementation Guides. The Coverage resource included in the PDex Implementation Guide will be superceded by the Coverage profile that is defined in the HRex Implementation Guide.
Check the Da Vinci Health Record Exchange IG Directory of Published Versions History Page> for release information: http://hl7.org/fhir/us/davinci-hrex/2020Sep
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from Coverage
This structure is derived from Coverage
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Coverage | 0..* | Coverage | Insurance or medical plan or a payment agreement | |
identifier | S | 0..* | Identifier | Business Identifier for the coverage |
type | 0..1 | CodeableConcept | Coverage category such as medical or accident Binding: CoverageTypeAndSelf-PayCodes (required) | |
policyHolder | 0..1 | Reference(US Core Patient Profile | US Core Organization Profile | RelatedPerson) | Owner of the policy | |
subscriber | 0..1 | Reference(US Core Patient Profile) | Subscriber to the policy | |
subscriberId | S | 0..1 | string | ID assigned to the subscriber |
beneficiary | S | 1..1 | Reference(US Core Patient Profile) | Plan beneficiary |
payor | S | 1..* | Reference(US Core Organization Profile) | Issuer of the policy |
Documentation for this format |
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Coverage | 0..* | Coverage | Insurance or medical plan or a payment agreement | |
id | Σ | 0..1 | string | 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) Max Binding: AllLanguages: 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 | Business Identifier for the coverage |
status | ?!Σ | 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 (required) |
policyHolder | Σ | 0..1 | Reference(US Core Patient Profile | US Core Organization Profile | RelatedPerson) | Owner of the policy |
subscriber | Σ | 0..1 | Reference(US Core Patient Profile) | Subscriber to the policy |
subscriberId | SΣ | 0..1 | string | ID assigned to the subscriber |
beneficiary | SΣ | 1..1 | Reference(US Core Patient Profile) | Plan beneficiary |
dependent | Σ | 0..1 | string | Dependent number |
relationship | 0..1 | CodeableConcept | Beneficiary relationship to the subscriber Binding: SubscriberRelationshipCodes (extensible): The relationship between the Subscriber and the Beneficiary (insured/covered party/patient). | |
period | Σ | 0..1 | Period | Coverage start and end dates |
payor | SΣ | 1..* | Reference(US Core Organization Profile) | Issuer of the policy |
class | 0..* | 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. |
value | Σ | 1..1 | string | Value associated with the type |
name | Σ | 0..1 | string | Human readable description of the type and value |
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 |
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Coverage | 0..* | Coverage | Insurance or medical plan or a payment agreement | |
identifier | Σ | 0..* | Identifier | Business Identifier for the coverage |
subscriberId | Σ | 0..1 | string | ID assigned to the subscriber |
beneficiary | Σ | 1..1 | Reference(US Core Patient Profile) | Plan beneficiary |
payor | Σ | 1..* | Reference(US Core Organization Profile) | Issuer of the policy |
Documentation for this format |
This structure is derived from Coverage
Differential View
This structure is derived from Coverage
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Coverage | 0..* | Coverage | Insurance or medical plan or a payment agreement | |
identifier | S | 0..* | Identifier | Business Identifier for the coverage |
type | 0..1 | CodeableConcept | Coverage category such as medical or accident Binding: CoverageTypeAndSelf-PayCodes (required) | |
policyHolder | 0..1 | Reference(US Core Patient Profile | US Core Organization Profile | RelatedPerson) | Owner of the policy | |
subscriber | 0..1 | Reference(US Core Patient Profile) | Subscriber to the policy | |
subscriberId | S | 0..1 | string | ID assigned to the subscriber |
beneficiary | S | 1..1 | Reference(US Core Patient Profile) | Plan beneficiary |
payor | S | 1..* | Reference(US Core Organization Profile) | Issuer of the policy |
Documentation for this format |
Snapshot View
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Coverage | 0..* | Coverage | Insurance or medical plan or a payment agreement | |
id | Σ | 0..1 | string | 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) Max Binding: AllLanguages: 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 | Business Identifier for the coverage |
status | ?!Σ | 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 (required) |
policyHolder | Σ | 0..1 | Reference(US Core Patient Profile | US Core Organization Profile | RelatedPerson) | Owner of the policy |
subscriber | Σ | 0..1 | Reference(US Core Patient Profile) | Subscriber to the policy |
subscriberId | SΣ | 0..1 | string | ID assigned to the subscriber |
beneficiary | SΣ | 1..1 | Reference(US Core Patient Profile) | Plan beneficiary |
dependent | Σ | 0..1 | string | Dependent number |
relationship | 0..1 | CodeableConcept | Beneficiary relationship to the subscriber Binding: SubscriberRelationshipCodes (extensible): The relationship between the Subscriber and the Beneficiary (insured/covered party/patient). | |
period | Σ | 0..1 | Period | Coverage start and end dates |
payor | SΣ | 1..* | Reference(US Core Organization Profile) | Issuer of the policy |
class | 0..* | 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. |
value | Σ | 1..1 | string | Value associated with the type |
name | Σ | 0..1 | string | Human readable description of the type and value |
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 |
Other representations of profile: Schematron
Path | Conformance | ValueSet |
Coverage.language | preferred | CommonLanguages Max Binding: AllLanguages |
Coverage.status | required | FinancialResourceStatusCodes |
Coverage.type | required | CoverageTypeAndSelf-PayCodes |
Coverage.relationship | extensible | SubscriberRelationshipCodes |
Coverage.class.type | extensible | CoverageClassCodes |
Coverage.costToBeneficiary.type | extensible | CoverageCopayTypeCodes |
Coverage.costToBeneficiary.exception.type | example | ExampleCoverageFinancialExceptionCodes |