HdBe-Payer
CBB | Concept | Status |
---|---|---|
HdBe-Payer | Payers are organizations or individuals that pay for the healthcare supplied to the patient. These organizations or individuals can be: facilities or people who financially guarantee or who are responsible for the patient (such as parents or guardians of minors), organizations with direct financial responsibility, combinations of these or the patient themselves. PurposeRecording the information of the paying authorities and people serves to simplify payment of the fees for the supplied care and to provide insight in advance on how these fees are to be paid, especially when it comes to non-insured healthcare. Evidence BaseThe structure of the 'European Health Insurance Card (EHIC)' information was taken into account. | draft |
Payer | I | Payer | |
PayerPerson | I | 0..1 | BackboneElement |
PayerName | 0..1 | string | |
BankInformation | 0..* | BackboneElement | |
BankName | 0..1 | string | |
BankCode | 0..1 | string | |
AccountNumber | 1..1 | string | |
InsuranceCompany | I | 0..1 | BackboneElement |
Insurance | 1..* | BackboneElement | |
StartDateTime | 0..1 | dateTime | |
EndDateTime | 1..1 | dateTime | |
InsuranceType | 1..1 | CodeableConceptBinding | |
IdentificationNumber | 0..1 | Identifier | |
OrganizationName | 0..1 | string | |
InsurantNumber | 1..1 | string | |
AddressInformation | 0..* | HdBe AddressInformation | |
ContactInformation | 0..* | HdBe ContactInformation |
Payer | 0..* | |
Payer.PayerPerson | BackboneElement | 0..1 |
Payer.PayerPerson.PayerName | string | 0..1 |
Payer.PayerPerson.BankInformation | BackboneElement | 0..* |
Payer.PayerPerson.BankInformation.BankName | string | 0..1 |
Payer.PayerPerson.BankInformation.BankCode | string | 0..1 |
Payer.PayerPerson.BankInformation.AccountNumber | string | 1..1 |
Payer.InsuranceCompany | BackboneElement | 0..1 |
Payer.InsuranceCompany.Insurance | BackboneElement | 1..* |
Payer.InsuranceCompany.Insurance.StartDateTime | dateTime | 0..1 |
Payer.InsuranceCompany.Insurance.EndDateTime | dateTime | 1..1 |
Payer.InsuranceCompany.Insurance.InsuranceType | CodeableConcept | 1..1 |
Payer.InsuranceCompany.IdentificationNumber | Identifier | 0..1 |
Payer.InsuranceCompany.OrganizationName | string | 0..1 |
Payer.InsuranceCompany.InsurantNumber | string | 1..1 |
Payer.AddressInformation | HdBe AddressInformation | 0..* |
Payer.ContactInformation | HdBe ContactInformation | 0..* |
Payer | |
Definition | Root concept of the Payer information model. This root concept contains all data elements of the Payer information model. |
Cardinality | 0...* |
Invariants |
|
Mappings |
|
Payer.id | |
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Cardinality | 0...1 |
Type | System.String |
Mappings |
|
Payer.extension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
Cardinality | 0...* |
Type | Extension |
Alias | extensions, user content |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Slicing | Unordered, Open, by url(Value) |
Invariants |
|
Mappings |
|
Payer.PayerPerson | |
Definition | Container of the PayerPerson concept. This container contains all data elements of the PayerPerson concept. In this a person is a natural person or a juridical person, such as an organization, municipality, etc. |
Cardinality | 0...1 |
Type | BackboneElement |
Invariants |
|
Mappings |
|
Payer.PayerPerson.id | |
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Cardinality | 0...1 |
Type | System.String |
Mappings |
|
Payer.PayerPerson.extension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
Cardinality | 0...* |
Type | Extension |
Alias | extensions, user content |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Slicing | Unordered, Open, by url(Value) |
Invariants |
|
Mappings |
|
Payer.PayerPerson.modifierExtension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). |
Cardinality | 0...* |
Type | Extension |
Modifier | True |
Summary | True |
Alias | extensions, user content, modifiers |
Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Invariants |
|
Mappings |
|
Payer.PayerPerson.PayerName | |
Definition | Full name of the paying person or organization (legal entity). |
Cardinality | 0...1 |
Type | string |
Comments | Note that FHIR strings SHALL NOT exceed 1MB in size |
Invariants |
|
Mappings |
|
Payer.PayerPerson.BankInformation | |
Definition | Container of the BankInformation concept. This container contains all data elements of the BankInformation concept. |
Cardinality | 0...* |
Type | BackboneElement |
Invariants |
|
Mappings |
|
Payer.PayerPerson.BankInformation.id | |
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Cardinality | 0...1 |
Type | System.String |
Mappings |
|
Payer.PayerPerson.BankInformation.extension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
Cardinality | 0...* |
Type | Extension |
Alias | extensions, user content |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Slicing | Unordered, Open, by url(Value) |
Invariants |
|
Mappings |
|
Payer.PayerPerson.BankInformation.modifierExtension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). |
Cardinality | 0...* |
Type | Extension |
Modifier | True |
Summary | True |
Alias | extensions, user content, modifiers |
Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Invariants |
|
Mappings |
|
Payer.PayerPerson.BankInformation.BankName | |
Definition | Name of the financial organization. |
Cardinality | 0...1 |
Type | string |
Comments | Note that FHIR strings SHALL NOT exceed 1MB in size |
Invariants |
|
Mappings |
|
Payer.PayerPerson.BankInformation.BankCode | |
Definition | Code indicating the bank and branch. For European countries, this is the organization’s BIC or SWIFT code. |
Cardinality | 0...1 |
Type | string |
Comments | Note that FHIR strings SHALL NOT exceed 1MB in size |
Invariants |
|
Mappings |
|
Payer.PayerPerson.BankInformation.AccountNumber | |
Definition | The payer’s bank account number at the listed organization. For European countries, this is the IBAN. |
Cardinality | 1...1 |
Type | string |
Comments | Note that FHIR strings SHALL NOT exceed 1MB in size |
Invariants |
|
Mappings |
|
Payer.InsuranceCompany | |
Definition | Container of the InsuranceCompany concept. This container contains all data elements of the InsuranceCompany concept. |
Cardinality | 0...1 |
Type | BackboneElement |
Invariants |
|
Mappings |
|
Payer.InsuranceCompany.id | |
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Cardinality | 0...1 |
Type | System.String |
Mappings |
|
Payer.InsuranceCompany.extension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
Cardinality | 0...* |
Type | Extension |
Alias | extensions, user content |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Slicing | Unordered, Open, by url(Value) |
Invariants |
|
Mappings |
|
Payer.InsuranceCompany.modifierExtension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). |
Cardinality | 0...* |
Type | Extension |
Modifier | True |
Summary | True |
Alias | extensions, user content, modifiers |
Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Invariants |
|
Mappings |
|
Payer.InsuranceCompany.Insurance | |
Definition | Container of the Insurance concept. This container contains all data elements of the Insurance concept. |
Cardinality | 1...* |
Type | BackboneElement |
Invariants |
|
Mappings |
|
Payer.InsuranceCompany.Insurance.id | |
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Cardinality | 0...1 |
Type | System.String |
Mappings |
|
Payer.InsuranceCompany.Insurance.extension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
Cardinality | 0...* |
Type | Extension |
Alias | extensions, user content |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Slicing | Unordered, Open, by url(Value) |
Invariants |
|
Mappings |
|
Payer.InsuranceCompany.Insurance.modifierExtension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). |
Cardinality | 0...* |
Type | Extension |
Modifier | True |
Summary | True |
Alias | extensions, user content, modifiers |
Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Invariants |
|
Mappings |
|
Payer.InsuranceCompany.Insurance.StartDateTime | |
Definition | Date from which the insurance policy coverage applies. |
Cardinality | 0...1 |
Type | dateTime |
Invariants |
|
Mappings |
|
Payer.InsuranceCompany.Insurance.EndDateTime | |
Definition | Date until which the insurance policy coverage applies. This item maps the *‘Expiry date’* on EHIC field 9. |
Cardinality | 1...1 |
Type | dateTime |
Invariants |
|
Mappings |
|
Payer.InsuranceCompany.Insurance.InsuranceType | |
Definition | Type of insurance policy. Codes as returned in the Check for Right to Insurance |
Cardinality | 1...1 |
Type | CodeableConcept |
Binding | InsuranceType codes InsuranceType (required) |
Comments | Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination. |
Invariants |
|
Mappings |
|
Payer.InsuranceCompany.IdentificationNumber | |
Definition | Unique healthcare insurance company identification. |
Cardinality | 0...1 |
Type | Identifier |
Invariants |
|
Mappings |
|
Payer.InsuranceCompany.OrganizationName | |
Definition | Full, official name of the healthcare insurance company. |
Cardinality | 0...1 |
Type | string |
Comments | Note that FHIR strings SHALL NOT exceed 1MB in size |
Invariants |
|
Mappings |
|
Payer.InsuranceCompany.InsurantNumber | |
Definition | Number under which the insured person is registered at the insurance company This item maps the *‘Identification number of the card’* on EHIC field 8 |
Cardinality | 1...1 |
Type | string |
Comments | Note that FHIR strings SHALL NOT exceed 1MB in size |
Invariants |
|
Mappings |
|
Payer.AddressInformation | |
Definition | The payer’s address information. |
Cardinality | 0...* |
Type | HdBe AddressInformation |
Invariants |
|
Mappings |
|
Payer.ContactInformation | |
Definition | The payer’s telephone number and/or e-mail address. |
Cardinality | 0...* |
Type | HdBe ContactInformation |
Invariants |
|
Mappings |
|
Example instances
payer | |
---|---|
PayerPerson | --- |
PayerPerson.PayerName | |
PayerPerson.BankInformation | |
PayerPerson.BankInformation.BankName | |
PayerPerson.BankInformation.BankCode | |
PayerPerson.BankInformation.AccountNumber | |
InsuranceCompany | --- |
InsuranceCompany.Insurance | --- |
InsuranceCompany.Insurance.StartDateTime | 01-01-2012 |
InsuranceCompany.Insurance.EndDateTime | 31-12-2012 |
InsuranceCompany.Insurance.InsuranceType | IT0001 - basis (verplichte ziekteverzekering) (code by Healthdata.be (Sciensano)) |
InsuranceCompany.IdentificationNumber | 235 |
InsuranceCompany.OrganizationName | Neutraal ziekenfonds Vlaanderen |
InsuranceCompany.InsurantNumber | 12345678 |
AddressInformation | see HdBe-AddressInformation |
ContactInformation | see HdBe-ContactInformation |
payer | |
---|---|
PayerPerson | --- |
PayerPerson.PayerName | Belle Ulijn |
PayerPerson.BankInformation | --- |
PayerPerson.BankInformation.BankName | BELFIUS BANK |
PayerPerson.BankInformation.BankCode | GKCC BE BB |
PayerPerson.BankInformation.AccountNumber | BE68 5390 0754 7034 |
InsuranceCompany | --- |
InsuranceCompany.Insurance | --- |
InsuranceCompany.Insurance.StartDateTime | |
InsuranceCompany.Insurance.EndDateTime | |
InsuranceCompany.Insurance.InsuranceType | |
InsuranceCompany.IdentificationNumber | |
InsuranceCompany.OrganizationName | |
InsuranceCompany.InsurantNumber | |
AddressInformation | see HdBe-AddressInformation |
ContactInformation | see HdBe-ContactInformation |
zib Payer-v3.1.1 difference
Concept | Category | Description |
---|---|---|
PayerPerson |
cardinality | Changed cardinality from 0..* to 0..1 and added a constraint that exactly one of InsuranceCompany or payerPerson must exists. The 0..* cardinality is likely an export error. |
Payer |
constraint | Added a constraint on the root to indicate the invariant from the zib that is noted in the UML representation. |
InsuranceCompany |
cardinality | Changed cardinality from 0..* to 0..1 and added a constraint that exactly one of InsuranceCompany or payerPerson must exists. The 0..* cardinality is likely an export error. |
description.EvidenceBase | textual | Removed Dutch context. |
Terminology Bindings
Path | Name | Strength | URL |
---|---|---|---|
InsuranceCompany.Insurance.InsuranceType | InsuranceType | required | https://fhir.healthdata.be/ValueSet/InsuranceType |