BSeR: Bidirectional Services_eReferral
BSeR: Bidirectional Services_eReferral
This page is part of the Bidirectional Services eReferrals (BSeR) (v1.0.0: STU 1) based on FHIR R4. This is the current published version in it's permanent home (it will always be available at this URL). For a full list of available versions, see the Directory of published versions 
Coverage high-level identifiers and descriptors of an insurance plan underwriting some or all of the cost of the referral services provided.
The official URL for this profile is:
http://hl7.org/fhir/us/bser/StructureDefinition/BSeR-Coverage
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 | ||
  identifier | 0..1 | Identifier | ||
| status | 1..1 | code | Binding: FinancialResourceStatusCodes (required) | |
| type | 1..1 | CodeableConcept | Binding: CoverageTypeAndSelf-PayCodes (extensible) | |
 subscriber | 1..1 | Reference(RelatedPerson) | ||
| beneficiary | 1..1 | Reference(US Core Patient Profile) | ||
 period | 0..1 | Period | ||
 start | 1..1 | dateTime | ||
 end | 0..1 | dateTime | ||
| payor | 1..1 | Reference(BSeR Organization) | ||
 class | 0..* | BackboneElement | ||
 type | 1..1 | CodeableConcept | Binding: CoverageClassCodes (extensible) | |
| value | 1..1 | string | ||
| Documentation for this format | ||||
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Coverage | I | 0..* | Coverage | Insurance or medical plan or a payment agreement |
 id | Σ | 0..1 | string | Logical id of this artifact |
 meta | ΣI | 0..1 | Meta | Metadata about the resource |
| implicitRules | ?!ΣI | 0..1 | uri | A set of rules under which this content was created |
| language | I | 0..1 | code | Language of the resource content Binding: CommonLanguages (preferred) Max Binding: AllLanguages |
| text | I | 0..1 | Narrative | Text summary of the resource, for human interpretation |
| contained | 0..* | Resource | Contained, inline Resources | |
 extension | I | 0..* | Extension | Additional content defined by implementations |
 modifierExtension | ?!I | 0..* | Extension | Extensions that cannot be ignored |
| identifier | ΣI | 0..1 | Identifier | Business Identifier for the coverage |
| status | ?!ΣI | 1..1 | code | active | cancelled | draft | entered-in-error Binding: FinancialResourceStatusCodes (required) |
| type | ΣI | 1..1 | CodeableConcept | Coverage category such as medical or accident Binding: CoverageTypeAndSelf-PayCodes (extensible) |
| policyHolder | ΣI | 0..1 | Reference(Patient | RelatedPerson | Organization) | Owner of the policy |
| subscriber | ΣI | 1..1 | Reference(RelatedPerson) | Subscriber to the policy |
| subscriberId | ΣI | 0..1 | string | ID assigned to the subscriber |
| beneficiary | ΣI | 1..1 | Reference(US Core Patient Profile) | Plan beneficiary |
| dependent | ΣI | 0..1 | string | Dependent number |
| relationship | I | 0..1 | CodeableConcept | Beneficiary relationship to the subscriber Binding: SubscriberRelationshipCodes (extensible) |
| period | ΣI | 0..1 | Period | Coverage start and end dates |
| id | 0..1 | string | Unique id for inter-element referencing | |
| extension | I | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url |
| start | ΣI | 1..1 | dateTime | Starting time with inclusive boundary |
| end | ΣI | 0..1 | dateTime | End time with inclusive boundary, if not ongoing |
| payor | ΣI | 1..1 | Reference(BSeR Organization) | Issuer of the policy |
| class | I | 0..* | BackboneElement | Additional coverage classifications |
| id | 0..1 | string | Unique id for inter-element referencing | |
| extension | I | 0..* | Extension | Additional content defined by implementations |
| modifierExtension | ?!ΣI | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| type | ΣI | 1..1 | CodeableConcept | Type of class such as 'group' or 'plan' Binding: CoverageClassCodes (extensible) |
| value | ΣI | 1..1 | string | Value associated with the type |
| name | ΣI | 0..1 | string | Human readable description of the type and value |
| order | ΣI | 0..1 | positiveInt | Relative order of the coverage |
| network | ΣI | 0..1 | string | Insurer network |
| costToBeneficiary | I | 0..* | BackboneElement | Patient payments for services/products |
| id | 0..1 | string | Unique id for inter-element referencing | |
| extension | I | 0..* | Extension | Additional content defined by implementations |
| modifierExtension | ?!ΣI | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| type | ΣI | 0..1 | CodeableConcept | Cost category Binding: CoverageCopayTypeCodes (extensible) |
 value[x] | ΣI | 1..1 | The amount or percentage due from the beneficiary | |
