Belgian MyCareNet Profiles
2.1.0 - STU
Belgian MyCareNet Profiles, published by eHealth Platform. This guide is not an authorized publication; it is the continuous build for version 2.1.0 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/hl7-be/mycarenet/ and changes regularly. See the Directory of published versions
Official URL: https://www.ehealth.fgov.be/standards/fhir/mycarenet/StructureDefinition/be-mycarenet-coverage | Version: 2.1.0 | |||
Draft as of 2024-08-26 | Computable Name: BeMyCareNetCoverage |
Coverage profile for use in the different MyCareNet flows
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 BeInvCT1CT2: Coverage.class SHALL contain at least a CT1 and a CT2 value |
id | S | 1..1 | id | Logical id of this artifact |
status | S | 1..1 | code | active | cancelled | draft | entered-in-error |
type | S | 1..1 | CodeableConcept | Coverage category such as medical or accident |
coding | S | 1..1 | Coding | Code defined by a terminology system |
system | S | 1..1 | uri | Identity of the terminology system |
code | S | 1..1 | code | Symbol in syntax defined by the system |
beneficiary | S | 1..1 | Reference(BePatient) | Plan beneficiary |
payor | S | 1..1 | Reference(BeOrganization) | Issuer of the policy |
class | S | 2..* | BackboneElement | Additional coverage classifications |
type | S | 1..1 | CodeableConcept | Type of class such as 'group' or 'plan' |
coding | S | 1..1 | Coding | Code defined by a terminology system |
system | S | 1..1 | uri | Identity of the terminology system |
code | S | 1..1 | code | Symbol in syntax defined by the system |
value | S | 1..1 | string | Value associated with the type |
Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
system | S | 0..1 | uri | Extension URL: https://www.ehealth.fgov.be/standards/fhir/mycarenet/StructureDefinition/be-ext-system |
Documentation for this format |
Id | Grade | Path(s) | Details | Requirements |
BeInvCT1CT2 | error | Coverage | Coverage.class SHALL contain at least a CT1 and a CT2 value : Coverage.class.value.extension('https://www.ehealth.fgov.be/standards/fhir/mycarenet/StructureDefinition/be-ext-system').where(value is Uri).where(value = 'https://www.ehealth.fgov.be/standards/fhir/mycarenet/CodeSystem/be-cs-holder-code-1').empty().not() and Coverage.class.value.extension('https://www.ehealth.fgov.be/standards/fhir/mycarenet/StructureDefinition/be-ext-system').where(value is Uri).where(value = 'https://www.ehealth.fgov.be/standards/fhir/mycarenet/CodeSystem/be-cs-holder-code-2').empty().not() and Coverage.class.value.where(extension('https://www.ehealth.fgov.be/standards/fhir/mycarenet/StructureDefinition/be-ext-system').value = 'https://www.ehealth.fgov.be/standards/fhir/mycarenet/CodeSystem/be-cs-holder-code-1').memberOf('https://www.ehealth.fgov.be/standards/fhir/mycarenet/ValueSet/be-vs-holder-code-1') and Coverage.class.value.where(extension('https://www.ehealth.fgov.be/standards/fhir/mycarenet/StructureDefinition/be-ext-system').value = 'https://www.ehealth.fgov.be/standards/fhir/mycarenet/CodeSystem/be-cs-holder-code-2').memberOf('https://www.ehealth.fgov.be/standards/fhir/mycarenet/ValueSet/be-vs-holder-code-2') |
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Coverage | C | 0..* | Coverage | Insurance or medical plan or a payment agreement BeInvCT1CT2: Coverage.class SHALL contain at least a CT1 and a CT2 value |
id | SΣ | 1..1 | id | Logical id of this artifact |
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created |
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
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Σ | 1..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. |
coding | SΣ | 1..1 | Coding | Code defined by a terminology system |
system | SΣ | 1..1 | uri | Identity of the terminology system |
code | SΣ | 1..1 | code | Symbol in syntax defined by the system |
beneficiary | SΣ | 1..1 | Reference(BePatient) | Plan beneficiary |
payor | SΣ | 1..1 | Reference(BeOrganization) | Issuer of the policy |
class | S | 2..* | BackboneElement | Additional coverage classifications |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
type | SΣ | 1..1 | CodeableConcept | Type of class such as 'group' or 'plan' Binding: CoverageClassCodes (extensible): The policy classifications, eg. Group, Plan, Class, etc. |
coding | SΣ | 1..1 | Coding | Code defined by a terminology system |
system | SΣ | 1..1 | uri | Identity of the terminology system |
code | SΣ | 1..1 | code | Symbol in syntax defined by the system |
value | SΣ | 1..1 | string | Value associated with the type |
Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
system | S | 0..1 | uri | Extension URL: https://www.ehealth.fgov.be/standards/fhir/mycarenet/StructureDefinition/be-ext-system |
Documentation for this format |
Path | Conformance | ValueSet | URI |
Coverage.status | required | FinancialResourceStatusCodeshttp://hl7.org/fhir/ValueSet/fm-status|4.0.1 from the FHIR Standard | |
Coverage.type | preferred | CoverageTypeAndSelf-PayCodeshttp://hl7.org/fhir/ValueSet/coverage-type from the FHIR Standard | |
Coverage.class.type | extensible | CoverageClassCodeshttp://hl7.org/fhir/ValueSet/coverage-class from the FHIR Standard |
Id | Grade | Path(s) | Details | Requirements |
BeInvCT1CT2 | error | Coverage | Coverage.class SHALL contain at least a CT1 and a CT2 value : Coverage.class.value.extension('https://www.ehealth.fgov.be/standards/fhir/mycarenet/StructureDefinition/be-ext-system').where(value is Uri).where(value = 'https://www.ehealth.fgov.be/standards/fhir/mycarenet/CodeSystem/be-cs-holder-code-1').empty().not() and Coverage.class.value.extension('https://www.ehealth.fgov.be/standards/fhir/mycarenet/StructureDefinition/be-ext-system').where(value is Uri).where(value = 'https://www.ehealth.fgov.be/standards/fhir/mycarenet/CodeSystem/be-cs-holder-code-2').empty().not() and Coverage.class.value.where(extension('https://www.ehealth.fgov.be/standards/fhir/mycarenet/StructureDefinition/be-ext-system').value = 'https://www.ehealth.fgov.be/standards/fhir/mycarenet/CodeSystem/be-cs-holder-code-1').memberOf('https://www.ehealth.fgov.be/standards/fhir/mycarenet/ValueSet/be-vs-holder-code-1') and Coverage.class.value.where(extension('https://www.ehealth.fgov.be/standards/fhir/mycarenet/StructureDefinition/be-ext-system').value = 'https://www.ehealth.fgov.be/standards/fhir/mycarenet/CodeSystem/be-cs-holder-code-2').memberOf('https://www.ehealth.fgov.be/standards/fhir/mycarenet/ValueSet/be-vs-holder-code-2') | |
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() |
Name | Flags | Card. | Type | Description & Constraints | ||||
---|---|---|---|---|---|---|---|---|
Coverage | C | 0..* | Coverage | Insurance or medical plan or a payment agreement BeInvCT1CT2: Coverage.class SHALL contain at least a CT1 and a CT2 value | ||||
id | SΣ | 1..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 | ||||
identifier | Σ | 0..* | Identifier | Business Identifier for the coverage | ||||
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Σ | 1..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. | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
coding | SΣ | 1..1 | Coding | Code defined by a terminology system | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
system | SΣ | 1..1 | uri | Identity of the terminology system | ||||
version | Σ | 0..1 | string | Version of the system - if relevant | ||||
code | SΣ | 1..1 | code | Symbol in syntax defined by the system | ||||
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 | ||||
policyHolder | Σ | 0..1 | Reference(Patient | RelatedPerson | Organization) | Owner of the policy | ||||
subscriber | Σ | 0..1 | Reference(Patient | RelatedPerson) | Subscriber to the policy | ||||
subscriberId | Σ | 0..1 | string | ID assigned to the subscriber | ||||
beneficiary | SΣ | 1..1 | Reference(BePatient) | 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..1 | Reference(BeOrganization) | Issuer of the policy | ||||
class | S | 2..* | 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 | SΣ | 1..1 | CodeableConcept | Type of class such as 'group' or 'plan' Binding: CoverageClassCodes (extensible): The policy classifications, eg. Group, Plan, Class, etc. | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
coding | SΣ | 1..1 | Coding | Code defined by a terminology system | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
system | SΣ | 1..1 | uri | Identity of the terminology system | ||||
version | Σ | 0..1 | string | Version of the system - if relevant | ||||
code | SΣ | 1..1 | code | Symbol in syntax defined by the system | ||||
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 | Value associated with the type | ||||
id | 0..1 | string | xml:id (or equivalent in JSON) | |||||
Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
system | S | 0..1 | uri | Extension URL: https://www.ehealth.fgov.be/standards/fhir/mycarenet/StructureDefinition/be-ext-system | ||||
value | 0..1 | string | Primitive value for string Max Length: 1048576 | |||||
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 |
Path | Conformance | ValueSet | URI | |||
Coverage.language | preferred | CommonLanguages
http://hl7.org/fhir/ValueSet/languages from the FHIR Standard | ||||
Coverage.status | required | FinancialResourceStatusCodeshttp://hl7.org/fhir/ValueSet/fm-status|4.0.1 from the FHIR Standard | ||||
Coverage.type | preferred | CoverageTypeAndSelf-PayCodeshttp://hl7.org/fhir/ValueSet/coverage-type from the FHIR Standard | ||||
Coverage.relationship | extensible | SubscriberRelationshipCodeshttp://hl7.org/fhir/ValueSet/subscriber-relationship from the FHIR Standard | ||||
Coverage.class.type | extensible | CoverageClassCodeshttp://hl7.org/fhir/ValueSet/coverage-class from the FHIR Standard | ||||
Coverage.costToBeneficiary.type | extensible | CoverageCopayTypeCodeshttp://hl7.org/fhir/ValueSet/coverage-copay-type from the FHIR Standard | ||||
Coverage.costToBeneficiary.exception.type | example | ExampleCoverageFinancialExceptionCodeshttp://hl7.org/fhir/ValueSet/coverage-financial-exception from the FHIR Standard |
Id | Grade | Path(s) | Details | Requirements |
BeInvCT1CT2 | error | Coverage | Coverage.class SHALL contain at least a CT1 and a CT2 value : Coverage.class.value.extension('https://www.ehealth.fgov.be/standards/fhir/mycarenet/StructureDefinition/be-ext-system').where(value is Uri).where(value = 'https://www.ehealth.fgov.be/standards/fhir/mycarenet/CodeSystem/be-cs-holder-code-1').empty().not() and Coverage.class.value.extension('https://www.ehealth.fgov.be/standards/fhir/mycarenet/StructureDefinition/be-ext-system').where(value is Uri).where(value = 'https://www.ehealth.fgov.be/standards/fhir/mycarenet/CodeSystem/be-cs-holder-code-2').empty().not() and Coverage.class.value.where(extension('https://www.ehealth.fgov.be/standards/fhir/mycarenet/StructureDefinition/be-ext-system').value = 'https://www.ehealth.fgov.be/standards/fhir/mycarenet/CodeSystem/be-cs-holder-code-1').memberOf('https://www.ehealth.fgov.be/standards/fhir/mycarenet/ValueSet/be-vs-holder-code-1') and Coverage.class.value.where(extension('https://www.ehealth.fgov.be/standards/fhir/mycarenet/StructureDefinition/be-ext-system').value = 'https://www.ehealth.fgov.be/standards/fhir/mycarenet/CodeSystem/be-cs-holder-code-2').memberOf('https://www.ehealth.fgov.be/standards/fhir/mycarenet/ValueSet/be-vs-holder-code-2') | |
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() |
This structure is derived from Coverage
Summary
Mandatory: 8 elements
Must-Support: 15 elements
Structures
This structure refers to these other structures:
Extensions
This structure refers to these extensions:
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 BeInvCT1CT2: Coverage.class SHALL contain at least a CT1 and a CT2 value |
id | S | 1..1 | id | Logical id of this artifact |
status | S | 1..1 | code | active | cancelled | draft | entered-in-error |
type | S | 1..1 | CodeableConcept | Coverage category such as medical or accident |
coding | S | 1..1 | Coding | Code defined by a terminology system |
system | S | 1..1 | uri | Identity of the terminology system |
code | S | 1..1 | code | Symbol in syntax defined by the system |
beneficiary | S | 1..1 | Reference(BePatient) | Plan beneficiary |
payor | S | 1..1 | Reference(BeOrganization) | Issuer of the policy |
class | S | 2..* | BackboneElement | Additional coverage classifications |
type | S | 1..1 | CodeableConcept | Type of class such as 'group' or 'plan' |
coding | S | 1..1 | Coding | Code defined by a terminology system |
system | S | 1..1 | uri | Identity of the terminology system |
code | S | 1..1 | code | Symbol in syntax defined by the system |
value | S | 1..1 | string | Value associated with the type |
Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
system | S | 0..1 | uri | Extension URL: https://www.ehealth.fgov.be/standards/fhir/mycarenet/StructureDefinition/be-ext-system |
Documentation for this format |
Id | Grade | Path(s) | Details | Requirements |
BeInvCT1CT2 | error | Coverage | Coverage.class SHALL contain at least a CT1 and a CT2 value : Coverage.class.value.extension('https://www.ehealth.fgov.be/standards/fhir/mycarenet/StructureDefinition/be-ext-system').where(value is Uri).where(value = 'https://www.ehealth.fgov.be/standards/fhir/mycarenet/CodeSystem/be-cs-holder-code-1').empty().not() and Coverage.class.value.extension('https://www.ehealth.fgov.be/standards/fhir/mycarenet/StructureDefinition/be-ext-system').where(value is Uri).where(value = 'https://www.ehealth.fgov.be/standards/fhir/mycarenet/CodeSystem/be-cs-holder-code-2').empty().not() and Coverage.class.value.where(extension('https://www.ehealth.fgov.be/standards/fhir/mycarenet/StructureDefinition/be-ext-system').value = 'https://www.ehealth.fgov.be/standards/fhir/mycarenet/CodeSystem/be-cs-holder-code-1').memberOf('https://www.ehealth.fgov.be/standards/fhir/mycarenet/ValueSet/be-vs-holder-code-1') and Coverage.class.value.where(extension('https://www.ehealth.fgov.be/standards/fhir/mycarenet/StructureDefinition/be-ext-system').value = 'https://www.ehealth.fgov.be/standards/fhir/mycarenet/CodeSystem/be-cs-holder-code-2').memberOf('https://www.ehealth.fgov.be/standards/fhir/mycarenet/ValueSet/be-vs-holder-code-2') |
Key Elements View
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Coverage | C | 0..* | Coverage | Insurance or medical plan or a payment agreement BeInvCT1CT2: Coverage.class SHALL contain at least a CT1 and a CT2 value |
id | SΣ | 1..1 | id | Logical id of this artifact |
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created |
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
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Σ | 1..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. |
coding | SΣ | 1..1 | Coding | Code defined by a terminology system |
system | SΣ | 1..1 | uri | Identity of the terminology system |
code | SΣ | 1..1 | code | Symbol in syntax defined by the system |
beneficiary | SΣ | 1..1 | Reference(BePatient) | Plan beneficiary |
payor | SΣ | 1..1 | Reference(BeOrganization) | Issuer of the policy |
class | S | 2..* | BackboneElement | Additional coverage classifications |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
type | SΣ | 1..1 | CodeableConcept | Type of class such as 'group' or 'plan' Binding: CoverageClassCodes (extensible): The policy classifications, eg. Group, Plan, Class, etc. |
coding | SΣ | 1..1 | Coding | Code defined by a terminology system |
system | SΣ | 1..1 | uri | Identity of the terminology system |
code | SΣ | 1..1 | code | Symbol in syntax defined by the system |
value | SΣ | 1..1 | string | Value associated with the type |
Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
system | S | 0..1 | uri | Extension URL: https://www.ehealth.fgov.be/standards/fhir/mycarenet/StructureDefinition/be-ext-system |
Documentation for this format |
Path | Conformance | ValueSet | URI |
Coverage.status | required | FinancialResourceStatusCodeshttp://hl7.org/fhir/ValueSet/fm-status|4.0.1 from the FHIR Standard | |
Coverage.type | preferred | CoverageTypeAndSelf-PayCodeshttp://hl7.org/fhir/ValueSet/coverage-type from the FHIR Standard | |
Coverage.class.type | extensible | CoverageClassCodeshttp://hl7.org/fhir/ValueSet/coverage-class from the FHIR Standard |
Id | Grade | Path(s) | Details | Requirements |
BeInvCT1CT2 | error | Coverage | Coverage.class SHALL contain at least a CT1 and a CT2 value : Coverage.class.value.extension('https://www.ehealth.fgov.be/standards/fhir/mycarenet/StructureDefinition/be-ext-system').where(value is Uri).where(value = 'https://www.ehealth.fgov.be/standards/fhir/mycarenet/CodeSystem/be-cs-holder-code-1').empty().not() and Coverage.class.value.extension('https://www.ehealth.fgov.be/standards/fhir/mycarenet/StructureDefinition/be-ext-system').where(value is Uri).where(value = 'https://www.ehealth.fgov.be/standards/fhir/mycarenet/CodeSystem/be-cs-holder-code-2').empty().not() and Coverage.class.value.where(extension('https://www.ehealth.fgov.be/standards/fhir/mycarenet/StructureDefinition/be-ext-system').value = 'https://www.ehealth.fgov.be/standards/fhir/mycarenet/CodeSystem/be-cs-holder-code-1').memberOf('https://www.ehealth.fgov.be/standards/fhir/mycarenet/ValueSet/be-vs-holder-code-1') and Coverage.class.value.where(extension('https://www.ehealth.fgov.be/standards/fhir/mycarenet/StructureDefinition/be-ext-system').value = 'https://www.ehealth.fgov.be/standards/fhir/mycarenet/CodeSystem/be-cs-holder-code-2').memberOf('https://www.ehealth.fgov.be/standards/fhir/mycarenet/ValueSet/be-vs-holder-code-2') | |
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() |
Snapshot View
Name | Flags | Card. | Type | Description & Constraints | ||||
---|---|---|---|---|---|---|---|---|
Coverage | C | 0..* | Coverage | Insurance or medical plan or a payment agreement BeInvCT1CT2: Coverage.class SHALL contain at least a CT1 and a CT2 value | ||||
id | SΣ | 1..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 | ||||
identifier | Σ | 0..* | Identifier | Business Identifier for the coverage | ||||
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Σ | 1..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. | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
coding | SΣ | 1..1 | Coding | Code defined by a terminology system | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
system | SΣ | 1..1 | uri | Identity of the terminology system | ||||
version | Σ | 0..1 | string | Version of the system - if relevant | ||||
code | SΣ | 1..1 | code | Symbol in syntax defined by the system | ||||
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 | ||||
policyHolder | Σ | 0..1 | Reference(Patient | RelatedPerson | Organization) | Owner of the policy | ||||
subscriber | Σ | 0..1 | Reference(Patient | RelatedPerson) | Subscriber to the policy | ||||
subscriberId | Σ | 0..1 | string | ID assigned to the subscriber | ||||
beneficiary | SΣ | 1..1 | Reference(BePatient) | 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..1 | Reference(BeOrganization) | Issuer of the policy | ||||
class | S | 2..* | 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 | SΣ | 1..1 | CodeableConcept | Type of class such as 'group' or 'plan' Binding: CoverageClassCodes (extensible): The policy classifications, eg. Group, Plan, Class, etc. | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
coding | SΣ | 1..1 | Coding | Code defined by a terminology system | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
system | SΣ | 1..1 | uri | Identity of the terminology system | ||||
version | Σ | 0..1 | string | Version of the system - if relevant | ||||
code | SΣ | 1..1 | code | Symbol in syntax defined by the system | ||||
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 | Value associated with the type | ||||
id | 0..1 | string | xml:id (or equivalent in JSON) | |||||
Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
system | S | 0..1 | uri | Extension URL: https://www.ehealth.fgov.be/standards/fhir/mycarenet/StructureDefinition/be-ext-system | ||||
value | 0..1 | string | Primitive value for string Max Length: 1048576 | |||||
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 |
Path | Conformance | ValueSet | URI | |||
Coverage.language | preferred | CommonLanguages
http://hl7.org/fhir/ValueSet/languages from the FHIR Standard | ||||
Coverage.status | required | FinancialResourceStatusCodeshttp://hl7.org/fhir/ValueSet/fm-status|4.0.1 from the FHIR Standard | ||||
Coverage.type | preferred | CoverageTypeAndSelf-PayCodeshttp://hl7.org/fhir/ValueSet/coverage-type from the FHIR Standard | ||||
Coverage.relationship | extensible | SubscriberRelationshipCodeshttp://hl7.org/fhir/ValueSet/subscriber-relationship from the FHIR Standard | ||||
Coverage.class.type | extensible | CoverageClassCodeshttp://hl7.org/fhir/ValueSet/coverage-class from the FHIR Standard | ||||
Coverage.costToBeneficiary.type | extensible | CoverageCopayTypeCodeshttp://hl7.org/fhir/ValueSet/coverage-copay-type from the FHIR Standard | ||||
Coverage.costToBeneficiary.exception.type | example | ExampleCoverageFinancialExceptionCodeshttp://hl7.org/fhir/ValueSet/coverage-financial-exception from the FHIR Standard |
Id | Grade | Path(s) | Details | Requirements |
BeInvCT1CT2 | error | Coverage | Coverage.class SHALL contain at least a CT1 and a CT2 value : Coverage.class.value.extension('https://www.ehealth.fgov.be/standards/fhir/mycarenet/StructureDefinition/be-ext-system').where(value is Uri).where(value = 'https://www.ehealth.fgov.be/standards/fhir/mycarenet/CodeSystem/be-cs-holder-code-1').empty().not() and Coverage.class.value.extension('https://www.ehealth.fgov.be/standards/fhir/mycarenet/StructureDefinition/be-ext-system').where(value is Uri).where(value = 'https://www.ehealth.fgov.be/standards/fhir/mycarenet/CodeSystem/be-cs-holder-code-2').empty().not() and Coverage.class.value.where(extension('https://www.ehealth.fgov.be/standards/fhir/mycarenet/StructureDefinition/be-ext-system').value = 'https://www.ehealth.fgov.be/standards/fhir/mycarenet/CodeSystem/be-cs-holder-code-1').memberOf('https://www.ehealth.fgov.be/standards/fhir/mycarenet/ValueSet/be-vs-holder-code-1') and Coverage.class.value.where(extension('https://www.ehealth.fgov.be/standards/fhir/mycarenet/StructureDefinition/be-ext-system').value = 'https://www.ehealth.fgov.be/standards/fhir/mycarenet/CodeSystem/be-cs-holder-code-2').memberOf('https://www.ehealth.fgov.be/standards/fhir/mycarenet/ValueSet/be-vs-holder-code-2') | |
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() |
This structure is derived from Coverage
Summary
Mandatory: 8 elements
Must-Support: 15 elements
Structures
This structure refers to these other structures:
Extensions
This structure refers to these extensions:
Other representations of profile: CSV, Excel, Schematron