| valueQuantity | Quantity(SimpleQuantity) | |||
| valueMoney | Money | |||
| exception | I | 0..* | BackboneElement | Exceptions for patient payments |
| id | 0..1 | string | Unique id for inter-element referencing | |
| extension | I | 0..* | Extension | Additional content defined by implementations |
| modifierExtension | ?!ΣI | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| type | ΣI | 1..1 | CodeableConcept | Exception category Binding: ExampleCoverageFinancialExceptionCodes (example) |
| period | ΣI | 0..1 | Period | The effective period of the exception |
| subrogation | I | 0..1 | boolean | Reimbursement to insurer |
| contract | I | 0..* | Reference(Contract) | Contract details |
| 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 | ||
| identifier | 0..1 | Identifier | ||
| status | 1..1 | code | Binding: FinancialResourceStatusCodes (required) | |
| type | 1..1 | CodeableConcept | Binding: CoverageTypeAndSelf-PayCodes (extensible) | |
| subscriber | 1..1 | Reference(RelatedPerson) | ||
| beneficiary | 1..1 | Reference(US Core Patient Profile) | ||
| period | 0..1 | Period | ||
| start | 1..1 | dateTime | ||
| end | 0..1 | dateTime | ||
| payor | 1..1 | Reference(BSeR Organization) | ||
| class | 0..* | BackboneElement | ||
| type | 1..1 | CodeableConcept | Binding: CoverageClassCodes (extensible) | |
| value | 1..1 | string | ||
| Documentation for this format | ||||
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Coverage | I | 0..* | Coverage | Insurance or medical plan or a payment agreement |
| id | Σ | 0..1 | string | Logical id of this artifact |
| meta | ΣI | 0..1 | Meta | Metadata about the resource |
| implicitRules | ?!ΣI | 0..1 | uri | A set of rules under which this content was created |
| language | I | 0..1 | code | Language of the resource content Binding: CommonLanguages (preferred) Max Binding: AllLanguages |
| text | I | 0..1 | Narrative | Text summary of the resource, for human interpretation |
| contained | 0..* | Resource | Contained, inline Resources | |
| extension | I | 0..* | Extension | Additional content defined by implementations |
| modifierExtension | ?!I | 0..* | Extension | Extensions that cannot be ignored |
| identifier | ΣI | 0..1 | Identifier | Business Identifier for the coverage |
| status | ?!ΣI | 1..1 | code | active | cancelled | draft | entered-in-error Binding: FinancialResourceStatusCodes (required) |
| type | ΣI | 1..1 | CodeableConcept | Coverage category such as medical or accident Binding: CoverageTypeAndSelf-PayCodes (extensible) |
| policyHolder | ΣI | 0..1 | Reference(Patient | RelatedPerson | Organization) | Owner of the policy |
| subscriber | ΣI | 1..1 | Reference(RelatedPerson) | Subscriber to the policy |
| subscriberId | ΣI | 0..1 | string | ID assigned to the subscriber |
| beneficiary | ΣI | 1..1 | Reference(US Core Patient Profile) | Plan beneficiary |
| dependent | ΣI | 0..1 | string | Dependent number |
| relationship | I | 0..1 | CodeableConcept | Beneficiary relationship to the subscriber Binding: SubscriberRelationshipCodes (extensible) |
| period | ΣI | 0..1 | Period | Coverage start and end dates |
| id | 0..1 | string | Unique id for inter-element referencing | |
| extension | I | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url |
| start | ΣI | 1..1 | dateTime | Starting time with inclusive boundary |
| end | ΣI | 0..1 | dateTime | End time with inclusive boundary, if not ongoing |
| payor | ΣI | 1..1 | Reference(BSeR Organization) | Issuer of the policy |
| class | I | 0..* | BackboneElement | Additional coverage classifications |
| id | 0..1 | string | Unique id for inter-element referencing | |
| extension | I | 0..* | Extension | Additional content defined by implementations |
| modifierExtension | ?!ΣI | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| type | ΣI | 1..1 | CodeableConcept | Type of class such as 'group' or 'plan' Binding: CoverageClassCodes (extensible) |
| value | ΣI | 1..1 | string | Value associated with the type |
| name | ΣI | 0..1 | string | Human readable description of the type and value |
| order | ΣI | 0..1 | positiveInt | Relative order of the coverage |
| network | ΣI | 0..1 | string | Insurer network |
| costToBeneficiary | I | 0..* | BackboneElement | Patient payments for services/products |
| id | 0..1 | string | Unique id for inter-element referencing | |
| extension | I | 0..* | Extension | Additional content defined by implementations |
| modifierExtension | ?!ΣI | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| type | ΣI | 0..1 | CodeableConcept | Cost category Binding: CoverageCopayTypeCodes (extensible) |
| value[x] | ΣI | 1..1 | The amount or percentage due from the beneficiary | |
| valueQuantity | Quantity(SimpleQuantity) | |||
| valueMoney | Money | |||
| exception | I | 0..* | BackboneElement | Exceptions for patient payments |
| id | 0..1 | string | Unique id for inter-element referencing | |
| extension | I | 0..* | Extension | Additional content defined by implementations |
| modifierExtension | ?!ΣI | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| type | ΣI | 1..1 | CodeableConcept | Exception category Binding: ExampleCoverageFinancialExceptionCodes (example) |
| period | ΣI | 0..1 | Period | The effective period of the exception |
| subrogation | I | 0..1 | boolean | Reimbursement to insurer |
| contract | I | 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 | extensible | CoverageTypeAndSelf-PayCodes |
| Coverage.relationship | extensible | SubscriberRelationshipCodes |
| Coverage.class.type | extensible | CoverageClassCodes |
| Coverage.costToBeneficiary.type | extensible | CoverageCopayTypeCodes |
| Coverage.costToBeneficiary.exception.type | example | ExampleCoverageFinancialExceptionCodes |
| Id | Path | Details | Requirements |
| dom-2 | Coverage | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
| dom-3 | 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 | 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 | Coverage | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
| dom-6 | Coverage | A resource should have narrative for robust management : text.`div`.exists() | |
| ele-1 | Coverage.meta | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Coverage.implicitRules | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Coverage.language | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Coverage.text | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Coverage.extension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | Coverage.extension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| ele-1 | Coverage.modifierExtension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | Coverage.modifierExtension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| ele-1 | Coverage.identifier | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Coverage.status | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Coverage.type | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Coverage.policyHolder | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Coverage.subscriber | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Coverage.subscriberId | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Coverage.beneficiary | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Coverage.dependent | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Coverage.relationship | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Coverage.period | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Coverage.period.extension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | Coverage.period.extension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| ele-1 | Coverage.period.start | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Coverage.period.end | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Coverage.payor | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Coverage.class | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Coverage.class.extension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | Coverage.class.extension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| ele-1 | Coverage.class.modifierExtension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | Coverage.class.modifierExtension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| ele-1 | Coverage.class.type | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Coverage.class.value | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Coverage.class.name | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Coverage.order | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Coverage.network | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Coverage.costToBeneficiary | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Coverage.costToBeneficiary.extension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | Coverage.costToBeneficiary.extension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| ele-1 | Coverage.costToBeneficiary.modifierExtension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | Coverage.costToBeneficiary.modifierExtension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| ele-1 | Coverage.costToBeneficiary.type | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Coverage.costToBeneficiary.value[x] | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Coverage.costToBeneficiary.exception | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Coverage.costToBeneficiary.exception.extension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | Coverage.costToBeneficiary.exception.extension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| ele-1 | Coverage.costToBeneficiary.exception.modifierExtension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | Coverage.costToBeneficiary.exception.modifierExtension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| ele-1 | Coverage.costToBeneficiary.exception.type | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Coverage.costToBeneficiary.exception.period | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Coverage.subrogation | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Coverage.contract | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) |
IG © 2019+ HL7 International - Public Health Work Group. Package hl7.fhir.us.bser#1.0.0 based on FHIR 4.0.1. Generated 2020-03-02
Links: Table of Contents |
QA Report | Search
| Version History |
|
Propose a change